autoAddObjectClasses = false; } /** * 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('group')); } /** * 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'] = 'kolab.png'; // alias name $return["alias"] = _("Kolab"); // module dependencies $return['dependencies'] = array('depends' => array(), 'conflicts' => array()); // managed object classes $return['objectClasses'] = array('kolabGroupOfUniqueNames'); // managed attributes $return['attributes'] = array('kolabAllowSMTPRecipient', 'kolabAllowSMTPSender', 'kolabDeleteflag'); // help Entries $return['help'] = array( 'mail' => array( "Headline" => _("Email address"), 'attr' => 'mail', "Text" => _("The list's email address.") ), 'mailList' => array( "Headline" => _("Email address"), 'attr' => 'mail', "Text" => _("The list's email address.") . ' ' . _("Multiple values are separated by semicolon.") ), 'kolabAllowSMTPRecipient' => array ( "Headline" => _('Allowed recipients'), 'attr' => 'kolabAllowSMTPRecipient', "Text" => _('Describes the allowed or disallowed SMTP recipient addresses for mail sent by this account (e.g. "domain.tld" or "-user@domain.tld").') ), 'kolabAllowSMTPRecipientList' => array ( "Headline" => _('Allowed recipients'), 'attr' => 'kolabAllowSMTPRecipient', "Text" => _('Describes the allowed or disallowed SMTP recipient addresses for mail sent by this account (e.g. "domain.tld" or "-user@domain.tld").') . ' ' . _("Multiple values are separated by semicolon.") ), 'kolabAllowSMTPSender' => array ( "Headline" => _('Allowed senders'), 'attr' => 'kolabAllowSMTPSender', "Text" => _('Describes the allowed or disallowed SMTP addresses sending mail to this account (e.g. "domain.tld" or "-user@domain.tld").') ), 'kolabAllowSMTPSenderList' => array ( "Headline" => _('Allowed senders'), 'attr' => 'kolabAllowSMTPSender', "Text" => _('Describes the allowed or disallowed SMTP addresses sending mail to this account (e.g. "domain.tld" or "-user@domain.tld").') . ' ' . _("Multiple values are separated by semicolon.") ), 'deleteFlag' => array( "Headline" => _("Mark for deletion"), 'attr' => 'kolabDeleteflag', "Text" => _("This will set a special flag on the account which tells Kolabd to remove it. Use this to cleanly delete Kolab accounts (e.g. this removes mail boxes).") ), 'autoAdd' => array( "Headline" => _("Automatically add this extension"), "Text" => _("This will enable the extension automatically if this profile is loaded.") ), 'addExtension' => array( "Headline" => _("Add Kolab extension"), "Text" => _("Adds this Kolab extension.") ), ); // profile options $profileContainer = new htmlTable(); $profileContainer->addElement(new htmlTableExtendedInputCheckbox('kolabGroup_addExt', false, _('Automatically add this extension'), 'autoAdd'), true); $return['profile_options'] = $profileContainer; // upload fields $return['upload_columns'] = array( array( 'name' => 'kolabGroup_addExtension', 'description' => _('Add Kolab extension'), 'help' => 'addExtension', 'example' => 'false', 'default' => 'false', 'values' => 'true, false' ), array( 'name' => 'kolabGroup_kolabAllowSMTPRecipient', 'description' => _('Allowed recipients'), 'help' => 'kolabAllowSMTPRecipientList', 'example' => '.com; -.net', ), array( 'name' => 'kolabGroup_kolabAllowSMTPSender', 'description' => _('Allowed senders'), 'help' => 'kolabAllowSMTPSenderList', 'example' => '.com; -.net', ), ); // available PDF fields $return['PDF_fields'] = array( 'kolabAllowSMTPRecipient' => _('Allowed recipients'), 'kolabAllowSMTPSender' => _('Allowed senders'), ); return $return; } /** * This function fills the $messages variable with output messages from this module. */ function load_Messages() { $this->messages['mail'][0] = array('ERROR', _('Email address'), _('Please enter a valid email address!')); $this->messages['mail'][1] = array('ERROR', _('Account %s:') . ' kolabGroup_mail', _('Please enter a valid email address!')); $this->messages['mail'][2] = array('ERROR', _('Email address'), _('Email address already exists.')); $this->messages['mail'][3] = array('ERROR', _('Account %s:') . ' kolabGroup_mail', _('Email address already exists.')); $this->messages['kolabAllowSMTPRecipient'][0] = array('ERROR', _('Allowed recipients'), _('Please enter a valid recipient expression.')); $this->messages['kolabAllowSMTPRecipient'][1] = array('ERROR', _('Account %s:') . ' kolabGroup_kolabAllowSMTPRecipient', _('Please enter a valid recipient expression.')); $this->messages['kolabAllowSMTPSender'][0] = array('ERROR', _('Allowed senders'), _('Please enter a valid sender expression.')); $this->messages['kolabAllowSMTPSender'][1] = array('ERROR', _('Account %s:') . ' kolabGroup_kolabAllowSMTPSender', _('Please enter a valid sender expression.')); } /** * Returns the HTML meta data for the main account page. * * @return htmlElement HTML meta data */ function display_html_attributes() { $container = new htmlTable(); if (isset($this->attributes['objectClass']) && in_array('kolabGroupOfUniqueNames', $this->attributes['objectClass'])) { // check if account is marked for deletion if (isset($this->attributes['kolabDeleteflag'])) { $container->addElement(new htmlOutputText(_('This account is marked for deletion.'))); return $container; } // mail if ($this->manageMail($this->getAccountContainer()->get_type()->getModules())) { $this->addSimpleInputTextField($container, 'mail', _('Email address'), true); } // allowed recipients $this->addMultiValueInputTextField($container, 'kolabAllowSMTPRecipient', _('Allowed recipients')); // allowed senders $this->addMultiValueInputTextField($container, 'kolabAllowSMTPSender', _('Allowed senders')); // delete flag $this->loadMailHostCache(); if (!$this->getAccountContainer()->isNewAccount && (sizeof($this->mailHostCache) > 0)) { $deleteContainer = new htmlTable(); $deleteContainer->addElement(new htmlSpacer(null, '20px'), true); $deleteContainer->addElement(new htmlAccountPageButton(get_class($this), 'deleteFlag', 'open', _('Mark account for deletion'))); $deleteContainer->addElement(new htmlHelpLink('deleteFlag')); $container->addElement($deleteContainer); } } else { // add button $container->addElement(new htmlButton('addObjectClass', _('Add Kolab 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'])) { $this->attributes['objectClass'][] = 'kolabGroupOfUniqueNames'; return $errors; } if (isset($_POST['remObjectClass'])) { $this->attributes['objectClass'] = array_delete(array('kolabGroupOfUniqueNames'), $this->attributes['objectClass']); $attrs = $this->meta['attributes']; 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('kolabGroupOfUniqueNames', $this->attributes['objectClass'])) { return $errors; } // mail if ($this->manageMail($this->getAccountContainer()->get_type()->getModules())) { if (!empty($_POST['mail'])) { $this->attributes['mail'][0] = $_POST['mail']; // check format if (!get_preg($_POST['mail'], 'email')) { $errors[] = $this->messages['mail'][0]; } // check if unique if ($this->getAccountContainer()->isNewAccount || (!empty($this->orig['mail'][0]) && ($this->orig['mail'][0] != $this->attributes['mail'][0]))) { $this->loadMailCache(); if (in_array_ignore_case($_POST['mail'], $this->mailCache)) { $errors[] = $this->messages['mail'][2]; } } } elseif (isset($this->attributes['mail'])) { unset($this->attributes['mail']); } } // allowed recipients $this->processMultiValueInputTextField('kolabAllowSMTPRecipient', $errors, 'kolabEmailPrefix'); // allowed senders $this->processMultiValueInputTextField('kolabAllowSMTPSender', $errors, 'kolabEmailPrefix'); return $errors; } /** * This function will create the meta HTML code to show a page to mark an account for deletion. * * @return htmlElement HTML meta data */ function display_html_deleteFlag() { $return = new htmlTable(); $message = new htmlOutputText(_('Do you really want to mark this account for deletion?')); $return->addElement($message, true); $return->addElement(new htmlSpacer(null, '10px'), true); $serverTable = new htmlTable(); $serverTable->addElement(new htmlTableExtendedSelect('deletionServer', $this->mailHostCache, array(), _('Server'), 'deleteFlag')); $return->addElement($serverTable, true); $return->addElement(new htmlSpacer(null, '10px'), true); $buttonGroup = new htmlGroup(); $buttonGroup->addElement(new htmlAccountPageButton(get_class($this), 'attributes', 'confirm', _('Mark account for deletion'))); $buttonGroup->addElement(new htmlAccountPageButton(get_class($this), 'attributes', 'cancel', _('Cancel'))); $return->addElement($buttonGroup, true); return $return; } /** * Write variables into object and do some regex checks */ function process_deleteFlag() { if (isset($_POST['form_subpage_kolabGroup_attributes_confirm'])) { // set delete flag $this->attributes['kolabDeleteflag'][0] = $_POST['deletionServer']; } } /** * Returns a list of modifications which have to be made to the LDAP account. * * @return array list of modifications *
This function returns an array with 3 entries: *
array( DN1 ('add' => array($attr), 'remove' => array($attr), 'modify' => array($attr)), DN2 .... ) *
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) *
"add" are attributes which have to be added to LDAP entry *
"remove" are attributes which have to be removed from LDAP entry *
"modify" are attributes which have to been modified in LDAP entry *
"info" are values with informational value (e.g. to be used later by pre/postModify actions) */ function save_attributes() { if (!in_array('kolabGroupOfUniqueNames', $this->attributes['objectClass']) && !in_array('kolabGroupOfUniqueNames', $this->orig['objectClass'])) { // skip saving if the extension was not added/modified return array(); } return parent::save_attributes(); } /** * 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['kolabGroup_addExt'][0]) && ($profile['kolabGroup_addExt'][0] == "true")) { if (!in_array('kolabGroupOfUniqueNames', $this->attributes['objectClass'])) { $this->attributes['objectClass'][] = 'kolabGroupOfUniqueNames'; } } } /** * {@inheritDoc} * @see baseModule::getManagedAttributes() */ function get_uploadColumns($selectedModules) { $return = parent::get_uploadColumns($selectedModules); if ($this->manageMail($selectedModules)) { $return[] = array( 'name' => 'kolabGroup_mail', 'description' => _('Email address'), 'help' => 'mailList', 'example' => 'list@company.com', 'required' => true, 'unique' => true, ); } return $return; } /** * In this function the LDAP account is built up. * * @param array $rawAccounts list of hash arrays (name => value) from user input * @param array $ids list of IDs for column position (e.g. "posixAccount_uid" => 5) * @param array $partialAccounts list of hash arrays (name => value) which are later added to LDAP * @param array $selectedModules list of selected account modules * @return array list of error messages if any */ function build_uploadAccounts($rawAccounts, $ids, &$partialAccounts, $selectedModules) { $messages = array(); for ($i = 0; $i < sizeof($rawAccounts); $i++) { // check if extension should be added if (isset($rawAccounts[$i][$ids['kolabGroup_addExtension']]) && ($rawAccounts[$i][$ids['kolabGroup_addExtension']] != 'true')) { continue; } // add object classes if (!in_array('kolabGroupOfUniqueNames', $partialAccounts[$i]['objectClass'])) { $partialAccounts[$i]['objectClass'][] = 'kolabGroupOfUniqueNames'; } // mail if ($this->manageMail($selectedModules) && !empty($rawAccounts[$i][$ids['kolabGroup_mail']])) { if (get_preg($rawAccounts[$i][$ids['kolabGroup_mail']], 'email')) { $this->loadMailCache(); if (!in_array_ignore_case(trim($rawAccounts[$i][$ids['kolabGroup_mail']]), $this->mailCache)) { $partialAccounts[$i]['mail'] = trim($rawAccounts[$i][$ids['kolabGroup_mail']]); } else { $errMsg = $this->messages['mail'][3]; array_push($errMsg, array($i)); $messages[] = $errMsg; } } else { $errMsg = $this->messages['mail'][1]; array_push($errMsg, array($i)); $messages[] = $errMsg; } } // allowed recipients $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'kolabGroup_kolabAllowSMTPRecipient', 'kolabAllowSMTPRecipient', 'kolabEmailPrefix', $this->messages['kolabAllowSMTPRecipient'][1], $messages, '/;[ ]*/'); // allowed senders $this->mapSimpleUploadField($rawAccounts, $ids, $partialAccounts, $i, 'kolabGroup_kolabAllowSMTPSender', 'kolabAllowSMTPSender', 'kolabEmailPrefix', $this->messages['kolabAllowSMTPSender'][1], $messages, '/;[ ]*/'); } return $messages; } /** * {@inheritDoc} * @see baseModule::get_pdfFields() */ public function get_pdfFields($typeId) { $fields = parent::get_pdfFields($typeId); $typeManager = new TypeManager(); $modules = $typeManager->getConfiguredType($typeId)->getModules(); if ($this->manageMail($modules)) { $fields['mail'] = _('Email address'); } return $fields; } /** * {@inheritDoc} * @see baseModule::get_pdfEntries() */ function get_pdfEntries($pdfKeys, $typeId) { $return = array(); $this->addSimplePDFField($return, 'mail', _('Email address')); $this->addSimplePDFField($return, 'kolabAllowSMTPRecipient', _('Allowed recipients')); $this->addSimplePDFField($return, 'kolabAllowSMTPSender', _('Allowed senders')); return $return; } /** * Returns if the mail attribute should be managed. * * @param string[] $modules account modules * @return boolean manage mail attribute */ private function manageMail($modules) { if (in_array('qmailGroup', $modules)) { return false; } else { return true; } } /** * Loads the list of email addresses into the cache. */ private function loadMailCache() { if ($this->mailCache != null) { return; } $results = searchLDAPByFilter('(mail=*)', array('mail'), array($this->get_scope())); $this->mailCache = array(); foreach ($results as $result) { if (isset($result['mail'][0])) { $this->mailCache[] = $result['mail'][0]; } } } /** * Loads the list of mail hosts into the cache. */ private function loadMailHostCache() { if ($this->mailHostCache != null) { return; } $results = searchLDAPByFilter('(mailHost=*)', array('mailHost'), array('user')); $this->mailHostCache = array(); foreach ($results as $result) { if (isset($result['mailhost'][0]) && !in_array_ignore_case($result['mailhost'][0], $this->mailHostCache)) { $this->mailHostCache[] = $result['mailhost'][0]; } } } /** * {@inheritDoc} * @see baseModule::getManagedAttributes() */ public function getManagedAttributes($typeId) { $attrs = parent::getManagedAttributes($typeId); $typeManager = new TypeManager(); if ($this->manageMail($typeManager->getConfiguredType($typeId)->getModules())) { $attrs[] = 'mail'; } return $attrs; } } ?>