dolibarr 20.0.0
mrp.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2019 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
4 * Copyright (C) 2024 Frédéric France <frederic.france@free.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
26// Load Dolibarr environment
27require '../main.inc.php';
28require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
29require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
30require_once DOL_DOCUMENT_ROOT.'/mrp/class/mo.class.php';
31require_once DOL_DOCUMENT_ROOT.'/mrp/lib/mrp_mo.lib.php';
32require_once DOL_DOCUMENT_ROOT.'/mrp/lib/mrp.lib.php';
33
34// Load translation files required by the page
35$langs->loadLangs(array('admin', 'errors', 'mrp', 'other'));
36
37if (!$user->admin) {
39}
40
41$action = GETPOST('action', 'aZ09');
42$value = GETPOST('value', 'alpha');
43$modulepart = GETPOST('modulepart', 'aZ09'); // Used by actions_setmoduleoptions.inc.php
44
45$label = GETPOST('label', 'alpha');
46$scandir = GETPOST('scan_dir', 'alpha');
47$type = 'mrp';
48
49
50/*
51 * Actions
52 */
53
54include DOL_DOCUMENT_ROOT.'/core/actions_setmoduleoptions.inc.php';
55
56if ($action == 'updateMask') {
57 $maskconstmrp = GETPOST('maskconstMo', 'aZ09');
58 $maskmrp = GETPOST('maskMo', 'alpha');
59
60 if ($maskconstmrp && preg_match('/_MASK$/', $maskconstmrp)) {
61 $res = dolibarr_set_const($db, $maskconstmrp, $maskmrp, 'chaine', 0, '', $conf->entity);
62 }
63
64 if (!($res > 0)) {
65 $error++;
66 }
67
68 if (!$error) {
69 setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
70 } else {
71 setEventMessages($langs->trans("Error"), null, 'errors');
72 }
73} elseif ($action == 'specimen') {
74 $modele = GETPOST('module', 'alpha');
75
76 $mo = new Mo($db);
77 $mo->initAsSpecimen();
78
79 // Search template files
80 $file = '';
81 $classname = '';
82 $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
83 foreach ($dirmodels as $reldir) {
84 $file = dol_buildpath($reldir."core/modules/mrp/doc/pdf_".$modele.".modules.php", 0);
85 if (file_exists($file)) {
86 $classname = "pdf_".$modele;
87 break;
88 }
89 }
90
91 if ($classname !== '') {
92 require_once $file;
93
94 $module = new $classname($db);
95 '@phan-var-force CommonDocGenerator $module';
96
97 if ($module->write_file($mo, $langs) > 0) {
98 header("Location: ".DOL_URL_ROOT."/document.php?modulepart=mrp&file=SPECIMEN.pdf");
99 return;
100 } else {
101 setEventMessages($module->error, null, 'errors');
102 dol_syslog($module->error, LOG_ERR);
103 }
104 } else {
105 setEventMessages($langs->trans("ErrorModuleNotFound"), null, 'errors');
106 dol_syslog($langs->trans("ErrorModuleNotFound"), LOG_ERR);
107 }
108} elseif ($action == 'set') {
109 // Activate a model
110 $ret = addDocumentModel($value, $type, $label, $scandir);
111} elseif ($action == 'del') {
112 $ret = delDocumentModel($value, $type);
113 if ($ret > 0) {
114 if ($conf->global->MRP_MO_ADDON_PDF == "$value") {
115 dolibarr_del_const($db, 'MRP_MO_ADDON_PDF', $conf->entity);
116 }
117 }
118} elseif ($action == 'setdoc') {
119 // Set default model
120 if (dolibarr_set_const($db, "MRP_MO_ADDON_PDF", $value, 'chaine', 0, '', $conf->entity)) {
121 // The constant that was read before the new set
122 // We therefore requires a variable to have a coherent view
123 $conf->global->MRP_MO_ADDON_PDF = $value;
124 }
125
126 // On active le modele
127 $ret = delDocumentModel($value, $type);
128 if ($ret > 0) {
129 $ret = addDocumentModel($value, $type, $label, $scandir);
130 }
131} elseif ($action == 'setmod') {
132 // TODO Check if numbering module chosen can be activated
133 // by calling method canBeActivated
134
135 dolibarr_set_const($db, "MRP_MO_ADDON", $value, 'chaine', 0, '', $conf->entity);
136} elseif ($action == 'set_MRP_MO_DRAFT_WATERMARK') {
137 $draft = GETPOST("MRP_MO_DRAFT_WATERMARK");
138 $res = dolibarr_set_const($db, "MRP_MO_DRAFT_WATERMARK", trim($draft), 'chaine', 0, '', $conf->entity);
139
140 if (!($res > 0)) {
141 $error++;
142 }
143
144 if (!$error) {
145 setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
146 } else {
147 setEventMessages($langs->trans("Error"), null, 'errors');
148 }
149} elseif ($action == 'set_MRP_MO_FREE_TEXT') {
150 $freetext = GETPOST("MRP_MO_FREE_TEXT", 'restricthtml'); // No alpha here, we want exact string
151
152 $res = dolibarr_set_const($db, "MRP_MO_FREE_TEXT", $freetext, 'chaine', 0, '', $conf->entity);
153
154 if (!($res > 0)) {
155 $error++;
156 }
157
158 if (!$error) {
159 setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
160 } else {
161 setEventMessages($langs->trans("Error"), null, 'errors');
162 }
163}
164
165
166/*
167 * View
168 */
169
170$form = new Form($db);
171
172$dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
173
174llxHeader("", $langs->trans("MrpSetupPage"), '', '', 0, 0, '', '', '', 'mod-admin page-mrp');
175
176$linkback = '<a href="'.DOL_URL_ROOT.'/admin/modules.php?restore_lastsearch_values=1">'.$langs->trans("BackToModuleList").'</a>';
177print load_fiche_titre($langs->trans("MrpSetupPage"), $linkback, 'title_setup');
178
179$head = mrpAdminPrepareHead();
180
181print dol_get_fiche_head($head, 'settings', $langs->trans("MOs"), -1, 'mrp');
182
183/*
184 * MOs Numbering model
185 */
186
187print load_fiche_titre($langs->trans("MOsNumberingModules"), '', '');
188
189print '<table class="noborder centpercent">';
190print '<tr class="liste_titre">';
191print '<td>'.$langs->trans("Name").'</td>';
192print '<td>'.$langs->trans("Description").'</td>';
193print '<td class="nowrap">'.$langs->trans("Example").'</td>';
194print '<td class="center" width="60">'.$langs->trans("Status").'</td>';
195print '<td class="center" width="16">'.$langs->trans("ShortInfo").'</td>';
196print '</tr>'."\n";
197
198clearstatcache();
199
200foreach ($dirmodels as $reldir) {
201 $dir = dol_buildpath($reldir."core/modules/mrp/");
202
203 if (is_dir($dir)) {
204 $handle = opendir($dir);
205 if (is_resource($handle)) {
206 while (($file = readdir($handle)) !== false) {
207 if (substr($file, 0, 7) == 'mod_mo_' && substr($file, dol_strlen($file) - 3, 3) == 'php') {
208 $file = substr($file, 0, dol_strlen($file) - 4);
209
210 require_once $dir.$file.'.php';
211
212 $module = new $file($db);
213
214 // Show modules according to features level
215 if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
216 continue;
217 }
218 if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) {
219 continue;
220 }
221
222 if ($module->isEnabled()) {
223 print '<tr class="oddeven"><td>'.$module->name."</td><td>\n";
224 print $module->info($langs);
225 print '</td>';
226
227 // Show example of numbering model
228 print '<td class="nowrap">';
229 $tmp = $module->getExample();
230 if (preg_match('/^Error/', $tmp)) {
231 $langs->load("errors");
232 print '<div class="error">'.$langs->trans($tmp).'</div>';
233 } elseif ($tmp == 'NotConfigured') {
234 print '<span class="opacitymedium">'.$langs->trans($tmp).'</span>';
235 } else {
236 print $tmp;
237 }
238 print '</td>'."\n";
239
240 print '<td class="center">';
241 if ($conf->global->MRP_MO_ADDON == $file) {
242 print img_picto($langs->trans("Activated"), 'switch_on');
243 } else {
244 print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=setmod&token='.newToken().'&value='.urlencode($file).'">';
245 print img_picto($langs->trans("Disabled"), 'switch_off');
246 print '</a>';
247 }
248 print '</td>';
249
250 $mrp = new Mo($db);
251 $mrp->initAsSpecimen();
252
253 // Info
254 $htmltooltip = '';
255 $htmltooltip .= ''.$langs->trans("Version").': <b>'.$module->getVersion().'</b><br>';
256 $mrp->type = 0;
257 $nextval = $module->getNextValue($mysoc, $mrp);
258 if ("$nextval" != $langs->trans("NotAvailable")) { // Keep " on nextval
259 $htmltooltip .= ''.$langs->trans("NextValue").': ';
260 if ($nextval) {
261 if (preg_match('/^Error/', $nextval) || $nextval == 'NotConfigured') {
262 $nextval = $langs->trans($nextval);
263 }
264 $htmltooltip .= $nextval.'<br>';
265 } else {
266 $htmltooltip .= $langs->trans($module->error).'<br>';
267 }
268 }
269
270 print '<td class="center">';
271 print $form->textwithpicto('', $htmltooltip, 1, 0);
272 print '</td>';
273
274 print "</tr>\n";
275 }
276 }
277 }
278 closedir($handle);
279 }
280 }
281}
282print "</table><br>\n";
283
284
285/*
286 * Document templates generators
287 */
288
289print load_fiche_titre($langs->trans("MOsModelModule"), '', '');
290
291// Load array def with activated templates
292$def = array();
293$sql = "SELECT nom";
294$sql .= " FROM ".MAIN_DB_PREFIX."document_model";
295$sql .= " WHERE type = '".$db->escape($type)."'";
296$sql .= " AND entity = ".$conf->entity;
297$resql = $db->query($sql);
298if ($resql) {
299 $i = 0;
300 $num_rows = $db->num_rows($resql);
301 while ($i < $num_rows) {
302 $array = $db->fetch_array($resql);
303 if (is_array($array)) {
304 array_push($def, $array[0]);
305 }
306 $i++;
307 }
308} else {
309 dol_print_error($db);
310}
311
312
313print "<table class=\"noborder\" width=\"100%\">\n";
314print "<tr class=\"liste_titre\">\n";
315print '<td>'.$langs->trans("Name").'</td>';
316print '<td>'.$langs->trans("Description").'</td>';
317print '<td class="center" width="60">'.$langs->trans("Status")."</td>\n";
318print '<td class="center" width="60">'.$langs->trans("Default")."</td>\n";
319print '<td class="center" width="38">'.$langs->trans("ShortInfo").'</td>';
320print '<td class="center" width="38">'.$langs->trans("Preview").'</td>';
321print "</tr>\n";
322
323clearstatcache();
324
325foreach ($dirmodels as $reldir) {
326 foreach (array('', '/doc') as $valdir) {
327 $realpath = $reldir."core/modules/mrp".$valdir;
328 $dir = dol_buildpath($realpath);
329
330 if (is_dir($dir)) {
331 $handle = opendir($dir);
332 if (is_resource($handle)) {
333 $filelist = array();
334 while (($file = readdir($handle)) !== false) {
335 $filelist[] = $file;
336 }
337 closedir($handle);
338 arsort($filelist);
339
340 foreach ($filelist as $file) {
341 if (preg_match('/\.modules\.php$/i', $file) && preg_match('/^(pdf_|doc_)/', $file)) {
342 if (file_exists($dir.'/'.$file)) {
343 $name = substr($file, 4, dol_strlen($file) - 16);
344 $classname = substr($file, 0, dol_strlen($file) - 12);
345
346 require_once $dir.'/'.$file;
347 $module = new $classname($db);
348
349 $modulequalified = 1;
350 if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
351 $modulequalified = 0;
352 }
353 if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) {
354 $modulequalified = 0;
355 }
356
357 if ($modulequalified) {
358 print '<tr class="oddeven"><td width="100">';
359 print(empty($module->name) ? $name : $module->name);
360 print "</td><td>\n";
361 if (method_exists($module, 'info')) {
362 print $module->info($langs);
363 } else {
364 print $module->description;
365 }
366 print '</td>';
367
368 // Active
369 if (in_array($name, $def)) {
370 print '<td class="center">'."\n";
371 print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=del&token='.newToken().'&value='.urlencode($name).'">';
372 print img_picto($langs->trans("Enabled"), 'switch_on');
373 print '</a>';
374 print '</td>';
375 } else {
376 print '<td class="center">'."\n";
377 print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=set&token='.newToken().'&value='.urlencode($name).'&scan_dir='.urlencode($module->scandir).'&label='.urlencode($module->name).'">'.img_picto($langs->trans("Disabled"), 'switch_off').'</a>';
378 print "</td>";
379 }
380
381 // Default
382 print '<td class="center">';
383 if ($conf->global->MRP_MO_ADDON_PDF == $name) {
384 print img_picto($langs->trans("Default"), 'on');
385 } else {
386 print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=setdoc&token='.newToken().'&value='.urlencode($name).'&scan_dir='.urlencode($module->scandir).'&label='.urlencode($module->name).'" alt="'.$langs->trans("Default").'">'.img_picto($langs->trans("Disabled"), 'off').'</a>';
387 }
388 print '</td>';
389
390 // Info
391 $htmltooltip = ''.$langs->trans("Name").': '.$module->name;
392 $htmltooltip .= '<br>'.$langs->trans("Type").': '.($module->type ? $module->type : $langs->trans("Unknown"));
393 if ($module->type == 'pdf') {
394 $htmltooltip .= '<br>'.$langs->trans("Width").'/'.$langs->trans("Height").': '.$module->page_largeur.'/'.$module->page_hauteur;
395 }
396 $htmltooltip .= '<br>'.$langs->trans("Path").': '.preg_replace('/^\//', '', $realpath).'/'.$file;
397
398 $htmltooltip .= '<br><br><u>'.$langs->trans("FeaturesSupported").':</u>';
399 $htmltooltip .= '<br>'.$langs->trans("MultiLanguage").': '.yn($module->option_multilang, 1, 1);
400 $htmltooltip .= '<br>'.$langs->trans("WatermarkOnDraftMOs").': '.yn($module->option_draft_watermark, 1, 1);
401
402
403 print '<td class="center">';
404 print $form->textwithpicto('', $htmltooltip, 1, 0);
405 print '</td>';
406
407 // Preview
408 print '<td class="center">';
409 if ($module->type == 'pdf') {
410 print '<a href="'.$_SERVER["PHP_SELF"].'?action=specimen&module='.$name.'">'.img_object($langs->trans("Preview"), 'pdf').'</a>';
411 } else {
412 print img_object($langs->trans("PreviewNotAvailable"), 'generic');
413 }
414 print '</td>';
415
416 print "</tr>\n";
417 }
418 }
419 }
420 }
421 }
422 }
423 }
424}
425
426print '</table>';
427print "<br>";
428
429/*
430 * Other options
431 */
432
433print load_fiche_titre($langs->trans("OtherOptions"), '', '');
434print '<table class="noborder centpercent">';
435print '<tr class="liste_titre">';
436print '<td>'.$langs->trans("Parameter").'</td>';
437print '<td class="center" width="60">'.$langs->trans("Value").'</td>';
438print "<td>&nbsp;</td>\n";
439print "</tr>\n";
440
441$substitutionarray = pdf_getSubstitutionArray($langs, null, null, 2);
442$substitutionarray['__(AnyTranslationKey)__'] = $langs->trans("Translation");
443$htmltext = '<i>'.$langs->trans("AvailableVariables").':<br>';
444foreach ($substitutionarray as $key => $val) {
445 $htmltext .= $key.'<br>';
446}
447$htmltext .= '</i>';
448
449print '<form action="'.$_SERVER["PHP_SELF"].'" method="post">';
450print '<input type="hidden" name="token" value="'.newToken().'">';
451print '<input type="hidden" name="action" value="set_MRP_MO_FREE_TEXT">';
452print '<tr class="oddeven"><td colspan="2">';
453print $form->textwithpicto($langs->trans("FreeLegalTextOnMOs"), $langs->trans("AddCRIfTooLong").'<br><br>'.$htmltext, 1, 'help', '', 0, 2, 'freetexttooltip').'<br>';
454$variablename = 'MRP_MO_FREE_TEXT';
455if (!getDolGlobalString('PDF_ALLOW_HTML_FOR_FREE_TEXT')) {
456 print '<textarea name="'.$variablename.'" class="flat" cols="120">'.getDolGlobalString($variablename).'</textarea>';
457} else {
458 include_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
459 $doleditor = new DolEditor($variablename, getDolGlobalString($variablename), '', 80, 'dolibarr_notes');
460 print $doleditor->Create();
461}
462print '</td><td class="right">';
463print '<input type="submit" class="button button-edit" value="'.$langs->trans("Modify").'">';
464print "</td></tr>\n";
465print '</form>';
466
467//Use draft Watermark
468
469print "<form method=\"post\" action=\"".$_SERVER["PHP_SELF"]."\">";
470print '<input type="hidden" name="token" value="'.newToken().'">';
471print "<input type=\"hidden\" name=\"action\" value=\"set_MRP_MO_DRAFT_WATERMARK\">";
472print '<tr class="oddeven"><td>';
473print $form->textwithpicto($langs->trans("WatermarkOnDraftMOs"), $htmltext, 1, 'help', '', 0, 2, 'watermarktooltip').'<br>';
474print '</td><td>';
475print '<input class="flat minwidth200" type="text" name="MRP_MO_DRAFT_WATERMARK" value="'.dol_escape_htmltag(getDolGlobalString('MRP_MO_DRAFT_WATERMARK')).'">';
476print '</td><td class="right">';
477print '<input type="submit" class="button button-edit" value="'.$langs->trans("Modify").'">';
478print "</td></tr>\n";
479print '</form>';
480
481print '</table>';
482print '<br>';
483
484
485// End of page
486llxFooter();
487$db->close();
addDocumentModel($name, $type, $label='', $description='')
Add document model used by doc generator.
dolibarr_set_const($db, $name, $value, $type='chaine', $visible=0, $note='', $entity=1)
Insert a parameter (key,value) into database (delete old key then insert it again).
dolibarr_del_const($db, $name, $entity=1)
Delete a constant.
delDocumentModel($name, $type)
Delete document model used by doc generator.
if(!defined('NOREQUIRESOC')) if(!defined( 'NOREQUIRETRAN')) if(!defined('NOTOKENRENEWAL')) if(!defined( 'NOREQUIREMENU')) if(!defined('NOREQUIREHTML')) if(!defined( 'NOREQUIREAJAX')) llxHeader()
Empty header.
Definition wrapper.php:55
llxFooter()
Empty footer.
Definition wrapper.php:69
Class to manage a WYSIWYG editor.
Class to manage generation of HTML components Only common components must be here.
Class for Mo.
Definition mo.class.php:36
load_fiche_titre($title, $morehtmlright='', $picto='generic', $pictoisfullpath=0, $id='', $morecssontable='', $morehtmlcenter='')
Load a title with picto.
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0)
Show a picto called object_picto (generic function)
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
yn($yesno, $case=1, $color=0)
Return yes or no in current language.
dol_get_fiche_head($links=array(), $active='', $title='', $notab=0, $picto='', $pictoisfullpath=0, $morehtmlright='', $morecss='', $limittoshow=0, $moretabssuffix='', $dragdropfile=0)
Show tabs of a record.
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
newToken()
Return the value of token currently saved into session with name 'newtoken'.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
setEventMessages($mesg, $mesgs, $style='mesgs', $messagekey='', $noduplicate=0)
Set event messages in dol_events session object.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
mrpAdminPrepareHead()
Prepare admin pages header.
Definition mrp.lib.php:30
pdf_getSubstitutionArray($outputlangs, $exclude=null, $object=null, $onlykey=0, $include=null)
Return array of possible substitutions for PDF content (without external module substitutions).
Definition pdf.lib.php:769
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition repair.php:140
accessforbidden($message='', $printheader=1, $printfooter=1, $showonlymessage=0, $params=null)
Show a message to say access is forbidden and stop program.