MediaWiki  master
SpecialUploadStash Class Reference

Web access for files temporarily stored by UploadStash. More...

Inheritance diagram for SpecialUploadStash:
Collaboration diagram for SpecialUploadStash:

Public Member Functions

 __construct ()
 
 doesWrites ()
 
 execute ( $subPage)
 Execute page – can output a file directly or show a listing of them. More...
 
 showUpload ( $key)
 If file available in stash, cats it out to the client as a simple HTTP response. More...
 
- Public Member Functions inherited from UnlistedSpecialPage
 __construct ( $name, $restriction='', $function=false, $file='default')
 
 isListed ()
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key)
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Static Public Member Functions

static tryClearStashedUploads ( $formData, $form)
 Static callback for the HTMLForm in showUploads, to process Note the stash has to be recreated since this is being called in a static context. More...
 
- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
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, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 

Public Attributes

const MAX_SERVE_BYTES = 1048576
 Since we are directly writing the file to STDOUT, we should not be reading in really big files and serving them out. More...
 

Private Member Functions

 outputContents ( $content, $contentType)
 Output HTTP response of raw content Side effect: writes HTTP response to STDOUT. More...
 
 outputLocalFile (File $file)
 Output HTTP response for file Side effect: writes HTTP response to STDOUT. More...
 
 outputLocallyScaledThumb ( $file, $params, $flags)
 Scale a file (probably with a locally installed imagemagick, or similar) and output it to STDOUT. More...
 
 outputRemoteScaledThumb ( $file, $params, $flags)
 Scale a file with a remote "scaler", as exists on the Wikimedia Foundation cluster, and output it to STDOUT. More...
 
 outputThumbFromStash ( $file, $params)
 Get a thumbnail for file, either generated locally or remotely, and stream it out. More...
 
 parseKey ( $key)
 Parse the key passed to the SpecialPage. More...
 
 showUploads ()
 Default action when we don't have a subpage – just show links to the uploads we have, Also show a button to clear stashed files. More...
 

Static Private Member Functions

static outputFileHeaders ( $contentType, $size)
 Output headers for streaming. More...
 

Private Attributes

 $stash
 

Additional Inherited Members

- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

Web access for files temporarily stored by UploadStash.

For example – files that were uploaded with the UploadWizard extension are stored temporarily before committing them to the db. But we want to see their thumbnails and get other information about them.

Since this is based on the user's session, in effect this creates a private temporary file area. However, the URLs for the files cannot be shared.

Definition at line 36 of file SpecialUploadStash.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialUploadStash::__construct ( )

Definition at line 52 of file SpecialUploadStash.php.

Member Function Documentation

◆ doesWrites()

SpecialUploadStash::doesWrites ( )

Definition at line 56 of file SpecialUploadStash.php.

◆ execute()

SpecialUploadStash::execute (   $subPage)

Execute page – can output a file directly or show a listing of them.

Parameters
string | null$subPageSubpage, e.g. in https://example.com/wiki/Special:UploadStash/foo.jpg, the "foo.jpg" part
Returns
bool Success

Definition at line 67 of file SpecialUploadStash.php.

References SpecialPage\checkPermissions(), SpecialPage\getUser(), null, showUpload(), showUploads(), RepoGroup\singleton(), and SpecialPage\useTransactionalTimeLimit().

◆ outputContents()

SpecialUploadStash::outputContents (   $content,
  $contentType 
)
private

Output HTTP response of raw content Side effect: writes HTTP response to STDOUT.

Parameters
string$content
string$contentTypeMIME type
Exceptions
SpecialUploadStashTooLargeException
Returns
bool

Definition at line 339 of file SpecialUploadStash.php.

References $content, SpecialPage\msg(), print, and wfResetOutputBuffers().

Referenced by outputRemoteScaledThumb().

◆ outputFileHeaders()

static SpecialUploadStash::outputFileHeaders (   $contentType,
  $size 
)
staticprivate

Output headers for streaming.

Todo:
Unsure about encoding as binary; if we received from HTTP perhaps we should use that encoding, concatenated with semicolon to $contentType as it usually is.

Side effect: preps PHP to write headers to STDOUT.

Parameters
string$contentTypeString suitable for content-type header
string$sizeLength in bytes

Definition at line 363 of file SpecialUploadStash.php.

◆ outputLocalFile()

SpecialUploadStash::outputLocalFile ( File  $file)
private

Output HTTP response for file Side effect: writes HTTP response to STDOUT.

Parameters
File$fileFile object with a local path (e.g. UnregisteredLocalFile, LocalFile. Oddly these don't share an ancestor!)
Exceptions
SpecialUploadStashTooLargeException
Returns
bool

Definition at line 318 of file SpecialUploadStash.php.

References File\getPath(), File\getRepo(), File\getSize(), and SpecialPage\msg().

Referenced by outputLocallyScaledThumb(), and showUpload().

◆ outputLocallyScaledThumb()

SpecialUploadStash::outputLocallyScaledThumb (   $file,
  $params,
  $flags 
)
private

Scale a file (probably with a locally installed imagemagick, or similar) and output it to STDOUT.

Parameters
File$file
array$paramsScaling parameters ( e.g. [ width => '50' ] );
int$flagsScaling flags ( see File:: constants )
Exceptions
MWException|UploadStashFileNotFoundException
Returns
bool Success

Definition at line 192 of file SpecialUploadStash.php.

References $file, $params, false, SpecialPage\msg(), outputLocalFile(), and File\RENDER_NOW.

Referenced by outputThumbFromStash().

◆ outputRemoteScaledThumb()

SpecialUploadStash::outputRemoteScaledThumb (   $file,
  $params,
  $flags 
)
private

Scale a file with a remote "scaler", as exists on the Wikimedia Foundation cluster, and output it to STDOUT.

Note: Unlike the usual thumbnail process, the web client never sees the cluster URL; we do the whole HTTP transaction to the scaler ourselves and cat the results out. Note: We rely on NFS to have propagated the file contents to the scaler. However, we do not rely on the thumbnail being created in NFS and then propagated back to our filesystem. Instead we take the results of the HTTP request instead. Note: No caching is being done here, although we are instructing the client to cache it forever.

Parameters
File$file
array$paramsScaling parameters ( e.g. [ width => '50' ] );
int$flagsScaling flags ( see File:: constants )
Exceptions
MWException
Returns
bool Success

Definition at line 244 of file SpecialUploadStash.php.

References $file, $params, $req, MWHttpRequest\factory(), SpecialPage\getConfig(), SpecialPage\msg(), outputContents(), PROTO_CANONICAL, and wfExpandUrl().

Referenced by outputThumbFromStash().

◆ outputThumbFromStash()

SpecialUploadStash::outputThumbFromStash (   $file,
  $params 
)
private

Get a thumbnail for file, either generated locally or remotely, and stream it out.

Parameters
File$file
array$params

Definition at line 169 of file SpecialUploadStash.php.

References $file, $params, SpecialPage\getConfig(), outputLocallyScaledThumb(), and outputRemoteScaledThumb().

Referenced by showUpload().

◆ parseKey()

SpecialUploadStash::parseKey (   $key)
private

Parse the key passed to the SpecialPage.

Returns an array containing the associated file object, the type ('file' or 'thumb') and if application the transform parameters

Parameters
string$key
Exceptions
UploadStashBadPathException
Returns
array

Definition at line 128 of file SpecialUploadStash.php.

References $file, $handler, $params, $type, and SpecialPage\msg().

Referenced by showUpload().

◆ showUpload()

SpecialUploadStash::showUpload (   $key)

If file available in stash, cats it out to the client as a simple HTTP response.

n.b. Most sanity checking done in UploadStashLocalFile, so this is straightforward.

Parameters
string$keyThe key of a particular requested file
Exceptions
HttpError
Returns
bool

Definition at line 88 of file SpecialUploadStash.php.

References $code, $e, $params, SpecialPage\getOutput(), outputLocalFile(), outputThumbFromStash(), and parseKey().

Referenced by execute().

◆ showUploads()

SpecialUploadStash::showUploads ( )
private

Default action when we don't have a subpage – just show links to the uploads we have, Also show a button to clear stashed files.

Returns
bool

Definition at line 399 of file SpecialUploadStash.php.

References $context, $e, $file, SpecialPage\$linkRenderer, as, Html\element(), HTMLForm\factory(), SpecialPage\getContext(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\msg(), SpecialPage\outputHeader(), Html\rawElement(), SpecialPage\setHeaders(), and text.

Referenced by execute().

◆ tryClearStashedUploads()

static SpecialUploadStash::tryClearStashedUploads (   $formData,
  $form 
)
static

Static callback for the HTMLForm in showUploads, to process Note the stash has to be recreated since this is being called in a static context.

This works, because there really is only one stash per logged-in user, despite appearances.

Parameters
array$formData
HTMLForm$form
Returns
Status

Definition at line 381 of file SpecialUploadStash.php.

References $stash, StatusValue\newFatal(), StatusValue\newGood(), RepoGroup\singleton(), true, and wfDebug().

Member Data Documentation

◆ $stash

SpecialUploadStash::$stash
private

Definition at line 38 of file SpecialUploadStash.php.

Referenced by tryClearStashedUploads().

◆ MAX_SERVE_BYTES

const SpecialUploadStash::MAX_SERVE_BYTES = 1048576

Since we are directly writing the file to STDOUT, we should not be reading in really big files and serving them out.

We also don't want people using this as a file drop, even if they share credentials.

This service is really for thumbnails and other such previews while uploading.

Definition at line 50 of file SpecialUploadStash.php.


The documentation for this class was generated from the following file: