writeconfirmation.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2026 Nick Fragoulis
 *
 * 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/>.
 */
 
class AiWriteConfirmation
{
  const DEFAULT_TTL_MINUTES = 10;
 
  private $db;
 
  public $error = '';
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
  public function issue($user, $toolName, array $args, $preview)
  {
    global $conf;
 
    $secret = $this->signingSecret();
    if ($secret === '') {
      $this->error = 'No instance secret available to sign the confirmation';
 
      return '';
    }
 
    $state = dol_hash($secret.'|'.$toolName.'|'.$user->id.'|'.dol_now().'|'.microtime(true).'|'.mt_rand(), 'sha256');
    $ttl = getDolGlobalInt('AI_WRITE_CONFIRMATION_TTL_MINUTES', self::DEFAULT_TTL_MINUTES);
    if ($ttl <= 0) {
      $ttl = self::DEFAULT_TTL_MINUTES;
    }
 
    $sql = "INSERT INTO ".MAIN_DB_PREFIX."ai_write_confirmation";
    $sql .= " (entity, state_hash, fk_user, tool_name, args_hash, preview, date_creation, date_expiration, ip)";
    $sql .= " VALUES (".((int) $conf->entity);
    $sql .= ", '".$this->db->escape($this->stateHash($state, $secret))."'";
    $sql .= ", ".((int) $user->id);
    $sql .= ", '".$this->db->escape($toolName)."'";
    $sql .= ", '".$this->db->escape($this->argsHash($args))."'";
    $sql .= ", '".$this->db->escape(dol_trunc((string) $preview, 60000, 'right', 'UTF-8', 1))."'";
    $sql .= ", '".$this->db->idate(dol_now())."'";
    $sql .= ", '".$this->db->idate(dol_now() + ($ttl * 60))."'";
    $sql .= ", '".$this->db->escape(getUserRemoteIP())."'";
    $sql .= ")";
 
    if (!$this->db->query($sql)) {
      $this->error = 'Cannot store the pending confirmation';
      dol_syslog('[AiWriteConfirmation] '.$this->error.': '.$this->db->lasterror(), LOG_ERR);
 
      return '';
    }
 
    // Keep the table bounded without depending on a scheduled job being
    // enabled: one call in a hundred clears rows older than the retention.
    if (mt_rand(1, 100) === 1) {
      $this->purge(getDolGlobalInt('AI_WRITE_CONFIRMATION_KEEP_DAYS', 30));
    }
 
    return $state;
  }
 
  public function consume($user, $toolName, array $args, $state)
  {
    global $conf;
 
    $this->error = '';
    $secret = $this->signingSecret();
    if ($secret === '' || !is_string($state) || $state === '') {
      $this->error = 'Invalid confirmation';
 
      return false;
    }
 
    $sql = "SELECT rowid, fk_user, tool_name, args_hash, date_expiration, date_consumed";
    $sql .= " FROM ".MAIN_DB_PREFIX."ai_write_confirmation";
    $sql .= " WHERE state_hash = '".$this->db->escape($this->stateHash($state, $secret))."'";
    $sql .= " AND entity = ".((int) $conf->entity);
 
    $resql = $this->db->query($sql);
    if (!$resql || !($obj = $this->db->fetch_object($resql))) {
      $this->error = 'Unknown or forged confirmation';
      dol_syslog('[AiWriteConfirmation] rejected: no state matches', LOG_NOTICE);
 
      return false;
    }
 
    if ((int) $obj->fk_user !== (int) $user->id) {
      $this->error = 'This confirmation was issued to another user';
    } elseif ((string) $obj->tool_name !== (string) $toolName) {
      $this->error = 'This confirmation was issued for another action';
    } elseif ((string) $obj->args_hash !== $this->argsHash($args)) {
      $this->error = 'The action changed since it was confirmed';
    } elseif (!empty($obj->date_consumed)) {
      $this->error = 'This confirmation was already used';
    } elseif ($this->db->jdate($obj->date_expiration) < dol_now()) {
      $this->error = 'This confirmation expired, ask again';
    }
 
    if ($this->error !== '') {
      dol_syslog('[AiWriteConfirmation] rejected for '.$toolName.': '.$this->error, LOG_NOTICE);
 
      return false;
    }
 
    // Mark consumed before the write runs: a crash mid-write must not leave a
    // state that can be replayed.
    $sql = "UPDATE ".MAIN_DB_PREFIX."ai_write_confirmation";
    $sql .= " SET date_consumed = '".$this->db->idate(dol_now())."'";
    $sql .= " WHERE rowid = ".((int) $obj->rowid)." AND date_consumed IS NULL";
 
    $resupdate = $this->db->query($sql);
    // The WHERE includes date_consumed IS NULL, so two concurrent confirmations
    // of the same state cannot both update the row: the loser gets 0 rows.
    if (!$resupdate || $this->db->affected_rows($resupdate) === 0) {
      $this->error = 'This confirmation was already used';
      dol_syslog('[AiWriteConfirmation] rejected for '.$toolName.': concurrent use', LOG_NOTICE);
 
      return false;
    }
 
    return true;
  }
 
  public function purge($keepdays = 30)
  {
    $sql = "DELETE FROM ".MAIN_DB_PREFIX."ai_write_confirmation";
    $sql .= " WHERE date_expiration < '".$this->db->idate(dol_now() - ((int) $keepdays * 86400))."'";
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      return -1;
    }
 
    return (int) $this->db->affected_rows($resql);
  }
 
  private function signingSecret()
  {
    global $dolibarr_main_instance_unique_id, $dolibarr_main_cookie_cryptkey;
 
    $instanceid = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id;
    if (empty($instanceid)) {
      return '';
    }
 
    return dol_hash('ai-write-confirmation'.$instanceid, 'sha256');
  }
 
  private function stateHash($state, $secret)
  {
    return dol_hash($secret.'|'.$state, 'sha256');
  }
 
  private function argsHash(array $args)
  {
    $normalized = $args;
    unset($normalized['requestState']);
    $this->ksortRecursive($normalized);
 
    return dol_hash((string) json_encode($normalized), 'sha256');
  }
 
  private function ksortRecursive(array &$arr)
  {
    ksort($arr);
    foreach ($arr as &$value) {
      if (is_array($value)) {
        $this->ksortRecursive($value);
      }
    }
  }
}