6de3ced6269c89fa0d371f528797a5d756fe9ebd
3 * Script for periodic off-peak updating of the search index
5 * Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
6 * Where START is the starting timestamp
7 * END is the ending timestamp
8 * POSFILE is a file to load timestamps from and save them to, searchUpdate.WIKI_ID.pos by default
9 * LOCKTIME is how long the searchindex and revision tables will be locked for
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
28 * @ingroup Maintenance
31 require_once( dirname( __FILE__
) . '/Maintenance.php' );
33 class UpdateSearchIndex
extends Maintenance
{
35 public function __construct() {
36 parent
::__construct();
37 $this->mDescription
= "Script for periodic off-peak updating of the search index";
38 $this->addOption( 's', 'starting timestamp', false, true );
39 $this->addOption( 'e', 'Ending timestamp', false, true );
40 $this->addOption( 'p', 'File for saving/loading timestamps, searchUpdate.WIKI_ID.pos by default', false, true );
41 $this->addOption( 'l', 'How long the searchindex and revision tables will be locked for', false, true );
44 public function getDbType() {
45 return Maintenance
::DB_ADMIN
;
48 public function execute() {
49 $posFile = $this->getOption( 'p', 'searchUpdate.' . wfWikiId() . '.pos' );
50 $end = $this->getOption( 'e', wfTimestampNow() );
51 if ( $this->hasOption( 's' ) ) {
52 $start = $this->getOption( 's' );
53 } elseif ( is_readable( 'searchUpdate.pos' ) ) {
54 # B/c to the old position file name which was hardcoded
55 # We can safely delete the file when we're done though.
56 $start = file_get_contents( 'searchUpdate.pos' );
57 unlink( 'searchUpdate.pos' );
59 $start = @file_get_contents
( $posFile );
61 $start = wfTimestamp( TS_MW
, time() - 86400 );
64 $lockTime = $this->getOption( 'l', 20 );
66 $this->doUpdateSearchIndex( $start, $end, $lockTime );
67 if ( is_writable( dirname( realpath( $posFile ) ) ) ) {
68 $file = fopen( $posFile, 'w' );
69 if ( $file !== false ) {
70 fwrite( $file, $end );
73 $this->error( "*** Couldn't write to the $posFile!\n" );
76 $this->error( "*** Couldn't write to the $posFile!\n" );
80 private function doUpdateSearchIndex( $start, $end, $maxLockTime ) {
81 global $wgDisableSearchUpdate;
83 $wgDisableSearchUpdate = false;
85 $dbw = wfGetDB( DB_MASTER
);
86 $recentchanges = $dbw->tableName( 'recentchanges' );
88 $this->output( "Updating searchindex between $start and $end\n" );
90 # Select entries from recentchanges which are on top and between the specified times
91 $start = $dbw->timestamp( $start );
92 $end = $dbw->timestamp( $end );
94 $page = $dbw->tableName( 'page' );
95 $sql = "SELECT rc_cur_id,rc_type,rc_moved_to_ns,rc_moved_to_title FROM $recentchanges
96 JOIN $page ON rc_cur_id=page_id AND rc_this_oldid=page_latest
97 WHERE rc_timestamp BETWEEN '$start' AND '$end'
99 $res = $dbw->query( $sql, __METHOD__
);
101 $this->updateSearchIndex( $maxLockTime, array( $this, 'searchIndexUpdateCallback' ), $dbw, $res );
103 $this->output( "Done\n" );
106 public function searchIndexUpdateCallback( $dbw, $row ) {
107 if ( $row->rc_type
== RC_MOVE ||
$row->rc_type
== RC_MOVE_OVER_REDIRECT
) {
108 # Rename searchindex entry
109 $titleObj = Title
::makeTitle( $row->rc_moved_to_ns
, $row->rc_moved_to_title
);
110 $title = $titleObj->getPrefixedDBkey();
111 $this->output( "$title..." );
112 $u = new SearchUpdate( $row->rc_cur_id
, $title, false );
114 $this->output( "\n" );
115 } elseif ( $row->rc_type
!== RC_LOG
) {
116 $this->updateSearchIndexForPage( $dbw, $row->rc_cur_id
);
121 $maintClass = "UpdateSearchIndex";
122 require_once( DO_MAINTENANCE
);