debug log group for DNS blacklist lookup results

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

diff --git a/includes/BacklinkCache.php b/includes/BacklinkCache.php
index 4de4afb..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 ) ) {
@@ -174,28 +192,10 @@ class BacklinkCache {
                return $ta;
        }
 
-       /**
-        * Get the distant backtemplatelinks for the table globaltemplatelinks. Cached in process memory only.
-        * @return ResultWrapper list of distant pages that use the local title
-        */
-       public function getDistantTemplateLinks( ) {
-               global $wgGlobalDatabase, $wgLocalInterwiki;
-
-               $dbr = wfGetDB( DB_SLAVE, array(), $wgGlobalDatabase );
-               $res = $dbr->select(
-                       array( 'globaltemplatelinks', 'globalinterwiki' ),
-                       array( 'gtl_from_wiki', 'gtl_from_page', 'gtl_from_title', 'giw_prefix' ),
-                       array( 'gtl_to_prefix' => $wgLocalInterwiki, 'gtl_to_title' => $this->title->getDBkey( ) ),
-                       __METHOD__,
-                       null,
-                       array( 'gtl_from_wiki = giw_wikiid' )
-               );
-               return $res;
-       }
-
        /**
         * Get the field name prefix for a given table
         * @param $table String
+        * @return null|string
         */
        protected function getPrefix( $table ) {
                static $prefixes = array(
@@ -204,7 +204,6 @@ class BacklinkCache {
                        'categorylinks' => 'cl',
                        'templatelinks' => 'tl',
                        'redirect'      => 'rd',
-                       'globaltemplatelinks' => 'gtl',
                );
 
                if ( isset( $prefixes[$table] ) ) {
@@ -224,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 );
@@ -303,7 +303,7 @@ class BacklinkCache {
         */
        public function partition( $table, $batchSize ) {
 
-               // 1) try partition cache ...
+               // 1) try partition cache ... 
 
                if ( isset( $this->partitionCache[$table][$batchSize] ) ) {
                        wfDebug( __METHOD__ . ": got from partition cache\n" );
@@ -358,7 +358,7 @@ class BacklinkCache {
         * Partition a DB result with backlinks in it into batches
         * @param $res ResultWrapper database result
         * @param $batchSize integer
-        * @return array @see
+        * @return array @see 
         */
        protected function partitionResult( $res, $batchSize ) {
                $batches = array();