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
|
<?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
*/
use MediaWiki\Shell\Shell;
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script that builds doxygen documentation.
* @ingroup Maintenance
*/
class MWDocGen extends Maintenance {
/** @var string */
private $doxygen;
/** @var string */
private $mwVersion;
/** @var string */
private $output;
/** @var string */
private $input;
/** @var string */
private $inputFilter;
/** @var string */
private $template;
/** @var string[] */
private $excludes;
/** @var string[] */
private $excludePatterns;
/** @var bool */
private $doDot;
/** @var bool */
private $doMan;
/**
* Prepare Maintenance class
*/
public function __construct() {
parent::__construct();
$this->addDescription( 'Build doxygen documentation' );
$this->addOption( 'doxygen',
'Path to doxygen',
false, true );
$this->addOption( 'version',
'Pass a MediaWiki version',
false, true );
$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( 'extensions',
'Process the extensions/ directory as well (ignored if --file is used)' );
$this->addOption( 'skins',
'Process the skins/ directory as well (ignored if --file is used)' );
}
public function getDbType() {
return Maintenance::DB_NONE;
}
protected function init() {
global $wgPhpCli, $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" );
// Do not use wfShellWikiCmd, because mwdoc-filter.php is not
// a Maintenance script.
$this->inputFilter = Shell::escape( [
$wgPhpCli,
$IP . '/maintenance/mwdoc-filter.php'
] );
$this->template = $IP . '/maintenance/Doxyfile';
$this->excludes = [
'images',
'node_modules',
'resources',
'static',
'tests',
'vendor',
];
$this->excludePatterns = [];
if ( $this->input === '' ) {
// If no explicit --file filter is set, we're indexing all of $IP,
// but any extension or skin submodules should be excluded by default.
if ( !$this->hasOption( 'extensions' ) ) {
$this->excludePatterns[] = 'extensions';
}
if ( !$this->hasOption( 'skins' ) ) {
$this->excludePatterns[] = 'skins';
}
}
$this->doDot = shell_exec( 'which dot' );
}
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 ),
[
'{{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',
'{{INPUT_FILTER}}' => $this->inputFilter,
]
);
$tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
if ( file_put_contents( $tmpFile, $conf ) === false ) {
$this->fatalError( "Could not write doxygen configuration to file $tmpFile\n" );
}
$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->fatalError( "Something went wrong (exit: $exitcode)\n", $exitcode );
}
}
}
$maintClass = MWDocGen::class;
require_once RUN_MAINTENANCE_IF_MAIN;
|
