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