User:XXN/massrename.js

From Wikimedia Commons, the free media repository
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.
// Simple script for renaming pages
// Adapted/inspired from Plastikspork's mass-move tool, Animum's mass-delete tool and Timotheus Canens's mass-edit tool
// Works with two parallel pair lists of page titles (source & target), including namespace prefix (if needed)
/*
// Installation. 
// Add the following line to your custom JavaScript (e.g. [[Special:MyPage/common.js]]):
mw.loader.load('//commons.wikimedia.org/w/index.php?title=User:XXN/massrename.js&action=raw&ctype=text/javascript');
// Once installed, go to [[Special:Massmove]] or [[Special:Massrename]]
*/
mw.loader.using(['mediawiki.api.edit', 'mediawiki.Title'], function () {
	"use strict";

	var config = mw.config.get(['wgNamespaceNumber', 'wgTitle', 'wgUserGroups', 'skin']);

	function removeBlanks(arr) {
		var ret = [];
		var i, len;
		for (i = 0, len = arr.length; i < len; i++) {
			var s = arr[i];
			s = s.trim();
			if (s) {
				ret.push(s);
			}
		}
		return ret;
	}

	function doMassMove() {
		var articles = document.getElementById("wpMassMovePages").value.split("\n");
		articles = removeBlanks(articles);
		if (!articles.length) {
			return;
		}
		var targets = document.getElementById("wpMassMoveText2").value.split("\n");
		targets = removeBlanks(targets);
		if (!targets.length) {
			return;
		}
		var
			api = new mw.Api(),
			wpMassMoveReason = document.getElementById("wpMassMoveReason").value,
			wpMassMoveWatch = document.getElementById("wpMassMoveWatch").value,
			wpMassMoveNoRedirect = document.getElementById("wpMassMoveNoRedirect").checked,
			wpMassMoveMoveTalk = document.getElementById("wpMassMoveMoveTalk").checked,
			moved = 0,
			failed = [],
			error = [],
			deferreds = [],
			onSuccess = function () {
				moved++;
				document.getElementById("wpMassMoveSubmit").value = "(" + moved + ")";
			};

		function makeMoveFunc(article, target) {
			return function () {
				return $.Deferred(function (deferred) {
					var options = {
						format: 'json',
						action: 'move',
						watchlist: wpMassMoveWatch,
						from: article,
						to: target,
						reason: wpMassMoveReason
					};
					if (wpMassMoveNoRedirect) {
						options.noredirect = '';
					}
					if (wpMassMoveMoveTalk) {
						options.movetalk = '';
					}
					var promise = api.postWithToken('move', options);
					promise.done(onSuccess);
					promise.fail(function (code, obj) {
						failed.push(article);
						error.push(obj.error.info);
					});
					promise.always(function () {
						deferred.resolve();
					});
				});
			};
		}

		// Make a chain of deferred objects. We chain them rather than execute them in
		// parallel so that we don't make 1000 simultaneous move requests and bring the
		// site down. We use deferred objects rather than the promise objects returned
		// from the API request so that the chain continues even if some articles gave errors.
		var deferred = makeMoveFunc(articles[0], targets[0])();
		for (var i = 1, len = articles.length, len2 = targets.length; i < len && i < len2; i++) {
			deferred = deferred.then(makeMoveFunc(articles[i], targets[i]));
		}

		// Show the output and do cleanup once all the requests are done.
		$.when(deferred).then(function () {
			document.getElementById("wpMassMoveSubmit").value = "Done (" + moved + ")";
			if (failed.length) {
				var $failedList = $('<ul>');
				for(var x = 0; x < failed.length; x++) {
					// Link the titles in the "failed" array
					var failedTitle = mw.Title.newFromText(failed[x]);
					var $failedItem = $('<li>');
					if (failedTitle) {
						$failedItem.append( $('<a>')
							.attr('href', failedTitle.getUrl())
							.text(failed[x])
						);
					} else {
						$failedItem.text(failed[x]);
					}
					$failedItem.append(document.createTextNode(': ' + error[x]));
					$failedList.append($failedItem);
				}
				$('#wpMassMoveFailedContainer')
					.append($('<br />'))
					.append($('<b>')
						.text('Failed moves:')
					)
					.append($failedList);
			}
		});
	}
 
	function massMoveForm() {
		var bodyContent = (config.skin == "cologneblue" ? "article" : "bodyContent");
		document.getElementsByTagName("h1")[0].textContent = "XXN's mass-rename tool";
		document.title = "XXN's mass-rename tool for Wikimedia projects";
		document.getElementById(bodyContent).innerHTML = '<br /><br />' +
			'<form id="wpMassMove" name="wpMassMove">' +
			'<b><big>If you abuse this tool, it\'s <i>your</i> fault, not mine.</big></b><br /><br />' +
			'<b>Each line from first text area is a source page title and corresponds to a line in the second text area which is a target page title.</b>' +
			'<div id="wpMassMoveFailedContainer"></div>' +
			'<br /><br />' +
				'Pages to rename (<u>one on each line</u>, please!):<br />' +
					'<textarea tabindex="1" name="wpMassMovePages" id="wpMassMovePages" rows="10" cols="80"></textarea>' +
                'Target titles (also <u>by one on each line</u>!):<br />' +
                    '<textarea tabindex="2" name="wpMassMoveText2" id="wpMassMoveText2" rows="10" cols="80"></textarea>' +
				'<br /><br /><table style="background-color:transparent">' +
				'<tr><td>Move talk:</td>' +
					'<td><input type="checkbox" checked="checked" id="wpMassMoveMoveTalk" name="wpMassMoveMoveTalk"/></td></tr>' +
				'<tr><td>No redirect:</td>' +
					'<td><input type="checkbox" id="wpMassMoveNoRedirect" name="wpMassMoveNoRedirect"/></td></tr>' +
				'<tr><td>Watch Pages:</td>' +
						'<td><select id="wpMassMoveWatch">' +
							'<option value="nochange">No change</option>' +
							'<option value="preferences">User preferences</option>' +
							'<option value="watch">Add to watchlist</option>' +
							'<option value="unwatch">Remove from watchlist</option>' +
						'</select></td></tr>' +
				'<tr><td>Edit summary:</td>' +
					'<td><input type="text" id="wpMassMoveReason" name="wpMassMoveReason" maxlength="255" /></td></tr>' +
					'<tr><td><input type="button" id="wpMassMoveSubmit" name="wpMassMoveSubmit" value="Move" /></td>' +
			'</form>';
		document.getElementById("wpMassMoveSubmit").addEventListener("click", function (e) {
			doMassMove();
		});
	}
	 
	if (config.wgNamespaceNumber == -1 &&
		(config.wgTitle.toLowerCase() == "massmove" || config.wgTitle.toLowerCase() == "massrename")/* &&
		/autoconfirmed/.test(config.wgUserGroups)*/
	) {
		massMoveForm();
	}

});