/htdocs/ecm/class/ecmdirectory.class.php
PHP | 693 lines | 626 code | 20 blank | 47 comment | 7 complexity | 8c6f576e867eeac14fdff788ee59e77f MD5 | raw file
Possible License(s): LGPL-3.0, LGPL-2.1, GPL-3.0, MIT
- <?php
- /* Copyright (C) 2007-2012 Laurent Destailleur <eldy@users.sourceforge.net>
- * Copyright (C) 2008-2012 Regis Houssin <regis.houssin@capnetworks.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 <http://www.gnu.org/licenses/>.
- */
- /**
- * \file htdocs/ecm/class/ecmdirectory.class.php
- * \ingroup ecm
- * \brief This file is an example for a class file
- */
- /**
- * \class EcmDirectory
- * \brief Class to manage ECM directories
- */
- class EcmDirectory // extends CommonObject
- {
- //public $element='ecm_directories'; //!< Id that identify managed objects
- //public $table_element='ecm_directories'; //!< Name of table without prefix where object is stored
- var $id;
- var $label;
- var $fk_parent;
- var $description;
- var $cachenbofdoc=-1; // By default cache initialized with value 'not calculated'
- var $date_c;
- var $date_m;
- var $cats=array();
- var $motherof=array();
- var $forbiddenchars = array('<','>',':','/','\\','?','*','|','"');
- /**
- * Constructor
- *
- * @param DoliDB $db Database handler
- */
- function __construct($db = '')
- {
- $this->db = $db;
- return 1;
- }
- /**
- * Create record into database
- *
- * @param User $user User that create
- * @return int <0 if KO, >0 if OK
- */
- function create($user)
- {
- global $conf, $langs;
- $error=0;
- $now=dol_now();
- // Clean parameters
- $this->label=dol_sanitizeFileName(trim($this->label));
- $this->fk_parent=trim($this->fk_parent);
- $this->description=trim($this->description);
- $this->date_c=$now;
- $this->fk_user_c=$user->id;
- if ($this->fk_parent <= 0) $this->fk_parent=0;
- // Check if same directory does not exists with this name
- $relativepath=$this->label;
- if ($this->fk_parent)
- {
- $parent = new EcmDirectory($this->db);
- $parent->fetch($this->fk_parent);
- $relativepath=$parent->getRelativePath().$relativepath;
- }
- $relativepath=preg_replace('/([\/])+/i','/',$relativepath); // Avoid duplicate / or \
- //print $relativepath.'<br>';
- $cat = new EcmDirectory($this->db);
- $cate_arbo = $cat->get_full_arbo(1);
- $pathfound=0;
- foreach ($cate_arbo as $key => $categ)
- {
- $path=str_replace($this->forbiddenchars,'_',$categ['fulllabel']);
- //print $path.'<br>';
- if ($path == $relativepath)
- {
- $pathfound=1;
- break;
- }
- }
- if ($pathfound)
- {
- $this->error="ErrorDirAlreadyExists";
- dol_syslog(get_class($this)."::create ".$this->error, LOG_WARNING);
- return -1;
- }
- else
- {
- $this->db->begin();
- // Insert request
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."ecm_directories(";
- $sql.= "label,";
- $sql.= "entity,";
- $sql.= "fk_parent,";
- $sql.= "description,";
- $sql.= "cachenbofdoc,";
- $sql.= "date_c,";
- $sql.= "fk_user_c";
- $sql.= ") VALUES (";
- $sql.= " '".$this->db->escape($this->label)."',";
- $sql.= " '".$conf->entity."',";
- $sql.= " '".$this->fk_parent."',";
- $sql.= " '".$this->db->escape($this->description)."',";
- $sql.= " ".$this->cachenbofdoc.",";
- $sql.= " '".$this->db->idate($this->date_c)."',";
- $sql.= " '".$this->fk_user_c."'";
- $sql.= ")";
- dol_syslog(get_class($this)."::create sql=".$sql, LOG_DEBUG);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."ecm_directories");
- $dir=$conf->ecm->dir_output.'/'.$this->getRelativePath();
- $result=dol_mkdir($dir);
- // Appel des triggers
- include_once DOL_DOCUMENT_ROOT . '/core/class/interfaces.class.php';
- $interface=new Interfaces($this->db);
- $result=$interface->run_triggers('MYECMDIR_CREATE',$this,$user,$langs,$conf);
- if ($result < 0) { $error++; $this->errors=$interface->errors; }
- // Fin appel triggers
- if (! $error)
- {
- $this->db->commit();
- return $this->id;
- }
- else
- {
- $this->db->rollback();
- return -1;
- }
- }
- else
- {
- $this->error="Error ".$this->db->lasterror();
- dol_syslog(get_class($this)."::create ".$this->error, LOG_ERR);
- $this->db->rollback();
- return -1;
- }
- }
- }
- /**
- * Update database
- *
- * @param User $user User that modify
- * @param int $notrigger 0=no, 1=yes (no update trigger)
- * @return int <0 if KO, >0 if OK
- */
- function update($user=0, $notrigger=0)
- {
- global $conf, $langs;
- $error=0;
- // Clean parameters
- $this->label=trim($this->label);
- $this->fk_parent=trim($this->fk_parent);
- $this->description=trim($this->description);
- // Check parameters
- // Put here code to add control on parameters values
- $this->db->begin();
- // Update request
- $sql = "UPDATE ".MAIN_DB_PREFIX."ecm_directories SET";
- $sql.= " label='".$this->db->escape($this->label)."',";
- $sql.= " fk_parent='".$this->fk_parent."',";
- $sql.= " description='".$this->db->escape($this->description)."'";
- $sql.= " WHERE rowid=".$this->id;
- dol_syslog(get_class($this)."::update sql=".$sql, LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (! $resql)
- {
- $error++;
- $this->error="Error ".$this->db->lasterror();
- dol_syslog("EcmDirectories::update ".$this->error, LOG_ERR);
- }
- if (! $error && ! $notrigger)
- {
- // Appel des triggers
- include_once DOL_DOCUMENT_ROOT . '/core/class/interfaces.class.php';
- $interface=new Interfaces($this->db);
- $result=$interface->run_triggers('MYECMDIR_MODIFY',$this,$user,$langs,$conf);
- if ($result < 0) { $error++; $this->errors=$interface->errors; }
- // Fin appel triggers
- }
- if (! $error)
- {
- $this->db->commit();
- return 1;
- }
- else
- {
- $this->db->rollback();
- return -1;
- }
- }
- /**
- * Update cache of nb of documents into database
- *
- * @param string $sign '+' or '-'
- * @return int <0 if KO, >0 if OK
- */
- function changeNbOfFiles($sign)
- {
- global $conf, $langs;
- // Update request
- $sql = "UPDATE ".MAIN_DB_PREFIX."ecm_directories SET";
- $sql.= " cachenbofdoc = cachenbofdoc ".$sign." 1";
- $sql.= " WHERE rowid = ".$this->id;
- dol_syslog(get_class($this)."::changeNbOfFiles sql=".$sql, LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (! $resql)
- {
- $this->error="Error ".$this->db->lasterror();
- dol_syslog(get_class($this)."::changeNbOfFiles ".$this->error, LOG_ERR);
- return -1;
- }
- return 1;
- }
- /**
- * Load object in memory from database
- *
- * @param int $id Id of object
- * @return int <0 if KO, 0 if not found, >0 if OK
- */
- function fetch($id)
- {
- $sql = "SELECT";
- $sql.= " t.rowid,";
- $sql.= " t.label,";
- $sql.= " t.fk_parent,";
- $sql.= " t.description,";
- $sql.= " t.cachenbofdoc,";
- $sql.= " t.fk_user_c,";
- $sql.= " t.fk_user_m,";
- $sql.= " t.date_c as date_c,";
- $sql.= " t.date_m as date_m";
- $sql.= " FROM ".MAIN_DB_PREFIX."ecm_directories as t";
- $sql.= " WHERE t.rowid = ".$id;
- dol_syslog(get_class($this)."::fetch sql=".$sql, LOG_DEBUG);
- $resql=$this->db->query($sql);
- if ($resql)
- {
- $obj = $this->db->fetch_object($resql);
- if ($obj)
- {
- $this->id = $obj->rowid;
- $this->ref = $obj->rowid;
- $this->label = $obj->label;
- $this->fk_parent = $obj->fk_parent;
- $this->description = $obj->description;
- $this->cachenbofdoc = $obj->cachenbofdoc;
- $this->fk_user_m = $obj->fk_user_m;
- $this->fk_user_c = $obj->fk_user_c;
- $this->date_c = $this->db->jdate($obj->date_c);
- $this->date_m = $this->db->jdate($obj->date_m);
- }
- $this->db->free($resql);
- return $obj?1:0;
- }
- else
- {
- $this->error="Error ".$this->db->lasterror();
- dol_syslog(get_class($this)."::fetch ".$this->error, LOG_ERR);
- return -1;
- }
- }
- /**
- * Delete object on database and on disk
- *
- * @param User $user User that delete
- * @return int <0 if KO, >0 if OK
- */
- function delete($user)
- {
- global $conf, $langs;
- require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- $error=0;
- $relativepath=$this->getRelativePath(1); // Ex: dir1/dir2/dir3
- dol_syslog(get_class($this)."::delete remove directory ".$relativepath);
- $this->db->begin();
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."ecm_directories";
- $sql.= " WHERE rowid=".$this->id;
- dol_syslog(get_class($this)."::delete sql=".$sql);
- $resql = $this->db->query($sql);
- if (! $resql)
- {
- $this->db->rollback();
- $this->error="Error ".$this->db->lasterror();
- dol_syslog(get_class($this)."::delete ".$this->error, LOG_ERR);
- return -2;
- }
- $file = $conf->ecm->dir_output . "/" . $relativepath;
- $result=@dol_delete_dir($file);
- if ($result || ! @is_dir(dol_osencode($file)))
- {
- $this->db->commit();
- }
- else
- {
- $this->error='ErrorFailToDeleteDir';
- dol_syslog(get_class($this)."::delete ".$this->error, LOG_ERR);
- $this->db->rollback();
- $error++;
- }
- if (! $error)
- {
- // Appel des triggers
- include_once DOL_DOCUMENT_ROOT . '/core/class/interfaces.class.php';
- $interface=new Interfaces($this->db);
- $result=$interface->run_triggers('MYECMDIR_DELETE',$this,$user,$langs,$conf);
- if ($result < 0) { $error++; $this->errors=$interface->errors; }
- // Fin appel triggers
- }
- if (! $error) return 1;
- else return -1;
- }
- /**
- * Initialise an instance with random values.
- * Used to build previews or test instances.
- * id must be 0 if object instance is a specimen.
- *
- * @return void
- */
- function initAsSpecimen()
- {
- $this->id=0;
- $this->label='MyDirectory';
- $this->fk_parent='0';
- $this->description='This is a directory';
- }
- /**
- * Return directory name you can click (and picto)
- *
- * @param int $withpicto 0=Pas de picto, 1=Inclut le picto dans le lien, 2=Picto seul
- * @param string $option Sur quoi pointe le lien
- * @param int $max Max length
- * @param string $more Add more param on a link
- * @return string Chaine avec URL
- */
- function getNomUrl($withpicto=0,$option='',$max=0,$more='')
- {
- global $langs;
- $result='';
- $lien = '<a href="'.DOL_URL_ROOT.'/ecm/docmine.php?section='.$this->id.'"'.($more?' '.$more:'').'>';
- if ($option == 'index') $lien = '<a href="'.DOL_URL_ROOT.'/ecm/index.php?section='.$this->id.'&sectionexpand=true"'.($more?' '.$more:'').'>';
- if ($option == 'indexexpanded') $lien = '<a href="'.DOL_URL_ROOT.'/ecm/index.php?section='.$this->id.'&sectionexpand=false"'.($more?' '.$more:'').'>';
- if ($option == 'indexnotexpanded') $lien = '<a href="'.DOL_URL_ROOT.'/ecm/index.php?section='.$this->id.'&sectionexpand=true"'.($more?' '.$more:'').'>';
- $lienfin='</a>';
- //$picto=DOL_URL_ROOT.'/theme/common/treemenu/folder.gif';
- $picto='dir';
- //$newref=str_replace('_',' ',$this->ref);
- $newref=$this->ref;
- $newlabel=$langs->trans("ShowECMSection").': '.$newref;
- if ($withpicto) $result.=($lien.img_object($newlabel,$picto).$lienfin);
- if ($withpicto && $withpicto != 2) $result.=' ';
- if ($withpicto != 2) $result.=$lien.($max?dol_trunc($newref,$max,'middle'):$newref).$lienfin;
- return $result;
- }
- /**
- * Return relative path of a directory on disk
- *
- * @param int $force Force reload of full arbo even if already loaded
- * @return string Relative physical path
- */
- function getRelativePath($force=0)
- {
- $this->get_full_arbo($force);
- $ret='';
- $idtosearch=$this->id;
- $i=0;
- do {
- // Get index cursor in this->cats for id_mere
- $cursorindex=-1;
- foreach ($this->cats as $key => $val)
- {
- if ($this->cats[$key]['id'] == $idtosearch)
- {
- $cursorindex=$key;
- break;
- }
- }
- //print "c=".$idtosearch."-".$cursorindex;
- if ($cursorindex >= 0)
- {
- // Path is label sanitized (no space and no special char) and concatenated
- $ret=dol_sanitizeFileName($this->cats[$cursorindex]['label']).'/'.$ret;
- $idtosearch=$this->cats[$cursorindex]['id_mere'];
- $i++;
- }
- }
- while ($cursorindex >= 0 && ! empty($idtosearch) && $i < 100); // i avoid infinite loop
- return $ret;
- }
- /**
- * Load this->motherof that is array(id_son=>id_parent, ...)
- *
- * @return int <0 if KO, >0 if OK
- */
- function load_motherof()
- {
- global $conf;
- $this->motherof=array();
- // Charge tableau des meres
- $sql = "SELECT fk_parent as id_parent, rowid as id_son";
- $sql.= " FROM ".MAIN_DB_PREFIX."ecm_directories";
- $sql.= " WHERE fk_parent != 0";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::get_full_arbo sql=".$sql);
- $resql = $this->db->query($sql);
- if ($resql)
- {
- while ($obj= $this->db->fetch_object($resql))
- {
- $this->motherof[$obj->id_son]=$obj->id_parent;
- }
- return 1;
- }
- else
- {
- dol_print_error($this->db);
- return -1;
- }
- }
- /**
- * Reconstruit l'arborescence des categories sous la forme d'un tableau
- * Renvoi un tableau de tableau('id','id_mere',...) trie selon arbre et avec:
- * id Id de la categorie
- * id_mere Id de la categorie mere
- * id_children Tableau des id enfant
- * label Name of directory
- * cachenbofdoc Nb of documents
- * date_c Date creation
- * fk_user_c User creation
- * login_c Login creation
- * fullpath Full path of id (Added by build_path_from_id_categ call)
- * fullrelativename Full path name (Added by build_path_from_id_categ call)
- * fulllabel Full label (Added by build_path_from_id_categ call)
- * level Level of line (Added by build_path_from_id_categ call)
- *
- * @param int $force Force reload of full arbo even if already loaded in cache $this->cats
- * @return array Tableau de array
- */
- function get_full_arbo($force=0)
- {
- global $conf;
- if (empty($force) && ! empty($this->full_arbo_loaded))
- {
- return $this->cats;
- }
- // Init this->motherof that is array(id_son=>id_parent, ...)
- $this->load_motherof();
- // Charge tableau des categories
- $sql = "SELECT c.rowid as rowid, c.label as label,";
- $sql.= " c.description as description, c.cachenbofdoc,";
- $sql.= " c.fk_user_c,";
- $sql.= " c.date_c,";
- $sql.= " u.login as login_c,";
- $sql.= " ca.rowid as rowid_fille";
- $sql.= " FROM ".MAIN_DB_PREFIX."user as u, ".MAIN_DB_PREFIX."ecm_directories as c";
- $sql.= " LEFT JOIN ".MAIN_DB_PREFIX."ecm_directories as ca";
- $sql.= " ON c.rowid = ca.fk_parent";
- $sql.= " WHERE c.fk_user_c = u.rowid";
- $sql.= " AND c.entity = ".$conf->entity;
- $sql.= " ORDER BY c.label, c.rowid";
- dol_syslog(get_class($this)."::get_full_arbo sql=".$sql);
- $resql = $this->db->query($sql);
- if ($resql)
- {
- $this->cats = array();
- $i=0;
- while ($obj = $this->db->fetch_object($resql))
- {
- $this->cats[$obj->rowid]['id'] = $obj->rowid;
- $this->cats[$obj->rowid]['id_mere'] = (isset($this->motherof[$obj->rowid])?$this->motherof[$obj->rowid]:'');
- $this->cats[$obj->rowid]['label'] = $obj->label;
- $this->cats[$obj->rowid]['description'] = $obj->description;
- $this->cats[$obj->rowid]['cachenbofdoc'] = $obj->cachenbofdoc;
- $this->cats[$obj->rowid]['date_c'] = $this->db->jdate($obj->date_c);
- $this->cats[$obj->rowid]['fk_user_c'] = $obj->fk_user_c;
- $this->cats[$obj->rowid]['login_c'] = $obj->login_c;
- if (! empty($obj->rowid_fille))
- {
- if (isset($this->cats[$obj->rowid]['id_children']) && is_array($this->cats[$obj->rowid]['id_children']))
- {
- $newelempos=count($this->cats[$obj->rowid]['id_children']);
- //print "this->cats[$i]['id_children'] est deja un tableau de $newelem elements<br>";
- $this->cats[$obj->rowid]['id_children'][$newelempos]=$obj->rowid_fille;
- }
- else
- {
- //print "this->cats[".$obj->rowid."]['id_children'] n'est pas encore un tableau<br>";
- $this->cats[$obj->rowid]['id_children']=array($obj->rowid_fille);
- }
- }
- $i++;
- }
- }
- else
- {
- dol_print_error($this->db);
- return -1;
- }
- // We add properties fullxxx to all elements
- foreach($this->cats as $key => $val)
- {
- if (isset($motherof[$key])) continue;
- $this->build_path_from_id_categ($key,0);
- }
- $this->cats=dol_sort_array($this->cats, 'fulllabel', 'asc', true, false);
- $this->full_arbo_loaded=1;
- return $this->cats;
- }
- /**
- * Define properties fullpath, fullrelativename, fulllabel of a directory of array this->cats and all its childs.
- * Separator between directories is always '/', whatever is OS.
- *
- * @param int $id_categ id_categ entry to update
- * @param int $protection Deep counter to avoid infinite loop
- * @return void
- */
- function build_path_from_id_categ($id_categ,$protection=0)
- {
- // Define fullpath
- if (! empty($this->cats[$id_categ]['id_mere']))
- {
- $this->cats[$id_categ]['fullpath'] =$this->cats[$this->cats[$id_categ]['id_mere']]['fullpath'];
- $this->cats[$id_categ]['fullpath'].='_'.$id_categ;
- $this->cats[$id_categ]['fullrelativename'] =$this->cats[$this->cats[$id_categ]['id_mere']]['fullrelativename'];
- $this->cats[$id_categ]['fullrelativename'].='/'.$this->cats[$id_categ]['label'];
- $this->cats[$id_categ]['fulllabel'] =$this->cats[$this->cats[$id_categ]['id_mere']]['fulllabel'];
- $this->cats[$id_categ]['fulllabel'].=' >> '.$this->cats[$id_categ]['label'];
- }
- else
- {
- $this->cats[$id_categ]['fullpath']='_'.$id_categ;
- $this->cats[$id_categ]['fullrelativename']=$this->cats[$id_categ]['label'];
- $this->cats[$id_categ]['fulllabel']=$this->cats[$id_categ]['label'];
- }
- // We count number of _ to have level (we use strlen that is faster than dol_strlen)
- $this->cats[$id_categ]['level']=strlen(preg_replace('/([^_])/i','',$this->cats[$id_categ]['fullpath']));
- // Traite ces enfants
- $protection++;
- if ($protection > 20) return; // On ne traite pas plus de 20 niveaux
- if (isset($this->cats[$id_categ]['id_children']) && is_array($this->cats[$id_categ]['id_children']))
- {
- foreach($this->cats[$id_categ]['id_children'] as $key => $val)
- {
- $this->build_path_from_id_categ($val,$protection);
- }
- }
- return 1;
- }
- /**
- * Refresh value for cachenboffile. This scan and count files into directory.
- *
- * @param int $all 0=refresh record using this->id , 1=refresh record using this->entity
- * @return int -1 if KO, Nb of files in directory if OK
- */
- function refreshcachenboffile($all=0)
- {
- global $conf;
- include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- $dir=$conf->ecm->dir_output.'/'.$this->getRelativePath();
- $filelist=dol_dir_list($dir,'files',0,'','\.meta$');
- // Test if filelist is in database
- // Update request
- $sql = "UPDATE ".MAIN_DB_PREFIX."ecm_directories SET";
- $sql.= " cachenbofdoc = '".count($filelist)."'";
- if (empty($all)) // By default
- {
- $sql.= " WHERE rowid = ".$this->id;
- }
- else
- {
- $sql.= " WHERE entity = ".$conf->entity;
- }
- dol_syslog(get_class($this)."::refreshcachenboffile sql=".$sql, LOG_DEBUG);
- $resql = $this->db->query($sql);
- if ($resql)
- {
- $this->cachenbofdoc=count($filelist);
- return $this->cachenbofdoc;
- }
- else
- {
- $this->error="Error ".$this->db->lasterror();
- dol_syslog(get_class($this)."::refreshcachenboffile ".$this->error, LOG_ERR);
- return -1;
- }
- }
- }
- ?>