Thismodule is rated asready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned onhelp pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed throughsandbox testing rather than repeated trial-and-error editing.
This Lua module is used in system messages, and onapproximately 73,000 pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption, any changes should be tested in the module's/sandbox or/testcases subpages, or in your ownmodule sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on thetalk page before implementing them.
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 a JavaScript or CSS subpage in userspace, or in the MediaWiki namespace: interfaceadmin
The page being in the MediaWiki namespace: sysop
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.
The function accepts two parameters. The first is a string containing the action to check, which must be one of "edit", "create", "move", "upload", "undelete", 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.
localp={}-- 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.functionp._main(action,pagename)localtitleiftype(pagename)=='table'andpagename.prefixedTextthentitle=pagenameelseifpagenamethentitle=mw.title.new(pagename)elsetitle=mw.title.getCurrentTitle()endpagename=title.prefixedTextifaction=='autoreview'thenlocallevel=mw.ext.FlaggedRevs.getStabilitySettings(title)level=levelandlevel.autoreviewiflevel=='review'thenreturn'reviewer'elseiflevel~=''thenreturnlevelelsereturnnil-- 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 reviewendelseifaction~='edit'andaction~='move'andaction~='create'andaction~='upload'andaction~='undelete'thenerror('First parameter must be one of edit, move, create, upload, undelete, autoreview',2)endiftitle.namespace==8then-- MediaWiki namespaceiftitle.text:sub(-3)=='.js'ortitle.text:sub(-4)=='.css'ortitle.contentModel=='javascript'ortitle.contentModel=='css'then-- site JS or CSS pagereturn'interfaceadmin'elseiftitle.baseText=="Gadgets-definition"thenreturn'interfaceadmin'else-- any non-JS/CSS MediaWiki pagereturn'sysop'endelseiftitle.namespace==2andtitle.isSubpagetheniftitle.contentModel=='javascript'ortitle.contentModel=='css'then-- user JS or CSS pagereturn'interfaceadmin'elseiftitle.contentModel=='json'then-- user JSON pagereturn'sysop'endendifaction=='undelete'thenreturn'sysop'endlocallevel=title.protectionLevels[action]andtitle.protectionLevels[action][1]iflevel=='sysop'orlevel=='editprotected'thenreturn'sysop'elseiftitle.cascadingProtection.restrictions[action]andtitle.cascadingProtection.restrictions[action][1]then-- used by a cascading-protected pagereturn'sysop'elseiflevel=='templateeditor'thenreturn'templateeditor'elseifaction=='move'thenlocalblacklistentry=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.ifblacklistentryandnotblacklistentry.params.autoconfirmedthenreturn'templateeditor'elseiftitle.namespace==6thenreturn'filemover'elseiflevel=='extendedconfirmed'thenreturn'extendedconfirmed'elsereturn'autoconfirmed'endendlocalblacklistentry=mw.ext.TitleBlacklist.test(action,pagename)ifblacklistentrythenifnotblacklistentry.params.autoconfirmedthenreturn'templateeditor'elseiflevel=='extendedconfirmed'thenreturn'extendedconfirmed'elsereturn'autoconfirmed'endelseiflevel=='editsemiprotected'then-- create-semiprotected pages return this for some reasonreturn'autoconfirmed'elseiflevelthenreturnlevelelseifaction=='upload'thenreturn'autoconfirmed'elseifaction=='create'andtitle.namespace%2==0andtitle.namespace~=118then-- You need to be registered, but not autoconfirmed, to create non-talk pages other than draftsiftitle.namespace==0thenreturn'autoconfirmed'-- Per [[WP:ACPERM]], you need to be autoconfirmed to create pages in mainspaceendreturn'user'elsereturn'*'endendsetmetatable(p,{__index=function(t,k)returnfunction(frame)returnt._main(k,frame.args[1])endend})returnp
