<?php
/*
$Id$
This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
Copyright (C) 2004 - 2015 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
*/
/**
* Provides NIS mail alias management.
*
* @package modules
* @author Roland Gruber
*/
/**
* Provides NIS mail alias management.
*
* @package modules
*/
class nisMailAlias extends baseModule {
/** mail cache */
private $cachedMailList = null;
/** user cache */
private $cachedUserList = null;
/** display limit */
const DISPLAY_LIMIT = 50;
/**
* Returns true if this module can manage accounts of the current type, otherwise false.
*
* @return boolean true if module fits
*/
public function can_manage() {
return in_array($this->get_scope(), array('mailAlias'));
}
/**
* 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'] = 'mailBig.png';
// base module
$return["is_base"] = true;
// LDAP filter
$return["ldap_filter"] = array('or' => "(objectClass=nisMailAlias)");
// alias name
$return["alias"] = _("Mail aliases");
// RDN attribute
$return["RDN"] = array("cn" => "normal");
// module dependencies
$return['dependencies'] = array('depends' => array(), 'conflicts' => array());
// managed object classes
$return['objectClasses'] = array('nisMailAlias');
// managed attributes
$return['attributes'] = array('cn', 'rfc822MailMember');
// help Entries
$return['help'] = array(
'alias' => array(
"Headline" => _("Alias name"), 'attr' => 'cn',
"Text" => _("Mails to this name are forwarded to the recipients.")
),
'recipient' => array(
"Headline" => _("Recipients"), 'attr' => 'rfc822MailMember',
"Text" => _("Please enter the recipients for this alias.")
),
'recipientList' => array(
"Headline" => _("Recipient list"), 'attr' => 'rfc822MailMember',
"Text" => _("This is a comma separated list of recipients.")
),
'filter' => array(
"Headline" => _("Filter"),
"Text" => _("Here you can enter a filter value. Only entries which contain the filter text will be shown.")
),
);
// upload fields
$return['upload_columns'] = array(
array(
'name' => 'nisMailAlias_alias',
'description' => _('Alias name'),
'help' => 'alias',
'example' => 'root',
'required' => true
),
array(
'name' => 'nisMailAlias_recipients',
'description' => _('Recipient list'),
'help' => 'recipientList',
'example' => _('smiller')
)
);
// available PDF fields
$return['PDF_fields'] = array(
'alias' => _('Alias name'),
'recipients' => _('Recipient list')
);
return $return;
}
/**
* This function fills the error message array with messages
*/
function load_Messages() {
$this->messages['alias'][0] = array('ERROR', _('Alias is empty or invalid!')); // third array value is set dynamically
$this->messages['alias'][1] = array('ERROR', _('Account %s:') . ' nisMailAlias_alias', _('Alias is empty or invalid!'));
$this->messages['recipient'][0] = array('ERROR', _('Recipient is invalid!')); // third array value is set dynamically
$this->messages['recipient'][1] = array('ERROR', _('Account %s:') . ' nisMailAlias_recipient', _('Recipient is invalid!'));
}
/**
* Returns a list of modifications which have to be made to the LDAP account.
*
* @return array list of modifications
* <br>This function returns an array with 3 entries:
* <br>array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... )
* <br>DN is the DN to change. It may be possible to change several DNs (e.g. create a new user and add him to some groups via attribute memberUid)
* <br>"add" are attributes which have to be added to LDAP entry
* <br>"remove" are attributes which have to be removed from LDAP entry
* <br>"modify" are attributes which have to been modified in LDAP entry
* <br>"info" are values with informational value (e.g. to be used later by pre/postModify actions)
*/
function save_attributes() {
// skip saving if account is based on another structural object class
if (!$this->getAccountContainer()->isNewAccount && !in_array('nisMailAlias', $this->getAccountContainer()->attributes_orig['objectClass'])) {
return array();
}
return parent::save_attributes();
}
/**
* Returns the HTML meta data for the main account page.
*
* @return htmlElement HTML meta data
*/
function display_html_attributes() {
$return = new htmlTable();
// alias name
$alias = '';
if (isset($this->attributes['cn'][0])) {
$alias = $this->attributes['cn'][0];
}
$nameInput = new htmlTableExtendedInputField(_('Alias name'), 'cn', $alias, 'alias');
$nameInput->setRequired(true);
$return->addElement($nameInput, true);
// list current recipients
$mailList = $this->getMailList();
$userList = $this->getUserList();
$autoList = array();
if ((sizeof($userList) + sizeof($mailList)) < 300) {
$autoList = array_merge($userList, $mailList);
}
$recipientCount = 0;
if (isset($this->attributes['rfc822MailMember'])) {
natcasesort($this->attributes['rfc822MailMember']);
$this->attributes['rfc822MailMember'] = array_values($this->attributes['rfc822MailMember']);
$recipientCount = sizeof($this->attributes['rfc822MailMember']);
if ($recipientCount < nisMailAlias::DISPLAY_LIMIT) {
for ($i = 0; $i < $recipientCount; $i++) {
if (($i == 0) && ($recipientCount == 1)) {
$return->addElement(new htmlOutputText(_('Recipient')));
}
elseif (($i == 0) && ($recipientCount > 1)) {
$return->addElement(new htmlOutputText(_('Recipients')));
}
else {
$return->addElement(new htmlOutputText(''));
}
$mailField = new htmlInputField('rfc822MailMember' . $i, $this->attributes['rfc822MailMember'][$i]);
if (sizeof($autoList) > 0) {
$mailField->enableAutocompletion($autoList);
}
$return->addElement($mailField);
$return->addElement(new htmlAccountPageButton(get_class($this), 'selectMail', 'recipient' . $i, 'mailAlias.png', true, _('Select mail')));
$return->addElement(new htmlAccountPageButton(get_class($this), 'selectUser', 'recipient' . $i, 'user.png', true, _('Select user')));
$return->addElement(new htmlButton('delRec' . $i, 'del.png', true));
$return->addElement(new htmlHelpLink('recipient'), true);
}
}
else {
$memberText = implode("\r\n", $this->attributes['rfc822MailMember']);
$return->addElement(new htmlTableExtendedInputTextarea('rfc822MailMember', $memberText, 50, 30, _('Recipients'), 'recipient'), true);
$return->addElement(new htmlEqualWidth(array('cn', 'rfc822MailMember')), true);
}
}
if ($recipientCount < nisMailAlias::DISPLAY_LIMIT) {
// input box for new recipient
$return->addElement(new htmlOutputText(_('New recipient')));
$newMailField = new htmlInputField('rfc822MailMember');
$newMailField->setOnKeyPress('SubmitForm(\'addRec\', event);');
if (sizeof($autoList) > 0) {
$newMailField->enableAutocompletion($autoList);
}
$return->addElement($newMailField);
$return->addElement(new htmlAccountPageButton(get_class($this), 'selectMail', 'recipient' . 'New', 'mailAlias.png', true, _('Select mail')));
$return->addElement(new htmlAccountPageButton(get_class($this), 'selectUser', 'recipient' . 'New', 'user.png', true, _('Select user')));
$return->addElement(new htmlButton('addRec', 'add.png', true));
$return->addElement(new htmlHelpLink('recipient'));
$return->addElement(new htmlHiddenInput('rec_number', $recipientCount));
}
return $return;
}
/**
* Processes user input of the primary module page.
* It checks if all input values are correct and updates the associated LDAP attributes.
*
* @return array list of info/error messages
*/
function process_attributes() {
$errors = array();
$this->attributes['cn'] = array();
$recipientCount = !empty($this->attributes['rfc822MailMember']) ? sizeof($this->attributes['rfc822MailMember']) : 0;
$this->attributes['rfc822MailMember'] = array();
// check alias name
if (isset($_POST['cn']) && ($_POST['cn'] != "") && get_preg($_POST['cn'], 'nis_alias')) {
$this->attributes['cn'][] = $_POST['cn'];
}
else {
$this->attributes['cn'][] = $_POST['cn'];
$message = $this->messages['alias'][0];
$message[] = $_POST['cn'];
$errors[] = $message;
}
if ($recipientCount < nisMailAlias::DISPLAY_LIMIT) {
// check old recipients
if (isset($_POST['rec_number'])) {
for ($i = 0; $i < $_POST['rec_number']; $i++) {
if (isset($_POST['delRec' . $i])) continue;
if (isset($_POST['rfc822MailMember' . $i]) && ($_POST['rfc822MailMember' . $i] != "")) {
// check if address has correct format
if (!get_preg($_POST['rfc822MailMember' . $i], 'nis_recipient') && !get_preg($_POST['rfc822MailMember' . $i], 'email')) {
$message = $this->messages['recipient'][0];
$message[] = $_POST['rfc822MailMember' . $i];
$errors[] = $message;
}
$this->attributes['rfc822MailMember'][] = $_POST['rfc822MailMember' . $i];
}
}
}
// check new recipient
if (isset($_POST['rfc822MailMember']) && ($_POST['rfc822MailMember'] != "")) {
// check if recipient has correct format
if (get_preg($_POST['rfc822MailMember'], 'nis_recipient') || get_preg($_POST['rfc822MailMember'], 'email')) {
$this->attributes['rfc822MailMember'][] = $_POST['rfc822MailMember'];
}
else {
$message = $this->messages['recipient'][0];
$message[] = $_POST['rfc822MailMember'];
$errors[] = $message;
}
}
}
else {
$recipients = explode("\r\n", $_POST['rfc822MailMember']);
foreach ($recipients as $recipient) {
$recipient = trim($recipient);
if (empty($recipient)) {
continue;
}
$this->attributes['rfc822MailMember'][] = $recipient;
// check if recipient has correct format
if (!get_preg($recipient, 'nis_recipient') && !get_preg($recipient, 'email')) {
$message = $this->messages['recipient'][0];
$message[] = htmlspecialchars($recipient);
$errors[] = $message;
}
}
}
$this->attributes['rfc822MailMember'] = array_unique($this->attributes['rfc822MailMember']);
return $errors;
}
/**
* Displays the mail selection.
*
* @return htmlElement meta HTML code
*/
function display_html_selectMail() {
return $this->display_html_select(true);
}
/**
* Processes user input of the host/user selection page.
* It checks if all input values are correct and updates the associated LDAP attributes.
*
* @return array list of info/error messages
*/
function process_selectMail() {
return $this->process_select();
}
/**
* Displays the user selection.
*
* @return htmlElement meta HTML code
*/
function display_html_selectUser() {
return $this->display_html_select(false);
}
/**
* Processes user input of the host/user selection page.
* It checks if all input values are correct and updates the associated LDAP attributes.
*
* @return array list of info/error messages
*/
function process_selectUser() {
return $this->process_select();
}
/**
* Displays the user/mail selection.
*
* @param boolean $isMail mail selection (user selection if false)
* @return htmlElement meta HTML code
*/
function display_html_select($isMail) {
$options = array();
if ($isMail) {
$regex = 'email';
$options = $this->getMailList();
$suffix = 'Mail';
$label = _('Email');
}
else {
$regex = 'username';
$options = $this->getUserList();
$suffix = 'User';
$label = _('User');
}
$return = new htmlTable();
$postKeys = array_keys($_POST);
$position = 'New';
$filter = '';
if (isset($_POST['dofilter'])) {
$filter = $_POST['filter'];
}
for ($i = 0; $i < sizeof($postKeys); $i++) {
if (strpos($postKeys[$i], 'form_subpage_' . get_class($this) . '_select' . $suffix . '_recipient') === 0) {
$position = substr($postKeys[$i], strlen('form_subpage_' . get_class($this) . '_select' . $suffix . '_recipient'));
break;
}
}
// load list with all mail addresses
$count = sizeof($options);
for ($i = 0; $i < $count; $i++) {
if (!get_preg($options[$i], $regex) || (!empty($filter) && !preg_match('/' . str_replace('*', '.*', $filter) . '/ui', $options[$i]))) {
unset($options[$i]);
}
}
$options = array_values($options);
$return->addElement(new htmlOutputText(_('Filter')));
$return->addElement(new htmlInputField('filter', $filter));
$return->addElement(new htmlButton('dofilter', _('Ok')));
$return->addElement(new htmlHelpLink('filter'), true);
$return->addElement(new htmlOutputText($label));
$mailSelect = new htmlSelect('selectBox', $options, array(), 15);
$mailSelect->setMultiSelect($position === 'New');
$mailSelect->colspan = 5;
$return->addElement($mailSelect, true);
$return->addElement(new htmlSpacer(null, '10px'), true);
$buttonContainer = new htmlTable();
$buttonContainer->addElement(new htmlAccountPageButton(get_class($this), 'attributes', 'select', _('Ok')));
$buttonContainer->addElement(new htmlAccountPageButton(get_class($this), 'attributes', 'back', _('Cancel')));
$buttonContainer->colspan = 4;
$return->addElement($buttonContainer, true);
$return->addElement(new htmlHiddenInput('position', $position));
return $return;
}
/**
* Processes user input of the host/user selection page.
* It checks if all input values are correct and updates the associated LDAP attributes.
*
* @return array list of info/error messages
*/
function process_select() {
if (isset($_POST['form_subpage_' . get_class($this) . '_attributes_select'])) {
if (!isset($this->attributes['rfc822MailMember'])) {
$this->attributes['rfc822MailMember'] = array();
}
$position = $_POST['position'];
if ($position == 'New') {
$this->attributes['rfc822MailMember'] = array_merge($this->attributes['rfc822MailMember'], $_POST['selectBox']);
}
else {
$this->attributes['rfc822MailMember'][$_POST['position']] = $_POST['selectBox'];
}
return array();
}
return array();
}
/**
* Controls if the module button the account page is visible and activated.
*
* @return string status ("enabled", "disabled", "hidden")
*/
function getButtonStatus() {
if (!$this->getAccountContainer()->isNewAccount) {
// check if account is based on our object class
$objectClasses = $this->getAccountContainer()->attributes_orig['objectClass'];
if (is_array($objectClasses) && !in_array('nisMailAlias', $objectClasses)) {
return "disabled";
}
}
return "enabled";
}
/**
* In this function the LDAP account is built up.
*
* @param array $rawAccounts list of hash arrays (name => value) from user input
* @param array $ids list of IDs for column position (e.g. "posixAccount_uid" => 5)
* @param array $partialAccounts list of hash arrays (name => value) which are later added to LDAP
* @param array $selectedModules list of selected account modules
* @return array list of error messages if any
*/
function build_uploadAccounts($rawAccounts, $ids, &$partialAccounts, $selectedModules) {
$messages = array();
for ($i = 0; $i < sizeof($rawAccounts); $i++) {
// add object class
if (!in_array("nisMailAlias", $partialAccounts[$i]['objectClass'])) $partialAccounts[$i]['objectClass'][] = "nisMailAlias";
// add alias name
$this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'nisMailAlias_alias', 'cn',
'nis_alias', $this->messages['alias'][1], $messages);
// add recipients
if ($rawAccounts[$i][$ids['nisMailAlias_recipients']] != "") {
$aliases = explode(',', $rawAccounts[$i][$ids['nisMailAlias_recipients']]);
// check format
for ($a = 0; $a < sizeof($aliases); $a++) {
if (get_preg($aliases[$a], 'nis_recipient') || get_preg($aliases[$a], 'email')) {
$partialAccounts[$i]['rfc822MailMember'][] = $aliases[$a];
}
else {
$errMsg = $this->messages['recipient'][1];
array_push($errMsg, array($i));
$messages[] = $errMsg;
}
}
}
}
return $messages;
}
/**
* Returns a list of possible PDF entries for this account.
*
* @param array $pdfKeys list of PDF keys that are included in document
* @return list of PDF entries (array(<PDF key> => <PDF lines>))
*/
function get_pdfEntries($pdfKeys) {
$return = array();
$this->addSimplePDFField($return, 'alias', _('Alias name'), 'cn');
$this->addSimplePDFField($return, 'recipients', _('Recipient list'), 'rfc822MailMember');
return $return;
}
/**
* Returns a list of existing email addresses.
*
* @return array email addresses
*/
private function getMailList() {
if ($this->cachedMailList != null) {
return $this->cachedMailList;
}
$objectClass = 'inetOrgPerson';
$activeTypes = $_SESSION['config']->get_ActiveTypes();
if (in_array('user', $activeTypes)) {
$userModules = $_SESSION['config']->get_AccountModules('user');
if (in_array('windowsUser', $userModules)) {
$objectClass = 'user';
}
}
$this->cachedMailList = searchLDAPByAttribute('mail', '*', $objectClass, array('mail'), array('user'));
for ($i = 0; $i < sizeof($this->cachedMailList); $i++) {
$this->cachedMailList[$i] = $this->cachedMailList[$i]['mail'][0];
}
$this->cachedMailList = array_values(array_unique($this->cachedMailList));
return $this->cachedMailList;
}
/**
* Returns a list of existing user names.
*
* @return array user names
*/
private function getUserList() {
if ($this->cachedUserList != null) {
return $this->cachedUserList;
}
$this->cachedUserList = searchLDAPByFilter('(|(objectClass=posixAccount)(objectClass=inetOrgPerson))', array('uid'), array('user'));
$count = sizeof($this->cachedUserList);
for ($i = 0; $i < $count; $i++) {
if (empty($this->cachedUserList[$i]['uid'][0])) {
unset($this->cachedUserList[$i]);
continue;
}
$this->cachedUserList[$i] = $this->cachedUserList[$i]['uid'][0];
}
$this->cachedUserList = array_values(array_unique($this->cachedUserList));
return $this->cachedUserList;
}
}
?>