triggerhistory.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017       Laurent Destailleur      <eldy@users.sourceforge.net>
 * Copyright (C) 2023-2025  Frédéric France          <frederic.france@free.fr>
 * Copyright (C) 2025   Alice Adminson        <myemail@mycompany.com>
 *
 * 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 3 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, see <https://www.gnu.org/licenses/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
 
class TriggerHistory extends CommonObject
{
  public $module = 'webhook';
 
  public $element = 'webhook_triggerhistory';
 
  public $table_element = 'webhook_history';
 
  //public $element_for_permission = 'webhook';
 
  public $picto = 'fa-calendar-alt';
 
 
  const STATUS_SUCCESS = 1;
  const STATUS_ERROR = -1;
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    "rowid" => array("type" => "integer", "label" => "TechnicalID", "enabled" => 1, 'position' => 1, 'notnull' => 1, "visible" => 1, "noteditable" => 1, "index" => 1, "css" => "left", "comment" => "Id"),
    "fk_target" => array("type" => "integer:target:webhook/class/target.class.php:0:(status:=:1)", "label" => "Target", "enabled" => 1, 'position' => 5, 'notnull' => 1, "visible" => 1),
    "trigger_code" => array("type" => "varchar(128)", "label" => "TriggerCode", "enabled" => 1, 'position' => 8, 'notnull' => 1, "visible" => 1),
    "url" => array("type" => "varchar(255)", "label" => "Url", "enabled" => 1, 'position' => 15, 'notnull' => 1, "visible" => 1, 'csslist' => "small tdoverflowmax150"),
    "trigger_data" => array("type" => "text", "label" => "TriggerData", "enabled" => 1, 'position' => 20, 'notnull' => 1, "visible" => 1, "csslist" => "small tdoverflowmax300"),
    "note_private" => array("type" => "text", "label" => "NotePrivate", "enabled" => 1, 'position' => 62, 'notnull' => 0, "visible" => 0, "cssview" => "wordbreak", "validate" => 1),
    "date_creation" => array("type" => "datetime", "label" => "DateCreation", "enabled" => 1, 'position' => 500, 'notnull' => 1, "visible" => -2),
    "tms" => array("type" => "timestamp", "label" => "DateModification", "enabled" => 1, 'position' => 501, 'notnull' => 0, "visible" => -2),
    "fk_user_creat" => array("type" => "integer:User:user/class/user.class.php", "label" => "UserAuthor", "picto" => "user", "enabled" => 1, 'position' => 510, 'notnull' => 1, "visible" => -2, "csslist" => "tdoverflowmax150"),
    "import_key" => array("type" => "varchar(14)", "label" => "ImportId", "enabled" => 1, 'position' => 1000, 'notnull' => -1, "visible" => -2,),
    "status" => array("type" => "integer", "label" => "Status", "enabled" => 1, "position" => 2000, "notnull" => 1, 'default' => '1', "visible" => 1, "index" => 1, "arrayofkeyval" => array("1" => "Success", "-1" => "Error"), "validate" => 1),
    "error_message" => array("type" => "text", "label" => "ErrorMessage", "enabled" => 1, 'position' => 50, 'notnull' => 0, "visible" => 1, "csslist" => "small tdoverflowmax150"),
  );
  public $rowid;
  public $note_public;
  public $note_private;
  public $date_creation;
  public $tms;
  public $fk_user_creat;
  public $import_key;
  public $status;
  public $trigger_data;
  public $fk_target;
  public $url;
  public $trigger_code;
  public $error_messsage;
  // END MODULEBUILDER PROPERTIES
 
 
  // If this object has a subtable with lines
 
  // /**
  //  * @var string    Name of subtable line
  //  */
  // public $table_element_line = 'webhook_historyline';
 
  // /**
  //  * @var string    Field name with ID of parent key if this object has a parent, Or Field name of in child tables to link to this record.
  //  */
  // public $fk_element = 'fk_history';
 
  // /**
  //  * @var string    Name of subtable class that manage subtable lines
  //  */
  // public $class_element_line = 'Historyline';
 
  // /**
  //  * @var array  List of child tables. To test if we can delete object.
  //  */
  // protected $childtables = array('mychildtable' => array('name'=>'', 'fk_element'=>'fk_history'));
 
  // /**
  //  * @var array    List of child tables. To know object to delete on cascade.
  //  *               If name matches '@ClassName:FilePathClass:ParentFkFieldName' (the recommended mode) it will
  //  *               call method ClassName->deleteByParentField(parentId, 'ParentFkFieldName') to fetch and delete child object.
  //  *               Using an array like childtables should not be implemented because a child may have other child, so we must only use the method that call deleteByParentField().
  //  */
  // protected $childtablesoncascade = array('webhook_historydet');
 
  // /**
  //  * @var HistoryLine[]     Array of subtable lines
  //  */
  // public $lines = array();
 
 
 
  public function __construct(DoliDB $db)
  {
    global $langs;
 
    $this->db = $db;
    $this->ismultientitymanaged = 0;
    $this->isextrafieldmanaged = 1;
 
    if (!getDolGlobalInt('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid']) && !empty($this->fields['ref'])) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
      $this->fields['entity']['enabled'] = 0;
    }
 
    // Example to show how to set values of fields definition dynamically
    /*if ($user->hasRight('webhook', 'triggerhistory', 'read')) {
      $this->fields['myfield']['visible'] = 1;
      $this->fields['myfield']['noteditable'] = 0;
    }*/
 
    // Unset fields that are disabled
    foreach ($this->fields as $key => $val) {
      if (isset($val['enabled']) && empty($val['enabled'])) {
        unset($this->fields[$key]);
      }
    }
 
    // Translate some data of arrayofkeyval
    if (is_object($langs)) {
      foreach ($this->fields as $key => $val) {
        if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
          foreach ($val['arrayofkeyval'] as $key2 => $val2) {
            $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
          }
        }
      }
    }
  }
 
  public function create(User $user, $notrigger = 0)
  {
    $result = $this->createCommon($user, $notrigger);
 
    // uncomment lines below if you want to validate object after creation
    // if ($result > 0) {
    // $this->fetch($this->id); // needed to retrieve some fields (ie date_creation for masked ref)
    // $resultupdate = $this->validate($user, $notrigger);
    // if ($resultupdate < 0) { return $resultupdate; }
    // }
 
    return $result;
  }
 
  public function fetch($id, $ref = null, $noextrafields = 0, $nolines = 0)
  {
    $result = $this->fetchCommon($id, $ref, '', $noextrafields);
    if ($result > 0 && !empty($this->table_element_line) && empty($nolines)) {
      $this->fetchLines($noextrafields);
    }
    return $result;
  }
 
  public function fetchLines($noextrafields = 0)
  {
    $this->lines = array();
 
    $result = $this->fetchLinesCommon('', $noextrafields);
    return $result;
  }
 
 
  public function fetchAll($sortorder = '', $sortfield = '', $limit = 1000, $offset = 0, string $filter = '', $filtermode = 'AND')
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $records = array();
 
    $sql = "SELECT ";
    $sql .= $this->getFieldList('t');
    $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
    if ($this->isextrafieldmanaged == 1) {
      $sql .= " LEFT JOIN ".$this->db->prefix().$this->table_element."_extrafields as te ON te.fk_object = t.rowid";
    }
    if ($this->ismultientitymanaged == 1) {
      $sql .= " WHERE t.entity IN (".getEntity($this->element).")";
    } else {
      $sql .= " WHERE 1 = 1";
    }
 
    // Manage filter
    $errormessage = '';
    $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
    if ($errormessage) {
      $this->errors[] = $errormessage;
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
      return -1;
    }
 
    if (!empty($sortfield)) {
      $sql .= $this->db->order($sortfield, $sortorder);
    }
    if (!empty($limit)) {
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
      $i = 0;
      while ($i < ($limit ? min($limit, $num) : $num)) {
        $obj = $this->db->fetch_object($resql);
 
        $record = new self($this->db);
        $record->setVarsFromFetchObj($obj);
 
        if (!empty($record->isextrafieldmanaged)) {
          $record->fetch_optionals();
        }
 
        $records[$record->id] = $record;
 
        $i++;
      }
      $this->db->free($resql);
 
      return $records;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function update(User $user, $notrigger = 0)
  {
    return $this->updateCommon($user, $notrigger);
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    return $this->deleteCommon($user, $notrigger);
    //return $this->deleteCommon($user, $notrigger, 1);
  }
 
  public function deleteLine(User $user, $idline, $notrigger = 0)
  {
    if ($this->status < 0) {
      $this->error = 'ErrorDeleteLineNotAllowedByObjectStatus';
      return -2;
    }
 
    return $this->deleteLineCommon($user, $idline, $notrigger);
  }
 
  public function setDraft($user, $notrigger = 0)
  {
    // Protection
    if ($this->status <= self::STATUS_SUCCESS) {
      return 0;
    }
 
    /* if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('webhook','write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('webhook','webhook_advance','validate'))))
     {
     $this->error='Permission denied';
     return -1;
     }*/
 
    return $this->setStatusCommon($user, self::STATUS_ERROR, $notrigger, 'WEBHOOK_MYOBJECT_UNVALIDATE');
  }
 
  public function cancel($user, $notrigger = 0)
  {
    // Protection
    if ($this->status != self::STATUS_SUCCESS) {
      return 0;
    }
 
    /* if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('webhook','write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('webhook','webhook_advance','validate'))))
     {
     $this->error='Permission denied';
     return -1;
     }*/
 
    return $this->setStatusCommon($user, self::STATUS_ERROR, $notrigger, 'WEBHOOK_MYOBJECT_CANCEL');
  }
 
  public function reopen($user, $notrigger = 0)
  {
    // Protection
    if ($this->status == self::STATUS_SUCCESS) {
      return 0;
    }
 
    /*if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('webhook','write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('webhook','webhook_advance','validate'))))
     {
     $this->error='Permission denied';
     return -1;
     }*/
 
    return $this->setStatusCommon($user, self::STATUS_SUCCESS, $notrigger, 'WEBHOOK_MYOBJECT_REOPEN');
  }
 
  public function getTooltipContentArray($params)
  {
    global $langs;
 
    $datas = [];
 
    if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
      return ['optimize' => $langs->trans("ShowTriggerHistory")];
    }
    $datas['picto'] = img_picto('', $this->picto).' <u>'.$langs->trans("").'</u>';
    $datas['picto'] .= ' '.$this->getLibStatut(5);
    return $datas;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $conf, $langs, $hookmanager;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
    $params = [
      'id' => (string) $this->id,
      'objecttype' => $this->element.($this->module ? '@'.$this->module : ''),
      'option' => $option,
    ];
    $classfortooltip = 'classfortooltip';
    $dataparams = '';
    $label = img_picto('', $this->picto).' <u>'.$langs->trans("TriggerHistory").'</u>';
    $label .= ' '.$this->getLibStatut(5);
    $label .= '<br>';
    $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
    $url = dol_buildpath('/webhook/triggerhistory_card.php', 1).'?id='.$this->id;
 
    if ($option !== 'nolink') {
      // Add param to save lastsearch_values or not
      $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
      if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
        $add_save_lastsearch_values = 1;
      }
      if ($add_save_lastsearch_values) {
        $url .= '&save_lastsearch_values=1';
      }
    }
 
    $linkclose = '';
    if (empty($notooltip)) {
      if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("ShowTriggerHistory");
        $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
      }
      $linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
      $linkclose .= $dataparams.' class="'.$classfortooltip.($morecss ? ' '.$morecss : '').'"';
    } else {
      $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
    }
 
    if ($option == 'nolink') {
      $linkstart = '<span';
    } else {
      $linkstart = '<a href="'.$url.'"';
    }
    $linkstart .= $linkclose.'>';
    if ($option == 'nolink') {
      $linkend = '</span>';
    } else {
      $linkend = '</a>';
    }
 
    $result .= $linkstart;
 
    if (empty($this->showphoto_on_popup)) {
      if ($withpicto) {
        $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), (($withpicto != 2) ? 'class="paddingright"' : ''), 0, 0, $notooltip ? 0 : 1);
      }
    } else {
      if ($withpicto) {
        require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
 
        list($class, $module) = explode('@', $this->picto);
        $upload_dir = $conf->$module->multidir_output[$conf->entity]."/$class/".dol_sanitizeFileName($this->ref);
        $filearray = dol_dir_list($upload_dir, "files");
        $filename = $filearray[0]['name'];
        if (!empty($filename)) {
          $pospoint = strpos($filearray[0]['name'], '.');
 
          $pathtophoto = $class.'/'.$this->ref.'/thumbs/'.substr($filename, 0, $pospoint).'_mini'.substr($filename, $pospoint);
          if (!getDolGlobalString(strtoupper($module.'_'.$class).'_FORMATLISTPHOTOSASUSERS')) {
            $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo'.$module.'" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div></div>';
          } else {
            $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photouserphoto userphoto" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div>';
          }
 
          $result .= '</div>';
        } else {
          $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'"'), 0, 0, $notooltip ? 0 : 1);
        }
      }
    }
 
    if ($withpicto != 2) {
      $result .= $this->ref;
    }
 
    $result .= $linkend;
    //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
 
    global $action, $hookmanager;
    $hookmanager->initHooks(array($this->element.'dao'));
    $parameters = array('id' => $this->id, 'getnomurl' => &$result);
    $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
    if ($reshook > 0) {
      $result = $hookmanager->resPrint;
    } else {
      $result .= $hookmanager->resPrint;
    }
 
    return $result;
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    global $conf, $langs;
 
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
 
    $return = '<div class="box-flex-item box-flex-grow-zero">';
    $return .= '<div class="info-box info-box-sm">';
    $return .= '<span class="info-box-icon bg-infobox-action">';
    $return .= img_picto('', $this->picto);
    $return .= '</span>';
    $return .= '<div class="info-box-content">';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">'.$this->getNomUrl().'</span>';
    if ($selected >= 0) {
      $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
    }
    if (is_object($this->thirdparty)) {
      $return .= '<br><div class="info-box-ref tdoverflowmax150">'.$this->thirdparty->getNomUrl(1).'</div>';
    }
    /*if (property_exists($this, 'amount')) {
      $return .= '<br>';
      $return .= '<span class="info-box-label amount">'.price($this->amount, 0, $langs, 1, -1, -1, getDolCurrency()).'</span>';
    }*/
    $return .= '<br><div class="info-box-status">'.$this->getLibStatut(3).'</div>';
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
 
    return $return;
  }
 
  public function getLabelStatus($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    if (is_null($status)) {
      return '';
    }
 
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      global $langs;
      //$langs->load("webhook@webhook");
      $this->labelStatus[self::STATUS_SUCCESS] = $langs->transnoentitiesnoconv('Success');
      $this->labelStatus[self::STATUS_ERROR] = $langs->transnoentitiesnoconv('Error');
      $this->labelStatusShort[self::STATUS_SUCCESS] = $langs->transnoentitiesnoconv('Success');
      $this->labelStatusShort[self::STATUS_ERROR] = $langs->transnoentitiesnoconv('Error');
    }
 
    $statusType = 'status'.$status;
    if ($status == self::STATUS_SUCCESS) {
      $statusType = 'status4';
    }
    if ($status == self::STATUS_ERROR) {
      $statusType = 'status8';
    }
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
  }
 
  public function info($id)
  {
    $sql = "SELECT rowid,";
    $sql .= " date_creation as datec, tms as datem";
    if (!empty($this->fields['date_validation'])) {
      $sql .= ", date_validation as datev";
    }
    if (!empty($this->fields['fk_user_creat'])) {
      $sql .= ", fk_user_creat";
    }
    if (!empty($this->fields['fk_user_modif'])) {
      $sql .= ", fk_user_modif";
    }
    if (!empty($this->fields['fk_user_valid'])) {
      $sql .= ", fk_user_valid";
    }
    $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
    $sql .= " WHERE t.rowid = ".((int) $id);
 
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
 
        $this->id = $obj->rowid;
 
        if (!empty($this->fields['fk_user_creat'])) {
          $this->user_creation_id = $obj->fk_user_creat;
        }
        if (!empty($this->fields['fk_user_modif'])) {
          $this->user_modification_id = $obj->fk_user_modif;
        }
        if (!empty($this->fields['fk_user_valid'])) {
          $this->user_validation_id = $obj->fk_user_valid;
        }
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
        if (!empty($obj->datev)) {
          $this->date_validation   = empty($obj->datev) ? '' : $this->db->jdate($obj->datev);
        }
      }
 
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }
 
  public function initAsSpecimen()
  {
    // Set here init that are not commonf fields
    // $this->property1 = ...
    // $this->property2 = ...
 
    return $this->initAsSpecimenCommon();
  }
 
  public function getLinesArray()
  {
    $this->lines = array();
 
    $objectline = new HistoryLine($this->db);
    $result = $objectline->fetchAll('ASC', 'position', 0, 0, '(fk_history:=:'.((int) $this->id).')');
 
    if (is_numeric($result)) {
      $this->setErrorsFromObject($objectline);
      return $result;
    } else {
      $this->lines = $result;
      return $this->lines;
    }
  }
 
  public function validateField($fields, $fieldKey, $fieldValue)
  {
    // Add your own validation rules here.
    // ...
 
    return parent::validateField($fields, $fieldKey, $fieldValue);
  }
 
  public function doScheduledJob()
  {
    //global $conf, $langs;
 
    //$conf->global->SYSLOG_FILE = 'DOL_DATA_ROOT/dolibarr_mydedicatedlogfile.log';
 
    $error = 0;
    $this->output = '';
    $this->error = '';
 
    dol_syslog(__METHOD__." start", LOG_INFO);
 
    $now = dol_now();
 
    $this->db->begin();
 
    // ...
 
    $this->db->commit();
 
    dol_syslog(__METHOD__." end", LOG_INFO);
 
    return $error;
  }
}
 
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobjectline.class.php';
 
class HistoryLine extends CommonObjectLine
{
  // To complete with content of an object HistoryLine
  // We should have a field rowid, fk_history and position
 
  public $parent_element = '';    // Example: '' or 'triggerhistory'
 
  public $fk_parent_attribute = ''; // Example: '' or 'fk_history'
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
 
    $this->isextrafieldmanaged = 0;
  }
}