/htdocs/core/modules/DolibarrModules.class.php
PHP | 1469 lines | 976 code | 214 blank | 279 comment | 159 complexity | 8064a78548165ffb5c59fb4088d2194f MD5 | raw file
Possible License(s): LGPL-2.0
- <?php
- /* Copyright (C) 2003-2007 Rodolphe Quiedeville <rodolphe@quiedeville.org>
- * Copyright (C) 2004 Sebastien Di Cintio <sdicintio@ressource-toi.org>
- * Copyright (C) 2004 Benoit Mortier <benoit.mortier@opensides.be>
- * Copyright (C) 2004 Eric Seigne <eric.seigne@ryxeo.com>
- * Copyright (C) 2005-2011 Laurent Destailleur <eldy@users.sourceforge.net>
- * Copyright (C) 2005-2011 Regis Houssin <regis@dolibarr.fr>
- *
- * 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 2 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/core/modules/DolibarrModules.class.php
- * \brief Fichier de description et activation des modules Dolibarr
- */
- /**
- * \class DolibarrModules
- * \brief Classe mere des classes de description et activation des modules Dolibarr
- */
- abstract class DolibarrModules
- {
- //! Database handler
- var $db;
- //! Relative path to module style sheet
- var $style_sheet = '';
- //! Path to create when module activated
- var $dirs = array();
- //! Tableau des boites
- var $boxes;
- //! Tableau des constantes
- var $const;
- //! Tableau des droits
- var $rights;
- //! Tableau des menus
- var $menu=array();
- //! Tableau des documents ???
- var $docs;
- var $dbversion = "-";
- /**
- * Fonction d'activation. Insere en base les constantes et boites du module
- *
- * @param array $array_sql Array of SQL requests to execute when enabling module
- * @param string $options Options when enabling module ('', 'noboxes')
- * @return int 1 if OK, 0 if KO
- */
- function _init($array_sql, $options='')
- {
- global $langs;
- $err=0;
- $this->db->begin();
- // Insert line in module table
- if (! $err) $err+=$this->_dbactive();
- // Insert activation module constant
- if (! $err) $err+=$this->_active();
- // Insere le nom de la feuille de style
- if (! $err) $err+=$this->insert_style_sheet();
- // Insert new pages for tabs into llx_const
- if (! $err) $err+=$this->insert_tabs();
- // Insert activation triggers
- if (! $err) $err+=$this->insert_triggers();
- // Insert activation login method
- if (! $err) $err+=$this->insert_login_method();
- // Insert constant defined by modules, into llx_const
- if (! $err) $err+=$this->insert_const();
- // Insere les boites dans llx_boxes_def
- if (! $err && $options != 'noboxes') $err+=$this->insert_boxes();
- // Insert permission definitions of module into llx_rights_def. If user is admin, grant this permission to user.
- if (! $err) $err+=$this->insert_permissions(1);
- // Insere les constantes associees au module dans llx_const
- if (! $err) $err+=$this->insert_menus();
- // Create module's directories
- if (! $err) $err+=$this->create_dirs();
- // Execute les requetes sql complementaires
- if (! $err)
- {
- $num=count($array_sql);
- for ($i = 0; $i < $num; $i++)
- {
- if (! $err)
- {
- $val=$array_sql[$i];
- $sql='';
- $ignoreerror=0;
- if (is_array($val))
- {
- $sql=$val['sql'];
- $ignoreerror=$val['ignoreerror'];
- }
- else
- {
- $sql=$val;
- }
- dol_syslog(get_class($this)."::_init ignoreerror=".$ignoreerror." sql=".$sql, LOG_DEBUG);
- $result=$this->db->query($sql);
- if (! $result)
- {
- if (! $ignoreerror)
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::_init Error ".$this->error, LOG_ERR);
- $err++;
- }
- else
- {
- dol_syslog(get_class($this)."::_init Warning ".$this->db->lasterror(), LOG_WARNING);
- }
- }
- }
- }
- }
- // Return code
- if (! $err)
- {
- $this->db->commit();
- return 1;
- }
- else
- {
- $this->db->rollback();
- return 0;
- }
- }
- /**
- * Fonction de desactivation. Supprime de la base les constantes et boites du module
- *
- * @param array $array_sql Array of SQL requests to execute when disable module
- * @param string $options Options when disabling module ('', 'noboxes')
- * @return int 1 if OK, 0 if KO
- */
- function _remove($array_sql, $options='')
- {
- global $langs;
- $err=0;
- $this->db->begin();
- // Remove line in activation module (entry in table llx_dolibarr_modules)
- if (! $err) $err+=$this->_dbunactive();
- // Remove activation module line (constant MAIN_MODULE_MYMODULE in llx_const)
- if (! $err) $err+=$this->_unactive();
- // Remove activation of module's style sheet (constant MAIN_MODULE_MYMODULE_CSS in llx_const)
- if (! $err) $err+=$this->delete_style_sheet();
- // Remove activation of module's new tabs (MAIN_MODULE_MYMODULE_TABS_XXX in llx_const)
- if (! $err) $err+=$this->delete_tabs();
- // Remove activation of module's triggers (MAIN_MODULE_MYMODULE_TRIGGERS in llx_const)
- if (! $err) $err+=$this->delete_triggers();
- // Remove activation of module's authentification method (MAIN_MODULE_MYMODULE_LOGIN_METHOD in llx_const)
- if (! $err) $err+=$this->delete_login_method();
- // Remove constants defined by modules
- if (! $err) $err+=$this->delete_const();
- // Remove list of module's available boxes (entry in llx_boxes)
- if (! $err && $options != 'noboxes') $err+=$this->delete_boxes();
- // Remove module's permissions from list of available permissions (entries in llx_rights_def)
- if (! $err) $err+=$this->delete_permissions();
- // Remove module's menus (entries in llx_menu)
- if (! $err) $err+=$this->delete_menus();
- // Remove module's directories
- if (! $err) $err+=$this->delete_dirs();
- // Run complementary sql requests
- $num=count($array_sql);
- for ($i = 0; $i < $num; $i++)
- {
- if (! $err)
- {
- dol_syslog(get_class($this)."::_remove sql=".$array_sql[$i], LOG_DEBUG);
- $result=$this->db->query($array_sql[$i]);
- if (! $result)
- {
- $this->error=$this->db->error();
- dol_syslog(get_class($this)."::_remove Error ".$this->error, LOG_ERR);
- $err++;
- }
- }
- }
- // Return code
- if (! $err)
- {
- $this->db->commit();
- return 1;
- }
- else
- {
- $this->db->rollback();
- return 0;
- }
- }
- /**
- * Retourne le nom traduit du module si la traduction existe dans admin.lang,
- * sinon le nom defini par defaut dans le module.
- * @return string Nom du module traduit
- */
- function getName()
- {
- global $langs;
- $langs->load("admin");
- if ($langs->trans("Module".$this->numero."Name") != ("Module".$this->numero."Name"))
- {
- // Si traduction du nom du module existe
- return $langs->trans("Module".$this->numero."Name");
- }
- else
- {
- // If translation of module with its numero does not exists, we take its name
- return $this->name;
- }
- }
- /**
- * Retourne la description traduite du module si la traduction existe dans admin.lang,
- * sinon la description definie par defaut dans le module
- *
- * @return string Nom du module traduit
- */
- function getDesc()
- {
- global $langs;
- $langs->load("admin");
- if ($langs->trans("Module".$this->numero."Desc") != ("Module".$this->numero."Desc"))
- {
- // Si traduction de la description du module existe
- return $langs->trans("Module".$this->numero."Desc");
- }
- else
- {
- // Si traduction de la description du module n'existe pas, on prend definition en dur dans module
- return $this->description;
- }
- }
- /**
- * Retourne la version du module.
- * Pour les modules a l'etat 'experimental', retourne la traduction de 'experimental'
- * Pour les modules 'dolibarr', retourne la version de Dolibarr
- * Pour les autres modules, retourne la version du module
- *
- * @return string Version du module
- */
- function getVersion()
- {
- global $langs;
- $langs->load("admin");
- if ($this->version == 'experimental') return $langs->trans("VersionExperimental");
- elseif ($this->version == 'development') return $langs->trans("VersionDevelopment");
- elseif ($this->version == 'dolibarr') return DOL_VERSION;
- elseif ($this->version) return $this->version;
- else return $langs->trans("VersionUnknown");
- }
- /**
- * Return list of lang files related to module
- *
- * @return array Array of lang files
- */
- function getLangFilesArray()
- {
- return $this->langfiles;
- }
- /**
- * Return translated label of a export dataset
- *
- * @return string Label of databaset
- */
- function getExportDatasetLabel($r)
- {
- global $langs;
- $langstring="ExportDataset_".$this->export_code[$r];
- if ($langs->trans($langstring) == $langstring)
- {
- // Traduction non trouvee
- return $langs->trans($this->export_label[$r]);
- }
- else
- {
- // Traduction trouvee
- return $langs->trans($langstring);
- }
- }
- /**
- * Return translated label of an import dataset
- *
- * @return string Label of databaset
- */
- function getImportDatasetLabel($r)
- {
- global $langs;
- $langstring="ImportDataset_".$this->import_code[$r];
- //print "x".$langstring;
- if ($langs->trans($langstring) == $langstring)
- {
- // Traduction non trouvee
- return $langs->trans($this->import_label[$r]);
- }
- else
- {
- // Traduction trouvee
- return $langs->trans($langstring);
- }
- }
- /**
- * Insert line in dolibarr_modules table.
- * Storage is made for information only, table is not required for Dolibarr usage
- *
- * @return int Nb of errors (0 if OK)
- */
- function _dbactive()
- {
- global $conf;
- $err = 0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."dolibarr_modules";
- $sql.= " WHERE numero = ".$this->numero;
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::_dbactive sql=".$sql, LOG_DEBUG);
- $this->db->query($sql);
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."dolibarr_modules (";
- $sql.= "numero";
- $sql.= ", entity";
- $sql.= ", active";
- $sql.= ", active_date";
- $sql.= ", active_version";
- $sql.= ")";
- $sql.= " VALUES (";
- $sql.= $this->numero;
- $sql.= ", ".$conf->entity;
- $sql.= ", 1";
- $sql.= ", '".$this->db->idate(gmmktime())."'";
- $sql.= ", '".$this->version."'";
- $sql.= ")";
- dol_syslog(get_class($this)."::_dbactive sql=".$sql, LOG_DEBUG);
- $this->db->query($sql);
- return $err;
- }
- /**
- * Remove line in dolibarr_modules table
- * Storage is made for information only, table is not required for Dolibarr usage
- *
- * @return int Nb of errors (0 if OK)
- */
- function _dbunactive()
- {
- global $conf;
- $err = 0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."dolibarr_modules";
- $sql.= " WHERE numero = ".$this->numero;
- $sql.= " AND entity in (0, ".$conf->entity.")";
- dol_syslog(get_class($this)."::_dbunactive sql=".$sql, LOG_DEBUG);
- $this->db->query($sql);
- return $err;
- }
- /**
- * Insert constant to activate module
- *
- * @return int Nb of errors (0 if OK)
- */
- function _active()
- {
- global $conf;
- $err = 0;
- // Common module
- $entity = ((! empty($this->always_enabled) || ! empty($this->core_enabled)) ? 0 : $conf->entity);
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." = '".$this->const_name."'";
- $sql.= " AND entity in (0, ".$entity.")";
- dol_syslog(get_class($this)."::_active sql=".$sql, LOG_DEBUG);
- $this->db->query($sql);
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (name,value,visible,entity) VALUES";
- $sql.= " (".$this->db->encrypt($this->const_name,1);
- $sql.= ",".$this->db->encrypt('1',1);
- $sql.= ",0,".$entity.")";
- dol_syslog(get_class($this)."::_active sql=".$sql, LOG_DEBUG);
- if (!$this->db->query($sql))
- {
- $err++;
- }
- return $err;
- }
- /**
- * Remove activation line
- *
- * @return int Nb of errors (0 if OK)
- **/
- function _unactive()
- {
- global $conf;
- $err = 0;
- // Common module
- $entity = ((! empty($this->always_enabled) || ! empty($this->core_enabled)) ? 0 : $conf->entity);
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." = '".$this->const_name."'";
- $sql.= " AND entity in (0, ".$entity.")";
- dol_syslog(get_class($this)."::_unactive sql=".$sql);
- $this->db->query($sql);
- return $err;
- }
- /**
- * Create tables and keys required by module.
- * Files module.sql and module.key.sql with create table and create keys
- * commands must be stored in directory reldir='/module/sql/'
- * This function is called by this->init
- *
- * @return int <=0 if KO, >0 if OK
- */
- function _load_tables($reldir)
- {
- global $db,$conf;
- $error=0;
- include_once(DOL_DOCUMENT_ROOT ."/core/lib/admin.lib.php");
- $ok = 1;
- foreach($conf->file->dol_document_root as $dirroot)
- {
- if ($ok)
- {
- $dir = $dirroot.$reldir;
- $ok = 0;
- // Run llx_mytable.sql files
- $handle=@opendir($dir); // Dir may not exists
- if (is_resource($handle))
- {
- while (($file = readdir($handle))!==false)
- {
- if (preg_match('/\.sql$/i',$file) && ! preg_match('/\.key\.sql$/i',$file) && substr($file,0,4) == 'llx_' && substr($file,0,4) != 'data')
- {
- $result=run_sql($dir.$file,1,'',1);
- if ($result <= 0) $error++;
- }
- }
- closedir($handle);
- }
- // Run llx_mytable.key.sql files (Must be done after llx_mytable.sql)
- $handle=@opendir($dir); // Dir may not exist
- if (is_resource($handle))
- {
- while (($file = readdir($handle))!==false)
- {
- if (preg_match('/\.key\.sql$/i',$file) && substr($file,0,4) == 'llx_' && substr($file,0,4) != 'data')
- {
- $result=run_sql($dir.$file,1,'',1);
- if ($result <= 0) $error++;
- }
- }
- closedir($handle);
- }
- // Run data_xxx.sql files (Must be done after llx_mytable.key.sql)
- $handle=@opendir($dir); // Dir may not exist
- if (is_resource($handle))
- {
- while (($file = readdir($handle))!==false)
- {
- if (preg_match('/\.sql$/i',$file) && ! preg_match('/\.key\.sql$/i',$file) && substr($file,0,4) == 'data')
- {
- $result=run_sql($dir.$file,1,'',1);
- if ($result <= 0) $error++;
- }
- }
- closedir($handle);
- }
- // Run update_xxx.sql files
- $handle=@opendir($dir); // Dir may not exist
- if (is_resource($handle))
- {
- while (($file = readdir($handle))!==false)
- {
- if (preg_match('/\.sql$/i',$file) && ! preg_match('/\.key\.sql$/i',$file) && substr($file,0,6) == 'update')
- {
- $result=run_sql($dir.$file,1,'',1);
- if ($result <= 0) $error++;
- }
- }
- closedir($handle);
- }
- if ($error == 0)
- {
- $ok = 1;
- }
- }
- }
- return $ok;
- }
- /**
- * Insert boxes into llx_boxes_def
- *
- * @return int Nb of errors (0 if OK)
- */
- function insert_boxes()
- {
- global $conf;
- $err=0;
- if (is_array($this->boxes))
- {
- foreach ($this->boxes as $key => $value)
- {
- //$titre = $this->boxes[$key][0];
- $file = isset($this->boxes[$key][1])?$this->boxes[$key][1]:'';
- $note = isset($this->boxes[$key][2])?$this->boxes[$key][2]:'';
- $sql = "SELECT count(*) FROM ".MAIN_DB_PREFIX."boxes_def";
- $sql.= " WHERE file = '".$file."'";
- $sql.= " AND entity = ".$conf->entity;
- if ($note) $sql.=" AND note ='".$this->db->escape($note)."'";
- $result=$this->db->query($sql);
- if ($result)
- {
- $row = $this->db->fetch_row($result);
- if ($row[0] == 0)
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."boxes_def (file,entity,note)";
- $sql.= " VALUES ('".$this->db->escape($file)."',";
- $sql.= $conf->entity.",";
- $sql.= $note?"'".$this->db->escape($note)."'":"null";
- $sql.= ")";
- dol_syslog(get_class($this)."::insert_boxes sql=".$sql);
- if (! $this->db->query($sql))
- {
- $err++;
- }
- }
- }
- else
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::insert_boxes ".$this->error, LOG_ERR);
- $err++;
- }
- }
- }
- return $err;
- }
- /**
- * Delete boxes
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_boxes()
- {
- global $conf;
- $err=0;
- if (is_array($this->boxes))
- {
- foreach ($this->boxes as $key => $value)
- {
- //$titre = $this->boxes[$key][0];
- $file = $this->boxes[$key][1];
- //$note = $this->boxes[$key][2];
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."boxes";
- $sql.= " USING ".MAIN_DB_PREFIX."boxes, ".MAIN_DB_PREFIX."boxes_def";
- $sql.= " WHERE ".MAIN_DB_PREFIX."boxes.box_id = ".MAIN_DB_PREFIX."boxes_def.rowid";
- $sql.= " AND ".MAIN_DB_PREFIX."boxes_def.file = '".$this->db->escape($file)."'";
- $sql.= " AND ".MAIN_DB_PREFIX."boxes_def.entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_boxes sql=".$sql);
- $resql=$this->db->query($sql);
- if (! $resql)
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_boxes ".$this->error, LOG_ERR);
- $err++;
- }
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."boxes_def";
- $sql.= " WHERE file = '".$this->db->escape($file)."'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_boxes sql=".$sql);
- $resql=$this->db->query($sql);
- if (! $resql)
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_boxes ".$this->error, LOG_ERR);
- $err++;
- }
- }
- }
- return $err;
- }
- /**
- * Desactive feuille de style du module par suppression ligne dans llx_const
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_style_sheet()
- {
- global $conf;
- $err=0;
- if ($this->style_sheet)
- {
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." = '".$this->const_name."_CSS'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_style_sheet sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_style_sheet ".$this->error, LOG_ERR);
- $err++;
- }
- }
- return $err;
- }
- /**
- * Remove links to new module page present in llx_const
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_tabs()
- {
- global $conf;
- $err=0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." like '".$this->const_name."_TABS_%'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_tabs sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_tabs ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Activate stylesheet provided by module by adding a line into llx_const
- *
- * @return int Nb of errors (0 if OK)
- */
- function insert_style_sheet()
- {
- global $conf;
- $err=0;
- if ($this->style_sheet)
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (";
- $sql.= "name";
- $sql.= ", type";
- $sql.= ", value";
- $sql.= ", note";
- $sql.= ", visible";
- $sql.= ", entity";
- $sql.= ")";
- $sql.= " VALUES (";
- $sql.= $this->db->encrypt($this->const_name."_CSS",1);
- $sql.= ", 'chaine'";
- $sql.= ", ".$this->db->encrypt($this->style_sheet,1);
- $sql.= ", 'Style sheet for module ".$this->name."'";
- $sql.= ", '0'";
- $sql.= ", ".$conf->entity;
- $sql.= ")";
- dol_syslog(get_class($this)."::insert_style_sheet sql=".$sql);
- $resql=$this->db->query($sql);
- /* Allow duplicate key
- if (! $resql)
- {
- $err++;
- }
- */
- }
- return $err;
- }
- /**
- * Add links of new pages from modules in llx_const
- *
- * @return int Number of errors (0 if ok)
- */
- function insert_tabs()
- {
- global $conf;
- $err=0;
- if (! empty($this->tabs))
- {
- $i=0;
- foreach ($this->tabs as $key => $value)
- {
- if ($value)
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (";
- $sql.= "name";
- $sql.= ", type";
- $sql.= ", value";
- $sql.= ", note";
- $sql.= ", visible";
- $sql.= ", entity";
- $sql.= ")";
- $sql.= " VALUES (";
- $sql.= $this->db->encrypt($this->const_name."_TABS_".$i,1);
- $sql.= ", 'chaine'";
- $sql.= ", ".$this->db->encrypt($value,1);
- $sql.= ", null";
- $sql.= ", '0'";
- $sql.= ", ".$conf->entity;
- $sql.= ")";
- dol_syslog(get_class($this)."::insert_tabs sql=".$sql);
- $resql=$this->db->query($sql);
- /* Allow duplicate key
- if (! $resql)
- {
- $err++;
- }
- */
- }
- $i++;
- }
- }
- return $err;
- }
- /**
- * Insert constants defined into $this->const array into table llx_const
- *
- * @return int Number of errors (0 if OK)
- */
- function insert_const()
- {
- global $conf;
- $err=0;
- foreach ($this->const as $key => $value)
- {
- $name = $this->const[$key][0];
- $type = $this->const[$key][1];
- $val = $this->const[$key][2];
- $note = isset($this->const[$key][3])?$this->const[$key][3]:'';
- $visible = isset($this->const[$key][4])?$this->const[$key][4]:0;
- $entity = (! empty($this->const[$key][5]) && $this->const[$key][5]!='current')?0:$conf->entity;
- // Clean
- if (empty($visible)) $visible='0';
- if (empty($val)) $val='';
- $sql = "SELECT count(*)";
- $sql.= " FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." = '".$name."'";
- $sql.= " AND entity = ".$entity;
- $result=$this->db->query($sql);
- if ($result)
- {
- $row = $this->db->fetch_row($result);
- if ($row[0] == 0) // If not found
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (name,type,value,note,visible,entity)";
- $sql.= " VALUES (";
- $sql.= $this->db->encrypt($name,1);
- $sql.= ",'".$type."'";
- $sql.= ",".($val?$this->db->encrypt($val,1):"''");
- $sql.= ",".($note?"'".$this->db->escape($note)."'":"null");
- $sql.= ",'".$visible."'";
- $sql.= ",".$entity;
- $sql.= ")";
- dol_syslog(get_class($this)."::insert_const sql=".$sql);
- if (! $this->db->query($sql) )
- {
- dol_syslog(get_class($this)."::insert_const ".$this->db->lasterror(), LOG_ERR);
- $err++;
- }
- }
- else
- {
- dol_syslog(get_class($this)."::insert_const constant '".$name."' already exists", LOG_WARNING);
- }
- }
- else
- {
- $err++;
- }
- }
- return $err;
- }
- /**
- * Remove constants with tags deleteonunactive
- *
- * @return int <0 if KO, 0 if OK
- */
- function delete_const()
- {
- global $conf;
- $err=0;
- foreach ($this->const as $key => $value)
- {
- $name = $this->const[$key][0];
- $deleteonunactive = (! empty($this->const[$key][6]))?1:0;
- if ($deleteonunactive)
- {
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." = '".$name."'";
- $sql.= " AND entity in (0, ".$conf->entity.")";
- dol_syslog(get_class($this)."::delete_const sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_const ".$this->error, LOG_ERR);
- $err++;
- }
- }
- }
- return $err;
- }
- /**
- * Insert permissions definitions related to the module into llx_rights_def
- *
- * @param $reinitadminperms If 1, we also grant them to all admin users
- * @return int Number of error (0 if OK)
- */
- function insert_permissions($reinitadminperms=0)
- {
- global $conf,$user;
- $err=0;
- //print $this->rights_class." ".count($this->rights)."<br>";
- // Test if module is activated
- $sql_del = "SELECT ".$this->db->decrypt('value')." as value";
- $sql_del.= " FROM ".MAIN_DB_PREFIX."const";
- $sql_del.= " WHERE ".$this->db->decrypt('name')." = '".$this->const_name."'";
- $sql_del.= " AND entity IN (0,".$conf->entity.")";
- dol_syslog(get_class($this)."::insert_permissions sql=".$sql_del);
- $resql=$this->db->query($sql_del);
- if ($resql)
- {
- $obj=$this->db->fetch_object($resql);
- if ($obj->value)
- {
- // Si module actif
- foreach ($this->rights as $key => $value)
- {
- $r_id = $this->rights[$key][0];
- $r_desc = $this->rights[$key][1];
- $r_type = isset($this->rights[$key][2])?$this->rights[$key][2]:'';
- $r_def = $this->rights[$key][3];
- $r_perms = $this->rights[$key][4];
- $r_subperms = isset($this->rights[$key][5])?$this->rights[$key][5]:'';
- $r_modul = $this->rights_class;
- if (empty($r_type)) $r_type='w';
- if (dol_strlen($r_perms) )
- {
- if (dol_strlen($r_subperms) )
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."rights_def";
- $sql.= " (id, entity, libelle, module, type, bydefault, perms, subperms)";
- $sql.= " VALUES ";
- $sql.= "(".$r_id.",".$conf->entity.",'".$this->db->escape($r_desc)."','".$r_modul."','".$r_type."',".$r_def.",'".$r_perms."','".$r_subperms."')";
- }
- else
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."rights_def";
- $sql.= " (id, entity, libelle, module, type, bydefault, perms)";
- $sql.= " VALUES ";
- $sql.= "(".$r_id.",".$conf->entity.",'".$this->db->escape($r_desc)."','".$r_modul."','".$r_type."',".$r_def.",'".$r_perms."')";
- }
- }
- else
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."rights_def ";
- $sql .= " (id, entity, libelle, module, type, bydefault)";
- $sql .= " VALUES ";
- $sql .= "(".$r_id.",".$conf->entity.",'".$this->db->escape($r_desc)."','".$r_modul."','".$r_type."',".$r_def.")";
- }
- dol_syslog(get_class($this)."::insert_permissions sql=".$sql, LOG_DEBUG);
- $resqlinsert=$this->db->query($sql,1);
- if (! $resqlinsert)
- {
- if ($this->db->errno() != "DB_ERROR_RECORD_ALREADY_EXISTS")
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::insert_permissions error ".$this->error, LOG_ERR);
- $err++;
- break;
- }
- else dol_syslog(get_class($this)."::insert_permissions record already exists", LOG_INFO);
- }
- $this->db->free($resqlinsert);
- // If we want to init permissions on admin users
- if ($reinitadminperms)
- {
- include_once(DOL_DOCUMENT_ROOT.'/user/class/user.class.php');
- $sql="SELECT rowid from ".MAIN_DB_PREFIX."user where admin = 1";
- dol_syslog(get_class($this)."::insert_permissions Search all admin users sql=".$sql);
- $resqlseladmin=$this->db->query($sql,1);
- if ($resqlseladmin)
- {
- $num=$this->db->num_rows($resqlseladmin);
- $i=0;
- while ($i < $num)
- {
- $obj2=$this->db->fetch_object($resqlseladmin);
- dol_syslog(get_class($this)."::insert_permissions Add permission to user id=".$obj2->rowid);
- $tmpuser=new User($this->db);
- $tmpuser->fetch($obj2->rowid);
- $tmpuser->addrights($r_id);
- $i++;
- }
- if (! empty($user->admin)) // Reload permission for current user if defined
- {
- // We reload permissions
- $user->clearrights();
- $user->getrights();
- }
- }
- else dol_print_error($this->db);
- }
- }
- }
- $this->db->free($resql);
- }
- else
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::insert_permissions ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Delete permissions
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_permissions()
- {
- global $conf;
- $err=0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."rights_def";
- $sql.= " WHERE module = '".$this->rights_class."'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_permissions sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_permissions ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Insert menus entries found into $this->menu into llx_menu*
- *
- * @return int Nb of errors (0 if OK)
- */
- function insert_menus()
- {
- require_once(DOL_DOCUMENT_ROOT."/core/class/menubase.class.php");
- $err=0;
- $this->db->begin();
- //var_dump($this->menu); exit;
- foreach ($this->menu as $key => $value)
- {
- $menu = new Menubase($this->db);
- $menu->menu_handler='all';
- $menu->module=$this->rights_class;
- if (! $this->menu[$key]['fk_menu'])
- {
- $menu->fk_menu=0;
- //print 'aaa'.$this->menu[$key]['fk_menu'];
- }
- else
- {
- //print 'xxx'.$this->menu[$key]['fk_menu'];exit;
- $foundparent=0;
- $fk_parent=$this->menu[$key]['fk_menu'];
- if (preg_match('/r=/',$fk_parent))
- {
- $fk_parent=str_replace('r=','',$fk_parent);
- if (isset($this->menu[$fk_parent]['rowid']))
- {
- $menu->fk_menu=$this->menu[$fk_parent]['rowid'];
- $foundparent=1;
- }
- }
- elseif (preg_match('/mainmenu=(.*),leftmenu=(.*)/',$fk_parent,$reg))
- {
- $menu->fk_menu=-1;
- $menu->fk_mainmenu=$reg[1];
- $menu->fk_leftmenu=$reg[2];
- $foundparent=1;
- }
- if (! $foundparent)
- {
- $this->error="ErrorBadDefinitionOfMenuArrayInModuleDescriptor (bad value for key fk_menu)";
- dol_syslog(get_class($this)."::insert_menus ".$this->error." ".$this->menu[$key]['fk_menu'], LOG_ERR);
- $err++;
- }
- }
- $menu->type=$this->menu[$key]['type'];
- $menu->mainmenu=$this->menu[$key]['mainmenu'];
- $menu->titre=$this->menu[$key]['titre'];
- $menu->leftmenu=isset($this->menu[$key]['leftmenu'])?$this->menu[$key]['leftmenu']:0;
- $menu->url=$this->menu[$key]['url'];
- $menu->langs=$this->menu[$key]['langs'];
- $menu->position=$this->menu[$key]['position'];
- $menu->perms=$this->menu[$key]['perms'];
- $menu->target=$this->menu[$key]['target'];
- $menu->user=$this->menu[$key]['user'];
- //$menu->constraint=$this->menu[$key]['constraint'];
- $menu->enabled=isset($this->menu[$key]['enabled'])?$this->menu[$key]['enabled']:0;
- if (! $err)
- {
- $result=$menu->create();
- if ($result > 0)
- {
- $this->menu[$key]['rowid']=$result;
- }
- else
- {
- $this->error=$menu->error;
- dol_syslog('DolibarrModules::insert_menus result='.$result." ".$this->error, LOG_ERR);
- $err++;
- break;
- }
- }
- }
- if (! $err)
- {
- $this->db->commit();
- }
- else
- {
- dol_syslog(get_class($this)."::insert_menus ".$this->error, LOG_ERR);
- $this->db->rollback();
- }
- return $err;
- }
- /**
- * Remove menus entries
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_menus()
- {
- global $conf;
- $err=0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."menu";
- $sql.= " WHERE module = '".$this->db->escape($this->rights_class)."'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_menus sql=".$sql);
- $resql=$this->db->query($sql);
- if (! $resql)
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_menus ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Create directories required by module
- *
- * @return int Nb of errors (0 if OK)
- */
- function create_dirs()
- {
- global $langs, $conf;
- $err=0;
- if (is_array($this->dirs))
- {
- foreach ($this->dirs as $key => $value)
- {
- $addtodatabase=0;
- if (! is_array($value)) $dir=$value; // Default simple mode
- else {
- $constname = $this->const_name."_DIR_";
- $dir = $this->dirs[$key][1];
- $addtodatabase = empty($this->dirs[$key][2])?'':$this->dirs[$key][2]; // Create constante in llx_const
- $subname = empty($this->dirs[$key][3])?'':strtoupper($this->dirs[$key][3]); // Add submodule name (ex: $conf->module->submodule->dir_output)
- $forcename = empty($this->dirs[$key][4])?'':strtoupper($this->dirs[$key][4]); // Change the module name if different
- if ($forcename) $constname = 'MAIN_MODULE_'.$forcename."_DIR_";
- if ($subname) $constname = $constname.$subname."_";
- $name = $constname.strtoupper($this->dirs[$key][0]);
- }
- // Define directory full path ($dir must start with "/")
- if (empty($conf->global->MAIN_MODULE_MULTICOMPANY) || $conf->entity == 1) $fulldir = DOL_DATA_ROOT.$dir;
- else $fulldir = DOL_DATA_ROOT."/".$conf->entity.$dir;
- // Create dir if it does not exists
- if ($fulldir && ! file_exists($fulldir))
- {
- if (create_exdir($fulldir) < 0)
- {
- $this->error = $langs->trans("ErrorCanNotCreateDir",$fulldir);
- dol_syslog(get_class($this)."::_init ".$this->error, LOG_ERR);
- $err++;
- }
- }
- // Define the constant in database if requested (not the default mode)
- if ($addtodatabase)
- {
- $result = $this->insert_dirs($name,$dir);
- if ($result) $err++;
- }
- }
- }
- return $err;
- }
- /**
- * Insert directories in llx_const
- *
- * @return int Nb of errors (0 if OK)
- */
- function insert_dirs($name,$dir)
- {
- global $conf;
- $err=0;
- $sql = "SELECT count(*)";
- $sql.= " FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." = '".$name."'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::insert_dirs sql=".$sql);
- $result=$this->db->query($sql);
- if ($result)
- {
- $row = $this->db->fetch_row($result);
- if ($row[0] == 0)
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (name,type,value,note,visible,entity)";
- $sql.= " VALUES (".$this->db->encrypt($name,1).",'chaine',".$this->db->encrypt($dir,1).",'Directory for module ".$this->name."','0',".$conf->entity.")";
- dol_syslog(get_class($this)."::insert_dirs sql=".$sql);
- $resql=$this->db->query($sql);
- }
- }
- else
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::insert_dirs ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Remove directory entries
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_dirs()
- {
- global $conf;
- $err=0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." like '".$this->const_name."_DIR_%'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_dirs sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_dirs ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Insert activation triggers from modules in llx_const
- *
- * @return int Nb of errors (0 if OK)
- */
- function insert_triggers()
- {
- global $conf;
- $err=0;
- if (! empty($this->triggers))
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (";
- $sql.= "name";
- $sql.= ", type";
- $sql.= ", value";
- $sql.= ", note";
- $sql.= ", visible";
- $sql.= ", entity";
- $sql.= ")";
- $sql.= " VALUES (";
- $sql.= $this->db->encrypt($this->const_name."_TRIGGERS",1);
- $sql.= ", 'chaine'";
- $sql.= ", ".$this->db->encrypt($this->triggers,1);
- $sql.= ", null";
- $sql.= ", '0'";
- $sql.= ", ".$conf->entity;
- $sql.= ")";
- dol_syslog(get_class($this)."::insert_triggers sql=".$sql);
- $resql=$this->db->query($sql);
- if (! $resql)
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::insert_triggers ".$this->error);
- }
- }
- return $err;
- }
- /**
- * Remove activation triggers from modules in llx_const
- *
- * @return int Nb of errors (0 if OK)
- */
- function delete_triggers()
- {
- global $conf;
- $err=0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." LIKE '".$this->const_name."_TRIGGERS'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_triggers sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_triggers ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- /**
- * Insert activation login method from modules in llx_const
- *
- * @return int Number of errors (0 if ok)
- */
- function insert_login_method()
- {
- global $conf;
- $err=0;
- if (! empty($this->login_method))
- {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (";
- $sql.= "name";
- $sql.= ", type";
- $sql.= ", value";
- $sql.= ", note";
- $sql.= ", visible";
- $sql.= ", entity";
- $sql.= ")";
- $sql.= " VALUES (";
- $sql.= $this->db->encrypt($this->const_name."_LOGIN_METHOD",1);
- $sql.= ", 'chaine'";
- $sql.= ", ".$this->db->encrypt($this->login_method,1);
- $sql.= ", null";
- $sql.= ", '0'";
- $sql.= ", ".$conf->entity;
- $sql.= ")";
- dol_syslog(get_class($this)."::insert_login_method sql=".$sql);
- $resql=$this->db->query($sql);
- if (! $resql)
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::insert_login_method ".$this->error);
- }
- }
- return $err;
- }
- /**
- * Remove activation login method from modules in llx_const
- *
- * @return int Nombre d'erreurs (0 si ok)
- */
- function delete_login_method()
- {
- global $conf;
- $err=0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql.= " WHERE ".$this->db->decrypt('name')." LIKE '".$this->const_name."_LOGIN_METHOD'";
- $sql.= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_login_method sql=".$sql);
- if (! $this->db->query($sql))
- {
- $this->error=$this->db->lasterror();
- dol_syslog(get_class($this)."::delete_login_method ".$this->error, LOG_ERR);
- $err++;
- }
- return $err;
- }
- }
- ?>