Clean up docblock on base namespace objects
[gitphp.git] / include / Resource.class.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<?php
 
require_once(GITPHP_BASEDIR . 'lib/php-gettext/streams.php');
require_once(GITPHP_BASEDIR . 'lib/php-gettext/gettext.php');
 
/**
 * Resource string manager class
 *
 * @author Christopher Han <xiphux@gmail.com>
 * @copyright Copyright (c) 2010 Christopher Han
 * @package GitPHP
 */
class GitPHP_Resource
{
 
        /**
         * Constant of the locale cookie in the user's browser
         *
         * @const
         */
        const LocaleCookie = 'GitPHPLocale';
 
        /**
         * Locale cookie lifetime
         *
         * @const
         */
        const LocaleCookieLifetime = 31536000;  // 1 year
        
        /**
         * Stores the singleton instance of the resource provider
         *
         * @var gettext_reader
         */
        protected static $instance = null;
 
        /**
         * Stores the currently instantiated locale identifier
         *
         * @var string
         */
        protected static $currentLocale = '';
 
        /**
         * Returns the singleton instance
         *
         * @return gettext_reader instance of resource class
         */
        public static function GetInstance()
        {
                return self::$instance;
        }
 
        /**
         * Releases the singleton instance
         */
        public static function DestroyInstance()
        {
                self::$instance = null;
        }
 
        /**
         * Tests if the resource provider has been instantiated
         *
         * @return boolean true if resource provider is instantiated
         */
        public static function Instantiated()
        {
                return (self::$instance !== null);
        }
 
        /**
         * Gets the currently instantiated locale
         *
         * @return string locale identifier
         */
        public static function GetLocale()
        {
                return self::$currentLocale;
        }
 
        /**
         * Gets the current instantiated locale's name
         *
         * @return string locale name
         */
        public static function GetLocaleName()
        {
                return GitPHP_Resource::LocaleToName(self::$currentLocale);
        }
 
        /**
         * Given a locale, returns a human readable name
         *
         * @param string $locale locale
         * @return string name
         */
        public static function LocaleToName($locale)
        {
                $localeName = __('English');            // for xgettext extraction
 
                $localeReader = null;
                if (self::$currentLocale == $locale) {
                        $localeReader = self::$instance;
                }
                if (!$localeReader) {
                        $localeReader = GitPHP_Resource::CreateLocale($locale, false);
                }
                if (!$localeReader) {
                        return '';
                }
 
                $localeName = $localeReader->translate('English');
 
                if (!(($locale == 'en_US') || ($locale == 'en'))) {
                        if ($localeName == 'English') {
                                // someone didn't translate the language name - don't mislabel it as english
                                return '';
                        }
                }
 
                return $localeName;
        }
 
        /**
         * Gets the list of supported locales and their languages
         *
         * @return string[] array 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);
                                }
                        }
                }
 
                ksort($locales);
                
                return $locales;
        }
 
        /**
         * Given a list of preferred locales, try to find a matching supported locale
         *
         * @param string $httpAcceptLang HTTP Accept-Language string
         * @return string matching locale if found
         */
        public static function FindPreferredLocale($httpAcceptLang)
        {
                if (empty($httpAcceptLang))
                        return '';
 
                $locales = explode(',', $httpAcceptLang);
 
                $localePref = array();
 
                foreach ($locales as $locale) {
                        $quality = '1.0';
                        $localeData = explode(';', trim($locale));
                        if (count($localeData) > 1) {
                                $q = trim($localeData[1]);
                                if (substr($q, 0, 2) == 'q=') {
                                        $quality = substr($q, 2);
                                }
                        }
                        $localePref[$quality][] = trim($localeData[0]);
                }
                krsort($localePref);
 
                $supportedLocales = GitPHP_Resource::SupportedLocales();
 
                foreach ($localePref as $quality => $qualityArray) {
                        foreach ($qualityArray as $browserLocale) {
                                $locale = str_replace('-', '_', $browserLocale);
                                $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 '';
        }
 
        /**
         * Instantiates the singleton instance
         *
         * @param string $locale locale to instantiate
         * @return boolean true if resource provider was instantiated successfully
         */
        public static function Instantiate($locale)
        {
                self::$instance = null;
                self::$currentLocale = '';
 
                $localeReader = GitPHP_Resource::CreateLocale($locale);
                if (!$localeReader) {
                        return false;
                }
 
                self::$instance = $localeReader;
                self::$currentLocale = $locale;
                return true;
        }
 
        /**
         * Creates a locale reader object
         *
         * @param string $locale locale to create
         * @param boolean $cache false to disable caching
         * @return gettext_reader|null locale reader object or null on failure
         */
        private static function CreateLocale($locale, $cache = true)
        {
                $reader = null;
                if (!(($locale == 'en_US') || ($locale == 'en'))) {
                        $reader = new FileReader(GITPHP_LOCALEDIR . $locale . '/gitphp.mo');
                        if (!$reader) {
                                return null;
                        }
                }
 
                return new gettext_reader($reader, $cache);
        }
 
}
 
 
/**
 * Gettext wrapper function for readability, single string version
 *
 * @param string $str string to translate
 * @return string translated string
 * @package GitPHP
 */
function __($str)
{
        if (GitPHP_Resource::Instantiated())
                return GitPHP_Resource::GetInstance()->translate($str);
        return $str;
}
 
/**
 * Gettext wrapper function for readability, plural form
 *
 * @param string $singular singular form of string
 * @param string $plural plural form of string
 * @param int $count number of items
 * @return string translated string
 * @package GitPHP
 */
function __n($singular, $plural, $count)
{
        if (GitPHP_Resource::Instantiated())
                return GitPHP_Resource::GetInstance()->ngettext($singular, $plural, $count);
        if ($count > 1)
                return $plural;
        return $singular;
}
 
 
comments