Merge "Added point in release notes about added ORM stuffs"

[lhc/web/wiklou.git] / includes / BacklinkCache.php

diff --git a/includes/BacklinkCache.php b/includes/BacklinkCache.php
index 7de7fae..2aba29f 100644 (file)
--- a/includes/BacklinkCache.php
+++ b/includes/BacklinkCache.php
@@ -1,7 +1,28 @@
 <?php
 /**
- * File for BacklinkCache class
+ * Class for fetching backlink lists, approximate backlink counts and
+ * partitions.
+ *
+ * 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
+ * @author Tim Starling
+ * @copyright © 2009, Tim Starling, Domas Mituzas
+ * @copyright © 2010, Max Sem
+ * @copyright © 2011, Antoine Musso
  */
 
 /**
@@ -18,11 +39,6 @@
  * Introduced by r47317
  *
  * @internal documentation reviewed on 18 Mar 2011 by hashar
- *
- * @author Tim Starling
- * @copyright © 2009, Tim Starling, Domas Mituzas
- * @copyright © 2010, Max Sem
- * @copyright © 2011, Ashar Voultoiz
  */
 class BacklinkCache {
 
@@ -75,6 +91,8 @@ class BacklinkCache {
         * Serialization handler, diasallows to serialize the database to prevent
         * failures after this class is deserialized from cache with dead DB
         * connection.
+        *
+        * @return array
         */
        function __sleep() {
                return array( 'partitionCache', 'fullResultCache', 'title' );
@@ -101,7 +119,7 @@ class BacklinkCache {
        /**
         * Get the slave connection to the database
         * When non existing, will initialize the connection.
-        * @return Database object
+        * @return DatabaseBase object
         */
        protected function getDB() {
                if ( !isset( $this->db ) ) {
@@ -177,6 +195,7 @@ class BacklinkCache {
        /**
         * Get the field name prefix for a given table
         * @param $table String
+        * @return null|string
         */
        protected function getPrefix( $table ) {
                static $prefixes = array(
@@ -190,7 +209,13 @@ class BacklinkCache {
                if ( isset( $prefixes[$table] ) ) {
                        return $prefixes[$table];
                } else {
-                       throw new MWException( "Invalid table \"$table\" in " . __CLASS__ );
+                       $prefix = null;
+                       wfRunHooks( 'BacklinkCacheGetPrefix', array( $table, &$prefix ) );
+                       if( $prefix ) {
+                               return $prefix;
+                       } else {
+                               throw new MWException( "Invalid table \"$table\" in " . __CLASS__ );
+                       }
                }
        }
 
@@ -198,6 +223,7 @@ class BacklinkCache {
         * Get the SQL condition array for selecting backlinks, with a join
         * on the page table.
         * @param $table String
+        * @return array|null
         */
        protected function getConditions( $table ) {
                $prefix = $this->getPrefix( $table );
@@ -207,10 +233,20 @@ class BacklinkCache {
                switch ( $table ) {
                        case 'pagelinks':
                        case 'templatelinks':
+                               $conds = array(
+                                       "{$prefix}_namespace" => $this->title->getNamespace(),
+                                       "{$prefix}_title"     => $this->title->getDBkey(),
+                                       "page_id={$prefix}_from"
+                               );
+                               break;
                        case 'redirect':
                                $conds = array(
                                        "{$prefix}_namespace" => $this->title->getNamespace(),
                                        "{$prefix}_title"     => $this->title->getDBkey(),
+                                       $this->getDb()->makeList( array(
+                                               "{$prefix}_interwiki = ''",
+                                               "{$prefix}_interwiki is null",
+                                       ), LIST_OR ),
                                        "page_id={$prefix}_from"
                                );
                                break;
@@ -227,7 +263,10 @@ class BacklinkCache {
                                );
                                break;
                        default:
-                               throw new MWException( "Invalid table \"$table\" in " . __CLASS__ );
+                               $conds = null;
+                               wfRunHooks( 'BacklinkCacheGetConditions', array( $table, $this->title, &$conds ) );
+                               if( !$conds )
+                                       throw new MWException( "Invalid table \"$table\" in " . __CLASS__ );
                }
 
                return $conds;
@@ -255,7 +294,7 @@ class BacklinkCache {
 
        /**
         * Partition the backlinks into batches.
-        * Returns an array giving the start and end of each range. The firsti
+        * Returns an array giving the start and end of each range. The first
         * batch has a start of false, and the last batch has an end of false.
         *
         * @param $table String: the links table name
@@ -264,7 +303,7 @@ class BacklinkCache {
         */
        public function partition( $table, $batchSize ) {
 
-               // 1) try this per process cache first
+               // 1) try partition cache ... 
 
                if ( isset( $this->partitionCache[$table][$batchSize] ) ) {
                        wfDebug( __METHOD__ . ": got from partition cache\n" );
@@ -274,7 +313,7 @@ class BacklinkCache {
                $this->partitionCache[$table][$batchSize] = false;
                $cacheEntry =& $this->partitionCache[$table][$batchSize];
 
-               // 2) try full result cache
+               // 2) ... then try full result cache ...
 
                if ( isset( $this->fullResultCache[$table] ) ) {
                        $cacheEntry = $this->partitionResult( $this->fullResultCache[$table], $batchSize );