(Follow-up r91059) Make backlinks query do both null or "" to potentially account...
[lhc/web/wiklou.git] / includes / LinksUpdate.php
index 7cf7453..a982aec 100644 (file)
@@ -2,6 +2,21 @@
 /**
  * See docs/deferred.txt
  *
+ * 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
+ *
  * @todo document (e.g. one-sentence top-level class description).
  */
 class LinksUpdate {
@@ -26,11 +41,11 @@ class LinksUpdate {
        /**
         * Constructor
         *
-        * @param Title $title Title of the page we're updating
-        * @param ParserOutput $parserOutput Output from a full parse of this page
-        * @param bool $recursive Queue jobs for recursive updates?
+        * @param $title Title of the page we're updating
+        * @param $parserOutput ParserOutput: output from a full parse of this page
+        * @param $recursive Boolean: queue jobs for recursive updates?
         */
-       function LinksUpdate( $title, $parserOutput, $recursive = true ) {
+       function __construct( $title, $parserOutput, $recursive = true ) {
                global $wgAntiLockFlags;
 
                if ( $wgAntiLockFlags & ALF_NO_LINK_LOCK ) {
@@ -54,6 +69,7 @@ class LinksUpdate {
                $this->mExternals = $parserOutput->getExternalLinks();
                $this->mCategories = $parserOutput->getCategories();
                $this->mProperties = $parserOutput->getProperties();
+               $this->mInterwikis = $parserOutput->getInterwikiLinks();
 
                # Convert the format of the interlanguage links
                # I didn't want to change it in the ParserOutput, because that array is passed all
@@ -66,6 +82,17 @@ class LinksUpdate {
                        $this->mInterlangs[$key] = $title;
                }
 
+               foreach ( $this->mCategories as &$sortkey ) {
+                       # If the sortkey is longer then 255 bytes,
+                       # it truncated by DB, and then doesn't get
+                       # matched when comparing existing vs current
+                       # categories, causing bug 25254.
+                       # Also. substr behaves weird when given "".
+                       if ( $sortkey !== '' ) {
+                               $sortkey = substr( $sortkey, 0, 255 );
+                       }
+               }
+
                $this->mRecursive = $recursive;
 
                wfRunHooks( 'LinksUpdateConstructed', array( &$this ) );
@@ -74,7 +101,7 @@ class LinksUpdate {
        /**
         * Update link tables with outgoing links from an updated article
         */
-       function doUpdate() {
+       public function doUpdate() {
                global $wgUseDumbLinkUpdate;
 
                wfRunHooks( 'LinksUpdate', array( &$this ) );
@@ -84,10 +111,9 @@ class LinksUpdate {
                        $this->doIncrementalUpdate();
                }
                wfRunHooks( 'LinksUpdateComplete', array( &$this ) );
-
        }
 
-       function doIncrementalUpdate() {
+       protected function doIncrementalUpdate() {
                wfProfileIn( __METHOD__ );
 
                # Page links
@@ -99,11 +125,11 @@ class LinksUpdate {
                $existing = $this->getExistingImages();
 
                $imageDeletes = $this->getImageDeletions( $existing );
-               $imageInserts = $this->getImageInsertions( $existing );
-               $this->incrTableUpdate( 'imagelinks', 'il', $imageDeletes, $imageInserts );
+               $this->incrTableUpdate( 'imagelinks', 'il', $imageDeletes,
+                       $this->getImageInsertions( $existing ) );
 
                # Invalidate all image description pages which had links added or removed
-               $imageUpdates = $imageDeletions + $imageInsertions
+               $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existing );
                $this->invalidateImageDescriptions( $imageUpdates );
 
                # External links
@@ -116,6 +142,11 @@ class LinksUpdate {
                $this->incrTableUpdate( 'langlinks', 'll', $this->getInterlangDeletions( $existing ),
                        $this->getInterlangInsertions( $existing ) );
 
+               # Inline interwiki links
+               $existing = $this->getExistingInterwikis();
+               $this->incrTableUpdate( 'iwlinks', 'iwl', $this->getInterwikiDeletions( $existing ),
+                       $this->getInterwikiInsertions( $existing ) );
+
                # Template links
                $existing = $this->getExistingTemplates();
                $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
@@ -125,11 +156,12 @@ class LinksUpdate {
                $existing = $this->getExistingCategories();
 
                $categoryDeletes = $this->getCategoryDeletions( $existing );
-               $categoryInserts = $this->getCategoryInsertions( $existing );
 
-               $this->incrTableUpdate( 'categorylinks', 'cl', $categoryDeletes, $categoryInserts );
+               $this->incrTableUpdate( 'categorylinks', 'cl', $categoryDeletes,
+                       $this->getCategoryInsertions( $existing ) );
 
                # Invalidate all categories which were added, deleted or changed (set symmetric difference)
+               $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
                $categoryUpdates = $categoryInserts + $categoryDeletes;
                $this->invalidateCategories( $categoryUpdates );
                $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
@@ -137,13 +169,13 @@ class LinksUpdate {
                # Page properties
                $existing = $this->getExistingProperties();
 
-               $propertiesDeletes = $this->getPropertiesDeletions( $existing );
-               $propertiesInserts = $this->getPropertiesInsertions( $existing );
+               $propertiesDeletes = $this->getPropertyDeletions( $existing );
 
-               $this->incrTableUpdate( 'page_props', 'pp', $propertiesDeletes, $propertiesInserts );
+               $this->incrTableUpdate( 'page_props', 'pp', $propertiesDeletes,
+                       $this->getPropertyInsertions( $existing ) );
 
                # Invalidate the necessary pages
-               $changed = $propertiesDeletes + $propertiesInserts;
+               $changed = $propertiesDeletes + array_diff_assoc( $this->mProperties, $existing );
                $this->invalidateProperties( $changed );
 
                # Refresh links of all pages including this page
@@ -160,13 +192,13 @@ class LinksUpdate {
         * May be slower or faster depending on level of lock contention and write speed of DB
         * Also useful where link table corruption needs to be repaired, e.g. in refreshLinks.php
         */
-       function doDumbUpdate() {
+       protected function doDumbUpdate() {
                wfProfileIn( __METHOD__ );
 
                # Refresh category pages and image description pages
                $existing = $this->getExistingCategories();
                $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
-               $categoryDeletes = array_diff_assoc( $existing, $this->mCategoties );
+               $categoryDeletes = array_diff_assoc( $existing, $this->mCategories );
                $categoryUpdates = $categoryInserts + $categoryDeletes;
                $existing = $this->getExistingImages();
                $imageUpdates = array_diff_key( $existing, $this->mImages ) + array_diff_key( $this->mImages, $existing );
@@ -177,6 +209,7 @@ class LinksUpdate {
                $this->dumbTableUpdate( 'templatelinks', $this->getTemplateInsertions(), 'tl_from' );
                $this->dumbTableUpdate( 'externallinks', $this->getExternalInsertions(), 'el_from' );
                $this->dumbTableUpdate( 'langlinks',     $this->getInterlangInsertions(),'ll_from' );
+               $this->dumbTableUpdate( 'iwlinks',       $this->getInterwikiInsertions(),'iwl_from' );
                $this->dumbTableUpdate( 'page_props',    $this->getPropertyInsertions(), 'pp_page' );
 
                # Update the cache of all the category pages and image description
@@ -195,42 +228,34 @@ class LinksUpdate {
        }
 
        function queueRecursiveJobs() {
+               global $wgUpdateRowsPerJob;
                wfProfileIn( __METHOD__ );
 
-               $batchSize = 100;
-               $dbr = wfGetDB( DB_SLAVE );
-               $res = $dbr->select( array( 'templatelinks', 'page' ),
-                       array( 'page_namespace', 'page_title' ),
-                       array(
-                               'page_id=tl_from',
-                               'tl_namespace' => $this->mTitle->getNamespace(),
-                               'tl_title' => $this->mTitle->getDBkey()
-                       ), __METHOD__
-               );
-
-               $done = false;
-               while ( !$done ) {
-                       $jobs = array();
-                       for ( $i = 0; $i < $batchSize; $i++ ) {
-                               $row = $dbr->fetchObject( $res );
-                               if ( !$row ) {
-                                       $done = true;
-                                       break;
-                               }
-                               $title = Title::makeTitle( $row->page_namespace, $row->page_title );
-                               $jobs[] = new RefreshLinksJob( $title, '' );
-                       }
-                       Job::batchInsert( $jobs );
+               $cache = $this->mTitle->getBacklinkCache();
+               $batches = $cache->partition( 'templatelinks', $wgUpdateRowsPerJob );
+               if ( !$batches ) {
+                       wfProfileOut( __METHOD__ );
+                       return;
+               }
+               $jobs = array();
+               foreach ( $batches as $batch ) {
+                       list( $start, $end ) = $batch;
+                       $params = array(
+                               'start' => $start,
+                               'end' => $end,
+                       );
+                       $jobs[] = new RefreshLinksJob2( $this->mTitle, $params );
                }
-               $dbr->freeResult( $res );
+               Job::batchInsert( $jobs );
+
                wfProfileOut( __METHOD__ );
        }
 
        /**
         * Invalidate the cache of a list of pages from a single namespace
         *
-        * @param integer $namespace
-        * @param array $dbkeys
+        * @param $namespace Integer
+        * @param $dbkeys Array
         */
        function invalidatePages( $namespace, $dbkeys ) {
                if ( !count( $dbkeys ) ) {
@@ -251,7 +276,7 @@ class LinksUpdate {
                                'page_touched < ' . $this->mDb->addQuotes( $now )
                        ), __METHOD__
                );
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        $ids[] = $row->page_id;
                }
                if ( !count( $ids ) ) {
@@ -288,7 +313,7 @@ class LinksUpdate {
        }
 
        function invalidateImageDescriptions( $images ) {
-               $this->invalidatePages( NS_IMAGE, array_keys( $images ) );
+               $this->invalidatePages( NS_FILE, array_keys( $images ) );
        }
 
        function dumbTableUpdate( $table, $insertions, $fromField ) {
@@ -301,18 +326,6 @@ class LinksUpdate {
                }
        }
 
-       /**
-        * Make a WHERE clause from a 2-d NS/dbkey array
-        *
-        * @param array $arr 2-d array indexed by namespace and DB key
-        * @param string $prefix Field name prefix, without the underscore
-        */
-       function makeWhereFrom2d( &$arr, $prefix ) {
-               $lb = new LinkBatch;
-               $lb->setArray( $arr );
-               return $lb->constructSet( $prefix, $this->mDb );
-       }
-
        /**
         * Update a table by doing a delete query then an insert query
         * @private
@@ -324,8 +337,13 @@ class LinksUpdate {
                        $fromField = "{$prefix}_from";
                }
                $where = array( $fromField => $this->mId );
-               if ( $table == 'pagelinks' || $table == 'templatelinks' ) {
-                       $clause = $this->makeWhereFrom2d( $deletions, $prefix );
+               if ( $table == 'pagelinks' || $table == 'templatelinks' || $table == 'iwlinks' ) {
+                       if ( $table == 'iwlinks' ) {
+                               $baseKey = 'iwl_prefix';
+                       } else {
+                               $baseKey = "{$prefix}_namespace";
+                       }
+                       $clause = $this->mDb->makeWhereFrom2d( $deletions, $baseKey, "{$prefix}_title" );
                        if ( $clause ) {
                                $where[] = $clause;
                        } else {
@@ -362,9 +380,9 @@ class LinksUpdate {
        function getLinkInsertions( $existing = array() ) {
                $arr = array();
                foreach( $this->mLinks as $ns => $dbkeys ) {
-                       # array_diff_key() was introduced in PHP 5.1, there is a compatibility function
-                       # in GlobalFunctions.php
-                       $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
+                       $diffs = isset( $existing[$ns] )
+                               ? array_diff_key( $dbkeys, $existing[$ns] )
+                               : $dbkeys;
                        foreach ( $diffs as $dbk => $id ) {
                                $arr[] = array(
                                        'pl_from'      => $this->mId,
@@ -431,19 +449,42 @@ class LinksUpdate {
 
        /**
         * Get an array of category insertions
-        * @param array $existing Array mapping existing category names to sort keys. If both
+        *
+        * @param $existing Array mapping existing category names to sort keys. If both
         * match a link in $this, the link will be omitted from the output
         * @private
         */
        function getCategoryInsertions( $existing = array() ) {
+               global $wgContLang, $wgCategoryCollation;
                $diffs = array_diff_assoc( $this->mCategories, $existing );
                $arr = array();
-               foreach ( $diffs as $name => $sortkey ) {
+               foreach ( $diffs as $name => $prefix ) {
+                       $nt = Title::makeTitleSafe( NS_CATEGORY, $name );
+                       $wgContLang->findVariantLink( $name, $nt, true );
+
+                       if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
+                               $type = 'subcat';
+                       } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
+                               $type = 'file';
+                       } else {
+                               $type = 'page';
+                       }
+
+                       # Treat custom sortkeys as a prefix, so that if multiple
+                       # things are forced to sort as '*' or something, they'll
+                       # sort properly in the category rather than in page_id
+                       # order or such.
+                       $sortkey = Collation::singleton()->getSortKey(
+                               $this->mTitle->getCategorySortkey( $prefix ) );
+
                        $arr[] = array(
                                'cl_from'    => $this->mId,
                                'cl_to'      => $name,
                                'cl_sortkey' => $sortkey,
-                               'cl_timestamp' => $this->mDb->timestamp()
+                               'cl_timestamp' => $this->mDb->timestamp(),
+                               'cl_sortkey_prefix' => $prefix,
+                               'cl_collation' => $wgCategoryCollation,
+                               'cl_type' => $type,
                        );
                }
                return $arr;
@@ -451,7 +492,8 @@ class LinksUpdate {
 
        /**
         * Get an array of interlanguage link insertions
-        * @param array $existing Array mapping existing language codes to titles
+        *
+        * @param $existing Array mapping existing language codes to titles
         * @private
         */
        function getInterlangInsertions( $existing = array() ) {
@@ -483,6 +525,25 @@ class LinksUpdate {
                return $arr;
        }
 
+       /**
+        * Get an array of interwiki insertions for passing to the DB
+        * Skips the titles specified by the 2-D array $existing
+        * @private
+        */
+       function getInterwikiInsertions( $existing = array() ) {
+               $arr = array();
+               foreach( $this->mInterwikis as $prefix => $dbkeys ) {
+                       $diffs = isset( $existing[$prefix] ) ? array_diff_key( $dbkeys, $existing[$prefix] ) : $dbkeys;
+                       foreach ( $diffs as $dbk => $id ) {
+                               $arr[] = array(
+                                       'iwl_from'   => $this->mId,
+                                       'iwl_prefix' => $prefix,
+                                       'iwl_title'  => $dbk
+                               );
+                       }
+               }
+               return $arr;
+       }
 
        /**
         * Given an array of existing links, returns those links which are not in $this
@@ -562,6 +623,23 @@ class LinksUpdate {
                return array_diff_assoc( $existing, $this->mProperties );
        }
 
+       /**
+        * Given an array of existing interwiki links, returns those links which are not in $this
+        * and thus should be deleted.
+        * @private
+        */
+       function getInterwikiDeletions( $existing ) {
+               $del = array();
+               foreach ( $existing as $prefix => $dbkeys ) {
+                       if ( isset( $this->mInterwikis[$prefix] ) ) {
+                               $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
+                       } else {
+                               $del[$prefix] = $existing[$prefix];
+                       }
+               }
+               return $del;
+       }
+
        /**
         * Get an array of existing links, as a 2-D array
         * @private
@@ -570,13 +648,12 @@ class LinksUpdate {
                $res = $this->mDb->select( 'pagelinks', array( 'pl_namespace', 'pl_title' ),
                        array( 'pl_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        if ( !isset( $arr[$row->pl_namespace] ) ) {
                                $arr[$row->pl_namespace] = array();
                        }
                        $arr[$row->pl_namespace][$row->pl_title] = 1;
                }
-               $this->mDb->freeResult( $res );
                return $arr;
        }
 
@@ -588,13 +665,12 @@ class LinksUpdate {
                $res = $this->mDb->select( 'templatelinks', array( 'tl_namespace', 'tl_title' ),
                        array( 'tl_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        if ( !isset( $arr[$row->tl_namespace] ) ) {
                                $arr[$row->tl_namespace] = array();
                        }
                        $arr[$row->tl_namespace][$row->tl_title] = 1;
                }
-               $this->mDb->freeResult( $res );
                return $arr;
        }
 
@@ -606,10 +682,9 @@ class LinksUpdate {
                $res = $this->mDb->select( 'imagelinks', array( 'il_to' ),
                        array( 'il_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        $arr[$row->il_to] = 1;
                }
-               $this->mDb->freeResult( $res );
                return $arr;
        }
 
@@ -621,10 +696,9 @@ class LinksUpdate {
                $res = $this->mDb->select( 'externallinks', array( 'el_to' ),
                        array( 'el_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        $arr[$row->el_to] = 1;
                }
-               $this->mDb->freeResult( $res );
                return $arr;
        }
 
@@ -633,13 +707,12 @@ class LinksUpdate {
         * @private
         */
        function getExistingCategories() {
-               $res = $this->mDb->select( 'categorylinks', array( 'cl_to', 'cl_sortkey' ),
+               $res = $this->mDb->select( 'categorylinks', array( 'cl_to', 'cl_sortkey_prefix' ),
                        array( 'cl_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
-                       $arr[$row->cl_to] = $row->cl_sortkey;
+               foreach ( $res as $row ) {
+                       $arr[$row->cl_to] = $row->cl_sortkey_prefix;
                }
-               $this->mDb->freeResult( $res );
                return $arr;
        }
 
@@ -652,12 +725,29 @@ class LinksUpdate {
                $res = $this->mDb->select( 'langlinks', array( 'll_lang', 'll_title' ),
                        array( 'll_from' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        $arr[$row->ll_lang] = $row->ll_title;
                }
                return $arr;
        }
 
+       /**
+        * Get an array of existing inline interwiki links, as a 2-D array
+        * @return array (prefix => array(dbkey => 1))
+        */
+       protected function getExistingInterwikis() {
+               $res = $this->mDb->select( 'iwlinks', array( 'iwl_prefix', 'iwl_title' ),
+                       array( 'iwl_from' => $this->mId ), __METHOD__, $this->mOptions );
+               $arr = array();
+               foreach ( $res as $row ) {
+                       if ( !isset( $arr[$row->iwl_prefix] ) ) {
+                               $arr[$row->iwl_prefix] = array();
+                       }
+                       $arr[$row->iwl_prefix][$row->iwl_title] = 1;
+               }
+               return $arr;
+       }
+
        /**
         * Get an array of existing categories, with the name in the key and sort key in the value.
         * @private
@@ -666,10 +756,9 @@ class LinksUpdate {
                $res = $this->mDb->select( 'page_props', array( 'pp_propname', 'pp_value' ),
                        array( 'pp_page' => $this->mId ), __METHOD__, $this->mOptions );
                $arr = array();
-               while ( $row = $this->mDb->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        $arr[$row->pp_propname] = $row->pp_value;
                }
-               $this->mDb->freeResult( $res );
                return $arr;
        }
 
@@ -680,6 +769,13 @@ class LinksUpdate {
        function getTitle() {
                return $this->mTitle;
        }
+       
+       /**
+        * Return the list of images used as generated by the parser
+        */
+       public function getImages() {
+               return $this->mImages;
+       }
 
        /**
         * Invalidate any necessary link lists related to page property changes