Module:Redirect: Difference between revisions

m
46 revisions imported from wikipedia:Module:Redirect
(update comment)
m (46 revisions imported from wikipedia:Module:Redirect)
 
(16 intermediate revisions by 9 users not shown)
Line 1:
-- This module provides functions for getting the target of a redirect page.
--[=[
Given a single page name determines what page, if any, it redirects to and returns the target page name, or the
passed page name if not a redirect. The passed page name can be given as plain text or as a page link. The
returned page name is as plain text, or when the bracket parameter is given, as a page link. An error message
is returned if page does not exist or the redirect target cannot be determined for some reason.
 
local p = {}
Thus these are roughly the same:
[[{{#invoke:redirect|main|redirect-page-name}}]] and {{#invoke:redirect|main|redirect-page-name|bracket=yes}}
--]=]
 
-- Gets a mw.title object, using pcall to avoid generating script errors if we
p={}
-- are over the expensive function count limit (among other possible causes).
local function getTitle(...)
local success, titleObj = pcall(mw.title.new, ...)
if success then
return titleObj
else
return nil
end
end
 
-- Gets the name of a page that a redirect leads to, or nil if it isn't a
-- redirect.
function p.getTargetFromText(text)
local target = string.match(
text,
"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)%]%]"
) or string.match(
text,
"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*:?%s*%[%[([^%[%]|]-)|[^%[%]]-%]%]"
)
return target and mw.uri.decode(target, 'PATH')
end
 
-- Gets the target of a redirect. If the page specified is not a redirect,
-- returns nil.
function p.getTarget(page, fulltext)
-- Get the title object. Both page names and title objects are allowed
-- as input.
local titleObj
if type(page) == 'string' or type(page) == 'number' then
titleObj = getTitle(page)
elseif type(page) == 'table' and type(page.getContent) == 'function' then
titleObj = page
else
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
 
--[[
-- 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.
--]]
function p.luaMain(rname, bracket, fulltext)
if type(rname) ~= "string" or not rname:find("%S") then
return nil
end
bracket = bracket and "[[%s]]" or "%s"
rname = rname:match("%[%[(.+)%]%]") or rname
local target = p.getTarget(rname, fulltext)
local ret = target or rname
ret = getTitle(ret)
if ret then
if fulltext then
ret = ret.fullText
else
ret = ret.prefixedText
end
return bracket:format(ret)
else
return nil
end
end
 
-- Provides access to the luaMain function from wikitext.
function p.main(frame)
local args, pargs = framerequire('Module:Arguments').args, getArgs(frame:getParent() or, {}).argsframeOnly or= {true})
return local rname, bracket = p.luaMain(args[1] or pargs[1], args.bracket, args.fulltext) or pargs.bracket''
end
 
if not rname or not mw.ustring.match(rname, "%S") then return "" end
-- Returns true if the specified page is a redirect, and false otherwise.
bracket = bracket and "[[%s]]" or "%s"
function p.luaIsRedirect(page)
rname = mw.ustring.match(rname,"%[%[(.+)%]%]") or rname
local titleObj = getTitle(page)
if not titleObj then
local rpage, err = mw.title.new(rname)
return false
end
-- avoid expensive operation when nothing to do
if not rpagetitleObj.isRedirect then
return true
err = "File not found (mw.title.new failed)"
else
elseif rpage.id == 0 then
return false
err = "File not found (id=0):"
end
elseif not rpage.isRedirect then
end
return mw.ustring.format(bracket, rname) -- not a redirect so use passed page name (for some general-purpose template use)
 
else
-- Provides access to the luaIsRedirect function from wikitext, returning 'yes'
local redirect = mw.ustring.match( rpage:getContent() or "", "^#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]%s*%[%[(.-)%]%]" )
-- if the specified page is a redirect, and the blank string otherwise.
function p.isRedirect(frame)
if redirect then
local args = require('Module:Arguments').getArgs(frame, {frameOnly = true})
return mw.ustring.format(bracket, redirect)
if p.luaIsRedirect(args[1]) then
end
return 'yes'
else
err = "failed to understand"
return ''
end
end
return '<span style="text-color:red;">[[Module:redirect]] error: ' .. err .. ' - [[' .. rname .. ']]</span>'
end
 
rtl-contributors
1,630

edits