From 77838209b8e0e8409bf03b07431a797d9d400499 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Tim=20D=C3=BCsterhus?= <duesterhus@woltlab.com>
Date: Thu, 16 Oct 2014 22:41:58 +0200
Subject: [PATCH] Allow completely disabling the edit history

---
 com.woltlab.wcf/option.xml                         |  6 ++++++
 com.woltlab.wcf/userGroupOption.xml                |  1 +
 .../form/UserContentRevertChangesForm.class.php    |  5 +++++
 .../history/entry/EditHistoryEntryAction.class.php |  5 +++++
 .../files/lib/page/EditHistoryPage.class.php       |  5 +++++
 .../action/UserContentClipboardAction.class.php    |  8 ++++++--
 .../system/cronjob/DailyCleanUpCronjob.class.php   | 14 +++++++++++---
 .../lib/system/edit/EditHistoryManager.class.php   |  3 +++
 wcfsetup/install/lang/de.xml                       |  2 ++
 wcfsetup/install/lang/en.xml                       |  2 ++
 10 files changed, 46 insertions(+), 5 deletions(-)

diff --git a/com.woltlab.wcf/option.xml b/com.woltlab.wcf/option.xml
index c68a390f9f..eeee94008d 100644
--- a/com.woltlab.wcf/option.xml
+++ b/com.woltlab.wcf/option.xml
@@ -917,6 +917,12 @@ memcached:cache_source_memcached_host]]></enableoptions>
 			<!-- /message.general -->
 			
 			<!-- message.general.edit -->
+			<option name="module_edit_history">
+				<categoryname>message.general.edit</categoryname>
+				<optiontype>boolean</optiontype>
+				<defaultvalue>1</defaultvalue>
+				<enableoptions>edit_history_expiration</enableoptions>
+			</option>
 			<option name="edit_history_expiration">
 				<categoryname>message.general.edit</categoryname>
 				<optiontype>integer</optiontype>
diff --git a/com.woltlab.wcf/userGroupOption.xml b/com.woltlab.wcf/userGroupOption.xml
index d62b5d392c..e8290f32fe 100644
--- a/com.woltlab.wcf/userGroupOption.xml
+++ b/com.woltlab.wcf/userGroupOption.xml
@@ -710,6 +710,7 @@ png]]></defaultvalue>
 				<defaultvalue>0</defaultvalue>
 				<admindefaultvalue>1</admindefaultvalue>
 				<usersonly>1</usersonly>
+				<options>module_edit_history</options>
 			</option>
 			
 			<option name="admin.content.label.canManageLabel">
diff --git a/wcfsetup/install/files/lib/acp/form/UserContentRevertChangesForm.class.php b/wcfsetup/install/files/lib/acp/form/UserContentRevertChangesForm.class.php
index 1415ad184b..a6ab8027da 100644
--- a/wcfsetup/install/files/lib/acp/form/UserContentRevertChangesForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/UserContentRevertChangesForm.class.php
@@ -19,6 +19,11 @@ use wcf\system\WCF;
  * @category	Community Framework
  */
 class UserContentRevertChangesForm extends AbstractForm {
+	/**
+	 * @see \wcf\page\AbstractPage::$neededModules
+	 */
+	public $neededModules = array('MODULE_EDIT_HISTORY');
+
 	/**
 	 * @see	\wcf\page\AbstractPage::$neededPermissions
 	 */
diff --git a/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php b/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php
index c6bc6ba0f2..5382c0bb3b 100644
--- a/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php
+++ b/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php
@@ -2,6 +2,7 @@
 namespace wcf\data\edit\history\entry;
 use wcf\data\object\type\ObjectTypeCache;
 use wcf\data\AbstractDatabaseObjectAction;
+use wcf\system\exception\IllegalLinkException;
 
 /**
  * Executes edit history entry-related actions.
@@ -23,6 +24,10 @@ class EditHistoryEntryAction extends AbstractDatabaseObjectAction {
 	 * Checks permissions to revert.
 	 */
 	public function validateRevert() {
+		if (!MODULE_EDIT_HISTORY) {
+			throw new IllegalLinkException();
+		}
+		
 		$historyEntry = $this->getSingleObject();
 		
 		$objectType = ObjectTypeCache::getInstance()->getObjectType($historyEntry->objectTypeID);
diff --git a/wcfsetup/install/files/lib/page/EditHistoryPage.class.php b/wcfsetup/install/files/lib/page/EditHistoryPage.class.php
index 8a8ff0370d..7f6df4bb80 100644
--- a/wcfsetup/install/files/lib/page/EditHistoryPage.class.php
+++ b/wcfsetup/install/files/lib/page/EditHistoryPage.class.php
@@ -21,6 +21,11 @@ use wcf\util\StringUtil;
  * @category	Community Framework
  */
 class EditHistoryPage extends AbstractPage {
+	/**
+	 * @see \wcf\page\AbstractPage::$neededModules
+	 */
+	public $neededModules = array('MODULE_EDIT_HISTORY');
+	
 	/**
 	 * DatabaseObjectList object
 	 * @var \wcf\data\DatabaseObjectList
diff --git a/wcfsetup/install/files/lib/system/clipboard/action/UserContentClipboardAction.class.php b/wcfsetup/install/files/lib/system/clipboard/action/UserContentClipboardAction.class.php
index e43337b4e1..a79e2e03f6 100644
--- a/wcfsetup/install/files/lib/system/clipboard/action/UserContentClipboardAction.class.php
+++ b/wcfsetup/install/files/lib/system/clipboard/action/UserContentClipboardAction.class.php
@@ -55,11 +55,15 @@ class UserContentClipboardAction extends AbstractClipboardAction {
 	}
 	
 	/**
-	 * Returns the ids of the users which can be enabled.
+	 * Returns the ids of the users whose edits can be reverted.
 	 * 
 	 * @return	array<integer>
 	 */
-	protected function validateRevertChanges() {
+	protected function validateRevertContentChanges() {
+		if (!MODULE_EDIT_HISTORY) {
+			return array();
+		}
+		
 		// check permissions
 		if (!WCF::getSession()->getPermission('admin.content.canBulkRevertContentChanges')) {
 			return array();
diff --git a/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php b/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php
index 7cf64836a7..33f86b999b 100644
--- a/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php
+++ b/wcfsetup/install/files/lib/system/cronjob/DailyCleanUpCronjob.class.php
@@ -126,13 +126,21 @@ class DailyCleanUpCronjob extends AbstractCronjob {
 		));
 		
 		// clean up expired edit history entries
-		if (EDIT_HISTORY_EXPIRATION) {
-			$sql = "DELETE FROM	wcf".WCF_N."_edit_history_entry
-				WHERE		obsoletedAt < ?";
+		if (MODULE_EDIT_HISTORY) {
+			if (EDIT_HISTORY_EXPIRATION) {
+				$sql = "DELETE FROM	wcf".WCF_N."_edit_history_entry
+					WHERE		obsoletedAt < ?";
 				$statement = WCF::getDB()->prepareStatement($sql);
 				$statement->execute(array(
 					(TIME_NOW - 86400 * EDIT_HISTORY_EXPIRATION)
 				));
+			}
+		}
+		else {
+			// edit history is disabled, prune old versions
+			$sql = "DELETE FROM	wcf".WCF_N."_edit_history_entry";
+			$statement = WCF::getDB()->prepareStatement($sql);
+			$statement->execute();
 		}
 		
 		// clean up user authentication failure log
diff --git a/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php b/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
index cbfb8a2926..d499f1cff3 100644
--- a/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
+++ b/wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
@@ -58,6 +58,9 @@ class EditHistoryManager extends SingletonFactory {
 	 * @param	integer		$obsoletedByUserID	The userID of the user that forced this entry to become outdated
 	 */
 	public function add($objectType, $objectID, $message, $time, $userID, $username, $editReason, $obsoletedByUserID) {
+		// no op, if edit history is disabled
+		if (!MODULE_EDIT_HISTORY) return;
+		
 		// save new entry
 		$sql = "INSERT INTO	wcf".WCF_N."_edit_history_entry
 					(objectTypeID, objectID, message, time, obsoletedAt, userID, username, editReason, obsoletedByUserID)
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index 37d925f5c6..4b75c172d7 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -852,6 +852,8 @@
 		<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>
+		<item name="wcf.acp.option.module_edit_history"><![CDATA[Bearbeitungsverlauf aktivieren]]></item>
+		<item name="wcf.acp.option.module_edit_history.description"><![CDATA[Speichert die alten Versionen von Benutzerinhalten.]]]></item>
 		<item name="wcf.acp.option.edit_history_expiration"><![CDATA[Speicherzeit]]></item>
 		<item name="wcf.acp.option.edit_history_expiration.description"><![CDATA[Zeitraum, nachdem alte Einträge aus dem Bearbeitungsverlauf entfernt werden [Zeitraum in Tagen, 0 um die Entfernung gänzlich zu deaktivieren]]]></item>
 		<item name="wcf.acp.option.github_public_key"><![CDATA[GitHub Client ID]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index f286b55b41..e3afdcbc32 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -851,6 +851,8 @@ Examples for medium ID detection:
 		<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>
+		<item name="wcf.acp.option.edit_history_enabled"><![CDATA[Enable Edit History]]></item>
+		<item name="wcf.acp.option.edit_history_enabled.description"><![CDATA[Stores old versions of user created items.]]]></item>
 		<item name="wcf.acp.option.edit_history_expiration"><![CDATA[Storage time]]></item>
 		<item 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, 0 to disable]]]></item>
 		<item name="wcf.acp.option.github_public_key"><![CDATA[GitHub Client ID]]></item>
-- 
2.20.1