e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
113 lines
3.5 KiB
PHP
113 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* Communications protocol.
|
|
* This is used by dumpTextPass.php when the --spawn option is present.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Maintenance
|
|
*/
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
use MediaWiki\MainConfigNames;
|
|
use MediaWiki\Settings\SettingsBuilder;
|
|
use MediaWiki\Storage\BlobAccessException;
|
|
use MediaWiki\Storage\BlobStore;
|
|
use MediaWiki\Storage\SqlBlobStore;
|
|
|
|
/**
|
|
* Maintenance script used to fetch page text in a subprocess.
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
class FetchText extends Maintenance {
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( "Fetch the raw revision blob from a blob address.\n" .
|
|
"Integer IDs are interpreted as referring to text.old_id for backwards compatibility.\n" .
|
|
"NOTE: Export transformations are NOT applied. " .
|
|
"This is left to dumpTextPass.php"
|
|
);
|
|
}
|
|
|
|
public function finalSetup( SettingsBuilder $settingsBuilder ) {
|
|
// This script should always try to run all db queries in the 'dump' group if such
|
|
// a group exists, just like the BackupDumper and TextPassDumper modules.
|
|
// To account for parts of MediaWiki that get their own db connection outside of
|
|
// Maintenance::getDB(), we set this global variable so that they will attempt
|
|
// to use this group.
|
|
$settingsBuilder->putConfigValue( MainConfigNames::DBDefaultGroup, 'dump' );
|
|
// do this last so that options can override
|
|
|
|
parent::finalSetup( $settingsBuilder );
|
|
}
|
|
|
|
/**
|
|
* @return BlobStore
|
|
*/
|
|
private function getBlobStore() {
|
|
return $this->getServiceContainer()->getBlobStore();
|
|
}
|
|
|
|
/**
|
|
* returns a string containing the following in order:
|
|
* textid
|
|
* \n
|
|
* length of text (-1 on error = failure to retrieve/unserialize/gunzip/etc)
|
|
* \n
|
|
* text (may be empty)
|
|
*
|
|
* note that the text string itself is *not* followed by newline
|
|
*/
|
|
public function execute() {
|
|
$stdin = $this->getStdin();
|
|
while ( !feof( $stdin ) ) {
|
|
$line = fgets( $stdin );
|
|
if ( $line === false ) {
|
|
// We appear to have lost contact...
|
|
break;
|
|
}
|
|
$blobAddress = trim( $line );
|
|
|
|
// Plain integers are supported for backwards compatibility with pre-MCR dumps.
|
|
if ( strpos( $blobAddress, ':' ) === false && is_numeric( $blobAddress ) ) {
|
|
$blobAddress = SqlBlobStore::makeAddressFromTextId( intval( $blobAddress ) );
|
|
}
|
|
|
|
try {
|
|
$text = $this->getBlobStore()->getBlob( $blobAddress );
|
|
$textLen = strlen( $text );
|
|
} catch ( BlobAccessException | InvalidArgumentException $ex ) {
|
|
// XXX: log $ex to stderr?
|
|
$textLen = '-1';
|
|
$text = '';
|
|
}
|
|
|
|
$this->output( $blobAddress . "\n" . $textLen . "\n" . $text );
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = FetchText::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|