User:Polygnotus/Scripts/AddMoreFilters.js
Code that you insert on this page could contain malicious content capable of compromising your account. If you import a script from another page with "importScript", "mw.loader.load", "iusc", or "lusc", take note that this causes you to dynamically load a remote script, which could be changed by others. Editors are responsible for all edits and actions they perform, including by scripts. User scripts are not centrally supported and may malfunction or become inoperable due to software changes. A guide to help you find broken scripts is available. If you are unsure whether code you are adding to this page is safe, you can ask at the appropriate village pump.
This code will be executed when previewing this page.
This code will be executed when previewing this page.
Documentation for this user script can be added at User:Polygnotus/Scripts/AddMoreFilters.
// <nowiki>
// {{Wikipedia:USync |repo=https://github.com/DVRTed/enwiki-userscripts |ref=refs/heads/prod |path=addMoreFilters.js}}
/* Adds advanced filters to Contribution, Page History, and LinkSearch pages
([[Special:Contributions]], [[Special:History]], [[Special:LinkSearch]])
Script authors: [[User:DVRTed]], [[User:Polygnotus]]
*/
/* global mw, OO, $ */
(function () {
"use strict";
const CONFIG = {
DEBOUNCE_TIME: 300,
STORAGE_KEY: "advancedFiltersExpanded",
PAGES: {
CONTRIB: {
listSelector: ".mw-contributions-list:first",
itemSelector: ".mw-contributions-list li",
titleSelector: ".mw-contributions-title",
},
HISTORY: {
listSelector: "#pagehistory",
itemSelector: "#pagehistory li",
titleSelector: "N/A",
},
LINKSEARCH: {
listSelector: ".mw-spcontent ol",
itemSelector: ".mw-spcontent ol li",
titleSelector: "a:not(.external)",
},
},
};
const NAMESPACES = mw.config.get("wgFormattedNamespaces");
const canonicalSpecialPageName = mw.config.get("wgCanonicalSpecialPageName");
let pageType = null;
if (canonicalSpecialPageName === "Contributions") {
pageType = "CONTRIB";
} else if (canonicalSpecialPageName === "LinkSearch") {
pageType = "LINKSEARCH";
} else if ($(CONFIG.PAGES.HISTORY.listSelector).length) {
pageType = "HISTORY";
}
if (!pageType) return;
const isContrib = pageType === "CONTRIB";
const isHistory = pageType === "HISTORY";
const isLinkSearch = pageType === "LINKSEARCH";
const selectors = CONFIG.PAGES[pageType];
let items = [];
let namespaces = new Set();
let tags = new Set();
let users = new Set();
let widgets = {};
// Used for debouncing summary filtering to avoid re-filtering on every keystroke
function debounce(func, wait) {
let timeout;
return function (...args) {
clearTimeout(timeout);
timeout = setTimeout(() => func.apply(this, args), wait);
};
}
function getNamespace(title) {
const titleObj = new mw.Title(title);
return NAMESPACES[titleObj.getNamespaceId()] || "Main";
}
function extractTags($item) {
return $item
.find(".mw-tag-marker")
.map((_, tag) => $(tag).text().trim())
.get();
}
function getItemData($item) {
if (isLinkSearch) {
// Get the non-external link and extract namespace
const $titleLink = $item.find(selectors.titleSelector);
const title = $titleLink.length ? $titleLink.text().trim() : "";
const namespace = title ? getNamespace(title) : "";
return { title, summary: "", tags: [], namespace, user: "", isMinor: false };
}
// For Contrib/History page...
const $title = isContrib ? $item.find(selectors.titleSelector) : "";
const $summary = $item.find(".comment");
const $userLink = $item.find(".mw-userlink");
const title = $title.length ? $title.text().trim() : "";
const summary = $summary.text().trim();
const itemTags = extractTags($item);
const namespace = title ? getNamespace(title) : "";
const user = $userLink.length ? $userLink.text().trim() : "";
// MediaWiki marks minor edits with <abbr class="minor">
const isMinor = $item.find("abbr.minor").length > 0;
return { title, summary, tags: itemTags, namespace, user, isMinor };
}
function initializeData() {
$(selectors.itemSelector).each((_, item) => {
const $item = $(item);
const data = getItemData($item);
namespaces.add(data.namespace);
data.tags.forEach((tag) => tags.add(tag));
if (data.user) users.add(data.user);
items.push({ element: item, data });
});
}
function createMultiSelectFilter(label, placeholder, optionsArray, onChange) {
const selector = new OO.ui.MenuTagMultiselectWidget({
placeholder,
options: optionsArray.map((item) =>
typeof item === "string" ? { data: item, label: item } : item
),
input: { autocomplete: "off" },
});
selector.on("change", onChange);
return new OO.ui.FieldLayout(selector, { label, align: "top" });
}
function createNamespaceFilter() {
const sortedNs = Array.from(namespaces).sort((a, b) =>
a === "Main" ? -1 : b === "Main" ? 1 : a.localeCompare(b)
);
return createMultiSelectFilter(
"Namespaces",
"Select namespaces...",
sortedNs,
applyFilters
);
}
function createTagFilter() {
if (tags.size === 0) return null;
const options = [
{ data: "none", label: "None (untagged)" },
...Array.from(tags).sort(),
];
return createMultiSelectFilter(
"Tags",
"Select tags...",
options,
applyFilters
);
}
// Hides items that match any of the selected tags
function createExcludeTagFilter() {
if (tags.size === 0) return null;
const options = [
{ data: "none", label: "None (untagged)" },
...Array.from(tags).sort(),
];
return createMultiSelectFilter(
"Exclude tags",
"Select tags to exclude...",
options,
applyFilters
);
}
function createUserFilter() {
if (users.size === 0) return null;
const sortedUsers = Array.from(users).sort((a, b) =>
a.localeCompare(b, undefined, { sensitivity: "base" })
);
return createMultiSelectFilter(
"Users",
"Select users...",
sortedUsers,
applyFilters
);
}
// Dropdown to filter by minor edit status: all / minor only / non-minor only
function createMinorFilter() {
const select = new OO.ui.DropdownInputWidget({
options: [
{ data: "all", label: "All edits" },
{ data: "minor", label: "Minor only" },
{ data: "non-minor", label: "Non-minor only" },
],
value: "all",
});
select.on("change", applyFilters);
return {
field: new OO.ui.FieldLayout(select, { label: "Minor edits", align: "top" }),
widget: select,
};
}
function createSummaryFilter() {
const input = new OO.ui.TextInputWidget({
placeholder: "Filter by edit summary...",
icon: "search",
});
const regexToggle = new OO.ui.ToggleSwitchWidget();
const errorMessage = new OO.ui.MessageWidget({
type: "error",
inline: true,
});
errorMessage.$element.css({
display: "none",
marginTop: "1em",
});
input.on("change", debounce(applyFilters, CONFIG.DEBOUNCE_TIME));
regexToggle.on("change", applyFilters);
const $container = $("<div>")
.append(
$("<div>")
.css("marginTop", "1em")
.append(
new OO.ui.FieldLayout(input, {
label: "Edit summary",
align: "top",
}).$element
)
.append(errorMessage.$element)
)
.append(
$("<div>")
.css("marginTop", "1em")
.append(
new OO.ui.FieldLayout(regexToggle, {
label: "Use regex",
align: "inline",
}).$element
)
);
return { container: $container, input, regexToggle, errorMessage };
}
function saveCollapsedState(isExpanded) {
try {
localStorage.setItem(CONFIG.STORAGE_KEY, isExpanded ? "true" : "false");
} catch (e) {
console.error("Failed to save filter panel state:", e);
}
}
function getCollapsedState() {
try {
const stored = localStorage.getItem(CONFIG.STORAGE_KEY);
return stored === null ? true : stored === "true";
} catch {
return true;
}
}
function createUI() {
const nsFilter = isContrib || isLinkSearch ? createNamespaceFilter() : null;
const tagFilter = !isLinkSearch ? createTagFilter() : null;
const excludeTagFilter = !isLinkSearch ? createExcludeTagFilter() : null;
const userFilter = isHistory ? createUserFilter() : null;
const minorFilter = !isLinkSearch ? createMinorFilter() : null;
const summaryFilter = !isLinkSearch ? createSummaryFilter() : null;
widgets = {
nsSelector: nsFilter?.fieldWidget,
tagSelector: tagFilter?.fieldWidget,
excludeTagSelector: excludeTagFilter?.fieldWidget,
userSelector: userFilter?.fieldWidget,
minorSelect: minorFilter?.widget,
summaryInput: summaryFilter?.input,
regexToggle: summaryFilter?.regexToggle,
regexError: summaryFilter?.errorMessage,
statsLabel: new OO.ui.LabelWidget({ label: "" }),
};
const resetButton = new OO.ui.ButtonWidget({
label: "Reset all filters",
flags: ["progressive", "secondary"],
});
resetButton.on("click", resetFilters);
const $footer = $("<div>")
.css({
display: "flex",
justifyContent: "space-between",
alignItems: "center",
marginTop: "1em",
paddingTop: "1em",
})
.append(widgets.statsLabel.$element, resetButton.$element);
const innerFieldset = new OO.ui.FieldsetLayout();
if (nsFilter) innerFieldset.addItems([nsFilter]);
if (tagFilter) innerFieldset.addItems([tagFilter]);
if (excludeTagFilter) innerFieldset.addItems([excludeTagFilter]);
if (userFilter) innerFieldset.addItems([userFilter]);
if (minorFilter) innerFieldset.addItems([minorFilter.field]);
if (summaryFilter) innerFieldset.$element.append(summaryFilter.container);
innerFieldset.$element.append($footer);
const fieldset = new OO.ui.FieldsetLayout({
label: "Advanced filters",
});
const isExpanded = getCollapsedState();
fieldset.$element
.addClass("mw-collapsibleFieldsetLayout")
.addClass("mw-collapsible");
if (!isExpanded) {
fieldset.$element.addClass("mw-collapsed");
}
// Make the header itself the toggle button
fieldset.$header.addClass("mw-collapsible-toggle").attr({
role: "button",
tabindex: "0",
"aria-expanded": isExpanded ? "true" : "false",
});
if (!isExpanded) {
fieldset.$header.addClass("mw-collapsible-toggle-collapsed");
} else {
fieldset.$header.addClass("mw-collapsible-toggle-expanded");
}
const expandIcon = new OO.ui.IconWidget({
icon: "expand",
label: "show",
});
const collapseIcon = new OO.ui.IconWidget({
icon: "collapse",
label: "hide",
});
fieldset.$header.append(expandIcon.$element, collapseIcon.$element);
// Remove the default group and replace with our content wrapped in .mw-collapsible-content
fieldset.$group.remove();
const $content = $("<div>")
.addClass("oo-ui-fieldsetLayout-group")
.addClass("mw-collapsible-content")
.css("max-width", "none") // Override a default for the contribs page
.append(innerFieldset.$element);
if (!isExpanded) {
$content.attr("hidden", "until-found");
}
fieldset.$element.append($content);
const panel = new OO.ui.PanelLayout({
expanded: false,
framed: true,
padded: true,
});
panel.$element.append(fieldset.$element);
// Insert above the pagination bar if present (e.g. on Contributions/History),
// otherwise fall back to inserting directly before the list
const $paginationBar = $(".mw-pager-navigation-bar").first();
if ($paginationBar.length) {
$paginationBar.before(panel.$element);
} else {
$(selectors.listSelector).before(panel.$element);
}
mw.loader.using("jquery.makeCollapsible", function () {
fieldset.$element.makeCollapsible({
collapsed: !isExpanded,
});
fieldset.$element.on("beforeExpand.mw-collapsible", function () {
saveCollapsedState(true);
});
fieldset.$element.on("beforeCollapse.mw-collapsible", function () {
saveCollapsedState(false);
});
});
}
// Summary match with regex support;
// throws "REGEX_ERROR" if the regex is invalid
function matchesSummary(summary, filter, useRegex) {
if (!filter) return true;
try {
return useRegex
? new RegExp(filter, "i").test(summary)
: summary.toLowerCase().includes(filter.toLowerCase());
} catch (e) {
const err = new Error(e.message);
err.code = "REGEX_ERROR";
throw err;
}
}
function itemPassesFilters(data, filters) {
const {
selectedNs,
selectedTags,
selectedExcludeTags,
selectedUsers,
summaryFilter,
useRegex,
minorMode,
} = filters;
// Namespace filter (Contrib, History, LinkSearch)
if (isContrib || isHistory || isLinkSearch) {
if (selectedNs.length > 0 && !selectedNs.includes(data.namespace)) {
return false;
}
}
// Tag include filter (Contrib, History)
if (isContrib || isHistory) {
if (selectedTags.length > 0) {
const hasNoTags = data.tags.length === 0;
const matchesTag = data.tags.some((tag) => selectedTags.includes(tag));
if (hasNoTags ? !selectedTags.includes("none") : !matchesTag) {
return false;
}
}
}
// Tag exclude filter: hide items that match any of the excluded tags (Contrib, History)
if (isContrib || isHistory) {
if (selectedExcludeTags.length > 0) {
const hasNoTags = data.tags.length === 0;
const matchesTag = data.tags.some((tag) => selectedExcludeTags.includes(tag));
// Hide if the item is untagged and "none" is excluded, or if it carries an excluded tag
if (hasNoTags ? selectedExcludeTags.includes("none") : matchesTag) {
return false;
}
}
}
// User filter (History)
if (isHistory) {
if (selectedUsers.length > 0 && !selectedUsers.includes(data.user)) {
return false;
}
}
// Minor edits filter (Contrib, History)
if (isContrib || isHistory) {
if (minorMode === "minor" && !data.isMinor) return false;
if (minorMode === "non-minor" && data.isMinor) return false;
}
// Summary filter (Contrib, History)
if (isContrib || isHistory) {
if (
summaryFilter &&
!matchesSummary(data.summary, summaryFilter, useRegex)
) {
return false;
}
}
return true;
}
function applyFilters() {
const filters = {
selectedNs: widgets.nsSelector?.getValue() || [],
selectedTags: widgets.tagSelector?.getValue() || [],
selectedExcludeTags: widgets.excludeTagSelector?.getValue() || [],
selectedUsers: widgets.userSelector?.getValue() || [],
summaryFilter: widgets.summaryInput?.getValue() || "",
useRegex: widgets.regexToggle?.getValue() || false,
minorMode: widgets.minorSelect?.getValue() || "all",
};
let visibleCount = 0;
let hasRegexError = false;
for (const { element, data } of items) {
try {
const show = itemPassesFilters(data, filters);
element.style.display = show ? "" : "none";
if (show) visibleCount++;
} catch (e) {
if (e.code === "REGEX_ERROR") {
hasRegexError = true;
// Hide all elements when the regex is invalid
for (const { element: el } of items) {
el.style.display = "none";
}
if (widgets.regexError) {
widgets.regexError.setLabel(`${e.message}`);
}
console.log("Regex error in filter:", e.message);
break;
} else {
throw e;
}
}
}
if (widgets.regexError) {
widgets.regexError.$element.css("display", hasRegexError ? "" : "none");
}
let text;
if (visibleCount === items.length) {
text = `Showing all ${items.length} items`;
} else {
text = `Showing ${visibleCount} of ${items.length} items`;
}
widgets.statsLabel.setLabel(text);
}
function resetFilters() {
widgets.nsSelector?.setValue([]);
widgets.tagSelector?.setValue([]);
widgets.excludeTagSelector?.setValue([]);
widgets.userSelector?.setValue([]);
widgets.minorSelect?.setValue("all");
widgets.summaryInput?.setValue("");
widgets.regexToggle?.setValue(false);
applyFilters();
}
function init() {
mw.loader.using(["oojs-ui-core", "oojs-ui-widgets"], () => {
initializeData();
createUI();
applyFilters();
});
}
$(init);
})();
// </nowiki>