Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
86.21% |
25 / 29 |
|
50.00% |
1 / 2 |
CRAP | |
0.00% |
0 / 1 |
| FormatInstallDoc | |
86.21% |
25 / 29 |
|
50.00% |
1 / 2 |
7.13 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
4 / 4 |
|
100.00% |
1 / 1 |
1 | |||
| execute | |
84.00% |
21 / 25 |
|
0.00% |
0 / 1 |
6.15 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * Format RELEASE-NOTE file to wiki text or HTML markup. |
| 4 | * |
| 5 | * @license GPL-2.0-or-later |
| 6 | * @file |
| 7 | * @ingroup Maintenance |
| 8 | */ |
| 9 | |
| 10 | use MediaWiki\Installer\InstallDocFormatter; |
| 11 | use MediaWiki\Maintenance\Maintenance; |
| 12 | use MediaWiki\Parser\ParserOptions; |
| 13 | use MediaWiki\Title\Title; |
| 14 | |
| 15 | // @codeCoverageIgnoreStart |
| 16 | require_once __DIR__ . '/Maintenance.php'; |
| 17 | // @codeCoverageIgnoreEnd |
| 18 | |
| 19 | /** |
| 20 | * Maintenance script that formats RELEASE-NOTE file to wiki text or HTML markup. |
| 21 | * |
| 22 | * @ingroup Maintenance |
| 23 | */ |
| 24 | class FormatInstallDoc extends Maintenance { |
| 25 | public function __construct() { |
| 26 | parent::__construct(); |
| 27 | $this->addArg( 'path', 'The file name to format', false ); |
| 28 | $this->addOption( 'outfile', 'The output file name', false, true ); |
| 29 | $this->addOption( 'html', 'Use HTML output format. By default, wikitext is used.' ); |
| 30 | } |
| 31 | |
| 32 | public function execute() { |
| 33 | if ( $this->hasArg( 0 ) ) { |
| 34 | $fileName = $this->getArg( 0 ); |
| 35 | $inFile = fopen( $fileName, 'r' ); |
| 36 | if ( !$inFile ) { |
| 37 | $this->fatalError( "Unable to open input file \"$fileName\"" ); |
| 38 | } |
| 39 | } else { |
| 40 | $inFile = STDIN; |
| 41 | } |
| 42 | |
| 43 | if ( $this->hasOption( 'outfile' ) ) { |
| 44 | $fileName = $this->getOption( 'outfile' ); |
| 45 | $outFile = fopen( $fileName, 'w' ); |
| 46 | if ( !$outFile ) { |
| 47 | $this->fatalError( "Unable to open output file \"$fileName\"" ); |
| 48 | } |
| 49 | } else { |
| 50 | $outFile = STDOUT; |
| 51 | } |
| 52 | |
| 53 | $inText = stream_get_contents( $inFile ); |
| 54 | $outText = InstallDocFormatter::format( $inText ); |
| 55 | |
| 56 | if ( $this->hasOption( 'html' ) ) { |
| 57 | $parser = $this->getServiceContainer()->getParser(); |
| 58 | $opt = ParserOptions::newFromAnon(); |
| 59 | $title = Title::newFromText( 'Text file' ); |
| 60 | $out = $parser->parse( $outText, $title, $opt ); |
| 61 | $outText = "<html><body>\n" . |
| 62 | // TODO T371008 consider if using the Content framework makes sense instead of creating the pipeline |
| 63 | $this->getServiceContainer()->getDefaultOutputPipeline() |
| 64 | ->run( $out, $opt, [] ) |
| 65 | ->getContentHolderText() |
| 66 | . "\n</body></html>\n"; |
| 67 | } |
| 68 | |
| 69 | fwrite( $outFile, $outText ); |
| 70 | } |
| 71 | } |
| 72 | |
| 73 | // @codeCoverageIgnoreStart |
| 74 | $maintClass = FormatInstallDoc::class; |
| 75 | require_once RUN_MAINTENANCE_IF_MAIN; |
| 76 | // @codeCoverageIgnoreEnd |