From 988618d917f5e601f73a2d2220c4db5b97218182 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Tim=20D=C3=BCsterhus?= <duesterhus@woltlab.com>
Date: Wed, 9 Jul 2014 20:43:45 +0200
Subject: [PATCH] Add edit history entry expiration

---
 com.woltlab.wcf/option.xml                           | 12 ++++++++++++
 .../lib/system/cronjob/DailyCleanUpCronjob.class.php | 10 ++++++++++
 .../lib/system/edit/EditHistoryManager.class.php     |  6 +++---
 wcfsetup/install/lang/de.xml                         |  3 +++
 wcfsetup/install/lang/en.xml                         |  3 +++
 wcfsetup/setup/db/install.sql                        |  3 ++-
 6 files changed, 33 insertions(+), 4 deletions(-)

diff --git a/com.woltlab.wcf/option.xml b/com.woltlab.wcf/option.xml
index fbedf945fa..6cf09935d5 100644
--- a/com.woltlab.wcf/option.xml
+++ b/com.woltlab.wcf/option.xml
@@ -184,6 +184,9 @@
 						<parent>message.general</parent>
 						<options>module_poll</options>
 					</category>
+					<category name="message.general.edit">
+						<parent>message.general</parent>
+					</category>
 				
 				<category name="message.attachment">
 					<parent>message</parent>
@@ -851,6 +854,15 @@ no:!cache_source_memcached_host]]></enableoptions>
 			</option>
 			<!-- /message.general -->
 			
+			<!-- message.general.edit -->
+			<option name="edit_history_expiration">
+				<categoryname>message.general.edit</categoryname>
+				<optiontype>integer</optiontype>
+				<defaultvalue>90</defaultvalue>
+				<minvalue>0</minvalue>
+			</option>
+			<!-- /message.general.edit -->
+			
 			<!-- message.general.share -->
 			<option name="enable_share_buttons">
 				<categoryname>message.general.share</categoryname>
diff --git a/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php b/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php
index fcecee03d8..2c6dbfc57b 100644
--- a/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php
+++ b/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php
@@ -125,6 +125,16 @@ class DailyCleanUpCronjob extends AbstractCronjob {
 			(TIME_NOW - 86400)
 		));
 		
+		// clean up expired edit history entries
+		if (EDIT_HISTORY_EXPIRATION) {
+			$sql = "DELETE FROM	wcf".WCF_N."_edit_history_entry
+				WHERE		insertionTime < ?";
+				$statement = WCF::getDB()->prepareStatement($sql);
+				$statement->execute(array(
+					(TIME_NOW - 86400 * EDIT_HISTORY_EXPIRATION)
+				));
+		}
+		
 		// clean up user authentication failure log
 		if (ENABLE_USER_AUTHENTICATION_FAILURE) {
 			$sql = "DELETE FROM	wcf".WCF_N."_user_authentication_failure
diff --git a/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php b/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
index a52f118a31..2748a837ff 100644
--- a/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
+++ b/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
@@ -58,10 +58,10 @@ class EditHistoryManager extends SingletonFactory {
 	public function add($objectType, $objectID, $message, $time, $userID, $username, $editReason) {
 		// save new entry
 		$sql = "INSERT INTO	wcf".WCF_N."_edit_history_entry
-					(objectTypeID, objectID, message, time, userID, username, editReason)
-			VALUES		(?, ?, ?, ?, ?, ?, ?)";
+					(objectTypeID, objectID, message, time, insertionTime, userID, username, editReason)
+			VALUES		(?, ?, ?, ?, ?, ?, ?, ?)";
 		$statement = WCF::getDB()->prepareStatement($sql);
-		$statement->execute(array($this->getObjectTypeID($objectType), $objectID, $message, $time, $userID, $username, $editReason));
+		$statement->execute(array($this->getObjectTypeID($objectType), $objectID, $message, $time, TIME_NOW, $userID, $username, $editReason));
 	}
 	
 	/**
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index e584042b22..c5cf9d5a16 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -843,6 +843,9 @@
 		<item name="wcf.acp.option.show_signature_default_value"><![CDATA[Signatur anzeigen [Vorgabewert]]]></item>
 		<item name="wcf.acp.option.enable_share_buttons"><![CDATA[Buttons zum Teilen von Inhalten anzeigen]]></item>
 		<item name="wcf.acp.option.share_buttons_show_count"><![CDATA[Anzahl der Teilungen anzeigen]]></item>
+		<item name="wcf.acp.option.category.message.general.edit"><![CDATA[Bearbeitungen]]></item>
+		<iten name="wcf.acp.option.edit_history_expiration"><![CDATA[Speicherzeit]]></item>
+		<iten name="wcf.acp.option.edit_history_expiration.description"><![CDATA[Zeitraum, nachdem alte Einträge aus dem Bearbeitungsverlauf entfernt werden [Zeitraum in Tagen]]]></item>
 		<item name="wcf.acp.option.github_public_key"><![CDATA[GitHub Client ID]]></item>
 		<item name="wcf.acp.option.github_public_key.description"><![CDATA[Sie können Ihre Client ID und Ihr Client Secret bei <a href="{@$__wcf->getPath()}acp/dereferrer.php?url={'https://github.com/settings/applications'|rawurlencode}" class="externalURL">GitHub</a> anfordern. Die Callback URL ist: {link controller="GithubAuth" forceFrontend=true appendSession=false}{/link}]]></item>
 		<item name="wcf.acp.option.github_private_key"><![CDATA[GitHub Client Secret]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index 7ee1079ecc..0c5c8c073c 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -842,6 +842,9 @@ Examples for medium ID detection:
 		<item name="wcf.acp.option.show_signature_default_value"><![CDATA[Show signatures [default value]]]></item>
 		<item name="wcf.acp.option.enable_share_buttons"><![CDATA[Show content share button]]></item>
 		<item name="wcf.acp.option.share_buttons_show_count"><![CDATA[Show number of shares]]></item>
+		<item name="wcf.acp.option.category.message.general.edit"><![CDATA[Edits]]></item>
+		<iten name="wcf.acp.option.edit_history_expiration"><![CDATA[Storage time]]></item>
+		<iten name="wcf.acp.option.edit_history_expiration.description"><![CDATA[Items in the edit history will be discarded if they are older than the given period. [time in days]]]></item>
 		<item name="wcf.acp.option.github_public_key"><![CDATA[GitHub Client ID]]></item>
 		<item name="wcf.acp.option.github_public_key.description"><![CDATA[You can obtain both your Client ID and Client Secret at <a href="{@$__wcf->getPath()}acp/dereferrer.php?url={'https://github.com/settings/applications'|rawurlencode}" class="externalURL">GitHub</a>. The Callback URL is: {link controller="GithubAuth" forceFrontend=true appendSession=false}{/link}]]></item>
 		<item name="wcf.acp.option.github_private_key"><![CDATA[GitHub Client Secret]]></item>
diff --git a/wcfsetup/setup/db/install.sql b/wcfsetup/setup/db/install.sql
index 59b4f6d5d6..ac4dae266c 100644
--- a/wcfsetup/setup/db/install.sql
+++ b/wcfsetup/setup/db/install.sql
@@ -357,7 +357,8 @@ CREATE TABLE wcf1_edit_history_entry (
 	objectID INT(10) NOT NULL,
 	userID INT(10),
 	username VARCHAR(255) NOT NULL DEFAULT '',
-	time INT(10) NOT NULL DEFAULT 0,
+	time INT(10) NOT NULL DEFAULT 0, -- time the version was created, displayed to the user
+	insertionTime INT(10) NOT NULL DEFAULT 0, -- time the version was inserted into the edit history, used for clean up
 	message MEDIUMTEXT,
 	editReason TEXT,
 	
-- 
2.20.1