MediaWiki 1.42.0
|
Form for handling uploads and special page. More...
Inherits MediaWiki\SpecialPage\SpecialPage.
Public Member Functions | |
__construct (RepoGroup $repoGroup=null, UserOptionsLookup $userOptionsLookup=null, NamespaceInfo $nsInfo=null, WatchlistManager $watchlistManager=null) | |
doesWrites () | |
Indicates whether this special page may perform database writes. | |
execute ( $par) | |
getDupeWarning ( $dupes) | |
Construct a warning and a gallery from an array of duplicate files. | |
userCanExecute (User $user) | |
This page can be shown if uploading is enabled. | |
![]() | |
__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. | |
addHelpLink ( $to, $overrideBaseUrl=false) | |
Adds help link with an icon via page indicators. | |
checkPermissions () | |
Checks if userCanExecute, and if not throws a PermissionsError. | |
checkReadOnly () | |
If the wiki is currently in readonly mode, throws a ReadOnlyError. | |
getAssociatedNavigationLinks () | |
Return an array of strings representing page titles that are discoverable to end users via UI. | |
getAuthority () | |
Shortcut to get the Authority executing this instance. | |
getConfig () | |
Shortcut to get main config object. | |
getContentLanguage () | |
Shortcut to get content language. | |
getContext () | |
Gets the context this SpecialPage is executed in. | |
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. | |
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. | |
getFullTitle () | |
Return the full title, including $par. | |
getLanguage () | |
Shortcut to get user's language. | |
getLinkRenderer () | |
getLocalName () | |
Get the localised name of the special page. | |
getName () | |
Get the canonical, unlocalized name of this special page without namespace. | |
getOutput () | |
Get the OutputPage being used for this instance. | |
getPageTitle ( $subpage=false) | |
Get a self-referential title object. | |
getRequest () | |
Get the WebRequest being used for this instance. | |
getRestriction () | |
Get the permission that a user must have to execute this page. | |
getShortDescription (string $path='') | |
Similar to getDescription but takes into account sub pages and designed for display in tabs. | |
getSkin () | |
Shortcut to get the skin being used for this instance. | |
getUser () | |
Shortcut to get the User executing this instance. | |
including ( $x=null) | |
Whether the special page is being evaluated via transclusion. | |
isCached () | |
Is this page cached? Expensive pages are cached or disabled in miser mode. | |
isExpensive () | |
Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. | |
isIncludable () | |
Whether it's allowed to transclude the special page via {{Special:Foo/params}}. | |
isListed () | |
Whether this special page is listed in Special:SpecialPages. | |
isRestricted () | |
Can be overridden by subclasses with more complicated permissions schemes. | |
maxIncludeCacheTime () | |
How long to cache page when it is being included. | |
msg ( $key,... $params) | |
Wrapper around wfMessage that sets the current context. | |
prefixSearchSubpages ( $search, $limit, $offset) | |
Return an array of subpages beginning with $search that this special page will accept. | |
requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | |
If the user is not logged in, throws UserNotLoggedIn error. | |
requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | |
If the user is not logged in or is a temporary user, throws UserNotLoggedIn. | |
run ( $subPage) | |
Entry point. | |
setContentLanguage (Language $contentLanguage) | |
Set content language. | |
setContext ( $context) | |
Sets the context this SpecialPage is executed in. | |
setHookContainer (HookContainer $hookContainer) | |
setLinkRenderer (LinkRenderer $linkRenderer) | |
setSpecialPageFactory (SpecialPageFactory $specialPageFactory) | |
Static Public Member Functions | |
static | getExistsWarning ( $exists) |
Functions for formatting warnings. | |
static | getInitialPageText ( $comment='', $license='', $copyStatus='', $source='', Config $config=null) |
Get the initial image page text based on a comment and optional file status information. | |
static | rotationEnabled () |
Should we rotate images in the preview on Special:Upload. | |
![]() | |
static | getSafeTitleFor ( $name, $subpage=false) |
Get a localised Title object for a page name with a possibly unvalidated subpage. | |
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. | |
static | getTitleValueFor ( $name, $subpage=false, $fragment='') |
Get a localised TitleValue object for a specified special page name. | |
static | newSearchPage (User $user) |
Get the users preferred search page. | |
Public Attributes | |
bool bool | $allowAsync |
wether uploads by url should be asynchronous or not | |
string | $mCacheKey |
The cache key to use to retreive the status of your async upload. | |
bool | $mCancelUpload |
The user clicked "Cancel and return to upload form" button. | |
$mComment | |
$mCopyrightSource | |
$mCopyrightStatus | |
string | $mDesiredDestName |
User input variables from the "description" section. | |
$mDestWarningAck | |
Hidden variables. | |
bool | $mForReUpload |
The user followed an "overwrite this file" link. | |
$mIgnoreWarning | |
User input variables from the root section. | |
$mLicense | |
LocalFile | $mLocalFile |
WebRequest FauxRequest | $mRequest |
Misc variables. | |
$mSourceType | |
$mTokenOk | |
UploadBase | $mUpload |
$mUploadClicked | |
bool | $mUploadSuccessful = false |
Subclasses can use this to determine whether a file was uploaded. | |
$mWatchthis | |
string | $uploadFormTextAfterSummary |
Raw html injection point for hooks not using HTMLForm. | |
string | $uploadFormTextTop |
Raw html injection point for hooks not using HTMLForm. | |
Protected Member Functions | |
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'. | |
getPageTextAndTags () | |
Get the page text and tags for the upload. | |
getUploadForm ( $message='', $sessionKey='', $hideIgnoreWarning=false) | |
Get an UploadForm instance with title and text properly set. | |
getWatchCheck () | |
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 to create a new file or update an existing one. | |
isAsyncUpload () | |
Check if the current request is an async upload by url request. | |
loadRequest () | |
Initialize instance variables from request and create an Upload handler. | |
performUploadChecks ( $fetchFileStatus) | |
Common steps for processing uploads. | |
processAsyncUpload () | |
Process an asynchronous upload. | |
processUpload () | |
Do the upload. | |
processVerificationError ( $details) | |
Provides output to the user for a result of UploadBase::verifyUpload. | |
showRecoverableUploadError ( $message) | |
Stashes the upload and shows the main upload form. | |
showUploadError ( $message) | |
Show the upload form with error message, but do not stash the file. | |
showUploadForm ( $form) | |
Show the main upload form. | |
showUploadStatus ( $user) | |
Show the upload status. | |
showUploadWarning ( $warnings) | |
Stashes the upload, shows the main form, but adds a "continue anyway button". | |
unsaveUploadedFile () | |
Remove a temporarily kept file stashed by saveTempUploadedFile(). | |
![]() | |
addFeedLinks ( $params) | |
Adds RSS/atom links. | |
afterExecute ( $subPage) | |
Gets called after. | |
authorizeAction (?string $action=null) | |
Utility function for authorizing an action to be performed by the special page. | |
beforeExecute ( $subPage) | |
Gets called before. | |
buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false) | |
Generate (prev x| next x) (20|50|100...) type links for paging. | |
checkLoginSecurityLevel ( $level=null) | |
Verifies that the user meets the security level, possibly reauthenticating them in the process. | |
displayRestrictionError () | |
Output an error message telling the user what access level they have to have. | |
getAuthManager () | |
getCacheTTL () | |
getHookContainer () | |
getHookRunner () | |
getLoginSecurityLevel () | |
Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. | |
getRobotPolicy () | |
Return the robot policy. | |
getSpecialPageFactory () | |
getSubpagesForPrefixSearch () | |
Return an array of subpages that this special page will accept for prefix searches. | |
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. | |
prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null) | |
Perform a regular substring search for prefixSearchSubpages. | |
setAuthManager (AuthManager $authManager) | |
Set the injected AuthManager from the special page constructor. | |
setHeaders () | |
Sets headers - this should be called from the execute() method of all derived classes! | |
setReauthPostData (array $data) | |
Record preserved POST data after a reauthentication. | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. | |
Additional Inherited Members | |
![]() | |
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). | |
![]() | |
IContextSource | $mContext |
Current request context. | |
bool | $mIncludable |
Whether the special page can be included in an article. | |
bool | $mIncluding |
Whether or not this special page is being included from an article. | |
string | $mName |
The canonical name of this special page Also used as the message key for the default. | |
string | $mRestriction |
Minimum user level required to access this page, or "" for anyone. | |
Form for handling uploads and special page.
Definition at line 67 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::__construct | ( | RepoGroup | $repoGroup = null, |
UserOptionsLookup | $userOptionsLookup = null, | ||
NamespaceInfo | $nsInfo = null, | ||
WatchlistManager | $watchlistManager = null ) |
RepoGroup | null | $repoGroup | |
UserOptionsLookup | null | $userOptionsLookup | |
NamespaceInfo | null | $nsInfo | |
WatchlistManager | null | $watchlistManager |
Definition at line 84 of file SpecialUpload.php.
References MediaWiki\MainConfigNames\EnableAsyncUploads, MediaWiki\MainConfigNames\EnableAsyncUploadsByURL, MediaWiki\SpecialPage\SpecialPage\getConfig(), and MediaWiki\MediaWikiServices\getInstance().
MediaWiki\Specials\SpecialUpload::doesWrites | ( | ) |
Indicates whether this special page may perform database writes.
Reimplemented from MediaWiki\SpecialPage\SpecialPage.
Definition at line 106 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::execute | ( | $par | ) |
string | null | $par |
Reimplemented from MediaWiki\SpecialPage\SpecialPage.
Definition at line 236 of file SpecialUpload.php.
References MediaWiki\SpecialPage\SpecialPage\addHelpLink(), MediaWiki\SpecialPage\SpecialPage\checkReadOnly(), MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\Specials\SpecialUpload\loadRequest(), MediaWiki\SpecialPage\SpecialPage\outputHeader(), MediaWiki\Specials\SpecialUpload\processAsyncUpload(), MediaWiki\Specials\SpecialUpload\processUpload(), MediaWiki\SpecialPage\SpecialPage\setHeaders(), MediaWiki\Specials\SpecialUpload\showUploadForm(), MediaWiki\Specials\SpecialUpload\showUploadStatus(), MediaWiki\Specials\SpecialUpload\unsaveUploadedFile(), MediaWiki\SpecialPage\SpecialPage\useTransactionalTimeLimit(), and wfDebug().
MediaWiki\Specials\SpecialUpload::getDupeWarning | ( | $dupes | ) |
Construct a warning and a gallery from an array of duplicate files.
array | $dupes |
Definition at line 1137 of file SpecialUpload.php.
References getContext().
Referenced by MediaWiki\Specials\SpecialUpload\showUploadWarning().
|
static |
Functions for formatting warnings.
Formats a result of UploadBase::getExistsWarning as HTML This check is static and can be done pre-upload via AJAX
array | $exists | The result of UploadBase::getExistsWarning |
Definition at line 1098 of file SpecialUpload.php.
References getTitle(), and wfMessage().
Referenced by MediaWiki\Specials\SpecialUpload\showUploadWarning().
|
protected |
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.
Reimplemented from MediaWiki\SpecialPage\SpecialPage.
Definition at line 1154 of file SpecialUpload.php.
|
static |
Get the initial image page text based on a comment and optional file status information.
string | $comment | |
string | $license | |
string | $copyStatus | |
string | $source | |
Config | null | $config | Configuration object to load data from |
Definition at line 903 of file SpecialUpload.php.
References $source, MediaWiki\MainConfigNames\ForceUIMsgAsContentMsg, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\UseCopyrightUpload, wfDebug(), and wfMessage().
|
protected |
Get the page text and tags for the upload.
Definition at line 770 of file SpecialUpload.php.
References ChangeTags\canAddTagsAccompanyingChange(), getRequest(), and getUser().
|
protected |
Get an UploadForm instance with title and text properly set.
string | $message | HTML string to add to the form |
string | null | $sessionKey | Session key in case this is a stashed upload |
bool | $hideIgnoreWarning | Whether to hide "ignore warning" check box |
Definition at line 491 of file SpecialUpload.php.
References MediaWiki\Title\Title\exists(), MediaWiki\SpecialPage\SpecialPage\getContentLanguage(), MediaWiki\SpecialPage\SpecialPage\getContext(), MediaWiki\SpecialPage\SpecialPage\getHookContainer(), MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getPageTitle(), MediaWiki\Specials\SpecialUpload\getWatchCheck(), MediaWiki\SpecialPage\SpecialPage\msg(), and NS_FILE.
Referenced by MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\Specials\SpecialUpload\showRecoverableUploadError(), MediaWiki\Specials\SpecialUpload\showUploadError(), MediaWiki\Specials\SpecialUpload\showUploadStatus(), and MediaWiki\Specials\SpecialUpload\showUploadWarning().
|
protected |
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 to create a new file or update an existing one.
In the case where 'watch edits' is off but 'watch creations' is on, we'll leave the box unchecked.
Note that the page target can be changed on the form, so our check state can get out of sync.
Definition at line 964 of file SpecialUpload.php.
References getUser(), and NS_FILE.
Referenced by MediaWiki\Specials\SpecialUpload\getUploadForm().
|
protected |
Check if the current request is an async upload by url request.
Definition at line 217 of file SpecialUpload.php.
Referenced by MediaWiki\Specials\SpecialUpload\loadRequest().
|
protected |
Initialize instance variables from request and create an Upload handler.
Definition at line 162 of file SpecialUpload.php.
References MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\Specials\SpecialUpload\isAsyncUpload(), and MediaWiki\SpecialPage\SpecialPage\msg().
Referenced by MediaWiki\Specials\SpecialUpload\execute().
|
protected |
Common steps for processing uploads.
Status | $fetchFileStatus |
Definition at line 712 of file SpecialUpload.php.
References MediaWiki\SpecialPage\SpecialPage\getOutput(), and MediaWiki\Specials\SpecialUpload\showUploadError().
|
protected |
Process an asynchronous upload.
Definition at line 843 of file SpecialUpload.php.
References $job, and getUser().
Referenced by MediaWiki\Specials\SpecialUpload\execute().
|
protected |
Do the upload.
Checks are made in SpecialUpload::execute()
Definition at line 803 of file SpecialUpload.php.
References getUser().
Referenced by MediaWiki\Specials\SpecialUpload\execute().
|
protected |
Provides output to the user for a result of UploadBase::verifyUpload.
array | $details | Result of UploadBase::verifyUpload |
Definition at line 995 of file SpecialUpload.php.
References MediaWiki\MainConfigNames\FileExtensions.
Referenced by MediaWiki\Specials\SpecialUpload\showUploadStatus().
|
static |
Should we rotate images in the preview on Special:Upload.
This controls js: mw.config.get( 'wgFileCanRotate' )
Definition at line 1166 of file SpecialUpload.php.
|
protected |
Stashes the upload and shows the main upload form.
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 sensible and has passed UploadBase::verifyFile. This essentially means that UploadBase::VERIFICATION_ERROR and UploadBase::EMPTY_FILE should not be passed here.
string | $message | HTML message to be passed to mainUploadForm |
Definition at line 566 of file SpecialUpload.php.
References MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\SpecialPage\SpecialPage\msg(), and MediaWiki\Specials\SpecialUpload\showUploadForm().
|
protected |
Show the upload form with error message, but do not stash the file.
string | $message | HTML string |
Definition at line 700 of file SpecialUpload.php.
References MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\SpecialPage\msg(), and MediaWiki\Specials\SpecialUpload\showUploadForm().
Referenced by MediaWiki\Specials\SpecialUpload\performUploadChecks(), and MediaWiki\Specials\SpecialUpload\showUploadStatus().
|
protected |
Show the main upload form.
HTMLForm | string | $form | An HTMLForm instance or HTML string to show |
Definition at line 475 of file SpecialUpload.php.
References MediaWiki\SpecialPage\SpecialPage\getOutput().
Referenced by MediaWiki\Specials\SpecialUpload\execute(), MediaWiki\Specials\SpecialUpload\showRecoverableUploadError(), MediaWiki\Specials\SpecialUpload\showUploadError(), MediaWiki\Specials\SpecialUpload\showUploadStatus(), and MediaWiki\Specials\SpecialUpload\showUploadWarning().
|
protected |
Show the upload status.
User | $user | The owner of the upload |
Definition at line 314 of file SpecialUpload.php.
References MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\SpecialPage\msg(), NS_FILE, MediaWiki\Specials\SpecialUpload\processVerificationError(), MediaWiki\Specials\SpecialUpload\showUploadError(), MediaWiki\Specials\SpecialUpload\showUploadForm(), and MediaWiki\Specials\SpecialUpload\showUploadWarning().
Referenced by MediaWiki\Specials\SpecialUpload\execute().
|
protected |
Stashes the upload, shows the main form, but adds a "continue anyway button".
Also checks whether there are actually warnings to display.
array | $warnings |
Definition at line 591 of file SpecialUpload.php.
References MediaWiki\Specials\SpecialUpload\getDupeWarning(), MediaWiki\Specials\SpecialUpload\getExistsWarning(), MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), MediaWiki\Specials\SpecialUpload\getUploadForm(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\SpecialPage\SpecialPage\msg(), NS_FILE, and MediaWiki\Specials\SpecialUpload\showUploadForm().
Referenced by MediaWiki\Specials\SpecialUpload\showUploadStatus().
|
protected |
Remove a temporarily kept file stashed by saveTempUploadedFile().
Definition at line 1071 of file SpecialUpload.php.
References $success.
Referenced by MediaWiki\Specials\SpecialUpload\execute().
MediaWiki\Specials\SpecialUpload::userCanExecute | ( | User | $user | ) |
This page can be shown if uploading is enabled.
Handle permission checking elsewhere in order to be able to show custom error messages.
User | $user |
Reimplemented from MediaWiki\SpecialPage\SpecialPage.
Definition at line 229 of file SpecialUpload.php.
bool bool MediaWiki\Specials\SpecialUpload::$allowAsync |
wether uploads by url should be asynchronous or not
Definition at line 74 of file SpecialUpload.php.
string MediaWiki\Specials\SpecialUpload::$mCacheKey |
The cache key to use to retreive the status of your async upload.
Definition at line 117 of file SpecialUpload.php.
bool MediaWiki\Specials\SpecialUpload::$mCancelUpload |
The user clicked "Cancel and return to upload form" button.
Definition at line 148 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mComment |
Definition at line 130 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mCopyrightSource |
Definition at line 138 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mCopyrightStatus |
Definition at line 137 of file SpecialUpload.php.
string MediaWiki\Specials\SpecialUpload::$mDesiredDestName |
User input variables from the "description" section.
The requested target file name
Definition at line 129 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mDestWarningAck |
Hidden variables.
Definition at line 142 of file SpecialUpload.php.
bool MediaWiki\Specials\SpecialUpload::$mForReUpload |
The user followed an "overwrite this file" link.
Definition at line 145 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mIgnoreWarning |
User input variables from the root section.
Definition at line 135 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mLicense |
Definition at line 131 of file SpecialUpload.php.
LocalFile MediaWiki\Specials\SpecialUpload::$mLocalFile |
Definition at line 123 of file SpecialUpload.php.
WebRequest FauxRequest MediaWiki\Specials\SpecialUpload::$mRequest |
Misc variables.
The request this form is supposed to handle
Definition at line 113 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mSourceType |
Definition at line 114 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mTokenOk |
Definition at line 149 of file SpecialUpload.php.
UploadBase MediaWiki\Specials\SpecialUpload::$mUpload |
Definition at line 120 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mUploadClicked |
Definition at line 124 of file SpecialUpload.php.
bool MediaWiki\Specials\SpecialUpload::$mUploadSuccessful = false |
Subclasses can use this to determine whether a file was uploaded.
Definition at line 152 of file SpecialUpload.php.
MediaWiki\Specials\SpecialUpload::$mWatchthis |
Definition at line 136 of file SpecialUpload.php.
string MediaWiki\Specials\SpecialUpload::$uploadFormTextAfterSummary |
Raw html injection point for hooks not using HTMLForm.
Definition at line 157 of file SpecialUpload.php.
string MediaWiki\Specials\SpecialUpload::$uploadFormTextTop |
Raw html injection point for hooks not using HTMLForm.
Definition at line 155 of file SpecialUpload.php.