Current File : //data/www_bck/varak.net_bck/havranipapuce.varak.net/maintenance/mwdocgen.php
<?php
/**
* Generate class and file reference documentation for MediaWiki using doxygen.
*
* If the dot DOT language processor is available, attempt call graph
* generation.
*
* Usage:
* php mwdocgen.php
*
* 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
* @todo document
* @ingroup Maintenance
*
* @author Antoine Musso <hashar at free dot fr>
* @author Brion Vibber
* @author Alexandre Emsenhuber
* @version first release
*/
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script that builds doxygen documentation.
* @ingroup Maintenance
*/
class MWDocGen extends Maintenance {
/**
* Prepare Maintenance class
*/
public function __construct() {
parent::__construct();
$this->mDescription = 'Build doxygen documentation';
$this->addOption( 'doxygen',
'Path to doxygen',
false, true );
$this->addOption( 'version',
'Pass a MediaWiki version',
false, true );
$this->addOption( 'generate-man',
'Whether to generate man files' );
$this->addOption( 'file',
"Only process given file or directory. Multiple values " .
"accepted with comma separation. Path relative to \$IP.",
false, true );
$this->addOption( 'output',
'Path to write doc to',
false, true );
$this->addOption( 'no-extensions',
'Ignore extensions' );
}
public function getDbType() {
return Maintenance::DB_NONE;
}
protected function init() {
global $IP;
$this->doxygen = $this->getOption( 'doxygen', 'doxygen' );
$this->mwVersion = $this->getOption( 'version', 'master' );
$this->input = '';
$inputs = explode( ',', $this->getOption( 'file', '' ) );
foreach ( $inputs as $input ) {
# Doxygen inputs are space separted and double quoted
$this->input .= " \"$IP/$input\"";
}
$this->output = $this->getOption( 'output', "$IP/docs" );
$this->inputFilter = wfShellWikiCmd(
$IP . '/maintenance/mwdoc-filter.php' );
$this->template = $IP . '/maintenance/Doxyfile';
$this->excludes = array(
'vendor',
'node_modules',
'images',
'static',
);
$this->excludePatterns = array();
if ( $this->hasOption( 'no-extensions' ) ) {
$this->excludePatterns[] = 'extensions';
}
$this->doDot = `which dot`;
$this->doMan = $this->hasOption( 'generate-man' );
}
public function execute() {
global $IP;
$this->init();
# Build out directories we want to exclude
$exclude = '';
foreach ( $this->excludes as $item ) {
$exclude .= " $IP/$item";
}
$excludePatterns = implode( ' ', $this->excludePatterns );
$conf = strtr( file_get_contents( $this->template ),
array(
'{{OUTPUT_DIRECTORY}}' => $this->output,
'{{STRIP_FROM_PATH}}' => $IP,
'{{CURRENT_VERSION}}' => $this->mwVersion,
'{{INPUT}}' => $this->input,
'{{EXCLUDE}}' => $exclude,
'{{EXCLUDE_PATTERNS}}' => $excludePatterns,
'{{HAVE_DOT}}' => $this->doDot ? 'YES' : 'NO',
'{{GENERATE_MAN}}' => $this->doMan ? 'YES' : 'NO',
'{{INPUT_FILTER}}' => $this->inputFilter,
)
);
$tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
if ( file_put_contents( $tmpFile, $conf ) === false ) {
$this->error( "Could not write doxygen configuration to file $tmpFile\n",
/** exit code: */ 1 );
}
$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->error( "Something went wrong (exit: $exitcode)\n",
$exitcode );
}
}
}
$maintClass = 'MWDocGen';
require_once RUN_MAINTENANCE_IF_MAIN;
Mini Shell