1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?php
/**
* Script to easily generate the mediawiki documentation using doxygen.
*
* By default it will generate the whole documentation but you will be able to
* generate just some parts.
*
* Usage:
* php mwdocgen.php
*
* Then make a selection from the menu
*
* KNOWN BUGS:
*
* - pass_thru seems to always use buffering (even with ob_implicit_flush()),
* that make output slow when doxygen parses language files.
* - the menu doesnt work, got disabled at revision 13740. Need to code it.
*
*
* @file
* @todo document
* @ingroup Maintenance
*
* @author Ashar Voultoiz <thoane@altern.org>
* @version first release
*/
#
# Variables / Configuration
#
if( php_sapi_name() != 'cli' ) {
echo 'Run me from the command line.';
die( -1 );
}
/** Figure out the base directory for MediaWiki location */
$mwPath = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR;
/** Global variable: temporary directory */
$tmpPath = '/tmp/';
/** 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 */
#$doxyOutput = '/var/www/mwdoc/';
$doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR ;
/** MediaWiki subpaths */
$mwPathI = $mwPath.'includes/';
$mwPathL = $mwPath.'languages/';
$mwPathM = $mwPath.'maintenance/';
$mwPathS = $mwPath.'skins/';
/** Variable to get user input */
$input = '';
#
# Functions
#
/**
* 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 !
#
unset( $file );
if( is_array( $argv ) && isset( $argv[1] ) ) {
switch( $argv[1] ) {
case '--all': $input = 0; break;
case '--includes': $input = 1; break;
case '--languages': $input = 2; break;
case '--maintenance': $input = 3; break;
case '--skins': $input = 4; break;
case '--file':
$input = 5;
if( isset( $argv[2] ) ) {
$file = $argv[2];
}
break;
}
}
// TODO : generate a list of paths ))
if( $input === '' ) {
echo <<<OPTIONS
Several documentation possibilities:
0 : whole documentation (1 + 2 + 3 + 4)
1 : only includes
2 : only languages
3 : only maintenance
4 : only skins
5 : only a given file
OPTIONS;
while ( !is_numeric($input) )
{
$input = readaline( "\nEnter your choice [0]:" );
if($input == '') {
$input = 0;
}
}
}
switch ($input) {
case 0: $input = $mwPath; break;
case 1: $input = $mwPathI; break;
case 2: $input = $mwPathL; break;
case 3: $input = $mwPathM; break;
case 4: $input = $mwPathS; break;
case 5:
if( !isset( $file ) ) {
$file = readaline( "Enter file name $mwPath" );
}
$input = $mwPath.$file;
}
$versionNumber = getSvnRevision( $input );
if( $versionNumber === false ){ #Not using subversion ?
$svnstat = ''; # Not really useful if subversion not available
$version = 'trunk'; # FIXME
} else {
$version = "trunk (r$versionNumber)";
}
$generatedConf = generateConfigFile( $doxygenTemplate, $doxyOutput, $mwPath, $version, $svnstat, $input );
$command = $doxygenBin . ' ' . $generatedConf;
echo <<<TEXT
---------------------------------------------------
Launching the command:
$command
---------------------------------------------------
TEXT;
passthru( $command );
echo <<<TEXT
---------------------------------------------------
Doxygen execution finished.
Check above for possible errors.
You might want to deleted the temporary file $generatedConf
TEXT;
|
