1 files changed, 193 insertions, 109 deletions

diff --git a/engine/lib/configuration.php b/engine/lib/configuration.php
index 5adc4bddc..55e5bbd36 100644
--- a/engine/lib/configuration.php
+++ b/engine/lib/configuration.php
@@ -3,8 +3,9 @@
  * Elgg configuration procedural code.
  *
  * Includes functions for manipulating the configuration values stored in the database
- * Plugin authors should use the {@link get_config()}, {@link set_config()},
- * and {@unset_config()} functions to access or update config values.
+ * Plugin authors should use the {@link elgg_get_config()}, {@link elgg_set_config()},
+ * {@link elgg_save_config()}, and {@unset_config()} functions to access or update
+ * config values.
  *
  * Elgg's configuration is split among 2 tables and 1 file:
  * - dbprefix_config
@@ -35,6 +36,7 @@ function elgg_get_site_url($site_guid = 0) {
 	if (!$site instanceof ElggSite) {
 		return false;
 	}
+	/* @var ElggSite $site */
 
 	return $site->url;
 }
@@ -45,7 +47,7 @@ function elgg_get_site_url($site_guid = 0) {
  * @return string
  * @since 1.8.0
  */
-function elgg_get_plugin_path() {
+function elgg_get_plugins_path() {
 	global $CONFIG;
 	return $CONFIG->pluginspath;
 }
@@ -62,12 +64,23 @@ function elgg_get_data_path() {
 }
 
 /**
+ * Get the root directory path for this installation
+ *
+ * @return string
+ * @since 1.8.0
+ */
+function elgg_get_root_path() {
+	global $CONFIG;
+	return $CONFIG->path;
+}
+
+/**
  * Get an Elgg configuration value
  *
  * @param string $name      Name of the configuration value
  * @param int    $site_guid NULL for installation setting, 0 for default site
  *
- * @return mixed Configuration value or false if it does not exist
+ * @return mixed Configuration value or null if it does not exist
  * @since 1.8.0
  */
 function elgg_get_config($name, $site_guid = 0) {
@@ -79,23 +92,29 @@ function elgg_get_config($name, $site_guid = 0) {
 		return $CONFIG->$name;
 	}
 
-	if ($site_guid === NULL) {
+	if ($site_guid === null) {
 		// installation wide setting
 		$value = datalist_get($name);
 	} else {
-		// site specific setting
-		if ($site_guid == 0) {
-			$site_guid = (int) $CONFIG->site_id;
+		// hit DB only if we're not sure if value exists or not
+		if (!isset($CONFIG->site_config_loaded)) {
+			// site specific setting
+			if ($site_guid == 0) {
+				$site_guid = (int) $CONFIG->site_id;
+			}
+			$value = get_config($name, $site_guid);
+		} else {
+			$value = null;
 		}
-		$value = get_config($name, $site_guid);
 	}
 
-	if ($value !== false) {
-		$CONFIG->$name = $value;
-		return $value;
+	// @todo document why we don't cache false
+	if ($value === false) {
+		return null;
 	}
-	
-	return false;
+
+	$CONFIG->$name = $value;
+	return $value;
 }
 
 /**
@@ -120,7 +139,7 @@ function elgg_set_config($name, $value) {
 /**
  * Save a configuration setting
  *
- * @param string $name      Configuration name
+ * @param string $name      Configuration name (cannot be greater than 255 characters)
  * @param mixed  $value     Configuration value. Should be string for installation setting
  * @param int    $site_guid NULL for installation setting, 0 for default site
  *
@@ -132,6 +151,11 @@ function elgg_save_config($name, $value, $site_guid = 0) {
 
 	$name = trim($name);
 
+	if (strlen($name) > 255) {
+		elgg_log("The name length for configuration variables cannot be greater than 255", "ERROR");
+		return false;
+	}
+
 	elgg_set_config($name, $value);
 
 	if ($site_guid === NULL) {
@@ -150,14 +174,15 @@ function elgg_save_config($name, $value, $site_guid = 0) {
 /**
  * Check that installation has completed and the database is populated.
  *
- * @throws InstallationException
+ * @throws InstallationException|DatabaseException
  * @return void
+ * @access private
  */
 function verify_installation() {
 	global $CONFIG;
 
 	if (isset($CONFIG->installed)) {
-		return $CONFIG->installed;
+		return;
 	}
 
 	try {
@@ -194,13 +219,21 @@ $DATALIST_CACHE = array();
  *
  * @tip Use datalists to store information common to a full installation.
  *
- * @param string $name The name of the datalist element
- *
- * @return string|false The datalist value or false if it doesn't exist.
+ * @param string $name The name of the datalist
+ * @return string|null|false String if value exists, null if doesn't, false on error
+ * @access private
  */
 function datalist_get($name) {
 	global $CONFIG, $DATALIST_CACHE;
 
+	$name = trim($name);
+
+	// cannot store anything longer than 255 characters in db, so catch here
+	if (elgg_strlen($name) > 255) {
+		elgg_log("The name length for configuration variables cannot be greater than 255", "ERROR");
+		return false;
+	}
+
 	$name = sanitise_string($name);
 	if (isset($DATALIST_CACHE[$name])) {
 		return $DATALIST_CACHE[$name];
@@ -239,7 +272,7 @@ function datalist_get($name) {
 		}
 	}
 
-	return false;
+	return null;
 }
 
 /**
@@ -248,13 +281,20 @@ function datalist_get($name) {
  * @param string $name  The name of the datalist
  * @param string $value The new value
  *
- * @return true
+ * @return bool
+ * @access private
  */
 function datalist_set($name, $value) {
 	global $CONFIG, $DATALIST_CACHE;
 
-	$name = sanitise_string($name);
-	$value = sanitise_string($value);
+	// cannot store anything longer than 255 characters in db, so catch before we set
+	if (elgg_strlen($name) > 255) {
+		elgg_log("The name length for configuration variables cannot be greater than 255", "ERROR");
+		return false;
+	}
+
+	$sanitised_name = sanitise_string($name);
+	$sanitised_value = sanitise_string($value);
 
 	// If memcache is available then invalidate the cached copy
 	static $datalist_memcache;
@@ -266,13 +306,16 @@ function datalist_set($name, $value) {
 		$datalist_memcache->delete($name);
 	}
 
-	insert_data("INSERT into {$CONFIG->dbprefix}datalists"
-		. " set name = '{$name}', value = '{$value}'"
-		. " ON DUPLICATE KEY UPDATE value='{$value}'");
-
-	$DATALIST_CACHE[$name] = $value;
+	$success = insert_data("INSERT into {$CONFIG->dbprefix}datalists"
+		. " set name = '{$sanitised_name}', value = '{$sanitised_value}'"
+		. " ON DUPLICATE KEY UPDATE value='{$sanitised_value}'");
 
-	return true;
+	if ($success !== FALSE) {
+		$DATALIST_CACHE[$name] = $value;
+		return true;
+	} else {
+		return false;
+	}
 }
 
 /**
@@ -290,6 +333,9 @@ function datalist_set($name, $value) {
  * This will cause the run once function to be run on all installations.  To perform
  * additional upgrades, create new functions for each release.
  *
+ * @warning The function name cannot be longer than 255 characters long due to
+ * the current schema for the datalist table.
+ *
  * @internal A datalist entry $functioname is created with the value of time().
  *
  * @param string $functionname         The name of the function you want to run.
@@ -299,10 +345,14 @@ function datalist_set($name, $value) {
  * @return bool
  */
 function run_function_once($functionname, $timelastupdatedcheck = 0) {
-	if ($lastupdated = datalist_get($functionname)) {
+	$lastupdated = datalist_get($functionname);
+	if ($lastupdated) {
 		$lastupdated = (int) $lastupdated;
-	} else {
+	} elseif ($lastupdated !== false) {
 		$lastupdated = 0;
+	} else {
+		// unable to check datalist
+		return false;
 	}
 	if (is_callable($functionname) && $lastupdated <= $timelastupdatedcheck) {
 		$functionname();
@@ -358,15 +408,24 @@ function unset_config($name, $site_guid = 0) {
  * @param string $value     Its value
  * @param int    $site_guid Optionally, the GUID of the site (current site is assumed by default)
  *
- * @return 0
+ * @return bool
  * @todo The config table doens't have numeric primary keys so insert_data returns 0.
  * @todo Use "INSERT ... ON DUPLICATE KEY UPDATE" instead of trying to delete then add.
  * @see unset_config()
  * @see get_config()
+ * @access private
  */
 function set_config($name, $value, $site_guid = 0) {
 	global $CONFIG;
 
+	$name = trim($name);
+
+	// cannot store anything longer than 255 characters in db, so catch before we set
+	if (elgg_strlen($name) > 255) {
+		elgg_log("The name length for configuration variables cannot be greater than 255", "ERROR");
+		return false;
+	}
+
 	// Unset existing
 	unset_config($name, $site_guid);
 
@@ -379,7 +438,8 @@ function set_config($name, $value, $site_guid = 0) {
 
 	$query = "insert into {$CONFIG->dbprefix}config"
 		. " set name = '{$name}', value = '{$value}', site_guid = {$site_guid}";
-	return insert_data($query);
+	$result = insert_data($query);
+	return $result !== false;
 }
 
 /**
@@ -392,30 +452,65 @@ function set_config($name, $value, $site_guid = 0) {
  * @param string $name      The name of the config value
  * @param int    $site_guid Optionally, the GUID of the site (current site is assumed by default)
  *
- * @return mixed|false
+ * @return mixed|null
  * @see set_config()
  * @see unset_config()
+ * @access private
  */
 function get_config($name, $site_guid = 0) {
 	global $CONFIG;
 
+	$name = sanitise_string($name);
+	$site_guid = (int) $site_guid;
+
+	// check for deprecated values.
+	// @todo might be a better spot to define this?
+	$new_name = false;
+	switch($name) {
+		case 'viewpath':
+			$new_name = 'view_path';
+			$dep_version = 1.8;
+			break;
+
+		case 'pluginspath':
+			$new_name = 'plugins_path';
+			$dep_version = 1.8;
+			break;
+
+		case 'sitename':
+			$new_name = 'site_name';
+			$dep_version = 1.8;
+			break;
+	}
+
+	// @todo these haven't really been implemented in Elgg 1.8. Complete in 1.9.
+	// show dep message
+	if ($new_name) {
+		//	$msg = "Config value $name has been renamed as $new_name";
+		$name = $new_name;
+		//	elgg_deprecated_notice($msg, $dep_version);
+	}
+
+	// decide from where to return the value
 	if (isset($CONFIG->$name)) {
 		return $CONFIG->$name;
 	}
-	$name = sanitise_string($name);
-	$site_guid = (int) $site_guid;
+
 	if ($site_guid == 0) {
 		$site_guid = (int) $CONFIG->site_id;
 	}
-	if ($result = get_data_row("SELECT value FROM {$CONFIG->dbprefix}config
-		WHERE name = '{$name}' and site_guid = {$site_guid}")) {
+
+	$result = get_data_row("SELECT value FROM {$CONFIG->dbprefix}config
+		WHERE name = '{$name}' and site_guid = {$site_guid}");
+
+	if ($result) {
 		$result = $result->value;
 		$result = unserialize($result->value);
 		$CONFIG->$name = $result;
 		return $result;
 	}
 
-	return false;
+	return null;
 }
 
 /**
@@ -424,6 +519,7 @@ function get_config($name, $site_guid = 0) {
  * @param int $site_guid Optionally, the GUID of the site (current site is assumed by default)
  *
  * @return bool
+ * @access private
  */
 function get_all_config($site_guid = 0) {
 	global $CONFIG;
@@ -431,10 +527,10 @@ function get_all_config($site_guid = 0) {
 	$site_guid = (int) $site_guid;
 
 	if ($site_guid == 0) {
-		$site_guid = (int) $CONFIG->site_id;
+		$site_guid = (int) $CONFIG->site_guid;
 	}
 
-	if ($result = get_data("SELECT * from {$CONFIG->dbprefix}config where site_guid = {$site_guid}")) {
+	if ($result = get_data("SELECT * FROM {$CONFIG->dbprefix}config WHERE site_guid = $site_guid")) {
 		foreach ($result as $r) {
 			$name = $r->name;
 			$value = $r->value;
@@ -447,72 +543,59 @@ function get_all_config($site_guid = 0) {
 }
 
 /**
- * Sets defaults for or attempts to autodetect some common config values and
- * loads them into $CONFIG.
+ * Loads configuration related to this site
  *
- * @return void
+ * This loads from the config database table and the site entity
+ * @access private
  */
-function set_default_config() {
+function _elgg_load_site_config() {
 	global $CONFIG;
 
-	if (empty($CONFIG->path)) {
-		$CONFIG->path = str_replace("\\", "/", dirname(dirname(dirname(__FILE__)))) . "/";
-	}
-
-	if (empty($CONFIG->viewpath)) {
-		$CONFIG->viewpath = $CONFIG->path . "views/";
-	}
-
-	if (empty($CONFIG->pluginspath)) {
-		$CONFIG->pluginspath = $CONFIG->path . "mod/";
-	}
-
-	if (empty($CONFIG->wwwroot)) {
-		/*
-		$CONFIG->wwwroot = "http://" . $_SERVER['SERVER_NAME'];
-
-		$request = $_SERVER['REQUEST_URI'];
-
-		if (strripos($request,"/") < (strlen($request) - 1)) {
-			// addressing a file directly, not a dir
-			$request = substr($request, 0, strripos($request,"/")+1);
-		}
-
-		$CONFIG->wwwroot .= $request;
-		*/
-		$pathpart = str_replace("//", "/", str_replace($_SERVER['DOCUMENT_ROOT'], "", $CONFIG->path));
-		if (substr($pathpart, 0, 1) != "/") {
-			$pathpart = "/" . $pathpart;
-		}
-		$CONFIG->wwwroot = "http://" . $_SERVER['HTTP_HOST'] . $pathpart;
-	}
-
-	if (empty($CONFIG->url)) {
-		$CONFIG->url = $CONFIG->wwwroot;
+	$CONFIG->site_guid = (int) datalist_get('default_site');
+	$CONFIG->site_id = $CONFIG->site_guid;
+	$CONFIG->site = get_entity($CONFIG->site_guid);
+	if (!$CONFIG->site) {
+		throw new InstallationException(elgg_echo('InstallationException:SiteNotInstalled'));
 	}
 
-	if (empty($CONFIG->sitename)) {
-		$CONFIG->sitename = "New Elgg site";
-	}
+	$CONFIG->wwwroot = $CONFIG->site->url;
+	$CONFIG->sitename = $CONFIG->site->name;
+	$CONFIG->sitedescription = $CONFIG->site->description;
+	$CONFIG->siteemail = $CONFIG->site->email;
+	$CONFIG->url = $CONFIG->wwwroot;
 
-	if (empty($CONFIG->language)) {
-		$CONFIG->language = "en";
-	}
+	get_all_config();
+	// gives hint to elgg_get_config function how to approach missing values
+	$CONFIG->site_config_loaded = true;
 }
 
 /**
- * Loads values into $CONFIG.
+ * Loads configuration related to Elgg as an application
  *
- * If Elgg is installed, this function pulls all rows from dbprefix_config
- * and cherry picks some values from dbprefix_datalists.  This also extracts
- * some commonly used values from the default site object.
- *
- * @elgg_event boot system
- * @return true|null
+ * This loads from the datalists database table
+ * @access private
  */
-function configuration_boot() {
+function _elgg_load_application_config() {
 	global $CONFIG;
 
+	$install_root = str_replace("\\", "/", dirname(dirname(dirname(__FILE__))));
+	$defaults = array(
+		'path'			=>	"$install_root/",
+		'view_path'		=>	"$install_root/views/",
+		'plugins_path'	=>	"$install_root/mod/",
+		'language'		=>	'en',
+
+		// compatibility with old names for plugins not using elgg_get_config()
+		'viewpath'		=>	"$install_root/views/",
+		'pluginspath'	=>	"$install_root/mod/",
+	);
+
+	foreach ($defaults as $name => $value) {
+		if (empty($CONFIG->$name)) {
+			$CONFIG->$name = $value;
+		}
+	}
+
 	$path = datalist_get('path');
 	if (!empty($path)) {
 		$CONFIG->path = $path;
@@ -527,22 +610,23 @@ function configuration_boot() {
 	} else {
 		$CONFIG->simplecache_enabled = 1;
 	}
-	$viewpath_cache_enabled = datalist_get('viewpath_cache_enabled');
-	if ($viewpath_cache_enabled !== false) {
-		$CONFIG->viewpath_cache_enabled = $viewpath_cache_enabled;
+	$system_cache_enabled = datalist_get('system_cache_enabled');
+	if ($system_cache_enabled !== false) {
+		$CONFIG->system_cache_enabled = $system_cache_enabled;
 	} else {
-		$CONFIG->viewpath_cache_enabled = 1;
-	}
-	if (isset($CONFIG->site) && ($CONFIG->site instanceof ElggSite)) {
-		$CONFIG->wwwroot = $CONFIG->site->url;
-		$CONFIG->sitename = $CONFIG->site->name;
-		$CONFIG->sitedescription = $CONFIG->site->description;
-		$CONFIG->siteemail = $CONFIG->site->email;
+		$CONFIG->system_cache_enabled = 1;
 	}
-	$CONFIG->url = $CONFIG->wwwroot;
 
-	// Load default settings from database
-	get_all_config();
-}
+	// initialize context here so it is set before the get_input call
+	$CONFIG->context = array();
+
+	// needs to be set before system, init for links in html head
+	$viewtype = get_input('view', 'default');
+	$lastcached = datalist_get("simplecache_lastcached_$viewtype");
+	$CONFIG->lastcache = $lastcached;
 
-elgg_register_event_handler('boot', 'system', 'configuration_boot', 10);
\ No newline at end of file
+	$CONFIG->i18n_loaded_from_cache = false;
+
+	// this must be synced with the enum for the entities table
+	$CONFIG->entity_types = array('group', 'object', 'site', 'user');
+}