1 <?php
  2 /**
  3  * @package     Joomla.Libraries
  4  * @subpackage  Table
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
  7  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8  */
  9 
 10 defined('JPATH_PLATFORM') or die;
 11 
 12 /**
 13  * Content History table.
 14  *
 15  * @since  3.2
 16  */
 17 class JTableContenthistory extends JTable
 18 {
 19     /**
 20      * Array of object fields to unset from the data object before calculating SHA1 hash. This allows us to detect a meaningful change
 21      * in the database row using the hash. This can be read from the #__content_types content_history_options column.
 22      *
 23      * @var    array
 24      * @since  3.2
 25      */
 26     public $ignoreChanges = array();
 27 
 28     /**
 29      * Array of object fields to convert to integers before calculating SHA1 hash. Some values are stored differently
 30      * when an item is created than when the item is changed and saved. This works around that issue.
 31      * This can be read from the #__content_types content_history_options column.
 32      *
 33      * @var    array
 34      * @since  3.2
 35      */
 36     public $convertToInt = array();
 37 
 38     /**
 39      * Constructor
 40      *
 41      * @param   JDatabaseDriver  $db  A database connector object
 42      *
 43      * @since   3.1
 44      */
 45     public function __construct($db)
 46     {
 47         parent::__construct('#__ucm_history', 'version_id', $db);
 48         $this->ignoreChanges = array(
 49             'modified_by',
 50             'modified_user_id',
 51             'modified',
 52             'modified_time',
 53             'checked_out',
 54             'checked_out_time',
 55             'version',
 56             'hits',
 57             'path',
 58         );
 59         $this->convertToInt  = array('publish_up', 'publish_down', 'ordering', 'featured');
 60     }
 61 
 62     /**
 63      * Overrides JTable::store to set modified hash, user id, and save date.
 64      *
 65      * @param   boolean  $updateNulls  True to update fields even if they are null.
 66      *
 67      * @return  boolean  True on success.
 68      *
 69      * @since   3.2
 70      */
 71     public function store($updateNulls = false)
 72     {
 73         $this->set('character_count', strlen($this->get('version_data')));
 74         $typeTable = JTable::getInstance('Contenttype');
 75         $typeTable->load($this->ucm_type_id);
 76 
 77         if (!isset($this->sha1_hash))
 78         {
 79             $this->set('sha1_hash', $this->getSha1($this->get('version_data'), $typeTable));
 80         }
 81 
 82         // Modify author and date only when not toggling Keep Forever
 83         if ($this->get('keep_forever') === null)
 84         {
 85             $this->set('editor_user_id', JFactory::getUser()->id);
 86             $this->set('save_date', JFactory::getDate()->toSql());
 87         }
 88 
 89         return parent::store($updateNulls);
 90     }
 91 
 92     /**
 93      * Utility method to get the hash after removing selected values. This lets us detect changes other than
 94      * modified date (which will change on every save).
 95      *
 96      * @param   mixed              $jsonData   Either an object or a string with json-encoded data
 97      * @param   JTableContenttype  $typeTable  Table object with data for this content type
 98      *
 99      * @return  string  SHA1 hash on success. Empty string on failure.
100      *
101      * @since   3.2
102      */
103     public function getSha1($jsonData, JTableContenttype $typeTable)
104     {
105         $object = is_object($jsonData) ? $jsonData : json_decode($jsonData);
106 
107         if (isset($typeTable->content_history_options) && is_object(json_decode($typeTable->content_history_options)))
108         {
109             $options = json_decode($typeTable->content_history_options);
110             $this->ignoreChanges = isset($options->ignoreChanges) ? $options->ignoreChanges : $this->ignoreChanges;
111             $this->convertToInt = isset($options->convertToInt) ? $options->convertToInt : $this->convertToInt;
112         }
113 
114         foreach ($this->ignoreChanges as $remove)
115         {
116             if (property_exists($object, $remove))
117             {
118                 unset($object->$remove);
119             }
120         }
121 
122         // Convert integers, booleans, and nulls to strings to get a consistent hash value
123         foreach ($object as $name => $value)
124         {
125             if (is_object($value))
126             {
127                 // Go one level down for JSON column values
128                 foreach ($value as $subName => $subValue)
129                 {
130                     $object->$subName = is_int($subValue) || is_bool($subValue) || $subValue === null ? (string) $subValue : $subValue;
131                 }
132             }
133             else
134             {
135                 $object->$name = is_int($value) || is_bool($value) || $value === null ? (string) $value : $value;
136             }
137         }
138 
139         // Work around empty values
140         foreach ($this->convertToInt as $convert)
141         {
142             if (isset($object->$convert))
143             {
144                 $object->$convert = (int) $object->$convert;
145             }
146         }
147 
148         if (isset($object->review_time))
149         {
150             $object->review_time = (int) $object->review_time;
151         }
152 
153         return sha1(json_encode($object));
154     }
155 
156     /**
157      * Utility method to get a matching row based on the hash value and id columns.
158      * This lets us check to make sure we don't save duplicate versions.
159      *
160      * @return  string  SHA1 hash on success. Empty string on failure.
161      *
162      * @since   3.2
163      */
164     public function getHashMatch()
165     {
166         $db    = $this->_db;
167         $query = $db->getQuery(true);
168         $query->select('*')
169             ->from($db->quoteName('#__ucm_history'))
170             ->where($db->quoteName('ucm_item_id') . ' = ' . (int) $this->get('ucm_item_id'))
171             ->where($db->quoteName('ucm_type_id') . ' = ' . (int) $this->get('ucm_type_id'))
172             ->where($db->quoteName('sha1_hash') . ' = ' . $db->quote($this->get('sha1_hash')));
173         $db->setQuery($query, 0, 1);
174 
175         return $db->loadObject();
176     }
177 
178     /**
179      * Utility method to remove the oldest versions of an item, saving only the most recent versions.
180      *
181      * @param   integer  $maxVersions  The maximum number of versions to save. All others will be deleted.
182      *
183      * @return  boolean   true on success, false on failure.
184      *
185      * @since   3.2
186      */
187     public function deleteOldVersions($maxVersions)
188     {
189         $result = true;
190 
191         // Get the list of version_id values we want to save
192         $db    = $this->_db;
193         $query = $db->getQuery(true);
194         $query->select($db->quoteName('version_id'))
195             ->from($db->quoteName('#__ucm_history'))
196             ->where($db->quoteName('ucm_item_id') . ' = ' . (int) $this->get('ucm_item_id'))
197             ->where($db->quoteName('ucm_type_id') . ' = ' . (int) $this->get('ucm_type_id'))
198             ->where($db->quoteName('keep_forever') . ' != 1')
199             ->order($db->quoteName('save_date') . ' DESC ');
200         $db->setQuery($query, 0, (int) $maxVersions);
201         $idsToSave = $db->loadColumn(0);
202 
203         // Don't process delete query unless we have at least the maximum allowed versions
204         if (count($idsToSave) === (int) $maxVersions)
205         {
206             // Delete any rows not in our list and and not flagged to keep forever.
207             $query = $db->getQuery(true);
208             $query->delete($db->quoteName('#__ucm_history'))
209                 ->where($db->quoteName('ucm_item_id') . ' = ' . (int) $this->get('ucm_item_id'))
210                 ->where($db->quoteName('ucm_type_id') . ' = ' . (int) $this->get('ucm_type_id'))
211                 ->where($db->quoteName('version_id') . ' NOT IN (' . implode(',', $idsToSave) . ')')
212                 ->where($db->quoteName('keep_forever') . ' != 1');
213             $db->setQuery($query);
214             $result = (boolean) $db->execute();
215         }
216 
217         return $result;
218     }
219 }
220 

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.