web/nav/lib.php

<?php
/**
 * mageia.org global nav bar utilities.
 *
 * PHP version 5.4
 *
 * @category Mageia
 * @package  Mageia\Web\nav
 * @author   rda <rda@mageia.org>
 * @link     http://nav.mageia.org/
 *
 * @license http://www.gnu.org/licenses/gpl-2.0.html GNU GPL v2+
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License aspublished by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
*/
// definition

require_once('php-mo.php');

// languages for home
$langs = array(
    'ast' => 'Asturianu',
    'ca' => 'Català',
    'cs' => 'Čeština',
    'de' => 'Deutsch',
    'el' => 'Ελληνικά',
    'en' => 'English',
    'eo' => 'Esperanto',
    'es' => 'Español',
    'et' => 'Eesti',
    'fi' => 'Suomeksi',
    'fr' => 'Français',
    'id' => 'Bahasa Indonesia',
    'it' => 'Italiano',
    'lv' => 'Latviešu',
    'nb' => 'Bokmål',
    'nl' => 'Nederlands',
    'pl' => 'Polski',
    'pt' => 'Português',
    'pt-br' => 'Português do Brasil',
    'ro' => 'Română',
    'ru' => 'Русский',
    'sl' => 'Slovenščina',
    'sq' => 'Gjuha shqipe',
    'sv' => 'Svenska',
    'tr' => 'Türkçe',
    'uk' => 'Українська',
    'ur' => 'اردو',
    'zh-cn' => '简体中文',
    'zh-tw' => '正體中文'
);

class NCache
{
    function __construct() { }

    /**
     * Factory.
     *
     * @param string $path where cache file store is located, relative to app path.
     * @param integer $timeout in seconds
     *
     * @return NCache
    */
    public static function build($path, $timeout = 3600)
    {
        $path = __DIR__ . '/' . $path;

        if (!is_dir($path))
            return null;

        if ($timeout < 60)
            $timeout = 60;

        $i           = new self;
        $i->_path    = $path;
        $i->_timeout = $timeout;

        return $i;
    }

    /**
     * Get value for $key.
     *
     * @param mixed $key
     *
     * @return mixed
    */
    function get($key = null)
    {
        if (is_null($key))
            return false;

        $filename = $this->_get_filename($key);

        if ($this->_is_valid_file($filename, $this->_timeout)) {
            return unserialize(file_get_contents($filename));
        }

        return null;
    }

    /**
     * Save $value under $key.
     *
     * @param mixed $key
     * @param mixed $value
    */
    function set($key, $value)
    {
        if (is_null($key))
            return false;

        $filename = $this->_get_filename($key);
        file_put_contents($filename, serialize($value));

        return true;
    }

    /**
     * Get cache file from key.
     *
     * @param mixed $key
     *
     * @return string
    */
    private function _get_filename($key)
    {
        $key  = hash('sha1', serialize($key));

        return $this->_path . '/' . $key . '.cache';
    }

    /**
     * Check that the cache file exists and has not expired.
     *
     * @param string $filename
     *
     * @return boolean
    */
    private function _is_valid_file($filename, $timeout)
    {
        if (!file_exists($filename)) {
            //error_log(sprintf('Could not find %s', $filename), 0);
            return false;
        }

        if (filemtime($filename) + $timeout < time()) {
            //error_log(sprintf('%s timestamp expired (timeout was %ds.).', $filename, $timeout));
            unlink($filename);
            return false;
        }

        //error_log(sprintf('Found %s', $filename));
        return true;
    }
}

class l10n
{
//    public static $t;

    /**
     * Load langs/$lang.lang into global $_t array.
     *
     * @param string $lang
     *
     * @return void
    */
    public static function load($lang)
    {
        global $_t;
        $_t = array();

        if ($lang == 'en')
            return;

        $po_file    = __DIR__ . '/langs/' . $lang . '.po';
        $cache_file = __DIR__ . '/var/tmp/cache/nav_lang_' . $lang . '.php';
        $po_ts      = filemtime($po_file);

        if (file_exists($cache_file)) {
            include $cache_file;
            if ($_ts > $po_ts)
                return;
        }

        if (file_exists($po_file)) {
            $dictionary = phpmo_parse_po_file($po_file);

            foreach ($dictionary as $key => $value) {
                if ($key != '') {
                    if ($value['msgstr'][0] != '') {
                        $_t[trim($key)] = trim($value['msgstr'][0]);
                    } else {
                        $_t[trim($key)] = trim($key);
                    }
                }
            }

            $_t_data = var_export($_t, true);
            $cache   = <<<P
<?php
/**! Generated. Do not edit. */

// filemtime($po_file)
\$_ts = $po_ts;

// $lang strings
global \$_t;
\$_t = $_t_data;
P;
            file_put_contents($cache_file, $cache);
        }
    }

    /**
     * Get value for key $s in global array $_t.
     *
     * @param string $s
     *
     * @return string
    */
    public static function _t($s) {
        if (trim($s) == '')
            return '';

        global $_t;

        $s = array_key_exists($s, $_t) ? $_t[$s] : $s;
        $s = trim(str_replace(array('{ok}', '{OK}', '{Ok}', '{oK}'), '', $s));

        return $s;
    }
}

/**
 * Produce navigation HTML code.
 *
 * @param boolean $wrap = false should it be wrapped in a <header id="nav" /> element?
 * @param string  $lang = 'en'
 * @param string  $inject = null
 * @param string  $vhost = 'www.mageia.org'
 * @param object  $cache
 *
 * @return string HTML code
*/
function _mgnav_html($wrap = false, $lang = 'en', $inject = null, $vhost = 'www.mageia.org', $cache = null)
{
    $key = array($wrap, $lang, $inject, $vhost);

    if (!is_null($cache) && ($h = $cache->get($key))) {
        apache_note('navCacheHit', 1);
        return $h;
    }

    apache_note('navCacheHit', 0);

    $lang = _lang_check($lang);

    l10n::load($lang, $cache);

    $tn = array(
        array('mageia',     '//$S/$L/map/',           'Mageia',                  l10n::_t('Go to mageia.org site map.')),
        array('about',      '//$S/$L/about/',         l10n::_t('About&nbsp;us'), l10n::_t('Learn more about Mageia.')),
        array('downloads',  '//$S/$L/downloads/',     l10n::_t('Downloads'),     l10n::_t('Download Mageia ISO and updates.')),
        array('support',    '//$S/$L/support/',       l10n::_t('Support'),       l10n::_t('Get support from Mageia community.')),
        array('wiki',       '//wiki.mageia.org/',     l10n::_t('Wiki'),          l10n::_t('Wiki of the Mageia Community')),
        array('doc',        '//$S/$L/doc/',           l10n::_t('Docs'),          l10n::_t('Documentations of Mageia')),
        array('community',  '//$S/$L/community/',     l10n::_t('Community'),     l10n::_t('')),
        array('contribute', '//$S/$L/contribute/',    l10n::_t('Contribute'),    l10n::_t('You too can build Mageia with us!')),
        array('donate',     '//$S/$L/donate/',        l10n::_t('Donate'),        l10n::_t('')),
        array('you',        '//identity.mageia.org/', l10n::_t('You'),           l10n::_t('Your Mageia online account.')),
        array('contact',    '//$S/$L/contact/',       l10n::_t('Contact'),       l10n::_t('Contact Us'))
    //    <search>
    );

    $s = array();
    foreach ($tn as $i) {
        $s[] = sprintf('<li><a href="%s" class="%s" title="%s">%s</a></li>',
            str_replace(
                array('$L', '$S'),
                array($lang, $vhost),
                $i[1]
            ),
            $i[0],
            $i[3],
            $i[2]
        );
    }

    if (!is_null($inject))
        $s[] = sprintf('<li>%s</li>', $inject);

    $s = implode($s);
    $h = sprintf('<!--googleoff: all--><nav id="mgnav"><ul id="nav">%s</ul></nav><!--googleon: all-->', $s);

    if ($wrap)
        $h = sprintf('<header id="hmgn">%s
<link rel="icon" type="image/png" href="/g/favicon.png" />
</header>', $h);

    if (!is_null($cache))
        $cache->set($key, $h);

    return $h;
}

/**
 * Returns CSS definition ready to be inserted into a HTML document.
 *
 * @return string
*/
function _mgnav_style()
{
        if ( defined('ALIGNMENT') && constant('ALIGNMENT') == 'Center' ){
                return '<style>' . file_get_contents(__DIR__ . '/css/source.css') . '</style><style>' . file_get_contents(__DIR__ . '/css/center.css') . '</style>';
        } else {
                return '<style>' . file_get_contents(__DIR__ . '/css/source.css') . '</style>';
        }
}

/**
 * Get the primary language subtag only.<p></p>
*/
function _lang_check($s = null)
{
    if (is_null($s)) {
        return 'en';
    }

    global $langs;
    $supported = array_keys($langs);

    if (in_array($s, $supported))
        return $s;

    $sub = explode('-', $s);
    $sub = strtolower($sub[0]);

    if (in_array($sub, $supported))
        return $sub;

    return 'en';
}
1	rda	1096	<?php
2	rda	2051	/**
3			* mageia.org global nav bar utilities.
4			*
5			* PHP version 5.4
6			*
7			* @category Mageia
8			* @package Mageia\Web\nav
9			* @author rda <rda@mageia.org>
10			* @link http://nav.mageia.org/
11			*
12			* @license http://www.gnu.org/licenses/gpl-2.0.html GNU GPL v2+
13			*
14			* This program is free software; you can redistribute it and/or modify it
15			* under the terms of the GNU General Public License aspublished by the
16			* Free Software Foundation; either version 2 of the License, or (at your
17			* option) any later version.
18			*/
19	rda	1096	// definition
20
21	leuhmanu	3275	require_once('php-mo.php');
22
23			// languages for home
24			$langs = array(
25			'ast' => 'Asturianu',
26			'ca' => 'Català',
27			'cs' => 'Čeština',
28			'de' => 'Deutsch',
29			'el' => 'Ελληνικά',
30			'en' => 'English',
31			'eo' => 'Esperanto',
32			'es' => 'Español',
33			'et' => 'Eesti',
34			'fi' => 'Suomeksi',
35			'fr' => 'Français',
36			'id' => 'Bahasa Indonesia',
37			'it' => 'Italiano',
38			'lv' => 'Latviešu',
39			'nb' => 'Bokmål',
40			'nl' => 'Nederlands',
41			'pl' => 'Polski',
42			'pt' => 'Português',
43			'pt-br' => 'Português do Brasil',
44			'ro' => 'Română',
45			'ru' => 'Русский',
46			'sl' => 'Slovenščina',
47			'sq' => 'Gjuha shqipe',
48			'sv' => 'Svenska',
49			'tr' => 'Türkçe',
50			'uk' => 'Українська',
51			'ur' => 'اردو',
52			'zh-cn' => '简体中文',
53			'zh-tw' => '正體中文'
54			);
55
56	rda	1305	class NCache
57			{
58			function __construct() { }
59
60			/**
61			* Factory.
62			*
63			* @param string $path where cache file store is located, relative to app path.
64			* @param integer $timeout in seconds
65			*
66			* @return NCache
67			*/
68	rda	2594	public static function build($path, $timeout = 3600)
69	rda	1305	{
70			$path = __DIR__ . '/' . $path;
71
72			if (!is_dir($path))
73			return null;
74
75			if ($timeout < 60)
76			$timeout = 60;
77
78			$i = new self;
79			$i->_path = $path;
80			$i->_timeout = $timeout;
81
82			return $i;
83			}
84
85			/**
86			* Get value for $key.
87			*
88			* @param mixed $key
89			*
90			* @return mixed
91			*/
92			function get($key = null)
93			{
94			if (is_null($key))
95			return false;
96
97			$filename = $this->_get_filename($key);
98
99			if ($this->_is_valid_file($filename, $this->_timeout)) {
100			return unserialize(file_get_contents($filename));
101			}
102
103			return null;
104			}
105
106			/**
107			* Save $value under $key.
108			*
109			* @param mixed $key
110			* @param mixed $value
111			*/
112			function set($key, $value)
113			{
114			if (is_null($key))
115			return false;
116
117			$filename = $this->_get_filename($key);
118			file_put_contents($filename, serialize($value));
119
120			return true;
121			}
122
123			/**
124			* Get cache file from key.
125			*
126			* @param mixed $key
127			*
128			* @return string
129			*/
130			private function _get_filename($key)
131			{
132			$key = hash('sha1', serialize($key));
133
134			return $this->_path . '/' . $key . '.cache';
135			}
136
137			/**
138			* Check that the cache file exists and has not expired.
139			*
140			* @param string $filename
141			*
142			* @return boolean
143			*/
144			private function _is_valid_file($filename, $timeout)
145			{
146			if (!file_exists($filename)) {
147			//error_log(sprintf('Could not find %s', $filename), 0);
148			return false;
149			}
150
151			if (filemtime($filename) + $timeout < time()) {
152			//error_log(sprintf('%s timestamp expired (timeout was %ds.).', $filename, $timeout));
153			unlink($filename);
154			return false;
155			}
156
157			//error_log(sprintf('Found %s', $filename));
158			return true;
159			}
160			}
161
162	rda	1096	class l10n
163			{
164	filip	3207	// public static $t;
165	rda	1096
166			/**
167			* Load langs/$lang.lang into global $_t array.
168			*
169			* @param string $lang
170			*
171			* @return void
172			*/
173	rda	2594	public static function load($lang)
174	rda	1306	{
175			global $_t;
176			$_t = array();
177
178			if ($lang == 'en')
179			return;
180
181	filip	3207	$po_file = __DIR__ . '/langs/' . $lang . '.po';
182	rda	1306	$cache_file = __DIR__ . '/var/tmp/cache/nav_lang_' . $lang . '.php';
183	filip	3207	$po_ts = filemtime($po_file);
184	rda	1306
185			if (file_exists($cache_file)) {
186			include $cache_file;
187	filip	3207	if ($_ts > $po_ts)
188	rda	1306	return;
189			}
190
191	filip	3207	if (file_exists($po_file)) {
192			$dictionary = phpmo_parse_po_file($po_file);
193	rda	1306
194	filip	3207	foreach ($dictionary as $key => $value) {
195			if ($key != '') {
196			if ($value['msgstr'][0] != '') {
197			$_t[trim($key)] = trim($value['msgstr'][0]);
198			} else {
199			$_t[trim($key)] = trim($key);
200			}
201	rda	1096	}
202			}
203	rda	1306
204			$_t_data = var_export($_t, true);
205			$cache = <<<P
206			<?php
207			/*! Generated. Do not edit. /
208
209	filip	3207	// filemtime($po_file)
210			\$_ts = $po_ts;
211	rda	1306
212			// $lang strings
213			global \$_t;
214			\$_t = $_t_data;
215			P;
216			file_put_contents($cache_file, $cache);
217	rda	1096	}
218			}
219
220			/**
221			* Get value for key $s in global array $_t.
222			*
223			* @param string $s
224			*
225			* @return string
226			*/
227	rda	2594	public static function _t($s) {
228	rda	1096	if (trim($s) == '')
229			return '';
230
231			global $_t;
232
233	rda	2046	$s = array_key_exists($s, $_t) ? $_t[$s] : $s;
234			$s = trim(str_replace(array('{ok}', '{OK}', '{Ok}', '{oK}'), '', $s));
235
236			return $s;
237	rda	1096	}
238			}
239
240			/**
241			* Produce navigation HTML code.
242			*
243			* @param boolean $wrap = false should it be wrapped in a <header id="nav" /> element?
244			* @param string $lang = 'en'
245			* @param string $inject = null
246	rda	1307	* @param string $vhost = 'www.mageia.org'
247			* @param object $cache
248	rda	1096	*
249			* @return string HTML code
250			*/
251	rda	1307	function _mgnav_html($wrap = false, $lang = 'en', $inject = null, $vhost = 'www.mageia.org', $cache = null)
252	rda	1096	{
253	rda	1307	$key = array($wrap, $lang, $inject, $vhost);
254
255			if (!is_null($cache) && ($h = $cache->get($key))) {
256	rda	1309	apache_note('navCacheHit', 1);
257	rda	1307	return $h;
258			}
259
260	rda	1309	apache_note('navCacheHit', 0);
261
262	rda	1254	$lang = _lang_check($lang);
263	rda	1154
264	rda	1307	l10n::load($lang, $cache);
265	rda	1096
266			$tn = array(
267	rda	1307	array('mageia', '//$S/$L/map/', 'Mageia', l10n::_t('Go to mageia.org site map.')),
268			array('about', '//$S/$L/about/', l10n::_t('About us'), l10n::_t('Learn more about Mageia.')),
269			array('downloads', '//$S/$L/downloads/', l10n::_t('Downloads'), l10n::_t('Download Mageia ISO and updates.')),
270			array('support', '//$S/$L/support/', l10n::_t('Support'), l10n::_t('Get support from Mageia community.')),
271	leuhmanu	2794	array('wiki', '//wiki.mageia.org/', l10n::_t('Wiki'), l10n::_t('Wiki of the Mageia Community')),
272	filip	3004	array('doc', '//$S/$L/doc/', l10n::_t('Docs'), l10n::_t('Documentations of Mageia')),
273	rda	1307	array('community', '//$S/$L/community/', l10n::_t('Community'), l10n::_t('')),
274			array('contribute', '//$S/$L/contribute/', l10n::_t('Contribute'), l10n::_t('You too can build Mageia with us!')),
275	akien	2586	array('donate', '//$S/$L/donate/', l10n::_t('Donate'), l10n::_t('')),
276	rda	2028	array('you', '//identity.mageia.org/', l10n::_t('You'), l10n::_t('Your Mageia online account.')),
277			array('contact', '//$S/$L/contact/', l10n::_t('Contact'), l10n::_t('Contact Us'))
278	rda	1096	// <search>
279			);
280
281			$s = array();
282			foreach ($tn as $i) {
283			$s[] = sprintf('<li><a href="%s" class="%s" title="%s">%s</a></li>',
284			str_replace(
285			array('$L', '$S'),
286			array($lang, $vhost),
287			$i[1]
288			),
289			$i[0],
290			$i[3],
291			$i[2]
292			);
293			}
294
295			if (!is_null($inject))
296			$s[] = sprintf('<li>%s</li>', $inject);
297
298			$s = implode($s);
299	rda	2028	$h = sprintf('<!--googleoff: all--><nav id="mgnav"><ul id="nav">%s</ul></nav><!--googleon: all-->', $s);
300	rda	1096
301			if ($wrap)
302	leuhmanu	3063	$h = sprintf('<header id="hmgn">%s
303			<link rel="icon" type="image/png" href="/g/favicon.png" />
304			</header>', $h);
305	rda	1096
306	rda	1307	if (!is_null($cache))
307			$cache->set($key, $h);
308
309	rda	1096	return $h;
310			}
311
312			/**
313			* Returns CSS definition ready to be inserted into a HTML document.
314			*
315			* @return string
316			*/
317			function _mgnav_style()
318			{
319	leuhmanu	3275	if ( defined('ALIGNMENT') && constant('ALIGNMENT') == 'Center' ){
320			return '<style>' . file_get_contents(__DIR__ . '/css/source.css') . '</style><style>' . file_get_contents(__DIR__ . '/css/center.css') . '</style>';
321			} else {
322			return '<style>' . file_get_contents(__DIR__ . '/css/source.css') . '</style>';
323			}
324	rda	1096	}
325	rda	1154
326			/**
327			* Get the primary language subtag only.<p></p>
328			*/
329	rda	1254	function _lang_check($s = null)
330	rda	1154	{
331	rda	2028	if (is_null($s)) {
332	rda	1257	return 'en';
333	rda	2028	}
334	rda	1254
335	leuhmanu	3275	global $langs;
336			$supported = array_keys($langs);
337	rda	1254
338			if (in_array($s, $supported))
339			return $s;
340
341	rda	1257	$sub = explode('-', $s);
342			$sub = strtolower($sub[0]);
343
344	rda	1254	if (in_array($sub, $supported))
345	rda	1257	return $sub;
346	rda	1254
347			return 'en';
348	rda	1154	}