2004-11-01 13:56:54 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2006-08-16 17:42:35 +00:00
< html > < head > < title > Module HowTo - Account pages< / title >
2010-10-24 13:52:51 +00:00
2006-08-16 17:42:35 +00:00
2010-10-24 13:52:51 +00:00
< link rel = "stylesheet" type = "text/css" href = "style/layout.css" > < link rel = "shortcut icon" type = "image/x-icon" href = "images/favicon.ico" > < / head > < body >
2004-11-01 13:56:54 +00:00
< div style = "text-align: center;" >
< h1 > Module HowTo - Account pages< br >
< / h1 >
< br >
< br >
< div style = "text-align: left;" > < br >
2004-11-01 16:53:58 +00:00
< h2 > 1. Loading the LDAP attributes< br >
< / h2 >
Every time the user selects an existing account to modify LAM will load
the complete LDAP entry of it. Your module then should select the
attributes which are useful for it.< br >
There are two variables in < span style = "font-style: italic;" > baseModule< / span >
2006-08-16 17:42:35 +00:00
which should be used to store the attributes. The < span style = "font-weight: bold;" > $attributes< / span > variable stores the
current attributes including changes the user made. The < span style = "font-weight: bold;" > $orig< / span > variable stores the attributes
2004-11-01 16:53:58 +00:00
as they were originally when the account was loaded. This allows you to
see what changes were made.< br >
< br >
The < span style = "font-weight: bold;" > load_attributes()< / span > function
in your module gets the complete attribute list from LDAP.< br >
< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold; text-decoration: underline;" > Example:< / span > < br style = "font-weight: bold; text-decoration: underline;" >
2004-11-01 16:53:58 +00:00
< br >
The < span style = "font-style: italic;" > ieee802Device< / span > uses an
object class and the < span style = "font-style: italic;" > 'macAddress'< / span >
2009-12-19 15:50:48 +00:00
attribute. Therefore we will save these two values.< br >
2004-11-01 16:53:58 +00:00
< br >
2006-08-16 17:42:35 +00:00
< table style = "width: 100%; text-align: left;" class = "mod-code" border = "0" cellpadding = "2" cellspacing = "2" >
2004-11-01 16:53:58 +00:00
< tbody >
< tr >
< td style = "vertical-align: top;" > /**< br >
* This function loads all needed attributes into the
object.< br >
*< br >
* @param array $attr an array as it is retured from
ldap_get_attributes< br >
*/< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold;" > function< / span > < span style = "color: rgb(255, 0, 0);" > load_attributes< / span > ($attr) {< br >
2004-11-01 16:53:58 +00:00
$this-> attributes['objectClass'] = array();< br >
$this-> attributes['macAddress'] = array();< br >
$this-> orig['objectClass'] =
array();< br >
$this-> orig['macAddress'] =
array();< br >
if (isset($attr['objectClass'])) {< br >
$this-> attributes['objectClass'] = $attr['objectClass'];< br >
$this-> orig['objectClass'] = $attr['objectClass'];< br >
}< br >
if (isset($attr['macAddress'])) {< br >
$this-> attributes['macAddress'] = $attr['macAddress'];< br >
$this-> orig['macAddress'] = $attr['macAddress'];< br >
}< br >
return 0;< br >
}< br >
< / td >
< / tr >
< / tbody >
< / table >
< br >
< br >
2005-09-19 18:43:10 +00:00
< h2 > 2. Page display< / h2 >
2004-11-01 13:56:54 +00:00
Now that you have defined your subpages you will need one function for
2006-08-16 17:42:35 +00:00
each page to display it. The function must return < span style = "font-style: italic;" > meta HTML code< / span > as defined in the < span style = "font-style: italic;" > modules specification< / span > .< br >
2004-11-01 13:56:54 +00:00
This function is called < span style = "font-weight: bold;" > display_html_< page
name> ()< / span > where < span style = "font-style: italic;" > < page
name> < / span > is the name of your subpage.< br >
< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold; text-decoration: underline;" > Example:< / span > < br style = "font-weight: bold; text-decoration: underline;" >
2004-11-01 13:56:54 +00:00
< br >
The
< span style = "font-style: italic;" > ieee802Device< / span >
module has only one subpage called < span style = "font-style: italic;" > 'attributes'< / span > .< br >
< br >
The first half of the code displays the existing MAC addresses and the
second an input field for new values.< br >
The variable < span style = "font-style: italic;" > $this-> attributes< / span >
2004-11-01 16:53:58 +00:00
contains the LDAP attributes which are useful for this module.< br >
2004-11-01 13:56:54 +00:00
< br >
2006-08-16 17:42:35 +00:00
< table style = "width: 100%; text-align: left;" class = "mod-code" border = "0" cellpadding = "2" cellspacing = "2" >
2004-11-01 13:56:54 +00:00
< tbody >
< tr >
< td style = "vertical-align: top;" > /**< br >
* This function will create the meta HTML code to
show a page with all attributes.< br >
*< br >
2010-10-24 13:52:51 +00:00
* @return htmlElement HTML meta data< br >
2004-11-01 13:56:54 +00:00
*/< br >
2010-10-24 13:52:51 +00:00
< span style = "font-weight: bold;" > function< / span > < span style = "color: rgb(255, 0, 0);" > display_html_attributes< / span > () {< br > $return = new htmlTable();< br >
$macCount = 0;< br >
2004-11-01 13:56:54 +00:00
// list current MACs< br >
2010-10-24 13:52:51 +00:00
if (isset($this-> attributes['macAddress'])) {< br >
$macCount = sizeof($this-> attributes['macAddress']);< br >
for ($i = 0;
$i < sizeof($this-> attributes['macAddress']); $i++) {< br >
2004-11-01 13:56:54 +00:00
2010-10-24 13:52:51 +00:00
$return-> addElement(new htmlOutputText(_('MAC
address')));< br >
2004-11-01 13:56:54 +00:00
2010-10-24 13:52:51 +00:00
$macInput = new htmlInputField('macAddress' . $i,
$this-> attributes['macAddress'][$i]);< br >
$macInput-> setFieldSize(17);< br >
$macInput-> setFieldMaxLength(17);< br >
$return-> addElement($macInput);< br >
2004-11-01 13:56:54 +00:00
2010-10-24 13:52:51 +00:00
$return-> addElement(new htmlButton('delMAC' . $i,
'del.png', true));< br >
2004-11-01 13:56:54 +00:00
2010-10-24 13:52:51 +00:00
$return-> addElement(new htmlHelpLink('mac'),
true);< br >
}< br >
2004-11-01 13:56:54 +00:00
}< br >
// input box for new MAC< br >
2010-10-24 13:52:51 +00:00
$return-> addElement(new htmlOutputText(_('New MAC address')));< br >
$newMacInput = new htmlInputField('macAddress', '');< br >
$newMacInput-> setFieldSize(17);< br >
$newMacInput-> setFieldMaxLength(17);< br >
$return-> addElement($newMacInput);< br >
$return-> addElement(new htmlButton('addMAC', 'add.png', true));< br >
$return-> addElement(new htmlHelpLink('mac'));< br >
$return-> addElement(new htmlHiddenInput('mac_number', $macCount));< br >
2004-11-01 13:56:54 +00:00
return $return;< br >
}< br >
< / td >
< / tr >
< / tbody >
< / table >
< br >
< br >
2005-09-19 18:43:10 +00:00
< h2 > 3. Processing input data< br >
2004-11-01 13:56:54 +00:00
< / h2 >
Every time the user clicks on a submit button while your page is
displayed LAM will call a function in your module.< br >
This function is called < span style = "font-weight: bold;" > process_< page
name> ()< / span > where < span style = "font-style: italic;" > < page
name> < / span > is the name of your subpage.< br >
< br >
2006-08-16 17:42:35 +00:00
If all input data is ok then return an empty array. If you return one or more error messages then the user will be
2005-08-13 09:14:05 +00:00
redirected to your page.< br >
< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold; text-decoration: underline;" > Example:< / span > < br style = "font-weight: bold; text-decoration: underline;" >
2004-11-01 13:56:54 +00:00
< br >
The
< span style = "font-style: italic;" > ieee802Device< / span >
module has only one subpage called < span style = "font-style: italic;" > 'attributes'< / span >
and therefore only < span style = "font-style: italic;" > process_attributes()< / span > .< br >
< br >
The function checks the input fields and fills the LDAP attributes. If
all is ok it will enable the user to move to another module page.< br >
< br >
2006-08-16 17:42:35 +00:00
< table style = "width: 100%; text-align: left;" class = "mod-code" border = "0" cellpadding = "2" cellspacing = "2" >
2004-11-01 13:56:54 +00:00
< tbody >
< tr >
< td style = "vertical-align: top;" > /**< br >
* Write variables into object and do some regex
checks< br >
*< br >
* @param array $post HTTP-POST values< br >
*/< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold;" > function< / span > < span style = "color: rgb(255, 0, 0);" > process_attributes< / span > ($post) {< br >
2006-05-13 08:37:08 +00:00
$errors = array();< br >
2004-11-01 13:56:54 +00:00
$this-> attributes['macAddress'] = array();< br >
// check old MACs< br >
if (isset($post['mac_number'])) {< br >
for ($i = 0;
$i < $post['mac_number']; $i++) {< br >
if (isset($post['delMAC' . $i])) continue;< br >
if (isset($post['macAddress' . $i]) & &
($post['macAddress' . $i] != "")) {< br >
// check if address has correct
format< br >
if (!get_preg($post['macAddress'
. $i], 'macAddress')) {< br >
$message =
$this-> messages['mac'][0];< br >
$message[] =
$post['macAddress' . $i];< br >
2006-08-16 17:42:35 +00:00
$errors[] = $message;< br >
2004-11-01 13:56:54 +00:00
}< br >
$this-> attributes['macAddress'][] = $post['macAddress' . $i];< br >
}< br >
}< br >
}< br >
// check new MAC< br >
if (isset($post['macAddress'])
& & ($post['macAddress'] != "")) {< br >
// check if
address has correct format< br >
if
(get_preg($post['macAddress'], 'macAddress')) {< br >
$this-> attributes['macAddress'][] =
$post['macAddress'];< br >
}< br >
else {< br >
$message =
$this-> messages['mac'][0];< br >
$message[] = $post['macAddress'];< br >
2006-08-16 17:42:35 +00:00
$errors[] = $message;< br >
2004-11-01 13:56:54 +00:00
}< br >
}< br >
$this-> attributes['macAddress'] =
array_unique($this-> attributes['macAddress']);< br >
2006-05-13 08:37:08 +00:00
return $errors;< br >
2004-11-01 13:56:54 +00:00
}< br >
< / td >
< / tr >
< / tbody >
< / table >
< br >
< br >
2006-02-01 19:12:31 +00:00
< h2 > 4. Defining that your module is ready for user input and LDAP
add/modify< / h2 >
2006-08-16 17:42:35 +00:00
In most cases you will not need to implement these functions. The < span style = "font-style: italic;" > baseModule< / span > will return < span style = "font-style: italic;" > true< / span > for both functions.< br >
2006-02-01 19:12:31 +00:00
< br >
< span style = "text-decoration: underline;" > < br >
2006-08-16 17:42:35 +00:00
There are two functions which control the module status:< / span > < br style = "text-decoration: underline;" >
2005-08-13 09:14:05 +00:00
< br >
The < span style = "font-weight: bold;" > module_ready()< / span > function
has to
2004-11-01 13:56:54 +00:00
return < span style = "font-style: italic;" > true< / span > if the user may
2005-08-13 09:14:05 +00:00
move to your module page. If it is < span style = "font-style: italic;" > false< / span >
the user will be shown an error message that your module is not yet
ready. You can use this if your module depends on input data from other
modules (e.g. you need the user name from posixAccount first).< br >
2006-02-01 19:12:31 +00:00
< br >
2005-08-13 09:14:05 +00:00
The second function is
2004-11-01 13:56:54 +00:00
< span style = "font-weight: bold;" > module_complete()< / span > . The user
2006-08-16 17:42:35 +00:00
cannot do the LDAP operation if one or more modules return < span style = "font-style: italic;" > false< / span > . This defines if all needed
2005-08-13 09:14:05 +00:00
input data for your module was entered.< br >
2006-02-01 19:12:31 +00:00
Use this function if you want to check that all required attributes are
set.< br >
2004-11-01 13:56:54 +00:00
< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold; text-decoration: underline;" > Example:< / span > < br style = "font-weight: bold; text-decoration: underline;" >
2004-11-01 13:56:54 +00:00
< br >
2006-02-01 19:12:31 +00:00
The < span style = "font-style: italic;" > sambaSamAccount< / span >
module needs the user's < span style = "font-style: italic;" > uidNumber< / span >
and < span style = "font-style: italic;" > gidNumber< / span > before it can
accept input and the account needs a < span style = "font-style: italic;" > sambaSID< / span >
before it can be saved.< br >
2004-11-01 13:56:54 +00:00
< br >
2006-08-16 17:42:35 +00:00
< table style = "width: 100%; text-align: left;" class = "mod-code" border = "0" cellpadding = "2" cellspacing = "2" >
2004-11-01 13:56:54 +00:00
< tbody >
< tr >
2006-02-01 19:12:31 +00:00
< td style = "vertical-align: top;" > /**< br >
* This function is used to check if this module page
can be displayed.< br >
* It returns false if a module depends on data from
other modules which was not yet entered.< br >
*< br >
* @return boolean true, if page can be displayed< br >
2004-11-01 13:56:54 +00:00
*/< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold;" > function< / span > < span style = "color: rgb(255, 0, 0);" > module_ready< / span > () {< br >
2006-02-01 19:12:31 +00:00
if
($_SESSION[$this-> base]-> module['posixAccount']-> attributes['gidNumber'][0]=='')
return false;< br >
if
($_SESSION[$this-> base]-> module['posixAccount']-> attributes['uidNumber'][0]=='')
return false;< br >
if
($this-> attributes['uid'][0]=='') return false;< br >
return true;< br >
2004-11-01 13:56:54 +00:00
}< br >
2006-02-01 19:12:31 +00:00
< br >
2004-11-01 13:56:54 +00:00
/**< br >
2006-02-01 19:12:31 +00:00
* This functions is used to check if all settings
for this module have been made.< br >
*< br >
* @return boolean true, if settings are complete< br >
2004-11-01 13:56:54 +00:00
*/< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold;" > function< / span > < span style = "color: rgb(255, 0, 0);" > module_complete< / span > () {< br >
2006-02-01 19:12:31 +00:00
if (!$this-> module_ready())
return false;< br >
if
($this-> attributes['sambaSID'][0] == '') return false;< br >
return true;< br >
2004-11-01 13:56:54 +00:00
}< br >
2006-02-01 19:12:31 +00:00
< br >
2004-11-01 13:56:54 +00:00
< / td >
< / tr >
< / tbody >
< / table >
< br >
< br >
2005-09-19 18:43:10 +00:00
< h2 > 5. Saving the LDAP attributes< br >
2004-11-01 13:56:54 +00:00
< / h2 >
2006-08-16 17:42:35 +00:00
In most cases you will not have to implement this option if you use < span style = "font-weight: bold;" > $this-> attributes< / span > and < span style = "font-weight: bold;" > $this-> orig< / span > to manage the LDAP
2006-02-01 19:12:31 +00:00
attributes. The < span style = "font-style: italic;" > baseModule< / span >
will generate the save comands for you.< br >
< br >
2004-11-01 16:53:58 +00:00
When all modules report that they are ready for LDAP add/modify and the
user clicks on the add/modify button your module will be asked what
changes have to be made.< br >
2006-02-01 19:12:31 +00:00
This is done in the function < span style = "font-weight: bold;" > save_attributes()< / span > .< br >
2004-11-01 13:56:54 +00:00
< br >
2006-08-16 17:42:35 +00:00
< span style = "font-weight: bold; text-decoration: underline;" > Example:< / span > < br style = "font-weight: bold; text-decoration: underline;" >
2004-11-01 13:56:54 +00:00
< br >
2006-02-01 19:12:31 +00:00
The < span style = "font-style: italic;" > kolabUser< / span > module uses
this function to make sure that its object class is saved. Other
modules (e.g. quota) use it build the lamdaemon commands.< br >
2004-11-01 13:56:54 +00:00
< br >
2006-08-16 17:42:35 +00:00
< table style = "width: 100%; text-align: left;" class = "mod-code" border = "0" cellpadding = "2" cellspacing = "2" >
2004-11-01 13:56:54 +00:00
< tbody >
< tr >
2004-11-01 16:53:58 +00:00
< td style = "vertical-align: top;" > /**< br >
* Returns a list of modifications which have to be
made to the LDAP account.< br >
*< br >
* @return array list of modifications< br >
* < br> This function returns an array with 3
entries:< br >
* < br> array( DN1 ('add' => array($attr),
'remove' => array($attr), 'modify' => array($attr)), DN2 .... )< br >
* < br> DN is the DN to change. It may be
possible to change several DNs (e.g. create a new user and add him to
some groups via attribute memberUid)< br >
* < br> "add" are attributes which have to be
added to LDAP entry< br >
* < br> " remove" are attributes which have to be
removed from LDAP entry< br >
* < br> "modify" are attributes which have to
been modified in LDAP entry< br >
*/< br >
2006-02-01 19:12:31 +00:00
function save_attributes() {< br >
// add object class if needed< br >
if
(!isset($this-> attributes['objectClass']) ||
!in_array('kolabInetOrgPerson', $this-> attributes['objectClass'])) {< br >
$this-> attributes['objectClass'][] = 'kolabInetOrgPerson';< br >
}< br >
return parent::save_attributes();< br >
2004-11-01 16:53:58 +00:00
}< br >
2004-11-01 13:56:54 +00:00
< / td >
< / tr >
< / tbody >
< / table >
< br >
< br >
< span style = "font-weight: bold;" > < / span >
< h2 > < span style = "font-weight: bold;" > < / span > < / h2 >
< / div >
< / div >
2006-08-16 17:42:35 +00:00
< / body > < / html >
