Changes

931 bytes added , 21:41, 12 June 2015

added the original link where the howto was for references

Line 1: Line 1:

−

{{warning box|msg= This documentation on how to build a panel in the server-manager is completely deprecated but it can bring to the developers some tricks to understand what is occurring in an old ~~contrib~~. Please if you intend to build a panel you should use formagick instead of the perl cgi}}

{{warning box|msg= '''This documentation on how to build a panel in the server-manager is completely deprecated''' but it can bring to the developers some tricks to understand what is occurring in old contribs. Please if you intend to build a panel you should use formagick instead of the perl cgi}}

−

[http://www.sme-server.de/download/Howtos/e-smith_panel_howto.html original ~~Author~~]

[http://dungog.net/wiki/Main_Page original Author] <br />

[http://www.sme-server.de/download/Howtos/e-smith_panel_howto.html original link]

===Introduction===

Writing a panel for an e-smith server need not be difficult. By choosing an existing panel that is similar to what you need you can get a head start. You need only a small background in any sort of programming, coding html or similar.

Line 139: Line 141:

Descriptive text explaining the page.

$q->p is ordinary text

−

$q->is bold

$q->b is bold

$q->h4 is a heading

are these perl options ? where can i find more examples. (?sn)

Line 145: Line 147:

esmith::cgi::genTextRow

($q, $q->p ('Enter the name of the',

−

$q->b ('windows workgroup'),

−

'that the e-smith server should appear in.')),

Create a text entry field. It has three parameters, a test description, a name for the variable and a default value, the default in the example below is taken from the configuation file

esmith::cgi::genNameValueRow ($q,

−

"Windows workgroup",

−

"sambaWorkgroup",

−

$conf {'SambaWorkgroup'}),

esmith::cgi::genTextRow

($q, $q->p ('Enter the name that the e-smith server should use',

−

'for Windows and Macintosh file sharing.')),

esmith::cgi::genNameValueRow ($q,

−

"Server name",

−

"sambaServerName",

−

$conf {'SambaServerName'}),

esmith::cgi::genTextRow

−

($q, $q->p ('Should the e-smith server be the domain master for your 'Windows workgroup?',

−

'Typically the answer should be',

−

$q->b ('no'),

−

'if you are running a Windows NT server on this network, and,',

−

$q->b ('yes'),

−

'otherwise.') . ' ' .

$q->p ('If you enable e-smith server to be the domain master a',

−

'netlogon.bat script will be created in order to make netlogon', 'clients use the existing script. The script is harmless',

−

'for those who do not wish to use it. It is recommended that only',

−

'experienced users customize the netlogon.bat script.')),

Create a drop down button, here you have two choices, yes and no. popup_menu has a minimum or 2 parameters, name and value. Optionaly you can give a defaults or label the buttons

$q->Tr (esmith::cgi::genCell ($q, "Domain master:"),

−

esmith::cgi::genCell ($q, $q->popup_menu (-name => 'sambaDomainMaster',

−

-values => ['yes', 'no'],

−

-default => $conf {'SambaDomainMaster'},

−

-labels => \%yesnoLabels))),

Create a button to push, name and label it. End the html for the page.

esmith::cgi::genButtonRow ($q,

−

$q->submit (-name => 'action', -value => 'Save')));

print $q->hidden (-name => 'state', -override => 1, -default => 'perform');

Line 206: Line 208:

if (db_get_prop(\%conf, 'ntpd', 'status') eq "enabled")

{

−

$enabledChk = "checked";

}

Line 221: Line 223:

print $q->table ({border => 0, cellspacing => 0, cellpadding => 4},

−

esmith::cgi::genTextRow

−

($q, $q->p ($description)),

−

esmith::cgi::genTextRow

−

($q, $q->p ("Enable NTP Service ',

−

'>input type=\"checkbox\" name=\"ntpdEnabled\"$enabledChk<")),

−

esmith::cgi::genNameValueRow ($q,

−

"NTP server",

−

"ntpServer",

−

$oldNTPServer),

−

esmith::cgi::genButtonRow ($q,

−

$q->submit (-name => 'action', -value => 'Save NTP Settings')));

print '';

Line 242: Line 244:

print $q->p ($q->a ({href => $q->url (-absolute => 1) . "?state=create"},

−

'Click here'),

−

'to create a user group.');

Which we defined above

Line 265: Line 267:

if ($msg eq '')

{

−

esmith::cgi::genHeaderNonCacheable

−

($q, \%conf, 'Create, remove, or change user groups');

}

else

{

−

esmith::cgi::genHeaderNonCacheable

−

($q, \%conf, 'Operation status report');

−

print $q->p ($msg);

−

print $q->hr;

}

Line 322: Line 324:

print $q->Tr (esmith::cgi::genSmallRedCell ($q, $pseudonym),

−

esmith::cgi::genSmallCell ($q, $account),

−

$q->td (' '), #also works

−

esmith::cgi::genSmallCell ($q, " " ),

−

);

or you can have just one cell per row, for a genSmallRedCell warning? ))

Line 378: Line 380:

{

my ($q) = @_;

−

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

# Verify the arguments and untaint the variables (see Camel

Line 391: Line 393:

if (defined ($q->param ('ntpdEnabled')))

{

−

$newStatus = "on";

}

else

{

−

$newStatus = "off";

}

Line 402: Line 404:

my $day = $q->param ('day');

if ($day =~ /^(.*)$/) {

−

$day = $1;

} else {

−

$day = "1";

}

if (($day < 1) || ($day > 31))

Line 412: Line 414:

{

esmith::cgi::genResult ($q, "Error: invalid day of month ($day). ',

−

'Please choose a day between 1 and 31.");

−

return;

}

The final part of the panel saves the key/values pair or key/prop|values sets and then calls an e-smith action or a unix command

−

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

−

# Looks good; go ahead and change the parameters.

−

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

−

if ($newStatus ne "on") # asking to have NTP disabled

{

−

# make sure that the parameters are set for disabled

−

my $old = $conf {'UnsavedChanges'};

−

db_set_prop(\%conf, 'ntpd', 'status', 'disabled');

−

db_set_prop(\%conf, 'ntpd', 'NTPServer', '');

−

$conf {'UnsavedChanges'} = $old;

−

system ("/sbin/e-smith/signal-event", "timeserver-update") == 0

−

or die ("Error occurred while updating system configuration.\n");

−

esmith::cgi::genHeaderNonCacheable

−

($q, \%conf, "Network time server disabled successfully");

−

esmith::cgi::genResult ($q, "You have disabled this service: The server will rely on its', 'internal clock, and will not try to synchronize from a time server.");

}

−

else # enable service and synch with ntpServer

−

{

−

if ($ntpServer =~ /^([a-zA-Z0-9\.\-]+)$/)

−

{

−

$ntpServer = $1;

−

}

−

elsif ($ntpServer =~ /^\s*$/)

−

{

−

$ntpServer = "";

−

}

−

else

−

{

−

esmith::cgi::genHeaderNonCacheable ($q, \%conf, "Error while changing network',

'time server setting");

−

esmith::cgi::genResult ($q, "Invalid NTP server address \"$ntpServer\".");

−

return;

−

}

−

return;

}

Line 471: Line 473:

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

−

db_set

−

db_get

−

db_delete

−

db_set_type

−

db_get_type

−

db_get_prop

−

db_set_prop

−

db_delete_prop

−

db_print

−

db_show

−

db_print_type

−

db_print_prop

* examples

−

/home/e-smith/configuration

−

AccessType=dialup

−

sshd=service|InitscriptOrder|05|status|enabled

−

/home/e-smith/accounts

−

jim=user|EmailForward|local|LastName|Morrison

−

cdrom=system

−

cgi-bin=url

−

jim.morrison=pseudonym|account|jim

−

$hash ; the file containing the variables

−

/home/e-smith/configuration

−

or /home/e-smith/accounts

−

shown as /%conf or /%accounts in the panel perl code

−

key/value pairs

−

$key ; AccessType, cdrom, cgi-bin, jim.morrison

−

$new_value ; dialup, system, url

−

key/property|value sets

−

$key ; sshd, jim, jim.morrison

−

$type ;service, user, pseudonym

−

$prop ;InitscriptOrder, EmailForward, account, status

−

$new_value ; 05, local, Morrison, jim, enabled

−

$hashref ; see below for explanation

* explanations

Line 527: Line 529:

# It returns one on success and undef on failure.

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

−

sub db_set (%$$;$)

my ($hash, $key, $new_value, $hashref)

Line 533: Line 535:

else

{

−

db_set(\%conf, 'DelegateMailServer', $delegate);

}

))

Line 544: Line 546:

# suitable for assigning to a type and properties hash list)

# or undef if the key does not exist.

−

sub db_get (%;$)

my ($hash, $key)

Line 555: Line 557:

# Takes a reference to a hash and a scalar key and deletes the key. It

# returns one on success and undef if the key does not exist.

−

sub db_delete (%$;)

my ($hash, $key)

Line 561: Line 563:

if ($delegate eq "")

{

−

db_delete(\%conf, 'DelegateMailServer');

}

))

Line 570: Line 572:

# Takes a reference to a hash, a scalar key and a scalar value and sets

# the type for the key. It returns one on success and undef on failure.

−

sub db_set_type (%$$;)

my ($hash, $key, $type)

Line 579: Line 581:

# Takes a reference to a hash and a scalar key and returns the type

# associated with the key. It returns undef if the key does not exist.

−

sub db_get_type (%$;)

my ($hash, $key)

Line 585: Line 587:

if (db_get(\%accounts, $groupName))

{

−

my $type = db_get_type(\%accounts, $groupName);

−

if ($type eq "pseudonym")

−

{

−

my $acct = db_get_prop(\%accounts, $groupName, "Account");

))

Line 599: Line 601:

# scalar value and sets the property from the value. It returns with

# the return status of db_set or undef if the key does not exist.

−

sub db_set_prop (%$$$;)

((

−

if ($specifyHeader eq 'on')

−

{

−

db_set_prop(\%conf, "fetchmail", 'SecondaryMailEnvelope', $header);

−

}

−

else

−

{

−

db_delete_prop(\%conf, "fetchmail", 'SecondaryMailEnvelope');

−

}

))

Line 620: Line 622:

# hash of all properties for the key. It returns undef if the key or

# the property does not exist.

−

sub db_get_prop (%$;$)

my ($hash, $key, $prop)

((

my $SecondaryMailServer =

−

db_get_prop(\%conf, "fetchmail", "SecondaryMailServer")

))

Line 634: Line 636:

# deletes the property from the value. It returns with the return status

# of db_set or undef if the key or the property do not exist.

−

sub db_delete_prop (%$$;)

my ($hash, $key, $prop)

((

−

if ($specifyHeader eq 'on')

−

{

−

db_set_prop(\%conf, "fetchmail", 'SecondaryMailEnvelope', $header);

−

}

−

else

−

{

−

db_delete_prop(\%conf, "fetchmail", 'SecondaryMailEnvelope');

−

}

))

Line 655: Line 657:

# the scalar key is provided, it prints key=value for that key. It

# returns one on success or undef if the key does not exist.

−

sub db_print (%;$)

my ($hash, $key)

Line 667: Line 669:

# that key. The value is expanded to show properties. It returns one

# on success or undef if the key does not exist.

−

sub db_show (%;$)

my ($hash, $key)

Line 678: Line 680:

# the scalar key is provided, it prints key=type for that key. It

# returns one on success or undef if the key does not exist.

−

sub db_print_type (%;$)

my ($hash, $key)

Line 690: Line 692:

# provided, it prints prop=value for that key. It returns one on success

# or undef if the key or property does not exist.

−

sub db_print_prop (%$;$)

my ($hash, $key, $prop)

Line 696: Line 698:

===Basic Perl===

A few samples that demonstrate correct coding practise. In areas of logic, Testing user input, and calling events and unix programs.

−

====Logic===

====Logic====

−

"||" gives an answer if the first try didn't work.

* "||" gives an answer if the first try didn't work.

my $FetchmailFreqOffice = db_get_prop(\%conf, "fetchmail", "FreqOffice")

−

|| 'every15min';

my $account = db_get_prop(\%accounts, $pseudonym, 'Account'); $account = "Administrator" if ($account eq "admin"); "(value eq 'something') ?" if first is true determine the second

my $FetchMethod =

−

(db_get_prop(\%conf, "fetchmail", "status") eq 'enabled') ?

−

(db_get_prop(\%conf, "fetchmail", "Method") || 'standard') :

−

'standard';

−

"if (defined $something)" if defined then first else second

* "if (defined $something)" if defined then first else second

my $SecondaryMailUseEnvelope;

if (defined $SecondaryMailEnvelope)

{

−

$SecondaryMailUseEnvelope = "on";

}

else

{

−

$SecondaryMailUseEnvelope = "off";

−

$SecondaryMailEnvelope = "";

}

−

"&&" if true twice continue

* "&&" if true twice continue

if (defined $backup_status && $backup_status eq "enabled")

{

−

print $q->p ("Tape backups are enabled.");

}

else

{

−

print $q->p ("Tape backups are disabled.");

}

db_set_prop(\%conf, "fetchmail", 'SecondaryMailServer', $server) unless ($server eq '');; db_set_prop(\%conf, "fetchmail", 'FreqOffice', $fetchmailFreqOffice); "foreach"

−

foreach $pseudonym ("everyone", "mailer-daemon", "postmaster")

−

{

do something over

}

Line 745: Line 747:

if (length $HostName > 32)

{

−

showInitial ($q,

−

"Error: account name \"$HostName\" is too long. The

−

maximum is 32 characters.");

−

return;

}

Line 756: Line 758:

if ($password =~ /^(.*)$/)

{

−

$password = $1;

}

else

{

−

$password = "";

}

Line 768: Line 770:

if ($groupName =~ /^([a-z][\-\_\.a-z0-9]*)$/)

{

−

$groupName = $1;

}

else

{

−

showInitial ($q,

−

"Error: unexpected characters in group name: " .

−

"\"$groupName\". The group name should contain only " .

−

"lower-case letters, numbers, hyphens, periods, and underscores, and should start " .

−

"with a lower-case letter. For example \"sales\", \"beta5\", and \"reseller_partners\" are " .

−

"all valid group names, but \"3rd-event\", \"Marketing Team\" " .

−

"and \"order-status\" are not.");

−

return;

If you have a lot of tests you can define a set of expressions, describe them, and test for them

−

#define expression to test

* define expression to test

my $REGEXPHostname = '([a-z0-9][a-z0-9-\.]*)';

my $REGEXPIPAddress = '(self|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})';

Line 789: Line 791: −

#advice to user

* advice to user

esmith::cgi::genTextRow ($q, $q->p ( 'The IP address displayed

is the IP address of the e-smith server. If this hostname

Line 796: Line 798:

address in the format "aaa.bbb.ccc.ddd"' )),

−

#get input

* get input

−

esmith::cgi::genNameValueRow ($q,

−

"Hostname",

−

"HostName",

−

""),

−

#test input

* test input

my $MACAddress = lc($q->param ('MACAddress'));

Line 810: Line 812:

elsif ($MACAddress =~ /^$REGEXPMACAddress$/ )

{

−

$MACAddress = $1;

}

else

{

−

showInitial ($q,

−

"Error: Ethernet Address \"$MACAddress\"

is invalid. Ethernet addresses must be in the

form \"AA:BB:CC:DD:EE:FF\" and only contain the

numbers 0-9 and the letters A-F. Did not create

host entry.");

−

return;

====Run command (event)====

Line 826: Line 828:

system ("/sbin/e-smith/signal-event", "email-update") == 0

−

or die ("Error occurred while updating system configuration.\n");

esmith::cgi::genHeaderNonCacheable

Line 838: Line 840:

esmith::cgi::genHeaderNonCacheable

−

($q, \%conf, "Dialup funtion performed - down");

esmith::cgi::genResult ($q, "The modem is going down");

Line 844: Line 846:

===References===

====Bugs====

−

Syntax errors are common, a misplaced , or missed ) will result in a panel that will not run or compile.

Syntax errors are common, a misplaced , or missed ) will result in a panel that will not run or compile. Look in /var/log/httpd/admin_error_log for errors or admin_access_log will report success.

−

Look in /var/log/httpd/admin_error_log for errors

−

or admin_access_log will report success.

Check that httpd-admin is running as well as httpd, via a

−

Check that httpd-admin is running as well as httpd, via a ps -A |grep httpd.

ps -A |grep httpd.

Check you have correct permissions, and locate/link it the e-smith way

−

cd /etc/e-smith/web/functions/

−

chmod 750 thing, then chmod u+s thing (?sn)

−

cd /etc/e-smith/web/panel/manager/cgi-bin

−

ln -s ../../../thing thing

−

Links

−

www.e-smth.org duh

====Links====

−

www.perl.org

www.e-smth.org duh

−

Thanks

www.perl.org

====Thanks====

A big thank you to Gordon, Charlie and the e-smith team.

−

Stephen Noble April 2001 ver 0.1-2

Stephdl

Administrators

5,576

edits

Retrieved from "https://wiki.koozali.org/Special:MobileDiff/27842...27864"

Changes

Create server-manager panels by perl cgi (deprecated) (view source)

Revision as of 21:41, 12 June 2015

Navigation menu

Search