경고: 이 문서의 오래된 판을 편집하고 있습니다. 이것을 게시하면, 이 판 이후로 바뀐 모든 편집이 사라집니다. 귀하는 로그인되어 있지 않습니다. 이대로 편집하면 귀하의 IP 주소가 편집 기록에 남게 됩니다.스팸 방지 검사입니다. 이것을 입력하지 마세요!-- This module implements {{pp-meta}} and its daughter templates such as -- {{pp-dispute}}, {{pp-vandalism}} and {{pp-sock}}. -- Initialise necessary modules. require('Module:No globals') local class = require('Module:Middleclass').class local mArguments = require('Module:Arguments') local mFileLink = require('Module:File link') local mProtectionLevel = require('Module:Effective protection level') local yesno = require('Module:Yesno') -------------------------------------------------------------------------------- -- PageData class -------------------------------------------------------------------------------- --[[ -- This class represents a MediaWiki page, just as the mw.title object does. -- The difference is that this class is much simpler, using only the fields -- necessary for this module. This is to keep the module extensible while -- keeping the code as simple as possible, e.g. this way we do not expose -- mw.title's protectionLevels property to classes that only need to know a -- page's namespace. The "data" in PageData is so that this class can be more -- easily differentiated with mw.title. --]] local PageData = class('PageData') function PageData:initialize(titleObj) self._namespace = titleObj.namespace end function PageData:getNamespace() return self._namespace end -------------------------------------------------------------------------------- -- ProtectionStatus class -------------------------------------------------------------------------------- local ProtectionStatus = class('ProtectionStatus') function ProtectionStatus:initialize(args, titleObj) -- Set action do local actions = { create = true, edit = true, move = true, autoreview = true } if args.action and actions[args.action] then self._action = args.action else self._action = 'edit' end end -- Set level do local level = mProtectionLevel._main(self._action, titleObj) if level == 'accountcreator' then -- Lump titleblacklisted pages in with template-protected pages, -- since templateeditors can do both. level = 'templateeditor' end self._level = level or '*' end -- Set reason self._reason = args.reason -- Set expiry self._expiry = args.expiry or 'indef' end function ProtectionStatus:getAction() return self._action end function ProtectionStatus:getLevel() return self._level end function ProtectionStatus:getReason() return self._reason end function ProtectionStatus:getExpiry() return self._expiry end -------------------------------------------------------------------------------- -- Config class -------------------------------------------------------------------------------- local Config = class('Config') function Config:initialize() self._cfg = mw.loadData('Module:Protection banner/config') end function Config:getBannerConfig(protectionStatusObj) local cfg = self._cfg local action = protectionStatusObj:getAction() local reason = protectionStatusObj:getReason() if cfg.banners[action][reason] then return cfg.banners[action][reason] else return cfg.defaultBanners[action] end end function Config:getConfigTable(key) local blacklist = { banners = true, defaultBanners = true } if not blacklist[key] then return self._cfg[key] else return nil end end -------------------------------------------------------------------------------- -- Image class -------------------------------------------------------------------------------- local Image = class('Image') function Image:initialize(configObj, protectionStatusObj, pageDataObj) self._configObj = configObj self._protectionStatusObj = protectionStatusObj self._pageDataObj = pageDataObj end function Image:setFilename(filename) if filename then self._filename = filename else local images, action, level, reason, namespace do local configObj = self._configObj local protectionStatusObj = self._protectionStatusObj local pageDataObj = self._pageDataObj images = configObj:getConfigTable('images') action = protectionStatusObj:getAction() level = protectionStatusObj:getLevel() reason = protectionStatusObj:getReason() namespace = pageDataObj:getNamespace() end local image if reason == 'office' or reason == 'reset' then image = images.office elseif namespace == 10 or namespace == 828 then -- We are in the template or module namespaces. if level == 'templateeditor' then image = images.template elseif level == 'sysop' then image = images.indef end elseif action == 'create' then image = images.create elseif action == 'move' and ( level == 'templateeditor' or level == 'sysop' ) then image = images.move elseif action == 'edit' then if level == 'sysop' then image = images.full elseif level == 'autoconfirmed' then image = images.semi end elseif action == 'autoreview' then if level == 'autoconfirmed' then image = images.pc1 elseif level == 'reviewer' then image = images.pc2 end end self._filename = image end end function Image:setWidth(width) self._width = width end function Image:setAlt(alt) self._alt = alt end function Image:setLink(link) self._link = link end function Image:setCaption(caption) self._caption = caption end function Image:export() return mFileLink.new(self._filename or 'Transparent.gif') :width(self._width or 20) :alt(self._alt) :link(self._link) :caption(self._caption) :render() end -------------------------------------------------------------------------------- -- Blurb class -------------------------------------------------------------------------------- local Blurb = class('Blurb') function Blurb:initialize(configObj, protectionStatusObj, pageDataObj) self._configObj = configObj self._protectionStatusObj = protectionStatusObj self._bannerConfig = configObj:getBannerConfig(protectionStatusObj) self._pageDataObj = pageDataObj end function Blurb:_makeIntroParameter() end function Blurb:_makePagetypeParameter() local pagetypes = self._configObj:getConfigTable('pagetypeNamespaces') local namespace = self._pageDataObj:getNamespace() return pagetypes[namespace] or pagetypes.default or 'page' end function Blurb:_substituteParameters(msg) if not self._params then local params, parameterFuncs = {}, {} setmetatable(params, { __index = function (t, k) local param if parameterFuncs[k] then param = parameterFuncs[k]() end params[k] = param return param end }) parameterFuncs[1] = function () return self:_makeIntroParameter() end -- TODO: Write parameter functions self._params = params end return mw.message.newRawMessage(msg):params(self._params):plain() end -------------------------------------------------------------------------------- -- BannerTemplate class -------------------------------------------------------------------------------- local BannerTemplate = class('BannerTemplate') function BannerTemplate:initialize() end function BannerTemplate:render() end -------------------------------------------------------------------------------- -- Banner class -------------------------------------------------------------------------------- local Banner = BannerTemplate:subclass('Banner') -------------------------------------------------------------------------------- -- Padlock class -------------------------------------------------------------------------------- local Padlock = BannerTemplate:subclass('Padlock') -------------------------------------------------------------------------------- -- BannerFactory class -------------------------------------------------------------------------------- local BannerFactory = class('BannerFactory') function BannerFactory:initialize( args, configObj, protectionStatusObj, pageDataObj ) -- Set dependent objects self._configObj = configObj self._protectionStatusObj = protectionStatusObj self._pageDataObj = pageDataObj -- Set object paradigm to use if yesno(args.small) then self._paradigm = 'padlock' else self._paradigm = 'banner' end end function BannerFactory:newBannerTemplate() end function BannerFactory:newBlurb() end function BannerFactory:newImage() local image = Image:new() if self._paradigm == 'padlock' then image:setWidth(20) else image:setWidth(40) end return image end -------------------------------------------------------------------------------- -- Category class -------------------------------------------------------------------------------- local Category = class('Category') function Category:initialize() end function Category:setName(name) self._name = name end function Category:export() if self._categoryName then return string.format( '[[%s:%s]]', mw.site.namespaces[14].name, self._categoryName ) else return '' end end -------------------------------------------------------------------------------- -- ProtectionCategory class -------------------------------------------------------------------------------- local ProtectionCategory = Category:subclass('ProtectionCategory') function ProtectionCategory:setName( name, configObj, protectionStatusObj, namespace ) --[[ -- Sets the protection category. If a category name is not provided, this -- method gets a category name from the module config, given a combination -- of the protection type, the protection level, the namespace number, the -- reason for protection, and the expiry date. --]] -- If a name was provided, use that. if name then Category.setName(self, name) end -- Get the namespace category key from the namespace number. local nskey do local categoryNamespaces = configObj:getConfigTable('categoryNamespaces') if not namespace or type(namespace) ~= 'number' then nskey = nil else nskey = categoryNamespaces[ns] if not nskey and ns % 2 == 1 then nskey = 'talk' end end end --[[ -- Define the properties table. Each property is a table containing the -- canonical order that the property is tested in, the position the -- property has in the category key strings, and the property value itself. --]] local properties = { expiry = {order = 1, keypos = 5, val = protectionStatusObj:getExpiry()}, namespace = {order = 2, keypos = 3, val = nskey}, reason = {order = 3, keypos = 4, val = protectionStatusObj:getReason()}, level = {order = 4, keypos = 2, val = protectionStatusObj:getLevel()}, action = {order = 5, keypos = 1, val = protectionStatusObj:getAction()} } --[[ -- Apply the category order configuration, if any. The configuration value -- will be a property string, e.g. 'reason', 'namespace', etc. The property -- corresponding to that string is tested last (i.e. it is the most -- important, because it keeps its specified value the longest) and the -- other properties are tested in the canonical order. If no configuration -- value is specified then the canonical order is used. --]] local configOrder = {} do local bannerConfig = configObj:getBannerConfig(protectionStatusObj) local categoryOrder = bannerConfig.categoryOrder for propertiesKey, t in pairs(properties) do configOrder[t.order] = t end if categoryOrder then local property = properties[categoryOrder] if not property then local msg = '"' .. categoryOrder .. '" is not a valid value of cfg.reasons.' .. reason .. '.categoryOrder' error(msg) end table.insert(configOrder, table.remove(configOrder, property.order)) end end --[[ -- Define the attempt order. Properties with no value defined are moved -- to the end, where they will later be given the value "all". This is -- to cut down on the number of table lookups in the cats table, which -- grows exponentially with the number of properties with valid values. -- We keep track of the number of active properties with the noActive -- parameter. --]] local noActive, attemptOrder do local active, inactive = {}, {} for i, t in ipairs(configOrder) do if t.val then active[#active + 1] = t else inactive[#inactive + 1] = t end end noActive = #active attemptOrder = active for i, t in ipairs(inactive) do attemptOrder[#attemptOrder + 1] = t end end --[[ -- Check increasingly generic key combinations until we find a match. -- If a specific category exists for the combination of properties -- we are given, that match will be found first. If not, we keep -- trying different key combinations until we match using the key -- "all-all-all-all-all". -- -- To generate the keys, we index the property subtables using a -- binary matrix with indexes i and j. j is only calculated up to -- the number of active properties. For example, if there were three -- active properties, the matrix would look like this, with 0 -- corresponding to the string "all", and 1 corresponding to the -- val field in the property table: -- -- j 1 2 3 -- i -- 1 1 1 1 -- 2 0 1 1 -- 3 1 0 1 -- 4 0 0 1 -- 5 1 1 0 -- 6 0 1 0 -- 7 1 0 0 -- 8 0 0 0 -- -- Values of j higher than the number of active properties are set -- to the string "all". -- -- A key for the category table is constructed for each value of i. -- The correct position of the value in the key is determined by the -- pos field in the property table. --]] local cats = configObj:getConfigTable('categories') local cat for i = 1, 2^noActive do local key = {} for j, t in ipairs(attemptOrder) do if j > noActive then key[t.keypos] = 'all' else local quotient = i / 2 ^ (j - 1) quotient = math.ceil(quotient) if quotient % 2 == 1 then key[t.keypos] = t.val else key[t.keypos] = 'all' end end end key = table.concat(key, '-') local attempt = cats[key] if attempt then cat = attempt break end end if cat then Category.setName(self, cat) else error( 'No category match found;' .. ' please define the category for key "all-all-all-all-all"' ) end end -------------------------------------------------------------------------------- -- ExpiryCategory class -------------------------------------------------------------------------------- local ExpiryCategory = Category:subclass('ExpiryCategory') -------------------------------------------------------------------------------- -- ErrorCategory class -------------------------------------------------------------------------------- local ErrorCategory = Category:subclass('ErrorCategory') -------------------------------------------------------------------------------- -- CategoryFactory class -------------------------------------------------------------------------------- local CategoryFactory = class('CategoryFactory') function CategoryFactory:initialize( configObj, protectionStatusObj, pageDataObj ) -- Set dependent objects self._configObj = configObj self._protectionStatusObj = protectionStatusObj self._pageDataObj = pageDataObj end function CategoryFactory:getCategoryObjects() local ret = {} local classes = {ProtectionCategory, ExpiryCategory, ErrorCategory} for i, aClass in ipairs(classes) do ret[#ret + 1] = aClass:new() end return ret end -------------------------------------------------------------------------------- -- ProtectionBanner class -------------------------------------------------------------------------------- local ProtectionBanner = {} function ProtectionBanner.exportToWiki(frame, title) local args = mArguments.getArgs(frame) return ProtectionBanner.exportToLua(args, title) end function ProtectionBanner.exportToLua(args, title) title = title or mw.title.getCurrentTitle() -- Get data objects local thePageData = PageData:new(title) local theProtectionStatus = ProtectionStatus.new(args, title) local theConfig = Config:new() local ret = {} -- Render the banner do local theBannerFactory = BannerFactory:new( args, theConfig, theProtectionStatus, thePageData ) local banner = theBannerFactory:newBannerTemplate() local image = theBannerFactory:newImage() local blurb = theBannerFactory:newBlurb() --TODO: actual rendering ret[#ret + 1] = banner:export() end -- Render the categories do local theCategoryFactory = CategoryFactory:new( theConfig, theProtectionStatus, thePageData ) local categoryObjects = theCategoryFactory:getCategoryObjects() for i, obj in ipairs(categoryObjects) do ret[#ret + 1] = obj:export() end end return table.concat(ret) end function ProtectionBanner._exportClasses() -- This is used to export the classes for testing purposes. return { PageData = PageData, ProtectionStatus = ProtectionStatus, Config = Config, Image = Image, Blurb = Blurb, BannerTemplate = BannerTemplate, Banner = Banner, Padlock = Padlock, BannerFactory = BannerFactory, Category = Category, ProtectionCategory = ProtectionCategory, ErrorCategory = ErrorCategory, ExpiryCategory = ExpiryCategory, CategoryFactory = CategoryFactory } end return ProtectionBanner 편집 요약 가온 위키에서의 모든 기여는 크리에이티브 커먼즈 저작자표시-동일조건변경허락 라이선스로 배포된다는 점을 유의해 주세요(자세한 내용에 대해서는 가온 위키:저작권 문서를 읽어주세요). 만약 여기에 동의하지 않는다면 문서를 저장하지 말아 주세요. 또한, 직접 작성했거나 퍼블릭 도메인과 같은 자유 문서에서 가져왔다는 것을 보증해야 합니다. 저작권이 있는 내용을 허가 없이 저장하지 마세요! 취소 편집 도움말 (새 창에서 열림) 이 문서에서 사용한 틀: 모듈:Protection banner/설명문서 (편집)