Modulo:Mappa di localizzazione New

Da Cathopedia, l'enciclopedia cattolica.
Vai alla navigazione Vai alla ricerca
__EXPECTED_UNCONNECTED_PAGE__

Modulo che implementa le funzionalità dei template {{Mappa di localizzazione New}}, {{Mappa di localizzazione~}} e {{Mappa di localizzazione+}}.

Crystal Clear action lock1.png Template protetto – Le modifiche possono essere proposte in Oratorio.

--[[
* Modulo che implementa le funzionalità dei template:
* {{Mappa di localizzazione New}}, {{Mappa di localizzazione~}} e {{Mappa di localizzazione+}}.
* Importato da Cathopedia il 17 dicembre 2019 - Versione del 3 maggio 2018
* Il modulo è stato importato da:
* http://en.wikipedia.org/w/index.php?title=Module:Location_map&oldid=656514684
]]

require('Module:No globals')

local p = {}

local getArgs = require('Module:Arguments').getArgs

local function round(n, decimals)
    local pow = 10^(decimals or 0)
    return math.floor(n * pow + 0.5) / pow
end

function p.getMapParams(map, frame)
    if not map then
        error('Mappa non specificata', 2)
    end
    -- Gestione mappe tramite sottopagine del modulo, non utilizzato al momento in Cathopedia
    --[[
    local moduletitle = mw.title.new('Modulo:Mappa di localizzazione New/data/' .. map)
    if not moduletitle then
        error('"' .. map .. '" non è un nome di mappa valido', 2)
    elseif moduletitle.exists then
        local mapData = mw.loadData('Modulo:Mappa di localizzazione New/data/' .. map)
        return function(name, params)
            if name == nil then
                return 'Modulo:Mappa di localizzazione New/data/' .. map
            elseif mapData[name] == nil then
                return ''
            elseif params then
                return mw.message.newRawMessage(tostring(mapData[name]), unpack(params)):plain()
            else
                return mapData[name]
            end
        end
    ]]--
    local maptitle = mw.title.new('Template:Mappa di localizzazione New/' .. map)
    if not maptitle then
        error('"' .. map .. '" non è un nome di mappa valido', 2)
    elseif maptitle.exists then
        local cache = {}
        if type(frame) ~= 'table' or type(frame.expandTemplate) ~= 'function' then
            error('frame.expandTemplate non disponibile')
        end
        return function(name, params)
            if params then
                return frame:expandTemplate{title = 'Mappa di localizzazione New/' .. map, args = { name, unpack(params) }}
            else
                if name == nil then
                    return 'Template:Mappa di localizzazione New/' .. map
                elseif cache[name] == nil then
                    cache[name] = frame:expandTemplate{title = 'Mappa di localizzazione New/' .. map, args = { name }}
                end
                return cache[name]
            end
        end
    else
        error('Mappa non disponibile (' .. map .. ')', 2)
    end
end

--[[
-- non utilizzata in Cathopedia
function p.data(frame, args, map)
    if not args then
        args = getArgs(frame, {frameOnly = true})
    end
    if not map then
        map = p.getMapParams(args[1], frame)
    end
    local params = {}
    for k,v in ipairs(args) do
        if k > 2 then
            params[k-2] = v
        end
    end
    return map(args[2], #params ~= 0 and params)
end
]]

local hemisphereMultipliers = {
    longitudine = { W = -1, w = -1, E = 1, e = 1 },
    latitudine = { S = -1, s = -1, N = 1, n = 1 }
}

local function decdeg(degrees, minutes, seconds, hemisphere, decimal, direction)
    if decimal then
        if degrees then
            error('I gradi decimali e DMS non vanno utilizzati insieme per la ' .. direction, 2)
        elseif minutes then
            error('I minuti vanno utilizzati insieme ai gradi DMS per la ' .. direction, 2)
        elseif seconds then
            error('I secondi vanno utilizzati insieme ai gradi DMS per la ' .. direction, 2)
        elseif hemisphere then
            error('L\'emisfero va utilizzato insieme ai gradi DMS per la ' .. direction, 2)
        end
        local retval = tonumber(decimal)
        if retval then
            return retval
        end
        error('I gradi "' .. decimal .. '" di ' .. direction .. ' non sono validi', 2)
    elseif seconds and not minutes then
        error('I secondi di ' .. direction .. ' sono utilizzati senza i minuti', 2)
    elseif not degrees then
        if minutes then
            error('I minuti di ' .. direction .. ' sono utilizzati senza i gradi', 2)
        elseif hemisphere then
            error('L\'emisfero di ' .. direction .. ' è utilizzato senza i gradi', 2)
        end
        return nil
    end
    decimal = tonumber(degrees)
    if not decimal then
        error('I gradi "' .. degrees .. '" di ' .. direction .. ' non sono validi', 2)
    elseif minutes and not tonumber(minutes) then
        error('I minuti "' .. minutes .. '" di ' .. direction .. ' non sono validi', 2)
    elseif seconds and not tonumber(seconds) then
        error('I secondi "' .. seconds .. '" di ' .. direction .. ' non sono validi', 2)
    end
    decimal = decimal + (minutes or 0)/60 + (seconds or 0)/3600
    if hemisphere then
        local multiplier = hemisphereMultipliers[direction][hemisphere]
        if not multiplier then
            error('L\'emisfero "' .. hemisphere .. '" di ' .. direction .. ' non è valido', 2)
        end
        decimal = decimal * multiplier
    end
    return decimal
end

-- effectively make removeBlanks false for caption and maplink, and true for everything else
-- if useWikidata is present but blank, convert it to false instead of nil
-- p.top, p.bottom, and their callers need to use this
function p.valueFunc(key, value)
    if value then
        value = mw.text.trim(value)
    end
    if value ~= '' or key == 'caption' or key == 'maplink' then
        return value
    elseif key == 'useWikidata' then
        return false
    end
end

local function getContainerImage(args, map)
    if args.AlternativeMap then
        return args.AlternativeMap
    elseif (args.relief or args.fisica) and map('image1') ~= '' then
        return map('image1')
    else
        return map('image')
    end
end

local function getWidth(args, map)
    local width = args.width or 240
    return (tonumber(args.max_height) and tonumber(map('ratio'))) and
            math.min(tonumber(width), round(tonumber(args.max_height) / tonumber(map('ratio')))) or
            width
end

function p.top(frame, args, map)
    if not args then
        args = getArgs(frame, {frameOnly = true, valueFunc = p.valueFunc})
    end
    if not map then
        map = p.getMapParams(args[1], frame)
    end
    -- Cathopedia ha in più il parametro max_height nel template e ratio nelle mappe
    local width = getWidth(args, map)
    --[[
    if not args.width then
        width = round((args.default_width or 240) * (tonumber(map('defaultscale')) or 1))
    elseif mw.ustring.sub(args.width, -2) == 'px' then
        width = mw.ustring.sub(args.width, 1, -3)
    else
        width = args.width
    end
    ]]
    local retval = args.float == 'center' and '<div class="center">' or ''
    if args.caption and args.caption ~= '' then
        retval = retval .. '<div class="noviewer thumb '
        if args.float == '"left"' or args.float == 'left' then
            retval = retval .. 'tleft'
        elseif args.float == '"center"' or args.float == 'center' or args.float == '"none"' or args.float == 'none' then
            retval = retval .. 'tnone'
        else
            retval = retval .. 'tright'
        end
        retval = retval .. '"><div class="thumbinner" style="width:' .. (width + 2) .. 'px'
        if args.border == 'none' then
            retval = retval .. ';border:none'
        elseif args.border then
            retval = retval .. ';border-color:' .. args.border
        end
        retval = retval .. '"><div style="position:relative;width:' .. width .. 'px' .. (args.border ~= 'none' and ';border:1px solid lightgray">' or '">')
    else
        retval = retval .. '<div style="width:' .. width .. 'px;'
        if args.float == '"left"' or args.float == 'left' then
            retval = retval .. 'float:left;clear:left'
        elseif args.float == '"center"' or args.float == 'center' then
            retval = retval .. 'float:none;clear:both;margin-left:auto;margin-right:auto'
        elseif args.float == '"none"' or args.float == 'none' then
            retval = retval .. 'float:none;clear:none'
        else
            retval = retval .. 'float:right;clear:right'
        end
        retval = retval .. '"><div style="width:' .. width .. 'px;padding:0"><div style="position:relative;width:' .. width .. 'px">'
    end
    local image = getContainerImage(args, map)
    retval = string.format(
        '%s[[File:%s|%spx|%s|link=%s]]',
        retval,
        image,
        width,
        args.alt or 'Mappa di localizzazione New: ' .. map('name'),
        args.maplink or ''
    )
    if args.overlay_image then
        return retval .. '<div style="position:absolute;top:0;left:0">[[File:' .. args.overlay_image .. '|' .. width .. 'px]]</div>'
    else
        return retval
    end
end

function p.bottom(frame, args, map)
    if not args then
        args = getArgs(frame, {frameOnly = true, valueFunc = p.valueFunc})
    end
    if not map then
        map = p.getMapParams(args[1], frame)
    end
    local retval = '</div>'
   
    if not args.caption then
        retval = retval .. '<div style="font-size:90%;padding-top:3px">'
        .. ((args.label or mw.title.getCurrentTitle().text) .. ' (' .. map('name') .. ')')
        .. '</div>'
    elseif args.caption ~= ''  then
        -- This is not the pipe trick. We're creating a link with no text on purpose, so that CSS can give us a nice image
        retval = retval .. '<div class="thumbcaption"><div class="magnify">[[:File:' .. getContainerImage(args, map) .. '| ]]</div>' .. args.caption .. '</div>'
    end

    --[[
    -- Switcher non utilizzato in Cathopedia
    if args.switcherLabel then
        retval = retval .. '<span class="switcher-label" style="display:none">' .. args.switcherLabel .. '</span>'
    elseif args.autoSwitcherLabel then
        retval = retval .. '<span class="switcher-label" style="display:none">Show map of ' .. map('name') .. '</span>'
    end
    ]]
   
    retval = retval .. '</div></div>'
    --[[
    -- Parametro non esistente in Cathopedia
    if args.caption_undefined then
        mw.log('Removed parameter caption_undefined used.')
        local parent = frame:getParent()
        if parent then
            mw.log('Parent is ' .. parent:getTitle())
        end
        mw.logObject(args, 'args')
        retval = retval .. '[ [Category:Location maps with possible errors|Page using removed parameter] ]'
    end
    ]]
    if args.float == 'center' then
        retval = retval .. '</div>'
    end
    return retval
end

local function markOuterDiv(x, y, imageDiv, labelDiv)
    return mw.html.create('div')
        :cssText('position:absolute;top:' .. round(y, 3) .. '%;left:' .. round(x, 3) .. '%;height:0;width:0;margin:0;padding:0')
        :node(imageDiv)
        :node(labelDiv)
end

local function markImageDiv(mark, marksize, label, link, alt, title)
    local builder = mw.html.create('div')
        :cssText('position:absolute;text-align:center;left:-' .. round(marksize / 2) .. 'px;top:-' .. round(marksize / 2) .. 'px;width:' .. marksize .. 'px;font-size:' .. marksize .. 'px;line-height:0')
        :attr('title', title)
    if marksize ~= 0 then
        builder:wikitext(string.format(
            '[[File:%s|%dx%dpx|%s|link=%s%s]]',
            mark,
            marksize,
            marksize,
            label,
            link,
            alt and ('|alt=' .. alt) or ''
        ))
    end
    return builder
end

local function markLabelDiv(label, label_size, label_width, position, background, x, marksize)
    local builder = mw.html.create('div')
        :cssText('font-size:' .. label_size .. '%;line-height:110%;position:absolute;width:' .. label_width .. 'em')
    local distance = round(marksize / 2 + 1)
    local spanCss
    if position == 'top' then -- specified top
        builder:cssText('bottom:' .. distance .. 'px;left:' .. (-label_width / 2) .. 'em;text-align:center')
    elseif position == 'bottom' then -- specified bottom
        builder:cssText('top:' .. distance .. 'px;left:' .. (-label_width / 2) .. 'em;text-align:center')
    elseif position == 'topleft' then
        builder:cssText('bottom:' .. distance .. 'px;right:' .. distance .. 'px;text-align:right')
        spanCss = 'float:right'
    elseif position == 'topright' then
        builder:cssText('bottom:' .. distance .. 'px;left:' .. distance .. 'px;text-align:left')
        spanCss = 'float:left'
    elseif position == 'bottomleft' then
        builder:cssText('top:' .. distance .. 'px;right:' .. distance .. 'px;text-align:right')
        spanCss = 'float:right'
    elseif position == 'bottomright' then
        builder:cssText('top:' .. distance .. 'px;left:' .. distance .. 'px;text-align:left')
        spanCss = 'float:left'
    elseif position == 'left' or (tonumber(x) > 70 and position ~= 'right') then -- specified left or autodetected to left
        builder:cssText('top:-0.75em;right:' .. distance .. 'px;text-align:right')
        spanCss = 'float:right'
    else -- specified right or autodetected to right
        builder:cssText('top:-0.75em;left:' .. distance .. 'px;text-align:left')
        spanCss = 'float:left'
    end
    builder = builder:tag('span')
        :cssText('padding:1px')
        :cssText(spanCss)
        :wikitext(label)
    if background then
        builder:cssText('background-color:' .. background)
    end
    return builder:done()
end

local function getX(longitude, left, right)
    local width = (right - left) % 360
    if width == 0 then
        width = 360
    end
    local distanceFromLeft = (longitude - left) % 360
    -- the distance needed past the map to the right equals distanceFromLeft - width. the distance needed past the map to the left equals 360 - distanceFromLeft. to minimize page stretching, go whichever way is shorter
    if distanceFromLeft - width / 2 >= 180 then
        distanceFromLeft = distanceFromLeft - 360
    end
    return 100 * distanceFromLeft / width
end

local function getY(latitude, top, bottom)
    return 100 * (top - latitude) / (top - bottom)
end

-- Collegamento a servizio cartografico esterno
-- Per ora usa openstreetmap.org. Livelli di zoom disponibili: http://wiki.openstreetmap.org/wiki/Zoom_levels
local function getLink(lat, lon, map)
    local ampiezza, fascia, zoom
    if map('top') == '' then
        zoom = 5 -- Se non ha gli estremi della mappa (mappe di tipo X/Y) usa un valore medio
    else
        ampiezza = math.max(map('top') - map('bottom'), map('right') - map('left'))
        fascia = 180
        zoom = 1
        while ampiezza < fascia do
            zoom = zoom + 1
            fascia = fascia / 2
        end
    end
    return 'http://www.openstreetmap.org/?mlat=' .. lat .. '&mlon=' .. lon .. '&zoom=' .. zoom
end

local function mark(frame, args, map)
    if not args then
        args = getArgs(frame, {wrappers = 'Template:Mappa di localizzazione~'})
    end
    if not map then
        map = p.getMapParams(args[1], frame)
    end
   
    -- nomi parametri in Cathopedia
    args.lat_deg = args.lat_deg or args.latitudineGradi
    args.lat_min = args.lat_min or args.latitudinePrimi
    args.lat_sec = args.lat_sec or args.latitudineSecondi
    args.lat_dir = args.lat_dir or args.latitudineNS
    args.lon_deg = args.lon_deg or args.longitudineGradi
    args.lon_min = args.lon_min or args.longitudinePrimi
    args.lon_sec = args.lon_sec or args.longitudineSecondi
    args.lon_dir = args.lon_dir or args.longitudineEW
   
    local x, y, longitude, latitude
    longitude = decdeg(args.lon_deg, args.lon_min, args.lon_sec, args.lon_dir, args.long, 'longitudine')
    latitude = decdeg(args.lat_deg, args.lat_min, args.lat_sec, args.lat_dir, args.lat, 'latitudine')
    if not longitude and not latitude and args.useWikidata then
        -- If they didn't provide either coordinate, try Wikidata. If they provided one but not the other, don't.
        local entity = mw.wikibase.getEntity()
        if entity and entity.claims and entity.claims.P625 and entity.claims.P625[1].mainsnak.snaktype == 'value' then
            local value = entity.claims.P625[1].mainsnak.datavalue.value
            longitude, latitude = value.longitude, value.latitude
        end
    end
    if not longitude then
        error('Longitudine non specificata')
    end
    if not latitude then
        error('Latitudine non specificata')
    end
    local builder = mw.html.create()
    --[[
    -- Categorie non esistenti in Cathopedia
    if (not args.lon_deg) ~= (not args.lat_deg) then
        builder:wikitext('[ [Category:Location maps with different longitude and latitude precisions|Degrees] ]')
    elseif (not args.lon_min) ~= (not args.lat_min) then
        builder:wikitext('[ [Category:Location maps with different longitude and latitude precisions|Minutes] ]')
    elseif (not args.lon_sec) ~= (not args.lat_sec) then
        builder:wikitext('[ [Category:Location maps with different longitude and latitude precisions|Seconds] ]')
    elseif (not args.lon_dir) ~= (not args.lat_dir) then
        builder:wikitext('[ [Category:Location maps with different longitude and latitude precisions|Hemisphere] ]')
    elseif (not args.long) ~= (not args.lat) then
        builder:wikitext('[ [Category:Location maps with different longitude and latitude precisions|Decimal] ]')
    end
    ]]--
    --[[
    -- Parametri non esistenti in Cathopedia o obsoleti
    if args.skew or args.lon_shift or args.markhigh then
        mw.log('Removed parameter used in invocation.')
        local parent = frame:getParent()
        if parent then
            mw.log('Parent is ' .. parent:getTitle())
        end
        mw.logObject(args, 'args')
        builder:wikitext('[ [Category:Location maps with possible errors|Page using removed parameter] ]')
    end
    if map('skew') ~= '' or map('lat_skew') ~= '' or map('crosses180') ~= '' or map('type') ~= '' then
        mw.log('Removed parameter used in map definition ' .. map())
        builder:wikitext('[ [Category:Location maps with possible errors|Map using removed parameter] ]')
    end
    ]]
    if map('x') ~= '' then
        x = tonumber(mw.ext.ParserFunctions.expr(map('x', { latitude, longitude })))
    else
        x = tonumber(getX(longitude, map('left'), map('right')))
    end
    if map('y') ~= '' then
        y = tonumber(mw.ext.ParserFunctions.expr(map('y', { latitude, longitude })))
    else
        y = tonumber(getY(latitude, map('top'), map('bottom')))
    end
    if (x < 0 or x > 100 or y < 0 or y > 100) and not args.outside then
        error('Coordinate al di fuori della mappa')
        --[[
        -- in Cathopedia non c'è la categoria
        mw.log('Mark placed outside map boundaries without outside flag set. x = ' .. x .. ', y = ' .. y)
        local parent = frame:getParent()
        if parent then
            mw.log('Parent is ' .. parent:getTitle())
        end
        mw.logObject(args, 'args')
        builder:wikitext('[ [Category:Location maps with possible errors|Outside flag not set with mark outside map] ]')
        ]]
    end
    local mark = args.mark or map('mark')
    if mark == '' then
        mark = 'Red pog.svg.png'
    end
    local marksize = tonumber(args.marksize) or tonumber(map('marksize')) or 8
    if args.link == nil then
        args.link = getLink(latitude, longitude, map)
    end
    local imageDiv = markImageDiv(mark, marksize, args.label or mw.title.getCurrentTitle().text, args.link or '', args.alt, args[2])
    local labelDiv
    if args.label and args.position ~= 'none' then
        labelDiv = markLabelDiv(args.label, args.label_size or 90, args.label_width or 6, args.position, args.background, x, marksize)
    end
    return builder:node(markOuterDiv(x, y, imageDiv, labelDiv))
end

local function container(frame, args, map)
    if not args then
        args = getArgs(frame, {wrappers = 'Template:Mappa di localizzazione+', valueFunc = p.valueFunc})
    end
    if not map then
        map = p.getMapParams(args[1], frame)
    end
    return p.top(frame, args, map) .. (args.places or '') .. p.bottom(frame, args, map)
end

local function main(frame, args, map)
    if not args then
        args = getArgs(frame, {wrappers = 'Template:Mappa di localizzazione New', valueFunc = p.valueFunc})
    end
    if args.useWikidata == nil then
        args.useWikidata = true
    end
    if not map then
        map = p.getMapParams(args[1], frame)
    end
    -- il parametro "sinottico" serve a impostare dei valori dei parametri e dei default
    -- adatti all'utilizzo della Mappa di localizzazione New in un sinottico
    if args.sinottico then
        args.position = 'center'
        args.float = 'center'
        args.caption = ''
        args.width = args.width or 260
        args.max_height = args.max_height or 400
    end
    return p.top(frame, args, map) .. tostring( mark(frame, args, map) ) .. p.bottom(frame, args, map)
end

-- Error handler per xpcall, formatta l'errore e aggiunge la categoria
local function errhandler(msg)
    local errmsg = msg:match(': (.+)$')
    local args = mw.getCurrentFrame():getParent().args
    local cat = ''
        local cat2 = ''
    if args.noerr then
        cat2 = ' - errore nascosto'
    end
    if mw.title.getCurrentTitle().namespace == 0 then
        if errmsg:match('^Mappa non disponibile') or
           errmsg:match('non è un nome di mappa valido$') then
            cat = '[[Categoria:Pagine con mappa di localizzazione non esistente' .. cat2 .. ']]'
        elseif errmsg == 'Coordinate al di fuori della mappa' then
            cat = (args.cat_fuorimappa and args.cat_fuorimappa ~= '') and
                  string.format('[[Categoria:%s]]', args.cat_fuorimappa) or
                  ('[[Categoria:Pagine con coordinate al di fuori della mappa di localizzazione' .. cat2 .. ']]')
        else
            cat = '[[Categoria:Errori di compilazione del template mappa di localizzazione' .. cat2 .. ']]'
        end
    end
    return args.noerr and cat or
        string.format('<div class="toccolours error" style="width:200px; text-align:center; margin-left:auto; margin-right:auto;">%s</div>%s', errmsg, cat)
end

-------------------------------------------------------------------------------
--                                    API
-------------------------------------------------------------------------------

-- Rispetto alla versione originaria di en.wiki, in Cathopedia gli entry-point
-- sono chiamati tramite xpcall per intercettare le eccezioni, così da
-- non categorizzare nella generica [[:Categoria:Pagine con errori di script]]
-- ma in categorie specifiche e poter formattare l'errore.

-- Entry-point per {{Mappa di localizzazione~}}
function p.mark(frame, args, map)
    return select(2, xpcall(function() return mark(frame, args, map) end, errhandler))
end

-- Entry-point per {{Mappa di localizzazione New}}
-- Nota: unito da [[:en:Module:Location map/multi]] in quanto il resto del modulo serviva per [[:en:Template:Location map many]] non presente in Cathopedia
function p.container(frame, args, map)
    return select(2, xpcall(function() return container(frame, args, map) end, errhandler))
end

-- Entry-point per {{Mappa di localizzazione New}}
function p.main(frame, args, map)
    return select(2, xpcall(function() return main(frame, args, map) end, errhandler))
end

return p