12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456 |
- <?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-2013 Laurent Destailleur <eldy@users.sourceforge.net>
- * Copyright (C) 2005-2012 Regis Houssin <regis.houssin@inodbox.com>
- * Copyright (C) 2014 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
- * Copyright (C) 2018 Josep Lluís Amador <joseplluis@lliuretic.cat>
- * Copyright (C) 2019 Frédéric France <frederic.france@netlogic.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 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/>.
- */
- /**
- * \file htdocs/core/modules/DolibarrModules.class.php
- * \brief File of parent class of module descriptor class files
- */
- /**
- * Class DolibarrModules
- *
- * Parent class for module descriptor class files
- */
- class DolibarrModules // Can not be abstract, because we need to instantiate it into unActivateModule to be able to disable a module whose files were removed.
- {
- /**
- * @var DoliDb Database handler
- */
- public $db;
- /**
- * @var int Module unique ID
- * @see https://wiki.dolibarr.org/index.php/List_of_modules_id
- */
- public $numero;
- /**
- * @var string Publisher name
- * @since 4.0.0
- */
- public $editor_name;
- /**
- * @var string URL of module at publisher site
- * @since 4.0.0
- */
- public $editor_url;
- /**
- * @var string Family
- * @see $familyinfo
- *
- * Native values: 'crm', 'financial', 'hr', 'projects', 'products', 'ecm', 'technic', 'other'.
- * Use familyinfo to declare a custom value.
- */
- public $family;
- /**
- * @var array Custom family informations
- * @see $family
- *
- * e.g.:
- * array(
- * 'myownfamily' => array(
- * 'position' => '001',
- * 'label' => $langs->trans("MyOwnFamily")
- * )
- * );
- */
- public $familyinfo;
- /**
- * @var string Module position on 2 digits
- */
- public $module_position = '50';
- /**
- * @var string Module name
- *
- * Only used if Module[ID]Name translation string is not found.
- *
- * You can use the following code to automatically derive it from your module's class name:
- * preg_replace('/^mod/i', '', get_class($this))
- */
- public $name;
- /**
- * @var string[] Paths to create when module is activated
- *
- * e.g.: array('/mymodule/temp')
- */
- public $dirs = array();
- /**
- * @var array Module boxes
- */
- public $boxes = array();
- /**
- * @var array Module constants
- */
- public $const = array();
- /**
- * @var array Module cron jobs entries
- */
- public $cronjobs = array();
- /**
- * @var array Module access rights
- */
- public $rights;
- /**
- * @var string Module access rights family
- */
- public $rights_class;
- /**
- * @var array|int Module menu entries (1 means the menu entries are not declared into module descriptor but are hardcoded into menu manager)
- */
- public $menu = array();
- /**
- * @var array Module parts
- * array(
- * // Set this to 1 if module has its own trigger directory (/mymodule/core/triggers)
- * 'triggers' => 0,
- * // Set this to 1 if module has its own login method directory (/mymodule/core/login)
- * 'login' => 0,
- * // Set this to 1 if module has its own substitution function file (/mymodule/core/substitutions)
- * 'substitutions' => 0,
- * // Set this to 1 if module has its own menus handler directory (/mymodule/core/menus)
- * 'menus' => 0,
- * // Set this to 1 if module has its own theme directory (/mymodule/theme)
- * 'theme' => 0,
- * // Set this to 1 if module overwrite template dir (/mymodule/core/tpl)
- * 'tpl' => 0,
- * // Set this to 1 if module has its own barcode directory (/mymodule/core/modules/barcode)
- * 'barcode' => 0,
- * // Set this to 1 if module has its own models directory (/mymodule/core/modules/xxx)
- * 'models' => 0,
- * // Set this to relative path of css file if module has its own css file
- * 'css' => '/mymodule/css/mymodule.css.php',
- * // Set this to relative path of js file if module must load a js on all pages
- * 'js' => '/mymodule/js/mymodule.js',
- * // Set here all hooks context managed by module
- * 'hooks' => array('hookcontext1','hookcontext2')
- * )
- */
- public $module_parts = array();
- /**
- * @var string Module documents ?
- * @deprecated Seems unused anywhere
- */
- public $docs;
- /**
- * @var string ?
- * @deprecated Seems unused anywhere
- */
- public $dbversion = "-";
- /**
- * @var string Error message
- */
- public $error;
- /**
- * @var string Module version
- * @see http://semver.org
- *
- * The following keywords can also be used:
- * 'development'
- * 'experimental'
- * 'dolibarr': only for core modules that share its version
- * 'dolibarr_deprecated': only for deprecated core modules
- */
- public $version;
- /**
- * Module last version
- * @var string $lastVersion
- */
- public $lastVersion = '';
- /**
- * true indicate this module need update
- * @var bool $needUpdate
- */
- public $needUpdate = false;
- /**
- * @var string Module description (short text)
- *
- * Only used if Module[ID]Desc translation string is not found.
- */
- public $description;
- /**
- * @var string Module description (long text)
- * @since 4.0.0
- *
- * HTML content supported.
- */
- public $descriptionlong;
- // For exports
- /**
- * @var string Module export code
- */
- public $export_code;
- /**
- * @var string Module export label
- */
- public $export_label;
- public $export_permission;
- public $export_fields_array;
- public $export_TypeFields_array; // Array of key=>type where type can be 'Numeric', 'Date', 'Text', 'Boolean', 'Status', 'List:xxx:login:rowid'
- public $export_entities_array;
- public $export_special_array; // special or computed field
- public $export_dependencies_array;
- public $export_sql_start;
- public $export_sql_end;
- public $export_sql_order;
- // For import
- /**
- * @var string Module import code
- */
- public $import_code;
- /**
- * @var string Module import label
- */
- public $import_label;
- /**
- * @var string Module constant name
- */
- public $const_name;
- /**
- * @var bool Module can't be disabled
- */
- public $always_enabled;
- /**
- * @var bool Module is disabled
- */
- public $disabled;
- /**
- * @var int Module is enabled globally (Multicompany support)
- */
- public $core_enabled;
- /**
- * @var string Name of image file used for this module
- *
- * If file is in theme/yourtheme/img directory under name object_pictoname.png use 'pictoname'
- * If file is in module/img directory under name object_pictoname.png use 'pictoname@module'
- */
- public $picto;
- /**
- * @var string[] List of config pages
- *
- * Name of php pages stored into module/admin directory, used to setup module.
- * e.g.: "admin.php@module"
- */
- public $config_page_url;
- /**
- * @var string[] List of module class names that must be enabled if this module is enabled. e.g.: array('modAnotherModule', 'FR'=>'modYetAnotherModule')
- * @see $requiredby
- */
- public $depends;
- /**
- * @var string[] List of module class names to disable if the module is disabled.
- * @see $depends
- */
- public $requiredby;
- /**
- * @var string[] List of module class names as string this module is in conflict with.
- * @see $depends
- */
- public $conflictwith;
- /**
- * @var string[] Module language files
- */
- public $langfiles;
- /**
- * @var array<string,string> Array of warnings to show when we activate the module
- *
- * array('always'='text') or array('FR'='text')
- */
- public $warnings_activation;
- /**
- * @var array<string,string> Array of warnings to show when we activate an external module
- *
- * array('always'='text') or array('FR'='text')
- */
- public $warnings_activation_ext;
- /**
- * @var array Minimum version of PHP required by module.
- * e.g.: PHP ≥ 5.6 = array(5, 6)
- */
- public $phpmin;
- /**
- * @var array Minimum version of Dolibarr required by module.
- * e.g.: Dolibarr ≥ 3.6 = array(3, 6)
- */
- public $need_dolibarr_version;
- /**
- * @var bool Whether to hide the module.
- */
- public $hidden = false;
- /**
- * @var string url to check for module update
- */
- public $url_last_version;
- /**
- * Constructor. Define names, constants, directories, boxes, permissions
- *
- * @param DoliDB $db Database handler
- */
- public function __construct($db)
- {
- $this->db = $db;
- }
- // We should but can't set this as abstract because this will make dolibarr hang
- // after migration due to old module not implementing. We must wait PHP is able to make
- // a try catch on Fatal error to manage this correctly.
- // We need constructor into function unActivateModule into admin.lib.php
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
- /**
- * Enables a module.
- * Inserts all informations into database.
- *
- * @param array $array_sql SQL requests to be executed when enabling module
- * @param string $options String with options when disabling module:
- * - 'noboxes' = Do all actions but do not insert boxes
- * - 'newboxdefonly' = Do all actions but for boxes, insert def of boxes only and not boxes activation
- * @return int 1 if OK, 0 if KO
- */
- protected function _init($array_sql, $options = '')
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- $this->db->begin();
- // Insert activation module constant
- if (!$err) {
- $err += $this->_active();
- }
- // Insert new pages for tabs (into llx_const)
- if (!$err) {
- $err += $this->insert_tabs();
- }
- // Insert activation of module's parts
- if (!$err) {
- $err += $this->insert_module_parts();
- }
- // Insert constant defined by modules (into llx_const)
- if (!$err && !preg_match('/newboxdefonly/', $options)) {
- $err += $this->insert_const(); // Test on newboxdefonly to avoid to erase value during upgrade
- }
- // Insert boxes def (into llx_boxes_def) and boxes setup (into llx_boxes)
- if (!$err && !preg_match('/noboxes/', $options)) {
- $err += $this->insert_boxes($options);
- }
- // Insert cron job entries (entry in llx_cronjobs)
- if (!$err) {
- $err += $this->insert_cronjobs();
- }
- // 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, null, 1);
- }
- // Insert specific menus entries into database
- if (!$err) {
- $err += $this->insert_menus();
- }
- // Create module's directories
- if (!$err) {
- $err += $this->create_dirs();
- }
- // Execute addons requests
- $num = count($array_sql);
- for ($i = 0; $i < $num; $i++) {
- if (!$err) {
- $val = $array_sql[$i];
- $sql = $val;
- $ignoreerror = 0;
- if (is_array($val)) {
- $sql = $val['sql'];
- $ignoreerror = $val['ignoreerror'];
- }
- // Add current entity id
- $sql = str_replace('__ENTITY__', $conf->entity, $sql);
- dol_syslog(get_class($this)."::_init ignoreerror=".$ignoreerror."", LOG_DEBUG);
- $result = $this->db->query($sql, $ignoreerror);
- if (!$result) {
- if (!$ignoreerror) {
- $this->error = $this->db->lasterror();
- $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;
- }
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
- /**
- * Disable function. Deletes the module constants and boxes from the database.
- *
- * @param string[] $array_sql SQL requests to be executed when module is disabled
- * @param string $options Options when disabling module:
- *
- * @return int 1 if OK, 0 if KO
- */
- protected function _remove($array_sql, $options = '')
- {
- // phpcs:enable
- $err = 0;
- $this->db->begin();
- // Remove activation module line (constant MAIN_MODULE_MYMODULE in llx_const)
- if (!$err) {
- $err += $this->_unactive();
- }
- // 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 parts (MAIN_MODULE_MYMODULE_XXX in llx_const)
- if (!$err) {
- $err += $this->delete_module_parts();
- }
- // Remove constants defined by modules
- if (!$err) {
- $err += $this->delete_const();
- }
- // Remove list of module's available boxes (entry in llx_boxes)
- if (!$err && !preg_match('/(newboxdefonly|noboxes)/', $options)) {
- $err += $this->delete_boxes(); // We don't have to delete if option ask to keep boxes safe or ask to add new box def only
- }
- // Remove list of module's cron job entries (entry in llx_cronjobs)
- if (!$err) {
- $err += $this->delete_cronjobs();
- }
- // 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", LOG_DEBUG);
- $result = $this->db->query($array_sql[$i]);
- if (!$result) {
- $this->error = $this->db->error();
- $err++;
- }
- }
- }
- // Return code
- if (!$err) {
- $this->db->commit();
- return 1;
- } else {
- $this->db->rollback();
- return 0;
- }
- }
- /**
- * Gives the translated module name if translation exists in admin.lang or into language files of module.
- * Otherwise return the module key name.
- *
- * @return string Translated module name
- */
- public function getName()
- {
- global $langs;
- $langs->load("admin");
- if ($langs->transnoentitiesnoconv("Module".$this->numero."Name") != ("Module".$this->numero."Name")) {
- // If module name translation exists
- return $langs->transnoentitiesnoconv("Module".$this->numero."Name");
- } else {
- // If module name translation using it's unique id does not exist, we try to use its name to find translation
- if (is_array($this->langfiles)) {
- foreach ($this->langfiles as $val) {
- if ($val) {
- $langs->load($val);
- }
- }
- }
- if ($langs->trans("Module".$this->name."Name") != ("Module".$this->name."Name")) {
- // If module name translation exists
- return $langs->transnoentitiesnoconv("Module".$this->name."Name");
- }
- // Last chance with simple label
- return $langs->transnoentitiesnoconv($this->name);
- }
- }
- /**
- * Gives the translated module description if translation exists in admin.lang or the default module description
- *
- * @return string Translated module description
- */
- public function getDesc()
- {
- global $langs;
- $langs->load("admin");
- if ($langs->transnoentitiesnoconv("Module".$this->numero."Desc") != ("Module".$this->numero."Desc")) {
- // If module description translation exists
- return $langs->transnoentitiesnoconv("Module".$this->numero."Desc");
- } else {
- // If module description translation does not exist using its unique id, we can use its name to find translation
- if (is_array($this->langfiles)) {
- foreach ($this->langfiles as $val) {
- if ($val) {
- $langs->load($val);
- }
- }
- }
- if ($langs->transnoentitiesnoconv("Module".$this->name."Desc") != ("Module".$this->name."Desc")) {
- // If module name translation exists
- return $langs->trans("Module".$this->name."Desc");
- }
- // Last chance with simple label
- return $langs->trans($this->description);
- }
- }
- /**
- * Gives the long description of a module. First check README-la_LA.md then README.md
- * If no markdown files found, it returns translated value of the key ->descriptionlong.
- *
- * @return string Long description of a module from README.md of from property.
- */
- public function getDescLong()
- {
- global $langs;
- $langs->load("admin");
- include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- include_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
- $content='';
- $pathoffile = $this->getDescLongReadmeFound();
- if ($pathoffile) { // Mostly for external modules
- $content = file_get_contents($pathoffile);
- if ((float) DOL_VERSION >= 6.0) {
- @include_once DOL_DOCUMENT_ROOT.'/core/lib/parsemd.lib.php';
- $content = dolMd2Html(
- $content,
- 'parsedown',
- array(
- 'doc/' => dol_buildpath(strtolower($this->name).'/doc/', 1),
- 'img/' => dol_buildpath(strtolower($this->name).'/img/', 1),
- 'images/' => dol_buildpath(strtolower($this->name).'/images/', 1),
- )
- );
- } else {
- $content = nl2br($content);
- }
- } else {
- // Mostly for internal modules
- if (!empty($this->descriptionlong)) {
- if (is_array($this->langfiles)) {
- foreach ($this->langfiles as $val) {
- if ($val) {
- $langs->load($val);
- }
- }
- }
- $content = $langs->transnoentitiesnoconv($this->descriptionlong);
- }
- }
- return $content;
- }
- /**
- * Return path of file if a README file was found.
- *
- * @return string Path of file if a README file was found.
- */
- public function getDescLongReadmeFound()
- {
- global $langs;
- $filefound = false;
- // Define path to file README.md.
- // First check README-la_LA.md then README-la.md then README.md
- $pathoffile = dol_buildpath(strtolower($this->name).'/README-'.$langs->defaultlang.'.md', 0);
- if (dol_is_file($pathoffile)) {
- $filefound = true;
- }
- if (!$filefound) {
- $tmp = explode('_', $langs->defaultlang);
- $pathoffile = dol_buildpath(strtolower($this->name).'/README-'.$tmp[0].'.md', 0);
- if (dol_is_file($pathoffile)) {
- $filefound = true;
- }
- }
- if (!$filefound) {
- $pathoffile = dol_buildpath(strtolower($this->name).'/README.md', 0);
- if (dol_is_file($pathoffile)) {
- $filefound = true;
- }
- }
- return ($filefound ? $pathoffile : '');
- }
- /**
- * Gives the changelog. First check ChangeLog-la_LA.md then ChangeLog.md
- *
- * @return string Content of ChangeLog
- */
- public function getChangeLog()
- {
- global $langs;
- $langs->load("admin");
- include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
- include_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
- $filefound = false;
- // Define path to file README.md.
- // First check ChangeLog-la_LA.md then ChangeLog.md
- $pathoffile = dol_buildpath(strtolower($this->name).'/ChangeLog-'.$langs->defaultlang.'.md', 0);
- if (dol_is_file($pathoffile)) {
- $filefound = true;
- }
- if (!$filefound) {
- $pathoffile = dol_buildpath(strtolower($this->name).'/ChangeLog.md', 0);
- if (dol_is_file($pathoffile)) {
- $filefound = true;
- }
- }
- if ($filefound) { // Mostly for external modules
- $content = file_get_contents($pathoffile);
- if ((float) DOL_VERSION >= 6.0) {
- @include_once DOL_DOCUMENT_ROOT.'/core/lib/parsemd.lib.php';
- $content = dolMd2Html($content, 'parsedown', array('doc/'=>dol_buildpath(strtolower($this->name).'/doc/', 1)));
- } else {
- $content = nl2br($content);
- }
- }
- return $content;
- }
- /**
- * Gives the publisher name
- *
- * @return string Publisher name
- */
- public function getPublisher()
- {
- return $this->editor_name;
- }
- /**
- * Gives the publisher url
- *
- * @return string Publisher url
- */
- public function getPublisherUrl()
- {
- return $this->editor_url;
- }
- /**
- * Gives module version (translated if param $translated is on)
- * For 'experimental' modules, gives 'experimental' translation
- * For 'dolibarr' modules, gives Dolibarr version
- *
- * @param int $translated 1=Special version keys are translated, 0=Special version keys are not translated
- * @return string Module version
- */
- public function getVersion($translated = 1)
- {
- global $langs;
- $langs->load("admin");
- $ret = '';
- $newversion = preg_replace('/_deprecated/', '', $this->version);
- if ($newversion == 'experimental') {
- $ret = ($translated ? $langs->transnoentitiesnoconv("VersionExperimental") : $newversion);
- } elseif ($newversion == 'development') {
- $ret = ($translated ? $langs->transnoentitiesnoconv("VersionDevelopment") : $newversion);
- } elseif ($newversion == 'dolibarr') {
- $ret = DOL_VERSION;
- } elseif ($newversion) {
- $ret = $newversion;
- } else {
- $ret = ($translated ? $langs->transnoentitiesnoconv("VersionUnknown") : 'unknown');
- }
- if (preg_match('/_deprecated/', $this->version)) {
- $ret .= ($translated ? ' ('.$langs->transnoentitiesnoconv("Deprecated").')' : $this->version);
- }
- return $ret;
- }
- /**
- * Gives the module position
- *
- * @return int Module position (an external module should never return a value lower than 100000. 1-100000 are reserved for core)
- */
- public function getModulePosition()
- {
- if (in_array($this->version, array('dolibarr', 'experimental', 'development'))) { // core module
- return $this->module_position;
- } else { // external module
- if ($this->module_position >= 100000) {
- return $this->module_position;
- } else {
- return $this->module_position + 100000;
- }
- }
- }
- /**
- * Tells if module is core or external.
- * 'dolibarr' and 'dolibarr_deprecated' is core
- * 'experimental' and 'development' is core
- *
- * @return string 'core', 'external' or 'unknown'
- */
- public function isCoreOrExternalModule()
- {
- if ($this->version == 'dolibarr' || $this->version == 'dolibarr_deprecated') {
- return 'core';
- }
- if (!empty($this->version) && !in_array($this->version, array('experimental', 'development'))) {
- return 'external';
- }
- if (!empty($this->editor_name) || !empty($this->editor_url)) {
- return 'external';
- }
- if ($this->numero >= 100000) {
- return 'external';
- }
- return 'unknown';
- }
- /**
- * Gives module related language files list
- *
- * @return string[] Language files list
- */
- public function getLangFilesArray()
- {
- return $this->langfiles;
- }
- /**
- * Gives translated label of an export dataset
- *
- * @param int $r Dataset index
- *
- * @return string Translated databaset label
- */
- public function getExportDatasetLabel($r)
- {
- global $langs;
- $langstring = "ExportDataset_".$this->export_code[$r];
- if ($langs->trans($langstring) == $langstring) {
- // Translation not found
- return $langs->trans($this->export_label[$r]);
- } else {
- // Translation found
- return $langs->trans($langstring);
- }
- }
- /**
- * Gives translated label of an import dataset
- *
- * @param int $r Dataset index
- *
- * @return string Translated dataset label
- */
- public function getImportDatasetLabel($r)
- {
- global $langs;
- $langstring = "ImportDataset_".$this->import_code[$r];
- //print "x".$langstring;
- if ($langs->trans($langstring) == $langstring) {
- // Translation not found
- return $langs->transnoentitiesnoconv($this->import_label[$r]);
- } else {
- // Translation found
- return $langs->transnoentitiesnoconv($langstring);
- }
- }
- /**
- * Gives the last date of activation
- *
- * @return int|string Date of last activation or '' if module was never activated
- */
- public function getLastActivationDate()
- {
- global $conf;
- $err = 0;
- $sql = "SELECT tms FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." = '".$this->db->escape($this->const_name)."'";
- $sql .= " AND entity IN (0, ".$conf->entity.")";
- dol_syslog(get_class($this)."::getLastActiveDate", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- } else {
- $obj = $this->db->fetch_object($resql);
- if ($obj) {
- return $this->db->jdate($obj->tms);
- }
- }
- return '';
- }
- /**
- * Gives the last author of activation
- *
- * @return array Array array('authorid'=>Id of last activation user, 'lastactivationdate'=>Date of last activation)
- */
- public function getLastActivationInfo()
- {
- global $conf;
- $err = 0;
- $sql = "SELECT tms, note FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." = '".$this->db->escape($this->const_name)."'";
- $sql .= " AND entity IN (0, ".$conf->entity.")";
- dol_syslog(get_class($this)."::getLastActiveDate", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- } else {
- $obj = $this->db->fetch_object($resql);
- if ($obj) {
- $tmp = array();
- if ($obj->note) {
- $tmp = json_decode($obj->note, true);
- }
- return array(
- 'authorid' => $tmp['authorid'],
- 'ip' => $tmp['ip'],
- 'lastactivationdate' => $this->db->jdate($obj->tms),
- 'lastactivationversion' => (!empty($tmp['lastactivationversion']) ? $tmp['lastactivationversion'] : 'unknown'),
- );
- }
- }
- return array();
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
- /**
- * Insert constants for module activation
- *
- * @return int Error count (0 if OK)
- */
- protected function _active()
- {
- // phpcs:enable
- global $conf, $user;
- $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->db->escape($this->const_name)."'";
- $sql .= " AND entity IN (0, ".$entity.")";
- dol_syslog(get_class($this)."::_active delete activation constant", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- }
- $note = json_encode(
- array(
- 'authorid' => (is_object($user) ? $user->id : 0),
- 'ip' => (empty($_SERVER['REMOTE_ADDR']) ? '' : $_SERVER['REMOTE_ADDR']),
- 'lastactivationversion' => $this->version,
- )
- );
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."const (name, value, visible, entity, note) VALUES";
- $sql .= " (".$this->db->encrypt($this->const_name);
- $sql .= ", ".$this->db->encrypt('1');
- $sql .= ", 0, ".((int) $entity);
- $sql .= ", '".$this->db->escape($note)."')";
- dol_syslog(get_class($this)."::_active insert activation constant", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
- /**
- * Module deactivation
- *
- * @return int Error count (0 if OK)
- */
- protected function _unactive()
- {
- // phpcs:enable
- 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->db->escape($this->const_name)."'";
- $sql .= " AND entity IN (0, ".$entity.")";
- dol_syslog(get_class($this)."::_unactive", LOG_DEBUG);
- $this->db->query($sql);
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps,PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
- /**
- * Create tables and keys required by module:
- * - Files table.sql or table-module.sql with create table instructions
- * - Then table.key.sql or table-module.key.sql with create keys instructions
- * - Then data_xxx.sql (usualy provided by external modules only)
- * - Then update_xxx.sql (usualy provided by external modules only)
- * Files must be stored in subdirectory 'tables' or 'data' into directory $reldir (Example: '/install/mysql/' or '/module/sql/')
- * This function may also be called by :
- * - _load_tables('/install/mysql/', 'modulename') into the this->init() of core module descriptors.
- * - _load_tables('/mymodule/sql/') into the this->init() of external module descriptors.
- *
- * @param string $reldir Relative directory where to scan files. Example: '/install/mysql/' or '/module/sql/'
- * @param string $onlywithsuffix Only with the defined suffix
- * @return int <=0 if KO, >0 if OK
- */
- protected function _load_tables($reldir, $onlywithsuffix = '')
- {
- // phpcs:enable
- global $conf;
- $error = 0;
- $dirfound = 0;
- if (empty($reldir)) {
- return 1;
- }
- include_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
- $ok = 1;
- foreach ($conf->file->dol_document_root as $dirroot) {
- if ($ok) {
- $dirsql = $dirroot.$reldir;
- $ok = 0;
- // We will loop on xxx/, xxx/tables/, xxx/data/
- $listofsubdir = array('', 'tables/', 'data/');
- if ($this->db->type == 'pgsql') {
- $listofsubdir[] = '../pgsql/functions/';
- }
- foreach ($listofsubdir as $subdir) {
- $dir = $dirsql.$subdir;
- $handle = @opendir($dir); // Dir may not exists
- if (is_resource($handle)) {
- $dirfound++;
- // Run llx_mytable.sql files, then llx_mytable_*.sql
- $files = array();
- while (($file = readdir($handle)) !== false) {
- $files[] = $file;
- }
- sort($files);
- foreach ($files as $file) {
- if ($onlywithsuffix) {
- if (!preg_match('/\-'.preg_quote($onlywithsuffix, '/').'\./i', $file)) {
- //print 'File '.$file.' does not match suffix '.$onlywithsuffix.' so it is discarded<br>'."\n";
- continue;
- } else {
- //print 'File '.$file.' match suffix '.$onlywithsuffix.' so we keep it<br>'."\n";
- }
- }
- if (preg_match('/\.sql$/i', $file) && !preg_match('/\.key\.sql$/i', $file) && substr($file, 0, 4) == 'llx_') {
- $result = run_sql($dir.$file, empty($conf->global->MAIN_DISPLAY_SQL_INSTALL_LOG) ? 1 : 0, '', 1);
- if ($result <= 0) {
- $error++;
- }
- }
- }
- rewinddir($handle);
- // Run llx_mytable.key.sql files (Must be done after llx_mytable.sql) then then llx_mytable_*.key.sql
- $files = array();
- while (($file = readdir($handle)) !== false) {
- $files[] = $file;
- }
- sort($files);
- foreach ($files as $file) {
- if ($onlywithsuffix) {
- if (!preg_match('/\-'.preg_quote($onlywithsuffix, '/').'\./i', $file)) {
- //print 'File '.$file.' does not match suffix '.$onlywithsuffix.' so it is discarded<br>'."\n";
- continue;
- } else {
- //print 'File '.$file.' match suffix '.$onlywithsuffix.' so we keep it<br>'."\n";
- }
- }
- if (preg_match('/\.key\.sql$/i', $file) && substr($file, 0, 4) == 'llx_') {
- $result = run_sql($dir.$file, empty($conf->global->MAIN_DISPLAY_SQL_INSTALL_LOG) ? 1 : 0, '', 1);
- if ($result <= 0) {
- $error++;
- }
- }
- }
- rewinddir($handle);
- // Run functions-xxx.sql files (Must be done after llx_mytable.key.sql)
- $files = array();
- while (($file = readdir($handle)) !== false) {
- $files[] = $file;
- }
- sort($files);
- foreach ($files as $file) {
- if ($onlywithsuffix) {
- if (!preg_match('/\-'.preg_quote($onlywithsuffix, '/').'\./i', $file)) {
- //print 'File '.$file.' does not match suffix '.$onlywithsuffix.' so it is discarded<br>'."\n";
- continue;
- } else {
- //print 'File '.$file.' match suffix '.$onlywithsuffix.' so we keep it<br>'."\n";
- }
- }
- if (preg_match('/\.sql$/i', $file) && !preg_match('/\.key\.sql$/i', $file) && substr($file, 0, 9) == 'functions') {
- $result = run_sql($dir.$file, empty($conf->global->MAIN_DISPLAY_SQL_INSTALL_LOG) ? 1 : 0, '', 1);
- if ($result <= 0) {
- $error++;
- }
- }
- }
- rewinddir($handle);
- // Run data_xxx.sql files (Must be done after llx_mytable.key.sql)
- $files = array();
- while (($file = readdir($handle)) !== false) {
- $files[] = $file;
- }
- sort($files);
- foreach ($files as $file) {
- if ($onlywithsuffix) {
- if (!preg_match('/\-'.preg_quote($onlywithsuffix, '/').'\./i', $file)) {
- //print 'File '.$file.' does not match suffix '.$onlywithsuffix.' so it is discarded<br>'."\n";
- continue;
- } else {
- //print 'File '.$file.' match suffix '.$onlywithsuffix.' so we keep it<br>'."\n";
- }
- }
- if (preg_match('/\.sql$/i', $file) && !preg_match('/\.key\.sql$/i', $file) && substr($file, 0, 4) == 'data') {
- $result = run_sql($dir.$file, empty($conf->global->MAIN_DISPLAY_SQL_INSTALL_LOG) ? 1 : 0, '', 1);
- if ($result <= 0) {
- $error++;
- }
- }
- }
- rewinddir($handle);
- // Run update_xxx.sql files
- $files = array();
- while (($file = readdir($handle)) !== false) {
- $files[] = $file;
- }
- sort($files);
- foreach ($files as $file) {
- if ($onlywithsuffix) {
- if (!preg_match('/\-'.preg_quote($onlywithsuffix, '/').'\./i', $file)) {
- //print 'File '.$file.' does not match suffix '.$onlywithsuffix.' so it is discarded<br>'."\n";
- continue;
- } else {
- //print 'File '.$file.' match suffix '.$onlywithsuffix.' so we keep it<br>'."\n";
- }
- }
- if (preg_match('/\.sql$/i', $file) && !preg_match('/\.key\.sql$/i', $file) && substr($file, 0, 6) == 'update') {
- $result = run_sql($dir.$file, empty($conf->global->MAIN_DISPLAY_SQL_INSTALL_LOG) ? 1 : 0, '', 1);
- if ($result <= 0) {
- $error++;
- }
- }
- }
- closedir($handle);
- }
- }
- if ($error == 0) {
- $ok = 1;
- }
- }
- }
- if (!$dirfound) {
- dol_syslog("A module ask to load sql files into ".$reldir." but this directory was not found.", LOG_WARNING);
- }
- return $ok;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds boxes
- *
- * @param string $option Options when disabling module ('newboxdefonly'=insert only boxes definition)
- *
- * @return int Error count (0 if OK)
- */
- public function insert_boxes($option = '')
- {
- // phpcs:enable
- include_once DOL_DOCUMENT_ROOT.'/core/class/infobox.class.php';
- global $conf;
- $err = 0;
- if (is_array($this->boxes)) {
- dol_syslog(get_class($this)."::insert_boxes", LOG_DEBUG);
- $pos_name = InfoBox::getListOfPagesForBoxes();
- foreach ($this->boxes as $key => $value) {
- $file = isset($this->boxes[$key]['file']) ? $this->boxes[$key]['file'] : '';
- $note = isset($this->boxes[$key]['note']) ? $this->boxes[$key]['note'] : '';
- $enabledbydefaulton = isset($this->boxes[$key]['enabledbydefaulton']) ? $this->boxes[$key]['enabledbydefaulton'] : 'Home';
- if (empty($file)) {
- $file = isset($this->boxes[$key][1]) ? $this->boxes[$key][1] : ''; // For backward compatibility
- }
- if (empty($note)) {
- $note = isset($this->boxes[$key][2]) ? $this->boxes[$key][2] : ''; // For backward compatibility
- }
- // Search if boxes def already present
- $sql = "SELECT count(*) as nb FROM ".MAIN_DB_PREFIX."boxes_def";
- $sql .= " WHERE file = '".$this->db->escape($file)."'";
- $sql .= " AND entity = ".$conf->entity;
- if ($note) {
- $sql .= " AND note ='".$this->db->escape($note)."'";
- }
- $result = $this->db->query($sql);
- if ($result) {
- $obj = $this->db->fetch_object($result);
- if ($obj->nb == 0) {
- $this->db->begin();
- if (!$err) {
- $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", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- }
- }
- if (!$err && !preg_match('/newboxdefonly/', $option)) {
- $lastid = $this->db->last_insert_id(MAIN_DB_PREFIX."boxes_def", "rowid");
- foreach ($pos_name as $key2 => $val2) {
- //print 'key2='.$key2.'-val2='.$val2."<br>\n";
- if ($enabledbydefaulton && $val2 != $enabledbydefaulton) {
- continue; // Not enabled by default onto this page.
- }
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."boxes (box_id, position, box_order, fk_user, entity)";
- $sql .= " VALUES (".((int) $lastid).", ".((int) $key2).", '0', 0, ".((int) $conf->entity).")";
- dol_syslog(get_class($this)."::insert_boxes onto page ".$key2."=".$val2."", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- }
- }
- }
- if (!$err) {
- $this->db->commit();
- } else {
- $this->error = $this->db->lasterror();
- $this->db->rollback();
- }
- }
- // else box already registered into database
- } else {
- $this->error = $this->db->lasterror();
- $err++;
- }
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes boxes
- *
- * @return int Error count (0 if OK)
- */
- public function delete_boxes()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- if (is_array($this->boxes)) {
- foreach ($this->boxes as $key => $value) {
- //$titre = $this->boxes[$key][0];
- if (empty($this->boxes[$key]['file'])) {
- $file = isset($this->boxes[$key][1]) ? $this->boxes[$key][1] : ''; // For backward compatibility
- } else {
- $file = $this->boxes[$key]['file'];
- }
- //$note = $this->boxes[$key][2];
- // TODO If the box is also included by another module and the other module is still on, we should not remove it.
- // For the moment, we manage this with hard coded exception
- //print "Remove box ".$file.'<br>';
- if ($file == 'box_graph_product_distribution.php') {
- if (!empty($conf->product->enabled) || !empty($conf->service->enabled)) {
- dol_syslog("We discard deleting module ".$file." because another module still active requires it.");
- continue;
- }
- }
- if ($this->db->type == 'sqlite3') {
- // sqlite doesn't support "USING" syntax.
- // TODO: remove this dependency.
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."boxes ";
- $sql .= "WHERE ".MAIN_DB_PREFIX."boxes.box_id IN (";
- $sql .= "SELECT ".MAIN_DB_PREFIX."boxes_def.rowid ";
- $sql .= "FROM ".MAIN_DB_PREFIX."boxes_def ";
- $sql .= "WHERE ".MAIN_DB_PREFIX."boxes_def.file = '".$this->db->escape($file)."') ";
- $sql .= "AND ".MAIN_DB_PREFIX."boxes.entity = ".$conf->entity;
- } else {
- $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.entity = ".$conf->entity;
- }
- dol_syslog(get_class($this)."::delete_boxes", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."boxes_def";
- $sql .= " WHERE file = '".$this->db->escape($file)."'";
- $sql .= " AND entity = ".$conf->entity; // Do not use getEntity here, we want to delete only in current company
- dol_syslog(get_class($this)."::delete_boxes", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds cronjobs
- *
- * @return int Error count (0 if OK)
- */
- public function insert_cronjobs()
- {
- // phpcs:enable
- include_once DOL_DOCUMENT_ROOT.'/core/class/infobox.class.php';
- global $conf;
- $err = 0;
- if (is_array($this->cronjobs)) {
- dol_syslog(get_class($this)."::insert_cronjobs", LOG_DEBUG);
- foreach ($this->cronjobs as $key => $value) {
- $entity = isset($this->cronjobs[$key]['entity']) ? $this->cronjobs[$key]['entity'] : $conf->entity;
- $label = isset($this->cronjobs[$key]['label']) ? $this->cronjobs[$key]['label'] : '';
- $jobtype = isset($this->cronjobs[$key]['jobtype']) ? $this->cronjobs[$key]['jobtype'] : '';
- $class = isset($this->cronjobs[$key]['class']) ? $this->cronjobs[$key]['class'] : '';
- $objectname = isset($this->cronjobs[$key]['objectname']) ? $this->cronjobs[$key]['objectname'] : '';
- $method = isset($this->cronjobs[$key]['method']) ? $this->cronjobs[$key]['method'] : '';
- $command = isset($this->cronjobs[$key]['command']) ? $this->cronjobs[$key]['command'] : '';
- $parameters = isset($this->cronjobs[$key]['parameters']) ? $this->cronjobs[$key]['parameters'] : '';
- $comment = isset($this->cronjobs[$key]['comment']) ? $this->cronjobs[$key]['comment'] : '';
- $frequency = isset($this->cronjobs[$key]['frequency']) ? $this->cronjobs[$key]['frequency'] : '';
- $unitfrequency = isset($this->cronjobs[$key]['unitfrequency']) ? $this->cronjobs[$key]['unitfrequency'] : '';
- $priority = isset($this->cronjobs[$key]['priority']) ? $this->cronjobs[$key]['priority'] : '';
- $datestart = isset($this->cronjobs[$key]['datestart']) ? $this->cronjobs[$key]['datestart'] : '';
- $dateend = isset($this->cronjobs[$key]['dateend']) ? $this->cronjobs[$key]['dateend'] : '';
- $status = isset($this->cronjobs[$key]['status']) ? $this->cronjobs[$key]['status'] : '';
- $test = isset($this->cronjobs[$key]['test']) ? $this->cronjobs[$key]['test'] : ''; // Line must be enabled or not (so visible or not)
- // Search if cron entry already present
- $sql = "SELECT count(*) as nb FROM ".MAIN_DB_PREFIX."cronjob";
- $sql .= " WHERE module_name = '".$this->db->escape(empty($this->rights_class) ?strtolower($this->name) : $this->rights_class)."'";
- if ($class) {
- $sql .= " AND classesname = '".$this->db->escape($class)."'";
- }
- if ($objectname) {
- $sql .= " AND objectname = '".$this->db->escape($objectname)."'";
- }
- if ($method) {
- $sql .= " AND methodename = '".$this->db->escape($method)."'";
- }
- if ($command) {
- $sql .= " AND command = '".$this->db->escape($command)."'";
- }
- if ($parameters) {
- $sql .= " AND params = '".$this->db->escape($parameters)."'";
- }
- $sql .= " AND entity = ".((int) $entity); // Must be exact entity
- $now = dol_now();
- $result = $this->db->query($sql);
- if ($result) {
- $obj = $this->db->fetch_object($result);
- if ($obj->nb == 0) {
- $this->db->begin();
- if (!$err) {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."cronjob (module_name, datec, datestart, dateend, label, jobtype, classesname, objectname, methodename, command, params, note,";
- if (is_int($frequency)) {
- $sql .= ' frequency,';
- }
- if (is_int($unitfrequency)) {
- $sql .= ' unitfrequency,';
- }
- if (is_int($priority)) {
- $sql .= ' priority,';
- }
- if (is_int($status)) {
- $sql .= ' status,';
- }
- $sql .= " entity, test)";
- $sql .= " VALUES (";
- $sql .= "'".$this->db->escape(empty($this->rights_class) ?strtolower($this->name) : $this->rights_class)."', ";
- $sql .= "'".$this->db->idate($now)."', ";
- $sql .= ($datestart ? "'".$this->db->idate($datestart)."'" : "'".$this->db->idate($now)."'").", ";
- $sql .= ($dateend ? "'".$this->db->idate($dateend)."'" : "NULL").", ";
- $sql .= "'".$this->db->escape($label)."', ";
- $sql .= "'".$this->db->escape($jobtype)."', ";
- $sql .= ($class ? "'".$this->db->escape($class)."'" : "null").",";
- $sql .= ($objectname ? "'".$this->db->escape($objectname)."'" : "null").",";
- $sql .= ($method ? "'".$this->db->escape($method)."'" : "null").",";
- $sql .= ($command ? "'".$this->db->escape($command)."'" : "null").",";
- $sql .= ($parameters ? "'".$this->db->escape($parameters)."'" : "null").",";
- $sql .= ($comment ? "'".$this->db->escape($comment)."'" : "null").",";
- if (is_int($frequency)) {
- $sql .= "'".$this->db->escape($frequency)."', ";
- }
- if (is_int($unitfrequency)) {
- $sql .= "'".$this->db->escape($unitfrequency)."', ";
- }
- if (is_int($priority)) {
- $sql .= "'".$this->db->escape($priority)."', ";
- }
- if (is_int($status)) {
- $sql .= "'".$this->db->escape($status)."', ";
- }
- $sql .= $entity.",";
- $sql .= "'".$this->db->escape($test)."'";
- $sql .= ")";
- $resql = $this->db->query($sql);
- if (!$resql) {
- $err++;
- }
- }
- if (!$err) {
- $this->db->commit();
- } else {
- $this->error = $this->db->lasterror();
- $this->db->rollback();
- }
- }
- // else box already registered into database
- } else {
- $this->error = $this->db->lasterror();
- $err++;
- }
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes boxes
- *
- * @return int Error count (0 if OK)
- */
- public function delete_cronjobs()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- if (is_array($this->cronjobs)) {
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."cronjob";
- $sql .= " WHERE module_name = '".$this->db->escape(empty($this->rights_class) ?strtolower($this->name) : $this->rights_class)."'";
- $sql .= " AND entity = ".$conf->entity;
- $sql .= " AND test = '1'"; // We delete on lines that are not set with a complete test that is '$conf->module->enabled' so when module is disabled, the cron is also removed.
- // For crons declared with a '$conf->module->enabled', there is no need to delete the line, so we don't loose setup if we reenable module.
- dol_syslog(get_class($this)."::delete_cronjobs", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes tabs
- *
- * @return int Error count (0 if OK)
- */
- public function delete_tabs()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." like '".$this->db->escape($this->const_name)."_TABS_%'";
- $sql .= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_tabs", LOG_DEBUG);
- if (!$this->db->query($sql)) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds tabs
- *
- * @return int Error count (0 if ok)
- */
- public function insert_tabs()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- if (!empty($this->tabs)) {
- dol_syslog(get_class($this)."::insert_tabs", LOG_DEBUG);
- $i = 0;
- foreach ($this->tabs as $key => $value) {
- if (is_array($value) && count($value) == 0) {
- continue; // Discard empty arrays
- }
- $entity = $conf->entity;
- $newvalue = $value;
- if (is_array($value)) {
- $newvalue = $value['data'];
- if (isset($value['entity'])) {
- $entity = $value['entity'];
- }
- }
- if ($newvalue) {
- $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);
- $sql .= ", 'chaine'";
- $sql .= ", ".$this->db->encrypt($newvalue);
- $sql .= ", null";
- $sql .= ", '0'";
- $sql .= ", ".((int) $entity);
- $sql .= ")";
- $resql = $this->db->query($sql);
- if (!$resql) {
- dol_syslog($this->db->lasterror(), LOG_ERR);
- if ($this->db->lasterrno() != 'DB_ERROR_RECORD_ALREADY_EXISTS') {
- $this->error = $this->db->lasterror();
- $this->errors[] = $this->db->lasterror();
- $err++;
- break;
- }
- }
- }
- $i++;
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds constants
- *
- * @return int Error count (0 if OK)
- */
- public function insert_const()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- if (empty($this->const)) {
- return 0;
- }
- dol_syslog(get_class($this)."::insert_const", LOG_DEBUG);
- 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 != '0') {
- $val = '';
- }
- $sql = "SELECT count(*)";
- $sql .= " FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." = '".$this->db->escape($name)."'";
- $sql .= " AND entity = ".((int) $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);
- $sql .= ",'".$this->db->escape($type)."'";
- $sql .= ",".(($val != '') ? $this->db->encrypt($val) : "''");
- $sql .= ",".($note ? "'".$this->db->escape($note)."'" : "null");
- $sql .= ",'".$this->db->escape($visible)."'";
- $sql .= ",".$entity;
- $sql .= ")";
- if (!$this->db->query($sql)) {
- $err++;
- }
- } else {
- dol_syslog(get_class($this)."::insert_const constant '".$name."' already exists", LOG_WARNING);
- }
- } else {
- $err++;
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes constants tagged 'deleteonunactive'
- *
- * @return int <0 if KO, 0 if OK
- */
- public function delete_const()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- if (empty($this->const)) {
- return 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')." = '".$this->db->escape($name)."'";
- $sql .= " AND entity in (0, ".$conf->entity.")";
- dol_syslog(get_class($this)."::delete_const", LOG_DEBUG);
- if (!$this->db->query($sql)) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds access rights
- *
- * @param int $reinitadminperms If 1, we also grant them to all admin users
- * @param int $force_entity Force current entity
- * @param int $notrigger 1=Does not execute triggers, 0= execute triggers
- * @return int Error count (0 if OK)
- */
- public function insert_permissions($reinitadminperms = 0, $force_entity = null, $notrigger = 0)
- {
- // phpcs:enable
- global $conf, $user;
- $err = 0;
- $entity = (!empty($force_entity) ? $force_entity : $conf->entity);
- dol_syslog(get_class($this)."::insert_permissions", LOG_DEBUG);
- // 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->db->escape($this->const_name)."'";
- $sql_del .= " AND entity IN (0,".$entity.")";
- $resql = $this->db->query($sql_del);
- if ($resql) {
- $obj = $this->db->fetch_object($resql);
- if ($obj !== null && !empty($obj->value) && !empty($this->rights)) {
- include_once DOL_DOCUMENT_ROOT.'/user/class/user.class.php';
- // If the module is active
- foreach ($this->rights as $key => $value) {
- $r_id = $this->rights[$key][0]; // permission id in llx_rights_def (not unique because primary key is couple id-entity)
- $r_desc = $this->rights[$key][1];
- $r_type = isset($this->rights[$key][2]) ? $this->rights[$key][2] : '';
- $r_def = empty($this->rights[$key][3]) ? 0 : $this->rights[$key][3];
- $r_perms = $this->rights[$key][4];
- $r_subperms = isset($this->rights[$key][5]) ? $this->rights[$key][5] : '';
- $r_modul = empty($this->rights_class) ? strtolower($this->name) : $this->rights_class;
- if (empty($r_type)) {
- $r_type = 'w';
- }
- // Search if perm already present
- $sql = "SELECT count(*) as nb FROM ".MAIN_DB_PREFIX."rights_def";
- $sql .= " WHERE id = ".((int) $r_id)." AND entity = ".((int) $entity);
- $resqlselect = $this->db->query($sql);
- if ($resqlselect) {
- $objcount = $this->db->fetch_object($resqlselect);
- if ($objcount && $objcount->nb == 0) {
- 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.",".$entity.",'".$this->db->escape($r_desc)."','".$this->db->escape($r_modul)."','".$this->db->escape($r_type)."',".$r_def.",'".$this->db->escape($r_perms)."','".$this->db->escape($r_subperms)."')";
- } else {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."rights_def";
- $sql .= " (id, entity, libelle, module, type, bydefault, perms)";
- $sql .= " VALUES ";
- $sql .= "(".$r_id.",".$entity.",'".$this->db->escape($r_desc)."','".$this->db->escape($r_modul)."','".$this->db->escape($r_type)."',".$r_def.",'".$this->db->escape($r_perms)."')";
- }
- } else {
- $sql = "INSERT INTO ".MAIN_DB_PREFIX."rights_def ";
- $sql .= " (id, entity, libelle, module, type, bydefault)";
- $sql .= " VALUES ";
- $sql .= "(".$r_id.",".$entity.",'".$this->db->escape($r_desc)."','".$this->db->escape($r_modul)."','".$this->db->escape($r_type)."',".$r_def.")";
- }
- $resqlinsert = $this->db->query($sql, 1);
- if (!$resqlinsert) {
- if ($this->db->errno() != "DB_ERROR_RECORD_ALREADY_EXISTS") {
- $this->error = $this->db->lasterror();
- $err++;
- break;
- } else {
- dol_syslog(get_class($this)."::insert_permissions record already exists", LOG_INFO);
- }
- }
- $this->db->free($resqlinsert);
- }
- $this->db->free($resqlselect);
- }
- // If we want to init permissions on admin users
- if ($reinitadminperms) {
- $sql = "SELECT rowid FROM ".MAIN_DB_PREFIX."user WHERE admin = 1";
- dol_syslog(get_class($this)."::insert_permissions Search all admin users", LOG_DEBUG);
- $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 id '.$r_id.' to user id=".$obj2->rowid);
- $tmpuser = new User($this->db);
- $result = $tmpuser->fetch($obj2->rowid);
- if ($result > 0) {
- $tmpuser->addrights($r_id, '', '', 0, 1);
- } else {
- dol_syslog(get_class($this)."::insert_permissions Failed to add the permission to user because fetch return an error", LOG_ERR);
- }
- $i++;
- }
- } else {
- dol_print_error($this->db);
- }
- }
- }
- if ($reinitadminperms && !empty($user->admin)) { // Reload permission for current user if defined
- // We reload permissions
- $user->clearrights();
- $user->getrights();
- }
- }
- $this->db->free($resql);
- } else {
- $this->error = $this->db->lasterror();
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes access rights
- *
- * @return int Error count (0 if OK)
- */
- public function delete_permissions()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."rights_def";
- $sql .= " WHERE module = '".$this->db->escape(empty($this->rights_class) ?strtolower($this->name) : $this->rights_class)."'";
- $sql .= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_permissions", LOG_DEBUG);
- if (!$this->db->query($sql)) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds menu entries
- *
- * @return int Error count (0 if OK)
- */
- public function insert_menus()
- {
- // phpcs:enable
- global $user;
- if (!is_array($this->menu) || empty($this->menu)) {
- return 0;
- }
- include_once DOL_DOCUMENT_ROOT.'/core/class/menubase.class.php';
- dol_syslog(get_class($this)."::insert_menus", LOG_DEBUG);
- $err = 0;
- $this->db->begin();
- foreach ($this->menu as $key => $value) {
- $menu = new Menubase($this->db);
- $menu->menu_handler = 'all';
- //$menu->module=strtolower($this->name); TODO When right_class will be same than module name
- $menu->module = empty($this->rights_class) ?strtolower($this->name) : $this->rights_class;
- if (!$this->menu[$key]['fk_menu']) {
- $menu->fk_menu = 0;
- } else {
- $foundparent = 0;
- $fk_parent = $this->menu[$key]['fk_menu'];
- if (preg_match('/^r=/', $fk_parent)) { // old deprecated method
- $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('/^fk_mainmenu=([a-zA-Z0-9_]+),fk_leftmenu=([a-zA-Z0-9_]+)$/', $fk_parent, $reg)) {
- $menu->fk_menu = -1;
- $menu->fk_mainmenu = $reg[1];
- $menu->fk_leftmenu = $reg[2];
- $foundparent = 1;
- } elseif (preg_match('/^fk_mainmenu=([a-zA-Z0-9_]+)$/', $fk_parent, $reg)) {
- $menu->fk_menu = -1;
- $menu->fk_mainmenu = $reg[1];
- $menu->fk_leftmenu = '';
- $foundparent = 1;
- }
- if (!$foundparent) {
- $this->error = "ErrorBadDefinitionOfMenuArrayInModuleDescriptor";
- 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 = isset($this->menu[$key]['mainmenu']) ? $this->menu[$key]['mainmenu'] : (isset($menu->fk_mainmenu) ? $menu->fk_mainmenu : '');
- $menu->leftmenu = isset($this->menu[$key]['leftmenu']) ? $this->menu[$key]['leftmenu'] : '';
- $menu->title = $this->menu[$key]['titre'];
- $menu->prefix = isset($this->menu[$key]['prefix']) ? $this->menu[$key]['prefix'] : '';
- $menu->url = $this->menu[$key]['url'];
- $menu->langs = isset($this->menu[$key]['langs']) ? $this->menu[$key]['langs'] : '';
- $menu->position = $this->menu[$key]['position'];
- $menu->perms = $this->menu[$key]['perms'];
- $menu->target = isset($this->menu[$key]['target']) ? $this->menu[$key]['target'] : '';
- $menu->user = $this->menu[$key]['user'];
- $menu->enabled = isset($this->menu[$key]['enabled']) ? $this->menu[$key]['enabled'] : 0;
- $menu->position = $this->menu[$key]['position'];
- if (!$err) {
- $result = $menu->create($user); // Save menu entry into table llx_menu
- if ($result > 0) {
- $this->menu[$key]['rowid'] = $result;
- } else {
- $this->error = $menu->error;
- dol_syslog(get_class($this).'::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;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes menu entries
- *
- * @return int Error count (0 if OK)
- */
- public function delete_menus()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- //$module=strtolower($this->name); TODO When right_class will be same than module name
- $module = empty($this->rights_class) ?strtolower($this->name) : $this->rights_class;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."menu";
- $sql .= " WHERE module = '".$this->db->escape($module)."'";
- $sql .= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_menus", LOG_DEBUG);
- $resql = $this->db->query($sql);
- if (!$resql) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Creates directories
- *
- * @return int Error count (0 if OK)
- */
- public function create_dirs()
- {
- // phpcs:enable
- global $langs, $conf;
- $err = 0;
- if (isset($this->dirs) && 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 (!empty($forcename)) {
- $constname = 'MAIN_MODULE_'.$forcename."_DIR_";
- }
- if (!empty($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 (!empty($fulldir) && !file_exists($fulldir)) {
- if (dol_mkdir($fulldir, DOL_DATA_ROOT) < 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 (!empty($addtodatabase)) {
- $result = $this->insert_dirs($name, $dir);
- if ($result) {
- $err++;
- }
- }
- }
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds directories definitions
- *
- * @param string $name Name
- * @param string $dir Directory
- *
- * @return int Error count (0 if OK)
- */
- public function insert_dirs($name, $dir)
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- $sql = "SELECT count(*)";
- $sql .= " FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." = '".$this->db->escape($name)."'";
- $sql .= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::insert_dirs", LOG_DEBUG);
- $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).", 'chaine', ".$this->db->encrypt($dir).", '".$this->db->escape("Directory for module ".$this->name)."', '0', ".((int) $conf->entity).")";
- dol_syslog(get_class($this)."::insert_dirs", LOG_DEBUG);
- $this->db->query($sql);
- }
- } else {
- $this->error = $this->db->lasterror();
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes directories
- *
- * @return int Error count (0 if OK)
- */
- public function delete_dirs()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." LIKE '".$this->db->escape($this->const_name)."_DIR_%'";
- $sql .= " AND entity = ".$conf->entity;
- dol_syslog(get_class($this)."::delete_dirs", LOG_DEBUG);
- if (!$this->db->query($sql)) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- return $err;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Adds generic parts
- *
- * @return int Error count (0 if OK)
- */
- public function insert_module_parts()
- {
- // phpcs:enable
- global $conf;
- $error = 0;
- if (is_array($this->module_parts) && !empty($this->module_parts)) {
- foreach ($this->module_parts as $key => $value) {
- if (is_array($value) && count($value) == 0) {
- continue; // Discard empty arrays
- }
- $entity = $conf->entity; // Reset the current entity
- $newvalue = $value;
- // Serialize array parameters
- if (is_array($value)) {
- // Can defined other parameters
- // Example when $key='hooks', then $value is an array('data'=>array('hookcontext1','hookcontext2'), 'entity'=>X)
- if (isset($value['data']) && is_array($value['data'])) {
- $newvalue = json_encode($value['data']);
- if (isset($value['entity'])) {
- $entity = $value['entity'];
- }
- } elseif (isset($value['data']) && !is_array($value['data'])) {
- $newvalue = $value['data'];
- if (isset($value['entity'])) {
- $entity = $value['entity'];
- }
- } else { // when hook is declared with syntax 'hook'=>array('hookcontext1','hookcontext2',...)
- $newvalue = json_encode($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."_".strtoupper($key));
- $sql .= ", 'chaine'";
- $sql .= ", ".$this->db->encrypt($newvalue);
- $sql .= ", null";
- $sql .= ", '0'";
- $sql .= ", ".((int) $entity);
- $sql .= ")";
- dol_syslog(get_class($this)."::insert_module_parts for key=".$this->const_name."_".strtoupper($key), LOG_DEBUG);
- $resql = $this->db->query($sql, 1);
- if (!$resql) {
- if ($this->db->lasterrno() != 'DB_ERROR_RECORD_ALREADY_EXISTS') {
- $error++;
- $this->error = $this->db->lasterror();
- } else {
- dol_syslog(get_class($this)."::insert_module_parts for ".$this->const_name."_".strtoupper($key)." Record already exists.", LOG_WARNING);
- }
- }
- }
- }
- return $error;
- }
- // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
- /**
- * Removes generic parts
- *
- * @return int Error count (0 if OK)
- */
- public function delete_module_parts()
- {
- // phpcs:enable
- global $conf;
- $err = 0;
- $entity = $conf->entity;
- if (is_array($this->module_parts) && !empty($this->module_parts)) {
- dol_syslog(get_class($this)."::delete_module_parts", LOG_DEBUG);
- foreach ($this->module_parts as $key => $value) {
- // If entity is defined
- if (is_array($value) && isset($value['entity'])) {
- $entity = $value['entity'];
- }
- $sql = "DELETE FROM ".MAIN_DB_PREFIX."const";
- $sql .= " WHERE ".$this->db->decrypt('name')." LIKE '".$this->db->escape($this->const_name)."_".strtoupper($key)."'";
- $sql .= " AND entity = ".((int) $entity);
- if (!$this->db->query($sql)) {
- $this->error = $this->db->lasterror();
- $err++;
- }
- }
- }
- return $err;
- }
- /**
- * Function called when module is enabled.
- * The init function adds tabs, constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
- * It also creates data directories
- *
- * @param string $options Options when enabling module ('', 'newboxdefonly', 'noboxes', 'menuonly')
- * 'noboxes' = Do not insert boxes 'newboxdefonly' = For boxes, insert def of boxes only and not boxes activation
- * @return int 1 if OK, 0 if KO
- */
- public function init($options = '')
- {
- return $this->_init(array(), $options);
- }
- /**
- * Function called when module is disabled.
- * The remove function removes tabs, constants, boxes, permissions and menus from Dolibarr database.
- * Data directories are not deleted
- *
- * @param string $options Options when enabling module ('', 'noboxes')
- * @return int 1 if OK, 0 if KO
- */
- public function remove($options = '')
- {
- return $this->_remove(array(), $options);
- }
- /**
- * Return Kanban view of a module
- *
- * @param string $codeenabledisable HTML code for button to enable/disable module
- * @param string $codetoconfig HTML code to go to config page
- * @return string HTML code of Kanban view
- */
- public function getKanbanView($codeenabledisable = '', $codetoconfig = '')
- {
- global $conf, $langs;
- // Define imginfo
- $imginfo = "info";
- if ($this->isCoreOrExternalModule() == 'external') {
- $imginfo = "info_black";
- }
- $const_name = 'MAIN_MODULE_'.strtoupper(preg_replace('/^mod/i', '', get_class($this)));
- $version = $this->getVersion(0);
- $versiontrans = '';
- if (preg_match('/development/i', $version)) {
- $versiontrans .= 'warning';
- }
- if (preg_match('/experimental/i', $version)) {
- $versiontrans .= 'warning';
- }
- if (preg_match('/deprecated/i', $version)) {
- $versiontrans .= 'warning';
- }
- print '
- <div class="box-flex-item info-box-module'
- .(empty($conf->global->$const_name) ? ' --disabled' : '')
- .($this->isCoreOrExternalModule() == 'external' ? ' --external' : '')
- .($this->needUpdate ? ' --need-update' : '')
- .'">
- <div class="info-box info-box-sm info-box-module">
- <div class="info-box-icon'.(empty($conf->global->$const_name) ? '' : ' info-box-icon-module-enabled'.($versiontrans ? ' info-box-icon-module-warning' : '')).'">';
- $alttext = '';
- //if (is_array($objMod->need_dolibarr_version)) $alttext.=($alttext?' - ':'').'Dolibarr >= '.join('.',$objMod->need_dolibarr_version);
- //if (is_array($objMod->phpmin)) $alttext.=($alttext?' - ':'').'PHP >= '.join('.',$objMod->phpmin);
- if (!empty($this->picto)) {
- if (preg_match('/^\//i', $this->picto)) {
- print img_picto($alttext, $this->picto, 'class="inline-block valignmiddle"', 1);
- } else {
- print img_object($alttext, $this->picto, 'class="inline-block valignmiddle"');
- }
- } else {
- print img_object($alttext, 'generic', 'class="inline-block valignmiddle"');
- }
- if ($this->isCoreOrExternalModule() == 'external' || preg_match('/development|experimental|deprecated/i', $version)) {
- $versionTitle = $langs->trans("Version").' '.$this->getVersion(1);
- if ($this->needUpdate) {
- $versionTitle.= '<br>'.$langs->trans('ModuleUpdateAvailable').' : '.$this->lastVersion;
- }
- print '<span class="info-box-icon-version'.($versiontrans ? ' '.$versiontrans : '').' classfortooltip" title="'.dol_escape_js($versionTitle).'" >';
- print $this->getVersion(1);
- print '</span>';
- }
- print '</div>
- <div class="info-box-content info-box-text-module'.(empty($conf->global->$const_name) ? '' : ' info-box-module-enabled'.($versiontrans ? ' info-box-content-warning' : '')).'">
- <span class="info-box-title">'.$this->getName().'</span>
- <span class="info-box-desc twolinesmax opacitymedium" title="'.dol_escape_htmltag($this->getDesc()).'">'.nl2br($this->getDesc()).'</span>';
- print '<div class="valignmiddle inline-block info-box-more">';
- //if ($versiontrans) print img_warning($langs->trans("Version").' '.$this->getVersion(1)).' ';
- print '<a class="valignmiddle inline-block" href="javascript:document_preview(\''.DOL_URL_ROOT.'/admin/modulehelp.php?id='.$this->numero.'\',\'text/html\',\''.dol_escape_js($langs->trans("Module")).'\')">'.img_picto(($this->isCoreOrExternalModule() == 'external' ? $langs->trans("ExternalModule").' - ' : '').$langs->trans("ClickToShowDescription"), $imginfo).'</a>';
- print '</div><br>';
- print '<div class="valignmiddle inline-block info-box-actions">';
- print '<div class="valignmiddle inline-block info-box-setup">';
- print $codetoconfig;
- print '</div>';
- print '<div class="valignmiddle inline-block marginleftonly marginrightonly">';
- print $codeenabledisable;
- print '</div>';
- print '</div>';
- print '
- </div><!-- /.info-box-content -->
- </div><!-- /.info-box -->
- </div>';
- }
- /**
- * Check for module update
- * TODO : store results for $this->url_last_version and $this->needUpdate
- * Add a cron task to monitor for updates
- *
- * @return int <0 if Error, 0 == no update needed, >0 if need update
- */
- public function checkForUpdate()
- {
- require_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
- if (!empty($this->url_last_version)) {
- $lastVersion = getURLContent($this->url_last_version, 'GET', '', 1, array(), array('http', 'https'), 0); // Accept http or https links on external remote server only
- if (isset($lastVersion['content']) && strlen($lastVersion['content']) < 30) {
- // Security warning : be careful with remote data content, the module editor could be hacked (or evil) so limit to a-z A-Z 0-9 _ . -
- $this->lastVersion = preg_replace("/[^a-zA-Z0-9_\.\-]+/", "", $lastVersion['content']);
- if (version_compare($this->lastVersion, $this->version) > 0) {
- $this->needUpdate = true;
- return 1;
- } else {
- $this->needUpdate = false;
- return 0;
- }
- } else {
- return -1;
- }
- }
- return 0;
- }
- }
|