. -------------------------------------------------------------------------- */ if (!defined('GLPI_ROOT')) { die("Sorry. You can't access directly to this file"); } /** * process short summary. * * process description. * * @version 1.0 * @author MoronO */ class PluginProcessmakerProcess extends CommonDBTM { const CLASSIC = 'classic'; const BPMN = 'bpmn'; static $rightname = 'plugin_processmaker_config'; static function canCreate() { return Session::haveRight('plugin_processmaker_config', UPDATE); } static function canView() { return Session::haveRightsOr('plugin_processmaker_config', [READ, UPDATE]); } static function canUpdate() { return Session::haveRight('plugin_processmaker_config', UPDATE); } function canUpdateItem() { return Session::haveRight('plugin_processmaker_config', UPDATE); } function maybeDeleted() { return false; } // static function getIcon() { //// return "fas fa-code-branch fa-rotate-90"; // return "fas fa-blog fa-flip-vertical"; //// return "fas fa-cogs fa-flip-vertical"; // } /** * Get default values to search engine to override **/ static function getDefaultSearchRequest() { $search = ['sort' => 1, 'order' => 'ASC']; return $search; } static function processMassiveActionsForOneItemtype(MassiveAction $ma, CommonDBTM $item, array $ids) { $action = $ma->getAction(); switch ($action) { case 'taskrefresh' : foreach ($ids as $pid) { if (!$item->canUpdateItem()) { $ma->itemDone(__CLASS__, $pid, MassiveAction::ACTION_NORIGHT); $ma->addMessage($item->getErrorMessage(ERROR_RIGHT)); continue; } $item->refreshTasks($pid); $ma->itemDone(__CLASS__, $pid, MassiveAction::ACTION_OK); } break; } } /** * Summary of refreshTasks * will refresh (re-synch) all process task list * @param integer $ID is the id of the process * @return void */ function refreshTasks($ID) { global $PM_DB, $CFG_GLPI; if ($this->getFromDB($ID)) { // here we are in the right process // we need to get the tasks + content from PM db $mapLangs = []; $dbu = new DbUtils; // if (class_exists('DropdownTranslation')) { // to force rights to add translations $_SESSION['glpi_dropdowntranslations']['TaskCategory']['name'] = 'name'; $_SESSION['glpi_dropdowntranslations']['TaskCategory']['completename'] = 'completename'; $_SESSION['glpi_dropdowntranslations']['TaskCategory']['comment'] = 'comment'; //$translates = true; // create a reversed map for languages foreach ($CFG_GLPI['languages'] as $key => $valArray) { $lg = locale_get_primary_language( $key ); $mapLangs[$lg][] = $key; $mapLangs[$key][] = $key; // also add complete lang } //} $lang = locale_get_primary_language( $CFG_GLPI['language'] ); $query = [ 'SELECT' => ['TASK.TAS_UID', 'TASK.TAS_START', 'TASK.TAS_TYPE', 'CONTENT.CON_LANG', 'CONTENT.CON_CATEGORY', 'CONTENT.CON_VALUE'], 'FROM' => 'TASK', 'INNER JOIN' => [ 'CONTENT' => [ 'FKEY' => [ 'CONTENT' => 'CON_ID', 'TASK' => 'TAS_UID' ] ] ], 'WHERE' => [ 'AND' => [ 'TASK.TAS_TYPE' => ['NORMAL', 'SUBPROCESS'], 'TASK.PRO_UID' => $this->fields['process_guid'], 'CONTENT.CON_CATEGORY' => ['TAS_TITLE', 'TAS_DESCRIPTION'] ] ] ]; //if (!$translates) { // $query['WHERE']['AND']['CONTENT.CON_LANG'] = $lang; //} //$query = "SELECT TASK.TAS_UID, TASK.TAS_START, TASK.TAS_TYPE, CONTENT.CON_LANG, CONTENT.CON_CATEGORY, CONTENT.CON_VALUE FROM TASK // INNER JOIN CONTENT ON CONTENT.CON_ID=TASK.TAS_UID // WHERE (TASK.TAS_TYPE = 'NORMAL' OR TASK.TAS_TYPE = 'SUBPROCESS') AND TASK.PRO_UID = '".$this->fields['process_guid']."' AND CONTENT.CON_CATEGORY IN ('TAS_TITLE', 'TAS_DESCRIPTION') ".($translates ? "" : " AND CONTENT.CON_LANG='$lang'")." ;"; $taskArray = []; $defaultLangTaskArray = []; foreach ($PM_DB->request( $query ) as $task) { if ($task['CON_LANG'] == $lang) { $defaultLangTaskArray[$task['TAS_UID']][$task['CON_CATEGORY']] = $task['CON_VALUE']; $defaultLangTaskArray[$task['TAS_UID']]['is_start'] = ($task['TAS_START'] == 'TRUE' ? 1 : 0); $defaultLangTaskArray[$task['TAS_UID']]['is_subprocess'] = ($task['TAS_TYPE'] == 'SUBPROCESS' ? 1 : 0); } else { foreach ($mapLangs[ $task['CON_LANG'] ] as $valL) { $taskArray[ $task['TAS_UID'] ][ $valL ][ $task['CON_CATEGORY'] ] = $task['CON_VALUE']; } } } $pmtask = new PluginProcessmakerTaskCategory; $restrict = ["is_active" => '1', 'plugin_processmaker_processes_id' => $this->getID()]; $currentasksinprocess = $dbu->getAllDataFromTable($pmtask->getTable(), $restrict); $tasks=[]; foreach ($currentasksinprocess as $task) { $tasks[$task['pm_task_guid']] = $task; } $inactivetasks = array_diff_key($tasks, $defaultLangTaskArray); foreach ($inactivetasks as $task) { // must verify if this taskcategory are used in a task somewhere $objs = ['TicketTask', 'ProblemTask', 'ChangeTask']; $countElt = 0; foreach ($objs as $obj) { $countElt += $dbu->countElementsInTable($dbu->getTableForItemType($obj), ['taskcategories_id' => $task['taskcategories_id']]); if ($countElt != 0) { // just set 'is_active' to 0 $pmtask->Update(['id' => $task['id'], 'is_start' => 0, 'is_active' => 0]); break; } } if ($countElt == 0) { // purge this category as it is not used anywhere $taskCat = new TaskCategory; $taskCat->delete(['id' => $task['taskcategories_id']], 1); $pmTaskCat = new PluginProcessmakerTaskCategory; $pmTaskCat->delete(['id' => $task['id']], 1); } } foreach ($defaultLangTaskArray as $taskGUID => $task) { $pmTaskCat = new PluginProcessmakerTaskCategory; $taskCat = new TaskCategory; if ($pmTaskCat->getFromGUID( $taskGUID )) { // got it then check names, and if != update if ($taskCat->getFromDB($pmTaskCat->fields['taskcategories_id'])) { // found it must test if should be updated if ($taskCat->fields['name'] != $task['TAS_TITLE'] || $taskCat->fields['comment'] != $task['TAS_DESCRIPTION']) { $taskCat->update([ 'id' => $taskCat->getID(), 'name' => $PM_DB->escape($task['TAS_TITLE']), 'comment' => $PM_DB->escape($task['TAS_DESCRIPTION']), 'taskcategories_id' => $this->fields['taskcategories_id'], 'is_active' => 0 // to prevent use of this task cat in manual tasks ] ); } if ($pmTaskCat->fields['is_start'] != $task['is_start']) { $pmTaskCat->update(['id' => $pmTaskCat->getID(), 'is_start' => $task['is_start']]); } } else { // taskcat must be created $taskCat->add([ 'is_recursive' => true, 'name' => $PM_DB->escape($task['TAS_TITLE']), 'comment' => $PM_DB->escape($task['TAS_DESCRIPTION']), 'taskcategories_id' => $this->fields['taskcategories_id'], 'is_active' => 0 // to prevent use of this task cat in manual tasks ] ); // update pmTaskCat $pmTaskCat->update(['id' => $pmTaskCat->getID(), 'taskcategories_id' => $taskCat->getID(), 'is_start' => $task['is_start']]); } } else { // should create a new one // taskcat must be created $taskCat->add([ 'is_recursive' => true, 'name' => $PM_DB->escape($task['TAS_TITLE']), 'comment' => $PM_DB->escape($task['TAS_DESCRIPTION']), 'taskcategories_id' => $this->fields['taskcategories_id'], 'is_active' => 0 // to prevent use of this task cat in manual tasks ] ); // pmTaskCat must be created too $pmTaskCat->add([ 'plugin_processmaker_processes_id' => $this->getID(), 'pm_task_guid' => $taskGUID, 'taskcategories_id' => $taskCat->getID(), 'is_start' => $task['is_start'], 'is_active' => 1, 'is_subprocess' => $task['is_subprocess'] ]); } // here we should take into account translations if any if (isset($taskArray[ $taskGUID ])) { foreach ($taskArray[ $taskGUID ] as $langTask => $taskL) { // look for 'name' field if ($loc_id = DropdownTranslation::getTranslationID( $taskCat->getID(), 'TaskCategory', 'name', $langTask )) { if (DropdownTranslation::getTranslatedValue( $taskCat->getID(), 'TaskCategory', 'name', $langTask ) != $taskL[ 'TAS_TITLE' ]) { // must be updated $trans = new DropdownTranslation; $trans->update( [ 'id' => $loc_id, 'field' => 'name', 'value' => $PM_DB->escape($taskL[ 'TAS_TITLE' ]), 'itemtype' => 'TaskCategory', 'items_id' => $taskCat->getID(), 'language' => $langTask ] ); $trans->generateCompletename( [ 'itemtype' => 'TaskCategory', 'items_id' => $taskCat->getID(), 'language' => $langTask ] ); } } else { // must be added // must be updated $trans = new DropdownTranslation; $trans->add( [ 'items_id' => $taskCat->getID(), 'itemtype' => 'TaskCategory', 'language' => $langTask, 'field' => 'name', 'value' => $PM_DB->escape($taskL[ 'TAS_TITLE' ]) ] ); $trans->generateCompletename( [ 'itemtype' => 'TaskCategory', 'items_id' => $taskCat->getID(),'language' => $langTask ] ); } // look for 'comment' field if ($loc_id = DropdownTranslation::getTranslationID( $taskCat->getID(), 'TaskCategory', 'comment', $langTask )) { if (DropdownTranslation::getTranslatedValue( $taskCat->getID(), 'TaskCategory', 'comment', $langTask ) != $taskL[ 'TAS_DESCRIPTION' ]) { // must be updated $trans = new DropdownTranslation; $trans->update( [ 'id' => $loc_id, 'field' => 'comment', 'value' => $PM_DB->escape($taskL[ 'TAS_DESCRIPTION' ]) , 'itemtype' => 'TaskCategory', 'items_id' => $taskCat->getID(), 'language' => $langTask] ); } } else { // must be added $trans = new DropdownTranslation; $trans->add( [ 'items_id' => $taskCat->getID(), 'itemtype' => 'TaskCategory', 'language' => $langTask, 'field' => 'comment', 'value' => $PM_DB->escape($taskL[ 'TAS_DESCRIPTION' ]) ] ); } } } } } } function prepareInputForAdd($input) { global $PM_DB; if (isset($input['name'])) { $input['name'] = $PM_DB->escape($input['name']); } return $input; } function prepareInputForUpdate($input) { global $PM_DB; if (isset($input['name'])) { $input['name'] = $PM_DB->escape($input['name']); } return $input; } function post_addItem() { $this->getFromDB($this->getID()); } function post_updateItem($history = 1) { $this->getFromDB($this->getID()); } /** * Summary of refresh * used to refresh process list and task category list * @return void */ function refresh() { global $DB, $PM_SOAP; $dbu = new DbUtils; $pmCurrentProcesses = []; PluginProcessmakerProcessCategory::refreshCategories(); // then refresh list of available process from PM to inner table $PM_SOAP->login( true ); $pmProcessList = $PM_SOAP->processList(); $pmMainTaskCat = $PM_SOAP->config['taskcategories_id']; // and get processlist from GLPI if ($pmProcessList) { foreach ($pmProcessList as $process) { $glpiprocess = new PluginProcessmakerProcess; if ($glpiprocess->getFromGUID($process->guid)) { // then update it only if name has changed if ($glpiprocess->fields['name'] != $process->name) { $glpiprocess->update( [ 'id' => $glpiprocess->getID(), 'name' => $process->name] ); } // and check if main task category needs update if (!$glpiprocess->fields['taskcategories_id']) { // then needs to be added $glpiprocess->addTaskCategory( $pmMainTaskCat ); } else { $glpiprocess->updateTaskCategory( $pmMainTaskCat ); } if (!$glpiprocess->fields['plugin_processmaker_processcategories_id']) { $glpiprocess->updateProcessCategory($process->category_guid); } } else { // create it if (isset( $process->project_type )) { $project_type = $process->project_type; } else { $project_type = 'classic'; } if ($glpiprocess->add([ 'process_guid' => $process->guid, 'name' => $process->name, 'project_type' => $project_type, ])) { $glpiprocess->updateProcessCategory($process->category_guid); // and add main task category for this process $glpiprocess->addTaskCategory( $pmMainTaskCat ); } } $pmCurrentProcesses[$glpiprocess->getID()] = $glpiprocess->getID(); } } // should de-activate other $glpiCurrentProcesses = $dbu->getAllDataFromTable(self::getTable()); // get difference between PM and GLPI foreach (array_diff_key($glpiCurrentProcesses, $pmCurrentProcesses) as $key => $process) { $proc = new PluginProcessmakerProcess; $proc->getFromDB($key); // check if at least one case is existing for this process $res = $DB->request( PluginProcessmakerCase::getTable(), [ 'plugin_processmaker_processes_id' => $key ] ); //$query = "SELECT * FROM `".PluginProcessmakerCase::getTable()."` WHERE `plugin_processmaker_processes_id` = ".$key; //$res = $DB->query($query); if ($res->numrows() === 0) { // and if no will delete the process $proc->delete(['id' => $key]); // delete main taskcat $tmp = new TaskCategory; $tmp->delete(['id' => $proc->fields['taskcategories_id']]); // must delete processes_profiles if any $tmp = new PluginProcessmakerProcess_Profile; $tmp->deleteByCriteria(['plugin_processmaker_processes_id' => $key]); // must delete any taskcategory and translations $restrict = ["plugin_processmaker_processes_id" => $key]; //$pmtaskcategories = $dbu->getAllDataFromTable( PluginProcessmakerTaskCategory::getTable(), "plugin_processmaker_processes_id = $key"); $pmtaskcategories = $dbu->getAllDataFromTable( PluginProcessmakerTaskCategory::getTable(), $restrict ); foreach ($pmtaskcategories as $pmcat) { // delete taskcat $tmp = new TaskCategory; $tmp->delete(['id' => $pmcat['taskcategories_id']]); // delete pmtaskcat $tmp = new PluginProcessmakerTaskCategory; $tmp->delete(['id' => $pmcat['id']]); // delete any translations $tmp = new DropdownTranslation; $tmp->deleteByCriteria(['itemtype' => 'TaskCategory', 'items_id' => $pmcat['taskcategories_id']]); } } else { // set it as inactive $proc->update(['id' => $key, 'is_active' => 0]); } } } /** * Summary of updateProcessCategory * Update Process category for current process, only if needed (i.e. name has changed) * @return boolean true if update is done, false otherwise */ function updateProcessCategory($category_guid) { global $PM_DB; if ($category_guid) { $processCategories = new PluginProcessmakerProcessCategory(); $processCategories->getFromDBByCrit(["category_guid" => $category_guid]); if ($processCategories) { return $this->update([ 'id' => $this->getID(), 'plugin_processmaker_processcategories_id' => $processCategories->fields['id'] ]); } } return false; } /** * Summary of updateTaskCategory * Updates TaskCategory for current process, only if needed (i.e. name has changed) * @param integer $pmMainTaskCat is the id of the main task category * @return boolean true if update is done, false otherwise */ function updateTaskCategory($pmMainTaskCat) { global $PM_DB; $taskCat = new TaskCategory; if ($taskCat->getFromDB( $this->fields['taskcategories_id'] ) && $taskCat->fields['name'] != $this->fields['name']) { return $taskCat->update([ 'id' => $taskCat->getID(), 'taskcategories_id' => $pmMainTaskCat, 'name' => $PM_DB->escape($this->fields['name']), 'is_active' => 0 // to prevent use of this task cat in a manual task ] ); } return false; } /** * Summary of addTaskCategory * Adds a new TaskCategory for $this process * @param int $pmMainTaskCat is the main TaskCategory from PM configuration * @return boolean true if TaskCategory has been created and updated into $this process, else otherwise */ function addTaskCategory($pmMainTaskCat) { global $PM_DB; $taskCat = new TaskCategory; if ($taskCat->add([ 'is_recursive' => true, 'taskcategories_id' => $pmMainTaskCat, 'name' => $PM_DB->escape($this->fields['name']), 'is_active' => 0 // to prevent use of this task cat in a manual task ])) { return $this->update( [ 'id' => $this->getID(), 'taskcategories_id' => $taskCat->getID() ] ); } return false; } /** * Print a good title for process pages * add button for re-synchro of process list (only if rigths are w) * @return void (display) **/ function title() { global $CFG_GLPI; $buttons = []; $title = __('Synchronize Process List', 'processmaker'); if ($this->canCreate()) { $buttons["process.php?refresh=1"] = $title; $title = ""; Html::displayTitle(Plugin::getWebDir('processmaker')."/pics/gears.png", $title, '', $buttons); } } /** * Retrieve a Process from the database using its external id (unique index): process_guid * @param string $process_guid guid of the process * @return bool true if succeed else false **/ public function getFromGUID($process_guid) { return $this->getFromDBByCrit(['process_guid' => $process_guid]); } /** * Summary of rawSearchOptions * @return mixed */ function rawSearchOptions() { $tab = []; $tab[] = [ 'id' => 'common', 'name' => __('ProcessMaker', 'processmaker') ]; $tab[] = [ 'id' => '1', 'table' => $this->getTable(), 'field' => 'name', 'name' => __('Name'), 'datatype' => 'itemlink', 'itemlink_type' => 'PluginProcessmakerProcess', 'massiveaction' => false ]; $tab[] = [ 'id' => '8', 'table' => $this->getTable(), 'field' => 'is_active', 'name' => __('Active'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '4', 'table' => $this->getTable(), 'field' => 'comment', 'name' => __('Comments'), 'massiveaction' => true, 'datatype' => 'text' ]; $tab[] = [ 'id' => '9', 'table' => $this->getTable(), 'field' => 'date_mod', 'name' => __('Last update'), 'massiveaction' => false, 'datatype' => 'datetime' ]; $tab[] = [ 'id' => '10', 'table' => $this->getTable(), 'field' => 'process_guid', 'name' => __('Process GUID', 'processmaker'), 'massiveaction' => false, 'datatype' => 'text' ]; $tab[] = [ 'id' => '11', 'table' => $this->getTable(), 'field' => 'project_type', 'name' => __('Process type', 'processmaker'), 'massiveaction' => false, 'datatype' => 'specific' ]; $tab[] = [ 'id' => '12', 'table' => $this->getTable(), 'field' => 'hide_case_num_title', 'name' => __('Hide case num. & title', 'processmaker'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '13', 'table' => $this->getTable(), 'field' => 'insert_task_comment', 'name' => __('Insert Task Category', 'processmaker'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '14', 'table' => 'glpi_itilcategories', 'field' => 'completename', 'name' => __('Category (self-service)', 'processmaker'), 'datatype' => 'dropdown', 'massiveaction' => false ]; $tab[] = [ 'id' => '15', 'table' => $this->getTable(), 'field' => 'type', 'name' => __('Ticket type (self-service)', 'processmaker'), 'searchtype' => 'equals', 'datatype' => 'specific', 'massiveaction' => false ]; $tab[] = [ 'id' => '16', 'table' => $this->getTable(), 'field' => 'is_incident', 'name' => __('Visible in Incident for Central interface', 'processmaker'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '17', 'table' => $this->getTable(), 'field' => 'is_request', 'name' => __('Visible in Request for Central interface', 'processmaker'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '18', 'table' => $this->getTable(), 'field' => 'is_change', 'name' => __('Visible in Change', 'processmaker'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '19', 'table' => $this->getTable(), 'field' => 'is_problem', 'name' => __('Visible in Problem', 'processmaker'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '20', 'table' => 'glpi_plugin_processmaker_processes', 'field' => 'maintenance', 'name' => __('Maintenance'), 'massiveaction' => true, 'datatype' => 'bool' ]; $tab[] = [ 'id' => '21', 'table' => 'glpi_plugin_processmaker_processes', 'field' => 'max_cases_per_item', 'name' => __('Max cases per item (0=unlimited)', 'processmaker'), 'massiveaction' => true, 'datatype' => 'number' ]; $tab[] = [ 'id' => '22', 'table' => 'glpi_plugin_processmaker_processcategories', 'field' => 'name', 'name' => __('Process category'), 'massiveaction' => false, 'datatype' => 'dropdown', ]; return $tab; } /** * @since version 0.84 * * @param $field * @param $values * @param $options array **/ static function getSpecificValueToDisplay($field, $values, array $options = []) { if (!is_array($values)) { $values = [$field => $values]; } switch ($field) { case 'project_type': return self::getProcessTypeName($values[$field]); case 'type': return Ticket::getTicketTypeName($values[$field]); } return parent::getSpecificValueToDisplay($field, $values, $options); } /** * Summary of getAllTypeArray * @return string[] */ static function getAllTypeArray() { $tab = [self::CLASSIC => _x('process_type', 'Classic', 'processmaker'), self::BPMN => _x('process_type', 'BPMN', 'processmaker')]; return $tab; } /** * Summary of getProcessTypeName * @param mixed $value * @return mixed */ static function getProcessTypeName($value) { $tab = static::getAllTypeArray(true); // Return $value if not defined return (isset($tab[$value]) ? $tab[$value] : $value); } /** * Summary of getTypeName * @param mixed $nb * @return mixed */ static function getTypeName($nb = 0) { if ($nb>1) { return __('Processes', 'processmaker'); } return __('Process', 'processmaker'); } function defineTabs($options = []) { // $ong = array('empty' => $this->getTypeName(1)); $ong = []; $this->addDefaultFormTab($ong); $this->addStandardTab(__CLASS__, $ong, $options); $this->addStandardTab('PluginProcessmakerTaskCategory', $ong, $options); $this->addStandardTab('PluginProcessmakerProcess_Profile', $ong, $options); //$this->addStandardTab('Ticket', $ong, $options); //$this->addStandardTab('Log', $ong, $options); return $ong; } function showForm ($ID, $options = ['candel'=>false]) { global $DB, $CFG_GLPI, $PM_SOAP; $this->initForm($ID, $options); $this->showFormHeader($options); echo "
"; echo sprintf(__('Process \'%s\' is under maintenance, please retry later, thank you.', 'processmaker'), $ptitle); echo "
"; echo "