ecmfiles.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2012  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2014-2016  Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2015       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2015       Raphaël Doursenaud  <rdoursenaud@gpcsolutions.fr>
 * Copyright (C) 2018       Francis Appels      <francis.appels@yahoo.com>
 * Copyright (C) 2019-2024  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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobjectline.class.php';
 
class EcmFiles extends CommonObject
{
  public $element = 'ecmfiles';
 
  public $table_element = 'ecm_files';
 
  public $picto = 'folder-open';
 
  public $ref;
 
  public $label;
 
  public $share;
 
  public $entity;
 
  public $filename;
 
  public $filepath;
 
  public $fullpath_orig;
 
  public $description;
 
  public $keywords;
 
  public $content;
 
  public $cover;
 
  public $position;
 
  public $gen_or_uploaded;
 
  public $extraparams;
 
  public $date_c = '';
 
  public $date_m = '';
 
  public $fk_user_c;
 
  public $fk_user_m;
 
  public $acl;
 
  public $src_object_type;
 
  public $src_object_id;
 
  public $agenda_id;
 
  public $section_id;
 
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'position' => 1, 'notnull' => 1, 'visible' => 0, 'noteditable' => 1, 'index' => 1, 'css' => 'left', 'comment' => "Id"),
    'ref' => array('type' => 'varchar(128)', 'label' => 'Ref', 'enabled' => 1, 'position' => 20, 'notnull' => 1, 'visible' => -1, 'index' => 1, 'searchall' => 1, 'showoncombobox' => 1, 'validate' => 1, 'comment' => "contains hash from filename+filepath"),
    'label' => array('type' => 'varchar(128)', 'label' => 'Label', 'enabled' => 1, 'position' => 30, 'notnull' => 0, 'visible' => -1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1, 'comment' => "contains hash of file content"),
    'share' => array('type' => 'varchar(128)', 'label' => 'Share', 'enabled' => 1, 'position' => 40, 'notnull' => 0, 'visible' => -1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1, 'comment' => "contains hash for file sharing"),
    'entity' => array('type' => 'integer', 'label' => 'Entity', 'default' => '1', 'enabled' => 1, 'visible' => -2, 'notnull' => -1, 'position' => 50, 'index' => 1),
    'filepath' => array('type' => 'varchar(255)', 'label' => 'FilePath', 'enabled' => 1, 'position' => 60, 'notnull' => 0, 'visible' => 0, 'searchall' => 0, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1,'comment' => "relative to dolibarr document dir. Example module/def"),
    'filename' => array('type' => 'varchar(255)', 'label' => 'FileName', 'enabled' => 1, 'position' => 70, 'notnull' => 0, 'visible' => 1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1,'comment' => "file name only without any directory"),
    'src_object_type' => array('type' => 'varchar(64)', 'label' => 'SourceType', 'enabled' => 1, 'position' => 80, 'notnull' => 0, 'visible' => 0, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1,'comment' => "Source object type ('proposal', 'invoice', ...)"),
    'src_object_id' => array('type' => 'integer', 'label' => 'SourceID', 'default' => '1', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 90, 'index' => 1, 'comment' => "Source object id"),
    'fullpath_orig' => array('type' => 'varchar(750)', 'label' => 'FullPathOrig', 'enabled' => 1, 'position' => 100, 'notnull' => 0, 'visible' => 0, 'searchall' => 0, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1,'comment' => "full path of original filename, when file is uploaded from a local computer"),
    'description' => array('type' => 'text', 'label' => 'Description', 'enabled' => 1, 'visible' => 0, 'position' => 110),
    'keywords' => array('type' => 'varchar(750)', 'label' => 'Keywords', 'enabled' => 1, 'position' => 120, 'notnull' => 0, 'visible' => 1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1,'comment' => "list of keywords, separated with comma. Must be limited to most important keywords."),
    'content' => array('type' => 'html', 'label' => 'Content', 'enabled' => 'getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")', 'position' => 120, 'notnull' => 0, 'visible' => 1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'csslist' => 'tdoverflowmax200', 'help' => "Text content of file", 'showoncombobox' => 2, 'validate' => 1,'comment' => "Text content if option to store txt content was set."),
    'cover' => array('type' => 'text', 'label' => 'Cover', 'enabled' => 1, 'visible' => 0, 'position' => 130, 'comment' => "is this file a file to use for a cover"),
    'position' => array('type' => 'integer', 'label' => 'Position', 'default' => '1', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 140, 'index' => 1, 'comment' => "position of file among others"),
    'gen_or_uploaded' => array('type' => 'varchar(12)', 'label' => 'GenOrUpload', 'enabled' => 1, 'position' => 150, 'notnull' => 0, 'visible' => -1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1,'comment' => "'generated' or 'uploaded'"),
    'extraparams' => array('type' => 'varchar(255)', 'label' => 'ExtraParams', 'enabled' => 1, 'position' => 160, 'notnull' => 0, 'visible' => 1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'showoncombobox' => 2, 'validate' => 1, 'comment' => "for stocking other parameters with json format"),
    'date_c' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -1, 'position' => 170),
    'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 175),
    'fk_user_c' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'position' => 510, 'notnull' => 1, 'visible' => -2, 'foreignkey' => 'user.rowid',),
    'fk_user_m' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserModif', 'enabled' => 1, 'position' => 511, 'notnull' => -1, 'visible' => -2,),
    'note_public' => array('type' => 'text', 'label' => 'NotePublic', 'enabled' => 1, 'visible' => 0, 'position' => 155),
    'note_private' => array('type' => 'text', 'label' => 'NotePrivate', 'enabled' => 1, 'visible' => 0, 'position' => 160),
    'acl' => array('type' => 'text', 'label' => 'NotePrivate', 'enabled' => 1, 'visible' => 0, 'position' => 160, 'comment' => "for future permission 'per file'"),
    'agenda_id' => array('type' => 'integer', 'label' => 'IdAgenda', 'enabled' => 1, 'visible' => 0, 'position' => 180, 'comment' => "Link to an actioncomm"),
  );
 
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
  }
 
  public function create(User $user, $notrigger = 0)
  {
    global $conf;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $error = 0;
 
    // Clean parameters
    if (isset($this->ref)) {
      $this->ref = trim($this->ref);
    }
    if (isset($this->label)) {
      $this->label = trim($this->label);
    }
    if (isset($this->share)) {
      $this->share = trim($this->share);
    }
    if (isset($this->entity)) {
      $this->entity = (int) $this->entity;
    }
    if (isset($this->filename)) {
      $this->filename = preg_replace('/\.noexe$/', '', trim($this->filename));
    }
    if (isset($this->filepath)) {
      $this->filepath = trim($this->filepath);
      $this->filepath = preg_replace('/[\\/]+$/', '', $this->filepath); // Remove last /
    }
    if (isset($this->fullpath_orig)) {
      $this->fullpath_orig = trim($this->fullpath_orig);
    }
    if (isset($this->description)) {
      $this->description = trim($this->description);
    }
    if (isset($this->keywords)) {
      $this->keywords = trim($this->keywords);
    }
    if (isset($this->cover)) {
      $this->cover = trim($this->cover);
    }
    if (isset($this->gen_or_uploaded)) {
      $this->gen_or_uploaded = trim($this->gen_or_uploaded);
    }
    if (isset($this->fk_user_c)) {
      $this->fk_user_c = (int) $this->fk_user_c;
    }
    if (isset($this->fk_user_m)) {
      $this->fk_user_m = (int) $this->fk_user_m;
    }
    if (isset($this->acl)) {
      $this->acl = trim($this->acl);
    }
    if (isset($this->src_object_type)) {
      $this->src_object_type = trim($this->src_object_type);
    }
    if (empty($this->date_c)) {
      $this->date_c = dol_now();
    }
    if (empty($this->date_m)) {
      $this->date_m = dol_now();
    }
 
    // If ref not defined
    if (empty($this->ref)) {
      include_once DOL_DOCUMENT_ROOT.'/core/lib/security.lib.php';
      $this->ref = dol_hash($this->filepath.'/'.$this->filename, '3');
    }
 
    $maxposition = 0;
    if (empty($this->position)) {
      // Get max used
      $sql = "SELECT MAX(position) as maxposition FROM ".MAIN_DB_PREFIX.$this->table_element;
      $sql .= " WHERE filepath ='".$this->db->escape($this->filepath)."'";
 
      $resql = $this->db->query($sql);
      if ($resql) {
        $obj = $this->db->fetch_object($resql);
        $maxposition = (int) $obj->maxposition;
      } else {
        $this->errors[] = 'Error '.$this->db->lasterror();
        return --$error;
      }
      $maxposition += 1;
    } else {
      $maxposition = $this->position;
    }
 
    // Check parameters
    if (empty($this->filename) || empty($this->filepath)) {
      $this->errors[] = 'Bad property filename or filepath';
      return --$error;
    }
    if (!isset($this->entity)) {
      $this->entity = $conf->entity;
    }
 
    $extraparams = (!empty($this->extraparams) ? json_encode($this->extraparams) : null);
    $extraparams = dol_trunc($extraparams, 250);
 
    // Put here code to add control on parameters values
    if (!empty($this->agenda_id)) {
      $this->agenda_id = (int) $this->agenda_id;
    }
 
    // Insert request
    $sql = 'INSERT INTO '.MAIN_DB_PREFIX.$this->table_element.'(';
    $sql .= 'ref,';
    $sql .= 'label,';
    $sql .= 'share,';
    $sql .= 'entity,';
    $sql .= 'filename,';
    $sql .= 'filepath,';
    $sql .= 'fullpath_orig,';
    $sql .= 'description,';
    $sql .= 'keywords,';
    if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
      $sql .= 'content,';
    }
    $sql .= 'cover,';
    $sql .= 'position,';
    $sql .= 'gen_or_uploaded,';
    $sql .= 'extraparams,';
    $sql .= 'date_c,';
    $sql .= 'tms,';
    $sql .= 'fk_user_c,';
    $sql .= 'fk_user_m,';
    $sql .= 'acl,';
    $sql .= 'src_object_type,';
    $sql .= 'src_object_id,';
    $sql .= 'agenda_id';
    $sql .= ') VALUES (';
    $sql .= " '".$this->db->escape($this->ref)."', ";
    $sql .= ' '.(!isset($this->label) ? 'NULL' : "'".$this->db->escape($this->label)."'").',';
    $sql .= ' '.(!isset($this->share) ? 'NULL' : "'".$this->db->escape($this->share)."'").',';
    $sql .= ' '.((int) $this->entity).',';
    $sql .= ' '.(!isset($this->filename) ? 'NULL' : "'".$this->db->escape($this->filename)."'").',';
    $sql .= ' '.(!isset($this->filepath) ? 'NULL' : "'".$this->db->escape($this->filepath)."'").',';
    $sql .= ' '.(!isset($this->fullpath_orig) ? 'NULL' : "'".$this->db->escape($this->fullpath_orig)."'").',';
    $sql .= ' '.(!isset($this->description) ? 'NULL' : "'".$this->db->escape($this->description)."'").',';
    $sql .= ' '.(!isset($this->keywords) ? 'NULL' : "'".$this->db->escape($this->keywords)."'").',';
    if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
      $sql .= ' '.(!isset($this->content) ? 'NULL' : "'".$this->db->escape($this->content)."'").',';
    }
    $sql .= ' '.(!isset($this->cover) ? 'NULL' : "'".$this->db->escape($this->cover)."'").',';
    $sql .= ' '.((int) $maxposition).',';
    $sql .= ' '.(!isset($this->gen_or_uploaded) ? 'NULL' : "'".$this->db->escape($this->gen_or_uploaded)."'").',';
    $sql .= ' '.(!isset($extraparams) ? 'NULL' : "'".$this->db->escape($extraparams)."'").',';
    $sql .= " '".$this->db->idate($this->date_c)."',";
    $sql .= ' '.(!isset($this->date_m) || dol_strlen((string) $this->date_m) == 0 ? 'NULL' : "'".$this->db->idate($this->date_m)."'").',';
    $sql .= ' '.(!isset($this->fk_user_c) ? $user->id : $this->fk_user_c).',';
    $sql .= ' '.(!isset($this->fk_user_m) ? 'NULL' : $this->fk_user_m).',';
    $sql .= ' '.(!isset($this->acl) ? 'NULL' : "'".$this->db->escape($this->acl)."'").',';
    $sql .= ' '.(!isset($this->src_object_type) ? 'NULL' : "'".$this->db->escape($this->src_object_type)."'").',';
    $sql .= ' '.(!isset($this->src_object_id) ? 'NULL' : $this->src_object_id).',';
    $sql .= ' '.(empty($this->agenda_id) ? 'NULL' : (int) $this->agenda_id);
    $sql .= ')';
 
    $this->db->begin();
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      if ($this->db->lasterrno() == 'DB_ERROR_RECORD_ALREADY_EXISTS') {
        $this->errors[] = 'Error DB_ERROR_RECORD_ALREADY_EXISTS : '.$this->db->lasterror();
      } else {
        $this->errors[] = 'Error '.$this->db->lasterror();
      }
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
    }
 
    if (!$error) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.$this->table_element);
      $this->position = $maxposition;
 
      // Triggers
      if (!$notrigger) {
        // Call triggers
        $result = $this->call_trigger(strtoupper(get_class($this)).'_CREATE', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
 
      return -1 * $error;
    } else {
      $this->db->commit();
 
      return $this->id;
    }
  }
 
  public function fetch($id, $ref = '', $relativepath = '', $hashoffile = '', $hashforshare = '', $src_object_type = '', $src_object_id = 0, $entity = 0)
  {
    global $conf;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $sql = 'SELECT';
    $sql .= ' t.rowid,';
    $sql .= " t.ref,";
    $sql .= " t.label,";
    $sql .= " t.share,";
    $sql .= " t.entity,";
    $sql .= " t.filename,";
    $sql .= " t.filepath,";
    $sql .= " t.fullpath_orig,";
    $sql .= " t.description,";
    $sql .= " t.keywords,";
    if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
      $sql .= " t.content,";
    }
    $sql .= " t.cover,";
    $sql .= " t.position,";
    $sql .= " t.gen_or_uploaded,";
    $sql .= " t.extraparams,";
    $sql .= " t.date_c,";
    $sql .= " t.tms as date_m,";
    $sql .= " t.fk_user_c,";
    $sql .= " t.fk_user_m,";
    $sql .= ' t.note_private,';
    $sql .= ' t.note_public,';
    $sql .= " t.acl,";
    $sql .= " t.src_object_type,";
    $sql .= " t.src_object_id,";
    $sql .= " t.agenda_id";
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE 1 = 1';
    /* Fetching this table depends on filepath+filename, it must not depends on entity because filesystem on disk does not know what is Dolibarr entities
     if (isModEnabled('multicompany')) {
     $sql .= " AND entity IN (" . getEntity('ecmfiles') . ")";
     }*/
    $filterfound = 0;
    if ($relativepath) {
      $relativepathwithnoexe = preg_replace('/\.noexe$/', '', $relativepath); // We must never have the .noexe into the database
      $sql .= " AND t.filepath = '".$this->db->escape(dirname($relativepath))."'";
      $filename = basename($relativepathwithnoexe);
      if ($filename != '*') {
        $sql .= " AND t.filename = '".$this->db->escape($filename)."'";
      }
      if (! empty($entity)) {
        $sql .= " AND t.entity = " . (int) $entity;
      } else {
        $sql .= " AND t.entity = " . $conf->entity; // unique key include the entity so each company has its own index
      }
      $filterfound++;
    }
    if (!empty($ref)) {   // hash of file path
      $sql .= " AND t.ref = '".$this->db->escape($ref)."'";
      if (! empty($entity)) {
        $sql .= " AND t.entity = " . (int) $entity;
      } else {
        $sql .= " AND t.entity = " . $conf->entity; // unique key include the entity so each company has its own index
      }
      $filterfound++;
    }
    if (!empty($hashoffile)) {  // hash of content
      $sql .= " AND t.label = '".$this->db->escape($hashoffile)."'";
      if (! empty($entity)) {
        $sql .= " AND t.entity = " . (int) $entity;
      } else {
        $sql .= " AND t.entity = " . $conf->entity; // unique key include the entity so each company has its own index
      }
      $filterfound++;
    }
    if (!empty($hashforshare)) {
      if ($hashforshare != 'shared') {
        $sql .= " AND t.share = '".$this->db->escape($hashforshare)."'";
      } else {
        $sql .= " AND t.share IS NOT NULL AND t.share <> ''";
      }
      //$sql .= " AND t.entity = ".$conf->entity;             // hashforshare already unique
      $filterfound++;
    }
    if ($src_object_type && $src_object_id) {
      $sql .= " AND t.src_object_type = '".$this->db->escape($src_object_type)."' AND t.src_object_id = ".((int) $src_object_id);
      if (! empty($entity)) {
        $sql .= " AND t.entity = " . (int) $entity;
      } else {
        $sql .= " AND t.entity = " . $conf->entity; // unique key include the entity so each company has its own index
      }
      $filterfound++;
    }
    if ($id > 0 || empty($filterfound)) {
      $sql .= ' AND t.rowid = '.((int) $id); // rowid already unique
    }
 
    // Warning: May return several record, and only first one is returned !
    $this->db->plimit(1); // When we search on src, or on hash of content (hashforfile), we take first one only
    $this->db->order('t.rowid', 'ASC');
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $numrows = $this->db->num_rows($resql);
      if ($numrows) {
        $obj = $this->db->fetch_object($resql);
 
        $this->id = $obj->rowid;
        $this->ref = $obj->ref;
        $this->label = $obj->label;
        $this->share = $obj->share;
        $this->entity = $obj->entity;
        $this->filename = $obj->filename;
        $this->filepath = $obj->filepath;
        $this->fullpath_orig = $obj->fullpath_orig;
        $this->description = $obj->description;
        $this->keywords = $obj->keywords;
        if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
          $this->content = $obj->content;
        }
        $this->cover = $obj->cover;
        $this->position = $obj->position;
        $this->gen_or_uploaded = $obj->gen_or_uploaded;
        $this->date_c = $this->db->jdate($obj->date_c);
        $this->date_m = $this->db->jdate($obj->date_m);
        $this->fk_user_c = $obj->fk_user_c;
        $this->fk_user_m = $obj->fk_user_m;
        $this->note_private = $obj->note_private;
        $this->note_public = $obj->note_public;
        $this->acl = $obj->acl;
        $this->src_object_type = $obj->src_object_type;
        $this->src_object_id = $obj->src_object_id;
        $this->agenda_id = $obj->agenda_id;
        $this->extraparams = (isset($obj->extraparams) ? (array) json_decode($obj->extraparams, true) : null);
      }
 
      // Retrieve all extrafields for ecm_files
      // fetch optionals attributes and labels
      $this->fetch_optionals();
 
      // $this->fetch_lines();
 
      $this->db->free($resql);
 
      if ($numrows) {
        return 1;
      } else {
        return 0;
      }
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, $filter = '', $filtermode = 'AND')
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $sql = 'SELECT';
    $sql .= ' t.rowid,';
    $sql .= " t.label,";
    $sql .= " t.share,";
    $sql .= " t.entity,";
    $sql .= " t.filename,";
    $sql .= " t.filepath,";
    $sql .= " t.fullpath_orig,";
    $sql .= " t.description,";
    $sql .= " t.keywords,";
    if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
      $sql .= " t.content,";
    }
    $sql .= " t.cover,";
    $sql .= " t.position,";
    $sql .= " t.gen_or_uploaded,";
    $sql .= " t.extraparams,";
    $sql .= " t.date_c,";
    $sql .= " t.tms as date_m,";
    $sql .= " t.fk_user_c,";
    $sql .= " t.fk_user_m,";
    $sql .= " t.acl,";
    $sql .= " t.src_object_type,";
    $sql .= " t.src_object_id,";
    $sql .= " t.agenda_id";
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE 1 = 1';
 
    // Manage filter
    if (is_array($filter)) {
      $sqlwhere = array();
      if (count($filter) > 0) {
        foreach ($filter as $key => $value) {
          if ($key == 't.src_object_id') {
            $sqlwhere[] = $this->db->sanitize($key)." = ".((int) $value);
          } else {
            $sqlwhere[] = $this->db->sanitize($key)." LIKE '%".$this->db->escape($this->db->escapeforlike($value))."%'";
          }
        }
      }
      if (count($sqlwhere) > 0) {
        $sql .= ' AND '.implode(' '.$this->db->escape($filtermode).' ', $sqlwhere);
      }
 
      $filter = '';
    }
 
    // Manage filter
    $errormessage = '';
    $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
    if ($errormessage) {
      $this->errors[] = $errormessage;
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
      return -1;
    }
 
    /* Fetching this table depends on filepath+filename, it must not depends on entity
     if (isModEnabled('multicompany')) {
     $sql .= " AND entity IN (" . getEntity('ecmfiles') . ")";
     }*/
    if (!empty($sortfield)) {
      $sql .= $this->db->order($sortfield, $sortorder);
    }
    if (!empty($limit)) {
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $this->lines = array();
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
 
      while ($obj = $this->db->fetch_object($resql)) {
        $line = new EcmFilesLine($this->db);
 
        $line->id = $obj->rowid;
        $line->ref = $obj->rowid;
        $line->label = $obj->label;
        $line->share = $obj->share;
        $line->entity = $obj->entity;
        $line->filename = $obj->filename;
        $line->filepath = $obj->filepath;
        $line->fullpath_orig = $obj->fullpath_orig;
        $line->description = $obj->description;
        $line->keywords = $obj->keywords;
        if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
          $line->content = $obj->content;
        }
        $line->cover = $obj->cover;
        $line->position = $obj->position;
        $line->gen_or_uploaded = $obj->gen_or_uploaded;
        $line->extraparams = $obj->extraparams;
        $line->date_c = $this->db->jdate($obj->date_c);
        $line->date_m = $this->db->jdate($obj->date_m);
        $line->fk_user_c = $obj->fk_user_c;
        $line->fk_user_m = $obj->fk_user_m;
        $line->acl = $obj->acl;
        $line->src_object_type = $obj->src_object_type;
        $line->src_object_id = $obj->src_object_id;
        $line->agenda_id = $obj->agenda_id;
        $this->lines[] = $line;
      }
      $this->db->free($resql);
 
      return $num;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function update(User $user, $notrigger = 0)
  {
    global $conf;
 
    $error = 0;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    // Clean parameters
 
    if (isset($this->ref)) {
      $this->ref = trim($this->ref);
    }
    if (isset($this->label)) {
      $this->label = trim($this->label);
    }
    if (isset($this->share)) {
      $this->share = trim($this->share);
    }
    if (isset($this->entity)) {
      $this->entity = (int) $this->entity;
    }
    if (isset($this->filename)) {
      $this->filename = preg_replace('/\.noexe$/', '', trim($this->filename));
    }
    if (isset($this->filepath)) {
      $this->filepath = trim($this->filepath);
      $this->filepath = preg_replace('/[\\/]+$/', '', $this->filepath); // Remove last /
    }
    if (isset($this->fullpath_orig)) {
      $this->fullpath_orig = trim($this->fullpath_orig);
    }
    if (isset($this->description)) {
      $this->description = trim($this->description);
    }
    if (isset($this->keywords)) {
      $this->keywords = trim($this->keywords);
    }
    if (isset($this->cover)) {
      $this->cover = trim($this->cover);
    }
    if (isset($this->gen_or_uploaded)) {
      $this->gen_or_uploaded = trim($this->gen_or_uploaded);
    }
    if (isset($this->fk_user_m)) {
      $this->fk_user_m = (int) $this->fk_user_m;
    }
    if (isset($this->acl)) {
      $this->acl = trim($this->acl);
    }
    if (isset($this->src_object_type)) {
      $this->src_object_type = trim($this->src_object_type);
    }
    if (!empty($this->agenda_id)) {
      $this->agenda_id = (int) $this->agenda_id;
    }
    $extraparams = (!empty($this->extraparams) ? json_encode($this->extraparams) : null);
    $extraparams = dol_trunc($extraparams, 250);
 
    // Update request
    $sql = 'UPDATE '.MAIN_DB_PREFIX.$this->table_element.' SET';
    $sql .= " ref = '".$this->db->escape(dol_hash($this->filepath."/".$this->filename, '3'))."',";
    $sql .= ' label = '.(isset($this->label) ? "'".$this->db->escape($this->label)."'" : "null").',';
    $sql .= ' share = '.(!empty($this->share) ? "'".$this->db->escape($this->share)."'" : "null").',';
    $sql .= ' entity = '.(isset($this->entity) ? $this->entity : $conf->entity).',';
    $sql .= ' filename = '.(isset($this->filename) ? "'".$this->db->escape($this->filename)."'" : "null").',';
    $sql .= ' filepath = '.(isset($this->filepath) ? "'".$this->db->escape($this->filepath)."'" : "null").',';
    $sql .= ' fullpath_orig = '.(isset($this->fullpath_orig) ? "'".$this->db->escape($this->fullpath_orig)."'" : "null").',';
    $sql .= ' description = '.(isset($this->description) ? "'".$this->db->escape($this->description)."'" : "null").',';
    $sql .= ' keywords = '.(isset($this->keywords) ? "'".$this->db->escape($this->keywords)."'" : "null").',';
    if (getDolGlobalString("MAIN_SAVE_FILE_CONTENT_AS_TEXT")) {
      $sql .= ' content = '.(isset($this->content) ? "'".$this->db->escape($this->content)."'" : "null").',';
    }
    $sql .= ' cover = '.(isset($this->cover) ? "'".$this->db->escape($this->cover)."'" : "null").',';
    $sql .= ' position = '.(isset($this->position) ? $this->db->escape((string) $this->position) : "0").',';
    $sql .= ' gen_or_uploaded = '.(isset($this->gen_or_uploaded) ? "'".$this->db->escape($this->gen_or_uploaded)."'" : "null").',';
    $sql .= ' extraparams = '.(isset($extraparams) ? "'".$this->db->escape($extraparams)."'" : "null").',';
    $sql .= ' date_c = '.(!isset($this->date_c) || dol_strlen($this->date_c) != 0 ? "'".$this->db->idate($this->date_c)."'" : 'null').',';
    //$sql .= ' tms = '.(! isset($this->date_m) || dol_strlen((string) $this->date_m) != 0 ? "'".$this->db->idate($this->date_m)."'" : 'null').','; // Field automatically updated
    $sql .= ' fk_user_m = '.($this->fk_user_m > 0 ? $this->fk_user_m : $user->id).',';
    $sql .= ' acl = '.(isset($this->acl) ? "'".$this->db->escape($this->acl)."'" : "null").',';
    $sql .= ' src_object_id = '.($this->src_object_id > 0 ? $this->src_object_id : "null").',';
    $sql .= ' src_object_type = '.(isset($this->src_object_type) ? "'".$this->db->escape($this->src_object_type)."'" : "null").',';
    $sql .= ' agenda_id = '.($this->agenda_id > 0 ? (int) $this->agenda_id : "null");
    $sql .= ' WHERE rowid='.((int) $this->id);
    $this->db->begin();
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      $error++;
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
    }
 
    if (!$error) {
      // Update extrafields
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
    }
 
    // Triggers
    if (!$error && !$notrigger) {
      // Call triggers
      $result = $this->call_trigger(strtoupper(get_class($this)).'_MODIFY', $user);
      if ($result < 0) {
        $error++;
      } //Do also here what you must do to rollback action if trigger fail
      // End call triggers
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
 
      return -1 * $error;
    } else {
      $this->db->commit();
 
      return 1;
    }
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $error = 0;
 
    $this->db->begin();
 
    // Triggers
    if (!$notrigger) {
      // Call triggers
      $result = $this->call_trigger(strtoupper(get_class($this)).'_DELETE', $user);
      if ($result < 0) {
        $error++;
      } //Do also here what you must do to rollback action if trigger fail
      // End call triggers
    }
 
    // If you need to delete child tables to, you can insert them here
    if (!$error) {
      $result = $this->deleteExtraFields();
      if (!$result) {
        dol_syslog(get_class($this)."::delete error ".$this->error, LOG_ERR);
        $error++;
      }
    }
    if (!$error) {
      $sql = 'DELETE FROM '.MAIN_DB_PREFIX.$this->table_element;
      $sql .= ' WHERE rowid='.((int) $this->id);
 
      $resql = $this->db->query($sql);
      if (!$resql) {
        $error++;
        $this->errors[] = 'Error '.$this->db->lasterror();
        dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
      }
    }
 
    // Commit or rollback
    if ($error) {
      $this->db->rollback();
 
      return -1 * $error;
    } else {
      $this->db->commit();
 
      return 1;
    }
  }
 
  public function createFromClone(User $user, $fromid)
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $error = 0;
    $object = new EcmFiles($this->db);
 
    $this->db->begin();
 
    // Load source object
    $object->fetch($fromid);
    // Reset object
    $object->id = 0;
 
    // Clear fields
    // ...
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->create($user);
 
    // Other options
    if ($result < 0) {
      $error++;
      $this->errors = $object->errors;
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
 
      return $object->id;
    } else {
      $this->db->rollback();
 
      return -1;
    }
  }
 
  public function updateAfterRename($olddir, $newdir)
  {
    $sql = 'UPDATE '.MAIN_DB_PREFIX.'ecm_files SET';
    $sql .= ' filepath = "'.$this->db->escape($newdir).'"';
    //$sql .= ', fullpath_orig = "'.$dbs->escape($newdir)."'";
    $sql .= ' WHERE ';
    $sql .= ' filepath = "'.$this->db->escape($olddir).'"';
    // $sql .= ' AND fullpath_orig = "'.$dbs->escape($olddir).'"';
 
    $this->db->query($sql);
  }
 
  public function getTooltipContentArray($params)
  {
    global $langs;
 
    $langs->load('ecm');
    $datas = [];
    $nofetch = !empty($params['nofetch']);
 
    if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
      return ['optimize' => $langs->trans("ShowFile")];
    }
    $datas['picto'] = img_picto('', $this->picto, '', 0, 0, 0, '', 'paddingrightonly') . '<u>' . $langs->trans("File") . '</u>';
    if (!empty($this->filename)) {
      $datas['name'] = '<br><b>'.$langs->trans('Name').':</b> '.basename($this->filename);
    }
    if (!empty($this->ref)) {
      $datas['ref'] = '<br><b>'.$langs->trans('HashOfFileContent').':</b> '.$this->ref;
    }
    if (!empty($this->share)) {
      $datas['share'] = '<br>'.$langs->trans("FileSharedViaALink");
    } else {
      $datas['share'] = '<br>'.$langs->trans("FileNotShared");
    }
    if (!empty($this->gen_or_uploaded)) {
      $datas['gen_or_upload'] = '<br><b>'.$langs->trans('GenOrUpload').':</b> '.$this->gen_or_uploaded;
    }
    if (!empty($this->content)) {
      $datas['content'] = '<br>'.$langs->trans('FileHasAnIndexedTextContent');
    }
 
    return $datas;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $maxlen = 24, $morecss = '')
  {
    global $conf, $hookmanager, $langs;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
 
    $params = [
      'id' => $this->id,
      'objecttype' => $this->element,
      'option' => $option,
      'nofetch' => 1,
    ];
    $classfortooltip = 'classfortooltip';
    $dataparams = '';
    if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
      $classfortooltip = 'classforajaxtooltip';
      $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
      $label = '';
    } else {
      $label = implode($this->getTooltipContentArray($params));
    }
 
    if ($option) {
      if ($option == 'facture_fournisseur') {
        $tmppath = preg_replace('/^(\d+\/)?fournisseur\/facture\//', '', $this->filepath);
      } elseif ($option == 'commande_fournisseur') {
        $tmppath = preg_replace('/^(\d+\/)?fournisseur\/commande\//', '', $this->filepath);
      } elseif ($option == 'tax-vat') { // Remove part "tax/vat/"
        $tmppath = preg_replace('/^(\d+\/)?tax\/vat\//', '', $this->filepath);
      } elseif ($option == 'remisecheque') {  // Remove part "tax/vat/"
        $tmppath = preg_replace('/^bank\/checkdeposits\//', '', $this->filepath);
      } else {
        if ((int) $this->entity > 1) {
          // Remove the part "entityid/commande/" into "entityid/commande/REFXXX" to get only the ref
          $tmppath = preg_replace('/^\d+\/[^\/]+\//', '', $this->filepath);
        } else {
          // Remove the part "commande/" into "commande/REFXXX" to get only the ref
          $tmppath = preg_replace('/^[^\/]+\//', '', $this->filepath);
        }
      }
      $url = DOL_URL_ROOT.'/document.php?modulepart='.urlencode($option).'&file='.urlencode($tmppath.'/'.$this->filename).'&entity='.((int) $this->entity);
    } else {
      $url = DOL_URL_ROOT.'/ecm/file_card.php?id='.$this->id;
    }
 
    $linkclose = '';
    if (empty($notooltip)) {
      if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("ShowFile");
        $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
      }
      $linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
      $linkclose .= $dataparams.' class="'.$classfortooltip.' '.($morecss ? ' '.$morecss : '').'"';
    } else {
      $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
    }
 
    $linkstart = '<a href="'.$url.'"';
    if (getDolGlobalInt('MAIN_DISABLE_FORCE_SAVEAS') == 2) {
      $linkstart .= 'target="_blank" ';
    }
    $linkstart .= $linkclose.'>';
    $linkend = '</a>';
 
    if ($withpicto) {
      if (empty($this->filename)) {
        $result .= ($linkstart.img_object(($notooltip ? '' : $label), 'label', ($notooltip ? '' : 'class="paddingright"')).$linkend);
      } else {
        $result .= ($linkstart.img_mime($this->filename, ($notooltip ? '' : dol_escape_htmltag($label, 1)), ($notooltip ? '' : ' paddingright')).$linkend);
      }
    }
    $result .= $linkstart.$this->filename.$linkend;
 
    global $action;
    $hookmanager->initHooks(array($this->element . 'dao'));
    $parameters = array('id' => $this->id, 'getnomurl' => &$result);
    $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
    if ($reshook > 0) {
      $result = $hookmanager->resPrint;
    } else {
      $result .= $hookmanager->resPrint;
    }
 
    return $result;
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
    return '';
  }
 
 
  public function initAsSpecimen()
  {
    global $conf, $user;
 
    $this->id = 0;
    $this->specimen = 1;
    $this->label = '0a1b2c3e4f59999999';
    $this->entity = 1;
    $this->filename = 'myspecimenfilefile.pdf';
    $this->filepath = '/aaa/bbb';
    $this->fullpath_orig = 'c:/file on my disk.pdf';
    $this->description = 'This is a description of the file';
    $this->keywords = 'key1,key2';
    $this->content = 'This is the text content of the file';
    $this->cover = '1';
    $this->position = 5;
    $this->gen_or_uploaded = 'uploaded';
    $this->extraparams = '';
    $this->date_c = (dol_now() - 3600 * 24 * 10);
    $this->date_m = '';
    $this->fk_user_c = $user->id;
    $this->fk_user_m = $user->id;
    $this->acl = '';
    $this->src_object_type = 'product';
    $this->src_object_id = 1;
 
    return 1;
  }
}
 
 
class EcmFilesLine extends CommonObjectLine
{
  public $label;
 
  public $entity;
 
  public $filename;
  public $filepath;
  public $fullpath_orig;
 
  public $description;
 
  public $keywords;
 
  public $content;
 
  public $cover;
  public $position;
  public $gen_or_uploaded; // can be 'generated', 'uploaded', 'unknown'
  public $extraparams;
  public $date_c = '';
  public $date_m = '';
 
  public $fk_user_c;
 
  public $fk_user_m;
 
  public $acl;
  public $src_object_type;
  public $src_object_id;
}