MediaWiki REL1_30
updateSearchIndex.php
Go to the documentation of this file.
1<?php
31require_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() {
61 }
62
63 public function execute() {
64 $posFile = $this->getOption( 'p', 'searchUpdate.' . wfWikiID() . '.pos' );
65 $end = $this->getOption( 'e', wfTimestampNow() );
66 if ( $this->hasOption( 's' ) ) {
67 $start = $this->getOption( 's' );
68 } elseif ( is_readable( 'searchUpdate.pos' ) ) {
69 # B/c to the old position file name which was hardcoded
70 # We can safely delete the file when we're done though.
71 $start = file_get_contents( 'searchUpdate.pos' );
72 unlink( 'searchUpdate.pos' );
73 } elseif ( is_readable( $posFile ) ) {
74 $start = file_get_contents( $posFile );
75 } else {
76 $start = wfTimestamp( TS_MW, time() - 86400 );
77 }
78 $lockTime = $this->getOption( 'l', 20 );
79
80 $this->doUpdateSearchIndex( $start, $end, $lockTime );
81 if ( is_writable( dirname( realpath( $posFile ) ) ) ) {
82 $file = fopen( $posFile, 'w' );
83 if ( $file !== false ) {
84 fwrite( $file, $end );
85 fclose( $file );
86 } else {
87 $this->error( "*** Couldn't write to the $posFile!\n" );
88 }
89 } else {
90 $this->error( "*** Couldn't write to the $posFile!\n" );
91 }
92 }
93
94 private function doUpdateSearchIndex( $start, $end, $maxLockTime ) {
96
98
99 $dbw = $this->getDB( DB_MASTER );
100 $recentchanges = $dbw->tableName( 'recentchanges' );
101
102 $this->output( "Updating searchindex between $start and $end\n" );
103
104 # Select entries from recentchanges which are on top and between the specified times
105 $start = $dbw->timestamp( $start );
106 $end = $dbw->timestamp( $end );
107
108 $page = $dbw->tableName( 'page' );
109 $sql = "SELECT rc_cur_id FROM $recentchanges
110 JOIN $page ON rc_cur_id=page_id AND rc_this_oldid=page_latest
111 WHERE rc_type != " . RC_LOG . " AND rc_timestamp BETWEEN '$start' AND '$end'";
112 $res = $dbw->query( $sql, __METHOD__ );
113
114 $this->updateSearchIndex( $maxLockTime, [ $this, 'searchIndexUpdateCallback' ], $dbw, $res );
115
116 $this->output( "Done\n" );
117 }
118
119 public function searchIndexUpdateCallback( $dbw, $row ) {
120 $this->updateSearchIndexForPage( $dbw, $row->rc_cur_id );
121 }
122}
123
124$maintClass = "UpdateSearchIndex";
125require_once RUN_MAINTENANCE_IF_MAIN;
$wgDisableSearchUpdate
If you've disabled search semi-permanently, this also disables updates to the table.
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.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
updateSearchIndexForPage( $dbw, $pageId)
Update the searchindex table for a given pageid.
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.
updateSearchIndex( $maxLockTime, $callback, $dbw, $results)
Perform a search index update with locking.
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.
doUpdateSearchIndex( $start, $end, $maxLockTime)
__construct()
Default constructor.
searchIndexUpdateCallback( $dbw, $row)
$res
Definition database.txt:21
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2581
const RC_LOG
Definition Defines.php:145
require_once RUN_MAINTENANCE_IF_MAIN
const DB_MASTER
Definition defines.php:26