<?php
/**
* @version	$Id: phrases_cache.php 12299 2009-08-17 01:51:27Z dmitrya $
* @package	In-Portal
* @copyright	Copyright (C) 1997 - 2009 Intechnic. All rights reserved.
* @license      GNU/GPL
* In-Portal is Open Source software.
* This means that this software may have been modified pursuant
* the GNU General Public License, and as distributed it includes
* or is derivative of works licensed under the GNU General Public License
* or other free or open source software licenses.
* See http://www.in-portal.net/license/ for copyright notices and details.
*/

defined('FULL_PATH') or die('restricted access!');

class PhrasesCache extends kBase {

	/**
	* Connection to database
	*
	* @var kDBConnection
	* @access public
	*/
	var $Conn;

	var $Phrases = Array();
	var $Ids = Array();
	var $OriginalIds = Array(); //for comparing cache

	var $LanguageId = null;

	var $fromTag = false;

	/**
	 * Allows to edit existing phrases
	 *
	 * @var bool
	 */
	var $_editExisting = false;

	/**
	 * Allows to edit missing phrases
	 *
	 * @var bool
	 */
	var $_editMissing = false;

	/**
	 * Template, used for phrase adding/editing
	 *
	 * @var string
	 */
	var $_phraseEditTemplate = '';

	/**
	 * Use popup for phrase editing
	 *
	 * @var bool
	 */
	var $_usePopups = false;

	/**
	 * Use simplified form for phrase editing
	 *
	 * @var bool
	 */
	var $_simpleEditingMode = false;

	/**
	 * HTML tag used to translate phrases
	 *
	 * @var string
	 */
	var $_translateHtmlTag = 'a';

	function PhrasesCache()
	{
		parent::kBase();
		$this->Conn =& $this->Application->GetADODBConnection();

		if (defined('DEBUG_MODE') && DEBUG_MODE && $this->Application->IsAdmin()) {
			// only has effect in admin, because on front-end phrases are translated in "Content Mode"
			$this->_editMissing = defined('DBG_PHRASES') && DBG_PHRASES;
		}

		// now we use admin phrase editing template even on front-end
		$this->_phraseEditTemplate = 'regional/phrases_edit';
		$this->_usePopups = $this->Application->ConfigValue('UsePopups');
	}

	/**
	 * Sets phrase editing mode, that corresponds current editing mode
	 *
	 */
	function setPhraseEditing()
	{
		if (!$this->Application->IsAdmin() && (EDITING_MODE == EDITING_MODE_CONTENT)) {
			$this->_editExisting = true;
			$this->_editMissing = true;
			$this->_simpleEditingMode = true;
			$this->_translateHtmlTag = 'span';
		}
	}

	function Init($prefix, $special = '')
	{
		if (constOn('IS_INSTALL')) {
			$this->LanguageId = 1;
		}
		else {
			if ($this->Application->IsAdmin()) {
				$id_field = $this->Application->getUnitOption('lang', 'IDField');
				$table_name = $this->Application->getUnitOption('lang', 'TableName');
				$sql = 'SELECT '.$id_field.'
						FROM '.$table_name.'
						WHERE AdminInterfaceLang = 1';
				$this->LanguageId = $this->Conn->GetOne($sql);
			}
			else {
				$this->LanguageId = $this->Application->GetVar('m_lang');
			}
		}

		if (isset($this->Application->Caches['PhraseList'])) {
			$this->LoadPhrases( $this->Application->Caches['PhraseList'] );
		}
	}

	function GetCachedIds()
	{
		$cache_key = md5($this->Application->GetVar('t') . $this->Application->GetVar('m_theme') . $this->Application->GetVar('m_lang'));

		$sql = 'SELECT PhraseList, ConfigVariables
				FROM ' . TABLE_PREFIX . 'PhraseCache
				WHERE Template = ' . $this->Conn->qstr($cache_key);
		$res = $this->Conn->GetRow($sql);

		if ($res && $res['ConfigVariables']) {
			$this->Application->OriginalConfigCacheIds =  explode(',', $res['ConfigVariables']);
			$this->Application->ConfigCacheIds = $this->Application->OriginalConfigCacheIds;
		}

		return ($res === false) ? Array() : explode(',', $res['PhraseList']);
	}

	function LoadPhrases($ids)
	{
		if ( !is_array($ids) || !implode('', $ids) ) {
			return;
		}

		$sql = 'SELECT Translation, UPPER(Phrase) AS Phrase
				FROM ' . TABLE_PREFIX . 'Phrase
				WHERE (LanguageId = ' . $this->LanguageId . ') AND PhraseId IN (' . implode(',', $ids) . ')';
		$this->Phrases = $this->Conn->GetCol($sql, 'Phrase');

		/*foreach($phrases as $phrase => $tanslation)
		{
			$this->AddCachedPhrase(mb_strtoupper($phrase), $tanslation);
		}*/

		$this->Ids = $ids;
		$this->OriginalIds = $ids;
	}

	function AddCachedPhrase($label, $value)
	{
		$label = mb_strtoupper($label);
		$this->Phrases[$label] = $value;
	}

	function NeedsCacheUpdate()
	{
		return is_array($this->Ids) && count($this->Ids) > 0 && $this->Ids != $this->OriginalIds;
	}

	/**
	 * Copy from Application->UpdateCache method
	 *
	 * @deprecated
	 */
	function UpdateCache()
	{
		$update = false;
		//something changed
		$update = $update || (is_array($this->Ids) && count($this->Ids) > 0 && $this->Ids != $this->OriginalIds);
		$update = $update || (count($this->Application->ConfigCacheIds) && $this->Application->ConfigCacheIds != $this->Application->OriginalConfigCacheIds);
		if ($update) {
			$query = sprintf("REPLACE %s (PhraseList, CacheDate, Template, ConfigVariables)
												VALUES (%s, %s, %s, %s)",
												TABLE_PREFIX.'PhraseCache',
												$this->Conn->Qstr(join(',', $this->Ids)),
												adodb_mktime(),
												$this->Conn->Qstr(md5($this->Application->GetVar('t').$this->Application->GetVar('m_theme').$this->Application->GetVar('m_lang'))),
												$this->Conn->qstr(implode(',', array_unique($this->Application->ConfigCacheIds))));
			$this->Conn->Query($query);
		}
	}

	function GetPhrase($label, $allow_editing = true)
	{
		if (!isset($this->LanguageId)) {
			//actually possible when custom field contains references to language labels and its being rebuilt in OnAfterConfigRead
			//which is triggered by Sections rebuild, which in turn read all the configs and all of that happens BEFORE seeting the language...
			return 'impossible case';
		}

		if (ereg("^!.+!$", $label) > 0) {
			$label = substr($label, 1, -1); //cut exclamation marks
		}

		if (strlen($label) == 0) {
			return '';
		}

		$original_label = $label;
		$label = mb_strtoupper($label);

		if (array_key_exists($label, $this->Phrases)) {
			$translated_label = $this->Phrases[$label];

			if ($this->_editExisting && $allow_editing) {
				// option to change translation for Labels
				if ($this->_usePopups) {
					// link to popup when using popups (only in admin)
					$edit_url = 'javascript:translate_phrase(\'' . addslashes($original_label) . '\', \'' . $this->_phraseEditTemplate . '\', {event: \'OnPrepareUpdate\', simple_mode: ' . ($this->_simpleEditingMode ? 'true' : 'false') . '});';
				}
				else {
					// direct link, when not using popups OR on frontend
					$url_params = Array(
						'm_opener' => 'd',
						'phrases_label' => $original_label,
						'phrases_event' => 'OnPrepareUpdate',
						'simple_mode' => $this->_simpleEditingMode ? 1 : 0,
						'pass' => 'all,phrases'
					);

					$edit_url = $this->Application->HREF($this->_phraseEditTemplate, '', $url_params, 'index.php');
				}

				$translated_label = '<' . $this->_translateHtmlTag . ' href="' . $edit_url . '" name="cms-translate-phrase" title="Edit translation">' . $translated_label . '</' . $this->_translateHtmlTag . '>';

				if ($this->fromTag) {
					$translated_label = $this->escapeTagReserved($translated_label);
				}
			}

			return $translated_label;
		}

		$this->LoadPhraseByLabel($label, $original_label, $allow_editing);

		return $this->GetPhrase($label);
	}

	function LoadPhraseByLabel($label, $original_label, $allow_editing = true)
	{
		$sql = 'SELECT PhraseId, Translation
				FROM ' . TABLE_PREFIX . 'Phrase
				WHERE (LanguageId = ' . $this->LanguageId . ') AND (UPPER(Phrase) = UPPER(' . $this->Conn->qstr($label) . '))';
		$res = $this->Conn->GetRow($sql);

		if ($res === false || count($res) == 0) {
			$translation = '!' . $label . '!';

			if ($this->_editMissing && $allow_editing) {
				if ($this->_usePopups) {
					// link to popup when using popups (only in admin)
					$edit_url = 'javascript:translate_phrase(\'' . addslashes($original_label) . '\', \'' . $this->_phraseEditTemplate . '\', {event: \'OnNew\', simple_mode: ' . ($this->_simpleEditingMode ? 'true' : 'false') . '});';
				}
				else {
					// direct link, when not using popups OR on frontend
					$url_params = Array (
						'm_opener' => 'd',
						'phrases_label' => $original_label,
						'phrases_event' => 'OnNew',
						'simple_mode' => $this->_simpleEditingMode ? 1 : 0,
						'pass' => 'all,phrases'
					);

					$edit_url = $this->Application->HREF($this->_phraseEditTemplate, '', $url_params, 'index.php');
				}

				$translation = '<' . $this->_translateHtmlTag . ' href="' . $edit_url . '" class="cms-translate-phrase" title="Translate">!' . $label . '!</' . $this->_translateHtmlTag . '>';

				if ($this->fromTag) {
					$translation = $this->escapeTagReserved($translation);
				}
			}

			// add it as already cached, as long as we dont need to cache not found phrase
			$this->AddCachedPhrase($label, $translation);

			return false;
		}

		$this->Phrases[$label] = $res['Translation'];
		array_push($this->Ids, $res['PhraseId']);
		$this->Ids = array_unique($this->Ids); //just to make sure
		return true;
	}

	/**
	 * Sort params by name and then by length
	 *
	 * @param string $a
	 * @param string $b
	 * @return int
	 * @access private
	 */
	function CmpParams($a, $b)
	{
		$a_len = mb_strlen($a);
		$b_len = mb_strlen($b);
		if ($a_len == $b_len) return 0;
		return $a_len > $b_len ? -1 : 1;
	}

	/**
	 * Replace language tags in exclamation marks found in text
	 *
	 * @param string $text
	 * @param bool $force_escape force escaping, not escaping of resulting string
	 * @return string
	 * @access public
	 */
	function ReplaceLanguageTags($text,$forse_escaping=null)
	{
		$this->fromTag = true;
		if( isset($forse_escaping) ) $this->fromTag = $forse_escaping;
		preg_match_all("(!(la|lu)[^!]+!)", $text, $res, PREG_PATTERN_ORDER);
		$language_tags = $res[0];
		uasort($language_tags, Array(&$this, 'CmpParams') );

		$values = Array();
		$i = 0;
		foreach ($language_tags as $label) {
			array_push($values, $this->GetPhrase($label) );
			//array_push($values, $this->Application->Phrase($label) );
			$language_tags[$i] = '/' . $language_tags[$i] . '/';
			$i++;
		}
		$this->fromTag = false;

		return preg_replace($language_tags, $values, $text);
	}

	/**
	 * Escape chars in phrase translation, that could harm parser to process tag
	 *
	 * @param string $text
	 * @return string
	 * @access private
	 */
	function escapeTagReserved($text)
	{
		$reserved = Array('"',"'"); // =
		$replacement = Array('\"',"\'"); // \=
		return str_replace($reserved,$replacement,$text);
	}

}