modWebhook.class.php 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526
  1. <?php
  2. /* Copyright (C) 2004-2022 Laurent Destailleur <eldy@users.sourceforge.net>
  3. * Copyright (C) 2018-2019 Nicolas ZABOURI <info@inovea-conseil.com>
  4. * Copyright (C) 2019-2020 Frédéric France <frederic.france@netlogic.fr>
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  18. */
  19. /**
  20. * \defgroup webhook Module Webhook
  21. * \brief Webhook module descriptor.
  22. *
  23. * \file htdocs/webhook/core/modules/modWebhook.class.php
  24. * \ingroup webhook
  25. * \brief Description and activation file for module Webhook
  26. */
  27. include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
  28. /**
  29. * Description and activation class for module Webhook
  30. */
  31. class modWebhook extends DolibarrModules
  32. {
  33. /**
  34. * Constructor. Define names, constants, directories, boxes, permissions
  35. *
  36. * @param DoliDB $db Database handler
  37. */
  38. public function __construct($db)
  39. {
  40. global $langs, $conf;
  41. $this->db = $db;
  42. // Id for module (must be unique).
  43. // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
  44. $this->numero = 68305; // TODO Go on page https://wiki.dolibarr.org/index.php/List_of_modules_id to reserve an id number for your module
  45. // Key text used to identify module (for permissions, menus, etc...)
  46. $this->rights_class = 'webhook';
  47. // Family can be 'base' (core modules),'crm','financial','hr','projects','products','ecm','technic' (transverse modules),'interface' (link with external tools),'other','...'
  48. // It is used to group modules by family in module setup page
  49. $this->family = "interface";
  50. // Module position in the family on 2 digits ('01', '10', '20', ...)
  51. $this->module_position = '90';
  52. // Gives the possibility for the module, to provide his own family info and position of this family (Overwrite $this->family and $this->module_position. Avoid this)
  53. //$this->familyinfo = array('myownfamily' => array('position' => '01', 'label' => $langs->trans("MyOwnFamily")));
  54. // Module label (no space allowed), used if translation string 'ModuleWebhookName' not found (Webhook is name of module).
  55. $this->name = preg_replace('/^mod/i', '', get_class($this));
  56. // Module description, used if translation string 'ModuleWebhookDesc' not found (Webhook is name of module).
  57. $this->description = "WebhookDescription";
  58. // Used only if file README.md and README-LL.md not found.
  59. $this->descriptionlong = "WebhookDescription";
  60. // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
  61. $this->version = 'experimental';
  62. // Url to the file with your last numberversion of this module
  63. //$this->url_last_version = 'http://www.example.com/versionmodule.txt';
  64. // Key used in llx_const table to save module status enabled/disabled (where WEBHOOK is value of property name of module in uppercase)
  65. $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
  66. // Name of image file used for this module.
  67. // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
  68. // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
  69. // To use a supported fa-xxx css style of font awesome, use this->picto='xxx'
  70. $this->picto = 'webhook';
  71. // Define some features supported by module (triggers, login, substitutions, menus, css, etc...)
  72. $this->module_parts = array(
  73. // Set this to 1 if module has its own trigger directory (core/triggers)
  74. 'triggers' => 1,
  75. // Set this to 1 if module has its own login method file (core/login)
  76. 'login' => 0,
  77. // Set this to 1 if module has its own substitution function file (core/substitutions)
  78. 'substitutions' => 0,
  79. // Set this to 1 if module has its own menus handler directory (core/menus)
  80. 'menus' => 0,
  81. // Set this to 1 if module overwrite template dir (core/tpl)
  82. 'tpl' => 0,
  83. // Set this to 1 if module has its own barcode directory (core/modules/barcode)
  84. 'barcode' => 0,
  85. // Set this to 1 if module has its own models directory (core/modules/xxx)
  86. 'models' => 1,
  87. // Set this to 1 if module has its own printing directory (core/modules/printing)
  88. 'printing' => 0,
  89. // Set this to 1 if module has its own theme directory (theme)
  90. 'theme' => 0,
  91. // Set this to relative path of css file if module has its own css file
  92. 'css' => array(
  93. // '/webhook/css/webhook.css.php',
  94. ),
  95. // Set this to relative path of js file if module must load a js on all pages
  96. 'js' => array(
  97. // '/webhook/js/webhook.js.php',
  98. ),
  99. // Set here all hooks context managed by module. To find available hook context, make a "grep -r '>initHooks(' *" on source code. You can also set hook context to 'all'
  100. 'hooks' => array(
  101. // 'data' => array(
  102. // 'hookcontext1',
  103. // 'hookcontext2',
  104. // ),
  105. // 'entity' => '0',
  106. ),
  107. // Set this to 1 if features of module are opened to external users
  108. 'moduleforexternal' => 0,
  109. );
  110. // Data directories to create when module is enabled.
  111. // Example: this->dirs = array("/webhook/temp","/webhook/subdir");
  112. $this->dirs = array("/webhook/temp");
  113. // Config pages. Put here list of php page, stored into webhook/admin directory, to use to setup module.
  114. $this->config_page_url = array("webhook.php");
  115. // Dependencies
  116. // A condition to hide module
  117. $this->hidden = false;
  118. // List of module class names as string that must be enabled if this module is enabled. Example: array('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('modModuleToEnableFR'...))
  119. $this->depends = array();
  120. $this->requiredby = array(); // List of module class names as string to disable if this one is disabled. Example: array('modModuleToDisable1', ...)
  121. $this->conflictwith = array(); // List of module class names as string this module is in conflict with. Example: array('modModuleToDisable1', ...)
  122. // The language file dedicated to your module
  123. $this->langfiles = array();
  124. // Prerequisites
  125. $this->phpmin = array(7, 0); // Minimum version of PHP required by module
  126. $this->need_dolibarr_version = array(11, -3); // Minimum version of Dolibarr required by module
  127. // Messages at activation
  128. $this->warnings_activation = array(); // Warning to show when we activate module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
  129. $this->warnings_activation_ext = array(); // Warning to show when we activate an external module. array('always'='text') or array('FR'='textfr','MX'='textmx'...)
  130. //$this->automatic_activation = array('FR'=>'WebhookWasAutomaticallyActivatedBecauseOfYourCountryChoice');
  131. //$this->always_enabled = true; // If true, can't be disabled
  132. // Constants
  133. // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
  134. // Example: $this->const=array(1 => array('WEBHOOK_MYNEWCONST1', 'chaine', 'myvalue', 'This is a constant to add', 1),
  135. // 2 => array('WEBHOOK_MYNEWCONST2', 'chaine', 'myvalue', 'This is another constant to add', 0, 'current', 1)
  136. // );
  137. $this->const = array();
  138. // Some keys to add into the overwriting translation tables
  139. /*$this->overwrite_translation = array(
  140. 'en_US:ParentCompany'=>'Parent company or reseller',
  141. 'fr_FR:ParentCompany'=>'Maison mère ou revendeur'
  142. )*/
  143. if (!isset($conf->webhook) || !isset($conf->webhook->enabled)) {
  144. $conf->webhook = new stdClass();
  145. $conf->webhook->enabled = 0;
  146. }
  147. // Array to add new pages in new tabs
  148. $this->tabs = array();
  149. // Example:
  150. // $this->tabs[] = array('data'=>'objecttype:+tabname1:Title1:mylangfile@webhook:$user->rights->webhook->read:/webhook/mynewtab1.php?id=__ID__'); // To add a new tab identified by code tabname1
  151. // $this->tabs[] = array('data'=>'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@webhook:$user->rights->othermodule->read:/webhook/mynewtab2.php?id=__ID__', // To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
  152. // $this->tabs[] = array('data'=>'objecttype:-tabname:NU:conditiontoremove'); // To remove an existing tab identified by code tabname
  153. //
  154. // Where objecttype can be
  155. // 'categories_x' to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
  156. // 'contact' to add a tab in contact view
  157. // 'contract' to add a tab in contract view
  158. // 'group' to add a tab in group view
  159. // 'intervention' to add a tab in intervention view
  160. // 'invoice' to add a tab in customer invoice view
  161. // 'invoice_supplier' to add a tab in supplier invoice view
  162. // 'member' to add a tab in fundation member view
  163. // 'opensurveypoll' to add a tab in opensurvey poll view
  164. // 'order' to add a tab in sales order view
  165. // 'order_supplier' to add a tab in supplier order view
  166. // 'payment' to add a tab in payment view
  167. // 'payment_supplier' to add a tab in supplier payment view
  168. // 'product' to add a tab in product view
  169. // 'propal' to add a tab in propal view
  170. // 'project' to add a tab in project view
  171. // 'stock' to add a tab in stock view
  172. // 'thirdparty' to add a tab in third party view
  173. // 'user' to add a tab in user view
  174. // Dictionaries
  175. $this->dictionaries = array();
  176. /* Example:
  177. $this->dictionaries=array(
  178. 'langs'=>'',
  179. // List of tables we want to see into dictonnary editor
  180. 'tabname'=>array(MAIN_DB_PREFIX."table1", MAIN_DB_PREFIX."table2", MAIN_DB_PREFIX."table3"),
  181. // Label of tables
  182. 'tablib'=>array("Table1", "Table2", "Table3"),
  183. // Request to select fields
  184. 'tabsql'=>array('SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table1 as f', 'SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table2 as f', 'SELECT f.rowid as rowid, f.code, f.label, f.active FROM '.MAIN_DB_PREFIX.'table3 as f'),
  185. // Sort order
  186. 'tabsqlsort'=>array("label ASC", "label ASC", "label ASC"),
  187. // List of fields (result of select to show dictionary)
  188. 'tabfield'=>array("code,label", "code,label", "code,label"),
  189. // List of fields (list of fields to edit a record)
  190. 'tabfieldvalue'=>array("code,label", "code,label", "code,label"),
  191. // List of fields (list of fields for insert)
  192. 'tabfieldinsert'=>array("code,label", "code,label", "code,label"),
  193. // Name of columns with primary key (try to always name it 'rowid')
  194. 'tabrowid'=>array("rowid", "rowid", "rowid"),
  195. // Condition to show each dictionary
  196. 'tabcond'=>array($conf->webhook->enabled, $conf->webhook->enabled, $conf->webhook->enabled)
  197. );
  198. */
  199. // Boxes/Widgets
  200. // Add here list of php file(s) stored in webhook/core/boxes that contains a class to show a widget.
  201. $this->boxes = array(
  202. // 0 => array(
  203. // 'file' => 'webhookwidget1.php@webhook',
  204. // 'note' => 'Widget provided by Webhook',
  205. // 'enabledbydefaulton' => 'Home',
  206. // ),
  207. // ...
  208. );
  209. // Cronjobs (List of cron jobs entries to add when module is enabled)
  210. // unit_frequency must be 60 for minute, 3600 for hour, 86400 for day, 604800 for week
  211. $this->cronjobs = array(
  212. // 0 => array(
  213. // 'label' => 'MyJob label',
  214. // 'jobtype' => 'method',
  215. // 'class' => '/webhook/class/webhook_target.class.php',
  216. // 'objectname' => 'Webhook_target',
  217. // 'method' => 'doScheduledJob',
  218. // 'parameters' => '',
  219. // 'comment' => 'Comment',
  220. // 'frequency' => 2,
  221. // 'unitfrequency' => 3600,
  222. // 'status' => 0,
  223. // 'test' => '$conf->webhook->enabled',
  224. // 'priority' => 50,
  225. // ),
  226. );
  227. // Example: $this->cronjobs=array(
  228. // 0=>array('label'=>'My label', 'jobtype'=>'method', 'class'=>'/dir/class/file.class.php', 'objectname'=>'MyClass', 'method'=>'myMethod', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>2, 'unitfrequency'=>3600, 'status'=>0, 'test'=>'$conf->webhook->enabled', 'priority'=>50),
  229. // 1=>array('label'=>'My label', 'jobtype'=>'command', 'command'=>'', 'parameters'=>'param1, param2', 'comment'=>'Comment', 'frequency'=>1, 'unitfrequency'=>3600*24, 'status'=>0, 'test'=>'$conf->webhook->enabled', 'priority'=>50)
  230. // );
  231. // Permissions provided by this module
  232. $this->rights = array();
  233. $r = 0;
  234. // Add here entries to declare new permissions
  235. /* BEGIN MODULEBUILDER PERMISSIONS */
  236. $this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
  237. $this->rights[$r][1] = 'Read Webhooks'; // Permission label
  238. $this->rights[$r][4] = 'webhook_target';
  239. $this->rights[$r][5] = 'read'; // In php code, permission will be checked by test if ($user->rights->webhook->webhook_target->read)
  240. $r++;
  241. $this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
  242. $this->rights[$r][1] = 'Create/Update Webhooks'; // Permission label
  243. $this->rights[$r][4] = 'webhook_target';
  244. $this->rights[$r][5] = 'write'; // In php code, permission will be checked by test if ($user->rights->webhook->webhook_target->write)
  245. $r++;
  246. $this->rights[$r][0] = $this->numero . sprintf("%02d", $r + 1); // Permission id (must not be already used)
  247. $this->rights[$r][1] = 'Delete Webhooks'; // Permission label
  248. $this->rights[$r][4] = 'webhook_target';
  249. $this->rights[$r][5] = 'delete'; // In php code, permission will be checked by test if ($user->rights->webhook->webhook_target->delete)
  250. $r++;
  251. /* END MODULEBUILDER PERMISSIONS */
  252. // Main menu entries to add
  253. $this->menu = array();
  254. $r = 0;
  255. // Add here entries to declare new menus
  256. /* BEGIN MODULEBUILDER TOPMENU */
  257. /*$this->menu[$r++] = array(
  258. 'fk_menu'=>'', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  259. 'type'=>'top', // This is a Top menu entry
  260. 'titre'=>'ModuleWebhookName',
  261. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
  262. 'mainmenu'=>'webhook',
  263. 'leftmenu'=>'',
  264. 'url'=>'/webhook/webhookindex.php',
  265. 'langs'=>'', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  266. 'position'=>1000 + $r,
  267. 'enabled'=>'$conf->webhook->enabled', // Define condition to show or hide menu entry. Use '$conf->webhook->enabled' if entry must be visible if module is enabled.
  268. 'perms'=>'1', // Use 'perms'=>'$user->rights->webhook->webhook_target->read' if you want your menu with a permission rules
  269. 'target'=>'',
  270. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  271. );*/
  272. /* END MODULEBUILDER TOPMENU */
  273. /* BEGIN MODULEBUILDER LEFTMENU WEBHOOK_TARGET
  274. $this->menu[$r++]=array(
  275. 'fk_menu'=>'fk_mainmenu=webhook', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  276. 'type'=>'left', // This is a Left menu entry
  277. 'titre'=>'Webhook_target',
  278. 'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth valignmiddle"'),
  279. 'mainmenu'=>'webhook',
  280. 'leftmenu'=>'webhook_target',
  281. 'url'=>'/webhook/webhookindex.php',
  282. 'langs'=>'', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  283. 'position'=>1000+$r,
  284. 'enabled'=>'$conf->webhook->enabled', // Define condition to show or hide menu entry. Use '$conf->webhook->enabled' if entry must be visible if module is enabled.
  285. 'perms'=>'$user->rights->webhook->webhook_target->read', // Use 'perms'=>'$user->rights->webhook->level1->level2' if you want your menu with a permission rules
  286. 'target'=>'',
  287. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  288. );
  289. $this->menu[$r++]=array(
  290. 'fk_menu'=>'fk_mainmenu=webhook,fk_leftmenu=webhook_target', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  291. 'type'=>'left', // This is a Left menu entry
  292. 'titre'=>'List_Webhook_target',
  293. 'mainmenu'=>'webhook',
  294. 'leftmenu'=>'webhook_webhook_target_list',
  295. 'url'=>'/webhook/webhook_target_list.php',
  296. 'langs'=>'', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  297. 'position'=>1000+$r,
  298. 'enabled'=>'$conf->webhook->enabled', // Define condition to show or hide menu entry. Use '$conf->webhook->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  299. 'perms'=>'$user->rights->webhook->webhook_target->read', // Use 'perms'=>'$user->rights->webhook->level1->level2' if you want your menu with a permission rules
  300. 'target'=>'',
  301. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  302. );
  303. $this->menu[$r++]=array(
  304. 'fk_menu'=>'fk_mainmenu=webhook,fk_leftmenu=webhook_target', // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  305. 'type'=>'left', // This is a Left menu entry
  306. 'titre'=>'New_Webhook_target',
  307. 'mainmenu'=>'webhook',
  308. 'leftmenu'=>'webhook_webhook_target_new',
  309. 'url'=>'/webhook/webhook_target_card.php?action=create',
  310. 'langs'=>'', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  311. 'position'=>1000+$r,
  312. 'enabled'=>'$conf->webhook->enabled', // Define condition to show or hide menu entry. Use '$conf->webhook->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  313. 'perms'=>'$user->rights->webhook->webhook_target->write', // Use 'perms'=>'$user->rights->webhook->level1->level2' if you want your menu with a permission rules
  314. 'target'=>'',
  315. 'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
  316. );
  317. */
  318. /*$this->menu[$r++]=array(
  319. // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  320. 'fk_menu'=>'fk_mainmenu=webhook',
  321. // This is a Left menu entry
  322. 'type'=>'left',
  323. 'titre'=>'List Webhook_target',
  324. 'mainmenu'=>'webhook',
  325. 'leftmenu'=>'webhook_webhook_target',
  326. 'url'=>'/webhook/webhook_target_list.php',
  327. // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  328. 'langs'=>'',
  329. 'position'=>1100+$r,
  330. // Define condition to show or hide menu entry. Use '$conf->webhook->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  331. 'enabled'=>'$conf->webhook->enabled',
  332. // Use 'perms'=>'$user->rights->webhook->level1->level2' if you want your menu with a permission rules
  333. 'perms'=>'1',
  334. 'target'=>'',
  335. // 0=Menu for internal users, 1=external users, 2=both
  336. 'user'=>2,
  337. );
  338. $this->menu[$r++]=array(
  339. // '' if this is a top menu. For left menu, use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
  340. 'fk_menu'=>'fk_mainmenu=webhook,fk_leftmenu=webhook_webhook_target',
  341. // This is a Left menu entry
  342. 'type'=>'left',
  343. 'titre'=>'New Webhook_target',
  344. 'mainmenu'=>'webhook',
  345. 'leftmenu'=>'webhook_webhook_target',
  346. 'url'=>'/webhook/webhook_target_card.php?action=create',
  347. // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
  348. 'langs'=>'',
  349. 'position'=>1100+$r,
  350. // Define condition to show or hide menu entry. Use '$conf->webhook->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
  351. 'enabled'=>'$conf->webhook->enabled',
  352. // Use 'perms'=>'$user->rights->webhook->level1->level2' if you want your menu with a permission rules
  353. 'perms'=>'1',
  354. 'target'=>'',
  355. // 0=Menu for internal users, 1=external users, 2=both
  356. 'user'=>2
  357. );*/
  358. /* END MODULEBUILDER LEFTMENU WEBHOOK_TARGET */
  359. // Exports profiles provided by this module
  360. $r = 1;
  361. /* BEGIN MODULEBUILDER EXPORT WEBHOOK_TARGET */
  362. /*
  363. $this->export_code[$r]=$this->rights_class.'_'.$r;
  364. $this->export_label[$r]='Webhook_targetLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  365. $this->export_icon[$r]='webhook_target@webhook';
  366. // Define $this->export_fields_array, $this->export_TypeFields_array and $this->export_entities_array
  367. $keyforclass = 'Webhook_target'; $keyforclassfile='/webhook/class/webhook_target.class.php'; $keyforelement='webhook_target@webhook';
  368. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  369. //$this->export_fields_array[$r]['t.fieldtoadd']='FieldToAdd'; $this->export_TypeFields_array[$r]['t.fieldtoadd']='Text';
  370. //unset($this->export_fields_array[$r]['t.fieldtoremove']);
  371. //$keyforclass = 'Webhook_targetLine'; $keyforclassfile='/webhook/class/webhook_target.class.php'; $keyforelement='webhook_targetline@webhook'; $keyforalias='tl';
  372. //include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
  373. $keyforselect='webhook_target'; $keyforaliasextra='extra'; $keyforelement='webhook_target@webhook';
  374. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  375. //$keyforselect='webhook_targetline'; $keyforaliasextra='extraline'; $keyforelement='webhook_targetline@webhook';
  376. //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
  377. //$this->export_dependencies_array[$r] = array('webhook_targetline'=>array('tl.rowid','tl.ref')); // To force to activate one or several fields if we select some fields that need same (like to select a unique key if we ask a field of a child to avoid the DISTINCT to discard them, or for computed field than need several other fields)
  378. //$this->export_special_array[$r] = array('t.field'=>'...');
  379. //$this->export_examplevalues_array[$r] = array('t.field'=>'Example');
  380. //$this->export_help_array[$r] = array('t.field'=>'FieldDescHelp');
  381. $this->export_sql_start[$r]='SELECT DISTINCT ';
  382. $this->export_sql_end[$r] =' FROM '.MAIN_DB_PREFIX.'webhook_target as t';
  383. //$this->export_sql_end[$r] =' LEFT JOIN '.MAIN_DB_PREFIX.'webhook_target_line as tl ON tl.fk_webhook_target = t.rowid';
  384. $this->export_sql_end[$r] .=' WHERE 1 = 1';
  385. $this->export_sql_end[$r] .=' AND t.entity IN ('.getEntity('webhook_target').')';
  386. $r++; */
  387. /* END MODULEBUILDER EXPORT WEBHOOK_TARGET */
  388. // Imports profiles provided by this module
  389. $r = 1;
  390. /* BEGIN MODULEBUILDER IMPORT WEBHOOK_TARGET */
  391. /*
  392. $this->import_code[$r]=$this->rights_class.'_'.$r;
  393. $this->import_label[$r]='Webhook_targetLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
  394. $this->import_icon[$r]='webhook_target@webhook';
  395. $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX.'webhook_webhook_target', 'extra' => MAIN_DB_PREFIX.'webhook_webhook_target_extrafields');
  396. $this->import_tables_creator_array[$r] = array('t' => 'fk_user_author'); // Fields to store import user id
  397. $import_sample = array();
  398. $keyforclass = 'Webhook_target'; $keyforclassfile='/webhook/class/webhook_target.class.php'; $keyforelement='webhook_target@webhook';
  399. include DOL_DOCUMENT_ROOT.'/core/commonfieldsinimport.inc.php';
  400. $import_extrafield_sample = array();
  401. $keyforselect='webhook_target'; $keyforaliasextra='extra'; $keyforelement='webhook_target@webhook';
  402. include DOL_DOCUMENT_ROOT.'/core/extrafieldsinimport.inc.php';
  403. $this->import_fieldshidden_array[$r] = array('extra.fk_object' => 'lastrowid-'.MAIN_DB_PREFIX.'webhook_webhook_target');
  404. $this->import_regex_array[$r] = array();
  405. $this->import_examplevalues_array[$r] = array_merge($import_sample, $import_extrafield_sample);
  406. $this->import_updatekeys_array[$r] = array('t.ref' => 'Ref');
  407. $this->import_convertvalue_array[$r] = array(
  408. 't.ref' => array(
  409. 'rule'=>'getrefifauto',
  410. 'class'=>(empty($conf->global->WEBHOOK_WEBHOOK_TARGET_ADDON) ? 'mod_webhook_target_standard' : $conf->global->WEBHOOK_WEBHOOK_TARGET_ADDON),
  411. 'path'=>"/core/modules/commande/".(empty($conf->global->WEBHOOK_WEBHOOK_TARGET_ADDON) ? 'mod_webhook_target_standard' : $conf->global->WEBHOOK_WEBHOOK_TARGET_ADDON).'.php'
  412. 'classobject'=>'Webhook_target',
  413. 'pathobject'=>'/webhook/class/webhook_target.class.php',
  414. ),
  415. 't.fk_soc' => array('rule' => 'fetchidfromref', 'file' => '/societe/class/societe.class.php', 'class' => 'Societe', 'method' => 'fetch', 'element' => 'ThirdParty'),
  416. 't.fk_user_valid' => array('rule' => 'fetchidfromref', 'file' => '/user/class/user.class.php', 'class' => 'User', 'method' => 'fetch', 'element' => 'user'),
  417. 't.fk_mode_reglement' => array('rule' => 'fetchidfromcodeorlabel', 'file' => '/compta/paiement/class/cpaiement.class.php', 'class' => 'Cpaiement', 'method' => 'fetch', 'element' => 'cpayment'),
  418. );
  419. $r++; */
  420. /* END MODULEBUILDER IMPORT WEBHOOK_TARGET */
  421. }
  422. /**
  423. * Function called when module is enabled.
  424. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
  425. * It also creates data directories
  426. *
  427. * @param string $options Options when enabling module ('', 'noboxes')
  428. * @return int 1 if OK, 0 if KO
  429. */
  430. public function init($options = '')
  431. {
  432. global $conf, $langs;
  433. $result = $this->_load_tables('/install/mysql/tables/', 'webhook');
  434. //$result = $this->_load_tables('/webhook/sql/');
  435. if ($result < 0) {
  436. return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
  437. }
  438. // Permissions
  439. $this->remove($options);
  440. $sql = array();
  441. // Document templates
  442. $moduledir = dol_sanitizeFileName('webhook');
  443. $myTmpObjects = array();
  444. $myTmpObjects['Webhook_target'] = array('includerefgeneration'=>0, 'includedocgeneration'=>0);
  445. foreach ($myTmpObjects as $myTmpObjectKey => $myTmpObjectArray) {
  446. if ($myTmpObjectKey == 'Webhook_target') {
  447. continue;
  448. }
  449. if ($myTmpObjectArray['includerefgeneration']) {
  450. $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/'.$moduledir.'/template_webhook_targets.odt';
  451. $dirodt = DOL_DATA_ROOT.'/doctemplates/'.$moduledir;
  452. $dest = $dirodt.'/template_webhook_targets.odt';
  453. if (file_exists($src) && !file_exists($dest)) {
  454. require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  455. dol_mkdir($dirodt);
  456. $result = dol_copy($src, $dest, 0, 0);
  457. if ($result < 0) {
  458. $langs->load("errors");
  459. $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
  460. return 0;
  461. }
  462. }
  463. $sql = array_merge($sql, array(
  464. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'standard_".strtolower($myTmpObjectKey)."' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
  465. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('standard_".strtolower($myTmpObjectKey)."', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")",
  466. "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = 'generic_".strtolower($myTmpObjectKey)."_odt' AND type = '".$this->db->escape(strtolower($myTmpObjectKey))."' AND entity = ".((int) $conf->entity),
  467. "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('generic_".strtolower($myTmpObjectKey)."_odt', '".$this->db->escape(strtolower($myTmpObjectKey))."', ".((int) $conf->entity).")"
  468. ));
  469. }
  470. }
  471. return $this->_init($sql, $options);
  472. }
  473. /**
  474. * Function called when module is disabled.
  475. * Remove from database constants, boxes and permissions from Dolibarr database.
  476. * Data directories are not deleted
  477. *
  478. * @param string $options Options when enabling module ('', 'noboxes')
  479. * @return int 1 if OK, 0 if KO
  480. */
  481. public function remove($options = '')
  482. {
  483. $sql = array();
  484. return $this->_remove($sql, $options);
  485. }
  486. }