archwiki/maintenance/formatInstallDoc.php

79 lines
2.4 KiB
PHP

<?php
/**
* Format RELEASE-NOTE file to wiki text or HTML markup.
*
* 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
*/
use MediaWiki\MediaWikiServices;
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup.
*
* @ingroup Maintenance
*/
class FormatInstallDoc extends Maintenance {
public function __construct() {
parent::__construct();
$this->addArg( 'path', 'The file name to format', false );
$this->addOption( 'outfile', 'The output file name', false, true );
$this->addOption( 'html', 'Use HTML output format. By default, wikitext is used.' );
}
public function execute() {
if ( $this->hasArg( 0 ) ) {
$fileName = $this->getArg( 0 );
$inFile = fopen( $fileName, 'r' );
if ( !$inFile ) {
$this->fatalError( "Unable to open input file \"$fileName\"" );
}
} else {
$inFile = STDIN;
}
if ( $this->hasOption( 'outfile' ) ) {
$fileName = $this->getOption( 'outfile' );
$outFile = fopen( $fileName, 'w' );
if ( !$outFile ) {
$this->fatalError( "Unable to open output file \"$fileName\"" );
}
} else {
$outFile = STDOUT;
}
$inText = stream_get_contents( $inFile );
$outText = InstallDocFormatter::format( $inText );
if ( $this->hasOption( 'html' ) ) {
$parser = MediaWikiServices::getInstance()->getParser();
$opt = ParserOptions::newFromAnon();
$title = Title::newFromText( 'Text file' );
$out = $parser->parse( $outText, $title, $opt );
$outText = "<html><body>\n" . $out->getText() . "\n</body></html>\n";
}
fwrite( $outFile, $outText );
}
}
$maintClass = FormatInstallDoc::class;
require_once RUN_MAINTENANCE_IF_MAIN;