मीडियाविकि:Gadget-morebits.js: रिवीजन सभ के बीचा में अंतर

Content deleted Content added
updated per enwikipedia
 
लाइन 1:
// <nowiki>
/**
* morebits.js
* ===========
* A library full of lots of goodness for user scripts on MediaWiki wikis, including Wikipedia.
*
* The highlights include:
* - -{@link Morebits.quickForm classwiki.api} - generatesmake quickcalls HTMLto formsthe on theMediaWiki flyAPI
* - {@link Morebits.wiki.api classpage} - makesmodify callspages toon the MediaWikiwiki API(edit, revert, delete, etc.)
* - -{@link Morebits.wiki.page classdate} - modifiesenhanced pagesdate onobject theprocessing, wikisort (edit,of revert,a delete,light etcmoment.)js
* - -{@link Morebits.wikitext classquickForm} - containsgenerate somequick utilitiesHTML forforms dealingon withthe wikitextfly
* - -{@link Morebits.status classsimpleWindow} - a rough-and-readywrapper statusfor messagejQuery displayer,UI usedDialog bywith thea Morebits.wikicustom look and extra classesfeatures
* - -{@link Morebits.simpleWindow classstatus} - a wrapperrough-and-ready forstatus jQuerymessage UIdisplayer, Dialogused withby athe custom look and extraMorebits.wiki featuresclasses
* - {@link Morebits.wikitext} - utilities for dealing with wikitext
* - {@link Morebits.string} - utilities for manipulating strings
* - {@link Morebits.array} - utilities for manipulating arrays
* - {@link Morebits.ip} - utilities to help process IP addresses
*
* Dependencies:
* - The whole thing relies on jQuery. But most wikis should provide this by default.
* - {@link Morebits.quickForm}, {@link Morebits.simpleWindow}, and {@link Morebits.status} rely on the "morebits.css" file for their styling.
* - {@link Morebits.simpleWindow} and {@link Morebits.quickForm} tooltips reliesrely on jqueryjQuery UI Dialog (from ResourceLoader module name 'jquery.ui').
* - To create a gadget based on morebits.js, use this syntax in MediaWiki:Gadgets-definition:
* - Morebits.quickForm tooltips rely on Tipsy (ResourceLoader module name 'jquery.tipsy').
* - `*GadgetName[ResourceLoader|dependencies=mediawiki.user,mediawiki.util,mediawiki.Title,jquery.ui]|morebits.js|morebits.css|GadgetName.js`
* For external installations, Tipsy is available at [http://onehackoranother.com/projects/jquery/tipsy].
* - ToAlternatively, createyou acan gadget based onconfigure morebits.js, useas thisa syntaxhidden gadget in MediaWiki:Gadgets-definition:
* - `* GadgetNamemorebits[ResourceLoader|dependencies=mediawiki.user,mediawiki.util,jquerymediawiki.uiTitle,jquery.tipsyui|hidden]|morebits.js|morebits.css|GadgetName.js`
* and then load ext.gadget.morebits as one of the dependencies for the new gadget.
* - Alternatively, you can configure morebits.js as a hidden gadget in MediaWiki:Gadgets-definition:
* * morebits[ResourceLoader|dependencies=mediawiki.user,mediawiki.util,jquery.ui,jquery.tipsy|hidden]|morebits.js|morebits.css
* and then load ext.gadget.morebits as one of the dependencies for the new gadget
*
* All the stuff here works on all browsers for which MediaWiki provides JavaScript support.
*
* This library is maintained by the maintainers of Twinkle.
* For queries, suggestions, help, etc., head to [[Wikipedia talk:Twinkle]] on English Wikipedia [](http://en.wikipedia.org]/wiki/WT:TW).
* The latest development source is available at [{@link https://github.com/azatothwikimedia-gadgets/twinkle/blob/master/morebits.js]|GitHub}.
*
* @namespace Morebits
*/
 
Line 35 ⟶ 37:
(function (window, document, $) { // Wrap entire file with anonymous function
 
/** @lends Morebits */
var Morebits = {};
window.Morebits = Morebits; // allow global access
 
/**
* i18n support for strings in Morebits
*/
Morebits.i18n = {
parser: null,
/**
* Set an i18n library to use with Morebits.
* Examples:
* Use jquery-i18n:
* Morebits.i18n.setParser({ get: $.i18n });
* Use banana-i18n or orange-i18n:
* var banana = new Banana('en');
* Morebits.i18n.setParser({ get: banana.i18n });
* @param {Object} parser
*/
setParser: function(parser) {
if (!parser || typeof parser.get !== 'function') {
throw new Error('Morebits.i18n: parser must implement get()');
}
Morebits.i18n.parser = parser;
},
/**
* @private
* @returns {string}
*/
getMessage: function () {
var args = Array.prototype.slice.call(arguments); // array of size `n`
// 1st arg: message name
// 2nd to (n-1)th arg: message parameters
// nth arg: legacy English fallback
var msgName = args[0];
var fallback = args[args.length - 1];
if (!Morebits.i18n.parser) {
return fallback;
}
// i18n libraries are generally invoked with variable number of arguments
// as msg(msgName, ...parameters)
var i18nMessage = Morebits.i18n.parser.get.apply(null, args.slice(0, -1));
// if no i18n message exists, i18n libraries generally give back the message name
if (i18nMessage === msgName) {
return fallback;
}
return i18nMessage;
}
};
 
// shortcut
var msg = Morebits.i18n.getMessage;
 
 
/**
* Wiki-specific configurations for Morebits
* **************** Morebits.userIsInGroup() ****************
*/
* Simple helper function to see what groups a user might belong
Morebits.l10n = {
* @param {string} group eg. `sysop`, `extendedconfirmed`, etc
/**
* Local aliases for "redirect" magic word.
* Check using api.php?action=query&format=json&meta=siteinfo&formatversion=2&siprop=magicwords
*/
redirectTagAliases: ['#REDIRECT'],
 
/**
* Takes a string as argument and checks if it is a timestamp or not
* If not, it returns null. If yes, it returns an array of integers
* in the format [year, month, date, hour, minute, second]
* which can be passed to Date.UTC()
* @param {string} str
* @returns {number[] | null}
*/
signatureTimestampFormat: function (str) {
// HH:mm, DD Month YYYY (UTC)
var rgx = /(\d{2}):(\d{2}), (\d{1,2}) (\w+) (\d{4}) \(UTC\)/;
var match = rgx.exec(str);
if (!match) {
return null;
}
var month = Morebits.date.localeData.months.indexOf(match[4]);
if (month === -1) {
return null;
}
// ..... year ... month .. date ... hour .... minute
return [match[5], month, match[3], match[1], match[2]];
}
};
 
 
/**
* Simple helper function to see what groups a user might belong.
*
* @param {string} group - e.g. `sysop`, `extendedconfirmed`, etc.
* @returns {boolean}
*/
Line 49 ⟶ 135:
return mw.config.get('wgUserGroups').indexOf(group) !== -1;
};
/** Hardcodes whether the user is a sysop, used a lot.
// Used a lot
*
* @type {boolean}
*/
Morebits.userIsSysop = Morebits.userIsInGroup('sysop');
 
 
 
/**
* ****************Deprecated as of February 2021, use {@link Morebits.ip.sanitizeIPv6() ****************}.
*
* JavaScript translation of the MediaWiki core function IP::sanitizeIP() in
* @deprecated Use {@link Morebits.ip.sanitizeIPv6}.
* includes/utils/IP.php.
* Converts an IPv6 address to the canonical form stored and used by MediaWiki.
* JavaScript translation of the {@link https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/core/+/8eb6ac3e84ea3312d391ca96c12c49e3ad0753bb/includes/utils/IP.php#131|`IP::sanitizeIP()`}
* @param {string} address - The IPv6 address
* function from the IPUtils library. Addresses are verbose, uppercase,
* normalized, and expanded to 8 words.
*
* @param {string} address - The IPv6 address, with or without CIDR.
* @returns {string}
*/
Morebits.sanitizeIPv6 = function (address) {
console.warn('NOTE: Morebits.sanitizeIPv6 was renamed to Morebits.ip.sanitizeIPv6 in February 2021, please use that instead'); // eslint-disable-line no-console
address = address.trim();
ifreturn Morebits.ip.sanitizeIPv6(address === '') {;
};
return null;
 
/**
* Determines whether the current page is a redirect or soft redirect. Fails
* to detect soft redirects on edit, history, etc. pages. Will attempt to
* detect Module:RfD, with the same failure points.
*
* @returns {boolean}
*/
Morebits.isPageRedirect = function() {
return !!(mw.config.get('wgIsRedirect') || document.getElementById('softredirect') || $('.box-RfD').length);
};
 
/**
* Stores a normalized (underscores converted to spaces) version of the
* `wgPageName` variable.
*
* @type {string}
*/
Morebits.pageNameNorm = mw.config.get('wgPageName').replace(/_/g, ' ');
 
 
/**
* Create a string for use in regex matching a page name. Accounts for
* leading character's capitalization, underscores as spaces, and special
* characters being escaped. See also {@link Morebits.namespaceRegex}.
*
* @param {string} pageName - Page name without namespace.
* @returns {string} - For a page name `Foo bar`, returns the string `[Ff]oo[_ ]bar`.
*/
Morebits.pageNameRegex = function(pageName) {
if (pageName === '') {
return '';
}
var firstChar = pageName[0],
if (!mw.util.isIPv6Address(address)) {
remainder = Morebits.string.escapeRegExp(pageName.slice(1));
return address; // nothing else to do for IPv4 addresses or invalid ones
if (mw.Title.phpCharToUpper(firstChar) !== firstChar.toLowerCase()) {
return '[' + mw.Title.phpCharToUpper(firstChar) + firstChar.toLowerCase() + ']' + remainder;
}
return Morebits.string.escapeRegExp(firstChar) + remainder;
// Remove any whitespaces, convert to upper case
};
address = address.toUpperCase();
 
// Expand zero abbreviations
/**
var abbrevPos = address.indexOf('::');
* Converts string or array of DOM nodes into an HTML fragment.
if (abbrevPos > -1) {
* Wikilink syntax (`[[...]]`) is transformed into HTML anchor.
// We know this is valid IPv6. Find the last index of the
* Used in Morebits.quickForm and Morebits.status
// address before any CIDR number (e.g. "a:b:c::/24").
* @internal
var CIDRStart = address.indexOf('/');
* @param {string|Node|(string|Node)[]} input
var addressEnd = CIDRStart > -1 ? CIDRStart - 1 : address.length - 1;
* @returns {DocumentFragment}
// If the '::' is at the beginning...
*/
var repeat, extra, pad;
Morebits.createHtml = function(input) {
if (abbrevPos === 0) {
var fragment = document.createDocumentFragment();
repeat = '0:';
if (!input) {
extra = address === '::' ? '0' : ''; // for the address '::'
return fragment;
pad = 9; // 7+2 (due to '::')
}
// If the '::' is at the end...
if (!Array.isArray(input)) {
} else if (abbrevPos === (addressEnd - 1)) {
repeatinput = ':0'[ input ];
}
extra = '';
for (var i = 0; i < input.length; ++i) {
pad = 9; // 7+2 (due to '::')
if (input[i] instanceof Node) {
// If the '::' is in the middle...
fragment.appendChild(input[i]);
} else {
$.parseHTML(Morebits.createHtml.renderWikilinks(input[i])).forEach(function(node) {
repeat = ':0';
fragment.appendChild(node);
extra = ':';
});
pad = 8; // 6+2 (due to '::')
}
var replacement = repeat;
pad -= address.split(':').length - 1;
for (var i = 1; i < pad; i++) {
replacement += repeat;
}
replacement += extra;
address = address.replace('::', replacement);
}
return fragment;
// Remove leading zeros from each bloc as needed
address = address.replace(/(^|:)0+([0-9A-Fa-f]{1,4})/g, '$1$2');
 
return address;
};
 
/**
 
* Converts wikilinks to HTML anchor tags.
* @param text
* @returns {*}
*/
Morebits.createHtml.renderWikilinks = function (text) {
var ub = new Morebits.unbinder(text);
// Don't convert wikilinks within code tags as they're used for displaying wiki-code
ub.unbind('<code>', '</code>');
ub.content = ub.content.replace(
/\[\[:?(?:([^|\]]+?)\|)?([^\]|]+?)\]\]/g,
function(_, target, text) {
if (!target) {
target = text;
}
return '<a target="_blank" href="' + mw.util.getUrl(target) +
'" title="' + target.replace(/"/g, '&#34;') + '">' + text + '</a>';
});
return ub.rebind();
};
 
/**
* Create a string for use in regex matching all namespace aliases, regardless
* **************** Morebits.quickForm ****************
* of the capitalization and underscores/spaces. Doesn't include the optional
* Morebits.quickForm is a class for creation of simple and standard forms without much
* leading `:`, but if there's more than one item, wraps the list in a
* specific coding.
* non-capturing group. This means you can do `Morebits.namespaceRegex([4]) +
* ':' + Morebits.pageNameRegex('Twinkle')` to match a full page. Uses
* {@link Morebits.pageNameRegex}.
*
* @param {number[]} namespaces - Array of namespace numbers. Unused/invalid
* Index to Morebits.quickForm element types:
* namespace numbers are silently discarded.
*
* @example
* select A combo box (aka drop-down).
* // returns '(?:[Ff][Ii][Ll][Ee]|[Ii][Mm][Aa][Gg][Ee])'
* - Attributes: name, label, multiple, size, list, event, disabled
* Morebits.namespaceRegex([6])
* option An element for a combo box.
* @returns {string} - Regex-suitable string of all namespace aliases.
* - Attributes: value, label, selected, disabled
* optgroup A group of "option"s.
* - Attributes: label, list
* field A fieldset (aka group box).
* - Attributes: name, label, disabled
* checkbox A checkbox. Must use "list" parameter.
* - Attributes: name, list, event
* - Attributes (within list): name, label, value, checked, disabled, event, subgroup
* radio A radio button. Must use "list" parameter.
* - Attributes: name, list, event
* - Attributes (within list): name, label, value, checked, disabled, event, subgroup
* input A text box.
* - Attributes: name, label, value, size, disabled, required, readonly, maxlength, event
* dyninput A set of text boxes with "Remove" buttons and an "Add" button.
* - Attributes: name, label, min, max, sublabel, value, size, maxlength, event
* hidden An invisible form field.
* - Attributes: name, value
* header A level 5 header.
* - Attributes: label
* div A generic placeholder element or label.
* - Attributes: name, label
* submit A submit button. Morebits.simpleWindow moves these to the footer of the dialog.
* - Attributes: name, label, disabled
* button A generic button.
* - Attributes: name, label, disabled, event
* textarea A big, multi-line text box.
* - Attributes: name, label, value, cols, rows, disabled, required, readonly
* fragment A DocumentFragment object.
* - No attributes, and no global attributes except adminonly
*
* Global attributes: id, className, style, tooltip, extra, adminonly
*/
Morebits.namespaceRegex = function(namespaces) {
if (!Array.isArray(namespaces)) {
namespaces = [namespaces];
}
var aliases = [], regex;
$.each(mw.config.get('wgNamespaceIds'), function(name, number) {
if (namespaces.indexOf(number) !== -1) {
// Namespaces are completely agnostic as to case,
// and a regex string is more useful/compatible than a RegExp object,
// so we accept any casing for any letter.
aliases.push(name.split('').map(function(char) {
return Morebits.pageNameRegex(char);
}).join(''));
}
});
switch (aliases.length) {
case 0:
regex = '';
break;
case 1:
regex = aliases[0];
break;
default:
regex = '(?:' + aliases.join('|') + ')';
break;
}
return regex;
};
 
 
/* **************** Morebits.quickForm **************** */
/**
* Creation of simple and standard forms without much specific coding.
* @constructor
*
* @param {event} event - Function to execute when form is submitted
* @namespace Morebits.quickForm
* @param {string} [eventType=submit] - Type of the event (default: submit)
* @memberof Morebits
* @class
* @param {event} event - Function to execute when form is submitted.
* @param {string} [eventType=submit] - Type of the event.
*/
Morebits.quickForm = function QuickForm(event, eventType) {
Line 165 ⟶ 307:
 
/**
* Renders the HTML output of the quickForm.
*
* @memberof Morebits.quickForm
* @returns {HTMLElement}
*/
Line 175 ⟶ 319:
 
/**
* Append element to the form.
*
* @param {(Object|Morebits.quickForm.element)} data - a quickform element, or the object with which
* @memberof Morebits.quickForm
* @param {(object|Morebits.quickForm.element)} data - A quickform element, or the object with which
* a quickform element is constructed.
* @returns {Morebits.quickForm.element} - sameSame as what is passed to the function.
*/
Morebits.quickForm.prototype.append = function QuickFormAppend(data) {
Line 185 ⟶ 331:
 
/**
* Create a new element for the the form.
* @constructor
*
* @param {Object} data - Object representing the quickform element. See class documentation
* Index to Morebits.quickForm.element types:
* comment for available types and attributes for each.
* - Global attributes: id, className, style, tooltip, extra, $data, adminonly
* - `select`: A combo box (aka drop-down).
* - Attributes: name, label, multiple, size, list, event, disabled
* - `option`: An element for a combo box.
* - Attributes: value, label, selected, disabled
* - `optgroup`: A group of "option"s.
* - Attributes: label, list
* - `field`: A fieldset (aka group box).
* - Attributes: name, label, disabled
* - `checkbox`: A checkbox. Must use "list" parameter.
* - Attributes: name, list, event
* - Attributes (within list): name, label, value, checked, disabled, event, subgroup
* - `radio`: A radio button. Must use "list" parameter.
* - Attributes: name, list, event
* - Attributes (within list): name, label, value, checked, disabled, event, subgroup
* - `input`: A text input box.
* - Attributes: name, label, value, size, placeholder, maxlength, disabled, required, readonly, event
* - `number`: A number input box.
* - Attributes: Everything the text `input` has, as well as: min, max, step, list
* - `dyninput`: A set of text boxes with "Remove" buttons and an "Add" button.
* - Attributes: name, label, min, max, sublabel, value, size, maxlength, event
* - `hidden`: An invisible form field.
* - Attributes: name, value
* - `header`: A level 5 header.
* - Attributes: label
* - `div`: A generic placeholder element or label.
* - Attributes: name, label
* - `submit`: A submit button. Morebits.simpleWindow moves these to the footer of the dialog.
* - Attributes: name, label, disabled
* - `button`: A generic button.
* - Attributes: name, label, disabled, event
* - `textarea`: A big, multi-line text box.
* - Attributes: name, label, value, cols, rows, disabled, required, readonly
* - `fragment`: A DocumentFragment object.
* - No attributes, and no global attributes except adminonly.
* There is some difference on how types handle the `label` attribute:
* - `div`, `select`, `field`, `checkbox`/`radio`, `input`, `textarea`, `header`, and `dyninput` can accept an array of items,
* and the label item(s) can be `Element`s.
* - `option`, `optgroup`, `_dyninput_element`, `submit`, and `button` accept only a single string.
*
* @memberof Morebits.quickForm
* @class
* @param {object} data - Object representing the quickform element. Should
* specify one of the available types from the index above, as well as any
* relevant and available attributes.
* @example new Morebits.quickForm.element({
* name: 'target',
* type: 'input',
* label: 'Your target:',
* tooltip: 'Enter your target. Required.',
* required: true
* });
*/
Morebits.quickForm.element = function QuickFormElement(data) {
this.data = data;
this.childs = [];
this.id = Morebits.quickForm.element.id++;
};
 
/**
* @memberof Morebits.quickForm.element
* @type {number}
*/
Morebits.quickForm.element.id = 0;
 
/**
* Appends an element to current element.
*
* @param {Morebits.quickForm.element} data A quickForm element or the object required to
* create the@memberof Morebits.quickForm .element
* @returnsparam {Morebits.quickForm.element} Thedata same- A quickForm element passedor the object required into
* create the quickForm element.
* @returns {Morebits.quickForm.element} The same element passed in.
*/
Morebits.quickForm.element.prototype.append = function QuickFormElementAppend(data) {
Line 215 ⟶ 418:
 
/**
* Renders the HTML output for the quickForm element. This should be called
* This should be called without parameters: `form.render()`.
*
* @memberof Morebits.quickForm.element
* @returns {HTMLElement}
*/
Line 229 ⟶ 434:
};
 
 
/** @memberof Morebits.quickForm.element */
Morebits.quickForm.element.prototype.compute = function QuickFormElementCompute(data, in_id) {
var node;
var childContainderchildContainer = null;
var label;
var id = (in_id ? in_id + '_' : '') + 'node_' + thisMorebits.quickForm.element.id++;
if (data.adminonly && !Morebits.userIsSysop) {
// hell hack alpha
Line 260 ⟶ 467:
label = node.appendChild(document.createElement('label'));
label.setAttribute('for', id);
label.appendChild(documentMorebits.createTextNodecreateHtml(data.label));
label.style.marginRight = '3px';
}
var select = node.appendChild(document.createElement('select'));
Line 292 ⟶ 500:
}
}
childContainderchildContainer = select;
break;
case 'option':
Line 325 ⟶ 533:
node = document.createElement('fieldset');
label = node.appendChild(document.createElement('legend'));
label.appendChild(documentMorebits.createTextNodecreateHtml(data.label));
if (data.name) {
node.setAttribute('name', data.name);
Line 354 ⟶ 562:
subnode.values = current.value;
subnode.setAttribute('value', current.value);
subnode.setAttribute('name', current.name || data.name);
subnode.setAttribute('type', data.type);
subnode.setAttribute('id', cur_id);
subnode.setAttribute('name', current.name || data.name);
 
// If name is provided on the individual checkbox, add a data-single
// attribute which indicates it isn't part of a list of checkboxes with
// same name. Used in getInputData()
if (current.name) {
subnode.setAttribute('data-single', 'data-single');
}
 
if (current.checked) {
Line 365 ⟶ 580:
}
label = cur_div.appendChild(document.createElement('label'));
 
label.appendChild(document.createTextNode(current.label));
label.appendChild(Morebits.createHtml(current.label));
label.setAttribute('for', cur_id);
if (current.tooltip) {
Line 438 ⟶ 654:
}
}
}
if (data.shiftClickSupport && data.type === 'checkbox') {
Morebits.checkboxShiftClickSupport(Morebits.quickForm.getElements(node, data.name));
}
break;
// input is actually a text-type, so number here inherits the same stuff
case 'number':
case 'input':
node = document.createElement('div');
Line 446 ⟶ 667:
if (data.label) {
label = node.appendChild(document.createElement('label'));
label.appendChild(documentMorebits.createTextNodecreateHtml(data.label));
label.setAttribute('for', data.id || id);
label.style.marginRight = '3px';
}
 
subnode = node.appendChild(document.createElement('input'));
if (data.value) {
subnode.setAttribute('value', data.value);
}
subnode.setAttribute('name', data.name);
 
subnode.setAttribute('type', 'text');
if (data.sizetype === 'input') {
subnode.setAttribute('sizetype', data.size'text');
} else {
subnode.setAttribute('type', 'number');
if (data.disabled) {
['min', 'max', 'step', 'list'].forEach(function(att) {
subnode.setAttribute('disabled', 'disabled');
if (data[att]) {
}
subnode.setAttribute(att, data[att]);
if (data.required) {
}
subnode.setAttribute('required', 'required');
});
if (data.readonly) {
subnode.setAttribute('readonly', 'readonly');
}
if (data.maxlength) {
subnode.setAttribute('maxlength', data.maxlength);
}
 
['value', 'size', 'placeholder', 'maxlength'].forEach(function(att) {
if (data[att]) {
subnode.setAttribute(att, data[att]);
}
});
['disabled', 'required', 'readonly'].forEach(function(att) {
if (data[att]) {
subnode.setAttribute(att, att);
}
});
if (data.event) {
subnode.addEventListener('keyup', data.event, false);
}
 
childContainder = subnode;
childContainer = subnode;
break;
case 'dyninput':
Line 483 ⟶ 709:
 
label = node.appendChild(document.createElement('h5'));
label.appendChild(documentMorebits.createTextNodecreateHtml(data.label));
 
var listNode = node.appendChild(document.createElement('div'));
 
Line 536 ⟶ 761:
label.appendChild(document.createTextNode(data.label));
label.setAttribute('for', id);
label.style.marginRight = '3px';
}
 
Line 584 ⟶ 810:
case 'header':
node = document.createElement('h5');
node.appendChild(documentMorebits.createTextNodecreateHtml(data.label));
break;
case 'div':
Line 592 ⟶ 818:
}
if (data.label) {
if (!Array.isArray(data.label)) {
data.label = [ data.label ];
}
var result = document.createElement('span');
result.className = 'quickformDescription';
for result.appendChild(Morebits.createHtml(i = 0; i < data.label.length; ++i) {);
if (typeof data.label[i] === 'string') {
result.appendChild(document.createTextNode(data.label[i]));
} else if (data.label[i] instanceof Element) {
result.appendChild(data.label[i]);
}
}
node.appendChild(result);
}
Line 609 ⟶ 826:
case 'submit':
node = document.createElement('span');
childContainderchildContainer = node.appendChild(document.createElement('input'));
childContainderchildContainer.setAttribute('type', 'submit');
if (data.label) {
childContainderchildContainer.setAttribute('value', data.label);
}
childContainderchildContainer.setAttribute('name', data.name || 'submit');
if (data.disabled) {
childContainderchildContainer.setAttribute('disabled', 'disabled');
}
break;
case 'button':
node = document.createElement('span');
childContainderchildContainer = node.appendChild(document.createElement('input'));
childContainderchildContainer.setAttribute('type', 'button');
if (data.label) {
childContainderchildContainer.setAttribute('value', data.label);
}
childContainderchildContainer.setAttribute('name', data.name);
if (data.disabled) {
childContainderchildContainer.setAttribute('disabled', 'disabled');
}
if (data.event) {
childContainderchildContainer.addEventListener('click', data.event, false);
}
break;
Line 640 ⟶ 857:
label = node.appendChild(document.createElement('h5'));
var labelElement = document.createElement('label');
labelElement.textContent = appendChild(Morebits.createHtml(data.label));
labelElement.setAttribute('for', data.id || id);
label.appendChild(labelElement);
Line 664 ⟶ 881:
subnode.value = data.value;
}
childContainderchildContainer = subnode;
break;
default:
Line 670 ⟶ 887:
}
 
if (!childContainderchildContainer) {
childContainderchildContainer = node;
}
if (data.tooltip) {
Line 678 ⟶ 895:
 
if (data.extra) {
childContainderchildContainer.extra = data.extra;
}
if (data.$data) {
$(childContainer).data(data.$data);
}
if (data.style) {
childContainderchildContainer.setAttribute('style', data.style);
}
if (data.className) {
childContainderchildContainer.className = childContainderchildContainer.className ?
childContainderchildContainer.className + ' ' + data.className :
data.className;
}
childContainderchildContainer.setAttribute('id', data.id || id);
 
return [ node, childContainderchildContainer ];
};
 
Morebits.quickForm.element.autoNWSW = function() {
return $(this).offset().top > ($(document).scrollTop() + ($(window).height() / 2)) ? 'sw' : 'nw';
};
 
/**
* Create a jquery.tipsyjQuery UI-based tooltip.
*
* @requires jquery.tipsy
* @memberof Morebits.quickForm.element
* @param {HTMLElement} node - the HTML element beside which a tooltip is to be generated
* @requires jquery.ui
* @param {Object} data - tooltip-related configuration data
* @param {HTMLElement} node - The HTML element beside which a tooltip is to be generated.
* @param {object} data - Tooltip-related configuration data.
*/
Morebits.quickForm.element.generateTooltip = function QuickFormElementGenerateTooltip(node, data) {
var tooltipButton = node.appendChild(document.createElement('span'));
$('<span/>', {
tooltipButton.className = 'morebits-tooltipButton';
'class': 'ui-icon ui-icon-help ui-icon-inline morebits-tooltip'
tooltipButton.title = data.tooltip; // Provides the content for jQuery UI
}).appendTo(node).tipsy({
tooltipButton.appendChild(document.createTextNode(msg('tooltip-mark', '?')));
'fallback': data.tooltip,
$(tooltipButton).tooltip({
'fade': true,
position: { my: 'left top', at: 'center bottom', collision: 'flipfit' },
'gravity': data.type === 'input' || data.type === 'select' ?
// Deprecated in UI 1.12, but MW stuck on 1.9.2 indefinitely; see #398 and T71386
Morebits.quickForm.element.autoNWSW : $.fn.tipsy.autoWE,
tooltipClass: 'morebits-ui-tooltip'
'html': true,
'delayOut': 250
});
};
Line 719 ⟶ 936:
// Some utility methods for manipulating quickForms after their creation:
// (None of these work for "dyninput" type fields at present)
 
/**
* Returns an object containing all filled form data entered by the user, with the object
* keys being the form element names. Disabled fields will be ignored, but not hidden fields.
*
* @memberof Morebits.quickForm
* @param {HTMLFormElement} form
* @returns {object} With field names as keys, input data as values.
*/
Morebits.quickForm.getInputData = function(form) {
var result = {};
 
for (var i = 0; i < form.elements.length; i++) {
var field = form.elements[i];
if (field.disabled || !field.name || !field.type ||
field.type === 'submit' || field.type === 'button') {
continue;
}
 
// For elements in subgroups, quickform prepends element names with
// name of the parent group followed by a period, get rid of that.
var fieldNameNorm = field.name.slice(field.name.indexOf('.') + 1);
 
switch (field.type) {
case 'radio':
if (field.checked) {
result[fieldNameNorm] = field.value;
}
break;
case 'checkbox':
if (field.dataset.single) {
result[fieldNameNorm] = field.checked; // boolean
} else {
result[fieldNameNorm] = result[fieldNameNorm] || [];
if (field.checked) {
result[fieldNameNorm].push(field.value);
}
}
break;
case 'select-multiple':
result[fieldNameNorm] = $(field).val(); // field.value doesn't work
break;
case 'text': // falls through
case 'textarea':
result[fieldNameNorm] = field.value.trim();
break;
default: // could be select-one, date, number, email, etc
if (field.value) {
result[fieldNameNorm] = field.value;
}
break;
}
}
return result;
};
 
 
/**
* Returns all form elements with a given field name or ID.
*
* @memberof Morebits.quickForm
* @param {HTMLFormElement} form
* @param {string} fieldName - theThe name or id of the fields.
* @returns {HTMLElement[]} - arrayArray of matching form elements.
*/
Morebits.quickForm.getElements = function QuickFormGetElements(form, fieldName) {
var $form = $(form);
fieldName = $.escapeSelector(fieldName); // sanitize input
var $elements = $form.find('[name="' + fieldName + '"]');
if ($elements.length > 0) {
Line 734 ⟶ 1,009:
}
$elements = $form.find('#' + fieldName);
ifreturn ($elements.length > 0toArray() {;
return $elements.toArray();
}
return null;
};
 
Line 743 ⟶ 1,015:
* Searches the array of elements for a checkbox or radio button with a certain
* `value` attribute, and returns the first such element. Returns null if not found.
*
* @param {HTMLInputElement[]} elementArray - array of checkbox or radio elements
* @memberof Morebits.quickForm
* @param {string} value - value to search for
* @param {HTMLInputElement[]} elementArray - Array of checkbox or radio elements.
* @param {string} value - Value to search for.
* @returns {HTMLInputElement}
*/
Line 758 ⟶ 1,032:
 
/**
* Returns the <&lt;div> containing the form element, or the form element itself
* May not work as expected on checkboxes or radios.
*
* @memberof Morebits.quickForm
* @param {HTMLElement} element
* @returns {HTMLElement}
Line 776 ⟶ 1,052:
/**
* Gets the HTML element that contains the label of the given form element
* (mainly for internal use).
*
* @memberof Morebits.quickForm
* @param {(HTMLElement|Morebits.quickForm.element)} element
* @returns {HTMLElement}
Line 797 ⟶ 1,075:
 
/**
* Gets the label text of the element.
*
* @memberof Morebits.quickForm
* @param {(HTMLElement|Morebits.quickForm.element)} element
* @returns {string}
Line 811 ⟶ 1,091:
 
/**
* Sets the label of the element to the given text.
*
* @memberof Morebits.quickForm
* @param {(HTMLElement|Morebits.quickForm.element)} element
* @param {string} labelText
* @returns {boolean} trueTrue if succeeded, false if the label element is unavailable.
*/
Morebits.quickForm.setElementLabel = function QuickFormSetElementLabel(element, labelText) {
Line 827 ⟶ 1,109:
 
/**
* Stores the element's current label, and temporarily sets the label to the given text.
*
* @memberof Morebits.quickForm
* @param {(HTMLElement|Morebits.quickForm.element)} element
* @param {string} temporaryLabelText
* @returns {boolean} `true` if succeeded, `false` if the label element is unavailable.
*/
Morebits.quickForm.overrideElementLabel = function QuickFormOverrideElementLabel(element, temporaryLabelText) {
Line 840 ⟶ 1,124:
 
/**
* Restores the label stored by overrideElementLabel.
*
* @memberof Morebits.quickForm
* @param {(HTMLElement|Morebits.quickForm.element)} element
* @returns {boolean} trueTrue if succeeded, false if the label element is unavailable.
*/
Morebits.quickForm.resetElementLabel = function QuickFormResetElementLabel(element) {
Line 852 ⟶ 1,138:
 
/**
* Shows or hides a form element plus its label and tooltip.
*
* @param {(HTMLElement|jQuery|string)} element HTML/jQuery element, or jQuery selector string
* @memberof Morebits.quickForm
* @param {boolean} [visibility] Skip this to toggle visibility
* @param {(HTMLElement|jQuery|string)} element - HTML/jQuery element, or jQuery selector string.
* @param {boolean} [visibility] - Skip this to toggle visibility.
*/
Morebits.quickForm.setElementVisibility = function QuickFormSetElementVisibility(element, visibility) {
Line 861 ⟶ 1,149:
 
/**
* Shows or hides the "question mark" icon (which displays the tooltip) next to a form element.
*
* @memberof Morebits.quickForm
* @param {(HTMLElement|jQuery)} element
* @param {boolean} [visibility] - Skip this to toggle visibility.
*/
Morebits.quickForm.setElementTooltipVisibility = function QuickFormSetElementTooltipVisibility(element, visibility) {
$(Morebits.quickForm.getElementContainer(element)).find('.morebits-tooltiptooltipButton').toggle(visibility);
};
 
Line 872 ⟶ 1,162:
 
/**
* ****************@external HTMLFormElement ****************
*/
 
/**
* Get checked items in the form.
* Returns an array containing the values of elements with the given name, that has it's
* checked property set to true. (i.e. a checkbox or a radiobutton is checked), or select
* options that have selected set to true. (don't try to mix selects with radio/checkboxes,
* please)
* Type is optional and can specify if either radio or checkbox (for the event
* that both checkboxes and radiobuttons have the same name.
*
* @function external:HTMLFormElement.getChecked
* XXX: Doesn't seem to work reliably across all browsers at the moment. -- see getChecked2
* @param {string} name - Find checked property of elements (i.e. a checkbox
* in twinkleunlink.js, which is better
* or a radiobutton) with the given name, or select options that have selected
* set to true (don't try to mix selects with radio/checkboxes).
* @param {string} [type] - Optionally specify either radio or checkbox (for
* the event that both checkboxes and radiobuttons have the same name).
* @returns {string[]} - Contains the values of elements with the given name
* checked property set to true.
*/
HTMLFormElement.prototype.getChecked = function(name, type) {
var elements = this.elements[name];
if (!elements) {
return [];
// if the element doesn't exists, return null.
return null;
}
var return_array = [];
Line 930 ⟶ 1,219:
 
/**
* Does the same as {@link HTMLFormElement.getChecked|getChecked}, but with unchecked elements.
* getUnchecked:
*
* Does the same as getChecked above, but with unchecked elements.
* @function external:HTMLFormElement.getUnchecked
* @param {string} name - Find checked property of elements (i.e. a checkbox
* or a radiobutton) with the given name, or select options that have selected
* set to true (don't try to mix selects with radio/checkboxes).
* @param {string} [type] - Optionally specify either radio or checkbox (for
* the event that both checkboxes and radiobuttons have the same name).
* @returns {string[]} - Contains the values of elements with the given name
* checked property set to true.
*/
 
HTMLFormElement.prototype.getUnchecked = function(name, type) {
var elements = this.elements[name];
if (!elements) {
return [];
// if the element doesn't exists, return null.
return null;
}
var return_array = [];
Line 976 ⟶ 1,271:
return return_array;
};
 
 
/**
* Utilities to help process IP addresses.
* **************** RegExp ****************
*
* @namespace Morebits.ip
* Escapes a string to be used in a RegExp
* @memberof Morebits
* @param {string} text - string to be escaped
* @param {boolean} [space_fix=false] - Set true to replace spaces and underscores with `[ _]` as they are
* often equivalent
* @returns {string} - the escaped text
*/
Morebits.ip = {
RegExp.escape = function(text, space_fix) {
/**
text = mw.util.escapeRegExp(text);
* Converts an IPv6 address to the canonical form stored and used by MediaWiki.
* JavaScript translation of the {@link https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/core/+/8eb6ac3e84ea3312d391ca96c12c49e3ad0753bb/includes/utils/IP.php#131|`IP::sanitizeIP()`}
* function from the IPUtils library. Addresses are verbose, uppercase,
* normalized, and expanded to 8 words.
*
* @param {string} address - The IPv6 address, with or without CIDR.
* @returns {string}
*/
sanitizeIPv6: function (address) {
address = address.trim();
if (address === '') {
return null;
}
if (!mw.util.isIPv6Address(address, true)) {
return address; // nothing else to do for IPv4 addresses or invalid ones
}
// Remove any whitespaces, convert to upper case
address = address.toUpperCase();
// Expand zero abbreviations
var abbrevPos = address.indexOf('::');
if (abbrevPos > -1) {
// We know this is valid IPv6. Find the last index of the
// address before any CIDR number (e.g. "a:b:c::/24").
var CIDRStart = address.indexOf('/');
var addressEnd = CIDRStart !== -1 ? CIDRStart - 1 : address.length - 1;
// If the '::' is at the beginning...
var repeat, extra, pad;
if (abbrevPos === 0) {
repeat = '0:';
extra = address === '::' ? '0' : ''; // for the address '::'
pad = 9; // 7+2 (due to '::')
// If the '::' is at the end...
} else if (abbrevPos === (addressEnd - 1)) {
repeat = ':0';
extra = '';
pad = 9; // 7+2 (due to '::')
// If the '::' is in the middle...
} else {
repeat = ':0';
extra = ':';
pad = 8; // 6+2 (due to '::')
}
var replacement = repeat;
pad -= address.split(':').length - 1;
for (var i = 1; i < pad; i++) {
replacement += repeat;
}
replacement += extra;
address = address.replace('::', replacement);
}
// Remove leading zeros from each bloc as needed
return address.replace(/(^|:)0+([0-9A-Fa-f]{1,4})/g, '$1$2');
},
 
/**
// Special MediaWiki escape - underscore/space are often equivalent
* Determine if the given IP address is a range. Just conjoins
if (space_fix) {
* `mw.util.isIPAddress` with and without the `allowBlock` option.
text = text.replace(/ |_/g, '[_ ]');
*
}
* @param {string} ip
* @returns {boolean} - True if given a valid IP address range, false otherwise.
*/
isRange: function (ip) {
return mw.util.isIPAddress(ip, true) && !mw.util.isIPAddress(ip);
},
 
/**
return text;
* Check that an IP range is within the CIDR limits. Most likely to be useful
* in conjunction with `wgRelevantUserName`. CIDR limits are hardcoded as /16
* for IPv4 and /32 for IPv6.
*
* @returns {boolean} - True for valid ranges within the CIDR limits,
* otherwise false (ranges outside the limit, single IPs, non-IPs).
*/
validCIDR: function (ip) {
if (Morebits.ip.isRange(ip)) {
var subnet = parseInt(ip.match(/\/(\d{1,3})$/)[1], 10);
if (subnet) { // Should be redundant
if (mw.util.isIPv6Address(ip, true)) {
if (subnet >= 32) {
return true;
}
} else {
if (subnet >= 16) {
return true;
}
}
}
}
return false;
},
 
/**
* Get the /64 subnet for an IPv6 address.
*
* @param {string} ipv6 - The IPv6 address, with or without a subnet.
* @returns {boolean|string} - False if not IPv6 or bigger than a 64,
* otherwise the (sanitized) /64 address.
*/
get64: function (ipv6) {
if (!ipv6 || !mw.util.isIPv6Address(ipv6, true)) {
return false;
}
var subnetMatch = ipv6.match(/\/(\d{1,3})$/);
if (subnetMatch && parseInt(subnetMatch[1], 10) < 64) {
return false;
}
ipv6 = Morebits.ip.sanitizeIPv6(ipv6);
var ip_re = /^((?:[0-9A-F]{1,4}:){4})(?:[0-9A-F]{1,4}:){3}[0-9A-F]{1,4}(?:\/\d{1,3})?$/;
return ipv6.replace(ip_re, '$1' + '0:0:0:0/64');
}
};
 
 
/**
* Helper functions to manipulate strings.
* **************** String; Morebits.string ****************
*
* @namespace Morebits.string
* @memberof Morebits
*/
 
Morebits.string = {
/**
// Helper functions to change case of a string
* @param {string} str
* @returns {string}
*/
toUpperCaseFirstChar: function(str) {
str = str.toString();
return str.substr(0, 1).toUpperCase() + str.substr(1);
},
/**
* @param {string} str
* @returns {string}
*/
toLowerCaseFirstChar: function(str) {
str = str.toString();
Line 1,015 ⟶ 1,418:
 
/**
* Gives an array of substrings of `str` - starting with `start` and
* ending with `end`, - which is not in `skiplist`. Intended for use
* on wikitext with templates or links.
*
* @param {string} str
* @param {string} start
* @param {string} end
* @param {(string[]|string)} [skiplist]
* @returns {Stringstring[]}
* @throws If the `start` and `end` strings aren't of the same length.
* @throws If `skiplist` isn't an array or string
*/
splitWeightedByKeys: function(str, start, end, skiplist) {
Line 1,066 ⟶ 1,473:
 
/**
* Formats freeform "reason" (from a textarea) for deletion/other templates
* templates that are going to be substituted, (e.g. PROD, XFD, RPP).
* Handles `|` outside a nowiki tag.
* Optionally, also adds a signature if not present already.
*
* @param {string} str
* @param {boolean} [addSig]
* @returns {string}
*/
formatReasonText: function(str, addSig) {
var resultreason = (str || '').toString().trim();
var unbinder = new Morebits.unbinder(resultreason);
unbinder.unbind('<no' + 'wiki>', '</no' + 'wiki>');
unbinder.content = unbinder.content.replace(/\|/g, '{{subst:!}}');
returnreason = unbinder.rebind();
if (addSig) {
var sig = '~~~~', sigIndex = reason.lastIndexOf(sig);
if (sigIndex === -1 || sigIndex !== reason.length - sig.length) {
reason += ' ' + sig;
}
}
return reason.trim();
},
 
/**
* Formats a "reason" (from a textarea) for inclusion in a userspace
* Like `String.prototype.replace()`, but escapes any dollar signs in the replacement string.
* log. Replaces newlines with {{Pb}}, and adds an extra `#` before
* Useful when the the replacement string is arbitrary, such as a username or freeform user input,
* andlist coulditems containfor dollarproper signsformatting.
*
* @param {string} string - text in which to replace
* @param {string} str
* @returns {string}
*/
formatReasonForLog: function(str) {
return str
// handle line breaks, which otherwise break numbering
.replace(/\n+/g, '{{pb}}')
// put an extra # in front before bulleted or numbered list items
.replace(/^(#+)/mg, '#$1')
.replace(/^(\*+)/mg, '#$1');
},
 
/**
* Like `String.prototype.replace()`, but escapes any dollar signs in
* the replacement string. Useful when the the replacement string is
* arbitrary, such as a username or freeform user input, and could
* contain dollar signs.
*
* @param {string} string - Text in which to replace.
* @param {(string|RegExp)} pattern
* @param {string} replacement
Line 1,090 ⟶ 1,527:
safeReplace: function morebitsStringSafeReplace(string, pattern, replacement) {
return string.replace(pattern, replacement.replace(/\$/g, '$$$$'));
},
 
/**
* Determine if the user-provided expiration will be considered an
* infinite-length by MW.
*
* @see {@link https://phabricator.wikimedia.org/T68646}
*
* @param {string} expiry
* @returns {boolean}
*/
isInfinity: function morebitsStringIsInfinity(expiry) {
return ['indefinite', 'infinity', 'infinite', 'never'].indexOf(expiry) !== -1;
},
 
/**
* Escapes a string to be used in a RegExp, replacing spaces and
* underscores with `[_ ]` as they are often equivalent.
*
* @param {string} text - String to be escaped.
* @returns {string} - The escaped text.
*/
escapeRegExp: function(text) {
return mw.util.escapeRegExp(text).replace(/ |_/g, '[_ ]');
}
};
Line 1,095 ⟶ 1,556:
 
/**
* Helper functions to manipulate arrays.
* **************** Morebits.array ****************
*
* @namespace Morebits.array
* @memberof Morebits
*/
 
Morebits.array = {
/**
* Remove duplicated items from an array.
* @returns {Array} a copy of the array with duplicates removed
*
* @param {Array} arr
* @returns {Array} A copy of the array with duplicates removed.
* @throws When provided a non-array.
*/
uniq: function(arr) {
Line 1,106 ⟶ 1,573:
throw 'A non-array object passed to Morebits.array.uniq';
}
return arr.filter(function(item, idx) {
var result = [];
return arr.indexOf(item) === idx;
for (var i = 0; i < arr.length; ++i) {
});
var current = arr[i];
if (result.indexOf(current) === -1) {
result.push(current);
}
}
return result;
},
 
/**
* Remove non-duplicated items from an array.
* @returns {Array} a copy of the array with the first instance of each value
*
* removed; subsequent instances of those values (duplicates) remain
* @param {Array} arr
* @returns {Array} A copy of the array with the first instance of each value
* removed; subsequent instances of those values (duplicates) remain.
* @throws When provided a non-array.
*/
dups: function(arr) {
Line 1,124 ⟶ 1,590:
throw 'A non-array object passed to Morebits.array.dups';
}
return arr.filter(function(item, idx) {
var uniques = [];
return arr.indexOf(item) !== idx;
var result = [];
});
for (var i = 0; i < arr.length; ++i) {
var current = arr[i];
if (uniques.indexOf(current) === -1) {
uniques.push(current);
} else {
result.push(current);
}
}
return result;
},
 
Line 1,140 ⟶ 1,598:
/**
* Break up an array into smaller arrays.
*
* @param {Array} arr
* @param {number} size - Size of each chunk (except the last, which could be different).
* @returns {Array[]} anAn array ofcontaining thesethe smaller, chunked arrays.
* @throws When provided a non-array.
*/
chunk: function(arr, size) {
Line 1,151 ⟶ 1,611:
return [ arr ]; // we return an array consisting of this array.
}
var resultnumChunks = []Math.ceil(arr.length / size);
var result = new Array(numChunks);
var current;
for (var i = 0; i < arr.lengthnumChunks; i++i) {
result[i] = arr.slice(i * size, (i + 1) * size);
if (i % size === 0) { // when 'i' is 0, this is always true, so we start by creating one.
current = [];
result.push(current);
}
current.push(arr[i]);
}
return result;
Line 1,165 ⟶ 1,621:
 
/**
* Utilities to enhance select2 menus. See twinklewarn, twinklexfd,
* ************ Morebits.select2 ***************
* twinkleblock for sample usages.
* Utilities to enhance select2 menus
*
* See twinklewarn, twinklexfd, twinkleblock for sample usages
* @see {@link https://select2.org/}
*
* @namespace Morebits.select2
* @memberof Morebits
* @requires jquery.select2
*/
Morebits.select2 = {
 
matchers: {
/**
* Custom matcher in which if the optgroup name matches, all options in that
* group are shown, like in jquery.chosen.
*/
optgroupFull: function(params, data) {
Line 1,187 ⟶ 1,647:
},
 
/** Custom matcher that matches from the beginning of words only. */
wordBeginning: function(params, data) {
var originalMatcher = $.fn.select2.defaults.defaults.matcher;
Line 1,199 ⟶ 1,659:
},
 
/** Underline matched part of options. */
highlightSearchMatches: function(data) {
var searchTerm = Morebits.select2SearchQuery;
Line 1,217 ⟶ 1,677:
},
 
/** Intercept query as it is happening, for use in highlightSearchMatches. */
queryInterceptor: function(params) {
Morebits.select2SearchQuery = params && params.term;
Line 1,223 ⟶ 1,683:
 
/**
* Open dropdown and begin search when the `.select2-selection` has
* focus and a key is pressed.
*
* https://github.com/select2/select2/issues/3279#issuecomment-442524147
* @see {@link https://github.com/select2/select2/issues/3279#issuecomment-442524147}
*/
autoStart: function(ev) {
Line 1,238 ⟶ 1,700:
var search = target.data('select2').dropdown.$search ||
target.data('select2').selection.$search;
// Use DOM .focus() to work around a jQuery 3.6.0 regression (https://github.com/select2/select2/issues/5993)
search.focus();
search[0].focus();
}
 
Line 1,245 ⟶ 1,708:
 
/**
* Temporarily hide a part of a string while processing the rest of it.
* **************** Morebits.pageNameNorm ****************
* Used by {@link Morebits.wikitext.page#commentOutImage|Morebits.wikitext.page.commentOutImage}.
* Stores a normalized version of the wgPageName variable (underscores converted to spaces).
* For queen/king/whatever and country!
*/
Morebits.pageNameNorm = mw.config.get('wgPageName').replace(/_/g, ' ');
 
 
/**
* *************** Morebits.pageNameRegex *****************
* For a page name 'Foo bar', returns the string '[Ff]oo bar'
* @param {string} pageName - page name without namespace
* @returns {string}
*/
Morebits.pageNameRegex = function(pageName) {
return '[' + pageName[0].toUpperCase() + pageName[0].toLowerCase() + ']' + pageName.slice(1);
};
 
 
/**
* **************** Morebits.unbinder ****************
* Used for temporarily hiding a part of a string while processing the rest of it.
*
* @memberof Morebits
* eg. var u = new Morebits.unbinder("Hello world <!-- world --> world");
* @class
* u.unbind('<!--','-->');
* @param {string} string - The initial text to process.
* u.content = u.content.replace(/world/g, 'earth');
* @example var u = new uMorebits.rebindunbinder(); // gives "'Hello earthworld <!-- world --> earth"world');
* u.unbind('<!--', '-->'); // text inside comment remains intact
*
* u.content = u.content.replace(/world/g, 'earth');
* Text within the 'unbinded' part (in this case, the HTML comment) remains intact
* u.rebind(); // gives 'Hello earth <!-- world --> earth'
* unbind() can be called multiple times to unbind multiple parts of the string.
*
* Used by Morebits.wikitext.page.commentOutImage
*/
 
/**
* @constructor
* @param {string} string
*/
Morebits.unbinder = function Unbinder(string) {
Line 1,286 ⟶ 1,723:
throw new Error('not a string');
}
/** The text being processed. */
this.content = string;
this.counter = 0;
Line 1,295 ⟶ 1,733:
Morebits.unbinder.prototype = {
/**
* Hide the region encapsulated by the `prefix` and `postfix` from
* string processing. `prefix` and `postfix` will be used in a
* RegExp, so items that need escaping should be use `\\`.
*
* @param {string} prefix
* @param {string} postfix
* @throws If either `prefix` or `postfix` is missing.
*/
unbind: function UnbinderUnbind(prefix, postfix) {
if (!prefix || !postfix) {
throw new Error('Both prefix and postfix must be provided');
}
var re = new RegExp(prefix + '([\\s\\S]*?)' + postfix, 'g');
this.content = this.content.replace(re, Morebits.unbinder.getCallback(this));
},
 
/**
/** @returns {string} The output */
* Restore the hidden portion of the `content` string.
*
* @returns {string} The processed output.
*/
rebind: function UnbinderRebind() {
var content = this.content;
Line 1,320 ⟶ 1,770:
history: null // {}
};
/** @memberof Morebits.unbinder */
 
Morebits.unbinder.getCallback = function UnbinderGetCallback(self) {
return function UnbinderCallback(match) {
Line 1,332 ⟶ 1,782:
 
 
/* **************** Morebits.date **************** */
/**
* Create a date object with enhanced processing capabilities, a la
* **************** Date ****************
* {@link https://momentjs.com/|moment.js}. MediaWiki timestamp format is also
* Helper functions to get the month as a string instead of a number
* acceptable, in addition to everything that JS Date() accepts.
*
* @memberof Morebits
* Normally it is poor form to play with prototypes of primitive types, but it
* @class
* is fairly unlikely that anyone will iterate over a Date object.
*/
Morebits.date = function() {
var args = Array.prototype.slice.call(arguments);
 
// Check MediaWiki formats
Date.monthNames = ['जनवरी', 'फरवरी', 'मार्च', 'अप्रैल', 'मई', 'जून',
// Must be first since firefox erroneously accepts the timestamp
'जुलाई', 'अगस्त', 'सितंबर', 'अक्टूबर', 'नवंबर', 'दिसंबर' ];
// format, sans timezone (See also: #921, #936, #1174, #1187), and the
// 14-digit string will be interpreted differently.
if (args.length === 1) {
var param = args[0];
if (/^\d{14}$/.test(param)) {
// YYYYMMDDHHmmss
var digitMatch = /(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/.exec(param);
if (digitMatch) {
// ..... year ... month .. date ... hour .... minute ..... second
this._d = new Date(Date.UTC.apply(null, [digitMatch[1], digitMatch[2] - 1, digitMatch[3], digitMatch[4], digitMatch[5], digitMatch[6]]));
}
} else if (typeof param === 'string') {
// Wikitext signature timestamp
var dateParts = Morebits.l10n.signatureTimestampFormat(param);
if (dateParts) {
this._d = new Date(Date.UTC.apply(null, dateParts));
}
}
}
 
if (!this._d) {
Date.monthNamesAbbrev = ['जन', 'फर', 'मार्च', 'अप्रै', 'मई', 'जून', 'जुल', 'अग', 'सित', 'अक्टू', 'नवं', 'दिस'];
// Try standard date
this._d = new (Function.prototype.bind.apply(Date, [Date].concat(args)));
}
 
// Still no?
Date.prototype.getUTCMonthName = function() {
if (!this.isValid()) {
return Date.monthNames[this.getUTCMonth()];
mw.log.warn('Invalid Morebits.date initialisation:', args);
}
};
 
/**
Date.prototype.getUTCMonthNameAbbrev = function() {
* Localized strings for date processing.
return Date.monthNamesAbbrev[this.getUTCMonth()];
*
* @memberof Morebits.date
* @type {object.<string, string>}
* @property {string[]} months
* @property {string[]} monthsShort
* @property {string[]} days
* @property {string[]} daysShort
* @property {object.<string, string>} relativeTimes
* @private
*/
Morebits.date.localeData = {
// message names here correspond to MediaWiki message names
months: [msg('january', 'January'), msg('february', 'February'), msg('march', 'March'),
msg('april', 'April'), msg('may_long', 'May'), msg('june', 'June'),
msg('july', 'July'), msg('august', 'August'), msg('september', 'September'),
msg('october', 'October'), msg('november', 'November'), msg('december', 'December')],
monthsShort: [msg('jan', 'Jan'), msg('feb', 'Feb'), msg('mar', 'Mar'),
msg('apr', 'Apr'), msg('may', 'May'), msg('jun', 'Jun'),
msg('jul', 'Jul'), msg('aug', 'Aug'), msg('sep', 'Sep'),
msg('oct', 'Oct'), msg('nov', 'Nov'), msg('dec', 'Dec')],
days: [msg('sunday', 'Sunday'), msg('monday', 'Monday'), msg('tuesday', 'Tuesday'),
msg('wednesday', 'Wednesday'), msg('thursday', 'Thursday'), msg('friday', 'Friday'),
msg('saturday', 'Saturday')],
daysShort: [msg('sun', 'Sun'), msg('mon', 'Mon'), msg('tue', 'Tue'),
msg('wed', 'Wed'), msg('thu', 'Thu'), msg('fri', 'Fri'),
msg('sat', 'Sat')],
 
relativeTimes: {
thisDay: msg('relative-today', '[Today at] h:mm A'),
prevDay: msg('relative-prevday', '[Yesterday at] h:mm A'),
nextDay: msg('relative-nextday', '[Tomorrow at] h:mm A'),
thisWeek: msg('relative-thisweek', 'dddd [at] h:mm A'),
pastWeek: msg('relative-pastweek', '[Last] dddd [at] h:mm A'),
other: msg('relative-other', 'YYYY-MM-DD')
}
};
 
/**
* Map units with getter/setter function names, for `add` and `subtract`
* methods.
*
* @memberof Morebits.date
* @type {object.<string, string>}
* @property {string} seconds
* @property {string} minutes
* @property {string} hours
* @property {string} days
* @property {string} weeks
* @property {string} months
* @property {string} years
*/
Morebits.date.unitMap = {
seconds: 'Seconds',
minutes: 'Minutes',
hours: 'Hours',
days: 'Date',
weeks: 'Week', // Not a function but handled in `add` through cunning use of multiplication
months: 'Month',
years: 'FullYear'
};
 
Morebits.date.prototype = {
// Morebits.wikipedia.namespaces is deprecated - use mw.config.get('wgFormattedNamespaces') or mw.config.get('wgNamespaceIds') instead
/** @returns {boolean} */
isValid: function() {
return !isNaN(this.getTime());
},
 
/**
* @param {(Date|Morebits.date)} date
* @returns {boolean}
*/
isBefore: function(date) {
return this.getTime() < date.getTime();
},
/**
* @param {(Date|Morebits.date)} date
* @returns {boolean}
*/
isAfter: function(date) {
return this.getTime() > date.getTime();
},
 
/** @returns {string} */
getUTCMonthName: function() {
return Morebits.date.localeData.months[this.getUTCMonth()];
},
/** @returns {string} */
getUTCMonthNameAbbrev: function() {
return Morebits.date.localeData.monthsShort[this.getUTCMonth()];
},
/** @returns {string} */
getMonthName: function() {
return Morebits.date.localeData.months[this.getMonth()];
},
/** @returns {string} */
getMonthNameAbbrev: function() {
return Morebits.date.localeData.monthsShort[this.getMonth()];
},
/** @returns {string} */
getUTCDayName: function() {
return Morebits.date.localeData.days[this.getUTCDay()];
},
/** @returns {string} */
getUTCDayNameAbbrev: function() {
return Morebits.date.localeData.daysShort[this.getUTCDay()];
},
/** @returns {string} */
getDayName: function() {
return Morebits.date.localeData.days[this.getDay()];
},
/** @returns {string} */
getDayNameAbbrev: function() {
return Morebits.date.localeData.daysShort[this.getDay()];
},
 
/**
* Add a given number of minutes, hours, days, weeks, months, or years to the date.
* This is done in-place. The modified date object is also returned, allowing chaining.
*
* @param {number} number - Should be an integer.
* @param {string} unit
* @throws If invalid or unsupported unit is given.
* @returns {Morebits.date}
*/
add: function(number, unit) {
var num = parseInt(number, 10); // normalize
if (isNaN(num)) {
throw new Error('Invalid number "' + number + '" provided.');
}
unit = unit.toLowerCase(); // normalize
var unitMap = Morebits.date.unitMap;
var unitNorm = unitMap[unit] || unitMap[unit + 's']; // so that both singular and plural forms work
if (unitNorm) {
// No built-in week functions, so rather than build out ISO's getWeek/setWeek, just multiply
// Probably can't be used for Julian->Gregorian changeovers, etc.
if (unitNorm === 'Week') {
unitNorm = 'Date', num *= 7;
}
this['set' + unitNorm](this['get' + unitNorm]() + num);
return this;
}
throw new Error('Invalid unit "' + unit + '": Only ' + Object.keys(unitMap).join(', ') + ' are allowed.');
},
 
/**
* Subtracts a given number of minutes, hours, days, weeks, months, or years to the date.
* This is done in-place. The modified date object is also returned, allowing chaining.
*
* @param {number} number - Should be an integer.
* @param {string} unit
* @throws If invalid or unsupported unit is given.
* @returns {Morebits.date}
*/
subtract: function(number, unit) {
return this.add(-number, unit);
},
 
/**
* Format the date into a string per the given format string.
* Replacement syntax is a subset of that in moment.js:
*
* | Syntax | Output |
* |--------|--------|
* | H | Hours (24-hour) |
* | HH | Hours (24-hour, padded to 2 digits) |
* | h | Hours (12-hour) |
* | hh | Hours (12-hour, padded to 2 digits) |
* | A | AM or PM |
* | m | Minutes |
* | mm | Minutes (padded to 2 digits) |
* | s | Seconds |
* | ss | Seconds (padded to 2 digits) |
* | SSS | Milliseconds fragment, 3 digits |
* | d | Day number of the week (Sun=0) |
* | ddd | Abbreviated day name |
* | dddd | Full day name |
* | D | Date |
* | DD | Date (padded to 2 digits) |
* | M | Month number (1-indexed) |
* | MM | Month number (1-indexed, padded to 2 digits) |
* | MMM | Abbreviated month name |
* | MMMM | Full month name |
* | Y | Year |
* | YY | Final two digits of year (20 for 2020, 42 for 1942) |
* | YYYY | Year (same as `Y`) |
*
* @param {string} formatstr - Format the date into a string, using
* the replacement syntax. Use `[` and `]` to escape items. If not
* provided, will return the ISO-8601-formatted string.
* @param {(string|number)} [zone=system] - `system` (for browser-default time zone),
* `utc`, or specify a time zone as number of minutes relative to UTC.
* @returns {string}
*/
format: function(formatstr, zone) {
if (!this.isValid()) {
return 'Invalid date'; // Put the truth out, preferable to "NaNNaNNan NaN:NaN" or whatever
}
var udate = this;
// create a new date object that will contain the date to display as system time
if (zone === 'utc') {
udate = new Morebits.date(this.getTime()).add(this.getTimezoneOffset(), 'minutes');
} else if (typeof zone === 'number') {
// convert to utc, then add the utc offset given
udate = new Morebits.date(this.getTime()).add(this.getTimezoneOffset() + zone, 'minutes');
}
 
// default to ISOString
if (!formatstr) {
return udate.toISOString();
}
 
var pad = function(num, len) {
len = len || 2; // Up to length of 00 + 1
return ('00' + num).toString().slice(0 - len);
};
var h24 = udate.getHours(), m = udate.getMinutes(), s = udate.getSeconds(), ms = udate.getMilliseconds();
var D = udate.getDate(), M = udate.getMonth() + 1, Y = udate.getFullYear();
var h12 = h24 % 12 || 12, amOrPm = h24 >= 12 ? msg('period-pm', 'PM') : msg('period-am', 'AM');
var replacementMap = {
HH: pad(h24), H: h24, hh: pad(h12), h: h12, A: amOrPm,
mm: pad(m), m: m,
ss: pad(s), s: s,
SSS: pad(ms, 3),
dddd: udate.getDayName(), ddd: udate.getDayNameAbbrev(), d: udate.getDay(),
DD: pad(D), D: D,
MMMM: udate.getMonthName(), MMM: udate.getMonthNameAbbrev(), MM: pad(M), M: M,
YYYY: Y, YY: pad(Y % 100), Y: Y
};
 
var unbinder = new Morebits.unbinder(formatstr); // escape stuff between [...]
unbinder.unbind('\\[', '\\]');
unbinder.content = unbinder.content.replace(
/* Regex notes:
* d(d{2,3})? matches exactly 1, 3 or 4 occurrences of 'd' ('dd' is treated as a double match of 'd')
* Y{1,2}(Y{2})? matches exactly 1, 2 or 4 occurrences of 'Y'
*/
/H{1,2}|h{1,2}|m{1,2}|s{1,2}|SSS|d(d{2,3})?|D{1,2}|M{1,4}|Y{1,2}(Y{2})?|A/g,
function(match) {
return replacementMap[match];
}
);
return unbinder.rebind().replace(/\[(.*?)\]/g, '$1');
},
 
/**
* Gives a readable relative time string such as "Yesterday at 6:43 PM" or "Last Thursday at 11:45 AM".
* Similar to `calendar` in moment.js, but with time zone support.
*
* @param {(string|number)} [zone=system] - 'system' (for browser-default time zone),
* 'utc' (for UTC), or specify a time zone as number of minutes past UTC.
* @returns {string}
*/
calendar: function(zone) {
// Zero out the hours, minutes, seconds and milliseconds - keeping only the date;
// find the difference. Note that setHours() returns the same thing as getTime().
var dateDiff = (new Date().setHours(0, 0, 0, 0) -
new Date(this).setHours(0, 0, 0, 0)) / 8.64e7;
switch (true) {
case dateDiff === 0:
return this.format(Morebits.date.localeData.relativeTimes.thisDay, zone);
case dateDiff === 1:
return this.format(Morebits.date.localeData.relativeTimes.prevDay, zone);
case dateDiff > 0 && dateDiff < 7:
return this.format(Morebits.date.localeData.relativeTimes.pastWeek, zone);
case dateDiff === -1:
return this.format(Morebits.date.localeData.relativeTimes.nextDay, zone);
case dateDiff < 0 && dateDiff > -7:
return this.format(Morebits.date.localeData.relativeTimes.thisWeek, zone);
default:
return this.format(Morebits.date.localeData.relativeTimes.other, zone);
}
},
 
/**
* Get a regular expression that matches wikitext section titles, such
* as `==December 2019==` or `=== Jan 2018 ===`.
*
* @returns {RegExp}
*/
monthHeaderRegex: function() {
return new RegExp('^(==+)\\s*(?:' + this.getUTCMonthName() + '|' + this.getUTCMonthNameAbbrev() +
')\\s+' + this.getUTCFullYear() + '\\s*\\1', 'mg');
},
 
/**
* Creates a wikitext section header with the month and year.
*
* @param {number} [level=2] - Header level. Pass 0 for just the text
* with no wikitext markers (==).
* @returns {string}
*/
monthHeader: function(level) {
// Default to 2, but allow for 0 or stringy numbers
level = parseInt(level, 10);
level = isNaN(level) ? 2 : level;
 
var header = Array(level + 1).join('='); // String.prototype.repeat not supported in IE 11
var text = this.getUTCMonthName() + ' ' + this.getUTCFullYear();
 
if (header.length) { // wikitext-formatted header
return header + ' ' + text + ' ' + header;
}
return text; // Just the string
 
}
 
};
 
// Allow native Date.prototype methods to be used on Morebits.date objects
Object.getOwnPropertyNames(Date.prototype).forEach(function(func) {
// Exclude methods that collide with PageTriage's Date.js external, which clobbers native Date: [[phab:T268513]]
if (['add', 'getDayName', 'getMonthName'].indexOf(func) === -1) {
Morebits.date.prototype[func] = function() {
return this._d[func].apply(this._d, Array.prototype.slice.call(arguments));
};
}
});
 
 
/* **************** Morebits.wiki **************** */
/**
* Various objects for wiki editing and API access, including
* **************** Morebits.wiki ****************
* {@link Morebits.wiki.api} and {@link Morebits.wiki.page}.
* Various objects for wiki editing and API access
*
* @namespace Morebits.wiki
* @memberof Morebits
*/
Morebits.wiki = {};
 
/**
* @deprecated in favor of Morebits.isPageRedirect as of November 2020
* Determines whether the current page is a redirect or soft redirect
* @memberof Morebits.wiki
* (fails to detect soft redirects on edit, history, etc. pages)
* @returns {boolean}
*/
Morebits.wiki.isPageRedirect = function wikipediaIsPageRedirect() {
console.warn('NOTE: Morebits.wiki.isPageRedirect has been deprecated, use Morebits.isPageRedirect instead.'); // eslint-disable-line no-console
return !!(mw.config.get('wgIsRedirect') || document.getElementById('softredirect'));
return Morebits.isPageRedirect();
};
 
 
/* **************** Morebits.wiki.actionCompleted **************** */
/**
* @memberof Morebits.wiki
* @type {number}
*/
Morebits.wiki.numberOfActionsLeft = 0;
/**
* @memberof Morebits.wiki
* @type {number}
*/
Morebits.wiki.nbrOfCheckpointsLeft = 0;
 
/**
* Display message and/or redirect to page upon completion of tasks.
* **************** Morebits.wiki.actionCompleted ****************
*
* Every call Use ofto Morebits.wiki.actionCompletedapi.post(): results in the dispatch of an
* asynchronous callback. Each callback can in turn make an additional call to
* Every call to Morebits.wiki.api.post() results in the dispatch of
* Morebits.wiki.api.post() to continue a processing sequence. At the
* an asynchronous callback. Each callback can in turn
* conclusion of the final callback of a processing sequence, it is not
* make an additional call to Morebits.wiki.api.post() to continue a
* possible to simply return to the original caller because there is no call
* processing sequence. At the conclusion of the final callback
* stack leading back to the original context. Instead,
* of a processing sequence, it is not possible to simply return to the
* Morebits.wiki.actionCompleted.event() is called to display the result to
* original caller because there is no call stack leading back to
* the user and to perform an optional page redirect.
* the original context. Instead, Morebits.wiki.actionCompleted.event() is
* called to display the result to the user and to perform an optional
* page redirect.
*
* The determination of when to call Morebits.wiki.actionCompleted.event() is
* is managed through the globals Morebits.wiki.numberOfActionsLeft and
* Morebits.wiki.nbrOfCheckpointsLeft. Morebits.wiki.numberOfActionsLeft is
* incremented at the start of every Morebits.wiki.api call and decremented
* after the completion of a callback function. If a callback function does
* does not create a new Morebits.wiki.api object before exiting, it is the final
* final step in the processing chain and Morebits.wiki.actionCompleted.event() will
* will then be called.
*
* Optionally, callers may use Morebits.wiki.addCheckpoint() to indicate that
* processing is not complete upon the conclusion of the final callback function.
* function. This is used for batch operations. The end of a batch is signaled by calling
* signaled by calling Morebits.wiki.removeCheckpoint().
*
* @memberof Morebits.wiki
*/
 
Morebits.wiki.numberOfActionsLeft = 0;
Morebits.wiki.nbrOfCheckpointsLeft = 0;
 
Morebits.wiki.actionCompleted = function(self) {
if (--Morebits.wiki.numberOfActionsLeft <= 0 && Morebits.wiki.nbrOfCheckpointsLeft <= 0) {
Line 1,412 ⟶ 2,216:
 
// Change per action wanted
/** @memberof Morebits.wiki */
Morebits.wiki.actionCompleted.event = function() {
if (Morebits.wiki.actionCompleted.notice) {
Line 1,430 ⟶ 2,235:
};
 
/** @memberof Morebits.wiki */
Morebits.wiki.actionCompleted.timeOut = typeof window.wpActionCompletedTimeOut === 'undefined' ? 5000 : window.wpActionCompletedTimeOut;
/** @memberof Morebits.wiki */
Morebits.wiki.actionCompleted.redirect = null;
/** @memberof Morebits.wiki */
Morebits.wiki.actionCompleted.notice = null;
 
/** @memberof Morebits.wiki */
Morebits.wiki.addCheckpoint = function() {
++Morebits.wiki.nbrOfCheckpointsLeft;
};
 
/** @memberof Morebits.wiki */
Morebits.wiki.removeCheckpoint = function() {
if (--Morebits.wiki.nbrOfCheckpointsLeft <= 0 && Morebits.wiki.numberOfActionsLeft <= 0) {
Line 1,444 ⟶ 2,254:
};
 
/**
* **************** Morebits.wiki.api ****************
* An easy way to talk to the MediaWiki API.
*/
 
/* **************** Morebits.wiki.api **************** */
/**
* An easy way to talk to the MediaWiki API. Accepts either json or xml
* @constructor
* (default) formats; if json is selected, will default to `formatversion=2`
* @param {string} currentAction - The current action (required)
* unless otherwise specified. Similarly, enforces newer `errorformat`s,
* @param {Object} query - The query (required)
* defaulting to `html` if unspecified. `uselang` enforced to the wiki's
* @param {Function} [onSuccess] - The function to call when request gotten
* content language.
* @param {Object} [statusElement] - A Morebits.status object to use for status messages (optional)
*
* @param {Function} [onError] - The function to call if an error occurs (optional)
* In new code, the use of the last 3 parameters should be avoided, instead
* use {@link Morebits.wiki.api#setStatusElement|setStatusElement()} to bind
* the status element (if needed) and use `.then()` or `.catch()` on the
* promise returned by `post()`, rather than specify the `onSuccess` or
* `onFailure` callbacks.
*
* @memberof Morebits.wiki
* @class
* @param {string} currentAction - The current action (required).
* @param {object} query - The query (required).
* @param {Function} [onSuccess] - The function to call when request is successful.
* @param {Morebits.status} [statusElement] - A Morebits.status object to use for status messages.
* @param {Function} [onError] - The function to call if an error occurs.
*/
Morebits.wiki.api = function(currentAction, query, onSuccess, statusElement, onError) {
Line 1,461 ⟶ 2,281:
this.query = query;
this.query.assert = 'user';
// Enforce newer error formats, preferring html
if (!query.errorformat || ['wikitext', 'plaintext'].indexOf(query.errorformat) === -1) {
this.query.errorformat = 'html';
}
// Explicitly use the wiki's content language to minimize confusion,
// see #1179 for discussion
this.query.uselang = 'content';
this.query.errorlang = 'uselang';
this.query.errorsuselocal = 1;
 
this.onSuccess = onSuccess;
this.onError = onError;
if (statusElement) {
this.statelem = setStatusElement(statusElement);
this.statelem.status(currentAction);
} else {
this.statelem = new Morebits.status(currentAction);
}
// JSON is used throughout Morebits/Twinkle, but xml remains the default for backwards compatibility
if (!query.format) {
this.query.format = 'xml';
} else if (query.format === 'json' && !query.formatversion) {
this.query.formatversion = '2';
} else if (['xml', 'json'].indexOf(query.format) === -1) {
this.statelem.error('Invalid API format: only xml and json are supported.');
}
 
// Ignore tags for queries and most common unsupported actions, produces warnings
if (query.action && ['query', 'review', 'stabilize', 'pagetriageaction', 'watch'].indexOf(query.action) !== -1) {
delete query.tags;
} else if (!query.tags && morebitsWikiChangeTag) {
query.tags = morebitsWikiChangeTag;
}
};
Line 1,484 ⟶ 2,323:
response: null,
responseXML: null, // use `response` instead; retained for backwards compatibility
setParent: function(parent) {
this.parent = parent;
}, // keep track of parent object for callbacks
statelem: null, // this non-standard name kept for backwards compatibility
statusText: null, // result received from the API, normally "success" or "error"
errorCode: null, // short text error code, if any, as documented in the MediaWiki API
errorText: null, // full error description, if any
badtokenRetry: false, // set to true if this on a retry attempted after a badtoken error
 
/**
* Keep track of parent object for callbacks.
* Carries out the request.
*
* @param {Object} callerAjaxParameters Do not specify a parameter unless you really
* @param {*} parent
* really want to give jQuery some extra parameters
*/
setParent: function(parent) {
this.parent = parent;
},
 
/** @param {Morebits.status} statusElement */
setStatusElement: function(statusElement) {
this.statelem = statusElement;
this.statelem.status(this.currentAction);
},
 
/**
* Carry out the request.
*
* @param {object} callerAjaxParameters - Do not specify a parameter unless you really
* really want to give jQuery some extra parameters.
* @returns {promise} - A jQuery promise object that is resolved or rejected with the api object.
*/
post: function(callerAjaxParameters) {
Line 1,512 ⟶ 2,366:
var ajaxparams = $.extend({}, {
context: this,
type: this.query.action === 'query' ? 'GET' : 'POST',
url: mw.util.wikiScript('api'),
data: queryString,
dataType: 'xml'this.query.format,
headers: {
'Api-User-Agent': morebitsWikiApiUserAgent
Line 1,521 ⟶ 2,375:
}, callerAjaxParameters);
 
return $.ajax(ajaxparams).donethen(
 
function(response, statusText) {
function onAPIsuccess(response, statusText) {
this.statusText = statusText;
this.response = this.responseXML = response;
// Limit to first error
if (this.query.format === 'json') {
this.errorCode = response.errorerrors && response.errorerrors[0].code;
if (this.query.errorformat === 'html') {
this.errorText = response.error && response.error.info;
this.errorText = response.errors && response.errors[0].html;
} else if (this.query.errorformat === 'wikitext' || this.query.errorformat === 'plaintext') {
this.errorText = response.errors && response.errors[0].text;
}
} else {
this.errorCode = $(response).find('errors error').eq(0).attr('code');
// Sufficient for html, wikitext, or plaintext errorformats
this.errorText = $(response).find('error').attr('info');
this.errorText = $(response).find('errors error').eq(0).text();
}
 
if (typeof this.errorCode === 'string') {
 
// the API didn't like what we told it, e.g., bad edit token or an error creating a page
return this.returnError(callerAjaxParameters);
return;
}
 
// invoke success callback if one was supplied
if (this.onSuccess) {
 
// set the callback context to this.parent for new code and supply the API object
// as the first argument to the callback (for legacy code)
this.onSuccess.call(this.parent, this);
} else {
this.statelem.info(msg('done', 'done'));
}
 
Morebits.wiki.actionCompleted();
 
}
return $.Deferred().resolveWith(this.parent, [this]);
).fail(
},
 
// only network and server errors reach here - complaints from the API itself are caught in success()
function onAPIfailure(jqXHR, statusText, errorThrown) {
this.statusText = statusText;
this.errorThrown = errorThrown; // frequently undefined
this.errorText = msg('api-error', statusText, jqXHR.statusText, statusText + ' "' + jqXHR.statusText + '" occurred while contacting the API.');
return this.returnError();
}
 
); // the return value should be ignored, unless using callerAjaxParameters with |async: false|
);
},
 
returnError: function(callerAjaxParameters) {
if (this.errorCode === 'badtoken' && !this.badtokenRetry) {
this.statelem.errorwarn(msg('invalid-token-retrying', 'Invalid token. RefreshGetting thea pagenew token and try againretrying...'));
this.badtokenRetry = true;
} else {
// Get a new CSRF token and retry. If the original action needs a different
this.statelem.error(this.errorText);
// type of action than CSRF, we do one pointless retry before bailing out
return Morebits.wiki.api.getToken().then(function(token) {
this.query.token = token;
return this.post(callerAjaxParameters);
}.bind(this));
}
 
this.statelem.error(this.errorText + ' (' + this.errorCode + ')');
 
// invoke failure callback if one was supplied
Line 1,578 ⟶ 2,446:
}
// don't complete the action so that the error remains displayed
 
return $.Deferred().rejectWith(this.parent, [this]);
},
 
Line 1,602 ⟶ 2,472:
};
 
var morebitsWikiApiUserAgent = 'morebits.js ([[w:WT:TW]])';
// Custom user agent header, used by WMF for server-side logging
// See https://lists.wikimedia.org/pipermail/mediawiki-api-announce/2014-November/000075.html
var morebitsWikiApiUserAgent = 'morebits.js/2.0 ([[w:WT:TW]])';
 
/**
* SetsSet the custom user agent header, which is used for server-side logging.
* Note that doing so will set the useragent for every `Morebits.wiki.api`
* @param {string} ua User agent
* process performed thereafter.
*
* @see {@link https://lists.wikimedia.org/pipermail/mediawiki-api-announce/2014-November/000075.html}
* for original announcement.
*
* @memberof Morebits.wiki.api
* @param {string} [ua=morebits.js ([[w:WT:TW]])] - User agent. The default
* value of `morebits.js ([[w:WT:TW]])` will be appended to any provided
* value.
*/
Morebits.wiki.api.setApiUserAgent = function(ua) {
morebitsWikiApiUserAgent = (ua ? ua + ' ' : '') + 'morebits.js/2.0 ([[w:WT:TW]])';
};
 
Line 1,617 ⟶ 2,493:
 
/**
* Change/revision tag applied to Morebits actions when no other tags are specified.
* **************** Morebits.wiki.page ****************
* Unused by default per {@link https://en.wikipedia.org/w/index.php?oldid=970618849#Adding_tags_to_Twinkle_edits_and_actions|EnWiki consensus}.
* Uses the MediaWiki API to load a page and optionally edit it, move it, etc.
*
* @constant
* @memberof Morebits.wiki.api
* @type {string}
*/
var morebitsWikiChangeTag = '';
 
 
/**
* Get a new CSRF token on encountering token errors.
*
* @memberof Morebits.wiki.api
* @returns {string} MediaWiki CSRF token.
*/
Morebits.wiki.api.getToken = function() {
var tokenApi = new Morebits.wiki.api(msg('getting-token', 'Getting token'), {
action: 'query',
meta: 'tokens',
type: 'csrf',
format: 'json'
});
return tokenApi.post().then(function(apiobj) {
return apiobj.response.query.tokens.csrftoken;
});
};
 
 
/* **************** Morebits.wiki.page **************** */
/**
* Use the MediaWiki API to load a page and optionally edit it, move it, etc.
*
* Callers are not permitted to directly access the properties of this class!
* All property access is through the appropriate get___() or set___() method.
*
* Callers should set {@link Morebits.wiki.actionCompleted.notice} and {@link Morebits.wiki.actionCompleted.redirect}
* before the first call to {@link Morebits.wiki.page.load()}.
*
* Each of the callback functions takes one parameter, which is a
Line 1,631 ⟶ 2,537:
*
*
* Call sequence for common operations (optional final user callbacks not shown):
* HIGHLIGHTS:
*
* - Edit current contents of a page (no edit conflict):
* Constructor: Morebits.wiki.page(pageName, currentAction)
* `.load(userTextEditCallback) -> ctx.loadApi.post() ->
* pageName - the name of the page, prefixed by the namespace (if any)
* ctx.loadApi.post.success() -> ctx.fnLoadSuccess() -> userTextEditCallback() ->
* (for the current page, use mw.config.get('wgPageName'))
* .save() -> ctx.saveApi.post() -> ctx.loadApi.post.success() -> ctx.fnSaveSuccess()`
* currentAction - a string describing the action about to be undertaken (optional)
*
* - Edit current contents of a page (with edit conflict):
* onSuccess and onFailure are callback functions called when the operation is a success or failure
* `.load(userTextEditCallback) -> ctx.loadApi.post() ->
* if enclosed in [brackets], it indicates that it is optional
* ctx.loadApi.post.success() -> ctx.fnLoadSuccess() -> userTextEditCallback() ->
* .save() -> ctx.saveApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnSaveError() -> ctx.loadApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnLoadSuccess() -> userTextEditCallback() -> .save() ->
* ctx.saveApi.post() -> ctx.loadApi.post.success() -> ctx.fnSaveSuccess()`
*
* - Append to a page (similar for prepend and newSection):
* load(onSuccess, [onFailure]): Loads the text for the page
* `.append() -> ctx.loadApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnLoadSuccess() -> ctx.fnAutoSave() -> .save() -> ctx.saveApi.post() ->
* ctx.loadApi.post.success() -> ctx.fnSaveSuccess()`
*
* Notes:
* getPageText(): returns a string containing the text of the page after a successful load()
* 1. All functions following Morebits.wiki.api.post() are invoked asynchronously from the jQuery AJAX library.
* 2. The sequence for append/prepend/newSection could be slightly shortened,
* but it would require significant duplication of code for little benefit.
*
* save([onSuccess], [onFailure]): Saves the text set via setPageText() for the page.
* Must be preceded by calling load().
* Warning: Calling save() can result in additional calls to the previous load() callbacks to
* recover from edit conflicts!
* In this case, callers must make the same edit to the new pageText and reinvoke save().
* This behavior can be disabled with setMaxConflictRetries(0).
*
* append([onSuccess], [onFailure]): Adds the text provided via setAppendText() to the end of
* the page. Does not require calling load() first.
*
* prepend([onSuccess], [onFailure]): Adds the text provided via setPrependText() to the start
* of the page. Does not require calling load() first.
*
* move([onSuccess], [onFailure]): Moves a page to another title
*
* deletePage([onSuccess], [onFailure]): Deletes a page (for admins only)
*
* undeletePage([onSuccess], [onFailure]): Undeletes a page (for admins only)
*
* protect([onSuccess], [onFailure]): Protects a page
*
* getPageName(): returns a string containing the name of the loaded page, including the namespace
*
* setPageText(pageText) sets the updated page text that will be saved when save() is called
*
* setAppendText(appendText) sets the text that will be appended to the page when append() is called
*
* setPrependText(prependText) sets the text that will be prepended to the page when prepend() is called
*
* setCallbackParameters(callbackParameters)
* callbackParameters - an object for use in a callback function
*
* getCallbackParameters(): returns the object previous set by setCallbackParameters()
*
* Callback notes: callbackParameters is for use by the caller only. The parameters
* allow a caller to pass the proper context into its callback function.
* Callers must ensure that any changes to the callbackParameters object
* within a load() callback still permit a proper re-entry into the
* load() callback if an edit conflict is detected upon calling save().
*
* getStatusElement(): returns the Status element created by the constructor
*
* exists(): returns true if the page existed on the wiki when it was last loaded
*
* getCurrentID(): returns a string containing the current revision ID of the page
*
* lookupCreation(onSuccess): Retrieves the username and timestamp of page creation
* onSuccess - callback function which is called when the username and timestamp
* are found within the callback.
* The username can be retrieved using the getCreator() function;
* the timestamp can be retrieved using the getCreationTimestamp() function
*
* getCreator(): returns the user who created the page following lookupCreation()
*
* getCreationTimestamp(): returns an ISOString timestamp of page creation following lookupCreation()
*
* @memberof Morebits.wiki
* @class
* @param {string} pageName - The name of the page, prefixed by the namespace (if any).
* For the current page, use `mw.config.get('wgPageName')`.
* @param {string|Morebits.status} [status] - A string describing the action about to be undertaken,
* or a Morebits.status object
*/
Morebits.wiki.page = function(pageName, status) {
 
if (!status) {
/**
status = msg('opening-page', pageName, 'Opening page "' + pageName + '"');
* Call sequence for common operations (optional final user callbacks not shown):
*
* Edit current contents of a page (no edit conflict):
* .load(userTextEditCallback) -> ctx.loadApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnLoadSuccess() -> userTextEditCallback() -> .save() ->
* ctx.saveApi.post() -> ctx.loadApi.post.success() -> ctx.fnSaveSuccess()
*
* Edit current contents of a page (with edit conflict):
* .load(userTextEditCallback) -> ctx.loadApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnLoadSuccess() -> userTextEditCallback() -> .save() ->
* ctx.saveApi.post() -> ctx.loadApi.post.success() -> ctx.fnSaveError() ->
* ctx.loadApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnLoadSuccess() -> userTextEditCallback() -> .save() ->
* ctx.saveApi.post() -> ctx.loadApi.post.success() -> ctx.fnSaveSuccess()
*
* Append to a page (similar for prepend):
* .append() -> ctx.loadApi.post() -> ctx.loadApi.post.success() ->
* ctx.fnLoadSuccess() -> ctx.fnAutoSave() -> .save() ->
* ctx.saveApi.post() -> ctx.loadApi.post.success() -> ctx.fnSaveSuccess()
*
* Notes:
* 1. All functions following Morebits.wiki.api.post() are invoked asynchronously
* from the jQuery AJAX library.
* 2. The sequence for append/prepend could be slightly shortened, but it would require
* significant duplication of code for little benefit.
*/
 
/**
* @constructor
* @param {string} pageName The name of the page, prefixed by the namespace (if any)
* For the current page, use mw.config.get('wgPageName')
* @param {string} [currentAction] A string describing the action about to be undertaken (optional)
*/
Morebits.wiki.page = function(pageName, currentAction) {
 
if (!currentAction) {
currentAction = 'Opening page "' + pageName + '"';
}
 
/**
* Private context variables.
*
* This context is not visible to the outside, thus all the data here
* must be accessed via getter and setter functions.
*
* @private
*/
var ctx = {
Line 1,754 ⟶ 2,589:
pageExists: false,
editSummary: null,
changeTags: null,
testActions: null, // array if any valid actions
callbackParameters: null,
statusElement: status instanceof Morebits.status ? status : new Morebits.status(currentActionstatus),
 
// - edit
Line 1,762 ⟶ 2,599:
appendText: null, // can't reuse pageText for this because pageText is needed to follow a redirect
prependText: null, // can't reuse pageText for this because pageText is needed to follow a redirect
newSectionText: null,
newSectionTitle: null,
createOption: null,
minorEdit: false,
Line 1,769 ⟶ 2,608:
maxRetries: 2,
followRedirect: false,
followCrossNsRedirect: true,
watchlistOption: 'nochange',
watchlistExpiry: null,
creator: null,
timestamp: null,
Line 1,786 ⟶ 2,627:
protectMove: null,
protectCreate: null,
protectCascade: falsenull,
 
// - creation lookup
Line 1,796 ⟶ 2,637:
// internal status
pageLoaded: false,
editTokencsrfToken: null,
loadTime: null,
lastEditTime: null,
pageID: null,
contentModel: null,
revertCurID: null,
revertUser: null,
watched: false,
fullyProtected: false,
suppressProtectWarning: false,
Line 1,812 ⟶ 2,656:
onSaveFailure: null,
onLookupCreationSuccess: null,
onLookupCreationFailure: null,
onMoveSuccess: null,
onMoveFailure: null,
Line 1,830 ⟶ 2,675:
moveApi: null,
moveProcessApi: null,
patrolApi: null,
patrolProcessApi: null,
triageApi: null,
triageProcessListApi: null,
triageProcessApi: null,
deleteApi: null,
deleteProcessApi: null,
Line 1,843 ⟶ 2,693:
 
/**
* Loads the text for the page.
*
* @param {Function} onSuccess - callback function which is called when the load has succeeded
* @param {Function} [onFailure]onSuccess - callbackCallback function which is called when the load failshas (optional)succeeded.
* @param {Function} [onFailure] - Callback function which is called when the load fails.
*/
this.load = function(onSuccess, onFailure) {
Line 1,861 ⟶ 2,712:
action: 'query',
prop: 'info|revisions',
inprop: 'watched',
intoken: 'edit', // fetch an edit token
intestactions: 'edit', // can be expanded
titles: ctx.pageName
curtimestamp: '',
meta: 'tokens',
type: 'csrf',
titles: ctx.pageName,
format: 'json'
// don't need rvlimit=1 because we don't need rvstartid here and only one actual rev is returned by default
};
Line 1,881 ⟶ 2,737:
}
if (Morebits.userIsSysop) {
ctx.loadQuery.inprop += '|protection';
}
 
ctx.loadApi = new Morebits.wiki.api(msg('retrieving-page', 'Retrieving page...'), ctx.loadQuery, fnLoadSuccess, ctx.statusElement, ctx.onLoadFailure);
ctx.loadApi.setParent(this);
ctx.loadApi.post();
Line 1,890 ⟶ 2,746:
 
/**
* Saves the text for the page to Wikipedia.
* Must be preceded by successfully calling `load()`.
*
* Warning: Calling `save()` can result in additional calls to the previous load() callbacks
* previous `load()` callbacks to recover from edit conflicts! In this
* In this case, callers must make the same edit to the new pageText and reinvoke save().
* re-invoke `save()`. This behavior can be disabled with
* `setMaxConflictRetries(0)`.
*
* @param {Function} [onSuccess] - callback function which is called when the save has
* @param {Function} [onSuccess] - Callback function which is called when the save has succeeded.
* succeeded (optional)
* @param {Function} [onFailure] - callbackCallback function which is called when the save fails.
* (optional)
*/
this.save = function(onSuccess, onFailure) {
Line 1,906 ⟶ 2,762:
ctx.onSaveFailure = onFailure || emptyFunction;
 
// are we getting our editediting token from mw.user.tokens?
var canUseMwUserToken = fnCanUseMwUserToken('edit');
 
Line 1,915 ⟶ 2,771:
}
if (!ctx.editSummary) {
// new section mode allows (nay, encourages) using the
ctx.statusElement.error('Internal error: edit summary not set before save!');
// title as the edit summary, but the query needs
ctx.onSaveFailure(this);
// editSummary to be undefined or '', not null
return;
if (ctx.editMode === 'new' && ctx.newSectionTitle) {
ctx.editSummary = '';
} else {
ctx.statusElement.error('Internal error: edit summary not set before save!');
ctx.onSaveFailure(this);
return;
}
}
 
// shouldn't happen if canUseMwUserToken === true
if (ctx.fullyProtected && !ctx.suppressProtectWarning &&
!confirm(
!confirm('You are about to make an edit to the fully protected page "' + ctx.pageName +
( ctx.fullyProtected === 'infinity' ? '" (protected indefinitely)' : '" (protection expiring ' + ctx.fullyProtected + ')') +
? msg('protected-indef-edit-warning', ctx.pageName,
'. \n\nClick OK to proceed with the edit, or Cancel to skip this edit.')) {
'You are about to make an edit to the fully protected page "' + ctx.pageName + '" (protected indefinitely). \n\nClick OK to proceed with the edit, or Cancel to skip this edit.'
ctx.statusElement.error('Edit to fully protected page was aborted.');
)
: msg('protected-edit-warning', ctx.pageName, ctx.fullyProtected,
'You are about to make an edit to the fully protected page "' + ctx.pageName +
'" (protection expiring ' + new Morebits.date(ctx.fullyProtected).calendar('utc') + ' (UTC)). \n\nClick OK to proceed with the edit, or Cancel to skip this edit.'
)
)
) {
ctx.statusElement.error(msg('protected-aborted', 'Edit to fully protected page was aborted.'));
ctx.onSaveFailure(this);
return;
Line 1,936 ⟶ 2,807:
title: ctx.pageName,
summary: ctx.editSummary,
token: canUseMwUserToken ? mw.user.optionstokens.get('csrfToken') : ctx.editTokencsrfToken,
watchlist: ctx.watchlistOption,
format: 'json'
};
if (ctx.changeTags) {
query.tags = ctx.changeTags;
}
 
if (fnApplyWatchlistExpiry()) {
query.watchlistexpiry = ctx.watchlistExpiry;
}
 
if (typeof ctx.pageSection === 'number') {
Line 1,951 ⟶ 2,830:
}
 
// Set bot edit attribute. If this paramterparameter is present with any value, it is interpreted as true
if (ctx.botEdit) {
query.bot = true;
Line 1,958 ⟶ 2,837:
switch (ctx.editMode) {
case 'append':
if (ctx.appendText === null) {
ctx.statusElement.error('Internal error: append text not set before save!');
ctx.onSaveFailure(this);
return;
}
query.appendtext = ctx.appendText; // use mode to append to current page contents
break;
case 'prepend':
if (ctx.prependText === null) {
ctx.statusElement.error('Internal error: prepend text not set before save!');
ctx.onSaveFailure(this);
return;
}
query.prependtext = ctx.prependText; // use mode to prepend to current page contents
break;
case 'new':
if (!ctx.newSectionText) { // API doesn't allow empty new section text
ctx.statusElement.error('Internal error: new section text not set before save!');
ctx.onSaveFailure(this);
return;
}
query.section = 'new';
query.text = ctx.newSectionText; // add a new section to current page
query.sectiontitle = ctx.newSectionTitle || ctx.editSummary; // done by the API, but non-'' values would get treated as text
break;
case 'revert':
Line 1,971 ⟶ 2,870:
query.starttimestamp = ctx.loadTime; // check that page hasn't been deleted since it was loaded (don't recreate bad stuff)
break;
default: // 'all'
query.text = ctx.pageText; // replace entire contents of the page
if (ctx.lastEditTime) {
Line 1,988 ⟶ 2,887:
}
 
ctx.saveApi = new Morebits.wiki.api(msg('saving-page', 'Saving page...'), query, fnSaveSuccess, ctx.statusElement, fnSaveError);
ctx.saveApi.setParent(this);
ctx.saveApi.post();
Line 1,994 ⟶ 2,893:
 
/**
* Adds the text provided via `setAppendText()` to the end of the page.
* page. Does not require calling `load()` first., unless a watchlist
* expiry is used.
* @param {Function} [onSuccess] - callback function which is called when the method has succeeded (optional)
*
* @param {Function} [onFailure] - callback function which is called when the method fails (optional)
* @param {Function} [onSuccess] - Callback function which is called when the method has succeeded.
* @param {Function} [onFailure] - Callback function which is called when the method fails.
*/
this.append = function(onSuccess, onFailure) {
Line 2,012 ⟶ 2,913:
 
/**
* Adds the text provided via `setPrependText()` to the start of the page.
* page. Does not require calling `load()` first., unless a watchlist
* expiry is used.
* @param {Function} [onSuccess] - callback function which is called when the method has succeeded (optional)
*
* @param {Function} [onFailure] - callback function which is called when the method fails (optional)
* @param {Function} [onSuccess] - Callback function which is called when the method has succeeded.
* @param {Function} [onFailure] - Callback function which is called when the method fails.
*/
this.prepend = function(onSuccess, onFailure) {
Line 2,029 ⟶ 2,932:
};
 
/**
/** @returns {string} string containing the name of the loaded page, including the namespace */
* Creates a new section with the text provided by `setNewSectionText()`
* and section title from `setNewSectionTitle()`.
* If `editSummary` is provided, that will be used instead of the
* autogenerated "->Title (new section" edit summary.
* Does not require calling `load()` first, unless a watchlist expiry
* is used.
*
* @param {Function} [onSuccess] - Callback function which is called when the method has succeeded.
* @param {Function} [onFailure] - Callback function which is called when the method fails.
*/
this.newSection = function(onSuccess, onFailure) {
ctx.editMode = 'new';
 
if (fnCanUseMwUserToken('edit')) {
this.save(onSuccess, onFailure);
} else {
ctx.onSaveSuccess = onSuccess;
ctx.onSaveFailure = onFailure || emptyFunction;
this.load(fnAutoSave, ctx.onSaveFailure);
}
};
 
/** @returns {string} The name of the loaded page, including the namespace */
this.getPageName = function() {
return ctx.pageName;
};
 
/** @returns {string} string containing theThe text of the page after a successful load() */
this.getPageText = function() {
return ctx.pageText;
};
 
/** @param {string} pageText - updatedUpdated page text that will be saved when `save()` is called */
this.setPageText = function(pageText) {
ctx.editMode = 'all';
Line 2,045 ⟶ 2,971:
};
 
/** @param {string} appendText - textText that will be appended to the page when `append()` is called */
this.setAppendText = function(appendText) {
ctx.editMode = 'append';
Line 2,051 ⟶ 2,977:
};
 
/** @param {string} prependText - textText that will be prepended to the page when `prepend()` is called */
this.setPrependText = function(prependText) {
ctx.editMode = 'prepend';
ctx.prependText = prependText;
};
 
/** @param {string} newSectionText - Text that will be added in a new section on the page when `newSection()` is called */
this.setNewSectionText = function(newSectionText) {
ctx.editMode = 'new';
ctx.newSectionText = newSectionText;
};
 
/**
* @param {string} newSectionTitle - Title for the new section created when `newSection()` is called
* If missing, `ctx.editSummary` will be used. Issues may occur if a substituted template is used.
*/
this.setNewSectionTitle = function(newSectionTitle) {
ctx.editMode = 'new';
ctx.newSectionTitle = newSectionTitle;
};
 
Line 2,060 ⟶ 3,001:
 
// Edit-related setter methods:
/**
/** @param {string} summary - text of the edit summary that will be used when save() is called */
* Set the edit summary that will be used when `save()` is called.
* Unnecessary if editMode is 'new' and newSectionTitle is provided.
*
* @param {string} summary
*/
this.setEditSummary = function(summary) {
ctx.editSummary = summary;
Line 2,066 ⟶ 3,012:
 
/**
* Set any custom tag(s) to be applied to the API action.
* @param {string} createOption - can take the following four values:
* A number of actions don't support it, most notably watch, review,
* `recreate` - create the page if it does not exist, or edit it if it exists.
* and stabilize ({@link https://phabricator.wikimedia.org/T247721|T247721}), and
* `createonly` - create the page if it does not exist, but return an error if it
* pagetriageaction ({@link https://phabricator.wikimedia.org/T252980|T252980}).
* already exists.
*
* `nocreate` - don't create the page, only edit it if it already exists.
* @param {string|string[]} tags - String or array of tag(s).
* null - create the page if it does not exist, unless it was deleted in the moment
*/
* between retrieving the edit token and saving the edit (default)
this.setChangeTags = function(tags) {
ctx.changeTags = tags;
};
 
 
/**
* @param {string} [createOption=null] - Can take the following four values:
* - recreate: create the page if it does not exist, or edit it if it exists.
* - createonly: create the page if it does not exist, but return an
* error if it already exists.
* - nocreate: don't create the page, only edit it if it already exists.
* - `null`: create the page if it does not exist, unless it was deleted
* in the moment between loading the page and saving the edit (default).
*
*/
Line 2,079 ⟶ 3,038:
};
 
/** @param {boolean} minorEdit - setSet true to mark the edit as a minor edit. */
this.setMinorEdit = function(minorEdit) {
ctx.minorEdit = minorEdit;
};
 
/** @param {boolean} botEdit - setSet true to mark the edit as a bot edit */
this.setBotEdit = function(botEdit) {
ctx.botEdit = botEdit;
Line 2,090 ⟶ 3,049:
 
/**
* @param {number} pageSection - integerInteger specifying the section number to load or save.
* If specified as `null`, the entire page will be retrieved.
*/
Line 2,098 ⟶ 3,057:
 
/**
* @param {number} maxConflictRetries - numberNumber of retries for save errors involving an edit conflict or
* loss of edit token. Default: 2.
*/
this.setMaxConflictRetries = function(maxConflictRetries) {
Line 2,106 ⟶ 3,065:
 
/**
* @param {number} maxRetries - numberNumber of retries for save errors not involving an edit conflict or
* loss of edit token. Default: 2.
*/
this.setMaxRetries = function(maxRetries) {
Line 2,114 ⟶ 3,073:
 
/**
* Set whether and how to watch the page, including setting an expiry.
* @param {boolean} watchlistOption
*
* True - page will be added to the user's watchlist when save() is called
* @param {boolean|string|Morebits.date|Date} [watchlistOption=false] -
* False - watchlist status of the page will not be changed (default)
* Basically a mix of MW API and Twinkley options available pre-expiry:
* - `true`|`'yes'`|`'watch'`: page will be added to the user's
* watchlist when the action is called. Defaults to an indefinite
* watch unless `watchlistExpiry` is provided.
* - `false`|`'no'`|`'nochange'`: watchlist status of the page (including expiry) will not be changed.
* - `'default'`|`'preferences'`: watchlist status of the page will be
* set based on the user's preference settings when the action is
* called. Defaults to an indefinite watch unless `watchlistExpiry` is
* provided.
* - `'unwatch'`: explicitly unwatch the page.
* - Any other `string` or `number`, or a `Morebits.date` or `Date`
* object: watch page until the specified time, deferring to
* `watchlistExpiry` if provided.
* @param {string|number|Morebits.date|Date} [watchlistExpiry=infinity] -
* A date-like string or number, or a date object. If a string or number,
* can be relative (2 weeks) or other similarly date-like (i.e. NOT "potato"):
* ISO 8601: 2038-01-09T03:14:07Z
* MediaWiki: 20380109031407
* UNIX: 2147483647
* SQL: 2038-01-09 03:14:07
* Can also be `infinity` or infinity-like (`infinite`, `indefinite`, and `never`).
* See {@link https://phabricator.wikimedia.org/source/mediawiki-libs-Timestamp/browse/master/src/ConvertibleTimestamp.php;4e53b859a9580c55958078f46dd4f3a44d0fcaa0$57-109?as=source&blame=off}
*/
this.setWatchlist = function(watchlistOption, watchlistExpiry) {
if (watchlistOption instanceof Morebits.date || watchlistOption instanceof Date) {
ctx.watchlistOption = 'watch'watchlistOption.toISOString();
} else {
if (typeof watchlistExpiry === 'undefined') {
ctx.watchlistOption = 'nochange';
watchlistExpiry = 'infinity';
} else if (watchlistExpiry instanceof Morebits.date || watchlistExpiry instanceof Date) {
watchlistExpiry = watchlistExpiry.toISOString();
}
 
switch (watchlistOption) {
case 'nochange':
case 'no':
case false:
case undefined:
ctx.watchlistOption = 'nochange';
// The MW API allows for changing expiry with nochange (as "nochange" refers to the binary status),
// but by keeping this null it will default to any existing expiry, ensure there is actually "no change."
ctx.watchlistExpiry = null;
break;
case 'unwatch':
// expiry unimportant
ctx.watchlistOption = 'unwatch';
break;
case 'preferences':
case 'default':
ctx.watchlistOption = 'preferences';
// The API allows an expiry here, but there is as of yet (T265716)
// no expiry preference option, so it's a bit devoid of context.
ctx.watchlistExpiry = watchlistExpiry;
break;
case 'watch':
case 'yes':
case true:
ctx.watchlistOption = 'watch';
ctx.watchlistExpiry = watchlistExpiry;
break;
default: // Not really a "default" per se but catches "any other string"
ctx.watchlistOption = 'watch';
ctx.watchlistExpiry = watchlistOption;
break;
}
};
 
/**
* Set a watchlist expiry. setWatchlist can mostly handle this by
* itself, so this is here largely for completeness and compatibility
* with the full suite of options.
*
* @param {string|number|Morebits.date|Date} [watchlistExpiry=infinity] -
* A date-like string or number, or a date object. If a string or number,
* can be relative (2 weeks) or other similarly date-like (i.e. NOT "potato"):
* ISO 8601: 2038-01-09T03:14:07Z
* MediaWiki: 20380109031407
* UNIX: 2147483647
* SQL: 2038-01-09 03:14:07
* Can also be `infinity` or infinity-like (`infinite`, `indefinite`, and `never`).
* See {@link https://phabricator.wikimedia.org/source/mediawiki-libs-Timestamp/browse/master/src/ConvertibleTimestamp.php;4e53b859a9580c55958078f46dd4f3a44d0fcaa0$57-109?as=source&blame=off}
*/
this.setWatchlistExpiry = function(watchlistExpiry) {
if (typeof watchlistExpiry === 'undefined') {
watchlistExpiry = 'infinity';
} else if (watchlistExpiry instanceof Morebits.date || watchlistExpiry instanceof Date) {
watchlistExpiry = watchlistExpiry.toISOString();
}
ctx.watchlistExpiry = watchlistExpiry;
};
 
/**
* @deprecated As of December 2020, use setWatchlist.
* @param {boolean} watchlistOption
* @param {boolean} [watchlistOption=false] -
* True - page watchlist status will be set based on the user's
* - `True`: page watchlist status will be set based on the user's
* preference settings when save() is called.
* preference settings when `save()` is called.
* False - watchlist status of the page will not be changed (default)
* - `False`: watchlist status of the page will not be changed.
*
* Watchlist notes:
* 1. The MediaWiki API value of 'unwatch', which explicitly removes the page from the
* the page from the user's watchlist, is not used.
* 2. If both `setWatchlist()` and `setWatchlistFromPreferences()` are called,
* called, the last call takes priority.
* 3. Twinkle modules should use the appropriate preference to set the watchlist options.
* 4. Most Twinkle modules use `setWatchlist()`. `setWatchlistFromPreferences()`
* setWatchlistFromPreferences() is only needed for the few Twinkle watchlist preferences that
* that accept a string value of '`default'`.
*/
this.setWatchlistFromPreferences = function(watchlistOption) {
console.warn('NOTE: Morebits.wiki.page.setWatchlistFromPreferences was deprecated December 2020, please use setWatchlist'); // eslint-disable-line no-console
if (watchlistOption) {
ctx.watchlistOption = 'preferences';
Line 2,151 ⟶ 3,194:
 
/**
* @param {boolean} [followRedirect=false] -
* - `true -`: a maximum of one redirect will be followed. In the event
* In the event of a redirect, a message is displayed to the user and the redirect
* the redirect target can be retrieved with getPageName().
* - `false`: -(default) the requested pageName will be used without regard to any redirect (default).
* @param {boolean} [followCrossNsRedirect=true] - Not applicable if `followRedirect` is not set true.
* - `true`: (default) follow redirect even if it is a cross-namespace redirect
* - `false`: don't follow redirect if it is cross-namespace, edit the redirect itself.
*/
this.setFollowRedirect = function(followRedirect, followCrossNsRedirect) {
if (ctx.pageLoaded) {
ctx.statusElement.error('Internal error: cannot change redirect setting after the page has been loaded!');
Line 2,163 ⟶ 3,209:
}
ctx.followRedirect = followRedirect;
ctx.followCrossNsRedirect = typeof followCrossNsRedirect !== 'undefined' ? followCrossNsRedirect : ctx.followCrossNsRedirect;
};
 
// lookup-creation setter function
/**
* @param {boolean} flag - ifIf set true, the author and timestamp of the first non-redirect
* the first non-redirect version of the page is retrieved.
*
* Warning:
* 1. If there are no revisions among the first 50 that are
* non-redirects, or if there are less 50 revisions and all are
* less 50 revisions and all are redirects, the original creation is retrivedretrieved.
* 2. Revisions that the user is not privileged to access
* (revdeled/suppressed) will be treated as non-redirects.
* as non-redirects.
* 3. Must not be used when the page has a non-wikitext contentmodel
* such as Modulespace Lua or user JavaScript/CSS.
*/
this.setLookupNonRedirectCreator = function(flag) {
Line 2,204 ⟶ 3,252:
 
// Protect-related setter functions
/**
* @param {string} level - The right required for the specific action
* e.g. autoconfirmed, sysop, templateeditor, extendedconfirmed
* (enWiki-only).
* @param {string} [expiry=infinity]
*/
this.setEditProtection = function(level, expiry) {
ctx.protectEdit = { level: level, expiry: expiry || 'infinity' };
};
 
this.setMoveProtection = function(level, expiry) {
ctx.protectMove = { level: level, expiry: expiry || 'infinity' };
};
 
this.setCreateProtection = function(level, expiry) {
ctx.protectCreate = { level: level, expiry: expiry || 'infinity' };
};
 
Line 2,229 ⟶ 3,283:
};
 
/** @returns {string} string containing theThe current revision ID of the page */
this.getCurrentID = function() {
return ctx.revertCurID;
};
 
/** @returns {string} lastLast editor of the page */
this.getRevisionUser = function() {
return ctx.revertUser;
};
 
/** @returns {string} ISO 8601 timestamp at which the page was last edited. */
this.getLastEditTime = function() {
return ctx.lastEditTime;
};
 
Line 2,242 ⟶ 3,301:
 
/**
* `callbackParameters` -Define an object for use in a callback function.
*
* `callbackParameters` is for use by the caller only. The parameters
* allow a caller to pass the proper context into its callback
* function. Callers must ensure that any changes to the
* callbackParameters object within a `load()` callback still permit a
* proper re-entry into the `load()` callback if an edit conflict is
* detected upon calling `save()`.
*
* Callback@param notes:{object} callbackParameters is for use by the caller only. The parameters
* allow a caller to pass the proper context into its callback function.
* Callers must ensure that any changes to the callbackParameters object
* within a load() callback still permit a proper re-entry into the
* load() callback if an edit conflict is detected upon calling save().
*/
this.setCallbackParameters = function(callbackParameters) {
Line 2,255 ⟶ 3,317:
 
/**
* @returns the{object} - The object previouspreviously set by `setCallbackParameters()`.
*/
this.getCallbackParameters = function() {
Line 2,262 ⟶ 3,324:
 
/**
* @returnsparam {Morebits.status} Status element created by the constructorstatusElement
*/
this.setStatusElement = function(statusElement) {
ctx.statusElement = statusElement;
};
 
/**
* @returns {Morebits.status} Status element created by the constructor.
*/
this.getStatusElement = function() {
Line 2,268 ⟶ 3,337:
};
 
/**
 
* @param {string} level - The right required for edits not to require
* review. Possible options: none, autoconfirmed, review (not on enWiki).
* @param {string} [expiry=infinity]
*/
this.setFlaggedRevs = function(level, expiry) {
ctx.flaggedRevs = { level: level, expiry: expiry || 'infinity' };
};
 
/**
* @returns {boolean} trueTrue if the page existed on the wiki when it was last loaded.
*/
this.exists = function() {
Line 2,281 ⟶ 3,354:
 
/**
* @returns {string} ISOPage 8601ID timestamp at whichof the page wasloaded. last0 loadedif the page doesn't
* exist.
*/
this.getPageID = function() {
return ctx.pageID;
};
 
/**
* @returns {string} - Content model of the page. Possible values
* include (but may not be limited to): `wikitext`, `javascript`,
* `css`, `json`, `Scribunto`, `sanitized-css`, `MassMessageListContent`.
* Also gettable via `mw.config.get('wgPageContentModel')`.
*/
this.getContentModel = function() {
return ctx.contentModel;
};
 
/**
* @returns {boolean|string} - Watched status of the page. Boolean
* unless it's being watched temporarily, in which case returns the
* expiry string.
*/
this.getWatched = function () {
return ctx.watched;
};
 
/**
* @returns {string} ISO 8601 timestamp at which the page was last loaded.
*/
this.getLoadTime = function() {
Line 2,288 ⟶ 3,388:
 
/**
* @returns {string} theThe user who created the page following `lookupCreation()`.
*/
this.getCreator = function() {
Line 2,295 ⟶ 3,395:
 
/**
* @returns {string} theThe ISOString timestamp of page creation following `lookupCreation()`.
*/
this.getCreationTimestamp = function() {
return ctx.timestamp;
};
 
/** @returns {boolean} whether or not you can edit the page */
this.canEdit = function() {
return !!ctx.testActions && ctx.testActions.indexOf('edit') !== -1;
};
 
/**
* Retrieves the username of the user who created the page as well as
* the timestamp of creation. The username can be retrieved using the
* `getCreator()` function; the timestamp can be retrieved using the
* @param {Function} onSuccess - callback function (required) which is
* `getCreationTimestamp()` function.
* called when the username and timestamp are found within the callback.
* Prior to June 2019 known as `lookupCreator()`.
* The username can be retrieved using the getCreator() function;
*
* the timestamp can be retrieved using the getCreationTimestamp() function
* @param {Function} onSuccess - Callback function to be called when
* the username and timestamp are found within the callback.
* @param {Function} [onFailure] - Callback function to be called when
* the lookup fails
*/
this.lookupCreation = function(onSuccess, onFailure) {
ctx.onLookupCreationSuccess = onSuccess;
ctx.onLookupCreationFailure = onFailure || emptyFunction;
if (!onSuccess) {
ctx.statusElement.error('Internal error: no onSuccess callback provided to lookupCreation()!');
ctx.onLookupCreationFailure(this);
return;
}
ctx.onLookupCreationSuccess = onSuccess;
 
var query = {
'action': 'query',
'prop': 'revisions',
'titles': ctx.pageName,
'rvlimit': 1,
'rvprop': 'user|timestamp',
'rvdir': 'newer',
format: 'json'
};
 
Line 2,339 ⟶ 3,451:
}
 
ctx.lookupCreationApi = new Morebits.wiki.api(msg('getting-creator', 'Retrieving page creation information'), query, fnLookupCreationSuccess, ctx.statusElement, ctx.onLookupCreationFailure);
ctx.lookupCreationApi.setParent(this);
ctx.lookupCreationApi.post();
};
/**
* @deprecated since May/June 2019, renamed to lookupCreation
*/
this.lookupCreator = function(onSuccess) {
console.warn("NOTE: lookupCreator() from Twinkle's Morebits has been deprecated since May/June 2019, please use lookupCreation() instead"); // eslint-disable-line no-console
Morebits.status.warn('NOTE', "lookupCreator() from Twinkle's Morebits has been deprecated since May/June 2019, please use lookupCreation() instead");
return this.lookupCreation(onSuccess);
};
 
/**
* marksReverts thea page asto patrolled,`revertOldID` ifset possibleby `setOldID`.
*/
* @param {Function} [onSuccess] - Callback function to run on success.
this.patrol = function() {
* @param {Function} [onFailure] - Callback function to run on failure.
// There's no patrol link on page, so we can't patrol
if (!$('.patrollink').length) {
return;
}
 
// Extract the rcid token from the "Mark page as patrolled" link on page
var patrolhref = $('.patrollink a').attr('href'),
rcid = mw.util.getParamValue('rcid', patrolhref);
 
if (rcid) {
 
var patrolstat = new Morebits.status('Marking page as patrolled');
 
var wikipedia_api = new Morebits.wiki.api('doing...', {
action: 'patrol',
rcid: rcid,
token: mw.user.options.get('patrolToken')
}, null, patrolstat);
 
// We don't really care about the response
wikipedia_api.post();
}
};
 
/**
* Reverts a page to revertOldID
* @param {Function} [onSuccess] - callback function to run on success (optional)
* @param {Function} [onFailure] - callback function to run on failure (optional)
*/
this.revert = function(onSuccess, onFailure) {
Line 2,400 ⟶ 3,477:
 
/**
* Moves a page to another title.
*
* @param {Function} [onSuccess] - callback function to run on success (optional)
* @param {Function} [onFailureonSuccess] - callbackCallback function to run on failure (optional)success.
* @param {Function} [onFailure] - Callback function to run on failure.
*/
this.move = function(onSuccess, onFailure) {
Line 2,408 ⟶ 3,486:
ctx.onMoveFailure = onFailure || emptyFunction;
 
if (!fnPreflightChecks.call(this, 'move', ctx.editSummaryonMoveFailure)) {
return; // abort
ctx.statusElement.error('Internal error: move reason not set before move (use setEditSummary function)!');
ctx.onMoveFailure(this);
return;
}
 
if (!ctx.moveDestination) {
ctx.statusElement.error('Internal error: destination page name was not set before move!');
Line 2,419 ⟶ 3,496:
}
 
if (fnCanUseMwUserToken('move')) {
var query = {
fnProcessMove.call(this, this);
action: 'query',
} else {
prop: 'info',
intoken:var query = fnNeedTokenInfoQuery('move',);
 
titles: ctx.pageName
ctx.moveApi = new Morebits.wiki.api(msg('getting-token', 'retrieving token...'), query, fnProcessMove, ctx.statusElement, ctx.onMoveFailure);
};
ctx.moveApi.setParent(this);
if (ctx.followRedirect) {
ctx.moveApi.post();
query.redirects = ''; // follow all redirects
}
};
if (Morebits.userIsSysop) {
 
query.inprop = 'protection';
/**
* Marks the page as patrolled, using `rcid` (if available) or `revid`.
*
* Patrolling as such doesn't need to rely on loading the page in
* question; simply passing a revid to the API is sufficient, so in
* those cases just using {@link Morebits.wiki.api} is probably preferable.
*
* No error handling since we don't actually care about the errors.
*/
this.patrol = function() {
if (!Morebits.userIsSysop && !Morebits.userIsInGroup('patroller')) {
return;
}
 
// If a link is present, don't need to check if it's patrolled
ctx.moveApi = new Morebits.wiki.api('retrieving move token...', query, fnProcessMove, ctx.statusElement, ctx.onMoveFailure);
if ($('.patrollink').length) {
ctx.moveApi.setParent(this);
var patrolhref = $('.patrollink a').attr('href');
ctx.moveApi.post();
ctx.rcid = mw.util.getParamValue('rcid', patrolhref);
fnProcessPatrol(this, this);
} else {
var patrolQuery = {
action: 'query',
prop: 'info',
meta: 'tokens',
type: 'patrol', // as long as we're querying, might as well get a token
list: 'recentchanges', // check if the page is unpatrolled
titles: ctx.pageName,
rcprop: 'patrolled',
rctitle: ctx.pageName,
rclimit: 1,
format: 'json'
};
 
ctx.patrolApi = new Morebits.wiki.api(msg('getting-token', 'retrieving token...'), patrolQuery, fnProcessPatrol);
ctx.patrolApi.setParent(this);
ctx.patrolApi.post();
}
};
 
/**
* Marks the page as reviewed by the PageTriage extension.
*
* Will, by it's nature, mark as patrolled as well. Falls back to
* patrolling if not in an appropriate namespace.
*
* Doesn't inherently rely on loading the page in question; simply
* passing a `pageid` to the API is sufficient, so in those cases just
* using {@link Morebits.wiki.api} is probably preferable.
*
* Will first check if the page is queued via
* {@link Morebits.wiki.page~fnProcessTriageList|fnProcessTriageList}.
*
* No error handling since we don't actually care about the errors.
*
* @see {@link https://www.mediawiki.org/wiki/Extension:PageTriage} Referred to as "review" on-wiki.
*/
this.triage = function() {
// Fall back to patrol if not a valid triage namespace
if (mw.config.get('pageTriageNamespaces').indexOf(new mw.Title(ctx.pageName).getNamespaceId()) === -1) {
this.patrol();
} else {
if (!Morebits.userIsSysop && !Morebits.userIsInGroup('patroller')) {
return;
}
 
// If on the page in question, don't need to query for page ID
if (new mw.Title(Morebits.pageNameNorm).getPrefixedText() === new mw.Title(ctx.pageName).getPrefixedText()) {
ctx.pageID = mw.config.get('wgArticleId');
fnProcessTriageList(this, this);
} else {
var query = fnNeedTokenInfoQuery('triage');
 
ctx.triageApi = new Morebits.wiki.api(msg('getting-token', 'retrieving token...'), query, fnProcessTriageList);
ctx.triageApi.setParent(this);
ctx.triageApi.post();
}
}
};
 
// |delete| is a reserved word in some flavours of JS
/**
* Deletes a page (for admins only).
*
* @param {Function} [onSuccess] - callback function to run on success (optional)
* @param {Function} [onFailureonSuccess] - callbackCallback function to run on failure (optional)success.
* @param {Function} [onFailure] - Callback function to run on failure.
*/
this.deletePage = function(onSuccess, onFailure) {
Line 2,447 ⟶ 3,597:
ctx.onDeleteFailure = onFailure || emptyFunction;
 
if (!fnPreflightChecks.call(this, 'delete', ctx.onDeleteFailure)) {
// if a non-admin tries to do this, don't bother
return; // abort
if (!Morebits.userIsSysop) {
ctx.statusElement.error('Cannot delete page: only admins can do that');
ctx.onDeleteFailure(this);
return;
}
if (!ctx.editSummary) {
ctx.statusElement.error('Internal error: delete reason not set before delete (use setEditSummary function)!');
ctx.onDeleteFailure(this);
return;
}
 
Line 2,462 ⟶ 3,604:
fnProcessDelete.call(this, this);
} else {
var query = {fnNeedTokenInfoQuery('delete');
action: 'query',
prop: 'info',
inprop: 'protection',
intoken: 'delete',
titles: ctx.pageName
};
if (ctx.followRedirect) {
query.redirects = ''; // follow all redirects
}
 
ctx.deleteApi = new Morebits.wiki.api(msg('retrievinggetting-token', delete'retrieving token...'), query, fnProcessDelete, ctx.statusElement, ctx.onDeleteFailure);
ctx.deleteApi.setParent(this);
ctx.deleteApi.post();
Line 2,480 ⟶ 3,613:
 
/**
* Undeletes a page (for admins only).
*
* @param {Function} [onSuccess] - callback function to run on success (optional)
* @param {Function} [onFailureonSuccess] - callbackCallback function to run on failure (optional)success.
* @param {Function} [onFailure] - Callback function to run on failure.
*/
this.undeletePage = function(onSuccess, onFailure) {
Line 2,488 ⟶ 3,622:
ctx.onUndeleteFailure = onFailure || emptyFunction;
 
if (!fnPreflightChecks.call(this, 'undelete', ctx.onUndeleteFailure)) {
// if a non-admin tries to do this, don't bother
return; // abort
if (!Morebits.userIsSysop) {
ctx.statusElement.error('Cannot undelete page: only admins can do that');
ctx.onUndeleteFailure(this);
return;
}
if (!ctx.editSummary) {
ctx.statusElement.error('Internal error: undelete reason not set before undelete (use setEditSummary function)!');
ctx.onUndeleteFailure(this);
return;
}
 
Line 2,503 ⟶ 3,629:
fnProcessUndelete.call(this, this);
} else {
var query = {fnNeedTokenInfoQuery('undelete');
action: 'query',
prop: 'info',
inprop: 'protection',
intoken: 'undelete',
titles: ctx.pageName
};
 
ctx.undeleteApi = new Morebits.wiki.api(msg('retrievinggetting-token', undelete'retrieving token...'), query, fnProcessUndelete, ctx.statusElement, ctx.onUndeleteFailure);
ctx.undeleteApi.setParent(this);
ctx.undeleteApi.post();
Line 2,518 ⟶ 3,638:
 
/**
* Protects a page (for admins only).
*
* @param {Function} [onSuccess] - callback function to run on success (optional)
* @param {Function} [onFailureonSuccess] - callbackCallback function to run on failure (optional)success.
* @param {Function} [onFailure] - Callback function to run on failure.
*/
this.protect = function(onSuccess, onFailure) {
Line 2,526 ⟶ 3,647:
ctx.onProtectFailure = onFailure || emptyFunction;
 
if (!fnPreflightChecks.call(this, 'protect', ctx.onProtectFailure)) {
// if a non-admin tries to do this, don't bother
return; // abort
if (!Morebits.userIsSysop) {
ctx.statusElement.error('Cannot protect page: only admins can do that');
ctx.onProtectFailure(this);
return;
}
 
if (!ctx.protectEdit && !ctx.protectMove && !ctx.protectCreate) {
ctx.statusElement.error('Internal error: you must set edit and/or move and/or create protection before calling protect()!');
ctx.onProtectFailure(this);
return;
}
if (!ctx.editSummary) {
ctx.statusElement.error('Internal error: protection reason not set before protect (use setEditSummary function)!');
ctx.onProtectFailure(this);
return;
}
 
// because of the way MW API interprets protection levels (absolute, not
// (absolute, not differential), we always need to request
// protection levels from the server
var query = {fnNeedTokenInfoQuery('protect');
action: 'query',
prop: 'info',
inprop: 'protection',
intoken: 'protect',
titles: ctx.pageName,
watchlist: ctx.watchlistOption
};
if (ctx.followRedirect) {
query.redirects = ''; // follow all redirects
}
 
ctx.protectApi = new Morebits.wiki.api(msg('retrievinggetting-token', protect'retrieving token...'), query, fnProcessProtect, ctx.statusElement, ctx.onProtectFailure);
ctx.protectApi.setParent(this);
ctx.protectApi.post();
Line 2,563 ⟶ 3,668:
 
/**
* Apply FlaggedRevs protection-style settings. Only works on wikis where
* onlythe worksextension whereis installed (`$wgFlaggedRevsProtection = true (i.e. where FlaggedRevs`
* i.e. where FlaggedRevs settings appear on the wiki's "protect" tab).
*
* @param {function} [onSuccess]
* @see {@link https://www.mediawiki.org/wiki/Extension:FlaggedRevs}
* @param {function} [onFailure]
* Referred to as "pending changes" on-wiki.
*
* @param {Function} [onSuccess]
* @param {Function} [onFailure]
*/
this.stabilize = function(onSuccess, onFailure) {
Line 2,573 ⟶ 3,682:
ctx.onStabilizeFailure = onFailure || emptyFunction;
 
if (!fnPreflightChecks.call(this, 'FlaggedRevs', ctx.onStabilizeFailure)) {
// if a non-admin tries to do this, don't bother
return; // abort
if (!Morebits.userIsSysop) {
ctx.statusElement.error('Cannot apply FlaggedRevs settings: only admins can do that');
ctx.onStabilizeFailure(this);
return;
}
 
if (!ctx.flaggedRevs) {
ctx.statusElement.error('Internal error: you must set flaggedRevs before calling stabilize()!');
ctx.onStabilizeFailure(this);
return;
}
if (!ctx.editSummary) {
ctx.statusElement.error('Internal error: reason not set before calling stabilize() (use setEditSummary function)!');
ctx.onStabilizeFailure(this);
return;
}
 
if (fnCanUseMwUserToken('stabilize')) {
var query = {
fnProcessStabilize.call(this, this);
action: 'query',
} else {
prop: 'info|flagged',
var query = fnNeedTokenInfoQuery('stabilize');
intoken: 'edit',
 
titles: ctx.pageName
ctx.stabilizeApi = new Morebits.wiki.api(msg('getting-token', 'retrieving token...'), query, fnProcessStabilize, ctx.statusElement, ctx.onStabilizeFailure);
};
ctx.stabilizeApi.setParent(this);
if (ctx.followRedirect) {
ctx.stabilizeApi.post();
query.redirects = ''; // follow all redirects
}
 
ctx.stabilizeApi = new Morebits.wiki.api('retrieving stabilize token...', query, fnProcessStabilize, ctx.statusElement, ctx.onStabilizeFailure);
ctx.stabilizeApi.setParent(this);
ctx.stabilizeApi.post();
};
 
Line 2,611 ⟶ 3,709:
 
/**
* Determines whether we can save an API call by using the editcsrf token sent with the page
* sent with the page HTML, or whether we need to ask the server for
* more info (e.g. protection or watchlist expiry).
*
* Currently only used for `append`, `prepend`, and`newSection`, deletePage.`move`,
* `stabilize`, `deletePage`, and `undeletePage`. Not used for
* `protect` since it always needs to request protection status.
*
* @param {string} [action=edit] - The action being undertaken, e.g. "edit", "delete".
* "edit" or "delete". In practice, only "edit" or "notedit" matters.
* @returns {boolean}
*/
var fnCanUseMwUserToken = function(action) {
action = typeof action !== 'undefined' ? action : 'edit'; // IE doesn't support default parameters
// API-based redirect resolution only works for action=query and
 
// action=edit in append/prepend modes (and section=new, but we don't
// If a watchlist expiry is set, we must always load the page
// really support that)
// to avoid overwriting indefinite protection. Of course, not
if (ctx.followRedirect && (action !== 'edit' ||
// needed if setting indefinite watching!
(ctx.editMode !== 'append' && ctx.editMode !== 'prepend'))) {
if (ctx.watchlistExpiry && !Morebits.string.isInfinity(ctx.watchlistExpiry)) {
return false;
}
 
// API-based redirect resolution only works for action=query and
// action=edit in append/prepend/new modes
if (ctx.followRedirect) {
if (!ctx.followCrossNsRedirect) {
return false; // must load the page to check for cross namespace redirects
}
if (action !== 'edit' || (ctx.editMode === 'all' || ctx.editMode === 'revert')) {
return false;
}
}
 
// do we need to fetch the edit protection expiry?
if (Morebits.userIsSysop && !ctx.suppressProtectWarning) {
if (new mw.Title(Morebits.pageNameNorm).getPrefixedText() !== new mw.Title(ctx.pageName).getPrefixedText()) {
// poor man's normalisation
if (Morebits.string.toUpperCaseFirstChar(mw.config.get('wgPageName')).replace(/ /g, '_').trim() !==
Morebits.string.toUpperCaseFirstChar(ctx.pageName).replace(/ /g, '_').trim()) {
return false;
}
 
// wgRestrictionEdit is null on non-existent pages,
// so this neatly handles nonexistent pages
var editRestriction = mw.config.get('wgRestrictionEdit');
if (!editRestriction || editRestriction.indexOf('sysop') !== -1) {
Line 2,642 ⟶ 3,756:
}
 
return !!mw.user.optionstokens.get('csrfToken');
};
 
/**
// callback from loadSuccess() for append() and prepend() threads
* When functions can't use
* {@link Morebits.wiki.page~fnCanUseMwUserToken|fnCanUseMwUserToken}
* or require checking protection or watched status, maintain the query
* in one place. Used for {@link Morebits.wiki.page#deletePage|delete},
* {@link Morebits.wiki.page#undeletePage|undelete},
* {@link* Morebits.wiki.page#protect|protect},
* {@link Morebits.wiki.page#stabilize|stabilize},
* and {@link Morebits.wiki.page#move|move}
* (basically, just not {@link Morebits.wiki.page#load|load}).
*
* @param {string} action - The action being undertaken, e.g. "edit" or
* "delete".
* @returns {object} Appropriate query.
*/
var fnNeedTokenInfoQuery = function(action) {
var query = {
action: 'query',
meta: 'tokens',
type: 'csrf',
titles: ctx.pageName,
prop: 'info',
inprop: 'watched',
format: 'json'
};
// Protection not checked for flagged-revs or non-sysop moves
if (action !== 'stabilize' && (action !== 'move' || Morebits.userIsSysop)) {
query.inprop += '|protection';
}
if (ctx.followRedirect && action !== 'undelete') {
query.redirects = ''; // follow all redirects
}
return query;
};
 
// callback from loadSuccess() for append(), prepend(), and newSection() threads
var fnAutoSave = function(pageobj) {
pageobj.save(ctx.onSaveSuccess, ctx.onSaveFailure);
Line 2,652 ⟶ 3,801:
// callback from loadApi.post()
var fnLoadSuccess = function() {
var xmlresponse = ctx.loadApi.getXMLgetResponse().query;
 
if (!fnCheckPageName(xmlresponse, ctx.onLoadFailure)) {
return; // abort
}
 
var page = response.pages[0], rev;
ctx.pageExists = $(xml).find('page').attr('missing') !== '';
ctx.pageExists = !page.missing;
if (ctx.pageExists) {
rev = page.revisions[0];
ctx.pageText = $(xml).find('rev').text();
ctx.lastEditTime = rev.timestamp;
ctx.pageText = rev.content;
ctx.pageID = page.pageid;
} else {
ctx.pageText = ''; // allow for concatenation, etc.
ctx.pageID = 0; // nonexistent in response, matches wgArticleId
}
ctx.csrfToken = response.tokens.csrftoken;
if (!ctx.csrfToken) {
ctx.statusElement.error(msg('token-fetch-fail', 'Failed to retrieve edit token.'));
ctx.onLoadFailure(this);
return;
}
ctx.loadTime = ctx.loadApi.getResponse().curtimestamp;
if (!ctx.loadTime) {
ctx.statusElement.error('Failed to retrieve current timestamp.');
ctx.onLoadFailure(this);
return;
}
 
ctx.contentModel = page.contentmodel;
ctx.watched = page.watchlistexpiry || page.watched;
 
// extract protection info, to alert admins when they are about to edit a protected page
// Includes cascading protection
if (Morebits.userIsSysop) {
var editproteditProt = $(xml)page.findprotection.filter(function('pr[type="edit"]'); {
if return (editprotpr.lengthtype >=== 0'edit' && editprotpr.attr('level') === 'sysop') {;
}).pop();
ctx.fullyProtected = editprot.attr('expiry');
if (editProt) {
ctx.fullyProtected = editProt.expiry;
} else {
ctx.fullyProtected = false;
Line 2,675 ⟶ 3,847:
}
 
ctx.editTokenrevertCurID = $(xml).find('page').attr('edittoken')lastrevid;
 
if (!ctx.editToken) {
var testactions = page.actions;
ctx.statusElement.error('Failed to retrieve edit token.');
ctx.testActions = []; // was null
ctx.onLoadFailure(this);
Object.keys(testactions).forEach(function(action) {
return;
if (testactions[action]) {
}
ctx.testActions.push(action);
ctx.loadTime = $(xml).find('page').attr('starttimestamp');
}
// XXX: starttimestamp is present because of intoken=edit parameter in the API call.
});
// When replacing that with meta=tokens (#615), add the curtimestamp parameter to the API call
// and change 'starttimestamp' here to 'curtimestamp'
if (!ctx.loadTime) {
ctx.statusElement.error('Failed to retrieve start timestamp.');
ctx.onLoadFailure(this);
return;
}
ctx.lastEditTime = $(xml).find('rev').attr('timestamp');
ctx.revertCurID = $(xml).find('page').attr('lastrevid');
 
if (ctx.editMode === 'revert') {
ctx.revertCurID = $(xml).find('rev') && rev.attr('revid');
if (!ctx.revertCurID) {
ctx.statusElement.error('Failed to retrieve current revision ID.');
Line 2,700 ⟶ 3,864:
return;
}
ctx.revertUser = $(xml).find('rev') && rev.attr('user');
if (!ctx.revertUser) {
if ($(xml).find('rev').attr('userhidden') ===&& ''rev.userhidden) { // username was RevDel'd or oversighted
ctx.revertUser = '<username hidden>';
} else {
Line 2,721 ⟶ 3,885:
 
// helper function to parse the page name returned from the API
var fnCheckPageName = function(xmlresponse, onFailure) {
if (!onFailure) {
onFailure = emptyFunction;
}
 
var page = response.pages && response.pages[0];
// check for invalid titles
if ($(xml).find('page').attr('invalid') === '') {
// check for invalid titles
ctx.statusElement.error('The page title is invalid: ' + ctx.pageName);
if (page.invalid) {
onFailure(this);
ctx.statusElement.error(msg('invalid-title', ctx.pageName, 'The page title is invalid: ' + ctx.pageName));
return false; // abort
onFailure(this);
}
return false; // abort
}
 
// retrieve actual title of the page after normalization and redirects
if var resolvedName = ($(xml).find('page').attr('title')) {;
var resolvedName = $(xml).find('page').attr('title');
 
// only notify user forif (response.redirects, not) normalization{
// check for cross-namespace redirect:
if ($(xml).find('redirects').length > 0) {
var origNs = new mw.Title(ctx.pageName).namespace;
Morebits.status.info('Info', 'Redirected from ' + ctx.pageName + ' to ' + resolvedName);
var newNs = new mw.Title(resolvedName).namespace;
if (origNs !== newNs && !ctx.followCrossNsRedirect) {
ctx.statusElement.error(msg('cross-redirect-abort', ctx.pageName, resolvedName, ctx.pageName + ' is a cross-namespace redirect to ' + resolvedName + ', aborted'));
onFailure(this);
return false;
}
 
// only notify user for redirects, not normalization
new Morebits.status('Note', msg('redirected', ctx.pageName, resolvedName, 'Redirected from ' + ctx.pageName + ' to ' + resolvedName));
}
 
ctx.pageName = resolvedName; // always update in case of normalization
ctx.pageName = resolvedName; // update to redirect target or normalized name
 
} else {
// could be a circular redirect or other problem
ctx.statusElement.error(msg('redirect-resolution-fail', ctx.pageName, 'Could not resolve redirects for: ' + ctx.pageName));
onFailure(this);
 
Line 2,754 ⟶ 3,930:
};
 
/**
// helper function to get a new token on encountering token errors
* Determine whether we should provide a watchlist expiry. Will not
// in save, deletePage, and undeletePage
* do so if the page is currently permanently watched, or the current
// Being a synchronous ajax call, this blocks the event loop,
* expiry is *after* the new, provided expiry. Only handles strings
// and hence should be used sparingly.
* recognized by {@link Morebits.date} or relative timeframes with
var fnGetToken = function() {
* unit it can process. Relies on the fact that fnCanUseMwUserToken
var token;
* requires page loading if a watchlistexpiry is provided, so we are
var tokenApi = new Morebits.wiki.api('Getting token', {
* ensured of knowing the watch status by the use of this.
action: 'query',
*
meta: 'tokens'
* @returns {boolean}
}, function(apiobj) {
*/
token = $(apiobj.responseXML).find('tokens').attr('csrftoken');
}, var null,fnApplyWatchlistExpiry = function() {
if (ctx.watchlistExpiry) {
this.getStatusElement().error('Failed to get token');
if (!ctx.watched || Morebits.string.isInfinity(ctx.watchlistExpiry)) {
});
return true;
tokenApi.post({async: false});
} else if (typeof ctx.watched === 'string') {
return token;
var newExpiry;
// Attempt to determine if the new expiry is a
// relative (e.g. `1 month`) or absolute datetime
var rel = ctx.watchlistExpiry.split(' ');
try {
newExpiry = new Morebits.date().add(rel[0], rel[1]);
} catch (e) {
newExpiry = new Morebits.date(ctx.watchlistExpiry);
}
 
// If the date is valid, only use it if it extends the current expiry
if (newExpiry.isValid()) {
if (newExpiry.isAfter(new Morebits.date(ctx.watched))) {
return true;
}
} else {
// If it's still not valid, hope it's a valid MW expiry format that
// Morebits.date doesn't recognize, so just default to using it.
// This will also include minor typos.
return true;
}
}
}
return false;
};
 
// callback from saveApi.post()
var fnSaveSuccess = function() {
ctx.editMode = 'all'; // cancel append/prepend/newSection/revert modes
var xmlresponse = ctx.saveApi.getXMLgetResponse();
 
// see if the API thinks we were successful
if ($(xml)response.find('edit').attr('result') === 'Success') {
 
// real success
Line 2,794 ⟶ 3,994:
// errors here are only generated by extensions which hook APIEditBeforeSave within MediaWiki,
// which as of 1.34.0-wmf.23 (Sept 2019) should only encompass captcha messages
if ($(xml)response.find('captcha')edit.length > 0captcha) {
ctx.statusElement.error('Could not save the page because the wiki server wanted you to fill out a CAPTCHA.');
} else {
ctx.statusElement.error(msg('api-error-unknown', 'Unknown error received from API while saving page'));
}
 
Line 2,819 ⟶ 4,019:
};
 
var purgeApi = new Morebits.wiki.api(msg('editconflict-purging', 'Edit conflict detected, purging server cache'), purgeQuery, null, ctx.statusElementfunction(); {
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds
purgeApi.post({ async: false }); // just wait for it, result is for debugging
 
ctx.statusElement.info(msg('editconflict-retrying', 'Edit conflict detected, reapplying edit'));
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds
if (fnCanUseMwUserToken('edit')) {
 
ctx.saveApi.post(); // necessarily append, prepend, or newSection, so this should work as desired
ctx.statusElement.info('Edit conflict detected, reapplying edit');
} else {
if (fnCanUseMwUserToken('edit')) {
ctx.saveApiloadApi.post(); // necessarilyreload appendthe orpage prepend,and soreapply thisthe should work as desirededit
} else {
}, ctx.statusElement);
ctx.loadApi.post(); // reload the page and reapply the edit
purgeApi.post();
}
 
// check for loss of edit token
} else if ((errorCode === 'badtoken' || errorCode === 'notoken') && ctx.retries++ < ctx.maxRetries) {
 
ctx.statusElement.info('Edit token is invalid, retrying');
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds
ctx.saveApi.query.token = fnGetToken.call(this);
ctx.saveApi.post();
 
// check for network or server error
} else if ((errorCode === 'null || errorCode === undefined') && ctx.retries++ < ctx.maxRetries) {
 
// the error might be transient, so try again
ctx.statusElement.info(msg('save-failed-retrying', 2, 'Save failed, retrying in 2 seconds ...'));
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds
 
ctx.saveApi.post(); // give it another go!
// wait for sometime for client to regain connectivity
sleep(2000).then(function() {
ctx.saveApi.post(); // give it another go!
});
 
// hard error, give up
} else {
 
switch (errorCode) {
// non-admin attempting to edit a protected page - this gives a friendlier message than the default
 
if (errorCode === 'protectedpage') {
case 'protectedpage':
ctx.statusElement.error('Failed to save edit: Page is protected');
// non-admin attempting to edit a protected page - this gives a friendlier message than the default
// check for absuefilter hits: disallowed or warning
ctx.statusElement.error('Failed to save edit: Page is protected');
} else if (errorCode.indexOf('abusefilter') === 0) {
break;
var desc = $(ctx.saveApi.getXML()).find('abusefilter').attr('description');
 
if (errorCode === 'abusefilter-disallowed') {
case 'abusefilter-disallowed':
ctx.statusElement.error('The edit was disallowed by the edit filter: "' + desc + '".');
ctx.statusElement.error('The edit was disallowed by the edit filter: "' + ctx.saveApi.getResponse().error.abusefilter.description + '".');
} else if (errorCode === 'abusefilter-warning') {
break;
ctx.statusElement.error([ 'A warning was returned by the edit filter: "', desc, '". If you wish to proceed with the edit, please carry it out again. This warning will not appear a second time.' ]);
 
case 'abusefilter-warning':
ctx.statusElement.error([ 'A warning was returned by the edit filter: "', ctx.saveApi.getResponse().error.abusefilter.description, '". If you wish to proceed with the edit, please carry it out again. This warning will not appear a second time.' ]);
// We should provide the user with a way to automatically retry the action if they so choose -
// I can't see how to do this without creating a UI dependency on Morebits.wiki.page though -- TTO
break;
} else { // shouldn't happen but...
 
ctx.statusElement.error('The edit was disallowed by the edit filter.');
case 'spamblacklist':
}
// If multiple items are blacklisted, we only return the first
// check for blacklist hits
} var elsespam if= ctx.saveApi.getResponse(errorCode === ').error.spamblacklist') {.matches[0];
ctx.statusElement.error('Could not save the page because the URL ' + spam + ' is on the spam blacklist');
// .find('matches') returns an array in case multiple items are blacklisted, we only return the first
break;
var spam = $(ctx.saveApi.getXML()).find('spamblacklist').find('matches').children()[0].textContent;
 
ctx.statusElement.error('Could not save the page because the URL ' + spam + ' is on the spam blacklist');
} else { default:
ctx.statusElement.error('Failed to save edit: ' + ctx.saveApi.getErrorText());
}
 
ctx.editMode = 'all'; // cancel append/prepend/revert modes
ctx.editMode = 'all'; // cancel append/prepend/newSection/revert modes
if (ctx.onSaveFailure) {
ctx.onSaveFailure(this); // invoke callback
}
}
};
 
var isTextRedirect = function(text) {
if (!text) { // no text - content empty or inaccessible (revdelled or suppressed)
return false;
}
return Morebits.l10n.redirectTagAliases.some(function(tag) {
return new RegExp('^\\s*' + tag + '\\W', 'i').test(text);
});
};
 
var fnLookupCreationSuccess = function() {
var xmlresponse = ctx.lookupCreationApi.getXMLgetResponse().query;
 
if (!fnCheckPageName(xmlresponse, ctx.onLookupCreationFailure)) {
return; // abort
}
 
var rev = response.pages[0].revisions && response.pages[0].revisions[0];
if (!ctx.lookupNonRedirectCreator || !/^\s*#redirect/i.test($(xml).find('rev').text())) {
if (!rev) {
ctx.statusElement.error('Could not find any revisions of ' + ctx.pageName);
ctx.onLookupCreationFailure(this);
return;
}
 
if (!ctx.lookupNonRedirectCreator || !isTextRedirect(rev.content)) {
 
ctx.creator = $(xml).find('rev').attr('user');
if (!ctx.creator) {
ctx.statusElement.error('Could not find name of page creator');
ctx.onLookupCreationFailure(this);
return;
}
ctx.timestamp = $(xml).find('rev').attr('timestamp');
if (!ctx.timestamp) {
ctx.statusElement.error('Could not find timestamp of page creation');
ctx.onLookupCreationFailure(this);
return;
}
 
ctx.statusElement.info('retrieved page creation information');
ctx.onLookupCreationSuccess(this);
 
Line 2,905 ⟶ 4,125:
ctx.lookupCreationApi.query.titles = ctx.pageName; // update pageName if redirect resolution took place in earlier query
 
ctx.lookupCreationApi = new Morebits.wiki.api('Retrieving page creation information', ctx.lookupCreationApi.query, fnLookupNonRedirectCreator, ctx.statusElement, ctx.onLookupCreationFailure);
ctx.lookupCreationApi.setParent(this);
ctx.lookupCreationApi.post();
Line 2,913 ⟶ 4,133:
 
var fnLookupNonRedirectCreator = function() {
var xmlresponse = ctx.lookupCreationApi.getXMLgetResponse().query;
var revs = response.pages[0].revisions;
 
for (var i = 0; i < revs.length; i++) {
$(xml).find('rev').each(function(_, rev) {
 
if (!/^\s*#redirect/i.test(rev.textContent)) { // inaccessible revisions also check out
if (!isTextRedirect(revs[i].content)) {
ctx.creator = rev.getAttribute('user');
ctx.timestampcreator = revrevs[i].getAttribute('timestamp')user;
ctx.timestamp = revs[i].timestamp;
return false; // break
break;
}
});
 
if (!ctx.creator) {
// fallback to give first revision author if no non-redirect version in the first 50
ctx.creator = $(xml).find('rev')revs[0].getAttribute('user');
ctx.timestamp = $(xml).find('rev')revs[0].getAttribute('timestamp');
if (!ctx.creator) {
ctx.statusElement.error('Could not find name of page creator');
ctx.onLookupCreationFailure(this);
return;
}
Line 2,935 ⟶ 4,158:
if (!ctx.timestamp) {
ctx.statusElement.error('Could not find timestamp of page creation');
ctx.onLookupCreationFailure(this);
return;
}
 
ctx.statusElement.info('retrieved page creation information');
ctx.onLookupCreationSuccess(this);
 
};
 
/**
var fnProcessMove = function() {
* Common checks for action methods. Used for move, undelete, delete,
var xml = ctx.moveApi.getXML();
* protect, stabilize.
*
* @param {string} action - The action being checked.
* @param {string} onFailure - Failure callback.
* @returns {boolean}
*/
var fnPreflightChecks = function(action, onFailure) {
// if a non-admin tries to do this, don't bother
if (!Morebits.userIsSysop && action !== 'move') {
ctx.statusElement.error('Cannot ' + action + 'page : only admins can do that');
onFailure(this);
return false;
}
 
if (!ctx.editSummary) {
if ($(xml).find('page').attr('missing') === '') {
ctx.statusElement.error('CannotInternal moveerror: the' page,+ becauseaction it+ no' longerreason existsnot set (use setEditSummary function)!');
ctx.onMoveFailureonFailure(this);
return false;
}
return true; // all OK
};
 
/**
* Common checks for fnProcess functions (`fnProcessDelete`, `fnProcessMove`, etc.
* Used for move, undelete, delete, protect, stabilize.
*
* @param {string} action - The action being checked.
* @param {string} onFailure - Failure callback.
* @param {string} response - The response document from the API call.
* @returns {boolean}
*/
var fnProcessChecks = function(action, onFailure, response) {
var missing = response.pages[0].missing;
 
// No undelete as an existing page could have deleted revisions
var actionMissing = missing && ['delete', 'stabilize', 'move'].indexOf(action) !== -1;
var protectMissing = action === 'protect' && missing && (ctx.protectEdit || ctx.protectMove);
var saltMissing = action === 'protect' && !missing && ctx.protectCreate;
 
if (actionMissing || protectMissing || saltMissing) {
ctx.statusElement.error('Cannot ' + action + ' the page because it ' + (missing ? 'no longer' : 'already') + ' exists');
onFailure(this);
return false;
}
 
// Delete, undelete, move
// extract protection info
var editprot;
if (Morebits.userIsSysop) {
if (action === 'undelete') {
var editprot = $(xml).find('pr[type="edit"]');
editprot = response.pages[0].protection.filter(function(pr) {
if (editprot.length > 0 && editprot.attr('level') === 'sysop' && !ctx.suppressProtectWarning &&
return pr.type === 'create' && pr.level === 'sysop';
!confirm('You are about to move the fully protected page "' + ctx.pageName +
}).pop();
(editprot.attr('expiry') === 'infinity' ? '" (protected indefinitely)' : '" (protection expiring ' + editprot.attr('expiry') + ')') +
} else if (action === 'delete' || action === 'move') {
'. \n\nClick OK to proceed with the move, or Cancel to skip this move.')) {
editprot = response.pages[0].protection.filter(function(pr) {
ctx.statusElement.error('Move of fully protected page was aborted.');
return pr.type === 'edit' && pr.level === 'sysop';
ctx.onMoveFailure(this);
return}).pop();
}
if (editprot && !ctx.suppressProtectWarning &&
!confirm('You are about to ' + action + ' the fully protected page "' + ctx.pageName +
(editprot.expiry === 'infinity' ? '" (protected indefinitely)' : '" (protection expiring ' + new Morebits.date(editprot.expiry).calendar('utc') + ' (UTC))') +
'. \n\nClick OK to proceed with ' + action + ', or Cancel to skip.')) {
ctx.statusElement.error('Aborted ' + action + ' on fully protected page.');
onFailure(this);
return false;
}
 
if (!response.tokens.csrftoken) {
var moveToken = $(xml).find('page').attr('movetoken');
ctx.statusElement.error('Failed to retrieve token.');
if (!moveToken) {
onFailure(this);
ctx.statusElement.error('Failed to retrieve move token.');
return false;
ctx.onMoveFailure(this);
}
return;
return true; // all OK
};
 
var fnProcessMove = function() {
var pageTitle, token;
 
if (fnCanUseMwUserToken('move')) {
token = mw.user.tokens.get('csrfToken');
pageTitle = ctx.pageName;
} else {
var response = ctx.moveApi.getResponse().query;
 
if (!fnProcessChecks('move', ctx.onMoveFailure, response)) {
return; // abort
}
 
token = response.tokens.csrftoken;
var page = response.pages[0];
pageTitle = page.title;
ctx.watched = page.watchlistexpiry || page.watched;
}
 
var query = {
'action': 'move',
'from': $(xml).find('page').attr('title')pageTitle,
'to': ctx.moveDestination,
'token': moveTokentoken,
'reason': ctx.editSummary,
watchlist: ctx.watchlistOption,
format: 'json'
};
if (ctx.changeTags) {
query.tags = ctx.changeTags;
}
 
if (fnApplyWatchlistExpiry()) {
query.watchlistexpiry = ctx.watchlistExpiry;
}
if (ctx.moveTalkPage) {
query.movetalk = 'true';
Line 2,986 ⟶ 4,286:
if (ctx.moveSuppressRedirect) {
query.noredirect = 'true';
}
if (ctx.watchlistOption === 'watch') {
query.watch = 'true';
}
 
ctx.moveProcessApi = new Morebits.wiki.api(msg('moving-page', 'moving page...'), query, ctx.onMoveSuccess, ctx.statusElement, ctx.onMoveFailure);
ctx.moveProcessApi.setParent(this);
ctx.moveProcessApi.post();
};
 
var fnProcessDeletefnProcessPatrol = function() {
var pageTitle,query token;= {
action: 'patrol',
format: 'json'
};
 
// Didn't need to load the page
if (fnCanUseMwUserToken('delete')) {
if (ctx.rcid) {
token = mw.user.options.get('csrfToken');
pageTitlequery.rcid = ctx.pageNamercid;
query.token = mw.user.tokens.get('patrolToken');
} else {
var xmlresponse = ctx.deleteApipatrolApi.getXMLgetResponse().query;
 
// Don't patrol if not unpatrolled
if ($(xml).find('page').attr('missing') === '') {
if (!response.recentchanges[0].unpatrolled) {
ctx.statusElement.error('Cannot delete the page, because it no longer exists');
ctx.onDeleteFailure(this);
return;
}
 
var lastrevid = response.pages[0].lastrevid;
// extract protection info
if (!lastrevid) {
var editprot = $(xml).find('pr[type="edit"]');
if (editprot.length > 0 && editprot.attr('level') === 'sysop' && !ctx.suppressProtectWarning &&
!confirm('You are about to delete the fully protected page "' + ctx.pageName +
(editprot.attr('expiry') === 'infinity' ? '" (protected indefinitely)' : '" (protection expiring ' + editprot.attr('expiry') + ')') +
'. \n\nClick OK to proceed with the deletion, or Cancel to skip this deletion.')) {
ctx.statusElement.error('Deletion of fully protected page was aborted.');
ctx.onDeleteFailure(this);
return;
}
query.revid = lastrevid;
 
var token = $(xml)response.find('page')tokens.attr('deletetoken')csrftoken;
if (!token) {
ctx.statusElement.error('Failed to retrieve delete token.');
ctx.onDeleteFailure(this);
return;
}
query.token = token;
}
if (ctx.changeTags) {
query.tags = ctx.changeTags;
}
 
pageTitlevar patrolStat = $(xml)new Morebits.findstatus('Marking page').attr('title as patrolled');
 
ctx.patrolProcessApi = new Morebits.wiki.api('patrolling page...', query, null, patrolStat);
ctx.patrolProcessApi.setParent(this);
ctx.patrolProcessApi.post();
};
 
// Ensure that the page is curatable
var fnProcessTriageList = function() {
if (ctx.pageID) {
ctx.csrfToken = mw.user.tokens.get('csrfToken');
} else {
var response = ctx.triageApi.getResponse().query;
 
ctx.pageID = response.pages[0].pageid;
if (!ctx.pageID) {
return;
}
 
ctx.csrfToken = response.tokens.csrftoken;
if (!ctx.csrfToken) {
return;
}
}
 
var query = {
'action': 'deletepagetriagelist',
'title'page_id: pageTitlectx.pageID,
'token'format: token,'json'
'reason': ctx.editSummary
};
 
if (ctx.watchlistOption === 'watch') {
ctx.triageProcessListApi = new Morebits.wiki.api('checking curation status...', query, fnProcessTriage);
query.watch = 'true';
ctx.triageProcessListApi.setParent(this);
ctx.triageProcessListApi.post();
};
 
// callback from triageProcessListApi.post()
var fnProcessTriage = function() {
var responseList = ctx.triageProcessListApi.getResponse().pagetriagelist;
// Exit if not in the queue
if (!responseList || responseList.result !== 'success') {
return;
}
var page = responseList.pages && responseList.pages[0];
// Do nothing if page already triaged/patrolled
if (!page || !parseInt(page.patrol_status, 10)) {
var query = {
action: 'pagetriageaction',
pageid: ctx.pageID,
reviewed: 1,
// tags: ctx.changeTags, // pagetriage tag support: [[phab:T252980]]
// Could use an adder to modify/create note:
// summaryAd, but that seems overwrought
token: ctx.csrfToken,
format: 'json'
};
var triageStat = new Morebits.status('Marking page as curated');
ctx.triageProcessApi = new Morebits.wiki.api('curating page...', query, null, triageStat);
ctx.triageProcessApi.setParent(this);
ctx.triageProcessApi.post();
}
};
 
var fnProcessDelete = function() {
var pageTitle, token;
 
if (fnCanUseMwUserToken('delete')) {
token = mw.user.tokens.get('csrfToken');
pageTitle = ctx.pageName;
} else {
var response = ctx.deleteApi.getResponse().query;
 
if (!fnProcessChecks('delete', ctx.onDeleteFailure, response)) {
return; // abort
}
 
token = response.tokens.csrftoken;
var page = response.pages[0];
pageTitle = page.title;
ctx.watched = page.watchlistexpiry || page.watched;
}
 
var query = {
action: 'delete',
title: pageTitle,
token: token,
reason: ctx.editSummary,
watchlist: ctx.watchlistOption,
format: 'json'
};
if (ctx.changeTags) {
query.tags = ctx.changeTags;
}
 
if (fnApplyWatchlistExpiry()) {
query.watchlistexpiry = ctx.watchlistExpiry;
}
 
Line 3,057 ⟶ 4,440:
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds
ctx.deleteProcessApi.post(); // give it another go!
 
} else if ((errorCode === 'badtoken' || errorCode === 'notoken') && ctx.retries++ < ctx.maxRetries) {
ctx.statusElement.info('Invalid token, retrying');
--Morebits.wiki.numberOfActionsLeft;
ctx.deleteProcessApi.query.token = fnGetToken.call(this);
ctx.deleteProcessApi.post();
} else if (errorCode === 'missingtitle') {
ctx.statusElement.error('Cannot delete the page, because it no longer exists');
Line 3,079 ⟶ 4,458:
var pageTitle, token;
 
// The whole handling of tokens in Morebits is outdated (#615)
// but has generally worked since intoken has been deprecated
// but remains. intoken does not, however, take undelete, so
// fnCanUseMwUserToken('undelete') is no good. Everything
// except watching and patrolling should eventually use csrf,
// but until then (#615) the stupid hack below should work for
// undeletion.
if (fnCanUseMwUserToken('undelete')) {
token = mw.user.optionstokens.get('csrfToken');
pageTitle = ctx.pageName;
} else {
var xmlresponse = ctx.undeleteApi.getXMLgetResponse().query;
 
if (!fnProcessChecks('undelete', ctx.onUndeleteFailure, response)) {
if ($(xml).find('page').attr('missing') !== '') {
return; // abort
ctx.statusElement.error('Cannot undelete the page, because it already exists');
ctx.onUndeleteFailure(this);
return;
}
 
// extract protection info
var editprot = $(xml).find('pr[type="create"]');
if (editprot.length > 0 && editprot.attr('level') === 'sysop' && !ctx.suppressProtectWarning &&
!confirm('You are about to undelete the fully create protected page "' + ctx.pageName +
(editprot.attr('expiry') === 'infinity' ? '" (protected indefinitely)' : '" (protection expiring ' + editprot.attr('expiry') + ')') +
'. \n\nClick OK to proceed with the undeletion, or Cancel to skip this undeletion.')) {
ctx.statusElement.error('Undeletion of fully create protected page was aborted.');
ctx.onUndeleteFailure(this);
return;
}
 
token = response.tokens.csrftoken;
// KLUDGE:
var page = response.pages[0];
token = mw.user.options.get('csrfToken');
pageTitle = ctxpage.pageNametitle;
ctx.watched = page.watchlistexpiry || page.watched;
}
 
var query = {
'action': 'undelete',
'title': pageTitle,
'token': token,
'reason': ctx.editSummary,
watchlist: ctx.watchlistOption,
format: 'json'
};
if (ctx.watchlistOption === 'watch'changeTags) {
query.watchtags = 'true'ctx.changeTags;
}
 
if (fnApplyWatchlistExpiry()) {
query.watchlistexpiry = ctx.watchlistExpiry;
}
 
Line 3,135 ⟶ 4,501:
 
// check for "Database query error"
if (errorCode === 'internal_api_error_DBQueryError') &&{
if (ctx.retries++ < ctx.maxRetries) {
ctx.statusElement.info('Database query error, retrying');
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds
ctx.undeleteProcessApi.post(); // give it another go!
} else {
} else if ((errorCode === 'badtoken' || errorCode === 'notoken') && ctx.retries++ < ctx.maxRetries) {
ctx.statusElement.infoerror('InvalidRepeated tokendatabase query error, retryingplease try again');
if (ctx.onUndeleteFailure) {
--Morebits.wiki.numberOfActionsLeft;
ctx.onUndeleteFailure.call(this, ctx.undeleteProcessApi); // invoke callback
ctx.undeleteProcessApi.query.token = fnGetToken.call(this);
}
ctx.undeleteProcessApi.post();
}
 
} else if (errorCode === 'cantundelete') {
ctx.statusElement.error('Cannot undelete the page, either because there are no revisions to undelete or because it has already been undeleted');
Line 3,160 ⟶ 4,527:
 
var fnProcessProtect = function() {
var xmlresponse = ctx.protectApi.getXMLgetResponse().query;
 
if (!fnProcessChecks('protect', ctx.onProtectFailure, response)) {
var missing = $(xml).find('page').attr('missing') === '';
return; // abort
if ((ctx.protectEdit || ctx.protectMove) && missing) {
ctx.statusElement.error('Cannot protect the page, because it no longer exists');
ctx.onProtectFailure(this);
return;
}
if (ctx.protectCreate && !missing) {
ctx.statusElement.error('Cannot create protect the page, because it already exists');
ctx.onProtectFailure(this);
return;
}
 
var token = response.tokens.csrftoken;
// TODO cascading protection not possible on edit<sysop
var page = response.pages[0];
var pageTitle = page.title;
ctx.watched = page.watchlistexpiry || page.watched;
 
// Fetch existing protection levels
var protectToken = $(xml).find('page').attr('protecttoken');
var prs = response.pages[0].protection;
if (!protectToken) {
var editprot, moveprot, createprot;
ctx.statusElement.error('Failed to retrieve protect token.');
prs.forEach(function(pr) {
ctx.onProtectFailure(this);
// Filter out protection from cascading
return;
if (pr.type === 'edit' && !pr.source) {
editprot = pr;
} else if (pr.type === 'move') {
moveprot = pr;
} else if (pr.type === 'create') {
createprot = pr;
}
});
 
 
// Fall back to current levels if not explicitly set
if (!ctx.protectEdit && editprot) {
ctx.protectEdit = { level: editprot.level, expiry: editprot.expiry };
}
if (!ctx.protectMove && moveprot) {
ctx.protectMove = { level: moveprot.level, expiry: moveprot.expiry };
}
if (!ctx.protectCreate && createprot) {
ctx.protectCreate = { level: createprot.level, expiry: createprot.expiry };
}
 
// fetchDefault to pre-existing cascading protection levelsif unchanged (similar to above)
if (ctx.protectCascade === null) {
var prs = $(xml).find('pr');
var editprot ctx.protectCascade = !!prs.filter('[type="edit"]'function(pr); {
return pr.cascade;
var moveprot = prs.filter('[type="move"]');
}).length;
var createprot = prs.filter('[type="create"]');
}
// Warn if cascading protection being applied with an invalid protection level,
// which for edit protection will cause cascading to be silently stripped
if (ctx.protectCascade) {
// On move protection, this is technically stricter than the MW API,
// but seems reasonable to avoid dumb values and misleading log entries (T265626)
if (((!ctx.protectEdit || ctx.protectEdit.level !== 'sysop') ||
(!ctx.protectMove || ctx.protectMove.level !== 'sysop')) &&
!confirm('You have cascading protection enabled on "' + ctx.pageName +
'" but have not selected uniform sysop-level protection.\n\n' +
'Click OK to adjust and proceed with sysop-level cascading protection, or Cancel to skip this action.')) {
ctx.statusElement.error('Cascading protection was aborted.');
ctx.onProtectFailure(this);
return;
}
 
ctx.protectEdit.level = 'sysop';
var protections = [], expirys = [];
ctx.protectMove.level = 'sysop';
}
 
// set editBuild protection levellevels and expirys (expiries?) for query
var protections = [], expirys = [];
if (ctx.protectEdit) {
protections.push('edit=' + ctx.protectEdit.level);
expirys.push(ctx.protectEdit.expiry);
} else if (editprot.length) {
protections.push('edit=' + editprot.attr('level'));
expirys.push(editprot.attr('expiry').replace('infinity', 'indefinite'));
}
 
Line 3,203 ⟶ 4,599:
protections.push('move=' + ctx.protectMove.level);
expirys.push(ctx.protectMove.expiry);
} else if (moveprot.length) {
protections.push('move=' + moveprot.attr('level'));
expirys.push(moveprot.attr('expiry').replace('infinity', 'indefinite'));
}
 
Line 3,211 ⟶ 4,604:
protections.push('create=' + ctx.protectCreate.level);
expirys.push(ctx.protectCreate.expiry);
} else if (createprot.length) {
protections.push('create=' + createprot.attr('level'));
expirys.push(createprot.attr('expiry').replace('infinity', 'indefinite'));
}
 
var query = {
action: 'protect',
title: $(xml).find('page').attr('title')pageTitle,
token: protectTokentoken,
protections: protections.join('|'),
expiry: expirys.join('|'),
reason: ctx.editSummary,
watchlist: ctx.watchlistOption,
format: 'json'
};
// Only shows up in logs, not page history [[phab:T259983]]
if (ctx.changeTags) {
query.tags = ctx.changeTags;
}
 
if (fnApplyWatchlistExpiry()) {
query.watchlistexpiry = ctx.watchlistExpiry;
}
if (ctx.protectCascade) {
query.cascade = 'true';
}
if (ctx.watchlistOption === 'watch') {
query.watch = 'true';
}
 
Line 3,237 ⟶ 4,634:
 
var fnProcessStabilize = function() {
var pageTitle, token;
var xml = ctx.stabilizeApi.getXML();
 
if (fnCanUseMwUserToken('stabilize')) {
var missing = $(xml).find('page').attr('missing') === '';
token = mw.user.tokens.get('csrfToken');
if (missing) {
pageTitle = ctx.pageName;
ctx.statusElement.error('Cannot protect the page, because it no longer exists');
} else {
ctx.onStabilizeFailure(this);
var response = ctx.stabilizeApi.getResponse().query;
return;
}
 
// 'stabilize' as a verb not necessarily well understood
var stabilizeToken = $(xml).find('page').attr('edittoken');
if (!fnProcessChecks('stabilize', ctx.onStabilizeFailure, response)) {
if (!stabilizeToken) {
return; // abort
ctx.statusElement.error('Failed to retrieve stabilize token.');
}
ctx.onStabilizeFailure(this);
 
return;
token = response.tokens.csrftoken;
var page = response.pages[0];
pageTitle = page.title;
// Doesn't support watchlist expiry [[phab:T263336]]
// ctx.watched = page.watchlistexpiry || page.watched;
}
 
var query = {
action: 'stabilize',
title: $(xml).find('page').attr('title')pageTitle,
token: stabilizeTokentoken,
protectlevel: ctx.flaggedRevs.level,
expiry: ctx.flaggedRevs.expiry,
// tags: ctx.changeTags, // flaggedrevs tag support: [[phab:T247721]]
reason: ctx.editSummary
reason: ctx.editSummary,
watchlist: ctx.watchlistOption,
format: 'json'
};
 
if (ctx.watchlistOption === 'watch') {
/* Doesn't support watchlist expiry [[phab:T263336]]
query.watch = 'true';
if (fnApplyWatchlistExpiry()) {
query.watchlistexpiry = ctx.watchlistExpiry;
}
*/
 
ctx.stabilizeProcessApi = new Morebits.wiki.api('configuring stabilization settings...', query, ctx.onStabilizeSuccess, ctx.statusElement, ctx.onStabilizeFailure);
Line 3,269 ⟶ 4,676:
ctx.stabilizeProcessApi.post();
};
 
var sleep = function(milliseconds) {
var deferred = $.Deferred();
setTimeout(deferred.resolve, milliseconds);
return deferred;
};
 
}; // end Morebits.wiki.page
 
Line 3,279 ⟶ 4,693:
 
 
/* **************** Morebits.wiki.preview **************** */
 
/**
* Use the API to parse a fragment of wikitext and render it as HTML.
* **************** Morebits.wiki.preview ****************
* Uses the API to parse a fragment of wikitext and render it as HTML.
*
* The suggested implementation pattern (in {@link Morebits.simpleWindow} +and
* {@link Morebits.quickForm} situations) is to construct a
* construct a `Morebits.wiki.preview` object after rendering a `Morebits.quickForm`, and bind the object
* bind the object to an arbitrary property of the form (e.g. |previewer|).
* For an example, see twinklewarn.js.
*
* twinklewarn.js.
* @memberof Morebits.wiki
*/
* @class
 
* @param {HTMLElement} previewbox - The element that will contain the rendered HTML,
/**
* usually a <div> element.
* @constructor
* @param {HTMLElement} previewbox - the element that will contain the rendered HTML,
* usually a <div> element
*/
Morebits.wiki.preview = function(previewbox) {
Line 3,302 ⟶ 4,715:
* Displays the preview box, and begins an asynchronous attempt
* to render the specified wikitext.
*
* @param {string} wikitext - wikitext to render; most things should work, including subst: and ~~~~
* @param {string} [pageTitle]wikitext - optionalWikitext parameterto forrender; themost page thisthings should be rendered as being onwork, if omitted it is taken asincluding the`subst:` currentand page`~~~~`.
* @param {string} [pageTitle] - Optional parameter for the page this should be rendered as being on, if omitted it is taken as the current page.
* @param {string} [sectionTitle] - If provided, render the text as a new section using this as the title.
* @returns {jQuery.promise}
*/
this.beginRender = function(wikitext, pageTitle, sectionTitle) {
$(previewbox).show();
 
Line 3,317 ⟶ 4,733:
pst: 'true', // PST = pre-save transform; this makes substitution work properly
text: wikitext,
title: pageTitle || mw.config.get('wgPageName'),
disablelimitreport: true,
format: 'json'
};
if (sectionTitle) {
query.section = 'new';
query.sectiontitle = sectionTitle;
}
var renderApi = new Morebits.wiki.api('loading...', query, fnRenderSuccess, new Morebits.status('Preview'));
return renderApi.post();
};
 
var fnRenderSuccess = function(apiobj) {
var xmlhtml = apiobj.getXMLgetResponse().parse.text;
var html = $(xml).find('text').text();
if (!html) {
apiobj.statelem.error('failed to retrieve preview, or template was blanked');
Line 3,341 ⟶ 4,762:
 
 
/* **************** Morebits.wikitext **************** */
 
/**
* Wikitext manipulation.
* **************** Morebits.wikitext ****************
*
* Wikitext manipulation
* @namespace Morebits.wikitext
* @memberof Morebits
*/
 
Morebits.wikitext = {};
 
/**
Morebits.wikitext.template = {
* Get the value of every parameter found in the wikitext of a given template.
parse: function(text, start) {
*
var count = -1;
* @memberof Morebits.wikitext
var level = -1;
* @param {string} text - Wikitext containing a template.
var equals = -1;
* @param {number} [start=0] - Index noting where in the text the template begins.
var current = '';
* @returns {object} `{name: templateName, parameters: {key: value}}`.
var result = {
*/
name: '',
Morebits.wikitext.parseTemplate = function(text, start) {
parameters: {}
start = start || 0;
};
var key, value;
 
var level = []; // Track of how deep we are ({{, {{{, or [[)
for (var i = start; i < text.length; ++i) {
var count = -1; // Number of parameters found
var test3 = text.substr(i, 3);
var unnamed = 0; // Keep track of what number an unnamed parameter should receive
if (test3 === '{{{') {
var equals = -1; // After finding "=" before a parameter, the index; otherwise, -1
current += '{{{';
i var current += 2'';
var result = {
++level;
name: '',
continue;
parameters: {}
}
};
if (test3 === '}}}') {
var key, value;
current += '}}}';
i += 2;
--level;
continue;
}
var test2 = text.substr(i, 2);
if (test2 === '{{' || test2 === '[[') {
current += test2;
++i;
++level;
continue;
}
if (test2 === ']]') {
current += ']]';
++i;
--level;
continue;
}
if (test2 === '}}') {
current += test2;
++i;
--level;
 
/**
if (level <= 0) {
* Function to handle finding parameter values.
if (count === -1) {
*
result.name = current.substring(2).trim();
* @param {boolean} [final=false] - Whether this is the final
++count;
* parameter and we need to remove the trailing `}}`.
} else {
*/
if (equals !== -1) {
function findParam(final) {
key = current.substring(0, equals).trim();
// Nothing found yet, this must be the template name
value = current.substring(equals).trim();
if (count === -1) {
result.parameters[key] = value;
result.name = current.substring(2).trim();
equals = -1;
} else {++count;
} else {
result.parameters[count] = current;
// In a parameter
++count;
if (equals !== -1) {
}
// We found an equals, so save the parameter as key: value
}
key = current.substring(0, equals).trim();
break;
value = final ? current.substring(equals + 1, current.length - 2).trim() : current.substring(equals + 1).trim();
result.parameters[key] = value;
equals = -1;
} else {
// No equals, so it must be unnamed; no trim since whitespace allowed
var param = final ? current.substring(equals + 1, current.length - 2) : current;
if (param) {
result.parameters[++unnamed] = param;
++count;
}
continue;
}
}
}
 
if for (text.charAt(var i) === '|'start; && leveli <= 0text.length; ++i) {
var test3 = text.substr(i, 3);
if (count === -1) {
if (test3 === '{{{' || (test3 === '}}}' && level[level.length - 1] === 3)) {
result.name = current.substring(2).trim();
current ++count= test3;
}i else+= {2;
if (equalstest3 !=== -1'{{{') {
level.push(3);
key = current.substring(0, equals).trim();
value = current.substring(equals + 1).trim();
result.parameters[key] = value;
equals = -1;
} else {
result.parameters[count] = current;
++count;
}
}
current = '';
} else if (equals === -1 && text.charAt(i) === '=' && level <= 0) {
equals = current.length;
current += text.charAt(i);
} else {
current += textlevel.charAtpop(i);
}
continue;
}
var test2 = text.substr(i, 2);
// Entering a template (or link)
if (test2 === '{{' || test2 === '[[') {
current += test2;
++i;
if (test2 === '{{') {
level.push(2);
} else {
level.push('wl');
}
continue;
}
// Either leaving a link or template/parser function
if ((test2 === '}}' && level[level.length - 1] === 2) ||
(test2 === ']]' && level[level.length - 1] === 'wl')) {
current += test2;
++i;
level.pop();
 
// Find the final parameter if this really is the end
return result;
if (test2 === '}}' && level.length === 0) {
findParam(true);
break;
}
continue;
}
 
if (text.charAt(i) === '|' && level.length === 1) {
// Another pipe found, toplevel, so parameter coming up!
findParam();
current = '';
} else if (equals === -1 && text.charAt(i) === '=' && level.length === 1) {
// Equals found, toplevel
equals = current.length;
current += text.charAt(i);
} else {
// Just advance the position
current += text.charAt(i);
}
}
 
return result;
};
 
/**
* Adjust and manipulate the wikitext of a page.
* @constructor
*
* @param {string} text
* @class
* @memberof Morebits.wikitext
* @param {string} text - Wikitext to be manipulated.
*/
Morebits.wikitext.page = function mediawikiPage(text) {
Line 3,454 ⟶ 4,896:
/**
* Removes links to `link_target` from the page text.
*
* @param {string} link_target
* @returns {Morebits.wikitext.page}
*/
removeLink: function(link_target) {
// Remove a leading colon, to be handled later
var first_char = link_target.substr(0, 1);
if (link_target.indexOf(':') === 0) {
var link_re_string = '[' + first_char.toUpperCase() + first_char.toLowerCase() + ']' + RegExp.escape(link_target.substr(1), true);
link_target = link_target.slice(1);
}
var link_re_string = '', ns = '', title = link_target;
 
var idx = link_target.indexOf(':');
if (idx > 0) {
ns = link_target.slice(0, idx);
title = link_target.slice(idx + 1);
 
link_re_string = Morebits.namespaceRegex(mw.config.get('wgNamespaceIds')[ns.toLowerCase().replace(/ /g, '_')]) + ':';
}
link_re_string += Morebits.pageNameRegex(title);
 
// Allow for an optional leading colon, e.g. [[:User:Test]]
// Files and Categories become links with a leading colon, e.g. [[:File:Test.png]]
var colon = new RegExp(Morebits.namespaceRegex([6, 14])).test(ns) ? ':' : ':?';
// Otherwise, allow for an optional leading colon, e.g. [[:User:Test]]
var special_ns_re = /^(?:[Ff]ile|[Ii]mage|[Cc]ategory):/;
var colon = special_ns_re.test(link_target) ? ':' : ':?';
 
var link_simple_re = new RegExp('\\[\\[' + colon + '(' + link_re_string + ')\\]\\]', 'g');
var link_named_re = new RegExp('\\[\\[' + colon + link_re_string + '\\|(.+?)\\]\\]', 'g');
this.text = this.text.replace(link_simple_re, '$1').replace(link_named_re, '$1');
return this;
},
 
/**
* Comments out images from page text.; Ifif used in a gallery, deletes the whole line.
* If used as a template argument (not necessarily with `File:` prefix), the template parameter is commented out.
*
* @param {string} image - Image name without File: prefix
* @param {string} reasonimage - ReasonImage toname bewithout included`File:` in comment, alongside the commented-out imageprefix.
* @param {string} [reason] - Reason to be included in comment, alongside the commented-out image.
* @returns {Morebits.wikitext.page}
*/
commentOutImage: function(image, reason) {
Line 3,481 ⟶ 4,939:
 
reason = reason ? reason + ': ' : '';
var first_charimage_re_string = imageMorebits.substrpageNameRegex(0, 1image);
var image_re_string = '[' + first_char.toUpperCase() + first_char.toLowerCase() + ']' + RegExp.escape(image.substr(1), true);
 
// Check for normal image links, i.e. [[File:Foobar.png|...]]
// Will eat the whole link
var links_re = new RegExp('\\[\\[' + Morebits.namespaceRegex(?:[Ii]mage|[Ff]ile6) + ':\\s*' + image_re_string + '\\s*[\\|(?:\\]\\])]');
var allLinks = Morebits.array.uniq(Morebits.string.splitWeightedByKeys(unbinder.content, '[[', ']]'));
for (var i = 0; i < allLinks.length; ++i) {
if (links_re.test(allLinks[i])) {
var replacement = '<!-- ' + reason + allLinks[i] + ' -->';
unbinder.content = unbinder.content.replace(allLinks[i], replacement, 'g');
}
}
Line 3,500 ⟶ 4,957:
// eventually preceded with some space, and must include File: prefix
// Will eat the whole line.
var gallery_image_re = new RegExp('(^\\s*' + Morebits.namespaceRegex(?:[Ii]mage|[Ff]ile6) + ':\\s*' + image_re_string + '\\s*(?:\\|.*?$|$))', 'mg');
unbinder.content = unbinder.content.replace(gallery_image_re, '<!-- ' + reason + '$1 -->');
 
Line 3,506 ⟶ 4,963:
unbinder.unbind('<!--', '-->');
 
// Check free image usages, for example as template arguments, might have the File: prefix excluded, but must be preceededpreceded by an |
// Will only eat the image name and the preceedingpreceding bar and an eventual named parameter
var free_image_re = new RegExp('(\\|\\s*(?:[\\w\\s]+\\=)?\\s*(?:' + Morebits.namespaceRegex(?:[Ii]mage|[Ff]ile6) + ':\\s*)?' + image_re_string + ')', 'mg');
unbinder.content = unbinder.content.replace(free_image_re, '<!-- ' + reason + '$1 -->');
// Rebind the content now, we are done!
this.text = unbinder.rebind();
return this;
},
 
/**
* Converts first usageuses of [[File:`image`]] to [[File:`image`|`data`]].
*
* @param {string} image - Image name without File: prefix
* @param {string} dataimage - Image name without File: prefix.
* @param {string} data - The display options.
* @returns {Morebits.wikitext.page}
*/
addToImageComment: function(image, data) {
var first_charimage_re_string = imageMorebits.substrpageNameRegex(0, 1image);
var links_re = new RegExp('\\[\\[' + Morebits.namespaceRegex(6) + ':\\s*' + image_re_string + '\\s*[\\|(?:\\]\\])]');
var first_char_regex = RegExp.escape(first_char, true);
var allLinks = Morebits.string.splitWeightedByKeys(this.text, '[[', ']]');
if (first_char.toUpperCase() !== first_char.toLowerCase()) {
first_char_regex = '[' + RegExp.escape(first_char.toUpperCase(), true) + RegExp.escape(first_char.toLowerCase(), true) + ']';
}
var image_re_string = '(?:[Ii]mage|[Ff]ile):\\s*' + first_char_regex + RegExp.escape(image.substr(1), true);
var links_re = new RegExp('\\[\\[' + image_re_string);
var allLinks = Morebits.array.uniq(Morebits.string.splitWeightedByKeys(this.text, '[[', ']]'));
for (var i = 0; i < allLinks.length; ++i) {
if (links_re.test(allLinks[i])) {
Line 3,533 ⟶ 4,988:
// just put it at the end?
replacement = replacement.replace(/\]\]$/, '|' + data + ']]');
this.text = this.text.replace(allLinks[i], replacement, 'g');
}
}
Line 3,539 ⟶ 4,994:
var newtext = '$1|$2 ' + data;
this.text = this.text.replace(gallery_re, newtext);
return this;
},
 
/**
* RemovesRemove all transclusions of a template from page text.
*
* @param {string} template - Page name whose transclusions are to be removed,
* include namespace prefix only if not in template namespace.
* @returns {Morebits.wikitext.page}
*/
removeTemplate: function(template) {
var first_chartemplate_re_string = templateMorebits.substrpageNameRegex(0, 1template);
var links_re = new RegExp('\\{\\{(?:' + Morebits.namespaceRegex(10) + ':)?\\s*' + template_re_string + '\\s*[\\|(?:\\}\\})]');
var template_re_string = '(?:[Tt]emplate:)?\\s*[' + first_char.toUpperCase() + first_char.toLowerCase() + ']' + RegExp.escape(template.substr(1), true);
var allTemplates = Morebits.string.splitWeightedByKeys(this.text, '{{', '}}', [ '{{{', '}}}' ]);
var links_re = new RegExp('\\{\\{' + template_re_string);
var allTemplates = Morebits.array.uniq(Morebits.string.splitWeightedByKeys(this.text, '{{', '}}', [ '{{{', '}}}' ]));
for (var i = 0; i < allTemplates.length; ++i) {
if (links_re.test(allTemplates[i])) {
this.text = this.text.replace(allTemplates[i], '', 'g');
}
}
return this;
},
 
/**
/** @returns {string} */
* Smartly insert a tag atop page text but after specified templates,
* such as hatnotes, short description, or deletion and protection templates.
* Notably, does *not* insert a newline after the tag.
*
* @param {string} tag - The tag to be inserted.
* @param {string|string[]} regex - Templates after which to insert tag,
* given as either as a (regex-valid) string or an array to be joined by pipes.
* @param {string} [flags=i] - Regex flags to apply. `''` to provide no flags;
* other falsey values will default to `i`.
* @param {string|string[]} [preRegex] - Optional regex string or array to match
* before any template matches (i.e. before `{{`), such as html comments.
* @returns {Morebits.wikitext.page}
*/
insertAfterTemplates: function(tag, regex, flags, preRegex) {
if (typeof tag === 'undefined') {
throw new Error('No tag provided');
}
 
// .length is only a property of strings and arrays so we
// shouldn't need to check type
if (typeof regex === 'undefined' || !regex.length) {
throw new Error('No regex provided');
} else if (Array.isArray(regex)) {
regex = regex.join('|');
}
 
if (typeof flags !== 'string') {
flags = 'i';
}
 
if (!preRegex || !preRegex.length) {
preRegex = '';
} else if (Array.isArray(preRegex)) {
preRegex = preRegex.join('|');
}
 
 
// Regex is extra complicated to allow for templates with
// parameters and to handle whitespace properly
this.text = this.text.replace(
new RegExp(
// leading whitespace
'^\\s*' +
// capture template(s)
'(?:((?:\\s*' +
// Pre-template regex, such as leading html comments
preRegex + '|' +
// begin template format
'\\{\\{\\s*(?:' +
// Template regex
regex +
// end main template name, optionally with a number
// Probably remove the (?:) though
')\\d*\\s*' +
// template parameters
'(\\|(?:\\{\\{[^{}]*\\}\\}|[^{}])*)?' +
// end template format
'\\}\\})+' +
// end capture
'(?:\\s*\\n)?)' +
// trailing whitespace
'\\s*)?',
flags), '$1' + tag
);
return this;
},
 
/**
* Get the manipulated wikitext.
*
* @returns {string}
*/
getText: function() {
return this.text;
Line 3,564 ⟶ 5,094:
};
 
 
/* *********** Morebits.userspaceLogger ************ */
/**
* Handles logging actions to a userspace log.
* **************** Morebits.status ****************
* Used in CSD, PROD, and XFD.
*
* @memberof Morebits
* @class
* @param {string} logPageName - Title of the subpage of the current user's log.
*/
Morebits.userspaceLogger = function(logPageName) {
if (!logPageName) {
throw new Error('no log page name specified');
}
/**
* The text to prefix the log with upon creation, defaults to empty.
*
* @type {string}
*/
this.initialText = '';
/**
* The header level to use for months, defaults to 3 (`===`).
*
* @type {number}
*/
this.headerLevel = 3;
this.changeTags = '';
 
/**
* Log the entry.
*
* @param {string} logText - Doesn't include leading `#` or `*`.
* @param {string} summaryText - Edit summary.
* @returns {JQuery.Promise}
*/
this.log = function(logText, summaryText) {
var def = $.Deferred();
if (!logText) {
return def.reject();
}
var page = new Morebits.wiki.page('User:' + mw.config.get('wgUserName') + '/' + logPageName,
'Adding entry to userspace log'); // make this '... to ' + logPageName ?
page.load(function(pageobj) {
// add blurb if log page doesn't exist or is blank
var text = pageobj.getPageText() || this.initialText;
 
// create monthly header if it doesn't exist already
var date = new Morebits.date(pageobj.getLoadTime());
if (!date.monthHeaderRegex().exec(text)) {
text += '\n\n' + date.monthHeader(this.headerLevel);
}
 
pageobj.setPageText(text + '\n' + logText);
pageobj.setEditSummary(summaryText);
pageobj.setChangeTags(this.changeTags);
pageobj.setCreateOption('recreate');
pageobj.save(def.resolve, def.reject);
}.bind(this));
return def;
};
};
 
 
/* **************** Morebits.status **************** */
/**
* Create and show status messages of varying urgency.
* @constructor
* {@link Morebits.status.init|Morebits.status.init()} must be called before any status object is created, otherwise
* any status object is created, otherwise those statuses won't be visible.
*
* @param {String} text - Text before the the colon `:`
* @memberof Morebits
* @param {String} stat - Text after the colon `:`
* @class
* @param {String} [type=status] - This parameter determines the font color of the status line,
* @param {string} text - Text before the the colon `:`.
* this can be 'status' (blue), 'info' (green), 'warn' (red), or 'error' (bold red)
* @param {string} stat - Text after the colon `:`.
* The default is 'status'
* @param {string} [type=status] - Determine the font color of the status
* line, allowable values are: `status` (blue), `info` (green), `warn` (red),
* or `error` (bold red).
*/
 
Morebits.status = function Status(text, stat, type) {
this.textRaw = text;
this.text = thisMorebits.codifycreateHtml(text);
this.type = type || 'status';
this.generate();
Line 3,590 ⟶ 5,183:
 
/**
* Specify an area for status message elements to be added to.
*
* @param {HTMLElement} root - usually a div element
* @memberof Morebits.status
* @param {HTMLElement} root - Usually a div element.
* @throws If `root` is not an `HTMLElement`.
*/
Morebits.status.init = function(root) {
Line 3,606 ⟶ 5,202:
Morebits.status.root = null;
 
/**
/** @param {Function} handler - function to execute on error */
* @memberof Morebits.status
* @param {Function} handler - Function to execute on error.
* @throws When `handler` is not a function.
*/
Morebits.status.onError = function(handler) {
if (typeof handler === 'function') {
Line 3,617 ⟶ 5,217:
Morebits.status.prototype = {
stat: null,
statRaw: null,
text: null,
textRaw: null,
Line 3,624 ⟶ 5,225:
linked: false,
 
/** Add the status element node to the DOM. */
link: function() {
if (!this.linked && Morebits.status.root) {
Line 3,632 ⟶ 5,233:
},
 
/** Remove the status element node from the DOM. */
unlink: function() {
if (this.linked) {
Line 3,641 ⟶ 5,242:
 
/**
* Create a document fragment withUpdate the status text.
*
* @param {(string|Element|Array)} obj
* @param {string} status - Part of status message after colon.
* @returns {DocumentFragment}
* @param {string} type - 'status' (blue), 'info' (green), 'warn'
*/
* (red), or 'error' (bold red).
codify: function(obj) {
if (!Array.isArray(obj)) {
obj = [ obj ];
}
var result;
result = document.createDocumentFragment();
for (var i = 0; i < obj.length; ++i) {
if (typeof obj[i] === 'string') {
result.appendChild(document.createTextNode(obj[i]));
} else if (obj[i] instanceof Element) {
result.appendChild(obj[i]);
} // Else cosmic radiation made something shit
}
return result;
 
},
 
/**
* Update the status
* @param {String} status - Part of status message after colon `:`
* @param {String} type - 'status' (blue), 'info' (green), 'warn' (red), or 'error' (bold red)
*/
update: function(status, type) {
this.statstatRaw = this.codify(status);
this.stat = Morebits.createHtml(status);
if (type) {
this.type = type;
Line 3,681 ⟶ 5,263:
 
// also log error messages in the browser console
console.error(this.textRaw + ': ' + statusthis.statRaw); // eslint-disable-line no-console
}
}
Line 3,687 ⟶ 5,269:
},
 
/** Produce the html for first part of the status message. */
generate: function() {
this.node = document.createElement('div');
Line 3,696 ⟶ 5,278:
},
 
/** Complete the html, for the second part of the status message. */
render: function() {
this.node.className = 'tw_status_morebits_status_' + this.type;
while (this.target.hasChildNodes()) {
this.target.removeChild(this.target.firstChild);
Line 3,718 ⟶ 5,300:
}
};
/**
 
* @memberof Morebits.status
* @param {string} text - Before colon
* @param {string} status - After colon
* @returns {Morebits.status} - `status`-type (blue)
*/
Morebits.status.status = function(text, status) {
return new Morebits.status(text, status);
};
/**
* @memberof Morebits.status
* @param {string} text - Before colon
* @param {string} status - After colon
* @returns {Morebits.status} - `info`-type (green)
*/
Morebits.status.info = function(text, status) {
return new Morebits.status(text, status, 'info');
};
/**
 
* @memberof Morebits.status
* @param {string} text - Before colon
* @param {string} status - After colon
* @returns {Morebits.status} - `warn`-type (red)
*/
Morebits.status.warn = function(text, status) {
return new Morebits.status(text, status, 'warn');
};
/**
 
* @memberof Morebits.status
* @param {string} text - Before colon
* @param {string} status - After colon
* @returns {Morebits.status} - `error`-type (bold red)
*/
Morebits.status.error = function(text, status) {
return new Morebits.status(text, status, 'error');
Line 3,734 ⟶ 5,340:
* For the action complete message at the end, create a status line without
* a colon separator.
*
* @param {String} text
* @memberof Morebits.status
* @param {string} text
*/
Morebits.status.actionCompleted = function(text) {
var node = document.createElement('div');
node.appendChild(document.createElement('spanb')).appendChild(document.createTextNode(text));
node.className = 'tw_status_infomorebits_status_info morebits_action_complete';
if (Morebits.status.root) {
Morebits.status.root.appendChild(node);
Line 3,746 ⟶ 5,354:
 
/**
* Display the user's rationale, comments, etc. backBack to them after a failure,
* so that they may re-use it.
*
* @memberof Morebits.status
* @param {string} comments
* @param {string} message
Line 3,766 ⟶ 5,376:
 
/**
* Simple helper function to create a simple node.
* **************** Morebits.htmlNode() ****************
*
* Simple helper function to create a simple node
* @param {string} type - typeType of HTML element.
* @param {string} textcontent - textText content.
* @param {string} [color] - fontFont color.
* @returns {HTMLElement}
*/
Line 3,785 ⟶ 5,395:
 
/**
* Add shift-click support for checkboxes. The wikibits version
* **************** Morebits.checkboxShiftClickSupport() ****************
* (`window.addCheckboxClickHandlers`) has some restrictions, and doesn't work
* shift-click-support for checkboxes
* with checkboxes inside a sortable table, so let's build our own.
* wikibits version (window.addCheckboxClickHandlers) has some restrictions, and
*
* doesn't work with checkboxes inside a sortable table, so let's build our own.
* @param jQuerySelector
* @param jQueryContext
*/
Morebits.checkboxShiftClickSupport = function (jQuerySelector, jQueryContext) {
Line 3,841 ⟶ 5,453:
 
 
/** **************** Morebits.batchOperation **************** */
/**
* Iterates over a group of pages (or arbitrary objects) and executes a worker function
* for each.
*
* `setPageList(pageList)`: Sets the list of pages to work on. It should be an
* Constructor: Morebits.batchOperation(currentAction)
* array of page names strings.
*
* `setOption(optionName, optionValue)`: Sets a known option:
* setPageList(wikitext): Sets the list of pages to work on.
* - `chunkSize` (integer): The size of chunks to break the array into (default
* It should be an array of page names (strings).
* 50). Setting this to a small value (<5) can cause problems.
* - `preserveIndividualStatusLines` (boolean): Keep each page's status element
* visible when worker is complete? See note below.
*
* `run(worker, postFinish)`: Runs the callback `worker` for each page in the
* setOption(optionName, optionValue): Sets a known option:
* list. The callback must call `workerSuccess` when succeeding, or
* - chunkSize (integer): the size of chunks to break the array into (default 50).
* `workerFailure` when failing. If using {@link Morebits.wiki.api} or
* Setting this to a small value (<5) can cause problems.
* {@link Morebits.wiki.page}, this is easily done by passing these two
* - preserveIndividualStatusLines (boolean): keep each page's status element visible
* functions as parameters to the methods on those objects: for instance,
* when worker is complete? See note below
* `page.save(batchOp.workerSuccess, batchOp.workerFailure)`. Make sure the
* methods are called directly if special success/failure cases arise. If you
* omit to call these methods, the batch operation will stall after the first
* chunk! Also ensure that either workerSuccess or workerFailure is called no
* more than once. The second callback `postFinish` is executed when the
* entire batch has been processed.
*
* If using `preserveIndividualStatusLines`, you should try to ensure that the
* run(worker, postFinish): Runs the callback `worker` for each page in the list.
* `workerSuccess` callback has access to the page title. This is no problem for
* The callback must call workerSuccess when succeeding, or workerFailure
* {@link Morebits.wiki.page} objects. But when using the API, please set the
* when failing. If using Morebits.wiki.api or Morebits.wiki.page, this is easily
* |pageName| property on the {@link Morebits.wiki.api} object.
* done by passing these two functions as parameters to the methods on those
* objects, for instance, page.save(batchOp.workerSuccess, batchOp.workerFailure).
* Make sure the methods are called directly if special success/failure cases arise.
* If you omit to call these methods, the batch operation will stall after the first
* chunk! Also ensure that either workerSuccess or workerFailure is called no more
* than once.
* The second callback `postFinish` is executed when the entire batch has been processed.
*
* If using preserveIndividualStatusLines, you should try to ensure that the
* workerSuccess callback has access to the page title. This is no problem for
* Morebits.wiki.page objects. But when using the API, please set the
* |pageName| property on the Morebits.wiki.api object.
*
* There are sample batchOperation implementations using Morebits.wiki.page in
* twinklebatchdelete.js, twinklebatchundelete.js, and twinklebatchprotect.js.
*/
* @memberof Morebits
 
* @class
/**
* @constructor
* @param {string} [currentAction]
*/
Line 3,890 ⟶ 5,501:
 
// internal counters, etc.
statusElement: new Morebits.status(currentAction || msg('batch-starting', 'Performing batch operation')),
worker: null, // function that executes for each item in pageList
postFinish: null, // function that executes when the whole batch has been processed
Line 3,907 ⟶ 5,518:
 
/**
* Sets the list of pages to work on.
*
* @param {Array} pageList Array of objects over which you wish to execute the worker function
* @param {Array} pageList - Array of objects over which you wish to execute the worker function
* This is usually the list of page names (strings).
*/
Line 3,916 ⟶ 5,528:
 
/**
* Sets a known option:.
*
* - chunkSize (integer):
* @param {string} optionName - Name of the option:
* The size of chunks to break the array into (default 50).
* - chunkSize (integer): The size of chunks to break the array into
* Setting this to a small value (<5) can cause problems.
* (default 50). Setting this to a small value (<5) can cause problems.
* - preserveIndividualStatusLines (boolean):
* - preserveIndividualStatusLines (boolean): Keep each page's status
* element visible when worker is complete?
* @param {number|boolean} optionValue - Value to which the option is
* to be set. Should be an integer for chunkSize and a boolean for
* preserveIndividualStatusLines.
*/
this.setOption = function(optionName, optionValue) {
Line 3,930 ⟶ 5,546:
* Runs the first callback for each page in the list.
* The callback must call workerSuccess when succeeding, or workerFailure when failing.
* Runs the optional second callback when the whole batch has been processed (optional).
*
* @param {Function} worker
* @param {Function} [postFinish]
Line 3,951 ⟶ 5,568:
var total = ctx.pageList.length;
if (!total) {
ctx.statusElement.info(msg('batch-no-pages', 'no pages specified'));
ctx.running = false;
if (ctx.postFinish) {
Line 3,969 ⟶ 5,586:
 
/**
* To be called by worker before it terminates succesfullysuccessfully.
*
* @param {(Morebits.wiki.page|Morebits.wiki.api|string)} arg
* @param {(Morebits.wiki.page|Morebits.wiki.api|string)} arg -
* This should be the `Morebits.wiki.page` or `Morebits.wiki.api` object used by worker
* (for the adjustment of status lines emitted by them).
* If no Morebits.wiki.* object is used (ege.g. you're using `mw.Api()` or something else), and
* `preserveIndividualStatusLines` option is on, give the page name (string) as argument.
*/
this.workerSuccess = function(arg) {
 
var createPageLink = function(pageName) {
var link = document.createElement('a');
link.setAttribute('href', mw.util.getUrl(pageName));
link.appendChild(document.createTextNode(pageName));
return link;
};
 
if (arg instanceof Morebits.wiki.api || arg instanceof Morebits.wiki.page) {
Line 3,992 ⟶ 5,603:
// we know the page title - display a relevant message
var pageName = arg.getPageName ? arg.getPageName() : arg.pageName || arg.query.title;
statelem.info([msg('batch-done-page', pageName, 'completed ([[', createPageLink(+ pageName), + ']])']));
} else {
// we don't know the page title - just display a generic message
statelem.info(msg('done', 'done'));
}
} else {
Line 4,003 ⟶ 5,614:
 
} else if (typeof arg === 'string' && ctx.options.preserveIndividualStatusLines) {
new Morebits.status(arg, [msg('batch-done (-page', createPageLink(arg), ')completed ([[' + arg + ']])'));
}
 
Line 4,036 ⟶ 5,647:
// update overall status line
var total = ctx.pageList.length;
if (ctx.countFinished ===< total) {
var statusStringprogress = 'Done Math.round('100 +* ctx.countFinishedSuccesscountFinished / +total);
ctx.statusElement.status(msg('percent', progress, progress + '%'));
'/' + ctx.countFinished + ' actions completed successfully)';
 
// start a new chunk if we're close enough to the end of the previous chunk, and
// we haven't already started the next one
if (ctx.countFinished >= (ctx.countStarted - Math.max(ctx.options.chunkSize / 10, 2)) &&
Math.floor(ctx.countFinished / ctx.options.chunkSize) > ctx.currentChunkIndex) {
fnStartNewChunk();
}
} else if (ctx.countFinished === total) {
var statusString = msg('batch-progress', ctx.countFinishedSuccess, ctx.countFinished, 'Done (' + ctx.countFinishedSuccess +
'/' + ctx.countFinished + ' actions completed successfully)');
if (ctx.countFinishedSuccess < ctx.countFinished) {
ctx.statusElement.warn(statusString);
Line 4,049 ⟶ 5,670:
Morebits.wiki.removeCheckpoint();
ctx.running = false;
} else {
return;
// ctx.countFinished > total
}
// just for giggles! (well, serious debugging, actually)
 
// just for giggles! (well, serious debugging, actually)
if (ctx.countFinished > total) {
ctx.statusElement.warn('Done (overshot by ' + (ctx.countFinished - total) + ')');
Morebits.wiki.removeCheckpoint();
ctx.running = false;
return;
}
};
};
 
/**
ctx.statusElement.status(parseInt(100 * ctx.countFinished / total, 10) + '%');
* Given a set of asynchronous functions to run along with their dependencies,
* run them in an efficient sequence so that multiple functions
* that don't depend on each other are triggered simultaneously. Where
* dependencies exist, it ensures that the dependency functions finish running
* before the dependent function runs. The values resolved by the dependencies
* are made available to the dependant as arguments.
*
* @memberof Morebits
* @class
*/
Morebits.taskManager = function(context) {
this.taskDependencyMap = new Map();
this.failureCallbackMap = new Map();
this.deferreds = new Map();
this.allDeferreds = []; // Hack: IE doesn't support Map.prototype.values
this.context = context || window;
 
/**
// start a new chunk if we're close enough to the end of the previous chunk, and
* Register a task along with its dependencies (tasks which should have finished
// we haven't already started the next one
* execution before we can begin this one). Each task is a function that must return
if (ctx.countFinished >= (ctx.countStarted - Math.max(ctx.options.chunkSize / 10, 2)) &&
* a promise. The function will get the values resolved by the dependency functions
Math.floor(ctx.countFinished / ctx.options.chunkSize) > ctx.currentChunkIndex) {
* as arguments.
fnStartNewChunk();
} *
* @param {Function} func - A task.
* @param {Function[]} deps - Its dependencies.
* @param {Function} [onFailure] - a failure callback that's run if the task or any one
* of its dependencies fail.
*/
this.add = function(func, deps, onFailure) {
this.taskDependencyMap.set(func, deps);
this.failureCallbackMap.set(func, onFailure || function() {});
var deferred = $.Deferred();
this.deferreds.set(func, deferred);
this.allDeferreds.push(deferred);
};
};
 
/**
* Run all the tasks. Multiple tasks may be run at once.
*
* @returns {jQuery.Promise} - Resolved if all tasks succeed, rejected otherwise.
*/
this.execute = function() {
var self = this; // proxy for `this` for use inside functions where `this` is something else
this.taskDependencyMap.forEach(function(deps, task) {
var dependencyPromisesArray = deps.map(function(dep) {
return self.deferreds.get(dep);
});
$.when.apply(self.context, dependencyPromisesArray).then(function() {
var result = task.apply(self.context, arguments);
if (result === undefined) { // maybe the function threw, or it didn't return anything
mw.log.error('Morebits.taskManager: task returned undefined');
self.deferreds.get(task).reject.apply(self.context, arguments);
self.failureCallbackMap.get(task).apply(self.context, []);
}
result.then(function() {
self.deferreds.get(task).resolve.apply(self.context, arguments);
}, function() { // task failed
self.deferreds.get(task).reject.apply(self.context, arguments);
self.failureCallbackMap.get(task).apply(self.context, arguments);
});
}, function() { // one or more of the dependencies failed
self.failureCallbackMap.get(task).apply(self.context, arguments);
});
});
return $.when.apply(null, this.allDeferreds); // resolved when everything is done!
};
 
};
 
/**
* A simple draggable window, now a wrapper for jQuery UI's dialog feature.
* **************** Morebits.simpleWindow ****************
*
* A simple draggable window
* @memberof Morebits
* now a wrapper for jQuery UI's dialog feature
* @class
* @requires {jquery.ui.dialog}
*/
 
/**
* @constructor
* @param {number} width
* @param {number} height - The maximum allowable height for the content area.
*/
Morebits.simpleWindow = function SimpleWindow(width, height) {
Line 4,113 ⟶ 5,787:
}
},
resizeEndresizeStop: function() {
this.scrollbox = null;
},
Line 4,125 ⟶ 5,799:
 
var $widget = $(this.content).dialog('widget');
 
// add background gradient to titlebar
var $titlebar = $widget.find('.ui-dialog-titlebar');
var oldstyle = $titlebar.attr('style');
$titlebar.attr('style', (oldstyle ? oldstyle : '') + '; background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAkCAMAAAB%2FqqA%2BAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAEhQTFRFr73ZobTPusjdsMHZp7nVwtDhzNbnwM3fu8jdq7vUt8nbxtDkw9DhpbfSvMrfssPZqLvVztbno7bRrr7W1d%2Fs1N7qydXk0NjpkW7Q%2BgAAADVJREFUeNoMwgESQCAAAMGLkEIi%2FP%2BnbnbpdB59app5Vdg0sXAoMZCpGoFbK6ciuy6FX4ABAEyoAef0BXOXAAAAAElFTkSuQmCC) !important;');
 
// delete the placeholder button (it's only there so the buttonpane gets created)
Line 4,155 ⟶ 5,824:
/**
* Focuses the dialog. This might work, or on the contrary, it might not.
*
* @returns {Morebits.simpleWindow}
*/
Line 4,165 ⟶ 5,835:
* Closes the dialog. If this is set as an event handler, it will stop the event
* from doing anything more.
*
* @param {event} [event]
* @returns {Morebits.simpleWindow}
*/
Line 4,178 ⟶ 5,850:
* Shows the dialog. Calling display() on a dialog that has previously been closed
* might work, but it is not guaranteed.
*
* @returns {Morebits.simpleWindow}
*/
Line 4,201 ⟶ 5,874:
/**
* Sets the dialog title.
*
* @param {string} title
* @returns {Morebits.simpleWindow}
Line 4,212 ⟶ 5,886:
* Sets the script name, appearing as a prefix to the title to help users determine which
* user script is producing which dialog. For instance, Twinkle modules set this to "Twinkle".
*
* @param {string} name
* @returns {Morebits.simpleWindow}
Line 4,222 ⟶ 5,897:
/**
* Sets the dialog width.
*
* @param {number} width
* @returns {Morebits.simpleWindow}
Line 4,233 ⟶ 5,909:
* Sets the dialog's maximum height. The dialog will auto-size to fit its contents,
* but the content area will grow no larger than the height given here.
*
* @param {number} height
* @returns {Morebits.simpleWindow}
Line 4,255 ⟶ 5,932:
/**
* Sets the content of the dialog to the given element node, usually from rendering
* a {@link Morebits.quickForm}.
* Re-enumerates the footer buttons, but leaves the footer links as they are.
* Be sure to call this at least once before the dialog is displayed...
*
* @param {HTMLElement} content
* @returns {Morebits.simpleWindow}
Line 4,269 ⟶ 5,947:
/**
* Adds the given element node to the dialog content.
*
* @param {HTMLElement} content
* @returns {Morebits.simpleWindow}
Line 4,280 ⟶ 5,959:
value.style.display = 'none';
var button = document.createElement('button');
button.textContent = value.hasAttribute('value') ? value.getAttribute('value') : value.textContent ? value.textContent : msg('submit', 'Submit Query');
button.className = value.className || 'submitButtonProxy';
// here is an instance of cheap coding, probably a memory-usage hit in using a closure here
Line 4,298 ⟶ 5,977:
 
/**
* Removes all contents from the dialog, barring any footer links.
*
* @returns {Morebits.simpleWindow}
*/
Line 4,317 ⟶ 5,997:
* For example, Twinkle's CSD module adds a link to the CSD policy page,
* as well as a link to Twinkle's documentation.
*
* @param {string} text Link's text content
* @param {string} wikiPagetext - LinkDisplay targettext.
* @param {string} wikiPage - Link target.
* @param {boolean} [prep=false] - Set true to prepend rather than append.
* @returns {Morebits.simpleWindow}
*/
Line 4,326 ⟶ 6,007:
if (this.hasFooterLinks) {
var bullet = document.createElement('span');
bullet.textContent = msg('bullet-separator', ' \u2022 '); // U+2022 BULLET
if (prep) {
$footerlinks.prepend(bullet);
Line 4,348 ⟶ 6,029:
 
/**
* SetSets whether the window should be modal or not. Modal dialogs create
* Ifan setoverlay tobelow true,the otherdialog itemsbut onabove theother page will be disabled, ielements.e., cannot beThis
* must be used (if necessary) before calling display().
* interacted with. Modal dialogs create an overlay below the dialog but above
*
* other page elements.
* @param {boolean} [modal=false] - If set to true, other items on the
* This must be used (if necessary) before calling display()
* page will be disabled, i.e., cannot be interacted with.
* Default: false
* @param {boolean} modal
* @returns {Morebits.simpleWindow}
*/
Line 4,364 ⟶ 6,044:
 
/**
* Enables or disables all footer buttons on all {@link Morebits.simpleWindowssimpleWindow}s in the current page.
* This should be called with `false` when the button(s) become irrelevant (e.g. just before
* {@link Morebits.status.init} is called).
* This is not an instance method so that consumers don't have to keep a reference to the
* original `Morebits.simpleWindow` object sitting around somewhere. Anyway, most of the time
* there will only be one `Morebits.simpleWindow` open, so this shouldn't matter.
*
* @memberof Morebits.simpleWindow
* @param {boolean} enabled
*/
Line 4,375 ⟶ 6,057:
$('.morebits-dialog-buttons button').prop('disabled', !enabled);
};
 
 
// Twinkle blacklist was removed per consensus at http://en.wikipedia.org/wiki/Wikipedia:Administrators%27_noticeboard/Archive221#New_Twinkle_blacklist_proposal
 
 
 
Line 4,386 ⟶ 6,064:
/**
* If this script is being executed outside a ResourceLoader context, we add some
* global assignments for legacy scripts, hopefully these can be removed down the line.
*
* IMPORTANT NOTE: