Extension:UploadWizard

MediaWiki extensions manual

UploadWizard Release status: stable
Implementation	Media, Special page
Description	Multi-file, step-by-step upload wizard
Author(s)	Neil Kandalgaonkar, Jeroen De Dauw, Mark Holmquist, Ryan Kaldari, Ankur Anand, Yuvi Panda, Michael Dale,
Latest version	continuous updates
MediaWiki	>= 1.43
Database changes	Yes
Tables	uw_campaigns
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review README
Namespace Campaign
Parameters $wgUploadWizardConfig
Added rights upwizcampaigns mass-upload
Hooks used ArticleDeleteComplete BeforePageDisplay ChangeTagsAllowedAdd ChangeTagsListActive CodeEditorGetPageLanguage ContentModelCanBeUsedOn EditFilterMergedContent GetPreferences IsUploadAllowedFromUrl LinksUpdateComplete ListDefinedTags LoadExtensionSchemaUpdates PageMoveComplete PageSaveComplete PreferencesGetIcon
Quarterly downloads	140 (Ranked 42nd)
Translate the UploadWizard extension if it is available at translatewiki.net
Vagrant role	uploadwizard
Issues	Open tasks · Report a bug

The UploadWizard extension allows a user to upload multiple files with a step-by-step JavaScript wizard via the page "Special:UploadWizard".

See also: Upload Wizard description page on Wikimedia Commons

Installation

Enabling uploads and thumbnails

Your MediaWiki will need to be capable of hosting media files and creating thumbnails (smaller previews of media files). If you can upload images and see smaller previews on their File page, you're already ready. If not, for full instructions, see Manual:Image administration , particularly image thumbnailing.

For GNU/Linux or macOS users

• Make sure that the images directory is writable by your web server.
• Install the ImageMagick libraries and binaries.
• Download and extract the UploadWizard files as specified here: Special:ExtensionDistributor/UploadWizard
• Add the following configuration to your LocalSettings.php :

$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = <path to your convert command>;  # Only needs to be set if different from /usr/bin/convert

wfLoadExtension( 'UploadWizard' );

You should also install the EventLogging extension. This is used only if you use the campaigns feature, and should be made a soft dependency at some point in the future.

If you use Internet Explorer, you'll also need to change the following core configuration variable. See phab:T41877:

$wgApiFrameOptions = 'SAMEORIGIN';

Enabling Flickr uploads

You can also use UploadWizard to transfer files directly from Flickr. To enable this option, first you'll need to get an API key from Flickr:

1. Log in to Flickr;
2. Go to the Apps By You page in the Flickr App Garden;
3. Click on 'Get another key';
4. Choose 'Apply for a non-commercial key';
5. Enter a name and a description and check the two waiver checkboxes before submitting.

Once you have a key, append the following to your LocalSettings.php:

$wgAllowCopyUploads = true;
$wgGroupPermissions['user']['upload_by_url'] = true;
$wgCopyUploadsDomains = ['*.flickr.com', '*.staticflickr.com'];
$wgUploadWizardConfig['flickrApiKey'] = 'YOUR_FLICKR_KEY_HERE';

Other configuration

• You need to have InstantCommons enabled in order to access the licensing tutorial. To enable InstantCommons add

  $wgUseInstantCommons = true;
  

  to LocalSettings.php.
• You may want to set

  $wgUploadNavigationUrl = '/wiki/Special:UploadWizard';
  

  in LocalSettings.php, where /wiki/ is the correct path for your wiki. A more general way of doing this that works for whatever path configuration you have, but that requires PHP 5.3 or later is:

$wgExtensionFunctions[] = function() {
	$GLOBALS['wgUploadNavigationUrl'] = SpecialPage::getTitleFor( 'UploadWizard' )->getLocalURL();
	return true;
};

This modifies the sidebar's "Upload file" link - probably in other places as well. More at Manual:$wgUploadNavigationUrl .

Several other options are available through a configuration array. For example:

$wgUploadWizardConfig = [
	'debug' => false,
	'autoAdd' => [
	 	'wikitext' => [
			'This file was uploaded with the UploadWizard extension.'
			],
	 	'categories' => [
	 		 'Uploaded with UploadWizard'	
	 		 ],
		], // Should be localised to the language of your wiki instance
	'feedbackPage' => 'Feedback about UploadWizard',
	'altUploadForm' => 'Special:Upload',
	'feedbackLink' => false, // Disable the link for feedback (default: points to Commons)
	'alternativeUploadToolsPage' => false, // Disable the link to alternative upload tools (default: points to Commons)
	'enableFormData' => true, // Enable FileAPI uploads be used on supported browsers
	'enableMultipleFiles' => true,
	'enableMultiFileSelect' => false,
	'uwLanguages' => [
		'ar' => 'العربية',
		'de' => 'Deutsch',
		'en' => 'English'
		], // Selectable languages for file descriptions - defaults to 'en'
	'tutorial' => [
	 	'skip' => true
		], // Skip the tutorial
	'maxUploads' => 15, // Number of uploads with one form - defaults to 50
	'fileExtensions' => $wgFileExtensions // omitting this may cause errors
	];

Usage in license-free environments

If you are installing UploadWizard in an environment where licenses are not used, you may want to add the configuration below to LocalSettings.php. This will limit the license choices to a single default that references the wiki's generic disclaimer. Note that there are many other configuration settings to add depending on your use case.

$wgUploadWizardConfig = [
	'licensing' => [
		'ownWorkDefault' => 'own',
		'ownWork' => [
			'type' => 'or',
			'template' => 'licensing', // this adds a link to Template:Licensing to the file info page
			'licenses' => [
				'generic',
			],
		],
	],
];

These are just some sample settings. See the UploadWizard.config.php file (starting around line 80) for many more options supported in the $wgUploadWizardConfig array.

Modifying the generic UI messages

If you wish to modify the generic messages, you can do so within the wiki itself editing the following pages:

• MediaWiki:Mwe-upwiz-source-ownwork
• MediaWiki:Mwe-upwiz-source-ownwork-assert-generic
• MediaWiki:Mwe-upwiz-source-ownwork-generic-explain

Modifying file pages created by Upload Wizard

To modify the wikitext of file pages created by UploadWizard, add a hook to LocalSettings.php that fires on every page save, then check if the page has the structure of a page created by UploadWizard, and modify it to your liking. For example:

$wgHooks['ParserPreSaveTransformComplete'][] = function ( Parser $parser, string &$text ) {
	if ( preg_match( '/=={{int:filedesc}}==
{{Information
\|description=(.*)
\|date=(.*)
\|source=(.*)
\|author=(.*)
\|permission=(.*)
\|other versions=(.*)
}}

=={{int:license-header}}==
{{(.*)}}
*(.*)/', $text, $matches ) ) {

		// Get data
		$description = $matches[1];
		$date = $matches[2];
		$source = $matches[3];
		$author = $matches[4];
		$permission = $matches[5];
		$otherVersions = $matches[6];
		$license = $matches[7];
		$licenseDetails = $matches[8];

		// Process data
		if ( $source === '{{own}}' ) {
			$source = 'Own work';
		}
		if ( preg_match( '/\[\[([^|]+)\|[^]]+\]\]/', $author, $matches ) ) {
			$author = $matches[1]; // Unlink the author
		}
		if ( $licenseDetails ) {
			$license = $licenseDetails;
		}

		// Build wikitext
		$text = "$description

{{File data
| date = $date
| author = $author
| source = $source
| license = $license
}}";
	}
};

Usage

URL arguments

There are several URL arguments that can be specified to alter the behaviour of the UploadWizard:

• campaign - Specifies which upload campaign to use.
• caption - Sets the initial value for the caption field (structural data). Note that by default this will be copied to the description.
• captionlang - Sets the language of the first caption field.
• description - Sets the initial value for the description field. Note that setting the description will disable copying the caption to the description.
• descriptionlang - Sets the language of the first description field.
• lat - Sets the initial value for the latitude field.
• lon - Sets the initial value for the longitude field.
• alt - Sets the initial value for the altitude field.
• categories - Sets the initial value for the categories field, multiple categories separated by |.
• fields[] - The initial values of additional fields defined by a campaign. Values of multiple fields must be passed in the exact same order as defined in the campaign.

(e.g. fields[]=value_first&fields[]=value_second)

• objref - Specifies an object reference that can be used to update a page with a thumbnail of an uploaded image. See #Object references for further details.
• updateList - Specifies whether a list page should be updated at all. This parameter only works in combination with objref. See #Object references for further details.

These arguments can be specified as follows: if you have an argument named campaign and want to provide the value foobar, then append campaign=foobar to the url. For example wiki/Special:UploadWizard?campaign=foobar or w/index.php?title=Special:UploadWizard&campaign=foobar.

The following URL arguments are still supported for existing URLs, but deprecated:

• id: If specified, this value is used instead of the first fields[] value. Please use fields[] instead.
• id2: If specified, this value is used instead of the second fields[] value. Please use fields[] instead.

Object references

Upload Wizard provides a way to store “object references” - references to list templates in Wiki pages - in the file description page. These may be used by bots to insert a thumbnail image into a list page. A bot that is doing this for monument lists of German Wikipedia is running on tool labs. Its code is hosted on GitHub. Though its purpose is to update monument lists on Wikipedia it can be adopted to serve in different scenarios.

This feature uses the parameters objref and updateList. If both parameters are passed, the Upload Wizard shows a checkbox for each upload, which can be used to select the image that the object reference is added to. If the parameter updateList is omitted, the checkboxes will be disabled and an additional notice is being displayed stating that an image for the object already exists in the list.

• objref - Specifies an object reference that can be used to update a page with a thumbnail of an uploaded image. Passing this parameter is expected in the following format objref=prefix|page_title|object_id
  • prefix - Interwiki or interlanguage prefix as defined per Special:Interwiki. The prefix must be defined in order to make this work.
  • page_title - The title of the page the object is listed on.
  • object_id - A unique identifier of the object for a bot to update
• updateList: Specifies whether a list page should be updated at all. Set to any value, this parameter enables a checkbox

Testing

If you're testing UploadWizard for whatever reason, and you've run out of "real" images to upload as test cases, you can always use the handy MediaWiki utility for creating test images. Open a terminal emulator, get into a directory where you want to store a bunch of test JPG files, and run

$ php path/to/mediawiki/tests/phpunit/includes/api/generateRandomImages.php

Here's a Bash script that should make it easier to do all of this without much trouble. It's a good idea to put this in your PATH and/or make a handy shortcut to it somewhere that will make it trivial to update your images with new ones.

#!/bin/bash

# Declare some paths (easier to configure)
PICPATH=/path/to/image/directory
MW_INSTALL_PATH=/path/to/mediawiki

# Get to the pic path, and remove old test images
cd $PICPATH
rm *.jpg

# Run the generate script three times to give us a bunch of images
php $MW_INSTALL_PATH/tests/phpunit/includes/api/generateRandomImages.php
php $MW_INSTALL_PATH/tests/phpunit/includes/api/generateRandomImages.php
php $MW_INSTALL_PATH/tests/phpunit/includes/api/generateRandomImages.php

Templates

Warning:

This list is not complete and more templates are required, otherwise you will end with SCRIPT error or other error messages not in English!

Upload Wizard will insert a few templates into generated file description pages, which need to exist on the wiki in order for the description pages to be rendered correctly. The templates used include:

• the Template:Information (you could use mediawiki's export tool to import this template into your own installation of mediawiki)
• Description language identifiers like the "En" template, if none are defined, then only {{en}} is used.
• the Location template for geocoordinates
• Various licensing tags (which are configurable )
• (Optionally) a template to indicate that a file is uncategorized

See also

• How do I add custom license to Extension:UploadWizard?
  • Above but for the messages only (Miraheze's Issue Tracker)
• Campaigns documentation
• Developer documentation
• Extension:UploadWizard/Error behavior
• Extension:EnhancedUpload – a new special page for multi-upload and improves drag-and-drop upload in VisualEditor
• Wikimedia ops notes
• Commons:Upload Wizard – the Upload Wizard info page in Wikimedia Commons
• Extension:MediaUploader – Flexible, multi-file, step-by-step uploader for third party users which was forked from UploadWizard
• Extension:MsUpload
• User:Drecodeam/GSoC 2012 Application - Ankur Anand's work on Flickr & geolocation integration

Related specs

• Custom WikiText License Feature
• Location - entering gps coordinates / deriving them from EXIF