Merge "New hook for filters on Special:Contributions form"
[lhc/web/wiklou.git] / maintenance / commandLine.inc
index 375448e..1a05907 100644 (file)
 <?php
 /**
- * @todo document
- * @addtogroup Maintenance
+ * Backwards-compatibility wrapper for old-style maintenance scripts.
+ *
+ * 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
  */
 
-$wgRequestTime = microtime(true);
-
-/** */
-# Abort if called from a web server
-if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
-       print "This script must be run from the command line\n";
-       exit();
-}
-
-if( version_compare( PHP_VERSION, '5.0.0' ) < 0 ) {
-       print "Sorry! This version of MediaWiki requires PHP 5; you are running " .
-               PHP_VERSION . ".\n\n" .
-               "If you are sure you already have PHP 5 installed, it may be " .
-               "installed\n" .
-               "in a different path from PHP 4. Check with your system administrator.\n";
-       die( -1 );
-}
-
-define('MEDIAWIKI',true);
-
-# Process command line arguments
-# $options becomes an array with keys set to the option names
-# $optionsWithArgs is an array of GNU-style options that take an argument. The arguments are returned
-# in the values of $options.
-# $args becomes a zero-based array containing the non-option arguments
+require_once __DIR__ . '/Maintenance.php';
 
+// @codingStandardsIgnoreStart MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
+global $optionsWithArgs;
+// @codingStandardsIgnoreEnd
 if ( !isset( $optionsWithArgs ) ) {
        $optionsWithArgs = array();
 }
-$optionsWithArgs[] = 'conf'; # For specifying the location of LocalSettings.php
-$optionsWithArgs[] = 'aconf'; # As above for AdminSettings.php
 
-$self = array_shift( $argv );
-$IP = realpath( dirname( __FILE__ ) . '/..' );
-#chdir( $IP );
-require_once( "$IP/StartProfiler.php" );
-
-$options = array();
-$args = array();
-
-
-# Parse arguments
-for( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
-       if ( $arg == '--' ) {
-               # End of options, remainder should be considered arguments
-               $arg = next( $argv );
-               while( $arg !== false ) {
-                       $args[] = $arg;
-                       $arg = next( $argv );
-               }
-               break;
-       } elseif ( substr( $arg, 0, 2 ) == '--' ) {
-               # Long options
-               $option = substr( $arg, 2 );
-               if ( in_array( $option, $optionsWithArgs ) ) {
-                       $param = next( $argv );
-                       if ( $param === false ) {
-                               echo "$arg needs an value after it\n";
-                               die( -1 );
-                       }
-                       $options[$option] = $param;
-               } else {
-                       $bits = explode( '=', $option, 2 );
-                       if( count( $bits ) > 1 ) {
-                               $option = $bits[0];
-                               $param = $bits[1];
-                       } else {
-                               $param = 1;
-                       }
-                       $options[$option] = $param;
-               }
-       } elseif ( substr( $arg, 0, 1 ) == '-' ) {
-               # Short options
-               for ( $p=1; $p<strlen( $arg ); $p++ ) {
-                       $option = $arg{$p};
-                       if ( in_array( $option, $optionsWithArgs ) ) {
-                               $param = next( $argv );
-                               if ( $param === false ) {
-                                       echo "$arg needs an value after it\n";
-                                       die( -1 );
-                               }
-                               $options[$option] = $param;
-                       } else {
-                               $options[$option] = 1;
-                       }
+class CommandLineInc extends Maintenance {
+       public function __construct() {
+               // @codingStandardsIgnoreStart MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
+               global $optionsWithArgs;
+               // @codingStandardsIgnoreEnd
+               parent::__construct();
+               foreach ( $optionsWithArgs as $name ) {
+                       $this->addOption( $name, '', false, true );
                }
-       } else {
-               $args[] = $arg;
        }
-}
-
-
-# General initialisation
-
-$wgCommandLineMode = true;
-# Turn off output buffering if it's on
-@ob_end_flush();
-$sep = PATH_SEPARATOR;
-
-if (!isset( $wgUseNormalUser ) ) {
-       $wgUseNormalUser = false;
-}
 
-if ( file_exists( '/home/wikipedia/common/langlist' ) ) {
-       $wgWikiFarm = true;
-       $cluster = trim( file_get_contents( '/etc/cluster' ) );
-       require_once( "$IP/includes/SiteConfiguration.php" );
-
-       # Get $wgConf
-       require( "$IP/wgConf.php" );
-
-       if ( empty( $wgNoDBParam ) ) {
-               # Check if we were passed a db name
-               $db = array_shift( $args );
-               list( $site, $lang ) = $wgConf->siteFromDB( $db );
-
-               # If not, work out the language and site the old way
-               if ( is_null( $site ) || is_null( $lang ) ) {
-                       if ( !$db ) {
-                               $lang = 'aa';
-                       } else {
-                               $lang = $db;
-                       }
-                       if ( isset( $args[0] ) ) {
-                               $site = array_shift( $args );
-                       } else {
-                               $site = 'wikipedia';
-                       }
+       /**
+        * No help, it would just be misleading since it misses custom options
+        * @param bool $force
+        */
+       protected function maybeHelp( $force = false ) {
+               if ( !$force ) {
+                       return;
                }
-       } else {
-               $lang = 'aa';
-               $site = 'wikipedia';
-       }
-
-       # This is for the IRC scripts, which now run as the apache user
-       # The apache user doesn't have access to the wikiadmin_pass command
-       if ( $_ENV['USER'] == 'apache' ) {
-       #if ( posix_geteuid() == 48 ) {
-               $wgUseNormalUser = true;
+               parent::maybeHelp( true );
        }
 
-       putenv( 'wikilang='.$lang);
-
-       $DP = $IP;
-       ini_set( 'include_path', ".:$IP:$IP/includes:$IP/languages:$IP/maintenance" );
-
-       #require_once( $IP.'/includes/ProfilerStub.php' );
-       require_once( $IP.'/includes/Defines.php' );
-       require_once( $IP.'/CommonSettings.php' );
-
-       $bin = '/home/wikipedia/bin';
-       if ( $wgUseRootUser ) {
-               $wgDBuser = $wgDBadminuser = 'root';
-               $wgDBpassword = $wgDBadminpassword = trim(`$bin/mysql_root_pass`);
-       } elseif ( !$wgUseNormalUser ) {
-               $wgDBuser = $wgDBadminuser = 'wikiadmin';
-               $wgDBpassword = $wgDBadminpassword = trim(`$bin/wikiadmin_pass`);
-       }
-} else {
-       $wgWikiFarm = false;
-       if ( isset( $options['conf'] ) ) {
-               $settingsFile = $options['conf'];
-       } else {
-               $settingsFile = "$IP/LocalSettings.php";
-       }
-
-       if ( ! is_readable( $settingsFile ) ) {
-               print "A copy of your installation's LocalSettings.php\n" .
-                 "must exist and be readable in the source directory.\n";
-               exit( 1 );
-       }
-       $wgCommandLineMode = true;
-       $DP = $IP;
-       #require_once( $IP.'/includes/ProfilerStub.php' );
-       require_once( $IP.'/includes/Defines.php' );
-       require_once( $settingsFile );
-       /* ini_set( 'include_path', ".$sep$IP$sep$IP/includes$sep$IP/languages$sep$IP/maintenance" ); */
-
-       $adminSettings = isset( $options['aconf'] )
-               ? $options['aconf']
-               : "{$IP}/AdminSettings.php";
-       if( is_readable( $adminSettings ) )
-               require_once( $adminSettings );
-
-}
-
-# Turn off output buffering again, it might have been turned on in the settings files
-if( ob_get_level() ) {
-       ob_end_flush();
-}
-# Same with these
-$wgCommandLineMode = true;
-
-if ( empty( $wgUseNormalUser ) && isset( $wgDBadminuser ) ) {
-       $wgDBuser = $wgDBadminuser;
-       $wgDBpassword = $wgDBadminpassword;
-
-       if( $wgDBservers ) {
-               foreach ( $wgDBservers as $i => $server ) {
-                       $wgDBservers[$i]['user'] = $wgDBuser;
-                       $wgDBservers[$i]['password'] = $wgDBpassword;
-               }
-       }
-}
-
-if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
-       $fn = MW_CMDLINE_CALLBACK;
-       $fn();
-}
-
-ini_set( 'memory_limit', -1 );
-
-if( version_compare( phpversion(), '5.2.4' ) >= 0 ) {
-       // 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' );
+       public function execute() {
+               // @codingStandardsIgnoreStart MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
+               global $args, $options;
+               // @codingStandardsIgnoreEnd
+               $args = $this->mArgs;
+               $options = $this->mOptions;
        }
-       
-       // Don't touch the setting on earlier versions of PHP,
-       // as setting it would disable output if you'd wanted it.
-       
-       // Note that exceptions are also sent to stderr when
-       // command-line mode is on, regardless of PHP version.
 }
-$wgShowSQLErrors = true;
 
-require_once( "$IP/includes/Setup.php" );
-require_once( "$IP/install-utils.inc" );
-$wgTitle = null; # Much much faster startup than creating a title object
-@set_time_limit(0);
+$maintClass = 'CommandLineInc';
+require RUN_MAINTENANCE_IF_MAIN;