Difference between revisions of "Module:Message box"
bring in changes from sandbox
>Jackmcbarn (bring in changes from sandbox) |
|||
| Line 1: | Line 1: | ||
-- This is a meta-module for producing message box templates, including | -- This is a meta-module for producing message box templates, including | ||
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}. | -- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}. | ||
-- | -- Load necessary modules. | ||
require('Module:No globals') | |||
local | local getArgs | ||
local categoryHandler = require('Module:Category handler'). | local categoryHandler = require('Module:Category handler')._main | ||
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
-- 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() | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
-- Helper functions | -- Helper functions | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local function getTitleObject( | 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 | ||
end | end | ||
local function union(t1, t2) | local function union(t1, t2) | ||
-- Returns the union of two arrays. | -- Returns the union of two arrays. | ||
| Line 46: | Line 35: | ||
local ret = {} | local ret = {} | ||
for k in pairs(vals) do | for k in pairs(vals) do | ||
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 = {} | ||
| Line 57: | Line 46: | ||
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 | ||
table.insert(nums, tonumber(num)) | |||
end | end | ||
end | end | ||
| Line 63: | Line 52: | ||
return nums | return nums | ||
end | end | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
-- Box class definition | -- Box class definition | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local | local MessageBox = {} | ||
MessageBox.__index = MessageBox | |||
function | function MessageBox.new(boxType, args, cfg) | ||
args = args or {} | |||
local obj = {} | 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 | |||
if | elseif ns == 14 then | ||
obj.cfg = cfg.cmbox -- category namespace | |||
else | 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 | ||
end | end | ||
-- Set the arguments, and remove all blank arguments except for the ones | |||
-- listed in cfg.allowBlankParams. | |||
do | |||
local | local newArgs = {} | ||
for k, v in pairs(args) do | |||
if v ~= '' then | |||
newArgs[k] = v | |||
end | |||
end | end | ||
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do | |||
newArgs[param] = args[param] | |||
for i, | |||
end | end | ||
obj.args = newArgs | |||
end | end | ||
-- Define internal data structure. | |||
obj.categories = {} | |||
obj.classes = {} | |||
return setmetatable(obj, MessageBox) | |||
end | end | ||
function | function MessageBox:addCat(ns, cat, sort) | ||
if not cat then | |||
return nil | |||
if | |||
end | end | ||
if sort then | |||
if | cat = string.format('[[Category:%s|%s]]', cat, sort) | ||
else | |||
cat = string.format('[[Category:%s]]', cat) | |||
end | end | ||
self.categories[ns] = self.categories[ns] or {} | |||
table.insert(self.categories[ns], cat) | |||
end | end | ||
function | function MessageBox:addClass(class) | ||
if not class then | |||
return nil | |||
end | end | ||
table.insert(self.classes, class) | |||
end | end | ||
function | function MessageBox:setParameters() | ||
local args = self.args | |||
local cfg = self.cfg | |||
-- Get type data. | -- Get type data. | ||
self.type = args.type | self.type = args.type | ||
| Line 198: | Line 140: | ||
and self.type | and self.type | ||
and not typeData | and not typeData | ||
typeData = typeData or cfg.types[cfg.default] | typeData = typeData or cfg.types[cfg.default] | ||
self.typeClass = typeData.class | self.typeClass = typeData.class | ||
self.typeImage = typeData.image | self.typeImage = typeData.image | ||
-- Find if the box has been wrongly substituted. | -- 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. | -- Find whether we are using a small message box. | ||
self.isSmall = cfg.allowSmall and ( | |||
cfg.smallParam and args.small == cfg.smallParam | cfg.smallParam and args.small == cfg.smallParam | ||
or not cfg.smallParam and yesno(args.small) | or not cfg.smallParam and yesno(args.small) | ||
) | ) | ||
-- Add attributes, classes and styles. | -- Add attributes, classes and styles. | ||
if cfg.allowId then | if cfg.allowId then | ||
| Line 237: | Line 170: | ||
self.style = args.style | self.style = args.style | ||
self.attrs = args.attrs | self.attrs = args.attrs | ||
-- Set text style. | -- Set text style. | ||
self.textstyle = args.textstyle | self.textstyle = args.textstyle | ||
-- Find if we are on the template page or not. This functionality is only | -- Find if we are on the template page or not. This functionality is only | ||
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory | -- used if useCollapsibleTextFields is set, or if both cfg.templateCategory | ||
| Line 260: | Line 193: | ||
self.isTemplatePage = self.templateTitle | self.isTemplatePage = self.templateTitle | ||
and mw.title.equals(self.title, self.templateTitle) | and mw.title.equals(self.title, self.templateTitle) | ||
end | end | ||
-- Process data for collapsible text fields. At the moment these are only | -- Process data for collapsible text fields. At the moment these are only | ||
-- used in {{ambox}}. | -- used in {{ambox}}. | ||
| Line 281: | Line 213: | ||
text = type(text) == 'string' and text or nil | text = type(text) == 'string' and text or nil | ||
local issues = {} | local issues = {} | ||
table.insert(issues, sect) | |||
table.insert(issues, issue) | |||
table.insert(issues, text) | |||
self.issue = | self.issue = table.concat(issues, ' ') | ||
end | end | ||
-- Get the self.talk value. | -- Get the self.talk value. | ||
local talk = args.talk | local talk = args.talk | ||
| Line 292: | Line 224: | ||
-- parameter is blank. | -- parameter is blank. | ||
if talk == '' | if talk == '' | ||
and self.templateTitle | and self.templateTitle | ||
and ( | and ( | ||
mw.title.equals(self.templateTitle, self.title) | mw.title.equals(self.templateTitle, self.title) | ||
| Line 318: | Line 250: | ||
local talkText = 'Relevant discussion may be found on' | local talkText = 'Relevant discussion may be found on' | ||
if talkArgIsTalkPage then | if talkArgIsTalkPage then | ||
talkText = format( | talkText = string.format( | ||
'%s [[%s|%s]].', | '%s [[%s|%s]].', | ||
talkText, | talkText, | ||
| Line 325: | Line 257: | ||
) | ) | ||
else | else | ||
talkText = format( | talkText = string.format( | ||
'%s the [[%s#%s|talk page]].', | '%s the [[%s#%s|talk page]].', | ||
talkText, | talkText, | ||
| Line 335: | Line 267: | ||
end | end | ||
end | end | ||
-- Get other values. | -- Get other values. | ||
self.fix = args.fix ~= '' and args.fix or nil | self.fix = args.fix ~= '' and args.fix or nil | ||
| Line 345: | Line 277: | ||
end | end | ||
if date then | if date then | ||
self.date = format(" <small>''(%s)''</small>", date) | self.date = string.format(" <small>''(%s)''</small>", date) | ||
end | end | ||
self.info = args.info | self.info = args.info | ||
end | end | ||
-- Set the non-collapsible text field. At the moment this is used by all box | -- 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. | -- types other than ambox, and also by ambox when small=yes. | ||
| Line 357: | Line 289: | ||
self.text = args.text | self.text = args.text | ||
end | end | ||
-- Set the below row. | -- Set the below row. | ||
self.below = cfg.below and args.below | self.below = cfg.below and args.below | ||
-- General image settings. | -- General image settings. | ||
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv | self.imageCellDiv = not self.isSmall and cfg.imageCellDiv | ||
self.imageEmptyCell = cfg.imageEmptyCell | self.imageEmptyCell = cfg.imageEmptyCell | ||
if cfg.imageEmptyCellStyle then | if cfg.imageEmptyCellStyle then | ||
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px' | self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px' | ||
end | end | ||
-- Left image settings. | -- Left image settings. | ||
local imageLeft = self.isSmall and args.smallimage or args.image | local imageLeft = self.isSmall and args.smallimage or args.image | ||
| Line 378: | Line 310: | ||
and (cfg.imageSmallSize or '30x30px') | and (cfg.imageSmallSize or '30x30px') | ||
or '40x40px' | or '40x40px' | ||
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage | self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage | ||
or 'Imbox notice.png', imageSize) | or 'Imbox notice.png', imageSize) | ||
end | end | ||
end | end | ||
-- Right image settings. | -- Right image settings. | ||
local imageRight = self.isSmall and args.smallimageright or args.imageright | local imageRight = self.isSmall and args.smallimageright or args.imageright | ||
| Line 388: | Line 320: | ||
self.imageRight = imageRight | self.imageRight = imageRight | ||
end | end | ||
end | |||
-- | |||
function MessageBox:setMainspaceCategories() | |||
local args = self.args | |||
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 | end | ||
if allCat then | |||
self:addCat(0, allCat) | |||
if | |||
end | end | ||
end | end | ||
end | |||
-- Add template | |||
function MessageBox:setTemplateCategories() | |||
local args = self.args | |||
local cfg = self.cfg | |||
-- Add template categories. | |||
if cfg.templateCategory then | if cfg.templateCategory then | ||
if cfg.templateCategoryRequireName then | if cfg.templateCategoryRequireName then | ||
if self.isTemplatePage then | if self.isTemplatePage then | ||
self:addCat( | self:addCat(10, cfg.templateCategory) | ||
end | end | ||
elseif not self.title.isSubpage then | elseif not self.title.isSubpage then | ||
self:addCat( | self:addCat(10, cfg.templateCategory) | ||
end | end | ||
end | end | ||
-- Add template error | -- Add template error categories. | ||
if cfg.templateErrorCategory then | if cfg.templateErrorCategory then | ||
local templateErrorCategory = cfg.templateErrorCategory | local templateErrorCategory = cfg.templateErrorCategory | ||
| Line 468: | Line 400: | ||
end | end | ||
end | end | ||
self:addCat( | self:addCat(10, templateCat, templateSort) | ||
end | end | ||
end | |||
-- | |||
function MessageBox:setAllNamespaceCategories() | |||
-- Set categories for all namespaces. | |||
if self.invalidTypeError then | if self.invalidTypeError then | ||
local allSort = (self. | local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText | ||
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort) | self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort) | ||
end | end | ||
| Line 479: | Line 413: | ||
self:addCat('all', 'Pages with incorrectly substituted templates') | self:addCat('all', 'Pages with incorrectly substituted templates') | ||
end | 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 | -- Convert category tables to strings and pass them through | ||
-- [[Module:Category handler]]. | -- [[Module:Category handler]]. | ||
return categoryHandler{ | |||
main = | main = table.concat(self.categories[0] or {}), | ||
template = | template = table.concat(self.categories[10] or {}), | ||
all = | all = table.concat(self.categories.all or {}), | ||
nocat = args.nocat | nocat = self.args.nocat, | ||
page = self.args.page | |||
page = self. | |||
} | } | ||
end | end | ||
function | function MessageBox:export() | ||
local root = | local root = mw.html.create() | ||
-- Add the subst check error. | -- Add the subst check error. | ||
if self.isSubstituted and self.name then | if self.isSubstituted and self.name then | ||
root | 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 | end | ||
-- Create the box table. | -- Create the box table. | ||
local boxTable = root | local boxTable = root:tag('table') | ||
boxTable | boxTable:attr('id', self.id or nil) | ||
for i, class in ipairs(self.classes or {}) do | for i, class in ipairs(self.classes or {}) do | ||
boxTable | boxTable:addClass(class or nil) | ||
end | end | ||
boxTable | boxTable | ||
:cssText(self.style or nil) | |||
:attr('role', 'presentation') | |||
boxTable | if self.attrs then | ||
boxTable:attr(self.attrs) | |||
end | end | ||
-- Add the left-hand image. | -- Add the left-hand image. | ||
local row = boxTable | local row = boxTable:tag('tr') | ||
if self.imageLeft then | if self.imageLeft then | ||
local imageLeftCell = row | 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 | -- If we are using a div, redefine imageLeftCell so that the image | ||
| Line 531: | Line 472: | ||
-- image width to 52px. If any images in a div are wider than that, | -- 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. | -- they may overlap with the text or cause other display problems. | ||
imageLeftCell = imageLeftCell | imageLeftCell = imageLeftCell:tag('div'):css('width', '52px') | ||
end | end | ||
imageLeftCell | imageLeftCell:wikitext(self.imageLeft or nil) | ||
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 | ||
| Line 540: | Line 480: | ||
-- specified gives the following hint: "No image. Cell with some width | -- specified gives the following hint: "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 | row:tag('td') | ||
:addClass('mbox-empty-cell') | |||
:cssText(self.imageEmptyCellStyle or nil) | |||
end | end | ||
-- Add the text. | -- Add the text. | ||
local textCell = row | 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 | -- The message box uses advanced text parameters that allow things to be | ||
-- collapsible. At the moment, only ambox uses this. | -- collapsible. At the moment, only ambox uses this. | ||
textCell | textCell:cssText(self.textstyle or nil) | ||
local textCellSpan = textCell:tag('span') | |||
local textCellSpan = textCell | |||
textCellSpan | textCellSpan | ||
:addClass('mbox-text-span') | |||
:wikitext(self.issue or nil) | |||
if not self.isSmall then | if not self.isSmall then | ||
textCellSpan | textCellSpan:tag('span') | ||
:addClass('hide-when-compact') | |||
:wikitext(self.talk and (' ' .. self.talk) or nil) | |||
:wikitext(self.fix and (' ' .. self.fix) or nil) | |||
end | end | ||
textCellSpan | textCellSpan:wikitext(self.date and (' ' .. self.date) or nil) | ||
if not self.isSmall then | if not self.isSmall then | ||
textCellSpan | textCellSpan | ||
:tag('span') | |||
:addClass('hide-when-compact') | |||
:wikitext(self.info and (' ' .. self.info) or nil) | |||
end | end | ||
else | else | ||
-- Default text formatting - anything goes. | -- Default text formatting - anything goes. | ||
textCell | textCell | ||
:cssText(self.textstyle or nil) | |||
:wikitext(self.text or nil) | |||
end | end | ||
-- Add the right-hand image. | -- Add the right-hand image. | ||
if self.imageRight then | if self.imageRight then | ||
local imageRightCell = row | local imageRightCell = row:tag('td'):addClass('mbox-imageright') | ||
if self.imageCellDiv then | if self.imageCellDiv then | ||
-- If we are using a div, redefine imageRightCell so that the image | -- If we are using a div, redefine imageRightCell so that the image | ||
-- is inside it. | -- is inside it. | ||
imageRightCell = imageRightCell | imageRightCell = imageRightCell:tag('div'):css('width', '52px') | ||
end | end | ||
imageRightCell | imageRightCell | ||
:wikitext(self.imageRight or nil) | |||
end | end | ||
-- Add the below row. | -- Add the below row. | ||
if self.below then | if self.below then | ||
boxTable | 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 | 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') | ||
:css('text-align', 'center') | |||
:wikitext(string.format( | |||
'This message box is using an invalid "type=%s" parameter and needs fixing.', | |||
self.type or '' | |||
)) | |||
end | end | ||
-- Add categories. | -- Add categories. | ||
root | root:wikitext(self:renderCategories() or nil) | ||
return tostring(root) | return tostring(root) | ||
end | end | ||
local function | -------------------------------------------------------------------------------- | ||
-- Exports | |||
-------------------------------------------------------------------------------- | |||
local | |||
local p, mt = {}, {} | |||
return | 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('Module:Message box/configuration')) | |||
box:setParameters() | |||
box:setCategories() | |||
return box:export() | |||
end | end | ||
function mt.__index(t, k) | |||
return function (frame) | 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 | ||
end | end | ||
return setmetatable(p, mt) | |||