maintenance/formatInstallDoc.php

   1 <?php
   2 /**
   3  * Format RELEASE-NOTE file to wiki text or HTML markup.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 use MediaWiki\MediaWikiServices;
  25
  26 require_once __DIR__ . '/Maintenance.php';
  27
  28 /**
  29  * Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup.
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class FormatInstallDoc extends Maintenance {
  34         function __construct() {
  35                 parent::__construct();
  36                 $this->addArg( 'path', 'The file name to format', false );
  37                 $this->addOption( 'outfile', 'The output file name', false, true );
  38                 $this->addOption( 'html', 'Use HTML output format. By default, wikitext is used.' );
  39         }
  40
  41         function execute() {
  42                 if ( $this->hasArg( 0 ) ) {
  43                         $fileName = $this->getArg( 0 );
  44                         $inFile = fopen( $fileName, 'r' );
  45                         if ( !$inFile ) {
  46                                 $this->fatalError( "Unable to open input file \"$fileName\"" );
  47                         }
  48                 } else {
  49                         $inFile = STDIN;
  50                 }
  51
  52                 if ( $this->hasOption( 'outfile' ) ) {
  53                         $fileName = $this->getOption( 'outfile' );
  54                         $outFile = fopen( $fileName, 'w' );
  55                         if ( !$outFile ) {
  56                                 $this->fatalError( "Unable to open output file \"$fileName\"" );
  57                         }
  58                 } else {
  59                         $outFile = STDOUT;
  60                 }
  61
  62                 $inText = stream_get_contents( $inFile );
  63                 $outText = InstallDocFormatter::format( $inText );
  64
  65                 if ( $this->hasOption( 'html' ) ) {
  66                         $parser = MediaWikiServices::getInstance()->getParser();
  67                         $opt = new ParserOptions;
  68                         $title = Title::newFromText( 'Text file' );
  69                         $out = $parser->parse( $outText, $title, $opt );
  70                         $outText = "<html><body>\n" . $out->getText() . "\n</body></html>\n";
  71                 }
  72
  73                 fwrite( $outFile, $outText );
  74         }
  75 }
  76
  77 $maintClass = FormatInstallDoc::class;
  78 require_once RUN_MAINTENANCE_IF_MAIN;