MediaWiki master
updateSearchIndex.php
Go to the documentation of this file.
1<?php
35
36require_once __DIR__ . '/Maintenance.php';
37
44
45 public function __construct() {
46 parent::__construct();
47 $this->addDescription( 'Script for periodic off-peak updating of the search index' );
48 $this->addOption( 's', 'Starting timestamp', false, true );
49 $this->addOption( 'e', 'Ending timestamp', false, true );
50 $this->addOption(
51 'p',
52 'File for saving/loading timestamps, searchUpdate.WIKI_ID.pos by default',
53 false,
54 true
55 );
56 $this->addOption(
57 'l',
58 'Deprecated, has no effect (formerly lock time)',
59 false,
60 true
61 );
62 }
63
64 public function getDbType() {
66 }
67
68 public function execute() {
69 $dbDomain = WikiMap::getCurrentWikiDbDomain()->getId();
70 $posFile = $this->getOption( 'p', 'searchUpdate.' . rawurlencode( $dbDomain ) . '.pos' );
71 $end = $this->getOption( 'e', wfTimestampNow() );
72 if ( $this->hasOption( 's' ) ) {
73 $start = $this->getOption( 's' );
74 } elseif ( is_readable( $posFile ) ) {
75 $start = file_get_contents( $posFile );
76 } else {
77 $start = wfTimestamp( TS_MW, time() - 86400 );
78 }
79
80 $this->doUpdateSearchIndex( $start, $end );
81 $file = fopen( $posFile, 'w' );
82 if ( $file !== false ) {
83 fwrite( $file, $end );
84 fclose( $file );
85 } else {
86 $this->error( "*** Couldn't write to the $posFile!\n" );
87 }
88 }
89
90 private function doUpdateSearchIndex( $start, $end ) {
92
94
95 $dbw = $this->getPrimaryDB();
96
97 $this->output( "Updating searchindex between $start and $end\n" );
98
99 # Select entries from recentchanges which are on top and between the specified times
100 $start = $dbw->timestamp( $start );
101 $end = $dbw->timestamp( $end );
102
103 $res = $dbw->newSelectQueryBuilder()
104 ->select( 'rc_cur_id' )
105 ->from( 'recentchanges' )
106 ->join( 'page', null, 'rc_cur_id=page_id AND rc_this_oldid=page_latest' )
107 ->where( [
108 $dbw->expr( 'rc_type', '!=', RC_LOG ),
109 'rc_timestamp BETWEEN ' . $dbw->addQuotes( $start ) . ' AND ' . $dbw->addQuotes( $end )
110 ] )
111 ->caller( __METHOD__ )->fetchResultSet();
112
113 foreach ( $res as $row ) {
114 $this->updateSearchIndexForPage( (int)$row->rc_cur_id );
115 }
116 $this->output( "Done\n" );
117 }
118
124 private function updateSearchIndexForPage( int $pageId ) {
125 // Get current revision
126 $rev = $this->getServiceContainer()
127 ->getRevisionLookup()
128 ->getRevisionByPageId( $pageId, 0, IDBAccessObject::READ_LATEST );
129 $title = null;
130 if ( $rev ) {
131 $titleObj = Title::newFromLinkTarget( $rev->getPageAsLinkTarget() );
132 $title = $titleObj->getPrefixedDBkey();
133 $this->output( "$title..." );
134 # Update searchindex
135 $u = new SearchUpdate( $pageId, $titleObj, $rev->getContent( SlotRecord::MAIN ) );
136 $u->doUpdate();
137 $this->output( "\n" );
138 }
139
140 return $title;
141 }
142}
143
144$maintClass = UpdateSearchIndex::class;
145require_once RUN_MAINTENANCE_IF_MAIN;
const RC_LOG
Definition Defines.php:118
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
hasOption( $name)
Checks to see if a particular option was set.
getServiceContainer()
Returns the main service container.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
Database independent search index updater.
Value object representing a content slot associated with a page revision.
Represents a title within MediaWiki.
Definition Title.php:78
Tools for dealing with other locally-hosted wikis.
Definition WikiMap.php:31
Maintenance script for periodic off-peak updating of the search index.
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
execute()
Do the actual work.
__construct()
Default constructor.
$wgDisableSearchUpdate
Config variable stub for the DisableSearchUpdate setting, for use by phpdoc and IDEs.