Module:Namespace detect/data: Difference between revisions

From The Satanic Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
--[[
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--                                                                           --
--                         Namespace detect data                            --
--                            NAMESPACE DETECT                                --
-- This module holds data for [[Module:Namespace detect]] to be loaded per   --
--                                                                            --
-- page, rather than per #invoke, for performance reasons.                   --
-- This module implements the {{namespace detect}} template in Lua, with a   --
-- few improvements: all namespaces and all namespace aliases are supported, --
-- and namespace names are detected automatically for the local wiki. The    --
-- module can also use the corresponding subject namespace value if it is    --
-- used on a talk page. Parameter names can be configured for different wikis --
-- by altering the values in the "cfg" table in                              --
-- Module:Namespace detect/config.                                            --
--                                                                            --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--]]
 
local cfg = mw.title.new( 'Module:Namespace detect/config').exists and require('Module:Namespace detect/config') or require('Dev:Namespace detect/config')
local data = mw.loadData('Module:Namespace detect/data')
 
local argKeys = data.argKeys
local function addKey(t, key, defaultKey)
local cfg = data.cfg
if key ~= defaultKey then
local mappings = data.mappings
t[#t + 1] = key
local yesno = require('Module:Yesno')
local mArguments -- Lazily initialise Module:Arguments
local mTableTools -- Lazily initilalise Module:TableTools
local ustringLower = mw.ustring.lower
local p = {}
local function fetchValue(t1, t2)
-- Fetches a value from the table t1 for the first key in array t2 where
-- a non-nil value of t1 exists.
for i, key in ipairs(t2) do
local value = t1[key]
if value ~= nil then
return value
end
end
return nil
end
local function equalsArrayValue(t, value)
-- Returns true if value equals a value in the array t. Otherwise
-- returns false.
for i, arrayValue in ipairs(t) do
if value == arrayValue then
return true
end
end
return false
end
function p.getPageObject(page)
-- Get the page object, passing the function through pcall in case of
-- errors, e.g. being over the expensive function count limit.
if page then
local success, pageObject = pcall(mw.title.new, page)
if success then
return pageObject
else
return nil
end
else
return mw.title.getCurrentTitle()
end
end
end
end
 
-- Provided for backward compatibility with other modules
-- Get a table of parameters to query for each default parameter name.
function p.getParamMappings()
-- This allows wikis to customise parameter names in the cfg table while
return mappings
-- ensuring that default parameter names will always work. The cfg table
-- values can be added as a string, or as an array of strings.
 
local defaultKeys = {
'main',
'talk',
'other',
'subjectns',
'demospace',
'demopage'
}
 
local argKeys = {}
for i, defaultKey in ipairs(defaultKeys) do
argKeys[defaultKey] = {defaultKey}
end
end
 
local function getNamespace(args)
for defaultKey, t in pairs(argKeys) do
-- This function gets the namespace name from the page object.
local cfgValue = cfg[defaultKey]
local page = fetchValue(args, argKeys.demopage)
local cfgValueType = type(cfgValue)
if page == '' then
if cfgValueType == 'string' then
page = nil
addKey(t, cfgValue, defaultKey)
end
elseif cfgValueType == 'table' then
local demospace = fetchValue(args, argKeys.demospace)
for i, key in ipairs(cfgValue) do
if demospace == '' then
addKey(t, key, defaultKey)
demospace = nil
end
local subjectns = fetchValue(args, argKeys.subjectns)
local ret
if demospace then
-- Handle "demospace = main" properly.
if equalsArrayValue(argKeys.main, ustringLower(demospace)) then
ret = mw.site.namespaces[0].name
else
ret = demospace
end
else
local pageObject = p.getPageObject(page)
if pageObject then
if pageObject.isTalkPage then
-- Get the subject namespace if the option is set,
-- otherwise use "talk".
if yesno(subjectns) then
ret = mw.site.namespaces[pageObject.namespace].subject.name
else
ret = 'talk'
end
else
ret = pageObject.nsText
end
else
return nil -- return nil if the page object doesn't exist.
end
end
end
end
ret = ret:gsub('_', ' ')
cfg[defaultKey] = nil -- Free the cfg value as we don't need it any more.
return ustringLower(ret)
end
end
 
function p._main(args)
local function getParamMappings()
-- Check the parameters stored in the mappings table for any matches.
local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
local params = mappings[namespace] or {}
local ret = fetchValue(args, params)
--[[
--[[
-- If there were no matches, return parameters for other namespaces.
-- Returns a table of how parameter names map to namespace names. The keys
-- This happens if there was no text specified for the namespace that
-- are the actual namespace names, in lower case, and the values are the
-- was detected or if the demospace parameter is not a valid
-- possible parameter names for that namespace, also in lower case. The
-- namespace. Note that the parameter for the detected namespace must be
-- table entries are structured like this:
-- completely absent for this to happen, not merely blank.
-- {
--   [''] = {'main'},
--   ['wikipedia'] = {'wikipedia', 'project', 'wp'},
--  ...
-- }
--]]
--]]
if ret == nil then
local mappings = {}
ret = fetchValue(args, argKeys.other)
local mainNsName = mw.site.subjectNamespaces[0].name
end
mainNsName = mw.ustring.lower(mainNsName)
return ret
mappings[mainNsName] = mw.clone(argKeys.main)
end
mappings['talk'] = mw.clone(argKeys.talk)
for nsid, ns in pairs(mw.site.subjectNamespaces) do
function p.main(frame)
if nsid ~= 0 then -- Exclude main namespace.
mArguments = require('Module:Arguments')
local nsname = mw.ustring.lower(ns.name)
local args = mArguments.getArgs(frame, {removeBlanks = false})
local canonicalName = mw.ustring.lower(ns.canonicalName)
local ret = p._main(args)
mappings[nsname] = {nsname}
return ret or ''
if canonicalName ~= nsname then
end
table.insert(mappings[nsname], canonicalName)
end
function p.table(frame)
for _, alias in ipairs(ns.aliases) do
--[[
table.insert(mappings[nsname], mw.ustring.lower(alias))
-- Create a wikitable of all subject namespace parameters, for
-- documentation purposes. The talk parameter is optional, in case it
-- needs to be excluded in the documentation.
--]]
-- Load modules and initialise variables.
mTableTools = require('Module:TableTools')
local namespaces = mw.site.namespaces
local cfg = data.cfg
local useTalk = type(frame) == 'table'  
and type(frame.args) == 'table'
and yesno(frame.args.talk) -- Whether to use the talk parameter.
-- Get the header names.
local function checkValue(value, default)
if type(value) == 'string' then
return value
else
return default
end
end
local nsHeader = checkValue(cfg.wikitableNamespaceHeader, 'Namespace')
local aliasesHeader = checkValue(cfg.wikitableAliasesHeader, 'Aliases')
-- Put the namespaces in order.
local mappingsOrdered = {}
for nsname, params in pairs(mappings) do
if useTalk or nsname ~= 'talk' then
local nsid = namespaces[nsname].id
-- Add 1, as the array must start with 1; nsid 0 would be lost otherwise.
nsid = nsid + 1
mappingsOrdered[nsid] = params
end
end
mappingsOrdered = mTableTools.compressSparseArray(mappingsOrdered)
-- Build the table.
local ret = '{| class="wikitable"'
.. '\n|-'
.. '\n! ' .. nsHeader
.. '\n! ' .. aliasesHeader
for i, params in ipairs(mappingsOrdered) do
for j, param in ipairs(params) do
if j == 1 then
ret = ret .. '\n|-'
.. '\n| <code>' .. param .. '</code>'
.. '\n| '
elseif j == 2 then
ret = ret .. '<code>' .. param .. '</code>'
else
ret = ret .. ', <code>' .. param .. '</code>'
end
end
end
end
end
end
ret = ret .. '\n|-'
return mappings
.. '\n|}'
return ret
end
end
 
return p
return {
argKeys = argKeys,
cfg = cfg,
mappings = getParamMappings()
}

Latest revision as of 03:08, 30 April 2021

This module holds data for Module:Namespace detect to be loaded per page, rather than per #invoke, for performance reasons.


--------------------------------------------------------------------------------
--                          Namespace detect data                             --
-- This module holds data for [[Module:Namespace detect]] to be loaded per    --
-- page, rather than per #invoke, for performance reasons.                    --
--------------------------------------------------------------------------------

local cfg = mw.title.new( 'Module:Namespace detect/config').exists and require('Module:Namespace detect/config') or require('Dev:Namespace detect/config')

local function addKey(t, key, defaultKey)
	if key ~= defaultKey then
		t[#t + 1] = key
	end
end

-- Get a table of parameters to query for each default parameter name.
-- This allows wikis to customise parameter names in the cfg table while
-- ensuring that default parameter names will always work. The cfg table
-- values can be added as a string, or as an array of strings.

local defaultKeys = {
	'main',
	'talk',
	'other',
	'subjectns',
	'demospace',
	'demopage'
}

local argKeys = {}
for i, defaultKey in ipairs(defaultKeys) do
	argKeys[defaultKey] = {defaultKey}
end

for defaultKey, t in pairs(argKeys) do
	local cfgValue = cfg[defaultKey]
	local cfgValueType = type(cfgValue)
	if cfgValueType == 'string' then
		addKey(t, cfgValue, defaultKey)
	elseif cfgValueType == 'table' then
		for i, key in ipairs(cfgValue) do
			addKey(t, key, defaultKey)
		end
	end
	cfg[defaultKey] = nil -- Free the cfg value as we don't need it any more.
end

local function getParamMappings()
	--[[
	-- Returns a table of how parameter names map to namespace names. The keys
	-- are the actual namespace names, in lower case, and the values are the
	-- possible parameter names for that namespace, also in lower case. The
	-- table entries are structured like this:
	-- {
	--   [''] = {'main'},
	--   ['wikipedia'] = {'wikipedia', 'project', 'wp'},
	--   ...
	-- }
	--]]
	local mappings = {}
	local mainNsName = mw.site.subjectNamespaces[0].name
	mainNsName = mw.ustring.lower(mainNsName)
	mappings[mainNsName] = mw.clone(argKeys.main)
	mappings['talk'] = mw.clone(argKeys.talk)
	for nsid, ns in pairs(mw.site.subjectNamespaces) do
		if nsid ~= 0 then -- Exclude main namespace.
			local nsname = mw.ustring.lower(ns.name)
			local canonicalName = mw.ustring.lower(ns.canonicalName)
			mappings[nsname] = {nsname}
			if canonicalName ~= nsname then
				table.insert(mappings[nsname], canonicalName)
			end
			for _, alias in ipairs(ns.aliases) do
				table.insert(mappings[nsname], mw.ustring.lower(alias))
			end
		end
	end
	return mappings
end

return {
	argKeys = argKeys,
	cfg = cfg,
	mappings = getParamMappings()
}