Module:Coordinates

--[[This module is intended to replace the functionality of {{Coord}} and relatedtemplates.  It provides several methods, including{{#invoke:Coordinates | coord }} : General function formatting and displayingcoordinate values.{{#invoke:Coordinates | dec2dms }} : Simple function for converting decimaldegree values to DMS format.{{#invoke:Coordinates | dms2dec }} : Simple function for converting DMS formatto decimal degree format.{{#invoke:Coordinates | link }} : Export the link used to reach the tools]]require('strict')local math_mod = require("Module:Math")local coordinates = {};local current_page = mw.title.getCurrentTitle()local page_name = mw.uri.encode( current_page.prefixedText, 'WIKI' );local coord_link = '//tools.wmflabs.org/geohack/geohack.php?pagename=' .. page_name .. '&params='--[[ Helper function, replacement for {{coord/display/title}} ]]local function displaytitle(s, notes)local l = "[[Geographic coordinate system|Coordinates]]: " .. slocal co = '<span id="coordinates">' .. l .. notes .. '</span>';return '<span style="font-size: small;">' .. co .. '</span>';end--[[ Helper function, Replacement for {{coord/display/inline}} ]]local function displayinline(s, notes)return s .. notesend--[[ Helper function, used in detecting DMS formatting ]]local function dmsTest(first, second)if type(first) ~= 'string' or type(second) ~= 'string' thenreturn nilendlocal s = (first .. second):upper()return s:find('^[NS][EW]$') or s:find('^[EW][NS]$')end--[[ Wrapper function to grab args, see Module:Arguments for this function's documentation. ]]local function makeInvokeFunc(funcName)return function (frame)local args = require('Module:Arguments').getArgs(frame, {wrappers = 'Template:Coord'})return coordinates[funcName](args, frame)endend--[[ Helper function, handle optional args. ]]local function optionalArg(arg, supplement)return arg and arg .. supplement or ''end--[[Formats any error messages generated for display]]local function errorPrinter(errors)local result = ""for i,v in ipairs(errors) dolocal errorHTML = '<strong class="error">Coordinates: ' .. v[2] .. '</strong>'result = result .. errorHTML .. "<br />"endreturn resultend--[[Determine the required CSS class to display coordinatesUsually geo-nondefault is hidden by CSS, unless a user has overridden this for himselfdefault is the mode as specificied by the user when calling the {{coord}} templatemode is the display mode (dec or dms) that we will need to determine the css class for ]]local function displayDefault(default, mode)if default == "" thendefault = "dec"endif default == mode thenreturn "geo-default"elsereturn "geo-nondefault"endend--[[specPrinterOutput formatter.  Takes the structure generated by either parseDecor parseDMS and formats it for inclusion on Wikipedia.]]local function specPrinter(args, coordinateSpec)local uriComponents = coordinateSpec["param"]if uriComponents == "" then-- RETURN error, should never be empty or nilreturn "ERROR param was empty"endif args["name"] thenuriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec["name"])endlocal geodmshtml = '<span class="geo-dms" title="Maps, aerial photos, and other data for this location">' .. '<span class="latitude">' .. coordinateSpec["dms-lat"] .. '</span> ' .. '<span class="longitude">' ..coordinateSpec["dms-long"] .. '</span>' .. '</span>'local lat = tonumber( coordinateSpec["dec-lat"] ) or 0local geodeclatif lat < 0 then-- FIXME this breaks the pre-existing precisiongeodeclat = tostring(coordinateSpec["dec-lat"]):sub(2) .. "°S"elsegeodeclat = (coordinateSpec["dec-lat"] or 0) .. "°N"endlocal long = tonumber( coordinateSpec["dec-long"] ) or 0local geodeclongif long < 0 then-- FIXME does not handle unicode minusgeodeclong = tostring(coordinateSpec["dec-long"]):sub(2) .. "°W" elsegeodeclong = (coordinateSpec["dec-long"] or 0) .. "°E"endlocal geodechtml = '<span class="geo-dec" title="Maps, aerial photos, and other data for this location">' .. geodeclat .. ' ' .. geodeclong .. '</span>'local geonumhtml = '<span class="geo">' .. coordinateSpec["dec-lat"] .. '; ' .. coordinateSpec["dec-long"] .. '</span>'local inner = '<span class="' .. displayDefault(coordinateSpec["default"], "dms" ) .. '">' .. geodmshtml .. '</span>'.. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>'.. '<span class="' .. displayDefault(coordinateSpec["default"], "dec" ) .. '">';if not args["name"] theninner = inner .. geodechtml .. '<span style="display:none">&#xfeff; / ' .. geonumhtml .. '</span></span>'elseinner = 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>'endreturn '<span class="plainlinks nourlexpansion">' .. '[' .. coord_link .. uriComponents .. ' ' .. inner .. ']' .. '</span>'end--[[ Helper function, convert decimal to degrees ]]local function convert_dec2dms_d(coordinate)local d = math_mod._round( coordinate, 0 ) .. "°"return d .. ""end--[[ Helper function, convert decimal to degrees and minutes ]]local 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--[[ Helper function, convert decimal to degrees, minutes, and seconds ]]local function convert_dec2dms_dms(coordinate)coordinate = math_mod._round( coordinate * 60 * 60, 0 );local s = coordinate % 60coordinate = math.floor( (coordinate - s) / 60 );local m = coordinate % 60coordinate = math.floor( (coordinate - m) / 60 );local d = coordinate % 360 .."°"return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s )end--[[ Helper function, convert decimal latitude or longitude to degrees, minutes, and seconds format based on the specified precision.  ]]local function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)local coord = tonumber(coordinate)local postfixif coord >= 0 thenpostfix = firstPostfixelsepostfix = secondPostfixendprecision = precision:lower();if precision == "dms" thenreturn convert_dec2dms_dms( math.abs( coord ) ) .. postfix;elseif precision == "dm" thenreturn convert_dec2dms_dm( math.abs( coord ) ) .. postfix;elseif precision == "d" thenreturn convert_dec2dms_d( math.abs( coord ) ) .. postfix;endend--[[Convert DMS format into a N or E decimal coordinate]]local function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str)local degrees = tonumber(degrees_str)local minutes = tonumber(minutes_str) or 0local seconds = tonumber(seconds_str) or 0local factor = 1if direction == "S" or direction == "W" thenfactor = -1endlocal precision = 0if seconds_str thenprecision = 5 + math.max( math_mod._precision(seconds_str), 0 );elseif minutes_str and minutes_str ~= '' thenprecision = 3 + math.max( math_mod._precision(minutes_str), 0 );elseprecision = math.max( math_mod._precision(degrees_str), 0 );endlocal decimal = factor * (degrees+(minutes+seconds/60)/60) return string.format( "%." .. precision .. "f", decimal ) -- not tonumber since this whole thing is string based.end--[[ Checks input values to for out of range errors.]]local 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 thenif lat_d < 0 thentable.insert(errors, {source, "latitude degrees < 0 with hemisphere flag"})endif long_d < 0 thentable.insert(errors, {source, "longitude degrees < 0 with hemisphere flag"})end--[[ #coordinates is inconsistent about whether this is an error.  If globe: isspecified, it won't error on this condition, but otherwise it will.For not simply disable this check.if long_d > 180 thentable.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"})end]]endif lat_d > 90 thentable.insert(errors, {source, "latitude degrees > 90"})endif lat_d < -90 thentable.insert(errors, {source, "latitude degrees < -90"})endif lat_m >= 60 thentable.insert(errors, {source, "latitude minutes >= 60"})endif lat_m < 0 thentable.insert(errors, {source, "latitude minutes < 0"})endif lat_s >= 60 thentable.insert(errors, {source, "latitude seconds >= 60"})endif lat_s < 0 thentable.insert(errors, {source, "latitude seconds < 0"})endif long_d >= 360 thentable.insert(errors, {source, "longitude degrees >= 360"})endif long_d <= -360 thentable.insert(errors, {source, "longitude degrees <= -360"})endif long_m >= 60 thentable.insert(errors, {source, "longitude minutes >= 60"})endif long_m < 0 thentable.insert(errors, {source, "longitude minutes < 0"})endif long_s >= 60 thentable.insert(errors, {source, "longitude seconds >= 60"})endif long_s < 0 thentable.insert(errors, {source, "longitude seconds < 0"})endreturn errors;end--[[parseDecTransforms decimal format latitude and longitude into thestructure to be used in displaying coordinates]]local function parseDec( lat, long, format )local coordinateSpec = {}local errors = {}if not long thenreturn nil, {{"parseDec", "Missing longitude"}}elseif not tonumber(long) thenreturn nil, {{"parseDec", "Longitude could not be parsed as a number: " .. long}}enderrors = 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, "N", "S", mode)  -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}coordinateSpec["dms-long"] = convert_dec2dms( long, "E", "W", mode)  -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}if format thencoordinateSpec.default = formatelsecoordinateSpec.default = "dec"endreturn coordinateSpec, errorsend--[[parseDMSTransforms degrees, minutes, seconds format latitude and longitude into the a structure to be used in displaying coordinates]]local function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format )local coordinateSpec, errors, backward = {}, {}lat_f = lat_f:upper();long_f = long_f:upper();-- Check if specified backwardif lat_f == 'E' or lat_f == 'W' thenlat_d, long_d, lat_m, long_m, lat_s, long_s, lat_f, long_f, backward = long_d, lat_d, long_m, lat_m, long_s, lat_s, long_f, lat_f, true;enderrors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS', true );if not long_d thenreturn nil, {{"parseDMS", "Missing longitude" }}elseif not tonumber(long_d) thenreturn nil, {{"parseDMS", "Longitude could not be parsed as a number:" .. long_d }}endif not lat_m and not lat_s and not long_m and not long_s and #errors == 0 then if math_mod._precision( lat_d ) > 0 or math_mod._precision( long_d ) > 0 thenif lat_f:upper() == 'S' then lat_d = '-' .. lat_d;endif long_f:upper() == 'W' then long_d = '-' .. long_d;end return parseDec( lat_d, long_d, format );endend   coordinateSpec["dms-lat"]  = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. lat_fcoordinateSpec["dms-long"] = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. long_fcoordinateSpec["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 thencoordinateSpec.default = formatelsecoordinateSpec.default = "dms"end   return coordinateSpec, errors, backwardend--[[ Check the input arguments for coord to determine the kind of data being providedand then make the necessary processing.]]local function formatTest(args)local result, errorslocal backward, primary = false, falselocal function getParam(args, lim)local ret = {}for i = 1, lim doret[i] = args[i] or ''endreturn table.concat(ret, '_')endif not args[1] then-- no lat logicreturn errorPrinter( {{"formatTest", "Missing latitude"}} )elseif not tonumber(args[1]) then-- bad lat logicreturn errorPrinter( {{"formatTest", "Unable to parse latitude as a number:" .. args[1]}} )elseif not args[4] and not args[5] and not args[6] then-- dec logicresult, errors = parseDec(args[1], args[2], args.format)if not result thenreturn errorPrinter(errors);end-- formatting for geohack: geohack expects D_N_D_E notation or D;D notation-- wikiminiatlas doesn't support D;D notation-- #coordinates parserfunction doesn't support negative decimals with NSWEresult.param = table.concat({math.abs(tonumber(args[1])), ((tonumber(args[1]) or 0) < 0) and 'S' or 'N', math.abs(tonumber(args[2])), ((tonumber(args[2]) or 0) < 0) and 'W' or 'E', args[3] or ''}, '_')elseif dmsTest(args[4], args[8]) then-- dms logicresult, errors, backward = parseDMS(args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args.format)if args[10] thentable.insert(errors, {'formatTest', 'Extra unexpected parameters'})endif not result thenreturn errorPrinter(errors)endresult.param = getParam(args, 9)elseif dmsTest(args[3], args[6]) then-- dm logicresult, errors, backward = parseDMS(args[1], args[2], nil, args[3], args[4], args[5], nil, args[6], args['format'])if args[8] thentable.insert(errors, {'formatTest', 'Extra unexpected parameters'})endif not result thenreturn errorPrinter(errors)endresult.param = getParam(args, 7)elseif dmsTest(args[2], args[4]) then-- d logicresult, errors, backward = parseDMS(args[1], nil, nil, args[2], args[3], nil, nil, args[4], args.format)if args[6] thentable.insert(errors, {'formatTest', 'Extra unexpected parameters'})endif not result thenreturn errorPrinter(errors)endresult.param = getParam(args, 5)else-- Errorreturn errorPrinter({{"formatTest", "Unknown argument format"}})endresult.name = args.namelocal extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'}for _, v in ipairs(extra_param) doif args[v] then table.insert(errors, {'formatTest', 'Parameter: "' .. v .. '=" should be "' .. v .. ':"' })endendlocal ret = specPrinter(args, result)if #errors > 0 thenret = ret .. ' ' .. errorPrinter(errors) .. '[[Category:Pages with malformed coordinate tags]]'endreturn ret, backwardend--[[Generate Wikidata tracking categories.]]local function makeWikidataCategories()local retif mw.wikibase and current_page.namespace == 0 thenlocal entity = mw.wikibase.getEntityObject()if entity and entity.claims and entity.claims.P625 and entity.claims.P625[1] thenlocal snaktype = entity.claims.P625[1].mainsnak.snaktypeif snaktype == 'value' then-- coordinates exist both here and on Wikidata, and can be compared.ret = 'Coordinates on Wikidata'elseif snaktype == 'somevalue' thenret = 'Coordinates on Wikidata set to unknown value'elseif snaktype == 'novalue' thenret = 'Coordinates on Wikidata set to no value'endelse-- We have to either import the coordinates to Wikidata or remove them here.ret = 'Coordinates not on Wikidata'endendif ret thenreturn string.format('[[Category:%s]]', ret)elsereturn ''endend--[[linkSimple function to export the coordinates link for other uses.Usage:{{#invoke:Coordinates | link }}]]function coordinates.link(frame)return coord_link;end--[[dec2dmsWrapper to allow templates to call dec2dms directly.Usage:{{#invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | negative_suffix | precision }}decimal_coordinate is converted to DMS format.  If positive, the positive_suffixis appended (typical N or E), if negative, the negative suffix is appended.  Thespecified precision is one of 'D', 'DM', or 'DMS' to specify the level of detailto use.]]coordinates.dec2dms = makeInvokeFunc('_dec2dms')function coordinates._dec2dms(args)local coordinate = args[1]local firstPostfix = args[2] or ''local secondPostfix = args[3] or ''local precision = args[4] or ''return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)end--[[Helper function to determine whether to use D, DM, or DMSformat depending on the precision of the decimal input.]]function coordinates.determineMode( value1, value2 )local precision = math.max( math_mod._precision( value1 ), math_mod._precision( value2 ) );if precision <= 0 thenreturn 'd'elseif precision <= 2 thenreturn 'dm';elsereturn 'dms';endend--[[dms2decWrapper to allow templates to call dms2dec directly.Usage:{{#invoke:Coordinates | dms2dec | direction_flag | degrees |minutes | seconds }}Converts DMS values specified as degrees, minutes, seconds too decimal format.direction_flag is one of N, S, E, W, and determines whether the output is positive (i.e. N and E) or negative (i.e. S and W).]]coordinates.dms2dec = makeInvokeFunc('_dms2dec')function coordinates._dms2dec(args)local direction = args[1]local degrees = args[2]local minutes = args[3]local seconds = args[4]return convert_dms2dec(direction, degrees, minutes, seconds)end--[[coordMain entry point for Lua function to replace {{coord}}Usage:{{#invoke:Coordinates | coord }}{{#invoke:Coordinates | coord | lat | long }}{{#invoke:Coordinates | coord | lat | lat_flag | long | long_flag }}...Refer to {{coord}} documentation page for many additional parameters and configuration options.Note: This function provides the visual display elements of {{coord}}.  Inorder to load coordinates into the database, the {{#coordinates:}} parser function must also be called, this is done automatically in the Luaversion of {{coord}}.]]coordinates.coord = makeInvokeFunc('_coord')function coordinates._coord(args)if (not args[1] or not tonumber(args[1])) and not args[2] and mw.wikibase.getEntityObject() thenargs[3] = args[1]; args[1] = nillocal entity = mw.wikibase.getEntityObject()if entity and entity.claimsand entity.claims.P625and entity.claims.P625[1].mainsnak.snaktype == 'value'thenlocal precision = entity.claims.P625[1].mainsnak.datavalue.value.precisionargs[1]=entity.claims.P625[1].mainsnak.datavalue.value.latitudeargs[2]=entity.claims.P625[1].mainsnak.datavalue.value.longitudeif precision thenprecision=-math_mod._round(math.log(precision)/math.log(10),0)args[1]=math_mod._round(args[1],precision)args[2]=math_mod._round(args[2],precision)endendendlocal contents, backward = formatTest(args)local Notes = args.notes or ''local Display = args.display and args.display:lower() or 'inline'local function isInline(s)-- Finds whether coordinates are displayed inline.return s:find('inline') ~= nil or s == 'i' or s == 'it' or s == 'ti'endlocal function isInTitle(s)-- Finds whether coordinates are displayed in the title.return s:find('title') ~= nil or s == 't' or s == 'it' or s == 'ti'endlocal function coord_wrapper(in_args)-- Calls the parser function {{#coordinates:}}.return mw.getCurrentFrame():callParserFunction('#coordinates', in_args) or ''endlocal text = ''if isInline(Display) thentext = text .. displayinline(contents, Notes)endif isInTitle(Display) thentext = text.. displaytitle(contents, Notes).. makeWikidataCategories()endif not args.nosave thenlocal page_title, count = mw.title.getCurrentTitle(), 1if backward thenlocal tmp = {}while not string.find((args[count-1] or ''), '[EW]') do tmp[count] = (args[count] or ''); count = count+1 endtmp.count = count; count = 2*(count-1)while count >= tmp.count do table.insert(tmp, 1, (args[count] or '')); count = count-1 endfor i, v in ipairs(tmp) do args[i] = v endelsewhile count <= 9 do args[count] = (args[count] or ''); count = count+1 endendif isInTitle(Display) and not page_title.isTalkPage and page_title.subpageText ~= 'doc' and page_title.subpageText ~= 'testcases' then args[10] = 'primary' endargs.notes, args.format, args.display = nil-- text = text .. coord_wrapper(args)endreturn textend--[[coord2textExtracts a single value from a transclusion of {{Coord}}.IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED.Usage:    {{#invoke:Coordinates | coord2text | {{Coord}} | parameter }}Valid values for the second parameter are: lat (signed integer), long (signed integer), type, scale, dim, region, globe, source]]function coordinates.coord2text(frame)if frame.args[1] == '' or frame.args[2] == '' or not frame.args[2] then return nil endframe.args[2] = mw.text.trim(frame.args[2])if frame.args[2] == 'lat' or frame.args[2] == 'long' thenlocal result, negative = mw.text.split((mw.ustring.match(frame.args[1],'[%.%d]+°[NS] [%.%d]+°[EW]') or ''), ' ')if frame.args[2] == 'lat' thenresult, negative = result[1], 'S'elseresult, negative = result[2], 'W'endresult = mw.text.split(result, '°')if result[2] == negative then result[1] = '-'..result[1] endreturn result[1]elsereturn mw.ustring.match(frame.args[1], 'params=.-_'..frame.args[2]..':(.-)[ _]')endend--[[coordinsertInjects some text into the Geohack link of a transclusion of {{Coord}} (if that text isn't already in the transclusion). Outputs the modified transclusion of {{Coord}}.IF THE GEOHACK LINK SYNTAX CHANGES THIS FUNCTION MUST BE MODIFIED.Usage:    {{#invoke:Coordinates | coordinsert | {{Coord}} | parameter:value | parameter:value | … }}Do not make Geohack unhappy by inserting something which isn't mentioned in the {{Coord}} documentation.]]function coordinates.coordinsert(frame)for i, v in ipairs(frame.args) doif i ~= 1 thenif not mw.ustring.find(frame.args[1], (mw.ustring.match(frame.args[i], '^(.-:)') or '')) then frame.args[1] = mw.ustring.gsub(frame.args[1], '(params=.-)_? ', '%1_'..frame.args[i]..' ')endendendif frame.args.name thenif not mw.ustring.find(frame.args[1], '<span class="vcard">') thenlocal namestr = frame.args.nameframe.args[1] = mw.ustring.gsub(frame.args[1], '(<span class="geo%-default">)(<span[^<>]*>[^<>]*</span><span[^<>]*>[^<>]*<span[^<>]*>[^<>]*</span></span>)(</span>)', '%1<span class="vcard">%2<span style="display:none">&#xfeff; (<span class="fn org">' .. namestr .. '</span>)</span></span>%3')frame.args[1] = mw.ustring.gsub(frame.args[1], '(&params=[^&"<>%[%] ]*) ', '%1&title=' .. mw.uri.encode(namestr) .. ' ')endendreturn frame.args[1]endreturn coordinates