UploadFromUrl.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserIdentity;

class UploadFromUrl extends UploadBase {
    protected $mUrl;

    protected $mTempPath, $mTmpHandle;

    protected static $allowedUrls = [];

    public static function isAllowed( UserIdentity $user ) {
        if ( !MediaWikiServices::getInstance()
                ->getPermissionManager()
                ->userHasRight( $user, 'upload_by_url' )
        ) {
            return 'upload_by_url';
        }

        return parent::isAllowed( $user );
    }

    public static function isEnabled() {
        global $wgAllowCopyUploads;

        return $wgAllowCopyUploads && parent::isEnabled();
    }

    public static function isAllowedHost( $url ) {
        global $wgCopyUploadsDomains;
        if ( !count( $wgCopyUploadsDomains ) ) {
            return true;
        }
        $parsedUrl = wfParseUrl( $url );
        if ( !$parsedUrl ) {
            return false;
        }
        $valid = false;
        foreach ( $wgCopyUploadsDomains as $domain ) {
            // See if the domain for the upload matches this whitelisted domain
            $whitelistedDomainPieces = explode( '.', $domain );
            $uploadDomainPieces = explode( '.', $parsedUrl['host'] );
            if ( count( $whitelistedDomainPieces ) === count( $uploadDomainPieces ) ) {
                $valid = true;
                // See if all the pieces match or not (excluding wildcards)
                foreach ( $whitelistedDomainPieces as $index => $piece ) {
                    if ( $piece !== '*' && $piece !== $uploadDomainPieces[$index] ) {
                        $valid = false;
                    }
                }
                if ( $valid ) {
                    // We found a match, so quit comparing against the list
                    break;
                }
            }
            /* Non-wildcard test
            if ( $parsedUrl['host'] === $domain ) {
                $valid = true;
                break;
            }
            */
        }

        return $valid;
    }

    public static function isAllowedUrl( $url ) {
        if ( !isset( self::$allowedUrls[$url] ) ) {
            $allowed = true;
            Hooks::run( 'IsUploadAllowedFromUrl', [ $url, &$allowed ] );
            self::$allowedUrls[$url] = $allowed;
        }

        return self::$allowedUrls[$url];
    }

    public function initialize( $name, $url ) {
        $this->mUrl = $url;

        $tempPath = $this->makeTemporaryFile();
        # File size and removeTempFile will be filled in later
        $this->initializePathInfo( $name, $tempPath, 0, false );
    }

    public function initializeFromRequest( &$request ) {
        $desiredDestName = $request->getText( 'wpDestFile' );
        if ( !$desiredDestName ) {
            $desiredDestName = $request->getText( 'wpUploadFileURL' );
        }
        $this->initialize(
            $desiredDestName,
            trim( $request->getVal( 'wpUploadFileURL' ) )
        );
    }

    public static function isValidRequest( $request ) {
        global $wgUser;

        $url = $request->getVal( 'wpUploadFileURL' );

        return !empty( $url )
            && MediaWikiServices::getInstance()
                   ->getPermissionManager()
                   ->userHasRight( $wgUser, 'upload_by_url' );
    }

    public function getSourceType() {
        return 'url';
    }

    public function fetchFile( $httpOptions = [] ) {
        if ( !Http::isValidURI( $this->mUrl ) ) {
            return Status::newFatal( 'http-invalid-url', $this->mUrl );
        }

        if ( !self::isAllowedHost( $this->mUrl ) ) {
            return Status::newFatal( 'upload-copy-upload-invalid-domain' );
        }
        if ( !self::isAllowedUrl( $this->mUrl ) ) {
            return Status::newFatal( 'upload-copy-upload-invalid-url' );
        }
        return $this->reallyFetchFile( $httpOptions );
    }

    protected function makeTemporaryFile() {
        $tmpFile = MediaWikiServices::getInstance()->getTempFSFileFactory()
            ->newTempFSFile( 'URL', 'urlupload_' );
        $tmpFile->bind( $this );

        return $tmpFile->getPath();
    }

    public function saveTempFileChunk( $req, $buffer ) {
        wfDebugLog( 'fileupload', 'Received chunk of ' . strlen( $buffer ) . ' bytes' );
        $nbytes = fwrite( $this->mTmpHandle, $buffer );

        if ( $nbytes == strlen( $buffer ) ) {
            $this->mFileSize += $nbytes;
        } else {
            // Well... that's not good!
            wfDebugLog(
                'fileupload',
                'Short write ' . $nbytes . '/' . strlen( $buffer ) .
                    ' bytes, aborting with ' . $this->mFileSize . ' uploaded so far'
            );
            fclose( $this->mTmpHandle );
            $this->mTmpHandle = false;
        }

        return $nbytes;
    }

    protected function reallyFetchFile( $httpOptions = [] ) {
        global $wgCopyUploadProxy, $wgCopyUploadTimeout;
        if ( $this->mTempPath === false ) {
            return Status::newFatal( 'tmp-create-error' );
        }

        // Note the temporary file should already be created by makeTemporaryFile()
        $this->mTmpHandle = fopen( $this->mTempPath, 'wb' );
        if ( !$this->mTmpHandle ) {
            return Status::newFatal( 'tmp-create-error' );
        }
        wfDebugLog( 'fileupload', 'Temporary file created "' . $this->mTempPath . '"' );

        $this->mRemoveTempFile = true;
        $this->mFileSize = 0;

        $options = $httpOptions + [ 'followRedirects' => true ];

        if ( $wgCopyUploadProxy !== false ) {
            $options['proxy'] = $wgCopyUploadProxy;
        }

        if ( $wgCopyUploadTimeout && !isset( $options['timeout'] ) ) {
            $options['timeout'] = $wgCopyUploadTimeout;
        }
        wfDebugLog(
            'fileupload',
            'Starting download from "' . $this->mUrl . '" ' .
                '<' . implode( ',', array_keys( array_filter( $options ) ) ) . '>'
        );
        $req = MWHttpRequest::factory( $this->mUrl, $options, __METHOD__ );
        $req->setCallback( [ $this, 'saveTempFileChunk' ] );
        $status = $req->execute();

        if ( $this->mTmpHandle ) {
            // File got written ok...
            fclose( $this->mTmpHandle );
            $this->mTmpHandle = null;
        } else {
            // We encountered a write error during the download...
            return Status::newFatal( 'tmp-write-error' );
        }

        wfDebugLog( 'fileupload', $status );
        if ( $status->isOK() ) {
            wfDebugLog( 'fileupload', 'Download by URL completed successfully.' );
        } else {
            wfDebugLog(
                'fileupload',
                'Download by URL completed with HTTP status ' . $req->getStatus()
            );
        }

        return $status;
    }
}