expedition.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003-2008  Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2004   Sebastien Di Cintio   <sdicintio@ressource-toi.org>
 * Copyright (C) 2004   Benoit Mortier      <benoit.mortier@opensides.be>
 * Copyright (C) 2004   Eric Seigne       <eric.seigne@ryxeo.com>
 * Copyright (C) 2005-2012  Regis Houssin     <regis.houssin@inodbox.com>
 * Copyright (C) 2011-2012  Juanjo Menent     <jmenent@2byte.es>
 * Copyright (C) 2011-2018  Philippe Grand      <philippe.grand@atoo-net.com>
 * Copyright (C) 2024-2025  MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France             <frederic.france@free.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
// Load Dolibarr environment
require '../main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/pdf.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/expedition.lib.php';
require_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
 
// Load translation files required by the page
$langs->loadLangs(array("admin", "sendings", "other"));
 
if (!$user->admin) {
  accessforbidden();
}
 
$action = GETPOST('action', 'aZ09');
$value = GETPOST('value', 'alpha');
$modulepart = GETPOST('modulepart', 'aZ09');  // Used by actions_setmoduleoptions.inc.php
 
$label = GETPOST('label', 'alpha');
$scandir = GETPOST('scan_dir', 'alpha');
$type = 'shipping';
 
if (!getDolGlobalString('EXPEDITION_ADDON_NUMBER')) {
  $conf->global->EXPEDITION_ADDON_NUMBER = 'mod_expedition_safor';
}
 
 
/*
 * Actions
 */
$error = 0;
 
include DOL_DOCUMENT_ROOT.'/core/actions_setmoduleoptions.inc.php';
 
if ($action == 'updateMask') {
  $maskconst = GETPOST('maskconstexpedition', 'aZ09');
  $maskvalue = GETPOST('maskexpedition', 'alpha');
  if (!empty($maskconst) && preg_match('/_MASK$/', $maskconst)) {
    $res = dolibarr_set_const($db, $maskconst, $maskvalue, 'chaine', 0, '', $conf->entity);
  }
 
  if (isset($res)) {
    if ($res > 0) {
      setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
    } else {
      setEventMessages($langs->trans("Error"), null, 'errors');
    }
  }
} elseif ($action == 'set_param') {
  $freetext = GETPOST('SHIPPING_FREE_TEXT', 'restricthtml'); // No alpha here, we want exact string
  $res = dolibarr_set_const($db, "SHIPPING_FREE_TEXT", $freetext, 'chaine', 0, '', $conf->entity);
  if ($res <= 0) {
    $error++;
    setEventMessages($langs->trans("Error"), null, 'errors');
  }
 
  $draft = GETPOST('SHIPPING_DRAFT_WATERMARK', 'alpha');
  $res = dolibarr_set_const($db, "SHIPPING_DRAFT_WATERMARK", trim($draft), 'chaine', 0, '', $conf->entity);
  if ($res <= 0) {
    $error++;
    setEventMessages($langs->trans("Error"), null, 'errors');
  }
 
  if (!$error) {
    setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
  }
} elseif ($action == 'specimen') {
  $modele = GETPOST('module', 'alpha');
 
  $exp = new Expedition($db);
  $exp->initAsSpecimen();
 
  // Search template files
  $file = '';
  $classname = '';
  $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
  foreach ($dirmodels as $reldir) {
    $file = dol_buildpath($reldir."core/modules/expedition/doc/pdf_".$modele.".modules.php", 0);
    if (file_exists($file)) {
      $classname = "pdf_".$modele;
      break;
    }
  }
 
  if ($classname !== '') {
    require_once $file;
 
    $module = new $classname($db);
    '@phan-var-force ModelePdfExpedition $module';
 
    if ($module->write_file($exp, $langs) > 0) {
      header("Location: ".DOL_URL_ROOT."/document.php?modulepart=expedition&file=SPECIMEN.pdf");
      return;
    } else {
      setEventMessages($module->error, $module->errors, 'errors');
      dol_syslog($module->error, LOG_ERR);
    }
  } else {
    setEventMessages($langs->trans("ErrorModuleNotFound"), null, 'errors');
    dol_syslog($langs->trans("ErrorModuleNotFound"), LOG_ERR);
  }
} elseif ($action == 'set') {
  // Activate a model
  $ret = addDocumentModel($value, $type, $label, $scandir);
} elseif ($action == 'del') {
  $ret = delDocumentModel($value, $type);
  if ($ret > 0) {
    if (getDolGlobalString('EXPEDITION_ADDON_PDF') == "$value") {
      dolibarr_del_const($db, 'EXPEDITION_ADDON_PDF', $conf->entity);
    }
  }
} elseif ($action == 'setdoc') {
  // Set default model
  if (dolibarr_set_const($db, "EXPEDITION_ADDON_PDF", $value, 'chaine', 0, '', $conf->entity)) {
    // La constante qui a ete lue en avant du nouveau set
    // on passe donc par une variable pour avoir un affichage coherent
    $conf->global->EXPEDITION_ADDON_PDF = $value;
  }
 
  // On active le modele
  $ret = delDocumentModel($value, $type);
  if ($ret > 0) {
    $ret = addDocumentModel($value, $type, $label, $scandir);
  }
} elseif ($action == 'setmodel') {
  dolibarr_set_const($db, "EXPEDITION_ADDON_NUMBER", $value, 'chaine', 0, '', $conf->entity);
}
 
 
/*
 * View
 */
 
$dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
 
$form = new Form($db);
 
llxHeader("", $langs->trans("SendingsSetup"), '', '', 0, 0, '', '', '', 'mod-admin page-expedition');
 
$linkback = '<a href="'.dolBuildUrl(DOL_URL_ROOT.'/admin/modules.php', ['restore_lastsearch_values' => 1]).'">'.img_picto($langs->trans("BackToModuleList"), 'back', 'class="pictofixedwidth"').'<span class="hideonsmartphone">'.$langs->trans("BackToModuleList").'</span></a>';
 
print load_fiche_titre($langs->trans("SendingsSetup"), $linkback, 'title_setup');
print '<br>';
$head = expedition_admin_prepare_head();
 
print dol_get_fiche_head($head, 'shipment', $langs->trans("Sendings"), -1, 'shipment');
 
// Shipment numbering model
 
print load_fiche_titre($langs->trans("SendingsNumberingModules"), '', '');
 
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print '<td width="100">'.$langs->trans("Name").'</td>';
print '<td>'.$langs->trans("Description").'</td>';
print '<td>'.$langs->trans("Example").'</td>';
print '<td class="center" width="60">'.$langs->trans("Status").'</td>';
print '<td class="center" width="80">'.$langs->trans("ShortInfo").'</td>';
print "</tr>\n";
 
clearstatcache();
 
foreach ($dirmodels as $reldir) {
  $dir = dol_buildpath($reldir."core/modules/expedition/");
 
  if (is_dir($dir)) {
    $handle = opendir($dir);
    if (is_resource($handle)) {
      while (($file = readdir($handle)) !== false) {
        if (preg_match('/^mod_expedition_([a-z0-9_]*)\.php$/', $file)) {
          $file = substr($file, 0, dol_strlen($file) - 4);
 
          require_once $dir.$file.'.php';
 
          $module = new $file();
          '@phan-var-force ModelNumRefExpedition $module';
 
          if ($module->isEnabled()) {
            // Show modules according to features level
            if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
              continue;
            }
            if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) {
              continue;
            }
 
            print '<tr><td>'.$module->name."</td>\n";
            print '<td>';
            print $module->info($langs);
            print '</td>';
 
            // Show example of numbering module
            print '<td class="nowrap">';
            $tmp = $module->getExample();
            if (preg_match('/^Error/', $tmp)) {
              $langs->load("errors");
              print '<div class="error">'.$langs->trans($tmp).'</div>';
            } elseif ($tmp == 'NotConfigured') {
              print '<span class="opacitymedium">'.$langs->trans($tmp).'</span>';
            } else {
              print $tmp;
            }
            print '</td>'."\n";
 
            print '<td class="center">';
            if (getDolGlobalString('EXPEDITION_ADDON_NUMBER') == "$file") {
              print img_picto($langs->trans("Activated"), 'switch_on');
            } else {
              print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=setmodel&token='.newToken().'&value='.urlencode($file).'&label='.urlencode($module->name).'">';
              print img_picto($langs->trans("Disabled"), 'switch_off');
              print '</a>';
            }
            print '</td>';
 
            $expedition = new Expedition($db);
            $expedition->initAsSpecimen();
 
            // Info
            $htmltooltip = '';
            $htmltooltip .= ''.$langs->trans("Version").': <b>'.$module->getVersion().'</b><br>';
            $nextval = $module->getNextValue($mysoc, $expedition);
            if ("$nextval" != $langs->trans("NotAvailable")) {  // Keep " on nextval
              $htmltooltip .= ''.$langs->trans("NextValue").': ';
              if ($nextval) {
                if (preg_match('/^Error/', $nextval) || $nextval == 'NotConfigured') {
                  $nextval = $langs->trans($nextval);
                }
                $htmltooltip .= $nextval.'<br>';
              } else {
                $htmltooltip .= $langs->trans($module->error).'<br>';
              }
            }
 
            print '<td class="center">';
            print $form->textwithpicto('', $htmltooltip, 1, 'info');
            print '</td>';
 
            print '</tr>';
          }
        }
      }
      closedir($handle);
    }
  }
}
 
print '</table><br>';
 
 
/*
 *  Documents models for Sendings Receipt
 */
print load_fiche_titre($langs->trans("SendingsReceiptModel"), '', '');
 
// Defini tableau def de modele invoice
$type = "shipping";
$def = array();
 
$sql = "SELECT nom";
$sql .= " FROM ".MAIN_DB_PREFIX."document_model";
$sql .= " WHERE type = '".$db->escape($type)."'";
$sql .= " AND entity = ".((int) $conf->entity);
 
$resql = $db->query($sql);
if ($resql) {
  $i = 0;
  $num_rows = $db->num_rows($resql);
  while ($i < $num_rows) {
    $array = $db->fetch_array($resql);
    if (is_array($array)) {
      array_push($def, $array[0]);
    }
    $i++;
  }
} else {
  dol_print_error($db);
}
 
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print '<td width="140">'.$langs->trans("Name").'</td>';
print '<td>'.$langs->trans("Description").'</td>';
print '<td class="center" width="60">'.$langs->trans("Status").'</td>';
print '<td class="center" width="60">'.$langs->trans("Default").'</td>';
print '<td class="nowrap center" width="80">'.$langs->trans("ShortInfo").'</td>';
print '<td class="nowrap center" width="80" >'.$langs->trans("Preview").'</td>';
print "</tr>\n";
 
clearstatcache();
 
foreach ($dirmodels as $reldir) {
  foreach (array('', '/doc') as $valdir) {
    $dir = dol_buildpath($reldir."core/modules/expedition".$valdir);
 
    if (is_dir($dir)) {
      $handle = opendir($dir);
      if (is_resource($handle)) {
        $filelist = array();
        while (($file = readdir($handle)) !== false) {
          $filelist[] = $file;
        }
        closedir($handle);
        arsort($filelist);
 
        foreach ($filelist as $file) {
          if (preg_match('/\.modules\.php$/i', $file) && preg_match('/^(pdf_|doc_)/', $file)) {
            if (file_exists($dir.'/'.$file)) {
              $name = substr($file, 4, dol_strlen($file) - 16);
              $classname = substr($file, 0, dol_strlen($file) - 12);
 
              require_once $dir.'/'.$file;
              $module = new $classname($db);
 
              '@phan-var-force ModelePdfExpedition $module';
 
              $modulequalified = 1;
              if ($module->version == 'development' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 2) {
                $modulequalified = 0;
              }
              if ($module->version == 'experimental' && getDolGlobalInt('MAIN_FEATURES_LEVEL') < 1) {
                $modulequalified = 0;
              }
 
              if ($modulequalified) {
                print '<tr><td width="100">';
                print(empty($module->name) ? $name : $module->name);
                print "</td><td>\n";
                if (method_exists($module, 'info')) {
                  print $module->info($langs);  // @phan-suppress-current-line PhanUndeclaredMethod
                } else {
                  print $module->description;
                }
                print '</td>';
 
                // Active
                if (in_array($name, $def)) {
                  print '<td class="center">'."\n";
                  print '<a class="reposition" href="'.$_SERVER["PHP_SELF"].'?action=del&token='.newToken().'&value='.urlencode($name).'">';
                  print img_picto($langs->trans("Enabled"), 'switch_on');
                  print '</a>';
                  print '</td>';
                } else {
                  print '<td class="center">'."\n";
                  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>';
                  print "</td>";
                }
 
                // Default
                print '<td class="center">';
                if (getDolGlobalString('EXPEDITION_ADDON_PDF') == $name) {
                  print img_picto($langs->trans("Default"), 'on');
                } else {
                  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>';
                }
                print '</td>';
 
                // Info
                $htmltooltip = ''.$langs->trans("Name").': '.$module->name;
                $htmltooltip .= '<br>'.$langs->trans("Type").': '.($module->type ? $module->type : $langs->trans("Unknown"));
                if ($module->type == 'pdf') {
                  $htmltooltip .= '<br>'.$langs->trans("Width").'/'.$langs->trans("Height").': '.$module->page_largeur.'/'.$module->page_hauteur;
                }
                $htmltooltip .= '<br><br><u>'.$langs->trans("FeaturesSupported").':</u>';
                $htmltooltip .= '<br>'.$langs->trans("Logo").': '.yn($module->option_logo, 1, 1);
                $htmltooltip .= '<br>'.$langs->trans("PaymentMode").': '.yn($module->option_modereg, 1, 1);
                $htmltooltip .= '<br>'.$langs->trans("PaymentConditions").': '.yn($module->option_condreg, 1, 1);
                $htmltooltip .= '<br>'.$langs->trans("MultiLanguage").': '.yn($module->option_multilang, 1, 1);
                $htmltooltip .= '<br>'.$langs->trans("WatermarkOnDraftOrders").': '.yn($module->option_draft_watermark, 1, 1);
 
                print '<td class="center">';
                print $form->textwithpicto('', $htmltooltip, 1, 'info');
                print '</td>';
 
                // Preview
                print '<td class="center">';
                if ($module->type == 'pdf') {
                  print '<a href="'.dolBuildUrl($_SERVER["PHP_SELF"], ['action' => 'specimen', 'module' => $name, 'scan_dir' => $module->scandir, 'label' => $module->name], true).'">'.img_object($langs->trans("Preview"), 'pdf').'</a>';
                } else {
                  print img_object($langs->transnoentitiesnoconv("PreviewNotAvailable"), 'generic');
                }
                print '</td>';
 
                print "</tr>\n";
              }
            }
          }
        }
      }
    }
  }
}
 
print '</table>';
 
 
/*
 * Other options
 */
 
print load_fiche_titre($langs->trans("OtherOptions"), '', '');
 
print '<form action="'.$_SERVER["PHP_SELF"].'" method="post">';
print '<input type="hidden" name="token" value="'.newToken().'">';
print '<input type="hidden" name="action" value="set_param">';
 
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print "<td>".$langs->trans("Parameter")."</td>\n";
print "<td></td>\n";
print '</tr>';
 
print '<tr class="oddeven">';
print '<td>'.$langs->trans('SHIPPING_DISPLAY_STOCK_ENTRY_DATE');
print '</td>';
print '<td>';
print ajax_constantonoff('SHIPPING_DISPLAY_STOCK_ENTRY_DATE');
print '</td></tr>';
 
print '<tr class="oddeven">';
print '<td>'.$langs->trans('SHIPPING_SELL_EAT_BY_DATE_PRE_SELECT_EARLIEST');
print '</td>';
print '<td>';
print ajax_constantonoff('SHIPPING_SELL_EAT_BY_DATE_PRE_SELECT_EARLIEST');
print '</td></tr>';
 
$substitutionarray = pdf_getSubstitutionArray($langs, null, null, 2);
$substitutionarray['__(AnyTranslationKey)__'] = $langs->trans("Translation");
$htmltext = '<i>'.$langs->trans("AvailableVariables").':<br>';
foreach ($substitutionarray as $key => $val) {
  $htmltext .= $key.'<br>';
}
$htmltext .= '</i>';
 
print '<tr><td colspan="2">';
print $form->textwithpicto($langs->trans("FreeLegalTextOnShippings"), $langs->trans("AddCRIfTooLong").'<br><br>'.$htmltext, 1, 'help', '', 0, 2, 'freetexttooltip').'<br>';
$variablename = 'SHIPPING_FREE_TEXT';
if (!getDolGlobalString('PDF_ALLOW_HTML_FOR_FREE_TEXT')) {
  print '<textarea name="'.$variablename.'" class="flat" cols="120">'.getDolGlobalString($variablename).'</textarea>';
} else {
  include_once DOL_DOCUMENT_ROOT.'/core/class/doleditor.class.php';
  $doleditor = new DolEditor($variablename, getDolGlobalString($variablename), '', 80, 'dolibarr_notes');
  print $doleditor->Create();
}
print "</td></tr>\n";
 
print '<tr><td>';
print $form->textwithpicto($langs->trans("WatermarkOnDraftContractCards"), $htmltext, 1, 'help', '', 0, 2, 'watermarktooltip');
print '</td><td>';
print '<input class="flat minwidth200" type="text" name="SHIPPING_DRAFT_WATERMARK" value="'.dol_escape_htmltag(getDolGlobalString('SHIPPING_DRAFT_WATERMARK')).'">';
print "</td></tr>\n";
 
// Allow OnLine Sign
print '<tr class="oddeven">';
print '<td>'.$langs->trans("AllowOnLineSign");
print '</td>';
print '<td>';
print ajax_constantonoff('EXPEDITION_ALLOW_ONLINESIGN', array(), null, 0, 0, 0, 2, 0, 1, '', '', 'inline-block', 0, $langs->transnoentitiesnoconv("WarningOnlineSignature", 'https://www.dolistore.com'));
print '</td></tr>';
 
// Pre fill shipment qty option
print '<tr class="oddeven">';
print '<td>'.$langs->trans("DontPrefillShipmentQty");
print '</td>';
print '<td>';
print ajax_constantonoff('SHIPMENT_DONT_PREFILL_QTY', array(), null, 0, 0, 0, 2, 0, 1, '', '', 'inline-block', 0, '');
print '</td></tr>';
 
 
// Notifications
print '<tr class="oddeven">';
print '<td>'.img_picto('', 'email', 'class="pictofixedwidth"').$langs->trans("Notifications").'</td>';
print '<td>';
print $langs->trans("YouMayFindNotificationsFeaturesIntoModuleNotification");
print '</td></tr>';
 
// More PDF options
print '<tr class="oddeven">';
print '<td>'.img_picto('', 'pdf', 'class="pictofixedwidth"').$langs->trans("MoreOptionsRelatedToPDF").'</td>';
print '<td>';
print img_picto('', 'url', 'class="pictofixedwidth"').'<a href="'.DOL_URL_ROOT.'/admin/pdf_other.php">'.$langs->trans("SeeInPDFSetupPage").'</a>';
print '</td></tr>';
 
print '</table>';
 
print $form->buttonsSaveCancel("Modify", '');
 
print '</form>';
 
// End of page
llxFooter();
$db->close();