LDAPAccountManager/lam/lib/modules/ieee802device.inc

171 lines
5.2 KiB
PHP
Raw Normal View History

2004-11-01 16:53:04 +00:00
<?php
/*
$Id$
2009-10-27 18:47:12 +00:00
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
2016-07-17 18:45:17 +00:00
Copyright (C) 2004 - 2016 Roland Gruber
2004-11-01 16:53:04 +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
*/
/**
* Provides MAC addresses for hosts.
*
* @package modules
* @author Roland Gruber
*/
/**
* Provides MAC addresses for hosts.
*
* @package modules
*/
2013-05-05 18:32:12 +00:00
class ieee802device extends baseModule {
2006-08-13 12:58:19 +00:00
/**
* Returns true if this module can manage accounts of the current type, otherwise false.
2015-08-15 18:11:54 +00:00
*
* @return boolean true if module fits
*/
public function can_manage() {
return in_array($this->get_scope(), array('host'));
}
2004-11-01 16:53:04 +00:00
/**
* Returns meta data that is interpreted by parent class
*
* @return array array with meta data
2015-08-15 18:11:54 +00:00
*
2008-02-03 14:28:28 +00:00
* @see baseModule::get_metaData()
2004-11-01 16:53:04 +00:00
*/
function get_metaData() {
$return = array();
2007-11-19 18:42:03 +00:00
// icon
2007-12-01 12:34:52 +00:00
$return['icon'] = 'network-wired.png';
2004-11-01 16:53:04 +00:00
// alias name
$return["alias"] = _("MAC address");
// module dependencies
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
// managed object classes
$return['objectClasses'] = array('ieee802Device');
2006-05-13 08:55:31 +00:00
// managed attributes
$return['attributes'] = array('macAddress');
2004-11-01 16:53:04 +00:00
// help Entries
$return['help'] = array(
2013-10-20 14:26:29 +00:00
'macAddress' => array(
2012-02-04 15:56:31 +00:00
"Headline" => _("MAC address"), 'attr' => 'macAddress',
2004-11-01 16:53:04 +00:00
"Text" => _("This is the MAC address of the network card of the device (e.g. 00:01:02:DE:EF:18).")
),
'macList' => array(
2012-02-04 15:56:31 +00:00
"Headline" => _("MAC address list"), 'attr' => 'macAddress',
2004-11-01 16:53:04 +00:00
"Text" => _("This is a comma separated list of MAC addresses.")
));
// upload fields
$return['upload_columns'] = array(
array(
'name' => 'ieee802Device_mac',
'description' => _('MAC address'),
'help' => 'macList',
'example' => '00:01:02:DE:EF:18'
)
);
// available PDF fields
$return['PDF_fields'] = array(
2012-02-08 19:12:00 +00:00
'macAddress' => _('MAC addresses')
2004-11-01 16:53:04 +00:00
);
return $return;
}
/**
* This function fills the error message array with messages
*/
function load_Messages() {
2013-10-20 14:26:29 +00:00
$this->messages['macAddress'][0] = array('ERROR', 'MAC address is invalid!'); // third array value is set dynamically
$this->messages['macAddress'][1] = array('ERROR', _('Account %s:') . ' ieee802Device_mac', 'MAC address is invalid!');
2004-11-01 16:53:04 +00:00
}
2006-08-13 12:58:19 +00:00
2004-11-01 16:53:04 +00:00
/**
2007-11-03 14:17:19 +00:00
* Returns the HTML meta data for the main account page.
2015-08-15 18:11:54 +00:00
*
2010-09-18 11:37:22 +00:00
* @return htmlElement HTML meta data
2007-11-03 14:17:19 +00:00
*/
2006-08-13 12:58:19 +00:00
function display_html_attributes() {
2010-09-18 11:37:22 +00:00
$return = new htmlTable();
2013-10-20 14:26:29 +00:00
$this->addMultiValueInputTextField($return, 'macAddress', _('MAC address'), false, 17);
2004-11-01 16:53:04 +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.
2004-11-01 16:53:04 +00:00
*
* @return array list of info/error messages
2004-11-01 16:53:04 +00:00
*/
2006-08-13 12:58:19 +00:00
function process_attributes() {
2006-05-13 08:55:31 +00:00
$errors = array();
2013-10-20 14:26:29 +00:00
$this->processMultiValueInputTextField('macAddress', $errors, 'macAddress');
2016-07-17 18:45:17 +00:00
// check if MAC is already assigned
if (!empty($this->attributes['macAddress'])) {
foreach ($this->attributes['macAddress'] as $macAddress) {
if (!empty($this->orig['macAddress']) && in_array($macAddress, $this->orig['macAddress'])) {
// check only new MAC addresses
continue;
}
$result = searchLDAPByAttribute('macAddress', $macAddress, 'ieee802Device', array('dn'), array('host'));
if (!empty($result)) {
$errors[] = array('WARN', _('This MAC address is already in use.'), getAbstractDN($result[0]['dn']));
}
}
}
2006-05-13 08:55:31 +00:00
return $errors;
2004-11-01 16:53:04 +00:00
}
/**
* 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)
2012-07-15 12:05:47 +00:00
* @param array $partialAccounts list of hash arrays (name => value) which are later added to LDAP
* @param array $selectedModules list of selected account modules
2004-11-01 16:53:04 +00:00
* @return array list of error messages if any
*/
function build_uploadAccounts($rawAccounts, $ids, &$partialAccounts, $selectedModules) {
2004-11-01 16:53:04 +00:00
$messages = array();
for ($i = 0; $i < sizeof($rawAccounts); $i++) {
// add object class
2015-08-15 18:11:54 +00:00
if (!in_array("ieee802Device", $partialAccounts[$i]['objectClass'])) {
$partialAccounts[$i]['objectClass'][] = "ieee802Device";
2004-11-01 16:53:04 +00:00
}
2015-08-15 18:11:54 +00:00
// add MACs
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'ieee802Device_mac', 'macAddress', 'macAddress', $this->messages['macAddress'][1], $messages, '/,[ ]*/');
2004-11-01 16:53:04 +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
*/
function get_pdfEntries($pdfKeys) {
2004-11-01 16:53:04 +00:00
$return = array();
2013-05-05 18:26:54 +00:00
$this->addSimplePDFField($return, 'macAddress', _('MAC addresses'));
2004-11-01 16:53:04 +00:00
return $return;
}
}
?>