Seeds of the Word

Module:Citation/CS1/Identifiers: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
m 1 revision imported
m 1 revision imported
 
(7 intermediate revisions by 2 users not shown)
Line 1:
 
--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]
Line 77 ⟶ 76:
 
Formats a wiki-style external link
 
NB. Wikidata P1630 has a formatter URL with $1 placeholder for the ID which could be worked into our prefix/id/suffix
string, either overriding local definitions (auto-update) or as fallback for identifiers without local definitions.
But is expensive and could be risky if WD gets vandalized.
 
See Template_talk:Authority_control/Archive_8#Use_Wikidata_as_the_source_for_the_external_link
 
]]
Line 93 ⟶ 86:
if options.encode == true or options.encode == nil then
url_string = mw.uri.encode( (url_string, 'PATH');
end
 
Line 100 ⟶ 93:
end
 
ext_link = mw.ustring.format ('[%s%s%s %s]', options.prefix, url_string, options.suffix or "", mw.text.nowiki (options.id));
if is_set (options.access) then
ext_link = substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[options.access].class, cfg.presentation[options.access].title, ext_link}); -- add the free-to-read / paywall lock
end
Line 116 ⟶ 109:
 
Formats a wiki-style internal link
 
TODO: Does not currently need to support options.access, options.encode, auto-linking and COinS (as in external_link_id),
but may be needed in the future for :m:Interwiki_map custom-prefixes like :arxiv:, :bibcode:, :DOI:, :hdl:, :ISSN:,
:JSTOR:, :Openlibrary:, :PMID:, :RFC:.
 
]]
 
local function internal_link_id (options)
local id = mw.ustring.gsub (options.id, '%d', cfg.date_names.local_digits); -- translate 'local' digits to Western 0-9
 
Line 141 ⟶ 138:
--[[--------------------------< I S _ E M B A R G O E D >------------------------------------------------------
 
Determines if a PMC identifier's online version is embargoed. Compares the date in |pmc-embargo-date= against today's date. If embargo date is
today's date. If embargo date is in the future, returns the content of |pmc-embargo-date=; otherwise, returns an empty string because the embargo has expired or because
an empty string because the embargo has expired or because |pmc-embargo-date= was not set in this cite.
 
]]
Line 182 ⟶ 179:
This function does not work if it is fed month names for languages other than English. Wikimedia #time: parser
apparently doesn't understand non-English date month names. This function will always return false when the date
contains a non-English month name because good1 is false after the call to langlang_object.formatDate(). To get around that
around that call this function with date parts and create a YYYY-MM-DD format datesdate.
 
]=]
 
local function is_valid_biorxiv_date (biorxiv_datey, m, d)
local biorxiv_date = table.concat ({y, m, d}, '-'); -- make ymd date
local good1, good2;
local biorxiv_ts, tomorrow_ts; -- to hold Unix timestamps representing the dates
local lang_object = mw.getContentLanguage();
 
good1, biorxiv_ts = pcall (lang_object.formatDate, lang_object, 'U', biorxiv_date ); -- convert biorxiv_date value to Unix timestamp
good2, tomorrow_ts = pcall (lang_object.formatDate, lang_object, 'U', 'today + 2 days' ); -- today midnight + 2 days is one second more than all day tomorrow
Line 220 ⟶ 218:
isxn_str = { isxn_str:byte(1, len) }; -- make a table of byte values '0' → 0x30 .. '9' → 0x39, 'X' → 0x58
len = len + 1; -- adjust to be a loop counter
for i, v in ipairs ( isxn_str ) do -- loop through all of the bytes and calculate the checksum
if v == string.byte( ("X" ) then -- if checkdigit is X (compares the byte value of 'X' which is 0x58)
temp = temp + 10 *( (len - i ); -- it represents 10 decimal
else
temp = temp + tonumber( (string.char (v) )*(len-i);
end
end
Line 243 ⟶ 241:
isxn_str = { isxn_str:byte(1, 13) }; -- make a table of byte values '0' → 0x30 .. '9' → 0x39
for i, v in ipairs ( isxn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( (string.char (v) ); -- multiply odd index digits by 1, even index digits by 3 and sum; includes check digit
end
return temp % 10 == 0; -- sum modulo 10 is zero when ISBN-13/ISMN is correct
Line 252 ⟶ 250:
--[[--------------------------< N O R M A L I Z E _ L C C N >--------------------------------------------------
 
LCCN normalization (httphttps://www.loc.gov/marc/lccn-namespace.html#normalization)
1. Remove all blanks.
2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
Line 262 ⟶ 260:
 
Returns a normalized LCCN for lccn() to validate. There is no error checking (step 3.b.1) performed in this function.
 
]]
 
Line 288 ⟶ 287:
--[[--------------------------< A R X I V >--------------------------------------------------------------------
 
See: httphttps://arxiv.org/help/arxiv_identifier
 
format and error check arXiv identifier. There are three valid forms of the identifier:
Line 313 ⟶ 312:
<date code> and <version> are as defined for 0704-1412
<number> is a five-digit number
 
]]
 
local function arxiv (id, classoptions)
local handlerid = cfgoptions.id_handlers['ARXIV']id;
local class = options.Class; -- TODO: lowercase?
local handler = options.handler;
local year, month, version;
local err_caterr_msg = false; -- assume no error message
local text; -- output text
if id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%d$") or id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%dv%d+$") then -- test for the 9107-0703 format with or without version
year, month = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$");
year = tonumber (year);
month = tonumber (month);
if ((not (90 < year or 8 > year)) or (1 > month or 12 < month)) or -- if invalid year or invalid month
((91 == year and 7 > month) or (7 == year and 3 < month)) then -- if years ok, are starting and ending months ok?
err_caterr_msg = true; -- flag for error message
end
 
elseif id:match("^%d%d[01]%d%.%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%dv%d+$") then -- test for the 0704-1412 with or without version
year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d[v%d]*$");
year = tonumber (year);
month = tonumber (month);
if ((7 > year) or (14 < year) or (1 > month or 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)
((7 == year) and (4 > month)) then -- when year is 07, is month invalid (before April)?
err_caterr_msg = true; -- flag for error message
end
 
elseif id:match("^%d%d[01]%d%.%d%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%d%dv%d+$") then -- test for the 1501- format with or without version
year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d%d[v%d]*$");
year = tonumber (year);
month = tonumber (month);
if ((15 > year) or (1 > month or 12 < month)) then -- is year invalid or is month invalid? (doesn't test for future years)
err_caterr_msg = true; -- flag for error message
end
 
else
err_caterr_msg = true; -- not a recognized format; flag for error message
end
 
if err_msg then
err_cat = err_cat and table.concat ({' ', set_message ('err_bad_arxiv')}) or ''; -- set error message if flag is true
options.coins_list_t['ARXIV'] = nil; -- when error, unset so not included in COinS
end
local err_msg_t = {};
if err_msg then
set_message ('err_bad_arxiv');
end
 
text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode, access = handler.access}) .. err_cat;
 
if is_set (class) then
Line 360 ⟶ 369:
text = table.concat ({text, ' [[//arxiv.org/archive/', class, ' ', class, ']]'}); -- external link within square brackets, not wikilink
else
text = table.concat ({text, ' ', set_message ('err_class_ignored')});
end
end
 
return text;
end
 
Line 372 ⟶ 381:
Validates (sort of) and formats a bibcode ID.
 
Format for bibcodes is specified here: httphttps://adsabs.harvard.edu/abs_doc/help_pages/data.html#bibcodes
 
But, this: 2015arXiv151206696F is apparently valid so apparently, the only things that really matter are length, 19 characters
Line 386 ⟶ 395:
]]
 
local function bibcode (id, accessoptions)
local handlerid = cfgoptions.id_handlers['BIBCODE']id;
local access = options.access;
local handler = options.handler;
local err_type;
local err_msg = '';
local year;
 
Line 402 ⟶ 414:
err_type = cfg.err_msg_supl.value; -- so value error
else
local next_year = tonumber (os.date ('%Y')) + 1; -- get the current year as a number and add one for next year
year = tonumber (year); -- convert year portion of bibcode to a number
if (1000 > year) or (year > next_year) then
Line 414 ⟶ 426:
 
if is_set (err_type) then -- if there was an error detected
textset_message = text .. ' ' .. set_message( 'err_bad_bibcode', {err_type});
options.coins_list_t['BIBCODE'] = nil; -- when error, unset so not included in COinS
 
end
 
return text;
end
Line 435 ⟶ 450:
]]
 
local function biorxiv (idoptions)
local handlerid = cfgoptions.id_handlers['BIORXIV']id;
local handler = options.handler;
local err_cat = true; -- flag; assume that there will be an error
local err_msg = true; -- flag; assume that there will be an error
local patterns = {
Line 450 ⟶ 466:
 
if m then -- m is nil when id is the six-digit form
if not is_valid_biorxiv_date (y .. '-' .., m .. '-' .., d) then -- validate the encoded date; TODO: don't ignore leap-year and actual month lengths ({{#time:}} is a poor date validator)
break; -- date fail; break out early so we don't unset the error message
end
end
err_caterr_msg = nil; -- we found a match so unset the error message
break; -- and done
end
end -- err_cat remains set here when no match
 
if err_msg then
options.coins_list_t['BIORXIV'] = nil; -- when error, unset so not included in COinS
set_message ('err_bad_biorxiv'); -- and set the error message
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator,
encode = handler.encode, access = handler.access}) .. (err_cat and (' ' .. set_message( 'err_bad_biorxiv')) or '');
end
 
Line 470 ⟶ 491:
 
The description of the structure of this identifier can be found at Help_talk:Citation_Style_1/Archive_26#CiteSeerX_id_structure
 
]]
 
local function citeseerx (idoptions)
local handlerid = cfgoptions.id_handlers['CITESEERX']id;
local handler = options.handler;
local matched;
 
local text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode,
Line 482 ⟶ 505:
matched = id:match ("^10%.1%.1%.[1-9]%d?%d?%d?%.[1-9]%d?%d?%d?$");
if not matched then
textset_message = text .. ' ' .. set_message( 'err_bad_citeseerx' );
options.coins_list_t['CITESEERX'] = nil; -- when error, unset so not included in COinS
end
 
return text;
end
Line 502 ⟶ 527:
and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely
if ever used in DOI names.
 
https://www.doi.org/doi_handbook/2_Numbering.html -- 2.2 Syntax of a DOI name
https://www.doi.org/doi_handbook/2_Numbering.html#2.2.2 -- 2.2.2 DOI prefix
 
]]
 
local function doi (id, inactive, access, ignore_invalidoptions)
local err_catid = options.id;
local handlerinactive = cfgoptions.id_handlers['DOI'];DoiBroken
local access = options.access;
local ignore_invalid = options.accept;
local handler = options.handler;
local err_flag;
 
local text;
if is_set (inactive) then
Line 526 ⟶ 558:
end
if is_set (inactive_year) and is_set (inactive_month) then
set_message ('maint_doi_inactive_dated', {inactive_year, inactive_month, ' '});
elseif is_set (inactive_year) then
set_message ('maint_doi_inactive_dated', {inactive_year, '', ''});
else
Line 536 ⟶ 568:
end
 
local registrant = id:mw.ustring.match (id, '^10%.([^/]+)/[^%s–]-[^%.,]$'); -- registrant set when DOI has the proper basic form
 
local registrant_err_patterns = { -- these patterns are for code ranges that are not supported
'^[^1-3]%d%d%d%d%.%d%d*$', -- 5 digits with subcode (0xxxx, 40000+); accepts: 10000–39999
'^[^1-45]%d%d%d%d$', -- 5 digits without subcode (0xxxx, 4000060000+); accepts: 10000–4999910000–59999
'^[^1-9]%d%d%d%.%d%d*$', -- 4 digits with subcode (0xxx); accepts: 1000–9999
'^[^1-9]%d%d%d$', -- 4 digits without subcode (0xxx); accepts: 1000–9999
'^%d%d%d%d%d%d+', -- 6 or more digits
'^%d%d?%d?$', -- less than 4 digits without subcode (3 digits with subcode is legitimate)
'^%d%d?%.[%d%.]+', -- 1 or 2 digits with subcode
'^5555$', -- test registrant will never resolve
'[^%sd%.]', -- any space character inthat isn't a digit or a registrantdot
}
 
if not ignore_invalid then
if registrant then -- when DOI has proper form
for i, pattern in ipairs (registrant_err_patterns) do -- spin through error patterns
if registrant:match (pattern) then -- to validate registrant codes
err_caterr_flag = ' ' .. set_message ('err_bad_doi'); -- when found, mark this DOI as bad
break; -- and done
end
end
else
err_caterr_flag = ' ' .. set_message ('err_bad_doi'); -- invalid directory or malformed
end
else
Line 564 ⟶ 597:
end
 
if err_flag then
options.coins_list_t['DOI'] = nil; -- when error, unset so not included in COinS
end
text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode, access = access,
auto_link = not (err_caterr_flag or is_set (inactive) or ignore_invalid) and 'doi' or nil -- do not auto-link when |doi-broken-date= has a value or when there is a DOI error or (to play it safe, after all, auto-linking is not essential) when invalid DOIs are ignored
}) .. (inactive or '');
 
return text;
return text .. (err_cat and err_cat or ''); -- parentheses required
end
 
Line 588 ⟶ 625:
if ever used in HDLs.
 
Query string parameters are named here: httphttps://www.handle.net/proxy_servlet.html. query strings are not displayed
but since '?' is an allowed character in an HDL, '?' followed by one of the query parameters is the only way we
have to detect the query string so that it isn't URL-encoded with the rest of the identifier.
Line 594 ⟶ 631:
]]
 
local function hdl(id, access(options)
local handlerid = cfgoptions.id_handlers['HDL']id;
local access = options.access;
local query_params = { -- list of known query parameters from http://www.handle.net/proxy_servlet.html
local handler = options.handler;
local query_params = { -- list of known query parameters from https://www.handle.net/proxy_servlet.html
'noredirect',
'ignore_aliases',
Line 630 ⟶ 669:
 
if nil == id:match("^[^%s–]-/[^%s–]-[^%.,]$") then -- HDL must contain a forward slash, must not contain spaces, endashes, and must not end with period or comma
textset_message = text .. ' ' .. set_message( 'err_bad_hdl' );
options.coins_list_t['HDL'] = nil; -- when error, unset so not included in COinS
end
 
return text;
end
Line 642 ⟶ 683:
]]
 
local function isbn (isbn_str, ignore_invalidoptions)
local handlerisbn_str = cfgoptions.id_handlers['ISBN']id;
local ignore_invalid = options.accept;
local handler = options.handler;
 
local function return_result (check, err_type) -- local function to handle the various returns
local ISBN = internal_link_id ({link = handler.link, label = handler.label, redirect = handler.redirect,
Line 651 ⟶ 695:
else -- here when not ignoring
if not check then -- and there is an error
options.coins_list_t['ISBN'] = nil; -- when error, unset so not included in COinS
return ISBN .. set_message ('err_bad_isbn', {err_type}, false, ' '); -- display an error message
set_message ('err_bad_isbn', err_type); -- set an error message
return ISBN; -- return id text
end
end
return ISBN; -- return id text
end
 
Line 673 ⟶ 719:
return return_result (false, cfg.err_msg_supl.form);
end
returnif return_resultnot (is_valid_isxn (id, 10), cfg.err_msg_supl.check);then -- test isbn-10 for numerical validity
return return_result (false, cfg.err_msg_supl.check); -- fail if isbn-10 is not numerically valid
end
if id:find ('^63[01]') then -- 630xxxxxxx and 631xxxxxxx are (apparently) not valid isbn group ids but are used by amazon as numeric identifiers (asin)
return return_result (false, cfg.err_msg_supl.group); -- fail if isbn-10 begins with 630/1
end
return return_result (true, cfg.err_msg_supl.check); -- pass if isbn-10 is numerically valid
else
if id:match ('^%d+$') == nil then
Line 696 ⟶ 748:
Error message if not 10 characters, if not ISBN-10, if mixed and first character is a digit.
 
|asin=630....... isand |asin=631....... are (apparently) not a legitimate ISBN though it checksums as one; these do not cause this
do not cause this function to emit the maint_asin message
 
This function is positioned here because it calls isbn()
Line 703 ⟶ 755:
]]
 
local function asin (id, domainoptions)
local err_catid = ""options.id;
local domain = options.ASINTLD;
local err_flag;
 
if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then
err_caterr_flag = ' ' .. set_message ('err_bad_asin'); -- ASIN is not a mix of 10 uppercase alpha and numeric characters
else
if id:match("^%d%d%d%d%d%d%d%d%d[%dX]$") then -- if 10-digit numeric (or 9 digits with terminal X)
if isbnis_valid_isxn (id, 10) then -- see if ASIN value is or validates as ISBN-10
if not id:find ('^63063[01]') then -- 630xxxxxxx isand 631xxxxxxx are (apparently) not a valid isbn prefixprefixes but isare used by amazon as a numeric identifier
err_flag = set_message ('maint_asinerr_bad_asin'); -- ASIN has ISBN-10 form but begins with something other than 630/1 so possiblyprobably an isbn
end
elseif not is_set (err_caterr_flag) then
err_caterr_flag = ' ' .. set_message ('err_bad_asin'); -- ASIN is not ISBN-10
end
elseif not id:match("^%u[%d%u]+$") then
err_caterr_flag = ' ' .. set_message ('err_bad_asin'); -- asin doesn't begin with uppercase alpha
end
end
if (not is_set (domain)) or in_array (domain, {'us'}) then -- default: United States
domain = "com";
elseif in_array (domain, {'jp', 'uk'}) then -- Japan, United Kingdom
domain = "co." .. domain;
elseif in_array (domain, {'au', 'br', 'mxz.cn'}) then -- Australia, Brazil, MexicoChina
domain = "cn";
elseif in_array (domain, {'au', 'br', 'mx', 'sg', 'tr'}) then -- Australia, Brazil, Mexico, Singapore, Turkey
domain = "com." .. domain;
elseif not in_array (domain, {'ae', 'ca', 'cn', 'de', 'es', 'fr', 'in', 'it', 'nl', 'pl', 'sa', 'se', 'co.jp', 'co.uk', 'com', 'com.au', 'com.br', 'com.mx', 'com.sg', 'com.tr'}) then -- Arabic Emirates, Canada, China, Germany, Spain, France, Indonesia, Italy, Netherlands, Poland, Saudi Arabia, Sweden (as of 2021-03 Austria (.at), Liechtenstein (.li) and Switzerland (.ch) still redirect to the German site (.de) with special settings, so don't maintain local ASINs for them)
err_flag = set_message ('err_bad_asin_tld'); -- unsupported asin-tld value
end
local handler = cfgoptions.id_handlers['ASIN']handler;
 
if not is_set (err_flag) then
options.coins_list_t['ASIN'] = handler.prefix .. domain .. "/dp/" .. id; -- asin for coins
else
options.coins_list_t['ASIN'] = nil; -- when error, unset so not included in COinS
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix .. domain .. "/dp/",
id = id, encode = handler.encode, separator = handler.separator}) .. err_cat;
end
 
Line 738 ⟶ 804:
 
Determines whether an ISMN string is valid. Similar to ISBN-13, ISMN is 13 digits beginning 979-0-... and uses the
same check digit calculations. See httphttps://www.ismn-international.org/download/Web_ISMN_Users_Manual_2008-6.pdf
section 2, pages 9–12.
 
ismn value not made part of COinS metadata because we don't have a url or isn't a COinS-defined identifier (rft.xxx)
or an identifier registered at info-uri.info (info:)
 
]]
 
local function ismn (idoptions)
local handlerid = cfgoptions.id_handlers['ISMN']id;
local handler = options.handler;
local text;
local valid_ismn = true;
Line 752 ⟶ 822:
id = id:gsub ('[%s-]', ''); -- remove hyphens and white space
 
if 13 ~= id:len() or id:match( ("^9790%d*$" ) == nil then -- ISMN must be 13 digits and begin with 9790
valid_ismn = false;
else
Line 769 ⟶ 839:
 
if false == valid_ismn then
options.coins_list_t['ISMN'] = nil; -- when error, unset so not included in COinS; not really necessary here because ismn not made part of COinS
text = text .. ' ' .. set_message( 'err_bad_ismn' ) -- add an error message if the ISMN is invalid
set_message ('err_bad_ismn'); -- create an error message if the ISMN is invalid
end
Line 782 ⟶ 853:
like this:
 
|issn=0819 4327 gives: [httphttps://www.worldcat.org/issn/0819 4327 0819 4327] -- can't have spaces in an external link
This code now prevents that by inserting a hyphen at the ISSN midpoint. It also validates the ISSN for length
Line 791 ⟶ 862:
]]
 
local function issn (id, e, ignore_invalidoptions)
local id = options.id;
local handler = options.handler;
local ignore_invalid = options.accept;
 
local issn_copy = id; -- save a copy of unadulterated ISSN; use this version for display if ISSN does not validate
local handler;
local text;
local valid_issn = true;
handler = cfg.id_handlers[e and 'EISSN' or 'ISSN'];
 
id = id:gsub ('[%s-]', ''); -- remove hyphens and whitespace
 
if 8 ~= id:len() or nil == id:match( ("^%d*X?$" ) then -- validate the ISSN: 8 digits long, containing only 0-9 or X in the last position
valid_issn = false; -- wrong length or improper character
else
valid_issn = is_valid_isxn (id, 8); -- validate ISSN
end
 
if true == valid_issn then
id = string.sub( (id, 1, 4 ) .. "-" .. string.sub( (id, 5 ); -- if valid, display correctly formatted version
else
id = issn_copy; -- if not valid, show the invalid ISSN with error message
Line 820 ⟶ 892:
else
if false == valid_issn then
options.coins_list_t['ISSN'] = nil; -- when error, unset so not included in COinS
text = text .. ' ' .. set_message ('err_bad_issn', e and 'e' or ''); -- add an error message if the ISSN is invalid
set_message ('err_bad_issn', (options.hkey == 'EISSN') and 'e' or ''); -- create an error message if the ISSN is invalid
end
end
return text;
end
 
Line 834 ⟶ 907:
]]
 
local function jfm (idoptions)
local handlerid = cfgoptions.id_handlers['JFM']id;
local handler = options.handler;
local id_num;
 
local err_cat = '';
id_num = id:match ('^[Jj][Ff][Mm](.*)$'); -- identifier with jfm prefix; extract identifier
 
if is_set (id_num) then
set_message ('maint_jfm_format');
else -- plain number without mrJFM prefix
id_num = id; -- if here id does not have prefix
end
Line 850 ⟶ 923:
id = id_num; -- jfm matches pattern
else
err_catset_message = ' ' .. set_message( 'err_bad_jfm' ); -- set an error message
options.coins_list_t['JFM'] = nil; -- when error, unset so not included in COinS
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode}) .. err_cat;
end
 
 
--[[--------------------------< J S T O R >--------------------------------------------------------------------
 
Format a JSTOR with some error checking
 
]]
 
local function jstor (options)
local id = options.id;
local access = options.access;
local handler = options.handler;
 
if id:find ('[Jj][Ss][Tt][Oo][Rr]') or id:find ('^https?://') or id:find ('%s') then
set_message ('err_bad_jstor'); -- set an error message
options.coins_list_t['JSTOR'] = nil; -- when error, unset so not included in COinS
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode, access = access});
end
 
Line 862 ⟶ 957:
Format LCCN link and do simple error checking. LCCN is a character string 8-12 characters long. The length of
the LCCN dictates the character type of the first 1-3 characters; the rightmost eight are always digits.
https://oclc-research.github.io/infoURI-Frozen/info-uri.info/info:lccn/reg.html
http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
 
length = 8 then all digits
Line 872 ⟶ 967:
]]
 
local function lccn (lccnoptions)
local handlerlccn = cfgoptions.id_handlers['LCCN']id;
local handler = options.handler;
local err_cat = ''; -- presume that LCCN is valid
local err_flag; -- presume that LCCN is valid
local id = lccn; -- local copy of the LCCN
 
Line 882 ⟶ 978:
if 8 == len then
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits)
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- set an error message
end
elseif 9 == len then -- LCCN should be adddddddd
if nil == id:match("%l%d%d%d%d%d%d%d%d") then -- does it match our pattern?
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- set an error message
end
elseif 10 == len then -- LCCN should be aadddddddd or dddddddddd
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) ...
if nil == id:match("^%l%l%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- no match, set an error message
end
end
elseif 11 == len then -- LCCN should be aaadddddddd or adddddddddd
if not (id:match("^%l%l%l%d%d%d%d%d%d%d%d") or id:match("^%l%d%d%d%d%d%d%d%d%d%d")) then -- see if it matches one of our patterns
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- no match, set an error message
end
elseif 12 == len then -- LCCN should be aadddddddddd
if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- no match, set an error message
end
else
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- wrong length, set an error message
end
 
if not is_set (err_caterr_flag) and nil ~= lccn:find ('%s') then
err_caterr_flag = ' ' .. set_message ('err_bad_lccn'); -- lccn contains a space, set an error message
end
 
if is_set (err_flag) then
options.coins_list_t['LCCN'] = nil; -- when error, unset so not included in COinS
end
 
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = lccn, separator = handler.separator, encode = handler.encode}) .. err_cat;
end
 
Line 921 ⟶ 1,021:
]]
 
local function mr (idoptions)
local handlerid = cfgoptions.id_handlers['MR']id;
local handler = options.handler;
local id_num;
local id_len;
 
local err_cat = '';
id_num = id:match ('^[Mm][Rr](%d+)$'); -- identifier with mr prefix
 
Line 937 ⟶ 1,037:
id_len = id_num and id_num:len() or 0;
if (7 >= id_len) and (0 ~= id_len) then
id = string.rep ('0', 7-id_len ) .. id_num; -- zero-fill leading digits
else
err_cat = ' ' .. set_message ('err_bad_mr'); -- set an error message
options.coins_list_t['MR'] = nil; -- when error, unset so not included in COinS
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode}) .. err_cat;
end
 
Line 954 ⟶ 1,055:
]]
 
local function oclc (idoptions)
local handlerid = cfgoptions.id_handlers['OCLC']id;
local handler = options.handler;
local number;
 
local err_msg = ''; -- empty string for concatenation
if id:match('^ocm%d%d%d%d%d%d%d%d$') then -- ocm prefix and 8 digits; 001 field (12 characters)
number = id:match('ocm(%d+)'); -- get the number
Line 980 ⟶ 1,081:
id = number; -- exclude prefix, if any, from external link
else
err_msg = ' ' .. set_message ('err_bad_oclc') -- add an error message if the id is malformed
options.coins_list_t['OCLC'] = nil; -- when error, unset so not included in COinS
end
local text =return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode}) .. err_msg;
 
return text;
end
 
Line 996 ⟶ 1,096:
]]
 
local function openlibrary(id, access(options)
local handlerid = cfgoptions.id_handlers['OL']id;
local access = options.access;
local handler = options.handler;
local ident, code = id:gsub('^OL', ''):match("^(%d+([AMW]))$"); -- strip optional OL prefix followed immediately by digits followed by 'A', 'M', or 'W';
local error_msg = ''err_flag;
local prefix = { -- these are appended to the handler.prefix according to code
['A']='authors/OL',
Line 1,010 ⟶ 1,112:
code = 'X'; -- no code or id completely invalid
ident = id; -- copy id to ident so that we display the flawed identifier
error_msgerr_flag = ' ' .. set_message ('err_bad_ol');
end
 
if not is_set (err_flag) then
options.coins_list_t['OL'] = handler.prefix .. prefix[code] .. ident; -- experiment for ol coins
else
options.coins_list_t['OL'] = nil; -- when error, unset so not included in COinS
end
 
Line 1,016 ⟶ 1,124:
prefix = handler.prefix .. prefix[code],
id = ident, separator = handler.separator, encode = handler.encode,
access = access}) .. error_msg;
end
 
 
--[[--------------------------< O S T I >----------------------------------------------------------------------
 
Format OSTI and do simple error checking. OSTIs are sequential numbers beginning at 1 and counting up. This
code checks the OSTI to see that it contains only digits and is less than test_limit specified in the configuration;
the value in test_limit will need to be updated periodically as more OSTIs are issued.
 
NB. 1018 is the lowest OSTI number found in the wild (so far) and resolving OK on the OSTI site
 
]]
 
local function osti (options)
local id = options.id;
local access = options.access;
local handler = options.handler;
 
if id:match("[^%d]") then -- if OSTI has anything but digits
set_message ('err_bad_osti'); -- set an error message
options.coins_list_t['OSTI'] = nil; -- when error, unset so not included in COinS
else -- OSTI is only digits
local id_num = tonumber (id); -- convert id to a number for range testing
if 1018 > id_num or handler.id_limit < id_num then -- if OSTI is outside test limit boundaries
set_message ('err_bad_osti'); -- set an error message
options.coins_list_t['OSTI'] = nil; -- when error, unset so not included in COinS
end
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode, access = access});
end
 
Line 1,037 ⟶ 1,176:
]]
 
local function pmc (id, embargooptions)
local handlerid = cfgoptions.id_handlers['PMC']id;
local embargo = options.Embargo; -- TODO: lowercase?
local err_cat;
local handler = options.handler;
local err_flag;
local id_num;
local text;
Line 1,052 ⟶ 1,193:
 
if is_set (id_num) then -- id_num has a value so test it
id_num = tonumber (id_num); -- convert id_num to a number for range testing
if 1 > id_num or handler.id_limit < id_num then -- if PMC is outside test limit boundaries
err_caterr_flag = ' ' .. set_message ('err_bad_pmc'); -- set an error message
else
id = tostring (id_num); -- make sure id is a string
end
else -- when id format incorrect
err_caterr_flag = ' ' .. set_message ('err_bad_pmc'); -- set an error message
end
Line 1,068 ⟶ 1,209:
handler.separator,
id,
(err_cat and err_cat or '') -- parens required
});
else
text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect, -- no embargo date or embargo has expired, ok to link to article
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode, access = handler.access,
auto_link = not err_caterr_flag and 'pmc' or nil -- do not auto-link when PMC has error
});
}) .. (err_cat and err_cat or ''); -- parentheses required
end
 
if err_flag then
options.coins_list_t['PMC'] = nil; -- when error, unset so not included in COinS
end
 
return text;
end
Line 1,088 ⟶ 1,233:
]]
 
local function pmid (idoptions)
local handlerid = cfgoptions.id_handlers['PMID']id;
local handler = options.handler;
local err_cat = ''; -- presume that PMID is valid
 
if id:match("[^%d]") then -- if PMID has anything but digits
err_cat = ' ' .. set_message ('err_bad_pmid'); -- set an error message
options.coins_list_t['PMID'] = nil; -- when error, unset so not included in COinS
else -- PMID is only digits
local id_num = tonumber (id); -- convert id to a number for range testing
if 1 > id_num or handler.id_limit < id_num then -- if PMID is outside test limit boundaries
err_cat = ' ' .. set_message ('err_bad_pmid'); -- set an error message
options.coins_list_t['PMID'] = nil; -- when error, unset so not included in COinS
end
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode});
end
 
 
--[[--------------------------< R F C >------------------------------------------------------------------------
 
Format RFC and do simple error checking. RFCs are sequential numbers beginning at 1 and counting up. This
code checks the RFC to see that it contains only digits and is less than test_limit specified in the configuration;
the value in test_limit will need to be updated periodically as more RFCs are issued.
 
An index of all RFCs is here: https://tools.ietf.org/rfc/
 
]]
 
local function rfc (options)
local id = options.id;
local handler = options.handler;
 
if id:match("[^%d]") then -- if RFC has anything but digits
set_message ('err_bad_rfc'); -- set an error message
options.coins_list_t['RFC'] = nil; -- when error, unset so not included in COinS
else -- RFC is only digits
local id_num = tonumber (id); -- convert id to a number for range testing
if 1 > id_num or handler.id_limit < id_num then -- if RFC is outside test limit boundaries
set_message ('err_bad_rfc'); -- set an error message
options.coins_list_t['RFC'] = nil; -- when error, unset so not included in COinS
end
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode}), ..access err_cat= handler.access});
end
 
Line 1,116 ⟶ 1,293:
]]
 
local function s2cid (id, accessoptions)
local handlerid = cfgoptions.id_handlers['S2CID']id;
local access = options.access;
local err_cat = ''; -- presume that S2CID is valid
local handler = options.handler;
local id_num;
local text;
Line 1,125 ⟶ 1,303:
 
if is_set (id_num) then -- id_num has a value so test it
id_num = tonumber (id_num); -- convert id_num to a number for range testing
if handler.id_limit < id_num then -- if S2CID is outside test limit boundaries
err_cat = ' ' .. set_message ('bad_s2cid_errerr_bad_s2cid'); -- set an error message
options.coins_list_t['S2CID'] = nil; -- when error, unset so not included in COinS
end
 
else -- when id format incorrect
err_cat = ' ' .. set_message ('bad_s2cid_errerr_bad_s2cid'); -- set an error message
options.coins_list_t['S2CID'] = nil; -- when error, unset so not included in COinS
end
 
text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id:gsub ('%.%a%a', ''), separator = handler.separator, encode = handler.encode, access = access}) .. err_cat;
 
return text;
Line 1,144 ⟶ 1,323:
 
9-digit form of ISBN-10; uses same check-digit validation when SBN is prefixed with an additional '0' to make 10 digits
 
sbn value not made part of COinS metadata because we don't have a url or isn't a COinS-defined identifier (rft.xxx)
or an identifier registered at info-uri.info (info:)
 
]]
 
local function sbn (id, ignore_invalidoptions)
local handlerid = cfgoptions.id_handlers['SBN']id;
local ignore_invalid = options.accept;
local function return_result (check, err_type) -- local function to handle the various returns
local handler = options.handler;
local function return_result (check, err_type) -- local function to handle the various returns
local SBN = internal_link_id ({link = handler.link, label = handler.label, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator});
if not ignore_invalid then -- if not ignoring SBN errors
if not check then
options.coins_list_t['SBN'] = nil; -- when error, unset so not included in COinS; not really necessary here because sbn not made part of COinS
return SBN .. set_message ('err_bad_sbn', {err_type}, false, ' '); -- display an error message
set_message ('err_bad_sbn', {err_type}); -- display an error message
return SBN;
end
else
Line 1,166 ⟶ 1,352:
end
 
local ident = id:gsub ('[%s-]', ''); -- remove hyphens and whitespace; they interfere with the rest of the tests
 
if 9 ~= ident:len() then
Line 1,190 ⟶ 1,376:
]]
 
local function ssrn (idoptions)
local handlerid = cfgoptions.id_handlers['SSRN']id;
local handler = options.handler;
local err_cat = ''; -- presume that SSRN is valid
local id_num;
local text;
Line 1,199 ⟶ 1,385:
 
if is_set (id_num) then -- id_num has a value so test it
id_num = tonumber (id_num); -- convert id_num to a number for range testing
if 100 > id_num or handler.id_limit < id_num then -- if SSRN is outside test limit boundaries
err_cat = ' ' .. set_message ('err_bad_ssrn'); -- set an error message
options.coins_list_t['SSRN'] = nil; -- when error, unset so not included in COinS
end
else -- when id format incorrect
err_cat = ' ' .. set_message ('err_bad_ssrn'); -- set an error message
options.coins_list_t['SSRN'] = nil; -- when error, unset so not included in COinS
end
text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode, access = handleroptions.access}) .. err_cat;
 
return text;
Line 1,221 ⟶ 1,409:
]]
 
local function usenet_id (idoptions)
local handlerid = cfgoptions.id_handlers['USENETID']id;
local handler = options.handler;
 
local text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
Line 1,228 ⟶ 1,417:
if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$') then -- doesn't have '@' or has one or first or last character is '< or '>'
text = text .. ' ' .. set_message ('err_bad_usenet_id') -- add an error message if the message id is invalid
options.coins_list_t['USENETID'] = nil; -- when error, unset so not included in COinS
end
return text;
end
 
Line 1,245 ⟶ 1,435:
]]
 
local function zbl (idoptions)
local handlerid = cfgoptions.id_handlers['ZBL']id;
local err_cathandler = ''options.handler;
 
if id:match('^%d%d%d%d%d%d%d%d$') then -- is this identifier using temporary format?
set_message ('maint_zbl'); -- yes, add maint cat
elseif not id:match('^%d?%d?%d?%d%.%d%d%d%d%d$') then -- not temporary, is it normal format?
err_cat = ' ' .. set_message ('err_bad_zbl'); -- no, set an error message
options.coins_list_t['ZBL'] = nil; -- when error, unset so not included in COinS
end
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode}) .. err_cat;
end
 
 
--============================<< I N T E R F A C E F U N C T I O N S >>==========================================
 
--[[--------------------------< B U I L D _ I D _ L I S T >--------------------------------------------------------
 
Takes a table of IDs created by extract_ids() and turns it into a table of formatted ID outputs.
 
inputs:
id_list – table of identifiers built by extract_ids()
options – table of various template parameter values used to modify some manually handled identifiers
 
]]
 
local function build_id_list( id_list, options )
local new_list, handler = {};
local accept;
 
local function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
for k, v in pairs( id_list ) do
v, accept = has_accept_as_written (v); -- remove and note accept-as-written markup if present
 
-- k is uppercase identifier name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a table
-- fallback to read-only cfg
handler = setmetatable( { ['id'] = v, ['access'] = options.IdAccessLevels[k] }, fallback(k) );
 
if handler.mode == 'external' then
table.insert( new_list, {handler.label, external_link_id( handler ) } );
elseif handler.mode == 'internal' then
table.insert( new_list, {handler.label, internal_link_id( handler ) } );
elseif handler.mode ~= 'manual' then
error( cfg.messages['unknown_ID_mode'] );
elseif k == 'ARXIV' then
table.insert( new_list, {handler.label, arxiv( v, options.Class ) } );
elseif k == 'ASIN' then
table.insert( new_list, {handler.label, asin( v, options.ASINTLD ) } );
elseif k == 'BIBCODE' then
table.insert( new_list, {handler.label, bibcode( v, handler.access ) } );
elseif k == 'BIORXIV' then
table.insert( new_list, {handler.label, biorxiv( v ) } );
elseif k == 'CITESEERX' then
table.insert( new_list, {handler.label, citeseerx( v ) } );
elseif k == 'DOI' then
table.insert( new_list, {handler.label, doi( v, options.DoiBroken, handler.access, accept) } );
elseif k == 'EISSN' then
table.insert( new_list, {handler.label, issn( v, true, accept) } ); -- true distinguishes EISSN from ISSN
elseif k == 'HDL' then
table.insert( new_list, {handler.label, hdl( v, handler.access ) } );
elseif k == 'ISBN' then
table.insert( new_list, {handler.label, isbn (v, (accept or options.IgnoreISBN)) } );
elseif k == 'ISMN' then
table.insert( new_list, {handler.label, ismn( v ) } );
elseif k == 'ISSN' then
table.insert( new_list, {handler.label, issn( v, false, accept) } );
elseif k == 'JFM' then
table.insert( new_list, {handler.label, jfm( v ) } );
elseif k == 'LCCN' then
table.insert( new_list, {handler.label, lccn( v ) } );
elseif k == 'MR' then
table.insert( new_list, {handler.label, mr( v ) } );
elseif k == 'OCLC' then
table.insert( new_list, {handler.label, oclc( v ) } );
elseif k == 'OL' or k == 'OLA' then
table.insert( new_list, {handler.label, openlibrary( v, handler.access ) } );
elseif k == 'PMC' then
table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
elseif k == 'PMID' then
table.insert( new_list, {handler.label, pmid( v ) } );
elseif k == 'S2CID' then
table.insert( new_list, {handler.label, s2cid( v, handler.access ) } );
elseif k == 'SBN' then
table.insert( new_list, {handler.label, sbn (v, accept) } );
elseif k == 'SSRN' then
table.insert( new_list, {handler.label, ssrn( v ) } );
elseif k == 'USENETID' then
table.insert( new_list, {handler.label, usenet_id( v ) } );
elseif k == 'ZBL' then
table.insert( new_list, {handler.label, zbl( v ) } );
else
error( cfg.messages['unknown_manual_ID'] );
end
end
local function comp( a, b ) -- used in following table.sort()
return a[1]:lower() < b[1]:lower();
end
table.sort( new_list, comp );
for k, v in ipairs( new_list ) do
new_list[k] = v[2];
end
return new_list;
end
 
 
--[[--------------------------< E X T R A C T _ I D S >------------------------------------------------------------
Line 1,363 ⟶ 1,461:
]]
 
local function extract_ids ( args )
local id_list = {}; -- list of identifiers found in args
for k, v in pairs ( cfg.id_handlers ) do -- k is uppercase identifier name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a table
v = select_one( (args, v.parameters, 'err_redundant_parameters' ); -- v.parameters is a table of aliases for k; here we pick one from args if present
if is_set (v) then id_list[k] = v; end -- if found in args, add identifier to our list
end
return id_list;
Line 1,375 ⟶ 1,473:
--[[--------------------------< E X T R A C T _ I D _ A C C E S S _ L E V E L S >--------------------------------------
 
Fetches custom id access levels from arguments using configuration settings. Parameters which have a predefined access
Parameters which have a predefined access level (e.g. arxiv) do not use this function as they are directly rendered as free without using an additional parameter.
 
function as they are directly rendered as free without using an additional parameter.
returns a table of k/v pairs where k is same as the identifier's key in cfg.id_handlers and v is the assigned (valid) keyword
 
access-level values must match the case used in cfg.keywords_lists['id-access'] (lowercase unless there is some special reason for something else)
Line 1,383 ⟶ 1,482:
]]
 
local function extract_id_access_levels ( args, id_list )
local id_accesses_list = {};
for k, v in pairs ( cfg.id_handlers ) do
local access_param = v.custom_access; -- name of identifier's access-level parameter
if is_set (access_param) then
local access_level = args[access_param]; -- get the assigned value if there is one
if is_set (access_level) then
if not in_array (access_level, cfg.keywords_lists['id-access']) then -- exact match required
table.insert(set_message z.message_tail, { set_message( 'invalid_param_valerr_invalid_param_val', {access_param, access_level}, true ) } );
access_level = nil; -- invalid so unset
end
if not is_set (id_list[k]) then -- identifier access-level must have a matching identifier
table.insert(set_message z.message_tail, { set_message( 'err_param_access_requires_param', {k:lower()}, true ) } ); -- parameter name is uppercase in cfg.id_handlers (k); lowercase for error message
end
id_accesses_list[k] = cfg.keywords_xlate[access_level]; -- get translated keyword
Line 1,402 ⟶ 1,501:
end
return id_accesses_list;
end
 
 
--[[--------------------------< B U I L D _ I D _ L I S T >----------------------------------------------------
 
render the identifiers into a sorted sequence table
 
<ID_list_coins_t> is a table of k/v pairs where k is same as key in cfg.id_handlers and v is the assigned value
<options_t> is a table of various k/v option pairs provided in the call to new_build_id_list();
modified by this function and passed to all identifier rendering functions
<access_levels_t> is a table of k/v pairs where k is same as key in cfg.id_handlers and v is the assigned value (if valid)
 
returns a sequence table of sorted (by hkey - 'handler' key) rendered identifier strings
 
]]
 
local function build_id_list (ID_list_coins_t, options_t, access_levels_t)
local ID_list_t = {};
local accept;
local func_map = { --function map points to functions associated with hkey identifier
['ARXIV'] = arxiv,
['ASIN'] = asin,
['BIBCODE'] = bibcode,
['BIORXIV'] = biorxiv,
['CITESEERX'] = citeseerx,
['DOI'] = doi,
['EISSN'] = issn,
['HDL'] = hdl,
['ISBN'] = isbn,
['ISMN'] = ismn,
['ISSN'] = issn,
['JFM'] = jfm,
['JSTOR'] = jstor,
['LCCN'] = lccn,
['MR'] = mr,
['OCLC'] = oclc,
['OL'] = openlibrary,
['OSTI'] = osti,
['PMC'] = pmc,
['PMID'] = pmid,
['RFC'] = rfc,
['S2CID'] = s2cid,
['SBN'] = sbn,
['SSRN'] = ssrn,
['USENETID'] = usenet_id,
['ZBL'] = zbl,
}
 
for hkey, v in pairs (ID_list_coins_t) do
v, accept = has_accept_as_written (v); -- remove accept-as-written markup if present; accept is boolean true when markup removed; false else
-- every function gets the options table with value v and accept boolean
options_t.hkey = hkey; -- ~/Configuration handler key
options_t.id = v; -- add that identifier value to the options table
options_t.accept = accept; -- add the accept boolean flag
options_t.access = access_levels_t[hkey]; -- add the access level for those that have an |<identifier-access= parameter
options_t.handler = cfg.id_handlers[hkey];
options_t.coins_list_t = ID_list_coins_t; -- pointer to ID_list_coins_t; for |asin= and |ol=; also to keep erroneous values out of the citation's metadata
options_t.coins_list_t[hkey] = v; -- id value without accept-as-written markup for metadata
if options_t.handler.access and not in_array (options_t.handler.access, cfg.keywords_lists['id-access']) then
error (cfg.messages['unknown_ID_access'] .. options_t.handler.access); -- here when handler access key set to a value not listed in list of allowed id access keywords
end
 
if func_map[hkey] then
local id_text = func_map[hkey] (options_t); -- call the function to get identifier text and any error message
table.insert (ID_list_t, {hkey, id_text}); -- add identifier text to the output sequence table
else
error (cfg.messages['unknown_ID_key'] .. hkey); -- here when func_map doesn't have a function for hkey
end
end
 
local function comp (a, b) -- used by following table.sort()
return a[1]:lower() < b[1]:lower(); -- sort by hkey
end
 
table.sort (ID_list_t, comp); -- sequence table of tables sort
for k, v in ipairs (ID_list_t) do -- convert sequence table of tables to simple sequence table of strings
ID_list_t[k] = v[2]; -- v[2] is the identifier rendering from the call to the various functions in func_map{}
end
return ID_list_t;
end
 
 
--[[--------------------------< O P T I O N S _ C H E C K >----------------------------------------------------
 
check that certain option parameters have their associated identifier parameters with values
 
<ID_list_coins_t> is a table of k/v pairs where k is same as key in cfg.id_handlers and v is the assigned value
<ID_support_t> is a sequence table of tables created in citation0() where each subtable has four elements:
[1] is the support parameter's assigned value; empty string if not set
[2] is a text string same as key in cfg.id_handlers
[3] is cfg.error_conditions key used to create error message
[4] is original ID support parameter name used to create error message
returns nothing; on error emits an appropriate error message
 
]]
 
local function options_check (ID_list_coins_t, ID_support_t)
for _, v in ipairs (ID_support_t) do
if is_set (v[1]) and not ID_list_coins_t[v[2]] then -- when support parameter has a value but matching identifier parameter is missing or empty
set_message (v[3], (v[4])); -- emit the appropriate error message
end
end
end
 
 
--[[--------------------------< I D E N T I F I E R _ L I S T S _ G E T >--------------------------------------
 
Creates two identifier lists: a k/v table of identifiers and their values to be used locally and for use in the
COinS metadata, and a sequence table of the rendered identifier strings that will be included in the rendered
citation.
 
]]
 
local function identifier_lists_get (args_t, options_t, ID_support_t)
local ID_list_coins_t = extract_ids (args_t); -- get a table of identifiers and their values for use locally and for use in COinS
options_check (ID_list_coins_t, ID_support_t); -- ID support parameters must have matching identifier parameters
local ID_access_levels_t = extract_id_access_levels (args_t, ID_list_coins_t); -- get a table of identifier access levels
local ID_list_t = build_id_list (ID_list_coins_t, options_t, ID_access_levels_t); -- get a sequence table of rendered identifier strings
 
return ID_list_t, ID_list_coins_t; -- return the tables
end
 
Line 1,432 ⟶ 1,654:
auto_link_urls = auto_link_urls, -- table of identifier URLs to be used when auto-linking |title=
identifier_lists_get = identifier_lists_get, -- experiment to replace individual calls to build_id_list(), extract_ids, extract_id_access_levels
build_id_list = build_id_list,
extract_ids = extract_ids,
extract_id_access_levels = extract_id_access_levels,
is_embargoed = is_embargoed;
set_selected_modules = set_selected_modules;
Retrieved from "https://en.seminaverbi.bibleget.io/wiki/Module:Citation/CS1/Identifiers"