Module:Delink/sandbox: Difference between revisions

Content deleted Content added
sync
Synced (rip one testcase but whatever), dramatically improved efficiency of one of the regex patterns
 
(32 intermediate revisions by 11 users not shown)
Line 1:
-- This module de-links most wikitext.
 
require("strict")
p = {}
 
local p = {}
 
local getArgs
 
local function delinkReversePipeTrick(s)
if mw.ustring.s:match(s, "^%[%[|.*[|\n]") then -- Check for newlines or multiple pipes.
return s
end
else
return mw.ustring.s:match(s, "%[%[|(.*)%]%]")
 
end
end
 
local function delinkPipeTrick(s)
-- We need to deal with colons, brackets, and commas, per [[Help:Pipe trick]].
local linkarea, display = "", ""
-- First, remove the text before the first colon, if any.
-- We need to deal with colons, brackets, and commas, per [[Help:Pipe trick]].
if s:match(":") then
s = s:match("%[%[.-:(.*)|%]%]")
-- First, remove the text before the first colon, if any.
-- If there are no colons, grab all of the text apart from the square brackets and the pipe.
if mw.ustring.match(s, ":") then
else
s = mw.ustring.match(s, "%[%[.-:(.*)|%]%]")
s = s:match("%[%[(.*)|%]%]")
-- If there are no colons, grab all of the text apart from the square brackets and the pipe.
end
else
s = mw.ustring.match(s, "%[%[(.*)|%]%]")
-- Next up, brackets and commas.
end
if s:match("%(.-%)$") then -- Brackets trump commas.
s = s:match("(.-) ?%(.-%)$")
-- Next up, brackets and commas.
elseif s:match(",") then -- If there are no brackets, display only the text before the first comma.
if mw.ustring.match(s, "%(.-%)$") then -- Brackets trump commas.
s = mw.ustring.s:match(s"[^, "(.-) ?%(.-%)$]*")
end
elseif mw.ustring.match(s, ",") then -- If there are no brackets, display only the text before the first comma.
return s
s = mw.ustring.match(s, "(.-),.*$")
end
return s
end
 
-- Return wikilink target |wikilinks=target
local function delinkWikilink(s)
local result =function getDelinkedTarget(s)
local result = s
-- Deal with the reverse pipe trick.
-- Deal with the reverse pipe trick.
if mw.ustring.match(result, "%[%[|") then
if result:match("%[%[|") then
return delinkReversePipeTrick(result)
return delinkReversePipeTrick(result)
end
end
result = mw.uri.decode(result, "PATH") -- decode percent-encoded entities. Leave underscores and plus signs.
result = mw.texturi.decode(result, true"PATH") -- decode HTMLpercent-encoded entities. Leave underscores and plus signs.
result = mw.text.decode(result, true) -- decode HTML entities.
-- Check for bad titles. To do this we need to find the
-- Check for bad titles. To do this we need to find the
-- title area of the link, i.e. the part before any pipes.
-- title area of the link, i.e. the part before any pipes.
local titlearea
local target_area
if mw.ustring.match(result, "|") then -- Find if we're dealing with a piped link.
if result:match("|") then -- Find if we're dealing with a piped link.
titlearea = mw.ustring.match(result, "^%[%[(.-)|.*%]%]")
target_area = result:match("^%[%[(.-)|.*%]%]")
else
else
titlearea = mw.ustring.match(result, "^%[%[(.-)%]%]")
target_area = result:match("^%[%[(.-)%]%]")
end
end
-- Check for bad characters.
if mw.ustring.match(titlearea, "[%[%]<>{}%%%c\n]") then
return s
end
-- Check for categories, interwikis, and files.
local colonprefix = mw.ustring.match(result, "%[%[(.-):.*%]%]") or "" -- Get the text before the first colon.
local ns = mw.site.namespaces[colonprefix] -- see if this is a known namespace
if mw.language.isKnownLanguageTag(colonprefix)
or ( ns and ( ns.canonicalName == "File" or ns.canonicalName == "Category" ) ) then
return ""
end
-- Remove the colon if the link is using the [[Help:Colon trick]].
if mw.ustring.match(result, "%[%[:") then
result = "[[" .. mw.ustring.match(result, "%[%[:(.*%]%])")
end
-- Deal with links using the [[Help:Pipe trick]].
if mw.ustring.match(result, "^%[%[[^|]*|%]%]") then
return delinkPipeTrick(result)
end
-- Find the display area of the wikilink
if mw.ustring.match(result, "|") then -- Find if we're dealing with a piped link.
result = mw.ustring.match(result, "^%[%[.-|(.+)%]%]")
-- Remove new lines from the display of multiline piped links,
-- where the pipe is before the first new line.
result = mw.ustring.gsub(result, "\n", "")
else
result = mw.ustring.match(result, "^%[%[(.-)%]%]")
end
 
-- Check for bad characters.
return result
if mw.ustring.match(target_area, "[%[%]<>{}%%%c\n]") and mw.ustring.match(target_area, "[%[%]<>{}%%%c\n]") ~= "?" then
return s
end
return target_area
end
 
local function getDelinkedLabel(s)
local result = s
-- Deal with the reverse pipe trick.
if result:match("%[%[|") then
return delinkReversePipeTrick(result)
end
 
result = mw.uri.decode(result, "PATH") -- decode percent-encoded entities. Leave underscores and plus signs.
result = mw.text.decode(result, true) -- decode HTML entities.
 
-- Check for bad titles. To do this we need to find the
-- title area of the link, i.e. the part before any pipes.
local target_area
if result:match("|") then -- Find if we're dealing with a piped link.
target_area = result:match("^%[%[(.-)|.*%]%]")
else
target_area = result:match("^%[%[(.-)%]%]")
end
 
-- Check for bad characters.
if mw.ustring.match(target_area, "[%[%]<>{}%%%c\n]") and mw.ustring.match(target_area, "[%[%]<>{}%%%c\n]") ~= "?" then
return s
end
 
-- Check for categories, interwikis, and files.
local colon_prefix = result:match("%[%[(.-):.*%]%]") or "" -- Get the text before the first colon.
local ns = mw.site.namespaces[colon_prefix] -- see if this is a known namespace
if mw.language.isKnownLanguageTag(colon_prefix) or (ns and (ns.canonicalName == "File" or ns.canonicalName == "Category")) then
return ""
end
 
-- Remove the colon if the link is using the [[Help:Colon trick]].
if result:match("%[%[:") then
result = "[[" .. result:match("%[%[:(.*%]%])")
end
 
-- Deal with links using the [[Help:Pipe trick]].
if mw.ustring.match(result, "^%[%[[^|]*|%]%]") then
return delinkPipeTrick(result)
end
-- Find the display area of the wikilink
if result:match("|") then -- Find if we're dealing with a piped link.
result = result:match("^%[%[.-|(.+)%]%]")
-- Remove new lines from the display of multiline piped links,
-- where the pipe is before the first new line.
result = result:gsub("\n", "")
else
result = result:match("^%[%[(.-)%]%]")
end
 
return result
end
 
local function delinkURL(s)
-- Assume we have already delinked internal wikilinks, and that
-- we have been passed some text between two square brackets [foo].
-- If the text contains a line break it is not formatted as a URL, regardless of other content.
if mw.ustring.s:match(s, "\n") then
return s
end
-- Check if the text has a valid URL prefix and at least one valid URL character.
local valid_url_prefixes = {"//", "http://", "https://", "ftp://", "gopher://", "mailto:", "news:", "irc://"}
local url_prefix
for _ for i,v in ipairs(valid_url_prefixes) do
if mw.ustring.match(s, '^%[' .. v ..'[^"%s].*%]' ) then
url_prefix = v
break
end
end
-- Get display text
if not url_prefix then
return s
end
s = mw.ustring.s:match(s, "^%[" .. url_prefix .. "(.*)%]") -- Grab all of the text after the URL prefix and before the final square bracket.
s = mw.ustring.s:match(s, '^.-(["<> ].*)') or "" -- Grab all of the text after the first URL separator character ("<> ).
s = mw.ustring.match(s, "^%s*(%S.*)$") or "" -- If the separating character was a space, trim it off.
local s_decoded = mw.text.decode(s, true)
if mw.ustring.match(s_decoded, "%c") then
return s
end
else
 
return s_decoded
return s_decoded
end
 
end
 
local function delinkLinkClass(stext, pattern, delinkFunction)
if not type(stext) =~= "string" then
error("Attempt to de-link non-string input.", 2)
end
if not ( type(pattern) =~= "string" andor mw.ustring.sub(pattern, 1, 1) =~= "^" ) then
error('Invalid pattern detected. Patterns must begin with "^".', 2)
end
-- Iterate over the text string, and replace any matched text. using the
-- delink function. We need to iterate character by character rather
-- than just use gsub, otherwise nested links aren't detected properly.
local result = ""
while mw.ustring.len(s)text >~= 0"" do
-- Replace text using one iteration of gsub.
s text = mw.ustring.gsub(stext, pattern, delinkFunction, 1)
-- Append the left-most character to the result string.
result = result .. mw.ustring.sub(stext, 1, 1)
s text = mw.ustring.sub(stext, 2, -1)
end
return result
end
 
local function p._delink(args)
local text = args[1] or ""
if args.refs == "yes" then
-- Remove any [[Help:Strip markers]] representing ref tags. In most situations
-- this is not a good idea - only use it if you know what you are doing!
text = mw.ustring.gsub(text, "UNIQ%w*%-ref%-%d*%-QINU", "")
end
if not (args.comments =~= "no") then
text = mw.ustring.text:gsub(text, "<!%-%-.-%-%->", "") -- Remove html comments.
end
 
if not (args.wikilinks == "no") then
if args.wikilinks ~= "no" and args.wikilinks ~= "target" then
text = delinkLinkClass(text, "^%[%[.-%]%]", delinkWikilink) -- De-link wikilinks.
-- De-link wikilinks and return the label portion of the wikilink.
end
text = delinkLinkClass(text, "^%[%[.-%]%]", getDelinkedLabel)
if not (args.urls == "no") then
elseif args.wikilinks == "target" then
text = delinkLinkClass(text, "^%[.-%]", delinkURL) -- De-link URLs.
-- De-link wikilinks and return the target portions of the wikilink.
end
text = delinkLinkClass(text, "^%[%[.-%]%]", getDelinkedTarget)
if not (args.whitespace == "no") then
end
-- Replace single new lines with a single space, but leave double new lines
if args.urls ~= "no" then
-- and new lines only containing spaces or tabs before a second new line.
text = mw.ustring.gsubdelinkLinkClass(text, "(^%[^\n \t.-%][", \t]*delinkURL)\n([ \t]*[^\n-- \t])",De-link "%1 %2")URLs.
end
text = mw.ustring.gsub(text, "[ \t]+", " ") -- Remove extra tabs and spaces.
if args.whitespace ~= "no" then
end
-- Replace single new lines with a single space, but leave double new lines
return text
-- and new lines only containing spaces or tabs before a second new line.
text = mw.ustring.gsub(text, "([^\n \t][ \t]*)\n([ \t]*[^\n \t])", "%1 %2")
text = text:gsub("[ \t]+", " ") -- Remove extra tabs and spaces.
end
return text
end
 
function p.delink(frame)
if not getArgs then
local args
getArgs = require('Module:Arguments').getArgs
if frame == mw.getCurrentFrame() then
end
-- We're being called via #invoke. If the invoking template passed any args, use
return p._delink(getArgs(frame, {wrappers = 'Template:Delink'}))
-- them. Otherwise, use the args that were passed into the template.
args = frame:getParent().args
for k, v in pairs(frame.args) do
args = frame.args
break
end
else
-- We're being called from another module or from the debug console, so assume
-- the args are passed in directly.
args = frame
end
return _delink(args)
end