mediawiki-extensions-Syntax.../maintenance/updateLexerList.php
Ryan Schmidt 57b3580811 Fix lexer list parsing on Windows
When using a non-bundled Pygments (which is required on Windows, as the
bundled version is an ELF binary), we call into the Pygments executable
to generate the list of supported languages (lexers). This list seems to
occasionally include carraige returns, causing some languages to not be
processed correctly. Trim those CRs out so the language list is
accurate.

Bug: T336087
Change-Id: If8b1f145dd10e2c4707d6d32927e85d1d2459f15
(cherry picked from commit 2ae82c7fb7)
2023-05-11 19:01:50 +00:00

83 lines
2.4 KiB
PHP

<?php
/**
* Script to update list of supported lexers.
*
* 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
* @author Ori Livneh <ori@wikimedia.org>
* @ingroup Maintenance
*/
use MediaWiki\Shell\Shell;
use Wikimedia\StaticArrayWriter;
$IP = getenv( 'MW_INSTALL_PATH' ) ?: __DIR__ . '/../../..';
require_once "$IP/maintenance/Maintenance.php";
class UpdateLexerList extends Maintenance {
public function __construct() {
parent::__construct();
$this->requireExtension( 'SyntaxHighlight' );
$this->addDescription( 'Update list of lexers supported by SyntaxHighlight_GeSHi' );
}
public function execute() {
$header = 'Generated by ' . basename( __FILE__ );
$lexers = [];
$result = Shell::command(
SyntaxHighlight::getPygmentizePath(),
'-L', 'lexer'
)
->restrict( Shell::RESTRICT_DEFAULT | Shell::NO_NETWORK )
->execute();
if ( $result->getExitCode() != 0 ) {
$this->fatalError( 'Non-zero exit code: ' . $result->getStderr() );
}
$output = $result->getStdout();
foreach ( explode( "\n", $output ) as $line ) {
if ( substr( $line, 0, 1 ) === '*' ) {
$newLexers = explode( ', ', trim( $line, "* :\r\n" ) );
// Skip internal, unnamed lexers
if ( $newLexers[0] !== '' ) {
$lexers = array_merge( $lexers, $newLexers );
}
}
}
$lexers = array_unique( $lexers );
sort( $lexers );
$data = [];
foreach ( $lexers as $lexer ) {
$data[$lexer] = true;
}
$writer = new StaticArrayWriter();
$code = $writer->create( $data, $header );
file_put_contents( __DIR__ . '/../SyntaxHighlight.lexers.php', $code );
$this->output( "Updated language list written to SyntaxHighlight.lexers.php\n" );
}
}
$maintClass = UpdateLexerList::class;
require_once RUN_MAINTENANCE_IF_MAIN;