hook.php

<?php

include_once 'inc/processmaker.class.php';

function plugin_processmaker_MassiveActions($type) {
   switch ($type) {
      case 'PluginProcessmakerProcess' :
         if (plugin_processmaker_haveRight('config', UPDATE)) {
            return ['plugin_processmaker_taskrefresh' => __('Synchronize Task List', 'processmaker')];
         }
          break;
      case 'PluginProcessmakerProcess_Profile' :
         if (plugin_processmaker_haveRight('config', UPDATE)) {
            return ['purge' => __('Delete permanently')];
         }
         break;
      //case 'PluginProcessmakerCase' :
      //   if (plugin_processmaker_haveRight("case", DELETE)) {
      //      return array('purge' => __('Delete permanently'));
      //   }
      //break;
   }
   return [];
}


/**
 * Summary of plugin_processmaker_install
 *      Creates tables and initializes tasks, "GLPI Requesters" group
 *      and so on
 * @return true or die!
 */
function plugin_processmaker_install() {
   global $DB;
   if (!$DB->tableExists("glpi_plugin_processmaker_cases")) {
      // new installation
      include_once(GLPI_ROOT."/plugins/processmaker/install/install.php");
      processmaker_install();

   } else {
      // upgrade installation
      include_once(GLPI_ROOT."/plugins/processmaker/install/update.php");
      processmaker_update();
   }

   // To be called for each task managed by the plugin
   // task in class
   CronTask::Register('PluginProcessmakerProcessmaker', 'pmusers', DAY_TIMESTAMP, [ 'state' => CronTask::STATE_DISABLE, 'mode' => CronTask::MODE_EXTERNAL]);
   CronTask::Register('PluginProcessmakerProcessmaker', 'pmorphancases', DAY_TIMESTAMP, ['param' => 10, 'state' => CronTask::STATE_DISABLE, 'mode' => CronTask::MODE_EXTERNAL]);
   CronTask::Register('PluginProcessmakerProcessmaker', 'pmtaskactions', MINUTE_TIMESTAMP, ['state' => CronTask::STATE_DISABLE, 'mode' => CronTask::MODE_EXTERNAL]);

   // required because autoload doesn't work for unactive plugin'
   include_once(GLPI_ROOT."/plugins/processmaker/inc/profile.class.php");
   PluginProcessmakerProfile::createAdminAccess($_SESSION['glpiactiveprofile']['id']);

   return true;
}

function plugin_processmaker_uninstall() {

   CronTask::Unregister('PluginProcessmakerProcessmaker');

   return true;
}


function plugin_processmaker_getAddSearchOptions($itemtype) {

   $sopt = [];
   // TODO add Change and Problem + other fields to the search
   if ($itemtype == 'Ticket') {
      $sopt[10001]['table']     = 'glpi_plugin_processmaker_cases';
      $sopt[10001]['field']     = 'case_status';
      //$sopt[1001]['linkfield'] = 'id';
      $sopt[10001]['massiveaction'] = false;
      $sopt[10001]['name']      = __('Case', 'processmaker').' - '.__('Status', 'processmaker');
      $sopt[10001]['datatype']       = 'text';
      $sopt[10001]['forcegroupby'] = true;
      //$sopt[10001]['searchtype'] = 'equals';

      //$sopt[1001]['itemlink_type'] = 'PluginProcessmakerTicketcase';

      //$sopt[1001]['table']          = 'glpi_plugin_processmaker_ticketcase';
      //$sopt[1001]['field']          = 'case_status';
      //$sopt[1001]['massiveaction']  = false;
      //$sopt[1001]['name']           = 'Case - Status';
      //$sopt[1001]['forcegroupby']   = true;
      //$sopt[1001]['datatype']       = 'itemlink';
      // $sopt[1001]['itemlink_type']  = 'PluginProcessmakerProcessmaker';
      //$sopt[1001]['joinparams']     = array('beforejoin'
      //                                       => array('table'      => 'glpi_plugin_processmaker_ticketcase',
      //                                                'linkfield' => 'ticket_id'));

      //$sopt[1001]['joinparams']['jointype'] = "itemtype_id";
      //$sopt[1001]['pfields_type']  = ;
   }
    return $sopt;
}

function plugin_processmaker_addLeftJoin($type, $ref_table, $new_table, $linkfield, &$already_link_tables) {

   switch ($type) {

      case 'Ticket':
         switch ($new_table) {

            case "glpi_plugin_processmaker_cases" :
               $out= " LEFT JOIN `glpi_plugin_processmaker_cases`
                        ON (`$ref_table`.`id` = `glpi_plugin_processmaker_cases`.`items_id` AND `glpi_plugin_processmaker_cases`.`itemtype` like 'Ticket') ";
               return $out;

         }

      return "";

   }

    return "";
}

/**
 * Summary of plugin_pre_item_update_processmaker
 * @param CommonITILObject $parm is an object
 * @return void
 */
function plugin_pre_item_update_processmaker(CommonITILObject $parm) {
   //global $DB;//, $PM_SOAP;

   // look at previous status
   if (isset($parm->input['status']) 
      && $parm->input['status'] == CommonITILObject::SOLVED
      && !in_array($parm->fields['status'], [CommonITILObject::SOLVED, CommonITILObject::CLOSED])
      && !PluginProcessmakerCase::canSolve(['item' => $parm])) {
      $parm->input = []; // empty array... to prevent item update
      Session::addMessageAfterRedirect(__('At least one \'Process case\' is running!<br/>Solving is currently disabled!', 'processmaker'), false, ERROR);
      return;
   }


   if (isset($_SESSION['glpiname'])) {
      $locVar = [ ];
      foreach ($parm->input as $key => $val) {
         switch ($key) {
            case 'global_validation' :
               $locVar[ 'GLPI_TICKET_GLOBAL_VALIDATION' ] = $val;
               $locVar[ 'GLPI_ITEM_GLOBAL_VALIDATION' ] = $val;
               break;
            case 'itilcategories_id' :
               $locVar[ 'GLPI_ITEM_ITIL_CATEGORY_ID' ] = $val;
               break;
            case 'date' :
               $locVar[ 'GLPI_ITEM_OPENING_DATE' ] = $val;
               break;
            case 'time_to_resolve' :
               $locVar[ 'GLPI_TICKET_DUE_DATE' ] = $val;
               $locVar[ 'GLPI_ITEM_DUE_DATE' ] = $val;
               break;
            case 'urgency' :
               $locVar[ 'GLPI_TICKET_URGENCY' ] = $val;
               $locVar[ 'GLPI_ITEM_URGENCY' ] = $val;
               break;
            case 'impact' :
               $locVar[ 'GLPI_ITEM_IMPACT' ] = $val;
               break;
            case 'priority' :
               $locVar[ 'GLPI_ITEM_PRIORITY' ] = $val;
               break;
         }
      }

      $itemId = $parm->getID();
      $itemType = $parm->getType();

      $locCase = new PluginProcessmakerCase;
      foreach (PluginProcessmakerCase::getIDsFromItem($itemType, $itemId) as $cases_id) {
         $locCase->getFromDB($cases_id);
         $locCase->sendVariables($locVar);

         // if entities_id of item has been changed, then must update case
         if (isset($parm->input['entities_id']) && $parm->input['entities_id'] != $parm->fields['entities_id']) {
            $locCase->update(['id' => $cases_id, 'entities_id' => $parm->input['entities_id']]);
         }
      }
   }

}

/**
 * Summary of plugin_item_update_processmaker_satisfaction
 * inject satisfaction survey into case
 * @param mixed $parm is the object
 */
function plugin_item_update_processmaker_satisfaction($parm) {
   global $PM_SOAP;
   if (Session::isCron()) { // Task cron log with user admin
      $PM_SOAP->login(true);
   } 
   $cases = PluginProcessmakerCase::getIDsFromItem('Ticket', $parm->fields['tickets_id']);
   foreach ($cases as $cases_id) {
      $locCase = new PluginProcessmakerCase;
      if ($locCase->getFromDB($cases_id)) {
         // case is existing for this item
         $locCase->sendVariables( ['GLPI_SATISFACTION_QUALITY' => $parm->fields['satisfaction']] );
      }
   }
}


/**
 * Summary of plugin_item_update_processmaker_user
 * When a user login is changed, then must change it in the PM tables
 * @param User $param is the user being changed
 */
function plugin_item_update_processmaker_user(User $param) {
   // Must test if user login has been changed
   // if yes, must change the login in the PM tables:
   // USERS and RBAC_USERS, othewise the link in the processmaker_users table will be invalid
   if (in_array('name', $param->updates)) {
      // check if user is in the processmaker_user table
      $pm_user = PluginProcessmakerUser::getPMUserId($param->getID());
      if ($pm_user) {
         // must update the user in PM tables
         global $PM_SOAP;
         if ($param->fields['is_active'] == 0 || $param->fields['is_deleted'] == 1) {
               $status = "INACTIVE";
            } else {
               $status = "ACTIVE";
            }
         $PM_SOAP->login(true);
         $pmResult = $PM_SOAP->updateUser( $pm_user, $param->fields['name'], $param->fields['firstname'], $param->fields['realname'], $status );
      }
   }
}


function plugin_processmaker_post_init() {
   global $PM_DB, $PM_SOAP;
   if (!isset($PM_DB)) {
      $PM_DB = new PluginProcessmakerDB;
   }
   if (!isset($PM_SOAP)) {
      $PM_SOAP = new PluginProcessmakerProcessmaker;
      // and default login is current running user if any
      if (Session::getLoginUserID()) {
         $PM_SOAP->login();
      }
   }
}


function plugin_processmaker_giveItem($itemtype, $ID, $data, $num) {

   return;
}


function plugin_processmaker_change_profile() {
   if ($_SESSION['glpiactiveprofile']['interface'] == "helpdesk") {
      // must add the rights for simplified interface
      $_SESSION['glpiactiveprofile']['plugin_processmaker_case'] = READ;
   }
}

/**
   * Summary of plugin_item_add_update_processmaker_tasks
   * @param mixed $parm
   */
function plugin_item_update_processmaker_tasks($parm) {
   global $DB, $CFG_GLPI, $PM_SOAP;

   $pmTaskCat = new PluginProcessmakerTaskCategory;
   if ($pmTaskCat->getFromDBbyCategory( $parm->fields['taskcategories_id'] )
            && in_array( 'state', $parm->updates )
            && $parm->input['state'] == Planning::DONE
            && $parm->oldvalues['state'] == Planning::TODO) {  // the task has just been set to DONE state

      //$itemtype = str_replace( 'Task', '', $parm->getType() );

      $pmTask = new PluginProcessmakerTask($parm->getType());
      $pmTask->getFromDB($parm->fields['id']);

      $locCase = new PluginProcessmakerCase;
      $locCase->getFromDB($pmTask->fields['plugin_processmaker_cases_id']);
      $srccase_guid = $locCase->fields['case_guid'];

      //$msg  =  Toolbox::backtrace(false);
      //$msg .= ' $locCase: '.str_replace("\n", "\n  ", print_r($locCase, true))."\n";
      //$msg .= ' $task: '.str_replace("\n", "\n  ", print_r($parm, true))."\n";
      //$msg .= ' $pmTask: '.str_replace("\n", "\n  ", print_r($pmTask, true))."\n";
      //$msg .= "\n";

      foreach ($DB->request( 'glpi_plugin_processmaker_caselinks', "is_active = 1 AND sourcetask_guid='".$pmTaskCat->fields['pm_task_guid']."'") as $targetTask) {

         // Must check the condition
         $casevariables = [];

         $matches = [];
         if (preg_match_all( "/@@(\w+)/u", $targetTask['sourcecondition'], $matches  )) {
            $casevariables = $matches[1];
         }

         $targetTask['targetactions'] = []; // empty array by default
         foreach ($DB->request( 'glpi_plugin_processmaker_caselinkactions', 'plugin_processmaker_caselinks_id = '.$targetTask['id']) as $actionvalue) {
            $targetTask['targetactions'][$actionvalue['name']] = $actionvalue['value'];
            if (preg_match_all( "/@@(\w+)/u", $actionvalue['value'], $matches  )) {
               $casevariables = array_merge( $casevariables, $matches[1] );
            }
         }
         $externalapplication = false; // by default
         if ($targetTask['is_externaldata'] && isset($targetTask['externalapplication'])) {
            // must read some values
            $externalapplication = json_decode( $targetTask['externalapplication'], true );
            // must be of the form
            // {"method":"POST","url":"urloftheservice","params":json_object}
            // Where method is the POST, GET, ... method
            // url is the URL to be called
            // params is a list of parameters to get from running case
            foreach ($externalapplication['params'] as $paramname => $variable) {
               if (preg_match_all( "/@@(\w+)/u", $variable, $matches  )) {
                  $casevariables = array_merge( $casevariables, $matches[1] );
               }
            }
         }

         // ask for those case variables
         //$PM_SOAP = new PluginProcessmakerProcessmaker();
         //$PM_SOAP->login( );
         // now tries to get the variables to check condition
         $infoForTasks = $locCase->getVariables($casevariables);
         foreach ($infoForTasks as $casevar => $varval) {
            $infoForTasks[ "@@$casevar" ] = "'$varval'";
            unset( $infoForTasks[ $casevar ] );
         }

         //$msg .= " ***********\n";
         //$msg .= ' $targetTask: '.str_replace("\n", "\n  ", print_r($targetTask, true))."\n";

         $targetTask['sourcecondition'] = str_replace( array_keys($infoForTasks), $infoForTasks, $targetTask['sourcecondition'] );

         $eval = eval( "return (".$targetTask['sourcecondition']." ? 1 : 0);" );

         //$msg .= ' $infoForTasks: '.str_replace("\n", "\n  ", print_r($infoForTasks, true))."\n";
         //$msg .= ' $targetTask[\'sourcecondition\']: '.str_replace("\n", "\n  ", print_r($targetTask['sourcecondition'], true))."\n";
         //$msg .= ' $result: '."$eval\n";
         //$msg .= "\n";

         if ($eval) {
            // look at each linked ticket if a case is attached and then if a task like $val is TO_DO
            // then will try to routeCase for each tasks in $val

            $postdata = [];
            foreach ($targetTask['targetactions'] as $action => $actionvalue) {
               $postdata['form'][$action] = eval( "return ".str_replace( array_keys($infoForTasks), $infoForTasks, $actionvalue)." ;" );
            }
            $postdata['UID']                        = $targetTask['targetdynaform_guid'];
            $postdata['__DynaformName__']           = $targetTask['targetprocess_guid']."_".$targetTask['targetdynaform_guid'];
            $postdata['__notValidateThisFields__']  = '[]';
            $postdata['DynaformRequiredFields']     = '[]';
            $postdata['form']['btnGLPISendRequest'] = 'submit';

            $externalapplicationparams = [];
            if ($externalapplication) {
               // must call curl
               foreach ($externalapplication['params'] as $paramname => $variable) {
                  $externalapplicationparams[$paramname] = eval( "return ".str_replace( array_keys($infoForTasks), $infoForTasks, $variable)." ;" );
               }
               $externalapplicationparams['callback'] = $CFG_GLPI["url_base"]."/plugins/processmaker/ajax/asynchronousdatas.php";
               $ch = curl_init();
               $externalapplication['url'] = eval( "return '".str_replace( array_keys($infoForTasks), $infoForTasks, $externalapplication['url'])."' ;" ); // '???
               curl_setopt($ch, CURLOPT_URL, $externalapplication['url'] );
               if (isset($externalapplication['method']) && $externalapplication['method'] == 'POST') {
                  curl_setopt($ch, CURLOPT_POST, 1);
               }
            }

            if ($targetTask['is_self']) {
               $PM_SOAP->login(true);
               $taskCase = $PM_SOAP->taskCase( $srccase_guid );
               foreach ($taskCase as $task) {
                  // search for target task guid
                  if ($task->guid == $targetTask['targettask_guid']) {
                     break;
                  }
               }
               $PM_SOAP->login();

               $postdata['APP_UID']                    = $srccase_guid;
               $postdata['DEL_INDEX']                  = $task->delegate;

               //need to get the 'ProcessMaker' user
               $pmconfig = $PM_SOAP->config; //PluginProcessmakerConfig::getInstance();

               $cronaction = new PluginProcessmakerCrontaskaction;
               $cronaction->add( [ 'plugin_processmaker_caselinks_id' => $targetTask['id'],
                                        'plugin_processmaker_cases_id' => $locCase->getID(),
                                          //'itemtype'         => $itemtype,
                                          //'items_id'         => $parm->fields['tickets_id'],
                                          'users_id'         => $pmconfig->fields['users_id'],
                                          'is_targettoclaim' => $targetTask['is_targettoclaim'],
                                          'state'            => ($targetTask['is_externaldata'] ? PluginProcessmakerCrontaskaction::WAITING_DATA : PluginProcessmakerCrontaskaction::DATA_READY),
                                          'postdata'         => json_encode( $postdata, JSON_HEX_APOS | JSON_HEX_QUOT),
                                          'logs_out'         => json_encode( $externalapplicationparams, JSON_HEX_APOS | JSON_HEX_QUOT)
                                          ],
                                 null,
                                 false);

               if ($externalapplication) {
                  // must call external application in order to get the needed data asynchroneously
                  // must be of the form
                  // {"url":"urloftheservice","params":{"user":"@@USER_ID","system":"GPP","list":"@@ROLE_LIST"}}
                  // url is the URL to be called

                  $externalapplicationparams['id'] = $cronaction->getID();

                  $externalapplicationparams = json_encode( $externalapplicationparams, JSON_HEX_APOS | JSON_HEX_QUOT);

                  curl_setopt($ch, CURLOPT_POSTFIELDS, $externalapplicationparams);
                  curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json', 'Content-Length: ' . strlen($externalapplicationparams), 'Expect:']);
                  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1 );
                  curl_setopt($ch, CURLOPT_VERBOSE, 1);

                  if (isset($externalapplication['ssl_verify'])) {
                     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $externalapplication['ssl_verify']);
                     curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, $externalapplication['ssl_verify']);
                  }

                  if (isset($externalapplication['proxy'])) {
                     curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, 1 ) ;
                     curl_setopt($ch, CURLOPT_PROXY, $externalapplication['proxy']);
                  }

                  $response = curl_exec ($ch);
                  if ($response === false) {
                     //throw new Exception(curl_error($ch), curl_errno($ch));
                     Toolbox::logDebug( curl_error($ch).":".curl_errno($ch) );
                  }

                  curl_close ($ch);
               }
               //               }
            } else {
               // TODO to review this part of code as it is no longer usable like this !!!
               foreach (Ticket_Ticket::getLinkedTicketsTo( $parm->fields['tickets_id'] ) as $tlink) {
                  if ($tlink['link'] == Ticket_Ticket::LINK_TO) {
                     $query = "SELECT glpi_plugin_processmaker_cases.id, MAX(glpi_plugin_processmaker_tasks.del_index) AS del_index FROM glpi_tickettasks
                           JOIN glpi_plugin_processmaker_taskcategories ON glpi_plugin_processmaker_taskcategories.taskcategories_id=glpi_tickettasks.taskcategories_id
                           JOIN glpi_plugin_processmaker_cases ON glpi_plugin_processmaker_cases.processes_id=glpi_plugin_processmaker_taskcategories.processes_id
                           RIGHT JOIN glpi_plugin_processmaker_tasks ON glpi_plugin_processmaker_tasks.items_id=glpi_tickettasks.id AND glpi_plugin_processmaker_tasks.case_id=glpi_plugin_processmaker_cases.id
                           WHERE glpi_plugin_processmaker_taskcategories.pm_task_guid = '".$targetTask['targettask_guid']."' AND glpi_tickettasks.state = 1 AND glpi_tickettasks.tickets_id=".$tlink['tickets_id'];
                     foreach ($DB->request($query) as $case) {
                        // must be only one row

                        $postdata['APP_UID']                    = $case['id'];
                        $postdata['DEL_INDEX']                  = $case['del_index'];

                        $cronaction = new PluginProcessmakerCrontaskaction;
                        $cronaction->add( [ 'plugin_processmaker_caselinks_id' => $targetTask['id'],
                                                 'plugin_processmaker_cases_id' => $locCase->getID(),
                                                   //'itemtype'         => $itemtype,
                                                   //'items_id'         => $parm->fields['tickets_id'],
                                                   'users_id'         => Session::getLoginUserID(),
                                                   'is_targettoclaim' => $targetTask['is_targettoclaim'],
                                                   'state'            => ($targetTask['is_externaldata'] ? PluginProcessmakerCrontaskaction::WAITING_DATA : PluginProcessmakerCrontaskaction::DATA_READY),
                                                   'postdata'         => json_encode( $postdata, JSON_HEX_APOS | JSON_HEX_QUOT),
                                                   'logs_out'         => json_encode( $externalapplicationparams, JSON_HEX_APOS | JSON_HEX_QUOT)
                                                   ],
                                          null,
                                          false);
                     }
                  }
               }
            }

            if ($targetTask['is_synchronous']) {
               // must call PluginProcessmakerProcessmaker::cronPMTaskActions()
               PluginProcessmakerProcessmaker::cronPMTaskActions();
            }
         }

      }

      //$msg .= "================\n";
      //Toolbox::logInFile("processmaker", $msg);

   }
}