setContext( $context );
}
if ( !$linkRenderer ) {
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
}
$this->mWatch = !empty( $options['watch'] );
$this->mForReUpload = !empty( $options['forreupload'] );
$this->mSessionKey = $options['sessionkey'] ?? '';
$this->mHideIgnoreWarning = !empty( $options['hideignorewarning'] );
$this->mDestWarningAck = !empty( $options['destwarningack'] );
$this->mDestFile = $options['destfile'] ?? '';
$this->mComment = $options['description'] ?? '';
$this->mTextTop = $options['texttop'] ?? '';
$this->mTextAfterSummary = $options['textaftersummary'] ?? '';
$sourceDescriptor = $this->getSourceSection();
$descriptor = $sourceDescriptor
+ $this->getDescriptionSection()
+ $this->getOptionsSection();
$this->getHookRunner()->onUploadFormInitDescriptor( $descriptor );
parent::__construct( $descriptor, $context, 'upload' );
# Add a link to edit MediaWiki:Licenses
if ( MediaWikiServices::getInstance()
->getPermissionManager()
->userHasRight( $this->getUser(), 'editinterface' )
) {
$this->getOutput()->addModuleStyles( 'mediawiki.special' );
$licensesLink = $linkRenderer->makeKnownLink(
$this->msg( 'licenses' )->inContentLanguage()->getTitle(),
$this->msg( 'licenses-edit' )->text(),
[],
[ 'action' => 'edit' ]
);
$editLicenses = '' . $licensesLink . '
';
$this->addFooterText( $editLicenses, 'description' );
}
# Set some form properties
$this->setSubmitText( $this->msg( 'uploadbtn' )->text() );
$this->setSubmitName( 'wpUpload' );
# Used message keys: 'accesskey-upload', 'tooltip-upload'
$this->setSubmitTooltip( 'upload' );
$this->setId( 'mw-upload-form' );
# Build a list of IDs for javascript insertion
$this->mSourceIds = [];
foreach ( $sourceDescriptor as $field ) {
if ( !empty( $field['id'] ) ) {
$this->mSourceIds[] = $field['id'];
}
}
}
/**
* Get the descriptor of the fieldset that contains the file source
* selection. The section is 'source'
*
* @return array Descriptor array
*/
protected function getSourceSection() {
if ( $this->mSessionKey ) {
return [
'SessionKey' => [
'type' => 'hidden',
'default' => $this->mSessionKey,
],
'SourceType' => [
'type' => 'hidden',
'default' => 'Stash',
],
];
}
$canUploadByUrl = UploadFromUrl::isEnabled()
&& ( UploadFromUrl::isAllowed( $this->getUser() ) === true )
&& $this->getConfig()->get( 'CopyUploadsFromSpecialUpload' );
$radio = $canUploadByUrl;
$selectedSourceType = strtolower( $this->getRequest()->getText( 'wpSourceType', 'File' ) );
$descriptor = [];
if ( $this->mTextTop ) {
$descriptor['UploadFormTextTop'] = [
'type' => 'info',
'section' => 'source',
'default' => $this->mTextTop,
'raw' => true,
];
}
$this->mMaxUploadSize['file'] = min(
UploadBase::getMaxUploadSize( 'file' ),
UploadBase::getMaxPhpUploadSize()
);
$help = $this->msg( 'upload-maxfilesize',
$this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize['file'] )
)->parse();
// If the user can also upload by URL, there are 2 different file size limits.
// This extra message helps stress which limit corresponds to what.
if ( $canUploadByUrl ) {
$help .= $this->msg( 'word-separator' )->escaped();
$help .= $this->msg( 'upload_source_file' )->parse();
}
$descriptor['UploadFile'] = [
'class' => UploadSourceField::class,
'section' => 'source',
'type' => 'file',
'id' => 'wpUploadFile',
'radio-id' => 'wpSourceTypeFile',
'label-message' => 'sourcefilename',
'upload-type' => 'File',
'radio' => &$radio,
'help' => $help,
'checked' => $selectedSourceType == 'file',
];
if ( $canUploadByUrl ) {
$this->mMaxUploadSize['url'] = UploadBase::getMaxUploadSize( 'url' );
$descriptor['UploadFileURL'] = [
'class' => UploadSourceField::class,
'section' => 'source',
'id' => 'wpUploadFileURL',
'radio-id' => 'wpSourceTypeurl',
'label-message' => 'sourceurl',
'upload-type' => 'url',
'radio' => &$radio,
'help' => $this->msg( 'upload-maxfilesize',
$this->getContext()->getLanguage()->formatSize( $this->mMaxUploadSize['url'] )
)->parse() .
$this->msg( 'word-separator' )->escaped() .
$this->msg( 'upload_source_url' )->parse(),
'checked' => $selectedSourceType == 'url',
];
}
$this->getHookRunner()->onUploadFormSourceDescriptors(
$descriptor, $radio, $selectedSourceType );
$descriptor['Extensions'] = [
'type' => 'info',
'section' => 'source',
'default' => $this->getExtensionsMessage(),
'raw' => true,
];
return $descriptor;
}
/**
* Get the messages indicating which extensions are preferred and prohibitted.
*
* @return string HTML string containing the message
*/
protected function getExtensionsMessage() {
# Print a list of allowed file extensions, if so configured. We ignore
# MIME type here, it's incomprehensible to most people and too long.
$config = $this->getConfig();
if ( $config->get( 'CheckFileExtensions' ) ) {
$fileExtensions = array_unique( $config->get( 'FileExtensions' ) );
if ( $config->get( 'StrictFileExtensions' ) ) {
# Everything not permitted is banned
$extensionsList =
'' .
$this->msg( 'upload-permitted' )
->params( $this->getLanguage()->commaList( $fileExtensions ) )
->numParams( count( $fileExtensions ) )
->parseAsBlock() .
"
\n";
} else {
# We have to list both preferred and prohibited
$fileBlacklist = array_unique( $config->get( 'FileBlacklist' ) );
$extensionsList =
'' .
$this->msg( 'upload-preferred' )
->params( $this->getLanguage()->commaList( $fileExtensions ) )
->numParams( count( $fileExtensions ) )
->parseAsBlock() .
"
\n" .
'' .
$this->msg( 'upload-prohibited' )
->params( $this->getLanguage()->commaList( $fileBlacklist ) )
->numParams( count( $fileBlacklist ) )
->parseAsBlock() .
"
\n";
}
} else {
# Everything is permitted.
$extensionsList = '';
}
return $extensionsList;
}
/**
* Get the descriptor of the fieldset that contains the file description
* input. The section is 'description'
*
* @return array Descriptor array
*/
protected function getDescriptionSection() {
$config = $this->getConfig();
if ( $this->mSessionKey ) {
$stash = MediaWikiServices::getInstance()->getRepoGroup()
->getLocalRepo()->getUploadStash( $this->getUser() );
try {
$file = $stash->getFile( $this->mSessionKey );
} catch ( Exception $e ) {
$file = null;
}
if ( $file ) {
$mto = $file->transform( [ 'width' => 120 ] );
if ( $mto ) {
$this->addHeaderText(
'' .
Html::element( 'img', [
'src' => $mto->getUrl(),
'class' => 'thumbimage',
] ) . '
', 'description' );
}
}
}
$descriptor = [
'DestFile' => [
'type' => 'text',
'section' => 'description',
'id' => 'wpDestFile',
'label-message' => 'destfilename',
'size' => 60,
'default' => $this->mDestFile,
# @todo FIXME: Hack to work around poor handling of the 'default' option in HTMLForm
'nodata' => strval( $this->mDestFile ) !== '',
],
'UploadDescription' => [
'type' => 'textarea',
'section' => 'description',
'id' => 'wpUploadDescription',
'label-message' => $this->mForReUpload
? 'filereuploadsummary'
: 'fileuploadsummary',
'default' => $this->mComment,
'cols' => 80,
'rows' => 8,
]
];
if ( $this->mTextAfterSummary ) {
$descriptor['UploadFormTextAfterSummary'] = [
'type' => 'info',
'section' => 'description',
'default' => $this->mTextAfterSummary,
'raw' => true,
];
}
$descriptor += [
'EditTools' => [
'type' => 'edittools',
'section' => 'description',
'message' => 'edittools-upload',
]
];
if ( $this->mForReUpload ) {
$descriptor['DestFile']['readonly'] = true;
} else {
$descriptor['License'] = [
'type' => 'select',
'class' => Licenses::class,
'section' => 'description',
'id' => 'wpLicense',
'label-message' => 'license',
];
}
if ( $config->get( 'UseCopyrightUpload' ) ) {
$descriptor['UploadCopyStatus'] = [
'type' => 'text',
'section' => 'description',
'id' => 'wpUploadCopyStatus',
'label-message' => 'filestatus',
];
$descriptor['UploadSource'] = [
'type' => 'text',
'section' => 'description',
'id' => 'wpUploadSource',
'label-message' => 'filesource',
];
}
return $descriptor;
}
/**
* Get the descriptor of the fieldset that contains the upload options,
* such as "watch this file". The section is 'options'
*
* @return array Descriptor array
*/
protected function getOptionsSection() {
$user = $this->getUser();
if ( $user->isLoggedIn() ) {
$descriptor = [
'Watchthis' => [
'type' => 'check',
'id' => 'wpWatchthis',
'label-message' => 'watchthisupload',
'section' => 'options',
'default' => $this->mWatch,
]
];
}
if ( !$this->mHideIgnoreWarning ) {
$descriptor['IgnoreWarning'] = [
'type' => 'check',
'id' => 'wpIgnoreWarning',
'label-message' => 'ignorewarnings',
'section' => 'options',
];
}
$descriptor['DestFileWarningAck'] = [
'type' => 'hidden',
'id' => 'wpDestFileWarningAck',
'default' => $this->mDestWarningAck ? '1' : '',
];
if ( $this->mForReUpload ) {
$descriptor['ForReUpload'] = [
'type' => 'hidden',
'id' => 'wpForReUpload',
'default' => '1',
];
}
return $descriptor;
}
/**
* Add the upload JS and show the form.
* @return bool|Status
*/
public function show() {
$this->addUploadJS();
return parent::show();
}
/**
* Add upload JS to the OutputPage
*/
protected function addUploadJS() {
$config = $this->getConfig();
$this->mMaxUploadSize['*'] = UploadBase::getMaxUploadSize();
$scriptVars = [
'wgAjaxUploadDestCheck' => $config->get( 'AjaxUploadDestCheck' ),
'wgAjaxLicensePreview' => $config->get( 'AjaxLicensePreview' ),
'wgUploadAutoFill' => !$this->mForReUpload &&
// If we received mDestFile from the request, don't autofill
// the wpDestFile textbox
$this->mDestFile === '',
'wgUploadSourceIds' => $this->mSourceIds,
'wgCheckFileExtensions' => $config->get( 'CheckFileExtensions' ),
'wgStrictFileExtensions' => $config->get( 'StrictFileExtensions' ),
'wgFileExtensions' => array_values( array_unique( $config->get( 'FileExtensions' ) ) ),
'wgCapitalizeUploads' => MediaWikiServices::getInstance()->getNamespaceInfo()->
isCapitalized( NS_FILE ),
'wgMaxUploadSize' => $this->mMaxUploadSize,
'wgFileCanRotate' => SpecialUpload::rotationEnabled(),
];
$out = $this->getOutput();
$out->addJsConfigVars( $scriptVars );
$out->addModules( [
'mediawiki.special.upload', // Extras for thumbnail and license preview.
] );
}
/**
* Empty function; submission is handled elsewhere.
*
* @return bool False
*/
public function trySubmit() {
return false;
}
}