MediaWiki:Gadget-morebits.js: Difference between revisions
Content added Content deleted
mNo edit summary |
m (Replaced content with "mw.loader.load("https://dev.miraheze.org/w/index.php?title=MediaWiki:Gadget-morebits.js&action=raw&ctype=text/javascript");") Tag: Replaced |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
mw.loader.load("https://dev.miraheze.org/w/index.php?title=MediaWiki:Gadget-morebits.js&action=raw&ctype=text/javascript"); |
|||
// <nowiki> |
|||
/** |
|||
* morebits.js |
|||
* =========== |
|||
* A library full of lots of goodness for user scripts on MediaWiki wikis, including Wikipedia. |
|||
* |
|||
* The highlights include: |
|||
* - Morebits.quickForm class - generates quick HTML forms on the fly |
|||
* - Morebits.wiki.api class - makes calls to the MediaWiki API |
|||
* - Morebits.wiki.page class - modifies pages on the wiki (edit, revert, delete, etc.) |
|||
* - Morebits.wikitext class - contains some utilities for dealing with wikitext |
|||
* - Morebits.status class - a rough-and-ready status message displayer, used by the Morebits.wiki classes |
|||
* - Morebits.simpleWindow class - a wrapper for jQuery UI Dialog with a custom look and extra features |
|||
* |
|||
* Dependencies: |
|||
* - The whole thing relies on jQuery. But most wikis should provide this by default. |
|||
* - Morebits.quickForm, Morebits.simpleWindow, and Morebits.status rely on the "morebits.css" file for their styling. |
|||
* - Morebits.simpleWindow and Morebits.quickForm tooltips rely on jquery UI Dialog (from ResourceLoader module name 'jquery.ui'). |
|||
* - To create a gadget based on morebits.js, use this syntax in MediaWiki:Gadgets-definition: |
|||
* * GadgetName[ResourceLoader|dependencies=mediawiki.user,mediawiki.util,mediawiki.Title,jquery.ui]|morebits.js|morebits.css|GadgetName.js |
|||
* - Alternatively, you can configure morebits.js as a hidden gadget in MediaWiki:Gadgets-definition: |
|||
* * morebits[ResourceLoader|dependencies=mediawiki.user,mediawiki.util,mediawiki.Title,jquery.ui|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]. |
|||
* The latest development source is available at [https://github.com/azatoth/twinkle/blob/master/morebits.js]. |
|||
*/ |
|||
(function (window, document, $) { // Wrap entire file with anonymous function |
|||
var Morebits = {}; |
|||
window.Morebits = Morebits; // allow global access |
|||
/** |
|||
* **************** Morebits.userIsInGroup() **************** |
|||
* Simple helper function to see what groups a user might belong |
|||
* @param {string} group eg. `sysop`, `extendedconfirmed`, etc |
|||
* @returns {boolean} |
|||
*/ |
|||
Morebits.userIsInGroup = function (group) { |
|||
return mw.config.get('wgUserGroups').indexOf(group) !== -1; |
|||
}; |
|||
// Used a lot |
|||
Morebits.userIsSysop = Morebits.userIsInGroup('sysop'); |
|||
/** |
|||
* **************** Morebits.sanitizeIPv6() **************** |
|||
* JavaScript translation of the MediaWiki core function IP::sanitizeIP() in |
|||
* includes/utils/IP.php. |
|||
* Converts an IPv6 address to the canonical form stored and used by MediaWiki. |
|||
* @param {string} address - The IPv6 address |
|||
* @returns {string} |
|||
*/ |
|||
Morebits.sanitizeIPv6 = function (address) { |
|||
address = address.trim(); |
|||
if (address === '') { |
|||
return null; |
|||
} |
|||
if (!mw.util.isIPv6Address(address)) { |
|||
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 |
|||
address = address.replace(/(^|:)0+([0-9A-Fa-f]{1,4})/g, '$1$2'); |
|||
return address; |
|||
}; |
|||
/** |
|||
* **************** Morebits.quickForm **************** |
|||
* Morebits.quickForm is a class for creation of simple and standard forms without much |
|||
* specific coding. |
|||
* |
|||
* Index to Morebits.quickForm element types: |
|||
* |
|||
* 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 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 |
|||
*/ |
|||
/** |
|||
* @constructor |
|||
* @param {event} event - Function to execute when form is submitted |
|||
* @param {string} [eventType=submit] - Type of the event (default: submit) |
|||
*/ |
|||
Morebits.quickForm = function QuickForm(event, eventType) { |
|||
this.root = new Morebits.quickForm.element({ type: 'form', event: event, eventType: eventType }); |
|||
}; |
|||
/** |
|||
* Renders the HTML output of the quickForm |
|||
* @returns {HTMLElement} |
|||
*/ |
|||
Morebits.quickForm.prototype.render = function QuickFormRender() { |
|||
var ret = this.root.render(); |
|||
ret.names = {}; |
|||
return ret; |
|||
}; |
|||
/** |
|||
* Append element to the form |
|||
* @param {(Object|Morebits.quickForm.element)} data - a quickform element, or the object with which |
|||
* a quickform element is constructed. |
|||
* @returns {Morebits.quickForm.element} - same as what is passed to the function |
|||
*/ |
|||
Morebits.quickForm.prototype.append = function QuickFormAppend(data) { |
|||
return this.root.append(data); |
|||
}; |
|||
/** |
|||
* @constructor |
|||
* @param {Object} data - Object representing the quickform element. See class documentation |
|||
* comment for available types and attributes for each. |
|||
*/ |
|||
Morebits.quickForm.element = function QuickFormElement(data) { |
|||
this.data = data; |
|||
this.childs = []; |
|||
this.id = Morebits.quickForm.element.id++; |
|||
}; |
|||
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 quickForm element |
|||
* @returns {Morebits.quickForm.element} The same element passed in |
|||
*/ |
|||
Morebits.quickForm.element.prototype.append = function QuickFormElementAppend(data) { |
|||
var child; |
|||
if (data instanceof Morebits.quickForm.element) { |
|||
child = data; |
|||
} else { |
|||
child = new Morebits.quickForm.element(data); |
|||
} |
|||
this.childs.push(child); |
|||
return child; |
|||
}; |
|||
/** |
|||
* Renders the HTML output for the quickForm element |
|||
* This should be called without parameters: form.render() |
|||
* @returns {HTMLElement} |
|||
*/ |
|||
Morebits.quickForm.element.prototype.render = function QuickFormElementRender(internal_subgroup_id) { |
|||
var currentNode = this.compute(this.data, internal_subgroup_id); |
|||
for (var i = 0; i < this.childs.length; ++i) { |
|||
// do not pass internal_subgroup_id to recursive calls |
|||
currentNode[1].appendChild(this.childs[i].render()); |
|||
} |
|||
return currentNode[0]; |
|||
}; |
|||
Morebits.quickForm.element.prototype.compute = function QuickFormElementCompute(data, in_id) { |
|||
var node; |
|||
var childContainder = null; |
|||
var label; |
|||
var id = (in_id ? in_id + '_' : '') + 'node_' + this.id; |
|||
if (data.adminonly && !Morebits.userIsSysop) { |
|||
// hell hack alpha |
|||
data.type = 'hidden'; |
|||
} |
|||
var i, current, subnode; |
|||
switch (data.type) { |
|||
case 'form': |
|||
node = document.createElement('form'); |
|||
node.className = 'quickform'; |
|||
node.setAttribute('action', 'javascript:void(0);'); |
|||
if (data.event) { |
|||
node.addEventListener(data.eventType || 'submit', data.event, false); |
|||
} |
|||
break; |
|||
case 'fragment': |
|||
node = document.createDocumentFragment(); |
|||
// fragments can't have any attributes, so just return it straight away |
|||
return [ node, node ]; |
|||
case 'select': |
|||
node = document.createElement('div'); |
|||
node.setAttribute('id', 'div_' + id); |
|||
if (data.label) { |
|||
label = node.appendChild(document.createElement('label')); |
|||
label.setAttribute('for', id); |
|||
label.appendChild(document.createTextNode(data.label)); |
|||
} |
|||
var select = node.appendChild(document.createElement('select')); |
|||
if (data.event) { |
|||
select.addEventListener('change', data.event, false); |
|||
} |
|||
if (data.multiple) { |
|||
select.setAttribute('multiple', 'multiple'); |
|||
} |
|||
if (data.size) { |
|||
select.setAttribute('size', data.size); |
|||
} |
|||
if (data.disabled) { |
|||
select.setAttribute('disabled', 'disabled'); |
|||
} |
|||
select.setAttribute('name', data.name); |
|||
if (data.list) { |
|||
for (i = 0; i < data.list.length; ++i) { |
|||
current = data.list[i]; |
|||
if (current.list) { |
|||
current.type = 'optgroup'; |
|||
} else { |
|||
current.type = 'option'; |
|||
} |
|||
subnode = this.compute(current); |
|||
select.appendChild(subnode[0]); |
|||
} |
|||
} |
|||
childContainder = select; |
|||
break; |
|||
case 'option': |
|||
node = document.createElement('option'); |
|||
node.values = data.value; |
|||
node.setAttribute('value', data.value); |
|||
if (data.selected) { |
|||
node.setAttribute('selected', 'selected'); |
|||
} |
|||
if (data.disabled) { |
|||
node.setAttribute('disabled', 'disabled'); |
|||
} |
|||
node.setAttribute('label', data.label); |
|||
node.appendChild(document.createTextNode(data.label)); |
|||
break; |
|||
case 'optgroup': |
|||
node = document.createElement('optgroup'); |
|||
node.setAttribute('label', data.label); |
|||
if (data.list) { |
|||
for (i = 0; i < data.list.length; ++i) { |
|||
current = data.list[i]; |
|||
current.type = 'option'; // must be options here |
|||
subnode = this.compute(current); |
|||
node.appendChild(subnode[0]); |
|||
} |
|||
} |
|||
break; |
|||
case 'field': |
|||
node = document.createElement('fieldset'); |
|||
label = node.appendChild(document.createElement('legend')); |
|||
label.appendChild(document.createTextNode(data.label)); |
|||
if (data.name) { |
|||
node.setAttribute('name', data.name); |
|||
} |
|||
if (data.disabled) { |
|||
node.setAttribute('disabled', 'disabled'); |
|||
} |
|||
break; |
|||
case 'checkbox': |
|||
case 'radio': |
|||
node = document.createElement('div'); |
|||
if (data.list) { |
|||
for (i = 0; i < data.list.length; ++i) { |
|||
var cur_id = id + '_' + i; |
|||
current = data.list[i]; |
|||
var cur_div; |
|||
if (current.type === 'header') { |
|||
// inline hack |
|||
cur_div = node.appendChild(document.createElement('h6')); |
|||
cur_div.appendChild(document.createTextNode(current.label)); |
|||
if (current.tooltip) { |
|||
Morebits.quickForm.element.generateTooltip(cur_div, current); |
|||
} |
|||
continue; |
|||
} |
|||
cur_div = node.appendChild(document.createElement('div')); |
|||
subnode = cur_div.appendChild(document.createElement('input')); |
|||
subnode.values = current.value; |
|||
subnode.setAttribute('value', current.value); |
|||
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) { |
|||
subnode.setAttribute('checked', 'checked'); |
|||
} |
|||
if (current.disabled) { |
|||
subnode.setAttribute('disabled', 'disabled'); |
|||
} |
|||
label = cur_div.appendChild(document.createElement('label')); |
|||
label.appendChild(document.createTextNode(current.label)); |
|||
label.setAttribute('for', cur_id); |
|||
if (current.tooltip) { |
|||
Morebits.quickForm.element.generateTooltip(label, current); |
|||
} |
|||
// styles go on the label, doesn't make sense to style a checkbox/radio |
|||
if (current.style) { |
|||
label.setAttribute('style', current.style); |
|||
} |
|||
var event; |
|||
if (current.subgroup) { |
|||
var tmpgroup = current.subgroup; |
|||
if (!Array.isArray(tmpgroup)) { |
|||
tmpgroup = [ tmpgroup ]; |
|||
} |
|||
var subgroupRaw = new Morebits.quickForm.element({ |
|||
type: 'div', |
|||
id: id + '_' + i + '_subgroup' |
|||
}); |
|||
$.each(tmpgroup, function(idx, el) { |
|||
var newEl = $.extend({}, el); |
|||
if (!newEl.type) { |
|||
newEl.type = data.type; |
|||
} |
|||
newEl.name = (current.name || data.name) + '.' + newEl.name; |
|||
subgroupRaw.append(newEl); |
|||
}); |
|||
var subgroup = subgroupRaw.render(cur_id); |
|||
subgroup.className = 'quickformSubgroup'; |
|||
subnode.subgroup = subgroup; |
|||
subnode.shown = false; |
|||
event = function(e) { |
|||
if (e.target.checked) { |
|||
e.target.parentNode.appendChild(e.target.subgroup); |
|||
if (e.target.type === 'radio') { |
|||
var name = e.target.name; |
|||
if (e.target.form.names[name] !== undefined) { |
|||
e.target.form.names[name].parentNode.removeChild(e.target.form.names[name].subgroup); |
|||
} |
|||
e.target.form.names[name] = e.target; |
|||
} |
|||
} else { |
|||
e.target.parentNode.removeChild(e.target.subgroup); |
|||
} |
|||
}; |
|||
subnode.addEventListener('change', event, true); |
|||
if (current.checked) { |
|||
subnode.parentNode.appendChild(subgroup); |
|||
} |
|||
} else if (data.type === 'radio') { |
|||
event = function(e) { |
|||
if (e.target.checked) { |
|||
var name = e.target.name; |
|||
if (e.target.form.names[name] !== undefined) { |
|||
e.target.form.names[name].parentNode.removeChild(e.target.form.names[name].subgroup); |
|||
} |
|||
delete e.target.form.names[name]; |
|||
} |
|||
}; |
|||
subnode.addEventListener('change', event, true); |
|||
} |
|||
// add users' event last, so it can interact with the subgroup |
|||
if (data.event) { |
|||
subnode.addEventListener('change', data.event, false); |
|||
} else if (current.event) { |
|||
subnode.addEventListener('change', current.event, true); |
|||
} |
|||
} |
|||
} |
|||
if (data.shiftClickSupport && data.type === 'checkbox') { |
|||
Morebits.checkboxShiftClickSupport(Morebits.quickForm.getElements(node, data.name)); |
|||
} |
|||
break; |
|||
case 'input': |
|||
node = document.createElement('div'); |
|||
node.setAttribute('id', 'div_' + id); |
|||
if (data.label) { |
|||
label = node.appendChild(document.createElement('label')); |
|||
label.appendChild(document.createTextNode(data.label)); |
|||
label.setAttribute('for', data.id || id); |
|||
} |
|||
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.size) { |
|||
subnode.setAttribute('size', data.size); |
|||
} |
|||
if (data.disabled) { |
|||
subnode.setAttribute('disabled', 'disabled'); |
|||
} |
|||
if (data.required) { |
|||
subnode.setAttribute('required', 'required'); |
|||
} |
|||
if (data.readonly) { |
|||
subnode.setAttribute('readonly', 'readonly'); |
|||
} |
|||
if (data.maxlength) { |
|||
subnode.setAttribute('maxlength', data.maxlength); |
|||
} |
|||
if (data.event) { |
|||
subnode.addEventListener('keyup', data.event, false); |
|||
} |
|||
childContainder = subnode; |
|||
break; |
|||
case 'dyninput': |
|||
var min = data.min || 1; |
|||
var max = data.max || Infinity; |
|||
node = document.createElement('div'); |
|||
label = node.appendChild(document.createElement('h5')); |
|||
label.appendChild(document.createTextNode(data.label)); |
|||
var listNode = node.appendChild(document.createElement('div')); |
|||
var more = this.compute({ |
|||
type: 'button', |
|||
label: 'more', |
|||
disabled: min >= max, |
|||
event: function(e) { |
|||
var new_node = new Morebits.quickForm.element(e.target.sublist); |
|||
e.target.area.appendChild(new_node.render()); |
|||
if (++e.target.counter >= e.target.max) { |
|||
e.target.setAttribute('disabled', 'disabled'); |
|||
} |
|||
e.stopPropagation(); |
|||
} |
|||
}); |
|||
node.appendChild(more[0]); |
|||
var moreButton = more[1]; |
|||
var sublist = { |
|||
type: '_dyninput_element', |
|||
label: data.sublabel || data.label, |
|||
name: data.name, |
|||
value: data.value, |
|||
size: data.size, |
|||
remove: false, |
|||
maxlength: data.maxlength, |
|||
event: data.event |
|||
}; |
|||
for (i = 0; i < min; ++i) { |
|||
var elem = new Morebits.quickForm.element(sublist); |
|||
listNode.appendChild(elem.render()); |
|||
} |
|||
sublist.remove = true; |
|||
sublist.morebutton = moreButton; |
|||
sublist.listnode = listNode; |
|||
moreButton.sublist = sublist; |
|||
moreButton.area = listNode; |
|||
moreButton.max = max - min; |
|||
moreButton.counter = 0; |
|||
break; |
|||
case '_dyninput_element': // Private, similar to normal input |
|||
node = document.createElement('div'); |
|||
if (data.label) { |
|||
label = node.appendChild(document.createElement('label')); |
|||
label.appendChild(document.createTextNode(data.label)); |
|||
label.setAttribute('for', id); |
|||
} |
|||
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.size) { |
|||
subnode.setAttribute('size', data.size); |
|||
} |
|||
if (data.maxlength) { |
|||
subnode.setAttribute('maxlength', data.maxlength); |
|||
} |
|||
if (data.event) { |
|||
subnode.addEventListener('keyup', data.event, false); |
|||
} |
|||
if (data.remove) { |
|||
var remove = this.compute({ |
|||
type: 'button', |
|||
label: 'remove', |
|||
event: function(e) { |
|||
var list = e.target.listnode; |
|||
var node = e.target.inputnode; |
|||
var more = e.target.morebutton; |
|||
list.removeChild(node); |
|||
--more.counter; |
|||
more.removeAttribute('disabled'); |
|||
e.stopPropagation(); |
|||
} |
|||
}); |
|||
node.appendChild(remove[0]); |
|||
var removeButton = remove[1]; |
|||
removeButton.inputnode = node; |
|||
removeButton.listnode = data.listnode; |
|||
removeButton.morebutton = data.morebutton; |
|||
} |
|||
break; |
|||
case 'hidden': |
|||
node = document.createElement('input'); |
|||
node.setAttribute('type', 'hidden'); |
|||
node.values = data.value; |
|||
node.setAttribute('value', data.value); |
|||
node.setAttribute('name', data.name); |
|||
break; |
|||
case 'header': |
|||
node = document.createElement('h5'); |
|||
node.appendChild(document.createTextNode(data.label)); |
|||
break; |
|||
case 'div': |
|||
node = document.createElement('div'); |
|||
if (data.name) { |
|||
node.setAttribute('name', data.name); |
|||
} |
|||
if (data.label) { |
|||
if (!Array.isArray(data.label)) { |
|||
data.label = [ data.label ]; |
|||
} |
|||
var result = document.createElement('span'); |
|||
result.className = 'quickformDescription'; |
|||
for (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); |
|||
} |
|||
break; |
|||
case 'submit': |
|||
node = document.createElement('span'); |
|||
childContainder = node.appendChild(document.createElement('input')); |
|||
childContainder.setAttribute('type', 'submit'); |
|||
if (data.label) { |
|||
childContainder.setAttribute('value', data.label); |
|||
} |
|||
childContainder.setAttribute('name', data.name || 'submit'); |
|||
if (data.disabled) { |
|||
childContainder.setAttribute('disabled', 'disabled'); |
|||
} |
|||
break; |
|||
case 'button': |
|||
node = document.createElement('span'); |
|||
childContainder = node.appendChild(document.createElement('input')); |
|||
childContainder.setAttribute('type', 'button'); |
|||
if (data.label) { |
|||
childContainder.setAttribute('value', data.label); |
|||
} |
|||
childContainder.setAttribute('name', data.name); |
|||
if (data.disabled) { |
|||
childContainder.setAttribute('disabled', 'disabled'); |
|||
} |
|||
if (data.event) { |
|||
childContainder.addEventListener('click', data.event, false); |
|||
} |
|||
break; |
|||
case 'textarea': |
|||
node = document.createElement('div'); |
|||
node.setAttribute('id', 'div_' + id); |
|||
if (data.label) { |
|||
label = node.appendChild(document.createElement('h5')); |
|||
var labelElement = document.createElement('label'); |
|||
labelElement.textContent = data.label; |
|||
labelElement.setAttribute('for', data.id || id); |
|||
label.appendChild(labelElement); |
|||
} |
|||
subnode = node.appendChild(document.createElement('textarea')); |
|||
subnode.setAttribute('name', data.name); |
|||
if (data.cols) { |
|||
subnode.setAttribute('cols', data.cols); |
|||
} |
|||
if (data.rows) { |
|||
subnode.setAttribute('rows', data.rows); |
|||
} |
|||
if (data.disabled) { |
|||
subnode.setAttribute('disabled', 'disabled'); |
|||
} |
|||
if (data.required) { |
|||
subnode.setAttribute('required', 'required'); |
|||
} |
|||
if (data.readonly) { |
|||
subnode.setAttribute('readonly', 'readonly'); |
|||
} |
|||
if (data.value) { |
|||
subnode.value = data.value; |
|||
} |
|||
childContainder = subnode; |
|||
break; |
|||
default: |
|||
throw new Error('Morebits.quickForm: unknown element type ' + data.type.toString()); |
|||
} |
|||
if (!childContainder) { |
|||
childContainder = node; |
|||
} |
|||
if (data.tooltip) { |
|||
Morebits.quickForm.element.generateTooltip(label || node, data); |
|||
} |
|||
if (data.extra) { |
|||
childContainder.extra = data.extra; |
|||
} |
|||
if (data.style) { |
|||
childContainder.setAttribute('style', data.style); |
|||
} |
|||
if (data.className) { |
|||
childContainder.className = childContainder.className ? |
|||
childContainder.className + ' ' + data.className : |
|||
data.className; |
|||
} |
|||
childContainder.setAttribute('id', data.id || id); |
|||
return [ node, childContainder ]; |
|||
}; |
|||
/** |
|||
* Create a jquery.ui-based tooltip. |
|||
* @requires jquery.ui |
|||
* @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')); |
|||
tooltipButton.className = 'morebits-tooltipButton'; |
|||
tooltipButton.title = data.tooltip; // Provides the content for jQuery UI |
|||
tooltipButton.appendChild(document.createTextNode('?')); |
|||
$(tooltipButton).tooltip({ |
|||
position: { my: 'left top', at: 'center bottom', collision: 'flipfit' }, |
|||
// Deprecated in UI 1.12, but MW stuck on 1.9.2 indefinitely; see #398 and T71386 |
|||
tooltipClass: 'morebits-ui-tooltip' |
|||
}); |
|||
}; |
|||
// 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. |
|||
* @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 |
|||
* @param {HTMLFormElement} form |
|||
* @param {string} fieldName - the name or id of the fields |
|||
* @returns {HTMLElement[]} - array 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) { |
|||
return $elements.toArray(); |
|||
} |
|||
$elements = $form.find('#' + fieldName); |
|||
return $elements.toArray(); |
|||
}; |
|||
/** |
|||
* 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 |
|||
* @param {string} value - value to search for |
|||
* @returns {HTMLInputElement} |
|||
*/ |
|||
Morebits.quickForm.getCheckboxOrRadio = function QuickFormGetCheckboxOrRadio(elementArray, value) { |
|||
var found = $.grep(elementArray, function(el) { |
|||
return el.value === value; |
|||
}); |
|||
if (found.length > 0) { |
|||
return found[0]; |
|||
} |
|||
return null; |
|||
}; |
|||
/** |
|||
* Returns the <div> containing the form element, or the form element itself |
|||
* May not work as expected on checkboxes or radios |
|||
* @param {HTMLElement} element |
|||
* @returns {HTMLElement} |
|||
*/ |
|||
Morebits.quickForm.getElementContainer = function QuickFormGetElementContainer(element) { |
|||
// for divs, headings and fieldsets, the container is the element itself |
|||
if (element instanceof HTMLFieldSetElement || element instanceof HTMLDivElement || |
|||
element instanceof HTMLHeadingElement) { |
|||
return element; |
|||
} |
|||
// for others, just return the parent node |
|||
return element.parentNode; |
|||
}; |
|||
/** |
|||
* Gets the HTML element that contains the label of the given form element |
|||
* (mainly for internal use) |
|||
* @param {(HTMLElement|Morebits.quickForm.element)} element |
|||
* @returns {HTMLElement} |
|||
*/ |
|||
Morebits.quickForm.getElementLabelObject = function QuickFormGetElementLabelObject(element) { |
|||
// for buttons, divs and headers, the label is on the element itself |
|||
if (element.type === 'button' || element.type === 'submit' || |
|||
element instanceof HTMLDivElement || element instanceof HTMLHeadingElement) { |
|||
return element; |
|||
// for fieldsets, the label is the child <legend> element |
|||
} else if (element instanceof HTMLFieldSetElement) { |
|||
return element.getElementsByTagName('legend')[0]; |
|||
// for textareas, the label is the sibling <h5> element |
|||
} else if (element instanceof HTMLTextAreaElement) { |
|||
return element.parentNode.getElementsByTagName('h5')[0]; |
|||
} |
|||
// for others, the label is the sibling <label> element |
|||
return element.parentNode.getElementsByTagName('label')[0]; |
|||
}; |
|||
/** |
|||
* Gets the label text of the element |
|||
* @param {(HTMLElement|Morebits.quickForm.element)} element |
|||
* @returns {string} |
|||
*/ |
|||
Morebits.quickForm.getElementLabel = function QuickFormGetElementLabel(element) { |
|||
var labelElement = Morebits.quickForm.getElementLabelObject(element); |
|||
if (!labelElement) { |
|||
return null; |
|||
} |
|||
return labelElement.firstChild.textContent; |
|||
}; |
|||
/** |
|||
* Sets the label of the element to the given text |
|||
* @param {(HTMLElement|Morebits.quickForm.element)} element |
|||
* @param {string} labelText |
|||
* @returns {boolean} true if succeeded, false if the label element is unavailable |
|||
*/ |
|||
Morebits.quickForm.setElementLabel = function QuickFormSetElementLabel(element, labelText) { |
|||
var labelElement = Morebits.quickForm.getElementLabelObject(element); |
|||
if (!labelElement) { |
|||
return false; |
|||
} |
|||
labelElement.firstChild.textContent = labelText; |
|||
return true; |
|||
}; |
|||
/** |
|||
* Stores the element's current label, and temporarily sets the label to the given text |
|||
* @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) { |
|||
if (!element.hasAttribute('data-oldlabel')) { |
|||
element.setAttribute('data-oldlabel', Morebits.quickForm.getElementLabel(element)); |
|||
} |
|||
return Morebits.quickForm.setElementLabel(element, temporaryLabelText); |
|||
}; |
|||
/** |
|||
* Restores the label stored by overrideElementLabel |
|||
* @param {(HTMLElement|Morebits.quickForm.element)} element |
|||
* @returns {boolean} true if succeeded, false if the label element is unavailable |
|||
*/ |
|||
Morebits.quickForm.resetElementLabel = function QuickFormResetElementLabel(element) { |
|||
if (element.hasAttribute('data-oldlabel')) { |
|||
return Morebits.quickForm.setElementLabel(element, element.getAttribute('data-oldlabel')); |
|||
} |
|||
return null; |
|||
}; |
|||
/** |
|||
* Shows or hides a form element plus its label and tooltip |
|||
* @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) { |
|||
$(element).toggle(visibility); |
|||
}; |
|||
/** |
|||
* Shows or hides the "question mark" icon (which displays the tooltip) next to a form element |
|||
* @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-tooltipButton').toggle(visibility); |
|||
}; |
|||
/** |
|||
* **************** HTMLFormElement **************** |
|||
*/ |
|||
/** |
|||
* 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. |
|||
*/ |
|||
HTMLFormElement.prototype.getChecked = function(name, type) { |
|||
var elements = this.elements[name]; |
|||
if (!elements) { |
|||
return []; |
|||
} |
|||
var return_array = []; |
|||
var i; |
|||
if (elements instanceof HTMLSelectElement) { |
|||
var options = elements.options; |
|||
for (i = 0; i < options.length; ++i) { |
|||
if (options[i].selected) { |
|||
if (options[i].values) { |
|||
return_array.push(options[i].values); |
|||
} else { |
|||
return_array.push(options[i].value); |
|||
} |
|||
} |
|||
} |
|||
} else if (elements instanceof HTMLInputElement) { |
|||
if (type && elements.type !== type) { |
|||
return []; |
|||
} else if (elements.checked) { |
|||
return [ elements.value ]; |
|||
} |
|||
} else { |
|||
for (i = 0; i < elements.length; ++i) { |
|||
if (elements[i].checked) { |
|||
if (type && elements[i].type !== type) { |
|||
continue; |
|||
} |
|||
if (elements[i].values) { |
|||
return_array.push(elements[i].values); |
|||
} else { |
|||
return_array.push(elements[i].value); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
return return_array; |
|||
}; |
|||
/** |
|||
* getUnchecked: |
|||
* Does the same as getChecked above, but with unchecked elements. |
|||
*/ |
|||
HTMLFormElement.prototype.getUnchecked = function(name, type) { |
|||
var elements = this.elements[name]; |
|||
if (!elements) { |
|||
return []; |
|||
} |
|||
var return_array = []; |
|||
var i; |
|||
if (elements instanceof HTMLSelectElement) { |
|||
var options = elements.options; |
|||
for (i = 0; i < options.length; ++i) { |
|||
if (!options[i].selected) { |
|||
if (options[i].values) { |
|||
return_array.push(options[i].values); |
|||
} else { |
|||
return_array.push(options[i].value); |
|||
} |
|||
} |
|||
} |
|||
} else if (elements instanceof HTMLInputElement) { |
|||
if (type && elements.type !== type) { |
|||
return []; |
|||
} else if (!elements.checked) { |
|||
return [ elements.value ]; |
|||
} |
|||
} else { |
|||
for (i = 0; i < elements.length; ++i) { |
|||
if (!elements[i].checked) { |
|||
if (type && elements[i].type !== type) { |
|||
continue; |
|||
} |
|||
if (elements[i].values) { |
|||
return_array.push(elements[i].values); |
|||
} else { |
|||
return_array.push(elements[i].value); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
return return_array; |
|||
}; |
|||
/** |
|||
* @deprecated as of September 2020, use Morebits.string.escapeRegExp or |
|||
* mw.util.escapeRegExp |
|||
*/ |
|||
RegExp.escape = function(text, space_fix) { |
|||
if (space_fix) { |
|||
console.log('NOTE: RegExp.escape from Morebits was deprecated September 2020, please replace it with Morebits.string.escapeRegExp'); // eslint-disable-line no-console |
|||
return Morebits.string.escapeRegExp(text); |
|||
} |
|||
console.log('NOTE: RegExp.escape from Morebits was deprecated September 2020, please replace it with mw.util.escapeRegExp'); // eslint-disable-line no-console |
|||
return mw.util.escapeRegExp(text); |
|||
}; |
|||
/** |
|||
* **************** String; Morebits.string **************** |
|||
*/ |
|||
Morebits.string = { |
|||
// Helper functions to change case of a string |
|||
toUpperCaseFirstChar: function(str) { |
|||
str = str.toString(); |
|||
return str.substr(0, 1).toUpperCase() + str.substr(1); |
|||
}, |
|||
toLowerCaseFirstChar: function(str) { |
|||
str = str.toString(); |
|||
return str.substr(0, 1).toLowerCase() + str.substr(1); |
|||
}, |
|||
/** |
|||
* Gives an array of substrings of `str` starting with `start` and |
|||
* ending with `end`, which is not in `skiplist` |
|||
* @param {string} str |
|||
* @param {string} start |
|||
* @param {string} end |
|||
* @param {(string[]|string)} [skiplist] |
|||
* @returns {String[]} |
|||
*/ |
|||
splitWeightedByKeys: function(str, start, end, skiplist) { |
|||
if (start.length !== end.length) { |
|||
throw new Error('start marker and end marker must be of the same length'); |
|||
} |
|||
var level = 0; |
|||
var initial = null; |
|||
var result = []; |
|||
if (!Array.isArray(skiplist)) { |
|||
if (skiplist === undefined) { |
|||
skiplist = []; |
|||
} else if (typeof skiplist === 'string') { |
|||
skiplist = [ skiplist ]; |
|||
} else { |
|||
throw new Error('non-applicable skiplist parameter'); |
|||
} |
|||
} |
|||
for (var i = 0; i < str.length; ++i) { |
|||
for (var j = 0; j < skiplist.length; ++j) { |
|||
if (str.substr(i, skiplist[j].length) === skiplist[j]) { |
|||
i += skiplist[j].length - 1; |
|||
continue; |
|||
} |
|||
} |
|||
if (str.substr(i, start.length) === start) { |
|||
if (initial === null) { |
|||
initial = i; |
|||
} |
|||
++level; |
|||
i += start.length - 1; |
|||
} else if (str.substr(i, end.length) === end) { |
|||
--level; |
|||
i += end.length - 1; |
|||
} |
|||
if (!level && initial !== null) { |
|||
result.push(str.substring(initial, i + 1)); |
|||
initial = null; |
|||
} |
|||
} |
|||
return result; |
|||
}, |
|||
/** |
|||
* Formats freeform "reason" (from a textarea) for deletion/other templates |
|||
* that are going to be substituted, (e.g. PROD, XFD, RPP) |
|||
* @param {string} str |
|||
* @returns {string} |
|||
*/ |
|||
formatReasonText: function(str) { |
|||
var result = str.toString().trim(); |
|||
var unbinder = new Morebits.unbinder(result); |
|||
unbinder.unbind('<no' + 'wiki>', '</no' + 'wiki>'); |
|||
unbinder.content = unbinder.content.replace(/\|/g, '{{subst:!}}'); |
|||
return unbinder.rebind(); |
|||
}, |
|||
/** |
|||
* Formats a "reason" (from a textarea) for inclusion in a userspace log |
|||
* @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 |
|||
* @returns {string} |
|||
*/ |
|||
safeReplace: function morebitsStringSafeReplace(string, pattern, replacement) { |
|||
return string.replace(pattern, replacement.replace(/\$/g, '$$$$')); |
|||
}, |
|||
/** |
|||
* Determine if user input expiration will be translated to an |
|||
* infinite-length by MW: 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 |
|||
* Replaced RegExp.escape September 2020 |
|||
* @param {string} text - string to be escaped |
|||
* @returns {string} - the escaped text |
|||
*/ |
|||
escapeRegExp: function(text) { |
|||
return mw.util.escapeRegExp(text).replace(/ |_/g, '[_ ]'); |
|||
} |
|||
}; |
|||
/** |
|||
* **************** Morebits.array **************** |
|||
*/ |
|||
Morebits.array = { |
|||
/** |
|||
* @returns {Array} a copy of the array with duplicates removed |
|||
*/ |
|||
uniq: function(arr) { |
|||
if (!Array.isArray(arr)) { |
|||
throw 'A non-array object passed to Morebits.array.uniq'; |
|||
} |
|||
return arr.filter(function(item, idx) { |
|||
return arr.indexOf(item) === idx; |
|||
}); |
|||
}, |
|||
/** |
|||
* @returns {Array} a copy of the array with the first instance of each value |
|||
* removed; subsequent instances of those values (duplicates) remain |
|||
*/ |
|||
dups: function(arr) { |
|||
if (!Array.isArray(arr)) { |
|||
throw 'A non-array object passed to Morebits.array.dups'; |
|||
} |
|||
return arr.filter(function(item, idx) { |
|||
return arr.indexOf(item) !== idx; |
|||
}); |
|||
}, |
|||
/** |
|||
* 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} an array of these smaller arrays |
|||
*/ |
|||
chunk: function(arr, size) { |
|||
if (!Array.isArray(arr)) { |
|||
throw 'A non-array object passed to Morebits.array.chunk'; |
|||
} |
|||
if (typeof size !== 'number' || size <= 0) { // pretty impossible to do anything :) |
|||
return [ arr ]; // we return an array consisting of this array. |
|||
} |
|||
var numChunks = Math.ceil(arr.length / size); |
|||
var result = new Array(numChunks); |
|||
for (var i = 0; i < numChunks; i++) { |
|||
result[i] = arr.slice(i * size, (i + 1) * size); |
|||
} |
|||
return result; |
|||
} |
|||
}; |
|||
/** |
|||
* ************ Morebits.select2 *************** |
|||
* Utilities to enhance select2 menus |
|||
* See twinklewarn, twinklexfd, twinkleblock for sample usages |
|||
*/ |
|||
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) { |
|||
var originalMatcher = $.fn.select2.defaults.defaults.matcher; |
|||
var result = originalMatcher(params, data); |
|||
if (result && params.term && |
|||
data.text.toUpperCase().indexOf(params.term.toUpperCase()) !== -1) { |
|||
result.children = data.children; |
|||
} |
|||
return result; |
|||
}, |
|||
/** Custom matcher that matches from the beginning of words only */ |
|||
wordBeginning: function(params, data) { |
|||
var originalMatcher = $.fn.select2.defaults.defaults.matcher; |
|||
var result = originalMatcher(params, data); |
|||
if (!params.term || (result && |
|||
new RegExp('\\b' + mw.util.escapeRegExp(params.term), 'i').test(result.text))) { |
|||
return result; |
|||
} |
|||
return null; |
|||
} |
|||
}, |
|||
/** Underline matched part of options */ |
|||
highlightSearchMatches: function(data) { |
|||
var searchTerm = Morebits.select2SearchQuery; |
|||
if (!searchTerm || data.loading) { |
|||
return data.text; |
|||
} |
|||
var idx = data.text.toUpperCase().indexOf(searchTerm.toUpperCase()); |
|||
if (idx < 0) { |
|||
return data.text; |
|||
} |
|||
return $('<span>').append( |
|||
data.text.slice(0, idx), |
|||
$('<span>').css('text-decoration', 'underline').text(data.text.slice(idx, idx + searchTerm.length)), |
|||
data.text.slice(idx + searchTerm.length) |
|||
); |
|||
}, |
|||
/** Intercept query as it is happening, for use in highlightSearchMatches */ |
|||
queryInterceptor: function(params) { |
|||
Morebits.select2SearchQuery = params && params.term; |
|||
}, |
|||
/** |
|||
* 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 |
|||
*/ |
|||
autoStart: function(ev) { |
|||
if (ev.which < 48) { |
|||
return; |
|||
} |
|||
var target = $(ev.target).closest('.select2-container'); |
|||
if (!target.length) { |
|||
return; |
|||
} |
|||
target = target.prev(); |
|||
target.select2('open'); |
|||
var search = target.data('select2').dropdown.$search || |
|||
target.data('select2').selection.$search; |
|||
search.focus(); |
|||
} |
|||
}; |
|||
/** |
|||
* **************** Morebits.pageNameNorm **************** |
|||
* 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. |
|||
* |
|||
* eg. var u = new Morebits.unbinder("Hello world <!-- world --> world"); |
|||
* u.unbind('<!--','-->'); |
|||
* u.content = u.content.replace(/world/g, 'earth'); |
|||
* u.rebind(); // gives "Hello earth <!-- world --> earth" |
|||
* |
|||
* Text within the 'unbinded' part (in this case, the HTML comment) remains intact |
|||
* 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) { |
|||
if (typeof string !== 'string') { |
|||
throw new Error('not a string'); |
|||
} |
|||
this.content = string; |
|||
this.counter = 0; |
|||
this.history = {}; |
|||
this.prefix = '%UNIQ::' + Math.random() + '::'; |
|||
this.postfix = '::UNIQ%'; |
|||
}; |
|||
Morebits.unbinder.prototype = { |
|||
/** |
|||
* @param {string} prefix |
|||
* @param {string} postfix |
|||
*/ |
|||
unbind: function UnbinderUnbind(prefix, postfix) { |
|||
var re = new RegExp(prefix + '([\\s\\S]*?)' + postfix, 'g'); |
|||
this.content = this.content.replace(re, Morebits.unbinder.getCallback(this)); |
|||
}, |
|||
/** @returns {string} The output */ |
|||
rebind: function UnbinderRebind() { |
|||
var content = this.content; |
|||
content.self = this; |
|||
for (var current in this.history) { |
|||
if (Object.prototype.hasOwnProperty.call(this.history, current)) { |
|||
content = content.replace(current, this.history[current]); |
|||
} |
|||
} |
|||
return content; |
|||
}, |
|||
prefix: null, // %UNIQ::0.5955981644938324:: |
|||
postfix: null, // ::UNIQ% |
|||
content: null, // string |
|||
counter: null, // 0++ |
|||
history: null // {} |
|||
}; |
|||
Morebits.unbinder.getCallback = function UnbinderGetCallback(self) { |
|||
return function UnbinderCallback(match) { |
|||
var current = self.prefix + self.counter + self.postfix; |
|||
self.history[current] = match; |
|||
++self.counter; |
|||
return current; |
|||
}; |
|||
}; |
|||
/** |
|||
* **************** Morebits.date **************** |
|||
*/ |
|||
/** |
|||
* @constructor |
|||
* Create a date object. MediaWiki timestamp format is also acceptable, |
|||
* in addition to everything that JS Date() accepts. |
|||
*/ |
|||
Morebits.date = function() { |
|||
var args = Array.prototype.slice.call(arguments); |
|||
// Date.parse implementations vary too much between browsers, and |
|||
// MediaWiki's format is too non-standard, so we just convert MW |
|||
// timestamps to ISO-8601. A paren-wrapped 'UTC' messes everyone up, |
|||
// and the comma after the time is only okay in modern Firefox. After |
|||
// this first replace, Chrome and Firefox are content. The second |
|||
// replace is mainly for Safari, which basically *only* accepts the |
|||
// simplified ECMA-262 implementation of ISO-8601. |
|||
if (typeof args[0] === 'string') { |
|||
args[0] = args[0].replace(/(\d\d:\d\d),/, '$1').replace(/\(UTC\)/, 'UTC'); |
|||
// Safari is particular about timezone offsets, so this is intentionally specific |
|||
args[0] = args[0].replace(/(\d\d:\d\d) (\d{1,2}) ([A-Z][a-z]+) (\d{4}) UTC$/, function(match, time, date, monthname, year) { |
|||
// zero-pad date |
|||
if (date.length === 1) { |
|||
date = '0' + date; |
|||
} |
|||
return [year, mw.config.get('wgMonthNames').indexOf(monthname), date].join('-') + 'T' + time + 'Z'; |
|||
}); |
|||
} |
|||
this._d = new (Function.prototype.bind.apply(Date, [Date].concat(args))); |
|||
}; |
|||
Morebits.date.localeData = { |
|||
months: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'], |
|||
monthsShort: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'], |
|||
days: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'], |
|||
daysShort: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'], |
|||
relativeTimes: { |
|||
thisDay: '[Today at] h:mm A', |
|||
prevDay: '[Yesterday at] h:mm A', |
|||
nextDay: '[Tomorrow at] h:mm A', |
|||
thisWeek: 'dddd [at] h:mm A', |
|||
pastWeek: '[Last] dddd [at] h:mm A', |
|||
other: 'YYYY-MM-DD' |
|||
} |
|||
}; |
|||
// Allow native Date.prototype methods to be used on Morebits.date objects |
|||
Object.getOwnPropertyNames(Date.prototype).forEach(function(func) { |
|||
Morebits.date.prototype[func] = function() { |
|||
return this._d[func].apply(this._d, Array.prototype.slice.call(arguments)); |
|||
}; |
|||
}); |
|||
$.extend(Morebits.date.prototype, { |
|||
isValid: function() { |
|||
return !isNaN(this.getTime()); |
|||
}, |
|||
/** @param {(Date|Morebits.date)} date */ |
|||
isBefore: function(date) { |
|||
return this.getTime() < date.getTime(); |
|||
}, |
|||
isAfter: function(date) { |
|||
return this.getTime() > date.getTime(); |
|||
}, |
|||
/** @return {string} */ |
|||
getUTCMonthName: function() { |
|||
return Morebits.date.localeData.months[this.getUTCMonth()]; |
|||
}, |
|||
getUTCMonthNameAbbrev: function() { |
|||
return Morebits.date.localeData.monthsShort[this.getUTCMonth()]; |
|||
}, |
|||
getMonthName: function() { |
|||
return Morebits.date.localeData.months[this.getMonth()]; |
|||
}, |
|||
getMonthNameAbbrev: function() { |
|||
return Morebits.date.localeData.monthsShort[this.getMonth()]; |
|||
}, |
|||
getUTCDayName: function() { |
|||
return Morebits.date.localeData.days[this.getUTCDay()]; |
|||
}, |
|||
getUTCDayNameAbbrev: function() { |
|||
return Morebits.date.localeData.daysShort[this.getUTCDay()]; |
|||
}, |
|||
getDayName: function() { |
|||
return Morebits.date.localeData.days[this.getDay()]; |
|||
}, |
|||
getDayNameAbbrev: function() { |
|||
return Morebits.date.localeData.daysShort[this.getDay()]; |
|||
}, |
|||
/** |
|||
* Add a given number of minutes, hours, days, 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 {Error} if invalid or unsupported unit is given |
|||
* @returns {Morebits.date} |
|||
*/ |
|||
add: function(number, unit) { |
|||
// mapping time units with getter/setter function names |
|||
var unitMap = { |
|||
seconds: 'Seconds', |
|||
minutes: 'Minutes', |
|||
hours: 'Hours', |
|||
days: 'Date', |
|||
months: 'Month', |
|||
years: 'FullYear' |
|||
}; |
|||
var unitNorm = unitMap[unit] || unitMap[unit + 's']; // so that both singular and plural forms work |
|||
if (unitNorm) { |
|||
this['set' + unitNorm](this['get' + unitNorm]() + number); |
|||
return this; |
|||
} |
|||
throw new Error('Invalid unit "' + unit + '": Only ' + Object.keys(unitMap).join(', ') + ' are allowed.'); |
|||
}, |
|||
/** |
|||
* Subtracts a given number of minutes, hours, days, 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 {Error} if invalid or unsupported unit is given |
|||
* @returns {Morebits.date} |
|||
*/ |
|||
subtract: function(number, unit) { |
|||
return this.add(-number, unit); |
|||
}, |
|||
/** |
|||
* Formats the date into a string per the given format string. |
|||
* Replacement syntax is a subset of that in moment.js. |
|||
* @param {string} formatstr |
|||
* @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} |
|||
*/ |
|||
format: function(formatstr, zone) { |
|||
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'); |
|||
} |
|||
var pad = function(num) { |
|||
return num < 10 ? '0' + num : num; |
|||
}; |
|||
var h24 = udate.getHours(), m = udate.getMinutes(), s = udate.getSeconds(); |
|||
var D = udate.getDate(), M = udate.getMonth() + 1, Y = udate.getFullYear(); |
|||
var h12 = h24 % 12 || 12, amOrPm = h24 >= 12 ? 'PM' : '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, |
|||
'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}|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); |
|||
} |
|||
}, |
|||
/** |
|||
* @returns {RegExp} that matches wikitext section titles such as ==December 2019== or |
|||
* === Jan 2018 === |
|||
*/ |
|||
monthHeaderRegex: function() { |
|||
return new RegExp('^==+\\s*(?:' + this.getUTCMonthName() + '|' + this.getUTCMonthNameAbbrev() + |
|||
')\\s+' + this.getUTCFullYear() + '\\s*==+', 'mg'); |
|||
}, |
|||
/** |
|||
* Creates a section header with the month and year. |
|||
* @param {number} [level=2] - Header level (default 2). 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 |
|||
} |
|||
}); |
|||
/** |
|||
* **************** Morebits.wiki **************** |
|||
* Various objects for wiki editing and API access |
|||
*/ |
|||
Morebits.wiki = {}; |
|||
/** |
|||
* Determines whether the current page is a redirect or soft redirect |
|||
* (fails to detect soft redirects on edit, history, etc. pages) |
|||
* @returns {boolean} |
|||
*/ |
|||
Morebits.wiki.isPageRedirect = function wikipediaIsPageRedirect() { |
|||
return !!(mw.config.get('wgIsRedirect') || document.getElementById('softredirect')); |
|||
}; |
|||
/** |
|||
* **************** Morebits.wiki.actionCompleted **************** |
|||
* |
|||
* Use of Morebits.wiki.actionCompleted(): |
|||
* Every call to Morebits.wiki.api.post() results in the dispatch of |
|||
* an asynchronous callback. Each callback can in turn |
|||
* make an additional call to Morebits.wiki.api.post() to continue a |
|||
* processing sequence. At the conclusion of the final callback |
|||
* of a processing sequence, it is not possible to simply return to the |
|||
* original caller because there is no call stack leading back to |
|||
* 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 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 not create a new Morebits.wiki.api object before exiting, it is the |
|||
* final step in the processing chain and Morebits.wiki.actionCompleted.event() |
|||
* 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. |
|||
* This is used for batch operations. The end of a batch is signaled by calling |
|||
* Morebits.wiki.removeCheckpoint(). |
|||
*/ |
|||
Morebits.wiki.numberOfActionsLeft = 0; |
|||
Morebits.wiki.nbrOfCheckpointsLeft = 0; |
|||
Morebits.wiki.actionCompleted = function(self) { |
|||
if (--Morebits.wiki.numberOfActionsLeft <= 0 && Morebits.wiki.nbrOfCheckpointsLeft <= 0) { |
|||
Morebits.wiki.actionCompleted.event(self); |
|||
} |
|||
}; |
|||
// Change per action wanted |
|||
Morebits.wiki.actionCompleted.event = function() { |
|||
if (Morebits.wiki.actionCompleted.notice) { |
|||
Morebits.status.actionCompleted(Morebits.wiki.actionCompleted.notice); |
|||
} |
|||
if (Morebits.wiki.actionCompleted.redirect) { |
|||
// if it isn't a URL, make it one. TODO: This breaks on the articles 'http://', 'ftp://', and similar ones. |
|||
if (!(/^\w+:\/\//).test(Morebits.wiki.actionCompleted.redirect)) { |
|||
Morebits.wiki.actionCompleted.redirect = mw.util.getUrl(Morebits.wiki.actionCompleted.redirect); |
|||
if (Morebits.wiki.actionCompleted.followRedirect === false) { |
|||
Morebits.wiki.actionCompleted.redirect += '?redirect=no'; |
|||
} |
|||
} |
|||
window.setTimeout(function() { |
|||
window.location = Morebits.wiki.actionCompleted.redirect; |
|||
}, Morebits.wiki.actionCompleted.timeOut); |
|||
} |
|||
}; |
|||
Morebits.wiki.actionCompleted.timeOut = typeof window.wpActionCompletedTimeOut === 'undefined' ? 5000 : window.wpActionCompletedTimeOut; |
|||
Morebits.wiki.actionCompleted.redirect = null; |
|||
Morebits.wiki.actionCompleted.notice = null; |
|||
Morebits.wiki.addCheckpoint = function() { |
|||
++Morebits.wiki.nbrOfCheckpointsLeft; |
|||
}; |
|||
Morebits.wiki.removeCheckpoint = function() { |
|||
if (--Morebits.wiki.nbrOfCheckpointsLeft <= 0 && Morebits.wiki.numberOfActionsLeft <= 0) { |
|||
Morebits.wiki.actionCompleted.event(); |
|||
} |
|||
}; |
|||
/** |
|||
* **************** Morebits.wiki.api **************** |
|||
* An easy way to talk to the MediaWiki API. |
|||
*/ |
|||
/** |
|||
* In new code, the use of the last 3 parameters should be avoided, instead use 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. |
|||
* @constructor |
|||
* @param {string} currentAction - The current action (required) |
|||
* @param {Object} query - The query (required) |
|||
* @param {Function} [onSuccess] - The function to call when request gotten |
|||
* @param {Morebits.status} [statusElement] - A Morebits.status object to use for status messages (optional) |
|||
* @param {Function} [onError] - The function to call if an error occurs (optional) |
|||
*/ |
|||
Morebits.wiki.api = function(currentAction, query, onSuccess, statusElement, onError) { |
|||
this.currentAction = currentAction; |
|||
this.query = query; |
|||
this.query.assert = 'user'; |
|||
this.onSuccess = onSuccess; |
|||
this.onError = onError; |
|||
if (statusElement) { |
|||
this.setStatusElement(statusElement); |
|||
} else { |
|||
this.statelem = new Morebits.status(currentAction); |
|||
} |
|||
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; |
|||
} |
|||
}; |
|||
Morebits.wiki.api.prototype = { |
|||
currentAction: '', |
|||
onSuccess: null, |
|||
onError: null, |
|||
parent: window, // use global context if there is no parent object |
|||
query: null, |
|||
response: null, |
|||
responseXML: null, // use `response` instead; retained for backwards compatibility |
|||
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 |
|||
* @param {*} parent |
|||
*/ |
|||
setParent: function(parent) { |
|||
this.parent = parent; |
|||
}, |
|||
/** @param {Morebits.status} statusElement */ |
|||
setStatusElement: function(statusElement) { |
|||
this.statelem = statusElement; |
|||
this.statelem.status(this.currentAction); |
|||
}, |
|||
/** |
|||
* Carries 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) { |
|||
++Morebits.wiki.numberOfActionsLeft; |
|||
var queryString = $.map(this.query, function(val, i) { |
|||
if (Array.isArray(val)) { |
|||
return encodeURIComponent(i) + '=' + val.map(encodeURIComponent).join('|'); |
|||
} else if (val !== undefined) { |
|||
return encodeURIComponent(i) + '=' + encodeURIComponent(val); |
|||
} |
|||
}).join('&').replace(/^(.*?)(\btoken=[^&]*)&(.*)/, '$1$3&$2'); |
|||
// token should always be the last item in the query string (bug TW-B-0013) |
|||
var ajaxparams = $.extend({}, { |
|||
context: this, |
|||
type: this.query.action === 'query' ? 'GET' : 'POST', |
|||
url: mw.util.wikiScript('api'), |
|||
data: queryString, |
|||
dataType: this.query.format, |
|||
headers: { |
|||
'Api-User-Agent': morebitsWikiApiUserAgent |
|||
} |
|||
}, callerAjaxParameters); |
|||
return $.ajax(ajaxparams).then( |
|||
function onAPIsuccess(response, statusText) { |
|||
this.statusText = statusText; |
|||
this.response = this.responseXML = response; |
|||
if (this.query.format === 'json') { |
|||
this.errorCode = response.error && response.error.code; |
|||
this.errorText = response.error && response.error.info; |
|||
} else { |
|||
this.errorCode = $(response).find('error').attr('code'); |
|||
this.errorText = $(response).find('error').attr('info'); |
|||
} |
|||
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); |
|||
} |
|||
// 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('done'); |
|||
} |
|||
Morebits.wiki.actionCompleted(); |
|||
return $.Deferred().resolveWith(this.parent, [this]); |
|||
}, |
|||
// 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 = statusText + ' "' + jqXHR.statusText + '" occurred while contacting the API.'; |
|||
return this.returnError(); |
|||
} |
|||
); |
|||
}, |
|||
returnError: function(callerAjaxParameters) { |
|||
if (this.errorCode === 'badtoken' && !this.badtokenRetry) { |
|||
this.statelem.warn('Invalid token. Getting a new token and retrying...'); |
|||
this.badtokenRetry = true; |
|||
// Get a new CSRF token and retry. If the original action needs a different |
|||
// 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 |
|||
if (this.onError) { |
|||
// 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.onError.call(this.parent, this); |
|||
} |
|||
// don't complete the action so that the error remains displayed |
|||
return $.Deferred().rejectWith(this.parent, [this]); |
|||
}, |
|||
getStatusElement: function() { |
|||
return this.statelem; |
|||
}, |
|||
getErrorCode: function() { |
|||
return this.errorCode; |
|||
}, |
|||
getErrorText: function() { |
|||
return this.errorText; |
|||
}, |
|||
getXML: function() { // retained for backwards compatibility, use getResponse() instead |
|||
return this.responseXML; |
|||
}, |
|||
getResponse: function() { |
|||
return this.response; |
|||
} |
|||
}; |
|||
// 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 ([[w:WT:TW]])'; |
|||
/** |
|||
* Sets the custom user agent header |
|||
* @param {string} ua User agent |
|||
*/ |
|||
Morebits.wiki.api.setApiUserAgent = function(ua) { |
|||
morebitsWikiApiUserAgent = (ua ? ua + ' ' : '') + 'morebits.js ([[w:WT:TW]])'; |
|||
}; |
|||
// Default change/revision tag applied to Morebits actions when no other tags are specified |
|||
// Off by default per [[Special:Permalink/970618849#Adding tags to Twinkle edits and actions]] |
|||
var morebitsWikiChangeTag = ''; |
|||
/** Get a new CSRF token on encountering token errors */ |
|||
Morebits.wiki.api.getToken = function() { |
|||
var tokenApi = new Morebits.wiki.api('Getting token', { |
|||
action: 'query', |
|||
meta: 'tokens', |
|||
type: 'csrf' |
|||
}); |
|||
return tokenApi.post().then(function(apiobj) { |
|||
return $(apiobj.responseXML).find('tokens').attr('csrftoken'); |
|||
}); |
|||
}; |
|||
/** |
|||
* **************** Morebits.wiki.page **************** |
|||
* Uses 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 Morebits.wiki.actionCompleted.notice and Morebits.wiki.actionCompleted.redirect |
|||
* before the first call to Morebits.wiki.page.load(). |
|||
* |
|||
* Each of the callback functions takes one parameter, which is a |
|||
* reference to the Morebits.wiki.page object that registered the callback. |
|||
* Callback functions may invoke any Morebits.wiki.page prototype method using this reference. |
|||
* |
|||
* |
|||
* HIGHLIGHTS: |
|||
* |
|||
* Constructor: Morebits.wiki.page(pageName, currentAction) |
|||
* pageName - the name of the page, prefixed by the namespace (if any) |
|||
* (for the current page, use mw.config.get('wgPageName')) |
|||
* currentAction - a string describing the action about to be undertaken (optional) |
|||
* |
|||
* onSuccess and onFailure are callback functions called when the operation is a success or failure |
|||
* if enclosed in [brackets], it indicates that it is optional |
|||
* |
|||
* load(onSuccess, [onFailure]): Loads the text for the page |
|||
* |
|||
* getPageText(): returns a string containing the text of the page after a successful load() |
|||
* |
|||
* 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. |
|||
* |
|||
* newSection([onSuccess], [onFailure]): Creates a new section with the text provided via setNewSectionText() |
|||
* and section title via setNewSetionTitle(). Does not require calling load() first. |
|||
* |
|||
* move([onSuccess], [onFailure]): Moves a page to another title |
|||
* |
|||
* patrol(): Patrols a page; ignores errors |
|||
* |
|||
* triage(): Marks page as reviewed using PageTriage, which implies patrolled; ignores most errors |
|||
* |
|||
* 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 |
|||
* |
|||
* setNewSectionText(newSectionText) sets the text that will be added in a new section when newSection() is called |
|||
* |
|||
* setNewSectionTitle(newSectionTitle) sets the title for the new section when newSection() 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() |
|||
* |
|||
*/ |
|||
/** |
|||
* 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 and newSection): |
|||
* .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/newSection 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. |
|||
*/ |
|||
var ctx = { |
|||
// backing fields for public properties |
|||
pageName: pageName, |
|||
pageExists: false, |
|||
editSummary: null, |
|||
changeTags: null, |
|||
callbackParameters: null, |
|||
statusElement: new Morebits.status(currentAction), |
|||
// - edit |
|||
pageText: null, |
|||
editMode: 'all', // save() replaces entire contents of the page by default |
|||
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, |
|||
botEdit: false, |
|||
pageSection: null, |
|||
maxConflictRetries: 2, |
|||
maxRetries: 2, |
|||
followRedirect: false, |
|||
followCrossNsRedirect: true, |
|||
watchlistOption: 'nochange', |
|||
creator: null, |
|||
timestamp: null, |
|||
// - revert |
|||
revertOldID: null, |
|||
// - move |
|||
moveDestination: null, |
|||
moveTalkPage: false, |
|||
moveSubpages: false, |
|||
moveSuppressRedirect: false, |
|||
// - protect |
|||
protectEdit: null, |
|||
protectMove: null, |
|||
protectCreate: null, |
|||
protectCascade: false, |
|||
// - creation lookup |
|||
lookupNonRedirectCreator: false, |
|||
// - stabilize (FlaggedRevs) |
|||
flaggedRevs: null, |
|||
// internal status |
|||
pageLoaded: false, |
|||
csrfToken: null, |
|||
loadTime: null, |
|||
lastEditTime: null, |
|||
pageID: null, |
|||
revertCurID: null, |
|||
revertUser: null, |
|||
fullyProtected: false, |
|||
suppressProtectWarning: false, |
|||
conflictRetries: 0, |
|||
retries: 0, |
|||
// callbacks |
|||
onLoadSuccess: null, |
|||
onLoadFailure: null, |
|||
onSaveSuccess: null, |
|||
onSaveFailure: null, |
|||
onLookupCreationSuccess: null, |
|||
onMoveSuccess: null, |
|||
onMoveFailure: null, |
|||
onDeleteSuccess: null, |
|||
onDeleteFailure: null, |
|||
onUndeleteSuccess: null, |
|||
onUndeleteFailure: null, |
|||
onProtectSuccess: null, |
|||
onProtectFailure: null, |
|||
onStabilizeSuccess: null, |
|||
onStabilizeFailure: null, |
|||
// internal objects |
|||
loadQuery: null, |
|||
loadApi: null, |
|||
saveApi: null, |
|||
lookupCreationApi: null, |
|||
moveApi: null, |
|||
moveProcessApi: null, |
|||
patrolApi: null, |
|||
patrolProcessApi: null, |
|||
triageApi: null, |
|||
triageProcessApi: null, |
|||
deleteApi: null, |
|||
deleteProcessApi: null, |
|||
undeleteApi: null, |
|||
undeleteProcessApi: null, |
|||
protectApi: null, |
|||
protectProcessApi: null, |
|||
stabilizeApi: null, |
|||
stabilizeProcessApi: null |
|||
}; |
|||
var emptyFunction = function() { }; |
|||
/** |
|||
* Loads the text for the page |
|||
* @param {Function} onSuccess - callback function which is called when the load has succeeded |
|||
* @param {Function} [onFailure] - callback function which is called when the load fails (optional) |
|||
*/ |
|||
this.load = function(onSuccess, onFailure) { |
|||
ctx.onLoadSuccess = onSuccess; |
|||
ctx.onLoadFailure = onFailure || emptyFunction; |
|||
// Need to be able to do something after the page loads |
|||
if (!onSuccess) { |
|||
ctx.statusElement.error('Internal error: no onSuccess callback provided to load()!'); |
|||
ctx.onLoadFailure(this); |
|||
return; |
|||
} |
|||
ctx.loadQuery = { |
|||
action: 'query', |
|||
prop: 'info|revisions', |
|||
curtimestamp: '', |
|||
meta: 'tokens', |
|||
type: 'csrf', |
|||
titles: ctx.pageName |
|||
// don't need rvlimit=1 because we don't need rvstartid here and only one actual rev is returned by default |
|||
}; |
|||
if (ctx.editMode === 'all') { |
|||
ctx.loadQuery.rvprop = 'content|timestamp'; // get the page content at the same time, if needed |
|||
} else if (ctx.editMode === 'revert') { |
|||
ctx.loadQuery.rvprop = 'timestamp'; |
|||
ctx.loadQuery.rvlimit = 1; |
|||
ctx.loadQuery.rvstartid = ctx.revertOldID; |
|||
} |
|||
if (ctx.followRedirect) { |
|||
ctx.loadQuery.redirects = ''; // follow all redirects |
|||
} |
|||
if (typeof ctx.pageSection === 'number') { |
|||
ctx.loadQuery.rvsection = ctx.pageSection; |
|||
} |
|||
if (Morebits.userIsSysop) { |
|||
ctx.loadQuery.inprop = 'protection'; |
|||
} |
|||
ctx.loadApi = new Morebits.wiki.api('Retrieving page...', ctx.loadQuery, fnLoadSuccess, ctx.statusElement, ctx.onLoadFailure); |
|||
ctx.loadApi.setParent(this); |
|||
ctx.loadApi.post(); |
|||
}; |
|||
/** |
|||
* 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 |
|||
* 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). |
|||
* @param {Function} [onSuccess] - callback function which is called when the save has |
|||
* succeeded (optional) |
|||
* @param {Function} [onFailure] - callback function which is called when the save fails |
|||
* (optional) |
|||
*/ |
|||
this.save = function(onSuccess, onFailure) { |
|||
ctx.onSaveSuccess = onSuccess; |
|||
ctx.onSaveFailure = onFailure || emptyFunction; |
|||
// are we getting our editing token from mw.user.tokens? |
|||
var canUseMwUserToken = fnCanUseMwUserToken('edit'); |
|||
if (!ctx.pageLoaded && !canUseMwUserToken) { |
|||
ctx.statusElement.error('Internal error: attempt to save a page that has not been loaded!'); |
|||
ctx.onSaveFailure(this); |
|||
return; |
|||
} |
|||
if (!ctx.editSummary) { |
|||
// new section mode allows (nay, encourages) using the |
|||
// title as the edit summary, but the query needs |
|||
// editSummary to be undefined or '', not null |
|||
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('You are about to make an edit to the fully protected page "' + ctx.pageName + |
|||
(ctx.fullyProtected === 'infinity' ? '" (protected indefinitely)' : '" (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('Edit to fully protected page was aborted.'); |
|||
ctx.onSaveFailure(this); |
|||
return; |
|||
} |
|||
ctx.retries = 0; |
|||
var query = { |
|||
action: 'edit', |
|||
title: ctx.pageName, |
|||
summary: ctx.editSummary, |
|||
token: canUseMwUserToken ? mw.user.tokens.get('csrfToken') : ctx.csrfToken, |
|||
watchlist: ctx.watchlistOption |
|||
}; |
|||
if (ctx.changeTags) { |
|||
query.tags = ctx.changeTags; |
|||
} |
|||
if (typeof ctx.pageSection === 'number') { |
|||
query.section = ctx.pageSection; |
|||
} |
|||
// Set minor edit attribute. If these parameters are present with any value, it is interpreted as true |
|||
if (ctx.minorEdit) { |
|||
query.minor = true; |
|||
} else { |
|||
query.notminor = true; // force Twinkle config to override user preference setting for "all edits are minor" |
|||
} |
|||
// Set bot edit attribute. If this paramter is present with any value, it is interpreted as true |
|||
if (ctx.botEdit) { |
|||
query.bot = true; |
|||
} |
|||
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': |
|||
query.undo = ctx.revertCurID; |
|||
query.undoafter = ctx.revertOldID; |
|||
if (ctx.lastEditTime) { |
|||
query.basetimestamp = ctx.lastEditTime; // check that page hasn't been edited since it was loaded |
|||
} |
|||
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) { |
|||
query.basetimestamp = ctx.lastEditTime; // check that page hasn't been edited since it was loaded |
|||
} |
|||
query.starttimestamp = ctx.loadTime; // check that page hasn't been deleted since it was loaded (don't recreate bad stuff) |
|||
break; |
|||
} |
|||
if (['recreate', 'createonly', 'nocreate'].indexOf(ctx.createOption) !== -1) { |
|||
query[ctx.createOption] = ''; |
|||
} |
|||
if (canUseMwUserToken && ctx.followRedirect) { |
|||
query.redirect = true; |
|||
} |
|||
ctx.saveApi = new Morebits.wiki.api('Saving page...', query, fnSaveSuccess, ctx.statusElement, fnSaveError); |
|||
ctx.saveApi.setParent(this); |
|||
ctx.saveApi.post(); |
|||
}; |
|||
/** |
|||
* Adds the text provided via setAppendText() to the end of the page. |
|||
* Does not require calling load() first. |
|||
* @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) |
|||
*/ |
|||
this.append = function(onSuccess, onFailure) { |
|||
ctx.editMode = 'append'; |
|||
if (fnCanUseMwUserToken('edit')) { |
|||
this.save(onSuccess, onFailure); |
|||
} else { |
|||
ctx.onSaveSuccess = onSuccess; |
|||
ctx.onSaveFailure = onFailure || emptyFunction; |
|||
this.load(fnAutoSave, ctx.onSaveFailure); |
|||
} |
|||
}; |
|||
/** |
|||
* Adds the text provided via setPrependText() to the start of the page. |
|||
* Does not require calling load() first. |
|||
* @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) |
|||
*/ |
|||
this.prepend = function(onSuccess, onFailure) { |
|||
ctx.editMode = 'prepend'; |
|||
if (fnCanUseMwUserToken('edit')) { |
|||
this.save(onSuccess, onFailure); |
|||
} else { |
|||
ctx.onSaveSuccess = onSuccess; |
|||
ctx.onSaveFailure = onFailure || emptyFunction; |
|||
this.load(fnAutoSave, ctx.onSaveFailure); |
|||
} |
|||
}; |
|||
/** |
|||
* 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 |
|||
* @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) |
|||
*/ |
|||
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} string containing the name of the loaded page, including the namespace */ |
|||
this.getPageName = function() { |
|||
return ctx.pageName; |
|||
}; |
|||
/** @returns {string} string containing the text of the page after a successful load() */ |
|||
this.getPageText = function() { |
|||
return ctx.pageText; |
|||
}; |
|||
/** @param {string} pageText - updated page text that will be saved when save() is called */ |
|||
this.setPageText = function(pageText) { |
|||
ctx.editMode = 'all'; |
|||
ctx.pageText = pageText; |
|||
}; |
|||
/** @param {string} appendText - text that will be appended to the page when append() is called */ |
|||
this.setAppendText = function(appendText) { |
|||
ctx.editMode = 'append'; |
|||
ctx.appendText = appendText; |
|||
}; |
|||
/** @param {string} prependText - text 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; |
|||
}; |
|||
// Edit-related setter methods: |
|||
/** |
|||
* @param {string} summary - text of the edit summary that will be used when save() is called |
|||
* Unnecessary if editMode is 'new' and newSectionTitle is provided |
|||
*/ |
|||
this.setEditSummary = function(summary) { |
|||
ctx.editSummary = summary; |
|||
}; |
|||
/** |
|||
* Set any custom tag(s) to be applied to the API action |
|||
* A number of actions don't support it, most notably watch, review |
|||
* and stabilize (T247721), and pagetriageaction (T252980) |
|||
* |
|||
* @param {string|string[]} tags - String or array of tag(s) |
|||
*/ |
|||
this.setChangeTags = function(tags) { |
|||
ctx.changeTags = tags; |
|||
}; |
|||
/** |
|||
* @param {string} createOption - 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) |
|||
* |
|||
*/ |
|||
this.setCreateOption = function(createOption) { |
|||
ctx.createOption = createOption; |
|||
}; |
|||
/** @param {boolean} minorEdit - set true to mark the edit as a minor edit. */ |
|||
this.setMinorEdit = function(minorEdit) { |
|||
ctx.minorEdit = minorEdit; |
|||
}; |
|||
/** @param {boolean} botEdit - set true to mark the edit as a bot edit */ |
|||
this.setBotEdit = function(botEdit) { |
|||
ctx.botEdit = botEdit; |
|||
}; |
|||
/** |
|||
* @param {number} pageSection - integer specifying the section number to load or save. |
|||
* If specified as `null`, the entire page will be retrieved. |
|||
*/ |
|||
this.setPageSection = function(pageSection) { |
|||
ctx.pageSection = pageSection; |
|||
}; |
|||
/** |
|||
* @param {number} maxConflictRetries - number of retries for save errors involving an edit conflict or |
|||
* loss of token. Default: 2 |
|||
*/ |
|||
this.setMaxConflictRetries = function(maxConflictRetries) { |
|||
ctx.maxConflictRetries = maxConflictRetries; |
|||
}; |
|||
/** |
|||
* @param {number} maxRetries - number of retries for save errors not involving an edit conflict or |
|||
* loss of token. Default: 2 |
|||
*/ |
|||
this.setMaxRetries = function(maxRetries) { |
|||
ctx.maxRetries = maxRetries; |
|||
}; |
|||
/** |
|||
* @param {boolean} watchlistOption |
|||
* True - page will be added to the user's watchlist when save() is called |
|||
* False - watchlist status of the page will not be changed (default) |
|||
*/ |
|||
this.setWatchlist = function(watchlistOption) { |
|||
if (watchlistOption) { |
|||
ctx.watchlistOption = 'watch'; |
|||
} else { |
|||
ctx.watchlistOption = 'nochange'; |
|||
} |
|||
}; |
|||
/** |
|||
* @param {boolean} watchlistOption |
|||
* True - page watchlist status will be set based on the user's |
|||
* preference settings when save() is called. |
|||
* False - watchlist status of the page will not be changed (default) |
|||
* |
|||
* Watchlist notes: |
|||
* 1. The MediaWiki API value of 'unwatch', which explicitly removes the page from the |
|||
* user's watchlist, is not used. |
|||
* 2. If both setWatchlist() and setWatchlistFromPreferences() are 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() is only needed for the few Twinkle watchlist preferences |
|||
* that accept a string value of 'default'. |
|||
*/ |
|||
this.setWatchlistFromPreferences = function(watchlistOption) { |
|||
if (watchlistOption) { |
|||
ctx.watchlistOption = 'preferences'; |
|||
} else { |
|||
ctx.watchlistOption = 'nochange'; |
|||
} |
|||
}; |
|||
/** |
|||
* @param {boolean} followRedirect |
|||
* true - a maximum of one redirect will be followed. |
|||
* In the event of a redirect, a message is displayed to the user and |
|||
* the redirect target can be retrieved with getPageName(). |
|||
* false - (default) the requested pageName will be used without regard to any |
|||
* redirect. |
|||
* @param {boolean} followCrossNsRedirect |
|||
* 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!'); |
|||
return; |
|||
} |
|||
ctx.followRedirect = followRedirect; |
|||
ctx.followCrossNsRedirect = typeof followCrossNsRedirect !== 'undefined' ? followCrossNsRedirect : ctx.followCrossNsRedirect; |
|||
}; |
|||
// lookup-creation setter function |
|||
/** |
|||
* @param {boolean} flag - if set true, the author and timestamp of 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 redirects, the original creation is retrived. |
|||
* 2. Revisions that the user is not privileged to access (revdeled/suppressed) will be treated |
|||
* 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) { |
|||
ctx.lookupNonRedirectCreator = flag; |
|||
}; |
|||
// Move-related setter functions |
|||
/** @param {string} destination */ |
|||
this.setMoveDestination = function(destination) { |
|||
ctx.moveDestination = destination; |
|||
}; |
|||
/** @param {boolean} flag */ |
|||
this.setMoveTalkPage = function(flag) { |
|||
ctx.moveTalkPage = !!flag; |
|||
}; |
|||
/** @param {boolean} flag */ |
|||
this.setMoveSubpages = function(flag) { |
|||
ctx.moveSubpages = !!flag; |
|||
}; |
|||
/** @param {boolean} flag */ |
|||
this.setMoveSuppressRedirect = function(flag) { |
|||
ctx.moveSuppressRedirect = !!flag; |
|||
}; |
|||
// Protect-related setter functions |
|||
/** |
|||
* @param {string} level The right required for the specific action |
|||
* e.g. autoconfirmed, sysop, templateeditor, extendedconfirmed (enWiki) |
|||
* @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' }; |
|||
}; |
|||
this.setCascadingProtection = function(flag) { |
|||
ctx.protectCascade = !!flag; |
|||
}; |
|||
this.suppressProtectWarning = function() { |
|||
ctx.suppressProtectWarning = true; |
|||
}; |
|||
// Revert-related getters/setters: |
|||
this.setOldID = function(oldID) { |
|||
ctx.revertOldID = oldID; |
|||
}; |
|||
/** @returns {string} string containing the current revision ID of the page */ |
|||
this.getCurrentID = function() { |
|||
return ctx.revertCurID; |
|||
}; |
|||
/** @returns {string} last 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; |
|||
}; |
|||
// Miscellaneous getters/setters: |
|||
/** |
|||
* `callbackParameters` - an object for use in a callback function |
|||
* |
|||
* 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(). |
|||
*/ |
|||
this.setCallbackParameters = function(callbackParameters) { |
|||
ctx.callbackParameters = callbackParameters; |
|||
}; |
|||
/** |
|||
* @returns the object previous set by setCallbackParameters() |
|||
*/ |
|||
this.getCallbackParameters = function() { |
|||
return ctx.callbackParameters; |
|||
}; |
|||
/** |
|||
* @returns {Morebits.status} Status element created by the constructor |
|||
*/ |
|||
this.getStatusElement = function() { |
|||
return ctx.statusElement; |
|||
}; |
|||
/** |
|||
* @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} true if the page existed on the wiki when it was last loaded |
|||
*/ |
|||
this.exists = function() { |
|||
return ctx.pageExists; |
|||
}; |
|||
/** |
|||
* @returns {string} Page ID of the page loaded. 0 if the page doesn't |
|||
* exist. |
|||
*/ |
|||
this.getPageID = function() { |
|||
return ctx.pageID; |
|||
}; |
|||
/** |
|||
* @returns {string} ISO 8601 timestamp at which the page was last loaded |
|||
*/ |
|||
this.getLoadTime = function() { |
|||
return ctx.loadTime; |
|||
}; |
|||
/** |
|||
* @returns {string} the user who created the page following lookupCreation() |
|||
*/ |
|||
this.getCreator = function() { |
|||
return ctx.creator; |
|||
}; |
|||
/** |
|||
* @returns {string} the ISOString timestamp of page creation following lookupCreation() |
|||
*/ |
|||
this.getCreationTimestamp = function() { |
|||
return ctx.timestamp; |
|||
}; |
|||
/** |
|||
* Retrieves the username of the user who created the page as well as |
|||
* the timestamp of creation |
|||
* @param {Function} onSuccess - callback function (required) 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 |
|||
* Prior to June 2019 known as lookupCreator |
|||
*/ |
|||
this.lookupCreation = function(onSuccess) { |
|||
if (!onSuccess) { |
|||
ctx.statusElement.error('Internal error: no onSuccess callback provided to lookupCreation()!'); |
|||
return; |
|||
} |
|||
ctx.onLookupCreationSuccess = onSuccess; |
|||
var query = { |
|||
'action': 'query', |
|||
'prop': 'revisions', |
|||
'titles': ctx.pageName, |
|||
'rvlimit': 1, |
|||
'rvprop': 'user|timestamp', |
|||
'rvdir': 'newer' |
|||
}; |
|||
// Only the wikitext content model can reliably handle |
|||
// rvsection, others return an error when paired with the |
|||
// content rvprop. Relatedly, non-wikitext models don't |
|||
// understand the #REDIRECT concept, so we shouldn't attempt |
|||
// the redirect resolution in fnLookupCreationSuccess |
|||
if (ctx.lookupNonRedirectCreator) { |
|||
query.rvsection = 0; |
|||
query.rvprop += '|content'; |
|||
} |
|||
if (ctx.followRedirect) { |
|||
query.redirects = ''; // follow all redirects |
|||
} |
|||
ctx.lookupCreationApi = new Morebits.wiki.api('Retrieving page creation information', query, fnLookupCreationSuccess, ctx.statusElement); |
|||
ctx.lookupCreationApi.setParent(this); |
|||
ctx.lookupCreationApi.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) { |
|||
ctx.onSaveSuccess = onSuccess; |
|||
ctx.onSaveFailure = onFailure || emptyFunction; |
|||
if (!ctx.revertOldID) { |
|||
ctx.statusElement.error('Internal error: revision ID to revert to was not set before revert!'); |
|||
ctx.onSaveFailure(this); |
|||
return; |
|||
} |
|||
ctx.editMode = 'revert'; |
|||
this.load(fnAutoSave, ctx.onSaveFailure); |
|||
}; |
|||
/** |
|||
* Moves a page to another title |
|||
* @param {Function} [onSuccess] - callback function to run on success (optional) |
|||
* @param {Function} [onFailure] - callback function to run on failure (optional) |
|||
*/ |
|||
this.move = function(onSuccess, onFailure) { |
|||
ctx.onMoveSuccess = onSuccess; |
|||
ctx.onMoveFailure = onFailure || emptyFunction; |
|||
if (!ctx.editSummary) { |
|||
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!'); |
|||
ctx.onMoveFailure(this); |
|||
return; |
|||
} |
|||
if (fnCanUseMwUserToken('move')) { |
|||
fnProcessMove.call(this, this); |
|||
} else { |
|||
var query = fnNeedTokenInfoQuery('move'); |
|||
ctx.moveApi = new Morebits.wiki.api('retrieving token...', query, fnProcessMove, ctx.statusElement, ctx.onMoveFailure); |
|||
ctx.moveApi.setParent(this); |
|||
ctx.moveApi.post(); |
|||
} |
|||
}; |
|||
/** |
|||
* 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 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 |
|||
if ($('.patrollink').length) { |
|||
var patrolhref = $('.patrollink a').attr('href'); |
|||
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 |
|||
}; |
|||
ctx.patrolApi = new Morebits.wiki.api('retrieving token...', patrolQuery, fnProcessPatrol); |
|||
ctx.patrolApi.setParent(this); |
|||
ctx.patrolApi.post(); |
|||
} |
|||
}; |
|||
/** |
|||
* Marks the page as reviewed by the PageTriage extension |
|||
* https://www.mediawiki.org/wiki/Extension:PageTriage |
|||
* |
|||
* Referred to as "review" on-wiki |
|||
* |
|||
* 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 Morebits.wiki.api is probably preferable. |
|||
* |
|||
* No error handling since we don't actually care about the errors |
|||
*/ |
|||
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'); |
|||
fnProcessTriage(this, this); |
|||
} else { |
|||
var query = fnNeedTokenInfoQuery('triage'); |
|||
ctx.triageApi = new Morebits.wiki.api('retrieving token...', query, fnProcessTriage); |
|||
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} [onFailure] - callback function to run on failure (optional) |
|||
*/ |
|||
this.deletePage = function(onSuccess, onFailure) { |
|||
ctx.onDeleteSuccess = onSuccess; |
|||
ctx.onDeleteFailure = onFailure || emptyFunction; |
|||
// if a non-admin tries to do this, don't bother |
|||
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; |
|||
} |
|||
if (fnCanUseMwUserToken('delete')) { |
|||
fnProcessDelete.call(this, this); |
|||
} else { |
|||
var query = fnNeedTokenInfoQuery('delete'); |
|||
ctx.deleteApi = new Morebits.wiki.api('retrieving token...', query, fnProcessDelete, ctx.statusElement, ctx.onDeleteFailure); |
|||
ctx.deleteApi.setParent(this); |
|||
ctx.deleteApi.post(); |
|||
} |
|||
}; |
|||
/** |
|||
* Undeletes a page (for admins only) |
|||
* @param {Function} [onSuccess] - callback function to run on success (optional) |
|||
* @param {Function} [onFailure] - callback function to run on failure (optional) |
|||
*/ |
|||
this.undeletePage = function(onSuccess, onFailure) { |
|||
ctx.onUndeleteSuccess = onSuccess; |
|||
ctx.onUndeleteFailure = onFailure || emptyFunction; |
|||
// if a non-admin tries to do this, don't bother |
|||
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; |
|||
} |
|||
if (fnCanUseMwUserToken('undelete')) { |
|||
fnProcessUndelete.call(this, this); |
|||
} else { |
|||
var query = fnNeedTokenInfoQuery('undelete'); |
|||
ctx.undeleteApi = new Morebits.wiki.api('retrieving token...', query, fnProcessUndelete, ctx.statusElement, ctx.onUndeleteFailure); |
|||
ctx.undeleteApi.setParent(this); |
|||
ctx.undeleteApi.post(); |
|||
} |
|||
}; |
|||
/** |
|||
* Protects a page (for admins only) |
|||
* @param {Function} [onSuccess] - callback function to run on success (optional) |
|||
* @param {Function} [onFailure] - callback function to run on failure (optional) |
|||
*/ |
|||
this.protect = function(onSuccess, onFailure) { |
|||
ctx.onProtectSuccess = onSuccess; |
|||
ctx.onProtectFailure = onFailure || emptyFunction; |
|||
// if a non-admin tries to do this, don't bother |
|||
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 differential), we always need to request |
|||
// protection levels from the server |
|||
var query = fnNeedTokenInfoQuery('protect'); |
|||
ctx.protectApi = new Morebits.wiki.api('retrieving token...', query, fnProcessProtect, ctx.statusElement, ctx.onProtectFailure); |
|||
ctx.protectApi.setParent(this); |
|||
ctx.protectApi.post(); |
|||
}; |
|||
/** |
|||
* Apply FlaggedRevs protection-style settings |
|||
* only works where $wgFlaggedRevsProtection = true (i.e. where FlaggedRevs |
|||
* settings appear on the wiki's "protect" tab) |
|||
* @param {function} [onSuccess] |
|||
* @param {function} [onFailure] |
|||
*/ |
|||
this.stabilize = function(onSuccess, onFailure) { |
|||
ctx.onStabilizeSuccess = onSuccess; |
|||
ctx.onStabilizeFailure = onFailure || emptyFunction; |
|||
// if a non-admin tries to do this, don't bother |
|||
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')) { |
|||
fnProcessStabilize.call(this, this); |
|||
} else { |
|||
var query = fnNeedTokenInfoQuery('stabilize'); |
|||
ctx.stabilizeApi = new Morebits.wiki.api('retrieving token...', query, fnProcessStabilize, ctx.statusElement, ctx.onStabilizeFailure); |
|||
ctx.stabilizeApi.setParent(this); |
|||
ctx.stabilizeApi.post(); |
|||
} |
|||
}; |
|||
/* |
|||
* Private member functions |
|||
* These are not exposed outside |
|||
*/ |
|||
/** |
|||
* Determines whether we can save an API call by using the csrf token sent with the page |
|||
* HTML, or whether we need to ask the server for more info (e.g. protection expiry). |
|||
* |
|||
* Currently used for append, prepend, newSection, move, stabilize, |
|||
* deletePage, and undeletePage. Can't use for protect since it always |
|||
* needs to request protection status. |
|||
* |
|||
* @param {string} [action=edit] The action being undertaken, e.g. |
|||
* "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/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()) { |
|||
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) { |
|||
return false; |
|||
} |
|||
} |
|||
return !!mw.user.tokens.get('csrfToken'); |
|||
}; |
|||
/** |
|||
* When functions can't use fnCanUseMwUserToken or require checking |
|||
* protection, maintain the query in one place. Used for delete, |
|||
* undelete, protect, stabilize, and move (basically, just not load) |
|||
* |
|||
* @param {string} action The action being undertaken, e.g. "edit" or |
|||
* "delete" |
|||
*/ |
|||
var fnNeedTokenInfoQuery = function(action) { |
|||
var query = { |
|||
action: 'query', |
|||
meta: 'tokens', |
|||
type: 'csrf', |
|||
titles: ctx.pageName |
|||
}; |
|||
// Protection not checked for flagged-revs or non-sysop moves |
|||
if (action !== 'stabilize' && (action !== 'move' || Morebits.userIsSysop)) { |
|||
query.prop = 'info'; |
|||
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); |
|||
}; |
|||
// callback from loadApi.post() |
|||
var fnLoadSuccess = function() { |
|||
var xml = ctx.loadApi.getXML(); |
|||
if (!fnCheckPageName(xml, ctx.onLoadFailure)) { |
|||
return; // abort |
|||
} |
|||
ctx.pageExists = $(xml).find('page').attr('missing') !== ''; |
|||
if (ctx.pageExists) { |
|||
ctx.pageText = $(xml).find('rev').text(); |
|||
ctx.pageID = $(xml).find('page').attr('pageid'); |
|||
} else { |
|||
ctx.pageText = ''; // allow for concatenation, etc. |
|||
ctx.pageID = 0; // nonexistent in response, matches wgArticleId |
|||
} |
|||
ctx.csrfToken = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!ctx.csrfToken) { |
|||
ctx.statusElement.error('Failed to retrieve edit token.'); |
|||
ctx.onLoadFailure(this); |
|||
return; |
|||
} |
|||
ctx.loadTime = $(xml).find('api').attr('curtimestamp'); |
|||
if (!ctx.loadTime) { |
|||
ctx.statusElement.error('Failed to retrieve current timestamp.'); |
|||
ctx.onLoadFailure(this); |
|||
return; |
|||
} |
|||
// extract protection info, to alert admins when they are about to edit a protected page |
|||
if (Morebits.userIsSysop) { |
|||
var editprot = $(xml).find('pr[type="edit"]'); |
|||
if (editprot.length > 0 && editprot.attr('level') === 'sysop') { |
|||
ctx.fullyProtected = editprot.attr('expiry'); |
|||
} else { |
|||
ctx.fullyProtected = false; |
|||
} |
|||
} |
|||
ctx.lastEditTime = $(xml).find('rev').attr('timestamp'); |
|||
ctx.revertCurID = $(xml).find('page').attr('lastrevid'); |
|||
if (ctx.editMode === 'revert') { |
|||
ctx.revertCurID = $(xml).find('rev').attr('revid'); |
|||
if (!ctx.revertCurID) { |
|||
ctx.statusElement.error('Failed to retrieve current revision ID.'); |
|||
ctx.onLoadFailure(this); |
|||
return; |
|||
} |
|||
ctx.revertUser = $(xml).find('rev').attr('user'); |
|||
if (!ctx.revertUser) { |
|||
if ($(xml).find('rev').attr('userhidden') === '') { // username was RevDel'd or oversighted |
|||
ctx.revertUser = '<username hidden>'; |
|||
} else { |
|||
ctx.statusElement.error('Failed to retrieve user who made the revision.'); |
|||
ctx.onLoadFailure(this); |
|||
return; |
|||
} |
|||
} |
|||
// set revert edit summary |
|||
ctx.editSummary = '[[Help:Revert|Reverted]] to revision ' + ctx.revertOldID + ' by ' + ctx.revertUser + ': ' + ctx.editSummary; |
|||
} |
|||
ctx.pageLoaded = true; |
|||
// alert("Generate edit conflict now"); // for testing edit conflict recovery logic |
|||
ctx.onLoadSuccess(this); // invoke callback |
|||
}; |
|||
// helper function to parse the page name returned from the API |
|||
var fnCheckPageName = function(xml, onFailure) { |
|||
if (!onFailure) { |
|||
onFailure = emptyFunction; |
|||
} |
|||
// check for invalid titles |
|||
if ($(xml).find('page').attr('invalid') === '') { |
|||
ctx.statusElement.error('The page title is invalid: ' + ctx.pageName); |
|||
onFailure(this); |
|||
return false; // abort |
|||
} |
|||
// retrieve actual title of the page after normalization and redirects |
|||
if ($(xml).find('page').attr('title')) { |
|||
var resolvedName = $(xml).find('page').attr('title'); |
|||
if ($(xml).find('redirects').length > 0) { |
|||
// check for cross-namespace redirect: |
|||
var origNs = new mw.Title(ctx.pageName).namespace; |
|||
var newNs = new mw.Title(resolvedName).namespace; |
|||
if (origNs !== newNs && !ctx.followCrossNsRedirect) { |
|||
ctx.statusElement.error(ctx.pageName + ' is a cross-namespace redirect to ' + resolvedName + ', aborted'); |
|||
onFailure(this); |
|||
return false; |
|||
} |
|||
// only notify user for redirects, not normalization |
|||
Morebits.status.info('Info', 'Redirected from ' + ctx.pageName + ' to ' + resolvedName); |
|||
} |
|||
ctx.pageName = resolvedName; // update to redirect target or normalized name |
|||
} else { |
|||
// could be a circular redirect or other problem |
|||
ctx.statusElement.error('Could not resolve redirects for: ' + ctx.pageName); |
|||
onFailure(this); |
|||
// force error to stay on the screen |
|||
++Morebits.wiki.numberOfActionsLeft; |
|||
return false; // abort |
|||
} |
|||
return true; // all OK |
|||
}; |
|||
// callback from saveApi.post() |
|||
var fnSaveSuccess = function() { |
|||
ctx.editMode = 'all'; // cancel append/prepend/newSection/revert modes |
|||
var xml = ctx.saveApi.getXML(); |
|||
// see if the API thinks we were successful |
|||
if ($(xml).find('edit').attr('result') === 'Success') { |
|||
// real success |
|||
// default on success action - display link for edited page |
|||
var link = document.createElement('a'); |
|||
link.setAttribute('href', mw.util.getUrl(ctx.pageName)); |
|||
link.appendChild(document.createTextNode(ctx.pageName)); |
|||
ctx.statusElement.info(['completed (', link, ')']); |
|||
if (ctx.onSaveSuccess) { |
|||
ctx.onSaveSuccess(this); // invoke callback |
|||
} |
|||
return; |
|||
} |
|||
// 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).find('captcha').length > 0) { |
|||
ctx.statusElement.error('Could not save the page because the wiki server wanted you to fill out a CAPTCHA.'); |
|||
} else { |
|||
ctx.statusElement.error('Unknown error received from API while saving page'); |
|||
} |
|||
// force error to stay on the screen |
|||
++Morebits.wiki.numberOfActionsLeft; |
|||
ctx.onSaveFailure(this); |
|||
}; |
|||
// callback from saveApi.post() |
|||
var fnSaveError = function() { |
|||
var errorCode = ctx.saveApi.getErrorCode(); |
|||
// check for edit conflict |
|||
if (errorCode === 'editconflict' && ctx.conflictRetries++ < ctx.maxConflictRetries) { |
|||
// edit conflicts can occur when the page needs to be purged from the server cache |
|||
var purgeQuery = { |
|||
action: 'purge', |
|||
titles: ctx.pageName // redirects are already resolved |
|||
}; |
|||
var purgeApi = new Morebits.wiki.api('Edit conflict detected, purging server cache', purgeQuery, function() { |
|||
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds |
|||
ctx.statusElement.info('Edit conflict detected, reapplying edit'); |
|||
if (fnCanUseMwUserToken('edit')) { |
|||
ctx.saveApi.post(); // necessarily append, prepend, or newSection, so this should work as desired |
|||
} else { |
|||
ctx.loadApi.post(); // reload the page and reapply the edit |
|||
} |
|||
}, ctx.statusElement); |
|||
purgeApi.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('Save failed, retrying in 2 seconds ...'); |
|||
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds |
|||
// wait for sometime for client to regain connnectivity |
|||
sleep(2000).then(function() { |
|||
ctx.saveApi.post(); // give it another go! |
|||
}); |
|||
// hard error, give up |
|||
} else { |
|||
switch (errorCode) { |
|||
case 'protectedpage': |
|||
// non-admin attempting to edit a protected page - this gives a friendlier message than the default |
|||
ctx.statusElement.error('Failed to save edit: Page is protected'); |
|||
break; |
|||
case 'abusefilter-disallowed': |
|||
ctx.statusElement.error('The edit was disallowed by the edit filter: "' + $(ctx.saveApi.getXML()).find('abusefilter').attr('description') + '".'); |
|||
break; |
|||
case 'abusefilter-warning': |
|||
ctx.statusElement.error([ 'A warning was returned by the edit filter: "', $(ctx.saveApi.getXML()).find('abusefilter').attr('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; |
|||
case 'spamblacklist': |
|||
// .find('matches') returns an array in case multiple items are blacklisted, we only return the first |
|||
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'); |
|||
break; |
|||
default: |
|||
ctx.statusElement.error('Failed to save edit: ' + ctx.saveApi.getErrorText()); |
|||
} |
|||
ctx.editMode = 'all'; // cancel append/prepend/newSection/revert modes |
|||
if (ctx.onSaveFailure) { |
|||
ctx.onSaveFailure(this); // invoke callback |
|||
} |
|||
} |
|||
}; |
|||
var fnLookupCreationSuccess = function() { |
|||
var xml = ctx.lookupCreationApi.getXML(); |
|||
if (!fnCheckPageName(xml)) { |
|||
return; // abort |
|||
} |
|||
if (!ctx.lookupNonRedirectCreator || !/^\s*#redirect/i.test($(xml).find('rev').text())) { |
|||
ctx.creator = $(xml).find('rev').attr('user'); |
|||
if (!ctx.creator) { |
|||
ctx.statusElement.error('Could not find name of page creator'); |
|||
return; |
|||
} |
|||
ctx.timestamp = $(xml).find('rev').attr('timestamp'); |
|||
if (!ctx.timestamp) { |
|||
ctx.statusElement.error('Could not find timestamp of page creation'); |
|||
return; |
|||
} |
|||
ctx.onLookupCreationSuccess(this); |
|||
} else { |
|||
ctx.lookupCreationApi.query.rvlimit = 50; // modify previous query to fetch more revisions |
|||
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.lookupCreationApi.setParent(this); |
|||
ctx.lookupCreationApi.post(); |
|||
} |
|||
}; |
|||
var fnLookupNonRedirectCreator = function() { |
|||
var xml = ctx.lookupCreationApi.getXML(); |
|||
$(xml).find('rev').each(function(_, rev) { |
|||
if (!/^\s*#redirect/i.test(rev.textContent)) { // inaccessible revisions also check out |
|||
ctx.creator = rev.getAttribute('user'); |
|||
ctx.timestamp = rev.getAttribute('timestamp'); |
|||
return false; // break |
|||
} |
|||
}); |
|||
if (!ctx.creator) { |
|||
// fallback to give first revision author if no non-redirect version in the first 50 |
|||
ctx.creator = $(xml).find('rev')[0].getAttribute('user'); |
|||
ctx.timestamp = $(xml).find('rev')[0].getAttribute('timestamp'); |
|||
if (!ctx.creator) { |
|||
ctx.statusElement.error('Could not find name of page creator'); |
|||
return; |
|||
} |
|||
} |
|||
if (!ctx.timestamp) { |
|||
ctx.statusElement.error('Could not find timestamp of page creation'); |
|||
return; |
|||
} |
|||
ctx.onLookupCreationSuccess(this); |
|||
}; |
|||
var fnProcessMove = function() { |
|||
var pageTitle, token; |
|||
if (fnCanUseMwUserToken('move')) { |
|||
token = mw.user.tokens.get('csrfToken'); |
|||
pageTitle = ctx.pageName; |
|||
} else { |
|||
var xml = ctx.moveApi.getXML(); |
|||
if ($(xml).find('page').attr('missing') === '') { |
|||
ctx.statusElement.error('Cannot move the page, because it no longer exists'); |
|||
ctx.onMoveFailure(this); |
|||
return; |
|||
} |
|||
// extract protection info |
|||
if (Morebits.userIsSysop) { |
|||
var editprot = $(xml).find('pr[type="edit"]'); |
|||
if (editprot.length > 0 && editprot.attr('level') === 'sysop' && !ctx.suppressProtectWarning && |
|||
!confirm('You are about to move the fully protected page "' + ctx.pageName + |
|||
(editprot.attr('expiry') === 'infinity' ? '" (protected indefinitely)' : '" (protection expiring ' + new Morebits.date(editprot.attr('expiry')).calendar('utc') + ' (UTC))') + |
|||
'. \n\nClick OK to proceed with the move, or Cancel to skip this move.')) { |
|||
ctx.statusElement.error('Move of fully protected page was aborted.'); |
|||
ctx.onMoveFailure(this); |
|||
return; |
|||
} |
|||
} |
|||
token = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!token) { |
|||
ctx.statusElement.error('Failed to retrieve move token.'); |
|||
ctx.onMoveFailure(this); |
|||
return; |
|||
} |
|||
pageTitle = $(xml).find('page').attr('title'); |
|||
} |
|||
var query = { |
|||
'action': 'move', |
|||
'from': pageTitle, |
|||
'to': ctx.moveDestination, |
|||
'token': token, |
|||
'reason': ctx.editSummary, |
|||
'watchlist': ctx.watchlistOption |
|||
}; |
|||
if (ctx.changeTags) { |
|||
query.tags = ctx.changeTags; |
|||
} |
|||
if (ctx.moveTalkPage) { |
|||
query.movetalk = 'true'; |
|||
} |
|||
if (ctx.moveSubpages) { |
|||
query.movesubpages = 'true'; |
|||
} |
|||
if (ctx.moveSuppressRedirect) { |
|||
query.noredirect = 'true'; |
|||
} |
|||
ctx.moveProcessApi = new Morebits.wiki.api('moving page...', query, ctx.onMoveSuccess, ctx.statusElement, ctx.onMoveFailure); |
|||
ctx.moveProcessApi.setParent(this); |
|||
ctx.moveProcessApi.post(); |
|||
}; |
|||
var fnProcessPatrol = function() { |
|||
var query = { |
|||
action: 'patrol' |
|||
}; |
|||
// Didn't need to load the page |
|||
if (ctx.rcid) { |
|||
query.rcid = ctx.rcid; |
|||
query.token = mw.user.tokens.get('patrolToken'); |
|||
} else { |
|||
var xml = ctx.patrolApi.getResponse(); |
|||
// Don't patrol if not unpatrolled |
|||
if ($(xml).find('rc').attr('unpatrolled') !== '') { |
|||
return; |
|||
} |
|||
var lastrevid = $(xml).find('page').attr('lastrevid'); |
|||
if (!lastrevid) { |
|||
return; |
|||
} |
|||
query.revid = lastrevid; |
|||
var token = $(xml).find('tokens').attr('patroltoken'); |
|||
if (!token) { |
|||
return; |
|||
} |
|||
query.token = token; |
|||
} |
|||
if (ctx.changeTags) { |
|||
query.tags = ctx.changeTags; |
|||
} |
|||
var patrolStat = new Morebits.status('Marking page as patrolled'); |
|||
ctx.patrolProcessApi = new Morebits.wiki.api('patrolling page...', query, null, patrolStat); |
|||
ctx.patrolProcessApi.setParent(this); |
|||
ctx.patrolProcessApi.post(); |
|||
}; |
|||
var fnProcessTriage = function() { |
|||
var pageID, token; |
|||
if (ctx.pageID) { |
|||
token = mw.user.tokens.get('csrfToken'); |
|||
pageID = ctx.pageID; |
|||
} else { |
|||
var xml = ctx.triageApi.getXML(); |
|||
pageID = $(xml).find('page').attr('pageid'); |
|||
if (!pageID) { |
|||
return; |
|||
} |
|||
token = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!token) { |
|||
return; |
|||
} |
|||
} |
|||
var query = { |
|||
action: 'pagetriageaction', |
|||
pageid: 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: token |
|||
}; |
|||
var triageStat = new Morebits.status('Marking page as curated'); |
|||
ctx.triageProcessApi = new Morebits.wiki.api('curating page...', query, fnProcessTriageSuccess, triageStat, fnProcessTriageError); |
|||
ctx.triageProcessApi.setParent(this); |
|||
ctx.triageProcessApi.post(); |
|||
}; |
|||
// callback from triageProcessApi.post() |
|||
var fnProcessTriageSuccess = function() { |
|||
// Swallow succesful return if nothing changed i.e. page in queue and already triaged |
|||
if ($(ctx.triageProcessApi.getResponse()).find('pagetriageaction').attr('pagetriage_unchanged_status')) { |
|||
ctx.triageProcessApi.getStatusElement().unlink(); |
|||
} |
|||
}; |
|||
// callback from triageProcessApi.post() |
|||
var fnProcessTriageError = function() { |
|||
// Ignore error if page not in queue, see https://github.com/azatoth/twinkle/pull/930 |
|||
if (ctx.triageProcessApi.getErrorCode() === 'bad-pagetriage-page') { |
|||
ctx.triageProcessApi.getStatusElement().unlink(); |
|||
} |
|||
}; |
|||
var fnProcessDelete = function() { |
|||
var pageTitle, token; |
|||
if (fnCanUseMwUserToken('delete')) { |
|||
token = mw.user.tokens.get('csrfToken'); |
|||
pageTitle = ctx.pageName; |
|||
} else { |
|||
var xml = ctx.deleteApi.getXML(); |
|||
if ($(xml).find('page').attr('missing') === '') { |
|||
ctx.statusElement.error('Cannot delete the page, because it no longer exists'); |
|||
ctx.onDeleteFailure(this); |
|||
return; |
|||
} |
|||
// extract protection info |
|||
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 ' + new Morebits.date(editprot.attr('expiry')).calendar('utc') + ' (UTC))') + |
|||
'. \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; |
|||
} |
|||
token = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!token) { |
|||
ctx.statusElement.error('Failed to retrieve delete token.'); |
|||
ctx.onDeleteFailure(this); |
|||
return; |
|||
} |
|||
pageTitle = $(xml).find('page').attr('title'); |
|||
} |
|||
var query = { |
|||
'action': 'delete', |
|||
'title': pageTitle, |
|||
'token': token, |
|||
'reason': ctx.editSummary, |
|||
'watchlist': ctx.watchlistOption |
|||
}; |
|||
if (ctx.changeTags) { |
|||
query.tags = ctx.changeTags; |
|||
} |
|||
ctx.deleteProcessApi = new Morebits.wiki.api('deleting page...', query, ctx.onDeleteSuccess, ctx.statusElement, fnProcessDeleteError); |
|||
ctx.deleteProcessApi.setParent(this); |
|||
ctx.deleteProcessApi.post(); |
|||
}; |
|||
// callback from deleteProcessApi.post() |
|||
var fnProcessDeleteError = function() { |
|||
var errorCode = ctx.deleteProcessApi.getErrorCode(); |
|||
// check for "Database query error" |
|||
if (errorCode === 'internal_api_error_DBQueryError' && ctx.retries++ < ctx.maxRetries) { |
|||
ctx.statusElement.info('Database query error, retrying'); |
|||
--Morebits.wiki.numberOfActionsLeft; // allow for normal completion if retry succeeds |
|||
ctx.deleteProcessApi.post(); // give it another go! |
|||
} else if (errorCode === 'missingtitle') { |
|||
ctx.statusElement.error('Cannot delete the page, because it no longer exists'); |
|||
if (ctx.onDeleteFailure) { |
|||
ctx.onDeleteFailure.call(this, ctx.deleteProcessApi); // invoke callback |
|||
} |
|||
// hard error, give up |
|||
} else { |
|||
ctx.statusElement.error('Failed to delete the page: ' + ctx.deleteProcessApi.getErrorText()); |
|||
if (ctx.onDeleteFailure) { |
|||
ctx.onDeleteFailure.call(this, ctx.deleteProcessApi); // invoke callback |
|||
} |
|||
} |
|||
}; |
|||
var fnProcessUndelete = function() { |
|||
var pageTitle, token; |
|||
if (fnCanUseMwUserToken('undelete')) { |
|||
token = mw.user.tokens.get('csrfToken'); |
|||
pageTitle = ctx.pageName; |
|||
} else { |
|||
var xml = ctx.undeleteApi.getXML(); |
|||
if ($(xml).find('page').attr('missing') !== '') { |
|||
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 ' + new Morebits.date(editprot.attr('expiry')).calendar('utc') + ' (UTC))') + |
|||
'. \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 = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!token) { |
|||
ctx.statusElement.error('Failed to retrieve undelete token.'); |
|||
ctx.onUndeleteFailure(this); |
|||
return; |
|||
} |
|||
pageTitle = $(xml).find('page').attr('title'); |
|||
} |
|||
var query = { |
|||
'action': 'undelete', |
|||
'title': pageTitle, |
|||
'token': token, |
|||
'reason': ctx.editSummary, |
|||
'watchlist': ctx.watchlistOption |
|||
}; |
|||
if (ctx.changeTags) { |
|||
query.tags = ctx.changeTags; |
|||
} |
|||
ctx.undeleteProcessApi = new Morebits.wiki.api('undeleting page...', query, ctx.onUndeleteSuccess, ctx.statusElement, fnProcessUndeleteError); |
|||
ctx.undeleteProcessApi.setParent(this); |
|||
ctx.undeleteProcessApi.post(); |
|||
}; |
|||
// callback from undeleteProcessApi.post() |
|||
var fnProcessUndeleteError = function() { |
|||
var errorCode = ctx.undeleteProcessApi.getErrorCode(); |
|||
// 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 { |
|||
ctx.statusElement.error('Repeated database query error, please try again'); |
|||
if (ctx.onUndeleteFailure) { |
|||
ctx.onUndeleteFailure.call(this, ctx.undeleteProcessApi); // invoke callback |
|||
} |
|||
} |
|||
} 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'); |
|||
if (ctx.onUndeleteFailure) { |
|||
ctx.onUndeleteFailure.call(this, ctx.undeleteProcessApi); // invoke callback |
|||
} |
|||
// hard error, give up |
|||
} else { |
|||
ctx.statusElement.error('Failed to undelete the page: ' + ctx.undeleteProcessApi.getErrorText()); |
|||
if (ctx.onUndeleteFailure) { |
|||
ctx.onUndeleteFailure.call(this, ctx.undeleteProcessApi); // invoke callback |
|||
} |
|||
} |
|||
}; |
|||
var fnProcessProtect = function() { |
|||
var xml = ctx.protectApi.getXML(); |
|||
var missing = $(xml).find('page').attr('missing') === ''; |
|||
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; |
|||
} |
|||
// TODO cascading protection not possible on edit<sysop |
|||
var token = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!token) { |
|||
ctx.statusElement.error('Failed to retrieve protect token.'); |
|||
ctx.onProtectFailure(this); |
|||
return; |
|||
} |
|||
var pageTitle = $(xml).find('page').attr('title'); |
|||
// fetch existing protection levels |
|||
var prs = $(xml).find('pr'); |
|||
var editprot = prs.filter('[type="edit"]'); |
|||
var moveprot = prs.filter('[type="move"]'); |
|||
var createprot = prs.filter('[type="create"]'); |
|||
var protections = [], expirys = []; |
|||
// set edit protection level |
|||
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')); |
|||
} |
|||
if (ctx.protectMove) { |
|||
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')); |
|||
} |
|||
if (ctx.protectCreate) { |
|||
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: pageTitle, |
|||
token: token, |
|||
protections: protections.join('|'), |
|||
expiry: expirys.join('|'), |
|||
reason: ctx.editSummary, |
|||
watchlist: ctx.watchlistOption |
|||
}; |
|||
// Only shows up in logs, not page history [[phab:T259983]] |
|||
if (ctx.changeTags) { |
|||
query.tags = ctx.changeTags; |
|||
} |
|||
if (ctx.protectCascade) { |
|||
query.cascade = 'true'; |
|||
} |
|||
ctx.protectProcessApi = new Morebits.wiki.api('protecting page...', query, ctx.onProtectSuccess, ctx.statusElement, ctx.onProtectFailure); |
|||
ctx.protectProcessApi.setParent(this); |
|||
ctx.protectProcessApi.post(); |
|||
}; |
|||
var fnProcessStabilize = function() { |
|||
var pageTitle, token; |
|||
if (fnCanUseMwUserToken('stabilize')) { |
|||
token = mw.user.tokens.get('csrfToken'); |
|||
pageTitle = ctx.pageName; |
|||
} else { |
|||
var xml = ctx.stabilizeApi.getXML(); |
|||
var missing = $(xml).find('page').attr('missing') === ''; |
|||
if (missing) { |
|||
ctx.statusElement.error('Cannot protect the page, because it no longer exists'); |
|||
ctx.onStabilizeFailure(this); |
|||
return; |
|||
} |
|||
token = $(xml).find('tokens').attr('csrftoken'); |
|||
if (!token) { |
|||
ctx.statusElement.error('Failed to retrieve stabilize token.'); |
|||
ctx.onStabilizeFailure(this); |
|||
return; |
|||
} |
|||
pageTitle = $(xml).find('page').attr('title'); |
|||
} |
|||
var query = { |
|||
action: 'stabilize', |
|||
title: pageTitle, |
|||
token: token, |
|||
protectlevel: ctx.flaggedRevs.level, |
|||
expiry: ctx.flaggedRevs.expiry, |
|||
// tags: ctx.changeTags, // flaggedrevs tag support: [[phab:T247721]] |
|||
reason: ctx.editSummary, |
|||
watchlist: ctx.watchlistOption |
|||
}; |
|||
ctx.stabilizeProcessApi = new Morebits.wiki.api('configuring stabilization settings...', query, ctx.onStabilizeSuccess, ctx.statusElement, ctx.onStabilizeFailure); |
|||
ctx.stabilizeProcessApi.setParent(this); |
|||
ctx.stabilizeProcessApi.post(); |
|||
}; |
|||
var sleep = function(milliseconds) { |
|||
var deferred = $.Deferred(); |
|||
setTimeout(deferred.resolve, milliseconds); |
|||
return deferred; |
|||
}; |
|||
}; // end Morebits.wiki.page |
|||
/* Morebits.wiki.page TODO: (XXX) |
|||
* - Should we retry loads also? |
|||
* - Need to reset current action before the save? |
|||
* - Deal with action.completed stuff |
|||
* - Need to reset all parameters once done (e.g. edit summary, move destination, etc.) |
|||
*/ |
|||
/** |
|||
* **************** Morebits.wiki.preview **************** |
|||
* Uses the API to parse a fragment of wikitext and render it as HTML. |
|||
* |
|||
* The suggested implementation pattern (in Morebits.simpleWindow + Morebits.quickForm situations) is to |
|||
* construct a Morebits.wiki.preview object after rendering a Morebits.quickForm, and bind the object |
|||
* to an arbitrary property of the form (e.g. |previewer|). For an example, see |
|||
* twinklewarn.js. |
|||
*/ |
|||
/** |
|||
* @constructor |
|||
* @param {HTMLElement} previewbox - the element that will contain the rendered HTML, |
|||
* usually a <div> element |
|||
*/ |
|||
Morebits.wiki.preview = function(previewbox) { |
|||
this.previewbox = previewbox; |
|||
$(previewbox).addClass('morebits-previewbox').hide(); |
|||
/** |
|||
* 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] - 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 |
|||
*/ |
|||
this.beginRender = function(wikitext, pageTitle, sectionTitle) { |
|||
$(previewbox).show(); |
|||
var statusspan = document.createElement('span'); |
|||
previewbox.appendChild(statusspan); |
|||
Morebits.status.init(statusspan); |
|||
var query = { |
|||
action: 'parse', |
|||
prop: 'text', |
|||
pst: 'true', // PST = pre-save transform; this makes substitution work properly |
|||
text: wikitext, |
|||
title: pageTitle || mw.config.get('wgPageName'), |
|||
disablelimitreport: true |
|||
}; |
|||
if (sectionTitle) { |
|||
query.section = 'new'; |
|||
query.sectiontitle = sectionTitle; |
|||
} |
|||
var renderApi = new Morebits.wiki.api('loading...', query, fnRenderSuccess, new Morebits.status('Preview')); |
|||
renderApi.post(); |
|||
}; |
|||
var fnRenderSuccess = function(apiobj) { |
|||
var xml = apiobj.getXML(); |
|||
var html = $(xml).find('text').text(); |
|||
if (!html) { |
|||
apiobj.statelem.error('failed to retrieve preview, or template was blanked'); |
|||
return; |
|||
} |
|||
previewbox.innerHTML = html; |
|||
$(previewbox).find('a').attr('target', '_blank'); // this makes links open in new tab |
|||
}; |
|||
/** Hides the preview box and clears it. */ |
|||
this.closePreview = function() { |
|||
$(previewbox).empty().hide(); |
|||
}; |
|||
}; |
|||
/** |
|||
* **************** Morebits.wikitext **************** |
|||
* Wikitext manipulation |
|||
*/ |
|||
Morebits.wikitext = {}; |
|||
/** |
|||
* Get the value of every parameter found in a given template |
|||
* @param {string} text Wikitext containing a template |
|||
* @param {number} [start=0] Index noting where in the text the template begins |
|||
* @returns {Object} {name: templateName, parameters: {key: value}} |
|||
*/ |
|||
Morebits.wikitext.parseTemplate = function(text, start) { |
|||
start = start || 0; |
|||
var count = -1; |
|||
var level = -1; |
|||
var equals = -1; |
|||
var current = ''; |
|||
var result = { |
|||
name: '', |
|||
parameters: {} |
|||
}; |
|||
var key, value; |
|||
for (var i = start; i < text.length; ++i) { |
|||
var test3 = text.substr(i, 3); |
|||
if (test3 === '{{{') { |
|||
current += '{{{'; |
|||
i += 2; |
|||
++level; |
|||
continue; |
|||
} |
|||
if (test3 === '}}}') { |
|||
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) { |
|||
if (count === -1) { |
|||
result.name = current.substring(2).trim(); |
|||
++count; |
|||
} else { |
|||
if (equals !== -1) { |
|||
key = current.substring(0, equals).trim(); |
|||
value = current.substring(equals).trim(); |
|||
result.parameters[key] = value; |
|||
equals = -1; |
|||
} else { |
|||
result.parameters[count] = current; |
|||
++count; |
|||
} |
|||
} |
|||
break; |
|||
} |
|||
continue; |
|||
} |
|||
if (text.charAt(i) === '|' && level <= 0) { |
|||
if (count === -1) { |
|||
result.name = current.substring(2).trim(); |
|||
++count; |
|||
} else { |
|||
if (equals !== -1) { |
|||
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 += text.charAt(i); |
|||
} |
|||
} |
|||
return result; |
|||
}; |
|||
/** |
|||
* @constructor |
|||
* @param {string} text |
|||
*/ |
|||
Morebits.wikitext.page = function mediawikiPage(text) { |
|||
this.text = text; |
|||
}; |
|||
Morebits.wikitext.page.prototype = { |
|||
text: '', |
|||
/** |
|||
* Removes links to `link_target` from the page text. |
|||
* @param {string} link_target |
|||
* |
|||
* @returns {Morebits.wikitext.page} |
|||
*/ |
|||
removeLink: function(link_target) { |
|||
var first_char = link_target.substr(0, 1); |
|||
var link_re_string = '[' + first_char.toUpperCase() + first_char.toLowerCase() + ']' + Morebits.string.escapeRegExp(link_target.substr(1)); |
|||
// Files and Categories become links with a leading colon, e.g. [[:File:Test.png]] |
|||
// 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. If 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} reason - Reason to be included in comment, alongside the commented-out image |
|||
* |
|||
* @returns {Morebits.wikitext.page} |
|||
*/ |
|||
commentOutImage: function(image, reason) { |
|||
var unbinder = new Morebits.unbinder(this.text); |
|||
unbinder.unbind('<!--', '-->'); |
|||
reason = reason ? reason + ': ' : ''; |
|||
var first_char = image.substr(0, 1); |
|||
var image_re_string = '[' + first_char.toUpperCase() + first_char.toLowerCase() + ']' + Morebits.string.escapeRegExp(image.substr(1)); |
|||
// Check for normal image links, i.e. [[File:Foobar.png|...]] |
|||
// Will eat the whole link |
|||
var links_re = new RegExp('\\[\\[(?:[Ii]mage|[Ff]ile):\\s*' + image_re_string); |
|||
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'); |
|||
} |
|||
} |
|||
// unbind the newly created comments |
|||
unbinder.unbind('<!--', '-->'); |
|||
// Check for gallery images, i.e. instances that must start on a new line, |
|||
// eventually preceded with some space, and must include File: prefix |
|||
// Will eat the whole line. |
|||
var gallery_image_re = new RegExp('(^\\s*(?:[Ii]mage|[Ff]ile):\\s*' + image_re_string + '.*?$)', 'mg'); |
|||
unbinder.content = unbinder.content.replace(gallery_image_re, '<!-- ' + reason + '$1 -->'); |
|||
// unbind the newly created comments |
|||
unbinder.unbind('<!--', '-->'); |
|||
// Check free image usages, for example as template arguments, might have the File: prefix excluded, but must be preceeded by an | |
|||
// Will only eat the image name and the preceeding bar and an eventual named parameter |
|||
var free_image_re = new RegExp('(\\|\\s*(?:[\\w\\s]+\\=)?\\s*(?:(?:[Ii]mage|[Ff]ile):\\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 usage of [[File:`image`]] to [[File:`image`|`data`]] |
|||
* @param {string} image - Image name without File: prefix |
|||
* @param {string} data |
|||
* |
|||
* @returns {Morebits.wikitext.page} |
|||
*/ |
|||
addToImageComment: function(image, data) { |
|||
var first_char = image.substr(0, 1); |
|||
var first_char_regex = Morebits.string.escapeRegExp(first_char); |
|||
if (first_char.toUpperCase() !== first_char.toLowerCase()) { |
|||
first_char_regex = '[' + Morebits.string.escapeRegExp(first_char.toUpperCase()) + Morebits.string.escapeRegExp(first_char.toLowerCase()) + ']'; |
|||
} |
|||
var image_re_string = '(?:[Ii]mage|[Ff]ile):\\s*' + first_char_regex + Morebits.string.escapeRegExp(image.substr(1)); |
|||
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])) { |
|||
var replacement = allLinks[i]; |
|||
// just put it at the end? |
|||
replacement = replacement.replace(/\]\]$/, '|' + data + ']]'); |
|||
this.text = this.text.replace(allLinks[i], replacement, 'g'); |
|||
} |
|||
} |
|||
var gallery_re = new RegExp('^(\\s*' + image_re_string + '.*?)\\|?(.*?)$', 'mg'); |
|||
var newtext = '$1|$2 ' + data; |
|||
this.text = this.text.replace(gallery_re, newtext); |
|||
return this; |
|||
}, |
|||
/** |
|||
* Removes transclusions of 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_char = template.substr(0, 1); |
|||
var template_re_string = '(?:[Tt]emplate:)?\\s*[' + first_char.toUpperCase() + first_char.toLowerCase() + ']' + Morebits.string.escapeRegExp(template.substr(1)); |
|||
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; |
|||
}, |
|||
/** |
|||
* 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. Optional, defaults 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('|'); |
|||
} |
|||
flags = 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; |
|||
}, |
|||
/** @returns {string} */ |
|||
getText: function() { |
|||
return this.text; |
|||
} |
|||
}; |
|||
/** |
|||
* *********** Morebits.userspaceLogger ************ |
|||
* Handles logging actions to a userspace log, used in |
|||
* twinklespeedy and twinkleprod. |
|||
*/ |
|||
Morebits.userspaceLogger = function(logPageName) { |
|||
if (!logPageName) { |
|||
throw new Error('no log page name specified'); |
|||
} |
|||
this.initialText = ''; |
|||
this.headerLevel = 3; |
|||
this.changeTags = ''; |
|||
this.log = function(logText, summaryText) { |
|||
if (!logText) { |
|||
return; |
|||
} |
|||
var page = new Morebits.wiki.page('User:' + mw.config.get('wgUserName') + '/' + logPageName, |
|||
'Adding entry to userspace log'); // make this '... to ' + logPageName ? |
|||
return 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(); |
|||
}.bind(this)); |
|||
}; |
|||
}; |
|||
/** |
|||
* **************** Morebits.status **************** |
|||
*/ |
|||
/** |
|||
* @constructor |
|||
* Morebits.status.init() must be called before any status object is created, otherwise |
|||
* those statuses won't be visible. |
|||
* @param {String} text - Text before the the colon `:` |
|||
* @param {String} stat - Text after the colon `:` |
|||
* @param {String} [type=status] - This parameter determines the font color of the status line, |
|||
* this can be 'status' (blue), 'info' (green), 'warn' (red), or 'error' (bold red) |
|||
* The default is 'status' |
|||
*/ |
|||
Morebits.status = function Status(text, stat, type) { |
|||
this.textRaw = text; |
|||
this.text = this.codify(text); |
|||
this.type = type || 'status'; |
|||
this.generate(); |
|||
if (stat) { |
|||
this.update(stat, type); |
|||
} |
|||
}; |
|||
/** |
|||
* Specify an area for status message elements to be added to |
|||
* @param {HTMLElement} root - usually a div element |
|||
*/ |
|||
Morebits.status.init = function(root) { |
|||
if (!(root instanceof Element)) { |
|||
throw new Error('object not an instance of Element'); |
|||
} |
|||
while (root.hasChildNodes()) { |
|||
root.removeChild(root.firstChild); |
|||
} |
|||
Morebits.status.root = root; |
|||
Morebits.status.errorEvent = null; |
|||
}; |
|||
Morebits.status.root = null; |
|||
/** @param {Function} handler - function to execute on error */ |
|||
Morebits.status.onError = function(handler) { |
|||
if (typeof handler === 'function') { |
|||
Morebits.status.errorEvent = handler; |
|||
} else { |
|||
throw 'Morebits.status.onError: handler is not a function'; |
|||
} |
|||
}; |
|||
Morebits.status.prototype = { |
|||
stat: null, |
|||
text: null, |
|||
textRaw: null, |
|||
type: 'status', |
|||
target: null, |
|||
node: null, |
|||
linked: false, |
|||
/** Add the status element node to the DOM */ |
|||
link: function() { |
|||
if (!this.linked && Morebits.status.root) { |
|||
Morebits.status.root.appendChild(this.node); |
|||
this.linked = true; |
|||
} |
|||
}, |
|||
/** Remove the status element node from the DOM */ |
|||
unlink: function() { |
|||
if (this.linked) { |
|||
Morebits.status.root.removeChild(this.node); |
|||
this.linked = false; |
|||
} |
|||
}, |
|||
/** |
|||
* Create a document fragment with the status text |
|||
* @param {(string|Element|Array)} obj |
|||
* @returns {DocumentFragment} |
|||
*/ |
|||
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.stat = this.codify(status); |
|||
if (type) { |
|||
this.type = type; |
|||
if (type === 'error') { |
|||
// hack to force the page not to reload when an error is output - see also Morebits.status() above |
|||
Morebits.wiki.numberOfActionsLeft = 1000; |
|||
// call error callback |
|||
if (Morebits.status.errorEvent) { |
|||
Morebits.status.errorEvent(); |
|||
} |
|||
// also log error messages in the browser console |
|||
console.error(this.textRaw + ': ' + status); // eslint-disable-line no-console |
|||
} |
|||
} |
|||
this.render(); |
|||
}, |
|||
/** Produce the html for first part of the status message */ |
|||
generate: function() { |
|||
this.node = document.createElement('div'); |
|||
this.node.appendChild(document.createElement('span')).appendChild(this.text); |
|||
this.node.appendChild(document.createElement('span')).appendChild(document.createTextNode(': ')); |
|||
this.target = this.node.appendChild(document.createElement('span')); |
|||
this.target.appendChild(document.createTextNode('')); // dummy node |
|||
}, |
|||
/** Complete the html, for the second part of the status message */ |
|||
render: function() { |
|||
this.node.className = 'morebits_status_' + this.type; |
|||
while (this.target.hasChildNodes()) { |
|||
this.target.removeChild(this.target.firstChild); |
|||
} |
|||
this.target.appendChild(this.stat); |
|||
this.link(); |
|||
}, |
|||
status: function(status) { |
|||
this.update(status, 'status'); |
|||
}, |
|||
info: function(status) { |
|||
this.update(status, 'info'); |
|||
}, |
|||
warn: function(status) { |
|||
this.update(status, 'warn'); |
|||
}, |
|||
error: function(status) { |
|||
this.update(status, 'error'); |
|||
} |
|||
}; |
|||
Morebits.status.info = function(text, status) { |
|||
return new Morebits.status(text, status, 'info'); |
|||
}; |
|||
Morebits.status.warn = function(text, status) { |
|||
return new Morebits.status(text, status, 'warn'); |
|||
}; |
|||
Morebits.status.error = function(text, status) { |
|||
return new Morebits.status(text, status, 'error'); |
|||
}; |
|||
/** |
|||
* For the action complete message at the end, create a status line without |
|||
* a colon separator. |
|||
* @param {String} text |
|||
*/ |
|||
Morebits.status.actionCompleted = function(text) { |
|||
var node = document.createElement('div'); |
|||
node.appendChild(document.createElement('b')).appendChild(document.createTextNode(text)); |
|||
node.className = 'morebits_status_info'; |
|||
if (Morebits.status.root) { |
|||
Morebits.status.root.appendChild(node); |
|||
} |
|||
}; |
|||
/** |
|||
* Display the user's rationale, comments, etc. back to them after a failure, |
|||
* so that they may re-use it |
|||
* @param {string} comments |
|||
* @param {string} message |
|||
*/ |
|||
Morebits.status.printUserText = function(comments, message) { |
|||
var p = document.createElement('p'); |
|||
p.innerHTML = message; |
|||
var div = document.createElement('div'); |
|||
div.className = 'toccolours'; |
|||
div.style.marginTop = '0'; |
|||
div.style.whiteSpace = 'pre-wrap'; |
|||
div.textContent = comments; |
|||
p.appendChild(div); |
|||
Morebits.status.root.appendChild(p); |
|||
}; |
|||
/** |
|||
* **************** Morebits.htmlNode() **************** |
|||
* Simple helper function to create a simple node |
|||
* @param {string} type - type of HTML element |
|||
* @param {string} text - text content |
|||
* @param {string} [color] - font color |
|||
* @returns {HTMLElement} |
|||
*/ |
|||
Morebits.htmlNode = function (type, content, color) { |
|||
var node = document.createElement(type); |
|||
if (color) { |
|||
node.style.color = color; |
|||
} |
|||
node.appendChild(document.createTextNode(content)); |
|||
return node; |
|||
}; |
|||
/** |
|||
* **************** Morebits.checkboxShiftClickSupport() **************** |
|||
* shift-click-support for checkboxes |
|||
* wikibits version (window.addCheckboxClickHandlers) has some restrictions, and |
|||
* doesn't work with checkboxes inside a sortable table, so let's build our own. |
|||
*/ |
|||
Morebits.checkboxShiftClickSupport = function (jQuerySelector, jQueryContext) { |
|||
var lastCheckbox = null; |
|||
function clickHandler(event) { |
|||
var thisCb = this; |
|||
if (event.shiftKey && lastCheckbox !== null) { |
|||
var cbs = $(jQuerySelector, jQueryContext); // can't cache them, obviously, if we want to support resorting |
|||
var index = -1, lastIndex = -1, i; |
|||
for (i = 0; i < cbs.length; i++) { |
|||
if (cbs[i] === thisCb) { |
|||
index = i; |
|||
if (lastIndex > -1) { |
|||
break; |
|||
} |
|||
} |
|||
if (cbs[i] === lastCheckbox) { |
|||
lastIndex = i; |
|||
if (index > -1) { |
|||
break; |
|||
} |
|||
} |
|||
} |
|||
if (index > -1 && lastIndex > -1) { |
|||
// inspired by wikibits |
|||
var endState = thisCb.checked; |
|||
var start, finish; |
|||
if (index < lastIndex) { |
|||
start = index + 1; |
|||
finish = lastIndex; |
|||
} else { |
|||
start = lastIndex; |
|||
finish = index - 1; |
|||
} |
|||
for (i = start; i <= finish; i++) { |
|||
if (cbs[i].checked !== endState) { |
|||
cbs[i].click(); |
|||
} |
|||
} |
|||
} |
|||
} |
|||
lastCheckbox = thisCb; |
|||
return true; |
|||
} |
|||
$(jQuerySelector, jQueryContext).click(clickHandler); |
|||
}; |
|||
/** **************** Morebits.batchOperation **************** |
|||
* Iterates over a group of pages (or arbitrary objects) and executes a worker function |
|||
* for each. |
|||
* |
|||
* Constructor: Morebits.batchOperation(currentAction) |
|||
* |
|||
* setPageList(wikitext): Sets the list of pages to work on. |
|||
* It should be an array of page names (strings). |
|||
* |
|||
* setOption(optionName, optionValue): Sets a known option: |
|||
* - chunkSize (integer): the size of chunks to break the array into (default 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 list. |
|||
* The callback must call workerSuccess when succeeding, or workerFailure |
|||
* when failing. If using Morebits.wiki.api or Morebits.wiki.page, this is easily |
|||
* 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. |
|||
*/ |
|||
/** |
|||
* @constructor |
|||
* @param {string} [currentAction] |
|||
*/ |
|||
Morebits.batchOperation = function(currentAction) { |
|||
var ctx = { |
|||
// backing fields for public properties |
|||
pageList: null, |
|||
options: { |
|||
chunkSize: 50, |
|||
preserveIndividualStatusLines: false |
|||
}, |
|||
// internal counters, etc. |
|||
statusElement: new Morebits.status(currentAction || '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 |
|||
countStarted: 0, |
|||
countFinished: 0, |
|||
countFinishedSuccess: 0, |
|||
currentChunkIndex: -1, |
|||
pageChunks: [], |
|||
running: false |
|||
}; |
|||
// shouldn't be needed by external users, but provided anyway for maximum flexibility |
|||
this.getStatusElement = function() { |
|||
return ctx.statusElement; |
|||
}; |
|||
/** |
|||
* Sets the list of pages to work on |
|||
* @param {Array} pageList Array of objects over which you wish to execute the worker function |
|||
* This is usually the list of page names (strings). |
|||
*/ |
|||
this.setPageList = function(pageList) { |
|||
ctx.pageList = pageList; |
|||
}; |
|||
/** |
|||
* Sets a known option: |
|||
* - chunkSize (integer): |
|||
* The size of chunks to break the array into (default 50). |
|||
* Setting this to a small value (<5) can cause problems. |
|||
* - preserveIndividualStatusLines (boolean): |
|||
* Keep each page's status element visible when worker is complete? |
|||
*/ |
|||
this.setOption = function(optionName, optionValue) { |
|||
ctx.options[optionName] = optionValue; |
|||
}; |
|||
/** |
|||
* Runs the first callback for each page in the list. |
|||
* The callback must call workerSuccess when succeeding, or workerFailure when failing. |
|||
* Runs the second callback when the whole batch has been processed (optional) |
|||
* @param {Function} worker |
|||
* @param {Function} [postFinish] |
|||
*/ |
|||
this.run = function(worker, postFinish) { |
|||
if (ctx.running) { |
|||
ctx.statusElement.error('Batch operation is already running'); |
|||
return; |
|||
} |
|||
ctx.running = true; |
|||
ctx.worker = worker; |
|||
ctx.postFinish = postFinish; |
|||
ctx.countStarted = 0; |
|||
ctx.countFinished = 0; |
|||
ctx.countFinishedSuccess = 0; |
|||
ctx.currentChunkIndex = -1; |
|||
ctx.pageChunks = []; |
|||
var total = ctx.pageList.length; |
|||
if (!total) { |
|||
ctx.statusElement.info('no pages specified'); |
|||
ctx.running = false; |
|||
if (ctx.postFinish) { |
|||
ctx.postFinish(); |
|||
} |
|||
return; |
|||
} |
|||
// chunk page list into more manageable units |
|||
ctx.pageChunks = Morebits.array.chunk(ctx.pageList, ctx.options.chunkSize); |
|||
// start the process |
|||
Morebits.wiki.addCheckpoint(); |
|||
ctx.statusElement.status('0%'); |
|||
fnStartNewChunk(); |
|||
}; |
|||
/** |
|||
* To be called by worker before it terminates succesfully |
|||
* @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 (eg. 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) { |
|||
// update or remove status line |
|||
var statelem = arg.getStatusElement(); |
|||
if (ctx.options.preserveIndividualStatusLines) { |
|||
if (arg.getPageName || arg.pageName || (arg.query && arg.query.title)) { |
|||
// we know the page title - display a relevant message |
|||
var pageName = arg.getPageName ? arg.getPageName() : arg.pageName || arg.query.title; |
|||
statelem.info(['completed (', createPageLink(pageName), ')']); |
|||
} else { |
|||
// we don't know the page title - just display a generic message |
|||
statelem.info('done'); |
|||
} |
|||
} else { |
|||
// remove the status line automatically produced by Morebits.wiki.* |
|||
statelem.unlink(); |
|||
} |
|||
} else if (typeof arg === 'string' && ctx.options.preserveIndividualStatusLines) { |
|||
new Morebits.status(arg, ['done (', createPageLink(arg), ')']); |
|||
} |
|||
ctx.countFinishedSuccess++; |
|||
fnDoneOne(); |
|||
}; |
|||
this.workerFailure = function() { |
|||
fnDoneOne(); |
|||
}; |
|||
// private functions |
|||
var thisProxy = this; |
|||
var fnStartNewChunk = function() { |
|||
var chunk = ctx.pageChunks[++ctx.currentChunkIndex]; |
|||
if (!chunk) { |
|||
return; // done! yay |
|||
} |
|||
// start workers for the current chunk |
|||
ctx.countStarted += chunk.length; |
|||
chunk.forEach(function(page) { |
|||
ctx.worker(page, thisProxy); |
|||
}); |
|||
}; |
|||
var fnDoneOne = function() { |
|||
ctx.countFinished++; |
|||
// update overall status line |
|||
var total = ctx.pageList.length; |
|||
if (ctx.countFinished < total) { |
|||
ctx.statusElement.status(parseInt(100 * ctx.countFinished / total, 10) + '%'); |
|||
// 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 = 'Done (' + ctx.countFinishedSuccess + |
|||
'/' + ctx.countFinished + ' actions completed successfully)'; |
|||
if (ctx.countFinishedSuccess < ctx.countFinished) { |
|||
ctx.statusElement.warn(statusString); |
|||
} else { |
|||
ctx.statusElement.info(statusString); |
|||
} |
|||
if (ctx.postFinish) { |
|||
ctx.postFinish(); |
|||
} |
|||
Morebits.wiki.removeCheckpoint(); |
|||
ctx.running = false; |
|||
} else { |
|||
// ctx.countFinished > total |
|||
// just for giggles! (well, serious debugging, actually) |
|||
ctx.statusElement.warn('Done (overshot by ' + (ctx.countFinished - total) + ')'); |
|||
Morebits.wiki.removeCheckpoint(); |
|||
ctx.running = false; |
|||
} |
|||
}; |
|||
}; |
|||
/** ********** Morebits.taskManager **************** |
|||
* |
|||
* Given a set of asynchronous functions to run along with their dependencies, |
|||
* Morebits.taskManager figures out an efficient sequence of running them 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. |
|||
*/ |
|||
Morebits.taskManager = function() { |
|||
this.taskDependencyMap = new Map(); |
|||
this.deferreds = new Map(); |
|||
this.allDeferreds = []; // Hack: IE doesn't support Map.prototype.values |
|||
/** |
|||
* Register a task along with its dependencies (tasks which should have finished |
|||
* execution before we can begin this one). Each task is a function that must return |
|||
* a promise. The function will get the values resolved by the dependency functions |
|||
* as arguments. |
|||
* @param {function} func - a task |
|||
* @param {function[]} deps - its dependencies |
|||
*/ |
|||
this.add = function(func, deps) { |
|||
this.taskDependencyMap.set(func, deps); |
|||
var deferred = $.Deferred(); |
|||
this.deferreds.set(func, deferred); |
|||
this.allDeferreds.push(deferred); |
|||
}; |
|||
/** |
|||
* Run all the tasks. Multiple tasks may be run at once. |
|||
*/ |
|||
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(null, dependencyPromisesArray).then(function() { |
|||
task.apply(null, arguments).then(function() { |
|||
self.deferreds.get(task).resolve.apply(null, arguments); |
|||
}); |
|||
}); |
|||
}); |
|||
return $.when.apply(null, this.allDeferreds); // resolved when everything is done! |
|||
}; |
|||
}; |
|||
/** |
|||
* **************** Morebits.simpleWindow **************** |
|||
* A simple draggable window |
|||
* now a wrapper for jQuery UI's dialog feature |
|||
* @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) { |
|||
var content = document.createElement('div'); |
|||
this.content = content; |
|||
content.className = 'morebits-dialog-content'; |
|||
content.id = 'morebits-dialog-content-' + Math.round(Math.random() * 1e15); |
|||
this.height = height; |
|||
$(this.content).dialog({ |
|||
autoOpen: false, |
|||
buttons: { 'Placeholder button': function() {} }, |
|||
dialogClass: 'morebits-dialog', |
|||
width: Math.min(parseInt(window.innerWidth, 10), parseInt(width ? width : 800, 10)), |
|||
// give jQuery the given height value (which represents the anticipated height of the dialog) here, so |
|||
// it can position the dialog appropriately |
|||
// the 20 pixels represents adjustment for the extra height of the jQuery dialog "chrome", compared |
|||
// to that of the old SimpleWindow |
|||
height: height + 20, |
|||
close: function(event) { |
|||
// dialogs and their content can be destroyed once closed |
|||
$(event.target).dialog('destroy').remove(); |
|||
}, |
|||
resizeStart: function() { |
|||
this.scrollbox = $(this).find('.morebits-scrollbox')[0]; |
|||
if (this.scrollbox) { |
|||
this.scrollbox.style.maxHeight = 'none'; |
|||
} |
|||
}, |
|||
resizeEnd: function() { |
|||
this.scrollbox = null; |
|||
}, |
|||
resize: function() { |
|||
this.style.maxHeight = ''; |
|||
if (this.scrollbox) { |
|||
this.scrollbox.style.width = ''; |
|||
} |
|||
} |
|||
}); |
|||
var $widget = $(this.content).dialog('widget'); |
|||
// delete the placeholder button (it's only there so the buttonpane gets created) |
|||
$widget.find('button').each(function(key, value) { |
|||
value.parentNode.removeChild(value); |
|||
}); |
|||
// add container for the buttons we add, and the footer links (if any) |
|||
var buttonspan = document.createElement('span'); |
|||
buttonspan.className = 'morebits-dialog-buttons'; |
|||
var linksspan = document.createElement('span'); |
|||
linksspan.className = 'morebits-dialog-footerlinks'; |
|||
$widget.find('.ui-dialog-buttonpane').append(buttonspan, linksspan); |
|||
// resize the scrollbox with the dialog, if one is present |
|||
$widget.resizable('option', 'alsoResize', '#' + this.content.id + ' .morebits-scrollbox, #' + this.content.id); |
|||
}; |
|||
Morebits.simpleWindow.prototype = { |
|||
buttons: [], |
|||
height: 600, |
|||
hasFooterLinks: false, |
|||
scriptName: null, |
|||
/** |
|||
* Focuses the dialog. This might work, or on the contrary, it might not. |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
focus: function() { |
|||
$(this.content).dialog('moveToTop'); |
|||
return this; |
|||
}, |
|||
/** |
|||
* Closes the dialog. If this is set as an event handler, it will stop the event |
|||
* from doing anything more. |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
close: function(event) { |
|||
if (event) { |
|||
event.preventDefault(); |
|||
} |
|||
$(this.content).dialog('close'); |
|||
return this; |
|||
}, |
|||
/** |
|||
* Shows the dialog. Calling display() on a dialog that has previously been closed |
|||
* might work, but it is not guaranteed. |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
display: function() { |
|||
if (this.scriptName) { |
|||
var $widget = $(this.content).dialog('widget'); |
|||
$widget.find('.morebits-dialog-scriptname').remove(); |
|||
var scriptnamespan = document.createElement('span'); |
|||
scriptnamespan.className = 'morebits-dialog-scriptname'; |
|||
scriptnamespan.textContent = this.scriptName + ' \u00B7 '; // U+00B7 MIDDLE DOT = · |
|||
$widget.find('.ui-dialog-title').prepend(scriptnamespan); |
|||
} |
|||
var dialog = $(this.content).dialog('open'); |
|||
if (window.setupTooltips && window.pg && window.pg.re && window.pg.re.diff) { // tie in with NAVPOP |
|||
dialog.parent()[0].ranSetupTooltipsAlready = false; |
|||
window.setupTooltips(dialog.parent()[0]); |
|||
} |
|||
this.setHeight(this.height); // init height algorithm |
|||
return this; |
|||
}, |
|||
/** |
|||
* Sets the dialog title. |
|||
* @param {string} title |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
setTitle: function(title) { |
|||
$(this.content).dialog('option', 'title', title); |
|||
return this; |
|||
}, |
|||
/** |
|||
* 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} |
|||
*/ |
|||
setScriptName: function(name) { |
|||
this.scriptName = name; |
|||
return this; |
|||
}, |
|||
/** |
|||
* Sets the dialog width. |
|||
* @param {number} width |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
setWidth: function(width) { |
|||
$(this.content).dialog('option', 'width', width); |
|||
return this; |
|||
}, |
|||
/** |
|||
* 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} |
|||
*/ |
|||
setHeight: function(height) { |
|||
this.height = height; |
|||
// from display time onwards, let the browser determine the optimum height, |
|||
// and instead limit the height at the given value |
|||
// note that the given height will exclude the approx. 20px that the jQuery UI |
|||
// chrome has in height in addition to the height of an equivalent "classic" |
|||
// Morebits.simpleWindow |
|||
if (parseInt(getComputedStyle($(this.content).dialog('widget')[0], null).height, 10) > window.innerHeight) { |
|||
$(this.content).dialog('option', 'height', window.innerHeight - 2).dialog('option', 'position', 'top'); |
|||
} else { |
|||
$(this.content).dialog('option', 'height', 'auto'); |
|||
} |
|||
$(this.content).dialog('widget').find('.morebits-dialog-content')[0].style.maxHeight = parseInt(this.height - 30, 10) + 'px'; |
|||
return this; |
|||
}, |
|||
/** |
|||
* Sets the content of the dialog to the given element node, usually from rendering |
|||
* a 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} |
|||
*/ |
|||
setContent: function(content) { |
|||
this.purgeContent(); |
|||
this.addContent(content); |
|||
return this; |
|||
}, |
|||
/** |
|||
* Adds the given element node to the dialog content. |
|||
* @param {HTMLElement} content |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
addContent: function(content) { |
|||
this.content.appendChild(content); |
|||
// look for submit buttons in the content, hide them, and add a proxy button to the button pane |
|||
var thisproxy = this; |
|||
$(this.content).find('input[type="submit"], button[type="submit"]').each(function(key, value) { |
|||
value.style.display = 'none'; |
|||
var button = document.createElement('button'); |
|||
button.textContent = value.hasAttribute('value') ? value.getAttribute('value') : value.textContent ? value.textContent : 'Submit Query'; |
|||
button.className = value.className || 'submitButtonProxy'; |
|||
// here is an instance of cheap coding, probably a memory-usage hit in using a closure here |
|||
button.addEventListener('click', function() { |
|||
value.click(); |
|||
}, false); |
|||
thisproxy.buttons.push(button); |
|||
}); |
|||
// remove all buttons from the button pane and re-add them |
|||
if (this.buttons.length > 0) { |
|||
$(this.content).dialog('widget').find('.morebits-dialog-buttons').empty().append(this.buttons)[0].removeAttribute('data-empty'); |
|||
} else { |
|||
$(this.content).dialog('widget').find('.morebits-dialog-buttons')[0].setAttribute('data-empty', 'data-empty'); // used by CSS |
|||
} |
|||
return this; |
|||
}, |
|||
/** |
|||
* Removes all contents from the dialog, barring any footer links |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
purgeContent: function() { |
|||
this.buttons = []; |
|||
// delete all buttons in the buttonpane |
|||
$(this.content).dialog('widget').find('.morebits-dialog-buttons').empty(); |
|||
while (this.content.hasChildNodes()) { |
|||
this.content.removeChild(this.content.firstChild); |
|||
} |
|||
return this; |
|||
}, |
|||
/** |
|||
* Adds a link in the bottom-right corner of the dialog. |
|||
* This can be used to provide help or policy links. |
|||
* 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} wikiPage Link target |
|||
* @param {boolean} [prep=false] Set true to prepend rather than append |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
addFooterLink: function(text, wikiPage, prep) { |
|||
var $footerlinks = $(this.content).dialog('widget').find('.morebits-dialog-footerlinks'); |
|||
if (this.hasFooterLinks) { |
|||
var bullet = document.createElement('span'); |
|||
bullet.textContent = ' \u2022 '; // U+2022 BULLET |
|||
if (prep) { |
|||
$footerlinks.prepend(bullet); |
|||
} else { |
|||
$footerlinks.append(bullet); |
|||
} |
|||
} |
|||
var link = document.createElement('a'); |
|||
link.setAttribute('href', mw.util.getUrl(wikiPage)); |
|||
link.setAttribute('title', wikiPage); |
|||
link.setAttribute('target', '_blank'); |
|||
link.textContent = text; |
|||
if (prep) { |
|||
$footerlinks.prepend(link); |
|||
} else { |
|||
$footerlinks.append(link); |
|||
} |
|||
this.hasFooterLinks = true; |
|||
return this; |
|||
}, |
|||
/** |
|||
* Set whether the window should be modal or not. |
|||
* If set to true, other items on the page will be disabled, i.e., cannot be |
|||
* interacted with. Modal dialogs create an overlay below the dialog but above |
|||
* other page elements. |
|||
* This must be used (if necessary) before calling display() |
|||
* Default: false |
|||
* @param {boolean} modal |
|||
* @returns {Morebits.simpleWindow} |
|||
*/ |
|||
setModality: function(modal) { |
|||
$(this.content).dialog('option', 'modal', modal); |
|||
return this; |
|||
} |
|||
}; |
|||
/** |
|||
* Enables or disables all footer buttons on all Morebits.simpleWindows in the current page. |
|||
* This should be called with `false` when the button(s) become irrelevant (e.g. just before |
|||
* 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. |
|||
* @param {boolean} enabled |
|||
*/ |
|||
Morebits.simpleWindow.setButtonsEnabled = function(enabled) { |
|||
$('.morebits-dialog-buttons button').prop('disabled', !enabled); |
|||
}; |
|||
}(window, document, jQuery)); // End wrap with anonymous function |
|||
/** |
|||
* 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: |
|||
* PLEASE DO NOT USE THESE ALIASES IN NEW CODE! |
|||
* Thanks. |
|||
*/ |
|||
if (typeof arguments === 'undefined') { // typeof is here for a reason... |
|||
/* global Morebits */ |
|||
window.SimpleWindow = Morebits.simpleWindow; |
|||
window.QuickForm = Morebits.quickForm; |
|||
window.Wikipedia = Morebits.wiki; |
|||
window.Status = Morebits.status; |
|||
} |
|||
// </nowiki> |