Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
4.35% covered (danger)
4.35%
1 / 23
33.33% covered (danger)
33.33%
1 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
MassIndex
4.35% covered (danger)
4.35%
1 / 23
33.33% covered (danger)
33.33%
1 / 3
37.51
0.00% covered (danger)
0.00%
0 / 1
 build
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
6
 doJob
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
12
 workItemCount
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3namespace CirrusSearch\Job;
4
5use CirrusSearch\Updater;
6use MediaWiki\Logger\LoggerFactory;
7use MediaWiki\MediaWikiServices;
8use Title;
9use WikiPage;
10
11/**
12 * Job wrapper around Updater::updatePages.  Used by forceSearchIndex.php
13 * when in job queueing mode.
14 *
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
19 *
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * You should have received a copy of the GNU General Public License along
26 * with this program; if not, write to the Free Software Foundation, Inc.,
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 * http://www.gnu.org/copyleft/gpl.html
29 */
30class MassIndex extends CirrusGenericJob {
31    /**
32     * @param WikiPage[] $pages
33     * @param int $updateFlags
34     * @param string|null $cluster
35     * @return MassIndex
36     */
37    public static function build( array $pages, $updateFlags, $cluster = null ) {
38        // Strip $pages down to PrefixedDBKeys so we don't put a ton of stuff in the job queue.
39        $pageDBKeys = [];
40        foreach ( $pages as $page ) {
41            $pageDBKeys[] = $page->getTitle()->getPrefixedDBkey();
42        }
43
44        // We don't have a "title" for this job so we use the Main Page because it exists.
45        return new self( [
46            'pageDBKeys' => $pageDBKeys,
47            'updateFlags' => $updateFlags,
48            'cluster' => $cluster,
49        ] );
50    }
51
52    /**
53     * @return bool
54     * @throws \MWException
55     */
56    protected function doJob() {
57        // Reload pages from pageIds to throw into the updater
58        $pageData = [];
59        $wikiPageFactory = MediaWikiServices::getInstance()->getWikiPageFactory();
60        foreach ( $this->params[ 'pageDBKeys' ] as $pageDBKey ) {
61            $title = Title::newFromDBkey( $pageDBKey );
62            // Skip any titles with broken keys.  We can't do anything with them.
63            if ( !$title ) {
64                LoggerFactory::getInstance( 'CirrusSearch' )->warning(
65                    "Skipping invalid DBKey: {pageDBKey}",
66                    [ 'pageDBKey' => $pageDBKey ]
67                );
68                continue;
69            }
70            $pageData[] = $wikiPageFactory->newFromTitle( $title );
71        }
72        // Now invoke the updater!
73        $updater = Updater::build( $this->searchConfig, $this->params['cluster'] ?? null );
74        $count = $updater->updatePages( $pageData, $this->params[ 'updateFlags' ] );
75        return $count >= 0;
76    }
77
78    /**
79     * @return int
80     */
81    public function workItemCount() {
82        return count( $this->params[ 'pageDBKeys' ] );
83    }
84}