includes/job/RefreshLinksJob.php

   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
  31         function __construct( $title, $params = '', $id = 0 ) {
  32                 parent::__construct( 'refreshLinks', $title, $params, $id );
  33         }
  34
  35         /**
  36          * Run a refreshLinks job
  37          * @return boolean success
  38          */
  39         function run() {
  40                 global $wgParser, $wgContLang;
  41                 wfProfileIn( __METHOD__ );
  42
  43                 $linkCache = LinkCache::singleton();
  44                 $linkCache->clear();
  45
  46                 if ( is_null( $this->title ) ) {
  47                         $this->error = "refreshLinks: Invalid title";
  48                         wfProfileOut( __METHOD__ );
  49                         return false;
  50                 }
  51
  52                 $revision = Revision::newFromTitle( $this->title );
  53                 if ( !$revision ) {
  54                         $this->error = 'refreshLinks: Article not found "' . $this->title->getPrefixedDBkey() . '"';
  55                         wfProfileOut( __METHOD__ );
  56                         return false;
  57                 }
  58
  59                 wfProfileIn( __METHOD__.'-parse' );
  60                 $options = ParserOptions::newFromUserAndLang( new User, $wgContLang );
  61                 $parserOutput = $wgParser->parse( $revision->getText(), $this->title, $options, true, true, $revision->getId() );
  62                 wfProfileOut( __METHOD__.'-parse' );
  63                 wfProfileIn( __METHOD__.'-update' );
  64                 $update = new LinksUpdate( $this->title, $parserOutput, false );
  65                 $update->doUpdate();
  66                 wfProfileOut( __METHOD__.'-update' );
  67                 wfProfileOut( __METHOD__ );
  68                 return true;
  69         }
  70 }
  71
  72 /**
  73  * Background job to update links for a given title.
  74  * Newer version for high use templates.
  75  *
  76  * @ingroup JobQueue
  77  */
  78 class RefreshLinksJob2 extends Job {
  79
  80         function __construct( $title, $params, $id = 0 ) {
  81                 parent::__construct( 'refreshLinks2', $title, $params, $id );
  82         }
  83
  84         /**
  85          * Run a refreshLinks2 job
  86          * @return boolean success
  87          */
  88         function run() {
  89                 global $wgParser, $wgContLang;
  90
  91                 wfProfileIn( __METHOD__ );
  92
  93                 $linkCache = LinkCache::singleton();
  94                 $linkCache->clear();
  95
  96                 if( is_null( $this->title ) ) {
  97                         $this->error = "refreshLinks2: Invalid title";
  98                         wfProfileOut( __METHOD__ );
  99                         return false;
 100                 }
 101                 if( !isset($this->params['start']) || !isset($this->params['end']) ) {
 102                         $this->error = "refreshLinks2: Invalid params";
 103                         wfProfileOut( __METHOD__ );
 104                         return false;
 105                 }
 106                 // Back compat for pre-r94435 jobs
 107                 $table = isset( $this->params['table'] ) ? $this->params['table'] : 'templatelinks';
 108                 $titles = $this->title->getBacklinkCache()->getLinks(
 109                         $table, $this->params['start'], $this->params['end']);
 110
 111                 # Not suitable for page load triggered job running!
 112                 # Gracefully switch to refreshLinks jobs if this happens.
 113                 if( php_sapi_name() != 'cli' ) {
 114                         $jobs = array();
 115                         foreach ( $titles as $title ) {
 116                                 $jobs[] = new RefreshLinksJob( $title, '' );
 117                         }
 118                         Job::batchInsert( $jobs );
 119
 120                         wfProfileOut( __METHOD__ );
 121                         return true;
 122                 }
 123                 $options = ParserOptions::newFromUserAndLang( new User, $wgContLang );
 124                 # Re-parse each page that transcludes this page and update their tracking links...
 125                 foreach ( $titles as $title ) {
 126                         $revision = Revision::newFromTitle( $title );
 127                         if ( !$revision ) {
 128                                 $this->error = 'refreshLinks: Article not found "' . $title->getPrefixedDBkey() . '"';
 129                                 wfProfileOut( __METHOD__ );
 130                                 return false;
 131                         }
 132                         wfProfileIn( __METHOD__.'-parse' );
 133                         $parserOutput = $wgParser->parse( $revision->getText(), $title, $options, true, true, $revision->getId() );
 134                         wfProfileOut( __METHOD__.'-parse' );
 135                         wfProfileIn( __METHOD__.'-update' );
 136                         $update = new LinksUpdate( $title, $parserOutput, false );
 137                         $update->doUpdate();
 138                         wfProfileOut( __METHOD__.'-update' );
 139                         wfWaitForSlaves();
 140                 }
 141                 wfProfileOut( __METHOD__ );
 142
 143                 return true;
 144         }
 145 }