MediaWiki  1.28.1
SpecialUpload.php
Go to the documentation of this file.
1 <?php
27 
34 class SpecialUpload extends SpecialPage {
40  public function __construct( $request = null ) {
41  parent::__construct( 'Upload', 'upload' );
42  }
43 
44  public function doesWrites() {
45  return true;
46  }
47 
51  public $mRequest;
52  public $mSourceType;
53 
55  public $mUpload;
56 
58  public $mLocalFile;
60 
65  public $mComment;
66  public $mLicense;
67 
71  public $mWatchthis;
74 
78 
80  public $mForReUpload;
81 
84  public $mTokenOk;
85 
87  public $mUploadSuccessful = false;
88 
92 
96  protected function loadRequest() {
97  $this->mRequest = $request = $this->getRequest();
98  $this->mSourceType = $request->getVal( 'wpSourceType', 'file' );
99  $this->mUpload = UploadBase::createFromRequest( $request );
100  $this->mUploadClicked = $request->wasPosted()
101  && ( $request->getCheck( 'wpUpload' )
102  || $request->getCheck( 'wpUploadIgnoreWarning' ) );
103 
104  // Guess the desired name from the filename if not provided
105  $this->mDesiredDestName = $request->getText( 'wpDestFile' );
106  if ( !$this->mDesiredDestName && $request->getFileName( 'wpUploadFile' ) !== null ) {
107  $this->mDesiredDestName = $request->getFileName( 'wpUploadFile' );
108  }
109  $this->mLicense = $request->getText( 'wpLicense' );
110 
111  $this->mDestWarningAck = $request->getText( 'wpDestFileWarningAck' );
112  $this->mIgnoreWarning = $request->getCheck( 'wpIgnoreWarning' )
113  || $request->getCheck( 'wpUploadIgnoreWarning' );
114  $this->mWatchthis = $request->getBool( 'wpWatchthis' ) && $this->getUser()->isLoggedIn();
115  $this->mCopyrightStatus = $request->getText( 'wpUploadCopyStatus' );
116  $this->mCopyrightSource = $request->getText( 'wpUploadSource' );
117 
118  $this->mForReUpload = $request->getBool( 'wpForReUpload' ); // updating a file
119 
120  $commentDefault = '';
121  $commentMsg = wfMessage( 'upload-default-description' )->inContentLanguage();
122  if ( !$this->mForReUpload && !$commentMsg->isDisabled() ) {
123  $commentDefault = $commentMsg->plain();
124  }
125  $this->mComment = $request->getText( 'wpUploadDescription', $commentDefault );
126 
127  $this->mCancelUpload = $request->getCheck( 'wpCancelUpload' )
128  || $request->getCheck( 'wpReUpload' ); // b/w compat
129 
130  // If it was posted check for the token (no remote POST'ing with user credentials)
131  $token = $request->getVal( 'wpEditToken' );
132  $this->mTokenOk = $this->getUser()->matchEditToken( $token );
133 
134  $this->uploadFormTextTop = '';
135  $this->uploadFormTextAfterSummary = '';
136  }
137 
146  public function userCanExecute( User $user ) {
147  return UploadBase::isEnabled() && parent::userCanExecute( $user );
148  }
149 
161  public function execute( $par ) {
162  $this->useTransactionalTimeLimit();
163 
164  $this->setHeaders();
165  $this->outputHeader();
166 
167  # Check uploading enabled
168  if ( !UploadBase::isEnabled() ) {
169  throw new ErrorPageError( 'uploaddisabled', 'uploaddisabledtext' );
170  }
171 
172  $this->addHelpLink( 'Help:Managing files' );
173 
174  # Check permissions
175  $user = $this->getUser();
176  $permissionRequired = UploadBase::isAllowed( $user );
177  if ( $permissionRequired !== true ) {
178  throw new PermissionsError( $permissionRequired );
179  }
180 
181  # Check blocks
182  if ( $user->isBlocked() ) {
183  throw new UserBlockedError( $user->getBlock() );
184  }
185 
186  // Global blocks
187  if ( $user->isBlockedGlobally() ) {
188  throw new UserBlockedError( $user->getGlobalBlock() );
189  }
190 
191  # Check whether we actually want to allow changing stuff
192  $this->checkReadOnly();
193 
194  $this->loadRequest();
195 
196  # Unsave the temporary file in case this was a cancelled upload
197  if ( $this->mCancelUpload ) {
198  if ( !$this->unsaveUploadedFile() ) {
199  # Something went wrong, so unsaveUploadedFile showed a warning
200  return;
201  }
202  }
203 
204  # Process upload or show a form
205  if (
206  $this->mTokenOk && !$this->mCancelUpload &&
207  ( $this->mUpload && $this->mUploadClicked )
208  ) {
209  $this->processUpload();
210  } else {
211  # Backwards compatibility hook
212  if ( !Hooks::run( 'UploadForm:initial', [ &$this ] ) ) {
213  wfDebug( "Hook 'UploadForm:initial' broke output of the upload form\n" );
214 
215  return;
216  }
217  $this->showUploadForm( $this->getUploadForm() );
218  }
219 
220  # Cleanup
221  if ( $this->mUpload ) {
222  $this->mUpload->cleanupTempFile();
223  }
224  }
225 
231  protected function showUploadForm( $form ) {
232  # Add links if file was previously deleted
233  if ( $this->mDesiredDestName ) {
234  $this->showViewDeletedLinks();
235  }
236 
237  if ( $form instanceof HTMLForm ) {
238  $form->show();
239  } else {
240  $this->getOutput()->addHTML( $form );
241  }
242  }
243 
252  protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) {
253  # Initialize form
254  $context = new DerivativeContext( $this->getContext() );
255  $context->setTitle( $this->getPageTitle() ); // Remove subpage
256  $form = new UploadForm( [
257  'watch' => $this->getWatchCheck(),
258  'forreupload' => $this->mForReUpload,
259  'sessionkey' => $sessionKey,
260  'hideignorewarning' => $hideIgnoreWarning,
261  'destwarningack' => (bool)$this->mDestWarningAck,
262 
263  'description' => $this->mComment,
264  'texttop' => $this->uploadFormTextTop,
265  'textaftersummary' => $this->uploadFormTextAfterSummary,
266  'destfile' => $this->mDesiredDestName,
267  ], $context, $this->getLinkRenderer() );
268 
269  # Check the token, but only if necessary
270  if (
271  !$this->mTokenOk && !$this->mCancelUpload &&
272  ( $this->mUpload && $this->mUploadClicked )
273  ) {
274  $form->addPreText( $this->msg( 'session_fail_preview' )->parse() );
275  }
276 
277  # Give a notice if the user is uploading a file that has been deleted or moved
278  # Note that this is independent from the message 'filewasdeleted'
279  $desiredTitleObj = Title::makeTitleSafe( NS_FILE, $this->mDesiredDestName );
280  $delNotice = ''; // empty by default
281  if ( $desiredTitleObj instanceof Title && !$desiredTitleObj->exists() ) {
282  LogEventsList::showLogExtract( $delNotice, [ 'delete', 'move' ],
283  $desiredTitleObj,
284  '', [ 'lim' => 10,
285  'conds' => [ "log_action != 'revision'" ],
286  'showIfEmpty' => false,
287  'msgKey' => [ 'upload-recreate-warning' ] ]
288  );
289  }
290  $form->addPreText( $delNotice );
291 
292  # Add text to form
293  $form->addPreText( '<div id="uploadtext">' .
294  $this->msg( 'uploadtext', [ $this->mDesiredDestName ] )->parseAsBlock() .
295  '</div>' );
296  # Add upload error message
297  $form->addPreText( $message );
298 
299  # Add footer to form
300  $uploadFooter = $this->msg( 'uploadfooter' );
301  if ( !$uploadFooter->isDisabled() ) {
302  $form->addPostText( '<div id="mw-upload-footer-message">'
303  . $uploadFooter->parseAsBlock() . "</div>\n" );
304  }
305 
306  return $form;
307  }
308 
312  protected function showViewDeletedLinks() {
313  $title = Title::makeTitleSafe( NS_FILE, $this->mDesiredDestName );
314  $user = $this->getUser();
315  // Show a subtitle link to deleted revisions (to sysops et al only)
316  if ( $title instanceof Title ) {
317  $count = $title->isDeleted();
318  if ( $count > 0 && $user->isAllowed( 'deletedhistory' ) ) {
319  $restorelink = $this->getLinkRenderer()->makeKnownLink(
320  SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedText() ),
321  $this->msg( 'restorelink' )->numParams( $count )->text()
322  );
323  $link = $this->msg( $user->isAllowed( 'delete' ) ? 'thisisdeleted' : 'viewdeleted' )
324  ->rawParams( $restorelink )->parseAsBlock();
325  $this->getOutput()->addHTML( "<div id=\"contentSub2\">{$link}</div>" );
326  }
327  }
328  }
329 
341  protected function showRecoverableUploadError( $message ) {
342  $stashStatus = $this->mUpload->tryStashFile( $this->getUser() );
343  if ( $stashStatus->isGood() ) {
344  $sessionKey = $stashStatus->getValue()->getFileKey();
345  } else {
346  $sessionKey = null;
347  // TODO Add a warning message about the failure to stash here?
348  }
349  $message = '<h2>' . $this->msg( 'uploaderror' )->escaped() . "</h2>\n" .
350  '<div class="error">' . $message . "</div>\n";
351 
352  $form = $this->getUploadForm( $message, $sessionKey );
353  $form->setSubmitText( $this->msg( 'upload-tryagain' )->escaped() );
354  $this->showUploadForm( $form );
355  }
356 
365  protected function showUploadWarning( $warnings ) {
366  # If there are no warnings, or warnings we can ignore, return early.
367  # mDestWarningAck is set when some javascript has shown the warning
368  # to the user. mForReUpload is set when the user clicks the "upload a
369  # new version" link.
370  if ( !$warnings || ( count( $warnings ) == 1
371  && isset( $warnings['exists'] )
372  && ( $this->mDestWarningAck || $this->mForReUpload ) )
373  ) {
374  return false;
375  }
376 
377  $stashStatus = $this->mUpload->tryStashFile( $this->getUser() );
378  if ( $stashStatus->isGood() ) {
379  $sessionKey = $stashStatus->getValue()->getFileKey();
380  } else {
381  $sessionKey = null;
382  // TODO Add a warning message about the failure to stash here?
383  }
384 
385  // Add styles for the warning, reused from the live preview
386  $this->getOutput()->addModuleStyles( 'mediawiki.special.upload.styles' );
387 
388  $linkRenderer = $this->getLinkRenderer();
389  $warningHtml = '<h2>' . $this->msg( 'uploadwarning' )->escaped() . "</h2>\n"
390  . '<div class="mw-destfile-warning"><ul>';
391  foreach ( $warnings as $warning => $args ) {
392  if ( $warning == 'badfilename' ) {
393  $this->mDesiredDestName = Title::makeTitle( NS_FILE, $args )->getText();
394  }
395  if ( $warning == 'exists' ) {
396  $msg = "\t<li>" . self::getExistsWarning( $args ) . "</li>\n";
397  } elseif ( $warning == 'no-change' ) {
398  $file = $args;
399  $filename = $file->getTitle()->getPrefixedText();
400  $msg = "\t<li>" . wfMessage( 'fileexists-no-change', $filename )->parse() . "</li>\n";
401  } elseif ( $warning == 'duplicate-version' ) {
402  $file = $args[0];
403  $count = count( $args );
404  $filename = $file->getTitle()->getPrefixedText();
405  $message = wfMessage( 'fileexists-duplicate-version' )
406  ->params( $filename )
407  ->numParams( $count );
408  $msg = "\t<li>" . $message->parse() . "</li>\n";
409  } elseif ( $warning == 'was-deleted' ) {
410  # If the file existed before and was deleted, warn the user of this
411  $ltitle = SpecialPage::getTitleFor( 'Log' );
412  $llink = $linkRenderer->makeKnownLink(
413  $ltitle,
414  wfMessage( 'deletionlog' )->text(),
415  [],
416  [
417  'type' => 'delete',
418  'page' => Title::makeTitle( NS_FILE, $args )->getPrefixedText(),
419  ]
420  );
421  $msg = "\t<li>" . wfMessage( 'filewasdeleted' )->rawParams( $llink )->parse() . "</li>\n";
422  } elseif ( $warning == 'duplicate' ) {
423  $msg = $this->getDupeWarning( $args );
424  } elseif ( $warning == 'duplicate-archive' ) {
425  if ( $args === '' ) {
426  $msg = "\t<li>" . $this->msg( 'file-deleted-duplicate-notitle' )->parse()
427  . "</li>\n";
428  } else {
429  $msg = "\t<li>" . $this->msg( 'file-deleted-duplicate',
430  Title::makeTitle( NS_FILE, $args )->getPrefixedText() )->parse()
431  . "</li>\n";
432  }
433  } else {
434  if ( $args === true ) {
435  $args = [];
436  } elseif ( !is_array( $args ) ) {
437  $args = [ $args ];
438  }
439  $msg = "\t<li>" . $this->msg( $warning, $args )->parse() . "</li>\n";
440  }
441  $warningHtml .= $msg;
442  }
443  $warningHtml .= "</ul></div>\n";
444  $warningHtml .= $this->msg( 'uploadwarning-text' )->parseAsBlock();
445 
446  $form = $this->getUploadForm( $warningHtml, $sessionKey, /* $hideIgnoreWarning */ true );
447  $form->setSubmitText( $this->msg( 'upload-tryagain' )->text() );
448  $form->addButton( [
449  'name' => 'wpUploadIgnoreWarning',
450  'value' => $this->msg( 'ignorewarning' )->text()
451  ] );
452  $form->addButton( [
453  'name' => 'wpCancelUpload',
454  'value' => $this->msg( 'reuploaddesc' )->text()
455  ] );
456 
457  $this->showUploadForm( $form );
458 
459  # Indicate that we showed a form
460  return true;
461  }
462 
468  protected function showUploadError( $message ) {
469  $message = '<h2>' . $this->msg( 'uploadwarning' )->escaped() . "</h2>\n" .
470  '<div class="error">' . $message . "</div>\n";
471  $this->showUploadForm( $this->getUploadForm( $message ) );
472  }
473 
478  protected function processUpload() {
479  // Fetch the file if required
480  $status = $this->mUpload->fetchFile();
481  if ( !$status->isOK() ) {
482  $this->showUploadError( $this->getOutput()->parse( $status->getWikiText() ) );
483 
484  return;
485  }
486 
487  if ( !Hooks::run( 'UploadForm:BeforeProcessing', [ &$this ] ) ) {
488  wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file.\n" );
489  // This code path is deprecated. If you want to break upload processing
490  // do so by hooking into the appropriate hooks in UploadBase::verifyUpload
491  // and UploadBase::verifyFile.
492  // If you use this hook to break uploading, the user will be returned
493  // an empty form with no error message whatsoever.
494  return;
495  }
496 
497  // Upload verification
498  $details = $this->mUpload->verifyUpload();
499  if ( $details['status'] != UploadBase::OK ) {
500  $this->processVerificationError( $details );
501 
502  return;
503  }
504 
505  // Verify permissions for this title
506  $permErrors = $this->mUpload->verifyTitlePermissions( $this->getUser() );
507  if ( $permErrors !== true ) {
508  $code = array_shift( $permErrors[0] );
509  $this->showRecoverableUploadError( $this->msg( $code, $permErrors[0] )->parse() );
510 
511  return;
512  }
513 
514  $this->mLocalFile = $this->mUpload->getLocalFile();
515 
516  // Check warnings if necessary
517  if ( !$this->mIgnoreWarning ) {
518  $warnings = $this->mUpload->checkWarnings();
519  if ( $this->showUploadWarning( $warnings ) ) {
520  return;
521  }
522  }
523 
524  // This is as late as we can throttle, after expected issues have been handled
525  if ( UploadBase::isThrottled( $this->getUser() ) ) {
527  $this->msg( 'actionthrottledtext' )->escaped()
528  );
529  return;
530  }
531 
532  // Get the page text if this is not a reupload
533  if ( !$this->mForReUpload ) {
534  $pageText = self::getInitialPageText( $this->mComment, $this->mLicense,
535  $this->mCopyrightStatus, $this->mCopyrightSource, $this->getConfig() );
536  } else {
537  $pageText = false;
538  }
539 
540  $changeTags = $this->getRequest()->getVal( 'wpChangeTags' );
541  if ( is_null( $changeTags ) || $changeTags === '' ) {
542  $changeTags = [];
543  } else {
544  $changeTags = array_filter( array_map( 'trim', explode( ',', $changeTags ) ) );
545  }
546 
547  if ( $changeTags ) {
548  $changeTagsStatus = ChangeTags::canAddTagsAccompanyingChange(
549  $changeTags, $this->getUser() );
550  if ( !$changeTagsStatus->isOK() ) {
551  $this->showUploadError( $this->getOutput()->parse( $changeTagsStatus->getWikiText() ) );
552 
553  return;
554  }
555  }
556 
557  $status = $this->mUpload->performUpload(
558  $this->mComment,
559  $pageText,
560  $this->mWatchthis,
561  $this->getUser(),
562  $changeTags
563  );
564 
565  if ( !$status->isGood() ) {
566  $this->showRecoverableUploadError( $this->getOutput()->parse( $status->getWikiText() ) );
567 
568  return;
569  }
570 
571  // Success, redirect to description page
572  $this->mUploadSuccessful = true;
573  Hooks::run( 'SpecialUploadComplete', [ &$this ] );
574  $this->getOutput()->redirect( $this->mLocalFile->getTitle()->getFullURL() );
575  }
576 
586  public static function getInitialPageText( $comment = '', $license = '',
587  $copyStatus = '', $source = '', Config $config = null
588  ) {
589  if ( $config === null ) {
590  wfDebug( __METHOD__ . ' called without a Config instance passed to it' );
591  $config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
592  }
593 
594  $msg = [];
595  $forceUIMsgAsContentMsg = (array)$config->get( 'ForceUIMsgAsContentMsg' );
596  /* These messages are transcluded into the actual text of the description page.
597  * Thus, forcing them as content messages makes the upload to produce an int: template
598  * instead of hardcoding it there in the uploader language.
599  */
600  foreach ( [ 'license-header', 'filedesc', 'filestatus', 'filesource' ] as $msgName ) {
601  if ( in_array( $msgName, $forceUIMsgAsContentMsg ) ) {
602  $msg[$msgName] = "{{int:$msgName}}";
603  } else {
604  $msg[$msgName] = wfMessage( $msgName )->inContentLanguage()->text();
605  }
606  }
607 
608  if ( $config->get( 'UseCopyrightUpload' ) ) {
609  $licensetxt = '';
610  if ( $license != '' ) {
611  $licensetxt = '== ' . $msg['license-header'] . " ==\n" . '{{' . $license . '}}' . "\n";
612  }
613  $pageText = '== ' . $msg['filedesc'] . " ==\n" . $comment . "\n" .
614  '== ' . $msg['filestatus'] . " ==\n" . $copyStatus . "\n" .
615  "$licensetxt" .
616  '== ' . $msg['filesource'] . " ==\n" . $source;
617  } else {
618  if ( $license != '' ) {
619  $filedesc = $comment == '' ? '' : '== ' . $msg['filedesc'] . " ==\n" . $comment . "\n";
620  $pageText = $filedesc .
621  '== ' . $msg['license-header'] . " ==\n" . '{{' . $license . '}}' . "\n";
622  } else {
623  $pageText = $comment;
624  }
625  }
626 
627  return $pageText;
628  }
629 
642  protected function getWatchCheck() {
643  if ( $this->getUser()->getOption( 'watchdefault' ) ) {
644  // Watch all edits!
645  return true;
646  }
647 
648  $desiredTitleObj = Title::makeTitleSafe( NS_FILE, $this->mDesiredDestName );
649  if ( $desiredTitleObj instanceof Title && $this->getUser()->isWatched( $desiredTitleObj ) ) {
650  // Already watched, don't change that
651  return true;
652  }
653 
654  $local = wfLocalFile( $this->mDesiredDestName );
655  if ( $local && $local->exists() ) {
656  // We're uploading a new version of an existing file.
657  // No creation, so don't watch it if we're not already.
658  return false;
659  } else {
660  // New page should get watched if that's our option.
661  return $this->getUser()->getOption( 'watchcreations' ) ||
662  $this->getUser()->getOption( 'watchuploads' );
663  }
664  }
665 
672  protected function processVerificationError( $details ) {
673  switch ( $details['status'] ) {
674 
677  $this->showRecoverableUploadError( $this->msg( 'minlength1' )->escaped() );
678  break;
680  $this->showRecoverableUploadError( $this->msg( 'illegalfilename',
681  $details['filtered'] )->parse() );
682  break;
684  $this->showRecoverableUploadError( $this->msg( 'filename-toolong' )->escaped() );
685  break;
687  $this->showRecoverableUploadError( $this->msg( 'filetype-missing' )->parse() );
688  break;
690  $this->showRecoverableUploadError( $this->msg( 'windows-nonascii-filename' )->parse() );
691  break;
692 
695  $this->showUploadError( $this->msg( 'emptyfile' )->escaped() );
696  break;
698  $this->showUploadError( $this->msg( 'largefileserver' )->escaped() );
699  break;
701  $msg = $this->msg( 'filetype-banned-type' );
702  if ( isset( $details['blacklistedExt'] ) ) {
703  $msg->params( $this->getLanguage()->commaList( $details['blacklistedExt'] ) );
704  } else {
705  $msg->params( $details['finalExt'] );
706  }
707  $extensions = array_unique( $this->getConfig()->get( 'FileExtensions' ) );
708  $msg->params( $this->getLanguage()->commaList( $extensions ),
709  count( $extensions ) );
710 
711  // Add PLURAL support for the first parameter. This results
712  // in a bit unlogical parameter sequence, but does not break
713  // old translations
714  if ( isset( $details['blacklistedExt'] ) ) {
715  $msg->params( count( $details['blacklistedExt'] ) );
716  } else {
717  $msg->params( 1 );
718  }
719 
720  $this->showUploadError( $msg->parse() );
721  break;
723  unset( $details['status'] );
724  $code = array_shift( $details['details'] );
725  $this->showUploadError( $this->msg( $code, $details['details'] )->parse() );
726  break;
728  if ( is_array( $details['error'] ) ) { # allow hooks to return error details in an array
729  $args = $details['error'];
730  $error = array_shift( $args );
731  } else {
732  $error = $details['error'];
733  $args = null;
734  }
735 
736  $this->showUploadError( $this->msg( $error, $args )->parse() );
737  break;
738  default:
739  throw new MWException( __METHOD__ . ": Unknown value `{$details['status']}`" );
740  }
741  }
742 
748  protected function unsaveUploadedFile() {
749  if ( !( $this->mUpload instanceof UploadFromStash ) ) {
750  return true;
751  }
752  $success = $this->mUpload->unsaveUploadedFile();
753  if ( !$success ) {
754  $this->getOutput()->showFileDeleteError( $this->mUpload->getTempPath() );
755 
756  return false;
757  } else {
758  return true;
759  }
760  }
761 
762  /*** Functions for formatting warnings ***/
763 
771  public static function getExistsWarning( $exists ) {
772  if ( !$exists ) {
773  return '';
774  }
775 
776  $file = $exists['file'];
777  $filename = $file->getTitle()->getPrefixedText();
778  $warnMsg = null;
779 
780  if ( $exists['warning'] == 'exists' ) {
781  // Exact match
782  $warnMsg = wfMessage( 'fileexists', $filename );
783  } elseif ( $exists['warning'] == 'page-exists' ) {
784  // Page exists but file does not
785  $warnMsg = wfMessage( 'filepageexists', $filename );
786  } elseif ( $exists['warning'] == 'exists-normalized' ) {
787  $warnMsg = wfMessage( 'fileexists-extension', $filename,
788  $exists['normalizedFile']->getTitle()->getPrefixedText() );
789  } elseif ( $exists['warning'] == 'thumb' ) {
790  // Swapped argument order compared with other messages for backwards compatibility
791  $warnMsg = wfMessage( 'fileexists-thumbnail-yes',
792  $exists['thumbFile']->getTitle()->getPrefixedText(), $filename );
793  } elseif ( $exists['warning'] == 'thumb-name' ) {
794  // Image w/o '180px-' does not exists, but we do not like these filenames
795  $name = $file->getName();
796  $badPart = substr( $name, 0, strpos( $name, '-' ) + 1 );
797  $warnMsg = wfMessage( 'file-thumbnail-no', $badPart );
798  } elseif ( $exists['warning'] == 'bad-prefix' ) {
799  $warnMsg = wfMessage( 'filename-bad-prefix', $exists['prefix'] );
800  }
801 
802  return $warnMsg ? $warnMsg->title( $file->getTitle() )->parse() : '';
803  }
804 
810  public function getDupeWarning( $dupes ) {
811  if ( !$dupes ) {
812  return '';
813  }
814 
815  $gallery = ImageGalleryBase::factory( false, $this->getContext() );
816  $gallery->setShowBytes( false );
817  foreach ( $dupes as $file ) {
818  $gallery->add( $file->getTitle() );
819  }
820 
821  return '<li>' .
822  $this->msg( 'file-exists-duplicate' )->numParams( count( $dupes ) )->parse() .
823  $gallery->toHTML() . "</li>\n";
824  }
825 
826  protected function getGroupName() {
827  return 'media';
828  }
829 
837  public static function rotationEnabled() {
838  $bitmapHandler = new BitmapHandler();
839  return $bitmapHandler->autoRotateEnabled();
840  }
841 }
842 
846 class UploadForm extends HTMLForm {
847  protected $mWatch;
848  protected $mForReUpload;
849  protected $mSessionKey;
851  protected $mDestWarningAck;
852  protected $mDestFile;
853 
854  protected $mComment;
855  protected $mTextTop;
857 
858  protected $mSourceIds;
859 
860  protected $mMaxFileSize = [];
861 
862  protected $mMaxUploadSize = [];
863 
864  public function __construct( array $options = [], IContextSource $context = null,
866  ) {
867  if ( $context instanceof IContextSource ) {
868  $this->setContext( $context );
869  }
870 
871  if ( !$linkRenderer ) {
872  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
873  }
874 
875  $this->mWatch = !empty( $options['watch'] );
876  $this->mForReUpload = !empty( $options['forreupload'] );
877  $this->mSessionKey = isset( $options['sessionkey'] ) ? $options['sessionkey'] : '';
878  $this->mHideIgnoreWarning = !empty( $options['hideignorewarning'] );
879  $this->mDestWarningAck = !empty( $options['destwarningack'] );
880  $this->mDestFile = isset( $options['destfile'] ) ? $options['destfile'] : '';
881 
882  $this->mComment = isset( $options['description'] ) ?
883  $options['description'] : '';
884 
885  $this->mTextTop = isset( $options['texttop'] )
886  ? $options['texttop'] : '';
887 
888  $this->mTextAfterSummary = isset( $options['textaftersummary'] )
889  ? $options['textaftersummary'] : '';
890 
891  $sourceDescriptor = $this->getSourceSection();
892  $descriptor = $sourceDescriptor
893  + $this->getDescriptionSection()
894  + $this->getOptionsSection();
895 
896  Hooks::run( 'UploadFormInitDescriptor', [ &$descriptor ] );
897  parent::__construct( $descriptor, $context, 'upload' );
898 
899  # Add a link to edit MediaWiki:Licenses
900  if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
901  $this->getOutput()->addModuleStyles( 'mediawiki.special.upload.styles' );
902  $licensesLink = $linkRenderer->makeKnownLink(
903  $this->msg( 'licenses' )->inContentLanguage()->getTitle(),
904  $this->msg( 'licenses-edit' )->text(),
905  [],
906  [ 'action' => 'edit' ]
907  );
908  $editLicenses = '<p class="mw-upload-editlicenses">' . $licensesLink . '</p>';
909  $this->addFooterText( $editLicenses, 'description' );
910  }
911 
912  # Set some form properties
913  $this->setSubmitText( $this->msg( 'uploadbtn' )->text() );
914  $this->setSubmitName( 'wpUpload' );
915  # Used message keys: 'accesskey-upload', 'tooltip-upload'
916  $this->setSubmitTooltip( 'upload' );
917  $this->setId( 'mw-upload-form' );
918 
919  # Build a list of IDs for javascript insertion
920  $this->mSourceIds = [];
921  foreach ( $sourceDescriptor as $field ) {
922  if ( !empty( $field['id'] ) ) {
923  $this->mSourceIds[] = $field['id'];
924  }
925  }
926  }
927 
934  protected function getSourceSection() {
935  if ( $this->mSessionKey ) {
936  return [
937  'SessionKey' => [
938  'type' => 'hidden',
939  'default' => $this->mSessionKey,
940  ],
941  'SourceType' => [
942  'type' => 'hidden',
943  'default' => 'Stash',
944  ],
945  ];
946  }
947 
948  $canUploadByUrl = UploadFromUrl::isEnabled()
949  && ( UploadFromUrl::isAllowed( $this->getUser() ) === true )
950  && $this->getConfig()->get( 'CopyUploadsFromSpecialUpload' );
951  $radio = $canUploadByUrl;
952  $selectedSourceType = strtolower( $this->getRequest()->getText( 'wpSourceType', 'File' ) );
953 
954  $descriptor = [];
955  if ( $this->mTextTop ) {
956  $descriptor['UploadFormTextTop'] = [
957  'type' => 'info',
958  'section' => 'source',
959  'default' => $this->mTextTop,
960  'raw' => true,
961  ];
962  }
963 
964  $this->mMaxUploadSize['file'] = min(
967  );
968 
969  $help = $this->msg( 'upload-maxfilesize',
970  $this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize['file'] )
971  )->parse();
972 
973  // If the user can also upload by URL, there are 2 different file size limits.
974  // This extra message helps stress which limit corresponds to what.
975  if ( $canUploadByUrl ) {
976  $help .= $this->msg( 'word-separator' )->escaped();
977  $help .= $this->msg( 'upload_source_file' )->parse();
978  }
979 
980  $descriptor['UploadFile'] = [
981  'class' => 'UploadSourceField',
982  'section' => 'source',
983  'type' => 'file',
984  'id' => 'wpUploadFile',
985  'radio-id' => 'wpSourceTypeFile',
986  'label-message' => 'sourcefilename',
987  'upload-type' => 'File',
988  'radio' => &$radio,
989  'help' => $help,
990  'checked' => $selectedSourceType == 'file',
991  ];
992 
993  if ( $canUploadByUrl ) {
994  $this->mMaxUploadSize['url'] = UploadBase::getMaxUploadSize( 'url' );
995  $descriptor['UploadFileURL'] = [
996  'class' => 'UploadSourceField',
997  'section' => 'source',
998  'id' => 'wpUploadFileURL',
999  'radio-id' => 'wpSourceTypeurl',
1000  'label-message' => 'sourceurl',
1001  'upload-type' => 'url',
1002  'radio' => &$radio,
1003  'help' => $this->msg( 'upload-maxfilesize',
1004  $this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize['url'] )
1005  )->parse() .
1006  $this->msg( 'word-separator' )->escaped() .
1007  $this->msg( 'upload_source_url' )->parse(),
1008  'checked' => $selectedSourceType == 'url',
1009  ];
1010  }
1011  Hooks::run( 'UploadFormSourceDescriptors', [ &$descriptor, &$radio, $selectedSourceType ] );
1012 
1013  $descriptor['Extensions'] = [
1014  'type' => 'info',
1015  'section' => 'source',
1016  'default' => $this->getExtensionsMessage(),
1017  'raw' => true,
1018  ];
1019 
1020  return $descriptor;
1021  }
1022 
1028  protected function getExtensionsMessage() {
1029  # Print a list of allowed file extensions, if so configured. We ignore
1030  # MIME type here, it's incomprehensible to most people and too long.
1031  $config = $this->getConfig();
1032 
1033  if ( $config->get( 'CheckFileExtensions' ) ) {
1034  $fileExtensions = array_unique( $config->get( 'FileExtensions' ) );
1035  if ( $config->get( 'StrictFileExtensions' ) ) {
1036  # Everything not permitted is banned
1037  $extensionsList =
1038  '<div id="mw-upload-permitted">' .
1039  $this->msg( 'upload-permitted' )
1040  ->params( $this->getLanguage()->commaList( $fileExtensions ) )
1041  ->numParams( count( $fileExtensions ) )
1042  ->parseAsBlock() .
1043  "</div>\n";
1044  } else {
1045  # We have to list both preferred and prohibited
1046  $fileBlacklist = array_unique( $config->get( 'FileBlacklist' ) );
1047  $extensionsList =
1048  '<div id="mw-upload-preferred">' .
1049  $this->msg( 'upload-preferred' )
1050  ->params( $this->getLanguage()->commaList( $fileExtensions ) )
1051  ->numParams( count( $fileExtensions ) )
1052  ->parseAsBlock() .
1053  "</div>\n" .
1054  '<div id="mw-upload-prohibited">' .
1055  $this->msg( 'upload-prohibited' )
1056  ->params( $this->getLanguage()->commaList( $fileBlacklist ) )
1057  ->numParams( count( $fileBlacklist ) )
1058  ->parseAsBlock() .
1059  "</div>\n";
1060  }
1061  } else {
1062  # Everything is permitted.
1063  $extensionsList = '';
1064  }
1065 
1066  return $extensionsList;
1067  }
1068 
1075  protected function getDescriptionSection() {
1076  $config = $this->getConfig();
1077  if ( $this->mSessionKey ) {
1078  $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $this->getUser() );
1079  try {
1080  $file = $stash->getFile( $this->mSessionKey );
1081  } catch ( Exception $e ) {
1082  $file = null;
1083  }
1084  if ( $file ) {
1086 
1087  $mto = $file->transform( [ 'width' => 120 ] );
1088  if ( $mto ) {
1089  $this->addHeaderText(
1090  '<div class="thumb t' . $wgContLang->alignEnd() . '">' .
1091  Html::element( 'img', [
1092  'src' => $mto->getUrl(),
1093  'class' => 'thumbimage',
1094  ] ) . '</div>', 'description' );
1095  }
1096  }
1097  }
1098 
1099  $descriptor = [
1100  'DestFile' => [
1101  'type' => 'text',
1102  'section' => 'description',
1103  'id' => 'wpDestFile',
1104  'label-message' => 'destfilename',
1105  'size' => 60,
1106  'default' => $this->mDestFile,
1107  # @todo FIXME: Hack to work around poor handling of the 'default' option in HTMLForm
1108  'nodata' => strval( $this->mDestFile ) !== '',
1109  ],
1110  'UploadDescription' => [
1111  'type' => 'textarea',
1112  'section' => 'description',
1113  'id' => 'wpUploadDescription',
1114  'label-message' => $this->mForReUpload
1115  ? 'filereuploadsummary'
1116  : 'fileuploadsummary',
1117  'default' => $this->mComment,
1118  'cols' => $this->getUser()->getIntOption( 'cols' ),
1119  'rows' => 8,
1120  ]
1121  ];
1122  if ( $this->mTextAfterSummary ) {
1123  $descriptor['UploadFormTextAfterSummary'] = [
1124  'type' => 'info',
1125  'section' => 'description',
1126  'default' => $this->mTextAfterSummary,
1127  'raw' => true,
1128  ];
1129  }
1130 
1131  $descriptor += [
1132  'EditTools' => [
1133  'type' => 'edittools',
1134  'section' => 'description',
1135  'message' => 'edittools-upload',
1136  ]
1137  ];
1138 
1139  if ( $this->mForReUpload ) {
1140  $descriptor['DestFile']['readonly'] = true;
1141  } else {
1142  $descriptor['License'] = [
1143  'type' => 'select',
1144  'class' => 'Licenses',
1145  'section' => 'description',
1146  'id' => 'wpLicense',
1147  'label-message' => 'license',
1148  ];
1149  }
1150 
1151  if ( $config->get( 'UseCopyrightUpload' ) ) {
1152  $descriptor['UploadCopyStatus'] = [
1153  'type' => 'text',
1154  'section' => 'description',
1155  'id' => 'wpUploadCopyStatus',
1156  'label-message' => 'filestatus',
1157  ];
1158  $descriptor['UploadSource'] = [
1159  'type' => 'text',
1160  'section' => 'description',
1161  'id' => 'wpUploadSource',
1162  'label-message' => 'filesource',
1163  ];
1164  }
1165 
1166  return $descriptor;
1167  }
1168 
1175  protected function getOptionsSection() {
1176  $user = $this->getUser();
1177  if ( $user->isLoggedIn() ) {
1178  $descriptor = [
1179  'Watchthis' => [
1180  'type' => 'check',
1181  'id' => 'wpWatchthis',
1182  'label-message' => 'watchthisupload',
1183  'section' => 'options',
1184  'default' => $this->mWatch,
1185  ]
1186  ];
1187  }
1188  if ( !$this->mHideIgnoreWarning ) {
1189  $descriptor['IgnoreWarning'] = [
1190  'type' => 'check',
1191  'id' => 'wpIgnoreWarning',
1192  'label-message' => 'ignorewarnings',
1193  'section' => 'options',
1194  ];
1195  }
1196 
1197  $descriptor['DestFileWarningAck'] = [
1198  'type' => 'hidden',
1199  'id' => 'wpDestFileWarningAck',
1200  'default' => $this->mDestWarningAck ? '1' : '',
1201  ];
1202 
1203  if ( $this->mForReUpload ) {
1204  $descriptor['ForReUpload'] = [
1205  'type' => 'hidden',
1206  'id' => 'wpForReUpload',
1207  'default' => '1',
1208  ];
1209  }
1210 
1211  return $descriptor;
1212  }
1213 
1217  public function show() {
1218  $this->addUploadJS();
1219  parent::show();
1220  }
1221 
1225  protected function addUploadJS() {
1226  $config = $this->getConfig();
1227 
1228  $useAjaxDestCheck = $config->get( 'UseAjax' ) && $config->get( 'AjaxUploadDestCheck' );
1229  $useAjaxLicensePreview = $config->get( 'UseAjax' ) &&
1230  $config->get( 'AjaxLicensePreview' ) && $config->get( 'EnableAPI' );
1231  $this->mMaxUploadSize['*'] = UploadBase::getMaxUploadSize();
1232 
1233  $scriptVars = [
1234  'wgAjaxUploadDestCheck' => $useAjaxDestCheck,
1235  'wgAjaxLicensePreview' => $useAjaxLicensePreview,
1236  'wgUploadAutoFill' => !$this->mForReUpload &&
1237  // If we received mDestFile from the request, don't autofill
1238  // the wpDestFile textbox
1239  $this->mDestFile === '',
1240  'wgUploadSourceIds' => $this->mSourceIds,
1241  'wgCheckFileExtensions' => $config->get( 'CheckFileExtensions' ),
1242  'wgStrictFileExtensions' => $config->get( 'StrictFileExtensions' ),
1243  'wgFileExtensions' => array_values( array_unique( $config->get( 'FileExtensions' ) ) ),
1244  'wgCapitalizeUploads' => MWNamespace::isCapitalized( NS_FILE ),
1245  'wgMaxUploadSize' => $this->mMaxUploadSize,
1246  'wgFileCanRotate' => SpecialUpload::rotationEnabled(),
1247  ];
1248 
1249  $out = $this->getOutput();
1250  $out->addJsConfigVars( $scriptVars );
1251 
1252  $out->addModules( [
1253  'mediawiki.action.edit', // For <charinsert> support
1254  'mediawiki.special.upload', // Extras for thumbnail and license preview.
1255  ] );
1256  }
1257 
1263  function trySubmit() {
1264  return false;
1265  }
1266 }
1267 
1272 
1277  function getLabelHtml( $cellAttributes = [] ) {
1278  $id = $this->mParams['id'];
1279  $label = Html::rawElement( 'label', [ 'for' => $id ], $this->mLabel );
1280 
1281  if ( !empty( $this->mParams['radio'] ) ) {
1282  if ( isset( $this->mParams['radio-id'] ) ) {
1283  $radioId = $this->mParams['radio-id'];
1284  } else {
1285  // Old way. For the benefit of extensions that do not define
1286  // the 'radio-id' key.
1287  $radioId = 'wpSourceType' . $this->mParams['upload-type'];
1288  }
1289 
1290  $attribs = [
1291  'name' => 'wpSourceType',
1292  'type' => 'radio',
1293  'id' => $radioId,
1294  'value' => $this->mParams['upload-type'],
1295  ];
1296 
1297  if ( !empty( $this->mParams['checked'] ) ) {
1298  $attribs['checked'] = 'checked';
1299  }
1300 
1301  $label .= Html::element( 'input', $attribs );
1302  }
1303 
1304  return Html::rawElement( 'td', [ 'class' => 'mw-label' ] + $cellAttributes, $label );
1305  }
1306 
1310  function getSize() {
1311  return isset( $this->mParams['size'] )
1312  ? $this->mParams['size']
1313  : 60;
1314  }
1315 }
setContext(IContextSource $context)
Set the IContextSource object.
static getExistsWarning($exists)
Formats a result of UploadBase::getExistsWarning as HTML This check is static and can be done pre-upl...
getExtensionsMessage()
Get the messages indicating which extensions are preferred and prohibitted.
getDupeWarning($dupes)
Construct a warning and a gallery from an array of duplicate files.
static rotationEnabled()
Should we rotate images in the preview on Special:Upload.
Interface for objects which can provide a MediaWiki context on request.
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:802
getOptionsSection()
Get the descriptor of the fieldset that contains the upload options, such as "watch this file"...
const FILENAME_TOO_LONG
Definition: UploadBase.php:80
the array() calling protocol came about after MediaWiki 1.4rc1.
getLanguage()
Get the Language object.
$context
Definition: load.php:50
getContext()
Gets the context this SpecialPage is executed in.
Implements uploading from previously stored file.
getWatchCheck()
See if we should check the 'watch this page' checkbox on the form based on the user's preferences and...
$success
static createFromRequest(&$request, $type=null)
Create a form of UploadBase depending on wpSourceType and initializes it.
Definition: UploadBase.php:161
static isAllowed($user)
Returns true if the user can use this upload module or else a string identifying the missing permissi...
Definition: UploadBase.php:131
UploadBase $mUpload
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name If you don't need a full Title object...
Definition: SpecialPage.php:82
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 after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:1936
setId($id)
Definition: HTMLForm.php:1480
showUploadForm($form)
Show the main upload form.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
setSubmitName($name)
Definition: HTMLForm.php:1370
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
setSubmitTooltip($name)
Definition: HTMLForm.php:1381
An IContextSource implementation which will inherit context from another source but allow individual ...
LocalFile $mLocalFile
$comment
addHeaderText($msg, $section=null)
Add HTML to the header, inside the form.
Definition: HTMLForm.php:757
null for the local wiki Added in
Definition: hooks.txt:1555
$source
execute($par)
Special page entry point.
A form field that contains a radio box in the label.
bool $mForReUpload
The user followed an "overwrite this file" link.
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
showViewDeletedLinks()
Shows the "view X deleted revivions link"".
msg()
Wrapper around wfMessage that sets the current context.
unsaveUploadedFile()
Remove a temporarily kept file stashed by saveTempUploadedFile().
getOutput()
Get the OutputPage being used for this instance.
const ILLEGAL_FILENAME
Definition: UploadBase.php:72
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
IContextSource $context
wfLocalFile($title)
Get an object referring to a locally registered file.
bool $mUploadSuccessful
Subclasses can use this to determine whether a file was uploaded.
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static getMaxUploadSize($forType=null)
Get the MediaWiki maximum uploaded file size for given type of upload, based on $wgMaxUploadSize.
static showLogExtract(&$out, $types=[], $page= '', $user= '', $param=[])
Show log extract.
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
if($line===false) $args
Definition: cdb.php:64
__construct($request=null)
Constructor : initialise object Get data POSTed through the form and assign them to the object...
userCanExecute(User $user)
This page can be shown if uploading is enabled.
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
static isCapitalized($index)
Is the namespace first-letter capitalized?
getRequest()
Get the WebRequest object.
static factory($mode=false, IContextSource $context=null)
Get a new image gallery.
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 true
Definition: hooks.txt:1936
getLabelHtml($cellAttributes=[])
static isThrottled($user)
Returns true if the user has surpassed the upload rate limit, false otherwise.
Definition: UploadBase.php:147
setSubmitText($t)
Set the text for the submit button.
Definition: HTMLForm.php:1310
msg()
Get a Message object with context set Parameters are the same as wfMessage()
Parent class for all special pages.
Definition: SpecialPage.php:36
static isEnabled()
Checks if the upload from URL feature is enabled.
Class that generates HTML links for pages.
__construct(array $options=[], IContextSource $context=null, LinkRenderer $linkRenderer=null)
string $mDesiredDestName
User input variables from the "description" section.
addUploadJS()
Add upload JS to the OutputPage.
An error page which can definitely be safely rendered using the OutputPage.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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 $options
Definition: hooks.txt:1046
processVerificationError($details)
Provides output to the user for a result of UploadBase::verifyUpload.
getSourceSection()
Get the descriptor of the fieldset that contains the file source selection.
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
Form for handling uploads and special page.
$uploadFormTextTop
Text injection points for hooks not using HTMLForm.
getTitle()
Get the title.
Definition: HTMLForm.php:1563
getConfig()
Get the Config object.
getContext()
Get the base IContextSource object.
getTitle($subpage=false)
Get a self-referential title object.
static getInitialPageText($comment= '', $license= '', $copyStatus= '', $source= '', Config $config=null)
Get the initial image page text based on a comment and optional file status information.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
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:1936
Object handling generic submission, CSRF protection, layout and other logic for UI forms...
Definition: HTMLForm.php:128
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:535
WebRequest FauxRequest $mRequest
Misc variables.
const FILE_TOO_LARGE
Definition: UploadBase.php:78
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
Using a hook running we can avoid having all this option specific stuff in our mainline code Using hooks
Definition: hooks.txt:73
const MIN_LENGTH_PARTNAME
Definition: UploadBase.php:71
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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:12
$help
Definition: mcc.php:32
const NS_FILE
Definition: Defines.php:62
Show an error when the user tries to do something whilst blocked.
const VERIFICATION_ERROR
Definition: UploadBase.php:76
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
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 modifiable & $code
Definition: hooks.txt:802
static isEnabled()
Returns true if uploads are enabled.
Definition: UploadBase.php:112
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 local account $user
Definition: hooks.txt:242
showUploadError($message)
Show the upload form with error message, but do not stash the file.
const FILETYPE_BADTYPE
Definition: UploadBase.php:75
const FILETYPE_MISSING
Definition: UploadBase.php:74
static getDefaultInstance()
static isAllowed($user)
Checks if the user is allowed to use the upload-by-URL feature.
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
$mIgnoreWarning
User input variables from the root section.
loadRequest()
Initialize instance variables from request and create an Upload handler.
getDescriptionSection()
Get the descriptor of the fieldset that contains the file description input.
const HOOK_ABORTED
Definition: UploadBase.php:77
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
getUser()
Shortcut to get the User executing this instance.
getConfig()
Shortcut to get main config object.
$license
Show an error when a user tries to do something they do not have the necessary permissions for...
const WINDOWS_NONASCII_FILENAME
Definition: UploadBase.php:79
getLanguage()
Shortcut to get user's language.
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 local content language as $wgContLang
Definition: design.txt:56
Generic handler for bitmap images.
Definition: Bitmap.php:29
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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 $status
Definition: hooks.txt:1046
$count
static getMaxPhpUploadSize()
Get the PHP maximum uploaded file size, based on ini settings.
showRecoverableUploadError($message)
Stashes the upload and shows the main upload form.
bool $mCancelUpload
The user clicked "Cancel and return to upload form" button.
static canAddTagsAccompanyingChange(array $tags, User $user=null)
Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the cha...
Definition: ChangeTags.php:392
addFooterText($msg, $section=null)
Add footer text, inside the form.
Definition: HTMLForm.php:812
processUpload()
Do the upload.
$extensions
getRequest()
Get the WebRequest being used for this instance.
const OK
Definition: UploadBase.php:69
$mDestWarningAck
Hidden variables.
checkReadOnly()
If the wiki is currently in readonly mode, throws a ReadOnlyError.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
showUploadWarning($warnings)
Stashes the upload, shows the main form, but adds a "continue anyway button".
Sub class of HTMLForm that provides the form section of SpecialUpload.
getUser()
Get the User object.
const EMPTY_FILE
Definition: UploadBase.php:70
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
trySubmit()
Empty function; submission is handled elsewhere.
show()
Add the upload JS and show the form.
getUploadForm($message= '', $sessionKey= '', $hideIgnoreWarning=false)
Get an UploadForm instance with title and text properly set.
getPageTitle($subpage=false)
Get a self-referential title object.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300