Split CacheTime into its own file
authorjeroendedauw <jeroendedauw@gmail.com>
Mon, 6 Aug 2012 14:18:02 +0000 (16:18 +0200)
committerjeroendedauw <jeroendedauw@gmail.com>
Mon, 6 Aug 2012 14:18:02 +0000 (16:18 +0200)
Change-Id: Iaa546fc5a30dad4bc0a0dbd0dc18dd2e05bf9d7f

includes/AutoLoader.php
includes/parser/CacheTime.php [new file with mode: 0644]
includes/parser/ParserOutput.php

index bdd6316..1fee9f6 100644 (file)
@@ -735,7 +735,7 @@ $wgAutoloadLocalClasses = array(
        'XCacheBagOStuff' => 'includes/objectcache/XCacheBagOStuff.php',
 
        # includes/parser
-       'CacheTime' => 'includes/parser/ParserOutput.php',
+       'CacheTime' => 'includes/parser/CacheTime.php',
        'CoreLinkFunctions' => 'includes/parser/CoreLinkFunctions.php',
        'CoreParserFunctions' => 'includes/parser/CoreParserFunctions.php',
        'CoreTagHooks' => 'includes/parser/CoreTagHooks.php',
diff --git a/includes/parser/CacheTime.php b/includes/parser/CacheTime.php
new file mode 100644 (file)
index 0000000..e42c464
--- /dev/null
@@ -0,0 +1,127 @@
+<?php
+
+/**
+ * @todo document
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Parser
+ */
+class CacheTime {
+
+       var     $mVersion = Parser::VERSION,  # Compatibility check
+               $mCacheTime = '',             # Time when this object was generated, or -1 for uncacheable. Used in ParserCache.
+               $mCacheExpiry = null,         # Seconds after which the object should expire, use 0 for uncachable. Used in ParserCache.
+               $mContainsOldMagic;           # Boolean variable indicating if the input contained variables like {{CURRENTDAY}}
+
+       function getCacheTime()              { return $this->mCacheTime; }
+
+       function containsOldMagic()          { return $this->mContainsOldMagic; }
+       function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); }
+
+       /**
+        * setCacheTime() sets the timestamp expressing when the page has been rendered.
+        * This doesn not control expiry, see updateCacheExpiry() for that!
+        * @param $t string
+        * @return string
+        */
+       function setCacheTime( $t )          { return wfSetVar( $this->mCacheTime, $t ); }
+
+       /**
+        * Sets the number of seconds after which this object should expire.
+        * This value is used with the ParserCache.
+        * If called with a value greater than the value provided at any previous call,
+        * the new call has no effect. The value returned by getCacheExpiry is smaller
+        * or equal to the smallest number that was provided as an argument to
+        * updateCacheExpiry().
+        *
+        * @param $seconds number
+        */
+       function updateCacheExpiry( $seconds ) {
+               $seconds = (int)$seconds;
+
+               if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) {
+                       $this->mCacheExpiry = $seconds;
+               }
+
+               // hack: set old-style marker for uncacheable entries.
+               if ( $this->mCacheExpiry !== null && $this->mCacheExpiry <= 0 ) {
+                       $this->mCacheTime = -1;
+               }
+       }
+
+       /**
+        * Returns the number of seconds after which this object should expire.
+        * This method is used by ParserCache to determine how long the ParserOutput can be cached.
+        * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
+        * The value returned by getCacheExpiry is smaller or equal to the smallest number
+        * that was provided to a call of updateCacheExpiry(), and smaller or equal to the
+        * value of $wgParserCacheExpireTime.
+        * @return int|mixed|null
+        */
+       function getCacheExpiry() {
+               global $wgParserCacheExpireTime;
+
+               if ( $this->mCacheTime < 0 ) {
+                       return 0;
+               } // old-style marker for "not cachable"
+
+               $expire = $this->mCacheExpiry;
+
+               if ( $expire === null ) {
+                       $expire = $wgParserCacheExpireTime;
+               } else {
+                       $expire = min( $expire, $wgParserCacheExpireTime );
+               }
+
+               if( $this->containsOldMagic() ) { //compatibility hack
+                       $expire = min( $expire, 3600 ); # 1 hour
+               }
+
+               if ( $expire <= 0 ) {
+                       return 0; // not cachable
+               } else {
+                       return $expire;
+               }
+       }
+
+       /**
+        * @return bool
+        */
+       function isCacheable() {
+               return $this->getCacheExpiry() > 0;
+       }
+
+       /**
+        * Return true if this cached output object predates the global or
+        * per-article cache invalidation timestamps, or if it comes from
+        * an incompatible older version.
+        *
+        * @param $touched String: the affected article's last touched timestamp
+        * @return Boolean
+        */
+       public function expired( $touched ) {
+               global $wgCacheEpoch;
+               return !$this->isCacheable() || // parser says it's uncacheable
+                       $this->getCacheTime() < $touched ||
+                       $this->getCacheTime() <= $wgCacheEpoch ||
+                       $this->getCacheTime() < wfTimestamp( TS_MW, time() - $this->getCacheExpiry() ) || // expiry period has passed
+                       !isset( $this->mVersion ) ||
+                       version_compare( $this->mVersion, Parser::VERSION, "lt" );
+       }
+
+}
\ No newline at end of file
index 62d3bfd..a017a54 100644 (file)
@@ -1,6 +1,7 @@
 <?php
+
 /**
- * Output of the PHP parser
+ * Output of the PHP parser.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * @file
  * @ingroup Parser
  */
-
-/**
- * @todo document
- * @ingroup Parser
- */
-class CacheTime {
-       var     $mVersion = Parser::VERSION,  # Compatibility check
-               $mCacheTime = '',             # Time when this object was generated, or -1 for uncacheable. Used in ParserCache.
-               $mCacheExpiry = null,         # Seconds after which the object should expire, use 0 for uncachable. Used in ParserCache.
-               $mContainsOldMagic;           # Boolean variable indicating if the input contained variables like {{CURRENTDAY}}
-
-       function getCacheTime()              { return $this->mCacheTime; }
-
-       function containsOldMagic()          { return $this->mContainsOldMagic; }
-       function setContainsOldMagic( $com ) { return wfSetVar( $this->mContainsOldMagic, $com ); }
-
-       /**
-        * setCacheTime() sets the timestamp expressing when the page has been rendered.
-        * This doesn not control expiry, see updateCacheExpiry() for that!
-        * @param $t string
-        * @return string
-        */
-       function setCacheTime( $t )          { return wfSetVar( $this->mCacheTime, $t ); }
-
-       /**
-        * Sets the number of seconds after which this object should expire.
-        * This value is used with the ParserCache.
-        * If called with a value greater than the value provided at any previous call,
-        * the new call has no effect. The value returned by getCacheExpiry is smaller
-        * or equal to the smallest number that was provided as an argument to
-        * updateCacheExpiry().
-        *
-        * @param $seconds number
-        */
-       function updateCacheExpiry( $seconds ) {
-               $seconds = (int)$seconds;
-
-               if ( $this->mCacheExpiry === null || $this->mCacheExpiry > $seconds ) {
-                       $this->mCacheExpiry = $seconds;
-               }
-
-               // hack: set old-style marker for uncacheable entries.
-               if ( $this->mCacheExpiry !== null && $this->mCacheExpiry <= 0 ) {
-                       $this->mCacheTime = -1;
-               }
-       }
-
-       /**
-        * Returns the number of seconds after which this object should expire.
-        * This method is used by ParserCache to determine how long the ParserOutput can be cached.
-        * The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime().
-        * The value returned by getCacheExpiry is smaller or equal to the smallest number
-        * that was provided to a call of updateCacheExpiry(), and smaller or equal to the
-        * value of $wgParserCacheExpireTime.
-        * @return int|mixed|null
-        */
-       function getCacheExpiry() {
-               global $wgParserCacheExpireTime;
-
-               if ( $this->mCacheTime < 0 ) {
-                       return 0;
-               } // old-style marker for "not cachable"
-
-               $expire = $this->mCacheExpiry;
-
-               if ( $expire === null ) {
-                       $expire = $wgParserCacheExpireTime;
-               } else {
-                       $expire = min( $expire, $wgParserCacheExpireTime );
-               }
-
-               if( $this->containsOldMagic() ) { //compatibility hack
-                       $expire = min( $expire, 3600 ); # 1 hour
-               }
-
-               if ( $expire <= 0 ) {
-                       return 0; // not cachable
-               } else {
-                       return $expire;
-               }
-       }
-
-       /**
-        * @return bool
-        */
-       function isCacheable() {
-               return $this->getCacheExpiry() > 0;
-       }
-
-       /**
-        * Return true if this cached output object predates the global or
-        * per-article cache invalidation timestamps, or if it comes from
-        * an incompatible older version.
-        *
-        * @param $touched String: the affected article's last touched timestamp
-        * @return Boolean
-        */
-       public function expired( $touched ) {
-               global $wgCacheEpoch;
-               return !$this->isCacheable() || // parser says it's uncacheable
-                          $this->getCacheTime() < $touched ||
-                          $this->getCacheTime() <= $wgCacheEpoch ||
-                          $this->getCacheTime() < wfTimestamp( TS_MW, time() - $this->getCacheExpiry() ) || // expiry period has passed
-                          !isset( $this->mVersion ) ||
-                          version_compare( $this->mVersion, Parser::VERSION, "lt" );
-       }
-}
-
 class ParserOutput extends CacheTime {
        var $mText,                       # The output text
                $mLanguageLinks,              # List of the full text of language links, in the order they appear