dolibarr 21.0.0-alpha
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
28include_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 = "WebHook";
66 // Used only if file README.md and README-LL.md not found.
67 $this->descriptionlong = "Interface to catch dolibarr triggers and send data of the event to an external URL";
68
69 // Possible values for version are: 'development', 'experimental', 'dolibarr', 'dolibarr_deprecated' or a version string like 'x.y.z'
70 $this->version = 'dolibarr';
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('always'=>array('modModuleToEnable1','modModuleToEnable2'), 'FR'=>array('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 foundation 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 Webhooks'; // 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 Webhooks'; // 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 Webhooks'; // 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 }
282
291 public function init($options = '')
292 {
293 $result = $this->_load_tables('/install/mysql/tables/', 'webhook');
294 //$result = $this->_load_tables('/webhook/sql/');
295 if ($result < 0) {
296 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')
297 }
298
299 // Permissions
300 $this->remove($options);
301
302 $sql = array();
303
304 return $this->_init($sql, $options);
305 }
306
315 public function remove($options = '')
316 {
317 $sql = array();
318 return $this->_remove($sql, $options);
319 }
320}
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 $mode $langs defaultlang(is_numeric($duration_value) ? " delay=". $duration_value :"").(is_numeric($duration_value2) ? " after cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140