An error occurred while loading the file. Please try again.
-
Verified12e6c16a
<?php/* This code is part of FusionDirectory (http://www.fusiondirectory.org) Copyright (C) 2024 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 tasksLifeCycle extends simplePlugin{ protected $displayHeader = TRUE; /** * @var array|array[] */ private $subStates; static function plInfo (): array { return [ 'plShortName' => _('Tasks Life Cycle'), 'plDescription' => _('Tasks Life Cycle Object'), 'plIcon' => 'geticon.php?context=applications&icon=tasks&size=16', 'plPriority' => 42, 'plObjectClass' => ['fdTasksLifeCycle'], 'plFilter' => '(objectClass=fdTasksLifeCycle)', 'plObjectType' => ['tasks'], 'plConflicts' => ['tasksMail'], 'plProvidedAcls' => parent::generatePlProvidedAcls(static::getAttributesInfo()), 'plForeignKeys' => [], ]; } static function getAttributesInfo (): array { return [ 'section1' => [ 'class' => ['fullwidth', 'information'], 'name' => _('We recommend the task redundancy to be set to daily, and the case New Members Only to be unpicked'), 'attrs' => [ // This hiddenAttribute is only present to show the information label on the section. new HiddenAttribute( 'fdShowInformation', FALSE, ), // Following attributes will contain all the DNs required to be verified by Orchestrator. new HiddenArrayAttribute('fdTasksLifeCycleListOfDN', FALSE, ''), ] ], 'section3' => [ 'name' => _('Post resources details'), 'attrs' => [ new SelectAttribute( _('Resource'), _('Supann resources'), 'fdTasksLifeCyclePostResource', TRUE ), new SelectAttribute( _('State'), _('Resource state'), 'fdTasksLifeCyclePostState', TRUE7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
),
new SelectAttribute(
_('Sub state'), _('Resource sub state'),
'fdTasksLifeCyclePostSubState', FALSE
),
new IntAttribute(
_('Extra days to add'), _('Extra days to be added after today'),
'fdTasksLifeCyclePostEndDate', FALSE, '0', FALSE, '0'
),
]
],
// Attributes are grouped by section
'section2' => [
'name' => _('Pre / existing resources details'),
'attrs' => [
new SelectAttribute(
_('Resource'), _('Supann resources'),
'fdTasksLifeCyclePreResource', TRUE
),
new SelectAttribute(
_('State'), _('Resource state'),
'fdTasksLifeCyclePreState', TRUE
),
new SelectAttribute(
_('Sub state'), _('Resource sub state'),
'fdTasksLifeCyclePreSubState', FALSE
),
]
],
'UserGroupSelection' => [
'name' => _('Recipients Users and/or Groups'),
'class' => ['fullwidth'],
'attrs' => [
new UsersGroupsRolesAttribute(
_('Members'), _('Users or groups to assign to this task.'),
'fdTasksLifeCycleMembers', TRUE
),
],
],
];
}
/**
* @throws NonExistingLdapNodeException
*/
function __construct ($dn = NULL, $object = NULL, $parent = NULL, $mainTab = FALSE)
{
parent::__construct($dn, $object, $parent, $mainTab);
$this->attributesAccess['fdShowInformation']->setInLdap(FALSE);
if (class_available('supannAccountStatus')) {
$this->setSupannStates();
} else {
$warning = new FusionDirectoryWarning(htmlescape(_('The plugin Supann does not seem to be installed !')));
$warning->display();
}
}
/**
* Set attributes values with defined supann states from configuration
*/
protected function setSupannStates (): void
{
global $config;
// Define the mandatory ones and get the remaining from configuration.
$resources = ['COMPTE' => _('Account'), 'MAIL' => _('Mail')];
foreach ($config->get_cfg_value('SupannRessourceLabels', []) as $line) {
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
list($resource, $label) = explode(':', $line, 2);
$resources[$resource] = $label;
}
$this->attributesAccess['fdTasksLifeCyclePreResource']->setChoices(array_keys($resources), array_values($resources));
$this->attributesAccess['fdTasksLifeCyclePostResource']->setChoices(array_keys($resources), array_values($resources));
// @phpstan-ignore-next-line - Class verification is performed prior but class is only available in plugin not CORE.
$this->subStates = supannAccountStatus::getConfiguredSubstates(); //Keys are states and Values are subStates
$this->attributesAccess['fdTasksLifeCyclePreState']->setChoices(array_keys($this->subStates));
$this->attributesAccess['fdTasksLifeCyclePostState']->setChoices(array_keys($this->subStates));
// Allows the sub states to be listed when state is modified.
$this->attributesAccess['fdTasksLifeCyclePreState']->setSubmitForm('updateFieldsChoices');
$this->attributesAccess['fdTasksLifeCyclePostState']->setSubmitForm('updateFieldsChoices');
// This initial fill the list choices based on registered states.
$this->updateFieldsChoices();
}
/* Update list of subStates which depends on the state selected */
function updateFieldsChoices ()
{
// Update pre sub states
$preSubStatesList = $this->subStates[$this->attributesAccess['fdTasksLifeCyclePreState']->getValue()] ?? [];
$this->attributesAccess['fdTasksLifeCyclePreSubState']->setChoices(array_keys($preSubStatesList), array_values($preSubStatesList));
// Update post sub states
$postSubStatesList = $this->subStates[$this->attributesAccess['fdTasksLifeCyclePostState']->getValue()] ?? [];
$this->attributesAccess['fdTasksLifeCyclePostSubState']->setChoices(array_keys($postSubStatesList), array_values($postSubStatesList));
}
/**
* Retrieve all the DNs from groups or members
*/
public function getListOfDN (): void
{
// Get the members or groups selected
$membersAndGroups = $this->attributesAccess['fdTasksLifeCycleMembers']->getValue();
// Call static function from tasks object, always return an array.
$this->attributesAccess['fdTasksLifeCycleListOfDN']->setValue(array_values(tasks::extractMembersFromGroups($membersAndGroups)));
}
/**
* 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 ()
{
$listOfDN = $this->attributesAccess['fdTasksLifeCycleListOfDN']->getValue();
// The attribute required to be search in createSlaveTasks
$attributeType = 'fdTasksGranularDN';
// Call the method from parent tasks object (first tab) to create sub-tasks.
$this->parent->getBaseObject()->createSlaveTasks($listOfDN, $attributeType);
}
public function update (): bool
{
parent::update();
// Take the list of DN based on the groups or members list selected and filled the related attributes
$this->getListOfDN();
return TRUE;
}
function save (): array
{
// Verify if this tasks has to be executed upon saving.
$execTasks = $this->parent->getBaseObject()->fdSubTasksActivation ?? NULL;
211212213214215216217218219
if ($execTasks) {
$this->generateSlaveTasks();
}
return parent::save();
}
}