Module:Random portal component/sandbox: Difference between revisions
Content deleted Content added
don't throw an error if no "header" argument is provided |
sync |
||
| Line 6: | Line 6: | ||
local currentTitle = mw.title.getCurrentTitle() |
local currentTitle = mw.title.getCurrentTitle() |
||
-- tracking function added by BHG 29/04/2019 |
|||
local portalNamesContainingSlashes = { |
|||
-- called as subPageTrackingCategories(pages, args.max) |
|||
["AC/DC"] = true, |
|||
local function subPageTrackingCategories(pages, max, header) |
|||
} |
|||
local retval = ""; |
|||
local availableSubPageCount = 0; |
|||
local i; |
|||
local thispagetitle = mw.title.getCurrentTitle().text |
|||
-- don't track DYK etc, only selected/featured articles, biogs etc |
|||
local function isSelectedHeader(header) |
|||
if ((string.find(header, "/[sS]elected") == -1) and (string.find(header, "/[fF]eatured") == -1)) then |
|||
-- Whether a page is selected (a selected article, selected list, etc.). |
|||
return retval |
|||
-- The "'*" part of the pattern checks for italic or bold text, like |
|||
end |
|||
-- ''Selected'' or '''Selected'''. |
|||
-- no tracking unless we are in Portal namespace |
|||
if header then |
|||
if (mw.title.getCurrentTitle().nsText ~= "Portal") then |
|||
return string.find(header, "^'*[sS]elected") ~= nil |
|||
return "" |
|||
else |
|||
return false |
|||
end |
end |
||
end |
|||
-- no tracking if this is a subpage |
|||
local function isInPortalNamespace(title) |
|||
if ((mw.ustring.match(thispagetitle, "/") ~= nil) and (thispagetitle ~= "AC/DC")) then |
|||
-- Whether a title object is in the portal namespace. |
|||
return retval |
|||
end |
end |
||
-- limit checking to prevent Lua overload |
|||
local function isPortalSubpage(title) |
|||
local myMaxCheck = 60 |
|||
-- Whether a title object is a portal subpage |
|||
if tonumber(max) < myMaxCheck then |
|||
return ( |
|||
myMaxCheck = tonumber(max) |
|||
isInPortalNamespace(title) |
|||
and title.isSubpage |
|||
and not portalNamesContainingSlashes[title.text] |
|||
) |
|||
end |
|||
local function isRootPortalTitle(title) |
|||
-- Whether a title object is for a root portal page. |
|||
return isInPortalNamespace(title) and not isPortalSubpage(title) |
|||
end |
|||
local function makeCategoryLink(category) |
|||
-- Make a category link. |
|||
return string.format('[[Category:%s]]', category) |
|||
end |
|||
local function makeSubpageTrackingCategoryLink(fragment) |
|||
-- Make a subpage tracking category link. |
|||
return makeCategoryLink( |
|||
string.format( |
|||
'Random portal component with %s available subpages', |
|||
fragment |
|||
) |
|||
) |
|||
end |
|||
local function renderSubpageTrackingCategory(pages, header) |
|||
-- Render the link for the appropriate subpage tracking category. |
|||
-- Only track root portal pages that have "Selected x" sections. |
|||
if not isSelectedHeader(header) or not isRootPortalTitle(currentTitle) then |
|||
return "" |
|||
end |
end |
||
for i=1,myMaxCheck do |
|||
local aSubPage = mw.title.new(pages.subpage .. '/' .. i) |
|||
-- Check whether subpages exist at the category boundaries, and return the |
|||
if (aSubPage.exists) then |
|||
-- appropriate category link. For example, if page 6 exists but page 11 |
|||
availableSubPageCount = availableSubPageCount + 1; |
|||
-- doesn't, return |
|||
-- [[Category:Random portal component with 6–10 available subpages]]. |
|||
local boundaries = {2, 6, 11, 16, 21, 26, 31, 41, 51, 101, 201, 501, 1001} |
|||
local fragment |
|||
for i, subpageNumber in ipairs(boundaries) do |
|||
local subpageName = pages.subpage .. '/' .. tostring(subpageNumber) |
|||
local subpageTitle = mw.title.new(subpageName) |
|||
if not subpageTitle.exists then |
|||
if i == 1 then |
|||
fragment = string.format("less than %d", boundaries[i]) |
|||
else |
|||
fragment = string.format("%d–%d", boundaries[i - 1], boundaries[i] - 1) |
|||
end |
|||
return makeSubpageTrackingCategoryLink(fragment) |
|||
end |
end |
||
end |
end |
||
if myMaxCheck >= tonumber(max) then |
|||
fragment = string.format("over %d", boundaries[#boundaries] - 1) |
|||
if (availableSubPageCount < tonumber(max)) then |
|||
return makeSubpageTrackingCategoryLink(fragment) |
|||
retval = retval .. "[[Category:Random portal component with fewer available subpages than specified max]]" |
|||
elseif (availableSubPageCount > tonumber(max)) then |
|||
retval = retval .. "[[Category:Random portal component with more available subpages than specified max]]" |
|||
end |
|||
end |
|||
-- before categorising, check what type of subpage we are categorising, and if detected, categorise images separately |
|||
local subpageType = "subpages" -- generic type |
|||
local subpageName = pages.subpage |
|||
subpageName = mw.ustring.gsub(subpageName, "^[^/]*/", "") |
|||
subpageName = mw.ustring.lower(subpageName) |
|||
if ((mw.ustring.find(subpageName, "picture", 1, true) ~= nil) or |
|||
(mw.ustring.find(subpageName, "image", 1, true) ~= nil) or |
|||
(mw.ustring.find(subpageName, "panorama", 1, true) ~= nil)) then |
|||
subpageType = "image subpages" |
|||
end |
|||
if (availableSubPageCount < 2) then |
|||
retval = retval .. "[[Category:Random portal component with less than 2 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 5) then |
|||
retval = retval .. "[[Category:Random portal component with 2–5 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 10) then |
|||
retval = retval .. "[[Category:Random portal component with 6–10 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 15) then |
|||
retval = retval .. "[[Category:Random portal component with 11–15 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 20) then |
|||
retval = retval .. "[[Category:Random portal component with 16–20 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 25) then |
|||
retval = retval .. "[[Category:Random portal component with 21–25 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 30) then |
|||
retval = retval .. "[[Category:Random portal component with 26–30 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 40) then |
|||
retval = retval .. "[[Category:Random portal component with 31–40 available " .. subpageType .. "]]" |
|||
elseif (availableSubPageCount <= 50) then |
|||
retval = retval .. "[[Category:Random portal component with 41–50 available " .. subpageType .. "]]" |
|||
else |
|||
retval = retval .. "[[Category:Random portal component with over 50 available " .. subpageType .. "]]" |
|||
end |
|||
return retval; |
|||
end |
end |
||
local function getRandomNumber(max) |
local function getRandomNumber(max) |
||
-- gets a random integer between 1 and max; max defaults to 1 |
-- gets a random integer between 1 and max; max defaults to 1 |
||
| Line 120: | Line 114: | ||
title |
title |
||
) |
) |
||
if mw.title.getCurrentTitle().namespace == 100 then -- is in the portal namespace |
|||
if isRootPortalTitle(currentTitle) then |
|||
msg = msg .. '[[Category:Portals needing attention]]' |
msg = msg .. '[[Category:Portals needing attention]]' |
||
end |
end |
||
| Line 167: | Line 161: | ||
end |
end |
||
return table.concat(ret, '\n') .. |
return table.concat(ret, '\n') .. subPageTrackingCategories(pages, args.max, args.header) |
||
end |
end |
||
| Line 173: | Line 167: | ||
frame = frame or mw.getCurrentFrame() |
frame = frame or mw.getCurrentFrame() |
||
local pages = getPages(args) |
local pages = getPages(args) |
||
local ret = {} |
local ret = {} |
||
ret[#ret + 1] = getHeader(frame, pages, expandArg(args, 'header'), args.headertemplate) |
ret[#ret + 1] = getHeader(frame, pages, expandArg(args, 'header'), args.headertemplate) |
||
| Line 184: | Line 178: | ||
)) |
)) |
||
return table.concat(ret, '\n') .. |
return table.concat(ret, '\n') .. subPageTrackingCategories(pages, args.max, args.header) |
||
end |
end |
||
Revision as of 14:57, 1 October 2020
 | This is the module sandbox page for Module:Random portal component (diff). |
 | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This module depends on the following other modules: |
This module implements {{random portal component}}. Please see the template page for documentation.
See also
-- This module implements [[Template:Random portal component]]
local p = {}
local mRandom = require('Module:Random')
local currentTitle = mw.title.getCurrentTitle()
-- tracking function added by BHG 29/04/2019
-- called as subPageTrackingCategories(pages, args.max)
local function subPageTrackingCategories(pages, max, header)
local retval = "";
local availableSubPageCount = 0;
local i;
local thispagetitle = mw.title.getCurrentTitle().text
-- don't track DYK etc, only selected/featured articles, biogs etc
if ((string.find(header, "/[sS]elected") == -1) and (string.find(header, "/[fF]eatured") == -1)) then
return retval
end
-- no tracking unless we are in Portal namespace
if (mw.title.getCurrentTitle().nsText ~= "Portal") then
return ""
end
-- no tracking if this is a subpage
if ((mw.ustring.match(thispagetitle, "/") ~= nil) and (thispagetitle ~= "AC/DC")) then
return retval
end
-- limit checking to prevent Lua overload
local myMaxCheck = 60
if tonumber(max) < myMaxCheck then
myMaxCheck = tonumber(max)
end
for i=1,myMaxCheck do
local aSubPage = mw.title.new(pages.subpage .. '/' .. i)
if (aSubPage.exists) then
availableSubPageCount = availableSubPageCount + 1;
end
end
if myMaxCheck >= tonumber(max) then
if (availableSubPageCount < tonumber(max)) then
retval = retval .. "[[Category:Random portal component with fewer available subpages than specified max]]"
elseif (availableSubPageCount > tonumber(max)) then
retval = retval .. "[[Category:Random portal component with more available subpages than specified max]]"
end
end
-- before categorising, check what type of subpage we are categorising, and if detected, categorise images separately
local subpageType = "subpages" -- generic type
local subpageName = pages.subpage
subpageName = mw.ustring.gsub(subpageName, "^[^/]*/", "")
subpageName = mw.ustring.lower(subpageName)
if ((mw.ustring.find(subpageName, "picture", 1, true) ~= nil) or
(mw.ustring.find(subpageName, "image", 1, true) ~= nil) or
(mw.ustring.find(subpageName, "panorama", 1, true) ~= nil)) then
subpageType = "image subpages"
end
if (availableSubPageCount < 2) then
retval = retval .. "[[Category:Random portal component with less than 2 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 5) then
retval = retval .. "[[Category:Random portal component with 2–5 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 10) then
retval = retval .. "[[Category:Random portal component with 6–10 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 15) then
retval = retval .. "[[Category:Random portal component with 11–15 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 20) then
retval = retval .. "[[Category:Random portal component with 16–20 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 25) then
retval = retval .. "[[Category:Random portal component with 21–25 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 30) then
retval = retval .. "[[Category:Random portal component with 26–30 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 40) then
retval = retval .. "[[Category:Random portal component with 31–40 available " .. subpageType .. "]]"
elseif (availableSubPageCount <= 50) then
retval = retval .. "[[Category:Random portal component with 41–50 available " .. subpageType .. "]]"
else
retval = retval .. "[[Category:Random portal component with over 50 available " .. subpageType .. "]]"
end
return retval;
end
local function getRandomNumber(max)
-- gets a random integer between 1 and max; max defaults to 1
return mRandom.number{max or 1}
end
local function expandArg(args, key)
-- Emulate how unspecified template parameters appear in wikitext. If the
-- specified argument exists, its value is returned, and if not the argument
-- name is returned inside triple curly braces.
local val = args[key]
if val then
return val
else
return string.format('{{{%s}}}', key)
end
end
local function getPages(args)
local pages = {}
pages.root = args.rootpage or currentTitle.prefixedText
pages.subpage = pages.root .. '/' .. expandArg(args, 'subpage')
pages.random = pages.subpage .. '/' .. getRandomNumber(args.max)
pages.footer = 'Template:Box-footer'
return pages
end
local function tryExpandTemplate(frame, title, args)
local success, result = pcall(frame.expandTemplate, frame, {title = title, args = args})
if success then
return result
else
local msg = string.format(
'<strong class="error">The page "[[%s]]" does not exist.</strong>',
title
)
if mw.title.getCurrentTitle().namespace == 100 then -- is in the portal namespace
msg = msg .. '[[Category:Portals needing attention]]'
end
return msg
end
end
local function getHeader(frame, pages, header, template)
return tryExpandTemplate(
frame,
template or pages.root .. '/box-header',
{header, pages.random}
)
end
local function getRandomSubpageContent(frame, pages)
return tryExpandTemplate(
frame,
pages.random
)
end
local function getFooter(frame, pages, link)
return tryExpandTemplate(
frame,
pages.footer,
{link}
)
end
function p._main(args, frame)
frame = frame or mw.getCurrentFrame()
local pages = getPages(args)
local ret = {}
ret[#ret + 1] = getHeader(frame, pages, args.header or 'subpage', args.headertemplate)
ret[#ret + 1] = getRandomSubpageContent(frame, pages)
if not args.footer or not args.footer:find('%S') then
ret[#ret + 1] = '<div style="clear:both;"></div></div>'
else
ret[#ret + 1] = getFooter(frame, pages, string.format(
'[[%s|%s]]',
pages.subpage,
expandArg(args, 'footer')
))
end
return table.concat(ret, '\n') .. subPageTrackingCategories(pages, args.max, args.header)
end
function p._nominate(args, frame)
frame = frame or mw.getCurrentFrame()
local pages = getPages(args)
local ret = {}
ret[#ret + 1] = getHeader(frame, pages, expandArg(args, 'header'), args.headertemplate)
ret[#ret + 1] = getRandomSubpageContent(frame, pages)
ret[#ret + 1] = getFooter(frame, pages, string.format(
'[[/Nominate/%s|Suggest]] • [[%s|%s]] ',
expandArg(args, 'subpage'),
pages.subpage,
args.footer or 'Archive'
))
return table.concat(ret, '\n') .. subPageTrackingCategories(pages, args.max, args.header)
end
local function makeInvokeFunction(func)
return function (frame)
local args = require('Module:Arguments').getArgs(frame, {
trim = false,
removeBlanks = false,
wrappers = {
'Template:Random portal component',
'Template:Random portal component/BHG-test',
'Template:Random portal component with nominate'
}
})
return func(args, frame)
end
end
p.main = makeInvokeFunction(p._main)
p.nominate = makeInvokeFunction(p._nominate)
return p