LDAPAccountManager/lam/lib/modules/hostObject.inc

220 lines
7.1 KiB
PHP
Raw Normal View History

2010-04-03 13:56:27 +00:00
<?php
/*
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
2019-08-27 19:29:51 +00:00
Copyright (C) 2011 - 2019 Roland Gruber
2010-04-03 13:56:27 +00:00
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 hosts to which a user may login.
*
* @package modules
* @author Roland Gruber
*/
/**
* Manages the hosts to which a user may login.
*
* @package modules
*/
class hostObject extends baseModule {
2015-07-26 07:56:32 +00:00
2010-04-03 13:56:27 +00:00
/**
* Creates a new hostObject object.
*
* @param string $scope account type (user, group, host)
*/
function __construct($scope) {
// call parent constructor
parent::__construct($scope);
$this->autoAddObjectClasses = false;
}
/**
* Returns true if this module can manage accounts of the current type, otherwise false.
2015-07-26 07:56:32 +00:00
*
* @return boolean true if module fits
*/
public function can_manage() {
return in_array($this->get_scope(), array('user'));
}
2010-04-03 13:56:27 +00:00
/**
* Returns meta data that is interpreted by parent class
*
* @return array array with meta data
2015-07-26 07:56:32 +00:00
*
2010-04-03 13:56:27 +00:00
* @see baseModule::get_metaData()
*/
function get_metaData() {
$return = array();
// icon
$return['icon'] = 'computer.png';
// alias name
$return["alias"] = _("Hosts");
// module dependencies
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
// managed object classes
$return['objectClasses'] = array('hostObject');
// managed attributes
$return['attributes'] = array('host');
// help Entries
$return['help'] = array(
'host' => array(
2012-02-04 15:56:31 +00:00
"Headline" => _("Hosts"), 'attr' => 'host',
2010-04-03 13:56:27 +00:00
"Text" => _("Here you can specify the list of host names where this account has login privileges. The wildcard \"*\" represents all hosts. You may also use \"!\" in front of a host name to deny access to a host.")
),
'autoAdd' => array(
"Headline" => _("Automatically add this extension"),
"Text" => _("This will enable the extension automatically if this profile is loaded.")
)
);
// upload fields
$return['upload_columns'] = array(
array(
'name' => 'hostObject_hosts',
'description' => _('Host list'),
'help' => 'host',
'example' => _('pc01,pc02')
)
);
// available PDF fields
$return['PDF_fields'] = array(
2010-04-05 12:38:23 +00:00
'hosts' => _('Host list')
2010-04-03 13:56:27 +00:00
);
2018-05-19 07:48:12 +00:00
$profileContainer = new htmlResponsiveRow();
$profileContainer->add(new htmlResponsiveInputCheckbox('hostObject_addExt', false, _('Automatically add this extension'), 'autoAdd'), 12);
2010-09-18 11:37:22 +00:00
$return['profile_options'] = $profileContainer;
2010-04-03 13:56:27 +00:00
return $return;
}
/**
* This function fills the error message array with messages
*/
function load_Messages() {
$this->messages['host'][0] = array('ERROR', 'Please enter a valid host name.'); // third array value is set dynamically
2015-07-26 07:56:32 +00:00
$this->messages['host'][1] = array('ERROR', _('Account %s:') . ' hostObject_hosts', _('Please enter a valid list of host names.'));
2010-04-03 13:56:27 +00:00
}
/**
* 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
2011-02-26 13:14:10 +00:00
* <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)
2010-04-03 13:56:27 +00:00
*/
function save_attributes() {
if (!in_array('hostObject', $this->attributes['objectClass']) && !in_array('hostObject', $this->orig['objectClass'])) {
// skip saving if the extension was not added/modified
return array();
}
return parent::save_attributes();
}
2015-07-26 07:56:32 +00:00
2010-04-03 13:56:27 +00:00
/**
* Returns the HTML meta data for the main account page.
2015-07-26 07:56:32 +00:00
*
2010-09-18 11:37:22 +00:00
* @return htmlElement HTML meta data
2010-04-03 13:56:27 +00:00
*/
function display_html_attributes() {
2010-09-18 11:37:22 +00:00
if (isset($_POST['addObjectClass'])) {
2010-04-03 13:56:27 +00:00
$this->attributes['objectClass'][] = 'hostObject';
}
2019-08-27 19:29:51 +00:00
$return = new htmlResponsiveRow();
2010-04-03 13:56:27 +00:00
if (in_array('hostObject', $this->attributes['objectClass'])) {
2013-10-20 14:26:29 +00:00
$this->addMultiValueInputTextField($return, 'host', _('Host'));
2019-08-27 19:29:51 +00:00
$return->addVerticalSpacer('2rem');
2010-09-18 11:37:22 +00:00
$remButton = new htmlButton('remObjectClass', _('Remove host extension'));
2019-08-27 19:29:51 +00:00
$return->add($remButton, 12, 12, 12, 'text-center');
2010-04-03 13:56:27 +00:00
}
else {
2019-08-27 19:29:51 +00:00
$return->add(new htmlButton('addObjectClass', _('Add host extension')), 12);
2010-04-03 13:56:27 +00:00
}
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() {
2010-09-18 11:37:22 +00:00
if (isset($_POST['remObjectClass'])) {
2010-04-03 13:56:27 +00:00
$this->attributes['objectClass'] = array_delete(array('hostObject'), $this->attributes['objectClass']);
if (isset($this->attributes['host'])) unset($this->attributes['host']);
return array();
}
if (!in_array('hostObject', $this->attributes['objectClass'])) {
return array();
}
$errors = array();
2013-10-20 14:26:29 +00:00
$this->processMultiValueInputTextField('host', $errors, 'hostObject');
2010-04-03 13:56:27 +00:00
return $errors;
}
/**
2017-05-20 09:46:49 +00:00
* {@inheritDoc}
* @see baseModule::build_uploadAccounts()
*/
function build_uploadAccounts($rawAccounts, $ids, &$partialAccounts, $selectedModules, &$type) {
2010-04-03 13:56:27 +00:00
$messages = array();
for ($i = 0; $i < sizeof($rawAccounts); $i++) {
// add object class
if (!in_array("hostObject", $partialAccounts[$i]['objectClass'])) $partialAccounts[$i]['objectClass'][] = "hostObject";
// add hosts
2015-07-26 07:56:32 +00:00
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'hostObject_hosts', 'host', 'hostObject', $this->messages['host'][1], $messages, '/,[ ]*/');
2010-04-03 13:56:27 +00:00
}
return $messages;
}
/**
2017-02-19 08:14:11 +00:00
* {@inheritDoc}
* @see baseModule::get_pdfEntries()
2015-01-07 17:16:35 +00:00
*/
2017-04-01 07:57:03 +00:00
function get_pdfEntries($pdfKeys, $typeId) {
2010-04-03 13:56:27 +00:00
$return = array();
2013-05-05 18:26:54 +00:00
$this->addSimplePDFField($return, 'hosts', _('Host list'), 'host');
2010-04-03 13:56:27 +00:00
return $return;
}
/**
* Loads the values of an account profile into internal variables.
*
* @param array $profile hash array with profile values (identifier => value)
*/
function load_profile($profile) {
// profile mappings in meta data
parent::load_profile($profile);
// add extension
2011-01-09 14:38:00 +00:00
if (isset($profile['hostObject_addExt'][0]) && ($profile['hostObject_addExt'][0] == "true")) {
2010-04-03 13:56:27 +00:00
if (!in_array('hostObject', $this->attributes['objectClass'])) {
$this->attributes['objectClass'][] = 'hostObject';
}
}
}
}
?>