Module:IATA and ICAO code

MyWikiBiz, Author Your Legacy — Tuesday November 26, 2024
Jump to navigationJump to search

Template:Module rating Template:Lua


Data

To modify the city name or the airport wikilink, it's here : Module:IATA and ICAO code/data

Usage Sandbox

To be used with template
{{IATA and ICAO code/sandbox|df=dmy|KORD: res 2019-03-03/2020-02-29|PDX: end 2020-02-29<ref>PDX date reference</ref>|CDG: res 2019-03-03/2020-02-29|NRT|YUL: beg 2019-03-03|YYZ|JRO:beg 2010-08-01 <ref>JRO date reference</ref>|NBO|KZS<ref>KZS date reference</ref>}}==>
Template:IATA and ICAO code/sandbox
{{IATA and ICAO code/sandbox|df=dmy|CDG: res 2019-03-03/2020-02-29|ORY: end 2020-02-29<ref>ORY date reference</ref>|CDG: res 2019-03-03/2020-01-29|TLS|NCE: beg 2019-03-03|FDF|FSP:beg 2019-08-01|TLN|RNS}}==>
Template:IATA and ICAO code/sandbox
To be used with template {{IATA and ICAO code|AA A}}==>Template:IATA and ICAO code

Usage with one code

To be used with template {{IATA and ICAO code|KORD}}==>Template:IATA and ICAO code
To be used with template {{IATA and ICAO code|ORD}}==>Template:IATA and ICAO code
To be used with template {{IATA and ICAO code|AA A}}==>Template:IATA and ICAO code
To be used with template {{IATA and ICAO code|AAA}}==>Template:IATA and ICAO code
To be used with template {{IATA and ICAO code|AHO}}==>Template:IATA and ICAO code

{{#invoke:IATA and ICAO code|count|AAA}}==> 1

Usage with multiple codes

{{IATA and ICAO code|AAA|NTGA|CDG|LIN|MXP|BGY}}==>
Template:IATA and ICAO code

Usage with multiple codes + dates

dmy format

{{IATA and ICAO code|df=dmy|PPT|NRT|MXP:beg 2018-10-01|BKK:res 2019-10-01|RUN:end 2018-08-01|TMS}}==>
Template:IATA and ICAO code

mdy format

{{IATA and ICAO code|df=mdy|PPT|NRT|MXP:beg 2018-10-01|BKK:res 2019-10-01|RUN:end 2018-08-01|TMS}}==>
Template:IATA and ICAO code

Usage with multiple codes + dates + references

{{IATA and ICAO code|df=dmy|PPT|NRT|MXP:beg 2018-10-01 <ref>MXP date reference</ref>|BKK:res 2019-10-01 <ref>BKK date reference</ref>|RUN:end 2018-08-01 <ref>RUN date reference</ref>|TMS}}==>
Template:IATA and ICAO code

Example for Portugal

Example for main world airports

Hartsfield–Jackson Atlanta International Airport ATL Template:IATA and ICAO code KATL Template:IATA and ICAO code
Beijing Capital International Airport PEK Template:IATA and ICAO code ZBAA Template:IATA and ICAO code
Dubai International Airport DXB Template:IATA and ICAO code OMDB Template:IATA and ICAO code
Tokyo Haneda Airport HND Template:IATA and ICAO code RJTT Template:IATA and ICAO code
Los Angeles International Airport LAX Template:IATA and ICAO code KLAX Template:IATA and ICAO code
O'Hare International Airport ORD Template:IATA and ICAO code KORD Template:IATA and ICAO code
London Heathrow Airport LHR Template:IATA and ICAO code EGLL Template:IATA and ICAO code
Hong Kong International Airport HKG Template:IATA and ICAO code VHHH Template:IATA and ICAO code
Shanghai Pudong International Airport PVG Template:IATA and ICAO code ZSPD Template:IATA and ICAO code
Paris-Charles de Gaulle Airport CDG Template:IATA and ICAO code LFPG Template:IATA and ICAO code
Amsterdam Airport Schiphol AMS Template:IATA and ICAO code EHAM Template:IATA and ICAO code
Dallas/Fort Worth International Airport DFW Template:IATA and ICAO code KDFW Template:IATA and ICAO code
Guangzhou Baiyun International Airport CAN Template:IATA and ICAO code ZGGG Template:IATA and ICAO code
Frankfurt Airport FRA Template:IATA and ICAO code EDDF Template:IATA and ICAO code
Istanbul Atatürk Airport IST Template:IATA and ICAO code LTBA Template:IATA and ICAO code
Indira Gandhi International Airport DEL Template:IATA and ICAO code VIDP Template:IATA and ICAO code
Soekarno-Hatta International Airport CGK Template:IATA and ICAO code WIII Template:IATA and ICAO code
Singapore Changi Airport SIN Template:IATA and ICAO code WSSS Template:IATA and ICAO code
Seoul Incheon International Airport ICN Template:IATA and ICAO code RKSI Template:IATA and ICAO code
Denver International Airport DEN Template:IATA and ICAO code KDEN Template:IATA and ICAO code
Suvarnabhumi Airport BKK Template:IATA and ICAO code VTBS Template:IATA and ICAO code
John F. Kennedy International Airport JFK Template:IATA and ICAO code KJFK Template:IATA and ICAO code
Kuala Lumpur International Airport KUL Template:IATA and ICAO code WMKK Template:IATA and ICAO code
San Francisco International Airport SFO Template:IATA and ICAO code KSFO Template:IATA and ICAO code
Madrid Barajas Airport MAD Template:IATA and ICAO code LEMD Template:IATA and ICAO code
Chengdu Shuangliu International Airport CTU Template:IATA and ICAO code ZUUU Template:IATA and ICAO code
McCarran International Airport LAS Template:IATA and ICAO code KLAS Template:IATA and ICAO code
Barcelona–El Prat Airport BCN Template:IATA and ICAO code LEBL Template:IATA and ICAO code
Chhatrapati Shivaji International Airport BOM Template:IATA and ICAO code VABB Template:IATA and ICAO code
Toronto Pearson International Airport YYZ Template:IATA and ICAO code CYYZ Template:IATA and ICAO code
Seattle-Tacoma International Airport SEA Template:IATA and ICAO code KSEA Template:IATA and ICAO code
Charlotte Douglas International Airport CLT Template:IATA and ICAO code KCLT Template:IATA and ICAO code
London Gatwick Airport LGW Template:IATA and ICAO code EGKK Template:IATA and ICAO code
Shenzhen Bao'an International Airport SZX Template:IATA and ICAO code ZGSZ Template:IATA and ICAO code
Taiwan Taoyuan International Airport TPE Template:IATA and ICAO code RCTP Template:IATA and ICAO code
Benito Juárez International Airport MEX Template:IATA and ICAO code MMMX Template:IATA and ICAO code
Kunming Changshui International Airport KMG Template:IATA and ICAO code ZPPP Template:IATA and ICAO code
Munich Airport MUC Template:IATA and ICAO code EDDM Template:IATA and ICAO code
Orlando International Airport MCO Template:IATA and ICAO code KMCO Template:IATA and ICAO code
Miami International Airport MIA Template:IATA and ICAO code KMIA Template:IATA and ICAO code
Phoenix Sky Harbor International Airport PHX Template:IATA and ICAO code KPHX Template:IATA and ICAO code
Sydney Kingsford-Smith Airport SYD Template:IATA and ICAO code YSSY Template:IATA and ICAO code
Newark Liberty International Airport EWR Template:IATA and ICAO code KEWR Template:IATA and ICAO code
Ninoy Aquino International Airport MNL Template:IATA and ICAO code RPLL Template:IATA and ICAO code
Shanghai Hongqiao International Airport SHA Template:IATA and ICAO code ZSSS Template:IATA and ICAO code
Xi'an Xianyang International Airport XIY Template:IATA and ICAO code ZLXY Template:IATA and ICAO code
Leonardo da Vinci–Fiumicino Airport FCO Template:IATA and ICAO code LIRF Template:IATA and ICAO code
George Bush Intercontinental Airport IAH Template:IATA and ICAO code KIAH Template:IATA and ICAO code
Narita International Airport NRT Template:IATA and ICAO code RJAA Template:IATA and ICAO code
Sheremetyevo International Airport SVO Template:IATA and ICAO code UUEE Template:IATA and ICAO code

Sandbox

Module:IATA and ICAO code/sandbox‎
Module:IATA and ICAO code/data/sandbox Module:IATA and ICAO code/data/sandbox2

  • {{#invoke:IATA and ICAO code/sandbox2|main|AAA}}==> Script error: No such module "IATA and ICAO code/sandbox2".
  • {{#invoke:IATA and ICAO code/sandbox2|main|BOD }}==> Script error: No such module "IATA and ICAO code/sandbox2".
  • {{#invoke:IATA and ICAO code/sandbox2|main|NTGA}}==> Script error: No such module "IATA and ICAO code/sandbox2".
  • {{#invoke:IATA and ICAO code/sandbox2|main|QKR}}==> Script error: No such module "IATA and ICAO code/sandbox2".
  • {{#invoke:IATA and ICAO code/sandbox|main|AAA}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|BOD }}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|NTGA}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|QKR}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|AAA}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|BOD }}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|NTGA}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|QKR}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|NWWX}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|CDG}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|LFPG}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|ORD}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|KSEA}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|O RD}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|cdg}}==> Script error: No such module "IATA and ICAO code/sandbox".
  • {{#invoke:IATA and ICAO code/sandbox|main|Bullshit}}==> Script error: No such module "IATA and ICAO code/sandbox".

require('Module:No globals');
local getArgs = require ('Module:Arguments').getArgs;
local lang = mw.language.getContentLanguage();									-- used for date formatting and validation
local namespace = mw.title.getCurrentTitle().namespace;							-- used for categorization

local master = mw.loadData("Module:IATA and ICAO code/data")
local IATA_airport = master.IATA
local ICAO_airport = master.ICAO
local wikilink_label = master.WikiName

local p = {}

function p.count(frame)
	local count = 0
		
	for i, v in ipairs(frame.args) do	
	count=count+1 end
	return count
end


--[[--------------------------< I S _ V A L I D _ D A T E >----------------------------------------------------

Dates must be real.  Returns true if date is a real date; false else.

Done this way because:
	mw.language.getContentLanguage():formatDate('Y-m-d', '2018-02-31') should return an error but instead returns
		2018-03-03

TODO: text for min/max years?

]]

local function is_valid_date (date)
local days_in_month = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};			-- number of days in each month
local month_length;
local year, month, day;

	year, month, day = date:match ('(%d%d%d%d)%-(%d%d)%-(%d%d)');				-- extract year, month, and day parts from date
	
	if (year < lang:formatDate ('Y', 'now')) or (year > lang:formatDate ('Y', 'now+2year')) then
		return false;
	end
	
	month = tonumber (month);
	if (1 > month) or (12 < month) then											-- check month
		return false;
	end
	
	if (2==month) then															-- if February
		month_length = 28;														-- then 28 days unless
		if (0==(year%4) and (0~=(year%100) or 0==(year%400))) then				-- a leap year
			month_length = 29;													-- in which case: 29 days in February
		end
	else
		month_length=days_in_month[month];										-- else month length from table
	end

	day = tonumber (day);
	if (1 > day) or ( month_length < day) then									-- check day
		return false;
	end
	return true;																-- good day
end


--[[-------------------------< M A K E _ D A T E _ T Y P E _ S T R I N G >------------------------------------

decodes begin, resume, end service date type and date stamps and returns human readable text.  Format is:
	<type><date> where:
		<type> is one of the three-character keywords:
			beg - new service begins
			res - service resumes after an interruption
			end - service ends
		<date> is a singe date or date-range similar in format to ISO 8601:
			YYYY-MM-DD - a single YMD date may be begin, resume, or end date
			YYYY-MM-DD/YYYY-MM-DD - a date range where the first date (left) is a start or resume date and the second (right) is an end date
	
returns nil and an error message if:
	type keyword is not recognized
	either date is invalid - dates must be real
	begin or resume date falls on or after end date - events must begin/resume before they end
	
event dates that have already occurred (today's date follows a begin/resume/end date) are quitely muted.  When this occurs
the function returns only an end date (if a date range and that event is still in the future).  The function will add a hidden category
to articles with muted begin/resume/end dates.

]]

local function make_date_type_string (date_type, date, date2, ref, df)
local result = {};
local cat = '';
local today = lang:formatDate ('Y-m-d', 'today');								-- system date in ymd format as a text string

	if not date_type or ('' == date_type) then									-- if not set then this code isn't dated
		return '', nil, '';														-- return empty string, no error message, empty string for category
	end

	if not is_valid_date (date) then											-- dates must be valid
		return nil, table.concat ({'invalid date: ', date});					-- return nil, an error message, category is nil but we don't care
	end

	if date2 then																-- if date is a range
		if 'end' == date_type then
			return nil, 'date range not allowed for keyword \'end\'';			-- :endYYYY-MM-DD/YYYY-MM-DD is nonsensical
		end
		
		if not is_valid_date (date2) then										-- dates must be valid
			return nil, table.concat ({'invalid date: ', date2});				-- return nil, an error message, category is nil but we don't care
		end

		if date >= date2 then													-- start/resume dates must precede end dates
			return nil, table.concat ({'invalid date order: ', date, '/', date2});	-- return nil, an error message, category is nil but we don't care
		end
	end

	if date < today then														-- if date has passed
		date = nil;																-- quietly hide expired dates
		cat = '[[Category:Expired airport code]]';								-- (but categorize)
	end

	if date2 then																-- if date is a range
		if date2 < today then													-- if date has passed
			date2 = nil;														-- quietly hide expired dates
			cat = '[[Category:Expired airport code]]';							-- (but categorize)
		end
	end

	date_type = date_type:lower();												-- make it case insensitive
	
	if 'beg' == date_type then
		if date then															-- date may be nil here because it has already passed
			table.insert (result, ' (begins ');									-- begin date is today or in the future
		elseif date2 then														-- here when date has passed and date timestamp was a range
			date = date2;														-- begin date is in the past so event has already happened; convert date2 to end
			date2 = nil;														-- unset
			table.insert (result, ' (ends ');									-- range end date is today or in the future
		end
	elseif 'res' == date_type then
		if date then
			table.insert (result, ' (resumes ');								-- resume date is today or in the future
		elseif date2 then
			date = date2;														-- resume date is in the past so event has already happened; convert date2 to end
			date2 = nil;														-- unset
			table.insert (result, ' (ends ');									-- range end date is today or in the future
		end
	elseif 'end' == date_type then
		if date then
			table.insert (result, ' (ends ');									-- end date is today or in the future
		else
			return nil;															-- date has expired for an end date type; return nil as flag to hide this destination
		end
	else
		return nil, table.concat ({'unexpected date type: ', date_type});		-- return nil, an error message, category is nil but we don't care
	end

	if date then																-- define formatting strings for lang:formatDate()
		if 'dmy' == df then
			df = 'j F Y';
		elseif 'mdy' == df then
			df = 'F j, Y';
		else
			df = 'Y-m-d';														-- yeah, sort of pointless, but simple
		end
		
		table.insert (result, lang:formatDate (df, date));						-- reformat ymd to selected format according to |df=
		
		if date2 then
			table.insert (result, '; ends ');									-- date2 always an end event
			table.insert (result, lang:formatDate (df, date2));					-- reformat ymd to selected format according to |df=
		end
	end

	if 0 ~= namespace then
		cat = ''																-- categorize articles in mainspace only
	end

	if 0 ~= #result then														-- when there is date text, 
		table.insert (result, ref);												-- reference goes just before we ...
		table.insert (result, ')');												-- ... close the date text
		return table.concat (result), nil, cat;									-- return formatted date string, no error message, and category (if mainspace)
	else
		return '', nil, cat;													-- return empty string for concatenation, no error message, and category (if mainspace)
	end
	
end


--[=[-------------------------< C O M P >---------------------------------------------------------------------

Comparison funtion for table.sort() compares wikilink labels

	[[wikilink target|wikilink label]]

]=]

local function comp (a, b)
local a_label = a:match ('^[^|]+|([^%]]+)%]%]'):lower();						-- extract the label from a
local b_label = b:match ('^[^|]+|([^%]]+)%]%]'):lower();						-- extract the label from b
	return a_label < b_label;
end


--[=[--------------------------< M A I N >--------------------------------------------------------------------

returns a wikilink to the en.wiki article that matches the IATA or ICAO code provided in the call
example of data:
	{'North America','USA','ABE','KABE','Lehigh Valley International Airport','Allentown/Bethlehem'},
	
{{#invoke:IATA and ICAO code|main|ABE}} returns
	[[Lehigh Valley International Airport|Allentown/Bethlehem]]
	or an error message

When there are multiple codes, returns comma separated, alpha ascending list of wikilinks or an error message.

]=]

function p.main(frame)
local args = getArgs(frame);
local results = {};
local code;
local date_type;
local date, date2;
local message;
local ref = '';
local cat = '';

	for _, value in ipairs (args) do
		value = mw.text.trim (value);
		if value:match ('^(%a%a%a%a?) *: *(%a%a%a) *(%d%d%d%d%-%d%d%-%d%d) */ *(%d%d%d%d%-%d%d%-%d%d) *(.*)') then
			code, date_type, date, date2, ref = value:match ('^(%a%a%a%a?) *: *(%a%a%a) *(%d%d%d%d%-%d%d%-%d%d) */ *(%d%d%d%d%-%d%d%-%d%d) *(.*)');
		elseif value:match ('^(%a%a%a%a?) *: *(%a%a%a) *(%d%d%d%d%-%d%d%-%d%d) *(.*)') then
			code, date_type, date, ref = value:match ('^(%a%a%a%a?) *: *(%a%a%a) *(%d%d%d%d%-%d%d%-%d%d) *(.*)');
		elseif value:match ('^%a%a%a%a?$') then
			code = value:match ('^%a%a%a%a?$');
		else
			return table.concat ({'<span style=\"font-size:100%; font-style:normal;\" class=\"error\">error: malformed parameter value: ', value, '</span>'});
		end

		ref = mw.text.trim (ref);												-- remove extraneous white space; if ref is only white space, makes empty string
		if '' ~= ref then
			if not ref:match ('^\127[^\127]*UNIQ%-%-ref%-%x+%-QINU[^\127]*\127') then
				return table.concat ({'<span style=\"font-size:100%; font-style:normal;\" class=\"error\">error: extraneous reference text: ', ref, '</span>'});
			end
		end

		date_type, message, cat = make_date_type_string (date_type, date, date2, ref, args.df);
		
		if message then															-- if an error message, abandon
			return table.concat ({'<span style=\"font-size:100%; font-style:normal;\" class=\"error\">error: ', message, '</span>'});
		end
		
		if date_type then														-- nil when end date type has expired
			code = code:upper();													-- force code to uppercase
	
			if IATA_airport[code] then
				table.insert (results, table.concat ({'[[', IATA_airport[code], '|', wikilink_label[code], ']]', date_type, cat}))	-- make wikilink from iata code
			elseif ICAO_airport[code] then
				table.insert (results, table.concat ({'[[', ICAO_airport[code], '|', wikilink_label[code], ']]', date_type, cat}))	-- make wikilink from icao code
			else
				return table.concat ({'<span style=\"font-size:100%; font-style:normal;\" class=\"error\">error: data missing for code: ', code, '</span>'});
			end
		end		
		date_type = nil;														-- clear so we can reuse these
		date = nil;
		date2 = nil;
		ref = '';
	end
	
	table.sort (results, comp);													-- sort in ascending alpha order
	
	local i = 1;
	while i<#results do															-- check for and remove duplicates
		if results[i] == results[i+1] then										-- compare
			table.remove (results, i);											-- remove the duplicate at results[i]; do not bump i
		else
			i = i + 1;															-- not the same so bump i
		end
	end
	
	return table.concat (results, ', ');										-- make a comma separated list
end


--[[--------------------------< D U P L I C A T E _ C H E C K >------------------------------------------------

This function looks at IATA and ICAO code in Module:IATA and ICAO code/data.  It attempts to locate invalid (by
length) codes and attempts to detect duplicate codes.

  1               2     3     4
{'North America','USA','ABE','KABE','Lehigh Valley International Airport','Allentown/Bethlehem'},

]]

function p.duplicate_check ()
	local iata_count_table = {};
	local icao_count_table = {};

	local _master = master._master

	local iata = {}
	local icao = {}

	for i, v in ipairs(_master) do												-- create tables from master
		if '' ~= v[3] then														-- iata codes TODO: length checking
			if not iata[v[3]] then
				iata[v[3]] = 1;													-- state that this is the first time we've seen this code
			else
				iata[v[3]] = iata[v[3]] + 1;									-- bump the count for this code
			end
		end
		if '' ~= v[4] then														-- iaco codes TODO: length checking
			if not icao[v[4]] then
				icao[v[4]] = 1;													-- state that this is the first time we've seen this code
			else
				icao[v[4]] = icao[v[4]] + 1;									-- bump the count for this code
			end
		end
	end
	
	for k, v in pairs (iata) do
		if 1 < v then
			table.insert (iata_count_table, table.concat ({k, ' (', v, '×)'}))
		end
	end

	for k, v in pairs (icao) do
		if 1 < v then
			table.insert (icao_count_table, table.concat ({k, ' (', v, '×)'}))
		end
	end
	
	local iata_msg = '';														-- error messages go here
	local icao_msg = '';

	if 0 ~= #iata_count_table then
		iata_msg = table.concat ({'<span style=\"font-size:100%; font-style:normal;\" class=\"error\">error: more than one IATA code:<br />	', table.concat (iata_count_table, ', '), '</span>'})
	end
	if 0 ~= #icao_count_table then
		icao_msg = table.concat ({'<span style=\"font-size:100%; font-style:normal;\" class=\"error\">error: more than one ICAO code:<br />	', table.concat (icao_count_table, ', '), '</span>'})
	end
	
	if (0 ~= #iata_count_table) or (0 ~= #icao_count_table) then				-- TODO find a better way of doing this
		return table.concat ({iata_msg, '<br /><br />', icao_msg})
	end
	return 'ok';
end

return p