<?php/* This code is part of FusionDirectory (http://www.fusiondirectory.org) Copyright (C) 2018-2022 FusionDirectory 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA*/class tasksMail extends simplePlugin{ protected $displayHeader = TRUE; static function plInfo (): array { return [ 'plShortName' => _('Tasks Mail'), 'plDescription' => _('Tasks Mail Object'), 'plIcon' => 'geticon.php?context=applications&icon=tasks&size=16', 'plPriority' => 42, 'plObjectClass' => ['fdTasksMail'], 'plFilter' => '(objectClass=fdTasksMail)', 'plObjectType' => ['tasks'], 'plConflicts' => [''], 'plProvidedAcls' => parent::generatePlProvidedAcls(static::getAttributesInfo()), 'plForeignKeys' => [ 'fdTasksMailUsers' => [ ['user', 'dn', 'fdTasksMailUsers=%oldvalue%', '*'] ] ], ]; } static function getAttributesInfo (): array { return [ // Attributes are grouped by section 'taskMail' => [ 'name' => _('Task Mail Object'), 'attrs' => [ new SelectAttribute( _('Mail Template'), _('Mail Template Object Selection'), 'fdTasksMailObject', FALSE ), new HiddenArrayAttribute('fdTasksEmailsFromDN', FALSE, ''), ] ], 'From Component' => [ 'name' => _('Sender email address'), 'attrs' => [ new MailAttribute( _('Sender email address'), _('Email address from which mails will be sent'), 'fdTasksEmailSender', TRUE, 'to.be@chang.ed'), ] ], 'UserGroupSelection' => [ 'name' => _('Recipients Users and/or Groups'), 'attrs' => [7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
new UsersGroupsRolesAttribute(
_('Members'), _('Users or groups to assign to this task.'),
'fdTasksMailUsers', TRUE
),
],
],
'tasksMailType' => [
'name' => _('Type of e-mail address desired'),
'attrs' => [
new SelectAttribute(
_('Mail Type - If not found, priority will apply'), _('Mail Type Object Selection'),
'fdTasksMailType', FALSE
),
],
]
];
}
function __construct ($dn = NULL, $object = NULL, $parent = NULL, $mainTab = FALSE)
{
global $config;
parent::__construct($dn, $object, $parent, $mainTab);
//Search within LDAP and retrieve all mail objects for current base.
$ldap = $config->get_ldap_link();
$ldap->cd($config->current['BASE']);
$ldap->search('(&(objectClass=fdMailTemplate))', ['cn']);
$tmpSearch = [];
while ($attrs = $ldap->fetch()) {
$tmpSearch[$attrs['cn'][0]] = $attrs['cn'][0];
}
asort($tmpSearch);
$this->attributesAccess['fdTasksMailObject']->setChoices(array_keys($tmpSearch), array_values($tmpSearch));
$mailAttrTypes = [
'mail' => 'mail - [gosaMailAccount primary]',
'gosaMailAlternateAddress' => 'gosaMailAlternateAddress',
'gosaMailForwardingAddress' => 'gosaMailForwardingAddress',
'supannAutreMail' => 'supannAutreMail',
'supannMailPerso' => 'supannMailPerso',
'supannMailPrive' => 'supannMailPrive'
];
$this->attributesAccess['fdTasksMailType']->setChoices(array_keys($mailAttrTypes), array_values($mailAttrTypes));
}
/*
* Must return bool to be compliant with the interface
* Allows attributes values based on others to be updated before save.
*/
public function update (): bool
{
parent::update();
// get the value of type mail desired and if null set default
$mailAttr = $this->attributesAccess['fdTasksMailType']->getValue();
if (empty($mailAttr)) {
$mailAttr = 'mail';
}
// create a method which return the objectype and attribute names required
$mailObject = $this->getMailObject($mailAttr);
// send the objectype and attrs name to the below method
$this->setEmailsFromSelectedDN($mailObject, $mailAttr);
return TRUE;
}
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
/*
* Return the objectype searched for by setEmailFromSelectedDN
*/
public function getMailObject (string $mailAttr): string
{
switch ($mailAttr) {
case 'mail' :
case 'gosaMailAlternateAddress' :
case 'gosaMailForwardingAddress':
return 'gosaMailAccount';
case 'supannAutreMail' :
case 'supannMailPerso' :
case 'supannMailPrive' :
return 'supannPerson';
default :
return 'gosaMailAccount';
}
}
/*
* Populate the fdTasksEmailsFromDN attribute with related mails addresses.
*/
public function setEmailsFromSelectedDN ($mailObject, $mailAttr): void
{
global $config;
$ldap = $config->get_ldap_link();
// Get the members or groups selected
$attributeValue = $this->attributesAccess['fdTasksMailUsers']->getValue();
if (!empty($attributeValue)) {
// listOfDN will contain only DN of members after below methods condition
$listOfDN = $attributeValue;
// Verify if the values received is a member or a group and collect the members DN
foreach ($attributeValue as $group) {
if (strpos($group, "ou=groups") !== FALSE) {
// Position ldap to the dn required (limit search).
$ldap->cd($group);
$filter = '(|(objectClass=groupOfUrls)(objectClass=groupOfNames))';
$attrs = ['member'];
$ldap->search($filter, $attrs);
$info = $ldap->fetch();
// Remove the DN of the group from the list of DN
unset($listOfDN[$group]);
// Add the member DN to the list of DN
foreach ($info['member'] as $memberDN) {
$listOfDN[] = $memberDN;
}
}
}
$mailList = [];
foreach ($listOfDN as $dn) {
// Position ldap to the dn required (limit search).
$ldap->cd($dn);
// filter and attributes should be equals to the arguments passed to this method
$filter = "(objectClass=$mailObject)";
$attrs = [$mailAttr];
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
$ldap->search($filter, $attrs);
$info = $ldap->fetch();
if (!empty($info[$mailAttr][0])) {
// In case of private supann mail, remove the prefix
$mailList[] = preg_replace('/.+?(?=supann)/', '', $info[$mailAttr][0]);
// Render the mailing list unique, somewhat mandatory when updating the members lists with dynGroups and members.
$mailList = array_unique($mailList);
// A possible enhancement is to recall itself with another mailObject / attr
}
}
$this->attributesAccess['fdTasksEmailsFromDN']->setValue(array_values($mailList));
}
}
function save (): array
{
$execTasks = $this->parent->getBaseObject()->fdSubTasksActivation ?? NULL;
if ($execTasks) {
$this->generateSlaveTasks();
}
return parent::save();
}
/*
* Generate slave tasks, careful that main task cannot be changed cause subtasks are not updated.
* It would be dangerous to edit subs tasks if some are under processed already.
*/
public function generateSlaveTasks ()
{
global $config;
$ldap = $config->get_ldap_link();
$emails = $this->attributesAccess['fdTasksEmailsFromDN']->getValue();
// Ref is supposed to be the mail object CN in this class
$ref = $this->attributesAccess['fdTasksMailObject']->getValue();
$from = $this->attributesAccess['fdTasksEmailSender']->getValue();
// Take the attribute from the other tabs - attribute cannot be null or unset by default
$schedule = $this->parent->getBaseObject()->fdTasksScheduleDate ?? NULL;
// Verify if members can have multiple sub-tasks for that main task.
$newMemberOnly = $this->parent->getBaseObject()->fdTasksUpdatable;
// remove 'dn' keeping only 'cn'
$rmDn = preg_replace('/(?=,).*/', '', $this->dn);
// only take the cn without dc
preg_match('/cn=(.*)/', $rmDn, $matches);
if (!empty($emails)) {
// Condition allowing the creation of subtasks for existing members
if ($newMemberOnly === TRUE) {
$ldap->cd($config->current['BASE']);
$filter = '(&(objectClass=fdTasksGranular)(fdTasksGranularMaster='.$this->dn.'))';
$attrs = ['fdTasksGranularMail'];
$ldap->search($filter, $attrs);
// The while loop is important to get all info from ldap into the array.
while ($info = $ldap->fetch()) {
$subTasks[] = $info;
}
if (!empty($subTasks)) {
// Recuperate members email from the ldap search.
foreach ($subTasks as $subTask) {
$membersEmailsList[] = $subTask['fdTasksGranularMail'][0];
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
}
// Verify the emails differences and only keep those.
if (!empty($membersEmailsList)) {
$emails = array_diff($emails, $membersEmailsList);
}
// Simple re-index the array.
$emails = array_values($emails);
}
}
foreach ($emails as $email) {
// Here we create the object taskGranular
$tabObject = objects::create('TasksGranular');
// Create a unique ID based on timestamp (Allowing duplicate subtasks for same members in case of repeat).
$timestamp = microtime(TRUE); // Get the current timestamp with microseconds
$timestamp = (string)$timestamp; // Convert the float to a string, str_replace expect array or string.
$uniqueID = str_replace(".", "_", $timestamp); // Remove . with _ for correct CN
// Array matches come from preg_match function above with rmDn
$subTaskName = $matches[1] . '-SubTask-' . $uniqueID;
$values['tasksGranular'] = [
"cn" => $subTaskName,
"fdTasksGranularType" => 'Mail Object',
"fdTasksGranularMaster" => $this->dn,
"fdTasksGranularMail" => $email,
"fdTasksGranularSchedule" => $schedule,
"fdTasksGranularRef" => $ref,
"fdTasksGranularMailFrom" => $from
];
foreach ($values as $tab => $tabvalues) {
if (!isset($tabObject->by_object[$tab])) {
echo "Error tab does not contains attributes values" . PHP_EOL;
}
$error = $tabObject->by_object[$tab]->deserializeValues($tabvalues);
if ($error !== TRUE) {
echo 'Error during deserializing' . $error . PHP_EOL;
}
$tabObject->current = $tab;
$tabObject->update();
$tabObject->loadTabs();
}
$errors = $tabObject->save();
// Showing errors should be better, enhancement here required.
if (!empty($errors)) {
$show_error = new SimplePluginError($this, htmlescape(sprintf(_('Error : "%s", already exist ! Editing existing tasks is forbidden.'), $subTaskName)));
$show_error->display();
}
}
}
}
}