maintenance/eval.php

   1 <?php
   2 /**
   3  * This script lets a command-line user start up the wiki engine and then poke
   4  * about by issuing PHP commands directly.
   5  *
   6  * Unlike eg Python, you need to use a 'return' statement explicitly for the
   7  * interactive shell to print out the value of the expression. Multiple lines
   8  * are evaluated separately, so blocks need to be input without a line break.
   9  * Fatal errors such as use of undeclared functions can kill the shell.
  10  *
  11  * To get decent line editing behavior, you should compile PHP with support
  12  * for GNU readline (pass --with-readline to configure).
  13  *
  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.
  18  *
  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.
  23  *
  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
  28  *
  29  * @file
  30  * @ingroup Maintenance
  31  */
  32
  33 use MediaWiki\Logger\LoggerFactory;
  34 use MediaWiki\Logger\ConsoleSpi;
  35 use MediaWiki\MediaWikiServices;
  36
  37 $optionsWithArgs = [ 'd' ];
  38
  39 require_once __DIR__ . "/commandLine.inc";
  40
  41 if ( isset( $options['d'] ) ) {
  42         $d = $options['d'];
  43         if ( $d > 0 ) {
  44                 LoggerFactory::registerProvider( new ConsoleSpi );
  45                 // Some services hold Logger instances in object properties
  46                 MediaWikiServices::resetGlobalInstance();
  47         }
  48         if ( $d > 1 ) {
  49                 wfGetDB( DB_MASTER )->setFlag( DBO_DEBUG );
  50                 wfGetDB( DB_REPLICA )->setFlag( DBO_DEBUG );
  51         }
  52 }
  53
  54 $__useReadline = function_exists( 'readline_add_history' )
  55         && Maintenance::posix_isatty( 0 /*STDIN*/ );
  56
  57 if ( $__useReadline ) {
  58         $__historyFile = isset( $_ENV['HOME'] ) ?
  59                 "{$_ENV['HOME']}/.mweval_history" : "$IP/maintenance/.mweval_history";
  60         readline_read_history( $__historyFile );
  61 }
  62
  63 $__e = null; // PHP exception
  64 while ( ( $__line = Maintenance::readconsole() ) !== false ) {
  65         if ( $__e && !preg_match( '/^(exit|die);?$/', $__line ) ) {
  66                 // Internal state may be corrupted or fatals may occur later due
  67                 // to some object not being set. Don't drop out of eval in case
  68                 // lines were being pasted in (which would then get dumped to the shell).
  69                 // Instead, just absorb the remaning commands. Let "exit" through per DWIM.
  70                 echo "Exception was thrown before; please restart eval.php\n";
  71                 continue;
  72         }
  73         if ( $__useReadline ) {
  74                 readline_add_history( $__line );
  75                 readline_write_history( $__historyFile );
  76         }
  77         try {
  78                 $__val = eval( $__line . ";" );
  79         } catch ( Exception $__e ) {
  80                 echo "Caught exception " . get_class( $__e ) .
  81                         ": {$__e->getMessage()}\n" . $__e->getTraceAsString() . "\n";
  82                 continue;
  83         }
  84         if ( wfIsHHVM() || is_null( $__val ) ) {
  85                 echo "\n";
  86         } elseif ( is_string( $__val ) || is_numeric( $__val ) ) {
  87                 echo "$__val\n";
  88         } else {
  89                 var_dump( $__val );
  90         }
  91 }
  92
  93 print "\n";