Merge pull request #274 from cash/language_caching

Fixes #4538 Language caching rewrite
Elgg · Jun 18, 2012 · 9f5634b · 9f5634b
2 parents 242ea5f + 460b47b
commit 9f5634b
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 94 deletions.
diff --git a/engine/lib/cache.php b/engine/lib/cache.php
@@ -442,6 +442,7 @@ function _elgg_cache_init() {
 	}
 
 	if ($CONFIG->system_cache_enabled && !$CONFIG->i18n_loaded_from_cache) {
+		reload_all_translations();
 		foreach ($CONFIG->translations as $lang => $map) {
 			elgg_save_system_cache("$lang.php", serialize($map));
 		}

diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
@@ -2116,11 +2116,13 @@ function _elgg_engine_boot() {
 
 	_elgg_load_application_config();
 
-	register_translations(dirname(dirname(dirname(__FILE__))) . "/languages/");
-
 	_elgg_load_site_config();
 
+	_elgg_session_boot();
+
 	_elgg_load_cache();
+
+	_elgg_load_translations();
 }
 
 /**

diff --git a/engine/lib/languages.php b/engine/lib/languages.php
@@ -7,6 +7,62 @@
  * @subpackage Languages
  */
 
+/**
+ * Given a message key, returns an appropriately translated full-text string
+ *
+ * @param string $message_key The short message code
+ * @param array  $args        An array of arguments to pass through vsprintf().
+ * @param string $language    Optionally, the standard language code
+ *                            (defaults to site/user default, then English)
+ *
+ * @return string Either the translated string, the English string,
+ * or the original language string.
+ */
+function elgg_echo($message_key, $args = array(), $language = "") {
+	global $CONFIG;
+
+	static $CURRENT_LANGUAGE;
+
+	// old param order is deprecated
+	if (!is_array($args)) {
+		elgg_deprecated_notice(
+			'As of Elgg 1.8, the 2nd arg to elgg_echo() is an array of string replacements and the 3rd arg is the language.',
+			1.8
+		);
+
+		$language = $args;
+		$args = array();
+	}
+
+	if (!isset($CONFIG->translations)) {
+		// this means we probably had an exception before translations were initialized
+		register_translations(dirname(dirname(dirname(__FILE__))) . "/languages/");
+	}
+
+	if (!$CURRENT_LANGUAGE) {
+		$CURRENT_LANGUAGE = get_language();
+	}
+	if (!$language) {
+		$language = $CURRENT_LANGUAGE;
+	}
+
+	if (isset($CONFIG->translations[$language][$message_key])) {
+		$string = $CONFIG->translations[$language][$message_key];
+	} else if (isset($CONFIG->translations["en"][$message_key])) {
+		$string = $CONFIG->translations["en"][$message_key];
+	} else {
+		$string = $message_key;
+	}
+
+	// only pass through if we have arguments to allow backward compatibility
+	// with manual sprintf() calls.
+	if ($args) {
+		$string = vsprintf($string, $args);
+	}
+
+	return $string;
+}
+
 /**
  * Add a translation.
  *
@@ -82,56 +138,34 @@ function get_language() {
 	return false;
 }
 
-/**
- * Given a message shortcode, returns an appropriately translated full-text string
- *
- * @param string $message_key The short message code
- * @param array  $args        An array of arguments to pass through vsprintf().
- * @param string $language    Optionally, the standard language code
- *                            (defaults to site/user default, then English)
- *
- * @return string Either the translated string, the English string,
- * or the original language string.
- */
-function elgg_echo($message_key, $args = array(), $language = "") {
+function _elgg_load_translations() {
 	global $CONFIG;
 
-	static $CURRENT_LANGUAGE;
-
-	// old param order is deprecated
-	if (!is_array($args)) {
-		elgg_deprecated_notice(
-			'As of Elgg 1.8, the 2nd arg to elgg_echo() is an array of string replacements and the 3rd arg is the language.',
-			1.8
-		);
-
-		$language = $args;
-		$args = array();
-	}
+	if ($CONFIG->system_cache_enabled) {
+		$loaded = true;
+		$languages = array_unique(array('en', get_current_language()));
+		foreach ($languages as $language) {
+			$data = elgg_load_system_cache("$language.php");
+			if ($data) {
+				add_translation($language, unserialize($data));
+			} else {
+				$loaded = false;
+			}
+		}
 
-	if (!$CURRENT_LANGUAGE) {
-		$CURRENT_LANGUAGE = get_language();
-	}
-	if (!$language) {
-		$language = $CURRENT_LANGUAGE;
+		if ($loaded) {
+			$CONFIG->i18n_loaded_from_cache = true;
+			// this is here to force 
+			$CONFIG->language_paths[dirname(dirname(dirname(__FILE__))) . "/languages/"] = true;
+			return;
+		}
 	}
 
-	if (isset($CONFIG->translations[$language][$message_key])) {
-		$string = $CONFIG->translations[$language][$message_key];
-	} else if (isset($CONFIG->translations["en"][$message_key])) {
-		$string = $CONFIG->translations["en"][$message_key];
-	} else {
-		$string = $message_key;
-	}
+	// load core translations from languages directory
+	register_translations(dirname(dirname(dirname(__FILE__))) . "/languages/");
+}
 
-	// only pass through if we have arguments to allow backward compatibility
-	// with manual sprintf() calls.
-	if ($args) {
-		$string = vsprintf($string, $args);
-	}
 
-	return $string;
-}
 
 /**
  * When given a full path, finds translation files and loads them
@@ -145,23 +179,17 @@ function elgg_echo($message_key, $args = array(), $language = "") {
 function register_translations($path, $load_all = false) {
 	global $CONFIG;
 
-	static $load_from_cache;
-	static $cache_loaded_langs;
-	if (!isset($load_from_cache)) {
-		$load_from_cache = $CONFIG->system_cache_enabled;
-		$cache_loaded_langs = array();
-	}
-
 	$path = sanitise_filepath($path);
 
-	// Make a note of this path just in case we need to register this language later
+	// Make a note of this path just incase we need to register this language later
 	if (!isset($CONFIG->language_paths)) {
 		$CONFIG->language_paths = array();
 	}
 	$CONFIG->language_paths[$path] = true;
 
 	// Get the current language based on site defaults and user preference
 	$current_language = get_current_language();
+	elgg_log("Translations loaded from: $path");
 
 	// only load these files unless $load_all is true.
 	$load_language_files = array(
@@ -171,32 +199,6 @@ function register_translations($path, $load_all = false) {
 
 	$load_language_files = array_unique($load_language_files);
 
-	if ($load_from_cache && !$load_all) {
-		// load language files from cache
-		$data = array();
-		foreach ($load_language_files as $lang_file) {
-			$lang = substr($lang_file, 0, strpos($lang_file, '.'));
-			if (!isset($cache_loaded_langs[$lang])) {
-				$data[$lang] = elgg_load_system_cache($lang_file);
-				if ($data[$lang]) {
-					$cache_loaded_langs[$lang] = true;
-				} else {
-					// this language file not cached yet
-					$load_from_cache = false;
-				}
-			}
-		}
-
-		// are we still suppose to load from cache
-		if ($load_from_cache) {
-			foreach ($data as $lang => $map) {
-				add_translation($lang, unserialize($map));
-			}
-			$CONFIG->i18n_loaded_from_cache = true;
-			return true;
-		}
-	}
-
 	$handle = opendir($path);
 	if (!$handle) {
 		elgg_log("Could not open language path: $path", 'ERROR');
@@ -218,11 +220,6 @@ function register_translations($path, $load_all = false) {
 		}
 	}
 
-	elgg_log("Translations loaded from: $path");
-
-	// make sure caching code saves language data if system cache is on
-	$CONFIG->i18n_loaded_from_cache = false;
-
 	return $return;
 }
 

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
@@ -311,6 +311,10 @@ function elgg_load_plugins() {
 		$start_flags = $start_flags & ~ELGG_PLUGIN_REGISTER_VIEWS;
 	}
 
+	if (elgg_get_config('i18n_loaded_from_cache')) {
+		$start_flags = $start_flags & ~ELGG_PLUGIN_REGISTER_LANGUAGES;
+	}
+
 	$return = true;
 	$plugins = elgg_get_plugins('active');
 	if ($plugins) {

diff --git a/engine/lib/sessions.php b/engine/lib/sessions.php
@@ -376,14 +376,10 @@ function logout() {
  *
  * @uses $_SESSION
  *
- * @param string $event       Event name
- * @param string $object_type Object type
- * @param mixed  $object      Object
- *
  * @return bool
  * @access private
  */
-function _elgg_session_boot($event, $object_type, $object) {
+function _elgg_session_boot() {
 	global $DB_PREFIX, $CONFIG;
 
 	// Use database for sessions
@@ -464,9 +460,6 @@ function _elgg_session_boot($event, $object_type, $object) {
 		return false;
 	}
 
-	// Since we have loaded a new user, this user may have different language preferences
-	register_translations(dirname(dirname(dirname(__FILE__))) . "/languages/");
-
 	return true;
 }
 
@@ -658,5 +651,3 @@ function _elgg_session_gc($maxlifetime) {
 
 	return true;
 }
-
-elgg_register_event_handler('boot', 'system', '_elgg_session_boot', 2);