summaryrefslogtreecommitdiff
path: root/maintenance/parse.php
diff options
context:
space:
mode:
Diffstat (limited to 'maintenance/parse.php')
-rw-r--r--maintenance/parse.php110
1 files changed, 110 insertions, 0 deletions
diff --git a/maintenance/parse.php b/maintenance/parse.php
new file mode 100644
index 00000000..876f28e9
--- /dev/null
+++ b/maintenance/parse.php
@@ -0,0 +1,110 @@
+<?php
+/**
+ * CLI script to easily parse some wikitext.
+ * Wikitext can be given by stdin or using a file. The wikitext will be parsed
+ * using 'CLIParser' as a title. This can be overriden with --title option.
+ *
+ * Example1:
+ * @code
+ * $ php parse.php --title foo
+ * ''[[foo]]''^D
+ * <p><i><strong class="selflink">foo</strong></i>
+ * </p>
+ * @endcode
+ *
+ * Example2:
+ * @code
+ * $ echo "'''bold'''" > /tmp/foo.txt
+ * $ php parse.php /tmp/foo.txt
+ * <p><b>bold</b>
+ * </p>$
+ * @endcode
+ *
+ * Example3:
+ * @code
+ * $ cat /tmp/foo | php parse.php
+ * <p><b>bold</b>
+ * </p>$
+ * @endcode
+ *
+ * @ingroup Maintenance
+ * @author Antoine Musso <hashar at free dot fr>
+ * @license GNU General Public License 2.0 or later
+ */
+require_once( dirname(__FILE__) . '/Maintenance.php' );
+
+class CLIParser extends Maintenance {
+ protected $parser;
+
+ public function __construct() {
+ parent::__construct();
+ $this->mDescription = "Parse a given wikitext";
+ $this->addOption( 'title', 'Title name for the given wikitext (Default: \'CLIParser\')', false, true );
+ $this->addArg( 'file', 'File containing wikitext (Default: stdin)', false );
+ }
+
+ public function execute() {
+ $this->initParser();
+ print $this->render( $this->WikiText() );
+ }
+
+ /**
+ * @param string $wikitext Wikitext to get rendered
+ * @return string HTML Rendering
+ */
+ public function render( $wikitext ) {
+ return $this->parse( $wikitext )->getText();
+ }
+
+ /**
+ * Get wikitext from a the file passed as argument or STDIN
+ * @return string Wikitext
+ */
+ protected function Wikitext() {
+
+ $php_stdin = 'php://stdin';
+ $input_file = $this->getArg( 0, $php_stdin );
+
+ if( $input_file === $php_stdin ) {
+ $this->error( basename(__FILE__) .": warning: reading wikitext from STDIN\n" );
+ }
+
+ return file_get_contents( $input_file );
+ }
+
+ protected function initParser() {
+ global $wgParserConf;
+ $parserClass = $wgParserConf['class'];
+ $this->parser = new $parserClass();
+ }
+
+ /**
+ * Title object to use for CLI parsing.
+ * Default title is 'CLIParser', it can be overriden with the option
+ * --title <Your:Title>
+ *
+ * @return Title object
+ */
+ protected function getTitle( ) {
+ $title =
+ $this->getOption( 'title' )
+ ? $this->getOption( 'title' )
+ : 'CLIParser' ;
+ return Title::newFromText( $title );
+ }
+
+ /**
+ * @param string $wikitext Wikitext to parse
+ * @return ParserOutput
+ */
+ protected function parse( $wikitext ) {
+ return $this->parser->parse(
+ $wikitext
+ , $this->getTitle()
+ , new ParserOptions()
+ );
+ }
+}
+
+$maintClass = "CLIParser";
+require_once( RUN_MAINTENANCE_IF_MAIN );