hook.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2019       Frédéric France     <frederic.france@netlogic.fr>
 * 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 <http://www.gnu.org/licenses/>.
 */

require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';

class Hook extends CommonObject
{
  public $element = 'hook';

  public $table_element = 'zapier_hook';

  public $ismultientitymanaged = 0;

  public $isextrafieldmanaged = 1;

  public $picto = 'hook@zapier';


  const STATUS_DRAFT = 0;
  const STATUS_VALIDATED = 1;
  const STATUS_DISABLED = -1;


  public $fields = array(
    'rowid' => array(
      'type' => 'integer',
      'label' => 'TechnicalID',
      'enabled' => 1,
      'visible' => -2,
      'noteditable' => 1,
      'notnull' => 1,
      'index' => 1,
      'position' => 1,
      'comment' => 'Id',
    ),
    'entity' => array(
      'type' => 'integer',
      'label' => 'Entity',
      'enabled' => 1,
      'visible' => 0,
      'notnull' => 1,
      'default' => 1,
      'index' => 1,
      'position' => 20,
    ),
    'fk_user' => array(
      'type' => 'integer',
      'label' => 'UserOwner',
      'enabled' => 1,
      'visible' => -2,
      'notnull' => 1,
      'position' => 510,
      'foreignkey' => 'llx_user.rowid',
    ),
    'url' => array(
      'type' => 'varchar(255)',
      'label' => 'Url',
      'enabled' => 1,
      'visible' => 1,
      'position' => 30,
      'searchall' => 1,
      'css' => 'minwidth200',
      'help' => 'Hook url',
      'showoncombobox' => 1,
    ),
    'module' => array(
      'type' => 'varchar(128)',
      'label' => 'Module',
      'enabled' => 1,
      'visible' => 1,
      'position' => 30,
      'searchall' => 1,
      'css' => 'minwidth200',
      'help' => 'Hook module',
      'showoncombobox' => 1,
    ),
    'action' => array(
      'type' => 'varchar(128)',
      'label' => 'Action',
      'enabled' => 1,
      'visible' => 1,
      'position' => 30,
      'searchall' => 1,
      'css' => 'minwidth200',
      'help' => 'Hook action trigger',
      'showoncombobox' => 1,
    ),
    'event' => array(
      'type' => 'varchar(255)',
      'label' => 'Event',
      'enabled' => 1,
      'visible' => 1,
      'position' => 30,
      'searchall' => 1,
      'css' => 'minwidth200',
      'help' => 'Event',
      'showoncombobox' => 1,
    ),
    'date_creation' => array(
      'type' => 'datetime',
      'label' => 'DateCreation',
      'enabled' => 1,
      'visible' => -2,
      'notnull' => 1,
      'position' => 500,
    ),
    'import_key' => array(
      'type' => 'varchar(14)',
      'label' => 'ImportId',
      'enabled' => 1,
      'visible' => -2,
      'notnull' => -1,
      'index' => 0,
      'position' => 1000,
    ),
    'status' => array(
      'type' => 'integer',
      'label' => 'Status',
      'enabled' => 1,
      'visible' => 1,
      'notnull' => 1,
      'default' => 0,
      'index' => 1,
      'position' => 1000,
      'arrayofkeyval' => array(
        0 => 'Draft',
        1 => 'Active',
        -1 => 'Canceled',
      ),
    ),
  );

  public $rowid;

  public $ref;

  public $entity;

  public $label;

  public $url;

  public $fk_user;

  public $status;

  public $date_creation;

  public $tms;

  public $fk_user_creat;

  public $fk_user_modif;

  public $import_key;


  public function __construct(DoliDB $db)
  {
    global $conf, $langs, $user;

    $this->db = $db;

    if (empty($conf->global->MAIN_SHOW_TECHNICAL_ID) && isset($this->fields['rowid'])) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (empty($conf->multicompany->enabled) && isset($this->fields['entity'])) {
      $this->fields['entity']['enabled'] = 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
    foreach ($this->fields as $key => $val) {
      if (is_array($this->fields['status']['arrayofkeyval'])) {
        foreach ($this->fields['status']['arrayofkeyval'] as $key2 => $val2) {
          $this->fields['status']['arrayofkeyval'][$key2] = $langs->trans($val2);
        }
      }
    }
  }

  public function create(User $user, $notrigger = false)
  {
    return $this->createCommon($user, $notrigger);
  }

  public function createFromClone(User $user, $fromid)
  {
    global $langs, $hookmanager, $extrafields;
    $error = 0;

    dol_syslog(__METHOD__, LOG_DEBUG);

    $object = new self($this->db);

    $this->db->begin();

    // Load source object
    $object->fetchCommon($fromid);
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
    unset($object->import_key);

    // Clear fields
    $object->ref = "copy_of_".$object->ref;
    $object->title = $langs->trans("CopyOf")." ".$object->title;
    // ...
    // Clear extrafields that are unique
    if (is_array($object->array_options) && count($object->array_options) > 0) {
      $extrafields->fetch_name_optionals_label($this->table_element);
      foreach ($object->array_options as $key => $option) {
        $shortkey = preg_replace('/options_/', '', $key);
        if (!empty($extrafields->attributes[$this->table_element]['unique'][$shortkey])) {
          // var_dump($key);
          // var_dump($clonedObj->array_options[$key]);
          // exit;
          unset($object->array_options[$key]);
        }
      }
    }

    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->error = $object->error;
      $this->errors = $object->errors;
    }

    unset($object->context['createfromclone']);

    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }

  public function fetch($id, $ref = null)
  {
    $result = $this->fetchCommon($id, $ref);
    if ($result > 0 && !empty($this->table_element_line)) {
      //$this->fetchLines();
    }
    return $result;
  }

  /*public function fetchLines()
    {
        $this->lines=array();

        // Load lines with object MyObjectLine

        return count($this->lines)?1:0;
    }*/

  public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
  {
    global $conf;

    dol_syslog(__METHOD__, LOG_DEBUG);

    $records = array();

    $sql = 'SELECT';
    $sql .= ' t.rowid';
    // TODO Get all fields
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE t.entity = '.$conf->entity;
    // Manage filter
    $sqlwhere = array();
    if (count($filter) > 0) {
      foreach ($filter as $key => $value) {
        if ($key == 't.rowid') {
          $sqlwhere[] = $key.'='.$value;
        } elseif (strpos($key, 'date') !== false) {
          $sqlwhere[] = $key.' = \''.$this->db->idate($value).'\'';
        } elseif ($key == 'customsql') {
          $sqlwhere[] = $value;
        } else {
          $sqlwhere[] = $key.' LIKE \'%'.$this->db->escape($value).'%\'';
        }
      }
    }
    if (count($sqlwhere) > 0) {
      $sql .= ' AND ('.implode(' '.$filtermode.' ', $sqlwhere).')';
    }

    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);

      while ($obj = $this->db->fetch_object($resql)) {
        $record = new self($this->db);

        $record->id = $obj->rowid;
        // TODO Get other fields

        //var_dump($record->id);
        $records[$record->id] = $record;
      }
      $this->db->free($resql);

      return $records;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.join(',', $this->errors), LOG_ERR);

      return -1;
    }
  }

  public function update(User $user, $notrigger = false)
  {
    return $this->updateCommon($user, $notrigger);
  }

  public function delete(User $user, $notrigger = false)
  {
    return $this->deleteCommon($user, $notrigger);
    //return $this->deleteCommon($user, $notrigger, 1);
  }

  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $db, $conf, $langs, $hookmanager, $action;
    global $dolibarr_main_authentication, $dolibarr_main_demo;
    global $menumanager;

    if (!empty($conf->dol_no_mouse_hover)) {
      // Force disable tooltips
      $notooltip = 1;
    }

    $result = '';

    $label = '<u>'.$langs->trans("Hook").'</u>';
    $label .= '<br>';
    $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;

    $url = dol_buildpath('/zapier/hook_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 && 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 (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
        $label = $langs->trans("ShowMyObject");
        $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
      }
      $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
      $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';

      /*
             $hookmanager->initHooks(array('hookdao'));
             $parameters=array('id'=>$this->id);
             $reshook=$hookmanager->executeHooks('getnomurltooltip',$parameters,$this,$action);    // Note that $action and $object may have been modified by some hooks
             if ($reshook > 0) $linkclose = $hookmanager->resPrint;
             */
    } else {
      $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
    }

    $linkstart = '<a href="'.$url.'"';
    $linkstart .= $linkclose.'>';
    $linkend = '</a>';

    $result .= $linkstart;
    if ($withpicto) {
      $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 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)) : '');

    $hookmanager->initHooks(array('hookdao'));
    $parameters = array(
      'id' => $this->id,
      'getnomurl' => $result,
    );
    // Note that $action and $object may have been modified by some hooks
    $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action);
    if ($reshook > 0) {
      $result = $hookmanager->resPrint;
    } else {
      $result .= $hookmanager->resPrint;
    }

    return $result;
  }

  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
    global $langs;

    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      global $langs;
      //$langs->load("mymodule");
      $this->labelStatus[self::STATUS_DRAFT] = $langs->trans('Disabled');
      $this->labelStatus[self::STATUS_VALIDATED] = $langs->trans('Enabled');
      $this->labelStatusShort[self::STATUS_DRAFT] = $langs->trans('Disabled');
      $this->labelStatusShort[self::STATUS_VALIDATED] = $langs->trans('Enabled');
    }

    $statusType = 'status5';
    if ($status == self::STATUS_VALIDATED) $statusType = 'status4';

    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
  }

  public function info($id)
  {
    $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
    $sql .= ' fk_user_creat, fk_user_modif';
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE t.rowid = '.$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 ($obj->fk_user_author) {
          $cuser = new User($this->db);
          $cuser->fetch($obj->fk_user_author);
          $this->user_creation = $cuser;
        }

        if ($obj->fk_user_valid) {
          $vuser = new User($this->db);
          $vuser->fetch($obj->fk_user_valid);
          $this->user_validation = $vuser;
        }

        if ($obj->fk_user_cloture) {
          $cluser = new User($this->db);
          $cluser->fetch($obj->fk_user_cloture);
          $this->user_cloture = $cluser;
        }

        $this->date_creation = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->datem);
        $this->date_validation = $this->db->jdate($obj->datev);
      }

      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }

  public function initAsSpecimen()
  {
    $this->initAsSpecimenCommon();
  }


  public function doScheduledJob()
  {
    global $conf, $langs;

    //$conf->global->SYSLOG_FILE = 'DOL_DATA_ROOT/dolibarr_mydedicatedlofile.log';

    $error = 0;
    $this->output = '';
    $this->error = '';

    dol_syslog(__METHOD__, LOG_DEBUG);

    $now = dol_now();

    $this->db->begin();

    // ...

    $this->db->commit();

    return $error;
  }
}

/*
class MyObjectLine
{
    // @var int ID
    public $id;
    // @var mixed Sample line property 1
    public $prop1;
    // @var mixed Sample line property 2
    public $prop2;
}
*/