RACKWiki

Module:High-use: Difference between revisions

Module Discussion

Module:High-use (view source)

Revision as of 22:12, 27 October 2025

2,657 bytes added ,  27 October
m
1 revision imported
m (1 revision imported)
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
require('strict')
local p = {}
local p = {}
local getArgs = require('Module:Arguments').getArgs


-- _fetch looks at the "demo" argument.
local _fetch = require('Module:Transclusion_count')._fetch -- _fetch looks at the 'demo' argument
local _fetch = require('Module:Transclusion_count').fetch
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')


function p.num(frame, count)
local lang_obj = mw.getContentLanguage() -- this here because the language object is used multiple places in the module
local large_count_cutoff = 100000
local approx_num_total_pages = 63000000
 
local user_subpage_info_page = 'Wikipedia:User pages#SUB'
local sandbox_module_page = 'Module:Sandbox'
local system_messages_cat = 'Pages used in system messages needing protection'
local sandbox_word = 'sandbox'
local testcases_word = 'testcases'
local doc_word = 'doc'
 
local function count_from_args(args)
if tonumber(args.count) then -- check if function has already been used
return tonumber(args.count) -- early exit if so
end
local count
if yesno(args['fetch']) ~= false then
count = _fetch(args) -- fetch transclusion count
end
-- use explicitly-provided count when fetch fails
if count == nil and args[1] ~= nil and args[1] ~= '' then
-- convert local language number string to a number understandable by Lua
count = mw.ustring.gsub(args[1], '+$', '')
count = lang_obj:parseFormattedNumber(args[1])
end
-- in case someone writes a non-positive number
if count and count > 0 then
return count
end
return nil
end
 
-- Actions if there is a large (greater than or equal to 100,000) transclusion count
local function risk_boolean(args)
if args.risk == true or args.risk == false then
return args.risk
elseif args[1]  == 'risk' then
return true
else
local count = count_from_args(args)
if count and count >= large_count_cutoff then
return true
end
end
return false
end
 
-- function retained for backwards compatibility
function p._risk(args)
return risk_boolean(args) and 'risk' or ''
end
 
-- function retained for backwards compatibility
function p.risk(frame)
return p._risk(getArgs(frame))
end
 
-- count and no_percent arguments retained for backwards compatibility
function p._num(args, count, no_percent)
if count == nil then
if count == nil then
if yesno(frame.args['fetch']) == false then
count = count_from_args(args)
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end
else
count = _fetch(frame)
end
end
end
args.count = count
args.risk = risk_boolean(args)
-- Build output string
-- Build output string
local return_value = ""
local return_value = ''
if count == nil then
if args.count == nil and args.risk then
if frame.args[1] == "risk" then
return 'a very large number of'
return_value = "a very large number of"
elseif args.count == nil then
else
return 'many'
return_value = "many"
end
else
else
-- Use 2 significant figures for smaller numbers and 3 for larger ones
-- Use 2 significant figures for smaller numbers and 3 for larger ones
local sigfig = 2
local sigfig = 2
if count >= 100000 then
if args.count >= large_count_cutoff then
sigfig = 3
sigfig = 3
end
end
-- Prepare to round to appropriate number of sigfigs
-- Prepare to round to appropriate number of sigfigs
local f = math.floor(math.log10(count)) - sigfig + 1
local f = math.floor(math.log10(args.count)) - sigfig + 1
-- Round and insert "approximately" or "+" when appropriate
-- Round and insert 'approximately' or '+' when appropriate
if (frame.args[2] == "yes") or (mw.ustring.sub(frame.args[1],-1) == "+") then
if yesno(args[2]) == true or (type(args[1]) == 'string' and (mw.ustring.sub(args[1], -1) == '+')) then
-- Round down
-- Round down
return_value = string.format("%s+", mw.getContentLanguage():formatNum(math.floor( (count / 10^(f)) ) * (10^(f))) )
return_value = string.format('%s+', lang_obj:formatNum(math.floor( (args.count / 10^(f)) ) * (10^(f))) )
else
else
-- Round to nearest
-- Round to nearest
return_value = string.format("approximately %s", mw.getContentLanguage():formatNum(math.floor( (count / 10^(f)) + 0.5) * (10^(f))) )
return_value = string.format('approximately %s', lang_obj:formatNum(math.floor( (args.count / 10^(f)) + 0.5) * (10^(f))) )
end
end
 
-- Insert percentage of pages if that is likely to be >= 1% and when |no-percent= not set to yes
-- Insert percentage of pages if that is likely to be >= 1% and when |no-percent= not set to yes
if count and count > 250000 and not yesno (frame:getParent().args['no-percent']) then
no_percent = yesno(no_percent or args['no-percent'])
local percent = math.floor( ( (count/frame:callParserFunction('NUMBEROFPAGES', 'R') ) * 100) + 0.5)
if args.count and args.count >= approx_num_total_pages/100 and not no_percent then
if percent >= 1 then
local num_total_pages = mw.getCurrentFrame():callParserFunction('NUMBEROFPAGES', 'R')
return_value = string.format("%s pages, or roughly %s%% of all", return_value, percent)
local total_percent = math.floor( ( ( args.count/num_total_pages ) * 100) + 0.5)
if total_percent >= 1 then
return_value = string.format('%s pages, or roughly %s%% of all', return_value, total_percent)
end
end
end
end
Line 53: Line 117:
end
end


-- Actions if there is a large (greater than or equal to 100,000) transclusion count
-- used by [[Template:Stub documentation]] and other pages
function p.risk(frame)
-- count argument retained for backwards compatibility
local return_value = ""
function p.num(frame, count)
if frame.args[1] == "risk" then
return p._num(getArgs(frame), count)
return_value = "risk"
else
local count = _fetch(frame)
if count and count >= 100000 then return_value = "risk" end
end
return return_value
end
end


function p.text(frame, count)
-- count argument retained for backwards compatibility
-- Only show the information about how this template gets updated if someone
function p._text(args, count)
-- is actually editing the page and maybe trying to update the count.
--[=[
local bot_text = (frame:preprocess("{{REVISIONID}}") == "") and "\n\n----\n'''Preview message''': Transclusion count updated automatically ([[Template:High-use/doc#Technical details|see documentation]])." or ''
Only show the information about how this template gets updated
if someone is actually editing the page and maybe trying to update the count.
]=]
local bot_text = (mw.getCurrentFrame():preprocess('{{REVISIONID}}') == '') and ("\n\n----\n'''Preview message''':" .. ' Transclusion count updated automatically ([[Template:High-use/doc#Technical details|see documentation]]).') or ''
if count == nil then
if count == nil then
if yesno(frame.args['fetch']) == false then
count = count_from_args(args)
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end
else
count = _fetch(frame)
end
end
end
local title = mw.title.getCurrentTitle()
args.count = count
if title.subpageText == "doc" or title.subpageText == "sandbox" then
args.risk = risk_boolean(args)
-- trim /doc, /sandbox and /testcases
local title = args.title or (args.demo and args.demo ~= '' and mw.title.new(args.demo, 'Template')) or mw.title.getCurrentTitle()
if title.subpageText == doc_word or title.subpageText == sandbox_word or title.subpageText == testcases_word then
title = title.basePageTitle
title = title.basePageTitle
end
end
local systemMessages = frame.args['system']
-- use /testcases of base template
if frame.args['system'] == '' then
local testcases_page = mw.title.new(title.prefixedText .. '/' .. testcases_word)
systemMessages = nil
-- exists is expensive
while testcases_page.basePageTitle.isSubpage and not testcases_page.exists do
testcases_page = mw.title.new(testcases_page.basePageTitle.basePageTitle.prefixedText .. '/' .. testcases_word)
end
end
-- This retrieves the project URL automatically to simplify localiation.
local systemMessages = (args['system'] or '') ~= ''
local templateCount = ('on [https://linkcount.toolforge.org/index.php?project=%s&page=%s %s pages]'):format(
mw.title.getCurrentTitle():fullUrl():gsub('//(.-)/.*', '%1'),
-- This retrieves the project URL automatically to simplify localization.
mw.uri.encode(title.fullText), p.num(frame, count))
local templateCount = ('on [https://linkcount.toolforge.org/?project=%s&page=%s#transclusions %s pages]'):format(
local used_on_text = "'''This " .. (mw.title.getCurrentTitle().namespace == 828 and "Lua module" or "template") .. ' is used ';
title:fullUrl():gsub('//(.-)/.*', '%1'),
mw.uri.encode(title.fullText), p._num(args))
local used_on_text = "'''This " .. (title:inNamespace('Module') and 'Lua module' or 'template') .. ' is used '
if systemMessages then
if systemMessages then
used_on_text = used_on_text .. systemMessages ..
used_on_text = used_on_text .. args['system'] ..
((count and count > 2000) and ("''', and " .. templateCount) or ("'''"))
((args.count and args.count > 2000) and ("''', and " .. templateCount) or ("'''"))
else
else
used_on_text = used_on_text .. templateCount .. "'''"
used_on_text = used_on_text .. templateCount .. "'''"
end
end
local sandbox_text = ('%s\'s [[%s/sandbox|/sandbox]] or [[%s|/testcases]] subpages, or in your own [[%s]]. '):format(
local sandbox_text = ("%s's [[%s/sandbox|/sandbox]] or [[%s/testcases|/testcases]] subpages, or in your own [[%s]]. "):format(
title:inNamespace('Module') and 'module' or 'template',
(mw.title.getCurrentTitle().namespace == 828 and "module" or "template"),
title.fullText,
title.fullText, title.fullText,
testcases_page.fullText,
mw.title.getCurrentTitle().namespace == 828 and "Module:Sandbox|module sandbox" or "Wikipedia:User pages#SUB|user subpage"
title:inNamespace('Module') and (sandbox_module_page .. '|module sandbox') or (user_subpage_info_page .. '|user subpage')
)
)
local infoArg = frame.args["info"] ~= "" and frame.args["info"]
local infoArg = args['info'] ~= '' and args['info']
if (systemMessages or frame.args[1] == "risk" or (count and count >= 100000) ) then
if (systemMessages or args.risk) then
local info = systemMessages and '.<br/>Changes to it can cause immediate changes to the Wikipedia user interface.' or '.'
local info = '.'
if systemMessages then
info = info .. '<br />Changes to it can cause immediate changes to the ' .. mw.site.namespaces.Project.name .. ' user interface.'
end
if infoArg then
if infoArg then
info = info .. "<br />" .. infoArg
info = info .. '<br />' .. infoArg
end
end
sandbox_text = info .. '<br /> To avoid major disruption' ..
sandbox_text = info .. '<br /> To avoid major disruption' ..
(count and count >= 100000 and ' and server load' or '') ..
(args.count and args.count >= large_count_cutoff and ' and server load' or '') .. -- should this use args.risk?
', any changes should be tested in the ' .. sandbox_text ..
', any changes should be tested in the ' .. sandbox_text ..
'The tested changes can be added to this page in a single edit. '
'The tested changes can be added to this page in a single edit. '
Line 120: Line 188:
'hanges may be widely noticed. Test changes in the ' .. sandbox_text
'hanges may be widely noticed. Test changes in the ' .. sandbox_text
end
end
local discussion_text = systemMessages and 'Please discuss changes ' or 'Consider discussing changes '
local discussion_text = systemMessages and 'Please discuss changes ' or 'Consider discussing changes '
if frame.args["2"] and frame.args["2"] ~= "" and frame.args["2"] ~= "yes" then
if args[2] ~= nil and args[2] ~= '' and yesno(args[2]) == nil then
discussion_text = string.format("%sat [[%s]]", discussion_text, frame.args["2"])
discussion_text = string.format('%sat [[%s]]', discussion_text, args[2])
else
else
discussion_text = string.format("%son the [[%s|talk page]]", discussion_text, title.talkPageTitle.fullText )
discussion_text = string.format('%son the [[%s|talk page]]', discussion_text, title.talkPageTitle.fullText)
end
end
return used_on_text .. sandbox_text .. discussion_text .. " before implementing them." .. bot_text
return used_on_text .. sandbox_text .. discussion_text .. ' before implementing them.' .. bot_text
end
 
-- used by [[Template:R from high-use template]]
-- count argument retained for backwards compatibility
function p.text(frame, count)
return p._text(getArgs(frame), count)
end
end


function p.main(frame)
-- nocat argument retained for backwards compatibility
local count = nil
function p._main(args, nocat)
if yesno(frame.args['fetch']) == false then
args.count = count_from_args(args)
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end
args.risk = risk_boolean(args)
else
args.title = (args.demo and args.demo ~= '' and mw.title.new(args.demo, 'Template')) or mw.title.getCurrentTitle()
count = _fetch(frame)
end
local image = 'Ambox warning yellow.svg'
local image = "[[File:Ambox warning yellow.svg|40px|alt=Warning|link=]]"
local type_param = 'style'
local type_param = "style"
local epilogue = ''
local epilogue = ''
if frame.args['system'] and frame.args['system'] ~= '' then
image = "[[File:Ambox important.svg|40px|alt=Warning|link=]]"
if args['system'] and args['system'] ~= '' then
type_param = "content"
image = 'Ambox important.svg'
local nocat = frame:getParent().args['nocat'] or frame.args['nocat']
type_param = 'content'
local categorise = (nocat == '' or not yesno(nocat))
if yesno(nocat or args['nocat']) ~= true and not args.title.isRedirect then
if categorise then
local protection_action = (args.title:inNamespace('File') and 'upload') or 'edit'
epilogue = frame:preprocess('{{Sandbox other||{{#switch:{{#invoke:Effective protection level|{{#switch:{{NAMESPACE}}|File=upload|#default=edit}}|{{FULLPAGENAME}}}}|sysop|templateeditor|interfaceadmin=|#default=[[Category:Pages used in system messages needing protection]]}}}}')
local protection_level = require('Module:Effective protection level')._main(protection_action, args.title.fullText)
if protection_level ~= 'sysop' and protection_level ~= 'templateeditor' and protection_level ~= 'interfaceadmin' then
epilogue = mw.getCurrentFrame():expandTemplate {
title = 'sandbox other',
args = {
[2] = '[[Category:' .. system_messages_cat .. ']]'
}
}
end
end
end
elseif (frame.args[1] == "risk" or (count and count >= 100000)) then
elseif args.risk then
image = "[[File:Ambox warning orange.svg|40px|alt=Warning|link=]]"
image = 'Ambox warning orange.svg'
type_param = "content"
type_param = 'content'
end
end
if frame.args["form"] == "editnotice" then
image = '[[File:' .. image .. '|40px|alt=Warning|link=]]'
return frame:expandTemplate{
if args['form'] == 'editnotice' then
return mw.getCurrentFrame():expandTemplate{
title = 'editnotice',
title = 'editnotice',
args = {
args = {
["image"] = image,
['image'] = image,
["text"] = p.text(frame, count),
['text'] = p._text(args),
["expiry"] = (frame.args["expiry"] or "")
['expiry'] = (args['expiry'] or '')
}
}
} .. epilogue
} .. epilogue
Line 168: Line 250:
type = type_param,
type = type_param,
image = image,
image = image,
text = p.text(frame, count),
text = p._text(args),
expiry = (frame.args["expiry"] or "")
expiry = (args['expiry'] or '')
}) .. epilogue
}) .. epilogue
end
end
end
function p.main(frame)
return p._main(getArgs(frame))
end
end


return p
return p
Retrieved from "https://rackwiki.org/wiki/Special:MobileDiff/174...1596"