ContentObject.php | searchcode

/administrator/components/com_joomfish/models/ContentObject.php

https://github.com/Shigaru/shigaru
PHP | 716 lines | 445 code | 94 blank | 177 comment | 125 complexity | 9222f42b78bcb481b2a0c0c5f89985a9 MD5 | raw file

<?php

/**

 * Joom!Fish - Multi Lingual extention and translation manager for Joomla!

 * Copyright (C) 2003 - 2012, Think Network GmbH, Munich

 *

 * All rights reserved.  The Joom!Fish project is a set of extentions for

 * the content management system Joomla!. It enables Joomla!

 * to manage multi lingual sites especially in all dynamic information

 * which are stored in the database.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * The "GNU General Public License" (GPL) is available at

 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

 * -----------------------------------------------------------------------------

 * $Id: ContentObject.php 1592 2012-01-20 12:51:08Z akede $

 * @package joomfish

 * @subpackage Models

 *

*/

JLoader::register('jfContent', JOOMFISH_ADMINPATH .DS. 'models' .DS. 'JFContent.php' );

JLoader::register('iJFTranslatable', JOOMFISH_ADMINPATH .DS. 'models' .DS. 'iJFTranslatable.php' );



/**

 * Representation of one content with his translation.

 * The object includes information from the original object and

 * the refering translation. Based on that information it is

 * able to handle all necessary interactions with the tranlsation.

 * Each instance of this object represents only one translation in

 * on specified language, but it handles all the fields within the

 * ContentElement.

 *

 * @package joomfish

 * @subpackage administrator

 * @copyright 2003 - 2012, Think Network GmbH, Munich

 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License

 * @version $Revision: 1592 $

 * @author Alex Kempkens

 */

class ContentObject implements iJFTranslatable {

	/** @var _contentElement Reference to the ContentElement definition of the instance */

	private $_contentElement;



	/** @var id ID of the based content */

	public $id;



	/** @var translation_id 	translation id value */

	public $translation_id=0;



	/** @var checked_out User who checked out this content if any */

	public $checked_out;



	/** @var title Title of the object; used from the field configured as titletext */

	public $title;



	/** @var titleTranslation the actual translation of the title */

	public $titleTranslation;



	/** @var language_id language for the translation */

	public $language_id;



	/** @var language Language name of the content */

	public $language;



	/** @var lastchanged Date when the translation was last modified */

	public $lastchanged;



	/** @var modified_date Date of the last modification of the content - if existing */

	public $modified_date;



	/** @var state State of the translation

	 * -1 := for at least one field of the content the translation is missing

	 *  0 := the translation exists but the original content was changed

	 *  1 := the translation is valid

	 */

	public $state=-1;



	/** @var int Number of changed fields */

	private $_numChangedFields=0;

	/** @var int Number of new fields, with an original other than NULL */

	private $_numNewAndNotNullFields=0;

	/** @var int Number for fields unchanged */

	private $_numUnchangedFields=0;



	/** published Flag if the translation is published or not */

	public $published=false;



	/** Standard constructor

	 *

	 * @param	languageID		ID of the associated language

	 * @param	elementTable	Reference to the ContentElementTable object

	 */

	public function __construct( $languageID,& $contentElement, $id=-1 ) {

		$db = JFactory::getDBO();



		if($id>0) $this->id = $id;

		$this->language_id = $languageID;

		$jfManager = JoomFishManager::getInstance();

		$lang = $jfManager->getLanguageByID($languageID);

		

		$this->language = $lang->name;

		$this->_contentElement = $contentElement;

	}



	/** Loads the information based on a certain content ID

	 */

	public function loadFromContentID( $id=null ) {

		$db = JFactory::getDBO();

		if( $id!=null && isset($this->_contentElement) && $this->_contentElement!==false ) {

			$db->setQuery( $this->_contentElement->createContentSQL( $this->language_id, $id ) );

			$row=null;

			$row = $db->loadObject(  );

			$this->id = $id;

			$this->readFromRow( $row );

		}

	}



	/** Reads the information from the values of the form

	 * The content element will be loaded first and then the values of the override

	 * what is actually in the element

	 *

	 * @param	array	The values which should be bound to the object

	 * @param	string	The field prefix

	 * @param	string	An optional field

	 * @param 	boolean	try to bind the values to the object

	 * @param 	boolean	store original values too

	 */

	public function bind( $formArray, $prefix="", $suffix="", $tryBind=true, $storeOriginalText=false ) {

		$user = JFactory::getUser();

		$db = JFactory::getDBO();



		if( $tryBind ) {

			$this->_jfBindArrayToObject( $formArray, $this );

		}

		if( $this->published=="" ) $this->published=0;



		// Go thru all the fields of the element and try to copy the content values

		$elementTable = $this->_contentElement->getTable();



		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldName=$field->Name;

			if( isset($formArray[$prefix ."refField_". $fieldName .$suffix]) ) {



				// Handle magic quotes compatability

				if (get_magic_quotes_gpc() && $field->Type !== 'htmltext') {

					$formArray[$prefix ."refField_". $fieldName .$suffix] = JRequest::_stripSlashesRecursive( $formArray[$prefix ."refField_". $fieldName .$suffix] );

					$formArray[$prefix ."origText_". $fieldName .$suffix] = JRequest::_stripSlashesRecursive( $formArray[$prefix ."origText_". $fieldName .$suffix] );

				}

				else {

					$formArray[$prefix ."refField_". $fieldName .$suffix] = JRequest::getVar( $prefix ."refField_". $fieldName .$suffix, '', 'post', 'string', JREQUEST_ALLOWRAW );

					$formArray[$prefix ."origText_". $fieldName .$suffix] = JRequest::getVar( $prefix ."origText_". $fieldName .$suffix, '', 'post', 'string', JREQUEST_ALLOWRAW );

				}



				$translationValue = $formArray[$prefix ."refField_". $fieldName .$suffix];

				$fieldContent = new jfContent($db);



				// code cleaner for xhtml transitional compliance

				if( $field->Type == 'titletext' || $field->Type == 'text') {

					jimport('joomla.filter.output');

					//$translationValue = JFilterOutput::ampReplace( $translationValue );

				}

				if( $field->Type == 'htmltext' ) {

					$translationValue = str_replace( '<br>', '<br />', $translationValue );



					// remove <br /> take being automatically added to empty fulltext

					$length	= strlen( $translationValue ) < 9;

					$search = strstr( $translationValue, '<br />');

					if ( $length && $search ) {

						$translationValue = NULL;

					}

				}

				if ($field->Type == "params" && is_array($translationValue)){

					$registry = new JRegistry();

					$registry->loadArray($translationValue);

					$translationValue = $registry->toString();

				}

				if ($field->posthandler!=""){

					if (method_exists($this,$field->posthandler)){

						$handler = $field->posthandler;

						$this->$handler($translationValue,$elementTable->Fields,$formArray,$prefix,$suffix,$storeOriginalText);

					}

				}



				$originalValue = $formArray[$prefix ."origValue_". $fieldName .$suffix];

				$originalText = ($storeOriginalText) ? $formArray[$prefix ."origText_". $fieldName .$suffix] : "";

				

				$fieldContent->id=$formArray[$prefix . "id_" .$fieldName .$suffix];

				$fieldContent->reference_id = (intval($formArray[$prefix . "reference_id" .$suffix]) > 0) ? intval($formArray[$prefix . "reference_id" .$suffix]) : $this->id;

				$fieldContent->language_id = $this->language_id;

				$fieldContent->reference_table= $db->getEscaped( $elementTable->Name );

				$fieldContent->reference_field= $db->getEscaped( $fieldName );

				$fieldContent->value = $translationValue;

				// original value will be already md5 encoded - based on that any encoding isn't needed!

				$fieldContent->original_value = $originalValue;

				$fieldContent->original_text = !is_null($originalText)?$originalText:"";

				

				$datenow =& JFactory::getDate();

				$fieldContent->modified 		= $datenow->toMySQL();

				

				$fieldContent->modified_by = $user->id;

				$fieldContent->published=$this->published;

				$field->translationContent = $fieldContent;



			}

		}

	}



	// Post handlers

	public function filterTitle(&$alias){

		if($alias=="") {

			$alias = JRequest::getString("refField_title");

		}

		$alias = JFilterOutput::stringURLSafe($alias);

	}



	public function filterName(&$alias){

		if($alias=="") {

			$alias = JRequest::getString("refField_name");

		}

		$alias = JFilterOutput::stringURLSafe($alias);

	}



	public function saveUrlParams(&$link){

		$urlparams = JRequest::getVar("urlparams",array(),'post',"array");

		if (is_array($urlparams) && count($urlparams)>0){

			$pos = strpos( $link, '?' );

			if ($pos !== false)

			{

				$prefix = substr( $link, 0, $pos );

				$query	= substr( $link, $pos+1 );



				$temp = array();

				if(strpos($query, '&amp;') !== false) {

					$query = str_replace('&amp;', '&', $query);

				}

				parse_str( $query, $temp );

				$temp2 = array_merge( $temp, $urlparams );



				$temp3 = array();

				foreach ($temp2 as $k => $v)

				{

					$temp3[] = $k.'='.$v;

				}

				$url = null;

				$link = $prefix . '?' . implode( '&', $temp3 );

			}

		}

		else {

			$menuid = JRequest::getInt("reference_id",0);

			if ($menuid==0) return;

			include_once( JPATH_SITE.DS.'includes'.DS.'application.php');

			$menu = JSite::getMenu();

			$item = $menu->getItem($menuid);

			if ($item->type=="menulink"){

				$urlparams = JRequest::getVar("refField_params",array(),'post',"array");

				if (is_array($urlparams) && count($urlparams)>0 && array_key_exists("menu_item",$urlparams)){

					$pos = strpos( $link, '?' );

					if ($pos !== false)

					{

						$prefix = substr( $link, 0, $pos );

						$link = $prefix . '?Itemid=' .$urlparams["menu_item"];

					}

				}

			}

		}

	}



	/**

	 * Special pre translation handler for content text to combine intro and full text

	 *

	 * @param unknown_type $row

	 */

	public function fetchArticleText($row){

		

		/*

		 * We need to unify the introtext and fulltext fields and have the

		 * fields separated by the {readmore} tag, so lets do that now.

		 */

		if (JString::strlen($row->fulltext) > 1) {

			return  $row->introtext . "<hr id=\"system-readmore\" />" . $row->fulltext;

		} else {

			return  $row->introtext;

		}



	}

	



	/**

	 * Special pre translation handler for content text to combine intro and full text

	 *

	 * @param unknown_type $row

	 */

	public function fetchArticleTranslation($field, &$translationFields){

		

		if (is_null($translationFields)) return;

		/*

		 * We need to unify the introtext and fulltext fields and have the

		 * fields separated by the {readmore} tag, so lets do that now.

		 */

		if (array_key_exists("fulltext",$translationFields)){

			if (isset($translationFields["introtext"])){

				$fulltext = $translationFields["fulltext"]->value;

				$introtext = $translationFields["introtext"]->value;

			}

			else {

				$translationFields["introtext"] = clone $translationFields["fulltext"];

				$translationFields["fulltext"]->value = "";

				$fulltext = "";

			}

			if (JString::strlen($fulltext) > 1) {

				$translationFields["introtext"]->value =  $introtext . "<hr id=\"system-readmore\" />" . $fulltext;

				$translationFields["fulltext"]->value = "";

			}

		}



	}

	

	

	/**

	 * Special post translation handler for content text to split intro and full text

	 *

	 * @param unknown_type $row

	 */

	public function saveArticleText(&$introtext, $fields,&$formArray,$prefix,$suffix,$storeOriginalText) {		

		

		// Search for the {readmore} tag and split the text up accordingly.

		$pattern = '#<hr\s+id=("|\')system-readmore("|\')\s*\/*>#i';

		$tagPos	= preg_match($pattern, $introtext);



		if ( $tagPos > 0 ) {

			list($introtext, $fulltext) = preg_split($pattern, $introtext, 2);

			JRequest::setVar($prefix ."refField_fulltext" .$suffix,$fulltext,"post");

			$formArray[$prefix ."refField_fulltext" .$suffix] = $fulltext;		

		}

		else {

			JRequest::setVar($prefix ."refField_fulltext" .$suffix,"","post");

			$formArray[$prefix ."refField_fulltext" .$suffix] = "";

		}

		

	}

	

	

	/** Reads the information out of an existing mosDBTable object into the contentObject.

	 *

	 * @param	object	instance of an mosDBTable object

	 */

	public function updateMLContent( &$dbObject ) {

		$db = JFactory::getDBO();

		if( $dbObject === null ) return;



		if( $this->published=="" ) $this->published=0;



		// retriev the original untranslated object for references

		// this MUST be copied by value and not by reference!

		$origObject = clone($dbObject);

		$key = $dbObject->get( '_tbl_key' );

		$db->setQuery( "SELECT * FROM " .$dbObject->get('_tbl'). " WHERE " .$key. "='" .$dbObject->$key. "'" );

		$origObject = $db->loadObject(  false );



		$this->copyContentToTranslation( $dbObject, $origObject );

	}



	/**

	 * This method copies a currect database object into the translations

	 * The original object might be the same kind of object and it is not required that

	 * both objects are of the type mosDBTable!

	 *

	 * @param object $dbObject new values for the translation

	 * @param object $origObject original values based on the db for reference

	 */

	public function copyContentToTranslation( &$dbObject, $origObject ) {

		$user = JFactory::getUser();



		// Go thru all the fields of the element and try to copy the content values

		$elementTable = $this->_contentElement->getTable();



		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldName=$field->Name;

			if( isset($dbObject->$fieldName) && $field->Translate ) {

				$translationValue = $dbObject->$fieldName;

				$fieldContent = $field->translationContent;



				$fieldContent->value = $translationValue;

				$dbObject->$fieldName = $origObject->$fieldName;

				$fieldContent->original_value = md5( $origObject->$fieldName );

				// ToDo: Add handling of original text!



				$datenow =& JFactory::getDate();

				$fieldContent->modified 		= $datenow->toMySQL();



				$fieldContent->modified_by = $user->id;

			}

		}

	}



	/** Reads some of the information from the overview row

	 */

	public function readFromRow( $row ) {

		$this->id = $row->id;

		$this->translation_id = $row->jfc_id;

		$this->title = $row->title;

		$this->titleTranslation = $row->titleTranslation;

		if( !isset($this->language_id) || $this->language_id == -1 ) {

			$this->language_id = $row->language_id;

			$this->language = $row->language;

		}

		$this->lastchanged = $row->lastchanged;

		$this->published = $row->published;

		if( isset($row->modified_date) ) $this->modified_date = $row->modified_date;

		if( isset($row->checked_out) ) $this->checked_out = $row->checked_out;



		// Go thru all the fields of the element and try to copy the content values

		$elementTable = $this->_contentElement->getTable();

		$fieldContent = new jfContent($db);

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldName = $field->Name;

			if( isset($row->$fieldName) ) {

				$field->originalValue = $row->$fieldName;

				

				if ($field->prehandleroriginal!=""){

					if (method_exists($this,$field->prehandleroriginal)){

						$handler = $field->prehandleroriginal;

						$field->originalValue = $this->$handler($row);

					}

				}

				

			}

		}





		$this->_loadContent();

	}



	/** Reads all translation information from the database

	 *

	 */

	private function _loadContent() {

		$db = JFactory::getDBO();



		$elementTable = $this->getTable();

		$sql = "select * "

		."\n  from #__jf_content"

		."\n where reference_id='" .$this->id."'"

		."\n   and reference_table='" .$elementTable->Name. "'";

		if( isset($this->language_id) && $this->language_id!="" ) {

			$sql .= "\n   and language_id=" .$this->language_id;

		}



		//echo "load sql=>$sql<<br />";

		$db->setQuery( $sql );

		$rows = $db->loadObjectList(false);

		if($db->getErrorNum() != 0) {

			JError::raiseWarning( 400,JTEXT::_('No valid table information: ') .$db->getErrorMsg());

		}



		$translationFields=null;

		if( count($rows) > 0 ) {

			foreach( $rows as $row ) {

				$fieldContent = new jfContent($db);

				if( !$fieldContent->bind( $row ) ) {

					JError::raiseWarning( 200, JText::_('Problems binding object to fields: ' .$fieldContent->getError()));

				}

				$translationFields[$fieldContent->reference_field] = $fieldContent;

			}

		}



		// Check fields and their state

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			

			if ($field->prehandlertranslation!=""){

				if (method_exists($this,$field->prehandlertranslation)){

					$handler = $field->prehandlertranslation;

					$this->$handler($field, $translationFields);

				}

			}



			if( isset($translationFields[$field->Name]) ) {

				$fieldContent = $translationFields[$field->Name];

			} else {

				$fieldContent = null;

			}



			if( $field->Translate) {

				if(isset($fieldContent) ) {

					$field->changed= (md5($field->originalValue) != $fieldContent->original_value);

					if( $field->changed ) {

						$this->_numChangedFields ++;

					}

					else $this->_numUnchangedFields++;

				}

				else{

					$fieldContent = new jfContent($db);

					$fieldContent->reference_id = $this->id;

					$fieldContent->reference_table = $elementTable->Name;

					$fieldContent->reference_field = $field->Name;

					$fieldContent->language_id = $this->language_id;

					$fieldContent->original_value = $field->originalValue;

					$field->changed =false;

					if ( $field->originalValue != '' ) {

						$this->_numNewAndNotNullFields ++;

					}

				}

			}

			$field->translationContent = $fieldContent;

		}



		// Checking the record state based on the fields. If one field is changed the record is modifed

		if( $this->_numChangedFields == 0 && $this->_numNewAndNotNullFields == 0 ) {

			$this->state = 1;

		} elseif ( $this->_numChangedFields == 0 && $this->_numNewAndNotNullFields > 0 && $this->_numUnchangedFields==0) {

			$this->state = -1;

		} else {

			$this->state = 0;

		}

	}



	/** Returns the content element fields which are text and can be translated

	 *

	 * @param	boolean	onle translateable fields?

	 * @return	array	of fieldnames

	 */

	public function getTextFields( $translation = true ) {

		$elementTable = $this->_contentElement->getTable();

		$textFields = null;



		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldType = $field->Type;

			if( $field->Translate == $translation && ($fieldType=="htmltext" || $fieldType=="text") ) {

				$textFields[] = $field->Name;

			}

		}



		return $textFields;

	}



	/**

	 * Returns the field type of a field

	 *

	 * @param string $fieldname

	 */

	public function getFieldType($fieldname){

		$elementTable = $this->_contentElement->getTable();

		$textFields = null;



		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			if ($elementTable->Fields[$i]->Name == $fieldname) return $elementTable->Fields[$i]->Type;

		}

		return "text";

	}



	/** Sets all fields of this content object to a certain published state

	*/

	public function setPublished( $published ) {

		$elementTable = $this->_contentElement->getTable();

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldContent = $field->translationContent;

			$fieldContent->published = $published;

		}

	}



	/** Updates the reference id of all included fields. This

	 * Happens e.g when the reference object was created new

	 *

	 * @param	referenceID		new reference id

	 */

	public function updateReferenceID( $referenceID ) {

		if( intval($referenceID) <= 0 ) return;



		$elementTable = $this->_contentElement->getTable();

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldContent = $field->translationContent;

			$fieldContent->reference_id = $referenceID;

		}

	}



	/** Stores all fields of the content element

	 */

	public function store() {

		$elementTable = $this->_contentElement->getTable();

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldContent = $field->translationContent;



			if( $field->Translate ) {

				if( isset($fieldContent->reference_id) ) {

					if ( isset($fieldContent->value) && $fieldContent->value!='' ) {

						$fieldContent->store(true);

					} 

					// special case to handle readmore in original when there is none in the translation

					else if (isset($fieldContent->value)  && $fieldContent->reference_table=="content" && $fieldContent->reference_field=="fulltext"){

						$fieldContent->store(true);

					}

					else {

						$fieldContent->delete();

					}

				}

			}

		}

	}



	/** Checkouts all fields of this content element

	*/

	public function checkout( $who, $oid=null ) {

		$elementTable = $this->_contentElement->getTable();

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldContent = $field->translationContent;



			if( $field->Translate ) {

				if( isset($fieldContent->reference_id) ) {

					$fieldContent->checkout( $who, $oid );

					JError::raiseWarning( 200, JText::_('Problems binding object to fields: ' .$fieldContent->getError()));

				}

			}

		}

	}



	/** Checkouts all fields of this content element

	*/

	public function checkin( $oid=null ) {

		$elementTable = $this->_contentElement->getTable();

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldContent = $field->translationContent;



			if( $field->Translate ) {

				if( isset($fieldContent->reference_id) ) {

					$fieldContent->checkin( $oid );

					JError::raiseWarning( 200, JText::_('Problems binding object to fields: ' .$fieldContent->getError()));

				}

			}

		}

	}



	/** Delets all translations (fields) of this content element

	*/

	public function delete( $oid=null ) {

		$elementTable = $this->_contentElement->getTable();

		for( $i=0; $i<count($elementTable->Fields); $i++ ) {

			$field = $elementTable->Fields[$i];

			$fieldContent = $field->translationContent;

			if( $field->Translate ) {

				if( isset($fieldContent->reference_id) ) {

					if( !$fieldContent->delete( $oid ) ) {

						echo $fieldContent->getError() ."<br />";

					}

				}

			}

		}

	}

	/** Returns the content element table this content is based on

	 */

	public function  getTable() {

		return $this->_contentElement->getTable();

	}







	/**

	 * Temporary legacy function copied from Joomla

	 *

	 * @param unknown_type $array

	 * @param unknown_type $obj

	 * @param unknown_type $ignore

	 * @param unknown_type $prefix

	 * @return unknown

	 */

	private function _jfBindArrayToObject( $array, &$obj, $ignore='', $prefix=NULL )

	{

		if (!is_array( $array ) || !is_object( $obj )) {

			return (false);

		}



		foreach (get_object_vars($obj) as $k => $v)

		{

			if( substr( $k, 0, 1 ) != '_' )

			{

				// internal attributes of an object are ignored

				if (strpos( $ignore, $k) === false)

				{

					if ($prefix) {

						$ak = $prefix . $k;

					} else {

						$ak = $k;

					}

					if (isset($array[$ak])) {

						$obj->$k = $array[$ak];

					}

				}

			}

		}



		return true;

	}



}

?>