<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Translate

 * @subpackage Zend_Translate_Adapter

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Adapter.php 22726 2010-07-30 10:52:07Z thomas $

 */

/**

 * @see Zend_Locale

 */

require_once 'Zend/Locale.php';

/**

 * @see Zend_Translate_Plural

 */

require_once 'Zend/Translate/Plural.php';

/**

 * Basic adapter class for each translation source adapter

 *

 * @category   Zend

 * @package    Zend_Translate

 * @subpackage Zend_Translate_Adapter

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

abstract class Zend_Translate_Adapter {

    /**

     * Shows if locale detection is in automatic level

     * @var boolean

     */

    private $_automatic = true;

    /**

     * Internal value to see already routed languages

     * @var array()

     */

    private $_routed = array();

    /**

     * Internal cache for all adapters

     * @var Zend_Cache_Core

     */

    protected static $_cache     = null;

    /**

     * Internal value to remember if cache supports tags

     *

     * @var boolean

     */

    private static $_cacheTags = false;

    /**

     * Scans for the locale within the name of the directory

     * @constant integer

     */

    const LOCALE_DIRECTORY = 'directory';

    /**

     * Scans for the locale within the name of the file

     * @constant integer

     */

    const LOCALE_FILENAME  = 'filename';

    /**

     * Array with all options, each adapter can have own additional options

     *   'clear'           => when true, clears already loaded translations when adding new files

     *   'content'         => content to translate or file or directory with content

     *   'disableNotices'  => when true, omits notices from being displayed

     *   'ignore'          => a prefix for files and directories which are not being added

     *   'locale'          => the actual set locale to use

     *   'log'             => a instance of Zend_Log where logs are written to

     *   'logMessage'      => message to be logged

     *   'logPriority'     => priority which is used to write the log message

     *   'logUntranslated' => when true, untranslated messages are not logged

     *   'reload'          => reloads the cache by reading the content again

     *   'scan'            => searches for translation files using the LOCALE constants

     *   'tag'             => tag to use for the cache

     *

     * @var array

     */

    protected $_options = array(

        'clear'           => false,

        'content'         => null,

        'disableNotices'  => false,

        'ignore'          => '.',

        'locale'          => 'auto',

        'log'             => null,

        'logMessage'      => "Untranslated message within '%locale%': %message%",

        'logPriority'     => 5,

        'logUntranslated' => false,

        'reload'          => false,

        'route'           => null,

        'scan'            => null,

        'tag'             => 'Zend_Translate'

    );

    /**

     * Translation table

     * @var array

     */

    protected $_translate = array();

    /**

     * Generates the adapter

     *

     * @param  array|Zend_Config $options Translation options for this adapter

     * @throws Zend_Translate_Exception

     * @return void

     */

    public function __construct($options = array())

    {

        if ($options instanceof Zend_Config) {

            $options = $options->toArray();

        } else if (func_num_args() > 1) {

            $args               = func_get_args();

            $options            = array();

            $options['content'] = array_shift($args);

            if (!empty($args)) {

                $options['locale'] = array_shift($args);

            }

            if (!empty($args)) {

                $opt     = array_shift($args);

                $options = array_merge($opt, $options);

            }

        } else if (!is_array($options)) {

            $options = array('content' => $options);

        }

        if (array_key_exists('cache', $options)) {

            self::setCache($options['cache']);

            unset($options['cache']);

        }

        if (isset(self::$_cache)) {

            $id = 'Zend_Translate_' . $this->toString() . '_Options';

            $result = self::$_cache->load($id);

            if ($result) {

                $this->_options = $result;

            }

        }

        if (empty($options['locale']) || ($options['locale'] === "auto")) {

            $this->_automatic = true;

        } else {

            $this->_automatic = false;

        }

        $locale = null;

        if (!empty($options['locale'])) {

            $locale = $options['locale'];

            unset($options['locale']);

        }

        $this->setOptions($options);

        $options['locale'] = $locale;

        if (!empty($options['content'])) {

            $this->addTranslation($options);

        }

        if ($this->getLocale() !== (string) $options['locale']) {

            $this->setLocale($options['locale']);

        }

    }

    /**

     * Add translations

     *

     * This may be a new language or additional content for an existing language

     * If the key 'clear' is true, then translations for the specified

     * language will be replaced and added otherwise

     *

     * @param  array|Zend_Config $options Options and translations to be added

     * @throws Zend_Translate_Exception

     * @return Zend_Translate_Adapter Provides fluent interface

     */

    public function addTranslation($options = array())

    {

        if ($options instanceof Zend_Config) {

            $options = $options->toArray();

        } else if (func_num_args() > 1) {

            $args = func_get_args();

            $options            = array();

            $options['content'] = array_shift($args);

            if (!empty($args)) {

                $options['locale'] = array_shift($args);

            }

            if (!empty($args)) {

                $opt     = array_shift($args);

                $options = array_merge($opt, $options);

            }

        } else if (!is_array($options)) {

            $options = array('content' => $options);

        }

        $originate = null;

        if (!empty($options['locale'])) {

            $originate = (string) $options['locale'];

        }

        if ((array_key_exists('log', $options)) && !($options['log'] instanceof Zend_Log)) {

            require_once 'Zend/Translate/Exception.php';

            throw new Zend_Translate_Exception('Instance of Zend_Log expected for option log');

        }

        try {

            if (!($options['content'] instanceof Zend_Translate) && !($options['content'] instanceof Zend_Translate_Adapter)) {

                if (empty($options['locale'])) {

                    $options['locale'] = null;

                }

                $options['locale'] = Zend_Locale::findLocale($options['locale']);

            }

        } catch (Zend_Locale_Exception $e) {

            require_once 'Zend/Translate/Exception.php';

            throw new Zend_Translate_Exception("The given Language '{$options['locale']}' does not exist", 0, $e);

        }

        $options  = $options + $this->_options;

        if (is_string($options['content']) and is_dir($options['content'])) {

            $options['content'] = realpath($options['content']);

            $prev = '';

            foreach (new RecursiveIteratorIterator(

                     new RecursiveDirectoryIterator($options['content'], RecursiveDirectoryIterator::KEY_AS_PATHNAME),

                     RecursiveIteratorIterator::SELF_FIRST) as $directory => $info) {

                $file = $info->getFilename();

                if (is_array($options['ignore'])) {

                    foreach ($options['ignore'] as $key => $ignore) {

                        if (strpos($key, 'regex') !== false) {

                            if (preg_match($ignore, $directory)) {

                                // ignore files matching the given regex from option 'ignore' and all files below

                                continue 2;

                            }

                        } else if (strpos($directory, DIRECTORY_SEPARATOR . $ignore) !== false) {

                            // ignore files matching first characters from option 'ignore' and all files below

                            continue 2;

                        }

                    }

                } else {

                    if (strpos($directory, DIRECTORY_SEPARATOR . $options['ignore']) !== false) {

                        // ignore files matching first characters from option 'ignore' and all files below

                        continue;

                    }

                }

                if ($info->isDir()) {

                    // pathname as locale

                    if (($options['scan'] === self::LOCALE_DIRECTORY) and (Zend_Locale::isLocale($file, true, false))) {

                        $options['locale'] = $file;

                        $prev              = (string) $options['locale'];

                    }

                } else if ($info->isFile()) {

                    // filename as locale

                    if ($options['scan'] === self::LOCALE_FILENAME) {

                        $filename = explode('.', $file);

                        array_pop($filename);

                        $filename = implode('.', $filename);

                        if (Zend_Locale::isLocale((string) $filename, true, false)) {

                            $options['locale'] = (string) $filename;

                        } else {

                            $parts  = explode('.', $file);

                            $parts2 = array();

                            foreach($parts as $token) {

                                $parts2 += explode('_', $token);

                            }

                            $parts  = array_merge($parts, $parts2);

                            $parts2 = array();

                            foreach($parts as $token) {

                                $parts2 += explode('-', $token);

                            }

                            $parts = array_merge($parts, $parts2);

                            $parts = array_unique($parts);

                            $prev  = '';

                            foreach($parts as $token) {

                                if (Zend_Locale::isLocale($token, true, false)) {

                                    if (strlen($prev) <= strlen($token)) {

                                        $options['locale'] = $token;

                                        $prev              = $token;

                                    }

                                }

                            }

                        }

                    }

                    try {

                        $options['content'] = $info->getPathname();

                        $this->_addTranslationData($options);

                    } catch (Zend_Translate_Exception $e) {

                        // ignore failed sources while scanning

                    }

                }

            }

        } else {

            $this->_addTranslationData($options);

        }

        if ((isset($this->_translate[$originate]) === true) and (count($this->_translate[$originate]) > 0)) {

            $this->setLocale($originate);

        }

        return $this;

    }

    /**

     * Sets new adapter options

     *

     * @param  array $options Adapter options

     * @throws Zend_Translate_Exception

     * @return Zend_Translate_Adapter Provides fluent interface

     */

    public function setOptions(array $options = array())

    {

        $change = false;

        $locale = null;

        foreach ($options as $key => $option) {

            if ($key == 'locale') {

                $locale = $option;

            } else if ((isset($this->_options[$key]) and ($this->_options[$key] != $option)) or

                    !isset($this->_options[$key])) {

                if (($key == 'log') && !($option instanceof Zend_Log)) {

                    require_once 'Zend/Translate/Exception.php';

                    throw new Zend_Translate_Exception('Instance of Zend_Log expected for option log');

                }

                if ($key == 'cache') {

                    self::setCache($option);

                    continue;

                }

                $this->_options[$key] = $option;

                $change = true;

            }

        }

        if ($locale !== null) {

            $this->setLocale($locale);

        }

        if (isset(self::$_cache) and ($change == true)) {

            $id = 'Zend_Translate_' . $this->toString() . '_Options';

            if (self::$_cacheTags) {

                self::$_cache->save($this->_options, $id, array($this->_options['tag']));

            } else {

                self::$_cache->save($this->_options, $id);

            }

        }

        return $this;

    }

    /**

     * Returns the adapters name and it's options

     *

     * @param  string|null $optionKey String returns this option

     *                                null returns all options

     * @return integer|string|array|null

     */

    public function getOptions($optionKey = null)

    {

        if ($optionKey === null) {

            return $this->_options;

        }

        if (isset($this->_options[$optionKey]) === true) {

            return $this->_options[$optionKey];

        }

        return null;

    }

    /**

     * Gets locale

     *

     * @return Zend_Locale|string|null

     */

    public function getLocale()

    {

        return $this->_options['locale'];

    }

    /**

     * Sets locale

     *

     * @param  string|Zend_Locale $locale Locale to set

     * @throws Zend_Translate_Exception

     * @return Zend_Translate_Adapter Provides fluent interface

     */

    public function setLocale($locale)

    {

        if (($locale === "auto") or ($locale === null)) {

            $this->_automatic = true;

        } else {

            $this->_automatic = false;

        }

        try {

            $locale = Zend_Locale::findLocale($locale);

        } catch (Zend_Locale_Exception $e) {

            require_once 'Zend/Translate/Exception.php';

            throw new Zend_Translate_Exception("The given Language ({$locale}) does not exist", 0, $e);

        }