MediaWiki REL1_28
Go to the documentation of this file.
36require_once __DIR__ . '/Maintenance.php';
42class MWDocGen extends Maintenance {
47 public function __construct() {
48 parent::__construct();
49 $this->addDescription( 'Build doxygen documentation' );
51 $this->addOption( 'doxygen',
52 'Path to doxygen',
53 false, true );
54 $this->addOption( 'version',
55 'Pass a MediaWiki version',
56 false, true );
57 $this->addOption( 'generate-man',
58 'Whether to generate man files' );
59 $this->addOption( 'file',
60 "Only process given file or directory. Multiple values " .
61 "accepted with comma separation. Path relative to \$IP.",
62 false, true );
63 $this->addOption( 'output',
64 'Path to write doc to',
65 false, true );
66 $this->addOption( 'no-extensions',
67 'Ignore extensions' );
68 }
70 public function getDbType() {
72 }
74 protected function init() {
75 global $IP;
77 $this->doxygen = $this->getOption( 'doxygen', 'doxygen' );
78 $this->mwVersion = $this->getOption( 'version', 'master' );
80 $this->input = '';
81 $inputs = explode( ',', $this->getOption( 'file', '' ) );
82 foreach ( $inputs as $input ) {
83 # Doxygen inputs are space separted and double quoted
84 $this->input .= " \"$IP/$input\"";
85 }
87 $this->output = $this->getOption( 'output', "$IP/docs" );
89 $this->inputFilter = wfShellWikiCmd( $IP . '/maintenance/mwdoc-filter.php' );
90 $this->template = $IP . '/maintenance/Doxyfile';
91 $this->excludes = [
92 'vendor',
93 'node_modules',
94 'images',
95 'static',
96 ];
97 $this->excludePatterns = [];
98 if ( $this->hasOption( 'no-extensions' ) ) {
99 $this->excludePatterns[] = 'extensions';
100 }
102 $this->doDot = `which dot`;
103 $this->doMan = $this->hasOption( 'generate-man' );
104 }
106 public function execute() {
107 global $IP;
109 $this->init();
111 # Build out directories we want to exclude
112 $exclude = '';
113 foreach ( $this->excludes as $item ) {
114 $exclude .= " $IP/$item";
115 }
117 $excludePatterns = implode( ' ', $this->excludePatterns );
119 $conf = strtr( file_get_contents( $this->template ),
120 [
121 '{{OUTPUT_DIRECTORY}}' => $this->output,
122 '{{STRIP_FROM_PATH}}' => $IP,
123 '{{CURRENT_VERSION}}' => $this->mwVersion,
124 '{{INPUT}}' => $this->input,
125 '{{EXCLUDE}}' => $exclude,
126 '{{EXCLUDE_PATTERNS}}' => $excludePatterns,
127 '{{HAVE_DOT}}' => $this->doDot ? 'YES' : 'NO',
128 '{{GENERATE_MAN}}' => $this->doMan ? 'YES' : 'NO',
129 '{{INPUT_FILTER}}' => $this->inputFilter,
130 ]
131 );
133 $tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
134 if ( file_put_contents( $tmpFile, $conf ) === false ) {
135 $this->error( "Could not write doxygen configuration to file $tmpFile\n",
1 );
137 }
139 $command = $this->doxygen . ' ' . $tmpFile;
140 $this->output( "Executing command:\n$command\n" );
142 $exitcode = 1;
143 system( $command, $exitcode );
145 $this->output( <<<TEXT
147Doxygen execution finished.
148Check above for possible errors.
150You might want to delete the temporary file:
151 $tmpFile
155 );
157 if ( $exitcode !== 0 ) {
158 $this->error( "Something went wrong (exit: $exitcode)\n",
159 $exitcode );
160 }
161 }
164$maintClass = 'MWDocGen';
165require_once RUN_MAINTENANCE_IF_MAIN;
within a display generated by the Derivative if and wherever such third party notices normally appear The contents of the NOTICE file are for informational purposes only and do not modify the License You may add Your own attribution notices within Derivative Works that You alongside or as an addendum to the NOTICE text from the provided that such additional attribution notices cannot be construed as modifying the License You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for or distribution of Your or for any such Derivative Works as a provided Your and distribution of the Work otherwise complies with the conditions stated in this License Submission of Contributions Unless You explicitly state any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this without any additional terms or conditions Notwithstanding the above
Tries to get the system directory for temporary files.
wfShellWikiCmd( $script, array $parameters=[], array $options=[])
Generate a shell-escaped command line string to run a MediaWiki cli script.
Definition WebStart.php:58
Definition cdb.php:65
Maintenance script that builds doxygen documentation.
Definition mwdocgen.php:42
Prepare Maintenance class.
Definition mwdocgen.php:47
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
Definition mwdocgen.php:70
Do the actual work.
Definition mwdocgen.php:106
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
const DB_NONE
Constants for DB access type.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
processing should stop and the error should be shown to the user if you wanted to authenticate users to a custom system(LDAP, another PHP program, whatever)
if the prop value should be in the metadata multi language array can modify can modify indexed by page_id indexed by prefixed DB keys can modify can modify can modify this should be populated with an alert message to that effect to be fed to an HTMLForm object and populate $result with the reason in the form of error messages should be plain text with no special etc to show that they re errors
Definition hooks.txt:1705
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition hooks.txt:108
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Definition mwdocgen.php:164