304 lines
11 KiB
PHP
304 lines
11 KiB
PHP
<?php
|
|
/*
|
|
$Id$
|
|
|
|
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
|
Copyright (C) 2003 - 2006 Tilo Lutz
|
|
2005 - 2014 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
|
|
*/
|
|
|
|
/**
|
|
* Manages the object class "account" for users and hosts.
|
|
*
|
|
* @package modules
|
|
*
|
|
* @author Tilo Lutz
|
|
* @author Roland Gruber
|
|
* @author Michael Duergner
|
|
*/
|
|
|
|
/**
|
|
* Manages the object class "account" for users and hosts.
|
|
*
|
|
* @package modules
|
|
*/
|
|
class account extends baseModule {
|
|
|
|
/**
|
|
* Returns true if this module can manage accounts of the current type, otherwise false.
|
|
*
|
|
* @return boolean true if module fits
|
|
*/
|
|
public function can_manage() {
|
|
return in_array($this->get_scope(), array("host", "user"));
|
|
}
|
|
|
|
/**
|
|
* Returns meta data that is interpreted by parent class
|
|
*
|
|
* @return array array with meta data
|
|
*
|
|
* @see baseModule::get_metaData()
|
|
*/
|
|
function get_metaData() {
|
|
if (isset($_SESSION['loggedIn']) && ($_SESSION['loggedIn'] === true)) {
|
|
$modules = $_SESSION['config']->get_AccountModules($this->get_scope());
|
|
}
|
|
$return = array();
|
|
// icon
|
|
$return['icon'] = 'uid.png';
|
|
// alias name
|
|
$return["alias"] = _('Account');
|
|
// this is a base module
|
|
$return["is_base"] = true;
|
|
// LDAP filter
|
|
$return["ldap_filter"] = array('or' => "(objectClass=account)");
|
|
// RDN attribute
|
|
$return["RDN"] = array("uid" => "low");
|
|
// module dependencies
|
|
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
|
|
// managed object classes
|
|
$return['objectClasses'] = array('account');
|
|
// LDAP aliases
|
|
$return['LDAPaliases'] = array('userid' => 'uid');
|
|
// managed attributes
|
|
$return['attributes'] = array('uid', 'description');
|
|
// available PDF fields
|
|
$return['PDF_fields'] = array(
|
|
'description' => _('Description')
|
|
);
|
|
if (isset($_SESSION['loggedIn']) && ($_SESSION['loggedIn'] === true) && !in_array('posixAccount', $modules)) {
|
|
$return['PDF_fields']['uid'] = _('User name');
|
|
}
|
|
// help Entries
|
|
$return['help'] = array (
|
|
'host' => array(
|
|
'uid' => array(
|
|
"Headline" => _("Host name"), 'attr' => 'uid',
|
|
"Text" => _("Host name of the host which should be created. Valid characters are: a-z,A-Z,0-9, .-_$. Host names are always ending with $. If last character is not $ it will be added. If host name is already used host name will be expanded with a number. The next free number will be used.")
|
|
),
|
|
'description' => array (
|
|
"Headline" => _("Description"), 'attr' => 'description',
|
|
"Text" => _("Host description. If left empty host name will be used.")
|
|
)
|
|
),
|
|
'user' => array(
|
|
'uid' => array(
|
|
"Headline" => _("User name"), 'attr' => 'uid',
|
|
"Text" => _("User name of the user who should be created. Valid characters are: a-z,A-Z,0-9, @.-_.")
|
|
),
|
|
'description' => array (
|
|
"Headline" => _("Description"), 'attr' => 'description',
|
|
"Text" => _("User description. If left empty user name will be used.")
|
|
)
|
|
)
|
|
);
|
|
// upload columns
|
|
$return['upload_columns'][] = array(
|
|
'name' => 'account_description',
|
|
'description' => _('Description'),
|
|
'help' => 'description',
|
|
'example' => ''
|
|
);
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* This function fills the message array.
|
|
*/
|
|
function load_Messages() {
|
|
$this->messages['uid'][0] = array('ERROR', _('User name'), _('User name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
|
$this->messages['uid'][1] = array('ERROR', _('Account %s:') . ' posixAccount_userName', _('User name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
|
$this->messages['uid'][2] = array('WARN', _('User name'), _('You are using capital letters. This can cause problems because Windows is not case-sensitive.'));
|
|
$this->messages['uid'][3] = array('ERROR', _('User name'), _('User name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
|
}
|
|
|
|
/**
|
|
* This functions returns true if all needed settings are done.
|
|
*
|
|
* @return boolean true if LDAP operation can be done
|
|
*/
|
|
function module_complete() {
|
|
$modules = $_SESSION['config']->get_AccountModules($this->get_scope());
|
|
if (!in_array('posixAccount', $modules) && $this->attributes['uid'][0] == '') return false;
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Controls if the module button the account page is visible and activated.
|
|
*
|
|
* @return string status ("enabled", "disabled", "hidden")
|
|
*/
|
|
function getButtonStatus() {
|
|
if (!$this->getAccountContainer()->isNewAccount) {
|
|
// check if account is based on our object class
|
|
$objectClasses = $this->getAccountContainer()->attributes_orig['objectClass'];
|
|
if (is_array($objectClasses) && !in_array('account', $objectClasses)) {
|
|
return "disabled";
|
|
}
|
|
}
|
|
return "enabled";
|
|
}
|
|
|
|
/**
|
|
* Returns a list of modifications which have to be made to the LDAP account.
|
|
*
|
|
* @return array list of modifications
|
|
* <br>This function returns an array with 3 entries:
|
|
* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
|
|
* <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>"add" are attributes which have to be added to LDAP entry
|
|
* <br>"remove" are attributes which have to be removed from LDAP entry
|
|
* <br>"modify" are attributes which have to been modified in LDAP entry
|
|
* <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)
|
|
*/
|
|
function save_attributes() {
|
|
// skip saving if account is based on another structural object class
|
|
if (!$this->getAccountContainer()->isNewAccount && !in_array('account', $this->getAccountContainer()->attributes_orig['objectClass'])) {
|
|
return array();
|
|
}
|
|
// Get easy attributes
|
|
$return = $this->getAccountContainer()->save_module_attributes($this->attributes, $this->orig);
|
|
// Return attributes
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Processes user input of the primary module page.
|
|
* It checks if all input values are correct and updates the associated LDAP attributes.
|
|
*
|
|
* @return array list of info/error messages
|
|
*/
|
|
function process_attributes() {
|
|
$errors = array();
|
|
// Load attributes
|
|
$this->attributes['description'][0] = $_POST['description'];
|
|
// user name if no posixAccount
|
|
$modules = $_SESSION['config']->get_AccountModules($this->get_scope());
|
|
if (!in_array('posixAccount', $modules)) {
|
|
$this->attributes['uid'][0] = $_POST['uid'];
|
|
if (!get_preg($this->attributes['uid'][0], '!upper')) $errors[] = $this->messages['uid'][2];
|
|
if (!get_preg($this->attributes['uid'][0], 'username')) $errors[] = $this->messages['uid'][3];
|
|
}
|
|
return $errors;
|
|
}
|
|
|
|
/**
|
|
* Returns the HTML meta data for the main account page.
|
|
*
|
|
* @return htmlElement HTML meta data
|
|
*/
|
|
function display_html_attributes() {
|
|
$container = new htmlTable();
|
|
// user name if no posixAccount
|
|
$modules = $_SESSION['config']->get_AccountModules($this->get_scope());
|
|
if (!in_array('posixAccount', $modules)) {
|
|
$title = _('User name');
|
|
if ($this->get_scope()=='host') {
|
|
$title = _('Host name');
|
|
}
|
|
$uidInput = $this->addSimpleInputTextField($container, 'uid', $title, true);
|
|
$uidInput->setFieldMaxLength(100);
|
|
}
|
|
// description
|
|
$this->addSimpleInputTextField($container, 'description', _('Description'));
|
|
return $container;
|
|
}
|
|
|
|
/**
|
|
* Returns the PDF entries for this module.
|
|
*
|
|
* @return array list of possible PDF entries
|
|
*/
|
|
function get_pdfEntries() {
|
|
$return = array();
|
|
$this->addSimplePDFField($return, 'description', _('Description'));
|
|
$this->addSimplePDFField($return, 'uid', _('User name'));
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* 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> )
|
|
*
|
|
* @param array $selectedModules list of selected account modules
|
|
* @return array column list
|
|
*/
|
|
function get_uploadColumns($selectedModules) {
|
|
$return = parent::get_uploadColumns($selectedModules);
|
|
if (!in_array('posixAccount', $selectedModules)) {
|
|
$return[] = array(
|
|
'name' => 'account_uid',
|
|
'description' => _('User name'),
|
|
'help' => 'uid',
|
|
'required' => true
|
|
);
|
|
}
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* In this function the LDAP account is built up.
|
|
*
|
|
* @param array $rawAccounts list of hash arrays (name => value) from user input
|
|
* @param array $ids list of IDs for column position (e.g. "posixAccount_uid" => 5)
|
|
* @param array $partialAccounts list of hash arrays (name => value) which are later added to LDAP
|
|
* @param array $selectedModules list of selected account modules
|
|
* @return array list of error messages if any
|
|
*/
|
|
function build_uploadAccounts($rawAccounts, $ids, &$partialAccounts, $selectedModules) {
|
|
$messages = array();
|
|
for ($i = 0; $i < sizeof($rawAccounts); $i++) {
|
|
// add object class
|
|
if (!in_array("account", $partialAccounts[$i]['objectClass'])) $partialAccounts[$i]['objectClass'][] = "account";
|
|
// description
|
|
if ($rawAccounts[$i][$ids['account_description']] && ($rawAccounts[$i][$ids['account_description']] != '')) {
|
|
$partialAccounts[$i]['description'] = $rawAccounts[$i][$ids['account_description']];
|
|
}
|
|
elseif (isset($ids['account_uid']) && isset($rawAccounts[$i][$ids['account_uid']])) {
|
|
$partialAccounts[$i]['description'] = $rawAccounts[$i][$ids['account_uid']];
|
|
}
|
|
elseif (isset($partialAccounts[$i]['uid'])) {
|
|
$partialAccounts[$i]['description'] = $partialAccounts[$i]['uid'];
|
|
}
|
|
if (!in_array('posixAccount', $selectedModules)) {
|
|
// user name
|
|
if (get_preg($rawAccounts[$i][$ids['account_uid']], 'username')) {
|
|
$partialAccounts[$i]['uid'] = $rawAccounts[$i][$ids['account_uid']];
|
|
}
|
|
else {
|
|
$errMsg = $this->messages['uid'][1];
|
|
array_push($errMsg, array($i));
|
|
$messages[] = $errMsg;
|
|
}
|
|
}
|
|
}
|
|
return $messages;
|
|
}
|
|
|
|
}
|
|
|
|
?>
|