File: //opt/cpanel/ea-php54/root/usr/share/pear/RVSeagullMod/lib/SGL/Translation.php
<?php
/* Reminder: always indent with 4 spaces (no tabs). */
// +---------------------------------------------------------------------------+
// | Copyright (c) 2008, Demian Turner |
// | All rights reserved. |
// | |
// | Redistribution and use in source and binary forms, with or without |
// | modification, are permitted provided that the following conditions |
// | are met: |
// | |
// | o Redistributions of source code must retain the above copyright |
// | notice, this list of conditions and the following disclaimer. |
// | o Redistributions in binary form must reproduce the above copyright |
// | notice, this list of conditions and the following disclaimer in the |
// | documentation and/or other materials provided with the distribution. |
// | o The names of the authors may not be used to endorse or promote |
// | products derived from this software without specific prior written |
// | permission. |
// | |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
// | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
// | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
// | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
// | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
// | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
// | |
// +---------------------------------------------------------------------------+
// | Seagull 0.6 |
// +---------------------------------------------------------------------------+
// | Translation.php |
// +---------------------------------------------------------------------------+
// | Author: Alexander J. Tarachanowicz II <ajt@localhype.net> |
// +---------------------------------------------------------------------------+
// $Id: Translation.php,v 1.0 2005/05/11 00:00:00 demian Exp $
/**
* A wrapper to PEAR Translation2.
*
* @package SGL
* @author Alexander J. Tarachanowicz II <ajt@localhype.net>
* @version $Revision: 1.0 $
*/
if (class_exists('SGL_Translation') === false) {
class SGL_Translation
{
/**
* Generate singleton for PEAR::Tranlation2
*
* Object types:
* o translation (default)
* o admin - translation2_admin
* Storage drivers: (Set in global config under site)
* o single - all translations in a single table (translations)
* o multiple (default) - all translations in a seperate table
* (translation_en, translation_pl, translation_de)
*
* @static
* @access public
* @param string $lang language to return translations
* @param string $type type of object: translation or admin
* @return object $translation Translation2 object
*
*
*/
public static function singleton($type = 'translation')
{
static $instance;
// If the instance exists, return one
if (isset($instance[$type])) {
return $instance[$type];
}
$c = SGL_Config::singleton();
$conf = $c->getAll();
$dbh = SGL_DB::singleton();
// set translation table parameters
$params = array(
'langs_avail_table' => $conf['db']['prefix'] . 'langs',
'lang_id_col' => 'lang_id',
'lang_name_col' => 'name',
'lang_meta_col' => 'meta',
'lang_errmsg_col' => 'error_text',
'lang_encoding_col' => 'encoding',
'string_id_col' => 'translation_id',
'string_page_id_col' => 'page_id',
'string_text_col' => '%s' //'%s' will be replaced by the lang code
);
// set translation driver
$driver = 'DB';
// create translation storage tables
if ($conf['translation']['container'] == 'db') {
$prefix = $conf['db']['prefix'] .
$conf['translation']['tablePrefix'] . '_';
$aLangs = explode(',', $conf['translation']['installedLanguages']);
// set params
foreach ($aLangs as $lang) {
$params['strings_tables'][$lang] = $prefix . $lang;
}
} else {
SGL::raiseError('translation table not specified check global config ',
SGL_ERROR_INVALIDCONFIG, PEAR_ERROR_DIE);
}
// instantiate selected translation2 object
switch (strtolower($type)) {
case 'admin':
require_once 'Translation2/Admin.php';
$instance[$type] = &Translation2_Admin::factory($driver, $dbh, $params);
break;
case 'translation':
default:
require_once 'Translation2.php';
$instance[$type] = &Translation2::factory($driver, $dbh, $params);
}
return $instance[$type];
}
/**
* Clear translation2 and GUI cache
*
* @static
* @access public
*
* @return boolean true on success/false on failure
*/
public static function clearCache()
{
$c = SGL_Config::singleton();
$conf = $c->getAll();
if ('db' == $conf['translation']['container']) {
// clear Translation2 cache
$trans = SGL_Translation::singleton('admin');
$trans->options['cacheOptions']['cacheDir'] = SGL_TMP_DIR .'/';
$trans->options['cacheOptions']['defaultGroup'] = 'translation';
return $trans->cleanCache();
} else {
// clear file GUI cache
return SGL_Translation::clearGuiTranslationsCache();
}
}
/**
* Clear GUI Translations cache
*
* @static
* @access public
*
* @return boolean true on success/false on failure
*/
public static function clearGuiTranslationsCache()
{
$c = SGL_Config::singleton();
$aLangs = $aLangs = explode(',', $c->get('translation.installedLanguages'));
if (count($aLangs) > 0) {
$cache = SGL_Cache::singleton();
$cache->setOption('cacheDir', SGL_TMP_DIR .'/');
$success = true;
foreach ($aLangs as $group) {
$group = SGL_Translation::transformLangID($group, SGL_LANG_ID_SGL);
$result = SGL_Cache::clear('translation_'. $group);
$success = $success && $result;
}
return $success;
}
}
/**
* Returns a dictionary of translated strings.
*
* @static
* @param string $module
* @param string $lang
* @return array
*/
function getGuiTranslationsFromFile($module, $lang)
{
// fetch translations from database and cache
$cache = SGL_Cache::singleton();
$lang = SGL_Translation::transformLangID($lang, SGL_LANG_ID_SGL);
$ret = array();
// returned cached translations else fetch from db and cache
if ($serialized = $cache->get($module, 'translation_'. $lang)) {
$words = unserialize($serialized);
SGL::logMessage('translations from cache', PEAR_LOG_DEBUG);
$ret = $words;
} else {
// fetch available languages
$aLanguages = $GLOBALS['_SGL']['LANGUAGE'];
// build global lang file
$language = @$aLanguages[$lang][1];
$globalLangFile = $language .'.php';
$path = SGL_MOD_DIR . '/' . $module . '/lang/';
if (!is_readable($path . $globalLangFile)) {
// load default language
$fallbackLang = SGL_Config::get('translation.fallbackLang');
$fallbackLang = SGL_Translation::transformLangID($fallbackLang, SGL_LANG_ID_SGL);
$language = @$aLanguages[$fallbackLang][1];
$globalLangFile = $language .'.php';
/// RVS START fix could not locate the global language file set lang file to english
if (defined('RVS_AUTO_SETUP')) {
$globalLangFile = (is_file($path . $globalLangFile)) ? $language . '.php' : 'english-utf-8.php';
}
/// RVS END fix could not locate the global language file set lang file to english
}
if (is_readable($path . $globalLangFile)) {
include $path . $globalLangFile;
if ($module == 'default') {
$words = &$defaultWords;
}
/// RVS START merge translate from file edit
//$ret = $words;
$ret = array_merge($words, SGL_Translation::loadTranslationsFromFileEdit($module, $language, $lang));
/// RVS END merge translate form file edit
if (!empty($ret)) {
$serialized = serialize($ret);
$cache->save($serialized, $module, 'translation_'. $lang);
SGL::logMessage('translations from file', PEAR_LOG_DEBUG);
}
} elseif ($module == 'default') {
SGL::raiseError('could not locate the global language file', SGL_ERROR_NOFILE);
}
}
return SGL_Translation::removeMetaData($ret);
}
/**
* Load Translate From File Edit
*
* @param String $module - Module name
* @param String $language - Language
* @return Array $aMergeWords - Array words edit
*/
function loadTranslationsFromFileEdit($module, $language, $lang)
{
SGL::logMessage(null, PEAR_LOG_DEBUG);
$aMergeWords = array();
$pathFileTransEdit = RVS_USER_HOME . '/.rvsitebuilder/projects/' . RVS_PROJECT_ID . '/lang/' . $module . '/language/' . $language . '.php';
SGL::logMessage('translate pathFileTransEdit1 : ' . $pathFileTransEdit, PEAR_LOG_DEBUG);
if (is_readable($pathFileTransEdit)) {
include_once $pathFileTransEdit;
if (isset($words) && is_array($words)) {
$aMergeWords = $words;
}
} else {
$pathFileTransEdit = RVS_USER_HOME . '/.rvsitebuilder/projects/' . RVS_PROJECT_ID . '/lang/' . $module . '/language/' . $lang . '.php';
SGL::logMessage('translate pathFileTransEdit2 : ' . $pathFileTransEdit, PEAR_LOG_DEBUG);
if (is_readable($pathFileTransEdit)) {
include_once $pathFileTransEdit;
if (isset($words) && is_array($words)) {
$aMergeWords = $words;
}
}
}
SGL::logMessage('translate pathFileTransEdit3 : ' . $pathFileTransEdit, PEAR_LOG_DEBUG);
SGL::logMessage('translate language : ' . $language, PEAR_LOG_DEBUG);
SGL::logMessage('translate lang : ' . $lang, PEAR_LOG_DEBUG);
return $aMergeWords;
}
/**
* Update GUI Translations.
*
* @static
* @param array $aTrans hash containing tranlsations to be updated
* @param string $langID language id
* @param string $module module
*
* @return boolean true on success and PEAR Error on failure
*/
public function updateGuiTranslations($module, $langID, $aTrans)
{
switch (strtolower($this->conf['translation']['container'])) {
case 'db':
require_once SGL_CORE_DIR . '/Translation.php';
$trans = SGL_Translation::singleton('admin');
$langID = SGL_Translation::transformLangID($langID, SGL_LANG_ID_TRANS2);
foreach ($aTrans as $key => $value) {
$string = array($langID => $value);
$result = $trans->add(stripslashes($key), $module, $string);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
}
return true;
case 'file':
default:
$aTrans = SGL_Translation::updateMetaData($aTrans);
// read translation data and get reference to root
require_once 'Config.php';
$c = new Config();
$aTransStrip = SGL_Translation::escapeSingleQuoteInArrayKeys($aTrans);
$root = & $c->parseConfig($aTransStrip, 'phparray');
$langID = SGL_Translation::transformLangID($langID, SGL_LANG_ID_SGL);
// write translation to file
$filename = SGL_Translation::getFileName($module, $langID);
$arrayName = ($module == 'default') ? 'defaultWords' : 'words';
$result = $c->writeConfig($filename, 'phparray', array('name' => $arrayName));
if (is_a($result, 'PEAR_Error')) {
return $result;
}
return true;
}
}
public static function getFileName($module, $langId, $path = SGL_MOD_DIR)
{
$fileName = $path . '/' . $module . '/lang/' .
$GLOBALS['_SGL']['LANGUAGE'][$langId][1] . '.php';
return $fileName;
}
/**
* Returns a dictionary of translated strings from the db.
*
* @static
* @param string $module
* @param string $lang
* @param string $fallbackLang
* @return array
*/
public static function getTranslations($module, $lang, $fallbackLang = false)
{
$c = SGL_Config::singleton();
$conf = $c->getAll();
if (!empty($module) && !empty($lang)) {
$lang = SGL_Translation::transformLangID($lang, SGL_LANG_ID_TRANS2);
$installedLangs = explode(',', $conf['translation']['installedLanguages']);
if ($conf['translation']['container'] == 'db'
&& in_array($lang, $installedLangs)) {
$translation = SGL_Translation::singleton();
// set language
$langInstalled = $translation->setLang($lang);
// set translation group
$translation->setPageID($module);
// create decorator for fallback language
if ($fallbackLang) {
$fallbackLang = (is_string($fallbackLang))
? $fallbackLang
: $conf['translation']['fallbackLang'];
$translation = & $translation->getDecorator('Lang');
$translation->setOption('fallbackLang', $fallbackLang);
}
// instantiate cachelite decorator and set options
if ($conf['cache']['enabled']) {
$translation = &$translation->getDecorator('CacheLiteFunction');
$translation->setOption('cacheDir', SGL_TMP_DIR .'/');
$translation->setOption('lifeTime', $conf['cache']['lifetime']);
$translation->setOption('defaultGroup', 'translation');
}
// fetch translations
$words = ($words = $translation->getPage()) ? $words : array();
SGL::logMessage('translations from db for '. $module, PEAR_LOG_DEBUG);
return $words;
} elseif ($conf['translation']['container'] == 'file') {
return SGL_Translation::getGuiTranslationsFromFile($module, $lang);
} else {
return array();
}
} else {
SGL::raiseError('Incorrect parameter passed to '.__CLASS__.'::'.__FUNCTION__,
SGL_ERROR_INVALIDARGS);
}
}
// ----------------------------------
// --- Language retrieval methods ---
// ----------------------------------
/**
* Return current language ID format.
*
* @static
*
* @access public
*
* @param string $format
*
* @return string
*/
public static function getLangID($format = SGL_LANG_ID_TRANS2)
{
if (isset($_SESSION['aPrefs']['language'])) {
$ret = $_SESSION['aPrefs']['language'];
} else {
$ret = SGL_Translation::getFallbackLangID();
}
return SGL_Translation::transformLangID($ret, $format);
}
/**
* Get current charset.
*
* @static
*
* @access public
*
* @param string $format
*
* @return string
*/
public static function getCharset($format = SGL_LANG_ID_SGL)
{
$lang = SGL_Translation::getLangID($format);
return SGL_Translation::extractCharset($lang, $format);
}
/**
* Check if language is allowed.
*
* @static
*
* @access public
*
* @param string $lang
*
* @return boolean
*/
public static function isAllowedLanguage($lang)
{
$lang = SGL_Translation::transformLangID($lang, SGL_LANG_ID_SGL);
return isset($GLOBALS['_SGL']['LANGUAGE'][$lang]);
}
/**
* Get charset from supplied language.
*
* @static
*
* @access public
*
* @param string $lang
* @param string $format
*
* @return string
*/
public static function extractCharset($lang, $format = SGL_LANG_ID_SGL)
{
switch ($format) {
case SGL_LANG_ID_TRANS2: $devider = '_'; break;
case SGL_LANG_ID_SGL: default: $devider = '-'; break;
}
$aLang = explode($devider, $lang);
array_shift($aLang);
if ($aLang[0] == 'tw') {
array_shift($aLang);
}
return implode($devider, $aLang);
}
/**
* Get fallback language.
*
* @static
*
* @access public
*
* @param string $format
*
* @return string
*/
public static function getFallbackLangID($format = SGL_LANG_ID_TRANS2)
{
$lang = SGL_Config::get('translation.fallbackLang');
return SGL_Translation::transformLangID($lang, $format);
}
/**
* Get default charset.
*
* @static
*
* @access public
*
* @param string $format
*
* @return string
*/
public static function getFallbackCharset($format = SGL_LANG_ID_SGL)
{
$lang = SGL_Translation::getFallbackLangID($format);
return SGL_Translation::extractCharset($lang, $format);
}
/**
* Toggle langID format
*
* SGL_LANG_ID_SGL - en-iso-8859-15
* SGL_LANG_ID_TRANS2 - en_iso_8859_15
*
* @static
* @param string langID language id
* @param int format language id format
* @return langID string
*/
public static function transformLangID($langID, $format = null)
{
if (isset($format)) {
$langID = ($format == SGL_LANG_ID_SGL)
? str_replace('_', '-', $langID)
: str_replace('-', '_', $langID);
return $langID;
} else {
$langID = (strstr($langID, '-'))
? str_replace('-', '_', $langID)
: str_replace('_', '-', $langID);
return $langID;
}
}
/**
* Remove all translations for all languages for specified module.
*
* @static
* @param string $moduleName module/page name
* @return boolean
*/
public static function removeTranslations($moduleName)
{
$trans = SGL_Translation::singleton('admin');
$aPages = $trans->getPageNames();
if (SGL::isError($aPages)) {
return $aPages;
}
if (!in_array($moduleName, $aPages)) {
return false; // no translations
}
$aLangs = $trans->getLangs('ids');
if (SGL::isError($aLangs)) {
return $aLangs;
}
$aStrings = array();
foreach ($aLangs as $langId) {
$ret = SGL_Translation::getTranslations($moduleName, $langId);
$aStrings = array_merge($aStrings, array_keys($ret));
}
foreach ($aStrings as $stringId) {
$ret = $trans->remove($stringId, $moduleName);
if (SGL::isError($ret)) {
return $ret;
}
}
return true;
}
/**
* Add/update meta keys to translation array.
*
* @param array $aConfigs
*
* @return array
*
* @static
*/
public static function updateMetaData($aConfigs)
{
$aMetaData = array(
'__SGL_UPDATED_BY' => SGL_Session::getUsername(),
'__SGL_LAST_UPDATED' => SGL_Date::getTime()
);
// we do it in this way to put meta data first in array
foreach ($aMetaData as $k => $v) {
if (isset($aConfigs[$k])) {
unset($aConfigs[$k]);
}
}
$aRet = $aMetaData + $aConfigs;
return $aRet;
//return array_merge($aConfigs, $aMetaData);
}
/**
* Remove meta data from translation array.
*
* @param array $aConfigs
*
* @return array
*
* @static
*/
public static function removeMetaData($aConfigs)
{
foreach ($aConfigs as $k => $v) {
if (strpos($k, '__SGL_') === 0) {
unset($aConfigs[$k]);
}
}
return $aConfigs;
}
/**
* Lock translation file.
*
* @param string $moduleName
* @param string $lang
*
* @return void
*
* @static
*/
public static function lockTranslationFile($moduleName, $lang)
{
$fileName = $moduleName . '_' . $lang . '.lock.txt';
$targetDir = SGL_VAR_DIR . '/translation';
$ok = SGL_Translation::ensureDirIsWrirable($targetDir);
if (SGL::isError($ok)) {
return $ok;
}
$ok = touch($targetDir . '/' . $fileName);
if ($ok === false) {
return SGL::raiseError(__CLASS__ . ': error creating transation '
. 'locking file', SGL_ERROR_INVALIDFILEPERMS);
}
file_put_contents($targetDir . '/' . $fileName,
SGL_Session::getUsername());
}
/**
* Check if translation is locked.
*
* @param string $moduleName
* @param string $lang
*
* @return boolean
*
* @static
*/
public static function translationFileIsLocked($moduleName, $lang)
{
$ret = false;
$fileName = SGL_VAR_DIR . "/translation/{$moduleName}_{$lang}.lock.txt";
if (file_exists($fileName)) {
$period = time() - filemtime($fileName);
if ($period < 15 * 60) { // minutes
$currentUser = file_get_contents($fileName);
if ($currentUser != SGL_Session::getUsername()) {
$ret = true;
}
} else {
SGL_Translation::removeTranslationLock($moduleName, $lang);
}
}
return $ret;
}
/**
* Remove translation lock.
*
* @param string $moduleName
* @param string $lang
*
* @return void
*
* @static
*/
public static function removeTranslationLock($moduleName, $lang)
{
$fileName = SGL_VAR_DIR . "/translation/{$moduleName}_{$lang}.lock.txt";
if (file_exists($fileName)) {
$ok = unlink($fileName);
if ($ok === false) {
return SGL::raiseError(__CLASS__ . ': error removing transation '
. 'locking file', SGL_ERROR_INVALIDFILEPERMS);
}
}
}
/**
* Remove locks set by $username.
*
* @param string $userName
*
* @return void
*
* @static
*/
public static function removeTranslationLocksByUser($username)
{
$targetDir = SGL_VAR_DIR . '/translation';
if (file_exists($targetDir) && is_readable($targetDir)) {
$dh = opendir($targetDir);
while (($fileName = readdir($dh)) !== false) {
if ($fileName == '..' || $fileName == '.') {
continue;
}
$configFile = $targetDir . '/' . $fileName;
$lockedUser = file_get_contents($configFile);
if ($lockedUser == $username) {
$ok = unlink($configFile);
if ($ok === false) {
return SGL::raiseError(__CLASS__ . ': error removing '
. 'transation locking file',
SGL_ERROR_INVALIDFILEPERMS);
}
}
}
closedir($dh);
}
}
/**
* Ensure that target dir exist and is writable.
*
* @param string $dirName
*
* @return boolean
*
* @static
*
* @todo move to SGL_File
*/
public static function ensureDirIsWrirable($dirName)
{
if (!is_writable($dirName)) {
require_once 'System.php';
$ok = System::mkDir(array('-p', $dirName));
if (SGL::isError($ok)) {
return $ok;
}
if (!$ok) {
return SGL::raiseError("Error making directory
'$dirName' writable");
}
$mask = umask(0);
$ok = @chmod($dirName, 0777);
if (!$ok) {
return SGL::raiseError("Error performing chmod on
directory '$dirName'");
}
umask($mask);
}
return true;
}
/**
* Esacape single quote.
*
* @param string $string
*
* @return string
*
* @static
*
* @todo move to SGL_String
*/
public static function escapeSingleQuote($string)
{
$ret = str_replace('\\', '\\\\', $string);
$ret = str_replace("'", '\\\'', $ret);
return $ret;
}
/**
* Escape single quotes in every key of given array.
*
* @param array $array
*
* @return array
*
* @static
*/
public static function escapeSingleQuoteInArrayKeys($array)
{
$ret = array();
foreach ($array as $key => $value) {
$k = SGL_Translation::escapeSingleQuote($key);
$ret[$k] = is_array($value)
? SGL_Translation::escapeSingleQuoteInArrayKeys($value)
: $value;
}
return $ret;
}
}
}
?>