MediaWiki  master
updateSearchIndex.php
Go to the documentation of this file.
1 <?php
31 require_once __DIR__ . '/Maintenance.php';
32 
39 
40  public function __construct() {
41  parent::__construct();
42  $this->addDescription( 'Script for periodic off-peak updating of the search index' );
43  $this->addOption( 's', 'starting timestamp', false, true );
44  $this->addOption( 'e', 'Ending timestamp', false, true );
45  $this->addOption(
46  'p',
47  'File for saving/loading timestamps, searchUpdate.WIKI_ID.pos by default',
48  false,
49  true
50  );
51  $this->addOption(
52  'l',
53  'How long the searchindex and revision tables will be locked for',
54  false,
55  true
56  );
57  }
58 
59  public function getDbType() {
60  return Maintenance::DB_ADMIN;
61  }
62 
63  public function execute() {
64  $dbDomain = WikiMap::getCurrentWikiDbDomain()->getId();
65  $posFile = $this->getOption( 'p', 'searchUpdate.' . rawurlencode( $dbDomain ) . '.pos' );
66  $end = $this->getOption( 'e', wfTimestampNow() );
67  if ( $this->hasOption( 's' ) ) {
68  $start = $this->getOption( 's' );
69  } elseif ( is_readable( 'searchUpdate.pos' ) ) {
70  # B/c to the old position file name which was hardcoded
71  # We can safely delete the file when we're done though.
72  $start = file_get_contents( 'searchUpdate.pos' );
73  unlink( 'searchUpdate.pos' );
74  } elseif ( is_readable( $posFile ) ) {
75  $start = file_get_contents( $posFile );
76  } else {
77  $start = wfTimestamp( TS_MW, time() - 86400 );
78  }
79  $lockTime = $this->getOption( 'l', 20 );
80 
81  $this->doUpdateSearchIndex( $start, $end, $lockTime );
82  if ( is_writable( dirname( realpath( $posFile ) ) ) ) {
83  $file = fopen( $posFile, 'w' );
84  if ( $file !== false ) {
85  fwrite( $file, $end );
86  fclose( $file );
87  } else {
88  $this->error( "*** Couldn't write to the $posFile!\n" );
89  }
90  } else {
91  $this->error( "*** Couldn't write to the $posFile!\n" );
92  }
93  }
94 
95  private function doUpdateSearchIndex( $start, $end, $maxLockTime ) {
97 
98  $wgDisableSearchUpdate = false;
99 
100  $dbw = $this->getDB( DB_MASTER );
101  $recentchanges = $dbw->tableName( 'recentchanges' );
102 
103  $this->output( "Updating searchindex between $start and $end\n" );
104 
105  # Select entries from recentchanges which are on top and between the specified times
106  $start = $dbw->timestamp( $start );
107  $end = $dbw->timestamp( $end );
108 
109  $page = $dbw->tableName( 'page' );
110  $sql = "SELECT rc_cur_id FROM $recentchanges
111  JOIN $page ON rc_cur_id=page_id AND rc_this_oldid=page_latest
112  WHERE rc_type != " . RC_LOG . " AND rc_timestamp BETWEEN '$start' AND '$end'";
113  $res = $dbw->query( $sql, __METHOD__ );
114 
115  $this->updateSearchIndex( $maxLockTime, [ $this, 'searchIndexUpdateCallback' ], $dbw, $res );
116 
117  $this->output( "Done\n" );
118  }
119 
120  public function searchIndexUpdateCallback( $dbw, $row ) {
121  $this->updateSearchIndexForPage( $dbw, $row->rc_cur_id );
122  }
123 }
124 
126 require_once RUN_MAINTENANCE_IF_MAIN;
searchIndexUpdateCallback( $dbw, $row)
error( $err, $die=0)
Throw an error to the user.
getOption( $name, $default=null)
Get an option, or return the default.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
updateSearchIndex( $maxLockTime, $callback, $dbw, $results)
Perform a search index update with locking.
Maintenance script for periodic off-peak updating of the search index.
updateSearchIndexForPage( $dbw, $pageId)
Update the searchindex table for a given pageid.
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
const DB_MASTER
Definition: defines.php:26
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$res
Definition: database.txt:21
addDescription( $text)
Set the description text.
const DB_ADMIN
Definition: Maintenance.php:87
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
output( $out, $channel=null)
Throw some output to the user.
static getCurrentWikiDbDomain()
Definition: WikiMap.php:293
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
doUpdateSearchIndex( $start, $end, $maxLockTime)
$wgDisableSearchUpdate
If you&#39;ve disabled search semi-permanently, this also disables updates to the table.
const RC_LOG
Definition: Defines.php:124