mwdocgen.php

Go to the documentation of this file.

<?php
use MediaWiki\Shell\Shell;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
class MWDocGen extends Maintenance {
    private $doxygen;
    private $mwVersion;
    private $output;
    private $input;
    private $inputFilter;
    private $template;
    private $excludes;
    private $doDot;
 
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Build doxygen documentation' );
 
        $this->addOption( 'doxygen',
            'Path to doxygen',
            false, true );
        $this->addOption( 'version',
            'Pass a MediaWiki version',
            false, true );
        $this->addOption( 'file',
            "Only process given file or directory. Multiple values " .
            "accepted with comma separation. Path relative to MW_INSTALL_PATH.",
            false, true );
        $this->addOption( 'output',
            'Path to write doc to',
            false, true );
        $this->addOption( 'extensions',
            'Process the extensions/ directory as well (ignored if --file is used)' );
        $this->addOption( 'skins',
            'Process the skins/ directory as well (ignored if --file is used)' );
    }
 
    public function getDbType() {
        return Maintenance::DB_NONE;
    }
 
    protected function init() {
        global $wgPhpCli;
 
        $this->doxygen = $this->getOption( 'doxygen', 'doxygen' );
        $this->mwVersion = $this->getOption( 'version', 'master' );
 
        $this->output = $this->getOption( 'output', 'docs' );
 
        // Do not use wfShellWikiCmd, because mwdoc-filter.php is not
        // a Maintenance script.
        $this->inputFilter = Shell::escape( [
            $wgPhpCli,
            MW_INSTALL_PATH . '/maintenance/mwdoc-filter.php'
        ] );
 
        $this->template = MW_INSTALL_PATH . '/maintenance/Doxyfile';
        $this->excludes = [
            'cache',
            'images',
        ];
 
        $file = $this->getOption( 'file' );
        if ( $file !== null ) {
            $this->input = '';
            foreach ( explode( ',', $file ) as $input ) {
                // Doxygen inputs are space separated and double quoted
                $this->input .= " \"$input\"";
            }
        } else {
            // If no explicit --file filter is set, we're indexing all of MediaWiki core
            // in MW_INSTALL_PATH, but not extension and skin submodules (T317451).
            $this->input = '';
            if ( !$this->hasOption( 'extensions' ) ) {
                $this->excludes[] = 'extensions';
            }
            if ( !$this->hasOption( 'skins' ) ) {
                $this->excludes[] = 'skins';
            }
        }
 
        $this->doDot = (bool)shell_exec( 'which dot' );
    }
 
    public function execute() {
        $this->init();
 
        # Build out directories we want to exclude
        $exclude = '';
        foreach ( $this->excludes as $item ) {
            $exclude .= " $item";
        }
 
        $conf = strtr( file_get_contents( $this->template ),
            [
                '{{OUTPUT_DIRECTORY}}' => $this->output,
                '{{CURRENT_VERSION}}' => $this->mwVersion,
                '{{INPUT}}' => $this->input,
                '{{EXCLUDE}}' => $exclude,
                '{{HAVE_DOT}}' => $this->doDot ? 'YES' : 'NO',
                '{{INPUT_FILTER}}' => $this->inputFilter,
            ]
        );
 
        $tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
        if ( file_put_contents( $tmpFile, $conf ) === false ) {
            $this->fatalError( "Could not write doxygen configuration to file $tmpFile\n" );
        }
 
        $command = $this->doxygen . ' ' . $tmpFile;
        $this->output( "Executing command:\n$command\n" );
 
        $exitcode = 1;
        system( $command, $exitcode );
 
        $this->output( <<<TEXT
---------------------------------------------------
Doxygen execution finished.
Check above for possible errors.
 
You might want to delete the temporary file:
 $tmpFile
---------------------------------------------------
 
TEXT
        );
 
        if ( $exitcode !== 0 ) {
            $this->fatalError( "Something went wrong (exit: $exitcode)\n", $exitcode );
        }
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = MWDocGen::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd