Newer
Older
Angie Byron
committed
use Drupal\Component\Utility\Crypt;
Dries Buytaert
committed
use Drupal\Component\Utility\NestedArray;
use Drupal\Component\Utility\Settings;
Alex Pott
committed
use Drupal\Component\Utility\String;
Alex Pott
committed
use Drupal\Component\Utility\Timer;
use Drupal\Component\Utility\Unicode;
use Drupal\Component\Utility\Url;
use Drupal\Core\DrupalKernel;
use Drupal\Core\Database\Database;
use Drupal\Core\DependencyInjection\ContainerBuilder;
Dries Buytaert
committed
use Drupal\Core\Utility\Title;
catch
committed
use Drupal\Core\Utility\Error;
catch
committed
use Symfony\Component\ClassLoader\ApcClassLoader;
Angie Byron
committed
use Symfony\Component\DependencyInjection\ContainerInterface;
Katherine Bailey
committed
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\DependencyInjection\Reference;
Dries Buytaert
committed
use Symfony\Component\DependencyInjection\Exception\RuntimeException as DependencyInjectionRuntimeException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
Dries Buytaert
committed
use Drupal\Core\Language\Language;
use Drupal\Core\Lock\DatabaseLockBackend;
use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\Session\UserSession;
/**
* @file
* Functions that need to be loaded on every Drupal request.
*/
Dries Buytaert
committed
/**
* Minimum supported version of PHP.
*/
Dries Buytaert
committed
const DRUPAL_MINIMUM_PHP = '5.3.10';
Dries Buytaert
committed
/**
* Minimum recommended value of PHP memory_limit.
*/
const DRUPAL_MINIMUM_PHP_MEMORY_LIMIT = '32M';
Dries Buytaert
committed
Angie Byron
committed
/**
* Error reporting level: display no errors.
*/
const ERROR_REPORTING_HIDE = 'hide';
/**
* Error reporting level: display errors and warnings.
*/
const ERROR_REPORTING_DISPLAY_SOME = 'some';
/**
* Error reporting level: display all messages.
*/
const ERROR_REPORTING_DISPLAY_ALL = 'all';
/**
* Error reporting level: display all messages, plus backtrace information.
*/
const ERROR_REPORTING_DISPLAY_VERBOSE = 'verbose';
Angie Byron
committed
/**
* @defgroup logging_severity_levels Logging severity levels
* @{
* Logging severity levels as defined in RFC 3164.
*
* The WATCHDOG_* constant definitions correspond to the logging severity levels
catch
committed
* defined in RFC 3164, section 4.1.1. PHP supplies predefined LOG_* constants
Angie Byron
committed
* for use in the syslog() function, but their values on Windows builds do not
catch
committed
* correspond to RFC 3164. The associated PHP bug report was closed with the
Angie Byron
committed
* comment, "And it's also not a bug, as Windows just have less log levels,"
* and "So the behavior you're seeing is perfectly normal."
*
* @see http://www.faqs.org/rfcs/rfc3164.html
* @see http://bugs.php.net/bug.php?id=18090
* @see http://php.net/manual/function.syslog.php
* @see http://php.net/manual/network.constants.php
* @see watchdog()
* @see watchdog_severity_levels()
*/
/**
* Log message severity -- Emergency: system is unusable.
*/
const WATCHDOG_EMERGENCY = 0;
Angie Byron
committed
/**
* Log message severity -- Alert: action must be taken immediately.
*/
const WATCHDOG_ALERT = 1;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Critical conditions.
Angie Byron
committed
*/
const WATCHDOG_CRITICAL = 2;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Error conditions.
Angie Byron
committed
*/
const WATCHDOG_ERROR = 3;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Warning conditions.
Angie Byron
committed
*/
const WATCHDOG_WARNING = 4;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Normal but significant conditions.
Angie Byron
committed
*/
const WATCHDOG_NOTICE = 5;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Informational messages.
Angie Byron
committed
*/
const WATCHDOG_INFO = 6;
Angie Byron
committed
/**
Jennifer Hodgdon
committed
* Log message severity -- Debug-level messages.
Angie Byron
committed
*/
const WATCHDOG_DEBUG = 7;
Angie Byron
committed
/**
* @} End of "defgroup logging_severity_levels".
*/
/**
* First bootstrap phase: initialize configuration.
*/
const DRUPAL_BOOTSTRAP_CONFIGURATION = 0;
* Second bootstrap phase, initalize a kernel.
const DRUPAL_BOOTSTRAP_KERNEL = 1;
* Third bootstrap phase: try to serve a cached page.
const DRUPAL_BOOTSTRAP_PAGE_CACHE = 2;
* Fourth bootstrap phase: initialize the variable system.
const DRUPAL_BOOTSTRAP_VARIABLES = 3;
* Fifth bootstrap phase: load code for subsystems and modules.
const DRUPAL_BOOTSTRAP_CODE = 4;
* Final bootstrap phase: initialize language, path, theme, and modules.
const DRUPAL_BOOTSTRAP_FULL = 5;
/**
* Role ID for anonymous users; should match what's in the "role" table.
*/
catch
committed
const DRUPAL_ANONYMOUS_RID = 'anonymous';
/**
* Role ID for authenticated users; should match what's in the "role" table.
*/
catch
committed
const DRUPAL_AUTHENTICATED_RID = 'authenticated';
Dries Buytaert
committed
Dries Buytaert
committed
/**
catch
committed
* The number of bytes in a kilobyte.
*
* For more information, visit http://en.wikipedia.org/wiki/Kilobyte.
Dries Buytaert
committed
*/
const DRUPAL_KILOBYTE = 1024;
Dries Buytaert
committed
/**
* The maximum number of characters in a module or theme name.
*/
const DRUPAL_EXTENSION_NAME_MAX_LENGTH = 50;
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Time of the current request in seconds elapsed since the Unix Epoch.
Dries Buytaert
committed
*
Dries Buytaert
committed
* This differs from $_SERVER['REQUEST_TIME'], which is stored as a float
* since PHP 5.4.0. Float timestamps confuse most PHP functions
* (including date_create()).
*
* @see http://php.net/manual/reserved.variables.server.php
* @see http://php.net/manual/function.time.php
Dries Buytaert
committed
*/
Dries Buytaert
committed
define('REQUEST_TIME', (int) $_SERVER['REQUEST_TIME']);
Dries Buytaert
committed
/**
* Flag for drupal_set_title(); text has already been sanitized.
Dries Buytaert
committed
*
* @todo Move to the Title class.
const PASS_THROUGH = -1;
Dries Buytaert
committed
/**
* Regular expression to match PHP function names.
*
* @see http://php.net/manual/language.functions.php
Dries Buytaert
committed
*/
const DRUPAL_PHP_FUNCTION_PATTERN = '[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*';
Dries Buytaert
committed
Angie Byron
committed
/**
* $config_directories key for active directory.
*
Jennifer Hodgdon
committed
* @see config_get_config_directory()
Angie Byron
committed
*/
const CONFIG_ACTIVE_DIRECTORY = 'active';
/**
* $config_directories key for staging directory.
*
Jennifer Hodgdon
committed
* @see config_get_config_directory()
Angie Byron
committed
*/
const CONFIG_STAGING_DIRECTORY = 'staging';
Angie Byron
committed
/**
* Defines the root directory of the Drupal installation.
*
* This strips two levels of directories off the current directory.
*/
define('DRUPAL_ROOT', dirname(dirname(__DIR__)));
Alex Pott
committed
* @deprecated as of Drupal 8.0.
* @see \Drupal\Component\Utility\Timer::start
Alex Pott
committed
Timer::start($name);
Alex Pott
committed
* @deprecated as of Drupal 8.0.
* @see \Drupal\Component\Utility\Timer::read
Alex Pott
committed
return Timer::read($name);
Alex Pott
committed
* @deprecated as of Drupal 8.0.
* @see \Drupal\Component\Utility\Timer::stop
Alex Pott
committed
return Timer::stop($name);
Jennifer Hodgdon
committed
* Returns the appropriate configuration directory.
Jennifer Hodgdon
committed
* Returns the configuration path based on the site's hostname, port, and
* pathname. Uses find_conf_path() to find the current configuration directory.
* See default.settings.php for examples on how the URL is converted to a
* directory.
* @param bool $require_settings
* Only configuration directories with an existing settings.php file
* will be recognized. Defaults to TRUE. During initial installation,
* this is set to FALSE so that Drupal can detect a matching directory,
* then create a new settings.php file in it.
* @param bool $reset
* Force a full search for matching directories even if one had been
* found previously. Defaults to FALSE.
*
* @return
* The path of the matching directory.
Jennifer Hodgdon
committed
*
* @see default.settings.php
function conf_path($require_settings = TRUE, $reset = FALSE) {
Alex Pott
committed
$conf_path = &drupal_static(__FUNCTION__, '');
Alex Pott
committed
if ($conf_path && !$reset) {
return $conf_path;
Angie Byron
committed
// Check for a simpletest override.
if ($simpletest_conf_path = _drupal_simpletest_conf_path()) {
Alex Pott
committed
$conf_path = $simpletest_conf_path;
return $conf_path;
Angie Byron
committed
}
// Otherwise, use the normal $conf_path.
$script_name = $_SERVER['SCRIPT_NAME'];
if (!$script_name) {
$script_name = $_SERVER['SCRIPT_FILENAME'];
}
$http_host = $_SERVER['HTTP_HOST'];
Alex Pott
committed
$conf_path = find_conf_path($http_host, $script_name, $require_settings);
return $conf_path;
}
Angie Byron
committed
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/**
* Determines whether to use an overridden value for conf_path().
*
* Simpletest may provide a secondary, test-specific settings.php file to load
* after the primary one used by the parent site and override its variables.
* - If the child settings.php does not override $conf_path, then this function
* returns FALSE and conf_path() returns the directory of the primary
* settings.php.
* - If the child settings.php does override $conf_path, then
* _drupal_load_test_overrides() sets the 'simpletest_conf_path' setting, and
* this function returns that to conf_path(), causing installations and
* upgrades to act on that one.
*
* @return string|false
* The overridden $conf_path, or FALSE if the $conf_path should not currently
* be overridden.
*
* @see conf_path()
* @see _drupal_load_test_overrides()
*/
function _drupal_simpletest_conf_path() {
// Ensure that the settings object is available. conf_path() is called once
// before the Settings class is included, and at that point it should still
// load the primary $conf_path. See drupal_settings_initialize().
if (!class_exists('Drupal\Component\Utility\Settings', FALSE)) {
return FALSE;
}
// If no $simpletest_conf_path is set, use the normal $conf_path.
if (!($simpletest_conf_path = settings()->get('simpletest_conf_path'))) {
return FALSE;
}
// Ensure that this is actually a simpletest request. We can't check this
// before settings.php is loaded.
if (!drupal_valid_test_ua()) {
return FALSE;
}
// When the $simpletest_conf_path is set in a valid test request,
// return that path.
return $simpletest_conf_path;
}
/**
* Finds the appropriate configuration directory for a given host and path.
*
Jennifer Hodgdon
committed
* Finds a matching configuration directory file by stripping the website's
* hostname from left to right and pathname from right to left. By default,
* the directory must contain a 'settings.php' file for it to match. If the
* parameter $require_settings is set to FALSE, then a directory without a
* 'settings.php' file will match as well. The first configuration
* file found will be used and the remaining ones will be ignored. If no
* configuration file is found, returns a default value '$confdir/default'. See
* default.settings.php for examples on how the URL is converted to a directory.
*
* If a file named sites.php is present in the $confdir, it will be loaded
* prior to scanning for directories. That file can define aliases in an
* associative array named $sites. The array is written in the format
* '<port>.<domain>.<path>' => 'directory'. As an example, to create a
* directory alias for http://www.drupal.org:8080/mysite/test whose configuration
* file is in sites/example.com, the array should be defined as:
* @code
* $sites = array(
* '8080.www.drupal.org.mysite.test' => 'example.com',
* );
* @endcode
*
* @param $http_host
* The hostname and optional port number, e.g. "www.example.com" or
* "www.example.com:8080".
* @param $script_name
Angie Byron
committed
* The part of the URL following the hostname, including the leading slash.
Jennifer Hodgdon
committed
* @param $require_settings
* Defaults to TRUE. If TRUE, then only match directories with a
* 'settings.php' file. Otherwise match any directory.
*
* @return
* The path of the matching configuration directory.
*
Jennifer Hodgdon
committed
* @see default.settings.php
* @see example.sites.php
* @see conf_path()
*/
function find_conf_path($http_host, $script_name, $require_settings = TRUE) {
Angie Byron
committed
// Determine whether multi-site functionality is enabled.
if (!file_exists(DRUPAL_ROOT . '/sites/sites.php')) {
return 'sites/default';
}
$sites = array();
Angie Byron
committed
include DRUPAL_ROOT . '/sites/sites.php';
$uri = explode('/', $script_name);
$server = explode('.', implode('.', array_reverse(explode(':', rtrim($http_host, '.')))));
for ($i = count($uri) - 1; $i > 0; $i--) {
for ($j = count($server); $j > 0; $j--) {
$dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
Angie Byron
committed
if (isset($sites[$dir]) && file_exists(DRUPAL_ROOT . '/sites/' . $sites[$dir])) {
$dir = $sites[$dir];
}
Angie Byron
committed
if (file_exists(DRUPAL_ROOT . '/sites/' . $dir . '/settings.php') || (!$require_settings && file_exists(DRUPAL_ROOT . '/sites/' . $dir))) {
return "sites/$dir";
Angie Byron
committed
return 'sites/default';
/**
Angie Byron
committed
* Returns the path of a configuration directory.
*
* @param string $type
* (optional) The type of config directory to return. Drupal core provides
* 'active' and 'staging'. Defaults to CONFIG_ACTIVE_DIRECTORY.
*
* @return string
* The configuration directory path.
*/
Angie Byron
committed
function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) {
global $config_directories;
Angie Byron
committed
if (!empty($config_directories[$type])) {
catch
committed
return $config_directories[$type];
}
catch
committed
throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type)));
}
Dries Buytaert
committed
/**
catch
committed
* Sets appropriate server variables needed for command line scripts to work.
Dries Buytaert
committed
*
* This function can be called by command line scripts before bootstrapping
* Drupal, to ensure that the page loads with the desired server parameters.
* This is because many parts of Drupal assume that they are running in a web
* browser and therefore use information from the global PHP $_SERVER variable
* that does not get set when Drupal is run from the command line.
*
* In many cases, the default way in which this function populates the $_SERVER
* variable is sufficient, and it can therefore be called without passing in
* any input. However, command line scripts running on a multisite installation
* (or on any installation that has settings.php stored somewhere other than
* the sites/default folder) need to pass in the URL of the site to allow
* Drupal to detect the correct location of the settings.php file. Passing in
* the 'url' parameter is also required for functions like request_uri() to
* return the expected values.
*
* Most other parameters do not need to be passed in, but may be necessary in
* some cases; for example, if \Drupal::request()->getClientIP()
* needs to return anything but the standard localhost value ('127.0.0.1'),
* the command line script should pass in the desired value via the
* 'REMOTE_ADDR' key.
Dries Buytaert
committed
*
* @param $variables
Angie Byron
committed
* (optional) An associative array of variables within
* \Drupal::request()->server that should be replaced. If the special element
* 'url' is provided in this array, it will be used to populate some of the
* server defaults; it should be set to the URL of the current page request,
* excluding any GET request but including the script name
* (e.g., http://www.example.com/mysite/index.php).
Dries Buytaert
committed
*
* @see conf_path()
* @see request_uri()
* @see \Symfony\Component\HttpFoundation\Request::getClientIP()
Dries Buytaert
committed
*/
function drupal_override_server_variables($variables = array()) {
Angie Byron
committed
$request = \Drupal::request();
$server_vars = $request->server->all();
// Allow the provided URL to override any existing values in $_SERVER.
Dries Buytaert
committed
if (isset($variables['url'])) {
$url = parse_url($variables['url']);
if (isset($url['host'])) {
Angie Byron
committed
$server_vars['HTTP_HOST'] = $url['host'];
}
if (isset($url['path'])) {
Angie Byron
committed
$server_vars['SCRIPT_NAME'] = $url['path'];
Dries Buytaert
committed
unset($variables['url']);
}
// Define default values for $_SERVER keys. These will be used if $_SERVER
// does not already define them and no other values are passed in to this
// function.
Dries Buytaert
committed
$defaults = array(
'HTTP_HOST' => 'localhost',
'SCRIPT_NAME' => NULL,
Dries Buytaert
committed
'REMOTE_ADDR' => '127.0.0.1',
'REQUEST_METHOD' => 'GET',
'SERVER_NAME' => NULL,
Dries Buytaert
committed
'SERVER_SOFTWARE' => NULL,
Dries Buytaert
committed
'HTTP_USER_AGENT' => NULL,
);
// Replace elements of the $_SERVER array, as appropriate.
Angie Byron
committed
$request->server->replace($variables + $server_vars + $defaults);
// @todo remove once conf_path() no longer uses $_SERVER.
$_SERVER = $request->server->all();
Dries Buytaert
committed
}
Gerhard Killesreiter
committed
/**
catch
committed
* Initializes the PHP environment.
*/
Dries Buytaert
committed
function drupal_environment_initialize() {
if (!isset($_SERVER['HTTP_REFERER'])) {
$_SERVER['HTTP_REFERER'] = '';
Gerhard Killesreiter
committed
}
Dries Buytaert
committed
if (!isset($_SERVER['SERVER_PROTOCOL']) || ($_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.0' && $_SERVER['SERVER_PROTOCOL'] != 'HTTP/1.1')) {
$_SERVER['SERVER_PROTOCOL'] = 'HTTP/1.0';
}
Dries Buytaert
committed
if (isset($_SERVER['HTTP_HOST'])) {
// As HTTP_HOST is user input, ensure it only contains characters allowed
// in hostnames. See RFC 952 (and RFC 2181).
// $_SERVER['HTTP_HOST'] is lowercased here per specifications.
$_SERVER['HTTP_HOST'] = strtolower($_SERVER['HTTP_HOST']);
if (!drupal_valid_http_host($_SERVER['HTTP_HOST'])) {
// HTTP_HOST is invalid, e.g. if containing slashes it may be an attack.
header($_SERVER['SERVER_PROTOCOL'] . ' 400 Bad Request');
exit;
}
}
else {
// Some pre-HTTP/1.1 clients will not send a Host header. Ensure the key is
// defined for E_ALL compliance.
$_SERVER['HTTP_HOST'] = '';
Dries Buytaert
committed
}
Dries Buytaert
committed
// @todo Refactor with the Symfony Request object.
_current_path(request_path());
Larry Garfield
committed
Angie Byron
committed
// Enforce E_STRICT, but allow users to set levels not part of E_STRICT.
error_reporting(E_STRICT | E_ALL | error_reporting());
// Override PHP settings required for Drupal to work properly.
// sites/default/default.settings.php contains more runtime settings.
// The .htaccess file contains settings that cannot be changed at runtime.
// Deny execution with enabled "magic quotes" (both GPC and runtime).
if (get_magic_quotes_gpc() || get_magic_quotes_runtime()) {
header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error');
print "PHP's 'magic_quotes_gpc' and 'magic_quotes_runtime' settings are not supported and must be disabled.";
exit;
}
Dries Buytaert
committed
// Use session cookies, not transparent sessions that puts the session id in
// the query string.
ini_set('session.use_cookies', '1');
Dries Buytaert
committed
ini_set('session.use_only_cookies', '1');
ini_set('session.use_trans_sid', '0');
Dries Buytaert
committed
// Don't send HTTP headers using PHP's session handler.
Dries Buytaert
committed
// Send an empty string to disable the cache limiter.
ini_set('session.cache_limiter', '');
Dries Buytaert
committed
// Use httponly session cookies.
ini_set('session.cookie_httponly', '1');
// Set sane locale settings, to ensure consistent string, dates, times and
// numbers handling.
setlocale(LC_ALL, 'C');
Gerhard Killesreiter
committed
}
Dries Buytaert
committed
/**
catch
committed
* Validates that a hostname (for example $_SERVER['HTTP_HOST']) is safe.
Dries Buytaert
committed
*
* @return
* TRUE if only containing valid characters, or FALSE otherwise.
*/
function drupal_valid_http_host($host) {
return preg_match('/^\[?(?:[a-zA-Z0-9-:\]_]+\.?)+$/', $host);
Dries Buytaert
committed
}
catch
committed
* Sets the base URL, cookie domain, and session name from configuration.
Dries Buytaert
committed
function drupal_settings_initialize() {
Dries Buytaert
committed
global $base_url, $base_path, $base_root, $script_path;
Jennifer Hodgdon
committed
// Export these settings.php variables to the global namespace.
Alex Pott
committed
global $databases, $cookie_domain, $conf, $db_prefix, $drupal_hash_salt, $base_secure_url, $base_insecure_url, $config_directories;
// Make conf_path() available as local variable in settings.php.
$conf_path = conf_path();
if (is_readable(DRUPAL_ROOT . '/' . $conf_path . '/settings.php')) {
include_once DRUPAL_ROOT . '/' . $conf_path . '/settings.php';
Dries Buytaert
committed
}
require_once __DIR__ . '../../lib/Drupal/Component/Utility/Settings.php';
new Settings(isset($settings) ? $settings : array());
Dries Buytaert
committed
$is_https = isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) == 'on';
if (isset($base_url)) {
// Parse fixed base URL from settings.php.
$parts = parse_url($base_url);
Neil Drumm
committed
if (!isset($parts['path'])) {
$parts['path'] = '';
}
$base_path = $parts['path'] . '/';
// Build $base_root (everything until first slash after "scheme://").
$base_root = substr($base_url, 0, strlen($base_url) - strlen($parts['path']));
}
else {
// Create base URL
Dries Buytaert
committed
$http_protocol = $is_https ? 'https' : 'http';
Dries Buytaert
committed
$base_root = $http_protocol . '://' . $_SERVER['HTTP_HOST'];
Dries Buytaert
committed
$base_url = $base_root;
Dries Buytaert
committed
// For a request URI of '/index.php/foo', $_SERVER['SCRIPT_NAME'] is
// '/index.php', whereas $_SERVER['PHP_SELF'] is '/index.php/foo'.
Dries Buytaert
committed
if ($dir = rtrim(dirname($_SERVER['SCRIPT_NAME']), '\/')) {
Nate Lampton
committed
// Remove "core" directory if present, allowing install.php, update.php,
// and others to auto-detect a base path.
Nate Lampton
committed
$core_position = strrpos($dir, '/core');
if ($core_position !== FALSE && strlen($dir) - 5 == $core_position) {
$base_path = substr($dir, 0, $core_position);
}
else {
$base_path = $dir;
}
$base_url .= $base_path;
$base_path .= '/';
}
else {
$base_path = '/';
}
}
Dries Buytaert
committed
$base_secure_url = str_replace('http://', 'https://', $base_url);
$base_insecure_url = str_replace('https://', 'http://', $base_url);
Dries Buytaert
committed
Dries Buytaert
committed
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
// Determine the path of the script relative to the base path, and add a
// trailing slash. This is needed for creating URLs to Drupal pages.
if (!isset($script_path)) {
$script_path = '';
// We don't expect scripts outside of the base path, but sanity check
// anyway.
if (strpos($_SERVER['SCRIPT_NAME'], $base_path) === 0) {
$script_path = substr($_SERVER['SCRIPT_NAME'], strlen($base_path)) . '/';
// If the request URI does not contain the script name, then clean URLs
// are in effect and the script path can be similarly dropped from URL
// generation. For servers that don't provide $_SERVER['REQUEST_URI'], we
// do not know the actual URI requested by the client, and request_uri()
// returns a URI with the script name, resulting in non-clean URLs unless
// there's other code that intervenes.
if (strpos(request_uri(TRUE) . '/', $base_path . $script_path) !== 0) {
$script_path = '';
}
// @todo Temporary BC for install.php, update.php, and other scripts.
// - http://drupal.org/node/1547184
// - http://drupal.org/node/1546082
if ($script_path !== 'index.php/') {
$script_path = '';
}
}
}
Dries Buytaert
committed
if ($cookie_domain) {
// If the user specifies the cookie domain, also use it for session name.
$session_name = $cookie_domain;
}
else {
Gábor Hojtsy
committed
// Otherwise use $base_url as session name, without the protocol
Angie Byron
committed
// to use the same session identifiers across HTTP and HTTPS.
Gábor Hojtsy
committed
list( , $session_name) = explode('://', $base_url, 2);
// HTTP_HOST can be modified by a visitor, but we already sanitized it
// in drupal_settings_initialize().
Dries Buytaert
committed
if (!empty($_SERVER['HTTP_HOST'])) {
$cookie_domain = $_SERVER['HTTP_HOST'];
Dries Buytaert
committed
// Strip leading periods, www., and port numbers from cookie domain.
$cookie_domain = ltrim($cookie_domain, '.');
if (strpos($cookie_domain, 'www.') === 0) {
$cookie_domain = substr($cookie_domain, 4);
}
$cookie_domain = explode(':', $cookie_domain);
$cookie_domain = '.' . $cookie_domain[0];
Dries Buytaert
committed
}
}
// Per RFC 2109, cookie domains must contain at least one dot other than the
// first. For hosts such as 'localhost' or IP Addresses we don't set a cookie domain.
if (count(explode('.', $cookie_domain)) > 2 && !is_numeric(str_replace('.', '', $cookie_domain))) {
ini_set('session.cookie_domain', $cookie_domain);
}
Dries Buytaert
committed
// To prevent session cookies from being hijacked, a user can configure the
// SSL version of their website to only transfer session cookies via SSL by
// using PHP's session.cookie_secure setting. The browser will then use two
// separate session cookies for the HTTPS and HTTP versions of the site. So we
// must use different session identifiers for HTTPS and HTTP to prevent a
// cookie collision.
if ($is_https) {
ini_set('session.cookie_secure', TRUE);
}
$prefix = ini_get('session.cookie_secure') ? 'SSESS' : 'SESS';
Dries Buytaert
committed
session_name($prefix . substr(hash('sha256', $session_name), 0, 32));
catch
committed
* Returns and optionally sets the filename for a system resource.
*
* The filename, whether provided, cached, or retrieved from the database, is
* only returned if the file exists.
* This function plays a key role in allowing Drupal's resources (modules
* and themes) to be located in different places depending on a site's
Jennifer Hodgdon
committed
* configuration. For example, a module 'foo' may legally be located
* core/modules/foo/foo.module
* modules/foo/foo.module
* sites/example.com/modules/foo/foo.module
*
* Calling drupal_get_filename('module', 'foo') will give you one of
* the above, depending on where the module is located.
*
Jennifer Hodgdon
committed
* The type of the item (theme, theme_engine, module, profile).
* @param $name
* The name of the item for which the filename is requested.
* @param $filename
* The filename of the item if it is to be set explicitly rather
* than by consulting the database.
*
* @return
Jennifer Hodgdon
committed
* The filename of the requested item or NULL if the item is not found.
function drupal_get_filename($type, $name, $filename = NULL) {
// The location of files will not change during the request, so do not use
// drupal_static().
Dries Buytaert
committed
static $files = array(), $dirs = array();
// Profiles are converted into modules in system_rebuild_module_data().
// @todo Remove false-exposure of profiles as modules.
$original_type = $type;
if ($type == 'profile') {
$type = 'module';
if (!isset($files[$type])) {
Alex Pott
committed
if (!empty($filename)) {
elseif (isset($files[$type][$name])) {
// Verify that we have an keyvalue service before using it. This is required
// because this function is called during installation.
// @todo Inject database connection into KeyValueStore\DatabaseStorage.
if (($container = \Drupal::getContainer()) && $container->has('keyvalue') && function_exists('db_query')) {
Angie Byron
committed
if ($type == 'module') {
if (empty($files[$type])) {
$files[$type] = \Drupal::moduleHandler()->getModuleList();
Angie Byron
committed
}
if (isset($files[$type][$name])) {
return $files[$type][$name];
}
}
try {
$file_list = \Drupal::state()->get('system.' . $type . '.files');
if ($file_list && isset($file_list[$name]) && file_exists(DRUPAL_ROOT . '/' . $file_list[$name])) {
$files[$type][$name] = $file_list[$name];
Angie Byron
committed
}
Angie Byron
committed
}
catch (Exception $e) {
// The keyvalue service raised an exception because the backend might
// be down. We have a fallback for this case so we hide the error
// completely.
}
Angie Byron
committed
}
// Fallback to searching the filesystem if the database could not find the
// file or the file returned by the database is not found.
if (!isset($files[$type][$name])) {
// We have consistent directory naming: modules, themes...
Angie Byron
committed
$dir = $type . 's';
if ($type == 'theme_engine') {
$dir = 'themes/engines';
Angie Byron
committed
$extension = 'engine';
Angie Byron
committed
}
elseif ($type == 'theme') {
$extension = 'info.yml';
Angie Byron
committed
}
// Profiles are converted into modules in system_rebuild_module_data().
// @todo Remove false-exposure of profiles as modules.
elseif ($original_type == 'profile') {
$dir = 'profiles';
$extension = 'profile';
}
Angie Byron
committed
else {
Angie Byron
committed
$extension = $type;
Angie Byron
committed
}
Dries Buytaert
committed
if (!isset($dirs[$dir][$extension])) {
$dirs[$dir][$extension] = TRUE;
if (!function_exists('drupal_system_listing')) {
require_once __DIR__ . '/common.inc';
Dries Buytaert
committed
}
// Scan the appropriate directories for all files with the requested
// extension, not just the file we are currently looking for. This
// prevents unnecessary scans from being repeated when this function is
// called more than once in the same page request.
$matches = drupal_system_listing("/^" . DRUPAL_PHP_FUNCTION_PATTERN . "\.$extension$/", $dir);
Dries Buytaert
committed
foreach ($matches as $matched_name => $file) {
$files[$type][$matched_name] = $file->uri;
}
Steven Wittens
committed
if (isset($files[$type][$name])) {
return $files[$type][$name];
}
/**
* Returns a setting.
*
* Settings can be set in settings.php in the $settings array and requested
* by this function. Settings should be used over configuration for read-only,
* possibly low bootstrap configuration that is environment specific.
*
* @return \Drupal\Component\Utility\Settings
* The settings object.
*/
function settings() {
return Settings::getSingleton();
}
catch
committed
* Loads the persistent variable table.
*
* The variable table is composed of values that have been saved in the table
catch
committed
* with variable_set() as well as those explicitly specified in the
* configuration file.
Dries Buytaert
committed
function variable_initialize($conf = array()) {
Dries Buytaert
committed
// NOTE: caching the variables improves performance by 20% when serving
// cached pages.
Dries Buytaert
committed
if ($cached = cache('bootstrap')->get('variables')) {
Dries Buytaert
committed
$variables = $cached->data;
Dries Buytaert
committed
// Cache miss. Avoid a stampede.
$name = 'variable_init';
$lock = \Drupal::lock();
if (!$lock->acquire($name, 1)) {
Dries Buytaert
committed
// Another request is building the variable cache.
// Wait, then re-run this function.
$lock->wait($name);
Dries Buytaert
committed
return variable_initialize($conf);
}
else {
// Proceed with variable rebuild.
$variables = array_map('unserialize', db_query('SELECT name, value FROM {variable}')->fetchAllKeyed());
Dries Buytaert
committed
cache('bootstrap')->set('variables', $variables);
$lock->release($name);
Dries Buytaert
committed
}
}
foreach ($conf as $name => $value) {
$variables[$name] = $value;
Dries Buytaert
committed
* Returns a persistent variable.
*
* Case-sensitivity of the variable_* functions depends on the database
* collation used. To avoid problems, always use lower case for persistent
* variable names.
*
* @param $name
* The name of the variable to return.
* @param $default
* The default value to use if this variable has never been set.
Dries Buytaert
committed
*
Jennifer Hodgdon
committed
* The value of the variable. Unserialization is taken care of as necessary.
*
* @deprecated This will be removed in Drupal 8.0. Instead, use the
* configuration API.
*
* @see \Drupal\Core\Config::get()
function variable_get($name, $default = NULL) {
global $conf;
return isset($conf[$name]) ? $conf[$name] : $default;
}
Dries Buytaert
committed
* Sets a persistent variable.
*
* Case-sensitivity of the variable_* functions depends on the database
* collation used. To avoid problems, always use lower case for persistent
* variable names.
*
* @param $name
* The name of the variable to set.
* @param $value
* The value to set. This can be any PHP data type; these functions take care
* of serialization as necessary.
*
* @deprecated This will be removed in Drupal 8.0. Instead, use the
* configuration API.
*
* @see \Drupal\Core\Config::set()
Dries Buytaert
committed
db_merge('variable')->key(array('name' => $name))->fields(array('value' => serialize($value)))->execute();
Dries Buytaert
committed
cache('bootstrap')->delete('variables');
Dries Buytaert
committed
* Unsets a persistent variable.
*
* Case-sensitivity of the variable_* functions depends on the database
* collation used. To avoid problems, always use lower case for persistent
* variable names.
*
* @deprecated This will be removed in Drupal 8.0. Instead, use the
* configuration API.
*
* @see \Drupal\Core\Config::clear()
Dries Buytaert
committed
db_delete('variable')
->condition('name', $name)
->execute();
Dries Buytaert
committed
cache('bootstrap')->delete('variables');
/**
* Gets the page cache cid for this request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request for this page.
*
* @return string
* The cid for this request.
*/
function drupal_page_cache_get_cid(Request $request) {
$cid_parts = array(
$request->getUri(),
\Drupal::service('content_negotiation')->getContentType($request),
);
return sha1(implode(':', $cid_parts));
}
catch
committed
* Retrieves the current page from the cache.
Dries Buytaert
committed
* Note: we do not serve cached pages to authenticated users, or to anonymous
* users when $_SESSION is non-empty. $_SESSION may contain status messages
* from a form submission, the contents of a shopping cart, or other user-
* specific content that should not be cached and displayed to other users.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request for this page.
Dries Buytaert
committed
*
Dries Buytaert
committed
* @return
Dries Buytaert
committed
* The cache object, if the page was found in the cache, NULL otherwise.
function drupal_page_get_cache(Request $request) {
Dries Buytaert
committed
if (drupal_page_is_cacheable()) {
return \Drupal::cache('page')->get(drupal_page_cache_get_cid($request));
Dries Buytaert
committed
}
Dries Buytaert
committed
}
/**
catch
committed
* Determines the cacheability of the current page.
Dries Buytaert
committed
*
* @param $allow_caching
Dries Buytaert
committed
* Set to FALSE if you want to prevent this page to get cached.
*
Dries Buytaert
committed
* @return
Dries Buytaert
committed
* TRUE if the current page can be cached, FALSE otherwise.
Dries Buytaert
committed
*/
function drupal_page_is_cacheable($allow_caching = NULL) {
$allow_caching_static = &drupal_static(__FUNCTION__, TRUE);
if (isset($allow_caching)) {
$allow_caching_static = $allow_caching;
Dries Buytaert
committed
return $allow_caching_static && ($_SERVER['REQUEST_METHOD'] == 'GET' || $_SERVER['REQUEST_METHOD'] == 'HEAD')
Dries Buytaert
committed
&& !drupal_is_cli();
catch
committed
* Includes a file with the provided type and name.
*
* This prevents including a theme, engine, module, etc., more than once.
*
* @param $type
* The type of item to load (i.e. theme, theme_engine, module).
* @param $name