* @addtogroup SpecialPage
*/
class UploadForm {
+ const SUCCESS = 0;
+ const BEFORE_PROCESSING = 1;
+ const LARGE_FILE_SERVER = 2;
+ const EMPTY_FILE = 3;
+ const MIN_LENGHT_PARTNAME = 4;
+ const ILLEGAL_FILENAME = 5;
+ const PROTECTED_PAGE = 6;
+ const OVERWRITE_EXISTING_FILE = 7;
+ const FILETYPE_MISSING = 8;
+ const FILETYPE_BADTYPE = 9;
+ const VERIFICATION_ERROR = 10;
+ const UPLOAD_VERIFICATION_ERROR = 11;
+ const UPLOAD_WARNING = 12;
+
/**#@+
* @access private
*/
}
$this->mainUploadForm();
} else if( 'submit' == $this->mAction || $this->mUploadClicked ) {
- $this->processUpload();
+ $this->processUpload();
} else {
$this->mainUploadForm();
}
$this->cleanupTempFile();
}
- /* -------------------------------------------------------------- */
+ /**
+ * Do the upload
+ * Checks are made in SpecialUpload::execute()
+ *
+ * @access private
+ */
+ function processUpload(){
+ global $wgUser, $wgOut, $wgFileExtensions;
+ $details = null;
+ $value = null;
+ $value = $this->internalProcessUpload( $details );
+
+ switch($value) {
+ case self::SUCCESS:
+ $wgOut->redirect( $this->mLocalFile->getTitle()->getFullURL() );
+ return;
+
+ case self::BEFORE_PROCESSING:
+ return false;
+
+ case self::LARGE_FILE_SERVER:
+ $this->mainUploadForm( wfMsgHtml( 'largefileserver' ) );
+ return;
+
+ case self::EMPTY_FILE:
+ $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
+ return;
+
+ case self::MIN_LENGHT_PARTNAME:
+ $this->mainUploadForm( wfMsgHtml( 'minlength1' ) );
+ return;
+
+ case self::ILLEGAL_FILENAME:
+ $filtered = $details['filtered'];
+ $this->uploadError( wfMsgWikiHtml( 'illegalfilename', htmlspecialchars( $filtered ) ) );
+ return;
+
+ case self::PROTECTED_PAGE:
+ return $this->uploadError( wfMsgWikiHtml( 'protectedpage' ) );
+
+ case self::OVERWRITE_EXISTING_FILE:
+ $errorText = $details['overwrite'];
+ $overwrite = new WikiError( $wgOut->parse( $errorText ) );
+ return $this->uploadError( $overwrite->toString() );
+
+ case self::FILETYPE_MISSING:
+ return $this->uploadError( wfMsgExt( 'filetype-missing', array ( 'parseinline' ) ) );
+
+ case self::FILETYPE_BADTYPE:
+ $finalExt = $details['finalExt'];
+ return $this->uploadError( wfMsgExt( 'filetype-badtype', array ( 'parseinline' ), htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ) );
+
+ case self::VERIFICATION_ERROR:
+ $veri = $details['veri'];
+ return $this->uploadError( $veri->toString() );
+
+ case self::UPLOAD_VERIFICATION_ERROR:
+ $error = $details['error'];
+ return $this->uploadError( $error );
+
+ case self::UPLOAD_WARNING:
+ $warning = $details['warning'];
+ return $this->uploadWarning( $warning );
+ }
+
+ /* TODO: Each case returns instead of breaking to maintain the highest level of compatibility during branch merging.
+ They should be reviewed and corrected separatelly.
+ */
+ new MWException( __METHOD__ . ": Unknown value `{$value}`" );
+ }
/**
* Really do the upload
* Checks are made in SpecialUpload::execute()
+ *
+ * @param array $resultDetails contains result-specific dict of additional values
+ *
* @access private
*/
- function processUpload() {
- global $wgUser, $wgOut;
+ function internalProcessUpload( &$resultDetails ) {
+ global $wgUser;
if( !wfRunHooks( 'UploadForm:BeforeProcessing', array( &$this ) ) )
{
wfDebug( "Hook 'UploadForm:BeforeProcessing' broke processing the file." );
- return false;
+ return self::BEFORE_PROCESSING;
}
/* Check for PHP error if any, requires php 4.2 or newer */
if( $this->mCurlError == 1/*UPLOAD_ERR_INI_SIZE*/ ) {
- $this->mainUploadForm( wfMsgHtml( 'largefileserver' ) );
- return;
+ return self::LARGE_FILE_SERVER;
}
/**
* If there was no filename or a zero size given, give up quick.
*/
if( trim( $this->mSrcName ) == '' || empty( $this->mFileSize ) ) {
- $this->mainUploadForm( wfMsgHtml( 'emptyfile' ) );
- return;
+ return self::EMPTY_FILE;
}
# Chop off any directories in the given filename
}
if( strlen( $partname ) < 1 ) {
- $this->mainUploadForm( wfMsgHtml( 'minlength1' ) );
- return;
+ return self::MIN_LENGHT_PARTNAME;
}
/**
$filtered = preg_replace ( "/[^".Title::legalChars()."]|:/", '-', $filtered );
$nt = Title::makeTitleSafe( NS_IMAGE, $filtered );
if( is_null( $nt ) ) {
- $this->uploadError( wfMsgWikiHtml( 'illegalfilename', htmlspecialchars( $filtered ) ) );
- return;
+ $resultDetails = array( 'filtered' => $filtered );
+ return self::ILLEGAL_FILENAME;
}
$this->mLocalFile = wfLocalFile( $nt );
$this->mDestName = $this->mLocalFile->getName();
* to modify it by uploading a new revision.
*/
if( !$nt->userCan( 'edit' ) ) {
- return $this->uploadError( wfMsgWikiHtml( 'protectedpage' ) );
+ return self::PROTECTED_PAGE;
}
/**
* In some cases we may forbid overwriting of existing files.
*/
$overwrite = $this->checkOverwrite( $this->mDestName );
- if( WikiError::isError( $overwrite ) ) {
- return $this->uploadError( $overwrite->toString() );
+ if( $overwrite !== true ) {
+ $resultDetails = array( 'overwrite' => $overwrite );
+ return self::OVERWRITE_EXISTING_FILE;
}
/* Don't allow users to override the blacklist (check file extension) */
global $wgStrictFileExtensions;
global $wgFileExtensions, $wgFileBlacklist;
if ($finalExt == '') {
- return $this->uploadError( wfMsgExt( 'filetype-missing', array ( 'parseinline' ) ) );
+ return self::FILETYPE_MISSING;
} elseif ( $this->checkFileExtensionList( $ext, $wgFileBlacklist ) ||
($wgStrictFileExtensions && !$this->checkFileExtension( $finalExt, $wgFileExtensions ) ) ) {
- return $this->uploadError( wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
- htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ) );
+ $resultDetails = array( 'finalExt' => $finalExt );
+ return self::FILETYPE_BADTYPE;
}
/**
$veri = $this->verify( $this->mTempPath, $finalExt );
if( $veri !== true ) { //it's a wiki error...
- return $this->uploadError( $veri->toString() );
+ $resultDetails = array( 'veri' => $veri );
+ return self::VERIFICATION_ERROR;
}
/**
$error = '';
if( !wfRunHooks( 'UploadVerification',
array( $this->mDestName, $this->mTempPath, &$error ) ) ) {
- return $this->uploadError( $error );
+ $resultDetails = array( 'error' => $error );
+ return self::UPLOAD_VERIFICATION_ERROR;
}
}
global $wgCheckFileExtensions;
if ( $wgCheckFileExtensions ) {
if ( ! $this->checkFileExtension( $finalExt, $wgFileExtensions ) ) {
- $warning .= '<li>'.wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
+ $warning .= '<li>'.wfMsgExt( 'filetype-badtype', array ( 'parseinline' ),
htmlspecialchars( $finalExt ), implode ( ', ', $wgFileExtensions ) ).'</li>';
}
}
* Stash the file in a temporary location; the user can choose
* to let it through and we'll complete the upload then.
*/
- return $this->uploadWarning( $warning );
+ $resultDetails = array( 'warning' => $warning );
+ return self::UPLOAD_WARNING;
}
}
$pageText = self::getInitialPageText( $this->mComment, $this->mLicense,
$this->mCopyrightStatus, $this->mCopyrightSource );
- $status = $this->mLocalFile->upload( $this->mTempPath, $this->mComment, $pageText,
+ $status = $this->mLocalFile->upload( $this->mTempPath, $this->mComment, $pageText,
File::DELETE_SOURCE, $this->mFileProps );
if ( !$status->isGood() ) {
$this->showError( $status->getWikiText() );
$wgUser->addWatch( $this->mLocalFile->getTitle() );
}
// Success, redirect to description page
- $wgOut->redirect( $this->mLocalFile->getTitle()->getFullURL() );
$img = null; // @todo: added to avoid passing a ref to null - should this be defined somewhere?
wfRunHooks( 'UploadComplete', array( &$img ) );
+ return self::SUCCESS;
}
}
if( $error ) {
$errorText = wfMsg( $error, wfEscapeWikiText( $img->getName() ) );
- return new WikiError( $wgOut->parse( $errorText ) );
+ return $errorText;
}
// Rockin', go ahead and upload