User:Psubhashish/inat2commons.js
Jump to navigation
Jump to search
Note: After saving, you have to bypass your browser's cache to see the changes. Internet Explorer: press Ctrl-F5, Mozilla: hold down Shift while clicking Reload (or press Ctrl-Shift-R), Opera/Konqueror: press F5, Safari: hold down Shift + Alt while clicking Reload, Chrome: hold down Shift while clicking Reload.
 |
Documentation for this user script can be added at User:Psubhashish/inat2commons. |
- Report page listing warnings and errors.
// This script adds a new "iNaturalist Import" button to taxon categories or gallery
// pages (whichever one is associated with the Wikidata item for the taxon).
//<nowiki>
// Make sure we are on a Category page and in view mode.
if ( ( mw.config.get( 'wgNamespaceNumber' ) === 0 || mw.config.get( 'wgNamespaceNumber' ) === 14 ) && mw.config.get( 'wgAction' ) === 'view' ) {
// Move this out when converting to gadget
importStylesheet( 'User:Kaldari/inat2commons.css' );
// Initialize global iNaturalist ID variable
iNatId = null;
// Script depends on jQuery UI dialog and jQuery UI selectable modules
mw.loader.using( ['mediawiki.user', 'mediawiki.api', 'mediawiki.ForeignApi', 'jquery.ui'], function() {
// Construct object (to prevent namespace conflicts)
inat2commons = {
uploadData: {},
displayProgress: function( message ) {
$( '#import-dialog div' ).remove(); // remove everything else from the dialog box
$( '#import-dialog' ).append ( $( '<div class="import-progress" style="text-align:center;margin:1.8em 0;"></div>' ).html( message+'<br/><br/><img src="//upload.wikimedia.org/wikipedia/commons/4/42/Loading.gif" />' ) );
},
displayMessage: function( message ) {
$( '#import-dialog div' ).remove(); // remove everything else from the dialog box
$( '#import-dialog' ).append ( $( '<div class="import-message"></div>' ).html( message ) );
},
displayError: function( error ) {
$( '#import-dialog div' ).remove(); // remove everything else from the dialog box
$( '#import-dialog' ).append ( $( '<div class="import-error" style="color:#990000;"></div>' ).html( 'Error: '+error ) );
},
launchPreview: function( uploadParams ) {
var imageExtension = uploadParams.thumbUrl.split('.').pop();
$previewInterface = $( '<div></div>', {
id: "preview-dialog",
style: "position: relative; text-align: center; min-height: 500px;",
html: "<p><img src='https://static.inaturalist.org/photos/" + uploadParams.photoId + "/medium." + imageExtension + "' /><\p>"
} )
.dialog({
width: 600,
autoOpen: false,
title: 'Preview',
modal: false,
position: { my: "top", at: "top+150", of: "body" },
buttons: [
{
text: "Upload image",
classes: "inaturalist-upload-button",
click: function() {
$previewInterface.dialog( 'close' );
inat2commons.launchUpload( uploadParams );
}
}
]
});
$previewInterface.dialog( 'open' );
},
launchUpload: function( uploadParams ) {
inat2commons.displayProgress( 'Loading upload form...' );
var href = '';
var uploadPage = 'https://commons.wikimedia.org/wiki/Special:Upload';
var license = '';
var description = '';
var author = '';
if ( uploadParams.taxonRank === 'species' || uploadParams.taxonRank === 'subspecies' ) {
if ( uploadParams.commonName !== undefined ) {
description = uploadParams.commonName + " (''" + uploadParams.taxon + "'')";
} else {
description = "''" + uploadParams.taxon + "''";
}
} else {
description = uploadParams.taxon;
}
var ext = uploadParams.thumbUrl.split( '?' )[0].split('.').slice( -1 );
var targetName = `${uploadParams.taxon} ${uploadParams.photoId}.jpg`;
var original = `https://static.inaturalist.org/photos/${uploadParams.photoId}/original.${ext}`;
if ( uploadParams.userName ) {
author = uploadParams.userName;
} else {
author = uploadParams.userLogin;
}
var summary = `{{Information
|description={{en|${description}}}
|date=${uploadParams.date}
|source=https://www.inaturalist.org/photos/${uploadParams.photoId}
|author=[https://www.inaturalist.org/users/${uploadParams.userId} ${author}]
|permission=
|other versions=
}}
{{inaturalist|${uploadParams.observationId}}}
[[Category:${uploadParams.category}]]
[[Category:Uploaded with iNaturalist2Commons]]
`;
switch ( uploadParams.photoLicense ) {
case 'cc-by':
license = 'cc-by-4.0';
break;
case 'cc-by-sa':
license = 'cc-by-sa-4.0';
break;
case 'cc0':
license = 'Cc-zero';
break;
default:
return '';
}
window.location.href = `${uploadPage}?wpUploadDescription=${encodeURIComponent(summary)}&wpLicense=${license}&wpDestFile=${targetName}&wpSourceType=url&wpUploadFileURL=${original}`;
},
launchDialog: function() {
var iNatApi = 'https://api.inaturalist.org/v1/observations';
var params = { 'photo_license': 'cc0,cc-by,cc-by-sa', 'quality_grade': 'research', 'taxon_id': iNatId, 'per_page': '80' };
// Restore dialog to original state
inat2commons.displayProgress( 'Loading images...');
// Open the dialog box
$importInterface.dialog( 'open' );
// Retrieve images
$.getJSON( iNatApi, params )
.done( function( data ) {
if ( data.results[0] === undefined ) {
inat2commons.displayMessage( 'No free license images were found for this taxon.');
} else {
var headerAdded = false;
var maxImages = 80;
var x = 0;
// Go through each observation
data.results.forEach( function( observation ) {
// Go through each photo
observation.photos.forEach( function( photoData ) {
var licenseCode = photoData.license_code;
// If the license is compatible, display the photo
if ( ( licenseCode === 'cc-by' || licenseCode === 'cc-by-sa' || licenseCode === 'cc0' ) && x < maxImages ) {
// Create dialog header once we know there is at least one free-license image
if ( headerAdded === false ) {
$( '#import-dialog div' ).remove();
$( '#import-dialog' ).append( $( '<div id="import-images"></div>' ).html( 'Select an image to preview:<br/>' ).append ( $( '<ol></ol>' ) ) );
headerAdded = true;
}
var uploadParams = {
photoId: photoData.id,
photoLicense: photoData.license_code,
userId: observation.user.id,
userName: observation.user.name,
userLogin: observation.user.login,
observationId: observation.id,
date: observation.observed_on,
taxon: observation.taxon.name,
taxonRank: observation.taxon.rank,
thumbUrl: photoData.url,
category: mw.config.get( 'wgTitle' )
};
if ( observation.taxon.preferred_common_name !== undefined ) {
uploadParams.commonName = observation.taxon.preferred_common_name;
}
$( '#import-dialog ol' ).append ( $( '<li></li>' )
.html( '<img data-photo-id="' + photoData.id + '" src="' + photoData.url + '" height="75" width="75"/>' )
.on( 'click', function() {
inat2commons.launchPreview( uploadParams );
} )
);
x++;
}
} );
} );
// After going through all the observations, if there are no free-license images, display error
if ( headerAdded === false ) {
inat2commons.displayMessage( 'No free license images were found for this taxon.');
}
}
} )
.fail( function() {
inat2commons.displayError( 'Loading images failed. If you are using a privacy plug-in like Privacy Badger, you may need to adjust your settings.' );
} );
},
initialize: function() {
// Define importing interface
$importInterface = $('<div id="import-dialog" style="position:relative;"></div>')
.dialog({
width: 724,
autoOpen: false,
title: 'Import images from iNaturalist',
modal: true,
position: { my: "top", at: "top+100", of: "body" },
});
// Define the import button
$button = $( '<button>' )
.attr( 'style', 'margin: 0 0.5em 0.5em 0.5em; text-decoration: none; font-size: 15px;' )
.append(
$( '<span>' )
.attr( 'id', 'inat2commons-buttontextwrapper' )
.append( $( '<span>' )
.attr( 'id', 'inat2commons-buttontext' )
.text( 'iNaturalist import' ) )
)
.on( 'click', function () {
inat2commons.launchDialog();
return false;
} )
.button();
$( document ).ready( function() {
var pageName = mw.config.get( 'wgPageName' );
var wikidataId = mw.config.get( 'wgWikibaseItemId' );
var wikidataApi = new mw.ForeignApi('//www.wikidata.org/w/api.php');
var params = { 'action': 'wbgetentities', 'props': 'claims' };
mw.user.getRights().then( function ( rights ) {
// Make sure the user has the 'upload_by_url' right
if ( rights.indexOf( 'upload_by_url' ) > -1 ) {
// Make sure the Wikidata ID is known
if ( typeof wikidataId !== "undefined" ) {
params.ids = wikidataId;
// Make API call to Wikidata
wikidataApi.get( params ).done( function ( data ) {
if ( data.entities[wikidataId].claims.P3151 !== undefined && data.entities[wikidataId].claims.P3151[0].mainsnak.datavalue.value !== undefined ) {
// Get the iNaturalist ID (P3151)
iNatId = data.entities[wikidataId].claims.P3151[0].mainsnak.datavalue.value;
// Insert import button into page interface
$( '#firstHeading' ).append( $button );
} else {
// Try getting the data associated with the main namespace page of the same title
params.sites = 'commonswiki';
params.titles = mw.config.get( 'wgTitle' );
delete params.ids;
// Make API call to Wikidata
wikidataApi.get( params ).done( function ( data2 ) {
// Get the Wikidata item ID
wikidataId = Object.keys( data2.entities )[0];
// Wikidata returns "-1" for undefined
if ( wikidataId !== "-1" && data2.entities[wikidataId].claims.P3151 !== undefined && data2.entities[wikidataId].claims.P3151[0].mainsnak.datavalue.value !== undefined ) {
// Get the iNaturalist ID (P3151)
iNatId = data2.entities[wikidataId].claims.P3151[0].mainsnak.datavalue.value;
// Insert import button into page interface
$( '#firstHeading' ).append( $button );
} else {
// Last resort: Try getting the data associated with the English Wikipedia article
params.sites = 'enwiki';
wikidataApi.get( params ).done( function ( data3 ) {
wikidataId = Object.keys( data3.entities )[0];
if ( wikidataId !== "-1" && data3.entities[wikidataId].claims.P3151 !== undefined && data3.entities[wikidataId].claims.P3151[0].mainsnak.datavalue.value !== undefined ) {
// Get the iNaturalist ID (P3151)
iNatId = data3.entities[wikidataId].claims.P3151[0].mainsnak.datavalue.value;
// Insert import button into page interface
$( '#firstHeading' ).append( $button );
}
});
}
});
}
});
}
}
} );
});
} // close initialize function
} // close inat2commons object
inat2commons.initialize();
}) // close mw.loader
} // close if
//</nowiki>