Changes

4,359 bytes added , 29 February

no edit summary

Line 1: Line 1:

__TOC__

−

~~[[Category:Howto]] [[Category:Server Manager 2]] [[Category:SM2]] [[Category:Mojolicious]]~~

== Introduction ==

−

Server Manager 2 is based on the perl library [https://mojolicious.org/ Mojolicious] and has as its central tenet that the html structure is kept separate from the content that is displayed, giving a lot of flexibility. It has a structure so that the web pages can have a theme applied independant of the content. Behind the scenes a non blocking web server does the actual work, and comes with lots of additional plugins.<br>

Some details about the implementation and installation of Server manager 2 can be found [[Server Manager2|here]]. <br>

Initially the default theme mimics the current Server Manager pages (which is based on [[Esmith::FormMagick|formMagick]]), however a new theme has also been developed which is based on [https://adminlte.io/themes/dev/AdminLTE/index3.html AdminLTE].<br>

Line 21: Line 22:

However (Feb 2022) until it is deemed stable enough it needs to be installed specifically from the development/testing repos:<syntaxhighlight lang="shell">

−

yum install smeserver-manager smeserver-manager-AdminLTE --enablerepo=smedev,smetest,smecontribs

yum install smeserver-manager smeserver-manager-AdminLTE js-jquery --enablerepo=smedev,smetest,smecontribs

</syntaxhighlight>you can access the new server manager as follows:<syntaxhighlight lang="shell">

<your server FQDN or Ip address>/smanager

Line 169: Line 170:

#----------------------------------------------------------------------

−

# heading : ~~Configuration~~

# heading : Network

# description : DHCP manager

# navigation : 2000 2500

Line 181: Line 182:

# name : dhcpd6, method : get, url : /dhcpd6, ctlact : Dhcpd#do_delete_one_lease

# name : dhcpd7, method : get, url : /dhcpd7, ctlact : Dhcpd#do_refresh_leases

−

# name : dhcpd8, method : ~~post~~, url : /dhcpd8, ctlact : Dhcpd#~~winpopup~~

# name : dhcpd8, method : get, url : /dhcpd8, ctlact : Dhcpd#do_winpopup

# name : dhcpd9, method : get, url : /dhcpd9, ctlact : Dhcpd#do_wol

# name : dhcpd10, method : post, url : /dhcpd10, ctlact : Dhcpd#do_update_check

# routes : end

Line 188: Line 191:

# Documentation: https://wiki.koozali.org/Dhcpmanager

−

</syntaxhighlight>The Server Manager 2 system extracts these "comments" from the header of the controller file and builds the navigation menu and the routing tables accordingly.

Line 221: Line 222:

</syntaxhighlight>Necessary library units are identified and Configuration databases opened and the hash to be used to communicate with the template files is initialised.

−

As can be seen from the routing tables the following routines are specified to be the receipt of control depending on the web page user.

As can be seen from the routing tables the following routines are specified to be the receipt of control depending on the web page user. I

In simplified terms these are the routines.

Updated in Feb 2024 - this code is the current at this time. <syntaxhighlight lang="perl">

my %dhcp_data = ();

−

~~In simplified terms these are the routines (as before currently untested):<syntaxhighlight lang="perl">~~

sub main {

Line 231: Line 236:

my $c = shift;

%dhcp_data = ();

−

~~#$dhcp_data{"first"} = 'dhcpd_DESCRIPTION';~~

do_display($c);

−

do_display( $c~~, %dhcp_data~~ );

}

Line 274: Line 278:

dhcp_data => \%dhcp_data

);

#die("here");

$c->render( template => 'dhcpd' );

}

Line 284: Line 289:

my $title = $c->l("dhcpd_MANAGING_DHCP_CLIENT");

my $modul = '';

−

my $trt = "LEASES";

$dhcp_data{"check"} = [[$c->l('dhcpd_ENABLED'),'enabled'],

[$c->l('dhcpd_DISABLED'),'disabled']

];

$dhcp_data{trt} = $trt;

$dhcp_data{"first"} = '';

my @leases = get_leases_in_array($c);

−

~~#print dumper @leases;~~

−

~~#$dhcp_data{"leases"} = \@leases;~~

$c->stash( title => $title, modul => $modul, dhcp_data => \%dhcp_data, leases=> \@leases );

$c->render( template => 'dhcpd' );

}

sub do_scan {

# call to show scan results

my $c = shift;

my $title = $c->l("dhcpd_SCANNING_NETWORK_TITLE");

my $modul = '';

my $trt = "SCAN";

$dhcp_data{trt} = $trt;

$dhcp_data{"first"} = '';

# ..... get scan results into stash for passing to html template

my $dhcp_scanresults = get_scan_results($c);

$c->stash( title => $title, modul => $modul, "dhcp_data" => \%dhcp_data, "scanresults" => $dhcp_scanresults);

$c->render( template => 'dhcpd' );

}

sub do_update_config {

Line 312: Line 335:

}

do_display($c);

−

return ;

return;

}

sub do_update_check {

#Just update the check parameter

my $c = shift;

my $dhcpd_check = $c->param ('dhcp_check');

###Update SME configuration dbase

my $dbh_sme = esmith::ConfigDB->open('/home/e-smith/db/configuration');

##Initiate get method --> create record object

my $sme_record = $dbh_sme->get('dhcpd');

$sme_record->set_prop('check' , $dhcpd_check);

$dhcp_data{"success"}="dhcpd_SUCCESSFULLY_SAVED_SETTINGS";

do_display($c);

return;

}

</syntaxhighlight>

Line 457: Line 495:

exit;

}

</syntaxhighlight>The routine extracts the input field values through the $c-<param routine and validates them, returning an error message if the validation fails and otherwise writing the results back to the DB.

Line 466: Line 506:

% content_for 'module' => begin

Line 482: Line 523:

</p>

−

</syntaxhighlight>All Mojolicious commands are indicated by a "%" in the first non space character. If the next character is an equals sign then the result of the expression is output. Inline commands are inside pseudo-tags "<%" and "%>".

This is the best list I have found of the ep syntax:<syntaxhighlight lang="text">

Line 507: Line 549:

%} elsif ($dhcp_data->{success}) {

−

<h2> Operation Status Report</h2><p>

<h2> Operation Status Report - success</h2><p>

%= $c->l($dhcp_data->{success});

</font>

</p>

</div>

Line 515: Line 559:

<h2> Operation Status Report - error</h2><p>

%= $c->l($dhcp_data->{error});

</font>

</p>

</div>

−

% if ($dhcp_data->{trt} eq 'LEASES') {

%= include 'partials/_dhcpd_leases'

−

~~%} elsif ($dhcp_data->{trt} eq 'WINPOPUP') {~~

%} elsif ($dhcp_data->{trt} eq 'SCAN') {

−

~~%= include 'partials/_dhcpd_winpopup'~~

%= include 'partials/_dhcpd_scan'

−

%} elsif ($dhcp_data->{trt} eq 'SCAN') {

−

%= include 'partials/_dhcpd_scan'

</syntaxhighlight>and finally the front panel details is defined:

Line 531: Line 576:

%} else { #PARAMS

% my $ip_regex = '^((\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.){3}(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])$';

−

<table>

−

%= button_to $c->l('dhcpd_CONNECTED_IP') => '/dhcpd1'

<tr>

−

</td><td>

<td>

−

%= button_to $c->l('dhcpd_SCAN_YOUR_NETWORK') => '/dhcpd3'

%= button_to $c->l('dhcpd_CONNECTED_IP') => '/dhcpd1', onclick=>"showSpinnerLeases()", id=>"scanLeases"

−

<~~/td~~><~~td>~~

−

%= ~~button_to~~ $c->l('~~dhcpd_GLOBAL_WINPOPUP~~') => '/~~dhcpd2'~~

Scanning

−

<td>

−

</tr>

</button>

−

</table>

</td><td>

%= button_to $c->l('dhcpd_SCAN_YOUR_NETWORK') => '/dhcpd3', onclick=>"showSpinnerNetwork()", id=>"scanNetwork"

Scanning

</button>

</td>

</tr>

</table>

<hr />

<h2>

Line 646: Line 699:

%= submit_button "$btn", class => 'action'

% end

−

~~</div>~~

−

~~%end~~

</syntaxhighlight>This shows the top few controls for the panel. Note the use of the table to keep the buttons in a row and also the structure of each parameter row involving the <nowiki><span> tags and the <br></nowiki> to create newlines. Use of this structure will keep your panel in line with both the default and the AdminLTE themes. You need not do this of course!

From the form command at the top it can be seen that clicking the "Save/Restart" button will lead to a routing through dhcpd5 which will result in the perl sub "do_update_config" being executed, which will save all the parameters back to the DB.

−

=== The Partials files can be used to keep the structure in ~~mulitple~~ files. ===

=== The Partials files can be used to keep the structure in multiple files. ===

We will look at just one to display the lease table. <syntaxhighlight lang="perl">

−

%= button_to $c->l('dhcpd_REFRESH') => '/dhcpd1'

%= button_to $c->l('dhcpd_REFRESH') => '/dhcpd1', onclick=>"showSpinnerLeases()", id=>"scanLeases"

−

</td><td>

−

%= button_to $c->l('dhcpd_REMOVE_ALL_LEASES') => '/dhcpd4'

Scanning

−

</td>

−

</tr>

</button>

</td><td>

%= button_to $c->l('dhcpd_REMOVE_ALL_LEASES') => '/dhcpd4'

</td>

</tr>

</table>

−

~~<hr />~~

% my $btn = l('dhcpd_SAVE/RESTART');

−

%= form_for '/~~dhcpd5~~' => (method => 'POST') => begin

%= form_for '/dhcpd10' => (method => 'POST') => begin

%=l 'dhcpd_CHECK_CLIENT_STATUS'

Line 676: Line 731:

%= $c->l("dhcpd_SAVE_TITLE");

<br />

−

%= submit_button "$btn", class => 'action'

% end

<br>

−

−

<tr>

Line 705: Line 758:

</th>

</tr>

</thead>

<tbody>

% foreach my $ip (@$leases) {

<tr>

Line 710: Line 765:

%= t td => (class => 'sme-border') => $ip->{name}

−

<a href="/smanager/dhcpd9??state=wake_up&MAC=<%= $ip->{mac}%>&name=<%= $ip->{name}%>" onclick="Wol_confirm(event,'<%=$c->l('dhcpd_WAKING_A_REMOTE_COMPUTER')%>',this);"><%==l $ip->{wol}%></a>

% if ($ip->{wol} =~ /ACTIVE/) {

%} else {

<a href="/smanager/dhcpd9??state=wake_up&MAC=<%= $ip->{mac}%>&name=<%= $ip->{name}%>" onclick="Wol_confirm(event,'<%=$c->l('dhcpd_WAKING_A_REMOTE_COMPUTER')%>',this);"><center><%==l $ip->{wol}%></center></a>

</td>

%= t td => (class => 'sme-border') => $ip->{start}

Line 716: Line 775:

%= t td => (class => 'sme-border') => $ip->{mac}

−

<a href="/smanager/dhcpd6?trt=DEL&ip=<%= $ip->{ip}%>~~" onclick="Remove_lease_confirm(event,'<%=$c->l('dhcpd_REMOVE_A_DHCP_LEASE_ACTION')%>',this);"><%=l 'dhcpd_REMOVE'%></a>~~

<a href="/smanager/dhcpd6?trt=DEL&ip=<%= $ip->{ip}%>&name=<%= $ip->{name}%>" onclick="Remove_lease_confirm(event,'<%=$c->l('dhcpd_REMOVE_A_DHCP_LEASE_ACTION')%>',this);"><center><%=l 'dhcpd_REMOVE'%></center></a>

−

~~<a href="/smanager/dhcpd8?trt=WIN~~&ip=<%= $ip->{ip}%>" onclick="~~Winpop_confirm~~(event,'<%=$c->l('~~dhcpd_SENDING_A_WINPOPUP~~')%>',this);"><%=l '~~dhcpd_WINPOPUP_ACTION~~'%></a>

</td>

</tr>

Line 726: Line 784:

<br />

%= button_to $c->l('dhcpd_CLICK_HERE_TO_MAIN_PANEL') => '/dhcpd'

−

~~<script>~~

−

~~//var form = document.getElementById("dhcpd-leases").getElementsByTagName('a');~~

%= javascript begin

−

~~//confirm("Form elements:"+form.length);~~

−

~~//for (let i = 0; i<form.length; i++) {~~

−

~~//form[i].onclick~~ = ~~function() {~~

−

~~// return confirm("html:"+i);~~

−

~~//}~~

−

~~//}~~

−

~~//function Wol_confirm(){~~

−

~~// if confirm("Confirm Wake on Lan to be sent to:"+this.href) then window.location.href=''~~

−

~~//}~~

function Wol_confirm(event,msg,current){

const getMAC = /.*MAC\=(.*)\&name.*/;

Line 761: Line 810:

const getIP = /.*ip\=(.*)/;

var IP = current.href.match(getIP)[1];

−

if (~~prompt~~(msg+" IP: "+IP))

if (confirm(msg+" IP: "+IP))

{ return true;}

else {event.preventDefault();return false;}

}

−

~~</script>~~

%end

</div>

</syntaxhighlight>

Note the use of Javascript to present to user with dialogs for confirmation and the WinPopup msg. This was done in the original using extra panels. Although some do not like Javascript, I feel it is here to stay and presents opportunities in terms of interfaces that are best taken advantage of. The main challenge is to work out how to pass the various perl based data to and from the JS routines. Note I use a hidden field for this in one case. And the html request parameters for the others. It can be a challenge to get the mixture of double and single quotes correct!

==== Adding Javascript and CSS to the .ep file ====

You can use the tag helpers "Javascript" and "Stylesheet"to add inline content to a .ep file, here is an example from the DHCPManager to add notification that the scan is being performed. Under the AdminLTE theme, the button is changed to show a "Scanning" text and also a spinner. In the default theme thje text is shown, but the AdminLTE/Bootstrap spinner classes are ignored.

This code fits in between the final html tags and the "%end" command:<syntaxhighlight lang="css">

%= javascript begin

document.getElementById("load").style.display="none";

function showSpinner(){

document.getElementById("scanLeases").style.display="none";

document.getElementById("load").style.display="inline";

}

%end

%= stylesheet begin

.spinnerButtonOverlay,

.spinnerButtonOverlay:hover,

.spinnerButtonOverlay:any-link ,

.spinnerButtonOverlay:focus ,

.spinnerButtonOverlay:active {

appearance: auto;

user-select: none;

align-items: flex-start;

cursor: default;

box-sizing: border-box;

background-color: #efefef;

color: black;

padding: 1px 6px;

border-width: 2px;

border-style: outset;

border-color: darkgrey;

border-image: initial;

}

%end

</syntaxhighlight>For completion sake here is the replacement button (with AdminLTE spinner) html/mojolicious helper tags:<syntaxhighlight lang="html">

%= button_to $c->l('dhcpd_CONNECTED_IP') => '/dhcpd1', onclick=>"showSpinner()", id=>"scanLeases"

Scanning

</button>

</syntaxhighlight>Note the Id codes used to allow the JS to find the controls.

===Translation Strings files===

Line 863: Line 954:

My current way to do this is to put the following code in the "%post" section of the .spec file:

−

if [ -~~f /usr/share/~~smanager~~/lib/SrvMngr.pm ]~~

if (systemctl list-unit-files |grep smanager) then

−

then

echo "Smanager restart in spec file" /sbin/e-smith/signal-event smanager-refresh

−

~~/usr~~/sbin/e-smith/signal-event smanager-refresh

−

~~true~~

In the fullness of time it might be better to put this in the smeserver-dhcpmanager-update event.

Line 883: Line 972:

So many of the well known contribs have not been done.

−

Ones that have been done (Feb ~~2022~~) are:

Ones that have been done (Feb 2024) are:

*smeserver-BackupPC (but not entirely - bug 11701)

*smeserver-awstats

*smeserver-certificate

*smeserver-ddclient

*smeserver-dhcpmanager

*smeserver-domains (this one may not be finished)

*smeserver-durep

*smeserver-fail2ban

*smeserver-geneweb

*smeserver-qmHandle

*smeserver-vacation

*smeserver-wbl

*smeserver-webhosting

*smeserver-wireguard

*smeserver-xt_geoip

−

* smeserver-ddclient

−

* smeserver-domains

−

* smeserver-BackupPC (but not entirely - [https://bugs.koozali.org/show_bug.cgi?id=11701 bug 11701])

−

* smeserver-qmhandle

−

* smeserver-dhcpmanager (not yet complete - [https://bugs.koozali.org/show_bug.cgi?id=11850 bug 11850])

−

* smeserver-durep

−

* smeserver-fail2ban

−

* smeserver-geneweb

−

* smeserver-xt_geoip

−

* smeserver-vacation

−

* smeserver-wbl

−

* smeserver-webhosting

I suggest you take one of the contribs you currently use and give it a go!! Check with the dev team and on the [https://forums.koozali.org/index.php/board,36.0.html forum] in case someone else is working on your choice though.

Line 903: Line 996:

This [[:Category:Contrib#In%20production|link]] will give you a list of contribs that have been released for SME10.

−

[[Category:Developer]]

===Bugs===

Please raise bugs under the SME-Server section in {{BugzillaFileBug|product=SME%20Server%2010.x|component=server-manager|title= bugzilla}}

and select the {{#var:smecontribname}} component or use {{BugzillaFileBug|product=SME%20Server%2010.x|component=server-manager|title=this link}}

Below is an overview of the current issues for this package:{{#bugzilla:columns=id,product,version,status,summary|sort=id|order=desc|component=server-manager|noresultsmessage=No open bugs found.}}

===Changelog===

Only released version in smeserver are listed here.

{{#smechangelog: {{#var:smecontribname}} }}

[[Category:SME Server]][[Category:Administration]][[Category:Server Manager 2]] [[Category:SM2]] [[Category:Mojolicious]] [[Category:Developer]]

Brianr

Administrators (Semantic MediaWiki), Administrators

681

edits

Retrieved from "https://wiki.koozali.org/Special:MobileDiff/40816...42554"

Changes

Server Manager2 create panel for contrib (view source)

Revision as of 13:38, 29 February 2024

Navigation menu

Search