|
-- This module provides functions for getting the target of a redirect page.
-- Given a single page name determines what page it redirects to and returns the target page name, or the
-- passed page name when not a redirect. The passed page name can be given as plain text or as a page link.
-- Returns page name as plain text, or when the bracket parameter is given, as a page link. Returns an
-- error message when page does not exist or the redirect target cannot be determined for some reason.
-- Thus these are roughly the same:
-- [[{{#invoke:redirect|main|redirect-page-name}}]] and {{#invoke:redirect|main|redirect-page-name|bracket=yes}}
local p = {}
-- Gets a mw.title object, using pcall to avoid generating script errors if we
local function warOnGsub(text, repl)
-- are over the expensive function count limit (among other possible causes).
if repl then
local function getTitle(...)
text = mw.ustring.gsub(text, "%%", "%%%%")
local success, titleObj = pcall(mw.title.new, ...)
if success then
return titleObj
else
return nil
text = mw.ustring.gsub(text, "([%?%^%$%(%)%%%.%[%]%*%+%-%]])", "%%%1")
end
return text
end
-- Gets the name of a page that a redirect leads to, or nil if it isn't a
local function getRedirect(rname)
-- redirect.
-- Get the title object, passing the function through pcall
function p.getTargetFromText(text)
-- in case we are over the expensive function count limit.
local target = string.match(
-- returning nil indicates the redirect did not parse, but nonexistent or non-redirect pages are not nil.
text,
local noError, rpage = pcall(mw.title.new, rname)
"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)%]%]"
if not noError or noError and not rpage or not rpage.isRedirect then
) or string.match(
-- mw.title.new failed, or the page is not a redirect, so use the passed page name.
text,
return rname
"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)|[^%[%]]-%]%]"
end
)
local redirect = mw.ustring.match(rpage:getContent() or "", "^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]]-)%]%]" )
return target and mw.uri.decode(target, 'PATH')
if redirect then
-- Decode html entities and percent encodings.
redirect = mw.text.decode(redirect, true)
redirect = mw.uri.decode(redirect, 'WIKI')
end
return redirect
end
-- Gets the target of a redirect. If the page specified is not a redirect,
function p._main(args)
-- returns nil.
local rname, bracket = args[1], args.bracket
function p.getTarget(page, fulltext)
bracket = bracket and "[[%s]]" or "%s"
-- Get the title object. Both page names and title objects are allowed
if type(rname) ~= "string" or not mw.ustring.match(rname, "%S") then return end
-- as input.
rname = mw.ustring.match(rname, "%[%[(.+)%]%]") or rname
local titleObj
local redirect = getRedirect(rname)
if type(page) == 'string' or type(page) == 'number' then
if redirect then
titleObj = getTitle(page)
return mw.ustring.format(bracket, redirect)
elseif type(page) == 'table' and type(page.getContent) == 'function' then
else
titleObj = page
return mw.ustring.format('<span class="error">[[Module:redirect]] error: could not parse redirect - [[%s]]</span>', rname)
else
end
error(string.format(
"bad argument #1 to 'getTarget'"
.. " (string, number, or title object expected, got %s)",
type(page)
), 2)
end
if not titleObj then
return nil
end
local targetTitle = titleObj.redirectTarget
if targetTitle then
if fulltext then
return targetTitle.fullText
else
return targetTitle.prefixedText
end
else
return nil
end
end
--[[
local function getPage(sourceName)
-- Given a single page name determines what page it redirects to and returns the
if type(sourceName) ~= "string" or not mw.ustring.match(sourceName, "%S") then return end
-- target page name, or the passed page name when not a redirect. The passed
-- the following delink doesn't make as much sense for this usage but is done for consistency.
-- page name can be given as plain text or as a page link.
sourceName = mw.ustring.match(sourceName, "%[%[(.+)%]%]") or sourceName
--
-- Returns page name as plain text, or when the bracket parameter is given, as a
local noError, title = pcall(mw.title.new, sourceName)
-- page link. Returns an error message when page does not exist or the redirect
if not noError then
-- target cannot be determined for some reason.
text = nil -- should be anyway; nil means error
--]]
else
function p.luaMain(rname, bracket, fulltext)
text = title:getContent()
if type(rname) ~= "string" or not rname:find("%S") then
end
return textnil
end
bracket = bracket and "[[%s]]" or "%s"
rname = rname:match("%[%[(.+)%]%]") or rname
local function nowikize(text, nowiki, default)
local frametarget = mwp.getCurrentFramegetTarget(rname, fulltext)
local ret = target or rname
if (default or nowiki) and (nowiki ~= 'no') then
ret = getTitle(ret)
text = frame:preprocess('<pre><nowiki>'..text..'</nowiki></pre>')
if ret then
if fulltext then
ret = ret.fullText
else
ret = ret.prefixedText
end
return bracket:format(ret)
else
return nil
end
return text
end
-- Provides access to the luaMain function from wikitext.
function p._block(args)
function p.main(frame)
-- this feature takes an initial page as an argument. It obtains all the links from that page
local args = require('Module:Arguments').getArgs(frame, {frameOnly = true})
-- starting from the first instance of some link named as start=, and replaces every link after
return p.luaMain(args[1], args.bracket, args.fulltext) or ''
-- that which is a redirect with the non-redirected canonical name, up until pcall throws an error
-- due to expense. Finally, it returns the substituted page.
local sourceName, start, text, pipe, nowiki = args[1], args[2], args.text, args.pipe, args.nowiki
if type(sourceName) == "string" then sourceName = mw.text.trim(sourceName) or sourceName end
if type(start) == "string" then start = mw.text.trim(start) or start end
if type(pipe) == "string" then pipe = mw.text.trim(pipe) or pipe end
if type(text) ~= "string" then
text = getPage(sourceName)-- we're getting text = the contents of the page at args[1]
end
if not(text) then -- nothing to work from
return -- optional error here
end
local originalText = text -- I don't want to even think about conflicts...
local separator = {na = '([%]|]%]?)', yes = '|', no = '%]%]', make = '|', set = '%]%]'}
local newSeparator = {na = '%1', yes = '|', no = ']]', make = '|', set = ']]'}
local nextLink = mw.ustring.gmatch(originalText, "%[%[([^%]|]*)|?([^%]]-)%]%]")
local link = " " -- true
local display = "" -- false
while link do
if not(start) and link ~= " " then
newLink = getRedirect(link)
-- if the page does redirect, do it if "pipe" isn't set or a pipe is present or absent as specified
if newLink and (newLink ~= link) and ((not pipe) or (pipe == 'make') or (display and (pipe == 'yes')) or (not display and (pipe == 'no'))) then
local pipePlay = pipe or 'na'
if pipe == 'make' and (not display) then
pipePlay = 'set'
-- if we're changing the link and there's no |something, create |the old name in the link.
newLink = newLink .. "|" .. link
end
link = warOnGsub(link, nil)
link = "%[%[%s*"..link.."%s*"..separator[pipePlay]
newLink = warOnGsub(newLink, true)
newLink = "[["..newLink..newSeparator[pipePlay]
text = mw.ustring.gsub(text, link, newLink, 1) or text -- no sense looking past 1, we'll be back...
end
end
link, display = nextLink()
if display then
display = mw.ustring.match(display, "(%S+)") -- nil if no non-space
end
if link then link = mw.text.trim(link) or link end
if start and link then
if start == link then
start = nil
else
link = " " -- discard all links before the one to start with
end
end
end
return nowikize(text, nowiki, true)
end
-- Returns true if the specified page is a redirect, and false otherwise.
local function makeWrapper(func)
return function p.luaIsRedirect(framepage)
local titleObj = getTitle(page)
-- If called via #invoke, use the args passed into the invoking
if not titleObj then
-- template, or the args passed to #invoke if any exist. Otherwise
return false
-- assume args are being passed directly in from the debug console
-- or from another Lua module.
local origArgs
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
for k, v in pairs(frame.args) do
origArgs = frame.args
break
end
else
origArgs = frame
end
-- Trim whitespace and remove blank arguments.
local args = {}
for k, v in pairs(origArgs) do
v = mw.text.trim(v)
if v ~= '' then
args[k] = v
end
end
return func(args)
end
return titleObj.isRedirect
end
-- Provides access to the luaIsRedirect function from wikitext, returning 'yes'
local funcNames = {'main', 'block'}
-- if the specified page is a redirect, and the blank string otherwise.
function p.isRedirect(frame)
for _, funcName in ipairs(funcNames) do
local args = require('Module:Arguments').getArgs(frame, {frameOnly = true})
p[funcName] = makeWrapper(p['_' .. funcName])
if p.luaIsRedirect(args[1]) then
return 'yes'
else
return ''
end
end
| 