modBlockedLog.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017-2025  Laurent Destailleur <eldy@users.sourcefore.net>
 * Copyright (C) 2026   Regis Houssin   <regis.houssin@inodbox.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/>.
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
include_once DOL_DOCUMENT_ROOT.'/blockedlog/lib/blockedlog.lib.php';
 
 
class modBlockedLog extends DolibarrModules
{
  public function __construct($db)
  {
    global $mysoc;
 
    $this->db = $db;
    $this->numero = 3200;
    // Key text used to identify module (for permissions, menus, etc...)
    $this->rights_class = 'blockedlog';
 
    // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
    // It is used to group modules in module setup page
    $this->family = "base";
    // Module position in the family on 2 digits ('01', '10', '20', ...)
    $this->module_position = '76';
    // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
    $this->name = preg_replace('/^mod/i', '', get_class($this));
    $this->description = "Enable a log on some business events into an unalterable log. This module may be mandatory for some countries.";
 
    // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
    $this->version = 'dolibarr';
    // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
    $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
    // Name of image file used for this module.
    $this->picto = 'blockedlog';
 
    // Data directories to create when module is enabled
    $this->dirs = array();
 
    // Config pages
    //-------------
    $this->config_page_url = array('blockedlog.php?withtab=1@blockedlog');
 
    // Dependencies
    //-------------
    $this->hidden = false; // A condition to disable module
    $this->depends = array('always'=>'modFacture'); // List of modules id that must be enabled if this module is enabled
    $this->requiredby = array(); // List of modules id to disable if this one is disabled
    $this->conflictwith = array(); // List of modules id this module is in conflict with
    $this->langfiles = array('blockedlog');
 
    $this->warnings_activation = array();
    $this->warnings_activation_ext = array();
    $this->warnings_unactivation = array('FR'=>'BlockedLogAreRequiredByYourCountryLegislation');
 
    // Currently, activation is not automatic because only companies (in France) making invoices to non business customers must
    // enable this module.
    /*if (getDolGlobalString('BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY')) {
      $tmp = explode(',', getDolGlobalString('BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY'));
      $this->automatic_activation = array();
      foreach($tmp as $countrycodekey)
      {
        $this->automatic_activation[$countrycodekey] = 'BlockedLogActivatedBecauseRequiredByYourCountryLegislation';
      }
    }*/
    //var_dump($this->automatic_activation);
 
    $this->always_enabled = (isModEnabled('blockedlog')
      && getDolGlobalString('BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY')
      && in_array((empty($mysoc->country_code) ? '' : $mysoc->country_code), explode(',', getDolGlobalString('BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY')))
      && $this->alreadyUsed());
 
    // Constants
    //-----------
    $this->const = array(
      1=>array('BLOCKEDLOG_DISABLE_NOT_ALLOWED_FOR_COUNTRY', 'chaine', 'FR', 'This is list of country code where the module may be mandatory', 0, 'current', 0)
    );
 
    // New pages on tabs
    // -----------------
    $this->tabs = array();
 
    // Boxes
    //------
    $this->boxes = array();
 
    // Permissions
    // -----------------
    $this->rights = array(); // Permission array used by this module
 
    $r = 1;
    $this->rights[$r][0] = $this->numero + $r; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Read archived events and fingerprints'; // Permission label
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->mymodule->level1->level2)
    $this->rights[$r][5] = '';
 
    // Main menu entries
    // -----------------
    $r = 0;
    $this->menu[$r] = array(
      'fk_menu'=>'fk_mainmenu=tools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
      'mainmenu'=>'tools',
      'leftmenu'=>'blockedlogbrowser',
      'type'=>'left', // This is a Left menu entry
      'titre'=>'BrowseBlockedLog',
      'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth"'),
      'url'=>'/blockedlog/admin/blockedlog_list.php?mainmenu=tools&leftmenu=blockedlogbrowser',
      'langs'=>'blockedlog', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
      'position'=>200,
      'enabled'=>'isModEnabled("blockedlog")', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
      'perms'=>'$user->hasRight("blockedlog", "read")', // Use 'perms'=>'$user->hasRight("mymodule","level1","level2")' if you want your menu with a permission rules
      'target'=>'',
      'user'=>2, // 0=Menu for internal users, 1=external users, 2=both
    );
    $r++;
  }
 
 
  public function alreadyUsed()
  {
    require_once DOL_DOCUMENT_ROOT.'/blockedlog/lib/blockedlog.lib.php';
 
    return isBlockedLogUsed();
  }
 
 
  public function init($options = '')
  {
    global $conf, $user;
 
    $sql = array();
 
 
    require_once DOL_DOCUMENT_ROOT . '/blockedlog/class/blockedlog.class.php';
    $b = new BlockedLog($this->db);
 
 
    $this->db->begin();
 
    include_once DOL_DOCUMENT_ROOT.'/core/lib/security.lib.php';
    include_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php';
 
    // Check that the HTTPS is forced
    $s = $b->canBeEnabled();
    if ($s) { // Activation not allowed
      $this->error = $s;
      return 0;
    }
 
    // Create HMAC if it does not exists yet
    $hmac_encoded_secret_key = getDolGlobalString('BLOCKEDLOG_HMAC_KEY');
    if (empty($hmac_encoded_secret_key)) {
      // Add key
      $hmac_secret_key = 'BLOCKEDLOGHMAC'.getRandomPassword(true);    // This is using random_int for 32 chars
 
      $result = dolibarr_set_const($this->db, 'BLOCKEDLOG_HMAC_KEY', $hmac_secret_key, 'chaine', 0, 'The secret key for HMAC used for blockedlog record', $conf->entity); // Will encrypt the value using dolCrypt and store it.
 
      if ($result < 0) {
        dol_print_error($this->db);
        $this->db->rollback();
 
        return 0;
      }
    } else {
      // Decode the HMAC key
      $hmac_secret_key = dolDecrypt($hmac_encoded_secret_key);
 
      if (! preg_match('/^BLOCKEDLOGHMAC/', $hmac_secret_key)) {
        $this->error = 'Error: Failed to decode the crypted value of the parameter BLOCKEDLOG_HMAC_KEY using the $dolibarr_main_crypt_key. A value was found in config parameters in database but decoding failed. May be the database data were restored onto another environment and the coding/decoding key $dolibarr_main_dolcrypt_key was not restored with the same value in conf.php file.';
        $this->error .= 'Restore the value of $dolibarr_main_crypt_key that was used for encryption in database and restart the migration.';
        $this->error .= 'If you don\'t use the Unalterable Log module, you can also remove the BLOCKEDLOG_HMAC_KEY entry from llx_const table. If you use the Unalterable Log, this is not possible because this will invalidate all past record.';
        $this->db->rollback();
 
        return 0;
      }
    }
 
    $this->db->commit();
 
 
    // We add an entry to show we enable module
 
    $object = new stdClass();
    $object->id = 0;
    $object->element = 'module';
    $object->ref = 'systemevent';
    $object->entity = $conf->entity;
    $object->date = dol_now();
 
    // Add first entry in unalterable Log to track that module was activated
    $action = 'MODULE_SET';
    $result = $b->setObjectData($object, $action, 0, $user, null);
 
    if ($result < 0) {
      $this->error = $b->error;
      $this->errors = $b->errors;
      return 0;
    }
 
    $res = $b->create($user);
    if ($res <= 0) {
      $this->error = $b->error;
      $this->errors = $b->errors;
      return $res;
    }
 
    return $this->_init($sql, $options);
  }
 
  public function remove($options = '')
  {
    global $conf, $user;
 
    $sql = array();
 
    // If already used, we add an entry to show we enable module
    require_once DOL_DOCUMENT_ROOT.'/blockedlog/class/blockedlog.class.php';
 
    dol_syslog("modBlockedLog::remove option=".$options, LOG_DEBUG);
 
    $object = new stdClass();
    $object->id = 1;
    $object->element = 'module';
    $object->ref = 'systemevent';
    $object->entity = $conf->entity;
    $object->date = dol_now();
    $object->label = 'Module disabled';
 
    $b = new BlockedLog($this->db);
    $result = $b->setObjectData($object, 'MODULE_RESET', 0, $user, null);
    if ($result < 0) {
      $this->error = $b->error;
      $this->errors = $b->errors;
      return 0;
    }
 
    if ($b->alreadyUsed(1)) {
      // Unalterable log was already used.
      if ($options != 'forcedisable' && !$b->canBeDisabled()) {
        // Case we refuse to disable it
        global $langs;
        $this->error = $langs->trans('DisablingBlockedLogIsNotallowedOnceUsedExceptOnFullreset', $langs->transnoentitiesnoconv('BlockedLog'));
        return 0;
      } else {
        // Case we disable it with a log
        $res = $b->create($user, '0000000000'); // If already used for something else than SET or UNSET, we log with error
      }
    } else {
      $res = $b->create($user);
    }
    if ($res <= 0) {
      $this->error = $b->error;
      $this->errors = $b->errors;
      return $res;
    }
 
    return $this->_remove($sql, $options);
  }
 
 
  public function getDesc($foruseinpopupdesc = 0)
  {
    global $langs;
    $langs->load("admin");
 
    // If module description translation exists
    $s = $langs->transnoentitiesnoconv("Module".$this->numero."Desc");
 
    if ($foruseinpopupdesc) {
      $langs->load("blockedlog");
      $s .= '<br><br>';
      if (isALNEQualifiedVersion(1, 1)) {
        $s .= info_admin($langs->trans("UnalterableLogTool1FR"), 0, 0, 'warning');
      }
    }
 
    return $s;
  }
}