debug log group for DNS blacklist lookup results

[lhc/web/wiklou.git] / includes / objectcache / DBABagOStuff.php

diff --git a/includes/objectcache/DBABagOStuff.php b/includes/objectcache/DBABagOStuff.php
index 2c07172..8483d7e 100644 (file)
--- a/includes/objectcache/DBABagOStuff.php
+++ b/includes/objectcache/DBABagOStuff.php
@@ -1,4 +1,25 @@
 <?php
+/**
+ * Object caching using DBA backend.
+ *
+ * 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 Cache
+ */
 
 /**
  * Cache that uses DBA as a backend.
@@ -6,20 +27,25 @@
  * writer locks. Intended for development use only,  as a memcached workalike
  * for systems that don't have it.
  *
+ * On construction you can pass array( 'dir' => '/some/path' ); as a parameter
+ * to override the default DBA files directory (wfTempDir()).
+ *
  * @ingroup Cache
  */
 class DBABagOStuff extends BagOStuff {
        var $mHandler, $mFile, $mReader, $mWriter, $mDisabled;
 
-       public function __construct( $dir = false ) {
+       /**
+        * @param $params array
+        */
+       public function __construct( $params ) {
                global $wgDBAhandler;
 
-               if ( $dir === false ) {
-                       global $wgTmpDirectory;
-                       $dir = $wgTmpDirectory;
+               if ( !isset( $params['dir'] ) ) {
+                       $params['dir'] = wfTempDir();
                }
 
-               $this->mFile = "$dir/mw-cache-" . wfWikiID();
+               $this->mFile = $params['dir']."/mw-cache-" . wfWikiID();
                $this->mFile .= '.db';
                wfDebug( __CLASS__ . ": using cache file {$this->mFile}\n" );
                $this->mHandler = $wgDBAhandler;
@@ -27,6 +53,10 @@ class DBABagOStuff extends BagOStuff {
 
        /**
         * Encode value and expiry for storage
+        * @param $value
+        * @param $expiry
+        *
+        * @return string
         */
        function encode( $value, $expiry ) {
                # Convert to absolute time
@@ -36,7 +66,8 @@ class DBABagOStuff extends BagOStuff {
        }
 
        /**
-        * @return list containing value first and expiry second
+        * @param $blob string
+        * @return array list containing value first and expiry second
         */
        function decode( $blob ) {
                if ( !is_string( $blob ) ) {
@@ -49,6 +80,9 @@ class DBABagOStuff extends BagOStuff {
                }
        }
 
+       /**
+        * @return resource
+        */
        function getReader() {
                if ( file_exists( $this->mFile ) ) {
                        $handle = dba_open( $this->mFile, 'rl', $this->mHandler );
@@ -63,6 +97,9 @@ class DBABagOStuff extends BagOStuff {
                return $handle;
        }
 
+       /**
+        * @return resource
+        */
        function getWriter() {
                $handle = dba_open( $this->mFile, 'cl', $this->mHandler );
 
@@ -73,6 +110,10 @@ class DBABagOStuff extends BagOStuff {
                return $handle;
        }
 
+       /**
+        * @param $key string
+        * @return mixed|null|string
+        */
        function get( $key ) {
                wfProfileIn( __METHOD__ );
                wfDebug( __METHOD__ . "($key)\n" );
@@ -102,6 +143,12 @@ class DBABagOStuff extends BagOStuff {
                return $val;
        }
 
+       /**
+        * @param $key string
+        * @param $value mixed
+        * @param $exptime int
+        * @return bool
+        */
        function set( $key, $value, $exptime = 0 ) {
                wfProfileIn( __METHOD__ );
                wfDebug( __METHOD__ . "($key)\n" );
@@ -121,6 +168,11 @@ class DBABagOStuff extends BagOStuff {
                return $ret;
        }
 
+       /**
+        * @param $key string
+        * @param $time int
+        * @return bool
+        */
        function delete( $key, $time = 0 ) {
                wfProfileIn( __METHOD__ );
                wfDebug( __METHOD__ . "($key)\n" );
@@ -138,6 +190,12 @@ class DBABagOStuff extends BagOStuff {
                return $ret;
        }
 
+       /**
+        * @param $key string
+        * @param $value mixed
+        * @param $exptime int
+        * @return bool
+        */
        function add( $key, $value, $exptime = 0 ) {
                wfProfileIn( __METHOD__ );
 
@@ -170,6 +228,9 @@ class DBABagOStuff extends BagOStuff {
                return $ret;
        }
 
+       /**
+        * @return Array
+        */
        function keys() {
                $reader = $this->getReader();
                $k1 = dba_firstkey( $reader );
@@ -180,8 +241,10 @@ class DBABagOStuff extends BagOStuff {
 
                $result[] = $k1;
 
-               while ( $key = dba_nextkey( $reader ) ) {
+               $key = dba_nextkey( $reader );
+               while ( $key ) {
                        $result[] = $key;
+                       $key = dba_nextkey( $reader );
                }
 
                return $result;