actions_ai.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2026 Nick Fragoulis
 * Copyright (C) 2026 Braito <braito4@hotmail.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/>.
 */
 
class ActionsAi
{
  public $db;
 
  public $error = '';
 
  public $results = array();
 
  public function __construct($db = null)
  {
    $this->db = $db;
  }
 
  public function addMoreActionsEmailCollector($parameters, &$object, &$action, $hookmanager)
  {
    global $langs;
 
    require_once DOL_DOCUMENT_ROOT.'/ai/class/emailcleaner.class.php';
 
    if (!EmailCleaner::isRuntimeAvailable()) return 0;
    if (!getDolGlobalInt('AI_EMAILCLEANER_EXPOSE_OPERATION', 0)) return 0;
 
    $arrayoftypes = (!empty($parameters['arrayoftypes']) && is_array($parameters['arrayoftypes'])) ? $parameters['arrayoftypes'] : array();
    $langs->load('ai');
    $arrayoftypes['hook_ai_emailcleaner'] = $langs->trans('AIEmailCleanerOperation');
    $this->results = $arrayoftypes;
 
    return 1;
  }
 
  public function doCollectImapOneCollector($parameters, &$object, &$action, $hookmanager)
  {
    require_once DOL_DOCUMENT_ROOT.'/ai/class/emailcleaner.class.php';
 
    if (!EmailCleaner::isRuntimeAvailable()) return 0;
    if (!EmailCleaner::isEmailCollectorHookAction($action)) return 0;
    if (!getDolGlobalInt('AI_EMAILCLEANER_ENABLED', 0)) return 0;
 
    $emailCleaner = new EmailCleaner($this->db);
    $result = $emailCleaner->processEmailCollectorMessage($parameters, $object);
    if (!empty($result['file'])) {
      $this->results['ai_emailcleaner_file'] = (string) $result['file'];
    }
 
    return 0;
  }
 
  public $errors = array();
 
  public $resprints = '';
 
  private $listRowIds = array();
 
  private $listPageSeen = false;
 
  public function printFieldListValue($parameters, &$object, &$action)
  {
    $this->listPageSeen = true;
    if (count($this->listRowIds) < 100 && isset($parameters['obj']) && is_object($parameters['obj'])) {
      // Lists alias the primary key inconsistently in their SELECT:
      // societe uses "rowid", facture uses "f.rowid as id" - accept both.
      $rowid = (int) ($parameters['obj']->rowid ?? $parameters['obj']->id ?? 0);
      if ($rowid > 0) {
        $this->listRowIds[] = $rowid;
      }
    }
 
    return 0;
  }
 
  public function printCommonFooter($parameters, &$object, &$action)
  {
    global $conf, $user;
 
    if (!isModEnabled('ai') || !getDolGlobalString('AI_ASSISTANT_ENABLED')) {
      return 0;
    }
    if (empty($user->id) || !$user->hasRight('ai', 'assistant', 'use')) {
      return 0;
    }
    // printCommonFooter's call site passes a hardcoded null object; the
    // page's main object is only reachable via the global scope here.
    $pageObject = $object;
    if (!is_object($pageObject) || empty($pageObject->id)) {
      $pageObject = isset($GLOBALS['object']) ? $GLOBALS['object'] : null;
    }
    // Card vs list discrimination: the per-row hook fired = list page,
    // whatever the template $object happens to hold; and a card emission
    // additionally requires the URL to actually address the object (card
    // pages always carry id or ref), so a list page whose template object
    // carries a stray id can never masquerade as a card.
    $urlIds = array((int) ($_GET['id'] ?? $_POST['id'] ?? 0), (int) ($_GET['facid'] ?? $_POST['facid'] ?? 0), (int) ($_GET['socid'] ?? $_POST['socid'] ?? 0));
    $urlRef = dol_string_nohtmltag((string) ($_GET['ref'] ?? $_POST['ref'] ?? ''));
    $looksLikeCard = is_object($pageObject) && !empty($pageObject->id)
      && (in_array((int) $pageObject->id, $urlIds, true) || ($urlRef !== '' && $urlRef == ($pageObject->ref ?? '')));
    if ($this->listPageSeen || !empty($this->listRowIds) || !$looksLikeCard || empty($pageObject->element)) {
      // List/dashboard pages: no single object, but the user's own active
      // filters are context enough - emitted uninterpreted, the model
      // maps them onto tool arguments (which validate as always).
      // Dolibarr's list search form submits by POST, so a filter the user
      // just typed never appears in $_GET: read both, GET last so a
      // bookmarked/paginated URL wins over a stale POST body.
      $filters = array();
      foreach (array_merge($_POST, $_GET) as $k => $v) {
        if (!is_string($v) || $v === '' || strlen($v) > 200) {
          continue;
        }
        if (preg_match('/^(search_[a-z0-9_]+|sall|search_all|sortfield|sortorder|contextpage)$/', $k)) {
          $filters[$k] = $v;
        }
      }
      $listElement = (is_object($pageObject) && !empty($pageObject->element)) ? (string) $pageObject->element : '';
 
      // Module dashboards (index pages): no object, no rows - the page
      // identity itself is the context ("what am I looking at?" and
      // module-scoped statistics questions). Whitelisted paths only, so
      // admin or third-party pages never leak their URLs into prompts.
      if (!$this->listPageSeen && empty($filters)) {
        $dashboards = array(
          '/index.php' => 'main home',
          '/societe/index.php' => 'thirdparties',
          '/compta/facture/index.php' => 'customer invoices',
          '/fourn/facture/index.php' => 'supplier invoices',
          '/commande/index.php' => 'sales orders',
          '/fourn/commande/index.php' => 'supplier orders',
          '/comm/propal/index.php' => 'commercial proposals',
          '/supplier_proposal/index.php' => 'supplier proposals',
          '/product/index.php' => 'products and services',
          '/product/stock/index.php' => 'stock and warehouses',
          '/projet/index.php' => 'projects',
          '/contrat/index.php' => 'contracts',
          '/fichinter/index.php' => 'interventions',
          '/ticket/index.php' => 'tickets',
          '/expedition/index.php' => 'shipments',
          '/reception/index.php' => 'receptions',
          '/adherents/index.php' => 'members',
          '/don/index.php' => 'donations',
          '/expensereport/index.php' => 'expense reports',
          '/comm/action/index.php' => 'agenda',
          '/mrp/index.php' => 'manufacturing',
          '/recruitment/index.php' => 'recruitment'
        );
        // Exact match on the path relative to DOL_URL_ROOT - a suffix
        // match on '/index.php' would hit every module index for the
        // home entry.
        $self = (string) ($_SERVER['PHP_SELF'] ?? '');
        $urlRoot = (string) constant('DOL_URL_ROOT');
        $rel = ($urlRoot !== '' && strpos($self, $urlRoot) === 0) ? substr($self, strlen($urlRoot)) : $self;
        if (isset($dashboards[$rel])) {
          print "\n".'<script nonce="'.getNonce().'">window.aiPageContext = '.json_encode(array('dashboard' => $dashboards[$rel])).';</script>'."\n";
 
          return 0;
        }
      }
      if (($this->listPageSeen || !empty($filters) || !empty($this->listRowIds)) && !empty($listElement)) {
        $ctx = array('element' => $listElement, 'list' => 1, 'filters' => $filters);
        if (!empty($this->listRowIds)) {
          $ctx['ids'] = $this->listRowIds;  // rows this page actually shows
        }
        print "\n".'<script nonce="'.getNonce().'">window.aiPageContext = '.json_encode($ctx).';</script>'."\n";
      }
 
      return 0;
    }
 
    $context = array(
      'element' => (string) $pageObject->element,
      'id' => (int) $pageObject->id,
      'ref' => (string) ($pageObject->ref ?? ''),
      'socid' => (int) (get_object_vars($pageObject)['socid'] ?? 0)
    );
 
    // printCommonFooter output convention: print directly (the caller does
    // not echo resPrint for this hook).
    print "\n".'<script nonce="'.getNonce().'">window.aiPageContext = '.json_encode($context).';</script>'."\n";
 
    return 0;
  }
}