modules_genpassword.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2011 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2024-2026  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.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/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/lib/security2.lib.php'; // For isPasswordGenerationNoneForbidden()
 
 
abstract class ModeleGenPassword
{
  public $id;
 
  public $version;
 
  public $picto = 'generic';
 
  public $WithoutAmbi = 0;
 
  public $error = '';
 
  public $db;
 
  public $conf;
 
  public $langs;
 
  public $user;
 
  public $length;
 
  public $length2;
 
  public function isEnabled()
  {
    return true;
  }
 
  public function getDescription()
  {
    global $langs;
    return $langs->trans("NoDescription");
  }
 
  public function getExample()
  {
    global $langs;
    $langs->load("bills");
    return $langs->trans("NoExample");
  }
 
  public function getNewGeneratedPassword()
  {
    global $langs;
    return $langs->trans("NotAvailable");
  }
 
  public function validatePassword($password)
  {
    return 1;
  }
 
  public static function loadAndInstantiate($id, $db, $conf, $langs, $user)
  {
    if (empty($id)) {
      return null;
    }
 
    // The 'none' model applies no rule at all. When it is forbidden (conf.php lock),
    // transparently fall back to the always-available 'standard' model so an installation still
    // configured with 'none' enforces a real rule at generation and validation time, without
    // having to rewrite the stored USER_PASSWORD_GENERATED value.
    if (strtolower($id) === 'none' && isPasswordGenerationNoneForbidden()) {
      $id = 'standard';
    }
 
    $classname = 'modGeneratePass'.ucfirst($id);
 
    $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
    foreach ($dirmodels as $reldir) {
      $file = dol_buildpath($reldir.'core/modules/security/generate/').$classname.'.class.php';
      if (is_file($file)) {
        require_once $file;
        if (class_exists($classname)) {
          return new $classname($db, $conf, $langs, $user);
        }
      }
    }
 
    return null;
  }
}