api_cronjobs.class.php

<?php
/* Copyright (C) 2026   Frédéric France     <frederic.france@free.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 <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
require_once DOL_DOCUMENT_ROOT.'/cron/class/cronjob.class.php';
 
class Cronjobs extends DolibarrApi
{
  public static $FIELDS = array(
    'jobtype',
    'label',
  );
 
  public $cronjob;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->cronjob = new Cronjob($this->db);
  }
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('cron', 'read')) {
      throw new RestException(403);
    }
 
    $result = $this->cronjob->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Cron job not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('cronjob', $this->cronjob->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    return $this->_cleanObjectDatas($this->cronjob);
  }
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $status = -1, $sqlfilters = '', $properties = '', $pagination_data = false)
  {
    if (!DolibarrApiAccess::$user->hasRight('cron', 'read')) {
      throw new RestException(403);
    }
 
    $obj_ret = array();
 
    if ($page < 0) {
      $page = 0;
    }
    $offset = $limit * $page;
 
    $result = $this->cronjob->fetchAll($sortorder, $sortfield, $limit, $offset, $status, $sqlfilters);
    if ($result < 0) {
      throw new RestException(503, 'Error when retrieving cron job list: '.$this->cronjob->errorsToString());
    }
 
    foreach ($this->cronjob->lines as $cronjob_static) {
      $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($cronjob_static), $properties);
    }
 
    if ($pagination_data) {
      $tmp = $obj_ret;
      $obj_ret = [];
 
      $obj_ret['data'] = $tmp;
      $obj_ret['pagination'] = [
        'total' => count($tmp),
        'page' => $page,
        'page_count' => ceil(count($tmp) / $limit),
        'limit' => $limit
      ];
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('cron', 'write') || !DolibarrApiAccess::$user->admin) {
      throw new RestException(403, "Insufficient rights - creating a cron job requires an admin user");
    }
 
    $result = $this->_validate($request_data);
 
    foreach ($request_data as $field => $value) {
      $this->cronjob->$field = $this->_checkValForAPI($field, $value, $this->cronjob);
    }
 
    if ($this->cronjob->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating cron job", array_merge(array($this->cronjob->error), $this->cronjob->errors));
    }
 
    return $this->cronjob->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('cron', 'write') || !DolibarrApiAccess::$user->admin) {
      throw new RestException(403, "Insufficient rights - updating a cron job requires an admin user");
    }
 
    $result = $this->cronjob->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Cron job not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('cronjob', $this->cronjob->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      $this->cronjob->$field = $this->_checkValForAPI($field, $value, $this->cronjob);
    }
 
    if ($this->cronjob->update(DolibarrApiAccess::$user) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->cronjob->errorsToString());
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('cron', 'delete')) {
      throw new RestException(403);
    }
 
    $result = $this->cronjob->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Cron job not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('cronjob', $this->cronjob->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    if (!$this->cronjob->delete(DolibarrApiAccess::$user)) {
      throw new RestException(500, 'Error when deleting cron job: '.$this->cronjob->errorsToString());
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'Cron job deleted'
      )
    );
  }
 
  public function run($id, $securitykey = '')
  {
    if (!DolibarrApiAccess::$user->hasRight('cron', 'write') || !DolibarrApiAccess::$user->admin) {
      throw new RestException(403, "Insufficient rights - running a cron job requires an admin user");
    }
 
    if (getDolGlobalString('CRON_KEY') && getDolGlobalString('CRON_KEY') != $securitykey) {
      throw new RestException(403, 'Security key is wrong');
    }
 
    $result = $this->cronjob->fetch($id);
    if (!$result) {
      throw new RestException(404, 'Cron job not found');
    }
 
    if (!DolibarrApi::_checkAccessToResource('cronjob', $this->cronjob->id)) {
      throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $now = dol_now();
 
    $result = $this->cronjob->run_jobs(DolibarrApiAccess::$user->login);
    if ($result < 0) {
      throw new RestException(500, 'Error when running cron job: '.$this->cronjob->errorsToString());
    }
 
    $result = $this->cronjob->reprogram_jobs(DolibarrApiAccess::$user->login, $now);
    if ($result <= 0) {
      throw new RestException(500, 'Job ran but failed to reprogram next run: '.$this->cronjob->errorsToString());
    }
 
    return $this->_cleanObjectDatas($this->cronjob);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->md5params);
 
    return $object;
  }
 
  private function _validate($data)
  {
    if ($data === null) {
      $data = array();
    }
    $cronjob = array();
    foreach (Cronjobs::$FIELDS as $field) {
      if (!isset($data[$field])) {
        throw new RestException(400, $field." field missing");
      }
      $cronjob[$field] = $data[$field];
    }
    return $cronjob;
  }
}