Modul:Category handler

Dokumentaciju za ovaj modul možete napraviti na straniciModul:Category handler/dok

----------------------------------------------------------------------------------------------------------
-- --
-- CATEGORY HANDLER --
-- --
-- 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 --
-- automatically for the local wiki. This module requires [[Module:Namespace detect]] and --
-- [[Module:Yesno]] to be available on the local wiki. It can be configured for different wikis --
-- by altering the values in the "cfg" table. --
-- --
----------------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------------
-- Configuration data --
-- Language-specific parameter names and values can be set here. --
----------------------------------------------------------------------------------------------------------

localcfg={}

-- The following config values set the names of parameters that suppress categorisation. They are used
-- with Module:Yesno, and work as follows:
--
-- cfg.nocat:
-- 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.categories='categories'

-- 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
-- cfg.category2Yes or cfg.category2Negative.
cfg.category2='category2'
cfg.category2Yes='yes'
cfg.category2Negative='¬'

-- cfg.subpage is the parameter name to specify how to behave on subpages. cfg.subpageNo is the value to
-- specify to not categorise on subpages; cfg.only is the value to specify to only categorise on subpages.
cfg.subpage='subpage'
cfg.subpageNo='no'
cfg.subpageOnly='only'

-- The parameter for data to return in all namespaces.
cfg.all='all'

-- 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='other'

-- 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]].
cfg.page='page'

-- 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.)
-- 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={
'^Main Page$',-- don't categorise the main page.

-- Don't categorise the following pages or their subpages.
'^Wikipedia:Cascade%-protected items$',
'^Wikipedia:Cascade%-protected items/.*$',
'^User:UBX$',-- The userbox "template" space.
'^User:UBX/.*$',
'^User_talk:UBX$',
'^User_talk:UBX/.*$',

-- Don't categorise subpages of these pages, but allow
-- categorisation of the base page.
'^Wikipedia:Template messages/.+$',

'/[aA]rchive'-- Don't categorise archives.
}

-- This is a table of namespaces to categorise by default. They should be in the format of parameter
-- names accepted by [[Module:Namespace detect]].
cfg.defaultNamespaces={
'main',
'file',
'help',
'category'
}

----------------------------------------------------------------------------------------------------------
-- End configuration data --
----------------------------------------------------------------------------------------------------------

-- Get dependent modules
localnsDetect=require('Module:Namespace detect')
localyesno=require('Module:Yesno')

----------------------------------------------------------------------------------------------------------
-- Local functions --
-- The following are internal functions, which we do not want to be accessible from other modules. --
----------------------------------------------------------------------------------------------------------

-- Find whether we need to return a category or not.
localfunctionneedsCategory(pageObject,args)
-- Don't categorise if the relevant options are set.
ifyesno(args[cfg.nocat])
oryesno(args[cfg.categories])==false
or(
args[cfg.category2]
andargs[cfg.category2]~=cfg.category2Yes
andargs[cfg.category2]~=cfg.category2Negative
)
then
returnfalse
end
-- If there is no pageObject available, then that either means that we are over
-- the expensive function limit or that the title specified was invalid. Invalid
-- titles will probably only be a problem during testing, so we choose the best
-- fallback for being over the expensive function limit. The fallback behaviour
-- of the old template was to assume the page was not a subpage, so we will do
-- the same here.
ifargs[cfg.subpage]==cfg.subpageNoandpageObjectandpageObject.isSubpagethen
returnfalse
end
ifargs[cfg.subpage]==cfg.subpageOnly
and(notpageObjector(pageObjectandnotpageObject.isSubpage))
then
returnfalse
end
returntrue
end

-- Find whether we need to check the blacklist or not.
localfunctionneedsBlacklistCheck(args)
ifyesno(args[cfg.nocat])==false
oryesno(args[cfg.categories])==true
orargs[cfg.category2]==cfg.category2Yes
then
returnfalse
else
returntrue
end
end

-- Find whether any namespace parameters have been specified.
-- Mappings is the table of parameter mappings taken from
-- [[Module:Namespace detect]].
localfunctionnsParamsExist(mappings,args)
ifargs[cfg.all]orargs[cfg.other]then
returntrue
end
forns,paramsinpairs(mappings)do
fori,paraminipairs(params)do
ifargs[param]then
returntrue
end
end
end
returnfalse
end

----------------------------------------------------------------------------------------------------------
-- Global functions --
-- The following functions are global, because we want them to be accessible from #invoke and --
-- from other Lua modules. --
----------------------------------------------------------------------------------------------------------

localp={}

-- 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".
functionp.matchesBlacklist(page)
iftype(page)~='string'thenreturnend
fori,patterninipairs(cfg.blacklist)do
localmatch=mw.ustring.match(page,pattern)
ifmatchthen
returnmatch
end
end
end

-- The main structure of the module. Checks whether we need to categorise,
-- and then passes the relevant arguments to [[Module:Namespace detect]].
functionp._main(args)
-- Get the page object and argument mappings from
-- [[Module:Namespace detect]], to save us from having to rewrite the
-- code.
localpageObject=nsDetect.getPageObject(args[cfg.page])
localmappings=nsDetect.getParamMappings()

ifnotneedsCategory(pageObject,args)thenreturnend

localret=''
-- Check blacklist if necessary.
ifnotneedsBlacklistCheck(args)ornotp.matchesBlacklist(pageObject.prefixedText)then
ifnotnsParamsExist(mappings,args)then
-- No namespace parameters exist; basic usage. Pass args[1] to
-- [[Module:Namespace detect]] using the default namespace
-- parameters, and return the result.
localndargs={}
for_,ndarginipairs(cfg.defaultNamespaces)do
ndargs[ndarg]=args[1]
end
ndargs.page=args.page
ndargs.demospace=args.demospace
localndresult=nsDetect._main(ndargs)
ifndresultthen
ret=ret..ndresult
end
else
-- Namespace parameters exist; advanced usage.
-- If the all parameter is specified, return it.
localall=args.all
iftype(all)=='string'then
ret=ret..all
end

-- Get the arguments to pass to [[Module:Namespace detect]].
localndargs={}
forns,paramsinpairs(mappings)do
for_,paraminipairs(params)do
ndargs[param]=args[param]orargs[cfg.other]ornil
end
end
ndargs.other=args.other
ndargs.page=args.page
ndargs.demospace=args.demospace

localdata=nsDetect._main(ndargs)

-- Work out what to return based on the result of the namespace detect call.
localdatanum=tonumber(data)
iftype(datanum)=='number'then
-- "data" is a number, so return that positional parameter.
-- Remove non-positive integer values, as only positive integers
-- from 1-10 were used with the old template.
ifdatanum>0andmath.floor(datanum)==datanumthen
localdataArg=args[datanum]
iftype(dataArg)=='string'then
ret=ret..dataArg
end
end
else
-- "data" is not a number, so return it as it is.
iftype(data)=='string'then
ret=ret..data
end
end
end
end
returnret
end

functionp.main(frame)
-- If called via #invoke, use the args passed into the invoking
-- template, or the args passed to #invoke if any exist. Otherwise
-- assume args are being passed directly in.
localorigArgs
ifframe==mw.getCurrentFrame()then
origArgs=frame:getParent().args
fork,vinpairs(frame.args)do
origArgs=frame.args
break
end
else
origArgs=frame
end

-- Trim whitespace and remove blank arguments for the following args:
-- 1, 2, 3 etc., "nocat", "categories", "subpage", and "page".
localargs={}
fork,vinpairs(origArgs)do
iftype(v)=='string'then
v=mw.text.trim(v)-- Trim whitespace.
end
iftype(k)=='number'
ork==cfg.nocat
ork==cfg.categories
ork==cfg.subpage
ork==cfg.page
then
ifv~=''then
args[k]=v
end
else
args[k]=v
end
end

-- Lower-case "nocat", "categories", "category2", and "subpage". These
-- 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.
locallowercase={cfg.nocat,cfg.categories,cfg.category2,cfg.subpage}
for_,vinipairs(lowercase)do
localargVal=args[v]
iftype(argVal)=='string'then
args[v]=mw.ustring.lower(argVal)
end
end

returnp._main(args)
end

returnp