From: Brion Vibber Date: Mon, 15 Nov 2004 10:03:34 +0000 (+0000) Subject: (bug 548) A spot of refactoring, for legibility and better handling of 'warning'... X-Git-Tag: 1.5.0alpha1~1322 X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/pie.php?a=commitdiff_plain;h=7a70e2fed67c774bfc049901a0b37ce991ae12c2;p=lhc%2Fweb%2Fwiklou.git (bug 548) A spot of refactoring, for legibility and better handling of 'warning'-causing uploads. Such uploads are now moved to a holding area, so if the user doesn't explicitly cancel it doesn't overwrite the original file silently. --- diff --git a/includes/SpecialUpload.php b/includes/SpecialUpload.php index f02cb23e1a..5a01331b4c 100644 --- a/includes/SpecialUpload.php +++ b/includes/SpecialUpload.php @@ -40,32 +40,44 @@ class UploadForm { * @param $request Data posted. */ function UploadForm( &$request ) { - $this->mUploadAffirm = $request->getVal( 'wpUploadAffirm' ); - $this->mUploadFile = $request->getVal( 'wpUploadFile' ); - $this->mUploadDescription = $request->getVal( 'wpUploadDescription'); - $this->mIgnoreWarning = $request->getVal( 'wpIgnoreWarning'); - $this->mUploadSaveName = $request->getVal( 'wpUploadSaveName'); - $this->mUploadTempName = $request->getVal( 'wpUploadTempName'); - $this->mUploadTempName = $request->getVal( 'wpUploadTempName'); - $this->mUploadSize = $request->getVal( 'wpUploadSize'); - $this->mUploadOldVersion = $request->getVal( 'wpUploadOldVersion'); - $this->mUploadCopyStatus = $request->getVal( 'wpUploadCopyStatus'); - $this->mUploadSource = $request->getVal( 'wpUploadSource'); - $this->mReUpload = $request->getCheck( 'wpReUpload' ); - $this->mAction = $request->getVal( 'action' ); - $this->mUpload = $request->getCheck( 'wpUpload' ); - $this->mSessionKey = $request->getVal( 'wpSessionKey' ); - - /** Generate a temporary name if we don't have one yet */ - if ( ! $this->mUploadTempName ) { - $this->mUploadTempName = $request->getFileTempName( 'wpUploadFile' ); + if( !$request->wasPosted() ) { + # GET requests just give the main form; no data. + return; } - /** Get size of file */ - if ( ! $this->mUploadSize ) { - $this->mUploadSize = $request->getFileSize( 'wpUploadFile' ); + $this->mUploadAffirm = $request->getCheck( 'wpUploadAffirm' ); + $this->mIgnoreWarning = $request->getCheck( 'wpIgnoreWarning'); + $this->mReUpload = $request->getCheck( 'wpReUpload' ); + $this->mUpload = $request->getCheck( 'wpUpload' ); + + $this->mUploadDescription = $request->getText( 'wpUploadDescription' ); + $this->mUploadCopyStatus = $request->getText( 'wpUploadCopyStatus' ); + $this->mUploadSource = $request->getText( 'wpUploadSource'); + + $this->mAction = $request->getVal( 'action' ); + + $this->mSessionKey = $request->getInt( 'wpSessionKey' ); + if( !empty( $this->mSessionKey ) && + isset( $_SESSION['wsUploadData'][$this->mSessionKey] ) ) { + /** + * Confirming a temporarily stashed upload. + * We don't want path names to be forged, so we keep + * them in the session on the server and just give + * an opaque key to the user agent. + */ + $data = $_SESSION['wsUploadData'][$this->mSessionKey]; + $this->mUploadTempName = $data['mUploadTempName']; + $this->mUploadSize = $data['mUploadSize']; + $this->mOname = $data['mOname']; + } else { + /** + *Check for a newly uploaded file. + */ + $this->mUploadTempName = $request->getFileTempName( 'wpUploadFile' ); + $this->mUploadSize = $request->getFileSize( 'wpUploadFile' ); + $this->mOname = $request->getFileName( 'wpUploadFile' ); + $this->mSessionKey = false; } - $this->mOname = $request->getFileName( 'wpUploadFile' ); } /** @@ -77,32 +89,34 @@ class UploadForm { global $wgDisableUploads; /** Show an error message if file upload is disabled */ - if ( $wgDisableUploads ) { + if( $wgDisableUploads ) { $wgOut->addWikiText( wfMsg( 'uploaddisabled' ) ); return; } /** Various rights checks */ - if ( ( $wgUser->getID() == 0 ) + if( ( $wgUser->getID() == 0 ) OR $wgUser->isBlocked() ) { $wgOut->errorpage( 'uploadnologin', 'uploadnologintext' ); return; } - if ( wfReadOnly() ) { + if( wfReadOnly() ) { $wgOut->readOnlyPage(); return; } - if ( $this->mReUpload ) { + if( $this->mReUpload ) { $this->unsaveUploadedFile(); - $this->mainUploadForm( '' ); + $this->mainUploadForm(); } else if ( 'submit' == $this->mAction || $this->mUpload ) { $this->processUpload(); } else { - $this->mainUploadForm( '' ); + $this->mainUploadForm(); } } + /* -------------------------------------------------------------- */ + /** * Really do the upload * Checks are made in SpecialUpload::execute() @@ -111,174 +125,278 @@ class UploadForm { function processUpload() { global $wgUser, $wgOut, $wgLang, $wgContLang; global $wgUploadDirectory; - global $wgSavedFile, $wgUploadOldVersion; global $wgUseCopyrightUpload, $wgCheckCopyrightUpload; - global $wgCheckFileExtensions, $wgStrictFileExtensions; - global $wgFileExtensions, $wgFileBlacklist, $wgUploadSizeWarning; - /** When using detailed copyright, if user filled field, assume he - * confirmed the upload */ + /** + * When using detailed copyright, if user filled field, assume he + * confirmed the upload + */ if ( $wgUseCopyrightUpload ) { - $this->mUploadAffirm = 1; - if ($wgCheckCopyrightUpload && - (trim ( $this->mUploadCopyStatus ) == '' || trim ( $this->mUploadSource ) == '' )) { - $this->mUploadAffirm = 0; + $this->mUploadAffirm = true; + if( $wgCheckCopyrightUpload && + ( trim( $this->mUploadCopyStatus ) == '' || + trim( $this->mUploadSource ) == '' ) ) { + $this->mUploadAffirm = false; } } /** User need to confirm his upload */ - if ( $this->mUploadAffirm != 1) { + if( !$this->mUploadAffirm ) { $this->mainUploadForm( WfMsg( 'noaffirmation' ) ); return; } - if ( $this->mOname != '' ) { - $basename = strrchr( $this->mOname, '/' ); - - if ( false === $basename ) { $basename = $this->mOname; } - else ( $basename = substr( $basename, 1 ) ); - - - $ext = strrchr( $basename, '.' ); - if ( false === $ext ) { $ext = ''; } - else { $ext = substr( $ext, 1 ); } + if ( $this->mOname == '' && !isset($this->mUploadSaveName) ) { + // no filename given! + return $this->uploadError('
  • '.wfMsg( 'emptyfile' ).'
    • '); + } + + # Chop off any directories in the given filename + $basename = basename( $this->mOname ); - if ( '' == $ext ) { $xl = 0; } else { $xl = strlen( $ext ) + 1; } - $partname = substr( $basename, 0, strlen( $basename ) - $xl ); + if( preg_match( '/^(.*)\.([^.]*)$/', $basename, $matches ) ) { + $partname = $matches[1]; + $ext = $matches[2]; + } else { + $partname = $basename; + $ext = ''; + } - if ( strlen( $partname ) < 3 ) { - $this->mainUploadForm( WfMsg( 'minlength' ) ); - return; - } + if ( strlen( $partname ) < 3 ) { + $this->mainUploadForm( wfMsg( 'minlength' ) ); + return; + } - $changed_name = false; - $bn = preg_replace ( "/[^".Title::legalChars()."]/", '-', $basename ); - if ( 0 != strcmp( $bn, $basename ) ) - { - $changed_name = true; - $basename = $bn; + /** + * Filter out illegal characters, and try to make a legible name + * out of it. We'll strip some silently that Title would die on. + */ + $filtered = preg_replace ( "/[^".Title::legalChars()."]/", '-', $basename ); + $nt = Title::newFromText( $filtered ); + if( is_null( $nt ) ) { + return $this->uploadError( wfMsg( 'illegalfilename', htmlspecialchars( $filtered ) ) ); + } + $nt->setNamespace( NS_IMAGE ); + $this->mUploadSaveName = $nt->getDBkey(); + + /** + * If the image is protected, non-sysop users won't be able + * to modify it by uploading a new revision. + */ + if( !$nt->userCanEdit() ) { + return $this->uploadError( wfMsg( 'protectedpage' ) ); + } + + /* Don't allow users to override the blacklist */ + global $wgStrictFileExtensions; + global $wgFileExtensions, $wgFileBlacklist; + if( $this->checkFileExtension( $ext, $wgFileBlacklist ) || + ($wgStrictFileExtensions && !$this->checkFileExtension( $ext, $wgFileExtensions ) ) ) { + return $this->uploadError( wfMsg( 'badfiletype', htmlspecialchars( $ext ) ) ); + } + + /** + * Look at the contents of the file; if we can recognize the + * type but it's corrupt or data of the wrong type, we should + * probably not accept it. + */ + if( !$this->verify( $this->mUploadTempName, $ext ) ) { + return $this->uploadError( wfMsg( 'uploadcorrupt' ) ); + } + + /** + * Check for non-fatal conditions + */ + if ( ! $this->mIgnoreWarning ) { + $warning = ''; + if( $this->mUploadSaveName != ucfirst( $filtered ) ) { + $warning .= '
  • '.wfMsg( 'badfilename', htmlspecialchars( $this->mUploadSaveName ) ).'
    • '; } - - $nt = Title::newFromText( $basename ); - if( !$nt ) { - return $this->uploadError( wfMsg( 'illegalfilename', htmlspecialchars( $basename ) ) ); + + global $wgCheckFileExtensions; + if ( $wgCheckFileExtensions ) { + if ( ! $this->checkFileExtension( $ext, $wgFileExtensions ) ) { + $warning .= '
  • '.wfMsg( 'badfiletype', htmlspecialchars( $ext ) ).'
    • '; + } } - $nt->setNamespace( Namespace::getImage() ); - $this->mUploadSaveName = $nt->getDBkey(); - - /* Don't allow users to override the blacklist */ - if( $this->checkFileExtension( $ext, $wgFileBlacklist ) || - ($wgStrictFileExtensions && !$this->checkFileExtension( $ext, $wgFileExtensions ) ) ) { - return $this->uploadError( wfMsg( 'badfiletype', htmlspecialchars( $ext ) ) ); + + global $wgUploadSizeWarning; + if ( $wgUploadSizeWarning && ( $this->mUploadSize > $wgUploadSizeWarning ) ) { + $warning .= '
  • '.wfMsg( 'largefile' ).'
    • '; } - - if( !$this->verify( $this->mUploadTempName, $ext ) ) { - return $this->uploadError( wfMsg( 'uploadcorrupt' ) ); + if ( $this->mUploadSize == 0 ) { + $warning .= '
  • '.wfMsg( 'emptyfile' ).'
    • '; } - $this->saveUploadedFile( $this->mUploadSaveName, $this->mUploadTempName ); - if ( !$nt->userCanEdit() ) { - return $this->uploadError( wfMsg( 'protectedpage' ) ); + if( $nt->getArticleID() ) { + global $wgUser; + $sk = $wgUser->getSkin(); + $dlink = $sk->makeKnownLinkObj( $nt ); + $warning .= '
  • '.wfMsg( 'fileexists', $dlink ).'
    • '; } - if ( ! $this->mIgnoreWarning ) { - $warning = ''; - if( $changed_name || 0 != strcmp( ucfirst( $basename ), $this->mUploadSaveName ) ) { - $warning .= '
  • '.wfMsg( 'badfilename', htmlspecialchars( $this->mUploadSaveName ) ).'
    • '; - } - - if ( $wgCheckFileExtensions ) { - if ( ! $this->checkFileExtension( $ext, $wgFileExtensions ) ) { - $warning .= '
  • '.wfMsg( 'badfiletype', htmlspecialchars( $ext ) ).'
    • '; - } - } - if ( $wgUploadSizeWarning && ( $this->mUploadSize > $wgUploadSizeWarning ) ) { - $warning .= '
  • '.wfMsg( 'largefile' ).'
    • '; - } - if ( $this->mUploadSize == 0 ) { - $warning .= '
  • '.wfMsg( 'emptyfile' ).'
    • '; - } - if( $nt->getArticleID() ) { - $sk = $wgUser->getSkin(); - $dname = $wgContLang->getNsText( Namespace::getImage() ) .':'.$this->mUploadSaveName; - $dlink = $sk->makeKnownLink( $dname, $dname ); - $warning .= '
  • '.wfMsg( 'fileexists', $dlink ).'
    • '; - } - if($warning != '') return $this->uploadWarning($warning); + if( $warning != '' ) { + /** + * 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); } - } elseif(!isset($this->mUploadSaveName)) { - // no filename given even when reuploading - return $this->uploadError('
  • '.wfMsg( 'emptyfile' ).'
    • '); - } - if ( !is_null( $this->mUploadOldVersion ) ) { - $wgUploadOldVersion = $this->mUploadOldVersion; + + /** + * Try actually saving the thing... + * It will show an error form on failure. + */ + if( $this->saveUploadedFile( $this->mUploadSaveName, + $this->mUploadTempName, + !empty( $this->mSessionKey ) ) ) { + /** + * Update the upload log and create the description page + * if it's a new file. + */ + wfRecordUpload( $this->mUploadSaveName, + $this->mUploadOldVersion, + $this->mUploadSize, + $this->mUploadDescription, + $this->mUploadCopyStatus, + $this->mUploadSource ); + $this->showSuccess(); } - wfRecordUpload( $this->mUploadSaveName, $wgUploadOldVersion, $this->mUploadSize, - $this->mUploadDescription, $this->mUploadCopyStatus, $this->mUploadSource ); - - $sk = $wgUser->getSkin(); - $ilink = $sk->makeMediaLink( $this->mUploadSaveName, Image::wfImageUrl( $this->mUploadSaveName ) ); - $dname = $wgContLang->getNsText( Namespace::getImage() ) . ':'.$this->mUploadSaveName; - $dlink = $sk->makeKnownLink( $dname, $dname ); - - $wgOut->addHTML( '

    ' . wfMsg( 'successfulupload' ) . "

    \n" ); - $text = wfMsg( 'fileuploaded', $ilink, $dlink ); - $wgOut->addHTML( '

    '.$text."\n" ); - $wgOut->returnToMain( false ); - } - - function checkFileExtension( $ext, $list ) { - return in_array( strtolower( $ext ), $list ); } - function saveUploadedFile( $saveName, $tempName ) { - global $wgSavedFile, $wgUploadOldVersion; + /** + * Move the uploaded file from its temporary location to the final + * destination. If a previous version of the file exists, move + * it into the archive subdirectory. + * + * @todo If the later save fails, we may have disappeared the original file. + * + * @param string $saveName + * @param string $tempName full path to the temporary file + * @param bool $useRename if true, doesn't check that the source file + * is a PHP-managed upload temporary + */ + function saveUploadedFile( $saveName, $tempName, $useRename = false ) { global $wgUploadDirectory, $wgOut; $dest = wfImageDir( $saveName ); $archive = wfImageArchiveDir( $saveName ); - $wgSavedFile = "{$dest}/{$saveName}"; + $this->mSavedFile = "{$dest}/{$saveName}"; - if ( is_file( $wgSavedFile ) ) { - $wgUploadOldVersion = gmdate( 'YmdHis' ) . "!{$saveName}"; + if( is_file( $this->mSavedFile ) ) { + $this->mUploadOldVersion = gmdate( 'YmdHis' ) . "!{$saveName}"; - if ( ! rename( $wgSavedFile, "${archive}/{$wgUploadOldVersion}" ) ) { - $wgOut->fileRenameError( $wgSavedFile, - "${archive}/{$wgUploadOldVersion}" ); - return; + if( !rename( $this->mSavedFile, "${archive}/{$this->mUploadOldVersion}" ) ) { + $wgOut->fileRenameError( $this->mSavedFile, + "${archive}/{$this->mUploadOldVersion}" ); + return false; } } else { - $wgUploadOldVersion = ''; + $this->mUploadOldVersion = ''; } - if ( ! move_uploaded_file( $tempName, $wgSavedFile ) ) { - $wgOut->fileCopyError( $tempName, $wgSavedFile ); + + if( $useRename ) { + if( !rename( $tempName, $this->mSavedFile ) ) { + $wgOut->fileCopyError( $tempName, $this->mSavedFile ); + return false; + } + } else { + if( !move_uploaded_file( $tempName, $this->mSavedFile ) ) { + $wgOut->fileCopyError( $tempName, $this->mSavedFile ); + return false; + } } - chmod( $wgSavedFile, 0644 ); + chmod( $this->mSavedFile, 0644 ); + return true; } - function unsaveUploadedFile() { - global $wgUploadDirectory, $wgOut, $wgRequest; + /** + * Stash a file in a temporary directory for later processing + * after the user has confirmed it. + * + * If the user doesn't explicitly cancel or accept, these files + * can accumulate in the temp directory. + * + * @param string $saveName - the destination filename + * @param string $tempName - the source temporary file to save + * @return string - full path the stashed file, or false on failure + * @access private + */ + function saveTempUploadedFile( $saveName, $tempName ) { + global $wgOut; + + $archive = wfImageArchiveDir( $saveName, 'temp' ); + $stash = $archive . '/' . gmdate( "YmdHis" ) . '!' . $saveName; + + if ( !move_uploaded_file( $tempName, $stash ) ) { + $wgOut->fileCopyError( $tempName, $stash ); + return false; + } - $wgSavedFile = $_SESSION['wsUploadFiles'][$this->mSessionKey]; - $wgUploadOldVersion = $this->mUploadOldVersion; + return $stash; + } + + /** + * Stash a file in a temporary directory for later processing, + * and save the necessary descriptive info into the session. + * Returns a key value which will be passed through a form + * to pick up the path info on a later invocation. + * + * @return int + * @access private + */ + function stashSession() { + $stash = $this->saveTempUploadedFile( + $this->mUploadSaveName, $this->mUploadTempName ); - if ( ! @unlink( $wgSavedFile ) ) { - $wgOut->fileDeleteError( $wgSavedFile ); - return; + if( !$stash ) { + # Couldn't save the file. + return false; } - if ( '' != $wgUploadOldVersion ) { - $hash = md5( substr( $wgUploadOldVersion, 15 ) ); - $archive = $wgUploadDirectory.'/archive/' . $hash{0} . - '/' . substr( $hash, 0, 2 ); + + $key = mt_rand( 0, 0x7fffffff ); + $_SESSION['wsUploadData'][$key] = array( + 'mUploadTempName' => $stash, + 'mUploadSize' => $this->mUploadSize, + 'mOname' => $this->mOname ); + return $key; + } - if ( ! rename( "{$archive}/{$wgUploadOldVersion}", $wgSavedFile ) ) { - $wgOut->fileRenameError( "{$archive}/{$wgUploadOldVersion}", - $wgSavedFile ); - } + /** + * Remove a temporarily kept file stashed by saveTempUploadedFile(). + * @access private + */ + function unsaveUploadedFile() { + if ( ! @unlink( $this->mUploadTempName ) ) { + $wgOut->fileDeleteError( $this->mUploadTempName ); } } + /* -------------------------------------------------------------- */ + + /** + * Show some text and linkage on successful upload. + * @access private + */ + function showSuccess() { + global $wgUser, $wgOut, $wgContLang; + + $sk = $wgUser->getSkin(); + $ilink = $sk->makeMediaLink( $this->mUploadSaveName, Image::wfImageUrl( $this->mUploadSaveName ) ); + $dname = $wgContLang->getNsText( Namespace::getImage() ) . ':'.$this->mUploadSaveName; + $dlink = $sk->makeKnownLink( $dname, $dname ); + + $wgOut->addHTML( '

    ' . wfMsg( 'successfulupload' ) . "

    \n" ); + $text = wfMsg( 'fileuploaded', $ilink, $dlink ); + $wgOut->addHTML( '

    '.$text."\n" ); + $wgOut->returnToMain( false ); + } + + /** + * @param string $error as HTML + * @access private + */ function uploadError( $error ) { global $wgOut; $sub = wfMsg( 'uploadwarning' ); @@ -286,14 +404,23 @@ class UploadForm { $wgOut->addHTML( "

    {$error}

    \n" ); } + /** + * There's something wrong with this file, not enough to reject it + * totally but we require manual intervention to save it for real. + * Stash it away, then present a form asking to confirm or cancel. + * + * @param string $warning as HTML + * @access private + */ function uploadWarning( $warning ) { global $wgOut, $wgUser, $wgLang, $wgUploadDirectory, $wgRequest; - global $wgSavedFile, $wgUploadOldVersion; global $wgUseCopyrightUpload; - # wgSavedFile is stored in the session not the form, for security - $this->mSessionKey = mt_rand( 0, 0x7fffffff ); - $_SESSION['wsUploadFiles'][$this->mSessionKey] = $wgSavedFile; + $this->mSessionKey = $this->stashSession(); + if( !$this->mSessionKey ) { + # Couldn't save file; an error has been displayed so let's go. + return; + } $sub = wfMsg( 'uploadwarning' ); $wgOut->addHTML( "

    {$sub}

    \n" ); @@ -321,13 +448,8 @@ class UploadForm { action=\"{$action}\"> - mUploadDescription ) . "\" /> - {$copyright} - mUploadSaveName ) . "\" /> - mUploadTempName ) . "\" /> - mUploadSize ) . "\" /> mSessionKey ) . "\" /> - + {$copyright}
    @@ -337,7 +459,14 @@ class UploadForm { {$reup}
    \n" ); } - function mainUploadForm( $msg ) { + /** + * Displays the main upload form, optionally with a highlighted + * error message up at the top. + * + * @param string $msg as HTML + * @access private + */ + function mainUploadForm( $msg='' ) { global $wgOut, $wgUser, $wgLang, $wgUploadDirectory, $wgRequest; global $wgUseCopyrightUpload; @@ -387,8 +516,7 @@ class UploadForm { action=\"{$action}\">
    {$fn}: - mUploadFile ) . "\" size='40' /> +
    {$fd}:
    \n" ); } + /* -------------------------------------------------------------- */ + + /** + * Perform case-insensitive match against a list of file extensions. + * Returns true if the extension is in the list. + * + * @param string $ext + * @param array $list + * @return bool + */ + function checkFileExtension( $ext, $list ) { + return in_array( strtolower( $ext ), $list ); + } + /** * Returns false if the file is of a known type but can't be recognized, * indicating a corrupt file.