MediaWiki:Gadget-ToolsRedirect.js
外观
注意:保存之后,你必须清除浏览器缓存才能看到做出的更改。Google Chrome、Firefox、Microsoft Edge及Safari:按住⇧ Shift键并单击工具栏的“刷新”按钮。参阅Help:绕过浏览器缓存以获取更多帮助。
// <nowiki>
(function ($, mw) {
'use strict';
const nsNumber = mw.config.get('wgNamespaceNumber');
const origPageName = mw.config.get('wgPageName');
const scriptPath = mw.config.get('wgScriptPath');
const SUFFIX_APPEND = 0;
const SUFFIX_REPLACE = 1;
const SUFFIX_SETDEFAULT = 2;
const isCategory = nsNumber === 14;
if (nsNumber === -1) {
const chainNoop = function () { return this; };
const noop = function () {};
mw.toolsRedirect = {
SUFFIX_APPEND,
SUFFIX_REPLACE,
SUFFIX_SETDEFAULT,
findRedirectCallback: chainNoop,
findRedirectBySelector: chainNoop,
setRedirectTextSuffix: noop
};
return;
}
const _findRedirectCallbacks = [];
const _pageWithRedirectTextSuffix = Object.create(null);
const _redirectExcludes = Object.create(null);
const _nsCanonPrefix = nsNumber === 0 ? '' : (origPageName.split(':')[0] + ':');
function fixNamespace(title) {
if (!title || nsNumber === 0) {
// do nothing if it's articles
return title;
}
const parsed = mw.Title.newFromText(title);
if (parsed) {
// canonize the namespace
if (parsed.getNamespaceId() === nsNumber) {
return _nsCanonPrefix + parsed.getMainText();
}
return _nsCanonPrefix + parsed.getPrefixedText();
}
// don't have a namespace
return _nsCanonPrefix + title.replace(/^:+/, '');
}
mw.toolsRedirect = {
SUFFIX_APPEND,
SUFFIX_REPLACE,
SUFFIX_SETDEFAULT,
findRedirectCallback: function (callback) {
/* Add new custom callback for finding new
* potential redirect titles.
*
* @param {function} callback( pagename, $content, titles ) -> title list
*/
if (arguments.length === 1) {
_findRedirectCallbacks.push(callback);
} else {
$.merge(_findRedirectCallbacks, arguments);
}
return this;
},
findRedirectBySelector: function (selector) {
/* A shortcut to add CSS selectors as rule to find new potential
* redirect titles.
*
* @param {string} selector
*/
_findRedirectCallbacks.push(function () {
return $(selector).map(function () {
const title = $(this).text();
return title || null;
});
});
return this;
},
setRedirectTextSuffix: function (title, suffix, flag) {
flag = flag || SUFFIX_APPEND; // default append
let flagSet = flag === SUFFIX_REPLACE;
let flagAppend = false;
title = fixNamespace(title);
if (title in _pageWithRedirectTextSuffix) {
flagAppend = flag === SUFFIX_APPEND;
} else {
// if not exist, every flag can set
flagSet = true;
}
if (flagSet) {
_pageWithRedirectTextSuffix[title] = suffix;
} else if (flagAppend) {
_pageWithRedirectTextSuffix[title] += suffix;
}
}
};
const _TR = {
api: null,
windowManager: null,
dialogInstance: null,
variants: ['zh-hans', 'zh-hant', 'zh-cn', 'zh-hk', 'zh-mo', 'zh-sg', 'zh-tw'],
init: function () {
const self = this;
const skin = mw.config.get('skin');
const portletId = ['vector', 'minerva', 'timeless'].includes(skin) ? 'p-views' : 'p-cactions';
const btn = $(mw.util.addPortletLink(
portletId,
'#',
mw.msg('toolsredirect-ca-redirect'),
'ca-redirect',
mw.msg('toolsredirect-tooltip-redirect')
));
btn.on('click', function (evt) {
evt.preventDefault();
self.openDialog();
});
if (skin === 'vector') {
btn.addClass('collapsible');
}
const position = {
vector: 'li#ca-history',
timeless: 'li#ca-history',
minerva: 'li#page-actions-history',
}[skin] || 'li#ca-move';
if (skin === 'minerva') {
$(position).before(btn);
} else {
$(position).after(btn);
}
},
openDialog: function () {
const self = this;
if (!self.api) {
self.api = new mw.Api({ userAgent: 'Gadget-ToolsRedirect' });
}
if (!self.windowManager) {
self.windowManager = new OO.ui.WindowManager();
$(document.body).append(self.windowManager.$element);
self.dialogInstance = self.createDialogClass();
self.windowManager.addWindows([self.dialogInstance]);
}
self.windowManager.openWindow(self.dialogInstance);
},
createDialogClass: function () {
const self = this;
function ToolsRedirectDialog(config) {
ToolsRedirectDialog.super.call(this, config);
}
OO.inheritClass(ToolsRedirectDialog, OO.ui.ProcessDialog);
ToolsRedirectDialog.static.name = 'toolsRedirectDialog';
ToolsRedirectDialog.static.title = mw.msg('toolsredirect-dialog-title');
ToolsRedirectDialog.static.size = 'large';
ToolsRedirectDialog.static.actions = [
{
flags: ['safe', 'close'],
label: mw.msg('ooui-dialog-process-dismiss')
}
];
ToolsRedirectDialog.prototype.initialize = function () {
ToolsRedirectDialog.super.prototype.initialize.apply(this, arguments);
this.indexLayout = new OO.ui.IndexLayout({
expanded: false
});
this.viewTab = new OO.ui.TabPanelLayout('view', {
label: mw.msg('toolsredirect-view-tab'),
expanded: false,
padded: true
});
this.createTab = new OO.ui.TabPanelLayout('create', {
label: mw.msg('toolsredirect-create-tab'),
expanded: false,
padded: true
});
this.indexLayout.addTabPanels([this.viewTab, this.createTab]);
this.viewLoaded = false;
this.createLoaded = false;
this.viewItems = [];
this.createItems = [];
this.indexLayout.on('set', (tabPanel) => {
const name = tabPanel.getName();
if (name === 'view' && !this.viewLoaded) {
this.loadViewTab(false);
} else if (name === 'create' && !this.createLoaded) {
this.loadCreateTab(false);
}
this.updateSize();
});
this.$body.append(this.indexLayout.$element);
};
ToolsRedirectDialog.prototype.getSetupProcess = function (data) {
return ToolsRedirectDialog.super.prototype.getSetupProcess.call(this, data).next(() => {
// default tab, autoload when dialog initiate
this.indexLayout.setTabPanel('view');
if (!this.viewLoaded) {
this.loadViewTab(false);
}
});
};
ToolsRedirectDialog.prototype.buildToolbar = function (items, actionLabel, onActionClick, onRefreshClick) {
const selectAllBtn = new OO.ui.ButtonWidget({
label: mw.msg('toolsredirect-selectall-button'),
framed: false
}).on('click', () => {
items.forEach((item) => {
if (!item.checkbox.isDisabled()) {
item.checkbox.setSelected(true);
}
});
updateToolbar();
});
const selectInvBtn = new OO.ui.ButtonWidget({
label: mw.msg('toolsredirect-seleteinverse-button'),
framed: false
}).on('click', () => {
items.forEach((item) => {
if (!item.checkbox.isDisabled()) {
item.checkbox.setSelected(!item.checkbox.isSelected());
}
});
updateToolbar();
});
const actionBtn = new OO.ui.ButtonWidget({
label: actionLabel,
flags: ['primary', 'progressive'],
framed: false
}).on('click', () => {
const selectedTitles = items
.filter((item) => !item.checkbox.isDisabled() && item.checkbox.isSelected())
.map((item) => item.title);
if (selectedTitles.length > 0) {
onActionClick(selectedTitles);
}
});
const refreshBtn = new OO.ui.ButtonWidget({
icon: 'reload',
label: mw.msg('toolsredirect-refresh-button'),
framed: false
}).on('click', onRefreshClick);
const updateToolbar = () => {
const selectableItems = items.filter((item) => !item.checkbox.isDisabled());
const selectedCount = selectableItems.filter((item) => item.checkbox.isSelected()).length;
selectAllBtn.setDisabled(
selectableItems.length === 0 || selectedCount === selectableItems.length
);
selectInvBtn.setDisabled(selectableItems.length === 0);
actionBtn.setDisabled(selectedCount === 0);
};
items.forEach((item) => {
item.checkbox.on('change', updateToolbar);
});
updateToolbar();
return new OO.ui.HorizontalLayout({
items: [selectAllBtn, selectInvBtn, actionBtn, refreshBtn]
});
};
ToolsRedirectDialog.prototype.loadViewTab = function (reload) {
if (reload) {
this.viewLoaded = false;
}
if (this.viewLoaded) {
return;
}
this.viewTab.$element.empty();
this.viewItems = [];
const $desc = $('<p class="desc">').text(mw.msg('toolsredirect-loading')).appendTo(this.viewTab.$element);
const $listContainer = $('<div class="tools-redirect-list">').appendTo(this.viewTab.$element);
this.updateSize();
this.pushPending();
self.loadRedirect(origPageName, $listContainer, 0, {}, this.viewItems)
.done(() => {
$desc.text(mw.msg('toolsredirect-view-tab-header'));
const toolbar = this.buildToolbar(
this.viewItems,
mw.msg('toolsredirect-fix-button'),
(titles) => this.executeFix(titles),
() => this.loadViewTab(true)
);
$desc.after(toolbar.$element);
})
.fail(() => {
$desc.text(mw.msg('toolsredirect-view-tab-not-found'));
const refreshBtn = new OO.ui.ButtonWidget({
icon: 'reload',
label: mw.msg('toolsredirect-refresh-button'),
framed: false
}).on('click', () => this.loadViewTab(true));
$desc.after(refreshBtn.$element);
})
.always(() => {
this.popPending();
this.viewLoaded = true;
this.updateSize();
});
};
ToolsRedirectDialog.prototype.loadCreateTab = function (reload) {
if (reload) {
this.createLoaded = false;
}
if (this.createLoaded) {
return;
}
this.createTab.$element.empty();
this.createItems = [];
const $desc = $('<p class="desc">').text(mw.msg('toolsredirect-loading')).appendTo(this.createTab.$element);
const $listContainer = $('<div class="tools-redirect-list">').appendTo(this.createTab.$element);
this.updateSize();
this.pushPending();
self.findRedirect(origPageName)
.done((titles) => {
$desc.text(mw.msg('toolsredirect-create-tab-header'));
titles.forEach((title) => {
const ultitle = title.replace(/ /g, '_');
const baseuri = scriptPath + '/index.php?title=' + encodeURIComponent(ultitle);
const checkbox = new OO.ui.CheckboxInputWidget({ selected: false });
this.createItems.push({ title: ultitle, checkbox: checkbox });
const $link = $('<a>')
.attr({
href: baseuri + '&action=edit&redlink=1',
title: title,
target: '_blank'
})
.addClass('new')
.text(title);
const singleCreateBtn = new OO.ui.ButtonWidget({
label: mw.msg('toolsredirect-create-tab'),
framed: false,
flags: ['progressive']
}).on('click', () => {
this.executeCreate([ultitle]);
});
const $row = $('<div class="tools-redirect-row">').append(
checkbox.$element,
$link,
singleCreateBtn.$element
);
$listContainer.append($row);
});
const toolbar = this.buildToolbar(
this.createItems,
mw.msg('toolsredirect-create-tab'),
(selected) => this.executeCreate(selected),
() => this.loadCreateTab(true)
);
$desc.after(toolbar.$element);
})
.fail(() => {
$desc.text(mw.msg('toolsredirect-create-tab-not-found'));
const refreshBtn = new OO.ui.ButtonWidget({
icon: 'reload',
label: mw.msg('toolsredirect-refresh-button'),
framed: false
}).on('click', () => this.loadCreateTab(true));
$desc.after(refreshBtn.$element);
})
.always(() => {
this.popPending();
this.createLoaded = true;
this.updateSize();
});
};
ToolsRedirectDialog.prototype.executeFix = function (pagenames) {
this.viewTab.$element.find('p.desc').text(mw.msg('toolsredirect-fixing'));
this.viewTab.$element.find('.tools-redirect-list, .oo-ui-horizontalLayout').remove();
this.updateSize();
this.pushPending();
self.bulkEditByRegex(pagenames, / \[\[(.*?)\]\]/, (_, oldRedirectTarget) => {
let newRedirectTarget = origPageName;
if (oldRedirectTarget.includes('#')) {
// 嘗試複製章節
const oldRedirectTitle = mw.Title.newFromText(oldRedirectTarget);
if (oldRedirectTitle && oldRedirectTitle.fragment) {
newRedirectTarget += `#${ oldRedirectTitle.fragment }`;
}
}
return ` [[${ newRedirectTarget }]]`;
}, mw.msg('toolsredirect-fix-editsummary')).always(() => {
// delay load before the asynchronous tasks on server finished
setTimeout(() => {
this.popPending();
this.loadViewTab(true);
}, 3000);
});
};
ToolsRedirectDialog.prototype.executeCreate = function (pagenames) {
this.createTab.$element.find('p.desc').text(mw.msg('toolsredirect-creating'));
this.createTab.$element.find('.tools-redirect-list, .oo-ui-horizontalLayout').remove();
this.updateSize();
this.pushPending();
self.bulkEdit(
pagenames,
mw.msg('toolsredirect-create-text', origPageName),
mw.msg('toolsredirect-create-editsummary', origPageName)
).always(() => {
// delay load before the asynchronous tasks on server finished
setTimeout(() => {
this.popPending();
this.viewLoaded = false;
this.loadCreateTab(true);
}, 500);
});
};
return new ToolsRedirectDialog();
},
addRedirectTextSuffix: function (title, text) {
if (title in _pageWithRedirectTextSuffix) {
text = text + _pageWithRedirectTextSuffix[title];
}
return text;
},
bulkEdit: function (titles, text, summary) {
const self = this;
const uniqueTitles = Array.from(new Set(titles));
const promises = uniqueTitles.map((title) => {
const displayTitle = title.replace(/_/g, ' ');
const finalText = self.addRedirectTextSuffix(displayTitle, text);
return self.api.postWithToken('csrf', {
action: 'edit',
title: title,
text: finalText,
summary: summary,
tags: 'ToolsRedirect',
createonly: true
});
});
return $.when.apply($, promises);
},
bulkEditByRegex: function (titles, regex, replacer, summary) {
const self = this;
const uniqueTitles = Array.from(new Set(titles));
const promises = uniqueTitles.map((title) => {
return self.api.edit(title, function (revision) {
return {
text: revision.content.replace(regex, replacer),
summary: summary,
tags: 'ToolsRedirect'
};
});
});
return $.when.apply($, promises);
},
loadRedirect: function (pagename, $container, deep, loaded, itemStore, isRoot = true) {
const self = this;
const deferObj = $.Deferred();
const $top = deep ? $('<dl>').css('margin-left', '1.5em').appendTo($container) : $container;
if (!loaded[pagename]) {
loaded[pagename] = true;
}
this.api.get({
action: 'query',
prop: 'redirects',
titles: pagename,
rdlimit: 'max',
formatversion: 2
}).done(function (data) {
let hasRedirect = false;
const maximumRedirectDepth = mw.config.get('toolsRedirectMaximumRedirectDepth', 10);
const subRequests = [];
if (data.query && Array.isArray(data.query.pages)) {
data.query.pages.forEach(function (page) {
if (!Array.isArray(page.redirects) || page.redirects.length === 0) {
return;
}
page.redirects.forEach(function (rdpage) {
hasRedirect = true;
const rdtitle = rdpage.title;
const ultitle = rdtitle.replace(/ /g, '_');
const baseuri = scriptPath + '/index.php?title=' + encodeURIComponent(ultitle);
const $entry = (deep ? $('<dd>') : $('<div>')).appendTo($top);
const isCycleRedirect = rdtitle in loaded;
loaded[rdtitle] = true;
const checkbox = new OO.ui.CheckboxInputWidget({
disabled: !deep || isCycleRedirect
});
if (deep && !isCycleRedirect) {
itemStore.push({ title: ultitle, checkbox: checkbox });
}
const $mainLink = $('<a>')
.attr({
href: baseuri + '&redirect=no',
title: rdtitle,
target: '_blank'
})
.text(rdtitle);
const $editLink = $('<a>')
.attr({
href: baseuri + '&action=edit',
title: mw.msg('toolsredirect-edit-link'),
target: '_blank'
})
.text(mw.msg('toolsredirect-edit-link'));
const $editLinkWrapper = $('<span class="mw-editsection-like">').append($editLink);
const $row = $('<div class="tools-redirect-row">').append(
checkbox.$element,
$mainLink,
$editLinkWrapper
);
if (!isCycleRedirect && deep) {
const fixBtn = new OO.ui.ButtonWidget({
label: mw.msg('toolsredirect-fix-button'),
framed: false,
flags: ['progressive']
}).on('click', function () {
self.dialogInstance.executeFix([ultitle]);
});
$row.append(fixBtn.$element);
}
if (isCycleRedirect) {
const errorMessage = new OO.ui.MessageWidget({
type: 'error',
label: mw.msg('toolsredirect-cycle-redirect-warning'),
inline: true
});
$row.append(errorMessage.$element);
}
$entry.append($row);
if (!isCycleRedirect && deep < maximumRedirectDepth) {
subRequests.push(self.loadRedirect(rdtitle, $entry, deep + 1, loaded, itemStore, false));
}
});
});
}
if (hasRedirect) {
$.when.apply($, subRequests).done(function () {
deferObj.resolveWith(self);
}).fail(function () {
deferObj.rejectWith(self);
});
} else if (isRoot) {
deferObj.rejectWith(self);
} else {
deferObj.resolveWith(self);
}
}).fail(function () {
deferObj.rejectWith(self);
});
return deferObj.promise();
},
findVariants: function (pagename, titles) {
const self = this;
const suffixReg = /^.+?( \(.+?\))$/;
const retTitles = [];
const simpAndTrad = { 'zh-hans': true, 'zh-hant': true };
const deferreds = this.variants.map(function (variant) {
let req = self.api.get({
action: 'parse',
page: pagename,
prop: 'displaytitle',
variant: variant,
formatversion: 2
}).then(function (data) {
const rawDisplay = $('<div>').html(data.parse.displaytitle).text();
const title = fixNamespace(rawDisplay);
if (variant in simpAndTrad) {
mw.toolsRedirect.setRedirectTextSuffix(title, '\n{{簡繁重定向}}', SUFFIX_APPEND);
}
return title;
});
if (isCategory) {
req = req.then(function (origTitle) {
return self.api.get({
action: 'parse',
text: pagename,
prop: 'text',
variant: variant,
formatversion: 2
}).then(function (data) {
const tmpTitle = $(data.parse.text)
.text()
.replace(/(^\s*|\s*$)/g, '');
// should not create redirect categories
// if the conversion is already in global table,
// or it will mess up a lot
_redirectExcludes[tmpTitle] = true;
return origTitle;
});
});
}
return req;
});
return $.when.apply($, deferreds).then(function () {
const suffixes = [];
Array.from(arguments).forEach(function (title) {
// find title suffix,
// for example " (济南市)" to "市中区 (济南市)"
const match = suffixReg.exec(title);
const suffix = (match && match.length === 2) ? match[1] : '';
retTitles.push(title);
suffixes.push(suffix);
});
// append suffixes
const uniqueSuffixes = Array.from(new Set(suffixes));
uniqueSuffixes.forEach(function (suffix) {
titles.forEach(function (rawTitle) {
const fixed = fixNamespace(rawTitle);
retTitles.push(suffixReg.test(fixed) ? fixed : fixed + suffix);
});
});
return self.findNotExists(Array.from(new Set(retTitles)));
});
},
findNotExists: function (titles) {
const self = this;
const excludes = ['用字模式'];
const normalizedInputs = Array.from(new Set(titles.map(fixNamespace).filter(Boolean)));
if (normalizedInputs.length === 0) {
return $.Deferred().resolve([]).promise();
}
const joinedTitles = normalizedInputs.join( '|' );
const deferreds = ['zh-hans', 'zh-hant'].map(function (variant) {
return self.api.get({
action: 'parse',
text: joinedTitles,
prop: 'text',
variant: variant,
formatversion: 2
});
});
return $.when.apply($, deferreds).then(function () {
let allTitles = [];
Array.from(arguments).forEach(function (res) {
const data = Array.isArray(res) ? res[0] : res;
const parsedList = $(data.parse.text)
.text()
.replace(/(^\s*|\s*$)/g, '')
.split('|')
.map((t) => fixNamespace(t.trim()));
allTitles = allTitles.concat(parsedList);
});
const uniqueTitles = Array.from(new Set(allTitles)).filter(Boolean);
if (uniqueTitles.length === 0) {
return [];
}
return self.api.get({
action: 'query',
prop: 'info',
titles: uniqueTitles.join('|'),
formatversion: 2
}).then(function (data) {
const missingTitles = [];
if (data.query && Array.isArray(data.query.pages)) {
data.query.pages.forEach(function (page) {
const title = page.title;
if (page.missing && excludes.indexOf(title) === -1) {
if (title in _redirectExcludes) {
// exclude special titles
return;
}
missingTitles.push(title);
if (isCategory) {
const target = origPageName.replace(/^Category:/, '');
mw.toolsRedirect.setRedirectTextSuffix(title, '\n{{分类重定向|$1}}'.replace('$1', target));
}
// only set default suffix
mw.toolsRedirect.setRedirectTextSuffix(title, '\n{{別名重定向}}', SUFFIX_SETDEFAULT);
}
});
}
return missingTitles;
});
});
},
findRedirect: function (pagename) {
const self = this;
let titles = [];
const frcDeferreds = [];
const $content = $('#mw-content-text > div.mw-parser-output');
const deferObj = $.Deferred();
_findRedirectCallbacks.forEach(function (callback) {
const ret = callback(pagename, $content, titles);
if (typeof ret === 'string') {
titles.push(ret);
} else if (ret && typeof ret.done === 'function') {
// is Deferred
frcDeferreds.push(ret);
} else if (ret) {
$.merge(titles, ret);
}
});
// remove all empty titles
titles = titles.filter(Boolean);
// handles the deferred callbacks
$.when.apply($, frcDeferreds)
.then(function () {
Array.from(arguments).forEach(function (ret) {
if (typeof ret === 'string') {
titles.push(ret);
} else if (ret) {
$.merge(titles, ret);
}
});
return self.findVariants(pagename, titles);
})
.done(function (resultTitles) {
if (resultTitles.length > 0) {
deferObj.resolveWith(self, [resultTitles]);
} else {
deferObj.rejectWith(self, [resultTitles]);
}
})
.fail(function () {
deferObj.rejectWith(self, [[]]);
});
return deferObj.promise();
}
};
const msgPage = ['zh-hant', 'zh-hk', 'zh-mo', 'zh-tw'].includes(mw.config.get('wgUserLanguage')) ? 'MediaWiki:Gadget-ToolsRedirect-msg-zh-hant.js' : 'MediaWiki:Gadget-ToolsRedirect-msg-zh-hans.js';
$.when(
mw.loader.getScript(mw.util.getUrl(msgPage, { action: 'raw', ctype: 'text/javascript' })),
$.ready
).done(function () {
_TR.init();
mw.hook('mw.toolsRedirect').fire();
});
}(jQuery, mw));
// </nowiki>