Merge pull request #91 from AlexeyDsov/uncachersSelf

Introducing Uncachers

core/Cache/Cache.class.php

@@ -58,6 +58,14 @@ public static function me()
 			self::$peer = $peer;
 		}
 
+		/**
+		 * @return CachePeer 
+		 */
+		public static function getPeer()
+		{
+			return self::$peer;
+		}
+
 		/* void */ public static function setDefaultWorker($worker)
 		{
 			Assert::classExists($worker);

core/DB/DB.class.php

@@ -42,6 +42,11 @@ abstract class DB
 
 		private $queue			= array();
 		private $toQueue		= false;
+		/**
+		 * @var UncachersPool
+		 */
+		private $uncacher		= null;
+		private $outOfTransactionCachePeer = null;
 
 		abstract public function connect();
 		abstract public function disconnect();
@@ -130,6 +135,9 @@ public function begin(
 
 			$this->transaction = true;
 
+			$this->outOfTransactionCachePeer = Cache::getPeer();
+			Cache::setPeer(new RuntimeMemory());
+
 			return $this;
 		}
 
@@ -146,6 +154,9 @@ public function commit()
 			$this->transaction = false;
 			$this->savepointList = array();
 
+			Cache::setPeer($this->outOfTransactionCachePeer);
+			$this->triggerUncacher();
+
 			return $this;
 		}
 
@@ -162,6 +173,9 @@ public function rollback()
 			$this->transaction = false;
 			$this->savepointList = array();
 
+			Cache::setPeer($this->outOfTransactionCachePeer);
+			$this->triggerUncacher();
+
 			return $this;
 		}
 
@@ -401,6 +415,14 @@ public function setEncoding($encoding)
 			return $this;
 		}
 
+		public function registerUncacher(UncacherBase $uncacher)
+		{
+			$uncacher->uncache();
+			if ($this->inTransaction()) {
+				$this->getUncacher()->merge($uncacher);
+			}
+		}
+
 		/**
 		 * @param string $savepointName 
 		 * @return DB
@@ -436,5 +458,21 @@ private function assertSavePointName($savepointName)
 		{
 			Assert::isEqual(1, preg_match('~^[A-Za-z][A-Za-z0-9]*$~iu', $savepointName));
 		}
+
+		/**
+		 * @return UncachersPool
+		 */
+		private function getUncacher()
+		{
+			return $this->uncacher = $this->uncacher ?: UncachersPool::create();
+		}
+
+		private function triggerUncacher()
+		{
+			if ($this->uncacher) {
+				$this->uncacher->uncache();
+				$this->uncacher = null;
+			}
+		}
 	}
-?>
+?>

doc/ChangeLog

@@ -1,3 +1,30 @@
+2012-07-03	Alexey S. Denisov
+
+	* core/Cache/Cache.class.php
+		core/DB/DB.class.php
+		global.inc.php.tpl
+		main/DAOs/BaseDAO.class.php
+		main/DAOs/GenericDAO.class.php
+		main/DAOs/Uncachers/UncacherBase.class.php
+		main/DAOs/Uncachers/UncacherBaseDaoWorker.class.php
+		main/DAOs/Uncachers/UncacherCacheDaoWorkerLists.class.php
+		main/DAOs/Uncachers/UncacherCommonDaoWorker.class.php
+		main/DAOs/Uncachers/UncacherGenericDAO.class.php
+		main/DAOs/Uncachers/UncacherNullDaoWorker.class.php
+		main/DAOs/Uncachers/UncacherSmartDaoWorkerLists.class.php
+		main/DAOs/Uncachers/UncacherTaggableDaoWorker.class.php
+		main/DAOs/Uncachers/UncacherVoodoDaoWorkerLists.class.php
+		main/DAOs/Uncachers/UncachersPool.class.php
+		main/DAOs/Workers/BaseDaoWorker.class.php
+		main/DAOs/Workers/CacheDaoWorker.class.php
+		main/DAOs/Workers/CommonDaoWorker.class.php
+		main/DAOs/Workers/DalayedDropDaoWorker.class.php
+		main/DAOs/Workers/NullDaoWorker.class.php
+		main/DAOs/Workers/SmartDaoWorker.class.php
+		main/DAOs/Workers/VoodooDaoWorker.class.php:
+
+	Introducing Uncachers
+
 2012-06-29	N. Konstantinov
 
 	* core/DB/PgSQL.class.php

global.inc.php.tpl

@@ -115,6 +115,7 @@
 		.ONPHP_MAIN_PATH.'DAOs'			.PATH_SEPARATOR
 		.ONPHP_MAIN_PATH.'DAOs'.DIRECTORY_SEPARATOR.'Handlers'.PATH_SEPARATOR
 		.ONPHP_MAIN_PATH.'DAOs'.DIRECTORY_SEPARATOR.'Workers'.PATH_SEPARATOR
+		.ONPHP_MAIN_PATH.'DAOs'.DIRECTORY_SEPARATOR.'Uncachers'.PATH_SEPARATOR
 
 		.ONPHP_MAIN_PATH.'Flow'			.PATH_SEPARATOR
 		.ONPHP_MAIN_PATH.'SPL'			.PATH_SEPARATOR

main/DAOs/BaseDAO.class.php

@@ -51,8 +51,12 @@ public function dropByIds(array $ids);
 		/// uncachers
 		//@{
 		public function uncacheById($id);
+		/**
+		 * @return UncacherBase
+		 */
+		public function getUncacherById($id);
 		public function uncacheByIds($ids);
 		public function uncacheLists();
 		//@}
 	}
-?>
+?>

main/DAOs/GenericDAO.class.php

@@ -301,17 +301,32 @@ public function dropByIds(array $ids)
 
 		public function uncacheById($id)
 		{
-			unset($this->identityMap[$id]);
-
-			return Cache::worker($this)->uncacheById($id);
+			return $this->getUncacherById($id)->uncache();
+		}
+
+		/**
+		 * @return UncachersPool
+		 */
+		public function getUncacherById($id)
+		{
+			return UncacherGenericDAO::create(
+				$this,
+				$id,
+				Cache::worker($this)->getUncacherById($id)
+			);
 		}
 
 		public function uncacheByIds($ids)
 		{
+			if (empty($ids))
+				return;
+
+			$uncacher = $this->getUncacherById(array_shift($ids));
+
 			foreach ($ids as $id)
-				unset($this->identityMap[$id]);
+				$uncacher->merge($this->getUncacherById($id));
 
-			return Cache::worker($this)->uncacheByIds($ids);
+			return $uncacher->uncache();
 		}
 
 		public function uncacheLists()
@@ -339,6 +354,11 @@ public function dropObjectIdentityMapById($id)
 			return $this;
 		}
 
+		public function registerWorkerUncacher(UncacherBase $uncacher)
+		{
+			DBPool::getByDao($this)->registerUncacher($uncacher);
+		}
+
 		protected function inject(
 			InsertOrUpdateQuery $query,
 			Identifiable $object
@@ -362,19 +382,35 @@ protected function doInject(
 			$db = DBPool::getByDao($this);
 
 			if (!$db->isQueueActive()) {
+				$preUncacher = is_scalar($object->getId())
+					? $this->getUncacherById($object->getId())
+					: null;
+
 				$count = $db->queryCount($query);
 
-				$this->uncacheById($object->getId());
+				$uncacher = $this->getUncacherById($object->getId());
+				if ($preUncacher) {
+					$uncacher->merge($uncacher);
+				}
+				$uncacher->uncache();
 
 				if ($count !== 1)
 					throw new WrongStateException(
 						$count.' rows affected: racy or insane inject happened: '
 						.$query->toDialectString($db->getDialect())
 					);
 			} else {
+				$preUncacher = is_scalar($object->getId())
+					? $this->getUncacherById($object->getId())
+					: null;
+
 				$db->queryNull($query);
 
-				$this->uncacheById($object->getId());
+				$uncacher = $this->getUncacherById($object->getId());
+				if ($preUncacher) {
+					$uncacher->merge($uncacher);
+				}
+				$uncacher->uncache();
 			}
 
 			// clean out Identifier, if any
@@ -403,4 +439,4 @@ private function addObjectListToMap($list)
 			return $list;
 		}
 	}
-?>
+?>

main/DAOs/Uncachers/UncacherBase.class.php

@@ -0,0 +1,25 @@
+<?php
+/***************************************************************************
+ *   Copyright (C) 2012 by Aleksey S. Denisov                              *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU Lesser General Public License as        *
+ *   published by the Free Software Foundation; either version 3 of the    *
+ *   License, or (at your option) any later version.                       *
+ *                                                                         *
+ ***************************************************************************/
+
+	/**
+	 * @ingroup Uncachers
+	**/
+	interface UncacherBase
+	{
+		/**
+		 * @param $uncacher BaseUncacher same as self class
+		 * @return BaseUncacher (this)
+		 */
+		public function merge(UncacherBase $uncacher);
+
+		public function uncache();
+	}
+?>

main/DAOs/Uncachers/UncacherBaseDaoWorker.class.php

@@ -0,0 +1,80 @@
+<?php
+/***************************************************************************
+ *   Copyright (C) 2012 by Aleksey S. Denisov                              *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU Lesser General Public License as        *
+ *   published by the Free Software Foundation; either version 3 of the    *
+ *   License, or (at your option) any later version.                       *
+ *                                                                         *
+ ***************************************************************************/
+
+	/**
+	 * @ingroup Uncachers
+	**/
+	class UncacherBaseDaoWorker implements UncacherBase
+	{
+		private $classNameMap = array();
+
+		/**
+		 * @return UncacherBaseDaoWorker
+		 */
+		public static function create($className, $idKey)
+		{
+			return new self($className, $idKey);
+		}
+
+		public function __construct($className, $idKey)
+		{
+			$this->classNameMap[$className] = array($idKey);
+		}
+
+		public function getClassNameMap()
+		{
+			return $this->classNameMap;
+		}
+
+		/**
+		 * @param $uncacher UncacherNullDaoWorker same as self class
+		 * @return BaseUncacher (this)
+		 */
+		public function merge(UncacherBase $uncacher)
+		{
+			Assert::isInstance($uncacher, get_class($this));
+			return $this->mergeSelf($uncacher);
+		}
+
+		public function uncache()
+		{
+			foreach ($this->classNameMap as $className => $idKeys) {
+				foreach ($idKeys as $key) {
+					$this->uncacheClassName($className, $idKeys);
+				}
+			}
+		}
+
+		protected function uncacheClassName($className, $idKeys) {
+			foreach ($idKeys as $key)
+				Cache::me()->mark($className)->delete($key);
+		}
+
+		/**
+		 * @param UncacherBaseDaoWorker $uncacher
+		 * @return UncacherBaseDaoWorker
+		 */
+		private function mergeSelf(UncacherBaseDaoWorker $uncacher)
+		{
+			foreach ($uncacher->getClassNameMap() as $className => $idKeys) {
+				if (isset($this->classNameMap[$className])) {
+					$this->classNameMap[$className] = ArrayUtils::mergeUnique(
+						$this->classNameMap[$className],
+						$idKeys
+					);
+				} else {
+					$this->classNameMap[$className] = $idKeys;
+				}
+			}
+			return $this;
+		}
+	}
+?>