3 * Modern interactive shell within the MediaWiki engine.
5 * Merely wraps around http://psysh.org/ and drop an interactive PHP shell in
8 * Copyright © 2017 Antoine Musso <hashar@free.fr>
9 * Copyright © 2017 Gergő Tisza <tgr.huwiki@gmail.com>
10 * Copyright © 2017 Justin Hileman <justin@justinhileman.info>
11 * Copyright © 2017 Wikimedia Foundation Inc.
12 * https://www.mediawiki.org/
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License along
25 * with this program; if not, write to the Free Software Foundation, Inc.,
26 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 * http://www.gnu.org/copyleft/gpl.html
30 * @ingroup Maintenance
32 * @author Antoine Musso <hashar@free.fr>
33 * @author Justin Hileman <justin@justinhileman.info>
34 * @author Gergő Tisza <tgr.huwiki@gmail.com>
37 use MediaWiki\Logger\LoggerFactory
;
38 use MediaWiki\Logger\ConsoleSpi
;
39 use MediaWiki\MediaWikiServices
;
41 require_once __DIR__
. '/Maintenance.php';
44 * Interactive shell with completion and global scope.
47 class MediaWikiShell
extends Maintenance
{
49 public function __construct() {
50 parent
::__construct();
51 $this->addOption( 'd',
52 'For back compatibility with eval.php. ' .
53 '1 send debug to stderr. ' .
54 'With 2 additionally initialize database with debugging ',
59 public function execute() {
60 if ( !class_exists( \Psy\Shell
::class ) ) {
61 $this->fatalError( 'PsySH not found. Please run composer with the --dev option.' );
64 $traverser = new \PhpParser\
NodeTraverser();
65 $codeCleaner = new \Psy\
CodeCleaner( null, null, $traverser );
67 // add this after initializing the code cleaner so all the default passes get added first
68 $traverser->addVisitor( new CodeCleanerGlobalsPass() );
70 $config = new \Psy\
Configuration();
71 $config->setCodeCleaner( $codeCleaner );
72 $config->setUpdateCheck( \Psy\VersionUpdater\Checker
::NEVER
);
73 // prevent https://github.com/bobthecow/psysh/issues/443 when using sudo -E
74 $config->setRuntimeDir( wfTempDir() );
76 $shell = new \Psy\
Shell( $config );
77 if ( $this->hasOption( 'd' ) ) {
85 * For back compatibility with eval.php
87 protected function setupLegacy() {
88 $d = intval( $this->getOption( 'd' ) );
90 LoggerFactory
::registerProvider( new ConsoleSpi
);
91 // Some services hold Logger instances in object properties
92 MediaWikiServices
::resetGlobalInstance();
95 # Set DBO_DEBUG (equivalent of $wgDebugDumpSql)
96 wfGetDB( DB_MASTER
)->setFlag( DBO_DEBUG
);
97 wfGetDB( DB_REPLICA
)->setFlag( DBO_DEBUG
);
103 $maintClass = MediaWikiShell
::class;
104 require_once RUN_MAINTENANCE_IF_MAIN
;