Revert "Convert mwdoc-filter.php to Maintenance", rm wfShellWikiCmd
authorMatthew Flaschen <mflaschen@wikimedia.org>
Thu, 4 May 2017 00:04:29 +0000 (20:04 -0400)
committerKrinkle <krinklemail@gmail.com>
Thu, 4 May 2017 00:15:22 +0000 (00:15 +0000)
Revert a58948d64 and instead remove wfShellWikiCmd and escape
shell arguments directly.

This should be fine since mwdoc-filter.php does not depend on per-wiki
state.

Change-Id: Id9c6ca84bab827675b71ca16bf688fd3f5c993a1

autoload.php
maintenance/mwdoc-filter.php
maintenance/mwdocgen.php

index 06e863f..1141c39 100644 (file)
@@ -786,7 +786,6 @@ $wgAutoloadLocalClasses = [
        'MWCryptRand' => __DIR__ . '/includes/utils/MWCryptRand.php',
        'MWDebug' => __DIR__ . '/includes/debug/MWDebug.php',
        'MWDocGen' => __DIR__ . '/maintenance/mwdocgen.php',
-       'MWDocGenFilter' => __DIR__ . '/maintenance/mwdoc-filter.php',
        'MWException' => __DIR__ . '/includes/exception/MWException.php',
        'MWExceptionHandler' => __DIR__ . '/includes/exception/MWExceptionHandler.php',
        'MWExceptionRenderer' => __DIR__ . '/includes/exception/MWExceptionRenderer.php',
index 46c5a00..feaad12 100644 (file)
  * DEALINGS IN THE SOFTWARE.
  */
 
-require_once __DIR__ . '/Maintenance.php';
-
-/**
- * Maintenance script that builds doxygen documentation.
- * @ingroup Maintenance
- */
-class MWDocGenFilter extends Maintenance {
-       public function __construct() {
-               parent::__construct();
-               $this->addDescription( 'Doxygen filter to fix member variable types in documentation. '
-                       . 'Used by mwdocgen.php'
-               );
-               $this->addArg( 'filename', 'PHP file to filter', true );
-       }
+// Warning: Converting this to a Maintenance script may reduce performance.
+if ( PHP_SAPI != 'cli' ) {
+       die( "This filter can only be run from the command line.\n" );
+}
 
-       public function execute() {
-               $source = file_get_contents( $this->getArg( 0 ) );
-               $tokens = token_get_all( $source );
+$source = file_get_contents( $argv[1] );
+$tokens = token_get_all( $source );
 
-               $buffer = $bufferType = null;
-               foreach ( $tokens as $token ) {
-                       if ( is_string( $token ) ) {
-                               if ( $buffer !== null && $token === ';' ) {
-                                       // If we still have a buffer and the statement has ended,
-                                       // flush it and move on.
-                                       echo $buffer;
-                                       $buffer = $bufferType = null;
-                               }
-                               echo $token;
-                               continue;
+$buffer = $bufferType = null;
+foreach ( $tokens as $token ) {
+       if ( is_string( $token ) ) {
+               if ( $buffer !== null && $token === ';' ) {
+                       // If we still have a buffer and the statement has ended,
+                       // flush it and move on.
+                       echo $buffer;
+                       $buffer = $bufferType = null;
+               }
+               echo $token;
+               continue;
+       }
+       list( $id, $content ) = $token;
+       switch ( $id ) {
+               case T_DOC_COMMENT:
+                       // Escape slashes so that references to namespaces are not
+                       // wrongly interpreted as a Doxygen "\command".
+                       $content = addcslashes( $content, '\\' );
+                       // Look for instances of "@var Type" not followed by $name.
+                       if ( preg_match( '#@var\s+([^\s]+)\s+([^\$]+)#s', $content ) ) {
+                               $buffer = preg_replace_callback(
+                                       // Strip the "@var Type" part and remember the type
+                                       '#(@var\s+)([^\s]+)#s',
+                                       function ( $matches ) use ( &$bufferType ) {
+                                               $bufferType = $matches[2];
+                                               return '';
+                                       },
+                                       $content
+                               );
+                       } else {
+                               echo $content;
                        }
-                       list( $id, $content ) = $token;
-                       switch ( $id ) {
-                               case T_DOC_COMMENT:
-                                       // Escape slashes so that references to namespaces are not
-                                       // wrongly interpreted as a Doxygen "\command".
-                                       $content = addcslashes( $content, '\\' );
-                                       // Look for instances of "@var Type" not followed by $name.
-                                       if ( preg_match( '#@var\s+([^\s]+)\s+([^\$]+)#s', $content ) ) {
-                                               $buffer = preg_replace_callback(
-                                                       // Strip the "@var Type" part and remember the type
-                                                       '#(@var\s+)([^\s]+)#s',
-                                                       function ( $matches ) use ( &$bufferType ) {
-                                                               $bufferType = $matches[2];
-                                                               return '';
-                                                       },
-                                                       $content
-                                               );
-                                       } else {
-                                               echo $content;
-                                       }
-                                       break;
+                       break;
 
-                               case T_VARIABLE:
-                                       if ( $buffer !== null ) {
-                                               echo $buffer;
-                                               echo "$bufferType $content";
-                                               $buffer = $bufferType = null;
-                                       } else {
-                                               echo $content;
-                                       }
-                                       break;
+               case T_VARIABLE:
+                       if ( $buffer !== null ) {
+                               echo $buffer;
+                               echo "$bufferType $content";
+                               $buffer = $bufferType = null;
+                       } else {
+                               echo $content;
+                       }
+                       break;
 
-                               default:
-                                       if ( $buffer !== null ) {
-                                               $buffer .= $content;
-                                       } else {
-                                               echo $content;
-                                       }
-                                       break;
+               default:
+                       if ( $buffer !== null ) {
+                               $buffer .= $content;
+                       } else {
+                               echo $content;
                        }
-               }
+                       break;
        }
 }
-
-$maintClass = 'MWDocGenFilter';
-require_once RUN_MAINTENANCE_IF_MAIN;
index dc2eccd..d005629 100644 (file)
@@ -72,7 +72,7 @@ class MWDocGen extends Maintenance {
        }
 
        protected function init() {
-               global $IP;
+               global $wgPhpCli, $IP;
 
                $this->doxygen = $this->getOption( 'doxygen', 'doxygen' );
                $this->mwVersion = $this->getOption( 'version', 'master' );
@@ -86,7 +86,13 @@ class MWDocGen extends Maintenance {
 
                $this->output = $this->getOption( 'output', "$IP/docs" );
 
-               $this->inputFilter = wfShellWikiCmd( $IP . '/maintenance/mwdoc-filter.php' );
+               // Do not use wfShellWikiCmd, because mwdoc-filter.php is not
+               // a Maintenance script.
+               $this->inputFilter = wfEscapeShellArg( [
+                       $wgPhpCli,
+                       $IP . '/maintenance/mwdoc-filter.php'
+               ] );
+
                $this->template = $IP . '/maintenance/Doxyfile';
                $this->excludes = [
                        'vendor',