Modul:Effective protection level

Module documentation

[view] [edit] [history] [purge]

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: reviewer or autoconfirmed
• The page being in the MediaWiki namespace: sysop
• The page being a JavaScript or CSS subpage in userspace: sysop
• The page being protected: sysop, templateeditor, or autoconfirmed
• The page being used in a cascading-protected page: sysop
• The page's title matching the titleblacklist: accountcreator 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

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}}

The above documentation is transcluded from Modul:Effective protection level/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this module.

local p = {}
local blacklistentry = nil

-- 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' and pagename.prefixedText then
		title = pagename
	elseif pagename then
		title = mw.title.new(pagename)
	else
		title = 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 title.isSubpage and ( title.contentModel == 'javascript' or title.contentModel == 'css' ) then -- user JS or CSS page
		return 'sysop'
	end
	local level = title.protectionLevels[action] and title.protectionLevels[action][1]
	if level == 'sysop' then
		return 'sysop'
	elseif title.cascadingProtection and title.cascadingProtection.restrictions[action] and title.cascadingProtection.restrictions[action][1] then -- used by a cascading-protected page
		return 'sysop'
	elseif level == 'templateeditor' then
		return 'templateeditor'
	elseif action == 'move' then
		-- no TitleBlacklist extension, so comment out
		-- 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
	end
	-- no TitleBlacklist extension, so comment out
	-- 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

-- unfortunately with REL1_23 setting of metatable doesn't seem to work.
-- more precisely: setting metatables works, but Scribunto strips them when the module is returned to the mw environment
-- you can thereby use metatables as long as you are within your module. but it gets lost at the final return :(
--[[
setmetatable(p, { __index = function(t, k)
	return function(frame)
		return t._main(k, frame.args[1])
	end
end })
--]]

-- we have to declare a function for each action manually. reason see line 65ff
function p.edit(frame)
	return p._main('edit', frame.args[1])
end

function p.create(frame)
	return p._main('create', frame.args[1])
end

function p.move(frame)
	return p._main('move', frame.args[1])
end

function p.upload(frame)
	return p._main('upload', frame.args[1])
end

function p.autoreview(frame)
	return p._main('autoreview', frame.args[1])
end

return p