1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?php
/**
* Modern interactive shell within the MediaWiki engine.
*
* Merely wraps around http://psysh.org/ and drop an interactive PHP shell in
* the global scope.
*
* Copyright © 2017 Antoine Musso <hashar@free.fr>
* Copyright © 2017 Gergő Tisza <tgr.huwiki@gmail.com>
* Copyright © 2017 Justin Hileman <justin@justinhileman.info>
* Copyright © 2017 Wikimedia Foundation Inc.
* https://www.mediawiki.org/
*
* 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
*
* @author Antoine Musso <hashar@free.fr>
* @author Justin Hileman <justin@justinhileman.info>
* @author Gergő Tisza <tgr.huwiki@gmail.com>
*/
// NO_AUTOLOAD -- file-scope code
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Logger\ConsoleSpi;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\MediaWikiServices;
use Psr\Log\LogLevel;
// Horrible hack to support the --no-session parameter, which needs to be handled
// way before parameters are parsed.
if ( in_array( '--no-session', $_SERVER['argv'], true ) ) {
define( 'MW_NO_SESSION', 1 );
}
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
* Interactive shell with completion and global scope.
*
*/
class MediaWikiShell extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption( 'd',
'Deprecated, for back compatibility with eval.php. ' .
'1 send debug to stderr. ' .
'With 2 additionally initialize database with debugging ',
false, true
);
$this->addOption( 'log-channels', 'Send the given log channels to STDERR. '
. 'Format: channel[:level],...', false, true );
$this->addOption( 'log-all', 'Send all log channels to STDERR.' );
$this->addOption( 'dbo-debug', 'Set DBO_DEBUG flags (equivalent of $wgDebugDumpSql).' );
$this->addOption( 'no-session',
'Disable session support (like MW_NO_SESSION)'
);
}
public function canExecuteWithoutLocalSettings(): bool {
return true;
}
public function execute() {
if ( !class_exists( \Psy\Shell::class ) ) {
$this->fatalError( 'PsySH not found. Please run composer with the --dev option.' );
}
$traverser = new \PhpParser\NodeTraverser();
$codeCleaner = new \Psy\CodeCleaner( null, null, $traverser );
// add this after initializing the code cleaner so all the default passes get added first
$traverser->addVisitor( new CodeCleanerGlobalsPass() );
$config = new \Psy\Configuration();
$config->setCodeCleaner( $codeCleaner );
$config->setUpdateCheck( \Psy\VersionUpdater\Checker::NEVER );
// prevent https://github.com/bobthecow/psysh/issues/443 when using sudo -E
$config->setRuntimeDir( wfTempDir() );
$shell = new \Psy\Shell( $config );
$this->setupLogging();
( new HookRunner( $this->getServiceContainer()->getHookContainer() ) )->onMaintenanceShellStart();
$shell->run();
}
protected function setupLogging() {
if ( $this->hasOption( 'd' ) ) {
wfDeprecated( 'shell.php -d', '1.40' );
$this->setupLegacy();
return;
}
if ( $this->hasOption( 'log-all' ) ) {
LoggerFactory::registerProvider( new ConsoleSpi( [
'forwardTo' => LoggerFactory::getProvider(),
] ) );
// Some services hold Logger instances in object properties
MediaWikiServices::resetGlobalInstance();
MediaWikiServices::getInstance()->getObjectCacheFactory()->clear();
} elseif ( $this->hasOption( 'log-channels' ) ) {
$channelsArg = $this->getOption( 'log-channels' );
$channels = [];
foreach ( explode( ',', $channelsArg ) as $channelArg ) {
$parts = explode( ':', $channelArg );
$channel = $parts[0];
$level = $parts[1] ?? LogLevel::DEBUG;
$channels[$channel] = $level;
}
LoggerFactory::registerProvider( new ConsoleSpi( [
'channels' => $channels,
'forwardTo' => LoggerFactory::getProvider(),
] ) );
MediaWikiServices::resetGlobalInstance();
MediaWikiServices::getInstance()->getObjectCacheFactory()->clear();
}
if ( $this->hasOption( 'dbo-debug' ) ) {
$this->getPrimaryDB()->setFlag( DBO_DEBUG );
$this->getReplicaDB()->setFlag( DBO_DEBUG );
}
}
/**
* For back compatibility with eval.php
*/
protected function setupLegacy() {
$d = intval( $this->getOption( 'd' ) );
if ( $d > 0 ) {
LoggerFactory::registerProvider( new ConsoleSpi );
// Some services hold Logger instances in object properties
MediaWikiServices::resetGlobalInstance();
MediaWikiServices::getInstance()->getObjectCacheFactory()->clear();
}
if ( $d > 1 ) {
# Set DBO_DEBUG (equivalent of $wgDebugDumpSql)
$this->getPrimaryDB()->setFlag( DBO_DEBUG );
$this->getReplicaDB()->setFlag( DBO_DEBUG );
}
}
}
// @codeCoverageIgnoreStart
$maintClass = MediaWikiShell::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd
|
