MediaWiki  1.29.1
SpecialExport.php
Go to the documentation of this file.
1 <?php
27 
33 class SpecialExport extends SpecialPage {
35 
36  public function __construct() {
37  parent::__construct( 'Export' );
38  }
39 
40  public function execute( $par ) {
41  $this->setHeaders();
42  $this->outputHeader();
43  $config = $this->getConfig();
44 
45  // Set some variables
46  $this->curonly = true;
47  $this->doExport = false;
48  $request = $this->getRequest();
49  $this->templates = $request->getCheck( 'templates' );
50  $this->pageLinkDepth = $this->validateLinkDepth(
51  $request->getIntOrNull( 'pagelink-depth' )
52  );
53  $nsindex = '';
54  $exportall = false;
55 
56  if ( $request->getCheck( 'addcat' ) ) {
57  $page = $request->getText( 'pages' );
58  $catname = $request->getText( 'catname' );
59 
60  if ( $catname !== '' && $catname !== null && $catname !== false ) {
61  $t = Title::makeTitleSafe( NS_MAIN, $catname );
62  if ( $t ) {
68  $catpages = $this->getPagesFromCategory( $t );
69  if ( $catpages ) {
70  if ( $page !== '' ) {
71  $page .= "\n";
72  }
73  $page .= implode( "\n", $catpages );
74  }
75  }
76  }
77  } elseif ( $request->getCheck( 'addns' ) && $config->get( 'ExportFromNamespaces' ) ) {
78  $page = $request->getText( 'pages' );
79  $nsindex = $request->getText( 'nsindex', '' );
80 
81  if ( strval( $nsindex ) !== '' ) {
85  $nspages = $this->getPagesFromNamespace( $nsindex );
86  if ( $nspages ) {
87  $page .= "\n" . implode( "\n", $nspages );
88  }
89  }
90  } elseif ( $request->getCheck( 'exportall' ) && $config->get( 'ExportAllowAll' ) ) {
91  $this->doExport = true;
92  $exportall = true;
93 
94  /* Although $page and $history are not used later on, we
95  nevertheless set them to avoid that PHP notices about using
96  undefined variables foul up our XML output (see call to
97  doExport(...) further down) */
98  $page = '';
99  $history = '';
100  } elseif ( $request->wasPosted() && $par == '' ) {
101  $page = $request->getText( 'pages' );
102  $this->curonly = $request->getCheck( 'curonly' );
103  $rawOffset = $request->getVal( 'offset' );
104 
105  if ( $rawOffset ) {
106  $offset = wfTimestamp( TS_MW, $rawOffset );
107  } else {
108  $offset = null;
109  }
110 
111  $maxHistory = $config->get( 'ExportMaxHistory' );
112  $limit = $request->getInt( 'limit' );
113  $dir = $request->getVal( 'dir' );
114  $history = [
115  'dir' => 'asc',
116  'offset' => false,
117  'limit' => $maxHistory,
118  ];
119  $historyCheck = $request->getCheck( 'history' );
120 
121  if ( $this->curonly ) {
122  $history = WikiExporter::CURRENT;
123  } elseif ( !$historyCheck ) {
124  if ( $limit > 0 && ( $maxHistory == 0 || $limit < $maxHistory ) ) {
125  $history['limit'] = $limit;
126  }
127 
128  if ( !is_null( $offset ) ) {
129  $history['offset'] = $offset;
130  }
131 
132  if ( strtolower( $dir ) == 'desc' ) {
133  $history['dir'] = 'desc';
134  }
135  }
136 
137  if ( $page != '' ) {
138  $this->doExport = true;
139  }
140  } else {
141  // Default to current-only for GET requests.
142  $page = $request->getText( 'pages', $par );
143  $historyCheck = $request->getCheck( 'history' );
144 
145  if ( $historyCheck ) {
146  $history = WikiExporter::FULL;
147  } else {
148  $history = WikiExporter::CURRENT;
149  }
150 
151  if ( $page != '' ) {
152  $this->doExport = true;
153  }
154  }
155 
156  if ( !$config->get( 'ExportAllowHistory' ) ) {
157  // Override
158  $history = WikiExporter::CURRENT;
159  }
160 
161  $list_authors = $request->getCheck( 'listauthors' );
162  if ( !$this->curonly || !$config->get( 'ExportAllowListContributors' ) ) {
163  $list_authors = false;
164  }
165 
166  if ( $this->doExport ) {
167  $this->getOutput()->disable();
168 
169  // Cancel output buffering and gzipping if set
170  // This should provide safer streaming for pages with history
172  $request->response()->header( "Content-type: application/xml; charset=utf-8" );
173  $request->response()->header( "X-Robots-Tag: noindex,nofollow" );
174 
175  if ( $request->getCheck( 'wpDownload' ) ) {
176  // Provide a sane filename suggestion
177  $filename = urlencode( $config->get( 'Sitename' ) . '-' . wfTimestampNow() . '.xml' );
178  $request->response()->header( "Content-disposition: attachment;filename={$filename}" );
179  }
180 
181  $this->doExport( $page, $history, $list_authors, $exportall );
182 
183  return;
184  }
185 
186  $out = $this->getOutput();
187  $out->addWikiMsg( 'exporttext' );
188 
189  if ( $page == '' ) {
190  $categoryName = $request->getText( 'catname' );
191  } else {
192  $categoryName = '';
193  }
194 
195  $formDescriptor = [
196  'catname' => [
197  'type' => 'textwithbutton',
198  'name' => 'catname',
199  'horizontal-label' => true,
200  'label-message' => 'export-addcattext',
201  'default' => $categoryName,
202  'size' => 40,
203  'buttontype' => 'submit',
204  'buttonname' => 'addcat',
205  'buttondefault' => $this->msg( 'export-addcat' )->text(),
206  'hide-if' => [ '===', 'exportall', '1' ],
207  ],
208  ];
209  if ( $config->get( 'ExportFromNamespaces' ) ) {
210  $formDescriptor += [
211  'nsindex' => [
212  'type' => 'namespaceselectwithbutton',
213  'default' => $nsindex,
214  'label-message' => 'export-addnstext',
215  'horizontal-label' => true,
216  'name' => 'nsindex',
217  'id' => 'namespace',
218  'cssclass' => 'namespaceselector',
219  'buttontype' => 'submit',
220  'buttonname' => 'addns',
221  'buttondefault' => $this->msg( 'export-addns' )->text(),
222  'hide-if' => [ '===', 'exportall', '1' ],
223  ],
224  ];
225  }
226 
227  if ( $config->get( 'ExportAllowAll' ) ) {
228  $formDescriptor += [
229  'exportall' => [
230  'type' => 'check',
231  'label-message' => 'exportall',
232  'name' => 'exportall',
233  'id' => 'exportall',
234  'default' => $request->wasPosted() ? $request->getCheck( 'exportall' ) : false,
235  ],
236  ];
237  }
238 
239  $formDescriptor += [
240  'textarea' => [
241  'class' => 'HTMLTextAreaField',
242  'name' => 'pages',
243  'label-message' => 'export-manual',
244  'nodata' => true,
245  'rows' => 10,
246  'default' => $page,
247  'hide-if' => [ '===', 'exportall', '1' ],
248  ],
249  ];
250 
251  if ( $config->get( 'ExportAllowHistory' ) ) {
252  $formDescriptor += [
253  'curonly' => [
254  'type' => 'check',
255  'label-message' => 'exportcuronly',
256  'name' => 'curonly',
257  'id' => 'curonly',
258  'default' => $request->wasPosted() ? $request->getCheck( 'curonly' ) : true,
259  ],
260  ];
261  } else {
262  $out->addWikiMsg( 'exportnohistory' );
263  }
264 
265  $formDescriptor += [
266  'templates' => [
267  'type' => 'check',
268  'label-message' => 'export-templates',
269  'name' => 'templates',
270  'id' => 'wpExportTemplates',
271  'default' => $request->wasPosted() ? $request->getCheck( 'templates' ) : false,
272  ],
273  ];
274 
275  if ( $config->get( 'ExportMaxLinkDepth' ) || $this->userCanOverrideExportDepth() ) {
276  $formDescriptor += [
277  'pagelink-depth' => [
278  'type' => 'text',
279  'name' => 'pagelink-depth',
280  'id' => 'pagelink-depth',
281  'label-message' => 'export-pagelinks',
282  'default' => '0',
283  'size' => 20,
284  ],
285  ];
286  }
287 
288  $formDescriptor += [
289  'wpDownload' => [
290  'type' => 'check',
291  'name' =>'wpDownload',
292  'id' => 'wpDownload',
293  'default' => $request->wasPosted() ? $request->getCheck( 'wpDownload' ) : true,
294  'label-message' => 'export-download',
295  ],
296  ];
297 
298  if ( $config->get( 'ExportAllowListContributors' ) ) {
299  $formDescriptor += [
300  'listauthors' => [
301  'type' => 'check',
302  'label-message' => 'exportlistauthors',
303  'default' => $request->wasPosted() ? $request->getCheck( 'listauthors' ) : false,
304  'name' => 'listauthors',
305  'id' => 'listauthors',
306  ],
307  ];
308  }
309 
310  $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
311  $htmlForm->setSubmitTextMsg( 'export-submit' );
312  $htmlForm->prepareForm()->displayForm( false );
313  $this->addHelpLink( 'Help:Export' );
314  }
315 
319  private function userCanOverrideExportDepth() {
320  return $this->getUser()->isAllowed( 'override-export-depth' );
321  }
322 
332  private function doExport( $page, $history, $list_authors, $exportall ) {
333 
334  // If we are grabbing everything, enable full history and ignore the rest
335  if ( $exportall ) {
336  $history = WikiExporter::FULL;
337  } else {
338  $pageSet = []; // Inverted index of all pages to look up
339 
340  // Split up and normalize input
341  foreach ( explode( "\n", $page ) as $pageName ) {
342  $pageName = trim( $pageName );
343  $title = Title::newFromText( $pageName );
344  if ( $title && !$title->isExternal() && $title->getText() !== '' ) {
345  // Only record each page once!
346  $pageSet[$title->getPrefixedText()] = true;
347  }
348  }
349 
350  // Set of original pages to pass on to further manipulation...
351  $inputPages = array_keys( $pageSet );
352 
353  // Look up any linked pages if asked...
354  if ( $this->templates ) {
355  $pageSet = $this->getTemplates( $inputPages, $pageSet );
356  }
357  $linkDepth = $this->pageLinkDepth;
358  if ( $linkDepth ) {
359  $pageSet = $this->getPageLinks( $inputPages, $pageSet, $linkDepth );
360  }
361 
362  $pages = array_keys( $pageSet );
363 
364  // Normalize titles to the same format and remove dupes, see T19374
365  foreach ( $pages as $k => $v ) {
366  $pages[$k] = str_replace( " ", "_", $v );
367  }
368 
369  $pages = array_unique( $pages );
370  }
371 
372  /* Ok, let's get to it... */
373  if ( $history == WikiExporter::CURRENT ) {
374  $lb = false;
375  $db = wfGetDB( DB_REPLICA );
377  } else {
378  // Use an unbuffered query; histories may be very long!
379  $lb = MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->newMainLB();
380  $db = $lb->getConnection( DB_REPLICA );
382 
383  // This might take a while... :D
384  MediaWiki\suppressWarnings();
385  set_time_limit( 0 );
386  MediaWiki\restoreWarnings();
387  }
388 
389  $exporter = new WikiExporter( $db, $history, $buffer );
390  $exporter->list_authors = $list_authors;
391  $exporter->openStream();
392 
393  if ( $exportall ) {
394  $exporter->allPages();
395  } else {
396  foreach ( $pages as $page ) {
397  # T10824: Only export pages the user can read
399  if ( is_null( $title ) ) {
400  // @todo Perhaps output an <error> tag or something.
401  continue;
402  }
403 
404  if ( !$title->userCan( 'read', $this->getUser() ) ) {
405  // @todo Perhaps output an <error> tag or something.
406  continue;
407  }
408 
409  $exporter->pageByTitle( $title );
410  }
411  }
412 
413  $exporter->closeStream();
414 
415  if ( $lb ) {
416  $lb->closeAll();
417  }
418  }
419 
424  private function getPagesFromCategory( $title ) {
426 
427  $maxPages = $this->getConfig()->get( 'ExportPagelistLimit' );
428 
429  $name = $title->getDBkey();
430 
431  $dbr = wfGetDB( DB_REPLICA );
432  $res = $dbr->select(
433  [ 'page', 'categorylinks' ],
434  [ 'page_namespace', 'page_title' ],
435  [ 'cl_from=page_id', 'cl_to' => $name ],
436  __METHOD__,
437  [ 'LIMIT' => $maxPages ]
438  );
439 
440  $pages = [];
441 
442  foreach ( $res as $row ) {
443  $n = $row->page_title;
444  if ( $row->page_namespace ) {
445  $ns = $wgContLang->getNsText( $row->page_namespace );
446  $n = $ns . ':' . $n;
447  }
448 
449  $pages[] = $n;
450  }
451 
452  return $pages;
453  }
454 
459  private function getPagesFromNamespace( $nsindex ) {
461 
462  $maxPages = $this->getConfig()->get( 'ExportPagelistLimit' );
463 
464  $dbr = wfGetDB( DB_REPLICA );
465  $res = $dbr->select(
466  'page',
467  [ 'page_namespace', 'page_title' ],
468  [ 'page_namespace' => $nsindex ],
469  __METHOD__,
470  [ 'LIMIT' => $maxPages ]
471  );
472 
473  $pages = [];
474 
475  foreach ( $res as $row ) {
476  $n = $row->page_title;
477 
478  if ( $row->page_namespace ) {
479  $ns = $wgContLang->getNsText( $row->page_namespace );
480  $n = $ns . ':' . $n;
481  }
482 
483  $pages[] = $n;
484  }
485 
486  return $pages;
487  }
488 
495  private function getTemplates( $inputPages, $pageSet ) {
496  return $this->getLinks( $inputPages, $pageSet,
497  'templatelinks',
498  [ 'namespace' => 'tl_namespace', 'title' => 'tl_title' ],
499  [ 'page_id=tl_from' ]
500  );
501  }
502 
508  private function validateLinkDepth( $depth ) {
509  if ( $depth < 0 ) {
510  return 0;
511  }
512 
513  if ( !$this->userCanOverrideExportDepth() ) {
514  $maxLinkDepth = $this->getConfig()->get( 'ExportMaxLinkDepth' );
515  if ( $depth > $maxLinkDepth ) {
516  return $maxLinkDepth;
517  }
518  }
519 
520  /*
521  * There's a HARD CODED limit of 5 levels of recursion here to prevent a
522  * crazy-big export from being done by someone setting the depth
523  * number too high. In other words, last resort safety net.
524  */
525 
526  return intval( min( $depth, 5 ) );
527  }
528 
536  private function getPageLinks( $inputPages, $pageSet, $depth ) {
537  // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
538  for ( ; $depth > 0; --$depth ) {
539  // @codingStandardsIgnoreEnd
540  $pageSet = $this->getLinks(
541  $inputPages, $pageSet, 'pagelinks',
542  [ 'namespace' => 'pl_namespace', 'title' => 'pl_title' ],
543  [ 'page_id=pl_from' ]
544  );
545  $inputPages = array_keys( $pageSet );
546  }
547 
548  return $pageSet;
549  }
550 
560  private function getLinks( $inputPages, $pageSet, $table, $fields, $join ) {
561  $dbr = wfGetDB( DB_REPLICA );
562 
563  foreach ( $inputPages as $page ) {
565 
566  if ( $title ) {
567  $pageSet[$title->getPrefixedText()] = true;
570  $result = $dbr->select(
571  [ 'page', $table ],
572  $fields,
573  array_merge(
574  $join,
575  [
576  'page_namespace' => $title->getNamespace(),
577  'page_title' => $title->getDBkey()
578  ]
579  ),
580  __METHOD__
581  );
582 
583  foreach ( $result as $row ) {
584  $template = Title::makeTitle( $row->namespace, $row->title );
585  $pageSet[$template->getPrefixedText()] = true;
586  }
587  }
588  }
589 
590  return $pageSet;
591  }
592 
593  protected function getGroupName() {
594  return 'pagetools';
595  }
596 }
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
$template
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:783
SpecialExport\getLinks
getLinks( $inputPages, $pageSet, $table, $fields, $join)
Expand a list of pages to include items used in those pages.
Definition: SpecialExport.php:560
wfResetOutputBuffers
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
Definition: GlobalFunctions.php:1802
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
SpecialExport
A special page that allows users to export pages in a XML file.
Definition: SpecialExport.php:33
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:675
SpecialExport\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialExport.php:40
WikiExporter\CURRENT
const CURRENT
Definition: WikiExporter.php:50
SpecialExport\getTemplates
getTemplates( $inputPages, $pageSet)
Expand a list of pages to include templates used in those pages.
Definition: SpecialExport.php:495
$result
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 '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:1954
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1994
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
SpecialExport\doExport
doExport( $page, $history, $list_authors, $exportall)
Do the actual page exporting.
Definition: SpecialExport.php:332
$res
$res
Definition: database.txt:21
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
SpecialExport\$curonly
$curonly
Definition: SpecialExport.php:34
SpecialExport\$templates
$templates
Definition: SpecialExport.php:34
php
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
SpecialExport\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialExport.php:593
NS_MAIN
const NS_MAIN
Definition: Defines.php:62
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:785
SpecialExport\getPagesFromCategory
getPagesFromCategory( $title)
Definition: SpecialExport.php:424
SpecialExport\$doExport
$doExport
Definition: SpecialExport.php:34
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:714
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3060
$page
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2536
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:277
$limit
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 you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1049
SpecialExport\getPageLinks
getPageLinks( $inputPages, $pageSet, $depth)
Expand a list of pages to include pages linked to from that page.
Definition: SpecialExport.php:536
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:484
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:685
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:514
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2023
WikiExporter
Definition: WikiExporter.php:36
$dir
$dir
Definition: Autoload.php:8
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:648
SpecialExport\$pageLinkDepth
$pageLinkDepth
Definition: SpecialExport.php:34
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:538
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:746
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
WikiExporter\STREAM
const STREAM
Definition: WikiExporter.php:56
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:665
WikiExporter\FULL
const FULL
Definition: WikiExporter.php:49
SpecialExport\validateLinkDepth
validateLinkDepth( $depth)
Validate link depth setting, if available.
Definition: SpecialExport.php:508
SpecialExport\getPagesFromNamespace
getPagesFromNamespace( $nsindex)
Definition: SpecialExport.php:459
$dbr
if(! $regexes) $dbr
Definition: cleanup.php:94
as
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
$t
$t
Definition: testCompression.php:67
MediaWikiServices
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
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:583
SpecialExport\userCanOverrideExportDepth
userCanOverrideExportDepth()
Definition: SpecialExport.php:319
$buffer
$buffer
Definition: mwdoc-filter.php:48
WikiExporter\BUFFER
const BUFFER
Definition: WikiExporter.php:55
SpecialExport\__construct
__construct()
Definition: SpecialExport.php:36
$wgContLang
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:56
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:783