Diff: Module:High-use
Comparing revision #1 (2022-06-12 23:44:07) with revision #2 (2023-02-02 06:54:37).
| Old | New |
|---|---|
local p = {} |
local p = {} |
-- _fetch looks at the "demo" argument. |
-- _fetch looks at the "demo" argument. |
local _fetch = require('Module:Transclusion_count').fetch |
local _fetch = require('Module:Transclusion_count').fetch |
local yesno = require('Module:Yesno') |
local yesno = require('Module:Yesno') |
function p.num(frame, count) |
function p.num(frame, count) |
if count == nil then |
if count == nil then |
if yesno(frame.args['fetch']) == false then |
if yesno(frame.args['fetch']) == false then |
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end |
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end |
else |
else |
count = _fetch(frame) |
count = _fetch(frame) |
end |
end |
end |
end |
-- Build output string |
-- Build output string |
local return_value = "" |
local return_value = "" |
if count == nil then |
if count == nil then |
if frame.args[1] == "risk" then |
if frame.args[1] == "risk" then |
return_value = "a very large number of" |
return_value = "a very large number of" |
else |
else |
return_value = "many" |
return_value = "many" |
end |
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 count >= 100000 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(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 (frame.args[2] == "yes") or (mw.ustring.sub(frame.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+", mw.getContentLanguage():formatNum(math.floor( (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", mw.getContentLanguage():formatNum(math.floor( (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 |
if count and count > 250000 and not yesno (frame:getParent().args['no-percent']) then |
local percent = math.floor( ( (count/frame:callParserFunction('NUMBEROFPAGES', 'R') ) * 100) + 0.5) |
local percent = math.floor( ( (count/frame:callParserFunction('NUMBEROFPAGES', 'R') ) * 100) + 0.5) |
if percent >= 1 then |
if percent >= 1 then |
return_value = string.format("%s pages, or roughly %s%% of all", return_value, percent) |
return_value = string.format("%s pages, or roughly %s%% of all", return_value, percent) |
end |
end |
end |
end |
end |
end |
return return_value |
return return_value |
end |
end |
-- Actions if there is a large (greater than or equal to 100,000) transclusion count |
-- Actions if there is a large (greater than or equal to 100,000) transclusion count |
function p.risk(frame) |
function p.risk(frame) |
local return_value = "" |
local return_value = "" |
if frame.args[1] == "risk" then |
if frame.args[1] == "risk" then |
return_value = "risk" |
return_value = "risk" |
else |
else |
local count = _fetch(frame) |
local count = _fetch(frame) |
if count and count >= 100000 then return_value = "risk" end |
if count and count >= 100000 then return_value = "risk" end |
end |
end |
return return_value |
return return_value |
end |
end |
function p.text(frame, count) |
function p.text(frame, count) |
-- Only show the information about how this template gets updated if someone |
-- Only show the information about how this template gets updated if someone |
-- is actually editing the page and maybe trying to update the 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 '' |
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 '' |
if count == nil then |
if count == nil then |
if yesno(frame.args['fetch']) == false then |
if yesno(frame.args['fetch']) == false then |
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end |
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end |
else |
else |
count = _fetch(frame) |
count = _fetch(frame) |
end |
end |
end |
end |
local title = mw.title.getCurrentTitle() |
local title = mw.title.getCurrentTitle() |
if title.subpageText == "doc" or title.subpageText == "sandbox" then |
if title.subpageText == "doc" or title.subpageText == "sandbox" then |
title = title.basePageTitle |
title = title.basePageTitle |
end |
end |
local systemMessages = frame.args['system'] |
local systemMessages = frame.args['system'] |
if frame.args['system'] == '' then |
if frame.args['system'] == '' then |
systemMessages = nil |
systemMessages = nil |
end |
end |
-- This retrieves the project URL automatically to simplify localiation. |
-- This retrieves the project URL automatically to simplify localiation. |
local templateCount = ('on [https://linkcount.toolforge.org/index.php?project=%s&page=%s %s pages]'):format( |
local templateCount = ('on [https://linkcount.toolforge.org/index.php?project=%s&page=%s %s pages]'):format( |
mw.title.getCurrentTitle():fullUrl():gsub('//(.-)/.*', '%1'), |
mw.title.getCurrentTitle():fullUrl():gsub('//(.-)/.*', '%1'), |
mw.uri.encode(title.fullText), p.num(frame, count)) |
mw.uri.encode(title.fullText), p.num(frame, count)) |
local used_on_text = "'''This " .. (mw.title.getCurrentTitle().namespace == 828 and "Lua module" or "template") .. ' is used '; |
local used_on_text = "'''This " .. (mw.title.getCurrentTitle().namespace == 828 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 .. systemMessages .. |
((count and count > 2000) and ("''', and " .. templateCount) or ("'''")) |
((count and 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|/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( |
(mw.title.getCurrentTitle().namespace == 828 and "module" or "template"), |
(mw.title.getCurrentTitle().namespace == 828 and "module" or "template"), |
title.fullText, title.fullText, |
title.fullText, title.fullText, |
mw.title.getCurrentTitle().namespace == 828 and "Module:Sandbox|module sandbox" or "iWiki:User pages#SUB|user subpage" |
mw.title.getCurrentTitle().namespace == 828 and "Module:Sandbox|module sandbox" or "iWiki:User pages#SUB|user subpage" |
) |
) |
local infoArg = frame.args["info"] ~= "" and frame.args["info"] |
local infoArg = frame.args["info"] ~= "" and frame.args["info"] |
if (systemMessages or frame.args[1] == "risk" or (count and count >= 100000) ) then |
if (systemMessages or frame.args[1] == "risk" or (count and count >= 100000) ) then |
local info = systemMessages and '.<br/>Changes to it can cause immediate changes to the iWiki user interface.' or '.' |
local info = systemMessages and '.<br/>Changes to it can cause immediate changes to the iWiki user interface.' or '.' |
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 '') .. |
(count and count >= 100000 and ' and server load' or '') .. |
', 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. ' |
else |
else |
sandbox_text = (infoArg and ('.<br />' .. infoArg .. ' C') or ' and c') .. |
sandbox_text = (infoArg and ('.<br />' .. infoArg .. ' C') or ' and c') .. |
'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 frame.args["2"] and frame.args["2"] ~= "" and frame.args["2"] ~= "yes" then |
discussion_text = string.format("%sat [[%s]]", discussion_text, frame.args["2"]) |
discussion_text = string.format("%sat [[%s]]", discussion_text, frame.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 |
end |
function p.main(frame) |
function p.main(frame) |
local count = nil |
local count = nil |
if yesno(frame.args['fetch']) == false then |
if yesno(frame.args['fetch']) == false then |
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end |
if (frame.args[1] or '') ~= '' then count = tonumber(frame.args[1]) end |
else |
else |
count = _fetch(frame) |
count = _fetch(frame) |
end |
end |
local image = "[[File:Ambox warning yellow.svg|40px|alt=Warning|link=]]" |
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 |
if frame.args['system'] and frame.args['system'] ~= '' then |
image = "[[File:Ambox important.svg|40px|alt=Warning|link=]]" |
image = "[[File:Ambox important.svg|40px|alt=Warning|link=]]" |
type_param = "content" |
type_param = "content" |
local nocat = frame:getParent().args['nocat'] or frame.args['nocat'] |
local nocat = frame:getParent().args['nocat'] or frame.args['nocat'] |
local categorise = (nocat == '' or not yesno(nocat)) |
local categorise = (nocat == '' or not yesno(nocat)) |
if categorise then |
if categorise then |
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]]}}}}') |
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]]}}}}') |
end |
end |
elseif (frame.args[1] == "risk" or (count and count >= 100000)) then |
elseif (frame.args[1] == "risk" or (count and count >= 100000)) then |
image = "[[File:Ambox warning orange.svg|40px|alt=Warning|link=]]" |
image = "[[File:Ambox warning orange.svg|40px|alt=Warning|link=]]" |
type_param = "content" |
type_param = "content" |
end |
end |
if frame.args["form"] == "editnotice" then |
if frame.args["form"] == "editnotice" then |
return frame:expandTemplate{ |
return frame:expandTemplate{ |
title = 'editnotice', |
title = 'editnotice', |
args = { |
args = { |
["image"] = image, |
["image"] = image, |
["text"] = p.text(frame, count), |
["text"] = p.text(frame, count), |
["expiry"] = (frame.args["expiry"] or "") |
["expiry"] = (frame.args["expiry"] or "") |
} |
} |
} .. epilogue |
} .. epilogue |
else |
else |
return require('Module:Message box').main('ombox', { |
return require('Module:Message box').main('ombox', { |
type = type_param, |
type = type_param, |
image = image, |
image = image, |
text = p.text(frame, count), |
text = p.text(frame, count), |
expiry = (frame.args["expiry"] or "") |
expiry = (frame.args["expiry"] or "") |
}) .. epilogue |
}) .. epilogue |
end |
end |
end |
end |
return p |
return p |