yaffs.net Git - yaffs-website/blob - web/core/lib/Drupal/Core/Site/Settings.php

   1 <?php
   2
   3 namespace Drupal\Core\Site;
   4
   5 use Drupal\Component\Utility\Crypt;
   6 use Drupal\Core\Database\Database;
   7
   8 /**
   9  * Read only settings that are initialized with the class.
  10  *
  11  * @ingroup utility
  12  */
  13 final class Settings {
  14
  15   /**
  16    * Array with the settings.
  17    *
  18    * @var array
  19    */
  20   private $storage = [];
  21
  22   /**
  23    * Singleton instance.
  24    *
  25    * @var \Drupal\Core\Site\Settings
  26    */
  27   private static $instance = NULL;
  28
  29   /**
  30    * Constructor.
  31    *
  32    * @param array $settings
  33    *   Array with the settings.
  34    */
  35   public function __construct(array $settings) {
  36     $this->storage = $settings;
  37     self::$instance = $this;
  38   }
  39
  40   /**
  41    * Returns the settings instance.
  42    *
  43    * A singleton is used because this class is used before the container is
  44    * available.
  45    *
  46    * @return \Drupal\Core\Site\Settings
  47    *
  48    * @throws \BadMethodCallException
  49    *   Thrown when the settings instance has not been initialized yet.
  50    */
  51   public static function getInstance() {
  52     if (self::$instance === NULL) {
  53       throw new \BadMethodCallException('Settings::$instance is not initialized yet. Whatever you are trying to do, it might be too early for that. You could call Settings::initialize(), but it is probably better to wait until it is called in the regular way. Also check for recursions.');
  54     }
  55     return self::$instance;
  56   }
  57
  58   /**
  59    * Protects creating with clone.
  60    */
  61   private function __clone() {
  62   }
  63
  64   /**
  65    * Prevents settings from being serialized.
  66    */
  67   public function __sleep() {
  68     throw new \LogicException('Settings can not be serialized. This probably means you are serializing an object that has an indirect reference to the Settings object. Adjust your code so that is not necessary.');
  69   }
  70
  71   /**
  72    * Returns a setting.
  73    *
  74    * Settings can be set in settings.php in the $settings array and requested
  75    * by this function. Settings should be used over configuration for read-only,
  76    * possibly low bootstrap configuration that is environment specific.
  77    *
  78    * @param string $name
  79    *   The name of the setting to return.
  80    * @param mixed $default
  81    *   (optional) The default value to use if this setting is not set.
  82    *
  83    * @return mixed
  84    *   The value of the setting, the provided default if not set.
  85    */
  86   public static function get($name, $default = NULL) {
  87     if ($name === 'install_profile' && isset(self::$instance->storage[$name])) {
  88       @trigger_error('To access the install profile in Drupal 8 use \Drupal::installProfile() or inject the install_profile container parameter into your service. See https://www.drupal.org/node/2538996', E_USER_DEPRECATED);
  89     }
  90     return isset(self::$instance->storage[$name]) ? self::$instance->storage[$name] : $default;
  91   }
  92
  93   /**
  94    * Returns all the settings. This is only used for testing purposes.
  95    *
  96    * @return array
  97    *   All the settings.
  98    */
  99   public static function getAll() {
 100     return self::$instance->storage;
 101   }
 102
 103   /**
 104    * Bootstraps settings.php and the Settings singleton.
 105    *
 106    * @param string $app_root
 107    *   The app root.
 108    * @param string $site_path
 109    *   The current site path.
 110    * @param \Composer\Autoload\ClassLoader $class_loader
 111    *   The class loader that is used for this request. Passed by reference and
 112    *   exposed to the local scope of settings.php, so as to allow it to be
 113    *   decorated with Symfony's ApcClassLoader, for example.
 114    *
 115    * @see default.settings.php
 116    */
 117   public static function initialize($app_root, $site_path, &$class_loader) {
 118     // Export these settings.php variables to the global namespace.
 119     global $config_directories, $config;
 120     $settings = [];
 121     $config = [];
 122     $databases = [];
 123
 124     if (is_readable($app_root . '/' . $site_path . '/settings.php')) {
 125       require $app_root . '/' . $site_path . '/settings.php';
 126     }
 127
 128     // Initialize Database.
 129     Database::setMultipleConnectionInfo($databases);
 130
 131     // Initialize Settings.
 132     new Settings($settings);
 133   }
 134
 135   /**
 136    * Gets a salt useful for hardening against SQL injection.
 137    *
 138    * @return string
 139    *   A salt based on information in settings.php, not in the database.
 140    *
 141    * @throws \RuntimeException
 142    */
 143   public static function getHashSalt() {
 144     $hash_salt = self::$instance->get('hash_salt');
 145     // This should never happen, as it breaks user logins and many other
 146     // services. Therefore, explicitly notify the user (developer) by throwing
 147     // an exception.
 148     if (empty($hash_salt)) {
 149       throw new \RuntimeException('Missing $settings[\'hash_salt\'] in settings.php.');
 150     }
 151
 152     return $hash_salt;
 153   }
 154
 155   /**
 156    * Generates a prefix for APCu user cache keys.
 157    *
 158    * A standardized prefix is useful to allow visual inspection of an APCu user
 159    * cache. By default, this method will produce a unique prefix per site using
 160    * the hash salt. If the setting 'apcu_ensure_unique_prefix' is set to FALSE
 161    * then if the caller does not provide a $site_path only the Drupal root will
 162    * be used. This allows tests to use the same prefix ensuring that the number
 163    * of APCu items created during a full test run is kept to a minimum.
 164    * Additionally, if a multi site implementation does not use site specific
 165    * module directories setting apcu_ensure_unique_prefix would allow the sites
 166    * to share APCu cache items.
 167    *
 168    * @param $identifier
 169    *   An identifier for the prefix. For example, 'class_loader' or
 170    *   'cache_backend'.
 171    *
 172    * @return string
 173    *   The prefix for APCu user cache keys.
 174    *
 175    * @see https://www.drupal.org/project/drupal/issues/2926309
 176    */
 177   public static function getApcuPrefix($identifier, $root, $site_path = '') {
 178     if (static::get('apcu_ensure_unique_prefix', TRUE)) {
 179       return 'drupal.' . $identifier . '.' . \Drupal::VERSION . '.' . static::get('deployment_identifier') . '.' . hash_hmac('sha256', $identifier, static::get('hash_salt') . '.' . $root . '/' . $site_path);
 180     }
 181     return 'drupal.' . $identifier . '.' . \Drupal::VERSION . '.' . static::get('deployment_identifier') . '.' . Crypt::hashBase64($root . '/' . $site_path);
 182   }
 183
 184 }