Module:Message box: Difference between revisions

Jump to navigation Jump to search
m
1 revision
m (1 revision)
 
m (1 revision)
(One intermediate revision by the same user not shown)
Line 2: Line 2:
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.


-- Require necessary modules.
-- Load necessary modules.
local getArgs = require('Module:Arguments').getArgs
require('Module:No globals')
local htmlBuilder = require('Module:HtmlBuilder')
local getArgs
local categoryHandler = require('Module:Category handler').main
local categoryHandler = require('Module:Category handler')._main
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.
local format = mw.ustring.format
local tinsert = table.insert
local tconcat = table.concat
local trim = mw.text.trim


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Line 24: Line 15:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


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
Line 46: Line 35:
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)
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
tinsert(nums, tonumber(num))
table.insert(nums, tonumber(num))
end
end
end
end
Line 68: Line 57:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local box = {}
local MessageBox = {}
box.__index = box
MessageBox.__index = MessageBox


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


function box.getNamespaceId(ns)
-- Set the title object and the namespace.
if not ns then return end
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
if type(ns) == 'string' then
ns = lang:ucfirst(mw.ustring.lower(ns))
if ns == 'Main' then
ns = 0
end
end
local nsTable = mw.site.namespaces[ns]
if nsTable then
return nsTable.id
end
end


function box.getMboxType(nsid)
-- Set the config for our box type.
-- Gets the mbox type from a namespace number.
obj.cfg = cfg[boxType]
if nsid == 0 then
if not obj.cfg then
return 'ambox' -- main namespace
local ns = obj.title.namespace
elseif nsid == 6 then
-- boxType is "mbox" or invalid input
return 'imbox' -- file namespace
if ns == 0 then
elseif nsid == 14 then
obj.cfg = cfg.ambox -- main namespace
return 'cmbox' -- category namespace
elseif ns == 6 then
else
obj.cfg = cfg.imbox -- file namespace
local nsTable = mw.site.namespaces[nsid]
elseif ns == 14 then
if nsTable and nsTable.isTalk then
obj.cfg = cfg.cmbox -- category namespace
return 'tmbox' -- any talk namespace
else
else
return 'ombox' -- other namespaces or invalid input
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
end


function box:addCat(ns, cat, sort)
-- Set the arguments, and remove all blank arguments except for the ones
if type(cat) ~= 'string' then return end
-- listed in cfg.allowBlankParams.
local nsVals = {'main', 'template', 'all'}
do
local tname
local newArgs = {}
for i, val in ipairs(nsVals) do
for k, v in pairs(args) do
if ns == val then
if v ~= '' then
tname = ns .. 'Cats'
newArgs[k] = v
end
end
end
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
if not tname then
newArgs[param] = args[param]
for i, val in ipairs(nsVals) do
nsVals[i] = format('"%s"', val)
end
end
error(
obj.args = newArgs
'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)
-- Define internal data structure.
if type(class) ~= 'string' then return end
obj.categories = {}
self.classes = self.classes or {}
obj.classes = {}
tinsert(self.classes, class)
end


function box:addAttr(attr, val)
return setmetatable(obj, MessageBox)
if type(attr) ~= 'string' or type(val) ~= 'string' then return end
self.attrs = self.attrs or {}
tinsert(self.attrs, attr)
end
end


function box:setTitle(args)
function MessageBox:addCat(ns, cat, sort)
-- Get the title object and the namespace.
if not cat then
self.pageTitle = getTitleObject(args.page ~= '' and args.page)
return nil
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)
-- Get the box config data from the data page.
if boxType == 'mbox' then
boxType = box.getMboxType(self.nsid)
end
end
local cfg = cfgTables[boxType]
if sort then
if not cfg then
cat = string.format('[[Category:%s|%s]]', cat, sort)
local boxTypes = {}
else
for k, v in pairs(dataTables) do
cat = string.format('[[Category:%s]]', cat)
tinsert(boxTypes, format('"%s"', k))
end
tinsert(boxTypes, '"mbox"')
error(format(
'invalid message box type "%s"; valid types are %s',
tostring(boxType),
mw.text.listToText(boxTypes)
), 2)
end
end
return cfg
self.categories[ns] = self.categories[ns] or {}
table.insert(self.categories[ns], cat)
end
end


function box:removeBlankArgs(cfg, args)
function MessageBox:addClass(class)
-- Only allow blank arguments for the parameter names listed in
if not class then
-- cfg.allowBlankParams.
return nil
local newArgs = {}
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
end
return newArgs
table.insert(self.classes, class)
end
end


function box:setBoxParameters(cfg, args)
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
and true
or false
typeData = typeData or cfg.types[cfg.default]
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeClass = typeData.class
Line 205: Line 145:


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


-- Find whether we are using a small message box.
-- Find whether we are using a small message box.
if cfg.allowSmall and (
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)
)
)
then
self.isSmall = true
else
self.isSmall = false
end


-- Add attributes, classes and styles.
-- Add attributes, classes and styles.
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)
or false
end
end


Line 281: Line 213:
text = type(text) == 'string' and text or nil
text = type(text) == 'string' and text or nil
local issues = {}
local issues = {}
tinsert(issues, sect)
table.insert(issues, sect)
tinsert(issues, issue)
table.insert(issues, issue)
tinsert(issues, text)
table.insert(issues, text)
self.issue = tconcat(issues, ' ')
self.issue = table.concat(issues, ' ')
end
end


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 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
Line 362: Line 294:


-- General image settings.
-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
self.imageEmptyCell = cfg.imageEmptyCell
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
if cfg.imageEmptyCellStyle then
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
Line 387: Line 319:
if not (cfg.imageRightNone and imageRight == 'none') then
if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = 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
end


-- Add mainspace categories. At the moment these are only used in {{ambox}}.
local nums = {}
if cfg.allowMainspaceCategories then
for _, prefix in ipairs{'cat', 'category', 'all'} do
if args.cat then
args[prefix .. '1'] = args[prefix]
args.cat1 = args.cat
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
self.catNums = getArgNums(args, 'cat')
if allCat then
if args.category then
self:addCat(0, allCat)
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', allCat)
end
end
end
end
end
end
function MessageBox:setTemplateCategories()
local args = self.args
local cfg = self.cfg


-- Add template-namespace categories.
-- 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('template', cfg.templateCategory)
self:addCat(10, cfg.templateCategory)
end
end
elseif not self.title.isSubpage then
elseif not self.title.isSubpage then
self:addCat('template', cfg.templateCategory)
self:addCat(10, cfg.templateCategory)
end
end
end
end


-- Add template error category.
-- 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('template', templateCat, templateSort)
self:addCat(10, templateCat, templateSort)
end
end
end


-- Categories for all namespaces.
function MessageBox:setAllNamespaceCategories()
-- Set categories for all namespaces.
if self.invalidTypeError then
if self.invalidTypeError then
local allSort = (self.nsid == 0 and 'Main:' or '') .. self.title.prefixedText
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]].
self.categories = categoryHandler{
return categoryHandler{
main = tconcat(self.mainCats or {}),
main = table.concat(self.categories[0] or {}),
template = tconcat(self.templateCats or {}),
template = table.concat(self.categories[10] or {}),
all = tconcat(self.allCats or {}),
all = table.concat(self.categories.all or {}),
nocat = args.nocat,
nocat = self.args.nocat,
demospace = self.demospace,
page = self.args.page
page = self.pageTitle and self.pageTitle.prefixedText or nil
}
}
end
end


function box:export()
function MessageBox:export()
local root = htmlBuilder.create()
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')
.tag('b')
:addClass('error')
.addClass('error')
:wikitext(string.format(
.wikitext(format(
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
))
))
end
end


-- Create the box table.
-- Create the box table.
local boxTable = root.tag('table')
local boxTable = root:tag('table')
boxTable
boxTable:attr('id', self.id or nil)
.attr('id', self.id)
for i, class in ipairs(self.classes or {}) do
for i, class in ipairs(self.classes or {}) do
boxTable
boxTable:addClass(class or nil)
.addClass(class)
end
end
boxTable
boxTable
.cssText(self.style)
:cssText(self.style or nil)
.attr('role', 'presentation')
:attr('role', 'presentation')
for attr, val in pairs(self.attrs or {}) do
 
boxTable
if self.attrs then
.attr(attr, val)
boxTable:attr(self.attrs)
end
end


-- 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
-- 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.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
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.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
-- 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)
.cssText(self.textstyle)
local textCellSpan = textCell:tag('span')
local textCellSpan = textCell.tag('span')
textCellSpan
textCellSpan
.addClass('mbox-text-span')
:addClass('mbox-text-span')
.wikitext(self.issue)
:wikitext(self.issue or nil)
if not self.isSmall then
if not self.isSmall then
textCellSpan
textCellSpan:tag('span')
.tag('span')
:addClass('hide-when-compact')
.addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
.wikitext(self.talk and ' ' .. self.talk)
:wikitext(self.fix and (' ' .. self.fix) or nil)
.wikitext(self.fix and ' ' .. self.fix)
end
end
textCellSpan
textCellSpan:wikitext(self.date and (' ' .. self.date) or nil)
.wikitext(self.date and ' ' .. self.date)
if not self.isSmall then
if not self.isSmall then
textCellSpan
textCellSpan
.tag('span')
:tag('span')
.addClass('hide-when-compact')
:addClass('hide-when-compact')
.wikitext(self.info and ' ' .. self.info)
: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)
:cssText(self.textstyle or nil)
.wikitext(self.text)
: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.tag('td').addClass('mbox-imageright')
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.tag('div').css('width', '52px')
imageRightCell = imageRightCell:tag('div'):css('width', '52px')
end
end
imageRightCell
imageRightCell
.wikitext(self.imageRight)
:wikitext(self.imageRight or nil)
end
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.',
'This message box is using an invalid "type=%s" parameter and needs fixing.',
self.type or ''
self.type or ''
))
))
end
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)
--------------------------------------------------------------------------------
local outputBox = box.new()
-- Exports
outputBox:setTitle(args)
--------------------------------------------------------------------------------
local cfg = outputBox:getConfig(boxType)
 
args = outputBox:removeBlankArgs(cfg, args)
local p, mt = {}, {}
outputBox:setBoxParameters(cfg, args)
 
return outputBox:export()
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


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


local p = {
return setmetatable(p, mt)
main = main,
mbox = makeWrapper('mbox')
}
 
for boxType in pairs(cfgTables) do
p[boxType] = makeWrapper(boxType)
end
 
return p
14,061

edits

Navigation menu