Candypedia - User contributions [en]

MediaWiki:Gadget-FormattingFixer.js

2026-01-06T01:16:49Z

Maintenance script: Change WikiEditor icons to articleCheck and code

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true (characters, locations)
chapters: {}, // chapter title -> true (always link, case-sensitive)
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
// Chapters are stored separately - they're always linked (not just first occurrence)
// and matching is case-sensitive
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.chapters[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section.
// Simplified regex to match "Relationships", "Major Relationships", "Minor Relationships" more robustly.
var isRelationships = sectionStack.some(function(section) {
// Matches: "Relationships", "Major Relationships", "Minor Relationships" (case insensitive)
return /^(Major|Minor)?\s*Relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Helper: Check if an index in body is on a header line (line-based, not position-based)
// This is more reliable than isInsideSectionHeader after body has been modified
function isOnHeaderLine(text, idx) {
// Find the line containing this index
var lineStart = text.lastIndexOf('\n', idx - 1) + 1;
var lineEnd = text.indexOf('\n', idx);
if (lineEnd === -1) lineEnd = text.length;
var line = text.substring(lineStart, lineEnd);
// Check if this line is a section header (== ... ==)
return /^={2,}[^=].*={2,}\s*$/.test(line);
}

// Chapter Pass: Link ALL occurrences of chapter titles (case-sensitive, exact match)
// Unlike characters which only get first occurrence linked, chapters are always linked.
var chapterTitles = Object.keys(database.chapters).sort(function(a, b) {
return b.length - a.length; // Longer titles first to avoid partial matches
});

chapterTitles.forEach(function(chapter) {
// Case-sensitive, exact word boundary match
var escapedChapter = chapter.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var chapterPattern = new RegExp('\\b(' + escapedChapter + ')\\b', 'g');

var newBody = '';
var lastIndex = 0;
var chapterMatch;

while ((chapterMatch = chapterPattern.exec(body)) !== null) {
// Skip if on a header line
if (isOnHeaderLine(body, chapterMatch.index)) continue;

// Skip if in See also section
var absPos = firstSectionIdx + chapterMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, chapterMatch.index - 50), chapterMatch.index);
var after = body.substring(chapterMatch.index, Math.min(body.length, chapterMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

// Link this occurrence
var captured = chapterMatch[1];
var replacement = '[[' + captured + ']]';

newBody += body.substring(lastIndex, chapterMatch.index) + replacement;
lastIndex = chapterMatch.index + chapterMatch[0].length;
fixes.push('Linked chapter "' + chapter + '"');
}

if (lastIndex > 0) {
body = newBody + body.substring(lastIndex);
}
});

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
// Skip if on a header line (use line-based detection, not position-based)
if (isOnHeaderLine(body, termMatch.index)) continue;

// Skip if in See also section (position-based is OK here since wikitext hasn't changed)
var absPos = firstSectionIdx + termMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers, See also, or chapters
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
// Use line-based detection since body has been modified.
if (isOnHeaderLine(body, dupMatch.index)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
var absPos = firstSectionIdx + dupMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

// Don't deduplicate chapter links - chapters should ALWAYS be linked
if (database.chapters[target]) {
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'articleCheck',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'code',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');

console.log('FormattingFixer: Initializing, action=' + action);

// VisualEditor integration removed - Parsoid causes too many issues with references and formatting

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();
// Force update timestamp: Mon Jan 5 19:24:00 EST 2026

MediaWiki:Gadget-FormattingFixer.js

2026-01-06T00:26:08Z

Maintenance script: Remove VisualEditor integration (Parsoid issues), change Fix All icon to check

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true (characters, locations)
chapters: {}, // chapter title -> true (always link, case-sensitive)
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
// Chapters are stored separately - they're always linked (not just first occurrence)
// and matching is case-sensitive
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.chapters[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section.
// Simplified regex to match "Relationships", "Major Relationships", "Minor Relationships" more robustly.
var isRelationships = sectionStack.some(function(section) {
// Matches: "Relationships", "Major Relationships", "Minor Relationships" (case insensitive)
return /^(Major|Minor)?\s*Relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Helper: Check if an index in body is on a header line (line-based, not position-based)
// This is more reliable than isInsideSectionHeader after body has been modified
function isOnHeaderLine(text, idx) {
// Find the line containing this index
var lineStart = text.lastIndexOf('\n', idx - 1) + 1;
var lineEnd = text.indexOf('\n', idx);
if (lineEnd === -1) lineEnd = text.length;
var line = text.substring(lineStart, lineEnd);
// Check if this line is a section header (== ... ==)
return /^={2,}[^=].*={2,}\s*$/.test(line);
}

// Chapter Pass: Link ALL occurrences of chapter titles (case-sensitive, exact match)
// Unlike characters which only get first occurrence linked, chapters are always linked.
var chapterTitles = Object.keys(database.chapters).sort(function(a, b) {
return b.length - a.length; // Longer titles first to avoid partial matches
});

chapterTitles.forEach(function(chapter) {
// Case-sensitive, exact word boundary match
var escapedChapter = chapter.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var chapterPattern = new RegExp('\\b(' + escapedChapter + ')\\b', 'g');

var newBody = '';
var lastIndex = 0;
var chapterMatch;

while ((chapterMatch = chapterPattern.exec(body)) !== null) {
// Skip if on a header line
if (isOnHeaderLine(body, chapterMatch.index)) continue;

// Skip if in See also section
var absPos = firstSectionIdx + chapterMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, chapterMatch.index - 50), chapterMatch.index);
var after = body.substring(chapterMatch.index, Math.min(body.length, chapterMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

// Link this occurrence
var captured = chapterMatch[1];
var replacement = '[[' + captured + ']]';

newBody += body.substring(lastIndex, chapterMatch.index) + replacement;
lastIndex = chapterMatch.index + chapterMatch[0].length;
fixes.push('Linked chapter "' + chapter + '"');
}

if (lastIndex > 0) {
body = newBody + body.substring(lastIndex);
}
});

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
// Skip if on a header line (use line-based detection, not position-based)
if (isOnHeaderLine(body, termMatch.index)) continue;

// Skip if in See also section (position-based is OK here since wikitext hasn't changed)
var absPos = firstSectionIdx + termMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers, See also, or chapters
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
// Use line-based detection since body has been modified.
if (isOnHeaderLine(body, dupMatch.index)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
var absPos = firstSectionIdx + dupMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

// Don't deduplicate chapter links - chapters should ALWAYS be linked
if (database.chapters[target]) {
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');

console.log('FormattingFixer: Initializing, action=' + action);

// VisualEditor integration removed - Parsoid causes too many issues with references and formatting

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();
// Force update timestamp: Mon Jan 5 19:24:00 EST 2026

MediaWiki:Gadget-FormattingFixer.js

2026-01-06T00:14:09Z

Maintenance script: Chapters always linked (case-sensitive), characters first occurrence only

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true (characters, locations)
chapters: {}, // chapter title -> true (always link, case-sensitive)
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
// Chapters are stored separately - they're always linked (not just first occurrence)
// and matching is case-sensitive
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.chapters[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section.
// Simplified regex to match "Relationships", "Major Relationships", "Minor Relationships" more robustly.
var isRelationships = sectionStack.some(function(section) {
// Matches: "Relationships", "Major Relationships", "Minor Relationships" (case insensitive)
return /^(Major|Minor)?\s*Relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Helper: Check if an index in body is on a header line (line-based, not position-based)
// This is more reliable than isInsideSectionHeader after body has been modified
function isOnHeaderLine(text, idx) {
// Find the line containing this index
var lineStart = text.lastIndexOf('\n', idx - 1) + 1;
var lineEnd = text.indexOf('\n', idx);
if (lineEnd === -1) lineEnd = text.length;
var line = text.substring(lineStart, lineEnd);
// Check if this line is a section header (== ... ==)
return /^={2,}[^=].*={2,}\s*$/.test(line);
}

// Chapter Pass: Link ALL occurrences of chapter titles (case-sensitive, exact match)
// Unlike characters which only get first occurrence linked, chapters are always linked.
var chapterTitles = Object.keys(database.chapters).sort(function(a, b) {
return b.length - a.length; // Longer titles first to avoid partial matches
});

chapterTitles.forEach(function(chapter) {
// Case-sensitive, exact word boundary match
var escapedChapter = chapter.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var chapterPattern = new RegExp('\\b(' + escapedChapter + ')\\b', 'g');

var newBody = '';
var lastIndex = 0;
var chapterMatch;

while ((chapterMatch = chapterPattern.exec(body)) !== null) {
// Skip if on a header line
if (isOnHeaderLine(body, chapterMatch.index)) continue;

// Skip if in See also section
var absPos = firstSectionIdx + chapterMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, chapterMatch.index - 50), chapterMatch.index);
var after = body.substring(chapterMatch.index, Math.min(body.length, chapterMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

// Link this occurrence
var captured = chapterMatch[1];
var replacement = '[[' + captured + ']]';

newBody += body.substring(lastIndex, chapterMatch.index) + replacement;
lastIndex = chapterMatch.index + chapterMatch[0].length;
fixes.push('Linked chapter "' + chapter + '"');
}

if (lastIndex > 0) {
body = newBody + body.substring(lastIndex);
}
});

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
// Skip if on a header line (use line-based detection, not position-based)
if (isOnHeaderLine(body, termMatch.index)) continue;

// Skip if in See also section (position-based is OK here since wikitext hasn't changed)
var absPos = firstSectionIdx + termMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers, See also, or chapters
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
// Use line-based detection since body has been modified.
if (isOnHeaderLine(body, dupMatch.index)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
var absPos = firstSectionIdx + dupMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

// Don't deduplicate chapter links - chapters should ALWAYS be linked
if (database.chapters[target]) {
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();
// Force update timestamp: Mon Jan 5 18:52:11 EST 2026

MediaWiki:Gadget-FormattingFixer.js

2026-01-06T00:04:54Z

Maintenance script: Fix: Use line-based header detection instead of position-based (fixes header links being stripped)

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section.
// Simplified regex to match "Relationships", "Major Relationships", "Minor Relationships" more robustly.
var isRelationships = sectionStack.some(function(section) {
// Matches: "Relationships", "Major Relationships", "Minor Relationships" (case insensitive)
return /^(Major|Minor)?\s*Relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Helper: Check if an index in body is on a header line (line-based, not position-based)
// This is more reliable than isInsideSectionHeader after body has been modified
function isOnHeaderLine(text, idx) {
// Find the line containing this index
var lineStart = text.lastIndexOf('\n', idx - 1) + 1;
var lineEnd = text.indexOf('\n', idx);
if (lineEnd === -1) lineEnd = text.length;
var line = text.substring(lineStart, lineEnd);
// Check if this line is a section header (== ... ==)
return /^={2,}[^=].*={2,}\s*$/.test(line);
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
// Skip if on a header line (use line-based detection, not position-based)
if (isOnHeaderLine(body, termMatch.index)) continue;

// Skip if in See also section (position-based is OK here since wikitext hasn't changed)
var absPos = firstSectionIdx + termMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
// Use line-based detection since body has been modified.
if (isOnHeaderLine(body, dupMatch.index)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
var absPos = firstSectionIdx + dupMatch.index;
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();
// Force update timestamp: Mon Jan 5 18:52:11 EST 2026

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:54:17Z

Maintenance script: Simplify Relationships regex and force update with debug logging

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section.
// Simplified regex to match "Relationships", "Major Relationships", "Minor Relationships" more robustly.
var isRelationships = sectionStack.some(function(section) {
// Matches: "Relationships", "Major Relationships", "Minor Relationships" (case insensitive)
return /^(Major|Minor)?\s*Relationships$/i.test(section.title);
});

// LOGGING: Track decision path for specific headers (debug-20250105-2)
if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Processing header "' + title + '" (Level ' + level + ')');
console.log('DEBUG: Stack before push: ' + sectionStack.map(function(s) { return s.title + '(' + s.level + ')'; }).join(' > '));
console.log('DEBUG: isRelationships=' + isRelationships);
}

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Lookup "' + titleKey + '" -> ' + canonical);
}

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Changed to ' + line);
}
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();
// Force update timestamp: Mon Jan 5 18:52:11 EST 2026

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:52:17Z

Maintenance script: Add debug logging for Relationships headers (timestamped)

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

// LOGGING: Track decision path for specific headers (debug-20250105)
if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Processing header "' + title + '"');
console.log('DEBUG: isRelationships=' + isRelationships);
console.log('DEBUG: Stack context: ' + sectionStack.map(function(s) { return s.title; }).join(' > '));
}

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Lookup "' + titleKey + '" -> ' + canonical);
}

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Changed to ' + line);
}
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();
// Force update timestamp: Mon Jan 5 18:52:11 EST 2026

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:49:43Z

Maintenance script: Debug Relationships header logic - Force Update

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

// LOGGING: Track decision path for specific headers (debug-20250105)
if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Processing header "' + title + '"');
console.log('DEBUG: isRelationships=' + isRelationships);
console.log('DEBUG: Stack context: ' + sectionStack.map(function(s) { return s.title; }).join(' > '));
}

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Lookup "' + titleKey + '" -> ' + canonical);
}

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Changed to ' + line);
}
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:47:44Z

Maintenance script: Add debug logging with timestamp to force update

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

// LOGGING: Track decision path for specific headers (debug-20250105)
if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Processing header "' + title + '"');
console.log('DEBUG: isRelationships=' + isRelationships);
console.log('DEBUG: Stack context: ' + sectionStack.map(function(s) { return s.title; }).join(' > '));
}

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Lookup "' + titleKey + '" -> ' + canonical);
}

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Changed to ' + line);
}
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:46:03Z

Maintenance script: Debug Relationships header logic

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

// LOGGING: Track decision path for specific headers
if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Processing header "' + title + '"');
console.log('DEBUG: isRelationships=' + isRelationships);
console.log('DEBUG: Stack context: ' + sectionStack.map(function(s) { return s.title; }).join(' > '));
}

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Lookup "' + titleKey + '" -> ' + canonical);
}

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');

if (/^(Jessica|Daisy|Tess|Augustus)$/i.test(title)) {
console.log('DEBUG: Changed to ' + line);
}
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:41:05Z

Maintenance script: Fix Relationships header linkify: case-insensitive canonical lookup

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// Case-insensitive lookup tables for header linkification.
// Some pages may have headings like "=== jessica ===" or extra whitespace.
// We normalize to lowercase and resolve to the canonical page title.
var targetsByLower = {};
for (var t in database.targets) {
if (database.targets.hasOwnProperty(t)) {
targetsByLower[t.toLowerCase()] = t;
}
}
var aliasesByLower = {};
for (var a in database.aliases) {
if (database.aliases.hasOwnProperty(a)) {
aliasesByLower[a.toLowerCase()] = database.aliases[a];
}
}

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a known target/alias.
// Use case-insensitive lookup so "jessica" resolves to "Jessica".
var titleKey = title.toLowerCase();
var canonical = targetsByLower[titleKey] || aliasesByLower[titleKey] || null;

// Only link if known target/alias and not already linked.
// Use canonical title in the link to ensure proper capitalization.
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + canonical + ']] ' + headerMatch[1];
fixes.push('Linked "' + canonical + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:31:05Z

Maintenance script: Fix self-linking on own page, fix single-bracket detection

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Get current page title to prevent self-linking
var currentPageTitle = '';
if (typeof mw !== 'undefined' && mw.config) {
currentPageTitle = mw.config.get('wgTitle') || '';
}

// Track which canonical targets have been linked
var linked = {};

// Mark current page as already linked to prevent self-linking
if (currentPageTitle) {
linked[currentPageTitle] = true;
}

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link or inside single brackets (e.g., [Augustus] in quotes)
// Check for [[ ]] (wikilinks) or [ ] (single brackets used in prose)
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
// Skip if inside wikilink [[ ... ]]
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;
// Skip if inside single brackets [ ... ] (common in prose like "[Augustus] said")
if (/\[[^\[\]]*$/.test(before) && /^[^\[\]]*\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:22:20Z

Maintenance script: Fix: Header links no longer prevent first body occurrence from being linked

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link (simple heuristic: look for surrounding [[ ]])
// This isn't perfect but handles simple cases where we might match inside a pipelink display text
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, and DON'T mark them as seen.
// Header links (e.g., === [[Augustus]] ===) are independent from body links.
// The first body occurrence should still be linked even if a header link exists.
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also, but DO mark them as seen.
// If a name appears in See also, we don't want to link it again in the body.
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:16:23Z

Maintenance script: Fix auto-linking logic to ensure first instance is linked, update documentation

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Link Consistency: Ensures the FIRST occurrence of a term in the body (or Relationships header) is linked.
* If a later occurrence was manually linked but the first was not, it links the first and unlinks the later one.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
/*
* PASS REMOVED: We no longer pre-mark existing links.
* Instead, we let the Third Pass link the FIRST occurrence of a term.
* The Fourth Pass (deduplication) will then clean up any subsequent links,
* ensuring the first occurrence is always the one that is linked.
*/

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link (simple heuristic: look for surrounding [[ ]])
// This isn't perfect but handles simple cases where we might match inside a pipelink display text
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;
var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

// Don't touch links in section headers, but DO mark them as seen
if (isInsideSectionHeader(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

// Don't touch links in See also, but DO mark them as seen
if (isInSeeAlsoSection(wikitext, absPos)) {
seenLinks[canonical] = true;
continue;
}

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T23:04:27Z

Maintenance script: Update documentation and comments

/**
* FormattingFixer for MediaWiki
*
* A comprehensive tool for standardizing citations and auto-linking content in wikitext.
* Designed to work seamlessly with both VisualEditor (VE) and the classic WikiEditor.
*
* KEY FEATURES:
*
* 1. CITATION STANDARDIZATION
* - Reorders references: Ensures definitions (<ref name="x">...</ref>) appear before reuses (<ref name="x" />).
* - Standardizes formats: Converts raw chapter URLs into {{Cite chapter|url=...}} templates.
* - Validates URLs: Checks that chapter URLs follow the /cXX/pXX pattern.
* - Renames References: Smartly renames generic ref names (e.g., ":0") to chapter-based names (e.g., "c37p15").
* - Fixes Undefined Refs: Identifies used but undefined references.
*
* 2. INTELLIGENT AUTO-LINKING
* - Database: Dynamically fetches link targets from Category:Characters, Category:Locations, and Template:ChapterList.
* - Alias Support: Respects manual aliases defined in Template:LinkifyAliases.
* - Smart Exclusions:
* - Skips the "Intro" section (text before the first section header) to preserve manual formatting and Infoboxes.
* - Skips the "See also" section to avoid modifying list items.
* - Ignores text already inside links ([[...]]) or section headers (== ... ==).
* - Relationships Logic: Specifically targets headers under "Relationships", "Major relationships",
* or "Minor relationships" sections (e.g., === Jessica ===) to auto-link character names,
* respecting the section hierarchy via a stack-based linear scan.
*
* 3. CONTENT PRESERVATION (VisualEditor)
* - Implements a "Split-Process-Merge" strategy for VisualEditor to prevent Parsoid corruption.
* - The Intro section (containing the Infobox and lead paragraph) is DETACHED before processing.
* - Only the body content is round-tripped through Parsoid for linking.
* - The original, untouched Intro is re-attached to the processed body at the end.
* - This guarantees that complex Infobox formatting (linebreaks) and lead text are preserved exactly.
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link (simple heuristic: look for surrounding [[ ]])
// This isn't perfect but handles simple cases where we might match inside a pipelink display text
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T22:54:20Z

Maintenance script: Update Relationships header logic to check full ancestor stack & add comments

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*
* Logic:
* 1. Find the last "See also" header before the position.
* 2. Check if there are any other headers between that "See also" and the position.
* 3. If we find a header of the same level (e.g. == See also == ... == References ==)
* or higher level (e.g. === See also === ... == Next Section ==), we are no longer in "See also".
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link (simple heuristic: look for surrounding [[ ]])
// This isn't perfect but handles simple cases where we might match inside a pipelink display text
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*
* Strategy:
* 1. Access the document's internal list of reference groups
* 2. Iterate through all refs in the "mwReference" group
* 3. extracting the raw wikitext content from the "mw" attribute or node content
* 4. Apply fixes (like wrapping raw URLs in {{Cite chapter}})
* 5. Create a transaction to update the "mw" attribute with the new content
* 6. Apply all transactions to the surface
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T22:52:39Z

Maintenance script: Improve Relationships header linking (nested support) and add code comments

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section hierarchy
// Scan up the stack to find if any ancestor is a "Relationships" section
var isRelationships = sectionStack.some(function(section) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(section.title);
});

if (isRelationships) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link (simple heuristic: look for surrounding [[ ]])
// This isn't perfect but handles simple cases where we might match inside a pipelink display text
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T22:51:20Z

Maintenance script: Add comments and finalize Relationships header linking logic

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section
// The parent is the last item in the stack (if any)
// e.g. "== Major relationships ==" (level 2) is parent of "=== Jessica ===" (level 3)
var parent = sectionStack.length > 0 ? sectionStack[sectionStack.length - 1] : null;

// We want to link sub-headers under "Relationships", "Major relationships", or "Minor relationships"
// Case-insensitive match for flexibility
var isRelationships = parent && /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(parent.title);

if (isRelationships && level > parent.level) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
// This prevents us from linking "Rachel" if "[[Rachel]]" is already present later in the text
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
// We scan for each term individually to ensure we find the FIRST instance in the text
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

// Escape regex special chars and look for whole word match
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
// Allow "Rachel's" to match "Rachel"
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link (simple heuristic: look for surrounding [[ ]])
// This isn't perfect but handles simple cases where we might match inside a pipelink display text
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
// Preserve display text if it differs from canonical (e.g. alias or possessive)
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T22:49:51Z

Maintenance script: Fix Relationships header linking with linear scan, add comments

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process section headers linearly to handle Relationships linking
// This avoids complex regex lookbacks and handles nesting correctly via a stack
// Section stack tracks current section level and title to determine if we are inside a "Relationships" hierarchy
var lines = body.split('\n');
var newLines = [];
var sectionStack = []; // Array of { level: number, title: string }

for (var i = 0; i < lines.length; i++) {
var line = lines[i];
var headerMatch = /^(={2,})\s*([^=]+?)\s*\1\s*$/.exec(line);

if (headerMatch) {
var level = headerMatch[1].length;
var title = headerMatch[2].trim();

// Update stack: pop anything >= current level (since we are starting a new section at 'level')
// e.g. if stack is [2, 3] and we see a level 2 header, we pop 3 and 2.
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

// Check if we are inside a Relationships section
// The parent is the last item in the stack (if any)
// e.g. "== Major relationships ==" (level 2) is parent of "=== Jessica ===" (level 3)
var parent = sectionStack.length > 0 ? sectionStack[sectionStack.length - 1] : null;

// We want to link sub-headers under "Relationships", "Major relationships", or "Minor relationships"
// Case-insensitive match for flexibility
var isRelationships = parent && /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(parent.title);

if (isRelationships && level > parent.level) {
// Check if title is a target or alias
var canonical = database.targets[title] ? title : (database.aliases[title] || null);

// Only link if known target/alias and not already linked
if (canonical && !/\[\[/.test(line)) {
line = headerMatch[1] + ' [[' + title + ']] ' + headerMatch[1];
fixes.push('Linked "' + title + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
newLines.push(line);
}
body = newLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T22:20:41Z

Maintenance script: Fix Relationships header linking bug, remove infobox restoration code

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process Relationships section headers - always link character names there
// Collect all matches first, then process backwards to preserve indices
var relationshipsSections = /^(===+)\s*([^=]+?)\s*\1\s*$/gm;
var relMatch;
var headerMatches = [];
while ((relMatch = relationshipsSections.exec(body)) !== null) {
headerMatches.push({
fullMatch: relMatch[0],
equals: relMatch[1],
title: relMatch[2].trim(),
index: relMatch.index
});
}

// Process backwards to preserve indices when modifying
for (var h = headerMatches.length - 1; h >= 0; h--) {
var hdr = headerMatches[h];
var headerPos = firstSectionIdx + hdr.index;
var parents = getParentSections(wikitext, headerPos);

// Check if parent is Relationships, Major relationships, or Minor relationships
var inRelationships = parents.some(function(p) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(p);
});

if (inRelationships && database.targets[hdr.title]) {
// This header should be linked if it's a plain character name
if (!/\[\[/.test(hdr.fullMatch)) {
var newHeader = hdr.equals + ' [[' + hdr.title + ']] ' + hdr.equals;
body = body.substring(0, hdr.index) + newHeader + body.substring(hdr.index + hdr.fullMatch.length);
fixes.push('Linked "' + hdr.title + '" in Relationships header');
}
}
}

// Second pass: Find all existing links (not in headers) and mark as "linked"
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T22:02:19Z

Maintenance script: Fix infobox preservation by applying combined wikitext in VE source mode; fix Relationships header auto-linking

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process Relationships subsection headers - always link character names there
// Do this line-by-line to avoid regex exec index issues when mutating the body string.
var bodyLines = body.split('\n');
var sectionStack = [];
for (var li = 0; li < bodyLines.length; li++) {
var line = bodyLines[li];
var headingMatch = /^(==+)\s*([^=]+?)\s*\1\s*$/.exec(line);
if (headingMatch) {
var level = headingMatch[1].length;
var title = headingMatch[2].trim();
while (sectionStack.length > 0 && sectionStack[sectionStack.length - 1].level >= level) {
sectionStack.pop();
}

var parentTitle = sectionStack.length > 0 ? sectionStack[sectionStack.length - 1].title : '';
var inRelationships = /^(Major\s+)?relationships$|^minor\s+relationships$|^relationships$/i.test(parentTitle);
if (inRelationships && level >= 3) {
var headerTitle = title;
var canonical = database.targets[headerTitle] ? headerTitle : (database.aliases[headerTitle] || null);
if (canonical && !/\[\[/.test(line)) {
bodyLines[li] = headingMatch[1] + ' [[' + canonical + ']] ' + headingMatch[1];
fixes.push('Linked "' + headerTitle + '" in Relationships header');
}
}

sectionStack.push({ level: level, title: title });
}
}
body = bodyLines.join('\n');

// Second pass: Find all existing links (not in headers) and mark as "linked"
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Restore linebreaks to collapsed infoboxes.
* Parsoid may collapse {{Infobox ...|param=val|param2=val2}} onto one line.
* This function expands them back to one parameter per line.
*/
function restoreInfoboxLinebreaks(wikitext) {
var lines = wikitext.split('\n');
var result = [];

for (var lineIdx = 0; lineIdx < lines.length; lineIdx++) {
var line = lines[lineIdx];

// Check if this line contains a collapsed infobox (starts with {{Infobox and has multiple | on same line)
if (/^\{\{[Ii]nfobox[^}]*\|[^}]*\|/.test(line) && !/\n/.test(line)) {
// This looks like a collapsed infobox - expand it
var expanded = expandInfobox(line);
result.push(expanded);
} else {
result.push(line);
}
}

return result.join('\n');
}

/**
* Expand a single-line infobox into multi-line format
*/
function expandInfobox(line) {
// Find the infobox template name
var match = /^\{\{([^|]+)/.exec(line);
if (!match) return line;

var templateName = match[1];
var rest = line.substring(match[0].length);

// Parse parameters respecting nested braces/brackets
var params = [];
var depth = 0;
var currentParam = '';

for (var i = 0; i < rest.length; i++) {
var char = rest[i];
var nextChar = rest[i + 1] || '';

if (char === '{' && nextChar === '{') {
depth++;
currentParam += char;
} else if (char === '}' && nextChar === '}') {
if (depth > 0) {
depth--;
currentParam += char;
} else {
// End of template
if (currentParam.trim()) {
params.push(currentParam.trim());
}
break;
}
} else if (char === '[' && nextChar === '[') {
depth++;
currentParam += char;
} else if (char === ']' && nextChar === ']') {
depth--;
currentParam += char;
} else if (char === '|' && depth === 0) {
if (currentParam.trim()) {
params.push(currentParam.trim());
}
currentParam = '';
} else {
currentParam += char;
}
}

// Build expanded infobox
var expanded = '{{' + templateName + '\n';
for (var p = 0; p < params.length; p++) {
expanded += '| ' + params[p] + '\n';
}
expanded += '}}';

return expanded;
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// To preserve infobox/intro formatting, apply finalWikitext in source mode
veEnsureSourceMode().then( function () {
var sourceSurface = veGetSurface();
if ( !sourceSurface ) {
showResultMessage( result );
return;
}
veReplaceAllWikitextInSourceSurface( sourceSurface, finalWikitext );
result.fixes.push( 'Applied changes in source mode to preserve infobox formatting' );
showResultMessage( result );
}, function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Extract the intro section (between infobox/start and first == heading)
*/
function extractIntroSection( wikitext ) {
var firstHeading = /^==[^=]/m.exec( wikitext );
if ( !firstHeading ) return { text: '', start: 0, end: 0 };

var introEnd = firstHeading.index;
var introStart = 0;

// Skip past any infobox at the start
var infoboxMatch = /^\{\{[Ii]nfobox[\s\S]*?\}\}\s*/m.exec( wikitext );
if ( infoboxMatch && infoboxMatch.index === 0 ) {
introStart = infoboxMatch[0].length;
}

return {
text: wikitext.substring( introStart, introEnd ),
start: introStart,
end: introEnd
};
}

/**
* Extract all infoboxes with their original formatting
*/
function extractInfoboxes( wikitext ) {
var infoboxes = [];
var pattern = /\{\{[Ii]nfobox[\s\S]*?\}\}/g;
var match;
while ( ( match = pattern.exec( wikitext ) ) !== null ) {
infoboxes.push( {
text: match[0],
index: match.index
} );
}
return infoboxes;
}

/**
* Restore the intro section if Parsoid deleted it
*/
function restoreIntroSection( wikitext, originalIntro, processedWikitext ) {
if ( !originalIntro.text.trim() ) return wikitext;

// Get what the intro SHOULD be from the processed wikitext
var processedIntro = extractIntroSection( processedWikitext );
if ( !processedIntro.text.trim() ) return wikitext;

// Check if current wikitext has the intro
var currentIntro = extractIntroSection( wikitext );

// If the intro is missing or substantially shorter, restore it
if ( currentIntro.text.trim().length < processedIntro.text.trim().length * 0.5 ) {
// Find where to insert the intro (after infobox, before first heading)
var insertPoint = currentIntro.start;
var firstHeading = /^==[^=]/m.exec( wikitext );
if ( firstHeading ) {
// Insert the processed intro before the first heading
return wikitext.substring( 0, firstHeading.index ) +
processedIntro.text +
wikitext.substring( firstHeading.index );
}
}

return wikitext;
}

/**
* Restore original infobox structure if Parsoid collapsed parameters
*/
function restoreInfoboxStructure( wikitext, originalInfoboxes ) {
if ( originalInfoboxes.length === 0 ) return wikitext;

// For each infobox in current wikitext, try to restore original formatting
var pattern = /\{\{[Ii]nfobox[^}]*\}\}/g;
var match;
var offset = 0;

while ( ( match = pattern.exec( wikitext ) ) !== null ) {
var currentInfobox = match[0];

// Find matching original infobox by type
var typeMatch = /\{\{([Ii]nfobox[^|}\n]*)/i.exec( currentInfobox );
if ( !typeMatch ) continue;
var type = typeMatch[1].toLowerCase().trim();

for ( var i = 0; i < originalInfoboxes.length; i++ ) {
var origTypeMatch = /\{\{([Ii]nfobox[^|}\n]*)/i.exec( originalInfoboxes[i].text );
if ( !origTypeMatch ) continue;
var origType = origTypeMatch[1].toLowerCase().trim();

if ( type === origType && originalInfoboxes[i].text.indexOf( '\n' ) !== -1 ) {
// Original was multi-line, restore it
var pos = match.index + offset;
wikitext = wikitext.substring( 0, pos ) +
originalInfoboxes[i].text +
wikitext.substring( pos + currentInfobox.length );
offset += originalInfoboxes[i].text.length - currentInfobox.length;
break;
}
}
}

return wikitext;
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup,
restoreInfoboxLinebreaks: restoreInfoboxLinebreaks
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T21:47:11Z

Maintenance script: Fix intro preservation: split at first header, only Parsoid the body; toast 4/8s

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process Relationships section headers - always link character names there
var relationshipsSections = /^(===+)\s*([^=]+?)\s*\1\s*$/gm;
var relMatch;
var headerLinksAdded = {};
while ((relMatch = relationshipsSections.exec(body)) !== null) {
var headerTitle = relMatch[2].trim();
var headerPos = firstSectionIdx + relMatch.index;
var parents = getParentSections(wikitext, headerPos);

// Check if parent is Relationships, Major relationships, or Minor relationships
var inRelationships = parents.some(function(p) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(p);
});

if (inRelationships && database.targets[headerTitle]) {
// This header should be linked if it's a plain character name
if (!/\[\[/.test(relMatch[0])) {
var newHeader = relMatch[1] + ' [[' + headerTitle + ']] ' + relMatch[1];
body = body.substring(0, relMatch.index) + newHeader + body.substring(relMatch.index + relMatch[0].length);
headerLinksAdded[headerTitle] = true;
fixes.push('Linked "' + headerTitle + '" in Relationships header');
// Don't count this as "first link" for body text
}
}
}

// Second pass: Find all existing links (not in headers) and mark as "linked"
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Restore linebreaks to collapsed infoboxes.
* Parsoid may collapse {{Infobox ...|param=val|param2=val2}} onto one line.
* This function expands them back to one parameter per line.
*/
function restoreInfoboxLinebreaks(wikitext) {
var lines = wikitext.split('\n');
var result = [];

for (var lineIdx = 0; lineIdx < lines.length; lineIdx++) {
var line = lines[lineIdx];

// Check if this line contains a collapsed infobox (starts with {{Infobox and has multiple | on same line)
if (/^\{\{[Ii]nfobox[^}]*\|[^}]*\|/.test(line) && !/\n/.test(line)) {
// This looks like a collapsed infobox - expand it
var expanded = expandInfobox(line);
result.push(expanded);
} else {
result.push(line);
}
}

return result.join('\n');
}

/**
* Expand a single-line infobox into multi-line format
*/
function expandInfobox(line) {
// Find the infobox template name
var match = /^\{\{([^|]+)/.exec(line);
if (!match) return line;

var templateName = match[1];
var rest = line.substring(match[0].length);

// Parse parameters respecting nested braces/brackets
var params = [];
var depth = 0;
var currentParam = '';

for (var i = 0; i < rest.length; i++) {
var char = rest[i];
var nextChar = rest[i + 1] || '';

if (char === '{' && nextChar === '{') {
depth++;
currentParam += char;
} else if (char === '}' && nextChar === '}') {
if (depth > 0) {
depth--;
currentParam += char;
} else {
// End of template
if (currentParam.trim()) {
params.push(currentParam.trim());
}
break;
}
} else if (char === '[' && nextChar === '[') {
depth++;
currentParam += char;
} else if (char === ']' && nextChar === ']') {
depth--;
currentParam += char;
} else if (char === '|' && depth === 0) {
if (currentParam.trim()) {
params.push(currentParam.trim());
}
currentParam = '';
} else {
currentParam += char;
}
}

// Build expanded infobox
var expanded = '{{' + templateName + '\n';
for (var p = 0; p < params.length; p++) {
expanded += '| ' + params[p] + '\n';
}
expanded += '}}';

return expanded;
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 4 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 8000 : 4000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, split intro from body to protect intro from Parsoid
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Split at first section header - intro stays untouched, only body goes through Parsoid
var firstHeaderMatch = /^==[^=]/m.exec( originalWikitext );
var introSection = '';
var bodySection = originalWikitext;

if ( firstHeaderMatch ) {
introSection = originalWikitext.substring( 0, firstHeaderMatch.index );
bodySection = originalWikitext.substring( firstHeaderMatch.index );
}

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Split the processed result the same way
var processedFirstHeader = /^==[^=]/m.exec( result.wikitext );
var processedBody = result.wikitext;
if ( processedFirstHeader ) {
processedBody = result.wikitext.substring( processedFirstHeader.index );
}

// Only send the BODY through Parsoid, not the intro
veCreateDmDocumentFromWikitext( processedBody, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid processes body, prepend the original intro unchanged
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidBody ) {
// Combine: original intro (unchanged) + Parsoid-processed body
var finalWikitext = introSection + parsoidBody;

// Apply this combined result
veCreateDmDocumentFromWikitext( finalWikitext, surface.getModel().getDocument() ).then( function ( finalDoc ) {
veReplaceAllContentWithDocument( surface, finalDoc );
showResultMessage( result );
} ).fail( function () {
showResultMessage( result );
} );
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Extract the intro section (between infobox/start and first == heading)
*/
function extractIntroSection( wikitext ) {
var firstHeading = /^==[^=]/m.exec( wikitext );
if ( !firstHeading ) return { text: '', start: 0, end: 0 };

var introEnd = firstHeading.index;
var introStart = 0;

// Skip past any infobox at the start
var infoboxMatch = /^\{\{[Ii]nfobox[\s\S]*?\}\}\s*/m.exec( wikitext );
if ( infoboxMatch && infoboxMatch.index === 0 ) {
introStart = infoboxMatch[0].length;
}

return {
text: wikitext.substring( introStart, introEnd ),
start: introStart,
end: introEnd
};
}

/**
* Extract all infoboxes with their original formatting
*/
function extractInfoboxes( wikitext ) {
var infoboxes = [];
var pattern = /\{\{[Ii]nfobox[\s\S]*?\}\}/g;
var match;
while ( ( match = pattern.exec( wikitext ) ) !== null ) {
infoboxes.push( {
text: match[0],
index: match.index
} );
}
return infoboxes;
}

/**
* Restore the intro section if Parsoid deleted it
*/
function restoreIntroSection( wikitext, originalIntro, processedWikitext ) {
if ( !originalIntro.text.trim() ) return wikitext;

// Get what the intro SHOULD be from the processed wikitext
var processedIntro = extractIntroSection( processedWikitext );
if ( !processedIntro.text.trim() ) return wikitext;

// Check if current wikitext has the intro
var currentIntro = extractIntroSection( wikitext );

// If the intro is missing or substantially shorter, restore it
if ( currentIntro.text.trim().length < processedIntro.text.trim().length * 0.5 ) {
// Find where to insert the intro (after infobox, before first heading)
var insertPoint = currentIntro.start;
var firstHeading = /^==[^=]/m.exec( wikitext );
if ( firstHeading ) {
// Insert the processed intro before the first heading
return wikitext.substring( 0, firstHeading.index ) +
processedIntro.text +
wikitext.substring( firstHeading.index );
}
}

return wikitext;
}

/**
* Restore original infobox structure if Parsoid collapsed parameters
*/
function restoreInfoboxStructure( wikitext, originalInfoboxes ) {
if ( originalInfoboxes.length === 0 ) return wikitext;

// For each infobox in current wikitext, try to restore original formatting
var pattern = /\{\{[Ii]nfobox[^}]*\}\}/g;
var match;
var offset = 0;

while ( ( match = pattern.exec( wikitext ) ) !== null ) {
var currentInfobox = match[0];

// Find matching original infobox by type
var typeMatch = /\{\{([Ii]nfobox[^|}\n]*)/i.exec( currentInfobox );
if ( !typeMatch ) continue;
var type = typeMatch[1].toLowerCase().trim();

for ( var i = 0; i < originalInfoboxes.length; i++ ) {
var origTypeMatch = /\{\{([Ii]nfobox[^|}\n]*)/i.exec( originalInfoboxes[i].text );
if ( !origTypeMatch ) continue;
var origType = origTypeMatch[1].toLowerCase().trim();

if ( type === origType && originalInfoboxes[i].text.indexOf( '\n' ) !== -1 ) {
// Original was multi-line, restore it
var pos = match.index + offset;
wikitext = wikitext.substring( 0, pos ) +
originalInfoboxes[i].text +
wikitext.substring( pos + currentInfobox.length );
offset += originalInfoboxes[i].text.length - currentInfobox.length;
break;
}
}
}

return wikitext;
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup,
restoreInfoboxLinebreaks: restoreInfoboxLinebreaks
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T21:35:52Z

Maintenance script: Bug fixes: intro preservation, infobox restoration, ref renaming, See also/header exceptions, Relationships auto-link, toast auto-hide

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Rename refs that have non-chapter-style names to proper chapter-based names.
* E.g., name=":0" with a chapter URL should become name="c32p7"
*/
function renameNonChapterStyleRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];
var renames = {}; // oldName -> newName mapping for updating reuses

// Pattern for non-chapter-style names (like :0, :1, etc. or random strings)
var nonChapterPattern = /^:[0-9]+$|^[^c]|^c[^0-9]/;

// Process definitions that have non-chapter-style names but contain chapter URLs
var defsToRename = refs.definitions.filter(function(def) {
if (!nonChapterPattern.test(def.name)) return false;
var url = extractUrl(def.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; }); // Process from end to preserve indices

defsToRename.forEach(function(def) {
var url = extractUrl(def.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Skip if already has proper name
if (def.name === baseName) return;

// Ensure unique name
var newName = baseName;
var suffix = 2;
while (usedNames.has(newName)) {
newName = baseName + '_' + suffix;
suffix++;
}
usedNames.add(newName);
renames[def.name] = newName;

// Replace the ref definition with new name
var newRef = '<ref name="' + newName + '">' + def.content + '</ref>';
wikitext = wikitext.substring(0, def.index) + newRef + wikitext.substring(def.index + def.fullMatch.length);
fixes.push('Renamed ref "' + def.name + '" to "' + newName + '"');
});

// Now update all reuses of renamed refs
for (var oldName in renames) {
var newName = renames[oldName];
// Match both <ref name="oldName" /> and <ref name="oldName"/> (with or without space)
var reusePattern = new RegExp('<ref\\s+name\\s*=\\s*["\']' + oldName.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '["\']\\s*/>', 'gi');
wikitext = wikitext.replace(reusePattern, '<ref name="' + newName + '" />');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the index where the first section heading starts
*/
function findFirstSectionIndex(wikitext) {
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
return sectionMatch ? sectionMatch.index : -1;
}

/**
* Check if a position is inside a section header (== ... ==)
*/
function isInsideSectionHeader(wikitext, position) {
// Find the line containing this position
var lineStart = wikitext.lastIndexOf('\n', position) + 1;
var lineEnd = wikitext.indexOf('\n', position);
if (lineEnd === -1) lineEnd = wikitext.length;
var line = wikitext.substring(lineStart, lineEnd);
return /^=+[^=]+=+\s*$/.test(line);
}

/**
* Check if position is within a "See also" section (until next same-level or higher heading)
*/
function isInSeeAlsoSection(wikitext, position) {
// Find all section headings before this position
var beforeText = wikitext.substring(0, position);
var seeAlsoPattern = /^(==+)\s*See\s+also\s*\1\s*$/gim;
var lastSeeAlso = null;
var match;
while ((match = seeAlsoPattern.exec(beforeText)) !== null) {
lastSeeAlso = { index: match.index, level: match[1].length };
}
if (!lastSeeAlso) return false;

// Check if there's a same-level or higher heading between See also and position
var afterSeeAlso = wikitext.substring(lastSeeAlso.index);
var nextHeadingPattern = /^(==+)\s*[^=]+\s*\1\s*$/gim;
nextHeadingPattern.lastIndex = 0; // Skip the See also heading itself
var firstMatch = true;
while ((match = nextHeadingPattern.exec(afterSeeAlso)) !== null) {
if (firstMatch) { firstMatch = false; continue; } // Skip See also itself
var headingLevel = match[1].length;
var absolutePos = lastSeeAlso.index + match.index;
if (absolutePos < position && headingLevel <= lastSeeAlso.level) {
return false; // We've left the See also section
}
if (absolutePos >= position) break;
}
return true;
}

/**
* Get the parent section context for a position (for Relationships detection)
*/
function getParentSections(wikitext, position) {
var sections = [];
var headingPattern = /^(==+)\s*([^=]+?)\s*\1\s*$/gm;
var match;
var stack = [];

while ((match = headingPattern.exec(wikitext)) !== null) {
if (match.index >= position) break;
var level = match[1].length;
var title = match[2].trim();

// Pop sections that are same level or higher
while (stack.length > 0 && stack[stack.length - 1].level >= level) {
stack.pop();
}
stack.push({ level: level, title: title });
}

return stack.map(function(s) { return s.title; });
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];

// Find where the first section starts - everything before is intro (don't touch)
var firstSectionIdx = findFirstSectionIndex(wikitext);
if (firstSectionIdx === -1) {
// No sections at all - don't linkify anything
return { wikitext: wikitext, fixes: [] };
}

var intro = wikitext.substring(0, firstSectionIdx);
var body = wikitext.substring(firstSectionIdx);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}
for (var alias in database.aliases) {
if (!database.targets[alias]) {
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First: Process Relationships section headers - always link character names there
var relationshipsSections = /^(===+)\s*([^=]+?)\s*\1\s*$/gm;
var relMatch;
var headerLinksAdded = {};
while ((relMatch = relationshipsSections.exec(body)) !== null) {
var headerTitle = relMatch[2].trim();
var headerPos = firstSectionIdx + relMatch.index;
var parents = getParentSections(wikitext, headerPos);

// Check if parent is Relationships, Major relationships, or Minor relationships
var inRelationships = parents.some(function(p) {
return /^(Major\s+)?[Rr]elationships$|^Minor\s+relationships$/i.test(p);
});

if (inRelationships && database.targets[headerTitle]) {
// This header should be linked if it's a plain character name
if (!/\[\[/.test(relMatch[0])) {
var newHeader = relMatch[1] + ' [[' + headerTitle + ']] ' + relMatch[1];
body = body.substring(0, relMatch.index) + newHeader + body.substring(relMatch.index + relMatch[0].length);
headerLinksAdded[headerTitle] = true;
fixes.push('Linked "' + headerTitle + '" in Relationships header');
// Don't count this as "first link" for body text
}
}
}

// Second pass: Find all existing links (not in headers) and mark as "linked"
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + match.index;
// Skip links in section headers
if (isInsideSectionHeader(wikitext, absPos)) continue;
// Skip links in See also
if (isInSeeAlsoSection(wikitext, absPos)) continue;

var linkTarget = match[1].trim();
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Third pass: Add links for unlinked terms (first occurrence only, respecting exclusions)
allTerms.forEach(function(item) {
if (linked[item.canonical]) return;

var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var termPattern = new RegExp('\\b(' + escapedTerm + "(?:'s)?)\\b", 'g');

var found = false;
var newBody = '';
var lastIndex = 0;
var termMatch;

while ((termMatch = termPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + termMatch.index;

// Skip if inside a section header
if (isInsideSectionHeader(wikitext, absPos)) continue;

// Skip if in See also section
if (isInSeeAlsoSection(wikitext, absPos)) continue;

// Skip if already inside a link
var before = body.substring(Math.max(0, termMatch.index - 50), termMatch.index);
var after = body.substring(termMatch.index, Math.min(body.length, termMatch.index + 50));
if (/\[\[[^\]]*$/.test(before) && /^[^\[]*\]\]/.test(after)) continue;

if (!found) {
found = true;
linked[item.canonical] = true;

var captured = termMatch[1];
var replacement;
if (item.display || captured !== item.canonical) {
replacement = '[[' + item.canonical + '|' + captured + ']]';
} else {
replacement = '[[' + captured + ']]';
}

newBody += body.substring(lastIndex, termMatch.index) + replacement;
lastIndex = termMatch.index + termMatch[0].length;
fixes.push('Linked first instance of "' + item.term + '"');
}
}

if (found) {
body = newBody + body.substring(lastIndex);
}
});

// Fourth pass: Remove duplicate links (keep first, remove subsequent) - but NOT in headers or See also
var seenLinks = {};
var dupPattern = /\[\[([^\]|]+)(\|([^\]]+))?\]\]/g;
var newBody = '';
var lastIdx = 0;
var dupMatch;

while ((dupMatch = dupPattern.exec(body)) !== null) {
var absPos = firstSectionIdx + dupMatch.index;

// Don't touch links in section headers
if (isInsideSectionHeader(wikitext, absPos)) {
continue;
}

// Don't touch links in See also
if (isInSeeAlsoSection(wikitext, absPos)) {
continue;
}

var target = dupMatch[1].trim();
var canonical = database.aliases[target] || target;

if (seenLinks[canonical]) {
// Duplicate - remove link, keep text
var text = dupMatch[3] || target;
newBody += body.substring(lastIdx, dupMatch.index) + text;
lastIdx = dupMatch.index + dupMatch[0].length;
fixes.push('Removed duplicate link to "' + target + '"');
} else {
seenLinks[canonical] = true;
}
}
body = newBody + body.substring(lastIdx);

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Restore linebreaks to collapsed infoboxes.
* Parsoid may collapse {{Infobox ...|param=val|param2=val2}} onto one line.
* This function expands them back to one parameter per line.
*/
function restoreInfoboxLinebreaks(wikitext) {
var lines = wikitext.split('\n');
var result = [];

for (var lineIdx = 0; lineIdx < lines.length; lineIdx++) {
var line = lines[lineIdx];

// Check if this line contains a collapsed infobox (starts with {{Infobox and has multiple | on same line)
if (/^\{\{[Ii]nfobox[^}]*\|[^}]*\|/.test(line) && !/\n/.test(line)) {
// This looks like a collapsed infobox - expand it
var expanded = expandInfobox(line);
result.push(expanded);
} else {
result.push(line);
}
}

return result.join('\n');
}

/**
* Expand a single-line infobox into multi-line format
*/
function expandInfobox(line) {
// Find the infobox template name
var match = /^\{\{([^|]+)/.exec(line);
if (!match) return line;

var templateName = match[1];
var rest = line.substring(match[0].length);

// Parse parameters respecting nested braces/brackets
var params = [];
var depth = 0;
var currentParam = '';

for (var i = 0; i < rest.length; i++) {
var char = rest[i];
var nextChar = rest[i + 1] || '';

if (char === '{' && nextChar === '{') {
depth++;
currentParam += char;
} else if (char === '}' && nextChar === '}') {
if (depth > 0) {
depth--;
currentParam += char;
} else {
// End of template
if (currentParam.trim()) {
params.push(currentParam.trim());
}
break;
}
} else if (char === '[' && nextChar === '[') {
depth++;
currentParam += char;
} else if (char === ']' && nextChar === ']') {
depth--;
currentParam += char;
} else if (char === '|' && depth === 0) {
if (currentParam.trim()) {
params.push(currentParam.trim());
}
currentParam = '';
} else {
currentParam += char;
}
}

// Build expanded infobox
var expanded = '{{' + templateName + '\n';
for (var p = 0; p < params.length; p++) {
expanded += '| ' + params[p] + '\n';
}
expanded += '}}';

return expanded;
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 5.5. Rename refs with non-chapter-style names (like :0) to proper chapter-based names
var renameResult = renameNonChapterStyleRefs(wikitext, refs);
if (renameResult.fixes.length > 0) {
wikitext = renameResult.wikitext;
fixes = fixes.concat(renameResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
// Auto-hide after 8 seconds (longer if there are warnings)
var hideDelay = result.warnings.length > 0 ? 12000 : 8000;
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: true,
autoHideSeconds: hideDelay / 1000,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, use Parsoid but post-process to restore formatting
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( originalWikitext ) {

// Save original intro and infobox for restoration after Parsoid
var originalIntro = extractIntroSection( originalWikitext );
var originalInfoboxes = extractInfoboxes( originalWikitext );

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === originalWikitext ) {
showResultMessage( result );
return;
}

// Parse new wikitext through Parsoid
veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid, restore any mangled sections
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( parsoidWikitext ) {
var fixed = parsoidWikitext;
var restorations = [];

// Restore intro section if it was deleted/changed
fixed = restoreIntroSection( fixed, originalIntro, result.wikitext );
if ( fixed !== parsoidWikitext ) {
restorations.push( 'Restored intro paragraph' );
}

// Restore infobox formatting
var afterIntro = fixed;
fixed = restoreInfoboxLinebreaks( fixed );
if ( fixed !== afterIntro ) {
restorations.push( 'Restored infobox formatting' );
}

// Restore original infobox structure if Parsoid mangled it
fixed = restoreInfoboxStructure( fixed, originalInfoboxes );

if ( fixed !== parsoidWikitext ) {
veCreateDmDocumentFromWikitext( fixed, surface.getModel().getDocument() ).then( function ( fixedDoc ) {
veReplaceAllContentWithDocument( surface, fixedDoc );
result.fixes = result.fixes.concat( restorations );
showResultMessage( result );
} ).fail( function () {
// If restoration fails, still show original results
showResultMessage( result );
} );
} else {
showResultMessage( result );
}
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( originalWikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( originalWikitext ).then( applyResult );
} else {
applyResult( fixCitations( originalWikitext ) );
}
} );
}

/**
* Extract the intro section (between infobox/start and first == heading)
*/
function extractIntroSection( wikitext ) {
var firstHeading = /^==[^=]/m.exec( wikitext );
if ( !firstHeading ) return { text: '', start: 0, end: 0 };

var introEnd = firstHeading.index;
var introStart = 0;

// Skip past any infobox at the start
var infoboxMatch = /^\{\{[Ii]nfobox[\s\S]*?\}\}\s*/m.exec( wikitext );
if ( infoboxMatch && infoboxMatch.index === 0 ) {
introStart = infoboxMatch[0].length;
}

return {
text: wikitext.substring( introStart, introEnd ),
start: introStart,
end: introEnd
};
}

/**
* Extract all infoboxes with their original formatting
*/
function extractInfoboxes( wikitext ) {
var infoboxes = [];
var pattern = /\{\{[Ii]nfobox[\s\S]*?\}\}/g;
var match;
while ( ( match = pattern.exec( wikitext ) ) !== null ) {
infoboxes.push( {
text: match[0],
index: match.index
} );
}
return infoboxes;
}

/**
* Restore the intro section if Parsoid deleted it
*/
function restoreIntroSection( wikitext, originalIntro, processedWikitext ) {
if ( !originalIntro.text.trim() ) return wikitext;

// Get what the intro SHOULD be from the processed wikitext
var processedIntro = extractIntroSection( processedWikitext );
if ( !processedIntro.text.trim() ) return wikitext;

// Check if current wikitext has the intro
var currentIntro = extractIntroSection( wikitext );

// If the intro is missing or substantially shorter, restore it
if ( currentIntro.text.trim().length < processedIntro.text.trim().length * 0.5 ) {
// Find where to insert the intro (after infobox, before first heading)
var insertPoint = currentIntro.start;
var firstHeading = /^==[^=]/m.exec( wikitext );
if ( firstHeading ) {
// Insert the processed intro before the first heading
return wikitext.substring( 0, firstHeading.index ) +
processedIntro.text +
wikitext.substring( firstHeading.index );
}
}

return wikitext;
}

/**
* Restore original infobox structure if Parsoid collapsed parameters
*/
function restoreInfoboxStructure( wikitext, originalInfoboxes ) {
if ( originalInfoboxes.length === 0 ) return wikitext;

// For each infobox in current wikitext, try to restore original formatting
var pattern = /\{\{[Ii]nfobox[^}]*\}\}/g;
var match;
var offset = 0;

while ( ( match = pattern.exec( wikitext ) ) !== null ) {
var currentInfobox = match[0];

// Find matching original infobox by type
var typeMatch = /\{\{([Ii]nfobox[^|}\n]*)/i.exec( currentInfobox );
if ( !typeMatch ) continue;
var type = typeMatch[1].toLowerCase().trim();

for ( var i = 0; i < originalInfoboxes.length; i++ ) {
var origTypeMatch = /\{\{([Ii]nfobox[^|}\n]*)/i.exec( originalInfoboxes[i].text );
if ( !origTypeMatch ) continue;
var origType = origTypeMatch[1].toLowerCase().trim();

if ( type === origType && originalInfoboxes[i].text.indexOf( '\n' ) !== -1 ) {
// Original was multi-line, restore it
var pos = match.index + offset;
wikitext = wikitext.substring( 0, pos ) +
originalInfoboxes[i].text +
wikitext.substring( pos + currentInfobox.length );
offset += originalInfoboxes[i].text.length - currentInfobox.length;
break;
}
}
}

return wikitext;
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup,
restoreInfoboxLinebreaks: restoreInfoboxLinebreaks
};

})();

Template:LinkifyAliases

2026-01-05T11:00:35Z

Maintenance script: Create linkify aliases template for FormattingFixer gadget

Mike's mom,Mike's mother->Ellen
Lucy's dad->Sam
Lucy's mom->Jordan



aquarium,the aquarium->Roseville Aquarium
fishy place->Roseville Aquarium

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T11:00:20Z

Maintenance script: Auto Add Links: formatting cleanup, linkify from categories/templates, aliases support

/**
* FormattingFixer for MediaWiki
*
* Fixes common reference citation issues in wikitext:
* - Reorders refs so definitions come before reuses
* - Standardizes chapter URLs to {{Cite chapter|url=...}} format
* - Detects and helps fix undefined named refs
* - Validates chapter URL format (must have /cXX/pXX)
*
* Works with:
* - VisualEditor (both visual and source modes)
* - WikiEditor (legacy source editor)
*
* Installation:
* 1. Copy this code to MediaWiki:Gadget-FormattingFixer.js
* 2. Add to MediaWiki:Gadgets-definition:
* * FormattingFixer[ResourceLoader|default]|Gadget-FormattingFixer.js
* 3. All users get it by default; can disable in Special:Preferences > Gadgets
*/
(function() {
'use strict';

// Configuration - adjust this pattern if your wiki uses a different URL structure
var config = {
chapterUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)\/p(\d+)/,
chapterUrlLoose: /https?:\/\/www\.bittersweetcandybowl\.com\/c(\d+(?:\.\d+)?)(\/(p\d+)?)?/,
siteUrlPattern: /https?:\/\/www\.bittersweetcandybowl\.com\//
};

// Guard to prevent duplicate WikiEditor buttons
var wikiEditorButtonsAdded = false;

/**
* Parse all references from wikitext
*/
function parseRefs(wikitext) {
var refs = {
definitions: [], // <ref name="X">content</ref>
reuses: [], // <ref name="X" />
anonymous: [] // <ref>content</ref>
};

// Match named refs with content: <ref name="X">content</ref>
var defined_refPattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*>([\s\S]*?)<\/ref>/gi;
var match;
while ((match = defined_refPattern.exec(wikitext)) !== null) {
refs.definitions.push({
fullMatch: match[0],
name: match[1],
content: match[2],
index: match.index
});
}

// Match named refs without content (reuses): <ref name="X" />
var reusePattern = /<ref\s+name\s*=\s*["']([^"']+)["']\s*\/>/gi;
while ((match = reusePattern.exec(wikitext)) !== null) {
refs.reuses.push({
fullMatch: match[0],
name: match[1],
index: match.index
});
}

// Match anonymous refs: <ref>content</ref>
// Need to be careful not to match named refs
var anonPattern = /<ref\s*>([\s\S]*?)<\/ref>/gi;
while ((match = anonPattern.exec(wikitext)) !== null) {
// Double-check it's not a named ref that our pattern somehow caught
if (!/<ref\s+name\s*=/.test(match[0])) {
refs.anonymous.push({
fullMatch: match[0],
content: match[1],
index: match.index
});
}
}

return refs;
}

/**
* Generate a ref name from a chapter URL (e.g., :c37p15 or :c37_1p15 for decimals)
*/
function generateRefName(url) {
var match = config.chapterUrlPattern.exec(url);
if (!match) return null;
var chapter = match[1];
var page = match[2];
// Replace decimal with underscore for valid ref names (37.1 -> 37_1)
var safeChapter = chapter.replace('.', '_');
return ':c' + safeChapter + 'p' + page;
}

/**
* Extract URL from ref content
*/
function extractUrl(content) {
// Try {{Cite chapter|url=...}} format first
var citeMatch = /\{\{Cite\s*chapter\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (citeMatch) {
return citeMatch[1];
}

// Try {{Cite web|url=...}} format
var webMatch = /\{\{Cite\s*web\s*\|\s*url\s*=\s*([^\s\}\|]+)/i.exec(content);
if (webMatch) {
return webMatch[1];
}

// Try raw URL
var urlMatch = /(https?:\/\/[^\s\}<]+)/.exec(content);
if (urlMatch) {
return urlMatch[1];
}

return null;
}

/**
* Format a URL as proper citation - ONLY for chapter URLs
*/
function formatCitation(url) {
if (!url) return null;

// Only convert chapter URLs (must match /cXX/pXX pattern)
if (config.chapterUrlPattern.test(url)) {
return '{{Cite chapter|url=' + url + '}}';
}

// All other URLs are left unchanged
return url;
}

/**
* Validate a chapter URL has proper format
*/
function validateChapterUrl(url) {
if (!url) return { valid: false, error: 'No URL found' };

var looseMatch = config.chapterUrlLoose.exec(url);
if (!looseMatch) {
return { valid: true, error: null }; // Not a chapter URL, skip validation
}

// It's a chapter URL - check if it has /pXX
if (!looseMatch[2]) {
return {
valid: false,
error: 'Chapter URL missing page number: ' + url + ' (needs /pXX)'
};
}

return { valid: true, error: null };
}

/**
* Find order issues - refs used before they're defined
*/
function findOrderIssues(refs) {
var issues = [];
var definitionsByName = {};

// Index definitions by name
refs.definitions.forEach(function(def) {
if (!definitionsByName[def.name]) {
definitionsByName[def.name] = def;
}
});

// Check each reuse
refs.reuses.forEach(function(reuse) {
var def = definitionsByName[reuse.name];
if (def && reuse.index < def.index) {
issues.push({
name: reuse.name,
reuseIndex: reuse.index,
definitionIndex: def.index,
definition: def,
reuse: reuse
});
}
});

return issues;
}

/**
* Find undefined refs - names used but never defined
*/
function findUndefinedRefs(refs) {
var definedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var undefinedRefs = [];

refs.reuses.forEach(function(reuse) {
if (!definedNames.has(reuse.name)) {
// Check if we already logged this name
if (!undefinedRefs.some(function(u) { return u.name === reuse.name; })) {
undefinedRefs.push({
name: reuse.name,
usages: refs.reuses.filter(function(r) { return r.name === reuse.name; })
});
}
}
});

return undefinedRefs;
}

/**
* Find anonymous refs that could match undefined names
*/
function findPotentialMatches(refs, undefinedRefs) {
var matches = [];

undefinedRefs.forEach(function(undef) {
refs.anonymous.forEach(function(anon) {
var url = extractUrl(anon.content);
if (url) {
matches.push({
undefinedName: undef.name,
anonymousRef: anon,
url: url
});
}
});
});

return matches;
}

/**
* Assign chapter-based names to anonymous refs with chapter URLs
*/
function assignNamesToAnonymousRefs(wikitext, refs) {
var usedNames = new Set(refs.definitions.map(function(d) { return d.name; }));
var fixes = [];

// Sort by index descending to preserve positions when replacing
var anonsToName = refs.anonymous.filter(function(anon) {
var url = extractUrl(anon.content);
return url && config.chapterUrlPattern.test(url);
}).sort(function(a, b) { return b.index - a.index; });

anonsToName.forEach(function(anon) {
var url = extractUrl(anon.content);
var baseName = generateRefName(url);
if (!baseName) return;

// Ensure unique name
var name = baseName;
var suffix = 2;
while (usedNames.has(name)) {
name = baseName + '_' + suffix;
suffix++;
}
usedNames.add(name);

// Replace anonymous ref with named ref
var namedRef = '<ref name="' + name + '">' + anon.content + '</ref>';
wikitext = wikitext.substring(0, anon.index) + namedRef + wikitext.substring(anon.index + anon.fullMatch.length);
fixes.push('Named anonymous ref as "' + name + '"');
});

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fix order issues in wikitext
*/
function fixOrderIssues(wikitext, issues) {
if (issues.length === 0) return wikitext;

// Sort issues by definition index descending (fix from end to preserve indices)
issues.sort(function(a, b) { return b.definitionIndex - a.definitionIndex; });

issues.forEach(function(issue) {
// Strategy:
// 1. Replace the definition with a reuse
// 2. Replace the first reuse with the definition

var def = issue.definition;
var reuse = issue.reuse;

// Build the replacement strings
var reuseStr = '<ref name="' + def.name + '" />';
var defStr = '<ref name="' + def.name + '">' + def.content + '</ref>';

// Replace definition with reuse (do this first since it's later in the text)
wikitext = wikitext.substring(0, def.index) +
reuseStr +
wikitext.substring(def.index + def.fullMatch.length);

// Now replace the reuse with definition
// Need to recalculate position since we changed the text
var offset = reuseStr.length - def.fullMatch.length;
var newReuseIndex = reuse.index; // reuse is before def, so no offset needed

wikitext = wikitext.substring(0, newReuseIndex) +
defStr +
wikitext.substring(newReuseIndex + reuse.fullMatch.length);
});

return wikitext;
}

/**
* Standardize citation format - ONLY for chapter URLs
*/
function standardizeCitations(wikitext) {
// Find all refs with raw URLs (not in Cite templates)
var refPattern = /<ref(\s+name\s*=\s*["'][^"']+["'])?\s*>([\s\S]*?)<\/ref>/gi;

wikitext = wikitext.replace(refPattern, function(match, nameAttr, content) {
nameAttr = nameAttr || '';

// Check if content is just a raw URL
var trimmedContent = content.trim();

// Skip if already in Cite template
if (/\{\{Cite/i.test(trimmedContent)) {
return match;
}

// Only process if it's a chapter URL (matches /cXX/pXX)
if (config.chapterUrlPattern.test(trimmedContent)) {
var formatted = formatCitation(trimmedContent);
return '<ref' + nameAttr + '>' + formatted + '</ref>';
}

return match;
});

return wikitext;
}

// ========================================
// Auto Add Links - Formatting & Linkify
// ========================================

/**
* Cache for linkify database (fetched from wiki)
*/
var linkifyCache = null;
var linkifyCacheTime = 0;
var LINKIFY_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

/**
* Apply formatting cleanup to wikitext
*/
function applyFormattingCleanup(wikitext) {
var fixes = [];
var original = wikitext;

// Step 1: Trim whitespace from start and end
wikitext = wikitext.trim();

// Step 2: Delete trailing spaces from lines
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/\s+$/, '');
}).join('\n');

// Step 3: Replace multiple spaces with single space (within lines)
wikitext = wikitext.split('\n').map(function(line) {
return line.replace(/ {2,}/g, ' ');
}).join('\n');

// Step 3.5: Replace ** markdown bold with ''' wikitext bold
if (/\*\*/.test(wikitext)) {
wikitext = wikitext.replace(/\*\*/g, "'''");
fixes.push('Converted markdown bold to wikitext bold');
}

// Ensure single space after </ref> if not at end of line
wikitext = wikitext.replace(/<\/ref>(?![\s\n]|$)/g, '</ref> ');

// Remove any double spaces that might have been created
wikitext = wikitext.replace(/ {2,}/g, ' ');

if (wikitext !== original) {
fixes.push('Applied formatting cleanup');
}

return { wikitext: wikitext, fixes: fixes };
}

/**
* Fetch the linkify database from wiki categories and templates
*/
function fetchLinkifyDatabase() {
var deferred = $.Deferred();

// Check cache
if (linkifyCache && (Date.now() - linkifyCacheTime < LINKIFY_CACHE_TTL)) {
return deferred.resolve(linkifyCache).promise();
}

var database = {
targets: {}, // canonical name -> true
aliases: {}, // alias -> canonical name
displayText: {} // search term -> { target: canonical, display: text }
};

var apiCalls = [];

// Fetch Category:Characters
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Characters',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Category:Locations
apiCalls.push(
new mw.Api().get({
action: 'query',
list: 'categorymembers',
cmtitle: 'Category:Locations',
cmlimit: 500,
format: 'json'
}).then(function(data) {
if (data.query && data.query.categorymembers) {
data.query.categorymembers.forEach(function(member) {
database.targets[member.title] = true;
});
}
})
);

// Fetch Template:ChapterList content
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:ChapterList',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse {{Chapter|number=X|title=Y|...}} entries
var chapterPattern = /\{\{Chapter\|[^}]*title=([^|}]+)/gi;
var match;
while ((match = chapterPattern.exec(content)) !== null) {
var title = match[1].trim();
database.targets[title] = true;
}
}
}
}
})
);

// Fetch Template:LinkifyAliases for custom mappings
apiCalls.push(
new mw.Api().get({
action: 'query',
titles: 'Template:LinkifyAliases',
prop: 'revisions',
rvprop: 'content',
rvslots: 'main',
format: 'json'
}).then(function(data) {
var pages = data.query && data.query.pages;
if (pages) {
for (var pageId in pages) {
var page = pages[pageId];
if (page.revisions && page.revisions[0]) {
var content = page.revisions[0].slots.main['*'];
// Parse alias definitions
// Format: alias1,alias2->CanonicalName
// Or: displayText->CanonicalName (for piped links)
var lines = content.split('\n');
lines.forEach(function(line) {
line = line.trim();
if (!line || line.startsWith('<!--') || line.startsWith('{{') || line.startsWith('}}')) return;

var arrowMatch = line.match(/^([^-]+)->(.+)$/);
if (arrowMatch) {
var aliases = arrowMatch[1].split(',').map(function(s) { return s.trim(); });
var target = arrowMatch[2].trim();
aliases.forEach(function(alias) {
database.aliases[alias] = target;
database.aliases[alias.toLowerCase()] = target;
});
}
});
}
}
}
}).fail(function() {
// Template doesn't exist yet, that's fine
})
);

$.when.apply($, apiCalls).always(function() {
linkifyCache = database;
linkifyCacheTime = Date.now();
deferred.resolve(database);
});

return deferred.promise();
}

/**
* Find the start of the "body" content (after intro/infobox)
*/
function findBodyStart(wikitext) {
// Look for first section heading
var sectionMatch = /^==\s*[^=]+\s*==/m.exec(wikitext);
if (sectionMatch) {
return sectionMatch.index;
}

// No sections - look for end of first infobox
var infoboxMatch = /\{\{[Ii]nfobox[\s\S]*?\}\}/m.exec(wikitext);
if (infoboxMatch) {
return infoboxMatch.index + infoboxMatch[0].length;
}

// No infobox either - just skip the first paragraph
var firstParaEnd = wikitext.indexOf('\n\n');
if (firstParaEnd > 0) {
return firstParaEnd;
}

return 0;
}

/**
* Apply linkify logic to wikitext
*/
function applyLinkify(wikitext, database) {
var fixes = [];
var bodyStart = findBodyStart(wikitext);

var intro = wikitext.substring(0, bodyStart);
var body = wikitext.substring(bodyStart);

// Track which canonical targets have been linked
var linked = {};

// Build a combined list of all searchable terms
var allTerms = [];

// Add canonical targets
for (var target in database.targets) {
allTerms.push({ term: target, canonical: target, display: null });
}

// Add aliases
for (var alias in database.aliases) {
if (!database.targets[alias]) { // Don't duplicate
allTerms.push({ term: alias, canonical: database.aliases[alias], display: alias });
}
}

// Sort by length (longest first) to match longer phrases before shorter ones
allTerms.sort(function(a, b) { return b.term.length - a.term.length; });

// First pass: Find all existing links and mark their targets as "linked"
var existingLinkPattern = /\[\[([^\]|]+)(?:\|[^\]]+)?\]\]/g;
var match;
while ((match = existingLinkPattern.exec(body)) !== null) {
var linkTarget = match[1].trim();
// Check if this is a known target or alias
if (database.targets[linkTarget]) {
linked[linkTarget] = true;
} else if (database.aliases[linkTarget]) {
linked[database.aliases[linkTarget]] = true;
}
}

// Second pass: Add links for unlinked terms (first occurrence only)
allTerms.forEach(function(item) {
if (linked[item.canonical]) return; // Already linked

// Build regex to find the term (word boundaries, case-sensitive for proper names)
var escapedTerm = item.term.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
var termPattern = new RegExp('(?<!\\[\\[)\\b(' + escapedTerm + "(?:'s)?)\\b(?![^\\[]*\\]\\])", 'g');

var found = false;
body = body.replace(termPattern, function(match, captured, offset) {
if (found) return match; // Only link first occurrence
found = true;
linked[item.canonical] = true;

if (item.display || captured !== item.canonical) {
// Need piped link
return '[[' + item.canonical + '|' + captured + ']]';
} else {
return '[[' + captured + ']]';
}
});

if (found) {
fixes.push('Linked first instance of "' + item.term + '"');
}
});

// Third pass: Remove duplicate links (keep first, remove subsequent)
var seenLinks = {};
body = body.replace(/\[\[([^\]|]+)(\|[^\]]+)?\]\]/g, function(match, target, display) {
var canonical = database.aliases[target] || target;
if (seenLinks[canonical]) {
// This is a duplicate - remove the link, keep the text
var text = display ? display.substring(1) : target;
fixes.push('Removed duplicate link to "' + target + '"');
return text;
}
seenLinks[canonical] = true;
return match;
});

return {
wikitext: intro + body,
fixes: fixes
};
}

/**
* Auto-add links - main function
*/
function autoAddLinks(wikitext) {
var deferred = $.Deferred();
var allFixes = [];
var warnings = [];

// Step 1: Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Step 2: Fetch linkify database and apply
fetchLinkifyDatabase().then(function(database) {
var targetCount = Object.keys(database.targets).length;
var aliasCount = Object.keys(database.aliases).length;

if (targetCount === 0) {
warnings.push('No linkify targets found. Create Category:Characters, Category:Locations, or Template:ChapterList.');
} else {
var linkResult = applyLinkify(wikitext, database);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
}

deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
}).fail(function() {
warnings.push('Could not fetch linkify database. Formatting cleanup was still applied.');
deferred.resolve({
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
});
});

return deferred.promise();
}

/**
* Synchronous version of autoAddLinks for source mode (uses cached database)
*/
function autoAddLinksSync(wikitext) {
var allFixes = [];
var warnings = [];

// Apply formatting cleanup
var formatResult = applyFormattingCleanup(wikitext);
wikitext = formatResult.wikitext;
allFixes = allFixes.concat(formatResult.fixes);

// Use cached database if available
if (linkifyCache) {
var linkResult = applyLinkify(wikitext, linkifyCache);
wikitext = linkResult.wikitext;
allFixes = allFixes.concat(linkResult.fixes);
} else {
warnings.push('Linkify database not cached. Run Auto Add Links in Visual Editor first, or wait a moment.');
}

return {
wikitext: wikitext,
fixes: allFixes,
warnings: warnings
};
}

/**
* Run both Fix Citations and Auto Add Links (async)
*/
function fixAll(wikitext) {
var deferred = $.Deferred();

// Run Fix Citations first (sync)
var citationResult = fixCitations(wikitext);

// Then run Auto Add Links on the result (async)
autoAddLinks(citationResult.wikitext).then(function(linkResult) {
deferred.resolve({
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
});
});

return deferred.promise();
}

/**
* Synchronous version of fixAll for source mode
*/
function fixAllSync(wikitext) {
var citationResult = fixCitations(wikitext);
var linkResult = autoAddLinksSync(citationResult.wikitext);

return {
wikitext: linkResult.wikitext,
fixes: citationResult.fixes.concat(linkResult.fixes),
warnings: citationResult.warnings.concat(linkResult.warnings)
};
}

/**
* Restore linebreaks to collapsed infoboxes.
* Parsoid may collapse {{Infobox ...|param=val|param2=val2}} onto one line.
* This function expands them back to one parameter per line.
*/
function restoreInfoboxLinebreaks(wikitext) {
var lines = wikitext.split('\n');
var result = [];

for (var lineIdx = 0; lineIdx < lines.length; lineIdx++) {
var line = lines[lineIdx];

// Check if this line contains a collapsed infobox (starts with {{Infobox and has multiple | on same line)
if (/^\{\{[Ii]nfobox[^}]*\|[^}]*\|/.test(line) && !/\n/.test(line)) {
// This looks like a collapsed infobox - expand it
var expanded = expandInfobox(line);
result.push(expanded);
} else {
result.push(line);
}
}

return result.join('\n');
}

/**
* Expand a single-line infobox into multi-line format
*/
function expandInfobox(line) {
// Find the infobox template name
var match = /^\{\{([^|]+)/.exec(line);
if (!match) return line;

var templateName = match[1];
var rest = line.substring(match[0].length);

// Parse parameters respecting nested braces/brackets
var params = [];
var depth = 0;
var currentParam = '';

for (var i = 0; i < rest.length; i++) {
var char = rest[i];
var nextChar = rest[i + 1] || '';

if (char === '{' && nextChar === '{') {
depth++;
currentParam += char;
} else if (char === '}' && nextChar === '}') {
if (depth > 0) {
depth--;
currentParam += char;
} else {
// End of template
if (currentParam.trim()) {
params.push(currentParam.trim());
}
break;
}
} else if (char === '[' && nextChar === '[') {
depth++;
currentParam += char;
} else if (char === ']' && nextChar === ']') {
depth--;
currentParam += char;
} else if (char === '|' && depth === 0) {
if (currentParam.trim()) {
params.push(currentParam.trim());
}
currentParam = '';
} else {
currentParam += char;
}
}

// Build expanded infobox
var expanded = '{{' + templateName + '\n';
for (var p = 0; p < params.length; p++) {
expanded += '| ' + params[p] + '\n';
}
expanded += '}}';

return expanded;
}

/**
* Main fix function
*/
function fixCitations(wikitext) {
var issues = [];
var warnings = [];
var fixes = [];

// Parse all refs
var refs = parseRefs(wikitext);

// 1. Find and fix order issues
var orderIssues = findOrderIssues(refs);
if (orderIssues.length > 0) {
wikitext = fixOrderIssues(wikitext, orderIssues);
orderIssues.forEach(function(issue) {
fixes.push('Fixed order: "' + issue.name + '" - moved definition before first usage');
});
// Re-parse after fixes
refs = parseRefs(wikitext);
}

// 2. Standardize citation format
var before = wikitext;
wikitext = standardizeCitations(wikitext);
if (wikitext !== before) {
fixes.push('Standardized raw URLs to {{Cite chapter|url=...}} format');
refs = parseRefs(wikitext);
}

// 3. Find undefined refs
var undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
undefinedRefs.forEach(function(undef) {
warnings.push('Undefined reference: "' + undef.name + '" is used ' +
undef.usages.length + ' time(s) but never defined');
});
}

// 4. Validate chapter URLs
refs.definitions.forEach(function(def) {
var url = extractUrl(def.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in "' + def.name + '": ' + validation.error);
}
});
refs.anonymous.forEach(function(anon, i) {
var url = extractUrl(anon.content);
var validation = validateChapterUrl(url);
if (!validation.valid) {
warnings.push('Invalid URL in anonymous ref #' + (i+1) + ': ' + validation.error);
}
});

// 5. Assign names to anonymous refs with chapter URLs
var namingResult = assignNamesToAnonymousRefs(wikitext, refs);
if (namingResult.fixes.length > 0) {
wikitext = namingResult.wikitext;
fixes = fixes.concat(namingResult.fixes);
refs = parseRefs(wikitext);
}

// 6. Re-check undefined refs after naming
undefinedRefs = findUndefinedRefs(refs);
if (undefinedRefs.length > 0) {
warnings.push('');
warnings.push('=== Undefined references requiring manual attention ===');
undefinedRefs.forEach(function(undef) {
warnings.push('Reference "' + undef.name + '" is used ' + undef.usages.length + ' time(s) but never defined.');
warnings.push(' → Find the correct source and add: <ref name="' + undef.name + '">{{Cite chapter|url=...}}</ref>');
});
}

return {
wikitext: wikitext,
fixes: fixes,
warnings: warnings
};
}

/**
* Show result message using mw.notify (nicer than alert)
*/
function showResultMessage(result) {
var message = '';
if (result.fixes.length > 0) {
message += 'FIXES APPLIED:\n' + result.fixes.join('\n') + '\n\n';
}
if (result.warnings.length > 0) {
message += 'WARNINGS:\n' + result.warnings.join('\n');
}
if (result.fixes.length === 0 && result.warnings.length === 0) {
message = 'No issues found! Citations look good.';
}

// Use mw.notify for a nicer notification, fall back to alert
if (typeof mw !== 'undefined' && mw.notify) {
mw.notify(message.replace(/\n/g, '<br>'), {
title: 'FormattingFixer',
autoHide: false,
tag: 'formattingfixer'
});
} else {
alert(message);
}
}

// ========================================
// VisualEditor Integration
// ========================================

function veIsAvailable() {
return typeof ve !== 'undefined' && ve.init && ve.init.target;
}

function veGetSurface() {
if ( !veIsAvailable() ) {
return null;
}
return ve.init.target.getSurface && ve.init.target.getSurface();
}

function veGetMode() {
var surface = veGetSurface();
return surface && surface.getMode ? surface.getMode() : null;
}

function veGetFullWikitextFromSourceSurface( surface ) {
var model = surface.getModel();
var doc = model.getDocument();
var range = new ve.Range( 0, doc.data.getLength() );
return doc.data.getSourceText( range );
}

function veReplaceAllWikitextInSourceSurface( surface, newWikitext ) {
var model = surface.getModel();
model.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertContent( newWikitext );
}

function veCreateDmDocumentFromWikitext( wikitext, targetDoc ) {
return ve.init.target.parseWikitextFragment( wikitext, false, targetDoc ).then( function ( response ) {
if ( ve.getProp( response, 'visualeditor', 'result' ) !== 'success' ) {
return $.Deferred().reject( response ).promise();
}

var html = response.visualeditor.content;
var htmlDoc = ve.createDocumentFromHtml( html );

// Mirror VE's own clipboard importer flow for Parsoid HTML
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripRestbaseIds ) {
mw.libs.ve.stripRestbaseIds( htmlDoc );
}
if ( mw.libs && mw.libs.ve && mw.libs.ve.stripParsoidFallbackIds ) {
mw.libs.ve.stripParsoidFallbackIds( htmlDoc.body );
}

// Pass an empty object for importRules to enable clipboard mode
var newDoc = targetDoc.newFromHtml( htmlDoc, {} );
var data = newDoc.data.data;
var surface = new ve.dm.Surface( newDoc );

// Filter out auto-generated items (e.g. reference lists)
for ( var i = data.length - 1; i >= 0; i-- ) {
if ( ve.getProp( data[ i ], 'attributes', 'mw', 'autoGenerated' ) ) {
surface.change(
ve.dm.TransactionBuilder.static.newFromRemoval(
newDoc,
surface.getDocument().getDocumentNode().getNodeFromOffset( i + 1 ).getOuterRange()
)
);
}
}

// Avoid about attribute conflicts
newDoc.data.cloneElements( true );
return newDoc;
} );
}

function veReplaceAllContentWithDocument( uiSurface, newDoc ) {
var surfaceModel = uiSurface.getModel();
surfaceModel.getLinearFragment( new ve.Range( 0 ), true )
.expandLinearSelection( 'root' )
.insertDocument( newDoc );
}

function veEnsureSourceMode() {
var target = ve.init.target;
var surface = veGetSurface();
if ( surface && surface.getMode && surface.getMode() === 'source' ) {
return $.Deferred().resolve().promise();
}

// Switch to the VisualEditor wikitext mode. This is the only reliable
// way to apply whole-document wikitext transforms.
try {
return target.switchToWikitextEditor( true );
} catch ( e ) {
return $.Deferred().reject( e ).promise();
}
}

/**
* Process a single ref's body content and return the fixed version
*/
function processRefBody( bodyWikitext ) {
if ( !bodyWikitext ) return { changed: false, wikitext: bodyWikitext };

var trimmed = bodyWikitext.trim();

// Skip if already in Cite template
if ( /\{\{Cite/i.test( trimmed ) ) {
return { changed: false, wikitext: bodyWikitext };
}

// Only process chapter URLs (must match /cXX/pXX pattern)
if ( config.chapterUrlPattern.test( trimmed ) ) {
var formatted = '{{Cite chapter|url=' + trimmed + '}}';
return { changed: true, wikitext: formatted };
}

return { changed: false, wikitext: bodyWikitext };
}

/**
* Surgically update refs in VisualEditor without touching other content.
* This modifies ref nodes directly in VE's internal list, avoiding Parsoid round-trip.
*/
function veUpdateRefsInPlace( surface, mode ) {
var doc = surface.getModel().getDocument();
var internalList = doc.getInternalList();
var refGroups = internalList.getNodeGroups();
var fixes = [];
var warnings = [];
var transactions = [];

// Iterate through all reference groups
for ( var groupName in refGroups ) {
if ( !refGroups.hasOwnProperty( groupName ) ) continue;
if ( groupName.indexOf( 'mwReference/' ) !== 0 ) continue;

var group = refGroups[ groupName ];
var indexOrder = group.indexOrder;

for ( var i = 0; i < indexOrder.length; i++ ) {
var itemIndex = indexOrder[ i ];
var itemNode = internalList.getItemNode( itemIndex );
if ( !itemNode ) continue;

// Get the ref content node
var refContentRange = itemNode.getRange();
var refContent = doc.data.getText( refContentRange );

// Also try to get the raw mw body if available
var listNode = itemNode.children && itemNode.children[ 0 ];
if ( !listNode ) continue;

// Get the wikitext body from the mw attribute
var mwData = null;
try {
// Find the actual ref node that uses this internal list item
var nodes = group.firstNodes;
if ( nodes && nodes[ i ] ) {
var refNode = nodes[ i ];
var refNodeData = doc.data.getData( refNode.getOffset() );
if ( refNodeData && refNodeData.attributes && refNodeData.attributes.mw ) {
mwData = refNodeData.attributes.mw;
}
}
} catch ( e ) {
// Ignore errors accessing node data
}

// Get body content - try mw.body.html first, then plain text
var bodyWikitext = '';
if ( mwData && mwData.body && mwData.body.html ) {
// Parse HTML to get text content (simple case)
var tempDiv = document.createElement( 'div' );
tempDiv.innerHTML = mwData.body.html;
bodyWikitext = tempDiv.textContent || tempDiv.innerText || '';
} else {
bodyWikitext = refContent;
}

// Process this ref
var result = processRefBody( bodyWikitext );
if ( result.changed ) {
// Build a transaction to update this ref's content
// We need to update the mw attribute of the ref node
if ( mwData && group.firstNodes && group.firstNodes[ i ] ) {
var refNode = group.firstNodes[ i ];
var offset = refNode.getOffset();

// Clone mwData and update body
var newMwData = ve.copy( mwData );
newMwData.body = { html: result.wikitext };

// Create attribute change transaction
var tx = ve.dm.TransactionBuilder.static.newFromAttributeChanges(
doc,
offset,
{ mw: newMwData }
);
transactions.push( tx );
fixes.push( 'Wrapped raw URL in {{Cite chapter}}' );
}
}
}
}

// Apply all transactions
if ( transactions.length > 0 ) {
var surfaceModel = surface.getModel();
for ( var t = 0; t < transactions.length; t++ ) {
surfaceModel.change( transactions[ t ] );
}
}

// Also check for name generation on anonymous refs
// (This is harder to do surgically, so we'll just warn)
if ( mode !== 'links' ) {
// TODO: Implement surgical name assignment for anonymous refs
}

return {
fixes: fixes,
warnings: warnings,
changed: transactions.length > 0
};
}

/**
* Alternative: Use VE's built-in wikitext serialization and re-parse only changed refs
*/
function veProcessRefsViaApi( surface, processFunc ) {
var target = ve.init.target;
var doc = surface.getModel().getDocument();

return target.getWikitextFragment( doc ).then( function ( wikitext ) {
var result = processFunc( wikitext );

if ( result.wikitext === wikitext ) {
// No changes needed
showResultMessage( result );
return $.Deferred().resolve().promise();
}

// Use VE's own mechanism to apply wikitext changes
// This parses the new wikitext through the API but we're only
// changing refs, not templates, so normalization should be minimal
return veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );
showResultMessage( result );
}, function () {
// If that fails, show results and offer copy option
mw.notify( $( '<div>' ).append(
$( '<p>' ).text( 'Could not apply changes automatically.' ),
$( '<p>' ).text( 'Fixes: ' + result.fixes.join( ', ' ) ),
$( '<button>' ).text( 'Copy fixed wikitext' ).on( 'click', function () {
navigator.clipboard.writeText( result.wikitext );
mw.notify( 'Copied!' );
} )
), { autoHide: false, tag: 'formattingfixer' } );
} );
} );
}

function runFormattingFixerInVE( mode ) {
if ( !veIsAvailable() ) {
mw.notify( 'FormattingFixer: VisualEditor is not available yet.', { type: 'error' } );
return;
}

var target = ve.init.target;
var surface = veGetSurface();
if ( !surface ) {
mw.notify( 'FormattingFixer: Could not access the editor surface.', { type: 'error' } );
return;
}

var currentMode = veGetMode();

// In source mode, we can read/write directly
if ( currentMode === 'source' ) {
var sourceWikitext = veGetFullWikitextFromSourceSurface( surface );

// Use sync versions for source mode
var result;
if ( mode === 'links' ) {
result = autoAddLinksSync( sourceWikitext );
} else if ( mode === 'all' ) {
result = fixAllSync( sourceWikitext );
} else {
result = fixCitations( sourceWikitext );
}

if ( result.wikitext !== sourceWikitext ) {
veReplaceAllWikitextInSourceSurface( surface, result.wikitext );
}
showResultMessage( result );
return;
}

// In visual mode, use Parsoid but post-process to restore infobox formatting
var doc = surface.getModel().getDocument();
target.getWikitextFragment( doc ).then( function ( wikitext ) {

// Helper to apply result to VE
function applyResult( result ) {
if ( result.wikitext === wikitext ) {
showResultMessage( result );
return;
}

// Parse new wikitext through Parsoid
veCreateDmDocumentFromWikitext( result.wikitext, doc ).then( function ( newDoc ) {
veReplaceAllContentWithDocument( surface, newDoc );

// After Parsoid, get the wikitext again and fix any collapsed infoboxes
setTimeout( function () {
target.getWikitextFragment( surface.getModel().getDocument() ).then( function ( newWikitext ) {
var fixed = restoreInfoboxLinebreaks( newWikitext );
if ( fixed !== newWikitext ) {
veCreateDmDocumentFromWikitext( fixed, surface.getModel().getDocument() ).then( function ( fixedDoc ) {
veReplaceAllContentWithDocument( surface, fixedDoc );
result.fixes.push( 'Restored infobox formatting' );
showResultMessage( result );
} );
} else {
showResultMessage( result );
}
} );
}, 500 );
}, function () {
mw.notify( 'FormattingFixer: Could not apply changes. Try using source mode.', { type: 'error' } );
} );
}

// Process based on mode - some functions are async
if ( mode === 'links' ) {
autoAddLinks( wikitext ).then( applyResult );
} else if ( mode === 'all' ) {
fixAll( wikitext ).then( applyResult );
} else {
applyResult( fixCitations( wikitext ) );
}
} );
}

/**
* Add toolbar buttons to VisualEditor
*/
function addVisualEditorButtons() {
function registerTools() {
// Define and register tools. Use the documented pattern:
// register tools via ve.ui.toolFactory, and add a toolbar group
// via target.static.toolbarGroups (early) or toolbar.addItems (late).

if ( !veIsAvailable() ) {
return;
}

var toolFactory = ve.ui.toolFactory;

// Tool 1: Fix Citations
if ( !toolFactory.lookup( 'formattingFixerFix' ) ) {
function FormattingFixerFixTool() {
FormattingFixerFixTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerFixTool, OO.ui.Tool );
FormattingFixerFixTool.static.name = 'formattingFixerFix';
FormattingFixerFixTool.static.group = 'formattingfixer';
FormattingFixerFixTool.static.title = 'Fix Citations';
FormattingFixerFixTool.static.icon = 'check';
FormattingFixerFixTool.static.autoAddToCatchall = false;
FormattingFixerFixTool.static.autoAddToGroup = true;
FormattingFixerFixTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'citations' );
this.setActive( false );
};
FormattingFixerFixTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerFixTool );
}

// Tool 2: Auto Add Links
if ( !toolFactory.lookup( 'formattingFixerLinks' ) ) {
function FormattingFixerLinksTool() {
FormattingFixerLinksTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerLinksTool, OO.ui.Tool );
FormattingFixerLinksTool.static.name = 'formattingFixerLinks';
FormattingFixerLinksTool.static.group = 'formattingfixer';
FormattingFixerLinksTool.static.title = 'Auto Add Links';
FormattingFixerLinksTool.static.icon = 'link';
FormattingFixerLinksTool.static.autoAddToCatchall = false;
FormattingFixerLinksTool.static.autoAddToGroup = true;
FormattingFixerLinksTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'links' );
this.setActive( false );
};
FormattingFixerLinksTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerLinksTool );
}

// Tool 3: Fix All (Citations + Links)
if ( !toolFactory.lookup( 'formattingFixerAll' ) ) {
function FormattingFixerAllTool() {
FormattingFixerAllTool.super.apply( this, arguments );
}
OO.inheritClass( FormattingFixerAllTool, OO.ui.Tool );
FormattingFixerAllTool.static.name = 'formattingFixerAll';
FormattingFixerAllTool.static.group = 'formattingfixer';
FormattingFixerAllTool.static.title = 'Fix Citations + Auto Add Links';
FormattingFixerAllTool.static.icon = 'wikiText';
FormattingFixerAllTool.static.autoAddToCatchall = false;
FormattingFixerAllTool.static.autoAddToGroup = true;
FormattingFixerAllTool.prototype.onSelect = function () {
runFormattingFixerInVE( 'all' );
this.setActive( false );
};
FormattingFixerAllTool.prototype.onUpdateState = function () {
this.setDisabled( false );
};
toolFactory.register( FormattingFixerAllTool );
}
}

// Ensure our tool group is available in the toolbar (early-load path).
function addGroupToTarget( targetClass ) {
if ( !targetClass.static.toolbarGroups ) {
return;
}
var exists = targetClass.static.toolbarGroups.some( function ( g ) {
return g && g.name === 'formattingfixer';
} );
if ( exists ) {
return;
}

targetClass.static.toolbarGroups.push( {
name: 'formattingfixer',
label: 'FormattingFixer',
type: 'list',
indicator: 'down',
include: [ { group: 'formattingfixer' } ]
} );
}

// Preferred: integrate during VE module loading.
mw.hook( 've.loadModules' ).add( function ( addPlugin ) {
addPlugin( function () {
registerTools();
mw.loader.using( [ 'ext.visualEditor.mediawiki' ] ).then( function () {
for ( var n in ve.init.mw.targetFactory.registry ) {
addGroupToTarget( ve.init.mw.targetFactory.lookup( n ) );
}
ve.init.mw.targetFactory.on( 'register', function ( name, targetClass ) {
addGroupToTarget( targetClass );
} );
} );
} );
} );

// Fallback: if VE is already active, add a toolgroup to the existing toolbar.
mw.hook( 've.activationComplete' ).add( function () {
if ( !veIsAvailable() ) {
return;
}
registerTools();

var toolbar = ve.init.target.getToolbar && ve.init.target.getToolbar();
if ( !toolbar ) {
toolbar = ve.init.target.toolbar;
}
if ( !toolbar || toolbar.$element.find( '.formattingfixer-toolgroup' ).length ) {
return;
}

var myToolGroup = new OO.ui.ListToolGroup( toolbar, {
label: 'FormattingFixer',
include: [ 'formattingFixerFix', 'formattingFixerLinks', 'formattingFixerAll' ]
} );
myToolGroup.$element.addClass( 'formattingfixer-toolgroup' );
toolbar.addItems( [ myToolGroup ] );
} );
}

// ========================================
// WikiEditor Integration (Legacy)
// ========================================

/**
* Add toolbar button for WikiEditor
*/
function addWikiEditorButtons() {
// Guard against duplicate button creation
if (wikiEditorButtonsAdded) {
return true;
}

if (typeof $ === 'undefined' || !$.fn.wikiEditor) {
console.log('FormattingFixer: WikiEditor not available');
return false;
}

var $textarea = $('#wpTextbox1');
if ($textarea.length === 0) {
console.log('FormattingFixer: No textarea found');
return false;
}

// Check if button already exists in DOM
if ($('.tool[rel="formattingfixer-fix"]').length > 0) {
wikiEditorButtonsAdded = true;
return true;
}

try {
$textarea.wikiEditor('addToToolbar', {
section: 'advanced',
group: 'format',
tools: {
'formattingfixer-fix': {
label: 'Fix Citations',
type: 'button',
oouiIcon: 'check',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
var result = fixCitations(textarea.value);
textarea.value = result.wikitext;
showResultMessage(result);
}
}
},
'formattingfixer-links': {
label: 'Auto Add Links',
type: 'button',
oouiIcon: 'link',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
autoAddLinks(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
},
'formattingfixer-all': {
label: 'Fix Citations + Auto Add Links',
type: 'button',
oouiIcon: 'wikiText',
action: {
type: 'callback',
execute: function() {
var textarea = document.getElementById('wpTextbox1');
mw.notify('Fetching linkify database...', { tag: 'formattingfixer' });
fixAll(textarea.value).then(function(result) {
textarea.value = result.wikitext;
showResultMessage(result);
});
}
}
}
}
});
wikiEditorButtonsAdded = true;
console.log('FormattingFixer: WikiEditor buttons added');
return true;
} catch (e) {
console.log('FormattingFixer: Error adding WikiEditor buttons:', e);
return false;
}
}

// ========================================
// Fallback: Simple Buttons
// ========================================

/**
* Add simple HTML buttons as fallback
*/
function addSimpleButtons() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) return false;

// Don't attach to VisualEditor's hidden dummy textbox
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return false;
}

// Check if buttons already exist
if (document.getElementById('formattingfixer-buttons')) return true;

var container = document.createElement('div');
container.id = 'formattingfixer-buttons';
container.style.cssText = 'margin: 5px 0; padding: 8px; background: #f8f9fa; border: 1px solid #a2a9b1; border-radius: 2px; display: flex; gap: 10px; align-items: center;';

var label = document.createElement('span');
label.textContent = 'FormattingFixer:';
label.style.fontWeight = 'bold';
container.appendChild(label);

var fixBtn = document.createElement('button');
fixBtn.textContent = 'Fix Citations';
fixBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
fixBtn.type = 'button';
fixBtn.onclick = function() {
var result = fixCitations(textbox.value);
textbox.value = result.wikitext;
showResultMessage(result);
};
container.appendChild(fixBtn);

var linksBtn = document.createElement('button');
linksBtn.textContent = 'Auto Add Links';
linksBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #fff;';
linksBtn.type = 'button';
linksBtn.onclick = function() {
linksBtn.disabled = true;
linksBtn.textContent = 'Loading...';
autoAddLinks(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
linksBtn.disabled = false;
linksBtn.textContent = 'Auto Add Links';
});
};
container.appendChild(linksBtn);

var allBtn = document.createElement('button');
allBtn.textContent = 'Fix All';
allBtn.style.cssText = 'padding: 5px 10px; cursor: pointer; border: 1px solid #a2a9b1; border-radius: 2px; background: #36c; color: #fff;';
allBtn.type = 'button';
allBtn.onclick = function() {
allBtn.disabled = true;
allBtn.textContent = 'Loading...';
fixAll(textbox.value).then(function(result) {
textbox.value = result.wikitext;
showResultMessage(result);
allBtn.disabled = false;
allBtn.textContent = 'Fix All';
});
};
container.appendChild(allBtn);

textbox.parentNode.insertBefore(container, textbox);
console.log('FormattingFixer: Simple buttons added');
return true;
}

// ========================================
// Initialization
// ========================================

function init() {
var action = mw.config.get('wgAction');
var veLoaded = mw.config.get('wgVisualEditor');

console.log('FormattingFixer: Initializing, action=' + action);

// For VisualEditor
if (typeof ve !== 'undefined' || (veLoaded && veLoaded.pageLanguageDir)) {
console.log('FormattingFixer: Setting up VisualEditor hooks');
addVisualEditorButtons();
}

// Hook for when VE loads later
mw.hook('ve.activationComplete').add(function() {
console.log('FormattingFixer: VE activation complete');
addVisualEditorButtons();
});

// For source editing (action=edit without VE)
if (action === 'edit' || action === 'submit') {
// Try WikiEditor first
mw.hook('wikiEditor.toolbarReady').add(function($textarea) {
console.log('FormattingFixer: WikiEditor toolbar ready');
addWikiEditorButtons();
});

// If this is the classic source editor, try loading WikiEditor explicitly.
// (If the user doesn't have it enabled, we'll fall back to simple buttons.)
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (!textbox) {
return;
}
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}

mw.loader.using(['ext.wikiEditor']).then(function() {
addWikiEditorButtons();
}, function() {
addSimpleButtons();
});
}, 0);

// If WikiEditor isn't present, ensure the user still gets controls
// in the classic source editor.
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
if (typeof $ !== 'undefined' && $.fn && $.fn.wikiEditor) {
// WikiEditor exists but may not be initialized yet.
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 250);

// Fallback after delay
setTimeout(function() {
var textbox = document.getElementById('wpTextbox1');
if (textbox && !document.getElementById('formattingfixer-buttons')) {
if (textbox.classList && textbox.classList.contains('ve-dummyTextbox')) {
return;
}
// Check if WikiEditor toolbar exists
if ($('.wikiEditor-ui-toolbar').length > 0) {
if (!addWikiEditorButtons()) {
addSimpleButtons();
}
} else {
addSimpleButtons();
}
}
}, 1500);
}
}

// Run when ready
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function() {
mw.loader.using(['mediawiki.util']).then(init);
});
} else {
mw.loader.using(['mediawiki.util']).then(init);
}

// Expose for testing
window.FormattingFixer = {
fixCitations: fixCitations,
autoAddLinks: autoAddLinks,
autoAddLinksSync: autoAddLinksSync,
fixAll: fixAll,
fixAllSync: fixAllSync,
parseRefs: parseRefs,
generateRefName: generateRefName,
fetchLinkifyDatabase: fetchLinkifyDatabase,
applyFormattingCleanup: applyFormattingCleanup,
restoreInfoboxLinebreaks: restoreInfoboxLinebreaks
};

})();

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T10:43:44Z

Maintenance script: Parsoid with infobox linebreak restoration, preview refresh in source mode

MediaWiki:Gadget-FormattingFixer.js

2026-01-05T10:37:58Z

Maintenance script: Surgical in-place ref updates in visual mode - no more source mode switching