read()) if ((substr($entry, strlen($entry) - 4, 4) == '.inc') && is_file($modulesINC_dirname . '/'.$entry)) { include_once($modulesINC_dirname . '/'.$entry); } /** * Returns the alias name of a module * * @param string $name the module name * @param string $scope the account type ("user", "group", "host") * @return string alias name */ function getModuleAlias($name, $scope) { $module = new $name($scope); return $module->get_alias(); } /** * Returns true if the module is a base module * * @param string $name the module name * @param string $scope the account type ("user", "group", "host") * @return boolean true if base module */ function is_base_module($name, $scope) { $module = new $name($scope); return $module->is_base_module(); } /** * Returns the LDAP filter used by the account lists * * @param string $scope the account type ("user", "group", "host") * @return string LDAP filter */ function get_ldap_filter($scope) { $mods = $_SESSION['config']->get_AccountModules($scope); $filters = array(); $orFilter = ''; for ($i = 0; $i < sizeof($mods); $i++) { $module = new $mods[$i]($scope); $modinfo = $module->get_ldap_filter(); if (isset($modinfo['or'])) $filters['or'][] = $modinfo['or']; if (isset($modinfo['and'])) $filters['and'][] = $modinfo['and']; } // build OR filter if (sizeof($filters['or']) == 1) { $orFilter = $filters['or'][0]; } elseif (sizeof($filters['or']) > 1) { $orFilter = "(|" . implode("", $filters['or']) . ")"; } // add built OR filter to AND filters if ($orFilter != '') $filters['and'][] = $orFilter; // collapse AND filters if (sizeof($filters['and']) < 2) return $filters['and'][0]; else return "(&" . implode("", $filters['and']) . ")"; } /** * Returns a list of LDAP attributes which can be used to form the RDN. * * The list is already sorted by the priority given by the nodules. * * @param string $scope account type (user, group, host) * @return array list of LDAP attributes */ function getRDNAttributes($scope) { $mods = $_SESSION['config']->get_AccountModules($scope); $return = array(); $attrs_low = array(); $attrs_normal = array(); $attrs_high = array(); for ($i = 0; $i < sizeof($mods); $i++) { // get list of attributes $module = new $mods[$i]($scope); $attrs = $module->get_RDNAttributes(); $keys = array_keys($attrs); // sort attributes for ($k = 0; $k < sizeof($keys); $k++) { switch ($attrs[$keys[$k]]) { case "low": $attrs_low[] = $keys[$k]; break; case "normal": $attrs_normal[] = $keys[$k]; break; case "high": $attrs_high[] = $keys[$k]; break; default: $attrs_low[] = $keys[$k]; break; } } } // merge arrays $return = array_values(array_unique($attrs_high)); for ($i = 0; $i < sizeof($attrs_normal); $i++) { if (!in_array($attrs_normal[$i], $return)) $return[] = $attrs_normal[$i]; } for ($i = 0; $i < sizeof($attrs_low); $i++) { if (!in_array($attrs_low[$i], $return)) $return[] = $attrs_low[$i]; } return $return; } /** * Returns a hash array (module name => dependencies) of all module dependencies * * "dependencies" contains an array with two sub arrays: depends, conflicts *
The elements of "depends" are either module names or an array of module names (OR-case). *
The elements of conflicts are module names. * * @param string $scope the account type (user, group, host) * @return array dependencies */ function getModulesDependencies($scope) { $mods = getAvailableModules($scope); for ($i = 0; $i < sizeof($mods); $i++) { $module = new $mods[$i]($scope); $return[$mods[$i]] = $module->get_dependencies(); } return $return; } /** * Checks if there are missing dependencies between modules. * * @param array $selected selected module names * @param array $deps module dependencies * @return mixed false if no misssing dependency was found, * otherwise an array of array(selected module, depending module) if missing dependencies were found */ function check_module_depends($selected, $deps) { $ret = array(); for ($m = 0; $m < sizeof($selected); $m++) { // check selected modules for ($i = 0; $i < sizeof($deps[$selected[$m]]['depends']); $i++) { // check dependencies of module // check if we have OR-combined modules if (is_array($deps[$selected[$m]]['depends'][$i])) { // one of the elements is needed $found = false; $depends = $deps[$selected[$m]]['depends'][$i]; for ($d = 0; $d < sizeof($depends); $d++) { if (in_array($depends[$d], $selected)) { $found = true; break; } } if (! $found) { // missing dependency, add to return value $ret[] = array($selected[$m], implode(" || ", $depends)); } } else { // single dependency if (! in_array($deps[$selected[$m]]['depends'][$i], $selected)) { // missing dependency, add to return value $ret[] = array($selected[$m], $deps[$selected[$m]]['depends'][$i]); } } } } if (sizeof($ret) > 0) return $ret; else return false; } /** * Checks if there are conflicts between modules * * @param array $selected selected module names * @param array $deps module dependencies * @return boolean false if no conflict was found, * otherwise an array of array(selected module, conflicting module) if conflicts were found */ function check_module_conflicts($selected, $deps) { $ret = array(); for ($m = 0; $m < sizeof($selected); $m++) { for ($i = 0; $i < sizeof($deps[$selected[$m]]['conflicts']); $i++) { if (in_array($deps[$selected[$m]]['conflicts'][$i], $selected)) { $ret[] = array($selected[$m], $deps[$selected[$m]]['conflicts'][$i]); } } } if (sizeof($ret) > 0) return $ret; else return false; } /** * Returns an array with all available user module names * * @param string $scope account type (user, group, host) * @return array list of possible modules */ function getAvailableModules($scope) { $dirname = substr(__FILE__, 0, strlen(__FILE__) - 12) . "/modules"; $dir = dir($dirname); $return = array(); // get module names. while ($entry = $dir->read()) if ((substr($entry, strlen($entry) - 4, 4) == '.inc') && is_file($dirname . '/'.$entry)) { $entry = substr($entry, 0, strpos($entry, '.')); $temp = new $entry($scope); if ($temp->can_manage()) $return[] = $entry; } return $return; } /** * Returns the elements for the profile page. * * @param string $scope account type (user, group, host) * @return array profile elements */ function getProfileOptions($scope) { $mods = $_SESSION['config']->get_AccountModules($scope); $return = array(); for ($i = 0; $i < sizeof($mods); $i++) { $module = new $mods[$i]($scope); $return[$mods[$i]] = $module->get_profileOptions(); } return $return; } /** * Checks if the profile options are valid * * @param string $scope account type (user, group, host) * @param array $options hash array containing all options (name => array(...)) * @return array list of error messages */ function checkProfileOptions($scope, $options) { $mods = $_SESSION['config']->get_AccountModules($scope); $return = array(); for ($i = 0; $i < sizeof($mods); $i++) { $module = new $mods[$i]($scope); $temp = $module->check_profileOptions($options); $return = array_merge($return, $temp); } return $return; } /** * Returns a hash array (module name => elements) of all module options for the configuration page. * * @param array $scopes hash array (module name => array(account types)) * @return array configuration options */ function getConfigOptions($scopes) { $return = array(); $modules = array_keys($scopes); for ($i = 0; $i < sizeof($modules); $i++) { $m = new $modules[$i]('none'); $return[$modules[$i]] = $m->get_configOptions($scopes[$modules[$i]], $scopes); } return $return; } /** * Checks if the configuration options are valid * * @param array $scopes hash array (module name => array(account types)) * @param array $options hash array containing all options (name => array(...)) * @return array list of error messages */ function checkConfigOptions($scopes, $options) { $return = array(); $modules = array_keys($scopes); for ($i = 0; $i < sizeof($modules); $i++) { $m = new $modules[$i]('none'); $errors = $m->check_configOptions($scopes[$modules[$i]], $options); if (isset($errors) && is_array($errors)) { $return = array_merge($return, $errors); } } return $return; } /** * Returns a help entry from an account module. * * @param string $helpID help identifier * @param string $module module name * @return array help entry */ function getHelp($module,$helpID,$scope='') { if (!isset($module) || ($module == '') || ($module == 'main')) { $helpPath = "../help/help.inc"; if (is_file("../../help/help.inc")) $helpPath = "../../help/help.inc"; if (!isset($helpArray)) { include($helpPath); } return $helpArray[$helpID]; } $moduleObject = new $module((($scope != '') ? $scope : 'none')); return $moduleObject->get_help($helpID); } /** * Returns a list of available PDF entries. * * @param string $scope account type (user, group, host) * @return array PDF entries */ function getAvailablePDFFields($scope) { $mods = $_SESSION['config']->get_AccountModules($scope); $return = array(); for ($i = 0; $i < sizeof($mods); $i++) { $module = new $mods[$i]($scope); $return[$mods[$i]] = $module->get_pdfFields(); } $return['main'] = array('dn'); return $return; } /** * Returns an array containing all input columns for the file upload. * * Syntax: *
array( *
string: name, // fixed non-translated name which is used as column name (should be of format: _) *
string: description, // short descriptive name *
string: help, // help ID *
string: example, // example value *
boolean: required // true, if user must set a value for this column *
) * * @param string $scope account type * @return array column list */ function getUploadColumns($scope) { $mods = $_SESSION['config']->get_AccountModules($scope); $return = array(); for ($i = 0; $i < sizeof($mods); $i++) { $module = new $mods[$i]($scope); $return[$mods[$i]] = $module->get_uploadColumns(); } return $return; } /** * This function builds the LDAP accounts for the file upload. * * If there are problems status messages will be printed automatically. * * @param string $scope account type * @param array $data array containing one account in each element * @param array $ids array( => ) * @return mixed array including accounts or false if there were errors */ function buildUploadAccounts($scope, $data, $ids) { // build module order $unOrdered = $_SESSION['config']->get_AccountModules($scope); $ordered = array(); $predepends = array(); // get dependencies for ($i = 0; $i < sizeof($unOrdered); $i++) { $mod = new $unOrdered[$i]($scope); $predepends[$unOrdered[$i]] = $mod->get_uploadPreDepends(); } // first all modules without predepends can be ordered for ($i = 0; $i < sizeof($unOrdered); $i++) { if (sizeof($predepends[$unOrdered[$i]]) == 0) { $ordered[] = $unOrdered[$i]; unset($unOrdered[$i]); $unOrdered = array_values($unOrdered); $i--; } } $unOrdered = array_values($unOrdered); // fix indexes // now add all modules with fulfilled dependencies until all are in order while (sizeof($unOrdered) > 0) { $newRound = false; for ($i = 0; $i < sizeof($unOrdered); $i++) { $deps = $predepends[$unOrdered[$i]]; $depends = false; for ($d = 0; $d < sizeof($deps); $d++) { if (in_array($deps[$d], $unOrdered)) { $depends = true; break; } } if (!$depends) { // add to order if dependencies are fulfilled $ordered[] = $unOrdered[$i]; unset($unOrdered[$i]); $unOrdered = array_values($unOrdered); $newRound = true; break; } } if ($newRound) continue; // this point should never be reached, LAM was unable to find a correct module order StatusMessage("ERROR", "Internal Error: Unable to find correct module order.", ""); return false; } // give raw data to modules $errors = array(); $partialAccounts = array(); for ($i = 0; $i < sizeof($data); $i++) $partialAccounts[$i]['objectClass'] = array(); for ($i = 0; $i < sizeof($ordered); $i++) { $module = new $ordered[$i]($scope); $errors = $module->build_uploadAccounts($data, $ids, $partialAccounts); if (sizeof($errors) > 0) { array_unshift($errors, array("INFO", _("Displayed account numbers start at \"0\". Add 2 to get the row in your spreadsheet."), "")); $errors[] = array("ERROR", _("Upload was stopped after errors in %s module!"), "", array($module->get_alias())); break; } } if (sizeof($errors) > 0) { for ($i = 0; (($i < sizeof($errors)) || ($i > 49)); $i++) call_user_func_array("StatusMessage", $errors[$i]); return false; } else return $partialAccounts; } /** * This function executes one post upload action. * * @param string $scope account type * @param array $data array containing one account in each element * @param array $ids array( => ) * @param array $failed list of accounts which were not created successfully * @return array current status *
array ( *
'status' => 'finished' | 'inProgress' *
'module' => *
'progress' => 0..100 *
'errors' => array () *
) */ function doUploadPostActions($scope, $data, $ids, $failed) { // check if function is called the first time if (! isset($_SESSION['mass_postActions']['remainingModules'])) { // make list of remaining modules $moduleList = $_SESSION['config']->get_AccountModules($scope); $_SESSION['mass_postActions']['remainingModules'] = $moduleList; } $activeModule = $_SESSION['mass_postActions']['remainingModules'][0]; // initialize temporary variable if (!isset($_SESSION['mass_postActions'][$activeModule])) { $_SESSION['mass_postActions'][$activeModule] = array(); } // let first module do one post action $module = new $activeModule($scope); $return = $module->doUploadPostActions($data, $ids, $failed, $_SESSION['mass_postActions'][$activeModule]); // remove active module from list if already finished if ($return['status'] == 'finished') { unset($_SESSION['mass_postActions']['remainingModules'][0]); $_SESSION['mass_postActions']['remainingModules'] = array_values($_SESSION['mass_postActions']['remainingModules']); } // update status and return back to upload page $return['module'] = $activeModule; if (sizeof($_SESSION['mass_postActions']['remainingModules']) > 0) { $return['status'] = 'inProgress'; } else { $return['status'] = 'finished'; } return $return; } /** * Returns true if the module is a base module * * @return array required extensions */ function getRequiredExtensions() { $extList = array(); $scopes = $_SESSION['config']->get_ActiveTypes(); for ($i = 0; $i < sizeof($scopes); $i++) { $mods = $_SESSION['config']->get_AccountModules($scopes[$i]); for ($m = 0; $m < sizeof($mods); $m++) { $module = new $mods[$m]($scopes[$i]); $ext = $module->getRequiredExtensions(); for ($e = 0; $e < sizeof($ext); $e++) { if (!in_array($ext[$e], $extList)) $extList[] = $ext[$e]; } } } return $extList; } /** * Takes a list of meta-HTML elements and prints the equivalent HTML output. * * The modules are not allowed to display HTML code directly but return * meta HTML code. This allows to have a common design for all module pages.
*
* Meta HTML code is always returned as a three dimensional array[a][b][c] * where a is the row number, b is the column number and c is * is a data element.
*
* Format of data elements:
*
* A data element is an array which contains the data to display.
* All data elements must contail a value "kind" which * defines what kind of element should be displayed.
*
* These are the possibilies for kind and what other options have to be added to the array:
*
*
    *
  • fieldset: Inserts a fieldset. *
      *
    • legend: The legend of the fieldset.
    • *
    • value: A data element. Can be used recursively.
    • *
    *
  • *
  • help: Adds a help link. *
      *
    • value: The help number for the help entry.
    • *
    • scope: The account type for the help entry.
      *
    • *
    *
  • *
  • input: Adds a HTML input element. *
      *
    • name: The name of the element, will be used later as variable name * when user input is returned.
    • *
    • type: allowed values: submit, reset, checkbox, text, password, file, hidden
    • *
    • checked: Boolean value, if true a checkbox will be checked. This * value is only needed or checkboxes.
    • *
    • disabled: Boolean value, if true the element will be disabled.
    • *
    • size: The length of the input element, only used for text, password and file.
    • *
    • maxlength: The maximum size of the input element, only used for * text, password and file.
    • *
    • value: The element will have this value as default. Button elements will have * this as caption.
    • *
    • title: Title value for input element (optional).
    • *
    • image: This is used to display image buttons. File name of an 16x16px image in the graphics folder * (e.g. add.png). You may only use this for submit buttons.
    • *
    *
  • *
  • select: This will add a select field. *
      *
    • name: The name of the element, will be used later as variable name when user input is * returned.
    • *
    • multiple: Boolean value, if set to true the user can select more than one entry.
    • *
    • options: Array of string. This is the list of option values the user can select.
    • *
    • options_selected: Array of string. This is the list of pre selected elements, must contain * values that are also in options.
    • *
    • descriptiveOptions: * Boolean value, if set to true then all elements in options must be arrays themselves (array(value, *description)) (default: false)
      *
    • *
    • size: The size of the select field, if set to 1 a dropdown box will be displayed.
    • *
    • noSorting: If set to true then the entries will not be sorted. Default is false.
    • *
    • onchange: onchange event
      *
    • *
    *
  • *
  • table: Adds a table. Can be used recursively. *
      *
    • value: A data element. Can be used recursively.
    • *
    *
  • *
  • text: Inserts a text element. *
      *
    • text: The text to display.
    • *
    *
  • *
  • textarea: Adds a multiline text field. *
      *
    • name: The name of the element, will be used later as variable name when user * input is returned.
    • *
    • rows: Number of rows (required)
      *
    • *
    • cols: Number of characters for each line (required)
      *
    • *
    • readonly: Boolean value, if true the text field will be read only.
      *
    • *
    *
  • *
  • image: Displays an image. *
      *
    • path: Path to the image
    • *
    • width: Width of the image
    • *
    • height: Height of the image
    • *
    • alt: Alt text of the image
      *
    • *
    *
  • *
*
* Beneath those values a "td" value may be added. This has to be an array with one or more * of these options:
*
*
    *
  • colspan: Like the HTML colspan attribute for td elements
  • *
  • rowspan: Like the HTML rowspan attribute for td elements
  • *
  • align: left/center/right/justify Like the HTML align attribute
  • *
  • valign: top/middle/bottom Like the HTML valign attribute
  • *
  • width: Like the HTML height attribute for td elements
  • *
*
* Input buttons which should load a different subpage of a module must have a special name attribute:
*
* name => 'form_subpage_' . . '_' . . '_' .