模組:Message box

-- This is a meta-module for producing message box templates, including-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.-- Require necessary modules.local getArgs = require('Module:Arguments').getArgslocal htmlBuilder = require('Module:HtmlBuilder')local categoryHandler = require('Module:Category handler').mainlocal yesno = require('Module:Yesno')-- Load the configuration page.local cfgTables = mw.loadData('Module:Message box/configuration')-- Get a language object for formatDate and ucfirst.local lang = mw.language.getContentLanguage()-- Set aliases for often-used functions to reduce table lookups.local format = mw.ustring.formatlocal tinsert = table.insertlocal tconcat = table.concatlocal trim = mw.text.trim---------------------------------------------------------------------------------- Helper functions--------------------------------------------------------------------------------local function getTitleObject(page, ...)if type(page) == 'string' then-- Get the title object, passing the function through pcall -- in case we are over the expensive function count limit.local success, title = pcall(mw.title.new, page, ...)if success thenreturn titleendendendlocal function union(t1, t2)-- Returns the union of two arrays.local vals = {}for i, v in ipairs(t1) dovals[v] = trueendfor i, v in ipairs(t2) dovals[v] = trueendlocal ret = {}for k in pairs(vals) dotinsert(ret, k)endtable.sort(ret)return retendlocal function getArgNums(args, prefix)local nums = {}for k, v in pairs(args) dolocal num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')if num thentinsert(nums, tonumber(num))endendtable.sort(nums)return numsend---------------------------------------------------------------------------------- Box class definition--------------------------------------------------------------------------------local box = {}box.__index = boxfunction box.new()local obj = {}setmetatable(obj, box)return objendfunction box.getNamespaceId(ns)if not ns then return endif type(ns) == 'string' thenns = lang:ucfirst(mw.ustring.lower(ns))if ns == 'Main' thenns = 0endendlocal nsTable = mw.site.namespaces[ns]if nsTable thenreturn nsTable.idendendfunction box.getMboxType(nsid)-- Gets the mbox type from a namespace number.if nsid == 0 thenreturn 'ambox' -- main namespaceelseif nsid == 6 thenreturn 'imbox' -- file namespaceelseif nsid == 14 thenreturn 'cmbox' -- category namespaceelselocal nsTable = mw.site.namespaces[nsid]if nsTable and nsTable.isTalk thenreturn 'tmbox' -- any talk namespaceelsereturn 'ombox' -- other namespaces or invalid inputendendendfunction box:addCat(ns, cat, sort)if type(cat) ~= 'string' then return endlocal nsVals = {'main', 'template', 'all'}local tnamefor i, val in ipairs(nsVals) doif ns == val thentname = ns .. 'Cats'endendif not tname thenfor i, val in ipairs(nsVals) donsVals[i] = format('"%s"', val)enderror('invalid ns parameter passed to box:addCat; valid values are '.. mw.text.listToText(nsVals, nil, ' or '))endself[tname] = self[tname] or {}if type(sort) == 'string' thentinsert(self[tname], format('[[Category:%s|%s]]', cat, sort))elsetinsert(self[tname], format('[[Category:%s]]', cat))endendfunction box:addClass(class)if type(class) ~= 'string' then return endself.classes = self.classes or {}tinsert(self.classes, class)endfunction box:addAttr(attr, val)if type(attr) ~= 'string' or type(val) ~= 'string' then return endself.attrs = self.attrs or {}tinsert(self.attrs, attr)endfunction box:setTitle(args)-- Get the title object and the namespace.self.pageTitle = getTitleObject(args.page ~= '' and args.page)self.title = self.pageTitle or mw.title.getCurrentTitle()self.demospace = args.demospace ~= '' and args.demospace or nilself.nsid = box.getNamespaceId(self.demospace) or self.title.namespaceendfunction box:getConfig(boxType)-- Get the box config data from the data page.if boxType == 'mbox' thenboxType = box.getMboxType(self.nsid)endlocal cfg = cfgTables[boxType]if not cfg thenlocal boxTypes = {}for k, v in pairs(dataTables) dotinsert(boxTypes, format('"%s"', k))endtinsert(boxTypes, '"mbox"')error(format('invalid message box type "%s"; valid types are %s',tostring(boxType),mw.text.listToText(boxTypes)), 2)endreturn cfgendfunction box:removeBlankArgs(cfg, args)-- Only allow blank arguments for the parameter names listed in-- cfg.allowBlankParams.local newArgs = {}for k, v in pairs(args) doif v ~= '' thennewArgs[k] = vendendfor i, param in ipairs(cfg.allowBlankParams or {}) donewArgs[param] = args[param]endreturn newArgsendfunction box:setBoxParameters(cfg, args)-- Get type data.self.type = args.typelocal typeData = cfg.types[self.type]self.invalidTypeError = cfg.showInvalidTypeErrorand self.typeand not typeDataand trueor falsetypeData = typeData or cfg.types[cfg.default]self.typeClass = typeData.classself.typeImage = typeData.image-- Find if the box has been wrongly substituted.if cfg.substCheck and args.subst == 'SUBST' thenself.isSubstituted = trueend-- Find whether we are using a small message box.if cfg.allowSmall and (cfg.smallParam and args.small == cfg.smallParamor not cfg.smallParam and yesno(args.small))thenself.isSmall = trueelseself.isSmall = falseend-- Add attributes, classes and styles.if cfg.allowId thenself.id = args.idendself:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks')for _, class in ipairs(cfg.classes or {}) doself:addClass(class)endif self.isSmall thenself:addClass(cfg.smallClass or 'mbox-small')endself:addClass(self.typeClass)self:addClass(args.class)self.style = args.styleself.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.useCollapsibleTextFieldsif self.useCollapsibleTextFieldsor cfg.templateCategoryand cfg.templateCategoryRequireNamethenself.name = args.nameif self.name thenlocal templateName = mw.ustring.match(self.name,'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$') or self.nametemplateName = 'Template:' .. templateNameself.templateTitle = getTitleObject(templateName)endself.isTemplatePage = self.templateTitleand mw.title.equals(self.title, self.templateTitle)or falseend-- 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 thenself.issue = args.smalltextelselocal sectif args.sect == '' thensect = 'This ' .. (cfg.sectionDefault or 'page')elseif type(args.sect) == 'string' thensect = 'This ' .. args.sectendlocal issue = args.issueissue = type(issue) == 'string' and issue ~= '' and issue or nillocal text = args.texttext = type(text) == 'string' and text or nillocal issues = {}tinsert(issues, sect)tinsert(issues, issue)tinsert(issues, text)self.issue = tconcat(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))thentalk = '#'elseif talk == '' thentalk = nilendif 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 = trueif not talkTitle or not talkTitle.isTalkPage thentalkArgIsTalkPage = falsetalkTitle = getTitleObject(self.title.text,mw.site.namespaces[self.title.namespace].talk.id)endif talkTitle and talkTitle.exists thenlocal talkText = 'Relevant discussion may be found on'if talkArgIsTalkPage thentalkText = format('%s [[%s|%s]].',talkText,talk,talkTitle.prefixedText)elsetalkText = format('%s the [[%s#%s|talk page]].',talkText,talkTitle.prefixedText,talk)endself.talk = talkTextendend-- Get other values.self.fix = args.fix ~= '' and args.fix or nillocal dateif args.date and args.date ~= '' thendate = args.dateelseif args.date == '' and self.isTemplatePage thendate = lang:formatDate('F Y')endif date thenself.date = format(" <small>''(%s)''</small>", date)endself.info = args.infoend-- 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 thenself.text = args.smalltext or args.textelseself.text = args.textend-- Set the below row.self.below = cfg.below and args.below-- General image settings.self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or falseself.imageEmptyCell = cfg.imageEmptyCellif cfg.imageEmptyCellStyle thenself.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'end-- Left image settings.local imageLeft = self.isSmall and args.smallimage or args.imageif cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'or not cfg.imageCheckBlank and imageLeft ~= 'none'thenself.imageLeft = imageLeftif not imageLeft thenlocal imageSize = self.isSmalland (cfg.imageSmallSize or '30x30px')or '40x40px'self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImageor 'Imbox notice.png', imageSize)endend-- Right image settings.local imageRight = self.isSmall and args.smallimageright or args.imagerightif not (cfg.imageRightNone and imageRight == 'none') thenself.imageRight = imageRightend-- Add mainspace categories. At the moment these are only used in {{ambox}}.if cfg.allowMainspaceCategories thenif args.cat thenargs.cat1 = args.catendself.catNums = getArgNums(args, 'cat')if args.category thenargs.category1 = args.categoryendself.categoryNums = getArgNums(args, 'category')if args.all thenargs.all1 = args.allendself.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.datedate = type(date) == 'string' and datelocal preposition = 'from'for _, num in ipairs(self.categoryParamNums) dolocal mainCat = args['cat' .. tostring(num)]or args['category' .. tostring(num)]local allCat = args['all' .. tostring(num)]mainCat = type(mainCat) == 'string' and mainCatallCat = type(allCat) == 'string' and allCatif mainCat and date and date ~= '' thenlocal catTitle = format('%s %s %s', mainCat, preposition, date)self:addCat('main', catTitle)catTitle = getTitleObject('Category:' .. catTitle)if not catTitle or not catTitle.exists thenself:addCat('main','Articles with invalid date parameter in template')endelseif mainCat and (not date or date == '') thenself:addCat('main', mainCat)endif allCat thenself:addCat('main', allCat)endendend-- Add template-namespace categories.if cfg.templateCategory thenif cfg.templateCategoryRequireName thenif self.isTemplatePage thenself:addCat('template', cfg.templateCategory)endelseif not self.title.isSubpage thenself:addCat('template', cfg.templateCategory)endend-- Add template error category.if cfg.templateErrorCategory thenlocal templateErrorCategory = cfg.templateErrorCategorylocal templateCat, templateSortif not self.name and not self.title.isSubpage thentemplateCat = templateErrorCategoryelseif self.isTemplatePage thenlocal paramsToCheck = cfg.templateErrorParamsToCheck or {}local count = 0for i, param in ipairs(paramsToCheck) doif not args[param] thencount = count + 1endendif count > 0 thentemplateCat = templateErrorCategorytemplateSort = tostring(count)endif self.categoryNums and #self.categoryNums > 0 thentemplateCat = templateErrorCategorytemplateSort = 'C'endendself:addCat('template', templateCat, templateSort)end-- Categories for all namespaces.if self.invalidTypeError thenlocal allSort = (self.nsid == 0 and 'Main:' or '') .. self.title.prefixedTextself:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)endif self.isSubstituted thenself:addCat('all', 'Pages with incorrectly substituted templates')end-- Convert category tables to strings and pass them through-- [[Module:Category handler]].self.categories = categoryHandler{main = tconcat(self.mainCats or {}),template = tconcat(self.templateCats or {}),all = tconcat(self.allCats or {}),nocat = args.nocat,demospace = self.demospace,page = self.pageTitle and self.pageTitle.prefixedText or nil}endfunction box:export()local root = htmlBuilder.create()-- Add the subst check error.if self.isSubstituted and self.name thenroot.tag('b').addClass('error').wikitext(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)for i, class in ipairs(self.classes or {}) doboxTable.addClass(class)endboxTable.cssText(self.style).attr('role', 'presentation')for attr, val in pairs(self.attrs or {}) doboxTable.attr(attr, val)end-- Add the left-hand image.local row = boxTable.tag('tr')if self.imageLeft thenlocal 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') endimageLeftCell.wikitext(self.imageLeft)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)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)local textCellSpan = textCell.tag('span')textCellSpan.addClass('mbox-text-span').wikitext(self.issue)if not self.isSmall thentextCellSpan.tag('span').addClass('hide-when-compact').wikitext(self.talk and ' ' .. self.talk).wikitext(self.fix and ' ' .. self.fix)endtextCellSpan.wikitext(self.date and ' ' .. self.date)if not self.isSmall thentextCellSpan.tag('span').addClass('hide-when-compact').wikitext(self.info and ' ' .. self.info)endelse-- Default text formatting - anything goes.textCell.cssText(self.textstyle).wikitext(self.text)end-- Add the right-hand image.if self.imageRight thenlocal 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')endimageRightCell.wikitext(self.imageRight)end-- Add the below row.if self.below thenboxTable.tag('tr').tag('td').attr('colspan', self.imageRight and '3' or '2').addClass('mbox-text').cssText(self.textstyle).wikitext(self.below)end-- Add error message for invalid type parameters.if self.invalidTypeError thenroot.tag('div').css('text-align', 'center').wikitext(format('This message box is using an invalid "type=%s" parameter and needs fixing.',self.type or ''))end-- Add categories.root.wikitext(self.categories)return tostring(root)endlocal function main(boxType, args)local outputBox = box.new()outputBox:setTitle(args)local cfg = outputBox:getConfig(boxType)args = outputBox:removeBlankArgs(cfg, args)outputBox:setBoxParameters(cfg, args)return outputBox:export()endlocal function makeWrapper(boxType)return function (frame)local args = getArgs(frame, {trim = false, removeBlanks = false})return main(boxType, args)endendlocal p = {main = main,mbox = makeWrapper('mbox')}for boxType in pairs(cfgTables) dop[boxType] = makeWrapper(boxType)endreturn p