inventory.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2026 Jose MARTINEZ <jose.martinez@pichinov.com>
 *
 * 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/stock.lib.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
require_once DOL_DOCUMENT_ROOT.'/product/inventory/class/inventory.class.php';
 
// Translations
$langs->loadLangs(array("admin", "errors", "stocks"));
 
// Access control
if (!$user->admin) {
  accessforbidden();
}
 
// Parameters
$action = GETPOST('action', 'aZ09');
$value = GETPOST('value', 'alpha');
$label = GETPOST('label', 'alpha');
$scandir = GETPOST('scan_dir', 'alpha');
 
$error = 0;
 
 
/*
 * Actions
 */
 
if ($action == 'updateMask') {
  $maskconstinventory = GETPOST('maskconstinventory', 'aZ09');
  $maskinventory = GETPOST('maskInventory', 'alpha');
 
  if ($maskconstinventory && preg_match('/_MASK$/', $maskconstinventory)) {
    $res = dolibarr_set_const($db, $maskconstinventory, $maskinventory, 'chaine', 0, '', $conf->entity);
    if ($res <= 0) {
      $error++;
    }
  }
 
  if (!$error) {
    setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
  } else {
    setEventMessages($langs->trans("Error"), null, 'errors');
  }
} elseif ($action == 'specimen') {
  $modele = GETPOST('module', 'alpha');
 
  $tmpobject = new Inventory($db);
  $tmpobject->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/inventory/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 ModelePDFInventory $module';
    if ($module->write_file($tmpobject, $langs) > 0) {
      header("Location: ".DOL_URL_ROOT."/document.php?modulepart=inventory&file=SPECIMEN.pdf");
      return;
    } else {
      setEventMessages($module->error, null, '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 document model
  $ret = addDocumentModel($value, 'inventory', $label, $scandir);
} elseif ($action == 'del') {
  $ret = delDocumentModel($value, 'inventory');
  if ($ret > 0) {
    if (getDolGlobalString('INVENTORY_ADDON_PDF') == "$value") {
      dolibarr_del_const($db, 'INVENTORY_ADDON_PDF', $conf->entity);
    }
  }
} elseif ($action == 'setdoc') { // Set default document model
  if (dolibarr_set_const($db, 'INVENTORY_ADDON_PDF', $value, 'chaine', 0, '', $conf->entity)) {
    // The constant that was read before the new set
    // We therefore requires a variable to have a coherent view
    $conf->global->INVENTORY_ADDON_PDF = $value;
  }
 
  // Activate the model
  $ret = delDocumentModel($value, 'inventory');
  if ($ret > 0) {
    $ret = addDocumentModel($value, 'inventory', $label, $scandir);
  }
} elseif ($action == 'setmod') {
  // The default value ('') means: free reference typed by the user
  dolibarr_set_const($db, 'INVENTORY_ADDON', $value, 'chaine', 0, '', $conf->entity);
}
 
 
/*
 * View
 */
 
$form = new Form($db);
 
$dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
 
$page_name = "StockSetup";
llxHeader('', $langs->trans($page_name), '', '', 0, 0, '', '', '', 'mod-admin page-inventory');
 
// Subheader
$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($page_name), $linkback, 'title_setup');
 
// Configuration header
$head = stock_admin_prepare_head();
print dol_get_fiche_head($head, 'inventory', $langs->trans("Inventory"), -1, 'stock');
 
// Numbering models
print load_fiche_titre($langs->trans("NumberingModules", $langs->transnoentities("Inventory")), '', '');
 
print '<div class="div-table-responsive-no-min">';
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print '<td>'.$langs->trans("Name").'</td>';
print '<td>'.$langs->trans("Description").'</td>';
print '<td class="nowrap">'.$langs->trans("Example").'</td>';
print '<td class="center" width="60">'.$langs->trans("Status").'</td>';
print '<td class="center" width="16">'.$langs->trans("ShortInfo").'</td>';
print '</tr>'."\n";
 
clearstatcache();
 
foreach ($dirmodels as $reldir) {
  $dir = dol_buildpath($reldir."core/modules/inventory");
 
  if (is_dir($dir)) {
    $handle = opendir($dir);
    if (is_resource($handle)) {
      while (($file = readdir($handle)) !== false) {
        if (strpos($file, 'mod_inventory_') === 0 && substr($file, dol_strlen($file) - 3, 3) == 'php') {
          $file = substr($file, 0, dol_strlen($file) - 4);
 
          require_once $dir.'/'.$file.'.php';
 
          $module = new $file($db);
 
          '@phan-var-force ModeleNumRefInventory $module';
 
          // 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;
          }
 
          if ($module->isEnabled()) {
            print '<tr class="oddeven"><td>'.$module->name."</td><td>\n";
            print $module->info($langs);
            print '</td>';
 
            // Show example of numbering model
            print '<td class="nowrap">';
            $tmp = $module->getExample();
            if (preg_match('/^Error/', $tmp)) {
              print '<div class="error">'.$langs->trans($tmp).'</div>';
            } elseif ($tmp == 'NotConfigured') {
              print $langs->trans($tmp);
            } else {
              print $tmp;
            }
            print '</td>'."\n";
 
            print '<td class="center">';
            if (getDolGlobalString('INVENTORY_ADDON') == $file) {
              print img_picto($langs->trans("Activated"), 'switch_on');
            } else {
              print '<a href="'.$_SERVER["PHP_SELF"].'?action=setmod&token='.newToken().'&value='.urlencode($file).'">';
              print img_picto($langs->trans("Disabled"), 'switch_off');
              print '</a>';
            }
            print '</td>';
 
            $mytmpinstance = new Inventory($db);
            $mytmpinstance->initAsSpecimen();
 
            // Info
            $htmltooltip = '';
            $htmltooltip .= ''.$langs->trans("Version").': <b>'.$module->getVersion().'</b><br>';
 
            $nextval = $module->getNextValue($mytmpinstance);
            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("InventoryRefTypedManually").'<br>';
              }
            }
 
            print '<td class="center">';
            print $form->textwithpicto('', $htmltooltip, 1, 'info');
            print '</td>';
 
            print "</tr>\n";
          }
        }
      }
      closedir($handle);
    }
  }
}
print "</table></div><br>\n";
 
// Document templates generators
print load_fiche_titre($langs->trans("DocumentModules", $langs->transnoentities("Inventory")), '', '');
 
// Load array def with activated templates
$def = array();
$sql = "SELECT nom";
$sql .= " FROM ".MAIN_DB_PREFIX."document_model";
$sql .= " WHERE type = 'inventory'";
$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 '<div class="div-table-responsive">';
print '<table class="noborder centpercent">'."\n";
print '<tr class="liste_titre">'."\n";
print '<td>'.$langs->trans("Name").'</td>';
print '<td>'.$langs->trans("Description").'</td>';
print '<td class="center" width="60">'.$langs->trans("Status")."</td>\n";
print '<td class="center" width="60">'.$langs->trans("Default")."</td>\n";
print '<td class="center" width="38">'.$langs->trans("ShortInfo").'</td>';
print '<td class="center" width="38">'.$langs->trans("Preview").'</td>';
print "</tr>\n";
 
clearstatcache();
 
foreach ($dirmodels as $reldir) {
  foreach (array('', '/doc') as $valdir) {
    $realpath = $reldir."core/modules/inventory".$valdir;
    $dir = dol_buildpath($realpath);
 
    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 ModelePDFInventory $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 class="oddeven"><td>';
                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 href="'.$_SERVER["PHP_SELF"].'?action=del&value='.urlencode($name).'&token='.newToken().'">';
                  print img_picto($langs->trans("Enabled"), 'switch_on');
                  print '</a>';
                  print '</td>';
                } else {
                  print '<td class="center">'."\n";
                  print '<a href="'.$_SERVER["PHP_SELF"].'?action=set&value='.urlencode($name).'&scan_dir='.urlencode($module->scandir).'&label='.urlencode($module->name).'&token='.newToken().'">'.img_picto($langs->trans("Disabled"), 'switch_off').'</a>';
                  print "</td>";
                }
 
                // Default
                print '<td class="center">';
                if (getDolGlobalString('INVENTORY_ADDON_PDF') == $name) {
                  print img_picto($langs->trans("Default"), 'on');
                } else {
                  print '<a 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>'.$langs->trans("Path").': '.preg_replace('/^\//', '', $realpath).'/'.$file;
 
                $htmltooltip .= '<br><br><u>'.$langs->trans("FeaturesSupported").':</u>';
                $htmltooltip .= '<br>'.$langs->trans("Logo").': '.yn($module->option_logo, 1, 1);
                $htmltooltip .= '<br>'.$langs->trans("MultiLanguage").': '.yn($module->option_multilang, 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="'.$_SERVER["PHP_SELF"].'?action=specimen&module='.$name.'&token='.newToken().'">'.img_object($langs->trans("Preview"), 'generic').'</a>';
                } else {
                  print img_object($langs->transnoentitiesnoconv("PreviewNotAvailable"), 'generic');
                }
                print '</td>';
 
                print "</tr>\n";
              }
            }
          }
        }
      }
    }
  }
}
 
print '</table></div>';
 
// Page end
print dol_get_fiche_end();
 
llxFooter();
$db->close();