From 6679afbb6bf86f775235614e530bc3034081374d Mon Sep 17 00:00:00 2001
From: Marcin Kurczewski <mkurczew@gmail.com>
Date: Sun, 9 Nov 2014 17:04:04 +0100
Subject: [PATCH] Added "created" snapshot operation

---
 public_html/templates/history.tpl           |  8 ++-
 src/Entities/Snapshot.php                   |  5 +-
 src/Services/ISnapshotProvider.php          | 10 ++++
 src/Services/PostHistoryService.php         |  9 +++-
 src/Services/PostService.php                |  2 +-
 src/Services/PostSnapshotProvider.php       | 58 ++++++++++++--------
 src/Services/TagHistoryService.php          |  9 +++-
 src/Services/TagService.php                 |  2 +-
 src/Services/TagSnapshotProvider.php        | 59 +++++++++++++--------
 src/Upgrades/Upgrade33.php                  | 19 +++++++
 src/di.php                                  |  1 +
 tests/Services/PostServiceTest.php          | 10 ++--
 tests/Services/PostSnapshotProviderTest.php |  4 +-
 13 files changed, 134 insertions(+), 62 deletions(-)
 create mode 100644 src/Services/ISnapshotProvider.php
 create mode 100644 src/Upgrades/Upgrade33.php

diff --git a/public_html/templates/history.tpl b/public_html/templates/history.tpl
index ad4c51c9..f946657f 100644
--- a/public_html/templates/history.tpl
+++ b/public_html/templates/history.tpl
@@ -48,10 +48,14 @@ var reprValue = function(value) {
 				</td>
 
 				<td class="difference">
-					<% if (historyEntry.operation == 1) { %>
+					<% if (historyEntry.operation == 2) { %>
 						deleted
 					<% } else { %>
-						changed
+						<% if (historyEntry.operation == 0) { %>
+							added
+						<% } else { %>
+							changed
+						<% } %>
 
 						<% if (historyEntry.dataDifference) { %>
 							<ul><!--
diff --git a/src/Entities/Snapshot.php b/src/Entities/Snapshot.php
index 8f0f961e..548ae857 100644
--- a/src/Entities/Snapshot.php
+++ b/src/Entities/Snapshot.php
@@ -7,8 +7,9 @@ final class Snapshot extends Entity
 	const TYPE_POST = 0;
 	const TYPE_TAG = 1;
 
-	const OPERATION_CHANGE = 0;
-	const OPERATION_DELETE = 1;
+	const OPERATION_CREATION = 0;
+	const OPERATION_CHANGE = 1;
+	const OPERATION_DELETE = 2;
 
 	const LAZY_LOADER_USER = 'user';
 
diff --git a/src/Services/ISnapshotProvider.php b/src/Services/ISnapshotProvider.php
new file mode 100644
index 00000000..78db0f04
--- /dev/null
+++ b/src/Services/ISnapshotProvider.php
@@ -0,0 +1,10 @@
+<?php
+namespace Szurubooru\Services;
+use Szurubooru\Entities\Entity;
+
+interface ISnapshotProvider
+{
+	public function getCreationSnapshot(Entity $entity);
+	public function getChangeSnapshot(Entity $entity);
+	public function getDeleteSnapshot(Entity $entity);
+}
diff --git a/src/Services/PostHistoryService.php b/src/Services/PostHistoryService.php
index c6a62e0b..dbad36e6 100644
--- a/src/Services/PostHistoryService.php
+++ b/src/Services/PostHistoryService.php
@@ -46,13 +46,18 @@ class PostHistoryService
 		return $this->transactionManager->rollback($transactionFunc);
 	}
 
+	public function savePostCreation(Post $post)
+	{
+		$this->historyService->saveSnapshot($this->postSnapshotProvider->getCreationSnapshot($post));
+	}
+
 	public function savePostChange(Post $post)
 	{
-		$this->historyService->saveSnapshot($this->postSnapshotProvider->getPostChangeSnapshot($post));
+		$this->historyService->saveSnapshot($this->postSnapshotProvider->getChangeSnapshot($post));
 	}
 
 	public function savePostDeletion(Post $post)
 	{
-		$this->historyService->saveSnapshot($this->postSnapshotProvider->getPostDeleteSnapshot($post));
+		$this->historyService->saveSnapshot($this->postSnapshotProvider->getDeleteSnapshot($post));
 	}
 }
diff --git a/src/Services/PostService.php b/src/Services/PostService.php
index b2709c07..93f67659 100644
--- a/src/Services/PostService.php
+++ b/src/Services/PostService.php
@@ -123,7 +123,7 @@ class PostService
 
 			$savedPost = $this->postDao->save($post);
 
-			$this->postHistoryService->savePostChange($savedPost);
+			$this->postHistoryService->savePostCreation($savedPost);
 			return $savedPost;
 		};
 		$ret = $this->transactionManager->commit($transactionFunc);
diff --git a/src/Services/PostSnapshotProvider.php b/src/Services/PostSnapshotProvider.php
index 272907e0..8fec8680 100644
--- a/src/Services/PostSnapshotProvider.php
+++ b/src/Services/PostSnapshotProvider.php
@@ -2,6 +2,7 @@
 namespace Szurubooru\Services;
 use Szurubooru\Dao\GlobalParamDao;
 use Szurubooru\Dao\PostNoteDao;
+use Szurubooru\Entities\Entity;
 use Szurubooru\Entities\GlobalParam;
 use Szurubooru\Entities\Post;
 use Szurubooru\Entities\PostNote;
@@ -9,7 +10,7 @@ use Szurubooru\Entities\Snapshot;
 use Szurubooru\Entities\Tag;
 use Szurubooru\Helpers\EnumHelper;
 
-class PostSnapshotProvider
+class PostSnapshotProvider implements ISnapshotProvider
 {
 	private $globalParamDao;
 	private $postNoteDao;
@@ -22,7 +23,39 @@ class PostSnapshotProvider
 		$this->postNoteDao = $postNoteDao;
 	}
 
-	public function getPostChangeSnapshot(Post $post)
+	public function getCreationSnapshot(Entity $post)
+	{
+		$snapshot = $this->getPostSnapshot($post);
+		$snapshot->setOperation(Snapshot::OPERATION_CREATION);
+		$snapshot->setData($this->getFullData($post));
+		return $snapshot;
+	}
+
+	public function getChangeSnapshot(Entity $post)
+	{
+		$snapshot = $this->getPostSnapshot($post);
+		$snapshot->setOperation(Snapshot::OPERATION_CHANGE);
+		$snapshot->setData($this->getFullData($post));
+		return $snapshot;
+	}
+
+	public function getDeleteSnapshot(Entity $post)
+	{
+		$snapshot = $this->getPostSnapshot($post);
+		$snapshot->setData([]);
+		$snapshot->setOperation(Snapshot::OPERATION_DELETE);
+		return $snapshot;
+	}
+
+	private function getPostSnapshot(Post $post)
+	{
+		$snapshot = new Snapshot();
+		$snapshot->setType(Snapshot::TYPE_POST);
+		$snapshot->setPrimaryKey($post->getId());
+		return $snapshot;
+	}
+
+	private function getFullData(Post $post)
 	{
 		static $featuredPostParam = null;
 		if ($featuredPostParam === null)
@@ -75,25 +108,6 @@ class PostSnapshotProvider
 		sort($data['relations']);
 		usort($data['notes'], function ($note1, $note2) { return $note1['x'] - $note2['x']; });
 
-		$snapshot = $this->getPostSnapshot($post);
-		$snapshot->setOperation(Snapshot::OPERATION_CHANGE);
-		$snapshot->setData($data);
-		return $snapshot;
-	}
-
-	public function getPostDeleteSnapshot(Post $post)
-	{
-		$snapshot = $this->getPostSnapshot($post);
-		$snapshot->setData([]);
-		$snapshot->setOperation(Snapshot::OPERATION_DELETE);
-		return $snapshot;
-	}
-
-	private function getPostSnapshot(Post $post)
-	{
-		$snapshot = new Snapshot();
-		$snapshot->setType(Snapshot::TYPE_POST);
-		$snapshot->setPrimaryKey($post->getId());
-		return $snapshot;
+		return $data;
 	}
 }
diff --git a/src/Services/TagHistoryService.php b/src/Services/TagHistoryService.php
index 11db6881..d06d1b45 100644
--- a/src/Services/TagHistoryService.php
+++ b/src/Services/TagHistoryService.php
@@ -46,14 +46,19 @@ class TagHistoryService
 		return $this->transactionManager->rollback($transactionFunc);
 	}
 
+	public function saveTagCreation(Tag $tag)
+	{
+		$this->historyService->saveSnapshot($this->tagSnapshotProvider->getCreationSnapshot($tag));
+	}
+
 	public function saveTagChange(Tag $tag)
 	{
-		$this->historyService->saveSnapshot($this->tagSnapshotProvider->getTagChangeSnapshot($tag));
+		$this->historyService->saveSnapshot($this->tagSnapshotProvider->getChangeSnapshot($tag));
 	}
 
 	public function saveTagDeletion(Tag $tag)
 	{
-		$this->historyService->saveSnapshot($this->tagSnapshotProvider->getTagDeleteSnapshot($tag));
+		$this->historyService->saveSnapshot($this->tagSnapshotProvider->getDeleteSnapshot($tag));
 	}
 }
 
diff --git a/src/Services/TagService.php b/src/Services/TagService.php
index e2f44890..d76a6557 100644
--- a/src/Services/TagService.php
+++ b/src/Services/TagService.php
@@ -113,7 +113,7 @@ class TagService
 			foreach ($this->tagDao->batchSave($tagsToCreate) as $tag)
 			{
 				$createdTags[$tagNameGetter($tag)] = $tag;
-				$this->tagHistoryService->saveTagChange($tag);
+				$this->tagHistoryService->saveTagCreation($tag);
 			}
 
 			$result = [];
diff --git a/src/Services/TagSnapshotProvider.php b/src/Services/TagSnapshotProvider.php
index d1eddf5b..f33cca92 100644
--- a/src/Services/TagSnapshotProvider.php
+++ b/src/Services/TagSnapshotProvider.php
@@ -1,11 +1,44 @@
 <?php
 namespace Szurubooru\Services;
+use Szurubooru\Entities\Entity;
 use Szurubooru\Entities\Snapshot;
 use Szurubooru\Entities\Tag;
 
-class TagSnapshotProvider
+class TagSnapshotProvider implements ISnapshotProvider
 {
-	public function getTagChangeSnapshot(Tag $tag)
+	public function getCreationSnapshot(Entity $tag)
+	{
+		$snapshot = $this->getTagSnapshot($tag);
+		$snapshot->setOperation(Snapshot::OPERATION_CREATION);
+		$snapshot->setData($this->getFullData($tag));
+		return $snapshot;
+	}
+
+	public function getChangeSnapshot(Entity $tag)
+	{
+		$snapshot = $this->getTagSnapshot($tag);
+		$snapshot->setOperation(Snapshot::OPERATION_CHANGE);
+		$snapshot->setData($this->getFullData($tag));
+		return $snapshot;
+	}
+
+	public function getDeleteSnapshot(Entity $tag)
+	{
+		$snapshot = $this->getTagSnapshot($tag);
+		$snapshot->setData(['name' => $tag->getName()]);
+		$snapshot->setOperation(Snapshot::OPERATION_DELETE);
+		return $snapshot;
+	}
+
+	private function getTagSnapshot(Tag $tag)
+	{
+		$snapshot = new Snapshot();
+		$snapshot->setType(Snapshot::TYPE_TAG);
+		$snapshot->setPrimaryKey($tag->getId());
+		return $snapshot;
+	}
+
+	private function getFullData(Tag $tag)
 	{
 		$data =
 		[
@@ -26,26 +59,6 @@ class TagSnapshotProvider
 
 		sort($data['implications']);
 		sort($data['suggestions']);
-
-		$snapshot = $this->getTagSnapshot($tag);
-		$snapshot->setOperation(Snapshot::OPERATION_CHANGE);
-		$snapshot->setData($data);
-		return $snapshot;
-	}
-
-	public function getTagDeleteSnapshot(Tag $tag)
-	{
-		$snapshot = $this->getTagSnapshot($tag);
-		$snapshot->setData(['name' => $tag->getName()]);
-		$snapshot->setOperation(Snapshot::OPERATION_DELETE);
-		return $snapshot;
-	}
-
-	private function getTagSnapshot(Tag $tag)
-	{
-		$snapshot = new Snapshot();
-		$snapshot->setType(Snapshot::TYPE_TAG);
-		$snapshot->setPrimaryKey($tag->getId());
-		return $snapshot;
+		return $data;
 	}
 }
diff --git a/src/Upgrades/Upgrade33.php b/src/Upgrades/Upgrade33.php
new file mode 100644
index 00000000..27755749
--- /dev/null
+++ b/src/Upgrades/Upgrade33.php
@@ -0,0 +1,19 @@
+<?php
+namespace Szurubooru\Upgrades;
+use Szurubooru\DatabaseConnection;
+
+class Upgrade33 implements IUpgrade
+{
+	public function run(DatabaseConnection $databaseConnection)
+	{
+		$pdo = $databaseConnection->getPDO();
+
+		$pdo->exec('UPDATE snapshots SET operation = 2 WHERE operation = 1');
+		$pdo->exec('UPDATE snapshots SET operation = 1 WHERE operation = 0');
+		$pdo->exec('CREATE INDEX tempIndex ON snapshots(primaryKey)');
+		$pdo->exec('CREATE TABLE tempTable AS SELECT MIN(id) AS id FROM snapshots GROUP BY type, primaryKey');
+		$pdo->exec('DROP INDEX tempIndex ON snapshots');
+		$pdo->exec('UPDATE snapshots SET operation = 0 WHERE id IN (SELECT id FROM tempTable)');
+		$pdo->exec('DROP TABLE tempTable');
+	}
+}
diff --git a/src/di.php b/src/di.php
index 4180a7fe..1a37fdc9 100644
--- a/src/di.php
+++ b/src/di.php
@@ -49,6 +49,7 @@ return [
 			$container->get(\Szurubooru\Upgrades\Upgrade30::class),
 			$container->get(\Szurubooru\Upgrades\Upgrade31::class),
 			$container->get(\Szurubooru\Upgrades\Upgrade32::class),
+			$container->get(\Szurubooru\Upgrades\Upgrade33::class),
 		];
 	}),
 
diff --git a/tests/Services/PostServiceTest.php b/tests/Services/PostServiceTest.php
index 7ee22841..0952bdd1 100644
--- a/tests/Services/PostServiceTest.php
+++ b/tests/Services/PostServiceTest.php
@@ -61,7 +61,7 @@ final class PostServiceTest extends AbstractDatabaseTestCase
 
 		$this->postDaoMock->expects($this->once())->method('save')->will($this->returnArgument(0));
 		$this->authServiceMock->expects($this->once())->method('getLoggedInUser')->willReturn(new User(5));
-		$this->postHistoryServiceMock->expects($this->once())->method('savePostChange')->willReturn(new Snapshot());
+		$this->postHistoryServiceMock->expects($this->once())->method('savePostCreation')->willReturn(new Snapshot());
 		$this->imageConverterMock->expects($this->never())->method('createImageFromBuffer');
 
 		$this->postService = $this->getPostService();
@@ -91,7 +91,7 @@ final class PostServiceTest extends AbstractDatabaseTestCase
 		$this->postDaoMock->expects($this->once())->method('save')->will($this->returnArgument(0));
 		$this->imageManipulatorMock->expects($this->once())->method('getImageWidth')->willReturn(640);
 		$this->imageManipulatorMock->expects($this->once())->method('getImageHeight')->willReturn(480);
-		$this->postHistoryServiceMock->expects($this->once())->method('savePostChange')->willReturn(new Snapshot());
+		$this->postHistoryServiceMock->expects($this->once())->method('savePostCreation')->willReturn(new Snapshot());
 
 		$this->postService = $this->getPostService();
 		$savedPost = $this->postService->createPost($formData);
@@ -112,7 +112,7 @@ final class PostServiceTest extends AbstractDatabaseTestCase
 		$formData->contentFileName = 'blah';
 
 		$this->postDaoMock->expects($this->once())->method('save')->will($this->returnArgument(0));
-		$this->postHistoryServiceMock->expects($this->once())->method('savePostChange')->willReturn(new Snapshot());
+		$this->postHistoryServiceMock->expects($this->once())->method('savePostCreation')->willReturn(new Snapshot());
 		$this->imageConverterMock->expects($this->once())->method('createImageFromBuffer');
 
 		$this->postService = $this->getPostService();
@@ -132,7 +132,7 @@ final class PostServiceTest extends AbstractDatabaseTestCase
 		$formData->contentFileName = 'blah';
 
 		$this->postDaoMock->expects($this->once())->method('save')->will($this->returnArgument(0));
-		$this->postHistoryServiceMock->expects($this->once())->method('savePostChange')->willReturn(new Snapshot());
+		$this->postHistoryServiceMock->expects($this->once())->method('savePostCreation')->willReturn(new Snapshot());
 		$this->imageConverterMock->expects($this->once())->method('createImageFromBuffer');
 
 		$this->postService = $this->getPostService();
@@ -196,7 +196,7 @@ final class PostServiceTest extends AbstractDatabaseTestCase
 
 		$this->postDaoMock->expects($this->once())->method('save')->will($this->returnArgument(0));
 		$this->authServiceMock->expects($this->never())->method('getLoggedInUser');
-		$this->postHistoryServiceMock->expects($this->once())->method('savePostChange')->willReturn(new Snapshot());
+		$this->postHistoryServiceMock->expects($this->once())->method('savePostCreation')->willReturn(new Snapshot());
 
 		$this->postService = $this->getPostService();
 		$savedPost = $this->postService->createPost($formData);
diff --git a/tests/Services/PostSnapshotProviderTest.php b/tests/Services/PostSnapshotProviderTest.php
index b0cdb98a..6c4d7d3a 100644
--- a/tests/Services/PostSnapshotProviderTest.php
+++ b/tests/Services/PostSnapshotProviderTest.php
@@ -44,7 +44,7 @@ class PostSnapshotProviderTest extends AbstractTestCase
 			->willReturn([$this->getTestPostNote()]);
 
 		$postSnapshotProvider = $this->getPostSnapshotProvider();
-		$snapshot = $postSnapshotProvider->getPostChangeSnapshot($post);
+		$snapshot = $postSnapshotProvider->getChangeSnapshot($post);
 
 		$this->assertEquals([
 			'source' => 'amazing source',
@@ -82,7 +82,7 @@ class PostSnapshotProviderTest extends AbstractTestCase
 			->willReturn([]);
 
 		$postSnapshotProvider = $this->getPostSnapshotProvider();
-		$snapshot = $postSnapshotProvider->getPostChangeSnapshot($post);
+		$snapshot = $postSnapshotProvider->getChangeSnapshot($post);
 
 		$this->assertTrue($snapshot->getData()['featured']);
 	}