Mô đun:Coordinates

Từ điển mở Wiktionary
--[=[
Mô đun này hỗ trợ [[Bản mẫu:Coord]] và các bản mẫu liên quan. Nó cung cấp vài
phương thức, nhất là:

{{#gọi:Coordinates | coord }} : Hàm tổng quát để định dạng và hiển thị các giá
trị tọa độ.

{{#gọi:Coordinates | dec2dms }} : Hàm đơn giản để chuyển đổi các giá trị thập
phân ra định dạng độ-phút-giây.

{{#gọi:Coordinates | dms2dec }} : Hàm đơn giản để chuyển đổi định dạng
độ-phút-giây ra định dạng độ thập phân.

]=]

math_mod = require( "Module:Math" );
globalFrame = nil

coordinates = {};

-- Định dạng các số theo quy tắc tiếng Việt (thí dụ 1.234,56).
local lang = mw.getContentLanguage()

--[[ Hàm hỗ trợ thay thế {{coord/display/title}}. ]]
function displaytitle (s, notes)
    local l = "[[tọa độ|Tọa độ]]: " .. s
    local co = '<span id="coordinates">' .. l .. notes .. '</span>';
    return '<span style="font-size: small;">' .. co .. '</span>';
end

--[[ Hàm hỗ trợ thay thế {{coord/display/inline}}. ]]
function displayinline (s, notes)
    return s .. notes    
end

--[[ Hàm hỗ trợ được sử dụng để nhận ra định dạng độ-phút-giây. ]]
local dmsTest = function(first, second)
    local concatenated = first:upper() .. second:upper();
    
    if concatenated == "NE" or concatenated == "NW" or concatenated == "SE" or concatenated == "SW" or
        concatenated == "EN" or concatenated == "WN" or concatenated == "ES" or concatenated == "WS" or
        concatenated == "BĐ" or concatenated == "BT" or concatenated == "NĐ" or concatenated == "TN" or
        concatenated == "ĐB" or concatenated == "TB" or concatenated == "ĐN" or concatenated == "NT" then
        return true;
    end
    return false;
end

--[[
parseDec

Biến đổi vĩ độ và kinh độ thành một cấu trúc để hiển thị tọa độ.
]]
function parseDec( lat, long, format )
    local coordinateSpec = {}
    local errors = {}
    
    if long == "" or long == nil then
        return nil, {{"parseDec", "Thiếu kinh độ"}}
    end
    
    errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false );    
    coordinateSpec["dec-lat"]  = lat;
    coordinateSpec["dec-long"] = long;

    local mode = coordinates.determineMode( lat, long );
    coordinateSpec["dms-lat"]  = convert_dec2dms( lat, "B", "N", mode)  -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
    coordinateSpec["dms-long"] = convert_dec2dms( long, "Đ", "T", mode)  -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}    
    
    if format ~= "" then
        coordinateSpec.default = format
    else
        coordinateSpec.default = "dec"
    end

    return coordinateSpec, errors
end

--[[ Hàm hỗ trợ để xử lý các đối số tùy chọn. ]]
function optionalArg(arg, suplement)
    if arg ~= nil and arg ~= "" then
        return arg .. suplement
    end
    return ""
end

--[[
parseDMS

Biến đổi vĩ độ và kinh độ duới dạng độ-phút-giây thành cấu trúc để hiển thị các
tọa độ.
]]
function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format )
    local coordinateSpec = {}
    local errors = {}
    
    lat_f = mw.ustring.upper(lat_f);
    long_f = mw.ustring.upper(long_f);
    
    -- Nhận các chữ bán cầu tiếng Việt.
    if long_f == "B" or lat_f == "Đ" or lat_f == "T" then
        local englishFlags = {B = "N", N = "S", T = "W", ["Đ"] = "E"}
        local lat_f = englishFlags[lat_f] or lat_f
        local long_f = englishFlags[long_f] or long_f
    end
    
    -- Check if specified backward
    if lat_f == 'E' or lat_f == 'W' then
        local t_d, t_m, t_s, t_f;
        t_d = lat_d;
        t_m = lat_m;
        t_s = lat_s;
        t_f = lat_f;
        lat_d = long_d;
        lat_m = long_m;
        lat_s = long_s;
        lat_f = long_f;
        long_d = t_d;
        long_m = t_m;
        long_s = t_s;
        long_f = t_f;
    end    
    
    errors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS', true );
    if long_d == nil or long_d == "" then
        table.insert(errors, {"parseDMS", "Thiếu kinh độ" })
    end
    
    if lat_m == nil and lat_s == nil and long_m == nil and long_s == nil and #errors == 0 then 
        if math_mod._precision( lat_d ) > 0 or math_mod._precision( long_d ) > 0 then
            if lat_f:upper() == 'S' then 
                lat_d = '-' .. lat_d;
            end
            if long_f:upper() == 'W' then 
                long_d = '-' .. long_d;
            end
            
            return parseDec( lat_d, long_d, format );
        end        
    end   
    
    -- Việt hóa các chữ bán cầu.
    local vietFlags = {N = "B", S = "N", W = "T", E = "Đ"}
    local viet_lat_f = vietFlags[lat_f:upper()] or lat_f
    local viet_long_f = vietFlags[long_f:upper()] or long_f
    
    -- Dịnh dạng các số thập phân.
    if tonumber(lat_s) then lat_s = lang:formatNum(tonumber(lat_s)) end
    if tonumber(long_s) then long_s = lang:formatNum(tonumber(long_s)) end
    
    coordinateSpec["dms-lat"]  = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. viet_lat_f
    coordinateSpec["dms-long"] = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. viet_long_f
    coordinateSpec["dec-lat"]  = convert_dms2dec(lat_f, lat_d, lat_m, lat_s) -- {{coord/dms2dec|{{{4}}}|{{{1}}}|0{{{2}}}|0{{{3}}}}}
    coordinateSpec["dec-long"] = convert_dms2dec(long_f, long_d, long_m, long_s) -- {{coord/dms2dec|{{{8}}}|{{{5}}}|0{{{6}}}|0{{{7}}}}}

    if format ~= "" then
        coordinateSpec.default = format
    else
        coordinateSpec.default = "dms"
    end   

    return coordinateSpec, errors
end

--[[
specPrinter

Hàm định dạng giá trị cho ra. Lấy cấu trúc do parseDec hoặc parseDMS tạo ra và
định dạng nó để nhúng vào Wikipedia.
]]
function specPrinter(args, coordinateSpec)
    local uriComponents = coordinateSpec["param"]
    if uriComponents == "" then
        -- RETURN error, should never be empty or nil
        return "LỖI tham số trống"
    end
    if args["name"] ~= "" and args["name"] ~= nil then
        uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec["name"])
    end
    
    local geodmshtml = '<span class="geo-dms" title="Bản đồ, không ảnh, cùng các dữ liệu khác cho vị trí này">'
             .. '<span class="latitude">' .. coordinateSpec["dms-lat"] .. '</span> '
             .. '<span class="longitude">' ..coordinateSpec["dms-long"] .. '</span>'
             .. '</span>'

    local lat = tonumber( coordinateSpec["dec-lat"] ) or 0
    if lat < 0 then
        -- FIXME this breaks the pre-existing precision
        geodeclat = lang:formatNum(tonumber(coordinateSpec["dec-lat"]:sub(2))) .. "°N"
    else
        geodeclat = lang:formatNum(tonumber(coordinateSpec["dec-lat"] or 0)) .. "°B"
    end

    local long = tonumber( coordinateSpec["dec-long"] ) or 0
    if long < 0 then
        -- FIXME does not handle unicode minus
        geodeclong = lang:formatNum(tonumber(coordinateSpec["dec-long"]:sub(2))) .. "°T"
    else
        geodeclong = lang:formatNum(tonumber(coordinateSpec["dec-long"] or 0)) .. "°Đ"
    end
    
    local geodechtml = '<span class="geo-dec" title="Bản đồ, không ảnh, cùng các dữ liệu khác cho vị trí này">'
             .. geodeclat .. ' '
             .. geodeclong
             .. '</span>'

    local geonumhtml = '<span class="geo">'
             .. coordinateSpec["dec-lat"] .. '; '
             .. coordinateSpec["dec-long"]
             .. '</span>'

    local inner;
    inner = '<span class="' .. displayDefault(coordinateSpec["default"], "dms" ) .. '">' .. geodmshtml .. '</span>'
                .. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>'
                .. '<span class="' .. displayDefault(coordinateSpec["default"], "dec" ) .. '">';

    if args["name"] == "" or args["name"] == nil then
        inner = inner .. geodechtml 
                .. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span></span>'
    else
        inner = inner .. '<span class="vcard">' .. geodechtml 
                .. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span>'
                .. '<span style="display:none">&#xfeff; (<span class="fn org">'
                .. args["name"] .. '</span>)</span></span></span>'
    end

    return '<span class="plainlinks nourlexpansion">' .. globalFrame:preprocess(
        '[//toolserver.org/~geohack/geohack.php?pagename={{FULLPAGENAMEE}}&params=' ..
        uriComponents .. ' ' .. inner .. ']') .. '</span>'
end

--[[
Định dạng những thông báo lỗi cần hiển thị.
]]
function errorPrinter(errors)
    local result = ""
    for i,v in ipairs(errors) do
        local errorHTML = '<strong class="error">Tọa độ: ' .. v[2] .. '</strong>'
        result = result .. errorHTML .. "<br />"
    end
    return result
end

--[=[
Tính lớp CSS cần để hiển thị tọa độ.

Bảng kiểu CSS thường ẩn geo-nondefault, trừ khi một nguời dùng đã ghi đè thiết lập này.
default là chế độ do nguời dùng định rõ khi nhúng [[Bản mẫu:coord]].
mode là chế độ hiển thị (dec hoặc dms) dùng để tính lớp CSS.
]=]
function displayDefault(default, mode)
    if default == "" then
        default = "dec"
    end
    
    if default == mode then
        return "geo-default"
    else
        return "geo-nondefault"
    end
end

--[[
Kiểm tra các đối số cho vào để nhận ra kiểu dữ liệu được cung cấp và xử lý đúng
cách.
]]
function formatTest(args)
    local result, errors;
    local primary = false;
    
    if args[1] == "" then
        -- no lat logic
        return errorPrinter( {{"formatTest", "Thiếu vĩ độ"}} )
    elseif args[4] == "" and args[5] == "" and args[6] == "" then
        -- dec logic
        result, errors = parseDec( args[1], args[2], args['format'] )
        if result == nil then
            return errorPrinter( errors );
        end              
        result.param    = table.concat( {args[1], "_N_", args[2], "_E_", args[3] } );
    elseif dmsTest(args[4], args[8]) then
        -- dms logic
        result, errors = parseDMS( args[1], args[2], args[3], args[4], 
            args[5], args[6], args[7], args[8], args['format'] )
        result.param = table.concat( { args[1], args[2], args[3], args[4], args[5],
            args[6], args[7], args[8], args[9] } , '_' );
        if args[10] ~= '' then
            table.insert( errors, { 'formatTest', 'Tham số dư' } );
        end        
    elseif dmsTest(args[3], args[6]) then
        -- dm logic
        result, errors = parseDMS( args[1], args[2], nil, args[3], 
            args[4], args[5], nil, args[6], args['format'] )
        result.param = table.concat( { args[1], args[2], args[3], args[4], args[5],
            args[6], args[7] } , '_' );
        if args[8] ~= '' then
            table.insert( errors, { 'formatTest', 'Tham số dư' } );
        end        
    elseif dmsTest(args[2], args[4]) then
        -- d logic
        result, errors = parseDMS( args[1], nil, nil, args[2], 
            args[3], nil, nil, args[4], args['format'] )
        result.param = table.concat( { args[1], args[2], args[3], args[4], args[5] } , '_' );
        if args[6] ~= '' then
            table.insert( errors, { 'formatTest', 'Tham số dư' } );
        end        
    else
        -- Error
        return errorPrinter( {{"formatTest", "Định dạng đối số không rõ"}} )
    end
    result.name     = args["name"]
    
    local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'}
    for _, v in ipairs( extra_param ) do
        if (args[v] or '') ~= '' then 
            table.insert( errors, {'formatTest', 'Tham số: “' .. v .. '=” cần phải là “' .. v .. ':”' } );
        end
    end
    
    if #errors == 0 then
        return specPrinter( args, result )    
    else
        return specPrinter( args, result ) .. " " .. errorPrinter(errors) .. '[[Thể loại:Trang có thẻ tọa độ hỏng]]'; 
    end    
end

--[[ 
Hàm hỗ trợ chuyển đổi vĩ độ hoặc kinh độ thập phân thành định dạng độ-phút-giây
theo độ chính xác được định rõ.
]]
function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
    local coord = tonumber(coordinate) or 0
    local postfix
    if coord >= 0 then
        postfix = firstPostfix
    else
        postfix = secondPostfix
    end

    precision = precision:lower();
    if precision == "dms" then
        return convert_dec2dms_dms( math.abs( coord ) ) .. postfix;
    elseif precision == "dm" then
        return convert_dec2dms_dm( math.abs( coord ) ) .. postfix;
    elseif precision == "d" then
        return convert_dec2dms_d( math.abs( coord ) ) .. postfix;
    end
end

--[[ Hàm hỗ trợ chuyển đổi số thập phân thành độ. ]]
function convert_dec2dms_d(coordinate)
    local d = math_mod._round( coordinate, 0 ) .. "°"
    return d .. ""
end

--[[ Hàm hỗ trợ chuyển đổi số thập phân thành độ và phút. ]]
function convert_dec2dms_dm(coordinate)    
    coordinate = math_mod._round( coordinate * 60, 0 );
    local m = coordinate % 60;
    coordinate = math.floor( (coordinate - m) / 60 );
    local d = coordinate % 360 .."°"
    
    return d .. string.format( "%02d′", m )
end

--[[ Hàm hỗ trợ chuyển đổi số thập phân thành độ, phút, và giây. ]]
function convert_dec2dms_dms(coordinate)
    coordinate = math_mod._round( coordinate * 60 * 60, 0 );
    local s = coordinate % 60
    coordinate = math.floor( (coordinate - s) / 60 );
    local m = coordinate % 60
    coordinate = math.floor( (coordinate - m) / 60 );
    local d = coordinate % 360 .."°"

    return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s )
end

--[[
Chuyển đổi định dạng độ-phút-giây thành tọa độ thập phân B hay Đ.
]]
function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str)
    local degrees = tonumber(degrees_str) or 0
    local minutes = tonumber(minutes_str) or 0
    local seconds = tonumber(seconds_str) or 0
    
    local factor
    if direction == "N" or direction == "E" then
        factor = 1
    else
        factor = -1
    end
    
    local precision = 0
    if seconds_str ~= nil and seconds_str ~= '' then
        precision = 5 + math.max( math_mod._precision(seconds_str), 0 );
    elseif minutes_str ~= nil and minutes_str ~= '' then
        precision = 3 + math.max( math_mod._precision(minutes_str), 0 );
    else
        precision = math.max( math_mod._precision(degrees_str), 0 );
    end
    
    local decimal = factor * (degrees+(minutes+seconds/60)/60) 
    return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based.
end

--[[
Kiểm tra các giá trị cho vào để nhận ra lỗi không đúng phạm vi.
]]
function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source, strong )
    local errors = {};
    lat_d = tonumber( lat_d ) or 0;
    lat_m = tonumber( lat_m ) or 0;
    lat_s = tonumber( lat_s ) or 0;
    long_d = tonumber( long_d ) or 0;
    long_m = tonumber( long_m ) or 0;
    long_s = tonumber( long_s ) or 0;

    if strong then
        if lat_d < 0 then
            table.insert(errors, {source, "vĩ độ < 0 có chữ bán cầu"})
        end
        if long_d < 0 then
            table.insert(errors, {source, "vĩ độ < 0 có chữ bán cầu"})
        end
        --[[ 
        #coordinates is inconsistent about whether this is an error.  If globe: is
        specified, it won't error on this condition, but otherwise it will.
        
        For not simply disable this check.
        
        if long_d > 180 then
            table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"})
        end
        ]]
    end    
        
    if lat_d > 90 then
        table.insert(errors, {source, "vĩ độ > 90"})
    end
    if lat_d < -90 then
        table.insert(errors, {source, "vĩ độ < -90"})
    end
    if lat_m >= 60 then
        table.insert(errors, {source, "vĩ phút >= 60"})
    end
    if lat_m < 0 then
        table.insert(errors, {source, "vĩ phút < 0"})
    end
    if lat_s >= 60 then
        table.insert(errors, {source, "vĩ giây >= 60"})
    end
    if lat_s < 0 then
        table.insert(errors, {source, "vĩ giây < 0"})
    end
    if long_d >= 360 then
        table.insert(errors, {source, "kinh độ >= 360"})
    end
    if long_d <= -360 then
        table.insert(errors, {source, "kinh độ <= -360"})
    end
    if long_m >= 60 then
        table.insert(errors, {source, "kinh phút >= 60"})
    end
    if long_m < 0 then
        table.insert(errors, {source, "kinh phút < 0"})
    end
    if long_s >= 60 then
        table.insert(errors, {source, "kinh giây >= 60"})
    end
    if long_s < 0 then
        table.insert(errors, {source, "kinh giây < 0"})
    end
    
    return errors;
end

--[[
dec2dms

Hàm bọc cho phép các bản mẫu gọi dec2dms trực tiếp.

Cách sử dụng:
    {{ #gọi:Coordinates | dec2dms | tọa độ thập phân | hậu tố cho số dương | 
        hậu tố cho số âm | độ chính xác }}

decimal_coordinate được chuyển đổi thành định dạng độ-phút-giây. Nếu là số
dương, hậu tố cho số dương được bổ sung (thường là N hay E); nếu là số dương,
hậu tố cho số dương được bổ sung. Độ chính xác định rõ mức chi tiết là một trong
“D”, “DM”, hay “DMS”.
]]
function coordinates.dec2dms(frame)
    globalFrame = frame
    local coordinate = frame.args[1]
    local firstPostfix = frame.args[2]
    local secondPostfix = frame.args[3]
    local precision = frame.args[4]

    return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
end

--[[
Hàm hỗ trợ quyết định sử dụng định dạng độ, độ-phút, hay độ-phút-giây, tùy độ
chính xác của giá trị thập phân cho vào.
]]
function coordinates.determineMode( value1, value2 )
    local precision = math.max( math_mod._precision( value1 ), math_mod._precision( value2 ) );
    if precision <= 0 then
        return 'd'
    elseif precision <= 2 then
        return 'dm';
    else
        return 'dms';
    end
end        

--[[
dms2dec

Hàm bọc cho phép các bản mẫu gọi dms2dec trực tiếp.

Cách sử dụng:
    {{ #gọi:Coordinates | dms2dec | chữ bán cầu | độ | 
        phút | giây }}

Chuyển đổi các giá trị độ-phút-giây thành định dạng thập phân.
direction_flag là một trong N, S, E, và W và định rõ giá trị cho ra là số dương
(N và E) hoặc số âm (S và W).
]]
function coordinates.dms2dec(frame)
    globalFrame = frame
    local direction = frame.args[1]
    local degrees = frame.args[2]
    local minutes = frame.args[3]
    local seconds = frame.args[4]

    return convert_dms2dec(direction, degrees, minutes, seconds)
end

--[=[
coord

Chỗ vào chính của hàm Lua thay thế [[Bản mẫu:Coord]].

Cách sử dụng:
    {{ #gọi:Coordinates | coord }}
    {{ #gọi:Coordinates | coord | vĩ độ | kinh độ }}
    {{ #gọi:Coordinates | coord | vĩ độ | chữ vĩ độ | kinh độ | chữ kinh độ }}

    
    Tra cứu trang tài liệu của [[Bản mẫu:Coord]] để biết đến nhiều tham số và
    tùy chọn khác.

Lưu ý: Hàm này cung cấp các phần tử hiển thị thị giác của [[Bản mẫu:Coord]]. Để
cho có thể tải các tọa độ lên cơ sở dữ liệu, hàm cú pháp {{#tọađộ:}} cũng cần
được gọi. Hàm này được gọi tự động trong phiên bản Lua của [[Bản mẫu:Coord]].
]=]
function coordinates.coord(frame)
    globalFrame = frame
    local args = frame.args
    if args[1] == nil then
        local pFrame = frame:getParent();
        args = pFrame.args;
        for k,v in pairs( frame.args ) do
            args[k] = v;
        end
    end
    
    for i=1,10 do 
        if args[i] == nil then 
            args[i] = ""
        else
            args[i] = args[i]:match( '^%s*(.-)%s*$' );  --remove whitespace
            
            -- Biến đổi thành định dạng số tiếng Anh.
            -- CHO RẰNG: Các giá trị số không bao giờ tới 1.000.
            args[i] = args[i]:gsub(",", ".", 1)
        end        
    end
    args['format'] = args['format'] or '';
    
    local contents = formatTest(args)
    local Notes = args.notes or ""
    local Display = string.lower(args.display or "inline")
    if Display == '' then
        Display = 'inline';
    end
    
    local text = ''
    if string.find( Display, 'inline' ) ~= nil or Display == 'i' or 
            Display == 'it' or Display == 'ti' then
        text = displayinline(contents, Notes)
    end
    if string.find( Display, 'title' ) ~= nil or Display == 't' or 
            Display == 'it' or Display == 'ti' then
        text = text .. displaytitle(contents, Notes)
    end
    return text
end

return coordinates