Module:Effective protection level: Difference between revisions

From CivWiki
Jump to navigation Jump to search
Content added Content deleted
(add a metamethod so the action can be passed as the first param to #invoke instead of 'main')
(make the metatable work with the change coming June 5th)
Line 3: Line 3:
-- Returns the permission required to perform a given action on a given title.
-- Returns the permission required to perform a given action on a given title.
-- If no title is specified, the title of the page being displayed is used.
-- If no title is specified, the title of the page being displayed is used.
function p.main(frame, action, pagename)
function p._main(action, pagename)
frame = frame or mw.getCurrentFrame()
action = action or frame.args.action or frame.args[1]
pagename = pagename or frame.args.pagename or frame.args[2]
local title
local title
if type(pagename) == 'table' then
if type(pagename) == 'table' then
title = pagename
title = pagename
pagename = title.prefixedText
else
else
title = mw.title.new(pagename) or mw.title.getCurrentTitle()
title = pagename and mw.title.new(pagename) or mw.title.getCurrentTitle()
end
end
pagename = title.prefixedText
if action == 'autoreview' then
if action == 'autoreview' then
local level = frame:callParserFunction('PENDINGCHANGELEVEL', pagename)
local level = mw.getCurrentFrame():callParserFunction('PENDINGCHANGELEVEL', pagename)
if level == 'review' then
if level == 'review' then
return 'reviewer'
return 'reviewer'
Line 34: Line 31:
if level == 'sysop' then
if level == 'sysop' then
return 'sysop'
return 'sysop'
elseif frame:callParserFunction('CASCADINGSOURCES', pagename) ~= '' then -- used by a cascading-protected page
elseif mw.getCurrentFrame():callParserFunction('CASCADINGSOURCES', pagename) ~= '' then -- used by a cascading-protected page
return 'sysop'
return 'sysop'
elseif level == 'templateeditor' then
elseif level == 'templateeditor' then
Line 65: Line 62:


setmetatable(p, { __index = function(t, k)
setmetatable(p, { __index = function(t, k)
return function(frame, ...)
return function(frameOrPagename)
if type(frameOrPagename) == 'table' and frameOrPagename.args then
return t.main(frame, k, ...)
return t._main(k, frame.args[1])
else
return t._main(k, frameOrPagename)
end
end
end
end })
end })

Revision as of 00:24, 27 May 2014

This module provides a way to retrieve the group required to perform a given action on a page. It currently tests the following criteria:

  • The page being pending-changes protected: autoconfirmed
  • The page being in the MediaWiki namespace: sysop
  • The page being a JavaScript or CSS subpage in userspace: interfaceadmin
  • The page being a JSON subpage in userspace: sysop
  • The page being protected: sysop, templateeditor, extendedconfirmed, or autoconfirmed
  • The page being used in a cascading-protected page: sysop
  • The page's title matching the titleblacklist: templateeditor or autoconfirmed
  • A file being moved: filemover
  • A page being moved or a file being uploaded: autoconfirmed
  • A non-Draft non-talk page being created: user
  • Anything else: *

Note that if a template-protected file is moved, both filemover and templateeditor are required, but this will return only templateeditor. This is not likely to be changed any time soon, since template protection currently shouldn't be used on files.

Usage

Warning: This module will use up to 4 expensive parser function calls each time it is ran. It should only be used if the exact effective protection level is necessary. Otherwise, consider using title.protectionLevels instead.

From other modules

To load this module:

local effectiveProtectionLevel = require('Module:Effective protection level')._main

The function accepts two parameters. The first is a string containing the action to check, which must be one of "edit", "create", "move", "upload", or "autoreview". The second is optional, and can either be the name of the page to check, or a title returned from the mw.title functions. If the second parameter is omitted, the page being displayed is the one checked against. The return value is a string containing the name of the group required to perform the given action.

From wikitext

The parameters are the same as when it is called directly.

{{#invoke:Effective protection level|action|title}}

See also


local p = {}

-- Returns the permission required to perform a given action on a given title.
-- If no title is specified, the title of the page being displayed is used.
function p._main(action, pagename)
	local title
	if type(pagename) == 'table' then
		title = pagename
	else
		title = pagename and mw.title.new(pagename) or mw.title.getCurrentTitle()
	end
	pagename = title.prefixedText
	if action == 'autoreview' then
		local level = mw.getCurrentFrame():callParserFunction('PENDINGCHANGELEVEL', pagename)
		if level == 'review' then
			return 'reviewer'
		elseif level ~= '' then
			return level
		else
			return nil -- not '*'. a page not being PC-protected is distinct from it being PC-protected with anyone able to review. also not '', as that would mean PC-protected but nobody can review
		end
	elseif action ~= 'edit' and action ~= 'move' and action ~= 'create' and action ~= 'upload' then
		error( 'First parameter must be one of edit, move, create, upload, autoreview', 2 )
	end
	if title.namespace == 8 then -- MediaWiki namespace
		return 'sysop'
	elseif title.namespace == 2 and ( mw.ustring.find( pagename, '/.*%.js$') or mw.ustring.find( pagename, '/.*%.css$') ) then -- user .js or .css page
		return 'sysop'
	else
		local level = title.protectionLevels[action] and title.protectionLevels[action][1]
		if level == 'sysop' then
			return 'sysop'
		elseif mw.getCurrentFrame():callParserFunction('CASCADINGSOURCES', pagename) ~= '' then -- used by a cascading-protected page
			return 'sysop'
		elseif level == 'templateeditor' then
			return 'templateeditor'
		elseif action == 'move' then
			local blacklistentry = mw.ext.TitleBlacklist.test('edit', pagename) -- Testing action edit is correct, since this is for the source page. The target page name gets tested with action move.
			if blacklistentry and not blacklistentry.params.autoconfirmed then
				return 'accountcreator'
			elseif title.namespace == 6 then
				return 'filemover'
			else
				return 'autoconfirmed'
			end
		else
			local blacklistentry = mw.ext.TitleBlacklist.test(action, pagename)
			if blacklistentry then
				return blacklistentry.params.autoconfirmed and 'autoconfirmed' or 'accountcreator'
			elseif level then
				return level
			elseif action == 'upload' then
				return 'autoconfirmed'
			elseif action == 'create' and title.namespace % 2 == 0 and title.namespace ~= 118 then -- You need to be registered, but not autoconfirmed, to create non-talk pages other than drafts
				return 'user'
			else
				return '*'
			end
		end
	end
end

setmetatable(p, { __index = function(t, k)
	return function(frameOrPagename)
		if type(frameOrPagename) == 'table' and frameOrPagename.args then
			return t._main(k, frame.args[1])
		else
			return t._main(k, frameOrPagename)
		end
	end
end })

return p