-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- Require Load necessary modules.local getArgs = require('Module:ArgumentsNo globals').getArgslocal htmlBuilder = require('Module:HtmlBuilder')getArgslocal categoryHandler = require('Module:Category handler').main_main
local yesno = require('Module:Yesno')
-- Load the configuration page.local cfgTables = mw.loadData('Module:Message box/configuration')
-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
-- Set aliases for often-used functions to reduce table lookups.local format = mw.ustring.formatlocal tinsert = table.insertlocal tconcat = table.concatlocal trim = mw.text.trim
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
local function getTitleObject(page, ...) if type(page) == 'string' then -- Get the title object, passing the function through pcall -- in case we are over the expensive function count limit. local success, title = pcall(mw.title.new, page, ...) if success then return title end
end
end
local function union(t1, t2)
-- Returns the union of two arrays.
local ret = {}
for k in pairs(vals) do
tinserttable.insert(ret, k)
end
table.sort(ret)
return ret
end
local function getArgNums(args, prefix)
local nums = {}
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
tinserttable.insert(nums, tonumber(num))
end
end
return nums
end
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
local box MessageBox = {}boxMessageBox.__index = boxMessageBox function boxMessageBox.new(boxType, args, cfg) args = args or {}
local obj = {}
setmetatable(obj, box)-- Set the title object and the namespace. return objend function box.getNamespaceIdtitle = getTitleObject(nsargs.page) if not ns then return end if type(ns) == 'string' then ns = lang:ucfirst(or mw.ustringtitle.lowergetCurrentTitle(ns)) if ns == 'Main' then ns = 0 end end-- Set the config for our box type. local nsTable obj.cfg = mw.site.namespacescfg[nsboxType] if nsTable not obj.cfg then return nsTablelocal ns = obj.id endend function boxtitle.getMboxType(nsid)namespace -- Gets the boxType is "mbox type from a namespace number." or invalid input if nsid ns == 0 then return ' obj.cfg = cfg.ambox' -- main namespace elseif nsid ns == 6 then return ' obj.cfg = cfg.imbox' -- file namespace elseif nsid ns == 14 then return ' obj.cfg = cfg.cmbox' -- category namespace else local nsTable = mw.site.namespaces[nsid] if nsTable and nsTable.isTalk then return 'tmbox' -- any talk namespace
else
return 'local nsTable = mw.site.namespaces[ns] if nsTable and nsTable.isTalk then obj.cfg = cfg.tmbox -- any talk namespace else obj.cfg = cfg.ombox' -- other namespaces or invalid input end
end
end
end function box:addCat(ns -- Set the arguments, cat, sort)and remove all blank arguments except for the ones if type(cat) ~= 'string' then return end-- listed in cfg.allowBlankParams. do local nsVals newArgs = {'main', 'template', 'all'} local tname for ik, val v in ipairspairs(nsValsargs) do if ns v ~='' then newArgs[k] = val thenv tname = ns .. 'Cats'end
end
end if not tname then for i, val param in ipairs(nsValsobj.cfg.allowBlankParams or {}) do nsValsnewArgs[iparam] = format('"%s"', val)args[param]
end
error( 'invalid ns parameter passed to box:addCat; valid values are ' obj.. mw.text.listToText(nsVals, nil, ' or ') ) end self[tname] = self[tname] or {} if type(sort) =args = 'string' then tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort)) else tinsert(self[tname], format('[[Category:%s]]', cat))newArgs
end
-- Define internal data structure.
obj.categories = {}
obj.classes = {}
return setmetatable(obj, MessageBox)
end
function boxMessageBox:addClassaddCat(class) if type(class) ~= 'string' then return end self.classes = self.classes or {} tinsert(self.classesns, class)end function box:addAttr(attrcat, valsort) if type(attr) ~= 'string' or type(val) ~= 'string' not cat then return end self.attrs = self.attrs or {} tinsert(self.attrs, attr)end function box:setTitle(args) -- Get the title object and the namespace. self.pageTitle = getTitleObject(args.page ~= '' and args.page) self.title = self.pageTitle or mw.title.getCurrentTitle() self.demospace = args.demospace ~= '' and args.demospace or nil self.nsid = box.getNamespaceId(self.demospace) or self.title.namespaceend function box:getConfig(boxType) -- Get the box config data from the data page. if boxType == 'mbox' then boxType = box.getMboxType(self.nsid)
end
local cfg = cfgTables[boxType] if not cfg sort then local boxTypes cat = {} for k, v in pairs(dataTables) do tinsert(boxTypes, string.format('"[[Category:%s|%s"]]', k)cat, sort) end else tinsert(boxTypes, '"mbox"') error(cat = string.format( 'invalid message box type "%s"; valid types are [[Category:%s]]', tostring(boxType), mw.text.listToText(boxTypes) ), 2cat)
end
return cfgself.categories[ns] = self.categories[ns] or {} table.insert(self.categories[ns], cat)
end
function boxMessageBox:removeBlankArgsaddClass(cfg, argsclass) -- Only allow blank arguments for the parameter names listed in -- cfg.allowBlankParams. local newArgs = {} for k, v in pairs(args) do if v ~= '' not class then newArgs[k] = v endreturn nil
end
for i, param in ipairstable.insert(cfgself.allowBlankParams or {}classes, class) do newArgs[param] = args[param] end return newArgs
end
function boxMessageBox:setBoxParameterssetParameters() local args = self.args local cfg, args)= self.cfg
-- Get type data.
self.type = args.type
and self.type
and not typeData
and true
or false
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeImage = typeData.image
-- Find if the box has been wrongly substituted.
if self.isSubstituted = cfg.substCheck and args.subst == 'SUBST' then self.isSubstituted = true end
-- Find whether we are using a small message box.
if self.isSmall = cfg.allowSmall and (
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)
then self.isSmall = true else self.isSmall = false end
-- Add attributes, classes and styles.
if cfg.allowId then
self.style = args.style
self.attrs = args.attrs
-- Set text style.
self.textstyle = args.textstyle
-- Find if we are on the template page or not. This functionality is only
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
or false
end
-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
text = type(text) == 'string' and text or nil
local issues = {}
tinserttable.insert(issues, sect) tinserttable.insert(issues, issue) tinserttable.insert(issues, text) self.issue = tconcattable.concat(issues, ' ')
end
-- Get the self.talk value.
local talk = args.talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
local talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
)
else
talkText = string.format(
'%s the [[%s#%s|talk page]].',
talkText,
end
end
-- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
end
if date then
self.date = string.format(" <small>''(%s)''</small>", date)
end
self.info = args.info
end
-- Set the non-collapsible text field. At the moment this is used by all box
-- types other than ambox, and also by ambox when small=yes.
self.text = args.text
end
-- Set the below row.
self.below = cfg.below and args.below
-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
end
-- Left image settings.
local imageLeft = self.isSmall and args.smallimage or args.image
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
end
-- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
self.imageRight = imageRight
end
end function MessageBox:setMainspaceCategories() local args = self.args local cfg = self.cfg if not cfg.allowMainspaceCategories then return nil end local nums = {} for _, prefix in ipairs{'cat', 'category', 'all'} do args[prefix .. '1'] = args[prefix] nums = union(nums, getArgNums(args, prefix)) end -- Add mainspace categories. At The following is roughly equivalent to the moment these are only used in old {{amboxAmbox/category}}. if cfglocal date = args.allowMainspaceCategories thendate date = type(date) == 'string' and date local preposition = 'from' for _, num in ipairs(nums) do if local mainCat = args['cat' ..cat thentostring(num)] or args['category' .cat1 . tostring(num)] local allCat = args['all' .. tostring(num)] mainCat = type(mainCat) == 'string' and mainCat allCat = type(allCat) == 'string' and allCat if mainCat and date and date ~= '' then local catTitle = string.format('%s %s %s', mainCat, preposition, date) self:addCat(0, catTitle) catTitle = getTitleObject('Category:' ..catcatTitle) if not catTitle or not catTitle.exists then self:addCat(0, 'Articles with invalid date parameter in template') end elseif mainCat and (not date or date == '') then self:addCat(0, mainCat)
end
self.catNums = getArgNums(args, 'cat') if args.category then args.category1 = args.category end self.categoryNums = getArgNums(args, 'category') if args.all then args.all1 = args.all end self.allNums = getArgNums(args, 'all') self.categoryParamNums = union(self.catNums, self.categoryNums) self.categoryParamNums = union(self.categoryParamNums, self.allNums) -- The following is roughly equivalent to the old {{Ambox/category}}. local date = args.date date = type(date) == 'string' and date local preposition = 'from' for _, num in ipairs(self.categoryParamNums) do local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)] local allCat = args['all' .. tostring(num)] mainCat = type(mainCat) == 'string' and mainCat allCat = type(allCat) == 'string' and allCat if mainCat and date and date ~= '' then local catTitle = format('%s %s %s', mainCat, preposition, date) self:addCat('main', catTitle) catTitle = getTitleObject('Category:' .. catTitle) if not catTitle or not catTitle.exists then self:addCat( 'main', 'Articles with invalid date parameter in template' ) end elseif mainCat and (not date or date == '') then self:addCat('main', mainCat) end if allCat then self:addCat('main'0, allCat) end
end
end
end function MessageBox:setTemplateCategories() local args = self.args local cfg = self.cfg -- Add template-namespace categories.
if cfg.templateCategory then
if cfg.templateCategoryRequireName then
if self.isTemplatePage then
self:addCat('template'10, cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat('template'10, cfg.templateCategory)
end
end
-- Add template error categorycategories.
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
end
end
self:addCat('template'10, templateCat, templateSort)
end
end function MessageBox:setAllNamespaceCategories() -- Categories Set categories for all namespaces.
if self.invalidTypeError then
local allSort = (self.nsid title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
end
self:addCat('all', 'Pages with incorrectly substituted templates')
end
end function MessageBox:setCategories() if self.title.namespace == 0 then self:setMainspaceCategories() elseif self.title.namespace == 10 then self:setTemplateCategories() end self:setAllNamespaceCategories()end function MessageBox:renderCategories()
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
self.categories = return categoryHandler{ main = tconcattable.concat(self.mainCats categories[0] or {}), template = tconcattable.concat(self.templateCats categories[10] or {}), all = tconcattable.concat(self.allCats categories.all or {}), nocat = self.args.nocat, demospace = self.demospace, page = self.pageTitle and selfargs.pageTitle.prefixedText or nilpage
}
end
function boxMessageBox:export() local root = htmlBuildermw.html.create()
-- Add the subst check error.
if self.isSubstituted and self.name then
root .:tag('b') . :addClass('error') . :wikitext(string.format( 'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.', mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') ))
end
-- Create the box table.
local boxTable = root.:tag('table') boxTable .:attr('id', self.idor nil)
for i, class in ipairs(self.classes or {}) do
boxTable .:addClass(classor nil)
end
boxTable
.:cssText(self.styleor nil) .:attr('role', 'presentation') for attr, val in pairs(if self.attrs or {}) dothen boxTable .:attr(attr, valself.attrs)
end
-- Add the left-hand image.
local row = boxTable.:tag('tr')
if self.imageLeft then
local imageLeftCell = row.:tag('td').:addClass('mbox-image')
if self.imageCellDiv then
-- If we are using a div, redefine imageLeftCell so that the image
-- image width to 52px. If any images in a div are wider than that,
-- they may overlap with the text or cause other display problems.
imageLeftCell = imageLeftCell.:tag('div').:css('width', '52px')
end
imageLeftCell .:wikitext(self.imageLeftor nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row.:tag('td') .:addClass('mbox-empty-cell') .:cssText(self.imageEmptyCellStyleor nil)
end
-- Add the text.
local textCell = row.:tag('td').:addClass('mbox-text')
if self.useCollapsibleTextFields then
-- The message box uses advanced text parameters that allow things to be
-- collapsible. At the moment, only ambox uses this.
textCell .:cssText(self.textstyleor nil) local textCellSpan = textCell.:tag('span')
textCellSpan
.:addClass('mbox-text-span') .:wikitext(self.issueor nil)
if not self.isSmall then
textCellSpan .:tag('span') . :addClass('hide-when-compact') . :wikitext(self.talk and (' ' .. self.talk) or nil) . :wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellSpan .:wikitext(self.date and (' ' .. self.date) or nil)
if not self.isSmall then
textCellSpan
.:tag('span') .:addClass('hide-when-compact') .:wikitext(self.info and (' ' .. self.info) or nil)
end
else
-- Default text formatting - anything goes.
textCell
.:cssText(self.textstyleor nil) .:wikitext(self.textor nil)
end
-- Add the right-hand image.
if self.imageRight then
local imageRightCell = row.:tag('td').:addClass('mbox-imageright')
if self.imageCellDiv then
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell.:tag('div').:css('width', '52px')
end
imageRightCell
.:wikitext(self.imageRightor nil)
end
-- Add the below row.
if self.below then
boxTable.:tag('tr') .:tag('td') .:attr('colspan', self.imageRight and '3' or '2') .:addClass('mbox-text') .:cssText(self.textstyleor nil) .:wikitext(self.belowor nil)
end
-- Add error message for invalid type parameters.
if self.invalidTypeError then
root .:tag('div') . :css('text-align', 'center') . :wikitext(string.format( 'This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or '' ))
end
-- Add categories.
root .:wikitext(self.categories:renderCategories() or nil)
return tostring(root)
end
---------------------------------------------------------------------------------- Exports-------------------------------------------------------------------------------- local p, mt = {}, {} function mainp._exportClasses(boxType, args) local outputBox -- For testing. return { MessageBox = box.new()MessageBox outputBox:setTitle}end function p.main(boxType, args, cfgTables) local cfg box = outputBox:getConfigMessageBox.new(boxType, args, cfgTables or mw.loadData('Module:Message box/configuration')) args = outputBoxbox:removeBlankArgssetParameters(cfg, args) outputBoxbox:setBoxParameterssetCategories(cfg, args) return outputBoxbox:export()
end
local function makeWrappermt.__index(boxTypet, k)
return function (frame)
local args if not getArgs then getArgs = require('Module:Arguments').getArgs end return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}) return main(boxType, args)
end
end
local return setmetatable(p = { main = main, mbox = makeWrapper('mbox'mt)} for boxType in pairs(cfgTables) do p[boxType] = makeWrapper(boxType)end return p