MediaWiki PHP Cross Reference Collaborative Wikis

Source: /includes/job/jobs/RefreshLinksJob.php - 222 lines - 7358 bytes - Summary - Text - Print

Description: Job to update links for a given title. 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.

   1  <?php
   2  /**
   3   * Job to update links for a given title.
   4   *
   5   * This program is free software; you can redistribute it and/or modify
   6   * it under the terms of the GNU General Public License as published by
   7   * the Free Software Foundation; either version 2 of the License, or
   8   * (at your option) any later version.
   9   *
  10   * This program is distributed in the hope that it will be useful,
  11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13   * GNU General Public License for more details.
  14   *
  15   * You should have received a copy of the GNU General Public License along
  16   * with this program; if not, write to the Free Software Foundation, Inc.,
  17   * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18   * http://www.gnu.org/copyleft/gpl.html
  19   *
  20   * @file
  21   * @ingroup JobQueue
  22   */
  23  
  24  /**
  25   * Background job to update links for a given title.
  26   *
  27   * @ingroup JobQueue
  28   */
  29  class RefreshLinksJob extends Job {
  30  	function __construct( $title, $params = '', $id = 0 ) {
  31          parent::__construct( 'refreshLinks', $title, $params, $id );
  32          $this->removeDuplicates = true; // job is expensive
  33      }
  34  
  35      /**
  36       * Run a refreshLinks job
  37       * @return boolean success
  38       */
  39  	function run() {
  40          $linkCache = LinkCache::singleton();
  41          $linkCache->clear();
  42  
  43          if ( is_null( $this->title ) ) {
  44              $this->error = "refreshLinks: Invalid title";
  45              return false;
  46          }
  47  
  48          # Wait for the DB of the current/next slave DB handle to catch up to the master.
  49          # This way, we get the correct page_latest for templates or files that just changed
  50          # milliseconds ago, having triggered this job to begin with.
  51          if ( isset( $this->params['masterPos'] ) && $this->params['masterPos'] !== false ) {
  52              wfGetLB()->waitFor( $this->params['masterPos'] );
  53          }
  54  
  55          $revision = Revision::newFromTitle( $this->title, false, Revision::READ_NORMAL );
  56          if ( !$revision ) {
  57              $this->error = 'refreshLinks: Article not found "' .
  58                  $this->title->getPrefixedDBkey() . '"';
  59              return false; // XXX: what if it was just deleted?
  60          }
  61  
  62          self::runForTitleInternal( $this->title, $revision, __METHOD__ );
  63  
  64          return true;
  65      }
  66  
  67      /**
  68       * @return Array
  69       */
  70  	public function getDeduplicationInfo() {
  71          $info = parent::getDeduplicationInfo();
  72          // Don't let highly unique "masterPos" values ruin duplicate detection
  73          if ( is_array( $info['params'] ) ) {
  74              unset( $info['params']['masterPos'] );
  75          }
  76          return $info;
  77      }
  78  
  79      /**
  80       * @param $title Title
  81       * @param $revision Revision
  82       * @param $fname string
  83       * @return void
  84       */
  85  	public static function runForTitleInternal( Title $title, Revision $revision, $fname ) {
  86          wfProfileIn( $fname );
  87          $content = $revision->getContent( Revision::RAW );
  88  
  89          if ( !$content ) {
  90              // if there is no content, pretend the content is empty
  91              $content = $revision->getContentHandler()->makeEmptyContent();
  92          }
  93  
  94          // Revision ID must be passed to the parser output to get revision variables correct
  95          $parserOutput = $content->getParserOutput( $title, $revision->getId(), null, false );
  96  
  97          $updates = $content->getSecondaryDataUpdates( $title, null, false, $parserOutput );
  98          DataUpdate::runUpdates( $updates );
  99  
 100          InfoAction::invalidateCache( $title );
 101  
 102          wfProfileOut( $fname );
 103      }
 104  }
 105  
 106  /**
 107   * Background job to update links for a given title.
 108   * Newer version for high use templates.
 109   *
 110   * @ingroup JobQueue
 111   */
 112  class RefreshLinksJob2 extends Job {
 113  	function __construct( $title, $params, $id = 0 ) {
 114          parent::__construct( 'refreshLinks2', $title, $params, $id );
 115          // Base jobs for large templates can easily be de-duplicated
 116          $this->removeDuplicates = !isset( $params['start'] ) && !isset( $params['end'] );
 117      }
 118  
 119      /**
 120       * Run a refreshLinks2 job
 121       * @return boolean success
 122       */
 123  	function run() {
 124          global $wgUpdateRowsPerJob;
 125  
 126          $linkCache = LinkCache::singleton();
 127          $linkCache->clear();
 128  
 129          if ( is_null( $this->title ) ) {
 130              $this->error = "refreshLinks2: Invalid title";
 131              return false;
 132          }
 133  
 134          // Back compat for pre-r94435 jobs
 135          $table = isset( $this->params['table'] ) ? $this->params['table'] : 'templatelinks';
 136  
 137          // Avoid slave lag when fetching templates.
 138          // When the outermost job is run, we know that the caller that enqueued it must have
 139          // committed the relevant changes to the DB by now. At that point, record the master
 140          // position and pass it along as the job recursively breaks into smaller range jobs.
 141          // Hopefully, when leaf jobs are popped, the slaves will have reached that position.
 142          if ( isset( $this->params['masterPos'] ) ) {
 143              $masterPos = $this->params['masterPos'];
 144          } elseif ( wfGetLB()->getServerCount() > 1 ) {
 145              $masterPos = wfGetLB()->getMasterPos();
 146          } else {
 147              $masterPos = false;
 148          }
 149  
 150          $tbc = $this->title->getBacklinkCache();
 151  
 152          $jobs = array(); // jobs to insert
 153          if ( isset( $this->params['start'] ) && isset( $this->params['end'] ) ) {
 154              # This is a partition job to trigger the insertion of leaf jobs...
 155              $jobs = array_merge( $jobs, $this->getSingleTitleJobs( $table, $masterPos ) );
 156          } else {
 157              # This is a base job to trigger the insertion of partitioned jobs...
 158              if ( $tbc->getNumLinks( $table, $wgUpdateRowsPerJob + 1 ) <= $wgUpdateRowsPerJob ) {
 159                  # Just directly insert the single per-title jobs
 160                  $jobs = array_merge( $jobs, $this->getSingleTitleJobs( $table, $masterPos ) );
 161              } else {
 162                  # Insert the partition jobs to make per-title jobs
 163                  foreach ( $tbc->partition( $table, $wgUpdateRowsPerJob ) as $batch ) {
 164                      list( $start, $end ) = $batch;
 165                      $jobs[] = new RefreshLinksJob2( $this->title,
 166                          array(
 167                              'table' => $table,
 168                              'start' => $start,
 169                              'end' => $end,
 170                              'masterPos' => $masterPos,
 171                          ) + $this->getRootJobParams() // carry over information for de-duplication
 172                      );
 173                  }
 174              }
 175          }
 176  
 177          if ( count( $jobs ) ) {
 178              JobQueueGroup::singleton()->push( $jobs );
 179          }
 180  
 181          return true;
 182      }
 183  
 184      /**
 185       * @param $table string
 186       * @param $masterPos mixed
 187       * @return Array
 188       */
 189  	protected function getSingleTitleJobs( $table, $masterPos ) {
 190          # The "start"/"end" fields are not set for the base jobs
 191          $start = isset( $this->params['start'] ) ? $this->params['start'] : false;
 192          $end = isset( $this->params['end'] ) ? $this->params['end'] : false;
 193          $titles = $this->title->getBacklinkCache()->getLinks( $table, $start, $end );
 194          # Convert into single page refresh links jobs.
 195          # This handles well when in sapi mode and is useful in any case for job
 196          # de-duplication. If many pages use template A, and that template itself
 197          # uses template B, then an edit to both will create many duplicate jobs.
 198          # Roughly speaking, for each page, one of the "RefreshLinksJob" jobs will
 199          # get run first, and when it does, it will remove the duplicates. Of course,
 200          # one page could have its job popped when the other page's job is still
 201          # buried within the logic of a refreshLinks2 job.
 202          $jobs = array();
 203          foreach ( $titles as $title ) {
 204              $jobs[] = new RefreshLinksJob( $title,
 205                  array( 'masterPos' => $masterPos ) + $this->getRootJobParams()
 206              ); // carry over information for de-duplication
 207          }
 208          return $jobs;
 209      }
 210  
 211      /**
 212       * @return Array
 213       */
 214  	public function getDeduplicationInfo() {
 215          $info = parent::getDeduplicationInfo();
 216          // Don't let highly unique "masterPos" values ruin duplicate detection
 217          if ( is_array( $info['params'] ) ) {
 218              unset( $info['params']['masterPos'] );
 219          }
 220          return $info;
 221      }
 222  }

title

Description

title

Description

title

Description

title

title

Body