maintenance/parse.php

   1 <?php
   2 /**
   3  * CLI script to easily parse some wikitext.
   4  * Wikitext can be given by stdin or using a file. The wikitext will be parsed
   5  * using 'CLIParser' as a title. This can be overriden with --title option.
   6  *
   7  * Example1:
   8  * @code
   9  * $ php parse.php --title foo
  10  * ''[[foo]]''^D
  11  * <p><i><strong class="selflink">foo</strong></i>
  12  * </p>
  13  * @endcode
  14  *
  15  * Example2:
  16  * @code
  17  * $ echo "'''bold'''" > /tmp/foo.txt
  18  * $ php parse.php /tmp/foo.txt
  19  * <p><b>bold</b>
  20  * </p>$
  21  * @endcode
  22  *
  23  * Example3:
  24  * @code
  25  * $ cat /tmp/foo | php parse.php
  26  * <p><b>bold</b>
  27  * </p>$
  28  * @endcode
  29  *
  30  * @ingroup Maintenance
  31  * @author Antoine Musso <hashar at free dot fr>
  32  * @license GNU General Public License 2.0 or later
  33  */
  34 require_once( dirname(__FILE__) . '/Maintenance.php' );
  35
  36 class CLIParser extends Maintenance {
  37         protected $parser;
  38
  39         public function __construct() {
  40                 parent::__construct();
  41                 $this->mDescription = "Parse a given wikitext";
  42                 $this->addOption( 'title', 'Title name for the given wikitext (Default: \'CLIParser\')', false, true );
  43                 $this->addArg( 'file', 'File containing wikitext (Default: stdin)', false );
  44         }
  45
  46         public function execute() {
  47                 $this->initParser();
  48                 print $this->render( $this->WikiText() );
  49         }
  50
  51         /**
  52          * @param string $wikitext Wikitext to get rendered
  53          * @return string HTML Rendering
  54          */
  55         public function render( $wikitext ) {
  56                 return $this->parse( $wikitext )->getText();
  57         }
  58
  59         /**
  60          * Get wikitext from a the file passed as argument or STDIN
  61          * @return string Wikitext
  62          */
  63         protected function Wikitext() {
  64
  65                 $php_stdin  = 'php://stdin';
  66                 $input_file = $this->getArg( 0, $php_stdin );
  67
  68                 if( $input_file === $php_stdin ) {
  69                         $ctrl = wfIsWindows() ? 'CTRL+Z' : 'CTRL+D';
  70                         $this->error( basename(__FILE__) .": warning: reading wikitext from STDIN. Press $ctrl to parse.\n" );
  71                 }
  72
  73                 return file_get_contents( $input_file );
  74         }
  75
  76         protected function initParser() {
  77                 global $wgParserConf;
  78                 $parserClass = $wgParserConf['class'];
  79                 $this->parser = new $parserClass();
  80         }
  81
  82         /**
  83          * Title object to use for CLI parsing.
  84          * Default title is 'CLIParser', it can be overriden with the option
  85          * --title <Your:Title>
  86          *
  87          * @return Title object
  88          */
  89         protected function getTitle( ) {
  90                 $title =
  91                         $this->getOption( 'title' )
  92                         ? $this->getOption( 'title' )
  93                         : 'CLIParser' ;
  94                 return Title::newFromText( $title );
  95         }
  96
  97         /**
  98          * @param string $wikitext Wikitext to parse
  99          * @return ParserOutput
 100          */
 101         protected function parse( $wikitext ) {
 102                 return $this->parser->parse(
 103                         $wikitext
 104                         , $this->getTitle()
 105                         , new ParserOptions()
 106                 );
 107         }
 108 }
 109
 110 $maintClass = "CLIParser";
 111 require_once( RUN_MAINTENANCE_IF_MAIN );