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
  82 #
  83 # Functions
  84 #
  85
  86 define( 'MEDIAWIKI', true );
  87 require_once( "$mwPath/includes/GlobalFunctions.php" );
  88
  89 /**
  90  * Read a line from the shell
  91  * @param $prompt String
  92  * @return string
  93  */
  94 function readaline( $prompt = '' ) {
  95         print $prompt;
  96         $fp = fopen( "php://stdin", "r" );
  97         $resp = trim( fgets( $fp, 1024 ) );
  98         fclose( $fp );
  99         return $resp;
 100 }
 101
 102 /**
 103  * Copied from SpecialVersion::getSvnRevision()
 104  * @param $dir String
 105  * @return Mixed: string or false
 106  */
 107 function getSvnRevision( $dir ) {
 108         // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html
 109         $entries = $dir . '/.svn/entries';
 110
 111         if ( !file_exists( $entries ) ) {
 112                 return false;
 113         }
 114
 115         $content = file( $entries );
 116
 117         // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4)
 118         if ( preg_match( '/^<\?xml/', $content[0] ) ) {
 119                 // subversion is release <= 1.3
 120                 if ( !function_exists( 'simplexml_load_file' ) ) {
 121                         // We could fall back to expat... YUCK
 122                         return false;
 123                 }
 124
 125                 $xml = simplexml_load_file( $entries );
 126
 127                 if ( $xml ) {
 128                         foreach ( $xml->entry as $entry ) {
 129                                 if ( $xml->entry[0]['name'] == '' ) {
 130                                         // The directory entry should always have a revision marker.
 131                                         if ( $entry['revision'] ) {
 132                                                 return intval( $entry['revision'] );
 133                                         }
 134                                 }
 135                         }
 136                 }
 137                 return false;
 138         } else {
 139                 // subversion is release 1.4
 140                 return intval( $content[3] );
 141         }
 142 }
 143
 144 /**
 145  * Generate a configuration file given user parameters and return the temporary filename.
 146  * @param $doxygenTemplate String: full path for the template.
 147  * @param $outputDirectory String: directory where the stuff will be output.
 148  * @param $stripFromPath String: path that should be stripped out (usually mediawiki base path).
 149  * @param $currentVersion String: Version number of the software
 150  * @param $svnstat String: path to the svnstat file
 151  * @param $input String: Path to analyze.
 152  * @param $exclude String: Additionals path regex to exclude
 153  * @param $exclude_patterns String: Additionals path regex to exclude
 154  *                 (LocalSettings.php, AdminSettings.php, .svn and .git directories are always excluded)
 155  * @return string
 156  */
 157 function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $svnstat, $input, $exclude, $exclude_patterns ) {
 158
 159         global $wgDoxyGenerateMan;
 160
 161         $template = file_get_contents( $doxygenTemplate );
 162
 163         // Replace template placeholders by correct values.
 164         $replacements = array(
 165                 '{{OUTPUT_DIRECTORY}}' => $outputDirectory,
 166                 '{{STRIP_FROM_PATH}}'  => $stripFromPath,
 167                 '{{CURRENT_VERSION}}'  => $currentVersion,
 168                 '{{SVNSTAT}}'          => $svnstat,
 169                 '{{INPUT}}'            => $input,
 170                 '{{EXCLUDE}}'          => $exclude,
 171                 '{{EXCLUDE_PATTERNS}}' => $exclude_patterns,
 172                 '{{HAVE_DOT}}'         => `which dot` ? 'YES' : 'NO',
 173                 '{{GENERATE_MAN}}'     => $wgDoxyGenerateMan ? 'YES' : 'NO',
 174         );
 175         $tmpCfg = str_replace( array_keys( $replacements ), array_values( $replacements ), $template );
 176         $tmpFileName = tempnam( wfTempDir(), 'mwdocgen-' );
 177         file_put_contents( $tmpFileName , $tmpCfg ) or die( "Could not write doxygen configuration to file $tmpFileName\n" );
 178
 179         return $tmpFileName;
 180 }
 181
 182 #
 183 # Main !
 184 #
 185
 186 unset( $file );
 187
 188 if ( is_array( $argv ) ) {
 189         for ($i = 0; $i < count($argv); $i++ ) {
 190                 switch( $argv[$i] ) {
 191                 case '--all':         $input = 0; break;
 192                 case '--includes':    $input = 1; break;
 193                 case '--languages':   $input = 2; break;
 194                 case '--maintenance': $input = 3; break;
 195                 case '--skins':       $input = 4; break;
 196                 case '--file':
 197                         $input = 5;
 198                         $i++;
 199                         if ( isset( $argv[$i] ) ) {
 200                                 $file = $argv[$i];
 201                         }
 202                         break;
 203                 case '--no-extensions': $input = 6; break;
 204                 case '--output':
 205                         $i++;
 206                         if ( isset( $argv[$i] ) ) {
 207                                 $doxyOutput = realpath( $argv[$i] );
 208                         }
 209                         break;
 210                 case '--generate-man':
 211                         $wgDoxyGenerateMan = true;
 212                         break;
 213                 case '--help':
 214                         print <<<END
 215 Usage: php mwdocgen.php [<command>] [<options>]
 216
 217 Commands:
 218     --all           Process entire codebase
 219     --includes      Process only files in includes/ dir
 220     --languages     Process only files in languages/ dir
 221     --maintenance   Process only files in maintenance/ dir
 222     --skins         Process only files in skins/ dir
 223     --file <file>   Process only the given file
 224     --no-extensions Process everything but extensions directorys
 225
 226 If no command is given, you will be prompted.
 227
 228 Other options:
 229     --output <dir>  Set output directory (default $doxyOutput)
 230     --generate-man  Generates man page documentation
 231     --help          Show this help and exit.
 232
 233
 234 END;
 235                         exit(0);
 236                         break;
 237                 }
 238         }
 239 }
 240
 241 // TODO : generate a list of paths ))
 242
 243 if ( $input === '' ) {
 244         echo <<<OPTIONS
 245 Several documentation possibilities:
 246  0 : whole documentation (1 + 2 + 3 + 4)
 247  1 : only includes
 248  2 : only languages
 249  3 : only maintenance
 250  4 : only skins
 251  5 : only a given file
 252  6 : all but the extensions directory
 253 OPTIONS;
 254         while ( !is_numeric( $input ) )
 255         {
 256                 $input = readaline( "\nEnter your choice [0]:" );
 257                 if ( $input == '' ) {
 258                         $input = 0;
 259                 }
 260         }
 261 }
 262
 263 switch ( $input ) {
 264 case 0: $input = $mwPath;  break;
 265 case 1: $input = $mwPathI; break;
 266 case 2: $input = $mwPathL; break;
 267 case 3: $input = $mwPathM; break;
 268 case 4: $input = $mwPathS; break;
 269 case 5:
 270         if ( !isset( $file ) ) {
 271                 $file = readaline( "Enter file name $mwPath" );
 272         }
 273         $input = $mwPath . $file;
 274 case 6:
 275         $input = $mwPath;
 276         $exclude_patterns = 'extensions';
 277 }
 278
 279 $versionNumber = getSvnRevision( $input );
 280 if ( $versionNumber === false ) { # Not using subversion ?
 281         $svnstat = ''; # Not really useful if subversion not available
 282         # @todo FIXME
 283         $version = 'trunk';
 284 } else {
 285         $version = "trunk (r$versionNumber)";
 286 }
 287
 288 // Generate path exclusions
 289 $excludedPaths = $mwPath . join( " $mwPath", $mwExcludePaths );
 290 print "EXCLUDE: $excludedPaths\n\n";
 291
 292 $generatedConf = generateConfigFile( $doxygenTemplate, $doxyOutput, $mwPath, $version, $svnstat, $input, $excludedPaths, $exclude_patterns );
 293 $command = $doxygenBin . ' ' . $generatedConf;
 294
 295 echo <<<TEXT
 296 ---------------------------------------------------
 297 Launching the command:
 298
 299 $command
 300
 301 ---------------------------------------------------
 302
 303 TEXT;
 304
 305 passthru( $command );
 306
 307 echo <<<TEXT
 308 ---------------------------------------------------
 309 Doxygen execution finished.
 310 Check above for possible errors.
 311
 312 You might want to delete the temporary file $generatedConf
 313
 314 TEXT;