* Added templatelinks table. The table currently represents a literal list of templat...
[lhc/web/wiklou.git] / includes / LinksUpdate.php
index 547aa51..b15f684 100644 (file)
-<?
-# See deferred.doc
-
+<?php
+/**
+ * See deferred.txt
+ * @package MediaWiki
+ */
+
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class LinksUpdate {
 
-       /* private */ var $mId, $mTitle;
-
-       function LinksUpdate( $id, $title )
-       {
-               $this->mId = $id;
+       /**#@+
+        * @access private
+        */
+       var $mId,            # Page ID of the article linked from
+               $mTitle,         # Title object of the article linked from
+               $mParserOutput,  # Parser output containing the links to be inserted into the database
+               $mLinks,         # Map of title strings to IDs for the links in the document
+               $mImages,        # DB keys of the images used, in the array key only
+               $mTemplates,     # Map of title strings to IDs for the template references, including broken ones
+               $mCategories,    # Map of category names to sort keys
+               $mDb,            # Database connection reference
+               $mOptions;       # SELECT options to be used (array)
+       /**#@-*/
+
+       /**
+        * Constructor
+        * Initialize private variables
+        * @param integer $id
+        * @param string $title
+        */
+       function LinksUpdate( $title, $parserOutput ) {
+               global $wgAntiLockFlags;
+
+               if ( $wgAntiLockFlags & ALF_NO_LINK_LOCK ) {
+                       $this->mOptions = array();
+               } else {
+                       $this->mOptions = array( 'FOR UPDATE' );
+               }
+               $this->mDb =& wfGetDB( DB_MASTER );
+                       
+               if ( !is_object( $title ) ) {
+                       wfDebugDieBacktrace( "The calling convention to LinksUpdate::LinksUpdate() has changed. " .
+                               "Please see Article::editUpdates() for an invocation example.\n" );
+               }
                $this->mTitle = $title;
-               $this->mTitleEnc = wfStrencode( $title );
+               $this->mId = $title->getArticleID();
+               $this->mParserOutput = $parserOutput;
+
+               // Shortcut aliases
+               $this->mLinks =& $this->mParserOutput->getLinks();
+               $this->mImages =& $this->mParserOutput->getImages();
+               $this->mTemplates =& $this->mParserOutput->getTemplates();
+               $this->mCategories =& $this->mParserOutput->getCategories();
+               
        }
 
-       
-       function doUpdate()
-       {
-               global $wgUseBetterLinksUpdate, $wgLinkCache, $wgDBtransactions;
-               global $wgEnablePersistentLC;
-
-               /* Update link tables with outgoing links from an updated article */
-               /* Relies on the 'link cache' to be filled out */
-
-               if ( !$wgUseBetterLinksUpdate ) {
+       /**
+        * Update link tables with outgoing links from an updated article
+        */
+       function doUpdate() {
+               global $wgUseDumbLinkUpdate;
+               if ( $wgUseDumbLinkUpdate ) {
                        $this->doDumbUpdate();
-                       return;
+               } else {
+                       $this->doIncrementalUpdate();
                }
+       }
 
-               $fname = "LinksUpdate::doUpdate";
+       function doIncrementalUpdate() {
+               $fname = 'LinksUpdate::doIncrementalUpdate';
                wfProfileIn( $fname );
 
-               $del = array();
-               $add = array();
+               # Page links
+               $existing = $this->getExistingLinks();
+               $this->incrTableUpdate( 'pagelinks', 'pl', $this->getLinkDeletions( $existing ), 
+                       $this->getLinkInsertions( $existing ) );
 
-               if( $wgDBtransactions ) {
-                       $sql = "BEGIN";
-                       wfQuery( $sql, DB_WRITE, $fname );
-               }
+               # Template links
+               $existing = $this->getExistingTemplates();
+               $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
+                       $this->getTemplateInsertions( $existing ) );
+
+               # Image links
+               $existing = $this->getExistingImages();
+               $this->incrTableUpdate( 'imagelinks', 'il', $this->getImageDeletions( $existing ),
+                       $this->getImageInsertions( $existing ) );
+
+               # Category links
+               $existing = $this->getExistingCategories();
+               $this->incrTableUpdate( 'categorylinks', 'cl', $this->getCategoryDeletions( $existing ),
+                       $this->getCategoryInsertions( $existing ) );
                
-               #------------------------------------------------------------------------------
-               # Good links
-
-               if ( $wgLinkCache->incrementalSetup( LINKCACHE_GOOD, $del, $add ) ) {
-                       # Delete where necessary
-                       if ( count( $del ) ) {
-                               $sql = "DELETE FROM links WHERE l_from='{$this->mTitleEnc}' AND l_to IN(".
-                                       implode( ",", $del ) . ")";
-                               wfQuery( $sql, DB_WRITE, $fname );
-                       }
-               } else {
-                       # Delete everything
-                       $sql = "DELETE FROM links WHERE l_from='{$this->mTitleEnc}'";
-                       wfQuery( $sql, DB_WRITE, $fname );
-                       
-                       # Get the addition list
-                       $add = $wgLinkCache->getGoodLinks();
-               }
+               # I think this works out to a set XOR operation, the idea is to invalidate all
+               # categories which were added, deleted or changed
+               # FIXME: surely there's a more appropriate place to put this update?
+               $categoryUpdates = array_diff_assoc( $existing, $this->mCategories ) + array_diff_assoc( $this->mCategories, $existing );
+               $this->invalidateCategories( $categoryUpdates );
+               
+               wfProfileOut( $fname );
+       }
 
-               # Do the insertion
-               $sql = "";
-               if ( 0 != count( $add ) ) {
-                       $sql = "INSERT INTO links (l_from,l_to) VALUES ";
-                       $first = true;
-                       foreach( $add as $lt => $lid ) {
-                               
-                               if ( ! $first ) { $sql .= ","; }
-                               $first = false;
+       /**
+         * Link update which clears the previous entries and inserts new ones
+         * 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() {
+               $fname = 'LinksUpdate::doDumbUpdate';
+               wfProfileIn( $fname );
 
-                               $sql .= "('{$this->mTitleEnc}',{$lid})";
-                       }
+               $existing = $this->getExistingCategories();
+               $categoryUpdates = array_diff_assoc( $existing, $this->mCategories ) + array_diff_assoc( $this->mCategories, $existing );
+               
+               $this->dumbTableUpdate( 'pagelinks',     $this->getLinkInsertions(),     'pl_from' );
+               $this->dumbTableUpdate( 'imagelinks',    $this->getImageInsertions(),    'il_from' );
+               $this->dumbTableUpdate( 'categorylinks', $this->getCategoryInsertions(), 'cl_from' );
+               $this->dumbTableUpdate( 'templatelinks', $this->getTemplateInsertions(), 'tl_from' );
+
+               # Update the cache of all the category pages
+               $this->invalidateCategories( $categoryUpdates );
+               
+               wfProfileOut( $fname );
+       }
+
+       function invalidateCategories( $cats ) {
+               $fname = 'LinksUpdate::invalidateCategories';
+               if ( count( $cats ) ) {
+                       $this->mDb->update( 'page', array( 'page_touched' => $this->mDb->timestamp() ), 
+                               array(
+                                       'page_namespace' => NS_CATEGORY,
+                                       'page_title IN (' . $this->mDb->makeList( array_keys( $cats ) ) . ')'
+                               ), $fname 
+                       );
                }
-               if ( "" != $sql ) { 
-                       wfQuery( $sql, DB_WRITE, $fname ); 
+       }       
+
+       function dumbTableUpdate( $table, $insertions, $fromField ) {
+               $fname = 'LinksUpdate::dumbTableUpdate';
+               $this->mDb->delete( $table, array( $fromField => $this->mId ), $fname );
+               if ( count( $insertions ) ) {
+                       # The link array was constructed without FOR UPDATE, so there may be collisions
+                       # Ignoring for now, I'm not sure if that causes problems or not, but I'm fairly
+                       # sure it's better than without IGNORE
+                       $this->mDb->insert( $table, $insertions, $fname, array( 'IGNORE' ) );
                }
+       }
 
-               #------------------------------------------------------------------------------
-               # Bad links
+       /**
+        * 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 );
+       }
 
-               if ( $wgLinkCache->incrementalSetup( LINKCACHE_BAD, $del, $add ) ) {
-                       # Delete where necessary
-                       if ( count( $del ) ) {
-                               $sql = "DELETE FROM brokenlinks WHERE bl_from={$this->mId} AND bl_to IN('" .    
-                                       implode( "','", $del ) . "')";
-                               wfQuery( $sql, DB_WRITE, $fname );
+       /**
+        * Update a table by doing a delete query then an insert query
+        * @private
+        */
+       function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
+               $fname = 'LinksUpdate::incrTableUpdate';
+               $where = array( "{$prefix}_from" => $this->mId );
+               if ( $table == 'pagelinks' || $table == 'templatelinks' ) {
+                       $clause = $this->makeWhereFrom2d( $deletions, $prefix );
+                       if ( $clause ) {
+                               $where[] = $clause;
+                       } else {
+                               $where = false;
                        }
                } else {
-                       # Delete all
-                       $sql = "DELETE FROM brokenlinks WHERE bl_from={$this->mId}";
-                       wfQuery( $sql, DB_WRITE, $fname );
-                       
-                       # Get addition list
-                       $add = $wgLinkCache->getBadLinks();
+                       if ( count( $deletions ) ) {
+                               $where[] = "{$prefix}_to IN (" . $this->mDb->makeList( array_keys( $deletions ) ) . ')';
+                       } else {
+                               $where = false;
+                       }
+               }
+               if ( $where ) {
+                       $this->mDb->delete( $table, $where, $fname );
                }
+               if ( count( $insertions ) ) {
+                       $this->mDb->insert( $table, $insertions, $fname, 'IGNORE' );
+               }
+       }
 
-               # Do additions
-               $sql = "";
-               if ( 0 != count ( $add ) ) {
-                       $sql = "INSERT INTO brokenlinks (bl_from,bl_to) VALUES ";
-                       $first = true;
-                       foreach( $add as $blt ) {
-                               $blt = wfStrencode( $blt );
-                               if ( ! $first ) { $sql .= ","; }
-                               $first = false;
 
-                               $sql .= "({$this->mId},'{$blt}')";
+       /**
+        * Get an array of pagelinks insertions for passing to the DB
+        * Skips the titles specified by the 2-D array $existing
+        * @private
+        */
+       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;
+                       foreach ( $diffs as $dbk => $id ) {
+                               $arr[] = array(
+                                       'pl_from'      => $this->mId,
+                                       'pl_namespace' => $ns,
+                                       'pl_title'     => $dbk 
+                               );
                        }
                }
-               if ( "" != $sql ) { 
-                       wfQuery( $sql, DB_WRITE, $fname );
-               }
+               return $arr;
+       }
 
-               #------------------------------------------------------------------------------
-               # Image links
-               $sql = "DELETE FROM imagelinks WHERE il_from='{$this->mTitleEnc}'";
-               wfQuery( $sql, DB_WRITE, $fname );
-               
-               # Get addition list
-               $add = $wgLinkCache->getImageLinks();
-               
-               # Do the insertion
-               $sql = "";
-               $image = Namespace::getImage();
-               if ( 0 != count ( $add ) ) {
-                       $sql = "INSERT INTO imagelinks (il_from,il_to) VALUES ";
-                       $first = true;
-                       foreach( $add as $iname => $val ) {
-                               # FIXME: Change all this to avoid unnecessary duplication
-                               $nt = Title::makeTitle( $image, $iname );
-                               $nt->invalidateCache();
-
-                               $iname = wfStrencode( $iname );
-                               if ( ! $first ) { $sql .= ","; }
-                               $first = false;
-
-                               $sql .= "('{$this->mTitleEnc}','{$iname}')";
+       /**
+        * Get an array of template insertions. Like getLinkInsertions()
+        * @private
+        */
+       function getTemplateInsertions( $existing = array() ) {
+               $arr = array();
+               foreach( $this->mTemplates as $ns => $dbkeys ) {
+                       $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
+                       foreach ( $diffs as $dbk => $id ) {
+                               $arr[] = array(
+                                       'tl_from'      => $this->mId,
+                                       'tl_namespace' => $ns,
+                                       'tl_title'     => $dbk 
+                               );
                        }
                }
-               if ( "" != $sql ) { wfQuery( $sql, DB_WRITE, $fname ); }
-
-               $this->fixBrokenLinks();
+               return $arr;
+       }
 
-               if( $wgDBtransactions ) {
-                       $sql = "COMMIT";
-                       wfQuery( $sql, DB_WRITE, $fname );
+       /**
+        * Get an array of image insertions
+        * Skips the names specified in $existing
+        * @private
+        */
+       function getImageInsertions( $existing = array() ) {
+               $arr = array();
+               $diffs = array_diff_key( $this->mImages, $existing );
+               foreach( $diffs as $iname => $val ) {
+                       $arr[] = array(
+                               'il_from' => $this->mId,
+                               'il_to'   => $iname
+                       );
                }
-               wfProfileOut( $fname );
+               return $arr;
        }
 
-       function doDumbUpdate()
-       {
-               # Old update function. This can probably be removed eventually, if the new one
-               # proves to be stable
-               global $wgLinkCache, $wgDBtransactions;
-               $fname = "LinksUpdate::doDumbUpdate";
-               wfProfileIn( $fname );
-
-               if( $wgDBtransactions ) {
-                       $sql = "BEGIN";
-                       wfQuery( $sql, DB_WRITE, $fname );
+       /**
+        * Get an array of category insertions
+        * @param array $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() ) {
+               $diffs = array_diff_assoc( $this->mCategories, $existing );
+               $arr = array();
+               foreach ( $diffs as $name => $sortkey ) {
+                       $arr[] = array(
+                               'cl_from'    => $this->mId,
+                               'cl_to'      => $name,
+                               'cl_sortkey' => $sortkey
+                       );
                }
-               
-               $sql = "DELETE FROM links WHERE l_from='{$this->mTitleEnc}'";
-               wfQuery( $sql, DB_WRITE, $fname );
-
-               $a = $wgLinkCache->getGoodLinks();
-               $sql = "";
-               if ( 0 != count( $a ) ) {
-                       $sql = "INSERT INTO links (l_from,l_to) VALUES ";
-                       $first = true;
-                       foreach( $a as $lt => $lid ) {
-                               if ( ! $first ) { $sql .= ","; }
-                               $first = false;
-
-                               $sql .= "('{$this->mTitleEnc}',{$lid})";
+               return $arr;
+       }
+
+       /**
+        * Given an array of existing links, returns those links which are not in $this
+        * and thus should be deleted.
+        * @private
+        */
+       function getLinkDeletions( $existing ) {
+               $del = array();
+               foreach ( $existing as $ns => $dbkeys ) {
+                       if ( isset( $this->mLinks[$ns] ) ) {
+                               $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
+                       } else {
+                               $del[$ns] = $existing[$ns];
                        }
                }
-               if ( "" != $sql ) { wfQuery( $sql, DB_WRITE, $fname ); }
+               return $del;
+       }
 
-               $sql = "DELETE FROM brokenlinks WHERE bl_from={$this->mId}";
-               wfQuery( $sql, DB_WRITE, $fname );
+       /**
+        * Given an array of existing templates, returns those templates which are not in $this
+        * and thus should be deleted.
+        * @private
+        */
+       function getTemplateDeletions( $existing ) {
+               $del = array();
+               foreach ( $existing as $ns => $dbkeys ) {
+                       if ( isset( $this->mTemplates[$ns] ) ) {
+                               $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
+                       } else {
+                               $del[$ns] = $existing[$ns];
+                       }
+               }
+               return $del;
+       }
 
-               $a = $wgLinkCache->getBadLinks();
-               $sql = "";
-               if ( 0 != count ( $a ) ) {
-                       $sql = "INSERT INTO brokenlinks (bl_from,bl_to) VALUES ";
-                       $first = true;
-                       foreach( $a as $blt ) {
-                               $blt = wfStrencode( $blt );
-                               if ( ! $first ) { $sql .= ","; }
-                               $first = false;
+       /**
+        * Given an array of existing images, returns those images which are not in $this
+        * and thus should be deleted.
+        * @private
+        */
+       function getImageDeletions( $existing ) {
+               return array_diff_key( $existing, $this->mImages );
+       }
+       
+       /**
+        * Given an array of existing categories, returns those categories which are not in $this
+        * and thus should be deleted.
+        * @private
+        */
+       function getCategoryDeletions( $existing ) {
+               return array_diff_assoc( $existing, $this->mCategories );
+       }
 
-                               $sql .= "({$this->mId},'{$blt}')";
+       /**
+        * Get an array of existing links, as a 2-D array
+        * @private
+        */
+       function getExistingLinks() {
+               $fname = 'LinksUpdate::getExistingLinks';
+               $res = $this->mDb->select( 'pagelinks', array( 'pl_namespace', 'pl_title' ), 
+                       array( 'pl_from' => $this->mId ), $fname, $this->mOptions );
+               $arr = array();
+               while ( $row = $this->mDb->fetchObject( $res ) ) {
+                       if ( !isset( $arr[$row->pl_namespace] ) ) {
+                               $arr[$row->pl_namespace] = array();
                        }
+                       $arr[$row->pl_namespace][$row->pl_title] = 1;
                }
-               if ( "" != $sql ) { wfQuery( $sql, DB_WRITE, $fname ); }
-               
-               $sql = "DELETE FROM imagelinks WHERE il_from='{$this->mTitleEnc}'";
-               wfQuery( $sql, DB_WRITE, $fname );
-
-               $a = $wgLinkCache->getImageLinks();
-               $sql = "";
-               if ( 0 != count ( $a ) ) {
-                       $sql = "INSERT INTO imagelinks (il_from,il_to) VALUES ";
-                       $first = true;
-                       foreach( $a as $iname => $val ) {
-                               $iname = wfStrencode( $iname );
-                               if ( ! $first ) { $sql .= ","; }
-                               $first = false;
-
-                               $sql .= "('{$this->mTitleEnc}','{$iname}')";
+               return $arr;
+       }
+
+       /**
+        * Get an array of existing templates, as a 2-D array
+        * @private
+        */
+       function getExistingTemplates() {
+               $fname = 'LinksUpdate::getExistingTemplates';
+               $res = $this->mDb->select( 'templatelinks', array( 'tl_namespace', 'tl_title' ), 
+                       array( 'tl_from' => $this->mId ), $fname, $this->mOptions );
+               $arr = array();
+               while ( $row = $this->mDb->fetchObject( $res ) ) {
+                       if ( !isset( $arr[$row->tl_namespace] ) ) {
+                               $arr[$row->tl_namespace] = array();
                        }
+                       $arr[$row->tl_namespace][$row->tl_title] = 1;
                }
-               if ( "" != $sql ) { wfQuery( $sql, DB_WRITE, $fname ); }
-
-               $this->fixBrokenLinks();
+               return $arr;
+       }
 
-               if( $wgDBtransactions ) {
-                       $sql = "COMMIT";
-                       wfQuery( $sql, DB_WRITE, $fname );
+       /**
+        * Get an array of existing images, image names in the keys
+        * @private
+        */
+       function getExistingImages() {
+               $fname = 'LinksUpdate::getExistingImages';
+               $res = $this->mDb->select( 'imagelinks', array( 'il_to' ), 
+                       array( 'il_from' => $this->mId ), $fname, $this->mOptions );
+               $arr = array();
+               while ( $row = $this->mDb->fetchObject( $res ) ) {
+                       $arr[$row->il_to] = 1;
                }
-               wfProfileOut( $fname );
+               return $arr;
        }
-       
-       function fixBrokenLinks() {
-               /* Update any brokenlinks *to* this page */
-               /* Call for a newly created page, or just to make sure state is consistent */
-               
-               $sql = "SELECT bl_from FROM brokenlinks WHERE bl_to='{$this->mTitleEnc}'";
-               $res = wfQuery( $sql, DB_READ, $fname );
-               if ( 0 == wfNumRows( $res ) ) { return; }
 
-               $sql = "INSERT INTO links (l_from,l_to) VALUES ";
-               $now = wfTimestampNow();
-               $sql2 = "UPDATE cur SET cur_touched='{$now}' WHERE cur_id IN (";
-               $first = true;
-               while ( $row = wfFetchObject( $res ) ) {
-                       if ( ! $first ) { $sql .= ","; $sql2 .= ","; }
-                       $first = false;
-                       $nl = wfStrencode( Title::nameOf( $row->bl_from ) );
-
-                       $sql .= "('{$nl}',{$this->mId})";
-                       $sql2 .= $row->bl_from;
+       /**
+        * Get an array of existing categories, with the name in the key and sort key in the value.
+        * @private
+        */
+       function getExistingCategories() {
+               $fname = 'LinksUpdate::getExistingCategories';
+               $res = $this->mDb->select( 'categorylinks', array( 'cl_to', 'cl_sortkey' ),
+                       array( 'cl_from' => $this->mId ), $fname, $this->mOptions );
+               $arr = array();
+               while ( $row = $this->mDb->fetchObject( $res ) ) {
+                       $arr[$row->cl_to] = $row->cl_sortkey;
                }
-               $sql2 .= ")";
-               wfQuery( $sql, DB_WRITE, $fname );
-               wfQuery( $sql2, DB_WRITE, $fname );
-
-               $sql = "DELETE FROM brokenlinks WHERE bl_to='{$this->mTitleEnc}'";
-               wfQuery( $sql, DB_WRITE, $fname );
+               return $arr;
        }
-       
 }
-
 ?>