actions_setmoduleoptions.inc.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2014-2017  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2024   MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2026  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/>.
 * or see https://www.gnu.org/
 */
 
// $error must have been initialized to 0
// $action must be defined
// $arrayofparameters must be set to list of parameters to update for action 'update' on constants
// $nomessageinupdate can be set to 1
// $nomessageinsetmoduleoptions can be set to 1
// $formSetup may be defined
 
'
@phan-var-force FormSetup $formSetup
@phan-var-force string $action
@phan-var-force int $error
@phan-var-force ?string $modulepart
@phan-var-force ?string $websitetemplateconf
@phan-var-force ?string $upload_dir
';
 
if (($action == 'update' || !empty($websitetemplateconf)) && !empty($formSetup) && is_object($formSetup) && !empty($user->admin)) {
  $formSetup->saveConfFromPost();
  return;
}
 
if (($action == 'update' || !empty($websitetemplateconf)) && !empty($arrayofparameters) && is_array($arrayofparameters) && !empty($user->admin)) {
  $db->begin();
 
  foreach ($arrayofparameters as $key => $val) {
    // Modify constant only if key was posted (avoid resetting key to the null value)
    if (GETPOSTISSET($key)) {
      if (isset($val['type']) && preg_match('/category:/', $val['type'])) {
        if (GETPOSTINT($key) == '-1') {
          $val_const = '';
        } else {
          $val_const = GETPOSTINT($key);
        }
      } elseif (isset($val['type']) && $val['type'] == 'html') {
        $val_const = GETPOST($key, 'restricthtml');
      } else {
        $val_const = GETPOST($key, 'alpha');
      }
 
      $result = dolibarr_set_const($db, $key, $val_const, 'chaine', 0, '', $conf->entity);
      if ($result < 0) {
        $error++;
        break;
      }
    }
  }
 
  if (!$error) {
    $db->commit();
    if (empty($nomessageinupdate)) {
      setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
    }
  } else {
    $db->rollback();
    if (empty($nomessageinupdate)) {
      setEventMessages($langs->trans("SetupNotSaved"), null, 'errors');
    }
  }
}
 
if ($action == 'deletefile' && $modulepart == 'doctemplates' && !empty($user->admin)) {
  include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  $keyforuploaddir = GETPOST('keyforuploaddir', 'aZ09');
  $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString($keyforuploaddir))));
 
  foreach ($listofdir as $key => $tmpdir) {
    $tmpdir = preg_replace('/DOL_DATA_ROOT\/*/', '', $tmpdir);  // Clean string if we found a hardcoded DOL_DATA_ROOT
    if (!$tmpdir) {
      unset($listofdir[$key]);
      continue;
    }
    $tmpdir = DOL_DATA_ROOT.'/'.$tmpdir;  // Complete with DOL_DATA_ROOT. Only files into DOL_DATA_ROOT can be reach/set
    if (!is_dir($tmpdir)) {
      if (empty($nomessageinsetmoduleoptions)) {
        setEventMessages($langs->trans("ErrorDirNotFound", $tmpdir), null, 'warnings');
      }
    } else {
      $upload_dir = $tmpdir;
      break;  // So we take the first directory found into setup $conf->global->$keyforuploaddir
    }
  }
 
  if ($upload_dir) {
    $filetodelete = $upload_dir.'/'.GETPOST('file');
    $result = dol_delete_file($filetodelete, 1);
    if ($result > 0) {
      setEventMessages($langs->trans("FileWasRemoved", GETPOST('file')), null, 'mesgs');
    }
  }
}
 
// Define constants for submodules that contains parameters (forms with param1, param2, ... and value1, value2, ...)
if ($action == 'setModuleOptions' && !empty($user->admin)) {
  $db->begin();
 
  // Process common param fields
  if (is_array($_POST)) {
    foreach ($_POST as $key => $val) {
      $reg = array();
      if (preg_match('/^param(\d*)$/', $key, $reg)) {    // Works for POST['param'], POST['param1'], POST['param2'], ...
        $param = GETPOST("param".$reg[1], 'aZ09');
        $value = GETPOST("value".$reg[1], 'alpha');
        if ($param) {
          $res = dolibarr_set_const($db, $param, $value, 'chaine', 0, '', $conf->entity);
          if (!($res > 0)) {
            $error++;
          }
 
          // Case we modify the list of directories for ODT templases, we want to be sure directory exists
          if (preg_match('/_ADDON_PDF_ODT_PATH$/', $param) && preg_match('/^DOL_DATA_ROOT/', $value)) {
            $tmpdir = preg_replace('/^DOL_DATA_ROOT/', DOL_DATA_ROOT, $value);
            dol_mkdir($tmpdir, DOL_DATA_ROOT);
          }
        }
      }
    }
  }
 
  // Process upload fields
  if (GETPOST('upload', 'alpha') && GETPOST('keyforuploaddir', 'aZ09')) {
    include_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
    $keyforuploaddir = GETPOST('keyforuploaddir', 'aZ09');
    $listofdir = explode(',', preg_replace('/[\r\n]+/', ',', trim(getDolGlobalString($keyforuploaddir))));
 
    foreach ($listofdir as $key => $tmpdir) {
      $tmpdir = trim($tmpdir);
      $tmpdir = preg_replace('/DOL_DATA_ROOT\/*/', '', $tmpdir);  // Clean string if we found a hardcoded DOL_DATA_ROOT
      if (!$tmpdir) {
        unset($listofdir[$key]);
        continue;
      }
      $tmpdir = DOL_DATA_ROOT.'/'.$tmpdir;  // Complete with DOL_DATA_ROOT. Only files into DOL_DATA_ROOT can be reach/set
      if (!is_dir($tmpdir)) {
        if (empty($nomessageinsetmoduleoptions)) {
          setEventMessages($langs->trans("ErrorDirNotFound", $tmpdir), null, 'warnings');
        }
      } else {
        $upload_dir = $tmpdir;
        break;  // So we take the first directory found into setup $conf->global->$keyforuploaddir
      }
    }
 
    // Restrict uploads for ODT template setup pages.
    if (preg_match('/_ADDON_PDF_ODT_PATH$/', $keyforuploaddir) && !empty($_FILES['uploadfile'])) {
      $allowedext = array('odt', 'ods');
      $allowedmimes = array(
        'application/vnd.oasis.opendocument.text',
        'application/vnd.oasis.opendocument.spreadsheet',
        'application/zip',
        'application/x-zip-compressed',
        'application/octet-stream'
      );
      $files = $_FILES['uploadfile'];
      if (!is_array($files['name'])) {
        foreach ($files as $key => &$val) {
          $val = array($val);
        }
        unset($val);
      }
      foreach ($files['name'] as $idx => $filename) {
        if (empty($filename)) {
          continue;
        }
 
        $extension = strtolower(pathinfo((string) $filename, PATHINFO_EXTENSION));
        if (!in_array($extension, $allowedext, true)) {
          $error++;
          setEventMessages($langs->trans("ErrorFileNotUploaded").' (Only .odt/.ods templates are allowed)', null, 'errors');
          dol_syslog(__FILE__." ODT template upload refused on extension filename=".$filename, LOG_WARNING);
          break;
        }
 
        $detectedmime = '';
        if (!empty($files['tmp_name'][$idx]) && function_exists('finfo_open')) {
          $finfo = finfo_open(FILEINFO_MIME_TYPE);
          if ($finfo) {
            $detectedmime = (string) finfo_file($finfo, $files['tmp_name'][$idx]);
            finfo_close($finfo);
          }
        }
        if (!empty($detectedmime) && !in_array(strtolower($detectedmime), $allowedmimes, true)) {
          $error++;
          setEventMessages($langs->trans("ErrorFileNotUploaded").' (Invalid MIME type for ODT/ODS template)', null, 'errors');
          dol_syslog(__FILE__." ODT template upload refused on mime filename=".$filename." mime=".$detectedmime, LOG_WARNING);
          break;
        }
      }
    }
 
    if ($upload_dir && !$error) {
      $result = dol_add_file_process($upload_dir, 1, 1, 'uploadfile', '');
      if ($result <= 0) {
        $error++;
      }
    }
  }
 
  if (!$error) {
    $db->commit();
    if (empty($nomessageinsetmoduleoptions)) {
      setEventMessages($langs->trans("SetupSaved"), null, 'mesgs');
    }
  } else {
    $db->rollback();
    if (empty($nomessageinsetmoduleoptions)) {
      setEventMessages($langs->trans("SetupNotSaved"), null, 'errors');
    }
  }
}