Actions

Module

Difference between revisions of "Message box"

From Unofficial Stationeers Wiki

(useId --> allowId)
m (59 revisions imported)
 
(25 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
+
-- This is a meta-module for producing message box templates, including
 +
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
  
−
-- Require necessary modules.
+
-- Load necessary modules.
−
local htmlBuilder = require('Module:HtmlBuilder')
+
require('Module:No globals')
−
local categoryHandler = require('Module:Category handler').main
+
local getArgs
 
local yesno = require('Module:Yesno')
 
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.
 
-- Get a language object for formatDate and ucfirst.
 
local lang = mw.language.getContentLanguage()
 
local lang = mw.language.getContentLanguage()
  
−
-- Set aliases for often-used functions to reduce table lookups.
+
-- Define constants
−
local format = mw.ustring.format
+
local CONFIG_MODULE = 'Module:Message box/configuration'
−
local tinsert = table.insert
 
−
local tconcat = table.concat
 
−
local trim = mw.text.trim
 
  
−
local box = {}
+
--------------------------------------------------------------------------------
 +
-- Helper functions
 +
--------------------------------------------------------------------------------
  
−
local function getTitleObject(page)
+
local function getTitleObject(...)
−
    if type(page) == 'string' then
+
-- Get the title object, passing the function through pcall
−
        -- Get the title object, passing the function through pcall  
+
-- in case we are over the expensive function count limit.
−
        -- in case we are over the expensive function count limit.
+
local success, title = pcall(mw.title.new, ...)
−
        local success, title = pcall(mw.title.new, page)
+
if success then
−
        if success then
+
return title
−
            return title
+
end
−
        end
 
−
    end
 
 
end
 
end
  
 
local function union(t1, t2)
 
local function union(t1, t2)
−
    -- Returns the union of two arrays.
+
-- Returns the union of two arrays.
−
    local vals = {}
+
local vals = {}
−
    for i, v in ipairs(t1) do
+
for i, v in ipairs(t1) do
−
        vals[v] = true
+
vals[v] = true
−
    end
+
end
−
    for i, v in ipairs(t2) do
+
for i, v in ipairs(t2) do
−
        vals[v] = true
+
vals[v] = true
−
    end
+
end
−
    local ret = {}
+
local ret = {}
−
    for k in pairs(vals) do
+
for k in pairs(vals) do
−
        tinsert(ret, k)
+
table.insert(ret, k)
−
    end
+
end
−
    table.sort(ret)
+
table.sort(ret)
−
    return ret
+
return ret
 
end
 
end
  
 
local function getArgNums(args, prefix)
 
local function getArgNums(args, prefix)
−
    local nums = {}
+
local nums = {}
−
    for k, v in pairs(args) do
+
for k, v in pairs(args) do
−
        local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
+
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
−
        if num then
+
if num then
−
            tinsert(nums, tonumber(num))
+
table.insert(nums, tonumber(num))
−
        end
+
end
−
    end
+
end
−
    table.sort(nums)
+
table.sort(nums)
−
    return nums
+
return nums
 
end
 
end
  
−
function box.getNamespaceId(ns)
+
--------------------------------------------------------------------------------
−
    if not ns then return end
+
-- Box class definition
−
    if type(ns) == 'string' then
+
--------------------------------------------------------------------------------
−
        ns = lang:ucfirst(mw.ustring.lower(ns))
+
 
−
        if ns == 'Main' then
+
local MessageBox = {}
−
            ns = 0
+
MessageBox.__index = MessageBox
−
        end
+
 
−
    end
+
function MessageBox.new(boxType, args, cfg)
−
    local nsTable = mw.site.namespaces[ns]
+
args = args or {}
−
    if nsTable then
+
local obj = {}
−
        return nsTable.id
+
 
−
    end
+
-- Set the title object and the namespace.
 +
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
 +
 
 +
-- Set the config for our box type.
 +
obj.cfg = cfg[boxType]
 +
if not obj.cfg then
 +
local ns = obj.title.namespace
 +
-- boxType is "mbox" or invalid input
 +
if ns == 0 then
 +
obj.cfg = cfg.ambox -- main namespace
 +
elseif ns == 6 then
 +
obj.cfg = cfg.imbox -- file namespace
 +
elseif ns == 14 then
 +
obj.cfg = cfg.cmbox -- category namespace
 +
else
 +
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
 +
 
 +
-- Set the arguments, and remove all blank arguments except for the ones
 +
-- listed in cfg.allowBlankParams.
 +
do
 +
local newArgs = {}
 +
for k, v in pairs(args) do
 +
if v ~= '' then
 +
newArgs[k] = v
 +
end
 +
end
 +
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
 +
newArgs[param] = args[param]
 +
end
 +
obj.args = newArgs
 +
end
 +
 
 +
-- Define internal data structure.
 +
obj.categories = {}
 +
obj.classes = {}
 +
-- For lazy loading of [[Module:Category handler]].
 +
obj.hasCategories = false
 +
 
 +
return setmetatable(obj, MessageBox)
 
end
 
end
  
−
function box.getMboxType(nsid)
+
function MessageBox:addCat(ns, cat, sort)
−
    -- Gets the mbox type from a namespace number.
+
if not cat then
−
    if nsid == 0 then
+
return nil
−
        return 'ambox' -- main namespace
+
end
−
    elseif nsid == 6 then
+
if sort then
−
        return 'imbox' -- file namespace
+
cat = string.format('[[Category:%s|%s]]', cat, sort)
−
    elseif nsid == 14 then
+
else
−
        return 'cmbox' -- category namespace
+
cat = string.format('[[Category:%s]]', cat)
−
    else
+
end
−
        local nsTable = mw.site.namespaces[nsid]
+
self.hasCategories = true
−
        if nsTable and nsTable.isTalk then
+
self.categories[ns] = self.categories[ns] or {}
−
            return 'tmbox' -- any talk namespace
+
table.insert(self.categories[ns], cat)
−
        else
 
−
            return 'ombox' -- other namespaces or invalid input
 
−
        end
 
−
    end
 
 
end
 
end
  
−
function box:addCat(ns, cat, sort)
+
function MessageBox:addClass(class)
−
    if type(cat) ~= 'string' then return end
+
if not class then
−
    local nsVals = {'main', 'template', 'all'}
+
return nil
−
    local tname
+
end
−
    for i, val in ipairs(nsVals) do
+
table.insert(self.classes, class)
−
        if ns == val then
 
−
            tname = ns .. 'Cats'
 
−
        end
 
−
    end
 
−
    if not tname then
 
−
        for i, val in ipairs(nsVals) do
 
−
            nsVals[i] = format('"%s"', val)
 
−
        end
 
−
        error('invalid ns parameter passed to box:addCat; valid values are ' .. mw.text.listToText(nsVals, nil, ' or '))
 
−
    end
 
−
    self[tname] = self[tname] or {}
 
−
    if type(sort) == 'string' then
 
−
        tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort))
 
−
    else
 
−
        tinsert(self[tname], format('[[Category:%s]]', cat))
 
−
    end
 
 
end
 
end
  
−
function box:addClass(class)
+
function MessageBox:setParameters()
−
    if type(class) ~= 'string' then return end
+
local args = self.args
−
    self.classes = self.classes or {}
+
local cfg = self.cfg
−
    tinsert(self.classes, class)
+
 
−
end
+
-- Get type data.
 +
self.type = args.type
 +
local typeData = cfg.types[self.type]
 +
self.invalidTypeError = cfg.showInvalidTypeError
 +
and self.type
 +
and not typeData
 +
typeData = typeData or cfg.types[cfg.default]
 +
self.typeClass = typeData.class
 +
self.typeImage = typeData.image
 +
 
 +
-- Find if the box has been wrongly substituted.
 +
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'
 +
 
 +
-- Find whether we are using a small message box.
 +
self.isSmall = cfg.allowSmall and (
 +
cfg.smallParam and args.small == cfg.smallParam
 +
or not cfg.smallParam and yesno(args.small)
 +
)
 +
 
 +
-- Add attributes, classes and styles.
 +
self.id = args.id
 +
if yesno(args.plainlinks) ~= false then
 +
self:addClass('plainlinks')
 +
end
 +
for _, class in ipairs(cfg.classes or {}) do
 +
self:addClass(class)
 +
end
 +
if self.isSmall then
 +
self:addClass(cfg.smallClass or 'mbox-small')
 +
end
 +
self:addClass(self.typeClass)
 +
self:addClass(args.class)
 +
self.style = args.style
 +
self.attrs = args.attrs
  
−
function box:setTitle(args)
+
-- Set text style.
−
    -- Get the title object and the namespace.
+
self.textstyle = args.textstyle
−
    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.namespace
 
−
end
 
  
−
function box:getConfig(boxType)
+
-- Find if we are on the template page or not. This functionality is only
−
    -- Get the box config data from the data page.
+
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
−
    if boxType == 'mbox' then
+
-- and cfg.templateCategoryRequireName are set.
−
        boxType = box.getMboxType(self.nsid)
+
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
−
    end
+
if self.useCollapsibleTextFields
−
    local cfg = cfgTables[boxType]
+
or cfg.templateCategory
−
    if not cfg then
+
and cfg.templateCategoryRequireName
−
        local boxTypes = {}
+
then
−
        for k, v in pairs(dataTables) do
+
self.name = args.name
−
            tinsert(boxTypes, format('"%s"', k))
+
if self.name then
−
        end
+
local templateName = mw.ustring.match(
−
        tinsert(boxTypes, '"mbox"')
+
self.name,
−
        error(format('invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes)), 2)
+
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
−
    end
+
) or self.name
−
    return cfg
+
templateName = 'Template:' .. templateName
−
end
+
self.templateTitle = getTitleObject(templateName)
−
   
+
end
−
function box:removeBlankArgs(cfg, args)
+
self.isTemplatePage = self.templateTitle
−
    -- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
+
and mw.title.equals(self.title, self.templateTitle)
−
    local newArgs = {}
+
end
−
    for k, v in pairs(args) do
 
−
        if v ~= '' then
 
−
            newArgs[k] = v
 
−
        end
 
−
    end
 
−
    for i, param in ipairs(cfg.allowBlankParams or {}) do
 
−
        newArgs[param] = args[param]
 
−
    end
 
−
    return newArgs
 
−
end
 
  
−
function box:setBoxParameters(cfg, args)
+
-- Process data for collapsible text fields. At the moment these are only
−
    -- Get type data.
+
-- used in {{ambox}}.
−
    self.type = args.type
+
if self.useCollapsibleTextFields then
−
    local typeData = cfg.types[self.type]
+
-- Get the self.issue value.
−
    self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData and true or false
+
if self.isSmall and args.smalltext then
−
    typeData = typeData or cfg.types[cfg.default]
+
self.issue = args.smalltext
−
    self.typeClass = typeData.class
+
else
−
    self.typeImage = typeData.image
+
local sect
 +
if args.sect == '' then
 +
sect = 'This ' .. (cfg.sectionDefault or 'page')
 +
elseif type(args.sect) == 'string' then
 +
sect = 'This ' .. args.sect
 +
end
 +
local issue = args.issue
 +
issue = type(issue) == 'string' and issue ~= '' and issue or nil
 +
local text = args.text
 +
text = type(text) == 'string' and text or nil
 +
local issues = {}
 +
table.insert(issues, sect)
 +
table.insert(issues, issue)
 +
table.insert(issues, text)
 +
self.issue = table.concat(issues, ' ')
 +
end
  
−
    -- Find if the box has been wrongly substituted.
+
-- Get the self.talk value.
−
    if cfg.substCheck and args.subst == 'SUBST' then
+
local talk = args.talk
−
        self.isSubstituted = true
+
-- Show talk links on the template page or template subpages if the talk
−
    end
+
-- parameter is blank.
 +
if talk == ''
 +
and self.templateTitle
 +
and (
 +
mw.title.equals(self.templateTitle, self.title)
 +
or self.title:isSubpageOf(self.templateTitle)
 +
)
 +
then
 +
talk = '#'
 +
elseif talk == '' then
 +
talk = nil
 +
end
 +
if talk then
 +
-- If the talk value is a talk page, make a link to that page. Else
 +
-- assume that it's a section heading, and make a link to the talk
 +
-- page of the current page with that section heading.
 +
local talkTitle = getTitleObject(talk)
 +
local talkArgIsTalkPage = true
 +
if not talkTitle or not talkTitle.isTalkPage then
 +
talkArgIsTalkPage = false
 +
talkTitle = getTitleObject(
 +
self.title.text,
 +
mw.site.namespaces[self.title.namespace].talk.id
 +
)
 +
end
 +
if talkTitle and talkTitle.exists then
 +
local talkText = 'Relevant discussion may be found on'
 +
if talkArgIsTalkPage then
 +
talkText = string.format(
 +
'%s [[%s|%s]].',
 +
talkText,
 +
talk,
 +
talkTitle.prefixedText
 +
)
 +
else
 +
talkText = string.format(
 +
'%s the [[%s#%s|talk page]].',
 +
talkText,
 +
talkTitle.prefixedText,
 +
talk
 +
)
 +
end
 +
self.talk = talkText
 +
end
 +
end
  
−
    -- Find whether we are using a small message box.
+
-- Get other values.
−
    if cfg.allowSmall and (
+
self.fix = args.fix ~= '' and args.fix or nil
−
            cfg.smallParam and args.small == cfg.smallParam
+
local date
−
            or not cfg.smallParam and yesno(args.small)
+
if args.date and args.date ~= '' then
−
    )
+
date = args.date
−
    then
+
elseif args.date == '' and self.isTemplatePage then
−
        self.isSmall = true
+
date = lang:formatDate('F Y')
−
    else
+
end
−
        self.isSmall = false
+
if date then
−
    end
+
self.date = string.format(" <small>''(%s)''</small>", date)
 +
end
 +
self.info = args.info
 +
if yesno(args.removalnotice) then
 +
self.removalNotice = cfg.removalNotice
 +
end
 +
end
  
−
    -- Add attributes, classes and styles.
+
-- Set the non-collapsible text field. At the moment this is used by all box
−
    if cfg.allowId then
+
-- types other than ambox, and also by ambox when small=yes.
−
        self.id = args.id
+
if self.isSmall then
−
    end
+
self.text = args.smalltext or args.text
−
    self:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks')
+
else
−
    for _, class in ipairs(cfg.classes or {}) do
+
self.text = args.text
−
        self:addClass(class)
+
end
−
    end
 
−
    if self.isSmall then
 
−
        self:addClass(cfg.smallClass or 'mbox-small')
 
−
    end
 
−
    self:addClass(self.typeClass)
 
−
    self:addClass(args.class)
 
−
    self.style = args.style
 
  
−
    -- Set text style.
+
-- Set the below row.
−
    self.textstyle = args.textstyle
+
self.below = cfg.below and args.below
  
−
    -- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
+
-- General image settings.
−
    self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
+
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
−
    if self.useCollapsibleTextFields then
+
self.imageEmptyCell = cfg.imageEmptyCell
−
        self.name = args.name
+
if cfg.imageEmptyCellStyle then
−
        local nameTitle = getTitleObject(self.name)
+
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
−
        self.isTemplatePage = nameTitle and self.title.prefixedText == ('Template:' .. nameTitle.text) and true or false
+
end
  
−
        -- Get the self.issue value.
+
-- Left image settings.
−
        if self.isSmall and args.smalltext then
+
local imageLeft = self.isSmall and args.smallimage or args.image
−
            self.issue = args.smalltext
+
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
−
        else
+
or not cfg.imageCheckBlank and imageLeft ~= 'none'
−
            local sect
+
then
−
            if args.sect == '' then
+
self.imageLeft = imageLeft
−
                sect = 'This ' .. (cfg.sectionDefault or 'page')
+
if not imageLeft then
−
            elseif type(args.sect) == 'string' then
+
local imageSize = self.isSmall
−
                sect = 'This ' .. args.sect
+
and (cfg.imageSmallSize or '30x30px')
−
            end
+
or '40x40px'
−
            local issue = args.issue
+
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
−
            issue = type(issue) == 'string' and issue or nil
+
or 'Imbox notice.png', imageSize)
−
            local text = args.text
+
end
−
            text = type(text) == 'string' and text or nil
+
end
−
            local issues = {}
 
−
            tinsert(issues, sect)
 
−
            tinsert(issues, issue)
 
−
            tinsert(issues, text)
 
−
            self.issue = tconcat(issues, ' ')
 
−
        end
 
  
−
        -- Get the self.talk value.
+
-- Right image settings.
−
        local talk = args.talk
+
local imageRight = self.isSmall and args.smallimageright or args.imageright
−
        if talk == '' and self.isTemplatePage then
+
if not (cfg.imageRightNone and imageRight == 'none') then
−
            talk = '#'
+
self.imageRight = imageRight
−
        end
+
end
−
        if talk then
+
end
−
            -- See if the talk link exists and is for a talk or a content namespace.
 
−
            local talkTitle = getTitleObject(talk)
 
−
            if not talkTitle or not talkTitle.isTalkPage then
 
−
                -- If we couldn't process the talk page link, get the talk page of the current page.
 
−
                local success
 
−
                success, talkTitle = pcall(self.title.talkPageTitle, self.title)
 
−
                if not success then
 
−
                    talkTitle = nil
 
−
                end
 
−
            end
 
−
            if talkTitle and talkTitle.exists then
 
−
                local talkText = 'Relevant discussion may be found on'
 
−
                if talkTitle.isTalkPage then
 
−
                    talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
 
−
                else
 
−
                    talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
 
−
                end
 
−
                self.talk = talkText
 
−
            end
 
−
        end
 
  
−
        -- Get other values.
+
function MessageBox:setMainspaceCategories()
−
        self.fix = args.fix
+
local args = self.args
−
        local date
+
local cfg = self.cfg
−
        if args.date and args.date ~= '' then
 
−
            date = args.date
 
−
        elseif args.date == '' and self.isTemplatePage then
 
−
            date = lang:formatDate('F Y')
 
−
        end
 
−
        if date then
 
−
            self.date = 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,
+
if not cfg.allowMainspaceCategories then
−
    -- and also by ambox when small=yes.
+
return nil
−
    if self.isSmall then
+
end
−
        self.text = args.smalltext or args.text
 
−
    else
 
−
        self.text = args.text
 
−
    end
 
  
−
    -- Set the below row.
+
local nums = {}
−
    self.below = cfg.below and args.below
+
for _, prefix in ipairs{'cat', 'category', 'all'} do
 +
args[prefix .. '1'] = args[prefix]
 +
nums = union(nums, getArgNums(args, prefix))
 +
end
  
−
    -- General image settings.
+
-- The following is roughly equivalent to the old {{Ambox/category}}.
−
    self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
+
local date = args.date
−
    self.imageEmptyCell = cfg.imageEmptyCell
+
date = type(date) == 'string' and date
−
    if cfg.imageEmptyCellStyle then
+
local preposition = 'from'
−
        self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
+
for _, num in ipairs(nums) do
−
    end
+
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 = string.format('%s %s %s', mainCat, preposition, date)
 +
self:addCat(0, catTitle)
 +
catTitle = getTitleObject('Category:' .. catTitle)
 +
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
 +
if allCat then
 +
self:addCat(0, allCat)
 +
end
 +
end
 +
end
  
−
    -- Left image settings.
+
function MessageBox:setTemplateCategories()
−
    local imageLeft = self.isSmall and args.smallimage or args.image
+
local args = self.args
−
    if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
+
local cfg = self.cfg
−
        or not cfg.imageCheckBlank and imageLeft ~= 'none'
 
−
    then
 
−
        self.imageLeft = imageLeft
 
−
        if not imageLeft then
 
−
            local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40x40px'
 
−
            self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize)
 
−
        end
 
−
    end
 
  
−
    -- Right image settings.
+
-- Add template categories.
−
    local imageRight = self.isSmall and args.smallimageright or args.imageright
+
if cfg.templateCategory then
−
    if not (cfg.imageRightNone and imageRight == 'none') then
+
if cfg.templateCategoryRequireName then
−
        self.imageRight = imageRight
+
if self.isTemplatePage then
−
    end
+
self:addCat(10, cfg.templateCategory)
 +
end
 +
elseif not self.title.isSubpage then
 +
self:addCat(10, cfg.templateCategory)
 +
end
 +
end
  
−
    -- Add mainspace categories. At the moment these are only used in {{ambox}}.
+
-- Add template error categories.
−
    if cfg.allowMainspaceCategories then
+
if cfg.templateErrorCategory then
−
        if args.cat then
+
local templateErrorCategory = cfg.templateErrorCategory
−
            args.cat1 = args.cat
+
local templateCat, templateSort
−
        end
+
if not self.name and not self.title.isSubpage then
−
        self.catNums = getArgNums(args, 'cat')
+
templateCat = templateErrorCategory
−
        if args.category then
+
elseif self.isTemplatePage then
−
            args.category1 = args.category
+
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
−
        end
+
local count = 0
−
        self.categoryNums = getArgNums(args, 'category')
+
for i, param in ipairs(paramsToCheck) do
−
        self.categoryParamNums = union(self.catNums, self.categoryNums)
+
if not args[param] then
−
        if args.all then
+
count = count + 1
−
            args.all1 = args.all
+
end
−
        end
+
end
−
        -- The following is roughly equivalent to the old {{Ambox/category}}.
+
if count > 0 then
−
        local date = args.date
+
templateCat = templateErrorCategory
−
        date = type(date) == 'string' and date
+
templateSort = tostring(count)
−
        local preposition = 'from'
+
end
−
        for _, num in ipairs(self.categoryParamNums) do
+
if self.categoryNums and #self.categoryNums > 0 then
−
            local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
+
templateCat = templateErrorCategory
−
            local allCat = args['all' .. tostring(num)]
+
templateSort = 'C'
−
            mainCat = type(mainCat) == 'string' and mainCat
+
end
−
            allCat = type(allCat) == 'string' and allCat
+
end
−
            if mainCat and date then
+
self:addCat(10, templateCat, templateSort)
−
                local catTitle = format('%s %s %s', mainCat, preposition, date)
+
end
−
                self:addCat('main', catTitle)
+
end
−
                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 then
 
−
                self:addCat('main', mainCat)
 
−
            end
 
−
            if allCat then
 
−
                self:addCat('main', allCat)
 
−
            end
 
−
        end
 
−
    end
 
  
−
    -- Add template-namespace categories.
+
function MessageBox:setAllNamespaceCategories()
−
    self.isTemplatePage = type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name)
+
-- Set categories for all namespaces.
−
    if cfg.templateCategory then
+
if self.invalidTypeError then
−
        if self.name then
+
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
−
            if self.isTemplatePage then
+
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
−
                self:addCat('template', cfg.templateCategory)
+
end
−
            end
+
if self.isSubstituted then
−
        elseif not self.title.isSubpage then
+
self:addCat('all', 'Pages with incorrectly substituted templates')
−
            self:addCat('template', cfg.templateCategory)
+
end
−
        end
+
end
−
    end
 
−
   
 
−
    -- Add template error category.
 
−
    if cfg.templateErrorCategory then
 
−
        local templateErrorCategory = cfg.templateErrorCategory
 
−
        local templateCat, templateSort
 
−
        if not self.name and not self.title.isSubpage then
 
−
            templateCat = templateErrorCategory
 
−
        elseif type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name) then
 
−
            local paramsToCheck = cfg.templateErrorParamsToCheck or {}
 
−
            local count = 0
 
−
            for i, param in ipairs(paramsToCheck) do
 
−
                if not args[param] then
 
−
                    count = count + 1
 
−
                end
 
−
            end
 
−
            if count > 0 then
 
−
                templateCat = templateErrorCategory
 
−
                templateSort = tostring(count)
 
−
            end
 
−
            if self.categoryNums and #self.categoryNums > 0 then
 
−
                templateCat = templateErrorCategory
 
−
                templateSort = 'C'
 
−
            end
 
−
        end
 
−
        self:addCat('template', templateCat, templateSort)
 
−
    end
 
  
−
    -- Categories for all namespaces.
+
function MessageBox:setCategories()
−
    if self.invalidTypeError then
+
if self.title.namespace == 0 then
−
        local allSort = (nsid == 0 and 'Main:' or '') .. self.title.prefixedText
+
self:setMainspaceCategories()
−
        self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
+
elseif self.title.namespace == 10 then
−
    end
+
self:setTemplateCategories()
−
    if self.isSubstituted then
+
end
−
        self:addCat('all', 'Pages with incorrectly substituted templates')
+
self:setAllNamespaceCategories()
−
    end
+
end
  
−
    -- Convert category tables to strings and pass them through [[Module:Category handler]].
+
function MessageBox:renderCategories()
−
    self.categories = categoryHandler{
+
if not self.hasCategories then
−
        main = tconcat(self.mainCats or {}),
+
-- No categories added, no need to pass them to Category handler so,
−
        template = tconcat(self.templateCats or {}),
+
-- if it was invoked, it would return the empty string.
−
        all = tconcat(self.allCats or {}),
+
-- So we shortcut and return the empty string.
−
        nocat = args.nocat,
+
return ""
−
        demospace = self.demospace,
+
end
−
        page = self.pageTitle and self.pageTitle.prefixedText or nil
+
-- Convert category tables to strings and pass them through
−
    }
+
-- [[Module:Category handler]].
 +
return require('Module:Category handler')._main{
 +
main = table.concat(self.categories[0] or {}),
 +
template = table.concat(self.categories[10] or {}),
 +
all = table.concat(self.categories.all or {}),
 +
nocat = self.args.nocat,
 +
page = self.args.page
 +
}
 
end
 
end
  
−
function box:export()
+
function MessageBox:export()
−
    local root = htmlBuilder.create()
+
local root = mw.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
  
−
    -- Add the subst check error.
+
-- Create the box table.
−
    if self.isSubstituted and self.name then
+
local boxTable = root:tag('table')
−
        root
+
boxTable:attr('id', self.id or nil)
−
            .tag('b')
+
for i, class in ipairs(self.classes or {}) do
−
                .addClass('error')
+
boxTable:addClass(class or nil)
−
                .wikitext(format(
+
end
−
                    'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
+
boxTable
−
                    mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
+
:cssText(self.style or nil)
−
                ))
+
:attr('role', 'presentation')
−
    end
 
  
−
    -- Create the box table.
+
if self.attrs then
−
    local boxTable = root.tag('table')
+
boxTable:attr(self.attrs)
−
    boxTable
+
end
−
        .attr('id', self.id)
 
−
    for i, class in ipairs(self.classes or {}) do
 
−
        boxTable
 
−
            .addClass(class)
 
−
    end
 
−
    boxTable
 
−
        .cssText(self.style)
 
−
        .attr('role', 'presentation')
 
  
−
    -- Add the left-hand image.
+
-- Add the left-hand image.
−
    local row = boxTable.tag('tr')
+
local row = boxTable:tag('tr')
−
    if self.imageLeft then
+
if self.imageLeft then
−
        local imageLeftCell = row.tag('td').addClass('mbox-image')
+
local imageLeftCell = row:tag('td'):addClass('mbox-image')
−
        if self.imageCellDiv then
+
if self.imageCellDiv then
−
            -- If we are using a div, redefine imageLeftCell so that the image is inside it.
+
-- If we are using a div, redefine imageLeftCell so that the image
−
            -- Divs use style="width: 52px;", which limits the image width to 52px. If any
+
-- is inside it. Divs use style="width: 52px;", which limits the
−
            -- images in a div are wider than that, they may overlap with the text or cause
+
-- image width to 52px. If any images in a div are wider than that,
−
            -- other display problems.
+
-- they may overlap with the text or cause other display problems.
−
            imageLeftCell = imageLeftCell.tag('div').css('width', '52px')  
+
imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')
−
        end
+
end
−
        imageLeftCell
+
imageLeftCell:wikitext(self.imageLeft or nil)
−
            .wikitext(self.imageLeft)
+
elseif self.imageEmptyCell then
−
    elseif self.imageEmptyCell then
+
-- Some message boxes define an empty cell if no image is specified, and
−
        -- Some message boxes define an empty cell if no image is specified, and some don't.
+
-- some don't. The old template code in templates where empty cells are
−
        -- The old template code in templates where empty cells are specified gives the following hint:
+
-- specified gives the following hint: "No image. Cell with some width
−
        -- "No image. Cell with some width or padding necessary for text cell to have 100% width."
+
-- or padding necessary for text cell to have 100% width."
−
        row.tag('td')
+
row:tag('td')
−
            .addClass('mbox-empty-cell')  
+
:addClass('mbox-empty-cell')
−
            .cssText(self.imageEmptyCellStyle)
+
:cssText(self.imageEmptyCellStyle or nil)
−
    end
+
end
  
−
    -- Add the text.
+
-- Add the text.
−
    local textCell = row.tag('td').addClass('mbox-text')
+
local textCell = row:tag('td'):addClass('mbox-text')
−
    if self.useCollapsibleTextFields then
+
if self.useCollapsibleTextFields then
−
        -- The message box uses advanced text parameters that allow things to be collapsible. At the
+
-- The message box uses advanced text parameters that allow things to be
−
        -- moment, only ambox uses this.
+
-- collapsible. At the moment, only ambox uses this.
−
        textCell
+
textCell:cssText(self.textstyle or nil)
−
            .cssText(self.textstyle)
+
local textCellDiv = textCell:tag('div')
−
        local textCellSpan = textCell.tag('span')
+
textCellDiv
−
        textCellSpan
+
:addClass('mbox-text-span')
−
            .addClass('mbox-text-span')
+
:wikitext(self.issue or nil)
−
            .wikitext(self.issue)
+
if (self.talk or self.fix) and not self.isSmall then
−
        if not self.isSmall then
+
textCellDiv:tag('span')
−
            textCellSpan
+
:addClass('hide-when-compact')
−
                .tag('span')
+
:wikitext(self.talk and (' ' .. self.talk) or nil)
−
                    .addClass('hide-when-compact')
+
:wikitext(self.fix and (' ' .. self.fix) or nil)
−
                    .wikitext(self.talk and ' ' .. self.talk)
+
end
−
                    .wikitext(self.fix and ' ' .. self.fix)
+
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
−
        end
+
if self.info and not self.isSmall then
−
        textCellSpan
+
textCellDiv
−
            .wikitext(self.date and ' ' .. self.date)
+
:tag('span')
−
        if not self.isSmall then
+
:addClass('hide-when-compact')
−
            textCellSpan
+
:wikitext(self.info and (' ' .. self.info) or nil)
−
                .tag('span')
+
end
−
                    .addClass('hide-when-compact')
+
if self.removalNotice then
−
                    .wikitext(self.info and ' ' .. self.info)
+
textCellDiv:tag('small')
−
        end
+
:addClass('hide-when-compact')
−
    else
+
:tag('i')
−
        -- Default text formatting - anything goes.
+
:wikitext(string.format(" (%s)", self.removalNotice))
−
        textCell
+
end
−
            .cssText(self.textstyle)
+
else
−
            .wikitext(self.text)
+
-- Default text formatting - anything goes.
−
    end
+
textCell
 +
:cssText(self.textstyle or nil)
 +
:wikitext(self.text or nil)
 +
end
  
−
    -- Add the right-hand image.
+
-- Add the right-hand image.
−
    if self.imageRight then
+
if self.imageRight then
−
        local imageRightCell = row.tag('td').addClass('mbox-imageright')
+
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
−
        if self.imageCellDiv then
+
if self.imageCellDiv then
−
            imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
+
-- If we are using a div, redefine imageRightCell so that the image
−
        end
+
-- is inside it.
−
        imageRightCell
+
imageRightCell = imageRightCell:tag('div'):css('width', '52px')
−
            .wikitext(self.imageRight)
+
end
−
    end
+
imageRightCell
 +
:wikitext(self.imageRight or nil)
 +
end
  
−
    -- Add the below row.
+
-- Add the below row.
−
    if self.below then
+
if self.below then
−
        boxTable.tag('tr')
+
boxTable:tag('tr')
−
            .tag('td')
+
:tag('td')
−
                .attr('colspan', self.imageRight and '3' or '2')
+
:attr('colspan', self.imageRight and '3' or '2')
−
                .addClass('mbox-text')
+
:addClass('mbox-text')
−
                .cssText(self.textstyle)
+
:cssText(self.textstyle or nil)
−
                .wikitext(self.below)
+
:wikitext(self.below or nil)
−
    end
+
end
  
−
    -- Add error message for invalid type parameters.
+
-- Add error message for invalid type parameters.
−
    if self.invalidTypeError then
+
if self.invalidTypeError then
−
        root
+
root:tag('div')
−
            .tag('div')
+
:css('text-align', 'center')
−
                .css('text-align', 'center')
+
:wikitext(string.format(
−
                .wikitext(format('This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or ''))
+
'This message box is using an invalid "type=%s" parameter and needs fixing.',
−
    end
+
self.type or ''
 +
))
 +
end
  
−
    -- Add categories.
+
-- Add categories.
−
    root
+
root:wikitext(self:renderCategories() or nil)
−
        .wikitext(self.categories)
 
  
−
    return tostring(root)
+
return tostring(root)
 
end
 
end
  
−
local function main(boxType, args)
+
--------------------------------------------------------------------------------
−
    box:setTitle(args)
+
-- Exports
−
    local cfg = box:getConfig(boxType)
+
--------------------------------------------------------------------------------
−
    args = box:removeBlankArgs(cfg, args)
+
 
−
    box:setBoxParameters(cfg, args)
+
local p, mt = {}, {}
−
    return box:export()
+
 
 +
function p._exportClasses()
 +
-- For testing.
 +
return {
 +
MessageBox = MessageBox
 +
}
 
end
 
end
  
−
local function makeWrapper(boxType)
+
function p.main(boxType, args, cfgTables)
−
    return function (frame)
+
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
−
        -- If called via #invoke, use the args passed into the invoking
+
box:setParameters()
−
        -- template, or the args passed to #invoke if any exist. Otherwise
+
box:setCategories()
−
        -- assume args are being passed directly in from the debug console
+
return box:export()
−
        -- 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.
 
−
        local args = {}
 
−
        for k, v in pairs(origArgs) do
 
−
            if type(v) == 'string' then
 
−
                v = trim(v)
 
−
            end
 
−
            args[k] = v
 
−
        end
 
−
        return main(boxType, args)
 
−
    end
 
 
end
 
end
  
−
local p = {
+
function mt.__index(t, k)
−
    main = main,
+
return function (frame)
−
    mbox = makeWrapper('mbox')
+
if not getArgs then
−
}
+
getArgs = require('Module:Arguments').getArgs
−
 
+
end
−
for boxType in pairs(cfgTables) do
+
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
−
    p[boxType] = makeWrapper(boxType)
+
end
 
end
 
end
  
−
return p
+
return setmetatable(p, mt)

Latest revision as of 14:00, 14 July 2018

Documentation for this module may be created at Module:Message box/doc 

-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.

-- Load necessary modules.
require('Module:No globals')
local getArgs
local yesno = require('Module:Yesno')

-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()

-- Define constants
local CONFIG_MODULE = 'Module:Message box/configuration'

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getTitleObject(...)
	-- 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, ...)
	if success then
		return title
	end
end

local function union(t1, t2)
	-- Returns the union of two arrays.
	local vals = {}
	for i, v in ipairs(t1) do
		vals[v] = true
	end
	for i, v in ipairs(t2) do
		vals[v] = true
	end
	local ret = {}
	for k in pairs(vals) do
		table.insert(ret, k)
	end
	table.sort(ret)
	return ret
end

local function getArgNums(args, prefix)
	local nums = {}
	for k, v in pairs(args) do
		local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
		if num then
			table.insert(nums, tonumber(num))
		end
	end
	table.sort(nums)
	return nums
end

--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------

local MessageBox = {}
MessageBox.__index = MessageBox

function MessageBox.new(boxType, args, cfg)
	args = args or {}
	local obj = {}

	-- Set the title object and the namespace.
	obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()

	-- Set the config for our box type.
	obj.cfg = cfg[boxType]
	if not obj.cfg then
		local ns = obj.title.namespace
		-- boxType is "mbox" or invalid input
		if ns == 0 then
			obj.cfg = cfg.ambox -- main namespace
		elseif ns == 6 then
			obj.cfg = cfg.imbox -- file namespace
		elseif ns == 14 then
			obj.cfg = cfg.cmbox -- category namespace
		else
			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

	-- Set the arguments, and remove all blank arguments except for the ones
	-- listed in cfg.allowBlankParams.
	do
		local newArgs = {}
		for k, v in pairs(args) do
			if v ~= '' then
				newArgs[k] = v
			end
		end
		for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
			newArgs[param] = args[param]
		end
		obj.args = newArgs
	end

	-- Define internal data structure.
	obj.categories = {}
	obj.classes = {}
	-- For lazy loading of [[Module:Category handler]].
	obj.hasCategories = false

	return setmetatable(obj, MessageBox)
end

function MessageBox:addCat(ns, cat, sort)
	if not cat then
		return nil
	end
	if sort then
		cat = string.format('[[Category:%s|%s]]', cat, sort)
	else
		cat = string.format('[[Category:%s]]', cat)
	end
	self.hasCategories = true
	self.categories[ns] = self.categories[ns] or {}
	table.insert(self.categories[ns], cat)
end

function MessageBox:addClass(class)
	if not class then
		return nil
	end
	table.insert(self.classes, class)
end

function MessageBox:setParameters()
	local args = self.args
	local cfg = self.cfg

	-- Get type data.
	self.type = args.type
	local typeData = cfg.types[self.type]
	self.invalidTypeError = cfg.showInvalidTypeError
		and self.type
		and not typeData
	typeData = typeData or cfg.types[cfg.default]
	self.typeClass = typeData.class
	self.typeImage = typeData.image

	-- Find if the box has been wrongly substituted.
	self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'

	-- Find whether we are using a small message box.
	self.isSmall = cfg.allowSmall and (
		cfg.smallParam and args.small == cfg.smallParam
		or not cfg.smallParam and yesno(args.small)
	)

	-- Add attributes, classes and styles.
	self.id = args.id
	if yesno(args.plainlinks) ~= false then
		self:addClass('plainlinks')
	end
	for _, class in ipairs(cfg.classes or {}) do
		self:addClass(class)
	end
	if self.isSmall then
		self:addClass(cfg.smallClass or 'mbox-small')
	end
	self:addClass(self.typeClass)
	self:addClass(args.class)
	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
	-- and cfg.templateCategoryRequireName are set.
	self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
	if self.useCollapsibleTextFields
		or cfg.templateCategory
		and cfg.templateCategoryRequireName
	then
		self.name = args.name
		if self.name then
			local templateName = mw.ustring.match(
				self.name,
				'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
			) or self.name
			templateName = 'Template:' .. templateName
			self.templateTitle = getTitleObject(templateName)
		end
		self.isTemplatePage = self.templateTitle
			and mw.title.equals(self.title, self.templateTitle)
	end

	-- Process data for collapsible text fields. At the moment these are only
	-- used in {{ambox}}.
	if self.useCollapsibleTextFields then
		-- Get the self.issue value.
		if self.isSmall and args.smalltext then
			self.issue = args.smalltext
		else
			local sect
			if args.sect == '' then
				sect = 'This ' .. (cfg.sectionDefault or 'page')
			elseif type(args.sect) == 'string' then
				sect = 'This ' .. args.sect
			end
			local issue = args.issue
			issue = type(issue) == 'string' and issue ~= '' and issue or nil
			local text = args.text
			text = type(text) == 'string' and text or nil
			local issues = {}
			table.insert(issues, sect)
			table.insert(issues, issue)
			table.insert(issues, text)
			self.issue = table.concat(issues, ' ')
		end

		-- Get the self.talk value.
		local talk = args.talk
		-- Show talk links on the template page or template subpages if the talk
		-- parameter is blank.
		if talk == ''
			and self.templateTitle
			and (
				mw.title.equals(self.templateTitle, self.title)
				or self.title:isSubpageOf(self.templateTitle)
			)
		then
			talk = '#'
		elseif talk == '' then
			talk = nil
		end
		if talk then
			-- If the talk value is a talk page, make a link to that page. Else
			-- assume that it's a section heading, and make a link to the talk
			-- page of the current page with that section heading.
			local talkTitle = getTitleObject(talk)
			local talkArgIsTalkPage = true
			if not talkTitle or not talkTitle.isTalkPage then
				talkArgIsTalkPage = false
				talkTitle = getTitleObject(
					self.title.text,
					mw.site.namespaces[self.title.namespace].talk.id
				)
			end
			if talkTitle and talkTitle.exists then
				local talkText = 'Relevant discussion may be found on'
				if talkArgIsTalkPage then
					talkText = string.format(
						'%s [[%s|%s]].',
						talkText,
						talk,
						talkTitle.prefixedText
					)
				else
					talkText = string.format(
						'%s the [[%s#%s|talk page]].',
						talkText,
						talkTitle.prefixedText,
						talk
					)
				end
				self.talk = talkText
			end
		end

		-- Get other values.
		self.fix = args.fix ~= '' and args.fix or nil
		local date
		if args.date and args.date ~= '' then
			date = args.date
		elseif args.date == '' and self.isTemplatePage then
			date = lang:formatDate('F Y')
		end
		if date then
			self.date = string.format(" <small>''(%s)''</small>", date)
		end
		self.info = args.info
		if yesno(args.removalnotice) then
			self.removalNotice = cfg.removalNotice
		end
	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.
	if self.isSmall then
		self.text = args.smalltext or args.text
	else
		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
	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
	if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
		or not cfg.imageCheckBlank and imageLeft ~= 'none'
	then
		self.imageLeft = imageLeft
		if not imageLeft then
			local imageSize = self.isSmall
				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
	if not (cfg.imageRightNone and imageRight == 'none') then
		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

	-- 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(nums) 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 = string.format('%s %s %s', mainCat, preposition, date)
			self:addCat(0, catTitle)
			catTitle = getTitleObject('Category:' .. catTitle)
			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
		if allCat then
			self:addCat(0, allCat)
		end
	end
end

function MessageBox:setTemplateCategories()
	local args = self.args
	local cfg = self.cfg

	-- Add template categories.
	if cfg.templateCategory then
		if cfg.templateCategoryRequireName then
			if self.isTemplatePage then
				self:addCat(10, cfg.templateCategory)
			end
		elseif not self.title.isSubpage then
			self:addCat(10, cfg.templateCategory)
		end
	end

	-- Add template error categories.
	if cfg.templateErrorCategory then
		local templateErrorCategory = cfg.templateErrorCategory
		local templateCat, templateSort
		if not self.name and not self.title.isSubpage then
			templateCat = templateErrorCategory
		elseif self.isTemplatePage then
			local paramsToCheck = cfg.templateErrorParamsToCheck or {}
			local count = 0
			for i, param in ipairs(paramsToCheck) do
				if not args[param] then
					count = count + 1
				end
			end
			if count > 0 then
				templateCat = templateErrorCategory
				templateSort = tostring(count)
			end
			if self.categoryNums and #self.categoryNums > 0 then
				templateCat = templateErrorCategory
				templateSort = 'C'
			end
		end
		self:addCat(10, templateCat, templateSort)
	end
end

function MessageBox:setAllNamespaceCategories()
	-- Set categories for all namespaces.
	if self.invalidTypeError then
		local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
		self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
	end
	if self.isSubstituted then
		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()
	if not self.hasCategories then
		-- No categories added, no need to pass them to Category handler so,
		-- if it was invoked, it would return the empty string.
		-- So we shortcut and return the empty string.
		return ""
	end
	-- Convert category tables to strings and pass them through
	-- [[Module:Category handler]].
	return require('Module:Category handler')._main{
		main = table.concat(self.categories[0] or {}),
		template = table.concat(self.categories[10] or {}),
		all = table.concat(self.categories.all or {}),
		nocat = self.args.nocat,
		page = self.args.page
	}
end

function MessageBox:export()
	local root = mw.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.id or nil)
	for i, class in ipairs(self.classes or {}) do
		boxTable:addClass(class or nil)
	end
	boxTable
		:cssText(self.style or nil)
		:attr('role', 'presentation')

	if self.attrs then
		boxTable:attr(self.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
			-- is inside it. Divs use style="width: 52px;", which limits the
			-- 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.imageLeft or nil)
	elseif self.imageEmptyCell then
		-- Some message boxes define an empty cell if no image is specified, and
		-- some don't. The old template code in templates where empty cells are
		-- 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.imageEmptyCellStyle or 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.textstyle or nil)
		local textCellDiv = textCell:tag('div')
		textCellDiv
			:addClass('mbox-text-span')
			:wikitext(self.issue or nil)
		if (self.talk or self.fix) and not self.isSmall then
			textCellDiv:tag('span')
				:addClass('hide-when-compact')
				:wikitext(self.talk and (' ' .. self.talk) or nil)
				:wikitext(self.fix and (' ' .. self.fix) or nil)
		end
		textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
		if self.info and not self.isSmall then
			textCellDiv
				:tag('span')
				:addClass('hide-when-compact')
				:wikitext(self.info and (' ' .. self.info) or nil)
		end
		if self.removalNotice then
			textCellDiv:tag('small')
				:addClass('hide-when-compact')
				:tag('i')
					:wikitext(string.format(" (%s)", self.removalNotice))
		end
	else
		-- Default text formatting - anything goes.
		textCell
			:cssText(self.textstyle or nil)
			:wikitext(self.text or 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.imageRight or 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.textstyle or nil)
				:wikitext(self.below or 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:renderCategories() or nil)

	return tostring(root)
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p, mt = {}, {}

function p._exportClasses()
	-- For testing.
	return {
		MessageBox = MessageBox
	}
end

function p.main(boxType, args, cfgTables)
	local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
	box:setParameters()
	box:setCategories()
	return box:export()
end

function mt.__index(t, k)
	return function (frame)
		if not getArgs then
			getArgs = require('Module:Arguments').getArgs
		end
		return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
	end
end

return setmetatable(p, mt)
Retrieved from "https://stationeers-wiki.com/index.php?title=Module:Message_box&oldid=4990"