Module:Portal

--[==[ This module is a Lua implementation of the old template. As of August 2013 it is used on nearly 5,000,000 articles. -- Please take care when updating it! It outputs two functions: p.portal, which generates a table of portals, and p.image, which -- produces the image name for an individual portal.

-- The portal image data is kept in submodules of Module:Portal/images, listed below: -- Module:Portal/images/a      - for portal names beginning with "A". -- Module:Portal/images/b      - for portal names beginning with "B". -- Module:Portal/images/c      - for portal names beginning with "C". -- Module:Portal/images/d      - for portal names beginning with "D". -- Module:Portal/images/e      - for portal names beginning with "E". -- Module:Portal/images/f      - for portal names beginning with "F". -- Module:Portal/images/g      - for portal names beginning with "G". -- Module:Portal/images/h      - for portal names beginning with "H". -- Module:Portal/images/i      - for portal names beginning with "I". -- Module:Portal/images/j      - for portal names beginning with "J". -- Module:Portal/images/k      - for portal names beginning with "K". -- Module:Portal/images/l      - for portal names beginning with "L". -- Module:Portal/images/m      - for portal names beginning with "M". -- Module:Portal/images/n      - for portal names beginning with "N". -- Module:Portal/images/o      - for portal names beginning with "O". -- Module:Portal/images/p      - for portal names beginning with "P". -- Module:Portal/images/q      - for portal names beginning with "Q". -- Module:Portal/images/r      - for portal names beginning with "R". -- Module:Portal/images/s      - for portal names beginning with "S". -- Module:Portal/images/t      - for portal names beginning with "T". -- Module:Portal/images/u      - for portal names beginning with "U". -- Module:Portal/images/v      - for portal names beginning with "V". -- Module:Portal/images/w      - for portal names beginning with "W". -- Module:Portal/images/x      - for portal names beginning with "X". -- Module:Portal/images/y      - for portal names beginning with "Y". -- Module:Portal/images/z      - for portal names beginning with "Z". -- Module:Portal/images/other  - for portal names beginning with any other letters. This includes numbers, --                                   letters with diacritics, and letters in non-Latin alphabets. -- Module:Portal/images/aliases - for adding aliases for existing portal names. Use this page for variations --                                   in spelling and diacritics, etc., no matter what letter the portal begins with. -- -- The images data pages are separated by the first letter to reduce server load when images are added, changed, or removed. -- Previously all the images were on one data page at Module:Portal/images, but this had the disadvantage that all -- 5,000,000 pages using this module needed to be refreshed every time an image was added or removed. ]==]

local htmlBuilder = require( 'Module:HtmlBuilder' )

-- Finds the appropriate image subpage given a lower-case -- portal name plus the first letter of that portal name. local function matchImagePage( s ) if type( s ) ~= 'string' or #s < 1 then return end local firstLetter = mw.ustring.sub( s, 1, 1 ) local imagePage if mw.ustring.find( firstLetter, '^[a-z]' ) then imagePage = 'Module:Portal/images/' .. firstLetter else imagePage= 'Module:Portal/images/other' end local images = mw.loadData( imagePage ) local image = images[ s ] if image then return image end end

-- Gets the image name for a given string. local function getImageName( s ) if type( s ) ~= 'string' or #s < 1 then return 'Portal-puzzle.svg' end s = mw.ustring.lower( s ) local image = matchImagePage( s ) if image then return image else local aliases = mw.loadData( 'Module:Portal/images/aliases' ) local alias = aliases[ s ] image = matchImagePage( alias ) if image then return image else return 'Portal-puzzle.svg' end end end

local function buildPortals( portals, args ) local root = htmlBuilder.create( 'div' ) root .addClass( 'noprint' ) .addClass( args.left and 'tleft' or 'tright' ) .addClass( 'portal' ) .css( 'border', 'solid #aaa 1px' ) .css( 'margin', args.margin or ( args.left == 'yes' and '0.5em 1em 0.5em 0' ) or '0.5em 0 0.5em 1em') .newline

-- Start the table. This corresponds to the start of the wikitext table in the old Template:Portal. local tableroot = root.tag( 'table' ) .css( 'background', '#f9f9f9' ) .css( 'font-size', '85%' ) .css( 'line-height', '110%' ) .css( 'max-width', '175px' ) .css( 'width', type( args.boxsize ) == 'string' and ( args.boxsize .. 'px' ) ) -- If no portals have been specified, display an error and add the page to a tracking category. if not portals[ 1 ] then tableroot.wikitext( ' No portals specified: please specify at least one portal ' ) end

-- Display the portals specified in the positional arguments. for i, portal in ipairs( portals ) do       local image = getImageName( portal ) -- Generate the html for the image and the portal name. tableroot .newline .tag( 'tr' ) .attr( 'valign', 'middle' ) .tag( 'td' ) .css( 'text-align', 'center' ) .wikitext( mw.ustring.format( '', image ) ) .done .tag( 'td' ) .css( 'padding', '0 0.2em' ) .css( 'vertical-align', 'middle' ) .css( 'font-style', 'italic' ) .css( 'font-weight', 'bold' ) .wikitext(mw.ustring.format( '%s%sportal', portal, portal, args[ 'break' ] and ' ' or ' ' ) ) end return tostring( root ) end

-- This function processes the arguments and sends them to the main portal-building function. We want to list all the portals in the order -- they were passed to the template. We also want to be able to deal with positional arguments passed explicitly, for example -- . However, pairs doesn't guarantee the correct order, and ipairs will stop after the first nil value. To get -- around this, we create a new table of portals where nil values have been removed, so that we can traverse the numerical arguments using -- ipairs. local function _portal( args ) local portals = {} for k, v in pairs( args ) do       if type( k ) == 'number' and type( v ) == 'string' then -- Make sure we have no non-string portal names. table.insert( portals, k ) end end table.sort( portals ) for i, v in ipairs( portals ) do       portals[ i ] = args[ v ] end return buildPortals( portals, args ) end

-- Wrapper function to allow getImageName to be accessed through #invoke. local function _image( args ) return getImageName( args[ 1 ] ) end

local function makeWrapper( func ) return function ( frame ) -- If called via #invoke, use the args passed into the invoking -- template, or the args passed to #invoke if any exist. Otherwise -- assume args are being passed directly in from the debug console -- or from another Lua module. local origArgs if frame == mw.getCurrentFrame then origArgs = frame:getParent.args for k, v in pairs( frame.args ) do               origArgs = frame.args break end else origArgs = frame end -- Trim whitespace and remove blank arguments. local args = {} for k, v in pairs( origArgs ) do           if type( v ) == 'string' then v = mw.text.trim( v ) end if v ~= '' then args[ k ] = v           end end return func( args ) end end

return { portal = makeWrapper( _portal ), image = makeWrapper( _image ) }