X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=maintenance%2Fmwdocgen.php;h=3a78f6785db6d4c21e3321e53a06321ae87a7ea1;hb=0cfb39fda2df50967c96e3c8bd7387e5f74508c8;hp=135f7ed4dd89976a94ad575775cc322675ce7fd2;hpb=6fae318406e72471153826c5bac16a476c01dc03;p=lhc%2Fweb%2Fwiklou.git diff --git a/maintenance/mwdocgen.php b/maintenance/mwdocgen.php index 135f7ed4dd..3a78f6785d 100644 --- a/maintenance/mwdocgen.php +++ b/maintenance/mwdocgen.php @@ -1,6 +1,6 @@ * @version first release @@ -23,60 +30,124 @@ # if( php_sapi_name() != 'cli' ) { - echo "Run me from the command line."; + echo 'Run me from the command line.'; die( -1 ); } -/** Phpdoc script with full path */ -#$pdExec = '/usr/bin/phpdoc'; -$pdExec = 'phpdoc'; +/** Figure out the base directory for MediaWiki location */ +$mwPath = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR; + +/** Global variable: temporary directory */ +$tmpPath = '/tmp/'; -/** Figure out the base directory. */ -$here = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR; +/** doxygen binary script */ +$doxygenBin = 'doxygen'; + +/** doxygen configuration template for mediawiki */ +$doxygenTemplate = $mwPath . 'maintenance/Doxyfile'; + +/** svnstat command, used to get the version of each file */ +$svnstat = $mwPath . 'bin/svnstat'; /** where Phpdoc should output documentation */ -#$pdOutput = '/var/www/mwdoc/'; -$pdOutput = "{$here}docs" . DIRECTORY_SEPARATOR . 'html'; - -/** Some more Phpdoc settings */ -# This will be used as the default for all files that don't have a package, -# it's useful to set it to something like 'untagged' to hunt down and fix files -# that don't have a package name declared. -$pdOthers = " -dn MediaWiki"; -$pdOthers .= ' --title "MediaWiki generated documentation"'; -$pdOthers .= ' --output "HTML:Smarty:HandS"'; #,HTML:Smarty:HandS"'; ###### HTML:frames:DOM/earthli -$pdOthers .= ' --ignore AdminSettings.php,LocalSettings.php,tests/LocalTestSettings.php'; -$pdOthers .= ' --parseprivate on'; -$pdOthers .= ' --sourcecode on'; - -/** MediaWiki location */ -#$mwPath = '/var/www/mediawiki/'; -$mwPath = "{$here}"; +#$doxyOutput = '/var/www/mwdoc/'; +$doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR ; /** MediaWiki subpaths */ $mwPathI = $mwPath.'includes/'; $mwPathL = $mwPath.'languages/'; $mwPathM = $mwPath.'maintenance/'; $mwPathS = $mwPath.'skins/'; -$mwBaseFiles = $mwPath.'*php '; - /** Variable to get user input */ $input = ''; -/** shell command that will be run */ -$command = ''; # # Functions # -function readaline( $prompt = '') { +/** + * Read a line from the shell + * @param $prompt String + */ +function readaline( $prompt = '' ){ print $prompt; $fp = fopen( "php://stdin", "r" ); $resp = trim( fgets( $fp, 1024 ) ); fclose( $fp ); return $resp; +} + +/** + * Copied from SpecialVersion::getSvnRevision() + * @param $dir String + * @return Mixed: string or false + */ +function getSvnRevision( $dir ) { + // http://svnbook.red-bean.com/nightly/en/svn.developer.insidewc.html + $entries = $dir . '/.svn/entries'; + + if( !file_exists( $entries ) ) { + return false; + } + + $content = file( $entries ); + + // check if file is xml (subversion release <= 1.3) or not (subversion release = 1.4) + if( preg_match( '/^<\?xml/', $content[0] ) ) { + // subversion is release <= 1.3 + if( !function_exists( 'simplexml_load_file' ) ) { + // We could fall back to expat... YUCK + return false; + } + + $xml = simplexml_load_file( $entries ); + + if( $xml ) { + foreach( $xml->entry as $entry ) { + if( $xml->entry[0]['name'] == '' ) { + // The directory entry should always have a revision marker. + if( $entry['revision'] ) { + return intval( $entry['revision'] ); + } + } + } + } + return false; + } else { + // subversion is release 1.4 + return intval( $content[3] ); } +} + +/** + * Generate a configuration file given user parameters and return the temporary filename. + * @param $doxygenTemplate String: full path for the template. + * @param $outputDirectory String: directory where the stuff will be output. + * @param $stripFromPath String: path that should be stripped out (usually mediawiki base path). + * @param $currentVersion String: Version number of the software + * @param $svnstat String: path to the svnstat file + * @param $input String: Path to analyze. + */ +function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $svnstat, $input ){ + global $tmpPath; + + $template = file_get_contents( $doxygenTemplate ); + + // Replace template placeholders by correct values. + $replacements = array( + '{{OUTPUT_DIRECTORY}}' => $outputDirectory, + '{{STRIP_FROM_PATH}}' => $stripFromPath, + '{{CURRENT_VERSION}}' => $currentVersion, + '{{SVNSTAT}}' => $svnstat, + '{{INPUT}}' => $input, + ); + $tmpCfg = str_replace( array_keys( $replacements ), array_values( $replacements ), $template ); + $tmpFileName = $tmpPath . 'mwdocgen'. rand() .'.tmp'; + file_put_contents( $tmpFileName , $tmpCfg ) or die("Could not write doxygen configuration to file $tmpFileName\n"); + + return $tmpFileName; +} # # Main ! @@ -100,14 +171,18 @@ if( is_array( $argv ) && isset( $argv[1] ) ) { } } +// TODO : generate a list of paths )) + if( $input === '' ) { -?>Several documentation possibilities: - 0 : whole documentation (1 + 2 + 3) + echo << +echo << +$command --------------------------------------------------- - +echo << +TEXT;