added PyKota support
This commit is contained in:
Roland Gruber
parent
9c5e5102f5
commit
1cccab7b66
|
|
@ -1,4 +1,5 @@
|
|||
December 2013 4.4
|
||||
- PyKota support: users, groups, printers, billing codes
|
||||
- allow to set a custom label for each account type
|
||||
- LAM Pro:
|
||||
-> Samba/Shadow: display password change date in self service
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
<pdf type="pykotaBillingCodeType" filename="printLogo.jpg" headline="LDAP Account Manager" foldingmarks="no">
|
||||
<section name="_pykotaBillingCode_pykotaBillingCode">
|
||||
<entry name="pykotaBillingCode_pykotaBalance" />
|
||||
<entry name="pykotaBillingCode_pykotaPageCounter" />
|
||||
<entry name="pykotaBillingCode_description" />
|
||||
</section>
|
||||
</pdf>
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<pdf type="pykotaPrinterType" filename="printLogo.jpg" headline="Printer information" foldingmarks="no">
|
||||
<section name="_pykotaPrinter_cn">
|
||||
<entry name="pykotaPrinter_description" />
|
||||
<entry name="pykotaPrinter_pykotaMaxJobSize" />
|
||||
<entry name="pykotaPrinter_pykotaPricePerJob" />
|
||||
<entry name="pykotaPrinter_pykotaPricePerPage" />
|
||||
<entry name="pykotaPrinter_pykotaPassThrough" />
|
||||
<entry name="pykotaPrinter_uniqueMember" />
|
||||
<entry name="pykotaPrinter_parentUniqueMember" />
|
||||
</section>
|
||||
</pdf>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
profname: default
|
||||
ldap_suffix: -
|
||||
ldap_rdn: cn
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
profname: default
|
||||
ldap_suffix: -
|
||||
ldap_rdn: cn
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 662 B |
Binary file not shown.
|
After Width: | Height: | Size: 662 B |
|
|
@ -0,0 +1,300 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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 PyKota billing codes.
|
||||
*
|
||||
* @package modules
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/**
|
||||
* Manages PyKota billing codes.
|
||||
*
|
||||
* @package modules
|
||||
*/
|
||||
class pykotaBillingCode extends baseModule {
|
||||
|
||||
/** cache for existing codes (array(dn1 => pykotaBillingCode1, dn2 => pykotaBillingCode2)) */
|
||||
private $codeCache = null;
|
||||
|
||||
/**
|
||||
* Returns meta data that is interpreted by parent class
|
||||
*
|
||||
* @return array array with meta data
|
||||
*
|
||||
* @see baseModule::get_metaData()
|
||||
*/
|
||||
function get_metaData() {
|
||||
$return = array();
|
||||
// icon
|
||||
$return['icon'] = 'printerBig.png';
|
||||
// manages host accounts
|
||||
$return["account_types"] = array('pykotaBillingCodeType');
|
||||
// alias name
|
||||
$return["alias"] = _("PyKota");
|
||||
// this is a base module
|
||||
$return["is_base"] = true;
|
||||
// RDN attribute
|
||||
$return["RDN"] = array("cn" => "high");
|
||||
// LDAP filter
|
||||
$return["ldap_filter"] = array('or' => "(objectClass=pykotaBilling)");
|
||||
// module dependencies
|
||||
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
|
||||
// managed object classes
|
||||
$return['objectClasses'] = array('pykotaObject', 'pykotaBilling');
|
||||
// managed attributes
|
||||
$return['attributes'] = array('cn', 'pykotaBillingCode', 'description', 'pykotaBalance', 'pykotaPageCounter');
|
||||
// help Entries
|
||||
$return['help'] = array(
|
||||
'pykotaBillingCode' => array(
|
||||
"Headline" => _("Billing code"), 'attr' => 'pykotaBillingCode',
|
||||
"Text" => _("Billing code name which should be created. Valid characters are: a-z, A-Z, 0-9 and .-_ .")
|
||||
),
|
||||
'description' => array (
|
||||
"Headline" => _("Description"), 'attr' => 'description',
|
||||
"Text" => _("Billing code description.")
|
||||
),
|
||||
'pykotaBalance' => array (
|
||||
"Headline" => _('Balance'), 'attr' => 'pykotaBalance',
|
||||
"Text" => _('Used balance for the billing code.')
|
||||
),
|
||||
'pykotaPageCounter' => array (
|
||||
"Headline" => _('Page count'), 'attr' => 'pykotaPageCounter',
|
||||
"Text" => _('Number of pages printed with this billing code.')
|
||||
),
|
||||
'reset' => array (
|
||||
"Headline" => _('Reset'), 'attr' => 'pykotaBalance, pykotaPageCounter',
|
||||
"Text" => _('Resets the billing code\'s balance and page counter to 0.')
|
||||
),
|
||||
);
|
||||
// upload fields
|
||||
$return['upload_columns'] = array(
|
||||
array(
|
||||
'name' => 'pykotaBillingCode_pykotaBillingCode',
|
||||
'description' => _('Printer name'),
|
||||
'help' => 'cn',
|
||||
'example' => _('billingCode01'),
|
||||
'required' => true,
|
||||
'unique' => true,
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaBillingCode_description',
|
||||
'description' => _('Description'),
|
||||
'help' => 'description',
|
||||
),
|
||||
);
|
||||
// available PDF fields
|
||||
$return['PDF_fields'] = array(
|
||||
'pykotaBillingCode' => _('Billing code'),
|
||||
'description' => _('Description'),
|
||||
'pykotaBalance' => _('Balance'),
|
||||
'pykotaPageCounter' => _('Page count'),
|
||||
);
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function fills the $messages variable with output messages from this module.
|
||||
*/
|
||||
function load_Messages() {
|
||||
$this->messages['pykotaBillingCode'][0] = array('ERROR', _('Billing code'), _('Billing code contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['pykotaBillingCode'][1] = array('ERROR', _('Account %s:') . ' pykotaBillingCode_cn', _('Billing code contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['pykotaBillingCode'][2] = array('ERROR', _('Billing code'), _('Billing code already exists!'));
|
||||
$this->messages['pykotaBillingCode'][3] = array('ERROR', _('Account %s:') . ' pykotaBillingCode_cn', _('Billing code already exists!'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the HTML meta data for the main account page.
|
||||
*
|
||||
* @return htmlElement HTML meta data
|
||||
*/
|
||||
function display_html_attributes() {
|
||||
$container = new htmlTable();
|
||||
// pykotaBillingCode
|
||||
$this->addSimpleInputTextField($container, 'pykotaBillingCode', _('BillingCode'), true);
|
||||
// balance
|
||||
$container->addElement(new htmlOutputText(_('Balance')));
|
||||
$pykotaBalance = '';
|
||||
if (isset($this->attributes['pykotaBalance'][0])) {
|
||||
$pykotaBalance = $this->attributes['pykotaBalance'][0];
|
||||
}
|
||||
$container->addElement(new htmlOutputText($pykotaBalance));
|
||||
$container->addElement(new htmlHelpLink('pykotaBalance'), true);
|
||||
// page count
|
||||
$container->addElement(new htmlOutputText(_('Page count')));
|
||||
$pykotaPageCounter = '';
|
||||
if (isset($this->attributes['pykotaPageCounter'][0])) {
|
||||
$pykotaPageCounter = $this->attributes['pykotaPageCounter'][0];
|
||||
}
|
||||
$container->addElement(new htmlOutputText($pykotaPageCounter));
|
||||
$container->addElement(new htmlHelpLink('pykotaPageCounter'), true);
|
||||
// description
|
||||
$this->addSimpleInputTextField($container, 'description', _('Description'), false, null, true);
|
||||
// reset
|
||||
$container->addElement(new htmlSpacer(null, '20px'), true);
|
||||
$container->addElement(new htmlOutputText(''));
|
||||
$container->addElement(new htmlButton('resetCounters', _('Reset')));
|
||||
$container->addElement(new htmlHelpLink('reset'), true);
|
||||
// same width
|
||||
$container->addElement(new htmlEqualWidth(array('pykotaBillingCode', 'description')));
|
||||
return $container;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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();
|
||||
// pykotaBillingCode
|
||||
if (isset($_POST['pykotaBillingCode']) && ($_POST['pykotaBillingCode'] != '')) {
|
||||
if (!get_preg($_POST['pykotaBillingCode'], 'username')) {
|
||||
$errors[] = $this->messages['pykotaBillingCode'][0];
|
||||
}
|
||||
else {
|
||||
$this->attributes['pykotaBillingCode'][0] = $_POST['pykotaBillingCode'];
|
||||
$this->attributes['cn'][0] = $_POST['pykotaBillingCode'];
|
||||
if ((!isset($this->orig['pykotaBillingCode'][0]) || ($this->attributes['pykotaBillingCode'][0] != $this->orig['pykotaBillingCode'][0]))
|
||||
&& $this->codeExists($_POST['pykotaBillingCode'])) {
|
||||
$errors[] = $this->messages['pykotaBillingCode'][2];
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (isset($this->attributes['cn'][0])) {
|
||||
unset($this->attributes['cn'][0]);
|
||||
}
|
||||
if (isset($this->attributes['pykotaBillingCode'][0])) {
|
||||
unset($this->attributes['pykotaBillingCode'][0]);
|
||||
}
|
||||
}
|
||||
// description
|
||||
$this->attributes['description'][0] = $_POST['description'];
|
||||
// reset
|
||||
if (isset($_POST['resetCounters'])) {
|
||||
$this->attributes['pykotaBalance'][0] = '0.0';
|
||||
$this->attributes['pykotaPageCounter'][0] = '0';
|
||||
}
|
||||
return $errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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();
|
||||
$this->loadCodeCache();
|
||||
for ($i = 0; $i < sizeof($rawAccounts); $i++) {
|
||||
// add object classes
|
||||
if (!in_array('pykotaBilling', $partialAccounts[$i]['objectClass'])) {
|
||||
$partialAccounts[$i]['objectClass'][] = 'pykotaBilling';
|
||||
}
|
||||
if (!in_array('pykotaObject', $partialAccounts[$i]['objectClass'])) {
|
||||
$partialAccounts[$i]['objectClass'][] = 'pykotaObject';
|
||||
}
|
||||
// pykotaBillingCode
|
||||
if (!get_preg($rawAccounts[$i][$ids['pykotaBillingCode_pykotaBillingCode']], 'username')) {
|
||||
$errMsg = $this->messages['pykotaBillingCode'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
elseif ($this->codeExists($rawAccounts[$i][$ids['pykotaBillingCode_pykotaBillingCode']])) {
|
||||
$errMsg = $this->messages['pykotaBillingCode'][3];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['cn'] = $rawAccounts[$i][$ids['pykotaBillingCode_pykotaBillingCode']];
|
||||
$partialAccounts[$i]['pykotaBillingCode'] = $rawAccounts[$i][$ids['pykotaBillingCode_pykotaBillingCode']];
|
||||
}
|
||||
// description
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaBillingCode_description']])) {
|
||||
$partialAccounts[$i]['description'] = $rawAccounts[$i][$ids['pykotaBillingCode_description']];
|
||||
}
|
||||
// balance
|
||||
$partialAccounts[$i]['pykotaBalance'] = '0.0';
|
||||
// page count
|
||||
$partialAccounts[$i]['pykotaPageCounter'] = '0';
|
||||
}
|
||||
return $messages;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of PDF entries
|
||||
*/
|
||||
function get_pdfEntries() {
|
||||
$return = array();
|
||||
$this->loadCodeCache();
|
||||
$this->addSimplePDFField($return, 'pykotaBillingCode', _('Billing code'));
|
||||
$this->addSimplePDFField($return, 'description', _('Description'));
|
||||
$this->addSimplePDFField($return, 'pykotaBalance', _('Balance'));
|
||||
$this->addSimplePDFField($return, 'pykotaPageCounter', _('Page count'));
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns if the given billing code already exists.
|
||||
*
|
||||
* @param String $code pykotaBillingCode attribute value
|
||||
* @return boolean pykotaBillingCode exists
|
||||
*/
|
||||
private function codeExists($code) {
|
||||
if ($this->codeCache == null) {
|
||||
$this->loadCodeCache();
|
||||
}
|
||||
foreach ($this->codeCache as $dn => $bCode) {
|
||||
if (!empty($bCode) && ($bCode == $code)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the list of billing code names into the cache.
|
||||
*/
|
||||
private function loadCodeCache() {
|
||||
if ($this->codeCache != null) {
|
||||
return;
|
||||
}
|
||||
$results = searchLDAPByFilter('(objectClass=pykotaBilling)', array('pykotaBillingCode', 'dn'), array($this->get_scope()));
|
||||
$this->codeCache = array();
|
||||
foreach ($results as $result) {
|
||||
if (isset($result['pykotabillingcode'][0])) {
|
||||
$this->codeCache[$result['dn']] = $result['pykotabillingcode'][0];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
?>
|
||||
|
|
@ -0,0 +1,592 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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 PyKota group accounts.
|
||||
*
|
||||
* @package modules
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/**
|
||||
* Manages PyKota group accounts.
|
||||
*
|
||||
* @package modules
|
||||
*/
|
||||
class pykotaGroup extends baseModule {
|
||||
|
||||
/** cache for cn attribute */
|
||||
private $cnCache = null;
|
||||
/** cache for pykotaGroupName attribute */
|
||||
private $pykotaGroupNameCache = null;
|
||||
/** list of limit options label => value */
|
||||
private $limitOptions;
|
||||
|
||||
/**
|
||||
* Returns if this module also manages the structural object class pykotaObject.
|
||||
* This is overridden by a submodule that must provide the structural object class.
|
||||
*
|
||||
* @return boolean structural usage
|
||||
*/
|
||||
public function isStructural() {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new pykotaGroup object.
|
||||
*
|
||||
* @param string $scope account type (user, group, host)
|
||||
*/
|
||||
function __construct($scope) {
|
||||
$this->limitOptions = array(
|
||||
_('Quota') => 'quota',
|
||||
_('Balance') => 'balance',
|
||||
_('No quota') => 'noquota',
|
||||
_('Free printing') => 'nochange',
|
||||
_('Deny printing') => 'noprint',
|
||||
);
|
||||
// call parent constructor
|
||||
parent::__construct($scope);
|
||||
$this->autoAddObjectClasses = $this->isStructural();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns meta data that is interpreted by parent class
|
||||
*
|
||||
* @return array array with meta data
|
||||
*
|
||||
* @see baseModule::get_metaData()
|
||||
*/
|
||||
function get_metaData() {
|
||||
$return = array();
|
||||
// icon
|
||||
$return['icon'] = 'printerBig.png';
|
||||
// manages host accounts
|
||||
$return["account_types"] = array('group');
|
||||
// alias name
|
||||
$return["alias"] = _("PyKota");
|
||||
// this is a base module
|
||||
$return["is_base"] = $this->isStructural();
|
||||
// LDAP filter
|
||||
$return["ldap_filter"] = array('or' => "(objectClass=pykotaGroup)");
|
||||
// module dependencies
|
||||
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
|
||||
// managed object classes
|
||||
$return['objectClasses'] = array('pykotaGroup');
|
||||
// managed attributes
|
||||
$return['attributes'] = array('pykotaLimitBy', 'pykotaGroupName');
|
||||
if ($this->manageCn()) {
|
||||
$return['attributes'][] = 'cn';
|
||||
}
|
||||
if ($this->manageDescription()) {
|
||||
$return['attributes'][] = 'description';
|
||||
}
|
||||
// help Entries
|
||||
$return['help'] = array(
|
||||
'cn' => array(
|
||||
"Headline" => _("Common name"), 'attr' => 'cn',
|
||||
"Text" => _("Group name of the group which should be created. Valid characters are: a-z, A-Z, 0-9 and .-_ .")
|
||||
),
|
||||
'description' => array (
|
||||
"Headline" => _("Description"), 'attr' => 'description',
|
||||
"Text" => _("Group description.")
|
||||
),
|
||||
'pykotaGroupName' => array(
|
||||
"Headline" => _("PyKota group name"), 'attr' => 'pykotaGroupName',
|
||||
"Text" => _("Group name that is used for PyKota.")
|
||||
),
|
||||
'pykotaLimitBy' => array(
|
||||
"Headline" => _("Limit type"), 'attr' => 'pykotaLimitBy',
|
||||
"Text" => _("Specifies the type of limit for printing if any. Please note that in contrast to \"Free printing\" the option \"No quota\" includes accounting.")
|
||||
),
|
||||
'autoAdd' => array(
|
||||
"Headline" => _("Automatically add this extension"),
|
||||
"Text" => _("This will enable the extension automatically if this profile is loaded.")
|
||||
),
|
||||
);
|
||||
// profile options
|
||||
$profileContainer = new htmlTable();
|
||||
$pykotaLimitByProfileOption = new htmlTableExtendedSelect('pykotaGroup_pykotaLimitBy', $this->limitOptions, array(), _('Limit type'), 'pykotaLimitBy');
|
||||
$pykotaLimitByProfileOption->setHasDescriptiveElements(true);
|
||||
$pykotaLimitByProfileOption->setSortElements(false);
|
||||
$profileContainer->addElement($pykotaLimitByProfileOption, true);
|
||||
if (!$this->isStructural()) {
|
||||
$profileContainer->addElement(new htmlTableExtendedInputCheckbox('pykotaGroup_addExt', false, _('Automatically add this extension'), 'autoAdd'), true);
|
||||
}
|
||||
$return['profile_options'] = $profileContainer;
|
||||
$return['profile_mappings']['pykotaGroup_pykotaLimitBy'] = 'pykotaLimitBy';
|
||||
// upload fields
|
||||
$return['upload_columns'] = array(
|
||||
array(
|
||||
'name' => 'pykotaGroup_pykotaGroupName',
|
||||
'description' => _('PyKota group name'),
|
||||
'help' => 'pykotaGroupName',
|
||||
'example' => _('adminstrators'),
|
||||
'unique' => true,
|
||||
)
|
||||
);
|
||||
if ($this->manageCn()) {
|
||||
$return['upload_columns'][] = array(
|
||||
'name' => 'pykotaGroup_cn',
|
||||
'description' => _('Common name'),
|
||||
'help' => 'cn',
|
||||
'example' => _('adminstrators'),
|
||||
'required' => true,
|
||||
);
|
||||
}
|
||||
if ($this->manageDescription()) {
|
||||
$return['upload_columns'][] = array(
|
||||
'name' => 'pykotaGroup_description',
|
||||
'description' => _('Description'),
|
||||
'help' => 'description',
|
||||
'example' => _('Administrators group'),
|
||||
);
|
||||
}
|
||||
$return['upload_columns'][] = array(
|
||||
'name' => 'pykotaGroup_pykotaLimitBy',
|
||||
'description' => _('Limit type'),
|
||||
'help' => 'pykotaLimitBy',
|
||||
'example' => _('Quota'),
|
||||
'default' => _('Quota'),
|
||||
'values' => implode(', ', array_keys($this->limitOptions))
|
||||
);
|
||||
// available PDF fields
|
||||
$return['PDF_fields'] = array(
|
||||
'pykotaGroupName' => _('PyKota group name'),
|
||||
'pykotaLimitBy' => _('Limit type'),
|
||||
);
|
||||
if ($this->manageCn()) {
|
||||
$return['PDF_fields']['cn'] = _('Common name');
|
||||
}
|
||||
if ($this->manageDescription()) {
|
||||
$return['PDF_fields']['description'] = _('Description');
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function fills the $messages variable with output messages from this module.
|
||||
*/
|
||||
function load_Messages() {
|
||||
$this->messages['cn'][0] = array('ERROR', _('Group name'), _('Group name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['cn'][1] = array('ERROR', _('Account %s:') . ' pykotaGroup_cn', _('Group name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['cn'][2] = array('ERROR', _('Group name'), _('Group name already exists!'));
|
||||
$this->messages['cn'][3] = array('ERROR', _('Account %s:') . ' pykotaGroup_cn', _('Group name already exists!'));
|
||||
$this->messages['pykotaGroupName'][0] = array('ERROR', _('PyKota group name'), _('Group name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['pykotaGroupName'][1] = array('ERROR', _('Account %s:') . ' pykotaGroup_pykotaGroupName', _('Group name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['pykotaGroupName'][2] = array('ERROR', _('PyKota group name'), _('Group name already exists!'));
|
||||
$this->messages['pykotaGroupName'][3] = array('ERROR', _('Account %s:') . ' pykotaGroup_pykotaGroupName', _('Group name already exists!'));
|
||||
$this->messages['pykotaLimitBy'][0] = array('ERROR', _('Account %s:') . ' pykotaGroup_pykotaLimitBy', _('Please enter a valid limit type.'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the HTML meta data for the main account page.
|
||||
*
|
||||
* @return htmlElement HTML meta data
|
||||
*/
|
||||
function display_html_attributes() {
|
||||
$container = new htmlTable();
|
||||
if ($this->isStructural() || (isset($this->attributes['objectClass']) && in_array('pykotaGroup', $this->attributes['objectClass']))) {
|
||||
// cn
|
||||
if ($this->manageCn()) {
|
||||
$this->addSimpleInputTextField($container, 'cn', _('Group name'), true);
|
||||
}
|
||||
// pykotaGroupName
|
||||
$this->addSimpleInputTextField($container, 'pykotaGroupName', _('Pykota group name'));
|
||||
// limit by
|
||||
$limitOption = 'quota';
|
||||
if (!empty($this->attributes['pykotaLimitBy'][0])) {
|
||||
$limitOption = $this->attributes['pykotaLimitBy'][0];
|
||||
}
|
||||
$limitSelect = new htmlTableExtendedSelect('pykotaLimitBy', $this->limitOptions, array($limitOption), _('Limit type'), 'pykotaLimitBy');
|
||||
$limitSelect->setHasDescriptiveElements(true);
|
||||
$limitSelect->setSortElements(false);
|
||||
$container->addElement($limitSelect, true);
|
||||
// description
|
||||
if ($this->manageDescription()) {
|
||||
$this->addMultiValueInputTextField($container, 'description', _('Description'), false, null, true);
|
||||
}
|
||||
// remove button
|
||||
if (!$this->isStructural()) {
|
||||
$container->addElement(new htmlSpacer(null, '20px'), true);
|
||||
$remButton = new htmlButton('remObjectClass', _('Remove PyKota extension'));
|
||||
$remButton->colspan = 5;
|
||||
$container->addElement($remButton);
|
||||
}
|
||||
}
|
||||
else {
|
||||
// add button
|
||||
$container->addElement(new htmlButton('addObjectClass', _('Add PyKota extension')));
|
||||
}
|
||||
return $container;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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();
|
||||
if (isset($_POST['addObjectClass'])) {
|
||||
if (!isset($this->attributes['objectClass'])) {
|
||||
$this->attributes['objectClass'] = array();
|
||||
}
|
||||
if (!in_array('pykotaGroup', $this->attributes['objectClass'])) {
|
||||
$this->attributes['objectClass'][] = 'pykotaGroup';
|
||||
}
|
||||
if (!isset($this->attributes['pykotaGroupName'][0])) {
|
||||
$this->attributes['pykotaGroupName'][0] = $this->getCurrentGroupName();
|
||||
}
|
||||
return $errors;
|
||||
}
|
||||
if (isset($_POST['remObjectClass'])) {
|
||||
$this->attributes['objectClass'] = array_delete(array('pykotaGroup'), $this->attributes['objectClass']);
|
||||
$attrs = array('pykotaLimitBy', 'pykotaGroupName');
|
||||
if ($this->manageDescription()) {
|
||||
$attrs[] = 'description';
|
||||
}
|
||||
if ($this->manageCn()) {
|
||||
$attrs[] = 'cn';
|
||||
}
|
||||
foreach ($attrs as $name) {
|
||||
if (isset($this->attributes[$name])) {
|
||||
unset($this->attributes[$name]);
|
||||
}
|
||||
}
|
||||
return $errors;
|
||||
}
|
||||
// skip processing if object class is not set
|
||||
if (!isset($this->attributes['objectClass']) || !in_array('pykotaGroup', $this->attributes['objectClass'])) {
|
||||
return $errors;
|
||||
}
|
||||
// cn
|
||||
if ($this->manageCn()) {
|
||||
if (isset($_POST['cn']) && ($_POST['cn'] != '')) {
|
||||
if (!get_preg($_POST['cn'], 'groupname')) {
|
||||
$errors[] = $this->messages['cn'][0];
|
||||
}
|
||||
else {
|
||||
$this->attributes['cn'][0] = $_POST['cn'];
|
||||
if ((!isset($this->orig['cn'][0]) || ($this->attributes['cn'][0] != $this->orig['cn'][0]))
|
||||
&& $this->cnExists($_POST['cn'])) {
|
||||
$errors[] = $this->messages['cn'][2];
|
||||
}
|
||||
}
|
||||
}
|
||||
elseif (isset($this->attributes['cn'][0])) {
|
||||
unset($this->attributes['cn'][0]);
|
||||
}
|
||||
}
|
||||
// PyKota group name
|
||||
if (!empty($_POST['pykotaGroupName'])) {
|
||||
if (!get_preg($_POST['pykotaGroupName'], 'groupname')) {
|
||||
$errors[] = $this->messages['pykotaGroupName'][0];
|
||||
}
|
||||
else {
|
||||
$this->attributes['pykotaGroupName'][0] = $_POST['pykotaGroupName'];
|
||||
if ((!isset($this->orig['pykotaGroupName'][0]) || ($this->attributes['pykotaGroupName'][0] != $this->orig['pykotaGroupName'][0]))
|
||||
&& $this->pykotaGroupNameExists($_POST['pykotaGroupName'])) {
|
||||
$errors[] = $this->messages['pykotaGroupName'][2];
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
$this->attributes['pykotaGroupName'][0] = $this->getCurrentGroupName();
|
||||
}
|
||||
// limit by
|
||||
$this->attributes['pykotaLimitBy'][0] = $_POST['pykotaLimitBy'];
|
||||
// description
|
||||
if ($this->manageDescription()) {
|
||||
$this->processMultiValueInputTextField('description', $errors);
|
||||
}
|
||||
return $errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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() {
|
||||
if (!in_array('pykotaGroup', $this->attributes['objectClass']) && !in_array('pykotaGroup', $this->orig['objectClass'])) {
|
||||
// skip saving if the extension was not added/modified
|
||||
return array();
|
||||
}
|
||||
return parent::save_attributes();
|
||||
}
|
||||
|
||||
/**
|
||||
* This function is used to check if all settings for this module have been made.
|
||||
*
|
||||
* Calling this method requires the existence of an enclosing {@link accountContainer}.<br>
|
||||
* <br>
|
||||
* This function tells LAM if it can create/modify the LDAP account. If your module needs any
|
||||
* additional input then set this to false. The user will be notified that your module needs
|
||||
* more input.<br>
|
||||
* This method's return value defaults to true.
|
||||
*
|
||||
* @return boolean true, if settings are complete
|
||||
*/
|
||||
public function module_complete() {
|
||||
if (in_array('pykotaGroup', $this->attributes['objectClass'])) {
|
||||
// require cn
|
||||
$cn = $this->getCurrentGroupName();
|
||||
return !empty($cn);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
if (isset($profile['pykotaGroup_addExt'][0]) && ($profile['pykotaGroup_addExt'][0] == "true")) {
|
||||
if (!in_array('pykotaGroup', $this->attributes['objectClass'])) {
|
||||
$this->attributes['objectClass'][] = 'pykotaGroup';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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 classes
|
||||
if (!in_array('pykotaGroup', $partialAccounts[$i]['objectClass'])) {
|
||||
$partialAccounts[$i]['objectClass'][] = 'pykotaGroup';
|
||||
}
|
||||
if ($this->isStructural() && !in_array('pykotaObject', $partialAccounts[$i]['objectClass'])) {
|
||||
$partialAccounts[$i]['objectClass'][] = 'pykotaObject';
|
||||
}
|
||||
// cn
|
||||
if ($this->manageCn() && !empty($rawAccounts[$i][$ids['pykotaGroup_cn']])) {
|
||||
if (!get_preg($rawAccounts[$i][$ids['pykotaGroup_cn']], 'groupname')) {
|
||||
$errMsg = $this->messages['cn'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
elseif ($this->cnExists($rawAccounts[$i][$ids['pykotaGroup_cn']])) {
|
||||
$errMsg = $this->messages['cn'][3];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['cn'] = $rawAccounts[$i][$ids['pykotaGroup_cn']];
|
||||
}
|
||||
}
|
||||
// description
|
||||
if ($this->manageDescription() && !empty($rawAccounts[$i][$ids['pykotaGroup_description']])) {
|
||||
$partialAccounts[$i]['description'] = $rawAccounts[$i][$ids['pykotaGroup_description']];
|
||||
}
|
||||
// PyKota group name
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaGroup_pykotaGroupName']])) {
|
||||
if (!get_preg($rawAccounts[$i][$ids['pykotaGroup_pykotaGroupName']], 'groupname')) {
|
||||
$errMsg = $this->messages['pykotaGroupName'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
elseif ($this->pykotaGroupNameExists($rawAccounts[$i][$ids['pykotaGroup_pykotaGroupName']])) {
|
||||
$errMsg = $this->messages['pykotaGroupName'][3];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaGroupName'] = $rawAccounts[$i][$ids['pykotaGroup_pykotaGroupName']];
|
||||
}
|
||||
}
|
||||
// limit by
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaGroup_pykotaLimitBy']])) {
|
||||
if (isset($this->limitOptions[$rawAccounts[$i][$ids['pykotaGroup_pykotaLimitBy']]])) {
|
||||
$partialAccounts[$i]['pykotaLimitBy'] = $this->limitOptions[$rawAccounts[$i][$ids['pykotaGroup_pykotaLimitBy']]];
|
||||
}
|
||||
else {
|
||||
$errMsg = $this->messages['pykotaLimitBy'][0];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaLimitBy'] = 'quota';
|
||||
}
|
||||
}
|
||||
return $messages;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of PDF entries
|
||||
*/
|
||||
function get_pdfEntries() {
|
||||
$return = array();
|
||||
$this->addSimplePDFField($return, 'cn', _('Common name'));
|
||||
$this->addSimplePDFField($return, 'pykotaGroupName', _('PyKota group name'));
|
||||
$this->addSimplePDFField($return, 'description', _('Description'));
|
||||
$limitByOptions = array_flip($this->limitOptions);
|
||||
$limitByValue = '';
|
||||
if (!empty($this->attributes['pykotaLimitBy'][0]) && isset($limitByOptions[$this->attributes['pykotaLimitBy'][0]])) {
|
||||
$limitByValue = $limitByOptions[$this->attributes['pykotaLimitBy'][0]];
|
||||
}
|
||||
$return[get_class($this) . '_pykotaLimitBy'] = array('<block><key>' . _('Limit type') . '</key><value>' . $limitByValue . '</value></block>');
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns if the cn attribute should be managed.
|
||||
*
|
||||
* @return boolean manage cn attribute
|
||||
*/
|
||||
private function manageCn() {
|
||||
if (isset($_SESSION['config'])) {
|
||||
$conf = $_SESSION['config'];
|
||||
if (in_array('posixGroup', $conf->get_AccountModules($this->get_scope()))
|
||||
|| in_array('groupOfNames', $conf->get_AccountModules($this->get_scope()))
|
||||
|| in_array('groupOfUniqueNames', $conf->get_AccountModules($this->get_scope()))) {
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns if the description attribute should be managed.
|
||||
*
|
||||
* @return boolean manage description attribute
|
||||
*/
|
||||
private function manageDescription() {
|
||||
if (isset($_SESSION['config'])) {
|
||||
$conf = $_SESSION['config'];
|
||||
if (in_array('posixGroup', $conf->get_AccountModules($this->get_scope()))
|
||||
|| in_array('groupOfNames', $conf->get_AccountModules($this->get_scope()))
|
||||
|| in_array('groupOfUniqueNames', $conf->get_AccountModules($this->get_scope()))) {
|
||||
return false;
|
||||
}
|
||||
else {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns if the given cn already exists.
|
||||
*
|
||||
* @param String $cn cn attribute value
|
||||
* @return boolean cn exists
|
||||
*/
|
||||
private function cnExists($cn) {
|
||||
if ($this->cnCache == null) {
|
||||
$this->loadGroupNameCache();
|
||||
}
|
||||
return in_array($cn, $this->cnCache);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns if the given pykotaGroupName already exists.
|
||||
*
|
||||
* @param String $pykotaGroupName pykotaGroupName attribute value
|
||||
* @return boolean pykotaGroupName exists
|
||||
*/
|
||||
private function pykotaGroupNameExists($pykotaGroupName) {
|
||||
if ($this->pykotaGroupNameCache == null) {
|
||||
$this->loadGroupNameCache();
|
||||
}
|
||||
return in_array($pykotaGroupName, $this->pykotaGroupNameCache);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the list of group names into the cache.
|
||||
*/
|
||||
private function loadGroupNameCache() {
|
||||
$results = searchLDAPByFilter('(objectClass=pykotaGroup)', array('cn', 'pykotaGroupName'), array($this->get_scope()));
|
||||
$this->cnCache = array();
|
||||
$this->pykotaGroupNameCache = array();
|
||||
foreach ($results as $result) {
|
||||
if (isset($result['cn'][0])) {
|
||||
$this->cnCache[] = $result['cn'][0];
|
||||
}
|
||||
if (isset($result['pykotagroupname'][0])) {
|
||||
$this->pykotaGroupNameCache[] = $result['pykotagroupname'][0];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current group name (cn) of this account.
|
||||
*
|
||||
* @return String group name
|
||||
*/
|
||||
private function getCurrentGroupName() {
|
||||
if (!empty($this->attributes['cn'][0])) {
|
||||
return $this->attributes['cn'][0];
|
||||
}
|
||||
if ($this->getAccountContainer()->getAccountModule('posixGroup') != null) {
|
||||
$posix = $this->getAccountContainer()->getAccountModule('posixGroup');
|
||||
$attrs = $posix->getAttributes();
|
||||
if (!empty($attrs['cn'][0])) {
|
||||
return $attrs['cn'][0];
|
||||
}
|
||||
}
|
||||
if ($this->getAccountContainer()->getAccountModule('groupOfNames') != null) {
|
||||
$posix = $this->getAccountContainer()->getAccountModule('groupOfNames');
|
||||
$attrs = $posix->getAttributes();
|
||||
if (!empty($attrs['cn'][0])) {
|
||||
return $attrs['cn'][0];
|
||||
}
|
||||
}
|
||||
if ($this->getAccountContainer()->getAccountModule('groupOfUniqueNames') != null) {
|
||||
$posix = $this->getAccountContainer()->getAccountModule('groupOfUniqueNames');
|
||||
$attrs = $posix->getAttributes();
|
||||
if (!empty($attrs['cn'][0])) {
|
||||
return $attrs['cn'][0];
|
||||
}
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
?>
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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 PyKota group accounts.
|
||||
* This module is used when the structural object class pykotaObject should be used.
|
||||
*
|
||||
* @package modules
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/** include parent class */
|
||||
include_once("pykotaGroup.inc");
|
||||
|
||||
/**
|
||||
* Manages PyKota group accounts.
|
||||
*
|
||||
* @package modules
|
||||
*/
|
||||
class pykotaGroupStructural extends pykotaGroup {
|
||||
|
||||
/**
|
||||
* Returns if this module also manages the structural object class pykotaObject.
|
||||
* This is overridden by a submodule that must provide the structural object class.
|
||||
*
|
||||
* @return boolean structural usage
|
||||
*/
|
||||
public function isStructural() {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns meta data that is interpreted by parent class
|
||||
*
|
||||
* @return array array with meta data
|
||||
*
|
||||
* @see baseModule::get_metaData()
|
||||
*/
|
||||
function get_metaData() {
|
||||
$return = parent::get_metaData();
|
||||
// module dependencies
|
||||
$return['dependencies'] = array('depends' => array(), 'conflicts' => array('pykotaGroup'));
|
||||
// additional object class and attribute
|
||||
$return['objectClasses'][] = 'pykotaObject';
|
||||
// RDN attribute
|
||||
$return["RDN"] = array("cn" => "normal");
|
||||
return $return;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,689 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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 PyKota printers.
|
||||
*
|
||||
* @package modules
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/**
|
||||
* Manages PyKota printers.
|
||||
*
|
||||
* @package modules
|
||||
*/
|
||||
class pykotaPrinter extends baseModule {
|
||||
|
||||
/** cache for existing printers (array(dn => array(cn => ..., description => ...))) */
|
||||
private $printerCache = null;
|
||||
/** printer group cache */
|
||||
private $groupCache = null;
|
||||
/** list of pass through options: label => value */
|
||||
private $passThroughOptions;
|
||||
|
||||
/**
|
||||
* Creates a new pykotaPrinter object.
|
||||
*
|
||||
* @param string $scope account type (user, group, host)
|
||||
*/
|
||||
function __construct($scope) {
|
||||
$this->passThroughOptions = array(
|
||||
_('Yes') => 't',
|
||||
_('No') => 'f',
|
||||
);
|
||||
// call parent constructor
|
||||
parent::__construct($scope);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns meta data that is interpreted by parent class
|
||||
*
|
||||
* @return array array with meta data
|
||||
*
|
||||
* @see baseModule::get_metaData()
|
||||
*/
|
||||
function get_metaData() {
|
||||
$return = array();
|
||||
// icon
|
||||
$return['icon'] = 'printerBig.png';
|
||||
// manages host accounts
|
||||
$return["account_types"] = array('pykotaPrinterType');
|
||||
// alias name
|
||||
$return["alias"] = _("PyKota");
|
||||
// this is a base module
|
||||
$return["is_base"] = true;
|
||||
// RDN attribute
|
||||
$return["RDN"] = array("cn" => "high");
|
||||
// LDAP filter
|
||||
$return["ldap_filter"] = array('or' => "(objectClass=pykotaPrinter)");
|
||||
// module dependencies
|
||||
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
|
||||
// managed object classes
|
||||
$return['objectClasses'] = array('pykotaObject', 'pykotaPrinter');
|
||||
// managed attributes
|
||||
$return['attributes'] = array('cn', 'description', 'pykotaMaxJobSize', 'pykotaPassThrough', 'pykotaPricePerJob', 'pykotaPricePerPage', 'pykotaPrinterName', 'uniqueMember');
|
||||
// help Entries
|
||||
$return['help'] = array(
|
||||
'cn' => array(
|
||||
"Headline" => _("Printer name"), 'attr' => 'cn',
|
||||
"Text" => _("Printer name of the printer which should be created. Valid characters are: a-z, A-Z, 0-9 and .-_ .")
|
||||
),
|
||||
'description' => array (
|
||||
"Headline" => _("Description"), 'attr' => 'description',
|
||||
"Text" => _("Printer description.")
|
||||
),
|
||||
'pykotaMaxJobSize' => array(
|
||||
"Headline" => _('Maximum job size'), 'attr' => 'pykotaMaxJobSize',
|
||||
"Text" => _('The maximum number of pages per job allowed on the printer. 0 means unlimited.')
|
||||
),
|
||||
'pykotaPassThrough' => array(
|
||||
"Headline" => _('Passthrough'), 'attr' => 'pykotaPassThrough',
|
||||
"Text" => _('In passthrough mode, users are allowed to print without any impact on their quota or account balance.')
|
||||
),
|
||||
'pykotaPricePerJob' => array(
|
||||
"Headline" => _('Price per job'), 'attr' => 'pykotaPricePerJob',
|
||||
"Text" => _('The price for each print job.')
|
||||
),
|
||||
'pykotaPricePerPage' => array(
|
||||
"Headline" => _('Price per page'), 'attr' => 'pykotaPricePerPage',
|
||||
"Text" => _('The price for each page of a print job.')
|
||||
),
|
||||
'uniqueMember' => array(
|
||||
"Headline" => _('Group members'), 'attr' => 'uniqueMember',
|
||||
"Text" => _('If this entry should be a printer group then you can set the member names here.')
|
||||
),
|
||||
'uniqueMemberUpload' => array(
|
||||
"Headline" => _('Group members'), 'attr' => 'uniqueMember',
|
||||
"Text" => _('If this entry should be a printer group then you can set the member names here.')
|
||||
. ' ' . _('Multiple values are separated by comma.')
|
||||
),
|
||||
'filter' => array(
|
||||
"Headline" => _("Filter"),
|
||||
"Text" => _("Here you can enter a filter value. Only entries which contain the filter text will be shown.")
|
||||
. ' ' . _('Possible wildcards are: "*" = any character, "^" = line start, "$" = line end')
|
||||
),
|
||||
);
|
||||
// profile options
|
||||
$profileContainer = new htmlTable();
|
||||
$profileContainer->addElement(new htmlTableExtendedInputField(_('Maximum job size'), 'pykotaPrinter_pykotaMaxJobSize', '', 'pykotaMaxJobSize'), true);
|
||||
$return['profile_options'] = $profileContainer;
|
||||
$return['profile_mappings']['pykotaPrinter_pykotaMaxJobSize'] = 'pykotaMaxJobSize';
|
||||
$return['profile_checks']['pykotaPrinter_pykotaMaxJobSize'] = array(
|
||||
'type' => 'ext_preg',
|
||||
'regex' => 'digit',
|
||||
'error_message' => $this->messages['pykotaMaxJobSize'][0]);
|
||||
// upload fields
|
||||
$return['upload_columns'] = array(
|
||||
array(
|
||||
'name' => 'pykotaPrinter_cn',
|
||||
'description' => _('Printer name'),
|
||||
'help' => 'cn',
|
||||
'example' => _('printer01'),
|
||||
'required' => true,
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaPrinter_description',
|
||||
'description' => _('Description'),
|
||||
'help' => 'description',
|
||||
'example' => _('Color laser printer'),
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaPrinter_pykotaMaxJobSize',
|
||||
'description' => _('Maximum job size'),
|
||||
'help' => 'pykotaMaxJobSize',
|
||||
'example' => '100',
|
||||
'default' => '0',
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaPrinter_pykotaPassThrough',
|
||||
'description' => _('Passthrough'),
|
||||
'help' => 'pykotaPassThrough',
|
||||
'example' => _('No'),
|
||||
'default' => _('No'),
|
||||
'values' => _('Yes') . ', ' . _('No'),
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaPrinter_pykotaPricePerJob',
|
||||
'description' => _('Price per job'),
|
||||
'help' => 'pykotaPricePerJob',
|
||||
'example' => '0.01',
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaPrinter_pykotaPricePerPage',
|
||||
'description' => _('Price per page'),
|
||||
'help' => 'pykotaPricePerPage',
|
||||
'example' => '0.01',
|
||||
),
|
||||
array(
|
||||
'name' => 'pykotaPrinter_uniqueMember',
|
||||
'description' => _('Group members'),
|
||||
'help' => 'uniqueMemberUpload',
|
||||
'example' => _('printergroup1'),
|
||||
),
|
||||
);
|
||||
// available PDF fields
|
||||
$return['PDF_fields'] = array(
|
||||
'cn' => _('Printer name'),
|
||||
'description' => _('Description'),
|
||||
'pykotaMaxJobSize' => _('Maximum job size'),
|
||||
'pykotaPassThrough' => _('Passthrough'),
|
||||
'pykotaPricePerJob' => _('Price per job'),
|
||||
'pykotaPricePerPage' => _('Price per page'),
|
||||
'uniqueMember' => _('Group members'),
|
||||
'parentUniqueMember' => _('Printer groups'),
|
||||
);
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function fills the $messages variable with output messages from this module.
|
||||
*/
|
||||
function load_Messages() {
|
||||
$this->messages['cn'][0] = array('ERROR', _('Printer name'), _('Printer name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['cn'][1] = array('ERROR', _('Account %s:') . ' pykotaPrinter_cn', _('Printer name contains invalid characters. Valid characters are: a-z, A-Z, 0-9 and .-_ !'));
|
||||
$this->messages['cn'][2] = array('ERROR', _('Printer name'), _('Printer name already exists!'));
|
||||
$this->messages['cn'][3] = array('ERROR', _('Account %s:') . ' pykotaPrinter_cn', _('Printer name already exists!'));
|
||||
$this->messages['pykotaMaxJobSize'][0] = array('ERROR', _('Maximum job size'), _('Please enter a valid number.'));
|
||||
$this->messages['pykotaMaxJobSize'][1] = array('ERROR', _('Account %s:') . ' pykotaPrinter_pykotaMaxJobSize', _('Please enter a valid number.'));
|
||||
$this->messages['pykotaPricePerJob'][0] = array('ERROR', _('Price per job'), _('Please enter a valid number (e.g. "1.5").'));
|
||||
$this->messages['pykotaPricePerJob'][1] = array('ERROR', _('Account %s:') . ' pykotaPrinter_pykotaPricePerJob', _('Please enter a valid number (e.g. "1.5").'));
|
||||
$this->messages['pykotaPricePerPage'][0] = array('ERROR', _('Price per page'), _('Please enter a valid number (e.g. "1.5").'));
|
||||
$this->messages['pykotaPricePerPage'][1] = array('ERROR', _('Account %s:') . ' pykotaPrinter_pykotaPricePerPage', _('Please enter a valid number (e.g. "1.5").'));
|
||||
$this->messages['pykotaPassThrough'][0] = array('ERROR', _('Account %s:') . ' pykotaPrinter_pykotaPassThrough', _('Please enter "Yes" or "No".'));
|
||||
$this->messages['uniqueMember'][0] = array('ERROR', _('Account %s:') . ' pykotaPrinter_uniqueMember', _('Unable to find a printer with name "%s".'));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the HTML meta data for the main account page.
|
||||
*
|
||||
* @return htmlElement HTML meta data
|
||||
*/
|
||||
function display_html_attributes() {
|
||||
$container = new htmlTable();
|
||||
// cn
|
||||
$this->addSimpleInputTextField($container, 'cn', _('Printer name'), true);
|
||||
// job size
|
||||
$this->addSimpleInputTextField($container, 'pykotaMaxJobSize', _('Maximum job size'));
|
||||
// price per job
|
||||
$this->addSimpleInputTextField($container, 'pykotaPricePerJob', _('Price per job'));
|
||||
// price per page
|
||||
$this->addSimpleInputTextField($container, 'pykotaPricePerPage', _('Price per page'));
|
||||
// passthrough
|
||||
$pykotaPassThroughOption = 'f';
|
||||
if (!empty($this->attributes['pykotaPassThrough'][0])) {
|
||||
$pykotaPassThroughOption = $this->attributes['pykotaPassThrough'][0];
|
||||
}
|
||||
$pykotaPassThroughSelect = new htmlTableExtendedSelect('pykotaPassThrough', $this->passThroughOptions, array($pykotaPassThroughOption), _('Passthrough'), 'pykotaPassThrough');
|
||||
$pykotaPassThroughSelect->setHasDescriptiveElements(true);
|
||||
$container->addElement($pykotaPassThroughSelect);
|
||||
$container->addElement(new htmlSpacer('150px', null), true); // layout fix if many parent groups exist
|
||||
// description
|
||||
$this->addMultiValueInputTextField($container, 'description', _('Description'), false, null, true);
|
||||
// printer groups
|
||||
if (!$this->getAccountContainer()->isNewAccount) {
|
||||
$groups = $this->getPrinterGroups();
|
||||
$this->loadPrinterNameCache();
|
||||
$parentPrinters = array();
|
||||
foreach ($groups as $groupDN) {
|
||||
$parentPrinters[] = $this->printerCache[$groupDN]['cn'];
|
||||
}
|
||||
if (sizeof($parentPrinters) > 0) {
|
||||
$container->addElement(new htmlOutputText(_('Printer groups')));
|
||||
$parentPrinterText = new htmlOutputText(implode(', ', $parentPrinters));
|
||||
$parentPrinterText->colspan = 5;
|
||||
$container->addElement($parentPrinterText, true);
|
||||
}
|
||||
}
|
||||
// printer members
|
||||
$memberLabel = new htmlOutputText(_('Group members'));
|
||||
$memberLabel->alignment = htmlElement::ALIGN_TOP;
|
||||
$container->addElement($memberLabel);
|
||||
$addMemberButton = new htmlAccountPageButton(get_class($this), 'members', 'open', 'add.png', true);
|
||||
$addMemberButton->setTitle(_('Add'));
|
||||
$addMemberButton->alignment = htmlElement::ALIGN_TOP;
|
||||
if (!empty($this->attributes['uniqueMember'][0])) {
|
||||
$memberTable = new htmlTable();
|
||||
$memberTable->alignment = htmlElement::ALIGN_TOP;
|
||||
for ($i = 0; $i < sizeof($this->attributes['uniqueMember']); $i++) {
|
||||
$member = $this->attributes['uniqueMember'][$i];
|
||||
if (isset($this->printerCache[$member]['cn'])) {
|
||||
$member = $this->printerCache[$member]['cn'];
|
||||
}
|
||||
$memberTable->addElement(new htmlOutputText($member));
|
||||
$delButton = new htmlButton('uniqueMemberDel_' . $i, 'del.png', true);
|
||||
$delButton->setTitle(_('Delete'));
|
||||
$memberTable->addElement($delButton);
|
||||
if ($i == (sizeof($this->attributes['uniqueMember']) - 1)) {
|
||||
$memberTable->addElement($addMemberButton);
|
||||
}
|
||||
$memberTable->addNewLine();
|
||||
}
|
||||
$container->addElement($memberTable);
|
||||
}
|
||||
else {
|
||||
$container->addElement($addMemberButton);
|
||||
}
|
||||
$memberHelp = new htmlHelpLink('uniqueMember');
|
||||
$memberHelp->alignment = htmlElement::ALIGN_TOP;
|
||||
$container->addElement($memberHelp, true);
|
||||
return $container;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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();
|
||||
// cn
|
||||
if (isset($_POST['cn']) && ($_POST['cn'] != '')) {
|
||||
if (!get_preg($_POST['cn'], 'username')) {
|
||||
$errors[] = $this->messages['cn'][0];
|
||||
}
|
||||
else {
|
||||
$this->attributes['cn'][0] = $_POST['cn'];
|
||||
$this->attributes['pykotaPrinterName'][0] = $_POST['cn'];
|
||||
if ((!isset($this->orig['cn'][0]) || ($this->attributes['cn'][0] != $this->orig['cn'][0]))
|
||||
&& $this->cnExists($_POST['cn'])) {
|
||||
$errors[] = $this->messages['cn'][2];
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (isset($this->attributes['cn'][0])) {
|
||||
unset($this->attributes['cn'][0]);
|
||||
}
|
||||
if (isset($this->attributes['pykotaPrinterName'][0])) {
|
||||
unset($this->attributes['pykotaPrinterName'][0]);
|
||||
}
|
||||
}
|
||||
// description
|
||||
$this->processMultiValueInputTextField('description', $errors);
|
||||
// job size
|
||||
$pykotaMaxJobSize = '0';
|
||||
if (isset($_POST['pykotaMaxJobSize']) && ($_POST['pykotaMaxJobSize'] != '')) {
|
||||
$pykotaMaxJobSize = $_POST['pykotaMaxJobSize'];
|
||||
if (!get_preg($pykotaMaxJobSize, 'digit')) {
|
||||
$errors[] = $this->messages['pykotaMaxJobSize'][0];
|
||||
}
|
||||
}
|
||||
$this->attributes['pykotaMaxJobSize'][0] = $pykotaMaxJobSize;
|
||||
// price per job
|
||||
$pykotaPricePerJob = '0.0';
|
||||
if (isset($_POST['pykotaPricePerJob']) && ($_POST['pykotaPricePerJob'] != '')) {
|
||||
$pykotaPricePerJob = $_POST['pykotaPricePerJob'];
|
||||
$pykotaPricePerJob = str_replace(',', '.', $pykotaPricePerJob);
|
||||
if (strpos($pykotaPricePerJob, '.') === false) {
|
||||
$pykotaPricePerJob .= '.0';
|
||||
}
|
||||
if (!get_preg($pykotaPricePerJob, 'float')) {
|
||||
$errors[] = $this->messages['pykotaPricePerJob'][0];
|
||||
}
|
||||
}
|
||||
$this->attributes['pykotaPricePerJob'][0] = $pykotaPricePerJob;
|
||||
// price per page
|
||||
$pykotaPricePerPage = '0.0';
|
||||
if (isset($_POST['pykotaPricePerPage']) && ($_POST['pykotaPricePerPage'] != '')) {
|
||||
$pykotaPricePerPage = $_POST['pykotaPricePerPage'];
|
||||
$pykotaPricePerPage = str_replace(',', '.', $pykotaPricePerPage);
|
||||
if (strpos($pykotaPricePerPage, '.') === false) {
|
||||
$pykotaPricePerPage .= '.0';
|
||||
}
|
||||
if (!get_preg($pykotaPricePerPage, 'float')) {
|
||||
$errors[] = $this->messages['pykotaPricePerPage'][0];
|
||||
}
|
||||
}
|
||||
$this->attributes['pykotaPricePerPage'][0] = $pykotaPricePerPage;
|
||||
// passthrough
|
||||
$this->attributes['pykotaPassThrough'][0] = $_POST['pykotaPassThrough'];
|
||||
// delete members
|
||||
foreach ($_POST as $key => $value) {
|
||||
if (strpos($key, 'uniqueMemberDel_') === 0) {
|
||||
$index = substr($key, strlen('uniqueMemberDel_'));
|
||||
unset($this->attributes['uniqueMember'][$index]);
|
||||
$this->attributes['uniqueMember'] = array_values($this->attributes['uniqueMember']);
|
||||
break;
|
||||
}
|
||||
}
|
||||
return $errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function will create the meta HTML code to show a page to add members.
|
||||
*
|
||||
* @return htmlElement HTML meta data
|
||||
*/
|
||||
function display_html_members() {
|
||||
$return = new htmlTable();
|
||||
$userFilter = '';
|
||||
$userFilterRegex = '';
|
||||
if (isset($_POST['newFilter'])) {
|
||||
$userFilter = $_POST['newFilter'];
|
||||
$userFilterRegex = '/' . str_replace(array('*', '(', ')'), array('.*', '\(', '\)'), $_POST['newFilter']) . '/ui';
|
||||
}
|
||||
$options = array();
|
||||
$this->loadPrinterNameCache();
|
||||
foreach ($this->printerCache as $dn => $attrs) {
|
||||
if (!empty($attrs['description'])) {
|
||||
$label = $attrs['cn'] . ' (' . $attrs['description'] . ')';
|
||||
}
|
||||
else {
|
||||
$label = $attrs['cn'];
|
||||
}
|
||||
// skip filtered printers
|
||||
if (!empty($userFilter) && !preg_match($userFilterRegex, $label)) {
|
||||
continue;
|
||||
}
|
||||
// skip own entry
|
||||
if (!$this->getAccountContainer()->isNewAccount && ($this->getAccountContainer()->dn_orig == $dn)) {
|
||||
continue;
|
||||
}
|
||||
// skip already set members
|
||||
if (!empty($this->attributes['uniqueMember'][0]) && in_array($dn, $this->attributes['uniqueMember'])) {
|
||||
continue;
|
||||
}
|
||||
$options[$label] = $dn;
|
||||
}
|
||||
$size = 20;
|
||||
if (sizeof($options) < 20) $size = sizeof($options);
|
||||
$membersSelect = new htmlSelect('members', $options, array(), $size);
|
||||
$membersSelect->setHasDescriptiveElements(true);
|
||||
$membersSelect->setMultiSelect(true);
|
||||
$membersSelect->setTransformSingleSelect(false);
|
||||
$return->addElement($membersSelect, true);
|
||||
$filterGroup = new htmlGroup();
|
||||
$filterGroup->addElement(new htmlInputField('newFilter', $userFilter));
|
||||
$filterGroup->addElement(new htmlButton('setFilter', _('Filter')));
|
||||
$filterGroup->addElement(new htmlHelpLink('filter'));
|
||||
$return->addElement($filterGroup, true);
|
||||
$return->addElement(new htmlSpacer(null, '10px'), true);
|
||||
$buttonTable = new htmlTable();
|
||||
$buttonTable->addElement(new htmlAccountPageButton(get_class($this), 'attributes', 'addMembers', _('Add')));
|
||||
$buttonTable->addElement(new htmlAccountPageButton(get_class($this), 'attributes', 'cancel', _('Cancel')));
|
||||
$return->addElement($buttonTable);
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes user input of the members page.
|
||||
* It checks if all input values are correct and updates the associated LDAP attributes.
|
||||
*
|
||||
* @return array list of info/error messages
|
||||
*/
|
||||
function process_members() {
|
||||
$return = array();
|
||||
if (isset($_POST['form_subpage_' . get_class($this) . '_attributes_addMembers']) && isset($_POST['members'])) {
|
||||
for ($i = 0; $i < sizeof($_POST['members']); $i++) {
|
||||
$this->attributes['uniqueMember'][] = $_POST['members'][$i];
|
||||
}
|
||||
}
|
||||
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();
|
||||
$this->loadPrinterNameCache();
|
||||
for ($i = 0; $i < sizeof($rawAccounts); $i++) {
|
||||
// add object classes
|
||||
if (!in_array('pykotaPrinter', $partialAccounts[$i]['objectClass'])) {
|
||||
$partialAccounts[$i]['objectClass'][] = 'pykotaPrinter';
|
||||
}
|
||||
if (!in_array('pykotaObject', $partialAccounts[$i]['objectClass'])) {
|
||||
$partialAccounts[$i]['objectClass'][] = 'pykotaObject';
|
||||
}
|
||||
// cn
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_cn']])) {
|
||||
if (!get_preg($rawAccounts[$i][$ids['pykotaPrinter_cn']], 'username')) {
|
||||
$errMsg = $this->messages['cn'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
elseif ($this->cnExists($rawAccounts[$i][$ids['pykotaPrinter_cn']])) {
|
||||
$errMsg = $this->messages['cn'][3];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['cn'] = $rawAccounts[$i][$ids['pykotaPrinter_cn']];
|
||||
$partialAccounts[$i]['pykotaPrinterName'] = $rawAccounts[$i][$ids['pykotaPrinter_cn']];
|
||||
}
|
||||
}
|
||||
// description
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_description']])) {
|
||||
$partialAccounts[$i]['description'] = $rawAccounts[$i][$ids['pykotaPrinter_description']];
|
||||
}
|
||||
// job size
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_pykotaMaxJobSize']])) {
|
||||
$pykotaMaxJobSize = $rawAccounts[$i][$ids['pykotaPrinter_pykotaMaxJobSize']];
|
||||
if (!get_preg($pykotaMaxJobSize, 'digit')) {
|
||||
$errMsg = $this->messages['pykotaMaxJobSize'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaMaxJobSize'] = $pykotaMaxJobSize;
|
||||
}
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaMaxJobSize'] = '0.0';
|
||||
}
|
||||
// price per job
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_pykotaPricePerJob']])) {
|
||||
$pykotaPricePerJob = $rawAccounts[$i][$ids['pykotaPrinter_pykotaPricePerJob']];
|
||||
$pykotaPricePerJob = str_replace(',', '.', $pykotaPricePerJob);
|
||||
if (strpos($pykotaPricePerJob, '.') === false) {
|
||||
$pykotaPricePerJob .= '.0';
|
||||
}
|
||||
if (!get_preg($pykotaPricePerJob, 'float')) {
|
||||
$errMsg = $this->messages['pykotaPricePerJob'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaPricePerJob'] = $pykotaPricePerJob;
|
||||
}
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaPricePerJob'] = '0.0';
|
||||
}
|
||||
// price per page
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_pykotaPricePerPage']])) {
|
||||
$pykotaPricePerPage = $rawAccounts[$i][$ids['pykotaPrinter_pykotaPricePerPage']];
|
||||
$pykotaPricePerPage = str_replace(',', '.', $pykotaPricePerPage);
|
||||
if (strpos($pykotaPricePerPage, '.') === false) {
|
||||
$pykotaPricePerPage .= '.0';
|
||||
}
|
||||
if (!get_preg($pykotaPricePerPage, 'float')) {
|
||||
$errMsg = $this->messages['pykotaPricePerPage'][1];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaPricePerPage'] = $pykotaPricePerPage;
|
||||
}
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaPricePerPage'] = '0.0';
|
||||
}
|
||||
// passthrough
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_pykotaPassThrough']])) {
|
||||
if (isset($this->passThroughOptions[$rawAccounts[$i][$ids['pykotaPrinter_pykotaPassThrough']]])) {
|
||||
$partialAccounts[$i]['pykotaPassThrough'] = $this->passThroughOptions[$rawAccounts[$i][$ids['pykotaPrinter_pykotaPassThrough']]];
|
||||
}
|
||||
else {
|
||||
$errMsg = $this->messages['pykotaPassThrough'][0];
|
||||
array_push($errMsg, array($i));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
}
|
||||
else {
|
||||
$partialAccounts[$i]['pykotaPassThrough'] = 'f';
|
||||
}
|
||||
// group members
|
||||
if (!empty($rawAccounts[$i][$ids['pykotaPrinter_uniqueMember']])) {
|
||||
$members = preg_split('/,[ ]*/', $rawAccounts[$i][$ids['pykotaPrinter_uniqueMember']]);
|
||||
$memberDNs = array();
|
||||
foreach ($members as $cn) {
|
||||
if (empty($cn)) {
|
||||
continue;
|
||||
}
|
||||
// search printer cache for cn to get DN
|
||||
$found = false;
|
||||
foreach ($this->printerCache as $dn => $attrs) {
|
||||
if ($this->printerCache[$dn]['cn'] == $cn) {
|
||||
$found = true;
|
||||
$memberDNs[] = $dn;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!$found) {
|
||||
$errMsg = $this->messages['uniqueMember'][0];
|
||||
array_push($errMsg, array($i, htmlspecialchars($cn)));
|
||||
$messages[] = $errMsg;
|
||||
}
|
||||
}
|
||||
if (sizeof($memberDNs) > 0) {
|
||||
$partialAccounts[$i]['uniqueMember'] = $memberDNs;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $messages;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of PDF entries
|
||||
*/
|
||||
function get_pdfEntries() {
|
||||
$return = array();
|
||||
$this->loadPrinterNameCache();
|
||||
$this->addSimplePDFField($return, 'cn', _('Printer name'));
|
||||
$this->addSimplePDFField($return, 'description', _('Description'));
|
||||
$this->addSimplePDFField($return, 'pykotaMaxJobSize', _('Maximum job size'));
|
||||
$this->addSimplePDFField($return, 'pykotaPricePerJob', _('Price per job'));
|
||||
$this->addSimplePDFField($return, 'pykotaPricePerPage', _('Price per page'));
|
||||
// passthrough
|
||||
$passthroughOptions = array_flip($this->passThroughOptions);
|
||||
$passthroughValue = '';
|
||||
if (!empty($this->attributes['pykotaPassThrough'][0]) && isset($passthroughOptions[$this->attributes['pykotaPassThrough'][0]])) {
|
||||
$passthroughValue = $passthroughOptions[$this->attributes['pykotaPassThrough'][0]];
|
||||
}
|
||||
$return[get_class($this) . '_pykotaPassThrough'] = array('<block><key>' . _('Passthrough') . '</key><value>' . $passthroughValue . '</value></block>');
|
||||
// members
|
||||
if (!empty($this->attributes['uniqueMember'][0])) {
|
||||
$members = array();
|
||||
foreach ($this->attributes['uniqueMember'] as $member) {
|
||||
if (!empty($this->printerCache[$member]['cn'])) {
|
||||
$members[] = $this->printerCache[$member]['cn'];
|
||||
}
|
||||
else {
|
||||
$members[] = getAbstractDN($member);
|
||||
}
|
||||
}
|
||||
$return[get_class($this) . '_uniqueMember'] = array('<block><key>' . _('Group members') . '</key><value>' . implode(', ', $members) . '</value></block>');
|
||||
}
|
||||
// printer groups
|
||||
$parentGroups = array();
|
||||
$groups = $this->getPrinterGroups();
|
||||
foreach ($groups as $group) {
|
||||
if (!empty($this->printerCache[$group]['cn'])) {
|
||||
$parentGroups[] = $this->printerCache[$group]['cn'];
|
||||
}
|
||||
else {
|
||||
$parentGroups[] = getAbstractDN($group);
|
||||
}
|
||||
}
|
||||
if (sizeof($parentGroups) > 0) {
|
||||
$return[get_class($this) . '_parentUniqueMember'] = array('<block><key>' . _('Printer groups') . '</key><value>' . implode(', ', $parentGroups) . '</value></block>');
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns if the given cn already exists.
|
||||
*
|
||||
* @param String $cn cn attribute value
|
||||
* @return boolean cn exists
|
||||
*/
|
||||
private function cnExists($cn) {
|
||||
if ($this->printerCache == null) {
|
||||
$this->loadPrinterNameCache();
|
||||
}
|
||||
foreach ($this->printerCache as $dn => $attrs) {
|
||||
if (!empty($attrs['cn']) && ($attrs['cn'] == $cn)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the list of printer names into the cache.
|
||||
*/
|
||||
private function loadPrinterNameCache() {
|
||||
if ($this->printerCache != null) {
|
||||
return;
|
||||
}
|
||||
$results = searchLDAPByFilter('(objectClass=pykotaPrinter)', array('cn', 'dn', 'description'), array($this->get_scope()));
|
||||
$this->printerCache = array();
|
||||
foreach ($results as $result) {
|
||||
if (isset($result['cn'][0])) {
|
||||
$this->printerCache[$result['dn']]['cn'] = $result['cn'][0];
|
||||
}
|
||||
if (isset($result['description'][0])) {
|
||||
$this->printerCache[$result['dn']]['description'] = $result['description'][0];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the printer group memberships.
|
||||
*
|
||||
* @return array DNs of parent groups
|
||||
*/
|
||||
private function getPrinterGroups() {
|
||||
if ($this->groupCache != null) {
|
||||
return $this->groupCache;
|
||||
}
|
||||
$results = searchLDAPByFilter('(&(objectClass=pykotaPrinter)(uniqueMember=' . $this->getAccountContainer()->dn_orig . '))', array('dn'), array($this->get_scope()));
|
||||
$this->groupCache = array();
|
||||
foreach ($results as $result) {
|
||||
$this->groupCache[] = $result['dn'];
|
||||
}
|
||||
return $this->groupCache;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
?>
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,70 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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 PyKota user accounts.
|
||||
* This module is used when the structural object class pykotaObject should be used.
|
||||
*
|
||||
* @package modules
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/** include parent class */
|
||||
include_once("pykotaUser.inc");
|
||||
|
||||
/**
|
||||
* Manages PyKota user accounts.
|
||||
*
|
||||
* @package modules
|
||||
*/
|
||||
class pykotaUserStructural extends pykotaUser {
|
||||
|
||||
/**
|
||||
* Returns if this module also manages the structural object class pykotaObject.
|
||||
* This is overridden by a submodule that must provide the structural object class.
|
||||
*
|
||||
* @return boolean structural usage
|
||||
*/
|
||||
public function isStructural() {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns meta data that is interpreted by parent class
|
||||
*
|
||||
* @return array array with meta data
|
||||
*
|
||||
* @see baseModule::get_metaData()
|
||||
*/
|
||||
function get_metaData() {
|
||||
$return = parent::get_metaData();
|
||||
// module dependencies
|
||||
$return['dependencies'] = array('depends' => array(), 'conflicts' => array('pykotaUser'));
|
||||
// additional object class and attribute
|
||||
$return['objectClasses'][] = 'pykotaObject';
|
||||
$return['attributes'][] = 'cn';
|
||||
// RDN attribute
|
||||
$return["RDN"] = array("cn" => "normal", 'uid' => 'low');
|
||||
return $return;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,172 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
* The account type for PyKota billing codes.
|
||||
*
|
||||
* @package types
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/**
|
||||
* The account type for PyKota billing codes.
|
||||
*
|
||||
* @package types
|
||||
*/
|
||||
class pykotaBillingCodeType extends baseType {
|
||||
|
||||
/**
|
||||
* Constructs a new billing code object.
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct();
|
||||
$this->LABEL_CREATE_ANOTHER_ACCOUNT = _('Create another billing code');
|
||||
$this->LABEL_BACK_TO_ACCOUNT_LIST = _('Back to billing code list');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the alias name of this account type.
|
||||
*
|
||||
* @return string alias name
|
||||
*/
|
||||
function getAlias() {
|
||||
return _("Billing codes");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the description of this account type.
|
||||
*
|
||||
* @return string description
|
||||
*/
|
||||
function getDescription() {
|
||||
return _("PyKota billing codes");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the class name for the list object.
|
||||
*
|
||||
* @return string class name
|
||||
*/
|
||||
function getListClassName() {
|
||||
return "lamPykotaBillingCodeTypeList";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the default attribute list for this account type.
|
||||
*
|
||||
* @return string attribute list
|
||||
*/
|
||||
function getDefaultListAttributes() {
|
||||
return "#cn;#description;#pykotaBalance;#pykotaPageCounter";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of attributes which have a translated description.
|
||||
* This is used for the head row in the list view.
|
||||
*
|
||||
* @return array list of descriptions
|
||||
*/
|
||||
function getListAttributeDescriptions() {
|
||||
return array (
|
||||
"cn" => _('Billing code'),
|
||||
"description" => _('Description'),
|
||||
'pykotaBalance' => _('Balance'),
|
||||
'pykotaPageCounter' => _('Page count'),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the the title text for the title bar on the new/edit page.
|
||||
*
|
||||
* @param accountContainer $container account container
|
||||
* @return String title text
|
||||
*/
|
||||
public function getTitleBarTitle($container) {
|
||||
// get attributes
|
||||
$attributes = array();
|
||||
if ($container->getAccountModule('pykotaBillingCode') != null) {
|
||||
$attributes = $container->getAccountModule('pykotaBillingCode')->getAttributes();
|
||||
}
|
||||
// check if pykotaBillingCode is set
|
||||
if (isset($attributes['pykotaBillingCode'][0])) {
|
||||
return htmlspecialchars($attributes['pykotaBillingCode'][0]);
|
||||
}
|
||||
// show new label
|
||||
if ($container->isNewAccount) {
|
||||
return _("New billing code");
|
||||
}
|
||||
// fall back to default
|
||||
return parent::getTitleBarTitle($container);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the the subtitle text for the title bar on the new/edit page.
|
||||
*
|
||||
* @param accountContainer $container account container
|
||||
* @return String title text
|
||||
*/
|
||||
public function getTitleBarSubtitle($container) {
|
||||
// get attributes
|
||||
$attributes = array();
|
||||
if ($container->getAccountModule('pykotaBillingCode') != null) {
|
||||
$attributes = $container->getAccountModule('pykotaBillingCode')->getAttributes();
|
||||
}
|
||||
// check if description is set
|
||||
if (isset($attributes['description'][0])) {
|
||||
return htmlspecialchars($attributes['description'][0]);
|
||||
}
|
||||
// fall back to default
|
||||
return parent::getTitleBarSubtitle($container);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Generates the list view.
|
||||
*
|
||||
* @package lists
|
||||
* @author Roland Gruber
|
||||
*
|
||||
*/
|
||||
class lamPykotaBillingCodeTypeList extends lamList {
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $type account type
|
||||
* @return lamList list object
|
||||
*/
|
||||
function __construct($type) {
|
||||
parent::__construct($type);
|
||||
$this->labels = array(
|
||||
'nav' => _("Billing code count: %s"),
|
||||
'error_noneFound' => _("No billing codes found!"),
|
||||
'newEntry' => _("New billing code"),
|
||||
'deleteEntry' => _("Delete selected billing codes"));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
?>
|
||||
|
|
@ -0,0 +1,173 @@
|
|||
<?php
|
||||
/*
|
||||
$Id$
|
||||
|
||||
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
|
||||
Copyright (C) 2013 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
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
* The account type for PyKota printers.
|
||||
*
|
||||
* @package types
|
||||
* @author Roland Gruber
|
||||
*/
|
||||
|
||||
/**
|
||||
* The account type for PyKota printers.
|
||||
*
|
||||
* @package types
|
||||
*/
|
||||
class pykotaPrinterType extends baseType {
|
||||
|
||||
/**
|
||||
* Constructs a new printer type object.
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct();
|
||||
$this->LABEL_CREATE_ANOTHER_ACCOUNT = _('Create another printer');
|
||||
$this->LABEL_BACK_TO_ACCOUNT_LIST = _('Back to printer list');
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the alias name of this account type.
|
||||
*
|
||||
* @return string alias name
|
||||
*/
|
||||
function getAlias() {
|
||||
return _("Printers");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the description of this account type.
|
||||
*
|
||||
* @return string description
|
||||
*/
|
||||
function getDescription() {
|
||||
return _("PyKota printers");
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the class name for the list object.
|
||||
*
|
||||
* @return string class name
|
||||
*/
|
||||
function getListClassName() {
|
||||
return "lamPykotaPrinterTypeList";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the default attribute list for this account type.
|
||||
*
|
||||
* @return string attribute list
|
||||
*/
|
||||
function getDefaultListAttributes() {
|
||||
return "#cn;#description;#pykotaPricePerPage;#pykotaPricePerJob;#pykotaMaxJobSize";
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of attributes which have a translated description.
|
||||
* This is used for the head row in the list view.
|
||||
*
|
||||
* @return array list of descriptions
|
||||
*/
|
||||
function getListAttributeDescriptions() {
|
||||
return array (
|
||||
"cn" => _('Printer name'),
|
||||
"description" => _('Description'),
|
||||
'pykotaPricePerPage' => _('Price per page'),
|
||||
'pykotaPricePerJob' => _('Price per job'),
|
||||
'pykotaMaxJobSize' => _('Maximum job size'),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the the title text for the title bar on the new/edit page.
|
||||
*
|
||||
* @param accountContainer $container account container
|
||||
* @return String title text
|
||||
*/
|
||||
public function getTitleBarTitle($container) {
|
||||
// get attributes
|
||||
$attributes = array();
|
||||
if ($container->getAccountModule('pykotaPrinter') != null) {
|
||||
$attributes = $container->getAccountModule('pykotaPrinter')->getAttributes();
|
||||
}
|
||||
// check if cn is set
|
||||
if (isset($attributes['cn'][0])) {
|
||||
return htmlspecialchars($attributes['cn'][0]);
|
||||
}
|
||||
// show new publication label
|
||||
if ($container->isNewAccount) {
|
||||
return _("New printer");
|
||||
}
|
||||
// fall back to default
|
||||
return parent::getTitleBarTitle($container);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the the subtitle text for the title bar on the new/edit page.
|
||||
*
|
||||
* @param accountContainer $container account container
|
||||
* @return String title text
|
||||
*/
|
||||
public function getTitleBarSubtitle($container) {
|
||||
// get attributes
|
||||
$attributes = array();
|
||||
if ($container->getAccountModule('pykotaPrinter') != null) {
|
||||
$attributes = $container->getAccountModule('pykotaPrinter')->getAttributes();
|
||||
}
|
||||
// check if description is set
|
||||
if (isset($attributes['description'][0])) {
|
||||
return htmlspecialchars($attributes['description'][0]);
|
||||
}
|
||||
// fall back to default
|
||||
return parent::getTitleBarSubtitle($container);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Generates the list view.
|
||||
*
|
||||
* @package lists
|
||||
* @author Roland Gruber
|
||||
*
|
||||
*/
|
||||
class lamPykotaPrinterTypeList extends lamList {
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $type account type
|
||||
* @return lamList list object
|
||||
*/
|
||||
function __construct($type) {
|
||||
parent::__construct($type);
|
||||
$this->labels = array(
|
||||
'nav' => _("Printer count: %s"),
|
||||
'error_noneFound' => _("No printers found!"),
|
||||
'newEntry' => _("New printer"),
|
||||
'deleteEntry' => _("Delete selected printers"));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
?>
|
||||
Loading…
Reference in New Issue