diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index fa1335b..b0a1544 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -359,56 +359,14 @@ function timer_stop($name) { } /** - * Finds the appropriate configuration directory. + * Returns the appropriate configuration directory. * - * Finds a matching configuration directory by stripping the website's - * hostname from left to right and pathname from right to left. The first - * configuration file found will be used and the remaining ones will be ignored. - * If no configuration file is found, return a default value '$confdir/default'. + * 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. * - * With a site located at http://www.example.com:8080/mysite/test/, the file, - * settings.php, is searched for in the following directories: - * - * - $confdir/8080.www.example.com.mysite.test - * - $confdir/www.example.com.mysite.test - * - $confdir/example.com.mysite.test - * - $confdir/com.mysite.test - * - * - $confdir/8080.www.example.com.mysite - * - $confdir/www.example.com.mysite - * - $confdir/example.com.mysite - * - $confdir/com.mysite - * - * - $confdir/8080.www.example.com - * - $confdir/www.example.com - * - $confdir/example.com - * - $confdir/com - * - * - $confdir/default - * - * If a file named sites.php is present in the $confdir, it will be loaded - * prior to scanning for directories. It should define an associative array - * named $sites, which maps domains to directories. It should be in the form - * of: - * @code - * $sites = array( - * 'The url to alias' => 'A directory within the sites directory' - * ); - * @endcode - * For example: - * @code - * $sites = array( - * 'devexample.com' => 'example.com', - * 'localhost.example' => 'example.com', - * ); - * @endcode - * The above array will cause Drupal to look for a directory named - * "example.com" in the sites directory whenever a request comes from - * "example.com", "devexample.com", or "localhost/example". That is useful - * on development servers, where the domain name may not be the same as the - * domain of the live server. Since Drupal stores file paths into the database - * (files, system table, etc.) this will ensure the paths are correct while - * accessed on development servers. + * @see default.settings.php * * @param bool $require_settings * Only configuration directories with an existing settings.php file @@ -441,6 +399,22 @@ function conf_path($require_settings = TRUE, $reset = FALSE) { /** * Finds the appropriate configuration directory for a given host and path. * + * Finds a matching configuration directory by stripping the website's hostname + * from left to right and pathname from right to left. 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. It should define an associative array + * named $sites, which maps domains to directories. $sites should be in the form + * of: + * @code + * $sites = array( + * 'The URL to alias' => 'A directory within the sites directory', + * ); + * @endcode + * * @param $http_host * The hostname and optional port number, e.g. "www.example.com" or * "www.example.com:8080". @@ -450,6 +424,8 @@ function conf_path($require_settings = TRUE, $reset = FALSE) { * @return * The path of the matching configuration directory. * + * @see default.settings.php + * @see example.sites.php * @see conf_path() */ function find_conf_path($http_host, $script_name, $require_settings = TRUE) { diff --git a/sites/default/default.settings.php b/sites/default/default.settings.php index 79f3067..fa8b716 100755 --- a/sites/default/default.settings.php +++ b/sites/default/default.settings.php @@ -5,41 +5,52 @@ * Drupal site-specific configuration file. * * IMPORTANT NOTE: - * This file may have been set to read-only by the Drupal installation - * program. If you make changes to this file, be sure to protect it again - * after making your modifications. Failure to remove write permissions - * to this file is a security risk. + * This file may have been set to read-only by the Drupal installation program. + * If you make changes to this file, be sure to protect it again after making + * your modifications. Failure to remove write permissions to this file is a + * security risk. * * The configuration file to be loaded is based upon the rules below. * - * The configuration directory will be discovered by stripping the - * website's hostname from left to right and pathname from right to - * left. The first configuration file found will be used and any - * others will be ignored. If no other configuration file is found - * then the default configuration file at 'sites/default' will be used. + * If the multisite aliasing file named sites/sites.php is present, it will be + * loaded, and the aliases in the array $sites will override the default + * directory rules below. See sites/example.sites.php for more information about + * aliases. + * + * The configuration directory will be discovered by stripping the website's + * hostname from left to right and pathname from right to left. The first + * configuration file found will be used and any others will be ignored. If no + * other configuration file is found then the default configuration file at + * 'sites/default' will be used. * * For example, for a fictitious site installed at - * http://www.drupal.org/mysite/test/, the 'settings.php' - * is searched in the following directories: + * http://www.drupal.org:8080/mysite/test/, the 'settings.php' is searched in + * the following directories: * + * - sites/8080.www.drupal.org.mysite.test * - sites/www.drupal.org.mysite.test * - sites/drupal.org.mysite.test * - sites/org.mysite.test * + * - sites/8080.www.drupal.org.mysite * - sites/www.drupal.org.mysite * - sites/drupal.org.mysite * - sites/org.mysite * + * - sites/8080.www.drupal.org * - sites/www.drupal.org * - sites/drupal.org * - sites/org * * - sites/default * - * If you are installing on a non-standard port number, prefix the + * Notice that if you are installing on a non-standard port number, prefix the * hostname with that number. For example, * http://www.drupal.org:8080/mysite/test/ could be loaded from * sites/8080.www.drupal.org.mysite.test/. + * + * @see example.sites.php + * @see conf_path() */ /** diff --git a/sites/example.sites.php b/sites/example.sites.php index 08c1020..f512f76 100644 --- a/sites/example.sites.php +++ b/sites/example.sites.php @@ -4,40 +4,65 @@ * @file * Configuration file for Drupal's multi-site directory aliasing feature. * - * Drupal searches for an appropriate configuration directory based on the - * website's hostname and pathname. A detailed description of the rules for - * discovering the configuration directory can be found in the comment - * documentation in 'sites/default/default.settings.php'. + * This file allows you to define a set of aliases that map hostnames, ports, and + * pathnames to configuration directories in the sites directory. These aliases + * are loaded prior to scanning for directories, and they are exempt from the + * normal discovery rules. See default.settings.php to view how Drupal discovers + * the configuration directory when no alias is found. * - * This file allows you to define a set of aliases that map hostnames and - * pathnames to configuration directories. These aliases are loaded prior to - * scanning for directories, and they are exempt from the normal discovery - * rules. The aliases are defined in an associative array named $sites, which - * should look similar to the following: - * - * $sites = array( - * 'devexample.com' => 'example.com', - * 'localhost.example' => 'example.com', - * ); - * - * The above array will cause Drupal to look for a directory named - * "example.com" in the sites directory whenever a request comes from - * "example.com", "devexample.com", or "localhost/example". That is useful - * on development servers, where the domain name may not be the same as the - * domain of the live server. Since Drupal stores file paths into the database - * (files, system table, etc.) this will ensure the paths are correct while - * accessed on development servers. + * Aliases are useful on development servers, where the domain name may not be + * the same as the domain of the live server. Since Drupal stores file paths in + * the database (files, system table, etc.) this will ensure the paths are + * correct when the site is deployed to a live server. * * To use this file, copy and rename it such that its path plus filename is * 'sites/sites.php'. If you don't need to use multi-site directory aliasing, * then you can safely ignore this file, and Drupal will ignore it too. + * + * Aliases are defined in an associative array named $sites. The array is + * written in the format: '..' => '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 written as such: + * @code + * $sites = array( + * '8080.www.drupal.org.mysite.test' => 'example.com', + * ); + * @endcode + * The URL, http://www.drupal.org:8080/mysite/test/, could be a symbolic link or + * an Apache Alias directive that points to the Drupal root containing + * index.php. An alias could also be created for a subdomain. See the + * @link http://drupal.org/documentation/install online Drupal installation guide @endlink + * for more information on setting up domains, subdomains, and subdirectories. + * + * @see default.settings.php + * @see conf_path() + * @see http://drupal.org/documentation/install/multi-site */ /** - * Multi-site directory aliasing: + * Example multi-site directory aliases. + * + * $sites should define an associative array which maps domains to directories. + * It should be in the form of: + * @code + * $sites = array( + * '..' => 'directory', + * ); + * @endcode + * + * The following examples look for a site configuration in sites/example.com + * @code + * URL: http://dev.drupal.org + * $sites['dev.drupal.org'] = 'example.com'; + * + * URL: http://localhost/example + * $sites['localhost.example'] = 'example.com'; + * + * URL: http://localhost:8080/example + * $sites['8080.localhost.example'] = 'example.com'; * - * Edit the lines below to define directory aliases. Remove the leading hash - * signs to enable. + * URL: http://www.drupal.org:8080/mysite/test/ + * $sites['8080.www.drupal.org.mysite.test'] = 'example.com'; + * @endcode */ -# $sites['devexample.com'] = 'example.com'; -# $sites['localhost.example'] = 'example.com';