cronjob.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2019 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2013      Florian Henry        <florian.henry@open-concept.pro>
 *
 * 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";


class Cronjob extends CommonObject
{
  public $element = 'cronjob';

  public $table_element = 'cronjob';

  public $picto = 'cron';

  public $entity;

  public $jobtype;
  public $tms = '';
  public $datec = '';

  public $label;

  public $command;
  public $classesname;
  public $objectname;
  public $methodename;
  public $params;
  public $md5params;
  public $module_name;
  public $priority;
  public $datelastrun = '';
  public $datenextrun = '';
  public $dateend = '';
  public $datestart = '';
  public $datelastresult = '';
  public $lastresult;
  public $lastoutput;
  public $unitfrequency;
  public $frequency;

  public $status;

  public $processing;

  public $fk_user_author;

  public $fk_user_mod;

  public $nbrun;
  public $libname;
  public $test; // A test condition to know if job is visible/qualified

  const STATUS_DISABLED = 0;
  const STATUS_ENABLED = 1;
  const STATUS_ARCHIVED = 2;


  public function __construct($db)
  {
    $this->db = $db;
  }


  public function create($user, $notrigger = 0)
  {
    global $conf, $langs;
    $error = 0;

    $now = dol_now();

    // Clean parameters

    if (isset($this->label)) $this->label = trim($this->label);
    if (isset($this->jobtype)) $this->jobtype = trim($this->jobtype);
    if (isset($this->command)) $this->command = trim($this->command);
    if (isset($this->classesname)) $this->classesname = trim($this->classesname);
    if (isset($this->objectname)) $this->objectname = trim($this->objectname);
    if (isset($this->methodename)) $this->methodename = trim($this->methodename);
    if (isset($this->params)) $this->params = trim($this->params);
    if (isset($this->md5params)) $this->md5params = trim($this->md5params);
    if (isset($this->module_name)) $this->module_name = trim($this->module_name);
    if (isset($this->priority)) $this->priority = trim($this->priority);
    if (isset($this->lastoutput)) $this->lastoutput = trim($this->lastoutput);
    if (isset($this->lastresult)) $this->lastresult = trim($this->lastresult);
    if (isset($this->unitfrequency)) $this->unitfrequency = trim($this->unitfrequency);
    if (isset($this->frequency)) $this->frequency = trim($this->frequency);
    if (isset($this->status)) $this->status = trim($this->status);
    if (isset($this->note_private)) $this->note_private = trim($this->note_private);
    if (isset($this->nbrun)) $this->nbrun = trim($this->nbrun);
    if (isset($this->libname)) $this->libname = trim($this->libname);
    if (isset($this->test)) $this->test = trim($this->test);

    // Check parameters
    // Put here code to add a control on parameters values
    if (dol_strlen($this->datestart) == 0) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronDtStart'));
      $error++;
    }
    if (empty($this->label)) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronLabel'));
      $error++;
    }
    if ((dol_strlen($this->datestart) != 0) && (dol_strlen($this->dateend) != 0) && ($this->dateend < $this->datestart)) {
      $this->errors[] = $langs->trans('CronErrEndDateStartDt');
      $error++;
    }
    if (empty($this->unitfrequency)) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronFrequency'));
      $error++;
    }
    if (($this->jobtype == 'command') && (empty($this->command))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronCommand'));
      $error++;
    }
    if (($this->jobtype == 'method') && (empty($this->classesname))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronClass'));
      $error++;
    }
    if (($this->jobtype == 'method' || $this->jobtype == 'function') && (empty($this->methodename))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronMethod'));
      $error++;
    }
    if (($this->jobtype == 'method') && (empty($this->objectname))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronObject'));
      $error++;
    }
    if (($this->jobtype == 'function') && (empty($this->libname))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronLib'));
      $error++;
    }

    // Insert request
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."cronjob(";
    $sql .= "entity,";
    $sql .= "datec,";
    $sql .= "jobtype,";
    $sql .= "label,";
    $sql .= "command,";
    $sql .= "classesname,";
    $sql .= "objectname,";
    $sql .= "methodename,";
    $sql .= "params,";
    $sql .= "md5params,";
    $sql .= "module_name,";
    $sql .= "priority,";
    $sql .= "datelastrun,";
    $sql .= "datenextrun,";
    $sql .= "dateend,";
    $sql .= "datestart,";
    $sql .= "lastresult,";
    $sql .= "datelastresult,";
    $sql .= "lastoutput,";
    $sql .= "unitfrequency,";
    $sql .= "frequency,";
    $sql .= "status,";
    $sql .= "fk_user_author,";
    $sql .= "fk_user_mod,";
    $sql .= "note,";
    $sql .= "nbrun,";
    $sql .= "maxrun,";
    $sql .= "libname,";
    $sql .= "test";
    $sql .= ") VALUES (";
    $sql .= " ".(!isset($this->entity) ? $conf->entity : $this->db->escape($this->entity)).",";
    $sql .= " '".$this->db->idate($now)."',";
    $sql .= " ".(!isset($this->jobtype) ? 'NULL' : "'".$this->db->escape($this->jobtype)."'").",";
    $sql .= " ".(!isset($this->label) ? 'NULL' : "'".$this->db->escape($this->label)."'").",";
    $sql .= " ".(!isset($this->command) ? 'NULL' : "'".$this->db->escape($this->command)."'").",";
    $sql .= " ".(!isset($this->classesname) ? 'NULL' : "'".$this->db->escape($this->classesname)."'").",";
    $sql .= " ".(!isset($this->objectname) ? 'NULL' : "'".$this->db->escape($this->objectname)."'").",";
    $sql .= " ".(!isset($this->methodename) ? 'NULL' : "'".$this->db->escape($this->methodename)."'").",";
    $sql .= " ".(!isset($this->params) ? 'NULL' : "'".$this->db->escape($this->params)."'").",";
    $sql .= " ".(!isset($this->md5params) ? 'NULL' : "'".$this->db->escape($this->md5params)."'").",";
    $sql .= " ".(!isset($this->module_name) ? 'NULL' : "'".$this->db->escape($this->module_name)."'").",";
    $sql .= " ".(!isset($this->priority) ? '0' : $this->priority).",";
    $sql .= " ".(!isset($this->datelastrun) || dol_strlen($this->datelastrun) == 0 ? 'NULL' : "'".$this->db->idate($this->datelastrun)."'").",";
    $sql .= " ".(!isset($this->datenextrun) || dol_strlen($this->datenextrun) == 0 ? 'NULL' : "'".$this->db->idate($this->datenextrun)."'").",";
    $sql .= " ".(!isset($this->dateend) || dol_strlen($this->dateend) == 0 ? 'NULL' : "'".$this->db->idate($this->dateend)."'").",";
    $sql .= " ".(!isset($this->datestart) || dol_strlen($this->datestart) == 0 ? 'NULL' : "'".$this->db->idate($this->datestart)."'").",";
    $sql .= " ".(!isset($this->lastresult) ? 'NULL' : "'".$this->db->escape($this->lastresult)."'").",";
    $sql .= " ".(!isset($this->datelastresult) || dol_strlen($this->datelastresult) == 0 ? 'NULL' : "'".$this->db->idate($this->datelastresult)."'").",";
    $sql .= " ".(!isset($this->lastoutput) ? 'NULL' : "'".$this->db->escape($this->lastoutput)."'").",";
    $sql .= " ".(!isset($this->unitfrequency) ? 'NULL' : "'".$this->db->escape($this->unitfrequency)."'").",";
    $sql .= " ".(!isset($this->frequency) ? '0' : $this->frequency).",";
    $sql .= " ".(!isset($this->status) ? '0' : $this->status).",";
    $sql .= " ".$user->id.",";
    $sql .= " ".$user->id.",";
    $sql .= " ".(!isset($this->note_private) ? 'NULL' : "'".$this->db->escape($this->note_private)."'").",";
    $sql .= " ".(!isset($this->nbrun) ? '0' : $this->db->escape($this->nbrun)).",";
    $sql .= " ".(empty($this->maxrun) ? '0' : $this->db->escape($this->maxrun)).",";
    $sql .= " ".(!isset($this->libname) ? 'NULL' : "'".$this->db->escape($this->libname)."'").",";
    $sql .= " ".(!isset($this->test) ? 'NULL' : "'".$this->db->escape($this->test)."'")."";
    $sql .= ")";

    $this->db->begin();

      dol_syslog(get_class($this)."::create", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }

    if (!$error)
    {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."cronjob");
    }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(get_class($this)."::create ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }


  public function fetch($id, $objectname = '', $methodname = '')
  {
    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.entity,";
    $sql .= " t.tms,";
    $sql .= " t.datec,";
    $sql .= " t.jobtype,";
    $sql .= " t.label,";
    $sql .= " t.command,";
    $sql .= " t.classesname,";
    $sql .= " t.objectname,";
    $sql .= " t.methodename,";
    $sql .= " t.params,";
    $sql .= " t.md5params,";
    $sql .= " t.module_name,";
    $sql .= " t.priority,";
    $sql .= " t.datelastrun,";
    $sql .= " t.datenextrun,";
    $sql .= " t.dateend,";
    $sql .= " t.datestart,";
    $sql .= " t.lastresult,";
    $sql .= " t.datelastresult,";
    $sql .= " t.lastoutput,";
    $sql .= " t.unitfrequency,";
    $sql .= " t.frequency,";
    $sql .= " t.status,";
    $sql .= " t.processing,";
    $sql .= " t.fk_user_author,";
    $sql .= " t.fk_user_mod,";
    $sql .= " t.note as note_private,";
    $sql .= " t.nbrun,";
    $sql .= " t.maxrun,";
    $sql .= " t.libname,";
    $sql .= " t.test";
    $sql .= " FROM ".MAIN_DB_PREFIX."cronjob as t";
    if ($id > 0) {
      $sql .= " WHERE t.rowid = ".$id;
    } else {
      $sql .= " WHERE t.entity IN(0, ".getEntity('cron').")";
      $sql .= " AND t.objectname = '".$this->db->escape($objectname)."'";
      $sql .= " AND t.methodename = '".$this->db->escape($methodname)."'";
    }

    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      if ($this->db->num_rows($resql))
      {
        $obj = $this->db->fetch_object($resql);

        $this->id = $obj->rowid;
        $this->ref = $obj->rowid;
        $this->entity = $obj->entity;
        $this->tms = $this->db->jdate($obj->tms);
        $this->datec = $this->db->jdate($obj->datec);
        $this->label = $obj->label;
        $this->jobtype = $obj->jobtype;
        $this->command = $obj->command;
        $this->classesname = $obj->classesname;
        $this->objectname = $obj->objectname;
        $this->methodename = $obj->methodename;
        $this->params = $obj->params;
        $this->md5params = $obj->md5params;
        $this->module_name = $obj->module_name;
        $this->priority = $obj->priority;
        $this->datelastrun = $this->db->jdate($obj->datelastrun);
        $this->datenextrun = $this->db->jdate($obj->datenextrun);
        $this->dateend = $this->db->jdate($obj->dateend);
        $this->datestart = $this->db->jdate($obj->datestart);
        $this->lastresult = $obj->lastresult;
        $this->lastoutput = $obj->lastoutput;
        $this->datelastresult = $this->db->jdate($obj->datelastresult);
        $this->unitfrequency = $obj->unitfrequency;
        $this->frequency = $obj->frequency;
        $this->status = $obj->status;
        $this->processing = $obj->processing;
        $this->fk_user_author = $obj->fk_user_author;
        $this->fk_user_mod = $obj->fk_user_mod;
        $this->note_private = $obj->note_private;
        $this->nbrun = $obj->nbrun;
        $this->maxrun = $obj->maxrun;
        $this->libname = $obj->libname;
        $this->test = $obj->test;
      }
      $this->db->free($resql);

      return 1;
    } else {
        $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_all($sortorder = 'DESC', $sortfield = 't.rowid', $limit = 0, $offset = 0, $status = 1, $filter = '', $processing = -1)
  {
    // phpcs:enable
    global $langs;

    $this->lines = array();

    $sql = "SELECT";
    $sql .= " t.rowid,";
    $sql .= " t.entity,";
    $sql .= " t.tms,";
    $sql .= " t.datec,";
    $sql .= " t.jobtype,";
    $sql .= " t.label,";
    $sql .= " t.command,";
    $sql .= " t.classesname,";
    $sql .= " t.objectname,";
    $sql .= " t.methodename,";
    $sql .= " t.params,";
    $sql .= " t.md5params,";
    $sql .= " t.module_name,";
    $sql .= " t.priority,";
    $sql .= " t.datelastrun,";
    $sql .= " t.datenextrun,";
    $sql .= " t.dateend,";
    $sql .= " t.datestart,";
    $sql .= " t.lastresult,";
    $sql .= " t.datelastresult,";
    $sql .= " t.lastoutput,";
    $sql .= " t.unitfrequency,";
    $sql .= " t.frequency,";
    $sql .= " t.status,";
    $sql .= " t.processing,";
    $sql .= " t.fk_user_author,";
    $sql .= " t.fk_user_mod,";
    $sql .= " t.note as note_private,";
    $sql .= " t.nbrun,";
    $sql .= " t.libname,";
    $sql .= " t.test";
    $sql .= " FROM ".MAIN_DB_PREFIX."cronjob as t";
    $sql .= " WHERE 1 = 1";
    if ($processing >= 0) $sql .= " AND t.processing = ".(empty($processing) ? '0' : '1');
    if ($status >= 0 && $status < 2) $sql .= " AND t.status = ".(empty($status) ? '0' : '1');
    elseif ($status == 2) $sql .= " AND t.status = 2";
    //Manage filter
    if (is_array($filter) && count($filter) > 0) {
      foreach ($filter as $key => $value)
      {
        if ($key == 't.rowid') $sql .= ' AND '.$key.' = '.$this->db->escape($value);
          else $sql .= ' AND '.$key.' LIKE \'%'.$this->db->escape($value).'%\'';
      }
    }

    $sql .= $this->db->order($sortfield, $sortorder);
    if (!empty($limit) && !empty($offset)) {
      $sql .= $this->db->plimit($limit + 1, $offset);
    }

    $sqlwhere = array();

    if (count($sqlwhere) > 0) {
      $sql .= " WHERE ".implode(' AND ', $sqlwhere);
    }

    dol_syslog(get_class($this)."::fetch_all", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      $num = $this->db->num_rows($resql);
      $i = 0;

      if ($num)
      {
        while ($i < $num)
        {
          $line = new Cronjobline();

          $obj = $this->db->fetch_object($resql);

          $line->id = $obj->rowid;
          $line->ref = $obj->rowid;
          $line->entity = $obj->entity;
          $line->tms = $this->db->jdate($obj->tms);
          $line->datec = $this->db->jdate($obj->datec);
          $line->label = $obj->label;
          $line->jobtype = $obj->jobtype;
          $line->command = $obj->command;
          $line->classesname = $obj->classesname;
          $line->objectname = $obj->objectname;
          $line->methodename = $obj->methodename;
          $line->params = $obj->params;
          $line->md5params = $obj->md5params;
          $line->module_name = $obj->module_name;
          $line->priority = $obj->priority;
          $line->datelastrun = $this->db->jdate($obj->datelastrun);
          $line->datenextrun = $this->db->jdate($obj->datenextrun);
          $line->dateend = $this->db->jdate($obj->dateend);
          $line->datestart = $this->db->jdate($obj->datestart);
          $line->lastresult = $obj->lastresult;
          $line->datelastresult = $this->db->jdate($obj->datelastresult);
          $line->lastoutput = $obj->lastoutput;
          $line->unitfrequency = $obj->unitfrequency;
          $line->frequency = $obj->frequency;
          $line->status = $obj->status;
          $line->processing = $obj->processing;
          $line->fk_user_author = $obj->fk_user_author;
          $line->fk_user_mod = $obj->fk_user_mod;
          $line->note_private = $obj->note_private;
          $line->nbrun = $obj->nbrun;
          $line->libname = $obj->libname;
          $line->test = $obj->test;
          $this->lines[] = $line;

          $i++;
        }
      }
      $this->db->free($resql);

      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }


  public function update($user = null, $notrigger = 0)
  {
    global $conf, $langs;

    $langs->load('cron');

    $error = 0;

    // Clean parameters
    if (isset($this->label)) $this->label = trim($this->label);
    if (isset($this->jobtype)) $this->jobtype = trim($this->jobtype);
    if (isset($this->command)) $this->command = trim($this->command);
    if (isset($this->classesname)) $this->classesname = trim($this->classesname);
    if (isset($this->objectname)) $this->objectname = trim($this->objectname);
    if (isset($this->methodename)) $this->methodename = trim($this->methodename);
    if (isset($this->params)) $this->params = trim($this->params);
    if (isset($this->md5params)) $this->md5params = trim($this->md5params);
    if (isset($this->module_name)) $this->module_name = trim($this->module_name);
    if (isset($this->priority)) $this->priority = trim($this->priority);
    if (isset($this->lastoutput)) $this->lastoutput = trim($this->lastoutput);
    if (isset($this->lastresult)) $this->lastresult = trim($this->lastresult);
    if (isset($this->unitfrequency)) $this->unitfrequency = trim($this->unitfrequency);
    if (isset($this->frequency)) $this->frequency = trim($this->frequency);
    if (isset($this->status)) $this->status = trim($this->status);
    if (isset($this->note_private)) $this->note_private = trim($this->note_private);
    if (isset($this->nbrun)) $this->nbrun = trim($this->nbrun);
    if (isset($this->libname)) $this->libname = trim($this->libname);
    if (isset($this->test)) $this->test = trim($this->test);

    if (empty($this->maxrun)) $this->maxrun = 0;
    if (empty($this->processing)) $this->processing = 0;

    // Check parameters
    // Put here code to add a control on parameters values
    if (dol_strlen($this->datestart) == 0) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronDtStart'));
      $error++;
    }
    if ((dol_strlen($this->datestart) != 0) && (dol_strlen($this->dateend) != 0) && ($this->dateend < $this->datestart)) {
      $this->errors[] = $langs->trans('CronErrEndDateStartDt');
      $error++;
    }
    if (empty($this->label)) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronLabel'));
      $error++;
    }
    if (empty($this->unitfrequency)) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronFrequency'));
      $error++;
    }
    if (($this->jobtype == 'command') && (empty($this->command))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronCommand'));
      $error++;
    }
    if (($this->jobtype == 'method') && (empty($this->classesname))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronClass'));
      $error++;
    }
    if (($this->jobtype == 'method' || $this->jobtype == 'function') && (empty($this->methodename))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronMethod'));
      $error++;
    }
    if (($this->jobtype == 'method') && (empty($this->objectname))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronObject'));
      $error++;
    }

    if (($this->jobtype == 'function') && (empty($this->libname))) {
      $this->errors[] = $langs->trans('CronFieldMandatory', $langs->transnoentitiesnoconv('CronLib'));
      $error++;
    }


    // Update request
    $sql = "UPDATE ".MAIN_DB_PREFIX."cronjob SET";
    $sql .= " entity=".(isset($this->entity) ? $this->db->escape($this->entity) : $conf->entity).",";
    $sql .= " label=".(isset($this->label) ? "'".$this->db->escape($this->label)."'" : "null").",";
    $sql .= " jobtype=".(isset($this->jobtype) ? "'".$this->db->escape($this->jobtype)."'" : "null").",";
    $sql .= " command=".(isset($this->command) ? "'".$this->db->escape($this->command)."'" : "null").",";
    $sql .= " classesname=".(isset($this->classesname) ? "'".$this->db->escape($this->classesname)."'" : "null").",";
    $sql .= " objectname=".(isset($this->objectname) ? "'".$this->db->escape($this->objectname)."'" : "null").",";
    $sql .= " methodename=".(isset($this->methodename) ? "'".$this->db->escape($this->methodename)."'" : "null").",";
    $sql .= " params=".(isset($this->params) ? "'".$this->db->escape($this->params)."'" : "null").",";
    $sql .= " md5params=".(isset($this->md5params) ? "'".$this->db->escape($this->md5params)."'" : "null").",";
    $sql .= " module_name=".(isset($this->module_name) ? "'".$this->db->escape($this->module_name)."'" : "null").",";
    $sql .= " priority=".(isset($this->priority) ? $this->priority : "null").",";
    $sql .= " datelastrun=".(dol_strlen($this->datelastrun) != 0 ? "'".$this->db->idate($this->datelastrun)."'" : 'null').",";
    $sql .= " datenextrun=".(dol_strlen($this->datenextrun) != 0 ? "'".$this->db->idate($this->datenextrun)."'" : 'null').",";
    $sql .= " dateend=".(dol_strlen($this->dateend) != 0 ? "'".$this->db->idate($this->dateend)."'" : 'null').",";
    $sql .= " datestart=".(dol_strlen($this->datestart) != 0 ? "'".$this->db->idate($this->datestart)."'" : 'null').",";
    $sql .= " datelastresult=".(dol_strlen($this->datelastresult) != 0 ? "'".$this->db->idate($this->datelastresult)."'" : 'null').",";
    $sql .= " lastresult=".(isset($this->lastresult) ? "'".$this->db->escape($this->lastresult)."'" : "null").",";
    $sql .= " lastoutput=".(isset($this->lastoutput) ? "'".$this->db->escape($this->lastoutput)."'" : "null").",";
    $sql .= " unitfrequency=".(isset($this->unitfrequency) ? $this->unitfrequency : "null").",";
    $sql .= " frequency=".(isset($this->frequency) ? $this->frequency : "null").",";
    $sql .= " status=".(isset($this->status) ? $this->status : "null").",";
    $sql .= " processing=".((isset($this->processing) && $this->processing > 0) ? $this->processing : "0").",";
    $sql .= " fk_user_mod=".$user->id.",";
    $sql .= " note=".(isset($this->note_private) ? "'".$this->db->escape($this->note_private)."'" : "null").",";
    $sql .= " nbrun=".((isset($this->nbrun) && $this->nbrun > 0) ? $this->nbrun : "null").",";
    $sql .= " maxrun=".((isset($this->maxrun) && $this->maxrun > 0) ? $this->maxrun : "0").",";
    $sql .= " libname=".(isset($this->libname) ? "'".$this->db->escape($this->libname)."'" : "null").",";
    $sql .= " test=".(isset($this->test) ? "'".$this->db->escape($this->test)."'" : "null");
    $sql .= " WHERE rowid=".$this->id;

    $this->db->begin();

    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) { $error++; $this->errors[] = "Error ".$this->db->lasterror(); }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }


  public function delete($user, $notrigger = 0)
  {
    $error = 0;

    $this->db->begin();

    $sql = "DELETE FROM ".MAIN_DB_PREFIX."cronjob";
    $sql .= " WHERE rowid=".$this->id;

    dol_syslog(get_class($this)."::delete", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = "Error ".$this->db->lasterror();
    }

    // Commit or rollback
    if ($error)
    {
      foreach ($this->errors as $errmsg)
      {
        dol_syslog(get_class($this)."::delete ".$errmsg, LOG_ERR);
        $this->error .= ($this->error ? ', '.$errmsg : $errmsg);
      }
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return 1;
    }
  }



  public function createFromClone(User $user, $fromid)
  {
    $error = 0;

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

    $this->db->begin();

    // Load source object
    $object->fetch($fromid);
    $object->id = 0;
    $object->statut = 0;

    // Clear fields
    // ...

    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->create($user);

    // Other options
    if ($result < 0)
    {
      $this->error = $object->error;
      $error++;
    }

    //if (! $error)
    //{

    //}

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

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


  public function initAsSpecimen()
  {
    $this->id = 0;
    $this->ref = 0;
    $this->entity = 0;
    $this->tms = '';
    $this->datec = '';
    $this->label = '';
    $this->jobtype = '';
    $this->command = '';
    $this->classesname = '';
    $this->objectname = '';
    $this->methodename = '';
    $this->params = '';
    $this->md5params = '';
    $this->module_name = '';
    $this->priority = '';
    $this->datelastrun = '';
    $this->datenextrun = '';
    $this->dateend = '';
    $this->datestart = '';
    $this->datelastresult = '';
    $this->lastoutput = '';
    $this->lastresult = '';
    $this->unitfrequency = '';
    $this->frequency = '';
    $this->status = 0;
    $this->processing = 0;
    $this->fk_user_author = 0;
    $this->fk_user_mod = 0;
    $this->note_private = '';
    $this->nbrun = '';
    $this->maxrun = 100;
    $this->libname = '';
  }


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

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

    $result = '';

    $label = img_picto('', 'object_'.$this->picto).' <u>'.$langs->trans("CronTask").'</u>';
    if (isset($this->status)) {
      $label .= ' '.$this->getLibStatut(5);
    }
    $label .= '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
    $label .= '<br><b>'.$langs->trans('Title').':</b> '.$this->label;

    $url = DOL_URL_ROOT.'/cron/card.php?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("ShowCronJob");
        $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
      }
      $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
      $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
    } 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)) : '');

    return $result;
  }


  public function info($id)
  {
    $sql = "SELECT";
    $sql .= " f.rowid, f.datec, f.tms, f.fk_user_mod, f.fk_user_author";
    $sql .= " FROM ".MAIN_DB_PREFIX."cronjob as f";
    $sql .= " WHERE f.rowid = ".$id;

    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql)
    {
      if ($this->db->num_rows($resql))
      {
        $obj = $this->db->fetch_object($resql);
        $this->id = $obj->rowid;
        $this->date_creation = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->tms);
        $this->user_modification = $obj->fk_user_mod;
        $this->user_creation = $obj->fk_user_author;
      }
      $this->db->free($resql);

      return 1;
    } else {
      $this->error = "Error ".$this->db->lasterror();
      return -1;
    }
  }


  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function run_jobs($userlogin)
  {
    // phpcs:enable
    global $langs, $conf, $hookmanager;

    $hookmanager->initHooks(array('cron'));

    $now = dol_now();
    $error = 0;
    $retval = '';

    $langs->load('cron');

    if (empty($userlogin))
    {
      $this->error = "User login is mandatory";
      dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
      return -1;
    }

    // Force the environment of running to the environment declared for job, so jobs launched from command line will run into correct environment
    // When job is ran from GUI, the environment should already be same, except if job has entity 0 (visible into all environments)
    if ($conf->entity != $this->entity && $this->entity > 0)
    {
      dol_syslog("We try to run a job in entity ".$this->entity." when we are in entity ".$conf->entity, LOG_WARNING);
    }
    $savcurrententity = $conf->entity;
    $conf->entity = $this->entity;
    dol_syslog(get_class($this)."::run_jobs entity for running job is ".$conf->entity);

    require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
    $user = new User($this->db);
    $result = $user->fetch('', $userlogin);
    if ($result < 0)
    {
      $this->error = "User Error:".$user->error;
      dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
      $conf->entity = $savcurrententity;
      return -1;
    } else {
      if (empty($user->id))
      {
        $this->error = " User user login:".$userlogin." do not exists";
        dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
        $conf->entity = $savcurrententity;
        return -1;
      }
    }

    dol_syslog(get_class($this)."::run_jobs jobtype=".$this->jobtype." userlogin=".$userlogin, LOG_DEBUG);

    // Increase limit of time. Works only if we are not in safe mode
    $ExecTimeLimit = 600;
    if (!empty($ExecTimeLimit))
    {
      $err = error_reporting();
      error_reporting(0); // Disable all errors
      //error_reporting(E_ALL);
      @set_time_limit($ExecTimeLimit); // Need more than 240 on Windows 7/64
      error_reporting($err);
    }
    if (!empty($MemoryLimit))
    {
      @ini_set('memory_limit', $MemoryLimit);
    }

    // Update last run date start (to track running jobs)
    $this->datelastrun = $now;
    $this->datelastresult = null;
    $this->lastoutput = '';
    $this->lastresult = '';
    $this->processing = 1; // To know job was started
    $this->nbrun = $this->nbrun + 1;
    $result = $this->update($user); // This include begin/commit
    if ($result < 0) {
      dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
      $conf->entity = $savcurrententity;
      return -1;
    }

    // Run a method
    if ($this->jobtype == 'method')
    {
      // load classes
      if (!$error)
      {
        $ret = dol_include_once($this->classesname);
        if ($ret === false || (!class_exists($this->objectname)))
        {
          if ($ret === false) $this->error = $langs->trans('CronCannotLoadClass', $this->classesname, $this->objectname);
          else $this->error = $langs->trans('CronCannotLoadObject', $this->classesname, $this->objectname);
          dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
          $this->lastoutput = $this->error;
          $this->lastresult = -1;
          $retval = $this->lastresult;
          $error++;
        }
      }

      // test if method exists
      if (!$error)
      {
        if (!method_exists($this->objectname, $this->methodename))
        {
          $this->error = $langs->trans('CronMethodDoesNotExists', $this->objectname, $this->methodename);
          dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
          $this->lastoutput = $this->error;
          $this->lastresult = -1;
          $retval = $this->lastresult;
          $error++;
        }
        if (in_array(strtolower(trim($this->methodename)), array('executecli')))
        {
          $this->error = $langs->trans('CronMethodNotAllowed', $this->methodename, $this->objectname);
          dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
          $this->lastoutput = $this->error;
          $this->lastresult = -1;
          $retval = $this->lastresult;
          $error++;
        }
      }

      // Load langs
      if (!$error)
      {
        $result = $langs->load($this->module_name);
        $result = $langs->load($this->module_name.'@'.$this->module_name, 0, 0, '', 0, 1);

        if ($result < 0)  // If technical error
        {
          dol_syslog(get_class($this)."::run_jobs Cannot load module lang file - ".$langs->error, LOG_ERR);
          $this->error = $langs->error;
          $this->lastoutput = $this->error;
          $this->lastresult = -1;
          $retval = $this->lastresult;
          $error++;
        }
      }

      if (!$error)
      {
        dol_syslog(get_class($this)."::run_jobs START ".$this->objectname."->".$this->methodename."(".$this->params.");", LOG_DEBUG);

        // Create Object for the called module
        $object = new $this->objectname($this->db);
        if ($this->entity > 0) $object->entity = $this->entity; // We work on a dedicated entity

        $params_arr = array();
        if (!empty($this->params) || $this->params === '0') {
          $params_arr = array_map('trim', explode(",", $this->params));
        }

        if (!is_array($params_arr))
        {
          $result = call_user_func(array($object, $this->methodename), $this->params);
        } else {
          $result = call_user_func_array(array($object, $this->methodename), $params_arr);
        }

        if ($result === false || (!is_bool($result) && $result != 0))
        {
          $langs->load("errors");

          $errmsg = '';
          if (!is_array($object->errors) || !in_array($object->error, $object->errors)) $errmsg .= $object->error;
          if (is_array($object->errors) && count($object->errors)) $errmsg .= (($errmsg ? ', ' : '').join(', ', $object->errors));
          if (empty($errmsg)) $errmsg = $langs->trans('ErrorUnknown');

          dol_syslog(get_class($this)."::run_jobs END result=".$result." error=".$errmsg, LOG_ERR);

          $this->error = $errmsg;
          $this->lastoutput = ($object->output ? $object->output."\n" : "").$errmsg;
          $this->lastresult = is_numeric($result) ? $result : -1;
          $retval = $this->lastresult;
          $error++;
        } else {
          dol_syslog(get_class($this)."::run_jobs END");
          $this->lastoutput = $object->output;
          $this->lastresult = var_export($result, true);
          $retval = $this->lastresult;
        }
      }
    }

    if ($this->jobtype == 'function') {
      //load lib
      $libpath = '/'.strtolower($this->module_name).'/lib/'.$this->libname;
      $ret = dol_include_once($libpath);
      if ($ret === false)
      {
        $this->error = $langs->trans('CronCannotLoadLib').': '.$libpath;
        dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
        $conf->entity = $savcurrententity;
        return -1;
      }

      // Load langs
      $result = $langs->load($this->module_name);
      $result = $langs->load($this->module_name.'@'.$this->module_name); // If this->module_name was an existing language file, this will make nothing
      if ($result < 0)  // If technical error
      {
        dol_syslog(get_class($this)."::run_jobs Cannot load module langs".$langs->error, LOG_ERR);
        $conf->entity = $savcurrententity;
        return -1;
      }

      dol_syslog(get_class($this)."::run_jobs ".$this->libname."::".$this->methodename."(".$this->params.");", LOG_DEBUG);
      $params_arr = explode(", ", $this->params);
      if (!is_array($params_arr))
      {
        $result = call_user_func($this->methodename, $this->params);
      } else {
        $result = call_user_func_array($this->methodename, $params_arr);
      }

      if ($result === false || (!is_bool($result) && $result != 0))
      {
        $langs->load("errors");
        dol_syslog(get_class($this)."::run_jobs result=".$result, LOG_ERR);
        $this->error = $langs->trans('ErrorUnknown');
        $this->lastoutput = $this->error;
        $this->lastresult = is_numeric($result) ? $result : -1;
        $retval = $this->lastresult;
        $error++;
      } else {
        $this->lastoutput = var_export($result, true);
        $this->lastresult = var_export($result, true); // Return code
        $retval = $this->lastresult;
      }
    }

    // Run a command line
    if ($this->jobtype == 'command')
    {
      global $dolibarr_cron_allow_cli;

      if (empty($dolibarr_cron_allow_cli)) {
        $langs->load("errors");
        $this->error      = $langs->trans("FailedToExecutCommandJob");
        $this->lastoutput = '';
        $this->lastresult = $langs->trans("ErrorParameterMustBeEnabledToAllwoThisFeature", 'dolibarr_cron_allow_cli');
      } else {
        $outputdir = $conf->cron->dir_temp;
        if (empty($outputdir)) $outputdir = $conf->cronjob->dir_temp;

        if (!empty($outputdir))
        {
          dol_mkdir($outputdir);
          $outputfile = $outputdir.'/cronjob.'.$userlogin.'.out'; // File used with popen method

          // Execute a CLI
          include_once DOL_DOCUMENT_ROOT.'/core/class/utils.class.php';
          $utils = new Utils($this->db);
          $arrayresult = $utils->executeCLI($this->command, $outputfile);

          $retval = $arrayresult['result'];
          $this->error      = $arrayresult['error'];
          $this->lastoutput = $arrayresult['output'];
          $this->lastresult = $arrayresult['result'];
        }
      }
    }

    dol_syslog(get_class($this)."::run_jobs now we update job to track it is finished (with success or error)");

    $this->datelastresult = dol_now();
    $this->processing = 0;
    $result = $this->update($user); // This include begin/commit
    if ($result < 0)
    {
      dol_syslog(get_class($this)."::run_jobs ".$this->error, LOG_ERR);
      $conf->entity = $savcurrententity;
      return -1;
    }

    $conf->entity = $savcurrententity;
    return $error ?-1 : 1;
  }


  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function reprogram_jobs($userlogin, $now)
  {
    // phpcs:enable
    dol_syslog(get_class($this)."::reprogram_jobs userlogin:$userlogin", LOG_DEBUG);

    require_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
    $user = new User($this->db);
    $result = $user->fetch('', $userlogin);
    if ($result < 0)
    {
      $this->error = "User Error : ".$user->error;
      dol_syslog(get_class($this)."::reprogram_jobs ".$this->error, LOG_ERR);
      return -1;
    } else {
      if (empty($user->id))
      {
        $this->error = " User user login:".$userlogin." do not exists";
        dol_syslog(get_class($this)."::reprogram_jobs ".$this->error, LOG_ERR);
        return -1;
      }
    }

    dol_syslog(get_class($this)."::reprogram_jobs datenextrun=".$this->datenextrun." ".dol_print_date($this->datenextrun, 'dayhourrfc')." frequency=".$this->frequency." unitfrequency=".$this->unitfrequency, LOG_DEBUG);

    if (empty($this->datenextrun))
    {
      if (empty($this->datestart)) $this->datenextrun = $now + ($this->frequency * $this->unitfrequency);
      else $this->datenextrun = $this->datestart + ($this->frequency * $this->unitfrequency);
    }

    if ($this->datenextrun < $now && $this->frequency > 0 && $this->unitfrequency > 0)
    {
      // Loop until date is after future
      while ($this->datenextrun < $now)
      {
        $this->datenextrun += ($this->frequency * $this->unitfrequency);

        // TODO For exact frequency (every month, every year, ...), use instead a dol_time_plus_duree($time, $duration_value, $duration_unit)
      }
    } else {
      //$this->datenextrun=$this->datenextrun + ($this->frequency * $this->unitfrequency);
      dol_syslog(get_class($this)."::reprogram_jobs datenextrun is already in future, we do not change it");
    }


    // Archive job
    if ($this->autodelete == 2)
    {
      if (($this->maxrun > 0 && ($this->nbrun >= $this->maxrun))
        || ($this->dateend && ($this->datenextrun > $this->dateend)))
      {
        $this->status = self::STATUS_ARCHIVED;
        dol_syslog(get_class($this)."::reprogram_jobs Job will be set to archived", LOG_ERR);
      }
    }

    $result = $this->update($user);
    if ($result < 0)
    {
      dol_syslog(get_class($this)."::reprogram_jobs ".$this->error, LOG_ERR);
      return -1;
    }

    return 1;
  }

  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode, $this->processing, $this->lastresult);
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0, $processing = 0, $lastresult = 0)
  {
    // phpcs:enable
    $this->labelStatus = array(); // Force reset o array because label depends on other fields
    $this->labelStatusShort = array();

    if (empty($this->labelStatus) || empty($this->labelStatusShort))
    {
      global $langs;
      $langs->load('users');

      $moretext = '';
      if ($processing) $moretext = ' ('.$langs->trans("Running").')';
      elseif ($lastresult) $moretext .= ' ('.$langs->trans("Error").')';

      $this->labelStatus[self::STATUS_DISABLED] = $langs->trans('Disabled').$moretext;
      $this->labelStatus[self::STATUS_ENABLED] = $langs->trans('Scheduled').$moretext;
      $this->labelStatusShort[self::STATUS_DISABLED] = $langs->trans('Disabled');
      $this->labelStatusShort[self::STATUS_ENABLED] = $langs->trans('Scheduled');
    }

    $statusType = 'status4';
    if ($status == 1 && $processing) $statusType = 'status1';
    if ($status == 0) $statusType = 'status5';
    if ($this->lastresult) $statusType = 'status8';

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


class Cronjobline
{

  public $id;

  public $ref;

  public $tms = '';
  public $datec = '';

  public $label;

  public $jobtype;
  public $command;
  public $classesname;
  public $objectname;
  public $methodename;
  public $params;
  public $md5params;
  public $module_name;
  public $priority;
  public $datelastrun = '';
  public $datenextrun = '';
  public $dateend = '';
  public $datestart = '';
  public $lastresult = '';
  public $lastoutput;
  public $unitfrequency;
  public $frequency;

  public $status;

  public $fk_user_author;

  public $fk_user_mod;

  public $note;
  public $nbrun;
  public $libname;

  public function __construct()
  {
    return 1;
  }
}