MediaWiki  master
SpecialExport.php
Go to the documentation of this file.
1 <?php
28 
34 class SpecialExport extends SpecialPage {
36 
37  public function __construct() {
38  parent::__construct( 'Export' );
39  }
40 
41  public function execute( $par ) {
42  $this->setHeaders();
43  $this->outputHeader();
44  $config = $this->getConfig();
45 
46  // Set some variables
47  $this->curonly = true;
48  $this->doExport = false;
49  $request = $this->getRequest();
50  $this->templates = $request->getCheck( 'templates' );
51  $this->pageLinkDepth = $this->validateLinkDepth(
52  $request->getIntOrNull( 'pagelink-depth' )
53  );
54  $nsindex = '';
55  $exportall = false;
56 
57  if ( $request->getCheck( 'addcat' ) ) {
58  $page = $request->getText( 'pages' );
59  $catname = $request->getText( 'catname' );
60 
61  if ( $catname !== '' && $catname !== null && $catname !== false ) {
62  $t = Title::makeTitleSafe( NS_MAIN, $catname );
63  if ( $t ) {
69  $catpages = $this->getPagesFromCategory( $t );
70  if ( $catpages ) {
71  if ( $page !== '' ) {
72  $page .= "\n";
73  }
74  $page .= implode( "\n", $catpages );
75  }
76  }
77  }
78  } elseif ( $request->getCheck( 'addns' ) && $config->get( 'ExportFromNamespaces' ) ) {
79  $page = $request->getText( 'pages' );
80  $nsindex = $request->getText( 'nsindex', '' );
81 
82  if ( strval( $nsindex ) !== '' ) {
86  $nspages = $this->getPagesFromNamespace( $nsindex );
87  if ( $nspages ) {
88  $page .= "\n" . implode( "\n", $nspages );
89  }
90  }
91  } elseif ( $request->getCheck( 'exportall' ) && $config->get( 'ExportAllowAll' ) ) {
92  $this->doExport = true;
93  $exportall = true;
94 
95  /* Although $page and $history are not used later on, we
96  nevertheless set them to avoid that PHP notices about using
97  undefined variables foul up our XML output (see call to
98  doExport(...) further down) */
99  $page = '';
100  $history = '';
101  } elseif ( $request->wasPosted() && $par == '' ) {
102  // Log to see if certain parameters are actually used.
103  // If not, we could deprecate them and do some cleanup, here and in WikiExporter.
104  LoggerFactory::getInstance( 'export' )->debug(
105  'Special:Export POST, dir: [{dir}], offset: [{offset}], limit: [{limit}]', [
106  'dir' => $request->getRawVal( 'dir' ),
107  'offset' => $request->getRawVal( 'offset' ),
108  'limit' => $request->getRawVal( 'limit' ),
109  ] );
110 
111  $page = $request->getText( 'pages' );
112  $this->curonly = $request->getCheck( 'curonly' );
113  $rawOffset = $request->getVal( 'offset' );
114 
115  if ( $rawOffset ) {
116  $offset = wfTimestamp( TS_MW, $rawOffset );
117  } else {
118  $offset = null;
119  }
120 
121  $maxHistory = $config->get( 'ExportMaxHistory' );
122  $limit = $request->getInt( 'limit' );
123  $dir = $request->getVal( 'dir' );
124  $history = [
125  'dir' => 'asc',
126  'offset' => false,
127  'limit' => $maxHistory,
128  ];
129  $historyCheck = $request->getCheck( 'history' );
130 
131  if ( $this->curonly ) {
132  $history = WikiExporter::CURRENT;
133  } elseif ( !$historyCheck ) {
134  if ( $limit > 0 && ( $maxHistory == 0 || $limit < $maxHistory ) ) {
135  $history['limit'] = $limit;
136  }
137 
138  if ( !is_null( $offset ) ) {
139  $history['offset'] = $offset;
140  }
141 
142  if ( strtolower( $dir ) == 'desc' ) {
143  $history['dir'] = 'desc';
144  }
145  }
146 
147  if ( $page != '' ) {
148  $this->doExport = true;
149  }
150  } else {
151  // Default to current-only for GET requests.
152  $page = $request->getText( 'pages', $par );
153  $historyCheck = $request->getCheck( 'history' );
154 
155  if ( $historyCheck ) {
156  $history = WikiExporter::FULL;
157  } else {
158  $history = WikiExporter::CURRENT;
159  }
160 
161  if ( $page != '' ) {
162  $this->doExport = true;
163  }
164  }
165 
166  if ( !$config->get( 'ExportAllowHistory' ) ) {
167  // Override
168  $history = WikiExporter::CURRENT;
169  }
170 
171  $list_authors = $request->getCheck( 'listauthors' );
172  if ( !$this->curonly || !$config->get( 'ExportAllowListContributors' ) ) {
173  $list_authors = false;
174  }
175 
176  if ( $this->doExport ) {
177  $this->getOutput()->disable();
178 
179  // Cancel output buffering and gzipping if set
180  // This should provide safer streaming for pages with history
182  $request->response()->header( "Content-type: application/xml; charset=utf-8" );
183  $request->response()->header( "X-Robots-Tag: noindex,nofollow" );
184 
185  if ( $request->getCheck( 'wpDownload' ) ) {
186  // Provide a sane filename suggestion
187  $filename = urlencode( $config->get( 'Sitename' ) . '-' . wfTimestampNow() . '.xml' );
188  $request->response()->header( "Content-disposition: attachment;filename={$filename}" );
189  }
190 
191  $this->doExport( $page, $history, $list_authors, $exportall );
192 
193  return;
194  }
195 
196  $out = $this->getOutput();
197  $out->addWikiMsg( 'exporttext' );
198 
199  if ( $page == '' ) {
200  $categoryName = $request->getText( 'catname' );
201  } else {
202  $categoryName = '';
203  }
204 
205  $formDescriptor = [
206  'catname' => [
207  'type' => 'textwithbutton',
208  'name' => 'catname',
209  'horizontal-label' => true,
210  'label-message' => 'export-addcattext',
211  'default' => $categoryName,
212  'size' => 40,
213  'buttontype' => 'submit',
214  'buttonname' => 'addcat',
215  'buttondefault' => $this->msg( 'export-addcat' )->text(),
216  'hide-if' => [ '===', 'exportall', '1' ],
217  ],
218  ];
219  if ( $config->get( 'ExportFromNamespaces' ) ) {
220  $formDescriptor += [
221  'nsindex' => [
222  'type' => 'namespaceselectwithbutton',
223  'default' => $nsindex,
224  'label-message' => 'export-addnstext',
225  'horizontal-label' => true,
226  'name' => 'nsindex',
227  'id' => 'namespace',
228  'cssclass' => 'namespaceselector',
229  'buttontype' => 'submit',
230  'buttonname' => 'addns',
231  'buttondefault' => $this->msg( 'export-addns' )->text(),
232  'hide-if' => [ '===', 'exportall', '1' ],
233  ],
234  ];
235  }
236 
237  if ( $config->get( 'ExportAllowAll' ) ) {
238  $formDescriptor += [
239  'exportall' => [
240  'type' => 'check',
241  'label-message' => 'exportall',
242  'name' => 'exportall',
243  'id' => 'exportall',
244  'default' => $request->wasPosted() ? $request->getCheck( 'exportall' ) : false,
245  ],
246  ];
247  }
248 
249  $formDescriptor += [
250  'textarea' => [
251  'class' => HTMLTextAreaField::class,
252  'name' => 'pages',
253  'label-message' => 'export-manual',
254  'nodata' => true,
255  'rows' => 10,
256  'default' => $page,
257  'hide-if' => [ '===', 'exportall', '1' ],
258  ],
259  ];
260 
261  if ( $config->get( 'ExportAllowHistory' ) ) {
262  $formDescriptor += [
263  'curonly' => [
264  'type' => 'check',
265  'label-message' => 'exportcuronly',
266  'name' => 'curonly',
267  'id' => 'curonly',
268  'default' => $request->wasPosted() ? $request->getCheck( 'curonly' ) : true,
269  ],
270  ];
271  } else {
272  $out->addWikiMsg( 'exportnohistory' );
273  }
274 
275  $formDescriptor += [
276  'templates' => [
277  'type' => 'check',
278  'label-message' => 'export-templates',
279  'name' => 'templates',
280  'id' => 'wpExportTemplates',
281  'default' => $request->wasPosted() ? $request->getCheck( 'templates' ) : false,
282  ],
283  ];
284 
285  if ( $config->get( 'ExportMaxLinkDepth' ) || $this->userCanOverrideExportDepth() ) {
286  $formDescriptor += [
287  'pagelink-depth' => [
288  'type' => 'text',
289  'name' => 'pagelink-depth',
290  'id' => 'pagelink-depth',
291  'label-message' => 'export-pagelinks',
292  'default' => '0',
293  'size' => 20,
294  ],
295  ];
296  }
297 
298  $formDescriptor += [
299  'wpDownload' => [
300  'type' => 'check',
301  'name' => 'wpDownload',
302  'id' => 'wpDownload',
303  'default' => $request->wasPosted() ? $request->getCheck( 'wpDownload' ) : true,
304  'label-message' => 'export-download',
305  ],
306  ];
307 
308  if ( $config->get( 'ExportAllowListContributors' ) ) {
309  $formDescriptor += [
310  'listauthors' => [
311  'type' => 'check',
312  'label-message' => 'exportlistauthors',
313  'default' => $request->wasPosted() ? $request->getCheck( 'listauthors' ) : false,
314  'name' => 'listauthors',
315  'id' => 'listauthors',
316  ],
317  ];
318  }
319 
320  $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
321  $htmlForm->setSubmitTextMsg( 'export-submit' );
322  $htmlForm->prepareForm()->displayForm( false );
323  $this->addHelpLink( 'Help:Export' );
324  }
325 
329  private function userCanOverrideExportDepth() {
330  return $this->getUser()->isAllowed( 'override-export-depth' );
331  }
332 
342  private function doExport( $page, $history, $list_authors, $exportall ) {
343  // If we are grabbing everything, enable full history and ignore the rest
344  if ( $exportall ) {
345  $history = WikiExporter::FULL;
346  } else {
347  $pageSet = []; // Inverted index of all pages to look up
348 
349  // Split up and normalize input
350  foreach ( explode( "\n", $page ) as $pageName ) {
351  $pageName = trim( $pageName );
352  $title = Title::newFromText( $pageName );
353  if ( $title && !$title->isExternal() && $title->getText() !== '' ) {
354  // Only record each page once!
355  $pageSet[$title->getPrefixedText()] = true;
356  }
357  }
358 
359  // Set of original pages to pass on to further manipulation...
360  $inputPages = array_keys( $pageSet );
361 
362  // Look up any linked pages if asked...
363  if ( $this->templates ) {
364  $pageSet = $this->getTemplates( $inputPages, $pageSet );
365  }
366  $linkDepth = $this->pageLinkDepth;
367  if ( $linkDepth ) {
368  $pageSet = $this->getPageLinks( $inputPages, $pageSet, $linkDepth );
369  }
370 
371  $pages = array_keys( $pageSet );
372 
373  // Normalize titles to the same format and remove dupes, see T19374
374  foreach ( $pages as $k => $v ) {
375  $pages[$k] = str_replace( " ", "_", $v );
376  }
377 
378  $pages = array_unique( $pages );
379  }
380 
381  /* Ok, let's get to it... */
382  $db = wfGetDB( DB_REPLICA );
383 
384  $exporter = new WikiExporter( $db, $history );
385  $exporter->list_authors = $list_authors;
386  $exporter->openStream();
387 
388  if ( $exportall ) {
389  $exporter->allPages();
390  } else {
391  $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
392 
393  foreach ( $pages as $page ) {
394  # T10824: Only export pages the user can read
395  $title = Title::newFromText( $page );
396  if ( is_null( $title ) ) {
397  // @todo Perhaps output an <error> tag or something.
398  continue;
399  }
400 
401  if ( !$permissionManager->userCan( 'read', $this->getUser(), $title ) ) {
402  // @todo Perhaps output an <error> tag or something.
403  continue;
404  }
405 
406  $exporter->pageByTitle( $title );
407  }
408  }
409 
410  $exporter->closeStream();
411  }
412 
417  private function getPagesFromCategory( $title ) {
418  $maxPages = $this->getConfig()->get( 'ExportPagelistLimit' );
419 
420  $name = $title->getDBkey();
421 
422  $dbr = wfGetDB( DB_REPLICA );
423  $res = $dbr->select(
424  [ 'page', 'categorylinks' ],
425  [ 'page_namespace', 'page_title' ],
426  [ 'cl_from=page_id', 'cl_to' => $name ],
427  __METHOD__,
428  [ 'LIMIT' => $maxPages ]
429  );
430 
431  $pages = [];
432 
433  foreach ( $res as $row ) {
434  $pages[] = Title::makeName( $row->page_namespace, $row->page_title );
435  }
436 
437  return $pages;
438  }
439 
444  private function getPagesFromNamespace( $nsindex ) {
445  $maxPages = $this->getConfig()->get( 'ExportPagelistLimit' );
446 
447  $dbr = wfGetDB( DB_REPLICA );
448  $res = $dbr->select(
449  'page',
450  [ 'page_namespace', 'page_title' ],
451  [ 'page_namespace' => $nsindex ],
452  __METHOD__,
453  [ 'LIMIT' => $maxPages ]
454  );
455 
456  $pages = [];
457 
458  foreach ( $res as $row ) {
459  $pages[] = Title::makeName( $row->page_namespace, $row->page_title );
460  }
461 
462  return $pages;
463  }
464 
471  private function getTemplates( $inputPages, $pageSet ) {
472  return $this->getLinks( $inputPages, $pageSet,
473  'templatelinks',
474  [ 'namespace' => 'tl_namespace', 'title' => 'tl_title' ],
475  [ 'page_id=tl_from' ]
476  );
477  }
478 
484  private function validateLinkDepth( $depth ) {
485  if ( $depth < 0 ) {
486  return 0;
487  }
488 
489  if ( !$this->userCanOverrideExportDepth() ) {
490  $maxLinkDepth = $this->getConfig()->get( 'ExportMaxLinkDepth' );
491  if ( $depth > $maxLinkDepth ) {
492  return $maxLinkDepth;
493  }
494  }
495 
496  /*
497  * There's a HARD CODED limit of 5 levels of recursion here to prevent a
498  * crazy-big export from being done by someone setting the depth
499  * number too high. In other words, last resort safety net.
500  */
501 
502  return intval( min( $depth, 5 ) );
503  }
504 
512  private function getPageLinks( $inputPages, $pageSet, $depth ) {
513  for ( ; $depth > 0; --$depth ) {
514  $pageSet = $this->getLinks(
515  $inputPages, $pageSet, 'pagelinks',
516  [ 'namespace' => 'pl_namespace', 'title' => 'pl_title' ],
517  [ 'page_id=pl_from' ]
518  );
519  $inputPages = array_keys( $pageSet );
520  }
521 
522  return $pageSet;
523  }
524 
534  private function getLinks( $inputPages, $pageSet, $table, $fields, $join ) {
535  $dbr = wfGetDB( DB_REPLICA );
536 
537  foreach ( $inputPages as $page ) {
538  $title = Title::newFromText( $page );
539 
540  if ( $title ) {
541  $pageSet[$title->getPrefixedText()] = true;
544  $result = $dbr->select(
545  [ 'page', $table ],
546  $fields,
547  array_merge(
548  $join,
549  [
550  'page_namespace' => $title->getNamespace(),
551  'page_title' => $title->getDBkey()
552  ]
553  ),
554  __METHOD__
555  );
556 
557  foreach ( $result as $row ) {
558  $template = Title::makeTitle( $row->namespace, $row->title );
559  $pageSet[$template->getPrefixedText()] = true;
560  }
561  }
562  }
563 
564  return $pageSet;
565  }
566 
567  protected function getGroupName() {
568  return 'pagetools';
569  }
570 }
getContext()
Gets the context this SpecialPage is executed in.
const NS_MAIN
Definition: Defines.php:60
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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 use $formDescriptor instead & $formDescriptor
Definition: hooks.txt:2061
A special page that allows users to export pages in a XML file.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
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 MediaWikiServices
Definition: injection.txt:23
getOutput()
Get the OutputPage being used for this instance.
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:299
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. '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. '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 '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 since 1.28! 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:1980
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
doExport( $page, $history, $list_authors, $exportall)
Do the actual page exporting.
$res
Definition: database.txt:21
getPagesFromCategory( $title)
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getPagesFromNamespace( $nsindex)
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
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:9
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:617
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
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:35
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping $template
Definition: hooks.txt:780
validateLinkDepth( $depth)
Validate link depth setting, if available.
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:52
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
msg( $key)
Wrapper around wfMessage that sets the current context.
getLinks( $inputPages, $pageSet, $table, $fields, $join)
Expand a list of pages to include items used in those pages.
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
const DB_REPLICA
Definition: defines.php:25
getRequest()
Get the WebRequest being used for this instance.
getPageLinks( $inputPages, $pageSet, $depth)
Expand a list of pages to include pages linked to from that page.
static makeName( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false)
Make a prefixed DB key from a DB key and a namespace index.
Definition: Title.php:819
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2633
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
getTemplates( $inputPages, $pageSet)
Expand a list of pages to include templates used in those pages.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319