Maintenance.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

Maintenance.php
View Options

	<?php
	// phpcs:disable Generic.Files.LineLength.TooLong

	namespace Wikimedia\Parsoid\Tools;

	global $argv;

	// Hacky preprocessing of command-line arguments: look for
	// --integrated and/or --standalone flags.
	use MediaWiki\Settings\SettingsBuilder;

	$parsoidMode = null;
	for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
	if ( $arg === '--' ) {
	# end of options
	break;
	} elseif ( $arg === '--integrated' \|\| $arg === '--standalone' ) {
	$parsoidMode = substr( $arg, 2 );
	break;
	}
	}

	# On parsoidtest1001 and production machines, you should use:
	# sudo -u www-data php /srv/mediawiki/multiversion/MWScript.php \
	# /srv/parsoid-testing/bin/<cmd>.php --wiki=hiwiki --integrated <args>
	#
	# eg:
	#
	# USER@parsoidtest1001:/srv/mediawiki/multiversion$ echo '==Foo==' \| \
	# sudo -u www-data php MWScript.php \
	# /srv/parsoid-testing/bin/parse.php --wiki=hiwiki --integrated
	#

	// phpcs:disable Generic.Classes.DuplicateClassName.Found
	// phpcs:disable Generic.Files.OneObjectStructurePerFile.MultipleFound
	if ( $parsoidMode === 'integrated' ) {
	/* Is MW installed w/ Parsoid? Then use core's copy of Maintenance.php. */
	if ( strval( getenv( 'MW_INSTALL_PATH' ) ) !== '' ) {
	require_once getenv( 'MW_INSTALL_PATH' ) . '/maintenance/Maintenance.php';
	require_once getenv( 'MW_INSTALL_PATH' ) . '/includes/AutoLoader.php';
	} else {
	error_log( 'MW_INSTALL_PATH environment variable must be defined.' );
	}

	// EVIL(ish) hack:
	// Override autoloader to ensure all of Parsoid is running from the
	// same place as this file (since there will also be another copy of
	// Parsoid included from the vendor/wikimedia/parsoid directory)
	// @phan-suppress-next-line PhanUndeclaredClassStaticProperty
	\AutoLoader::registerNamespaces( [
	// Keep this in sync with the "autoload" clause in /composer.json!
	'Wikimedia\\Parsoid\\' => __DIR__ . "/../src",
	// And this is from autoload-dev
	'Wikimedia\\Parsoid\\Tools\\' => __DIR__ . "/../tools/",
	] );

	abstract class Maintenance extends \Maintenance {
	private $requiresParsoid;

	/**
	* @param bool $requiresParsoid Whether parsoid-specific processing
	* should be done (default: true)
	*/
	public function __construct( bool $requiresParsoid = true ) {
	parent::__construct();
	$this->requiresParsoid = $requiresParsoid;
	if ( $this->requiresParsoid ) {
	$this->requireExtension( 'Parsoid' );
	}
	}

	/**
	* @inheritDoc
	*/
	public function finalSetup( ?SettingsBuilder $settingsBuilder = null ) {
	parent::finalSetup( $settingsBuilder ?? SettingsBuilder::getInstance() );
	}

	public function addDefaultParams(): void {
	if ( $this->requiresParsoid ) {
	$this->addOption(
	'integrated',
	'Run parsoid integrated with a host MediaWiki installation ' .
	'at MW_INSTALL_PATH'
	);
	$this->addOption(
	'standalone',
	'Run parsoid standalone, communicating with a host MediaWiki ' .
	'using network API (see --domain option)'
	);
	$this->addOption(
	'mock',
	'Use mock environment instead of api or standalone'
	);
	}
	parent::addDefaultParams();
	}

	/**
	* Make the protected method from the superclass into a public method
	* so we can use this from TestUtils.php.
	*
	* @inheritDoc
	*/
	public function addOption(
	$name, $description, $required = false,
	$withArg = false, $shortName = false,
	$multiOccurrence = false
	) {
	parent::addOption(
	$name, $description, $required, $withArg, $shortName,
	$multiOccurrence
	);
	}

	/**
	* Make the options array available to ExtendedOptsProcessor
	*
	* @return array
	*/
	protected function getOptions(): array {
	return $this->mOptions;
	}
	}

	define( 'PARSOID_RUN_MAINTENANCE_IF_MAIN', RUN_MAINTENANCE_IF_MAIN );

	// Ensure parsoid extension is loaded on production machines.
	$_SERVER['SERVERGROUP'] = 'parsoid';
	} else {
	/* Use Parsoid's stand-alone clone of the Maintenance framework */
	require_once __DIR__ . '/../vendor/autoload.php';

	abstract class Maintenance extends OptsProcessor {
	/** @var bool Whether to perform Parsoid-specific processing */
	private $requiresParsoid;

	/**
	* @param bool $requiresParsoid Whether parsoid-specific processing
	* should be done (default: true)
	*/
	public function __construct( bool $requiresParsoid = true ) {
	parent::__construct();
	$this->requiresParsoid = $requiresParsoid;
	}

	public function addDefaultParams(): void {
	if ( $this->requiresParsoid ) {
	$this->addOption(
	'integrated',
	'Run parsoid integrated with a host MediaWiki installation ' .
	'at MW_INSTALL_PATH'
	);
	$this->addOption(
	'standalone',
	'Run parsoid standalone, communicating with a host MediaWiki ' .
	'using network API (see --domain option)'
	);
	$this->addOption(
	'mock',
	'Use mock environment instead of api or standalone'
	);
	}
	parent::addDefaultParams();
	}

	/**
	* Make the options array available to ExtendedOptsProcessor
	*
	* @return array
	*/
	protected function getOptions(): array {
	return $this->options;
	}

	public function setup() {
	# Abort if called from a web server
	# wfIsCLI() is not available yet
	if ( PHP_SAPI !== 'cli' && PHP_SAPI !== 'phpdbg' ) {
	$this->fatalError( 'This script must be run from the command line' );
	}
	# Make sure we can handle script parameters
	if ( !ini_get( 'register_argc_argv' ) ) {
	$this->fatalError( 'Cannot get command line arguments, register_argc_argv is set to false' );
	}

	// Send PHP warnings and errors to stderr instead of stdout.
	// This aids in diagnosing problems, while keeping messages
	// out of redirected output.
	if ( ini_get( 'display_errors' ) ) {
	ini_set( 'display_errors', 'stderr' );
	}

	$this->loadParamsAndArgs();

	# Set max execution time to 0 (no limit). PHP.net says that
	# "When running PHP from the command line the default setting is 0."
	# But sometimes this doesn't seem to be the case.
	ini_set( 'max_execution_time', 0 );

	# Turn off output buffering if it's on
	while ( ob_get_level() > 0 ) {
	ob_end_flush();
	}
	}

	/** For compatibility with core. */
	public static function requireTestsAutoloader() {
	/* do nothing, for compatibility only */
	}

	/** For compatibility with core */
	public function finalSetup() {
	if ( ob_get_level() ) {
	ob_end_flush();
	}
	}

	/**
	* Implementation copied from core
	*
	* Wrapper for posix_isatty()
	* We default as considering stdin a tty (for nice readline methods)
	* but treating stdout as not a tty to avoid color codes
	*
	* @param mixed $fd File descriptor
	* @return bool
	*/
	public static function posix_isatty( $fd ): bool { // phpcs:ignore MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName
	if ( !function_exists( 'posix_isatty' ) ) {
	return !$fd;
	} else {
	return posix_isatty( $fd );
	}
	}
	}

	define( 'PARSOID_RUN_MAINTENANCE_IF_MAIN', __DIR__ . '/doMaintenance.php' );
	}

File Metadata

Mime Type: text/x-php
Expires: Sat, Oct 3, 14:54 (22 h, 47 m)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 6f/d1/0671ba74bdaee31b6160202af1aa
Default Alt Text: Maintenance.php (6 KB)

Maintenance.phpNo OneTemporaryActions

Maintenance.phpView Options

File Metadata

Event Timeline

Maintenance.php
No OneTemporary
Actions

Maintenance.php
View Options