api_zapier.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2015       Jean-François Ferry     <jfefe@aternatik.fr>
 * Copyright (C) 2019-2025  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2024-2025  MDW           <mdeweerd@users.noreply.github.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/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/zapier/class/hook.class.php';
 
 
class Zapier extends DolibarrApi
{
  public static $FIELDS = array(
    'url',
  );
 
 
  public $hook;
 
  public function __construct()
  {
    global $db;
 
    $this->db = $db;
    $this->hook = new Hook($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('zapier', 'read')) {
      throw new RestException(403);
    }
 
    $result = $this->hook->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Hook not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('hook', $this->hook->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    return $this->_cleanObjectDatas($this->hook);
  }
 
  public function getModulesChoices()
  {
    if (!DolibarrApiAccess::$user->hasRight('zapier', 'read')) {
      throw new RestException(403);
    }
 
    $arraychoices = array(
      'invoices' => 'Invoices',
      'orders' => 'Orders',
      'thirdparties' => 'ThirdParties',
      'contacts' => 'Contacts',
      'users' => 'Users',
    );
    // $result = $this->hook->fetch($id);
    // if (! $result ) {
    //     throw new RestException(404, 'Hook not found');
    // }
 
    // if (! DolibarrApi::_checkAccessToResource('hook', $this->hook->id)) {
    //     throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    // }
 
    return $arraychoices;
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('zapier', 'read')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    $socid = DolibarrApiAccess::$user->socid ?: 0;
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".MAIN_DB_PREFIX."zapier_hook as t";
    $sql .= " WHERE 1 = 1";
    $tmpobject = new Hook($this->db);
    if ($tmpobject->ismultientitymanaged) {
      $sql .= ' AND t.entity IN ('.getEntity('hook').')';
    }
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    $result = $this->db->query($sql);
    $i = 0;
    if ($result) {
      $i = 0;
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $hook_static = new Hook($this->db);
        if ($hook_static->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($hook_static), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieve hook list');
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('zapier', 'write')) {
      throw new RestException(403);
    }
 
    dol_syslog("API Zapier create hook receive : ".print_r($request_data, true), LOG_DEBUG);
 
    // Check mandatory fields
    $fields = array(
      'url',
    );
    $request_data = $this->validate($request_data, $fields);
 
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $this->hook->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      $this->hook->$field = $this->_checkValForAPI($field, $value, $this->hook);
    }
 
    $this->hook->fk_user = DolibarrApiAccess::$user->id;
    // we create the hook into database
    if (!$this->hook->create(DolibarrApiAccess::$user)) {
      throw new RestException(500, "Error creating Hook", array_merge(array($this->hook->error), $this->hook->errors));
    }
    return array(
      'id' => $this->hook->id,
    );
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('zapier', 'delete')) {
      throw new RestException(403);
    }
 
    $result = $this->hook->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Hook not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('hook', $this->hook->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->hook->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when deleting Hook : '.$this->hook->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Hook deleted'
      )
    );
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  public function _cleanObjectDatas($object)
  {
    // phpcs:disable
    $object = parent::_cleanObjectDatas($object);
 
    return $object;
  }
 
  private function validate($data, $fields)
  {
    $hook = array();
    foreach ($fields as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, $field." field missing");
      }
      $hook[$field] = $data[$field];
    }
    return $hook;
  }
}