From cd36d274b91a86403fce90f50b5c07ce4595c600 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Tim=20D=C3=BCsterhus?= <timwolla@arcor.de>
Date: Sun, 25 Sep 2011 18:22:22 +0200
Subject: [PATCH] Adding "NoCacheSource"

Disables the cache entirely, useful for debugging purposes.
---
 com.woltlab.wcf/option.xml                    |  6 +-
 .../install/files/acp/templates/cacheList.tpl | 12 ++--
 .../lib/acp/page/CacheListPage.class.php      |  5 ++
 .../cache/source/NoCacheSource.class.php      | 64 +++++++++++++++++++
 wcfsetup/install/lang/de-informal.xml         |  1 +
 wcfsetup/install/lang/de.xml                  |  1 +
 wcfsetup/install/lang/en.xml                  |  1 +
 7 files changed, 82 insertions(+), 8 deletions(-)
 create mode 100644 wcfsetup/install/files/lib/system/cache/source/NoCacheSource.class.php

diff --git a/com.woltlab.wcf/option.xml b/com.woltlab.wcf/option.xml
index 31812b19ed..d68febfd1d 100644
--- a/com.woltlab.wcf/option.xml
+++ b/com.woltlab.wcf/option.xml
@@ -312,10 +312,12 @@ debug:mail_debug_logfile_path,!mail_use_f_param,!mail_smtp_host,!mail_smtp_port,
 				<defaultvalue><![CDATA[disk]]></defaultvalue>
 				<selectoptions><![CDATA[disk:wcf.acp.option.cache_source_type.disk
 memcache:wcf.acp.option.cache_source_type.memcache
-apc:wcf.acp.option.cache_source_type.apc]]></selectoptions>
+apc:wcf.acp.option.cache_source_type.apc
+no:wcf.acp.option.cache_source_type.no]]></selectoptions>
 				<enableoptions><![CDATA[disk:!cache_source_memcache_host,!cache_source_memcache_use_pconnect,!enable_session_data_cache
 memcache:cache_source_memcache_host,cache_source_memcache_use_pconnect,enable_session_data_cache
-apc:!cache_source_memcache_host,!cache_source_memcache_use_pconnect,!enable_session_data_cache]]></enableoptions>
+apc:!cache_source_memcache_host,!cache_source_memcache_use_pconnect,!enable_session_data_cache
+no:!cache_source_memcache_host,!cache_source_memcache_use_pconnect,!enable_session_data_cache]]></enableoptions>
 			</option>
 			
 			<option name="enable_session_data_cache">
diff --git a/wcfsetup/install/files/acp/templates/cacheList.tpl b/wcfsetup/install/files/acp/templates/cacheList.tpl
index 9db4419f4f..4f6ba66033 100644
--- a/wcfsetup/install/files/acp/templates/cacheList.tpl
+++ b/wcfsetup/install/files/acp/templates/cacheList.tpl
@@ -36,14 +36,14 @@
 			<dd>{$cacheData.version}</dd>
 		</dl>
 	{/if}
-	<dl>
+	{if $cacheData.size}<dl>
 		<dt>{lang}wcf.acp.cache.data.size{/lang}</dt>
 		<dd>{@$cacheData.size|filesize}</dd>
-	</dl>
-	<dl>
+	</dl>{/if}
+	{if $cacheData.files}<dl>
 		<dt>{lang}wcf.acp.cache.data.files{/lang}</dt>
 		<dd>{#$cacheData.files}</dd>
-	</dl>
+	</dl>{/if}
 	
 	{if $additionalFields|isset}{@$additionalFields}{/if}
 </fieldset>
@@ -51,7 +51,7 @@
 <div class="contentHeader">
 	<nav class="largeButtons">
 		<ul>
-			<li><a onclick="return confirm('{lang}wcf.acp.cache.clear.sure{/lang}')" href="index.php?action=CacheClear{@SID_ARG_2ND}"><img src="{@RELATIVE_WCF_DIR}icon/delete1.svg" alt="" /> <span>{lang}wcf.acp.cache.button.clear{/lang}</span></a></li>
+			{if $cacheData.files}<li><a onclick="return confirm('{lang}wcf.acp.cache.clear.sure{/lang}')" href="index.php?action=CacheClear{@SID_ARG_2ND}"><img src="{@RELATIVE_WCF_DIR}icon/delete1.svg" alt="" /> <span>{lang}wcf.acp.cache.button.clear{/lang}</span></a></li>{/if}
 			{if $additionalLargeButtons|isset}{@$additionalLargeButtons}{/if}
 		</ul>
 	</nav>
@@ -99,7 +99,7 @@
 <div class="contentFooter">
 	<nav class="largeButtons">
 		<ul>
-			<li><a onclick="return confirm('{lang}wcf.acp.cache.clear.sure{/lang}')" href="index.php?action=CacheClear{@SID_ARG_2ND}"><img src="{@RELATIVE_WCF_DIR}icon/delete1.svg" alt="" /> <span>{lang}wcf.acp.cache.button.clear{/lang}</span></a></li>
+			{if $cacheData.files}<li><a onclick="return confirm('{lang}wcf.acp.cache.clear.sure{/lang}')" href="index.php?action=CacheClear{@SID_ARG_2ND}"><img src="{@RELATIVE_WCF_DIR}icon/delete1.svg" alt="" /> <span>{lang}wcf.acp.cache.button.clear{/lang}</span></a></li>{/if}
 			{if $additionalLargeButtons|isset}{@$additionalLargeButtons}{/if}
 		</ul>
 	</nav>
diff --git a/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php b/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
index 42ff8e5bcd..8b2f735654 100755
--- a/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
@@ -167,6 +167,11 @@ class CacheListPage extends AbstractPage {
 				}
 			}
 		}
+		// disabled
+		else if ($this->cacheData['source'] == 'wcf\system\cache\source\NoCacheSource') {
+			$this->cacheData['version'] = WCF_VERSION;
+			$this->cacheData['files'] = $this->cacheData['size'] = 0;
+		}
 	}
 	
 	/**
diff --git a/wcfsetup/install/files/lib/system/cache/source/NoCacheSource.class.php b/wcfsetup/install/files/lib/system/cache/source/NoCacheSource.class.php
new file mode 100644
index 0000000000..a34f26987e
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/cache/source/NoCacheSource.class.php
@@ -0,0 +1,64 @@
+<?php
+namespace wcf\system\cache\source;
+
+/**
+ * DevNullCacheSource is an implementation of CacheSource that stores the cache in /dev/null.
+ * 
+ * @author	Tim Düsterhus
+ * @copyright	2011 Tim Düsterhus
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	com.woltlab.wcf
+ * @subpackage	system.cache.source
+ * @category	Community Framework
+ */
+class NoCacheSource implements ICacheSource {
+	/**
+	 * @see wcf\system\cache\source\ICacheSource::get()
+	 */
+	public function get(array $cacheResource) {
+		if (!isset($this->cache[$cacheResource['cache']])) return null;
+
+		return $this->cache[$cacheResource['cache']];
+	}
+	
+	/**
+	 * @see wcf\system\cache\source\ICacheSource::set()
+	 */
+	public function set(array $cacheResource, $value) {
+		// we have to keep it temporarily
+		$this->cache[$cacheResource['cache']] = $value;
+		$this->loaded[$cacheResource['file']] = true;
+	}
+	
+	/**
+	 * @see wcf\system\cache\source\ICacheSource::delete()
+	 */
+	public function delete(array $cacheResource) {	
+		// reset open cache
+		if (isset($this->cache[$cacheResource['cache']])) unset($this->cache[$cacheResource['cache']]);
+		if (isset($this->loaded[$cacheResource['file']])) unset($this->loaded[$cacheResource['file']]);
+
+		return;
+	}
+	
+	/**
+	 * @see wcf\system\cache\source\ICacheSource::clear()
+	 */
+	public function clear($directory, $filepattern) {
+		return;
+	}
+	
+	/**
+	 * @see wcf\system\cache\source\ICacheSource::close()
+	 */
+	public function close() {
+		return;
+	}
+	
+	/**
+	 * @see wcf\system\cache\source\ICacheSource::flush()
+	 */
+	public function flush() {
+		return;
+	}
+}
diff --git a/wcfsetup/install/lang/de-informal.xml b/wcfsetup/install/lang/de-informal.xml
index f734405fd8..afd8d1a399 100644
--- a/wcfsetup/install/lang/de-informal.xml
+++ b/wcfsetup/install/lang/de-informal.xml
@@ -265,6 +265,7 @@
 		<item name="wcf.acp.option.cache_source_type.description"><![CDATA[Bitte wähle die gewünschte Cache-Methode aus! Beachte, dass einige Methoden spezielle Anforderungen an das Server-System stellen und nicht auf jedem Server zur Verfügung stehen.]]></item>
 		<item name="wcf.acp.option.cache_source_type.disk"><![CDATA[Dateisystem (Standard)]]></item>
 		<item name="wcf.acp.option.cache_source_type.memcache"><![CDATA[Memcache (Experimentell)]]></item>
+		<item name="wcf.acp.option.cache_source_type.no"><![CDATA[Caching deaktivieren (Nicht empfohlen)]]></item>
 		<item name="wcf.acp.option.category.general"><![CDATA[Allgemein]]></item>
 		<item name="wcf.acp.option.category.general.cache"><![CDATA[Cache]]></item>
 		<item name="wcf.acp.option.category.general.cache.description"><![CDATA[]]></item>
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index a5022e7721..6b7bcc5be2 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -291,6 +291,7 @@
 		<item name="wcf.acp.option.cache_source_type.description"><![CDATA[Bitte wählen Sie die gewünschte Cache-Methode aus! Beachten Sie, dass einige Methoden spezielle Anforderungen an das Server-System stellen und nicht auf jedem Server zur Verfügung stehen.]]></item>
 		<item name="wcf.acp.option.cache_source_type.disk"><![CDATA[Dateisystem (Standard)]]></item>
 		<item name="wcf.acp.option.cache_source_type.memcache"><![CDATA[Memcache]]></item>
+		<item name="wcf.acp.option.cache_source_type.no"><![CDATA[Caching deaktivieren (Nicht empfohlen)]]></item>
 		<item name="wcf.acp.option.blacklist_hostnames"><![CDATA[Hostname ausschließen]]></item>
 		<item name="wcf.acp.option.blacklist_hostnames.description"><![CDATA[Geben Sie pro Zeile einen Hostname an, die Sie von der Seite ausschließen möchten.]]></item>
 		<item name="wcf.acp.option.blacklist_ip_addresses"><![CDATA[IP-Adresse ausschließen]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index dc5939752b..e473bf343d 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -265,6 +265,7 @@
 		<item name="wcf.acp.option.cache_source_type.description"><![CDATA[Please select the type of cache you want to use. Some of the types have special requirements to the server system and cannot be used in your environment.]]></item>
 		<item name="wcf.acp.option.cache_source_type.disk"><![CDATA[File system (default)]]></item>
 		<item name="wcf.acp.option.cache_source_type.memcache"><![CDATA[Memcache (experimental)]]></item>
+		<item name="wcf.acp.option.cache_source_type.no"><![CDATA[Disable caching (not recommended)]]></item>
 		<item name="wcf.acp.option.category.general"><![CDATA[General]]></item>
 		<item name="wcf.acp.option.category.general.cache"><![CDATA[Cache]]></item>
 		<item name="wcf.acp.option.category.general.cache.description"><![CDATA[]]></item>
-- 
2.20.1