* @file
* @ingroup SpecialPage
* @ingroup Upload
- *
+ *
* Form for handling uploads and special page.
- *
*/
class SpecialUpload extends SpecialPage {
/**
* Constructor : initialise object
* Get data POSTed through the form and assign them to the object
- * @param WebRequest $request Data posted.
+ * @param $request WebRequest : data posted.
*/
public function __construct( $request = null ) {
global $wgRequest;
-
+
parent::__construct( 'Upload', 'upload' );
-
+
$this->loadRequest( is_null( $request ) ? $wgRequest : $request );
}
-
+
/** Misc variables **/
protected $mRequest; // The WebRequest or FauxRequest this form is supposed to handle
protected $mSourceType;
protected $mUpload;
protected $mLocalFile;
protected $mUploadClicked;
-
+
/** User input variables from the "description" section **/
- protected $mDesiredDestName; // The requested target file name
+ public $mDesiredDestName; // The requested target file name
protected $mComment;
protected $mLicense;
-
+
/** User input variables from the root section **/
protected $mIgnoreWarning;
protected $mWatchThis;
protected $mCopyrightStatus;
protected $mCopyrightSource;
-
+
/** Hidden variables **/
+ protected $mDestWarningAck;
protected $mForReUpload; // The user followed an "overwrite this file" link
protected $mCancelUpload; // The user clicked "Cancel and return to upload form" button
protected $mTokenOk;
-
+ protected $mUploadSuccessful = false; // Subclasses can use this to determine whether a file was uploaded
+
+ /** Text injection points for hooks not using HTMLForm **/
+ public $uploadFormTextTop;
+ public $uploadFormTextAfterSummary;
+
/**
* Initialize instance variables from request and create an Upload handler
- *
- * @param WebRequest $request The request to extract variables from
+ *
+ * @param $request WebRequest: the request to extract variables from
*/
protected function loadRequest( $request ) {
global $wgUser;
$this->mRequest = $request;
$this->mSourceType = $request->getVal( 'wpSourceType', 'file' );
$this->mUpload = UploadBase::createFromRequest( $request );
- $this->mUploadClicked = $request->getCheck( 'wpUpload' ) && $request->wasPosted();
-
+ $this->mUploadClicked = $request->wasPosted()
+ && ( $request->getCheck( 'wpUpload' )
+ || $request->getCheck( 'wpUploadIgnoreWarning' ) );
+
// Guess the desired name from the filename if not provided
$this->mDesiredDestName = $request->getText( 'wpDestFile' );
- if( !$this->mDesiredDestName )
+ if( !$this->mDesiredDestName ) {
$this->mDesiredDestName = $request->getText( 'wpUploadFile' );
+ }
$this->mComment = $request->getText( 'wpUploadDescription' );
- $this->mLicense = $request->getText( 'wpLicense' );
-
-
- $this->mIgnoreWarning = $request->getCheck( 'wpIgnoreWarning' );
- $this->mWatchthis = $request->getBool( 'wpWatchthis' );
+ $this->mLicense = $request->getText( 'wpLicense' );
+
+
+ $this->mDestWarningAck = $request->getText( 'wpDestFileWarningAck' );
+ $this->mIgnoreWarning = $request->getCheck( 'wpIgnoreWarning' )
+ || $request->getCheck( 'wpUploadIgnoreWarning' );
+ $this->mWatchthis = $request->getBool( 'wpWatchthis' ) && $wgUser->isLoggedIn();
$this->mCopyrightStatus = $request->getText( 'wpUploadCopyStatus' );
$this->mCopyrightSource = $request->getText( 'wpUploadSource' );
- $this->mForReUpload = $request->getBool( 'wpForReUpload' ); // updating a file
+ $this->mForReUpload = $request->getBool( 'wpForReUpload' ); // updating a file
$this->mCancelUpload = $request->getCheck( 'wpCancelUpload' )
|| $request->getCheck( 'wpReUpload' ); // b/w compat
} else {
$this->mTokenOk = $wgUser->matchEditToken( $token );
}
+
+ $this->uploadFormTextTop = '';
+ $this->uploadFormTextAfterSummary = '';
}
-
+
/**
* This page can be shown if uploading is enabled.
- * Handle permission checking elsewhere in order to be able to show
+ * Handle permission checking elsewhere in order to be able to show
* custom error messages.
- *
- * @param User $user
- * @return bool
+ *
+ * @param $user User object
+ * @return Boolean
*/
public function userCanExecute( $user ) {
return UploadBase::isEnabled() && parent::userCanExecute( $user );
}
-
+
/**
* Special page entry point
*/
public function execute( $par ) {
global $wgUser, $wgOut, $wgRequest;
-
+
$this->setHeaders();
$this->outputHeader();
-
+
# Check uploading enabled
if( !UploadBase::isEnabled() ) {
$wgOut->showErrorPage( 'uploaddisabled', 'uploaddisabledtext' );
$wgOut->readOnlyPage();
return;
}
-
+
# Unsave the temporary file in case this was a cancelled upload
if ( $this->mCancelUpload ) {
- if ( !$this->unsaveUploadedFile() )
+ if ( !$this->unsaveUploadedFile() ) {
# Something went wrong, so unsaveUploadedFile showed a warning
return;
+ }
}
-
+
# Process upload or show a form
- if ( $this->mTokenOk && !$this->mCancelUpload
- && ( $this->mUpload && $this->mUploadClicked ) ) {
+ if (
+ $this->mTokenOk && !$this->mCancelUpload &&
+ ( $this->mUpload && $this->mUploadClicked )
+ )
+ {
$this->processUpload();
} else {
+ # Backwards compatibility hook
+ if( !wfRunHooks( 'UploadForm:initial', array( &$this ) ) ) {
+ wfDebug( "Hook 'UploadForm:initial' broke output of the upload form" );
+ return;
+ }
+
$this->showUploadForm( $this->getUploadForm() );
}
-
+
# Cleanup
- if ( $this->mUpload )
+ if ( $this->mUpload ) {
$this->mUpload->cleanupTempFile();
+ }
}
-
+
/**
- * Show the main upload form and optionally add the session key to the
- * output. This hides the source selection.
- *
- * @param string $message HTML message to be shown at top of form
- * @param string $sessionKey Session key of the stashed upload
+ * Show the main upload form
+ *
+ * @param $form Mixed: an HTMLForm instance or HTML string to show
*/
protected function showUploadForm( $form ) {
# Add links if file was previously deleted
- if ( !$this->mDesiredDestName )
+ if ( !$this->mDesiredDestName ) {
$this->showViewDeletedLinks();
-
- $form->show();
+ }
+
+ if ( $form instanceof HTMLForm ) {
+ $form->show();
+ } else {
+ global $wgOut;
+ $wgOut->addHTML( $form );
+ }
+
}
-
+
/**
* Get an UploadForm instance with title and text properly set.
- *
- * @param string $message HTML string to add to the form
- * @param string $sessionKey Session key in case this is a stashed upload
+ *
+ * @param $message String: HTML string to add to the form
+ * @param $sessionKey String: session key in case this is a stashed upload
+ * @param $hideIgnoreWarning Boolean: whether to hide "ignore warning" check box
* @return UploadForm
*/
- protected function getUploadForm( $message = '', $sessionKey = '' ) {
+ protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) {
+ global $wgOut;
+
# Initialize form
- $form = new UploadForm( $this->watchCheck(), $this->mForReUpload, $sessionKey );
+ $form = new UploadForm( array(
+ 'watch' => $this->getWatchCheck(),
+ 'forreupload' => $this->mForReUpload,
+ 'sessionkey' => $sessionKey,
+ 'hideignorewarning' => $hideIgnoreWarning,
+ 'destwarningack' => (bool)$this->mDestWarningAck,
+
+ 'texttop' => $this->uploadFormTextTop,
+ 'textaftersummary' => $this->uploadFormTextAfterSummary,
+ ) );
$form->setTitle( $this->getTitle() );
-
+
# Check the token, but only if necessary
- if( !$this->mTokenOk && !$this->mCancelUpload
- && ( $this->mUpload && $this->mUploadClicked ) )
+ if(
+ !$this->mTokenOk && !$this->mCancelUpload &&
+ ( $this->mUpload && $this->mUploadClicked )
+ )
+ {
$form->addPreText( wfMsgExt( 'session_fail_preview', 'parseinline' ) );
+ }
# Add text to form
- $form->addPreText( '<div id="uploadtext">' . wfMsgExt( 'uploadtext', 'parse' ) . '</div>');
+ $form->addPreText( '<div id="uploadtext">' .
+ wfMsgExt( 'uploadtext', 'parse', array( $this->mDesiredDestName ) ) .
+ '</div>' );
# Add upload error message
- $form->addPreText( $message );
-
- return $form;
+ $form->addPreText( $message );
+
+ # Add footer to form
+ $uploadFooter = wfMsgNoTrans( 'uploadfooter' );
+ if ( $uploadFooter != '-' && !wfEmptyMsg( 'uploadfooter', $uploadFooter ) ) {
+ $form->addPostText( '<div id="mw-upload-footer-message">'
+ . $wgOut->parse( $uploadFooter ) . "</div>\n" );
+ }
+
+ return $form;
+
}
-
+
/**
- * TODO: DOCUMENT
+ * Shows the "view X deleted revivions link""
*/
protected function showViewDeletedLinks() {
global $wgOut, $wgUser;
-
+
$title = Title::makeTitleSafe( NS_FILE, $this->mDesiredDestName );
// Show a subtitle link to deleted revisions (to sysops et al only)
- if( $title instanceof Title && ( $count = $title->isDeleted() ) > 0 && $wgUser->isAllowed( 'deletedhistory' ) ) {
- $link = wfMsgExt(
- $wgUser->isAllowed( 'delete' ) ? 'thisisdeleted' : 'viewdeleted',
- array( 'parse', 'replaceafter' ),
- $wgUser->getSkin()->linkKnown(
- SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedText() ),
- wfMsgExt( 'restorelink', array( 'parsemag', 'escape' ), $count )
- )
- );
- $wgOut->addHTML( "<div id=\"contentSub2\">{$link}</div>" );
+ if( $title instanceof Title ) {
+ $count = $title->isDeleted();
+ if ( $count > 0 && $wgUser->isAllowed( 'deletedhistory' ) ) {
+ $link = wfMsgExt(
+ $wgUser->isAllowed( 'delete' ) ? 'thisisdeleted' : 'viewdeleted',
+ array( 'parse', 'replaceafter' ),
+ $wgUser->getSkin()->linkKnown(
+ SpecialPage::getTitleFor( 'Undelete', $title->getPrefixedText() ),
+ wfMsgExt( 'restorelink', array( 'parsemag', 'escape' ), $count )
+ )
+ );
+ $wgOut->addHTML( "<div id=\"contentSub2\">{$link}</div>" );
+ }
}
// Show the relevant lines from deletion log (for still deleted files only)
$this->showDeletionLog( $wgOut, $title->getPrefixedText() );
}
}
-
+
/**
* Stashes the upload and shows the main upload form.
- *
- * Note: only errors that can be handled by changing the name or
+ *
+ * Note: only errors that can be handled by changing the name or
* description should be redirected here. It should be assumed that the
- * file itself is sane and has passed UploadBase::verifyFile. This
- * essentially means that UploadBase::VERIFICATION_ERROR and
+ * file itself is sane and has passed UploadBase::verifyFile. This
+ * essentially means that UploadBase::VERIFICATION_ERROR and
* UploadBase::EMPTY_FILE should not be passed here.
- *
- * @param string $message HTML message to be passed to mainUploadForm
+ *
+ * @param $message String: HTML message to be passed to mainUploadForm
*/
- protected function recoverableUploadError( $message ) {
+ protected function showRecoverableUploadError( $message ) {
$sessionKey = $this->mUpload->stashSession();
$message = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" .
'<div class="error">' . $message . "</div>\n";
- $this->showUploadForm( $this->getUploadForm( $message, $sessionKey ) );
+
+ $form = $this->getUploadForm( $message, $sessionKey );
+ $form->setSubmitText( wfMsg( 'upload-tryagain' ) );
+ $this->showUploadForm( $form );
}
- /**
- * Stashes the upload, shows the main form, but adds an "continue anyway button"
- *
- * @param array $warnings
+ /**
+ * Stashes the upload, shows the main form, but adds an "continue anyway button".
+ * Also checks whether there are actually warnings to display.
+ *
+ * @param $warnings Array
+ * @return boolean true if warnings were displayed, false if there are no
+ * warnings and the should continue processing like there was no warning
*/
- protected function uploadWarning( $warnings ) {
- global $wgUser;
-
+ protected function showUploadWarning( $warnings ) {
+ # If there are no warnings, or warnings we can ignore, return early.
+ # mDestWarningAck is set when some javascript has shown the warning
+ # to the user. mForReUpload is set when the user clicks the "upload a
+ # new version" link.
+ if ( !$warnings || ( count( $warnings ) == 1 &&
+ isset( $warnings['exists'] ) &&
+ ( $this->mDestWarningAck || $this->mForReUpload ) ) )
+ {
+ return false;
+ }
+
$sessionKey = $this->mUpload->stashSession();
-
- $sk = $wgUser->getSkin();
- $warningHtml = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n"
+ $warningHtml = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n"
. '<ul class="warning">';
foreach( $warnings as $warning => $args ) {
- $msg = '';
- if( $warning == 'exists' ) {
- $msg = self::getExistsWarning( $args );
- } elseif( $warning == 'duplicate' ) {
- $msg = self::getDupeWarning( $args );
- } elseif( $warning == 'duplicate-archive' ) {
- $msg = "\t<li>" . wfMsgExt( 'file-deleted-duplicate', 'parseinline',
- array( Title::makeTitle( NS_FILE, $args )->getPrefixedText() ) )
- . "</li>\n";
- } else {
- if ( is_bool( $args ) )
- $args = array();
- elseif ( !is_array( $args ) )
- $args = array( $args );
- $msg = "\t<li>" . wfMsgExt( $warning, 'parseinline', $args ) . "</li>\n";
+ $msg = '';
+ if( $warning == 'exists' ) {
+ $msg = "\t<li>" . self::getExistsWarning( $args ) . "</li>\n";
+ } elseif( $warning == 'duplicate' ) {
+ $msg = self::getDupeWarning( $args );
+ } elseif( $warning == 'duplicate-archive' ) {
+ $msg = "\t<li>" . wfMsgExt( 'file-deleted-duplicate', 'parseinline',
+ array( Title::makeTitle( NS_FILE, $args )->getPrefixedText() ) )
+ . "</li>\n";
+ } else {
+ if ( $args === true ) {
+ $args = array();
+ } elseif ( !is_array( $args ) ) {
+ $args = array( $args );
}
- $warningHtml .= $msg;
+ $msg = "\t<li>" . wfMsgExt( $warning, 'parseinline', $args ) . "</li>\n";
+ }
+ $warningHtml .= $msg;
}
-
- $form = $this->getUploadForm( $warningHtml, $sessionKey );
- $form->setSubmitText( wfMsg( 'ignorewarning' ) );
+ $warningHtml .= "</ul>\n";
+ $warningHtml .= wfMsgExt( 'uploadwarning-text', 'parse' );
+
+ $form = $this->getUploadForm( $warningHtml, $sessionKey, /* $hideIgnoreWarning */ true );
+ $form->setSubmitText( wfMsg( 'upload-tryagain' ) );
+ $form->addButton( 'wpUploadIgnoreWarning', wfMsg( 'ignorewarning' ) );
$form->addButton( 'wpCancelUpload', wfMsg( 'reuploaddesc' ) );
-
+
$this->showUploadForm( $form );
+
+ # Indicate that we showed a form
+ return true;
}
-
+
/**
* Show the upload form with error message, but do not stash the file.
- *
- * @param string $message
+ *
+ * @param $message HTML string
*/
- protected function uploadError( $message ) {
+ protected function showUploadError( $message ) {
$message = '<h2>' . wfMsgHtml( 'uploadwarning' ) . "</h2>\n" .
'<div class="error">' . $message . "</div>\n";
$this->showUploadForm( $this->getUploadForm( $message ) );
}
-
+
/**
* Do the upload.
* Checks are made in SpecialUpload::execute()
*/
protected function processUpload() {
global $wgUser, $wgOut;
-
+
// Verify permissions
$permErrors = $this->mUpload->verifyPermissions( $wgUser );
- if( $permErrors !== true )
- return $wgOut->showPermissionsErrorPage( $permErrors );
+ if( $permErrors !== true ) {
+ $wgOut->showPermissionsErrorPage( $permErrors );
+ return;
+ }
// Fetch the file if required
$status = $this->mUpload->fetchFile();
- if( !$status->isOK() )
- return $this->mainUploadForm( $wgOut->parse( $status->getWikiText() ) );
-
+ if( !$status->isOK() ) {
+ $this->showUploadError( $wgOut->parse( $status->getWikiText() ) );
+ return;
+ }
+
+ // Deprecated backwards compatibility hook
+ if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) ) {
+ wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file.\n" );
+ return array( 'status' => UploadBase::BEFORE_PROCESSING );
+ }
+
+
// Upload verification
$details = $this->mUpload->verifyUpload();
- if ( $details['status'] != UploadBase::OK )
- return $this->processVerificationError( $details );
-
+ if ( $details['status'] != UploadBase::OK ) {
+ $this->processVerificationError( $details );
+ return;
+ }
+
$this->mLocalFile = $this->mUpload->getLocalFile();
// Check warnings if necessary
if( !$this->mIgnoreWarning ) {
$warnings = $this->mUpload->checkWarnings();
- if( count( $warnings ) )
- return $this->uploadWarning( $warnings );
+ if( $this->showUploadWarning( $warnings ) ) {
+ return;
+ }
}
// Get the page text if this is not a reupload
$pageText = false;
}
$status = $this->mUpload->performUpload( $this->mComment, $pageText, $this->mWatchthis, $wgUser );
- if ( !$status->isGood() )
- return $this->uploadError( $wgOut->parse( $status->getWikiText() ) );
-
+ if ( !$status->isGood() ) {
+ $this->showUploadError( $wgOut->parse( $status->getWikiText() ) );
+ return;
+ }
+
// Success, redirect to description page
+ $this->mUploadSuccessful = true;
wfRunHooks( 'SpecialUploadComplete', array( &$this ) );
$wgOut->redirect( $this->mLocalFile->getTitle()->getFullURL() );
-
}
-
+
/**
* Get the initial image page text based on a comment and optional file status information
*/
if ( $license != '' ) {
$licensetxt = '== ' . wfMsgForContent( 'license-header' ) . " ==\n" . '{{' . $license . '}}' . "\n";
}
- $pageText = '== ' . wfMsgForContent ( 'filedesc' ) . " ==\n" . $comment . "\n" .
- '== ' . wfMsgForContent ( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
- "$licensetxt" .
- '== ' . wfMsgForContent ( 'filesource' ) . " ==\n" . $source ;
+ $pageText = '== ' . wfMsgForContent( 'filedesc' ) . " ==\n" . $comment . "\n" .
+ '== ' . wfMsgForContent( 'filestatus' ) . " ==\n" . $copyStatus . "\n" .
+ "$licensetxt" .
+ '== ' . wfMsgForContent( 'filesource' ) . " ==\n" . $source;
} else {
if ( $license != '' ) {
- $filedesc = $comment == '' ? '' : '== ' . wfMsgForContent ( 'filedesc' ) . " ==\n" . $comment . "\n";
- $pageText = $filedesc .
- '== ' . wfMsgForContent ( 'license-header' ) . " ==\n" . '{{' . $license . '}}' . "\n";
+ $filedesc = $comment == '' ? '' : '== ' . wfMsgForContent( 'filedesc' ) . " ==\n" . $comment . "\n";
+ $pageText = $filedesc .
+ '== ' . wfMsgForContent( 'license-header' ) . " ==\n" . '{{' . $license . '}}' . "\n";
} else {
$pageText = $comment;
}
}
return $pageText;
}
-
+
/**
* See if we should check the 'watch this page' checkbox on the form
* based on the user's preferences and whether we're being asked
* Note that the page target can be changed *on the form*, so our check
* state can get out of sync.
*/
- protected function watchCheck() {
+ protected function getWatchCheck() {
global $wgUser;
if( $wgUser->getOption( 'watchdefault' ) ) {
// Watch all edits!
return $wgUser->getOption( 'watchcreations' );
}
}
-
-
+
+
/**
* Provides output to the user for a result of UploadBase::verifyUpload
- *
- * @param array $details Result of UploadBase::verifyUpload
+ *
+ * @param $details Array: result of UploadBase::verifyUpload
*/
protected function processVerificationError( $details ) {
global $wgFileExtensions, $wgLang;
-
+
switch( $details['status'] ) {
/** Statuses that only require name changing **/
case UploadBase::MIN_LENGTH_PARTNAME:
- $this->recoverableUploadError( wfMsgHtml( 'minlength1' ) );
+ $this->showRecoverableUploadError( wfMsgHtml( 'minlength1' ) );
break;
case UploadBase::ILLEGAL_FILENAME:
- $this->recoverableUploadError( wfMsgExt( 'illegalfilename',
+ $this->showRecoverableUploadError( wfMsgExt( 'illegalfilename',
'parseinline', $details['filtered'] ) );
break;
case UploadBase::OVERWRITE_EXISTING_FILE:
- $this->recoverableUploadError( wfMsgExt( $details['overwrite'],
+ $this->showRecoverableUploadError( wfMsgExt( $details['overwrite'],
'parseinline' ) );
break;
case UploadBase::FILETYPE_MISSING:
- $this->recoverableUploadError( wfMsgExt( 'filetype-missing',
+ $this->showRecoverableUploadError( wfMsgExt( 'filetype-missing',
'parseinline' ) );
break;
/** Statuses that require reuploading **/
case UploadBase::EMPTY_FILE:
- $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
+ $this->showUploadError( wfMsgHtml( 'emptyfile' ) );
+ break;
+ case UploadBase::FILESIZE_TOO_LARGE:
+ $this->showUploadError( wfMsgHtml( 'largefileserver' ) );
break;
case UploadBase::FILETYPE_BADTYPE:
$finalExt = $details['finalExt'];
- $this->uploadError(
+ $this->showUploadError(
wfMsgExt( 'filetype-banned-type',
array( 'parseinline' ),
htmlspecialchars( $finalExt ),
case UploadBase::VERIFICATION_ERROR:
unset( $details['status'] );
$code = array_shift( $details['details'] );
- $this->uploadError( wfMsgExt( $code, 'parseinline', $details['details'] ) );
+ $this->showUploadError( wfMsgExt( $code, 'parseinline', $details['details'] ) );
break;
case UploadBase::HOOK_ABORTED:
- $error = $details['error'];
- $this->uploadError( wfMsgExt( $error, 'parseinline' ) );
+ if ( is_array( $details['error'] ) ) { # allow hooks to return error details in an array
+ $args = $details['error'];
+ $error = array_shift( $args );
+ } else {
+ $error = $details['error'];
+ $args = null;
+ }
+
+ $this->showUploadError( wfMsgExt( $error, 'parseinline', $args ) );
break;
default:
throw new MWException( __METHOD__ . ": Unknown value `{$details['status']}`" );
}
}
-
+
/**
* Remove a temporarily kept file stashed by saveTempUploadedFile().
- * @access private
- * @return success
+ *
+ * @return Boolean: success
*/
protected function unsaveUploadedFile() {
global $wgOut;
- if ( !( $this->mUpload instanceof UploadFromStash ) )
+ if ( !( $this->mUpload instanceof UploadFromStash ) ) {
return true;
+ }
$success = $this->mUpload->unsaveUploadedFile();
- if ( ! $success ) {
+ if ( !$success ) {
$wgOut->showFileDeleteError( $this->mUpload->getTempPath() );
return false;
} else {
return true;
}
}
-
+
/*** Functions for formatting warnings ***/
-
+
/**
* Formats a result of UploadBase::getExistsWarning as HTML
* This check is static and can be done pre-upload via AJAX
- *
- * @param array $exists The result of UploadBase::getExistsWarning
- * @return string Empty string if there is no warning or an HTML fragment
- * consisting of one or more <li> elements if there is a warning.
+ *
+ * @param $exists Array: the result of UploadBase::getExistsWarning
+ * @return String: empty string if there is no warning or an HTML fragment
*/
public static function getExistsWarning( $exists ) {
global $wgUser, $wgContLang;
-
- if ( !$exists )
+
+ if ( !$exists ) {
return '';
+ }
$file = $exists['file'];
$filename = $file->getTitle()->getPrefixedText();
- $warning = array();
+ $warning = '';
$sk = $wgUser->getSkin();
if( $exists['warning'] == 'exists' ) {
// Exact match
- $warning[] = '<li>' . wfMsgExt( 'fileexists', 'parseinline', $filename ) . '</li>';
+ $warning = wfMsgExt( 'fileexists', 'parseinline', $filename );
} elseif( $exists['warning'] == 'page-exists' ) {
// Page exists but file does not
- $warning[] = '<li>' . wfMsgExt( 'filepageexists', 'parseinline', $filename ) . '</li>';
+ $warning = wfMsgExt( 'filepageexists', 'parseinline', $filename );
} elseif ( $exists['warning'] == 'exists-normalized' ) {
- $warning[] = '<li>' . wfMsgExt( 'fileexists-extension', 'parseinline', $filename,
- $exists['normalizedFile']->getTitle()->getPrefixedText() ) . '</li>';
+ $warning = wfMsgExt( 'fileexists-extension', 'parseinline', $filename,
+ $exists['normalizedFile']->getTitle()->getPrefixedText() );
} elseif ( $exists['warning'] == 'thumb' ) {
// Swapped argument order compared with other messages for backwards compatibility
- $warning[] = '<li>' . wfMsgExt( 'fileexists-thumbnail-yes', 'parseinline',
- $exists['thumbFile']->getTitle()->getPrefixedText(), $filename ) . '</li>';
+ $warning = wfMsgExt( 'fileexists-thumbnail-yes', 'parseinline',
+ $exists['thumbFile']->getTitle()->getPrefixedText(), $filename );
} elseif ( $exists['warning'] == 'thumb-name' ) {
// Image w/o '180px-' does not exists, but we do not like these filenames
$name = $file->getName();
$badPart = substr( $name, 0, strpos( $name, '-' ) + 1 );
- $warning[] = '<li>' . wfMsgExt( 'file-thumbnail-no', 'parseinline', $badPart ) . '</li>';
+ $warning = wfMsgExt( 'file-thumbnail-no', 'parseinline', $badPart );
} elseif ( $exists['warning'] == 'bad-prefix' ) {
- $warning[] = '<li>' . wfMsgExt( 'filename-bad-prefix', 'parseinline', $exists['prefix'] ) . '</li>';
+ $warning = wfMsgExt( 'filename-bad-prefix', 'parseinline', $exists['prefix'] );
} elseif ( $exists['warning'] == 'was-deleted' ) {
# If the file existed before and was deleted, warn the user of this
$ltitle = SpecialPage::getTitleFor( 'Log' );
'page' => $filename
)
);
- $warning[] = '<li>' . wfMsgWikiHtml( 'filewasdeleted', $llink ) . '</li>';
+ $warning = wfMsgWikiHtml( 'filewasdeleted', $llink );
}
-
- return implode( "\n", $warning );
+
+ return $warning;
}
/**
* Get a list of warnings
*
- * @param string local filename, e.g. 'file exists', 'non-descriptive filename'
- * @return array list of warning messages
+ * @param $filename String: local filename, e.g. 'file exists', 'non-descriptive filename'
+ * @return Array: list of warning messages
*/
public static function ajaxGetExistsWarning( $filename ) {
$file = wfFindFile( $filename );
$exists = UploadBase::getExistsWarning( $file );
$warning = self::getExistsWarning( $exists );
if ( $warning !== '' ) {
- $s = "<ul>$warning</ul>";
+ $s = "<div>$warning</div>";
}
}
return $s;
}
- /**
- * Render a preview of a given license for the AJAX preview on upload
- *
- * @param string $license
- * @return string
- */
- public static function ajaxGetLicensePreview( $license ) {
- global $wgParser, $wgUser;
- $text = '{{' . $license . '}}';
- $title = Title::makeTitle( NS_FILE, 'Sample.jpg' );
- $options = ParserOptions::newFromUser( $wgUser );
-
- // Expand subst: first, then live templates...
- $text = $wgParser->preSaveTransform( $text, $title, $wgUser, $options );
- $output = $wgParser->parse( $text, $title, $options );
-
- return $output->getText();
- }
-
/**
* Construct a warning and a gallery from an array of duplicate files.
*/
public static function getDupeWarning( $dupes ) {
if( $dupes ) {
global $wgOut;
- $msg = "<gallery>";
+ $msg = '<gallery>';
foreach( $dupes as $file ) {
$title = $file->getTitle();
$msg .= $title->getPrefixedText() .
- "|" . $title->getText() . "\n";
+ '|' . $title->getText() . "\n";
}
- $msg .= "</gallery>";
- return "<li>" .
- wfMsgExt( "file-exists-duplicate", array( "parse" ), count( $dupes ) ) .
+ $msg .= '</gallery>';
+ return '<li>' .
+ wfMsgExt( 'file-exists-duplicate', array( 'parse' ), count( $dupes ) ) .
$wgOut->parse( $msg ) .
"</li>\n";
} else {
return '';
}
}
-
+
}
/**
- * Sub class of HTMLForm that provides the form section of SpecialUpload
+ * Sub class of HTMLForm that provides the form section of SpecialUpload
*/
class UploadForm extends HTMLForm {
protected $mWatch;
protected $mForReUpload;
protected $mSessionKey;
+ protected $mHideIgnoreWarning;
+ protected $mDestWarningAck;
+
+ protected $mTextTop;
+ protected $mTextAfterSummary;
+
protected $mSourceIds;
-
- public function __construct( $watch, $forReUpload = false, $sessionKey = '' ) {
- global $wgLang;
-
- $this->mWatch = $watch;
- $this->mForReUpload = $forReUpload;
- $this->mSessionKey = $sessionKey;
-
- $sourceDescriptor = $this->getSourceSection();
+
+ public function __construct( $options = array() ) {
+ $this->mWatch = !empty( $options['watch'] );
+ $this->mForReUpload = !empty( $options['forreupload'] );
+ $this->mSessionKey = isset( $options['sessionkey'] )
+ ? $options['sessionkey'] : '';
+ $this->mHideIgnoreWarning = !empty( $options['hideignorewarning'] );
+ $this->mDestWarningAck = !empty( $options['destwarningack'] );
+
+ $this->mTextTop = $options['texttop'];
+ $this->mTextAfterSummary = $options['textaftersummary'];
+
+ $sourceDescriptor = $this->getSourceSection();
$descriptor = $sourceDescriptor
+ $this->getDescriptionSection()
+ $this->getOptionsSection();
-
- wfRunHooks( 'UploadFormInitDescriptor', array( $descriptor ) );
+
+ wfRunHooks( 'UploadFormInitDescriptor', array( &$descriptor ) );
parent::__construct( $descriptor, 'upload' );
-
+
# Set some form properties
$this->setSubmitText( wfMsg( 'uploadbtn' ) );
$this->setSubmitName( 'wpUpload' );
$this->setSubmitTooltip( 'upload' );
$this->setId( 'mw-upload-form' );
-
+
# Build a list of IDs for javascript insertion
$this->mSourceIds = array();
foreach ( $sourceDescriptor as $key => $field ) {
- if ( !empty( $field['id'] ) )
+ if ( !empty( $field['id'] ) ) {
$this->mSourceIds[] = $field['id'];
+ }
}
-
+
}
-
+
/**
- *
+ * Get the descriptor of the fieldset that contains the file source
+ * selection. The section is 'source'
+ *
+ * @return Array: descriptor array
*/
protected function getSourceSection() {
global $wgLang, $wgUser, $wgRequest;
-
+ global $wgMaxUploadSize;
+
if ( $this->mSessionKey ) {
return array(
'wpSessionKey' => array(
),
);
}
-
+
$canUploadByUrl = UploadFromUrl::isEnabled() && $wgUser->isAllowed( 'upload_by_url' );
$radio = $canUploadByUrl;
$selectedSourceType = strtolower( $wgRequest->getText( 'wpSourceType', 'File' ) );
-
+
$descriptor = array();
- $descriptor['UploadFile'] = array(
- 'class' => 'UploadSourceField',
+ if ( $this->mTextTop ) {
+ $descriptor['UploadFormTextTop'] = array(
+ 'type' => 'info',
'section' => 'source',
- 'type' => 'file',
- 'id' => 'wpUploadFile',
- 'label-message' => 'sourcefilename',
- 'upload-type' => 'File',
- 'radio' => &$radio,
- 'help' => wfMsgExt( 'upload-maxfilesize',
- array( 'parseinline', 'escapenoentities' ),
- $wgLang->formatSize(
- wfShorthandToInteger( ini_get( 'upload_max_filesize' ) )
- )
- ) . ' ' . wfMsgHtml( 'upload_source_file' ),
- 'checked' => $selectedSourceType == 'file',
+ 'default' => $this->mTextTop,
+ 'raw' => true,
+ );
+ }
+
+ $descriptor['UploadFile'] = array(
+ 'class' => 'UploadSourceField',
+ 'section' => 'source',
+ 'type' => 'file',
+ 'id' => 'wpUploadFile',
+ 'label-message' => 'sourcefilename',
+ 'upload-type' => 'File',
+ 'radio' => &$radio,
+ 'help' => wfMsgExt( 'upload-maxfilesize',
+ array( 'parseinline', 'escapenoentities' ),
+ $wgLang->formatSize(
+ wfShorthandToInteger( min(
+ wfShorthandToInteger(
+ ini_get( 'upload_max_filesize' )
+ ), $wgMaxUploadSize
+ ) )
+ )
+ ) . ' ' . wfMsgHtml( 'upload_source_file' ),
+ 'checked' => $selectedSourceType == 'file',
);
if ( $canUploadByUrl ) {
- global $wgMaxUploadSize;
$descriptor['UploadFileURL'] = array(
'class' => 'UploadSourceField',
'section' => 'source',
'id' => 'wpUploadFileURL',
'label-message' => 'sourceurl',
- 'upload-type' => 'Url',
+ 'upload-type' => 'url',
'radio' => &$radio,
- 'help' => wfMsgExt( 'upload-maxfilesize',
+ 'help' => wfMsgExt( 'upload-maxfilesize',
array( 'parseinline', 'escapenoentities' ),
$wgLang->formatSize( $wgMaxUploadSize )
) . ' ' . wfMsgHtml( 'upload_source_url' ),
'checked' => $selectedSourceType == 'url',
);
}
- wfRunHooks( 'UploadFormSourceDescriptors', array( $descriptor, &$radio, $selectedSourceType ) );
-
+ wfRunHooks( 'UploadFormSourceDescriptors', array( &$descriptor, &$radio, $selectedSourceType ) );
+
$descriptor['Extensions'] = array(
'type' => 'info',
'section' => 'source',
'default' => $this->getExtensionsMessage(),
'raw' => true,
);
- return $descriptor;
+ return $descriptor;
}
-
+
/**
- *
+ * Get the messages indicating which extensions are preferred and prohibitted.
+ *
+ * @return String: HTML string containing the message
*/
protected function getExtensionsMessage() {
# Print a list of allowed file extensions, if so configured. We ignore
}
return $extensionsList;
}
-
+
/**
- *
+ * Get the descriptor of the fieldset that contains the file description
+ * input. The section is 'description'
+ *
+ * @return Array: descriptor array
*/
protected function getDescriptionSection() {
global $wgUser, $wgOut;
-
+
$cols = intval( $wgUser->getOption( 'cols' ) );
if( $wgUser->getOption( 'editwidth' ) ) {
$wgOut->addInlineStyle( '#mw-htmlform-description { width: 100%; }' );
}
-
+
$descriptor = array(
'DestFile' => array(
'type' => 'text',
'section' => 'description',
'id' => 'wpUploadDescription',
'label-message' => $this->mForReUpload
- ? 'filereuploadsummary'
+ ? 'filereuploadsummary'
: 'fileuploadsummary',
'cols' => $cols,
'rows' => 8,
+ )
+ );
+ if ( $this->mTextAfterSummary ) {
+ $descriptor['UploadFormTextAfterSummary'] = array(
+ 'type' => 'info',
+ 'section' => 'description',
+ 'default' => $this->mTextAfterSummary,
+ 'raw' => true,
+ );
+ }
+
+ $descriptor += array(
+ 'EditTools' => array(
+ 'type' => 'edittools',
+ 'section' => 'description',
),
'License' => array(
'type' => 'select',
'label-message' => 'license',
),
);
- if ( $this->mForReUpload )
+ if ( $this->mForReUpload ) {
$descriptor['DestFile']['readonly'] = true;
-
- global $wgUseAjax, $wgAjaxLicensePreview;
- if ( $wgUseAjax && $wgAjaxLicensePreview )
- $descriptor['AjaxLicensePreview'] = array(
- 'class' => 'UploadAjaxLicensePreview',
- 'section' => 'description'
- );
-
+ }
+
global $wgUseCopyrightUpload;
if ( $wgUseCopyrightUpload ) {
$descriptor['UploadCopyStatus'] = array(
'label-message' => 'filesource',
);
}
-
+
return $descriptor;
}
-
+
/**
- *
+ * Get the descriptor of the fieldset that contains the upload options,
+ * such as "watch this file". The section is 'options'
+ *
+ * @return Array: descriptor array
*/
protected function getOptionsSection() {
- global $wgOut;
-
- $descriptor = array(
- 'Watchthis' => array(
- 'type' => 'check',
- 'id' => 'wpWatchthis',
- 'label-message' => 'watchthisupload',
- 'section' => 'options',
- ),
- 'IgnoreWarning' => array(
+ global $wgUser;
+
+ if ( $wgUser->isLoggedIn() ) {
+ $descriptor = array(
+ 'Watchthis' => array(
+ 'type' => 'check',
+ 'id' => 'wpWatchthis',
+ 'label-message' => 'watchthisupload',
+ 'section' => 'options',
+ 'default' => $wgUser->getOption( 'watchcreations' ),
+ )
+ );
+ }
+ if ( !$this->mHideIgnoreWarning ) {
+ $descriptor['IgnoreWarning'] = array(
'type' => 'check',
'id' => 'wpIgnoreWarning',
'label-message' => 'ignorewarnings',
'section' => 'options',
- ),
- 'EditTools' => array(
- 'type' => 'edittools',
- 'section' => 'options',
- ),
+ );
+ }
+
+ $descriptor['wpDestFileWarningAck'] = array(
+ 'type' => 'hidden',
+ 'id' => 'wpDestFileWarningAck',
+ 'default' => $this->mDestWarningAck ? '1' : '',
);
- $uploadFooter = wfMsgNoTrans( 'uploadfooter' );
- if ( $uploadFooter != '-' && !wfEmptyMsg( 'uploadfooter', $uploadFooter ) )
- $descriptor['UploadFooter'] = array(
- 'type' => 'info',
- 'id' => 'mw-upload-footer-message',
- 'default' => $wgOut->parse( $uploadFooter ),
+ if ( $this->mForReUpload ) {
+ $descriptor['wpForReUpload'] = array(
+ 'type' => 'hidden',
+ 'id' => 'wpForReUpload',
+ 'default' => '1',
);
-
+ }
+
return $descriptor;
-
}
-
+
/**
- *
+ * Add the upload JS and show the form.
*/
public function show() {
$this->addUploadJS();
parent::show();
}
-
+
/**
- *
+ * Add upload JS to $wgOut
*/
- protected function addUploadJS( $autofill = true ) {
- global $wgUseAjax, $wgAjaxUploadDestCheck, $wgAjaxLicensePreview;
- global $wgEnableFirefogg, $wgEnableJS2system;
+ protected function addUploadJS() {
+ global $wgUseAjax, $wgAjaxUploadDestCheck, $wgAjaxLicensePreview, $wgEnableAPI;
global $wgOut;
-
+
$useAjaxDestCheck = $wgUseAjax && $wgAjaxUploadDestCheck;
- $useAjaxLicensePreview = $wgUseAjax && $wgAjaxLicensePreview;
-
+ $useAjaxLicensePreview = $wgUseAjax && $wgAjaxLicensePreview && $wgEnableAPI;
+
$scriptVars = array(
- 'wgAjaxUploadDestCheck' => $wgUseAjax && $wgAjaxUploadDestCheck,
- 'wgAjaxLicensePreview' => $wgUseAjax && $wgAjaxLicensePreview,
- 'wgEnableFirefogg' => (bool)$wgEnableFirefogg,
- 'wgUploadAutoFill' => (bool)$autofill,
+ 'wgAjaxUploadDestCheck' => $useAjaxDestCheck,
+ 'wgAjaxLicensePreview' => $useAjaxLicensePreview,
+ 'wgUploadAutoFill' => !$this->mForReUpload,
'wgUploadSourceIds' => $this->mSourceIds,
);
$wgOut->addScript( Skin::makeVariablesScript( $scriptVars ) );
- if ( $wgEnableJS2system ) {
- //js2version of upload page:
- $wgOut->addScriptClass( 'uploadPage' );
- } else {
- //legacy upload code:
- $wgOut->addScriptFile( 'upload.js' );
- $wgOut->addScriptFile( 'edit.js' ); // For <charinsert> support
- }
+ // For <charinsert> support
+ $wgOut->addScriptFile( 'edit.js' );
+ $wgOut->addScriptFile( 'upload.js' );
}
-
+
+ /**
+ * Empty function; submission is handled elsewhere.
+ *
+ * @return bool false
+ */
function trySubmit() {
return false;
}
}
/**
- * TODO: DOCUMENT
+ * A form field that contains a radio box in the label
*/
class UploadSourceField extends HTMLTextField {
function getLabelHtml() {
- $id = "wpSourceType{$this->mParams['upload-type']}";
- $label = Html::rawElement( 'label', array( 'for' => $id ), $this->mLabel );
-
+ $id = "wpSourceType{$this->mParams['upload-type']}";
+ $label = Html::rawElement( 'label', array( 'for' => $id ), $this->mLabel );
+
if ( !empty( $this->mParams['radio'] ) ) {
- $attribs = array(
+ $attribs = array(
'name' => 'wpSourceType',
'type' => 'radio',
'id' => $id,
'value' => $this->mParams['upload-type'],
);
- if ( !empty( $this->mParams['checked'] ) )
+ if ( !empty( $this->mParams['checked'] ) ) {
$attribs['checked'] = 'checked';
+ }
$label .= Html::element( 'input', $attribs );
}
-
+
return Html::rawElement( 'td', array( 'class' => 'mw-label' ), $label );
}
+
function getSize() {
- return isset( $this->mParams['size'] )
- ? $this->mParams['size']
+ return isset( $this->mParams['size'] )
+ ? $this->mParams['size']
: 60;
}
}
-/**
- * TODO: Document
- * TODO: This can be migrated to JS only
- */
-class UploadAjaxLicensePreview extends HTMLFormField {
- public function getTableRow( $value ) {
- return "<tr><td></td><td id=\"mw-license-preview\"></td></tr>\n";
- }
- public function getInputHTML( $value ) {
- return '';
- }
-}
\ No newline at end of file