Extension:ImportFreeImages

MediaWiki extensions manual
ImportFreeImages
Release status: stable
Implementation Special page
Description Allows users to import properly licensed photos directly into their wiki from Flickr.
Author(s) Travis Derouin
Bryan Tong Minh
Latest version 2.2 (2019-01-24)
MediaWiki 1.41+
License GNU General Public License 2.0 or later
Download
  • $wgIFI_CreditsTemplate
  • $wgIFI_FlickrSearchBy
  • $wgIFI_GetOriginal
  • $wgIFI_PromptForFilename
  • $wgIFI_ResultsPerRow
  • $wgIFI_ThumbType
  • $wgIFI_AppendRandomNumber
  • $wgIFI_FlickrSort
  • $wgIFI_phpFlickr
  • $wgIFI_FlickrLicense
  • $wgIFI_ResultsPerPage
  • $wgIFI_FlickrAPIKey
Quarterly downloads 5 (Ranked 129th)
Translate the ImportFreeImages extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The ImportFreeImages extension allows users to import properly licensed photos directly into their wiki from Flickr.

Pre-requisites

edit

Your PHP configuration must have set allow_url_fopen to On.

Configuration & Installation

edit
  • Download and move the extracted ImportFreeImages folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ImportFreeImages
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ImportFreeImages' );
    
  • You have to have already set up uploads to work properly on your wiki.
  • You may have to manually create the $wgTmpDirectory
  • Download and install phpflickr 2.2 and put it in the directory extensions/ImportFreeImages (so you should have a directory wiki/extensions/ImportFreeImages/phpFlickr-2.2.0).
  • Get yourself an API Key from here and set $wgIFI_FlickrAPIKey to this key in ImportFreeImages.php.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Options

edit
  • Configure $wgIFI_CreditsTemplate to point to a (possible set of) template that takes the Flickr user id, user display name and photo id as parameter. Example:
This photography was imported from flickr. 
This photo was originally taken by [http://www.flickr.com/people/{{{2}}} {{{3}}}] 
and the original photo can be found here: http://www.flickr.com/photos/{{{2}}}/{{{1}}}

This file is licensed under [http://creativecommons.org/licenses/by/2.0/ Creative Commons Attribution 2.0 license].

The license id of the imported image will be appended to the $wgIFI_CreditsTemplate name. So if you are using 'flickr', create a template 'flickr4' for the photos that are imported with the license id 4. See here for all possible license ids.

  • Configure $wgIFI_ResultsPerPage and $wgIFI_ResultsPerRow if you desire.
  • Change which license photos are searched by changing $wgIFI_FlickrLicense, by default it's '4', which is CC Attribution License. Multiple licenses are searchable by using a comma-delimited list (such as '4,5'). See more info here.
  • Change how the results are sorted by altering $wgIFI_FlickrSort, see more here.
  • Change $wgIFI_GetOriginal to true if you want the tool to import the 'original' (or 'large' if original doesn't exist) version of the image, which is most likely the largest version of the image. Otherwise, the 'medium' version by default will be imported.
  • Change $wgIFI_PromptForFilename to true to prompt the user for a destination filename for the photo (using a JavaScript prompt), use false if you'd prefer just to use the title of the photo as the filename.
  • $wgIFI_FlickrSearchBy can specify whether to search by text or tags. See here for more information on this.
  • $wgIFI_AppendRandomNumber - appends a random to the filename to avoid overwriting existing files. (e.g. specifying a desination filename of Punk may store the file at Punk-1934.jpg)

Bugs and enhancements

edit

Bugs or feature requests can be submitted via Phabricator.

Other ideas offering radio buttons and checkboxes to allow users to customize which licenses are searched and how the results are sorted. Other API sources could be added to complement the flickr functionality.

Notes

edit