MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
27 require_once __DIR__ . '/Maintenance.php';
34 class BackupReader extends Maintenance {
35  public $reportingInterval = 100;
36  public $pageCount = 0;
37  public $revCount = 0;
38  public $dryRun = false;
39  public $uploads = false;
40  protected $uploadCount = 0;
41  public $imageBasePath = false;
42  public $nsFilter = false;
44  function __construct() {
45  parent::__construct();
46  $gz = in_array( 'compress.zlib', stream_get_wrappers() )
47  ? 'ok'
48  : '(disabled; requires PHP zlib module)';
49  $bz2 = in_array( 'compress.bzip2', stream_get_wrappers() )
50  ? 'ok'
51  : '(disabled; requires PHP bzip2 module)';
53  $this->addDescription(
54  <<<TEXT
55 This script reads pages from an XML file as produced from Special:Export or
56 dumpBackup.php, and saves them into the current wiki.
58 Compressed XML files may be read directly:
59  .gz $gz
60  .bz2 $bz2
61  .7z (if 7za executable is in PATH)
63 Note that for very large data sets, importDump.php may be slow; there are
64 alternate methods which can be much faster for full site restoration:
65 <>
67  );
68  $this->stderr = fopen( "php://stderr", "wt" );
69  $this->addOption( 'report',
70  'Report position and speed after every n pages processed', false, true );
71  $this->addOption( 'namespaces',
72  'Import only the pages from namespaces belonging to the list of ' .
73  'pipe-separated namespace names or namespace indexes', false, true );
74  $this->addOption( 'rootpage', 'Pages will be imported as subpages of the specified page',
75  false, true );
76  $this->addOption( 'dry-run', 'Parse dump without actually importing pages' );
77  $this->addOption( 'debug', 'Output extra verbose debug information' );
78  $this->addOption( 'uploads', 'Process file upload data if included (experimental)' );
79  $this->addOption(
80  'no-updates',
81  'Disable link table updates. Is faster but leaves the wiki in an inconsistent state'
82  );
83  $this->addOption( 'image-base-path', 'Import files from a specified path', false, true );
84  $this->addOption( 'skip-to', 'Start from nth page by skipping first n-1 pages', false, true );
85  $this->addOption( 'username-interwiki', 'Use interwiki usernames with this prefix', false, true );
86  $this->addOption( 'no-local-users',
87  'Treat all usernames as interwiki. ' .
88  'The default is to assign edits to local users where they exist.',
89  false, false
90  );
91  $this->addArg( 'file', 'Dump file to import [else use stdin]', false );
92  }
94  public function execute() {
95  if ( wfReadOnly() ) {
96  $this->fatalError( "Wiki is in read-only mode; you'll need to disable it for import to work." );
97  }
99  $this->reportingInterval = intval( $this->getOption( 'report', 100 ) );
100  if ( !$this->reportingInterval ) {
101  $this->reportingInterval = 100; // avoid division by zero
102  }
104  $this->dryRun = $this->hasOption( 'dry-run' );
105  $this->uploads = $this->hasOption( 'uploads' ); // experimental!
106  if ( $this->hasOption( 'image-base-path' ) ) {
107  $this->imageBasePath = $this->getOption( 'image-base-path' );
108  }
109  if ( $this->hasOption( 'namespaces' ) ) {
110  $this->setNsfilter( explode( '|', $this->getOption( 'namespaces' ) ) );
111  }
113  if ( $this->hasArg() ) {
114  $this->importFromFile( $this->getArg() );
115  } else {
116  $this->importFromStdin();
117  }
119  $this->output( "Done!\n" );
120  $this->output( "You might want to run rebuildrecentchanges.php to regenerate RecentChanges,\n" );
121  $this->output( "and initSiteStats.php to update page and revision counts\n" );
122  }
125  if ( count( $namespaces ) == 0 ) {
126  $this->nsFilter = false;
128  return;
129  }
130  $this->nsFilter = array_unique( array_map( [ $this, 'getNsIndex' ], $namespaces ) );
131  }
133  private function getNsIndex( $namespace ) {
135  $result = $wgContLang->getNsIndex( $namespace );
136  if ( $result !== false ) {
137  return $result;
138  }
139  $ns = intval( $namespace );
140  if ( strval( $ns ) === $namespace && $wgContLang->getNsText( $ns ) !== false ) {
141  return $ns;
142  }
143  $this->fatalError( "Unknown namespace text / index specified: $namespace" );
144  }
151  private function skippedNamespace( $obj ) {
152  $title = null;
153  if ( $obj instanceof Title ) {
154  $title = $obj;
155  } elseif ( $obj instanceof Revision ) {
156  $title = $obj->getTitle();
157  } elseif ( $obj instanceof WikiRevision ) {
158  $title = $obj->title;
159  } else {
160  throw new MWException( "Cannot get namespace of object in " . __METHOD__ );
161  }
163  if ( is_null( $title ) ) {
164  // Probably a log entry
165  return false;
166  }
168  $ns = $title->getNamespace();
170  return is_array( $this->nsFilter ) && !in_array( $ns, $this->nsFilter );
171  }
173  function reportPage( $page ) {
174  $this->pageCount++;
175  }
180  function handleRevision( $rev ) {
181  $title = $rev->getTitle();
182  if ( !$title ) {
183  $this->progress( "Got bogus revision with null title!" );
185  return;
186  }
188  if ( $this->skippedNamespace( $title ) ) {
189  return;
190  }
192  $this->revCount++;
193  $this->report();
195  if ( !$this->dryRun ) {
196  call_user_func( $this->importCallback, $rev );
197  }
198  }
204  function handleUpload( $revision ) {
205  if ( $this->uploads ) {
206  if ( $this->skippedNamespace( $revision ) ) {
207  return false;
208  }
209  $this->uploadCount++;
210  // $this->report();
211  $this->progress( "upload: " . $revision->getFilename() );
213  if ( !$this->dryRun ) {
214  // bluuuh hack
215  // call_user_func( $this->uploadCallback, $revision );
216  $dbw = $this->getDB( DB_MASTER );
218  return $dbw->deadlockLoop( [ $revision, 'importUpload' ] );
219  }
220  }
222  return false;
223  }
225  function handleLogItem( $rev ) {
226  if ( $this->skippedNamespace( $rev ) ) {
227  return;
228  }
229  $this->revCount++;
230  $this->report();
232  if ( !$this->dryRun ) {
233  call_user_func( $this->logItemCallback, $rev );
234  }
235  }
237  function report( $final = false ) {
238  if ( $final xor ( $this->pageCount % $this->reportingInterval == 0 ) ) {
239  $this->showReport();
240  }
241  }
243  function showReport() {
244  if ( !$this->mQuiet ) {
245  $delta = microtime( true ) - $this->startTime;
246  if ( $delta ) {
247  $rate = sprintf( "%.2f", $this->pageCount / $delta );
248  $revrate = sprintf( "%.2f", $this->revCount / $delta );
249  } else {
250  $rate = '-';
251  $revrate = '-';
252  }
253  # Logs dumps don't have page tallies
254  if ( $this->pageCount ) {
255  $this->progress( "$this->pageCount ($rate pages/sec $revrate revs/sec)" );
256  } else {
257  $this->progress( "$this->revCount ($revrate revs/sec)" );
258  }
259  }
260  wfWaitForSlaves();
261  }
263  function progress( $string ) {
264  fwrite( $this->stderr, $string . "\n" );
265  }
267  function importFromFile( $filename ) {
268  if ( preg_match( '/\.gz$/', $filename ) ) {
269  $filename = 'compress.zlib://' . $filename;
270  } elseif ( preg_match( '/\.bz2$/', $filename ) ) {
271  $filename = 'compress.bzip2://' . $filename;
272  } elseif ( preg_match( '/\.7z$/', $filename ) ) {
273  $filename = 'mediawiki.compress.7z://' . $filename;
274  }
276  $file = fopen( $filename, 'rt' );
278  return $this->importFromHandle( $file );
279  }
281  function importFromStdin() {
282  $file = fopen( 'php://stdin', 'rt' );
283  if ( self::posix_isatty( $file ) ) {
284  $this->maybeHelp( true );
285  }
287  return $this->importFromHandle( $file );
288  }
290  function importFromHandle( $handle ) {
291  $this->startTime = microtime( true );
293  $source = new ImportStreamSource( $handle );
294  $importer = new WikiImporter( $source, $this->getConfig() );
296  // Updating statistics require a lot of time so disable it
297  $importer->disableStatisticsUpdate();
299  if ( $this->hasOption( 'debug' ) ) {
300  $importer->setDebug( true );
301  }
302  if ( $this->hasOption( 'no-updates' ) ) {
303  $importer->setNoUpdates( true );
304  }
305  if ( $this->hasOption( 'username-prefix' ) ) {
306  $importer->setUsernamePrefix(
307  $this->getOption( 'username-prefix' ),
308  !$this->hasOption( 'no-local-users' )
309  );
310  }
311  if ( $this->hasOption( 'rootpage' ) ) {
312  $statusRootPage = $importer->setTargetRootPage( $this->getOption( 'rootpage' ) );
313  if ( !$statusRootPage->isGood() ) {
314  // Die here so that it doesn't print "Done!"
315  $this->fatalError( $statusRootPage->getMessage()->text() );
316  return false;
317  }
318  }
319  if ( $this->hasOption( 'skip-to' ) ) {
320  $nthPage = (int)$this->getOption( 'skip-to' );
321  $importer->setPageOffset( $nthPage );
322  $this->pageCount = $nthPage - 1;
323  }
324  $importer->setPageCallback( [ $this, 'reportPage' ] );
325  $importer->setNoticeCallback( function ( $msg, $params ) {
326  echo wfMessage( $msg, $params )->text() . "\n";
327  } );
328  $this->importCallback = $importer->setRevisionCallback(
329  [ $this, 'handleRevision' ] );
330  $this->uploadCallback = $importer->setUploadCallback(
331  [ $this, 'handleUpload' ] );
332  $this->logItemCallback = $importer->setLogItemCallback(
333  [ $this, 'handleLogItem' ] );
334  if ( $this->uploads ) {
335  $importer->setImportUploads( true );
336  }
337  if ( $this->imageBasePath ) {
338  $importer->setImageBasePath( $this->imageBasePath );
339  }
341  if ( $this->dryRun ) {
342  $importer->setPageOutCallback( null );
343  }
345  return $importer->doImport();
346  }
347 }
350 require_once RUN_MAINTENANCE_IF_MAIN;
skippedNamespace( $obj)
Definition: importDump.php:151
Definition: importDump.php:349
XML file reader for the page data importer.
Definition: WikiImporter.php:33
Definition: importDump.php:36
Definition: importDump.php:281
Default constructor.
Definition: importDump.php:44
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
the array() calling protocol came about after MediaWiki 1.4rc1.
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
maybeHelp( $force=false)
Maybe show the help.
Definition: Maintenance.php:999
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
Definition: importDump.php:41
Prior to maintenance scripts were a hodgepodge of code that had no cohesion or formal method of action Beginning maintenance scripts have been cleaned up to use a unified class Directory structure How to run a script How to write your own DIRECTORY STRUCTURE The maintenance directory of a MediaWiki installation contains several all of which have unique purposes HOW TO RUN A SCRIPT Ridiculously just call php someScript php that s in the top level maintenance directory if not default wiki
Definition: maintenance.txt:27
importFromFile( $filename)
Definition: importDump.php:267
Definition: maintenance.txt:50
Definition: styleTest.css.php:40
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1262
handleLogItem( $rev)
Definition: importDump.php:225
setNsfilter(array $namespaces)
Definition: importDump.php:124
hasArg( $argId=0)
Does a given argument exist?
Definition: Maintenance.php:300
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
Definition: importDump.php:39
Use of locking reads(e.g. the FOR UPDATE clause) is not advised. They are poorly implemented in InnoDB and will cause regular deadlock errors. It 's also surprisingly easy to cripple the wiki with lock contention. Instead of locking reads
Imports a XML dump from a file (either from file upload, files on disk, or HTTP)
Definition: ImportStreamSource.php:32
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2966
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
The ContentHandler facility adds support for arbitrary content types on wiki pages
Definition: contenthandler.txt:1
handleUpload( $revision)
Definition: importDump.php:204
Definition: importDump.php:243
Definition: Revision.php:41
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:106
MediaWiki exception.
Definition: MWException.php:26
Definition: Maintenance.php:547
reportPage( $page)
Definition: importDump.php:173
Definition: importDump.php:42
Definition: importDump.php:37
has been added to your &Future changes to this page and its associated Talk page will be listed there
Definition: All_system_messages.txt:357
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 but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical it also represents a few features of articles that don t involve their such as access rights See also title txt Article Encapsulates access to the page table of the database The object represents a an and maintains state such as etc Revision Encapsulates individual page revision data and access to the revision text blobs storage system Higher level code should never touch text storage directly
Definition: design.txt:39
Definition: importDump.php:40
Maintenance script that imports XML dump files into the current wiki.
Definition: importDump.php:34
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Definition: importDump.php:35
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
Definition: defines.php:29
Definition: importDump.php:38
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing them
Definition: hooks.txt:1018
importFromHandle( $handle)
Definition: importDump.php:290
getNsIndex( $namespace)
Definition: importDump.php:133
handleRevision( $rev)
Definition: importDump.php:180
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation files(the "Software")
wiki Special
Definition: All_system_messages.txt:2667
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1777
Represents a title within MediaWiki.
Definition: Title.php:39
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:934
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
Represents a revision, log entry or upload during the import process.
Definition: WikiRevision.php:37
progress( $string)
Definition: importDump.php:263
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
Definition: contenthandler.txt:9
Do the actual work.
Definition: importDump.php:94
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 https
Definition: design.txt:12
Definition: APACHE-LICENSE-2.0.txt:114
report( $final=false)
Definition: importDump.php:237
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:271
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
Definition: distributors.txt:22
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable from
Definition: APACHE-LICENSE-2.0.txt:46
Definition: mwdoc-filter.php:46
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
null for the wiki Added in
Definition: hooks.txt:1591
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if that
Definition: deferred.txt:13
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:310
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:18
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57