Remove DBABagOStuff
authorChad Horohoe <chadh@wikimedia.org>
Thu, 16 Jan 2014 19:32:33 +0000 (11:32 -0800)
committerChad Horohoe <chadh@wikimedia.org>
Thu, 16 Jan 2014 19:43:59 +0000 (11:43 -0800)
Isn't useful outside of testing as the comments state, but it's
barely even useful for that. People who are testing the cache
code can use CACHE_DB if CACHE_MEMCACHED is too hard.

Change-Id: Ief0aa148376957fdd844c8bb585a133b854a012c

RELEASE-NOTES-1.23
includes/AutoLoader.php
includes/DefaultSettings.php
includes/Defines.php
includes/objectcache/DBABagOStuff.php [deleted file]

index b0d97aa..ca8c91b 100644 (file)
@@ -28,6 +28,7 @@ production.
   should be updated if LBFactory_Simple or LBFactory_Multi is configured.
 * $wgPasswordSenderName has been deprecated. To set a custom mailer name,
   the system message 'emailsender' should be modified (default: "{{SITENAME}}").
+* $wgDBAhandler was removed as the only class using it was also removed
 
 === New features in 1.23 ===
 * ResourceLoader can utilize the Web Storage API to cache modules client-side.
index 0ebca0e..e1f8a14 100644 (file)
@@ -768,7 +768,6 @@ $wgAutoloadLocalClasses = array(
        # includes/objectcache
        'APCBagOStuff' => 'includes/objectcache/APCBagOStuff.php',
        'BagOStuff' => 'includes/objectcache/BagOStuff.php',
-       'DBABagOStuff' => 'includes/objectcache/DBABagOStuff.php',
        'EmptyBagOStuff' => 'includes/objectcache/EmptyBagOStuff.php',
        'FakeMemCachedClient' => 'includes/objectcache/EmptyBagOStuff.php',
        'HashBagOStuff' => 'includes/objectcache/HashBagOStuff.php',
index 92ceb6f..a8f51fe 100644 (file)
@@ -1945,9 +1945,6 @@ $wgCacheDirectory = false;
  *   - CACHE_DB:         Store cache objects in the DB
  *   - CACHE_MEMCACHED:  MemCached, must specify servers in $wgMemCachedServers
  *   - CACHE_ACCEL:      APC, XCache or WinCache
- *   - CACHE_DBA:        Use PHP's DBA extension to store in a DBM-style
- *                       database. This is slow, and is not recommended for
- *                       anything other than debugging.
  *   - (other):          A string may be used which identifies a cache
  *                       configuration in $wgObjectCaches.
  *
@@ -2000,15 +1997,10 @@ $wgLanguageConverterCacheType = CACHE_ANYTHING;
  * the value is an associative array of parameters. The "class" parameter is the
  * class name which will be used. Alternatively, a "factory" parameter may be
  * given, giving a callable function which will generate a suitable cache object.
- *
- * The other parameters are dependent on the class used.
- * - CACHE_DBA uses $wgTmpDirectory by default. The 'dir' parameter let you
- *   overrides that.
  */
 $wgObjectCaches = array(
        CACHE_NONE => array( 'class' => 'EmptyBagOStuff' ),
        CACHE_DB => array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
-       CACHE_DBA => array( 'class' => 'DBABagOStuff' ),
 
        CACHE_ANYTHING => array( 'factory' => 'ObjectCache::newAnything' ),
        CACHE_ACCEL => array( 'factory' => 'ObjectCache::newAccelerator' ),
@@ -2028,12 +2020,6 @@ $wgObjectCaches = array(
  */
 $wgParserCacheExpireTime = 86400;
 
-/**
- * Select which DBA handler <http://www.php.net/manual/en/dba.requirements.php>
- * to use as CACHE_DBA backend.
- */
-$wgDBAhandler = 'db3';
-
 /**
  * Deprecated alias for $wgSessionsInObjectCache.
  *
index 7c71fe7..015ea9c 100644 (file)
@@ -113,7 +113,6 @@ define( 'CACHE_NONE', 0 );       // Do not cache
 define( 'CACHE_DB', 1 );         // Store cache objects in the DB
 define( 'CACHE_MEMCACHED', 2 );  // MemCached, must specify servers in $wgMemCacheServers
 define( 'CACHE_ACCEL', 3 );      // APC, XCache or WinCache
-define( 'CACHE_DBA', 4 );        // Use PHP's DBA extension to store in a DBM-style database
 /**@}*/
 
 /**@{
diff --git a/includes/objectcache/DBABagOStuff.php b/includes/objectcache/DBABagOStuff.php
deleted file mode 100644 (file)
index a81b5c5..0000000
+++ /dev/null
@@ -1,305 +0,0 @@
-<?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.
- * Slow due to the need to constantly open and close the file to avoid holding
- * 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;
-
-       /**
-        * @param $params array
-        */
-       public function __construct( $params ) {
-               global $wgDBAhandler;
-
-               if ( !isset( $params['dir'] ) ) {
-                       $params['dir'] = wfTempDir();
-               }
-
-               $this->mFile = $params['dir'] . '/mw-cache-' . wfWikiID() . '.db';
-               wfDebug( __CLASS__ . ": using cache file {$this->mFile}\n" );
-               $this->mHandler = $wgDBAhandler;
-       }
-
-       /**
-        * Encode value and expiry for storage
-        * @param $value
-        * @param $expiry
-        *
-        * @return string
-        */
-       protected function encode( $value, $expiry ) {
-               # Convert to absolute time
-               $expiry = $this->convertExpiry( $expiry );
-
-               return sprintf( '%010u', intval( $expiry ) ) . ' ' . serialize( $value );
-       }
-
-       /**
-        * @param $blob string
-        * @return array list containing value first and expiry second
-        */
-       protected function decode( $blob ) {
-               if ( !is_string( $blob ) ) {
-                       return array( false, 0 );
-               } else {
-                       return array(
-                               unserialize( substr( $blob, 11 ) ),
-                               intval( substr( $blob, 0, 10 ) )
-                       );
-               }
-       }
-
-       /**
-        * @return resource
-        */
-       protected function getReader() {
-               if ( file_exists( $this->mFile ) ) {
-                       $handle = dba_open( $this->mFile, 'rl', $this->mHandler );
-               } else {
-                       $handle = $this->getWriter();
-               }
-
-               if ( !$handle ) {
-                       wfDebug( "Unable to open DBA cache file {$this->mFile}\n" );
-               }
-
-               return $handle;
-       }
-
-       /**
-        * @return resource
-        */
-       protected function getWriter() {
-               $handle = dba_open( $this->mFile, 'cl', $this->mHandler );
-
-               if ( !$handle ) {
-                       wfDebug( "Unable to open DBA cache file {$this->mFile}\n" );
-               }
-
-               return $handle;
-       }
-
-       /**
-        * @param $key string
-        * @param $casToken[optional] mixed
-        * @return mixed
-        */
-       public function get( $key, &$casToken = null ) {
-               wfProfileIn( __METHOD__ );
-               wfDebug( __METHOD__ . "($key)\n" );
-
-               $handle = $this->getReader();
-               if ( !$handle ) {
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               $val = dba_fetch( $key, $handle );
-               $casToken = $val;
-               list( $val, $expiry ) = $this->decode( $val );
-
-               # Must close ASAP because locks are held
-               dba_close( $handle );
-
-               if ( $val !== false && $expiry && $expiry < time() ) {
-                       # Key is expired, delete it
-                       $handle = $this->getWriter();
-                       dba_delete( $key, $handle );
-                       dba_close( $handle );
-                       wfDebug( __METHOD__ . ": $key expired\n" );
-                       $val = false;
-               }
-
-               wfProfileOut( __METHOD__ );
-
-               return $val;
-       }
-
-       /**
-        * @param $key string
-        * @param $value mixed
-        * @param $exptime int
-        * @return bool
-        */
-       public function set( $key, $value, $exptime = 0 ) {
-               wfProfileIn( __METHOD__ );
-               wfDebug( __METHOD__ . "($key)\n" );
-
-               $blob = $this->encode( $value, $exptime );
-
-               $handle = $this->getWriter();
-               if ( !$handle ) {
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               $ret = dba_replace( $key, $blob, $handle );
-               dba_close( $handle );
-
-               wfProfileOut( __METHOD__ );
-               return $ret;
-       }
-
-       /**
-        * @param $casToken mixed
-        * @param $key string
-        * @param $value mixed
-        * @param $exptime int
-        * @return bool
-        */
-       public function cas( $casToken, $key, $value, $exptime = 0 ) {
-               wfProfileIn( __METHOD__ );
-               wfDebug( __METHOD__ . "($key)\n" );
-
-               $blob = $this->encode( $value, $exptime );
-
-               $handle = $this->getWriter();
-               if ( !$handle ) {
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               // DBA is locked to any other write connection, so we can safely
-               // compare the current & previous value before saving new value
-               $val = dba_fetch( $key, $handle );
-               if ( $casToken !== $val ) {
-                       dba_close( $handle );
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               $ret = dba_replace( $key, $blob, $handle );
-               dba_close( $handle );
-
-               wfProfileOut( __METHOD__ );
-               return $ret;
-       }
-
-       /**
-        * @param $key string
-        * @param $time int
-        * @return bool
-        */
-       public function delete( $key, $time = 0 ) {
-               wfProfileIn( __METHOD__ );
-               wfDebug( __METHOD__ . "($key)\n" );
-
-               $handle = $this->getWriter();
-               if ( !$handle ) {
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               $ret = !dba_exists( $key, $handle ) || dba_delete( $key, $handle );
-               dba_close( $handle );
-
-               wfProfileOut( __METHOD__ );
-               return $ret;
-       }
-
-       /**
-        * @param $key string
-        * @param $value mixed
-        * @param $exptime int
-        * @return bool
-        */
-       public function add( $key, $value, $exptime = 0 ) {
-               wfProfileIn( __METHOD__ );
-
-               $blob = $this->encode( $value, $exptime );
-
-               $handle = $this->getWriter();
-
-               if ( !$handle ) {
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               $ret = dba_insert( $key, $blob, $handle );
-
-               # Insert failed, check to see if it failed due to an expired key
-               if ( !$ret ) {
-                       list( , $expiry ) = $this->decode( dba_fetch( $key, $handle ) );
-
-                       if ( $expiry && $expiry < time() ) {
-                               # Yes expired, delete and try again
-                               dba_delete( $key, $handle );
-                               $ret = dba_insert( $key, $blob, $handle );
-                               # This time if it failed then it will be handled by the caller like any other race
-                       }
-               }
-
-               dba_close( $handle );
-
-               wfProfileOut( __METHOD__ );
-               return $ret;
-       }
-
-       /**
-        * @param $key string
-        * @param $step integer
-        * @return integer|bool
-        */
-       public function incr( $key, $step = 1 ) {
-               wfProfileIn( __METHOD__ );
-
-               $handle = $this->getWriter();
-
-               if ( !$handle ) {
-                       wfProfileOut( __METHOD__ );
-                       return false;
-               }
-
-               list( $value, $expiry ) = $this->decode( dba_fetch( $key, $handle ) );
-               if ( $value !== false ) {
-                       if ( $expiry && $expiry < time() ) {
-                               # Key is expired, delete it
-                               dba_delete( $key, $handle );
-                               wfDebug( __METHOD__ . ": $key expired\n" );
-                               $value = false;
-                       } else {
-                               $value += $step;
-                               $blob = $this->encode( $value, $expiry );
-
-                               $ret = dba_replace( $key, $blob, $handle );
-                               $value = $ret ? $value : false;
-                       }
-               }
-
-               dba_close( $handle );
-
-               wfProfileOut( __METHOD__ );
-
-               return ( $value === false ) ? false : (int)$value;
-       }
-}