pax_global_header00006660000000000000000000000064117031116460014512gustar00rootroot0000000000000052 comment=afcae3edb37de0a67e379c93484149ede5e0781e php-horde-history-1.0.0/000077500000000000000000000000001170311164600150755ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/000077500000000000000000000000001170311164600203115ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/lib/000077500000000000000000000000001170311164600210575ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/000077500000000000000000000000001170311164600221205ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/History.php000066400000000000000000000225361170311164600243020ustar00rootroot00000000000000 * @author Gunnar Wrobel * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ /** * The Horde_History:: class provides a method of tracking changes in Horde * objects, stored in a SQL table. * * Copyright 2003-2011 The Horde Project (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. * * @category Horde * @package History * @author Chuck Hagenbuch * @author Gunnar Wrobel * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ abstract class Horde_History { /** * The current user. * * @var string */ protected $_auth; /** * Our log handler. * * @var Horde_Log_Logger */ protected $_logger; /** * Constructor. * * @param string $auth The current user. */ public function __construct($auth) { $this->_auth = $auth; } /** * Set the log handler. * * @param Horde_Log_Logger $logger The log handler. * * @return NULL */ public function setLogger(Horde_Log_Logger $logger) { $this->_logger = $logger; } /** * Logs an event to an item's history log. * * The item must be uniquely identified by $guid. Any other details about * the event are passed in $attributes. Standard suggested attributes are: * - who: The id of the user that performed the action (will be added * automatically if not present). * - ts: Timestamp of the action (this will be added automatically if it * is not present). * * @param string $guid The unique identifier of the entry to add * to. * @param array $attributes The hash of name => value entries that * describe this event. * @param boolean $replaceAction If $attributes['action'] is already * present in the item's history log, update * that entry instead of creating a new one. * * @throws Horde_History_Exception */ public function log($guid, array $attributes = array(), $replaceAction = false) { if (!is_string($guid)) { throw new Horde_History_Exception('The guid needs to be a string!'); } $history = $this->getHistory($guid); if (!isset($attributes['who'])) { $attributes['who'] = $this->_auth; } if (!isset($attributes['ts'])) { $attributes['ts'] = time(); } $this->_log($history, $attributes, $replaceAction); } /** * Logs an event to an item's history log. Any other details about the * event are passed in $attributes. * * @param Horde_History_Log $history The history item to add to. * @param array $attributes The hash of name => value * entries that describe this * event. * @param boolean $replaceAction If $attributes['action'] is * already present in the item's * history log, update that entry * instead of creating a new one. * * @throws Horde_History_Exception */ abstract protected function _log(Horde_History_Log $history, array $attributes, $replaceAction = false); /** * Returns a Horde_History_Log corresponding to the named history entry, * with the data retrieved appropriately. * * @param string $guid The name of the history entry to retrieve. * * @return Horde_History_Log A Horde_History_Log object. * * @throws Horde_History_Exception */ public function getHistory($guid) { if (!is_string($guid)) { throw new Horde_History_Exception('The guid needs to be a string!'); } return $this->_getHistory($guid); } /** * Returns a Horde_History_Log corresponding to the named history entry, * with the data retrieved appropriately. * * @param string $guid The name of the history entry to retrieve. * * @return Horde_History_Log A Horde_History_Log object. */ abstract public function _getHistory($guid); /** * Finds history objects by timestamp, and optionally filter on other * fields as well. * * @param string $cmp The comparison operator (<, >, <=, >=, or =) to * check the timestamps with. * @param integer $ts The timestamp to compare against. * @param array $filters An array of additional (ANDed) criteria. * Each array value should be an array with 3 * entries: * - field: the history field being compared (i.e. * 'action'). * - op: the operator to compare this field with. * - value: the value to check for (i.e. 'add'). * @param string $parent The parent history to start searching at. If * non-empty, will be searched for with a LIKE * '$parent:%' clause. * * @return array An array of history object ids, or an empty array if * none matched the criteria. * * @throws Horde_History_Exception */ public function getByTimestamp($cmp, $ts, array $filters = array(), $parent = null) { if (!is_string($cmp)) { throw new Horde_History_Exception('The comparison operator needs to be a string!'); } if (!is_integer($ts)) { throw new Horde_History_Exception('The timestamp needs to be an integer!'); } return $this->_getByTimestamp($cmp, $ts, $filters, $parent); } /** * Finds history objects by timestamp, and optionally filter on other * fields as well. * * @param string $cmp The comparison operator (<, >, <=, >=, or =) to * check the timestamps with. * @param integer $ts The timestamp to compare against. * @param array $filters An array of additional (ANDed) criteria. * Each array value should be an array with 3 * entries: * - field: the history field being compared (i.e. * 'action'). * - op: the operator to compare this field with. * - value: the value to check for (i.e. 'add'). * @param string $parent The parent history to start searching at. If * non-empty, will be searched for with a LIKE * '$parent:%' clause. * * @return array An array of history object ids, or an empty array if * none matched the criteria. * * @throws Horde_History_Exception */ abstract public function _getByTimestamp($cmp, $ts, array $filters = array(), $parent = null); /** * Gets the timestamp of the most recent change to $guid. * * @param string $guid The name of the history entry to retrieve. * @param string $action An action: 'add', 'modify', 'delete', etc. * * @return integer The timestamp, or 0 if no matching entry is found. * * @throws Horde_History_Exception If the input parameters are not of type string. */ public function getActionTimestamp($guid, $action) { if (!is_string($guid) || !is_string($action)) { throw new Horde_History_Exception('$guid and $action need to be strings!'); } try { $history = $this->getHistory($guid); } catch (Horde_History_Exception $e) { return 0; } $last = 0; foreach ($history as $entry) { if (($entry['action'] == $action) && ($entry['ts'] > $last)) { $last = $entry['ts']; } } return (int)$last; } /** * Remove one or more history entries by parent. * * @param string $parent The parent name to remove. * * @throws Horde_History_Exception */ public function removeByParent($parent) { /* Remove entries 100 at a time. */ $all = array_keys($this->getByTimestamp('>', 0, array(), $parent)); while (count($d = array_splice($all, 0, 100)) > 0) { $this->removebyNames($d); } } /** * Removes one or more history entries by name. * * @param array $names The history entries to remove. * * @throws Horde_History_Exception */ abstract public function removeByNames(array $names); } php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/History/000077500000000000000000000000001170311164600235615ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/History/Exception.php000066400000000000000000000006621170311164600262340ustar00rootroot00000000000000 * @category Horde * @package History */ class Horde_History_Exception extends Horde_Exception_Wrapped { } php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/History/Log.php000066400000000000000000000036461170311164600250240ustar00rootroot00000000000000 * @author Jan Schneider * @package History */ class Horde_History_Log implements IteratorAggregate, ArrayAccess, Countable { /** * TODO */ public $uid; /** * TODO */ protected $_data = array(); /** * Constructor. * * TODO */ public function __construct($uid, $data = array()) { $this->uid = $uid; if (!$data) { return; } reset($data); while (list(,$row) = each($data)) { $history = array( 'action' => $row['history_action'], 'desc' => $row['history_desc'], 'who' => $row['history_who'], 'id' => $row['history_id'], 'ts' => $row['history_ts'] ); if ($row['history_extra']) { $extra = @unserialize($row['history_extra']); if ($extra) { $history = array_merge($history, $extra); } } $this->_data[] = $history; } } public function getIterator() { return new ArrayIterator($this->_data); } public function offsetExists($offset) { return isset($this->_data[$offset]); } public function offsetGet($offset) { return $this->_data[$offset]; } public function offsetSet($offset, $value) { $this->_data[$offset] = $value; } public function offsetUnset($offset) { unset($this->_data[$offset]); } public function count() { return count($this->_data); } } php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/History/Mock.php000066400000000000000000000172701170311164600251720ustar00rootroot00000000000000 * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ /** * The Horde_History_Mock:: class provides a method of tracking changes in * Horde objects, stored in memory. * * Copyright 2009-2011 The Horde Project (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. * * @category Horde * @package History * @author Gunnar Wrobel * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ class Horde_History_Mock extends Horde_History { /** * Our storage location. * * @var array */ private $_data = array(); /** * The next id. * * @var int */ private $_id = 1; /** * Logs an event to an item's history log. Any other details about the * event are passed in $attributes. * * @param Horde_History_Log $history The history item to add to. * @param array $attributes The hash of name => value * entries that describe this * event. * @param boolean $replaceAction If $attributes['action'] is * already present in the item's * history log, update that entry * instead of creating a new one. * * @throws Horde_History_Exception */ protected function _log(Horde_History_Log $history, array $attributes, $replaceAction = false) { $values = array( 'history_uid' => $history->uid, 'history_ts' => $attributes['ts'], 'history_who' => $attributes['who'], 'history_desc' => isset($attributes['desc']) ? $attributes['desc'] : null, 'history_action' => isset($attributes['action']) ? $attributes['action'] : null ); unset($attributes['ts'], $attributes['who'], $attributes['desc'], $attributes['action']); $values['history_extra'] = $attributes ? serialize($attributes) : null; /* If we want to replace an entry with the same action, try and find * one. Track whether or not we succeed in $done, so we know whether * or not to add the entry later. */ $done = false; if ($replaceAction && !empty($values['history_action'])) { foreach ($history as $entry) { if (!empty($entry['action']) && $entry['action'] == $values['history_action']) { $this->_data[$entry['id']] = $values; $done = true; break; } } } /* If we're not replacing by action, or if we didn't find an entry to * replace, insert a new row. */ if (!$done) { $this->_data[$this->_id] = $values; $this->_id++; } } /** * Returns a Horde_History_Log corresponding to the named history entry, * with the data retrieved appropriately. * * @param string $guid The name of the history entry to retrieve. * * @return Horde_History_Log A Horde_History_Log object. */ public function _getHistory($guid) { $result= array(); foreach ($this->_data as $id => $element) { if ($element['history_uid'] == $guid) { $element['history_id'] = $id; $result[] = $element; } } return new Horde_History_Log($guid, $result); } /** * Finds history objects by timestamp, and optionally filter on other * fields as well. * * @param string $cmp The comparison operator (<, >, <=, >=, or =) to * check the timestamps with. * @param integer $ts The timestamp to compare against. * @param array $filters An array of additional (ANDed) criteria. * Each array value should be an array with 3 * entries: * - field: the history field being compared (i.e. * 'action'). * - op: the operator to compare this field with. * - value: the value to check for (i.e. 'add'). * @param string $parent The parent history to start searching at. If * non-empty, will be searched for with a LIKE * '$parent:%' clause. * * @return array An array of history object ids, or an empty array if * none matched the criteria. * * @throws Horde_History_Exception */ public function _getByTimestamp($cmp, $ts, array $filters = array(), $parent = null) { $result = array(); foreach ($this->_data as $id => $element) { $ignore = false; switch ($cmp) { case '<=': case '=<': if ($element['history_ts'] > $ts) { $ignore = true; }; break; case '<': if ($element['history_ts'] >= $ts) { $ignore = true; }; break; case '=': if ($element['history_ts'] != $ts) { $ignore = true; }; break; case '>': if ($element['history_ts'] <= $ts) { $ignore = true; }; break; case '>=': case '=>': if ($element['history_ts'] < $ts) { $ignore = true; }; break; default: throw new Horde_History_Exception(sprintf("Comparison %s not implemented!", $cmp)); } if ($ignore) { continue; } /* Add additional filters, if there are any. */ if ($filters) { foreach ($filters as $filter) { if ($filter['op'] != '=') { throw new Horde_History_Exception(sprintf("Comparison %s not implemented!", $filter['op'])); } if ($element['history_' . $filter['field']] != $filter['value']) { $ignore = true; } } } if ($ignore) { continue; } if ($parent) { if (substr($element['history_uid'], 0, strlen($parent) + 1) != $parent . ':') { continue; } } $result[$element['history_uid']] = $id; } return $result; } /** * Removes one or more history entries by name. * * @param array $names The history entries to remove. * * @throws Horde_History_Exception */ public function removeByNames(array $names) { if (!count($names)) { return; } $ids = array(); foreach ($this->_data as $id => $element) { if (in_array($element['history_uid'], $names)) { $ids[] = $id; } } foreach ($ids as $id) { unset($this->_data[$id]); } } } php-horde-history-1.0.0/Horde_History-1.0.0/lib/Horde/History/Sql.php000066400000000000000000000207341170311164600250370ustar00rootroot00000000000000 * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ /** * The Horde_History_Sql:: class provides a method of tracking changes in * Horde objects, stored in a SQL table. * * Copyright 2003-2011 The Horde Project (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. * * @category Horde * @package History * @author Chuck Hagenbuch * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ class Horde_History_Sql extends Horde_History { /** * Horde_Db_Adapter instance to manage the history. * * @var Horde_Db_Adapter */ protected $_db; /** * Constructor. * * @param string $auth The current user. * @param Horde_Db_Adapter $db The database connection. */ public function __construct($auth, Horde_Db_Adapter $db) { parent::__construct($auth); $this->_db = $db; } /** * Gets the timestamp of the most recent change to $guid. * * @param string $guid The name of the history entry to retrieve. * @param string $action An action: 'add', 'modify', 'delete', etc. * * @return integer The timestamp, or 0 if no matching entry is found. * * @throws Horde_History_Exception If the input parameters are not of type string. */ public function getActionTimestamp($guid, $action) { if (!is_string($guid) || !is_string($action)) { throw new Horde_History_Exception('$guid and $action need to be strings!'); } try { $result = $this->_db->selectValue('SELECT MAX(history_ts) FROM horde_histories WHERE history_action = ? AND object_uid = ?', array($action, $guid)); } catch (Horde_Db_Exception $e) { return 0; } return (int)$result; } /** * Logs an event to an item's history log. Any other details about the * event are passed in $attributes. * * @param Horde_History_Log $history The history item to add to. * @param array $attributes The hash of name => value * entries that describe this * event. * @param boolean $replaceAction If $attributes['action'] is * already present in the item's * history log, update that entry * instead of creating a new one. * * @throws Horde_History_Exception */ protected function _log(Horde_History_Log $history, array $attributes, $replaceAction = false) { /* If we want to replace an entry with the same action, try and find * one. Track whether or not we succeed in $done, so we know whether or * not to add the entry later. */ $done = false; if ($replaceAction && !empty($attributes['action'])) { foreach ($history as $entry) { if (!empty($entry['action']) && $entry['action'] == $attributes['action']) { $values = array( $attributes['ts'], $attributes['who'], isset($attributes['desc']) ? $attributes['desc'] : null ); unset($attributes['ts'], $attributes['who'], $attributes['desc'], $attributes['action']); $values[] = $attributes ? serialize($attributes) : null; $values[] = $entry['id']; try { $r = $this->_db->update( 'UPDATE horde_histories SET history_ts = ?,' . ' history_who = ?,' . ' history_desc = ?,' . ' history_extra = ? WHERE history_id = ?', $values ); } catch (Horde_Db_Exception $e) { throw new Horde_History_Exception($e); } $done = true; break; } } } /* If we're not replacing by action, or if we didn't find an entry to * replace, insert a new row. */ if (!$done) { $values = array( $history->uid, $attributes['ts'], $attributes['who'], isset($attributes['desc']) ? $attributes['desc'] : null, isset($attributes['action']) ? $attributes['action'] : null ); unset($attributes['ts'], $attributes['who'], $attributes['desc'], $attributes['action']); $values[] = $attributes ? serialize($attributes) : null; try { $this->_db->insert( 'INSERT INTO horde_histories (object_uid, history_ts, history_who, history_desc, history_action, history_extra)' . ' VALUES (?, ?, ?, ?, ?, ?)', $values ); } catch (Horde_Db_Exception $e) { throw new Horde_History_Exception($e); } } } /** * Returns a Horde_History_Log corresponding to the named history entry, * with the data retrieved appropriately. * * @param string $guid The name of the history entry to retrieve. * * @return Horde_History_Log A Horde_History_Log object. * * @throws Horde_History_Exception */ public function _getHistory($guid) { $rows = $this->_db->selectAll('SELECT * FROM horde_histories WHERE object_uid = ?', array($guid)); return new Horde_History_Log($guid, $rows); } /** * Finds history objects by timestamp, and optionally filter on other * fields as well. * * @param string $cmp The comparison operator (<, >, <=, >=, or =) to * check the timestamps with. * @param integer $ts The timestamp to compare against. * @param array $filters An array of additional (ANDed) criteria. * Each array value should be an array with 3 * entries: * - field: the history field being compared (i.e. * 'action'). * - op: the operator to compare this field with. * - value: the value to check for (i.e. 'add'). * @param string $parent The parent history to start searching at. If * non-empty, will be searched for with a LIKE * '$parent:%' clause. * * @return array An array of history object ids, or an empty array if * none matched the criteria. * * @throws Horde_History_Exception */ public function _getByTimestamp($cmp, $ts, array $filters = array(), $parent = null) { /* Build the timestamp test. */ $where = array("history_ts $cmp $ts"); /* Add additional filters, if there are any. */ if ($filters) { foreach ($filters as $filter) { $where[] = 'history_' . $filter['field'] . ' ' . $filter['op'] . ' ' . $this->_db->quote($filter['value']); } } if ($parent) { $where[] = 'object_uid LIKE ' . $this->_db->quote($parent . ':%'); } return $this->_db->selectAssoc('SELECT DISTINCT object_uid, history_id FROM horde_histories WHERE ' . implode(' AND ', $where)); } /** * Removes one or more history entries by name. * * @param array $names The history entries to remove. * * @throws Horde_History_Exception */ public function removeByNames(array $names) { if (!count($names)) { return; } $ids = array(); foreach ($names as $name) { $ids[] = $this->_db->quote($name); } $this->_db->delete('DELETE FROM horde_histories WHERE object_uid IN (' . implode(',', $ids) . ')'); } } php-horde-history-1.0.0/Horde_History-1.0.0/migration/000077500000000000000000000000001170311164600223025ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/migration/Horde_History/000077500000000000000000000000001170311164600250645ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/migration/Horde_History/1_horde_history_base_tables.php000066400000000000000000000021351170311164600332240ustar00rootroot00000000000000tables())) { $t = $this->createTable('horde_histories', array('autoincrementKey' => array('history_id'))); $t->column('history_id', 'integer', array('null' => false, 'unsigned' => true)); $t->column('object_uid', 'string', array('limit' => 255, 'null' => false)); $t->column('history_action', 'string', array('limit' => 32, 'null' => false)); $t->column('history_ts', 'bigint', array('null' => false)); $t->column('history_desc', 'text'); $t->column('history_who', 'string', array('limit' => 255)); $t->column('history_extra', 'text'); $t->end(); $this->addIndex('horde_histories', array('history_action')); $this->addIndex('horde_histories', array('history_ts')); $this->addIndex('horde_histories', array('object_uid')); } } public function down() { $this->dropTable('horde_histories'); } } 2_horde_history_upgrade_autoincrement.php000066400000000000000000000007331170311164600352700ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/migration/Horde_HistorychangeColumn('horde_histories', 'history_id', 'autoincrementKey'); try { $this->dropTable('horde_histories_seq'); } catch (Horde_Db_Exception $e) { } } public function down() { $this->changeColumn('horde_histories', 'history_id', 'integer', array('null' => false, 'unsigned' => true)); } }php-horde-history-1.0.0/Horde_History-1.0.0/test/000077500000000000000000000000001170311164600212705ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/test/Horde/000077500000000000000000000000001170311164600223315ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/test/Horde/History/000077500000000000000000000000001170311164600237725ustar00rootroot00000000000000php-horde-history-1.0.0/Horde_History-1.0.0/test/Horde/History/AllTests.php000066400000000000000000000014151170311164600262370ustar00rootroot00000000000000 * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ /** * Define the main method */ if (!defined('PHPUnit_MAIN_METHOD')) { define('PHPUnit_MAIN_METHOD', 'Horde_History_AllTests::main'); } /** * Prepare the test setup. */ require_once 'Horde/Test/AllTests.php'; /** * @package History * @subpackage UnitTests */ class Horde_History_AllTests extends Horde_Test_AllTests { } Horde_History_AllTests::init('Horde_History', __FILE__); if (PHPUnit_MAIN_METHOD == 'Horde_History_AllTests::main') { Horde_History_AllTests::main(); } php-horde-history-1.0.0/Horde_History-1.0.0/test/Horde/History/Autoload.php000066400000000000000000000006421170311164600262550ustar00rootroot00000000000000 * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ require_once 'Horde/Test/Autoload.php'; /** Catch strict standards */ error_reporting(E_ALL | E_STRICT); php-horde-history-1.0.0/Horde_History-1.0.0/test/Horde/History/InterfaceTest.php000066400000000000000000000402321170311164600272440ustar00rootroot00000000000000 * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ /** * Prepare the test setup. */ require_once dirname(__FILE__) . '/Autoload.php'; /** * A test suite for the Horde_History:: interface. DOX format is suggested for * the PHPUnit test report. * * Copyright 2009-2011 The Horde Project (http://www.horde.org/) * * See the enclosed file COPYING for license information (LGPL). If you * did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. * * @category Horde * @package History * @author Gunnar Wrobel * @license http://www.fsf.org/copyleft/lgpl.html LGPL * @link http://pear.horde.org/index.php?package=History */ class Horde_History_InterfaceTest extends PHPUnit_Framework_TestCase { /** * Identify the environments we want to run our tests in. * * @return array The selected environments. */ public function getEnvironments() { if (empty($this->_environments)) { /* The db environment provides our only test scenario before * refactoring. */ $this->_environments = array('Mock', 'Sql'); } return $this->_environments; } /** * Specifically set the environments we wish to support. * * @param array $environments The selected environments. * * @return NULL */ public function setEnvironments($environments) { $this->_environments = $environments; } /** * Initialize the given environment. * * @param string $environment The selected environment. * * @return Horde_History The environment. */ public function initializeEnvironment($environment) { switch ($environment) { case 'Sql': $table = << ':memory:')); $db->execute($table); $db->execute('CREATE INDEX history_action_idx ON horde_histories (history_action)'); $db->execute('CREATE INDEX history_ts_idx ON horde_histories (history_ts)'); $db->execute('CREATE INDEX history_uid_idx ON horde_histories (object_uid)'); return new Horde_History_Sql('test', $db); case 'Mock': return new Horde_History_Mock('test'); } } /** * Return the history handler for the specified environment. * * @param string $environment The selected environment. * * @return Horde_History The history. */ public function getHistory($environment) { if (!isset($this->_histories[$environment])) { $this->_histories[$environment] = $this->initializeEnvironment($environment); } return $this->_histories[$environment]; } public function testMethodLogHasPostConditionThatTimestampAndActorAreAlwaysRecorded() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me','action' => 'test')); $this->assertTrue($history->getActionTimestamp('test', 'test') > 0); $data = $history->getHistory('test'); $this->assertTrue(isset($data[0]['who'])); } } public function testMethodLogHasPostConditionThatTheGivenEventHasBeenRecorded() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $this->assertEquals(1000, $history->getActionTimestamp('test', 'test')); } } public function testMethodLogHasParameterStringGuid() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); try { $history->log(array()); $this->fail('No exception!'); } catch (Horde_History_Exception $e) { } } } public function testMethodLogHasArrayParameterBooleanReplaceaction() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test'), false); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours')); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours'), true); $data = $history->getHistory('test'); $expect = array( 'action' => 'test', 'desc' => '', 'who' => 'me', 'id' => 1, 'ts' => 1000, ); $this->assertEquals($expect, $data[0]); $expect = array( 'action' => 'test', 'desc' => '', 'who' => 'me', 'id' => 2, 'ts' => 1000, ); $this->assertEquals($expect, $data[1]); $expect = array( 'action' => 'yours', 'desc' => '', 'who' => 'you', 'id' => 3, 'ts' => 2000, ); $this->assertEquals($expect, $data[2]); } } public function testMethodGethistoryHasParameterStringGuid() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); try { $history->getHistory(array()); $this->fail('No exception!'); } catch (Horde_History_Exception $e) { } } } public function testMethodGethistoryHasResultHordehistorylogRepresentingTheHistoryLogMatchingTheGivenGuid() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours', 'extra' => array('a' => 'a'))); $data = $history->getHistory('test'); $expect = array( 'action' => 'test', 'desc' => '', 'who' => 'me', 'id' => 1, 'ts' => 1000, ); $this->assertEquals($expect, $data[0]); $expect = array( 'action' => 'yours', 'desc' => '', 'who' => 'you', 'id' => 2, 'ts' => 2000, 'extra' => array('a' => 'a'), ); $this->assertEquals($expect, $data[1]); } } public function testMethodGetbytimestampHasParameterStringCmp() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); try { $history->getByTimestamp(array(), 1); $this->fail('No exception!'); } catch (Horde_History_Exception $e) { } } } public function testMethodGetbytimestampHasParameterIntegerTs() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); try { $history->getByTimestamp('>', 'hello'); $this->fail('No exception!'); } catch (Horde_History_Exception $e) { } } } public function testMethodGetbytimestampHasParameterArrayFilters() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours', 'extra' => array('a' => 'a'))); $result = $history->getByTimestamp('>', 1, array(array('field' => 'who', 'op' => '=', 'value' => 'you'))); $this->assertEquals(array('test' => 2), $result); } } public function testMethodGetbytimestampHasParameterStringParent() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test:a', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test:b', array('who' => 'you', 'ts' => 2000, 'action' => 'yours')); $history->log('yours', array('who' => 'you', 'ts' => 3000, 'action' => 'yours')); $result = $history->getByTimestamp('>', 1, array(), 'test'); $this->assertEquals(array('test:a' => 1, 'test:b' => 2), $result); } } public function testMethodGetbytimestampHasResultArrayContainingTheMatchingEventIds() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours', 'extra' => array('a' => 'a'))); $result = $history->getByTimestamp('<=', 1000); $this->assertEquals(array('test' => 2), $result); $result = $history->getByTimestamp('<', 1001); $this->assertEquals(array('test' => 2), $result); $result = $history->getByTimestamp('>', 1001); $this->assertEquals(array('test' => 3), $result); $result = $history->getByTimestamp('>=', 2000); $this->assertEquals(array('test' => 3), $result); $result = $history->getByTimestamp('=', 2000); $this->assertEquals(array('test' => 3), $result); $result = $history->getByTimestamp('>', 2000); $this->assertEquals(array(), $result); } } public function testMethodGetactiontimestampHasParameterStringGuid() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); try { $history->getActionTimestamp(array(), 'test'); $this->fail('No exception!'); } catch (Horde_History_Exception $e) { } } } public function testMethodGetactiontimestampHasParameterStringAction() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); try { $history->getActionTimestamp('test', array()); $this->fail('No exception!'); } catch (Horde_History_Exception $e) { } } } public function testMethodGetactiontimestampHasResultIntegerZeroIfGethistoryReturnsAnError() { $history = $this->getHistory('Sql'); $this->assertEquals(0, $history->getActionTimestamp('test', 'test')); } public function testMethodGetactiontimestampHasResultIntegerZeroIfThereIsNoMatchingRecord() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $this->assertEquals(0, $history->getActionTimestamp('test', 'test')); } } public function testMethodGetactiontimestampHasResultIntegerTimestampOfTheMatchingRecord() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1, 'action' => 'test')); $history->log('test', array('who' => 'me', 'ts' => 2, 'action' => 'test')); $this->assertEquals(2, $history->getActionTimestamp('test', 'test')); $history->log('test', array('who' => 'me', 'ts' => 3, 'action' => 'test')); $this->assertEquals(3, $history->getActionTimestamp('test', 'test')); } } public function testMethodRemovebynamesHasPostconditionThatAllNamedRevordsHaveBeenRemoved() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test'), false); $history->log('yours', array('who' => 'you', 'ts' => 2000, 'action' => 'yours')); $history->log('yours', array('who' => 'you', 'ts' => 2000, 'action' => 'yours'), true); $history->removeByNames(array('test')); $data = $history->getHistory('test'); $this->assertEquals(0, count($data)); $data = $history->getHistory('yours'); $expect = array( 'action' => 'yours', 'desc' => '', 'who' => 'you', 'id' => 3, 'ts' => 2000, ); $this->assertEquals($expect, $data[0]); $history->removeByNames(array('yours')); $data = $history->getHistory('yours'); $this->assertEquals(0, count($data)); } } public function testMethodRemovebynamesHasParameterArrayNames() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test'), false); $history->log('yours', array('who' => 'you', 'ts' => 2000, 'action' => 'yours')); $history->log('yours', array('who' => 'you', 'ts' => 2000, 'action' => 'yours'), true); $history->removeByNames(array('test', 'yours')); $data = $history->getHistory('test'); $this->assertEquals(0, count($data)); $data = $history->getHistory('yours'); $this->assertEquals(0, count($data)); } } public function testMethodRemovebynamesSucceedsIfParameterNamesIsEmpty() { foreach ($this->getEnvironments() as $environment) { $history = $this->getHistory($environment); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test'), false); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours')); $history->log('test', array('who' => 'you', 'ts' => 2000, 'action' => 'yours'), true); $history->removeByNames(array()); } } public function testHordehistorysqlConvertsDbExceptionsToHordeHistoryExceptions() { $db = new Horde_Db_Adapter_Pdo_Sqlite(array('dbname' => ':memory:')); $history = new Horde_History_Sql('test', $db); try { $history->log('test', array('who' => 'me', 'ts' => 1000, 'action' => 'test')); $this->fail('No exception was thrown!'); } catch (Horde_Exception $e) { } try { $history->getHistory('test'); $this->fail('No exception was thrown!'); } catch (Horde_Exception $e) { } try { $history->getByTimestamp('>', 1, array(array('field' => 'who', 'op' => '=', 'value' => 'you'))); $this->fail('No exception was thrown!'); } catch (Horde_Exception $e) { } try { $history->removeByNames(array('test')); $this->fail('No exception was thrown!'); } catch (Horde_Exception $e) { } } } php-horde-history-1.0.0/Horde_History-1.0.0/test/Horde/History/phpunit.xml000066400000000000000000000002541170311164600262040ustar00rootroot00000000000000 ../../../lib php-horde-history-1.0.0/package.xml000066400000000000000000000147121170311164600172170ustar00rootroot00000000000000 Horde_History pear.horde.org API for tracking the history of an object. The Horde_History API provides a way to track changes on arbitrary pieces of data in Horde applications. Chuck Hagenbuch chuck chuck@horde.org yes 2011-04-06 1.0.0 1.0.0 stable stable LGPL * First stable release for Horde 4. 5.2.0 1.7.0 Horde_Db pear.horde.org 1.0.0 2.0.0 2.0.0 Horde_Exception pear.horde.org 1.0.0 2.0.0 2.0.0 0.0.1 0.0.1 alpha alpha 2004-01-25 LGPL Initial release as a PEAR package 2006-05-08 0.0.2 0.0.2 alpha alpha LGPL Converted to package.xml 2.0 for pear.horde.org 1.0.0alpha1 1.0.0 alpha alpha 2011-03-08 LGPL * First alpha release for Horde 4. 1.0.0beta1 1.0.0 beta beta 2011-03-16 LGPL * First beta release for Horde 4. 1.0.0RC1 1.0.0 beta beta 2011-03-22 LGPL * First release candidate for Horde 4. 1.0.0RC2 1.0.0 beta beta 2011-03-29 LGPL * Second release candidate for Horde 4. 1.0.0 1.0.0 stable stable 2011-04-06 LGPL * First stable release for Horde 4.