Remove unnecessary old resource classes, move resource class out of resource subpackage since it's the only resource file now
[gitphp.git] / include / Resource.class.php
blob:a/include/Resource.class.php -> blob:b/include/Resource.class.php
--- a/include/Resource.class.php
+++ b/include/Resource.class.php
@@ -12,6 +12,8 @@
 require_once(GITPHP_BASEDIR . 'lib/php-gettext/streams.php');
 require_once(GITPHP_BASEDIR . 'lib/php-gettext/gettext.php');
 
+define('GITPHP_LOCALE_COOKIE', 'GitPHPLocale');
+
 /**
  * Resource
  *
@@ -32,6 +34,16 @@
 	protected static $instance = null;
 
 	/**
+	 * currentLocale
+	 *
+	 * Stores the currently instantiated locale identifier
+	 *
+	 * @access protected
+	 * @static
+	 */
+	protected static $currentLocale = '';
+
+	/**
 	 * GetInstance
 	 *
 	 * Returns the singleton instance
@@ -39,7 +51,6 @@
 	 * @access public
 	 * @static
 	 * @return mixed instance of resource class
-	 * @throws Exception if resource provider has not been instantiated yet
 	 */
 	public static function GetInstance()
 	{
@@ -47,6 +58,144 @@
 	}
 
 	/**
+	 * Instantiated
+	 *
+	 * Tests if the resource provider has been instantiated
+	 *
+	 * @access public
+	 * @static
+	 * @return boolean true if resource provider is instantiated
+	 */
+	public static function Instantiated()
+	{
+		return (self::$instance !== null);
+	}
+
+	/**
+	 * GetLocale
+	 *
+	 * Gets the currently instantiated locale
+	 *
+	 * @access public
+	 * @static
+	 * @return string locale identifier
+	 */
+	public static function GetLocale()
+	{
+		return self::$currentLocale;
+	}
+
+	/**
+	 * GetLocaleName
+	 *
+	 * Gets the current instantiated locale's name
+	 *
+	 * @access public
+	 * @static
+	 * @return string locale name
+	 */
+	public static function GetLocaleName()
+	{
+		return GitPHP_Resource::LocaleToName(self::$currentLocale);
+	}
+
+	/**
+	 * LocaleToName
+	 *
+	 * Given a locale, returns a human readable name
+	 *
+	 * @access public
+	 * @static
+	 * @param string $locale locale
+	 * return string name
+	 */
+	public static function LocaleToName($locale)
+	{
+		switch ($locale) {
+			case 'en_US':
+				return 'English';
+			case 'fr_FR':
+				return 'Français';
+			case 'zz_Debug':
+				return 'Gibberish';
+		}
+		return '';
+	}
+
+	/**
+	 * SupportedLocales
+	 *
+	 * Gets the list of supported locales and their languages
+	 *
+	 * @access public
+	 * @static
+	 * @return array list of locales mapped to languages
+	 */
+	public static function SupportedLocales()
+	{
+		$locales = array();
+
+		$locales['en_US'] = GitPHP_Resource::LocaleToName('en_US');
+
+		if ($dh = opendir(GITPHP_LOCALEDIR)) {
+			while (($file = readdir($dh)) !== false) {
+				$fullPath = GITPHP_LOCALEDIR . '/' . $file;
+				if ((strpos($file, '.') !== 0) && is_dir($fullPath) && is_file($fullPath . '/gitphp.mo')) {
+					if ($file == 'zz_Debug') {
+						$conf = GitPHP_Config::GetInstance();
+						if ($conf) {
+							if (!$conf->GetValue('debug', false)) {
+								continue;
+							}
+						}
+					}
+					$locales[$file] = GitPHP_Resource::LocaleToName($file);
+				}
+			}
+		}
+		
+		return $locales;
+	}
+
+	/**
+	 * FindPreferredLocale
+	 *
+	 * Given a list of preferred locales, try to find a matching supported locale
+	 *
+	 * @access public
+	 * @static
+	 * @param array locales array of locale preferences
+	 * @return string matching locale if found
+	 */
+	public static function FindPreferredLocale($locales)
+	{
+		if (count($locales) < 1) {
+			return '';
+		}
+
+		$supportedLocales = GitPHP_Resource::SupportedLocales();
+
+		for ($i = 0; $i < count($locales); ++$i) {
+			$locale = str_replace('-', '_', $locales[$i]);
+			$loclen = strlen($locale);
+
+			foreach ($supportedLocales as $l => $lang) {
+				/* 
+				 * using strncasecmp with length of the preferred
+				 * locale means we can match both full
+				 * language + country preference specifications
+				 * (en_US) as well as just language specifications
+				 * (en)
+				 */
+				if (strncasecmp($locale, $l, $loclen) === 0) {
+					return $l;
+				}
+			}
+		}
+		return '';
+	}
+
+	/**
 	 * Instantiate
 	 *
 	 * Instantiates the singleton instance
@@ -54,17 +203,23 @@
 	 * @access public
 	 * @static
 	 * @param string $locale locale to instantiate
-	 * @throws Exception on invalid locale
+	 * @return boolean true if resource provider was instantiated successfully
 	 */
 	public static function Instantiate($locale)
 	{
+		self::$instance = null;
+		self::$currentLocale = '';
+
 		$reader = null;
-
 		if (!(($locale == 'en_US') || ($locale == 'en'))) {
-			$reader = new FileReader(GITPHP_LOCALEDIR . $locale . '/LC_MESSAGES/gitphp.mo');
+			$reader = new FileReader(GITPHP_LOCALEDIR . $locale . '/gitphp.mo');
+			if (!$reader)
+				return false;
 		}
 
 		self::$instance = new gettext_reader($reader);
+		self::$currentLocale = $locale;
+		return true;
 	}
 
 }

comments