maintenance/mwdocgen.php

   1 <?php
   2 /**
   3  * Generate class and file reference documentation for MediaWiki using doxygen.
   4  *
   5  * If the dot DOT language processor is available, attempt call graph
   6  * generation.
   7  *
   8  * Usage:
   9  *   php mwdocgen.php
  10  *
  11  * KNOWN BUGS:
  12  *
  13  * - pass_thru seems to always use buffering (even with ob_implicit_flush()),
  14  * that make output slow when doxygen parses language files.
  15  * - the menu doesnt work, got disabled at revision 13740. Need to code it.
  16  *
  17  * This program is free software; you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation; either version 2 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License along
  28  * with this program; if not, write to the Free Software Foundation, Inc.,
  29  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  30  * http://www.gnu.org/copyleft/gpl.html
  31  *
  32  * @file
  33  * @todo document
  34  * @ingroup Maintenance
  35  *
  36  * @author Antoine Musso <hashar at free dot fr>
  37  * @author Brion Vibber
  38  * @author Alexandre Emsenhuber
  39  * @version first release
  40  */
  41
  42 #
  43 # Variables / Configuration
  44 #
  45
  46 if ( php_sapi_name() != 'cli' ) {
  47         echo 'Run "' . __FILE__ . '" from the command line.';
  48         die( -1 );
  49 }
  50
  51 /** Figure out the base directory for MediaWiki location */
  52 $mwPath = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR;
  53
  54 /** doxygen binary script */
  55 $doxygenBin = 'doxygen';
  56
  57 /** doxygen configuration template for mediawiki */
  58 $doxygenTemplate = $mwPath . 'maintenance/Doxyfile';
  59
  60 /** svnstat command, used to get the version of each file */
  61 $svnstat = $mwPath . 'bin/svnstat';
  62
  63 /** where Phpdoc should output documentation */
  64 $doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR ;
  65
  66 /** MediaWiki subpaths */
  67 $mwPathI = $mwPath . 'includes/';
  68 $mwPathL = $mwPath . 'languages/';
  69 $mwPathM = $mwPath . 'maintenance/';
  70 $mwPathS = $mwPath . 'skins/';
  71
  72 /** Ignored paths relative to $mwPath */
  73 $mwExcludePaths = array(
  74         'images',
  75         'static',
  76 );
  77
  78 /** Variable to get user input */
  79 $input = '';
  80 $exclude_patterns = '';
  81 /** Whether to generates man pages: */
  82 $wgDoxyGenerateMan = false;
  83
  84 #
  85 # Functions
  86 #
  87
  88 define( 'MEDIAWIKI', true );
  89 require_once( "$mwPath/includes/GlobalFunctions.php" );
  90
  91 /**
  92  * Read a line from the shell
  93  * @param $prompt String
  94  * @return string
  95  */
  96 function readaline( $prompt = '' ) {
  97         print $prompt;
  98         $fp = fopen( "php://stdin", "r" );
  99         $resp = trim( fgets( $fp, 1024 ) );
 100         fclose( $fp );
 101         return $resp;
 102 }
 103
 104 /**
 105  * Copied from SpecialVersion::getSvnRevision()
 106  * @param $dir String
 107  * @return Mixed: string or false
 108  */
 109 function getSvnRevision( $dir ) {
 110         // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
 111         $entries = $dir . '/.svn/entries';
 112
 113         if ( !file_exists( $entries ) ) {
 114                 return false;
 115         }
 116
 117         $content = file( $entries );
 118
 119         return intval( $content[3] );
 120 }
 121
 122 /**
 123  * Generate a configuration file given user parameters and return the temporary filename.
 124  * @param $doxygenTemplate String: full path for the template.
 125  * @param $outputDirectory String: directory where the stuff will be output.
 126  * @param $stripFromPath String: path that should be stripped out (usually mediawiki base path).
 127  * @param $currentVersion String: Version number of the software
 128  * @param $svnstat String: path to the svnstat file
 129  * @param $input String: Path to analyze.
 130  * @param $exclude String: Additionals path regex to exclude
 131  * @param $exclude_patterns String: Additionals path regex to exclude
 132  *                 (LocalSettings.php, AdminSettings.php, .svn and .git directories are always excluded)
 133  * @return string
 134  */
 135 function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $svnstat, $input, $exclude, $exclude_patterns ) {
 136
 137         global $wgDoxyGenerateMan;
 138
 139         $template = file_get_contents( $doxygenTemplate );
 140
 141         // Replace template placeholders by correct values.
 142         $replacements = array(
 143                 '{{OUTPUT_DIRECTORY}}' => $outputDirectory,
 144                 '{{STRIP_FROM_PATH}}'  => $stripFromPath,
 145                 '{{CURRENT_VERSION}}'  => $currentVersion,
 146                 '{{SVNSTAT}}'          => $svnstat,
 147                 '{{INPUT}}'            => $input,
 148                 '{{EXCLUDE}}'          => $exclude,
 149                 '{{EXCLUDE_PATTERNS}}' => $exclude_patterns,
 150                 '{{HAVE_DOT}}'         => `which dot` ? 'YES' : 'NO',
 151                 '{{GENERATE_MAN}}'     => $wgDoxyGenerateMan ? 'YES' : 'NO',
 152         );
 153         $tmpCfg = str_replace( array_keys( $replacements ), array_values( $replacements ), $template );
 154         $tmpFileName = tempnam( wfTempDir(), 'mwdocgen-' );
 155         file_put_contents( $tmpFileName , $tmpCfg ) or die( "Could not write doxygen configuration to file $tmpFileName\n" );
 156
 157         return $tmpFileName;
 158 }
 159
 160 #
 161 # Main !
 162 #
 163
 164 unset( $file );
 165
 166 if ( is_array( $argv ) ) {
 167         for ($i = 0; $i < count($argv); $i++ ) {
 168                 switch( $argv[$i] ) {
 169                 case '--all':         $input = 0; break;
 170                 case '--includes':    $input = 1; break;
 171                 case '--languages':   $input = 2; break;
 172                 case '--maintenance': $input = 3; break;
 173                 case '--skins':       $input = 4; break;
 174                 case '--file':
 175                         $input = 5;
 176                         $i++;
 177                         if ( isset( $argv[$i] ) ) {
 178                                 $file = $argv[$i];
 179                         }
 180                         break;
 181                 case '--no-extensions': $input = 6; break;
 182                 case '--output':
 183                         $i++;
 184                         if ( isset( $argv[$i] ) ) {
 185                                 $doxyOutput = realpath( $argv[$i] );
 186                         }
 187                         break;
 188                 case '--generate-man':
 189                         $wgDoxyGenerateMan = true;
 190                         break;
 191                 case '--help':
 192                         print <<<END
 193 Usage: php mwdocgen.php [<command>] [<options>]
 194
 195 Commands:
 196     --all           Process entire codebase
 197     --includes      Process only files in includes/ dir
 198     --languages     Process only files in languages/ dir
 199     --maintenance   Process only files in maintenance/ dir
 200     --skins         Process only files in skins/ dir
 201     --file <file>   Process only the given file
 202     --no-extensions Process everything but extensions directorys
 203
 204 If no command is given, you will be prompted.
 205
 206 Other options:
 207     --output <dir>  Set output directory (default $doxyOutput)
 208     --generate-man  Generates man page documentation
 209     --help          Show this help and exit.
 210
 211
 212 END;
 213                         exit(0);
 214                         break;
 215                 }
 216         }
 217 }
 218
 219 // TODO : generate a list of paths ))
 220
 221 if ( $input === '' ) {
 222         echo <<<OPTIONS
 223 Several documentation possibilities:
 224  0 : whole documentation (1 + 2 + 3 + 4)
 225  1 : only includes
 226  2 : only languages
 227  3 : only maintenance
 228  4 : only skins
 229  5 : only a given file
 230  6 : all but the extensions directory
 231 OPTIONS;
 232         while ( !is_numeric( $input ) )
 233         {
 234                 $input = readaline( "\nEnter your choice [0]:" );
 235                 if ( $input == '' ) {
 236                         $input = 0;
 237                 }
 238         }
 239 }
 240
 241 switch ( $input ) {
 242 case 0: $input = $mwPath;  break;
 243 case 1: $input = $mwPathI; break;
 244 case 2: $input = $mwPathL; break;
 245 case 3: $input = $mwPathM; break;
 246 case 4: $input = $mwPathS; break;
 247 case 5:
 248         if ( !isset( $file ) ) {
 249                 $file = readaline( "Enter file name $mwPath" );
 250         }
 251         $input = $mwPath . $file;
 252         break;
 253 case 6:
 254         $input = $mwPath;
 255         $exclude_patterns = 'extensions';
 256 }
 257
 258 $versionNumber = getSvnRevision( $input );
 259 if ( $versionNumber === false ) { # Not using subversion ?
 260         $svnstat = ''; # Not really useful if subversion not available
 261         # @todo FIXME
 262         $version = 'trunk';
 263 } else {
 264         $version = "trunk (r$versionNumber)";
 265 }
 266
 267 // Generate path exclusions
 268 $excludedPaths = $mwPath . join( " $mwPath", $mwExcludePaths );
 269 print "EXCLUDE: $excludedPaths\n\n";
 270
 271 $generatedConf = generateConfigFile( $doxygenTemplate, $doxyOutput, $mwPath, $version, $svnstat, $input, $excludedPaths, $exclude_patterns );
 272 $command = $doxygenBin . ' ' . $generatedConf;
 273
 274 echo <<<TEXT
 275 ---------------------------------------------------
 276 Launching the command:
 277
 278 $command
 279
 280 ---------------------------------------------------
 281
 282 TEXT;
 283
 284 passthru( $command );
 285
 286 echo <<<TEXT
 287 ---------------------------------------------------
 288 Doxygen execution finished.
 289 Check above for possible errors.
 290
 291 You might want to delete the temporary file $generatedConf
 292
 293 TEXT;