MediaWiki  REL1_31
SpecialImport.php
Go to the documentation of this file.
1 <?php
32 class SpecialImport extends SpecialPage {
33  private $sourceName = false;
34  private $interwiki = false;
35  private $subproject;
37  private $mapping = 'default';
38  private $namespace;
39  private $rootpage = '';
40  private $frompage = '';
41  private $logcomment = false;
42  private $history = true;
43  private $includeTemplates = false;
44  private $pageLinkDepth;
45  private $importSources;
47  private $usernamePrefix;
48 
49  public function __construct() {
50  parent::__construct( 'Import', 'import' );
51  }
52 
53  public function doesWrites() {
54  return true;
55  }
56 
63  function execute( $par ) {
65 
66  $this->setHeaders();
67  $this->outputHeader();
68 
69  $this->namespace = $this->getConfig()->get( 'ImportTargetNamespace' );
70 
71  $this->getOutput()->addModules( 'mediawiki.special.import' );
72 
73  $this->importSources = $this->getConfig()->get( 'ImportSources' );
74  Hooks::run( 'ImportSources', [ &$this->importSources ] );
75 
76  $user = $this->getUser();
77  if ( !$user->isAllowedAny( 'import', 'importupload' ) ) {
78  throw new PermissionsError( 'import' );
79  }
80 
81  # @todo Allow Title::getUserPermissionsErrors() to take an array
82  # @todo FIXME: Title::checkSpecialsAndNSPermissions() has a very wierd expectation of what
83  # getUserPermissionsErrors() might actually be used for, hence the 'ns-specialprotected'
84  $errors = wfMergeErrorArrays(
85  $this->getPageTitle()->getUserPermissionsErrors(
86  'import', $user, true,
87  [ 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' ]
88  ),
89  $this->getPageTitle()->getUserPermissionsErrors(
90  'importupload', $user, true,
91  [ 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' ]
92  )
93  );
94 
95  if ( $errors ) {
96  throw new PermissionsError( 'import', $errors );
97  }
98 
99  $this->checkReadOnly();
100 
101  $request = $this->getRequest();
102  if ( $request->wasPosted() && $request->getVal( 'action' ) == 'submit' ) {
103  $this->doImport();
104  }
105  $this->showForm();
106  }
107 
111  private function doImport() {
112  $isUpload = false;
113  $request = $this->getRequest();
114  $this->sourceName = $request->getVal( "source" );
115  $this->assignKnownUsers = $request->getCheck( 'assignKnownUsers' );
116 
117  $this->logcomment = $request->getText( 'log-comment' );
118  $this->pageLinkDepth = $this->getConfig()->get( 'ExportMaxLinkDepth' ) == 0
119  ? 0
120  : $request->getIntOrNull( 'pagelink-depth' );
121 
122  $this->mapping = $request->getVal( 'mapping' );
123  if ( $this->mapping === 'namespace' ) {
124  $this->namespace = $request->getIntOrNull( 'namespace' );
125  } elseif ( $this->mapping === 'subpage' ) {
126  $this->rootpage = $request->getText( 'rootpage' );
127  } else {
128  $this->mapping = 'default';
129  }
130 
131  $user = $this->getUser();
132  if ( !$user->matchEditToken( $request->getVal( 'editToken' ) ) ) {
133  $source = Status::newFatal( 'import-token-mismatch' );
134  } elseif ( $this->sourceName === 'upload' ) {
135  $isUpload = true;
136  $this->usernamePrefix = $this->fullInterwikiPrefix = $request->getVal( 'usernamePrefix' );
137  if ( $user->isAllowed( 'importupload' ) ) {
139  } else {
140  throw new PermissionsError( 'importupload' );
141  }
142  } elseif ( $this->sourceName === 'interwiki' ) {
143  if ( !$user->isAllowed( 'import' ) ) {
144  throw new PermissionsError( 'import' );
145  }
146  $this->interwiki = $this->fullInterwikiPrefix = $request->getVal( 'interwiki' );
147  // does this interwiki have subprojects?
148  $hasSubprojects = array_key_exists( $this->interwiki, $this->importSources );
149  if ( !$hasSubprojects && !in_array( $this->interwiki, $this->importSources ) ) {
150  $source = Status::newFatal( "import-invalid-interwiki" );
151  } else {
152  if ( $hasSubprojects ) {
153  $this->subproject = $request->getVal( 'subproject' );
154  $this->fullInterwikiPrefix .= ':' . $request->getVal( 'subproject' );
155  }
156  if ( $hasSubprojects &&
157  !in_array( $this->subproject, $this->importSources[$this->interwiki] )
158  ) {
159  $source = Status::newFatal( "import-invalid-interwiki" );
160  } else {
161  $this->history = $request->getCheck( 'interwikiHistory' );
162  $this->frompage = $request->getText( "frompage" );
163  $this->includeTemplates = $request->getCheck( 'interwikiTemplates' );
165  $this->fullInterwikiPrefix,
166  $this->frompage,
167  $this->history,
168  $this->includeTemplates,
169  $this->pageLinkDepth );
170  }
171  }
172  } else {
173  $source = Status::newFatal( "importunknownsource" );
174  }
175 
176  if ( (string)$this->fullInterwikiPrefix === '' ) {
177  $source->fatal( 'importnoprefix' );
178  }
179 
180  $out = $this->getOutput();
181  if ( !$source->isGood() ) {
182  $out->addWikiText( "<p class=\"error\">\n" .
183  $this->msg( 'importfailed', $source->getWikiText() )->parse() . "\n</p>" );
184  } else {
185  $importer = new WikiImporter( $source->value, $this->getConfig() );
186  if ( !is_null( $this->namespace ) ) {
187  $importer->setTargetNamespace( $this->namespace );
188  } elseif ( !is_null( $this->rootpage ) ) {
189  $statusRootPage = $importer->setTargetRootPage( $this->rootpage );
190  if ( !$statusRootPage->isGood() ) {
191  $out->wrapWikiMsg(
192  "<p class=\"error\">\n$1\n</p>",
193  [
194  'import-options-wrong',
195  $statusRootPage->getWikiText(),
196  count( $statusRootPage->getErrorsArray() )
197  ]
198  );
199 
200  return;
201  }
202  }
203  $importer->setUsernamePrefix( $this->fullInterwikiPrefix, $this->assignKnownUsers );
204 
205  $out->addWikiMsg( "importstart" );
206 
207  $reporter = new ImportReporter(
208  $importer,
209  $isUpload,
210  $this->fullInterwikiPrefix,
211  $this->logcomment
212  );
213  $reporter->setContext( $this->getContext() );
214  $exception = false;
215 
216  $reporter->open();
217  try {
218  $importer->doImport();
219  } catch ( Exception $e ) {
220  $exception = $e;
221  }
222  $result = $reporter->close();
223 
224  if ( $exception ) {
225  # No source or XML parse error
226  $out->wrapWikiMsg(
227  "<p class=\"error\">\n$1\n</p>",
228  [ 'importfailed', $exception->getMessage() ]
229  );
230  } elseif ( !$result->isGood() ) {
231  # Zero revisions
232  $out->wrapWikiMsg(
233  "<p class=\"error\">\n$1\n</p>",
234  [ 'importfailed', $result->getWikiText() ]
235  );
236  } else {
237  # Success!
238  $out->addWikiMsg( 'importsuccess' );
239  }
240  $out->addHTML( '<hr />' );
241  }
242  }
243 
244  private function getMappingFormPart( $sourceName ) {
245  $isSameSourceAsBefore = ( $this->sourceName === $sourceName );
246  $defaultNamespace = $this->getConfig()->get( 'ImportTargetNamespace' );
247  return "<tr>
248  <td>
249  </td>
250  <td class='mw-input'>" .
252  $this->msg( 'import-mapping-default' )->text(),
253  'mapping',
254  'default',
255  // mw-import-mapping-interwiki-default, mw-import-mapping-upload-default
256  "mw-import-mapping-$sourceName-default",
257  ( $isSameSourceAsBefore ?
258  ( $this->mapping === 'default' ) :
259  is_null( $defaultNamespace ) )
260  ) .
261  "</td>
262  </tr>
263  <tr>
264  <td>
265  </td>
266  <td class='mw-input'>" .
268  $this->msg( 'import-mapping-namespace' )->text(),
269  'mapping',
270  'namespace',
271  // mw-import-mapping-interwiki-namespace, mw-import-mapping-upload-namespace
272  "mw-import-mapping-$sourceName-namespace",
273  ( $isSameSourceAsBefore ?
274  ( $this->mapping === 'namespace' ) :
275  !is_null( $defaultNamespace ) )
276  ) . ' ' .
278  [
279  'selected' => ( $isSameSourceAsBefore ?
280  $this->namespace :
281  ( $defaultNamespace || '' ) ),
282  ], [
283  'name' => "namespace",
284  // mw-import-namespace-interwiki, mw-import-namespace-upload
285  'id' => "mw-import-namespace-$sourceName",
286  'class' => 'namespaceselector',
287  ]
288  ) .
289  "</td>
290  </tr>
291  <tr>
292  <td>
293  </td>
294  <td class='mw-input'>" .
296  $this->msg( 'import-mapping-subpage' )->text(),
297  'mapping',
298  'subpage',
299  // mw-import-mapping-interwiki-subpage, mw-import-mapping-upload-subpage
300  "mw-import-mapping-$sourceName-subpage",
301  ( $isSameSourceAsBefore ? ( $this->mapping === 'subpage' ) : '' )
302  ) . ' ' .
303  Xml::input( 'rootpage', 50,
304  ( $isSameSourceAsBefore ? $this->rootpage : '' ),
305  [
306  // Should be "mw-import-rootpage-...", but we keep this inaccurate
307  // ID for legacy reasons
308  // mw-interwiki-rootpage-interwiki, mw-interwiki-rootpage-upload
309  'id' => "mw-interwiki-rootpage-$sourceName",
310  'type' => 'text'
311  ]
312  ) . ' ' .
313  "</td>
314  </tr>";
315  }
316 
317  private function showForm() {
318  $action = $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] );
319  $user = $this->getUser();
320  $out = $this->getOutput();
321  $this->addHelpLink( '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Import', true );
322 
323  if ( $user->isAllowed( 'importupload' ) ) {
324  $mappingSelection = $this->getMappingFormPart( 'upload' );
325  $out->addHTML(
326  Xml::fieldset( $this->msg( 'import-upload' )->text() ) .
328  'form',
329  [
330  'enctype' => 'multipart/form-data',
331  'method' => 'post',
332  'action' => $action,
333  'id' => 'mw-import-upload-form'
334  ]
335  ) .
336  $this->msg( 'importtext' )->parseAsBlock() .
337  Html::hidden( 'action', 'submit' ) .
338  Html::hidden( 'source', 'upload' ) .
339  Xml::openElement( 'table', [ 'id' => 'mw-import-table-upload' ] ) .
340  "<tr>
341  <td class='mw-label'>" .
342  Xml::label( $this->msg( 'import-upload-filename' )->text(), 'xmlimport' ) .
343  "</td>
344  <td class='mw-input'>" .
345  Html::input( 'xmlimport', '', 'file', [ 'id' => 'xmlimport' ] ) . ' ' .
346  "</td>
347  </tr>
348  <tr>
349  <td class='mw-label'>" .
350  Xml::label( $this->msg( 'import-upload-username-prefix' )->text(),
351  'mw-import-usernamePrefix' ) .
352  "</td>
353  <td class='mw-input'>" .
354  Xml::input( 'usernamePrefix', 50,
355  $this->usernamePrefix,
356  [ 'id' => 'usernamePrefix', 'type' => 'text' ] ) . ' ' .
357  "</td>
358  </tr>
359  <tr>
360  <td></td>
361  <td class='mw-input'>" .
363  $this->msg( 'import-assign-known-users' )->text(),
364  'assignKnownUsers',
365  'assignKnownUsers',
366  $this->assignKnownUsers
367  ) .
368  "</td>
369  </tr>
370  <tr>
371  <td class='mw-label'>" .
372  Xml::label( $this->msg( 'import-comment' )->text(), 'mw-import-comment' ) .
373  "</td>
374  <td class='mw-input'>" .
375  Xml::input( 'log-comment', 50,
376  ( $this->sourceName === 'upload' ? $this->logcomment : '' ),
377  [ 'id' => 'mw-import-comment', 'type' => 'text' ] ) . ' ' .
378  "</td>
379  </tr>
380  $mappingSelection
381  <tr>
382  <td></td>
383  <td class='mw-submit'>" .
384  Xml::submitButton( $this->msg( 'uploadbtn' )->text() ) .
385  "</td>
386  </tr>" .
387  Xml::closeElement( 'table' ) .
388  Html::hidden( 'editToken', $user->getEditToken() ) .
389  Xml::closeElement( 'form' ) .
390  Xml::closeElement( 'fieldset' )
391  );
392  } else {
393  if ( empty( $this->importSources ) ) {
394  $out->addWikiMsg( 'importnosources' );
395  }
396  }
397 
398  if ( $user->isAllowed( 'import' ) && !empty( $this->importSources ) ) {
399  # Show input field for import depth only if $wgExportMaxLinkDepth > 0
400  $importDepth = '';
401  if ( $this->getConfig()->get( 'ExportMaxLinkDepth' ) > 0 ) {
402  $importDepth = "<tr>
403  <td class='mw-label'>" .
404  $this->msg( 'export-pagelinks' )->parse() .
405  "</td>
406  <td class='mw-input'>" .
407  Xml::input( 'pagelink-depth', 3, 0 ) .
408  "</td>
409  </tr>";
410  }
411  $mappingSelection = $this->getMappingFormPart( 'interwiki' );
412 
413  $out->addHTML(
414  Xml::fieldset( $this->msg( 'importinterwiki' )->text() ) .
416  'form',
417  [
418  'method' => 'post',
419  'action' => $action,
420  'id' => 'mw-import-interwiki-form'
421  ]
422  ) .
423  $this->msg( 'import-interwiki-text' )->parseAsBlock() .
424  Html::hidden( 'action', 'submit' ) .
425  Html::hidden( 'source', 'interwiki' ) .
426  Html::hidden( 'editToken', $user->getEditToken() ) .
427  Xml::openElement( 'table', [ 'id' => 'mw-import-table-interwiki' ] ) .
428  "<tr>
429  <td class='mw-label'>" .
430  Xml::label( $this->msg( 'import-interwiki-sourcewiki' )->text(), 'interwiki' ) .
431  "</td>
432  <td class='mw-input'>" .
434  'select',
435  [ 'name' => 'interwiki', 'id' => 'interwiki' ]
436  )
437  );
438 
439  $needSubprojectField = false;
440  foreach ( $this->importSources as $key => $value ) {
441  if ( is_int( $key ) ) {
442  $key = $value;
443  } elseif ( $value !== $key ) {
444  $needSubprojectField = true;
445  }
446 
447  $attribs = [
448  'value' => $key,
449  ];
450  if ( is_array( $value ) ) {
451  $attribs['data-subprojects'] = implode( ' ', $value );
452  }
453  if ( $this->interwiki === $key ) {
454  $attribs['selected'] = 'selected';
455  }
456  $out->addHTML( Html::element( 'option', $attribs, $key ) );
457  }
458 
459  $out->addHTML(
460  Xml::closeElement( 'select' )
461  );
462 
463  if ( $needSubprojectField ) {
464  $out->addHTML(
466  'select',
467  [ 'name' => 'subproject', 'id' => 'subproject' ]
468  )
469  );
470 
471  $subprojectsToAdd = [];
472  foreach ( $this->importSources as $key => $value ) {
473  if ( is_array( $value ) ) {
474  $subprojectsToAdd = array_merge( $subprojectsToAdd, $value );
475  }
476  }
477  $subprojectsToAdd = array_unique( $subprojectsToAdd );
478  sort( $subprojectsToAdd );
479  foreach ( $subprojectsToAdd as $subproject ) {
480  $out->addHTML( Xml::option( $subproject, $subproject, $this->subproject === $subproject ) );
481  }
482 
483  $out->addHTML(
484  Xml::closeElement( 'select' )
485  );
486  }
487 
488  $out->addHTML(
489  "</td>
490  </tr>
491  <tr>
492  <td class='mw-label'>" .
493  Xml::label( $this->msg( 'import-interwiki-sourcepage' )->text(), 'frompage' ) .
494  "</td>
495  <td class='mw-input'>" .
496  Xml::input( 'frompage', 50, $this->frompage, [ 'id' => 'frompage' ] ) .
497  "</td>
498  </tr>
499  <tr>
500  <td>
501  </td>
502  <td class='mw-input'>" .
504  $this->msg( 'import-interwiki-history' )->text(),
505  'interwikiHistory',
506  'interwikiHistory',
507  $this->history
508  ) .
509  "</td>
510  </tr>
511  <tr>
512  <td>
513  </td>
514  <td class='mw-input'>" .
516  $this->msg( 'import-interwiki-templates' )->text(),
517  'interwikiTemplates',
518  'interwikiTemplates',
519  $this->includeTemplates
520  ) .
521  "</td>
522  </tr>
523  <tr>
524  <td></td>
525  <td class='mw-input'>" .
527  $this->msg( 'import-assign-known-users' )->text(),
528  'assignKnownUsers',
529  'assignKnownUsers',
530  $this->assignKnownUsers
531  ) .
532  "</td>
533  </tr>
534  $importDepth
535  <tr>
536  <td class='mw-label'>" .
537  Xml::label( $this->msg( 'import-comment' )->text(), 'mw-interwiki-comment' ) .
538  "</td>
539  <td class='mw-input'>" .
540  Xml::input( 'log-comment', 50,
541  ( $this->sourceName === 'interwiki' ? $this->logcomment : '' ),
542  [ 'id' => 'mw-interwiki-comment', 'type' => 'text' ] ) . ' ' .
543  "</td>
544  </tr>
545  $mappingSelection
546  <tr>
547  <td>
548  </td>
549  <td class='mw-submit'>" .
551  $this->msg( 'import-interwiki-submit' )->text(),
553  ) .
554  "</td>
555  </tr>" .
556  Xml::closeElement( 'table' ) .
557  Xml::closeElement( 'form' ) .
558  Xml::closeElement( 'fieldset' )
559  );
560  }
561  }
562 
563  protected function getGroupName() {
564  return 'pagetools';
565  }
566 }
SpecialImport\showForm
showForm()
Definition: SpecialImport.php:317
SpecialImport
MediaWiki page data importer.
Definition: SpecialImport.php:32
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
SpecialImport\$pageLinkDepth
$pageLinkDepth
Definition: SpecialImport.php:44
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
SpecialImport\$includeTemplates
$includeTemplates
Definition: SpecialImport.php:43
WikiImporter
XML file reader for the page data importer.
Definition: WikiImporter.php:33
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
wfMergeErrorArrays
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
Definition: GlobalFunctions.php:211
SpecialImport\$usernamePrefix
$usernamePrefix
Definition: SpecialImport.php:47
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
Xml\label
static label( $label, $id, $attribs=[])
Convenience function to build an HTML form label.
Definition: Xml.php:359
text
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 text
Definition: design.txt:18
SpecialImport\$fullInterwikiPrefix
$fullInterwikiPrefix
Definition: SpecialImport.php:36
$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:864
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Xml\option
static option( $text, $value=null, $selected=false, $attribs=[])
Convenience function to build an HTML drop-down list item.
Definition: Xml.php:485
SpecialPage\useTransactionalTimeLimit
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: SpecialPage.php:897
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
ImportReporter
Reporting callback.
Definition: ImportReporter.php:27
$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. '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
Xml\openElement
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:109
SpecialImport\$namespace
$namespace
Definition: SpecialImport.php:38
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:37
Linker\tooltipAndAccesskeyAttribs
static tooltipAndAccesskeyAttribs( $name, array $msgParams=[], $options=null)
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2135
Html\input
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:645
Xml\fieldset
static fieldset( $legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:610
SpecialImport\$subproject
$subproject
Definition: SpecialImport.php:35
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:832
SpecialImport\execute
execute( $par)
Execute.
Definition: SpecialImport.php:63
SpecialImport\doImport
doImport()
Do the actual import.
Definition: SpecialImport.php:111
SpecialImport\$importSources
$importSources
Definition: SpecialImport.php:45
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
SpecialImport\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialImport.php:563
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
SpecialImport\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialImport.php:53
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
ImportStreamSource\newFromInterwiki
static newFromInterwiki( $interwiki, $page, $history=false, $templates=false, $pageLinkDepth=0)
Definition: ImportStreamSource.php:142
SpecialImport\$interwiki
$interwiki
Definition: SpecialImport.php:34
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:774
$attribs
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:2014
SpecialImport\$frompage
$frompage
Definition: SpecialImport.php:40
$value
$value
Definition: styleTest.css.php:45
Html\namespaceSelector
static namespaceSelector(array $params=[], array $selectAttribs=[])
Build a drop-down box for selecting a namespace.
Definition: Html.php:862
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialImport\$logcomment
$logcomment
Definition: SpecialImport.php:41
Xml\radioLabel
static radioLabel( $label, $name, $value, $id, $checked=false, $attribs=[])
Convenience function to build an HTML radio button with a label.
Definition: Xml.php:445
Xml\closeElement
static closeElement( $element)
Shortcut to close an XML element.
Definition: Xml.php:118
SpecialImport\$sourceName
$sourceName
Definition: SpecialImport.php:33
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:22
SpecialImport\__construct
__construct()
Definition: SpecialImport.php:49
$source
$source
Definition: mwdoc-filter.php:46
history
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc next in line in page history
Definition: hooks.txt:1777
SpecialImport\$mapping
$mapping
Definition: SpecialImport.php:37
Xml\input
static input( $name, $size=false, $value=false, $attribs=[])
Convenience function to build an HTML text input field.
Definition: Xml.php:275
SpecialImport\$assignKnownUsers
$assignKnownUsers
Definition: SpecialImport.php:46
SpecialPage\checkReadOnly
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
Definition: SpecialPage.php:319
$request
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:2806
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
SpecialImport\$rootpage
$rootpage
Definition: SpecialImport.php:39
SpecialImport\$history
$history
Definition: SpecialImport.php:42
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
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:629
ImportStreamSource\newFromUpload
static newFromUpload( $fieldname="xmlimport")
Definition: ImportStreamSource.php:69
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
Xml\submitButton
static submitButton( $value, $attribs=[])
Convenience function to build an HTML submit button When $wgUseMediaWikiUIEverywhere is true it will ...
Definition: Xml.php:460
Xml\checkLabel
static checkLabel( $label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:420
SpecialImport\getMappingFormPart
getMappingFormPart( $sourceName)
Definition: SpecialImport.php:244