510 lines
19 KiB
PHP
510 lines
19 KiB
PHP
<?php
|
|
/*
|
|
$Id$
|
|
|
|
This code is part of LDAP Account Manager (http://www.sourceforge.net/projects/lam)
|
|
Copyright (C) 2003 - 2004 Roland Gruber
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
|
|
*/
|
|
|
|
/**
|
|
* This is the parent class for all account modules.
|
|
*
|
|
* It implements the complete module interface and uses meta-data
|
|
* provided by the account modules for its functions.
|
|
*
|
|
* @package modules
|
|
* @author Roland Gruber
|
|
*/
|
|
|
|
/**
|
|
* Parent class of all account modules
|
|
*
|
|
* @package modules
|
|
*/
|
|
class baseModule {
|
|
|
|
/** includes all meta data provided by the sub class */
|
|
var $meta;
|
|
|
|
/** the account type of this module (user, group, host) */
|
|
var $scope;
|
|
|
|
/** configuration settings of all modules */
|
|
var $moduleSettings;
|
|
|
|
/** name of parent accountContainer ($_SESSION[$base]) */
|
|
var $base;
|
|
|
|
/** contains all ldap attributes which should be written */
|
|
var $attributes;
|
|
|
|
/** contains all ldap attributes which are loaded from ldap */
|
|
var $orig;
|
|
|
|
/** contains all error messages wich were triggered*/
|
|
var $errors;
|
|
|
|
/** contains all error messages of a module */
|
|
var $messages;
|
|
|
|
/**
|
|
* Creates a new base module class
|
|
*
|
|
* @param string $scope the account type (user, group, host)
|
|
*/
|
|
function baseModule($scope) {
|
|
$this->scope = $scope;
|
|
$this->load_Messages();
|
|
$this->meta = $this->get_metaData();
|
|
if (isset($_SESSION['config'])) $this->moduleSettings = $_SESSION['config']->get_moduleSettings();
|
|
}
|
|
|
|
/**
|
|
* This function fills the $messages variable with output messages from this module.
|
|
*/
|
|
function load_Messages() {
|
|
}
|
|
|
|
/**
|
|
* Initializes the module after it became part of an accountContainer
|
|
*
|
|
* @param string $base the name of the accountContainer object ($_SESSION[$base])
|
|
*/
|
|
function init($base) {
|
|
$this->base = $base;
|
|
// Create Arrays with ldap attributes
|
|
$this->attributes =& $_SESSION[$this->base]->get_module_attributes(get_class($this));
|
|
$this->orig =& $_SESSION[$this->base]->get_module_attributes(get_class($this), true);
|
|
$line=-1;
|
|
for ($i=0; $i<count($_SESSION['ldap']->objectClasses) || $i==-1; $i++) {
|
|
if (strpos(strtolower($_SESSION['ldap']->objectClasses[$i]), strtolower("NAME '".get_class($this)."'"))) $line = $i;
|
|
}
|
|
$objectClassName = substr($_SESSION['ldap']->objectClasses[$line], 6+strpos($_SESSION['ldap']->objectClasses[$line], "NAME '"), strlen(get_class($this)) );
|
|
$this->attributes['objectClass'][0] = $objectClassName;
|
|
}
|
|
|
|
|
|
/* This function loads all standard ldap attributes. It is used
|
|
* by the modules to reduce code
|
|
*/
|
|
function load_ldap_attributes($attr) {
|
|
// Load attributes which are displayed
|
|
$objectClassName = $this->attributes['objectClass'];
|
|
// unset count entries
|
|
unset ($attr['count']);
|
|
$attributes = array_keys($attr);
|
|
foreach ($attributes as $attribute) unset ($attr[$attribute]['count']);
|
|
// unset double entries
|
|
for ($i=0; $i<count($attr); $i++)
|
|
if (isset($attr[$i])) unset($attr[$i]);
|
|
foreach ($attributes as $attribute) {
|
|
if (isset($this->attributes[$attribute])) {
|
|
// decode as unicode
|
|
$this->attributes[$attribute] = $attr[$attribute];
|
|
$this->orig[$attribute] = $attr[$attribute];
|
|
}
|
|
}
|
|
$this->attributes['objectClass'] = $objectClassName;
|
|
if (in_array($objectClassName[0], $attr['objectClass']))
|
|
$this->orig['objectClass'] = $objectClassName;
|
|
else $this->orig['objectClass'] = array();
|
|
}
|
|
|
|
/**
|
|
* Dummy function, meta data is provided by sub classes.
|
|
*
|
|
* @return array empty array
|
|
*/
|
|
function get_metaData() {
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Returns the account type of this module (user, group, host)
|
|
*
|
|
* @return string account type
|
|
*/
|
|
function get_scope() {
|
|
return $this->scope;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this module fits for the current scope.
|
|
*
|
|
* @return boolean true if module fits
|
|
*/
|
|
function can_manage() {
|
|
if (is_array($this->meta["account_types"]) && in_array($this->scope, $this->meta["account_types"])) return true;
|
|
else return false;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this module is enough to provide a sensible account.
|
|
*
|
|
* There is no relation to the name of this class.
|
|
*
|
|
* @return boolean true if base module
|
|
*/
|
|
function is_base_module() {
|
|
if ($this->meta['is_base'] == true) return true;
|
|
else return false;
|
|
}
|
|
|
|
/**
|
|
* returns an LDAP filter for the account lists
|
|
*
|
|
* @return string LDAP filter
|
|
*/
|
|
function get_ldap_filter() {
|
|
if (isset($this->meta['ldap_filter'])) return $this->meta['ldap_filter'];
|
|
else return "";
|
|
}
|
|
|
|
/**
|
|
* Returns an alias name for the module.
|
|
*
|
|
* This alias is used in various places instead of the less descriptive class name.
|
|
* The alias also has less syntax restrictions and may contain spaces or special characters.
|
|
*
|
|
* @return string alias name
|
|
*/
|
|
function get_alias() {
|
|
if (isset($this->meta['alias'])) return $this->meta['alias'];
|
|
else return get_class($this);
|
|
}
|
|
|
|
/**
|
|
* Returns a list of possible LDAP attributes which can be used to form the RDN.
|
|
*
|
|
* The returned elements have this form: <attribute> => <priority>
|
|
* <br> <attribute> is the name of the LDAP attribute
|
|
* <br> <priority> defines the priority of the attribute (can be "low", "normal", "high")
|
|
*
|
|
* @return array list of attributes
|
|
*/
|
|
function get_RDNAttributes() {
|
|
if (isset($this->meta['RDN'])) return $this->meta['RDN'];
|
|
else return array();
|
|
}
|
|
|
|
/**
|
|
* This function returns a list with all depending and conflicting modules.
|
|
*
|
|
* @return array list of dependencies and conflicts
|
|
*/
|
|
function get_dependencies() {
|
|
if (isset($this->meta['dependencies'])) return $this->meta['dependencies'];
|
|
else return array('depends' => array(), 'conflicts' => array());
|
|
}
|
|
|
|
/**
|
|
* Returns a list of elements for the account profiles.
|
|
*
|
|
* @return profile elements
|
|
*/
|
|
function get_profileOptions() {
|
|
if (isset($this->meta['profile_options'])) return $this->meta['profile_options'];
|
|
else return array();
|
|
}
|
|
|
|
/**
|
|
* Checks input values of account profiles.
|
|
*
|
|
* @param array $options a hash array (name => value) containing the options
|
|
* @return array list of error messages (array(type, title, text)) to generate StatusMessages, if any
|
|
*/
|
|
function check_profileOptions($options) {
|
|
$messages = array();
|
|
if (is_array($this->meta['profile_checks'])) {
|
|
$identifiers = array_keys($this->meta['profile_checks']);
|
|
for ($i = 0; $i < sizeof($identifiers); $i++) {
|
|
// check if option is required
|
|
if ($this->meta['profile_checks'][$identifiers[$i]]['required'] && ($options[$identifiers[$i]][0] == '')) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['required_message'];
|
|
}
|
|
switch ($this->meta['profile_checks'][$identifiers[$i]]['type']) {
|
|
// check by regular expression (from account.inc)
|
|
case "ext_preg":
|
|
// ignore empty fileds
|
|
if ($options[$identifiers[$i]][0] == '') continue;
|
|
if (! get_preg($options[$identifiers[$i]][0], $this->meta['profile_checks'][$identifiers[$i]]['regex'])) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by regular expression (case insensitive)
|
|
case 'regex_i':
|
|
// ignore empty fileds
|
|
if ($options[$identifiers[$i]][0] == '') continue;
|
|
if (! eregi($this->meta['profile_checks'][$identifiers[$i]]['regex'], $options[$identifiers[$i]][0])) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by regular expression (case sensitive)
|
|
case 'regex':
|
|
// ignore empty fileds
|
|
if ($options[$identifiers[$i]][0] == '') continue;
|
|
if (! ereg($this->meta['profile_checks'][$identifiers[$i]]['regex'], $options[$identifiers[$i]][0])) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by integer comparison (greater)
|
|
case 'int_greater':
|
|
// ignore if both fields are empty
|
|
if (($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name1']][0] == '') && ($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name2']][0] == '')) continue;
|
|
// print error message if only one field is empty
|
|
if (($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name1']][0] == '') || ($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name2']][0] == '')) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
continue;
|
|
}
|
|
// compare
|
|
if (!(intval($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name1']][0]) > intval($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name2']][0]))) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by integer comparison (greater or equal)
|
|
case 'int_greaterOrEqual':
|
|
// ignore if both fields are empty
|
|
if (($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name1']][0] == '') && ($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name2']][0] == '')) continue;
|
|
// print error message if only one field is empty
|
|
if (($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name1']][0] == '') || ($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name2']][0] == '')) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
continue;
|
|
}
|
|
// compare
|
|
if (!(intval($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name1']][0]) >= intval($options[$this->meta['profile_checks'][$identifiers[$i]]['cmp_name2']][0]))) {
|
|
$messages[] = $this->meta['profile_checks'][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// print error message for invalid types
|
|
default:
|
|
StatusMessage("ERROR", "Unsupported type!", $this->meta['profile_checks'][$identifiers[$i]]['type']);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
return $messages;
|
|
}
|
|
|
|
/**
|
|
* Returns a list of elements for the configuration.
|
|
*
|
|
* @param array $scopes account types (user, group, host)
|
|
* @return array configuration elements
|
|
*/
|
|
function get_configOptions($scopes) {
|
|
$return = array();
|
|
for ($i = 0; $i < sizeof($scopes); $i++) {
|
|
if (isset($this->meta['config_options'][$scopes[$i]])) $return = array_merge($return, $this->meta['config_options'][$scopes[$i]]);
|
|
}
|
|
if (isset($this->meta['config_options']['all'])) $return = array_merge($return, $this->meta['config_options']['all']);
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Returns an array containing descriptions shown on configuration pages.
|
|
*
|
|
* The returned array has the format array('legend' => '...', descriptions => array('option1' => '...', ...)).
|
|
* <br> The "legend" value is used as text for the fieldset, the descriptions are used when the configuration is printed.
|
|
*
|
|
* @return array configuration elements
|
|
*/
|
|
function get_configDescriptions() {
|
|
$return = array('legend' => 'no description', 'descriptions' => array());
|
|
if (isset($this->meta['config_descriptions'])) $return = $this->meta['config_descriptions'];
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Checks input values of module settings.
|
|
*
|
|
* @param array $scopes list of account types which are used
|
|
* @param array $options hash array containing the settings (array('option' => array('value')))
|
|
* @return array list of error messages
|
|
*/
|
|
function check_configOptions($scopes, $options) {
|
|
$messages = array();
|
|
$scopes[] = 'all'; // add checks that are independent of scope
|
|
for ($s = 0; $s < sizeof($scopes); $s++) {
|
|
if (is_array($this->meta['config_checks'][$scopes[$s]])) {
|
|
$identifiers = array_keys($this->meta['config_checks'][$scopes[$s]]);
|
|
for ($i = 0; $i < sizeof($identifiers); $i++) {
|
|
// check if option is required
|
|
if ($this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['required'] && ($options[$identifiers[$i]][0] == '')) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['required_message'];
|
|
}
|
|
switch ($this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['type']) {
|
|
// check by regular expression (from account.inc)
|
|
case "ext_preg":
|
|
// ignore empty fileds
|
|
if ($options[$identifiers[$i]][0] == '') continue;
|
|
if (! get_preg($options[$identifiers[$i]][0], $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['regex'])) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by regular expression (case insensitive)
|
|
case "regex_i":
|
|
// ignore empty fileds
|
|
if ($options[$identifiers[$i]][0] == '') continue;
|
|
if (! eregi($this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['regex'], $options[$identifiers[$i]][0])) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by regular expression (case sensitive)
|
|
case "regex":
|
|
// ignore empty fileds
|
|
if ($options[$identifiers[$i]][0] == '') continue;
|
|
if (! ereg($this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['regex'], $options[$identifiers[$i]][0])) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by integer comparison (greater)
|
|
case "int_greater":
|
|
// ignore if both fields are empty
|
|
if (($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name1']][0] == '') && ($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name2']][0] == '')) continue;
|
|
// print error message if only one field is empty
|
|
if (($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name1']][0] == '') || ($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name2']][0] == '')) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
continue;
|
|
}
|
|
// compare
|
|
if (!(intval($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name1']][0]) > intval($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name2']][0]))) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// check by integer comparison (greater or equal)
|
|
case "int_greaterOrEqual":
|
|
// ignore if both fields are empty
|
|
if (($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name1']][0] == '') && ($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name2']][0] == '')) continue;
|
|
// print error message if only one field is empty
|
|
if (($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name1']][0] == '') || ($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name2']][0] == '')) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
continue;
|
|
}
|
|
// compare
|
|
if (!(intval($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name1']][0]) >= intval($options[$this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['cmp_name2']][0]))) {
|
|
$messages[] = $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['error_message'];
|
|
}
|
|
break;
|
|
// print error message on undefined type
|
|
default:
|
|
StatusMessage("ERROR", "Unsupported type!", $this->meta['config_checks'][$scopes[$s]][$identifiers[$i]]['type']);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $messages;
|
|
}
|
|
|
|
/**
|
|
* Returns an array with all fields available for this account type on the PDF
|
|
* output. This method may be overwritten by subclasses or it may be used
|
|
* by using entries in the $this->meta['PDF_fields'] array of the specific sub-
|
|
* class.
|
|
*
|
|
* @param string $scope account type
|
|
* @return array list of available fields for PDF output
|
|
*/
|
|
function get_pdfFields($scope = 'user') {
|
|
return ((isset($this->meta['PDF_fields'])) ? $this->meta['PDF_fields'] : array());
|
|
}
|
|
|
|
/**
|
|
* Returns a hastable with all entries that may be printed out in the PDF. The
|
|
* syntax of the hashtable is specified by the module specification and the
|
|
* corresponding DTD. This method must be overwritten in case that there
|
|
* are non static things to be returned. The $this->meta['PDF_entries'] array
|
|
* may be used when there is only static content.
|
|
*
|
|
* @param string $scope account type
|
|
* @return array hastable of entries for the PDF. Each entry is an array where
|
|
* each entry is treated as a new line in the PDF.
|
|
*/
|
|
function get_pdf_entries($scope = 'user') {
|
|
return ((isset($this->meta['PDF_entries'])) ? $this->meta['PDF_entries'] : array());
|
|
}
|
|
|
|
/**
|
|
* Returns an array containing all input columns for the file upload.
|
|
*
|
|
* Syntax:
|
|
* <br> array(
|
|
* <br> string: name, // fixed non-translated name which is used as column name (should be of format: <module name>_<column name>)
|
|
* <br> string: description, // short descriptive name
|
|
* <br> string: help, // help ID
|
|
* <br> string: example, // example value
|
|
* <br> boolean: required // true, if user must set a value for this column
|
|
* <br> )
|
|
*
|
|
* @return array column list
|
|
*/
|
|
function get_uploadColumns() {
|
|
if (isset($this->meta['upload_columns'])) return $this->meta['upload_columns'];
|
|
else return array();
|
|
}
|
|
|
|
/**
|
|
* Returns a list of module names which must be processed in building the account befor this module.
|
|
*
|
|
* @return array list of module names
|
|
*/
|
|
function get_uploadPreDepends() {
|
|
if (isset($this->meta['upload_preDepends'])) return $this->meta['upload_preDepends'];
|
|
else return array();
|
|
}
|
|
|
|
/**
|
|
* In this function the LDAP account is built up.
|
|
*
|
|
* @param array $rawAccounts list of hash arrays (name => value) from user input
|
|
* @param array $partialAccounts list of hash arrays (name => value) which are later added to LDAP
|
|
* @param array $ids list of IDs for column position (e.g. "posixAccount_uid" => 5)
|
|
* @return array list of error messages if any
|
|
*/
|
|
function build_uploadAccounts($rawAccounts, $ids, &$partialAccounts) {
|
|
// must be implemented in sub modules
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* This function return the help entry array for a specific help id. Normally this->meta can be used.
|
|
*
|
|
* @param string $id The id string for the help entry needed.
|
|
* @param string $scope The scope for which the help entry should be retrieved. May be empty when
|
|
* there is now difference of the help entry depending on the actual scope.
|
|
*
|
|
* @return array The desired help entry.
|
|
*/
|
|
function get_help($id,$scope) {
|
|
if(isset($this->meta['help'][$id])) {
|
|
return $this->meta['help'][$id];
|
|
}
|
|
elseif(isset($this->meta['help'][$scope][$id])) {
|
|
return $this->meta['help'][$scope][$id];
|
|
}
|
|
else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
?>
|