Module:Category handler: Difference between revisions
From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search
Content added Content deleted
(tweak blacklist - on matching subpages, don't match "basepage/", only "basepage/foo") |
(update to use Module:Yesno and to allow it to play nicely with other Lua modules) |
||
| Line 1: | Line 1: | ||
---------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------------- |
||
-- -- |
-- -- |
||
-- CATEGORY HANDLER -- |
-- CATEGORY HANDLER -- |
||
-- -- |
-- -- |
||
-- This module implements the {{category handler}} template -- |
-- This module implements the {{category handler}} template in Lua, with a few improvements: all -- |
||
-- namespaces and all namespace aliases are supported, and namespace names are detected -- |
|||
-- in Lua, with a few improvements: all namespaces and all -- |
|||
-- automatically for the local wiki. This module requires [[Module:Namespace detect]] and -- |
|||
-- namespace aliases are supported, and namespace names are -- |
|||
-- |
-- [[Module:Yesno]] to be available on the local wiki. It can be configured for different wikis -- |
||
-- by altering the values in the "cfg" table. -- |
|||
-- requires [[Module:Namespace detect]] to be available on -- |
|||
-- -- |
|||
-- the local wiki. It can be configured for different wikis -- |
|||
---------------------------------------------------------------------------------------------------------- |
|||
-- by altering the values in the "cfg" table. -- |
|||
-- -- |
|||
---------------------------------------------------------------------- |
|||
---------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------------- |
||
-- Configuration data -- |
-- Configuration data -- |
||
-- Language-specific parameter names and values can be set -- |
-- Language-specific parameter names and values can be set here. -- |
||
---------------------------------------------------------------------------------------------------------- |
|||
-- here. -- |
|||
---------------------------------------------------------------------- |
|||
local cfg = {} |
local cfg = {} |
||
-- |
-- The following config values set the names of parameters that suppress categorisation. They are used |
||
-- with Module:Yesno, and work as follows: |
|||
-- cfg.nocatTrue is the value to suppress categorisation, and |
|||
-- |
|||
-- cfg.nocatFalse is the value to both categorise and to skip the |
|||
-- cfg.nocat: |
|||
-- blacklist check. |
|||
-- Result of yesno(args[cfg.nocat]) Effect |
|||
-- true Categorisation is suppressed |
|||
-- false Categorisation is allowed, and the blacklist check is skipped |
|||
-- nil Categorisation is allowed |
|||
-- |
|||
-- cfg.categories: |
|||
-- Result of yesno(args[cfg.categories]) Effect |
|||
-- true Categorisation is allowed, and the blacklist check is skipped |
|||
-- false Categorisation is suppressed |
|||
-- nil Categorisation is allowed |
|||
cfg.nocat = 'nocat' |
cfg.nocat = 'nocat' |
||
cfg.nocatTrue = 'true' |
|||
cfg.nocatFalse = 'false' |
|||
-- The parameter name for the legacy "categories" parameter. This |
|||
-- skips the blacklist if set to the cfg.category2Yes value, and |
|||
-- suppresses categorisation if set to the cfg.categoriesNo value. |
|||
cfg.categories = 'categories' |
cfg.categories = 'categories' |
||
cfg.categoriesYes = 'yes' |
|||
cfg.categoriesNo = 'no' |
|||
-- The parameter name for the legacy "category2" parameter. This |
-- The parameter name for the legacy "category2" parameter. This skips the blacklist if set to the |
||
-- cfg.category2Yes value, and suppresses categorisation if present but equal to anything other than |
|||
-- skips the blacklist if set to the cfg.category2Yes value, and |
|||
-- cfg.category2Yes or cfg.category2Negative. |
|||
-- suppresses categorisation if present but equal to anything other |
|||
-- than cfg.category2Yes or cfg.category2Negative. |
|||
cfg.category2 = 'category2' |
cfg.category2 = 'category2' |
||
cfg.category2Yes = 'yes' |
cfg.category2Yes = 'yes' |
||
cfg.category2Negative = ' |
cfg.category2Negative = 'Ê' |
||
-- cfg.subpage is the parameter name to specify how to behave on |
-- cfg.subpage is the parameter name to specify how to behave on subpages. cfg.subpageNo is the value to |
||
-- subpages |
-- specify to not categorise on subpages; cfg.only is the value to specify to only categorise on subpages. |
||
-- categorise on subpages; cfg.only is the value to specify to only |
|||
-- categorise on subpages. |
|||
cfg.subpage = 'subpage' |
cfg.subpage = 'subpage' |
||
cfg.subpageNo = 'no' |
cfg.subpageNo = 'no' |
||
| Line 55: | Line 51: | ||
cfg.all = 'all' |
cfg.all = 'all' |
||
-- The parameter name for data to return if no data is specified for |
-- The parameter name for data to return if no data is specified for the namespace that is detected. This |
||
-- |
-- must be the same as the cfg.other parameter in [[Module:Namespace detect]]. |
||
-- cfg.other parameter in [[Module:Namespace detect]]. |
|||
cfg.other = 'other' |
cfg.other = 'other' |
||
-- The parameter name used to specify a page other than the current |
-- The parameter name used to specify a page other than the current page; used for testing and |
||
-- |
-- demonstration. This must be the same as the cfg.page parameter in [[Module:Namespace detect]]. |
||
-- as the cfg.page parameter in [[Module:Namespace detect]]. |
|||
cfg.page = 'page' |
cfg.page = 'page' |
||
-- The categorisation blacklist. Pages that match Lua patterns in this |
-- The categorisation blacklist. Pages that match Lua patterns in this list will not be categorised. |
||
-- (However, see the explanation of cfg.nocat, cfg.categories and cfg.category2 for some exceptions.) |
|||
-- list will not be categorised unless any of the following options are |
|||
-- If the namespace name has a space in, it must be written with an underscore, e.g. "Wikipedia_talk". |
|||
-- set: "nocat=false", "categories=yes", or "category2=yes". |
|||
-- Other parts of the title can have either underscores or spaces. |
|||
-- If the namespace name has a space in, it must be written with an |
|||
-- underscore, e.g. "Wikipedia_talk". Other parts of the title can have |
|||
-- either underscores or spaces. |
|||
cfg.blacklist = { |
cfg.blacklist = { |
||
'^Main Page$', -- don't categorise the main page. |
'^Main Page$', -- don't categorise the main page. |
||
| Line 89: | Line 81: | ||
} |
} |
||
-- This is a table of namespaces to categorise by default. They |
-- This is a table of namespaces to categorise by default. They should be in the format of parameter |
||
-- |
-- names accepted by [[Module:Namespace detect]]. |
||
-- [[Module:Namespace detect]]. |
|||
cfg.defaultNamespaces = { |
cfg.defaultNamespaces = { |
||
'main', |
'main', |
||
| Line 99: | Line 90: | ||
} |
} |
||
---------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------------- |
||
-- End configuration data -- |
-- End configuration data -- |
||
---------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------------- |
||
-- Get dependent modules |
|||
-- Get [[Module:Namespace detect]] and declare the table of functions |
|||
local nsDetect = require('Module:Namespace detect') |
|||
-- that we will return. |
|||
local |
local yesno = require('Module:Yesno') |
||
local p = {} |
|||
---------------------------------------------------------------------- |
---------------------------------------------------------------------------------------------------------- |
||
-- Local functions -- |
-- Local functions -- |
||
-- The following are internal functions, which we do not want -- |
-- The following are internal functions, which we do not want to be accessible from other modules. -- |
||
---------------------------------------------------------------------------------------------------------- |
|||
-- to be accessible from other modules. -- |
|||
---------------------------------------------------------------------- |
|||
-- Find whether we need to return a category or not. |
-- Find whether we need to return a category or not. |
||
local function needsCategory( |
local function needsCategory(pageObject, args) |
||
-- Don't categorise if the relevant options are set. |
-- Don't categorise if the relevant options are set. |
||
if args[cfg.nocat] |
if yesno(args[cfg.nocat]) |
||
or args[cfg.categories] == |
or yesno(args[cfg.categories]) == false |
||
or ( |
or ( |
||
args[cfg.category2] |
|||
and args[cfg.category2] ~= cfg.category2Yes |
and args[cfg.category2] ~= cfg.category2Yes |
||
and args[cfg.category2] ~= cfg.category2Negative |
and args[cfg.category2] ~= cfg.category2Negative |
||
) |
|||
then |
|||
return false |
return false |
||
end |
end |
||
| Line 135: | Line 126: | ||
end |
end |
||
if args[cfg.subpage] == cfg.subpageOnly |
if args[cfg.subpage] == cfg.subpageOnly |
||
and (not pageObject or (pageObject and not pageObject.isSubpage) |
and (not pageObject or (pageObject and not pageObject.isSubpage)) |
||
then |
|||
return false |
return false |
||
end |
end |
||
| Line 142: | Line 134: | ||
-- Find whether we need to check the blacklist or not. |
-- Find whether we need to check the blacklist or not. |
||
local function needsBlacklistCheck( |
local function needsBlacklistCheck(args) |
||
if args[cfg.nocat] == |
if yesno(args[cfg.nocat]) == false |
||
or args[cfg.categories] == |
or yesno(args[cfg.categories]) == true |
||
or args[cfg.category2] == cfg.category2Yes |
or args[cfg.category2] == cfg.category2Yes |
||
then |
|||
return false |
return false |
||
else |
else |
||
return true |
return true |
||
end |
end |
||
end |
|||
-- Searches the blacklist to find a match with the page object. The |
|||
-- string searched is the namespace plus the title, including subpages. |
|||
-- Returns true if there is a match, otherwise returns false. |
|||
local function findBlacklistMatch( pageObject ) |
|||
if not pageObject then return end |
|||
-- Get the title to check. |
|||
local title = pageObject.nsText -- Get the namespace. |
|||
-- Append a colon if the namespace isn't the blank string. |
|||
if #title > 0 then |
|||
title = title .. ':' .. pageObject.text |
|||
else |
|||
title = pageObject.text |
|||
end |
|||
-- Check the blacklist. |
|||
for i, pattern in ipairs( cfg.blacklist ) do |
|||
if mw.ustring.match( title, pattern ) then |
|||
return true |
|||
end |
|||
end |
|||
return false |
|||
end |
end |
||
| Line 179: | Line 148: | ||
-- Mappings is the table of parameter mappings taken from |
-- Mappings is the table of parameter mappings taken from |
||
-- [[Module:Namespace detect]]. |
-- [[Module:Namespace detect]]. |
||
local function nsParamsExist( |
local function nsParamsExist(mappings, args) |
||
if args[cfg.all] or args[cfg.other] then |
if args[cfg.all] or args[cfg.other] then |
||
return true |
return true |
||
end |
end |
||
for ns, params in pairs( |
for ns, params in pairs(mappings) do |
||
for i, param in ipairs( |
for i, param in ipairs(params) do |
||
if args[param] then |
if args[param] then |
||
return true |
return true |
||
| Line 191: | Line 160: | ||
end |
end |
||
return false |
return false |
||
end |
|||
---------------------------------------------------------------------------------------------------------- |
|||
-- Global functions -- |
|||
-- The following functions are global, because we want them to be accessible from #invoke and -- |
|||
-- from other Lua modules. -- |
|||
---------------------------------------------------------------------------------------------------------- |
|||
local p = {} |
|||
-- Find if a string matches the blacklist. Returns the match if one is found, or nil otherwise. |
|||
-- Input should be a page title with a namespace prefix, e.g. "Wikipedia talk:Articles for deletion". |
|||
function p.matchesBlacklist(page) |
|||
if type(page) ~= 'string' then return end |
|||
for i, pattern in ipairs(cfg.blacklist) do |
|||
local match = mw.ustring.match(page, pattern) |
|||
if match then |
|||
return match |
|||
end |
|||
end |
|||
end |
end |
||
-- The main structure of the module. Checks whether we need to categorise, |
-- The main structure of the module. Checks whether we need to categorise, |
||
-- and then passes the relevant arguments to [[Module:Namespace detect]]. |
-- and then passes the relevant arguments to [[Module:Namespace detect]]. |
||
function p._main(args) |
|||
-- Get the page object and argument mappings from |
-- Get the page object and argument mappings from |
||
-- [[Module:Namespace detect]], to save us from having to rewrite the |
-- [[Module:Namespace detect]], to save us from having to rewrite the |
||
-- code. |
-- code. |
||
local pageObject = |
local pageObject = nsDetect.getPageObject(args[cfg.page]) |
||
local mappings = |
local mappings = nsDetect.getParamMappings() |
||
if not needsCategory(pageObject, args) then return end |
|||
-- Check if we need a category or not, and return nothing if not. |
|||
if not needsCategory( pageObject, args ) then return end |
|||
local ret = '' |
local ret = '' |
||
-- Check blacklist if necessary. |
-- Check blacklist if necessary. |
||
if not needsBlacklistCheck( |
if not needsBlacklistCheck(args) or not p.matchesBlacklist(pageObject.prefixedText) then |
||
if not nsParamsExist(mappings, args) then |
|||
if not nsParamsExist( mappings, args ) then |
|||
-- No namespace parameters exist; basic usage. Pass args[1] to |
-- No namespace parameters exist; basic usage. Pass args[1] to |
||
-- [[Module:Namespace detect]] using the default namespace |
-- [[Module:Namespace detect]] using the default namespace |
||
-- parameters, and return the result. |
-- parameters, and return the result. |
||
local ndargs = {} |
local ndargs = {} |
||
for _, ndarg in ipairs( |
for _, ndarg in ipairs(cfg.defaultNamespaces) do |
||
ndargs[ndarg] = args[1] |
ndargs[ndarg] = args[1] |
||
end |
end |
||
ndargs.page = args.page |
ndargs.page = args.page |
||
local ndresult = |
local ndresult = nsDetect.main(ndargs) |
||
if ndresult then |
if ndresult then |
||
ret = ret .. ndresult |
ret = ret .. ndresult |
||
| Line 232: | Line 218: | ||
-- Get the arguments to pass to [[Module:Namespace detect]]. |
-- Get the arguments to pass to [[Module:Namespace detect]]. |
||
local ndargs = {} |
local ndargs = {} |
||
for ns, params in pairs( |
for ns, params in pairs(mappings) do |
||
for _, param in ipairs( |
for _, param in ipairs(params) do |
||
ndargs[param] = args[param] or args[cfg.other] or nil |
ndargs[param] = args[param] or args[cfg.other] or nil |
||
end |
end |
||
| Line 244: | Line 230: | ||
end |
end |
||
local data = |
local data = nsDetect.main(ndargs) |
||
-- Work out what to return based on the result of the namespace |
-- Work out what to return based on the result of the namespace detect call. |
||
local datanum = tonumber(data) |
|||
if type(datanum) == 'number' then |
|||
if type( datanum ) == 'number' then |
|||
-- "data" is a number, so return that positional parameter. |
-- "data" is a number, so return that positional parameter. |
||
-- Remove non-positive integer values, as only positive integers |
-- Remove non-positive integer values, as only positive integers |
||
-- from 1-10 were used with the old template. |
-- from 1-10 were used with the old template. |
||
if datanum > 0 |
if datanum > 0 |
||
and math.floor( |
and math.floor(datanum) == datanum |
||
and args[datanum] then |
and args[datanum] then |
||
ret = ret .. args[ |
ret = ret .. args[datanum] |
||
end |
end |
||
else |
else |
||
| Line 269: | Line 254: | ||
end |
end |
||
function p.main(frame) |
|||
---------------------------------------------------------------------- |
|||
-- Global functions -- |
|||
-- The following functions are global, because we want them -- |
|||
-- to be accessible from #invoke and from other Lua modules. -- |
|||
-- At the moment only the main function is here. It processes -- |
|||
-- the arguments and passes them to the _main function. -- |
|||
---------------------------------------------------------------------- |
|||
function p.main( frame ) |
|||
-- If called via #invoke, use the args passed into the invoking |
-- If called via #invoke, use the args passed into the invoking |
||
-- template, or the args passed to #invoke if any exist. Otherwise |
-- template, or the args passed to #invoke if any exist. Otherwise |
||
| Line 284: | Line 261: | ||
if frame == mw.getCurrentFrame() then |
if frame == mw.getCurrentFrame() then |
||
origArgs = frame:getParent().args |
origArgs = frame:getParent().args |
||
for k, v in pairs( |
for k, v in pairs(frame.args) do |
||
origArgs = frame.args |
origArgs = frame.args |
||
break |
break |
||
| Line 295: | Line 272: | ||
-- 1, 2, 3 etc., "nocat", "categories", "subpage", and "page". |
-- 1, 2, 3 etc., "nocat", "categories", "subpage", and "page". |
||
local args = {} |
local args = {} |
||
for k, v in pairs( |
for k, v in pairs(origArgs) do |
||
if type(v) == 'string' then |
|||
v = mw.text.trim(v) -- Trim whitespace. |
|||
end |
|||
if type(k) == 'number' |
if type(k) == 'number' |
||
or k == cfg.nocat |
or k == cfg.nocat |
||
or k == cfg.categories |
or k == cfg.categories |
||
or k == cfg.subpage |
or k == cfg.subpage |
||
or k == cfg.page |
or k == cfg.page |
||
then |
|||
if v ~= '' then |
if v ~= '' then |
||
args[k] = v |
args[k] = v |
||
| Line 313: | Line 293: | ||
-- parameters are put in lower case whenever they appear in the old |
-- parameters are put in lower case whenever they appear in the old |
||
-- template, so we can just do it once here and save ourselves some work. |
-- template, so we can just do it once here and save ourselves some work. |
||
local lowercase = { |
local lowercase = {cfg.nocat, cfg.categories, cfg.category2, cfg.subpage} |
||
for _, v in ipairs( |
for _, v in ipairs(lowercase) do |
||
local argVal = args[v] |
|||
if type(argVal) == 'string' then |
|||
args[v] = mw.ustring.lower(argVal) |
|||
end |
end |
||
end |
end |
||
return _main( |
return p._main(args) |
||
end |
end |
||
