|
]]
local has_accept_as_written, is_set, in_array, set_message, select_one,wrap_style; -- functions in Module:Citation/CS1/Utilities
local append_error, set_error, throw_error, select_one, add_maint_cat; -- functions in Module:Citation/CS1/Error
substitute, make_wikilink;
local make_internal_link; -- functions in Module:Citation/CS1/Links
local is_valid_date_from_a_point; -- functions in Module:Citation/CS1/Date_validation
local cfg; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
local wd_int_lang = (mw.site.server:match ('wikidata') and mw.getCurrentFrame():preprocess('{{int:lang}}')) or '';
--[[--------------------------< P A G E S C O P E V A R I A B L E S >--------------------------------------
declare variables here that have page-wide scope that are not brought in from other modules; that are created here and used here
]]
local auto_link_urls = {}; -- holds identifier URLs for those identifiers that can auto-link |title=
--============================<< H E L P E R F U N C T I O N S >>============================================
--[[--------------------------< W I K I D A T A _ A R T I C L E _ N A M E _ G E T >----------------------------
as an aid to internationalizing identifier-label wikilinks, gets identifier article names from Wikidata.
returns w:<lang code>:<article title> when <q> has an <article title> for <lang code>; nil else. 'w:<lang code>'
ensures that sister project (like wiktionary) will link to the <lang code>.wikipedia article.
for identifiers that do not have <q>, returns nil
for wikis that do not have mw.wikibase installed, returns nil
]]
local function wikidata_article_name_get (q)
if not is_set (q) or (q and not mw.wikibase) then -- when no q number or when a q number but mw.wikibase not installed on this wiki
return nil; -- abandon
end
local wd_article;
local this_wiki_code = cfg.this_wiki_code; -- Wikipedia subdomain; 'en' for en.wikipedia.org
wd_article = mw.wikibase.getSitelink (q, this_wiki_code .. 'wiki'); -- fetch article title from WD; nil when no title available at this wiki
if wd_article then
wd_article = table.concat ({'w:', this_wiki_code, ':', wd_article}); -- interwiki-style link without brackets if taken from WD; leading 'w:' required
end
return wd_article; -- article title from WD; nil else
end
--[[--------------------------< L A B E L _ L I N K _ M A K E >------------------------------------------------
common function to create a link for an identifier label from handler table or from Wikidata
returns the first available of:
1. redirect from local wiki's handler table (if enabled)
2. Wikidata sitelink to the local language wikipedia article (if there is a Wikidata entry for this identifier in the local language)
3. link to wikipedia article specified in the local wiki's handler table
]]
local function label_link_make (handler)
local wd_article;
if not (cfg.use_identifier_redirects and is_set (handler.redirect)) then -- redirect has priority so if enabled and available don't fetch from Wikidata because expensive
wd_article = wikidata_article_name_get (handler.q); -- if Wikidata has an article title for this wiki, get it;
end
return (cfg.use_identifier_redirects and is_set (handler.redirect) and handler.redirect) or wd_article or handler.link;
end
--[[--------------------------< E X T E R N A L _ L I N K _ I D >----------------------------------------------
Formats a wiki- style external link
警告:该函数与英文站CS1模块中相应函数不兼容,请勿盲目替换!
]]
local function external_link_id (options)
local url_string = options.link_id or options.id;
local ext_link;
if options.encode == true or options.encode == nil then
url_string = mw.uri.encode ( url_string, 'PATH');
end
ext_link = mw.ustring.format( '[%s%s%s <span title=\"%s\">%s%s%s</span>]',
if options.auto_linkprefix, andurl_string, is_set (options.access)suffix or then"",
auto_link_urls[options.auto_link]link, = tableoptions.concatlabel, ({options.prefix,separator url_string,or options.suffix})" ",
mw.text.nowiki(options.id)
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 = substitutewrap_style (cfg.presentation['ext-link-access-signal'], {cfg.presentation[options.access].classext_link, cfg.presentation[options.access].title, ext_link}); -- add the free-to-read / paywall lock
end
return ext_link;
return table.concat ({
make_wikilink (label_link_make (options), options.label), -- redirect, Wikidata link, or locally specified link (in that order)
options.separator or ' ',
ext_link
});
end
--[[--------------------------< I N T E R N A L _ L I N K _ I D >----------------------------------------------
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)
return mw.ustring.format( '[[%s%s%s|<span title=\"%s\">%s</span>%s%s]]',
local function internal_link_id (options)
options.prefix, options.id, options.suffix or "",
local id = mw.ustring.gsub (options.id, '%d', cfg.date_names.local_digits); -- translate 'local' digits to Western 0-9
options.link, options.label, options.separator or " ",
mw.text.nowiki(options.id)
return table.concat (
);
{
make_wikilink (label_link_make (options), options.label), -- wiki-link the identifier label
options.separator or ' ', -- add the separator
make_wikilink (
table.concat (
{
options.prefix,
id, -- translated to Western digits
options.suffix or ''
}),
substitute (cfg.presentation['bdi'], {'', mw.text.nowiki (options.id)}) -- bdi tags to prevent Latin script identifiers from being reversed at RTL language wikis
); -- nowiki because MediaWiki still has magic links for ISBN and the like; TODO: is it really required?
});
end
--[[--------------------------< 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 and 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.
]]
if is_set (embargo) then
local lang = mw.getContentLanguage();
local good1, embargo_date, good2, todays_date;
good1, embargo_date = pcall ( lang.formatDate, lang, 'U', embargo );
good2, todays_date = pcall( lang:.formatDate, lang, ('U' );
if good1 and good2 then -- if embargo date isand atoday's date are good datedates
if tonumber ( embargo_date ) >= tonumber ( todays_date ) then -- is embargo date is in the future?
return embargo; -- still embargoed
else
add_maint_cat ('embargo')
set_message ('maint_pmc_embargo'); -- embargo has expired; add main cat
return ''; -- unset because embargo has expired
end
end
end
return ''; -- |pmc-embargo-date= not set return empty string
end
--[[--------------------------< IS _ V A L I D _ C H I N E S E _ B O O K _ C A T E G O R Y >----------------------
检查是否为GB/T 9999.1-2018附表B.1规定的合法图书分类
]]
--[=[-------------------------< I S _ V A L I D _ R X I V _ D A T E >------------------------------------------
local function is_valid_Chinese_book_category (str)
return in_array (str, {
for biorxiv, returns true if:
"A",
2019-12-11T00:00Z <= biorxiv_date < today + 2 days
"B", "B0", "B1", "B2", "B3", "B4", "B5", "B6", "B7", "B80", "B82", "B83", "B84", "B9",
for medrxiv, returns true if:
"C", "C0", "C1", "C2", "C3", "C4", "C5", "C6", "C7", "C8", "C91", "C92", "C93", "C94", "C95", "C96", "C97",
2020-01-01T00:00Z <= medrxiv_date < today + 2 days
"D", "D0", "D1", "D2", "D33", "D4", "D5", "D6", "D73", "D8", "D9", "DF",
"E", "E0", "E1", "E2", "E3", "E8", "E9", "E99",
The dated form of biorxiv identifier has a start date of 2019-12-11. The Unix timestamp for that date is {{#time:U|2019-12-11}} = 1576022400
"F", "F0", "F1", "F2", "F3", "F4", "F49", "F5", "F59", "F6", "F7", "F8",
The medrxiv identifier has a start date of 2020-01-01. The Unix timestamp for that date is {{#time:U|2020-01-01}} = 1577836800
"G", "G0", "G1", "G2", "G3", "G4", "G8",
"H", "H0", "H1", "H2", "H3", "H4", "H5", "H61", "H62", "H63", "H64", "H65", "H66", "H67", "H7", "H81", "H83", "H84", "H9",
<rxiv_date> is the date provided in those |biorxiv= parameter values that are dated and in |medrxiv= parameter values at time 00:00:00 UTC
"I", "I0", "I1", "I2", "I3", "I7",
<today> is the current date at time 00:00:00 UTC plus 48 hours
"J", "J0", "J1", "J19", "J2", "J29", "J3", "J4", "J5", "J59", "J6", "J7", "J8", "J9",
if today's date is 2023-01-01T00:00:00 then
"K", "K0", "K1", "K2", "K3", "K4", "K5", "K6", "K7", "K81", "K85", "K89", "K9",
adding 24 hours gives 2023-01-02T00:00:00 – one second more than today
"N", "N0", "N1", "N2", "N3", "N4", "N5", "N6", "N7", "N79", "N8", "N91", "N93", "N94", "N99",
adding 24 hours gives 2023-01-03T00:00:00 – one second more than tomorrow
"O", "O1", "O3", "O4", "O6", "O7",
"P", "P1", "P2", "P3", "P4", "P5", "P6", "P7", "P9",
inputs:
"Q", "Q1", "Q2", "Q3", "Q4", "Q5", "Q6", "Q7", "Q81", "Q89", "Q91", "Q93", "Q94", "Q95", "Q96", "Q98",
<y>, <m>, <d> – year, month, day parts of the date from the birxiv or medrxiv identifier
"R", "R1", "R2", "R3", "R4", "R5", "R6", "R71", "R72", "R73", "R74", "R75", "R76", "R77", "R78", "R79", "R8", "R9",
<select> 'b' for biorxiv, 'm' for medrxiv; defaults to 'b'
"S", "S1", "S2", "S3", "S4", "S5", "S6", "S7", "S8", "S9",
"T", "TB", "TD", "TE", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TP", "TQ", "TS", "TU", "TV",
]=]
"U", "U1", "U2", "U4", "U6", "U8",
"V", "V1", "V2", "V4", "V7",
local function is_valid_rxiv_date (y, m, d, select)
"X", "X1", "X2", "X3", "X4", "X5", "X7", "X8", "X9",
if 0 == tonumber (m) and 12 < tonumber (m) then -- <m> must be a number 1–12
"Z"
return false;
});
end
if 0 == tonumber (d) and 31 < tonumber (d) then -- <d> must be a number 1–31; TODO: account for month length and leap yer?
return false;
end
local rxiv_date = table.concat ({y, m, d}, '-'); -- make ymd date string
local good1, good2;
local rxiv_ts, tomorrow_ts; -- to hold Unix timestamps representing the dates
local lang_object = mw.getContentLanguage();
good1, rxiv_ts = pcall (lang_object.formatDate, lang_object, 'U', rxiv_date); -- convert rxiv_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
if good1 and good2 then -- lang.formatDate() returns a timestamp in the local script which tonumber() may not understand
rxiv_ts = tonumber (rxiv_ts) or lang_object:parseFormattedNumber (rxiv_ts); -- convert to numbers for the comparison;
tomorrow_ts = tonumber (tomorrow_ts) or lang_object:parseFormattedNumber (tomorrow_ts);
else
return false; -- one or both failed to convert to Unix timestamp
end
local limit_ts = ((select and ('m' == select)) and 1577836800) or 1576022400; -- choose the appropriate limit timesatmp
return ((limit_ts <= rxiv_ts) and (rxiv_ts < tomorrow_ts)) -- limit_ts <= rxiv_date < tomorrow's date
end
--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------
ISBN-10 and ISSN validator code calculates checksum across all ISBNisbn/ISSNissn digits including the check digit.
ISBN-13 is checked in isbn().
If the number is valid the result will be 0. Before calling this function, ISBNissbn/ISSNissn must be checked for length
and stripped of dashes, spaces and other non-ISxNisxn characters.
]]
local function is_valid_isxn (isxn_str, len)
local temp = 0;
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
return temp % 11 == 0; -- returns true if calculation result is zero
end
--[[--------------------------< IS _ V A L I D _ I S X N _ 1 3 >-----------------------------------------------
ISBN-13 and ISMN validator code calculates checksum across all 13 ISBNisbn/ISMNismn digits including the check digit.
If the number is valid, the result will be 0. Before calling this function, ISBNisbn-13/ISMNismn must be checked for length
and stripped of dashes, spaces and other non-ISxNisxn-13 characters.
]]
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 ISBNisbn-13/ISMNismn is correct
end
--[[--------------------------< N O R M A L I Z E _ L C C N >--------------------------------------------------
LCCNlccn normalization (httpshttp://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.
2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
Returns a normalized LCCNlccn for lccn() to validate. There is no error checking (step 3.b.1) performed in this function.
]]
local function normalize_lccn (lccn)
lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace
if nil ~= string.find (lccn, '/') then
lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it
end
local prefix
local suffix
prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix
if nil ~= suffix then -- if there was a hyphen
suffix = string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6
lccn = prefix..suffix; -- reassemble the LCCNlccn
end
return lccn;
end
--============================<< I D E N T I F I E R F U N C T I O N S >>====================================
--[[--------------------------< A R X I V >--------------------------------------------------------------------
See: httpshttp://arxiv.org/help/arxiv_identifier
format and error check arXiv identifier. There are three valid forms of the identifier:
the first form, valid only between date codes 91079108 and 0703, is:
arXiv:<archive>.<class>/<date code><number><version>
where:
<date code> and <version> are as defined for 0704-1412
<number> is a five-digit number
]]
local function arxiv (optionsid, class)
local idhandler = optionscfg.idid_handlers['ARXIV'];
local year, month, version;
local class = options.Class; -- TODO: lowercase?
local err_cat = false; -- assume no error message
local handler = options.handler;
local year, month;
local err_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 91079108-0703 format withw/ or& withoutw/o 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_msgerr_cat = 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 withw/ or& withoutw/o 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 --or -- when year is 07, is month invalid (before April)?
err_msgerr_cat = 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 withw/ or& withoutw/o 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_msg err_cat = true; -- flag for error message
end
else
err_msgerr_cat = true; -- not a recognized format; flag for error message
end
err_cat = err_cat and table.concat ({' ', set_error ('bad_arxiv')}) or ''; -- set error message if flag is true
if err_msg then
options.coins_list_t['ARXIV'] = nil; -- when error, unset so not included in COinS
end
text = external_link_id({link = handler.link, label = handler.label, q = handler.q,
if err_msg then
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode, access=handler.access}) .. err_cat;
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});
if is_set (class) then
if id:match ('^%d+') then
text = table.concat ({text, ' [[https://arxiv.org/archive/', class, ' ', class, ']]'}); -- external link within square brackets, not wikilink
else
text = table.concat ({text, ' ', set_error ('class_ignored')});
set_message ('err_class_ignored');
end
else -- class not set
if id:match ('^%d+') and options.CitationClass == 'arxiv' then -- new (post 2007) format; {{cite arxiv}} only
set_message ('maint_missing_class'); -- add maint cat
end
end
return text;
end
--[[--------------------------< B I B C O D E >--------------------------------------------------------------------
Validates (sort of) and formats a bibcode IDid.
Format for bibcodes is specified here: httpshttp://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
1–4 must be digits and must represent a year in the range of 1000 – next year
5 must be a letter
6–86 must be letter, digit, ampersand, or dot (ampersand cannot directly precede a dot; &. )
7–8 must be letter, digit, ampersand, or dot (ampersand cannot directly precede a dot; &. )
9–18 must be letter, digit, or dot
19 must be a letter or dot
]]
local function bibcode (optionsid, access)
local idhandler = optionscfg.idid_handlers['BIBCODE'];
local access = options.access;
local handler = options.handler;
local ignore_invalid = options.accept;
local err_type;
local year;
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,
access = access});
if 19 ~= id:len() then
err_type = cfg.err_msg_supl.'length';
else
year = id:match ("^(%d%d%d%d)[%a][%wa&%.][%wa&%.%d][%wa&%.%d][%wa%d%.]+[%a%.]$"); --
if not year then -- if nil then no pattern match
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
err_type = cfg.err_msg_supl.'year'; -- year out of bounds
end
if id:find('&%.') then
err_type = cfg.err_msg_supl.'journal'; -- journal abbreviation must not have '&.' (if it does it'sits missing a letter)
end
if id:match ('.........%.tmp%.') then -- temporary bibcodes when positions 10–14 are '.tmp.'
set_message ('maint_bibcode');
end
end
end
if is_set (err_type) and not ignore_invalid then -- if there was an error detected and accept-as-written markup not used
set_messagetext = text .. ' ' .. set_error( 'err_bad_bibcodebad_bibcode', {err_type});
options.coins_list_t['BIBCODE'] = nil; -- when error, unset so not included in COinS
end
return text;
end
--[[--------------------------< B I O R X I V >-----------------------------------------------------------------
Format bioRxiv IDid and do simple error checking. BeforeBiorXiv 2019-12-11,ids biorXivare IDsexactly were6 10digits.1101/ followed by exactly
The bioRxiv id is the number following the last slash in the bioRxiv-issued DOI:
6 digits. After 2019-12-11, biorXiv IDs retained the six-digit identifier but prefixed that with a yyyy.mm.dd.
https://doi.org/10.1101/078733 -> 078733
date and suffixed with an optional version identifier.
2019年底,biorxiv更换新格式,故而有必要兼容新旧两种格式,对该函数作出针对性修改
From December 2025 biorxiv added a new 'doi' prefix: 10.64898:
10.64898/2025.12.10.693067
The bioRxiv ID is the string of characters:
https://doi.org/10.1101/078733 -> 10.1101/078733
or a date followed by a six-digit number followed by an optional version indicator 'v' and one or more digits:
https://www.biorxiv.org/content/10.1101/2019.12.11.123456v2 -> 10.1101/2019.12.11.123456v2
see https://www.biorxiv.org/about-biorxiv
]]
local function biorxiv (optionsid)
local idhandler = optionscfg.idid_handlers['BIORXIV'];
local err_cat = ''; -- presume that bioRxiv id is valid
local handler = options.handler;
local invalid = false;
local err_msg = true; -- flag; assume that there will be an error
id = id:gsub ("^10.1101/",""); -- doi前缀10.1101/可填可不填,便利用户使用
if nil == id:match ("^%d%d%d%d%d%d$") then -- 不是旧格式
local patterns = {
local date_str;
'^10%.1101/%d%d%d%d%d%d$', -- simple 6-digit identifier (before 2019-12-11)
'if (nil ~= id:match ("^10%.1101/(20%d%d)%.(%d%d)%.([01]%d%.[0-3]%d)%.%d%d%d%d%d%dv%d+$', --")) y.m.d. date + 6-digit identifier + version (after 2019-12-11)then
' date_str = id:match ("^10%.1101/(20%d%d)%.(%d%d)%.([01]%d%.[0-3]%d)%.%d%d%d%d%d%d$', -- y.m.d. date + 6-digit identifier (after 2019-12-11");
else
'^10%.64898/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%dv%d+$', -- y.m.d. date + 6-digit identifier + version (from December 2025)
' if (nil ~= id:match ("^10%.64898/(20%d%d)%.(%d%d)%.([01]%d%.[0-3]%d)%.%d%d%d%d%d%dv%d+$', --")) y.m.d. date + 6-digit identifier (from December 2025)then
date_str = id:match ("^(%d%d%d%d%.[01]%d%.[0-3]%d)%.%d%d%d%d%d%dv%d+$");
}
else -- 也不匹配新格式,因而为非法格式
invalid = true;
for _, pattern in ipairs (patterns) do -- spin through the patterns looking for a match
end
if id:match (pattern) then
end
local y, m, d = id:match (pattern); -- found a match, attempt to get year, month and date from the identifier
if (not invalid) then
date_str = date_str:gsub ("%.", "-");
if m then -- m is nil when id is the six-digit form
if(not is_valid_date_from_a_point(date_str, 1576022400)) then
if not is_valid_rxiv_date (y, m, d, 'b') then -- validate the encoded date; 'b' for biorxiv limit
invalid = true;
break; -- date fail; break out early so we don't unset the error message
end
end
err_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
if (invalid) then
err_cat = ' ' .. set_error( 'bad_biorxiv'); -- set an error message
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
end
prefix = handler.prefix, id = id, separator = handler.separator,
encode return external_link_id({link = handler.encodelink, accesslabel = handler.access});label, q = handler.q,
prefix = handler.prefix, id = "10.1101/" .. id, separator = handler.separator,
encode = handler.encode, access = handler.access}) .. err_cat;
end
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 (optionsid)
local idhandler = optionscfg.idid_handlers['CITESEERX'];
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,
access = handler.access});
matched = id:match ("^10%.1%.1%.[1-9]%d?%d?%d?%.[1-9]%d?%d?%d?$");
if not matched then
text = text .. ' ' .. set_error( 'bad_citeseerx' );
set_message ('err_bad_citeseerx' );
options.coins_list_t['CITESEERX'] = nil; -- when error, unset so not included in COinS
end
return text;
end
--[[--------------------------< C N I D >----------------------------------------------------------------------
判断国内统一刊号的合法性及输出相关内容
]]
local function cnid (id)
local handler = cfg.id_handlers['CNID'];
local text;
local type = 0;
local invalid = false;
local AA, BBBB, CC;
id = id:gsub ("^CN ?", "");
if nil ~= id:match ("^%d%d%-%d%d%d%d$") then
AA, BBBB = id:match ("^(%d%d)%-(%d%d%d%d)$");
else
if nil ~= id:match ("^%d%d%-%d%d%d%d/[A-Z0-9]+$") then
AA, BBBB, CC = id:match ("^(%d%d)%-(%d%d%d%d)/([A-Z0-9]+)$")
else invalid = true;
end
end
if (not invalid) then
if not in_array (AA, {"09", "10", "11", -- 北京
"12", "13", "14", "15", -- 华北
"21", "22", "23", -- 东北
"30", "31", "32", "33", "34", "35", "36", "37", -- 华东
"41", "42", "43", "44", "45", "46", -- 华中华南
"50", "51", "52", "53", "54", -- 西南
"61", "62", "63", "64", "65" -- 西北
}) then
invalid = true ;
else
local BBBB_num = tonumber (BBBB);
if (BBBB_num >= 1 and BBBB_num <= 999) then
type = 1;
if (nil ~= CC) then
invalid = true;
end;
else
if (BBBB_num >= 1000 and BBBB_num <= 5999) then
type = 2;
if (not is_valid_Chinese_book_category (CC)) then
invalid = true;
end
else
type = 3;
if (nil ~= CC and not is_valid_Chinese_book_category (CC)) then
invalid = true;
end
end
end
end
end
if (not invalid) and (1 == type) then
local link_id = id:gsub ("-","");
text = external_link_id({link = handler.link, label = handler.label,
q = handler.q, prefix = handler.prefix, suffix = "&typeNum=1",
link_id = link_id, id = id,
separator = handler.separator, encode = handler.encode});
else
if (not invalid) and (2 == type) then
text = external_link_id({link = handler.link, label = handler.label,
q = handler.q, prefix = handler.prefix, suffix = "&typeNum=2",
id = id, separator = handler.separator, encode = handler.encode});
else
text = mw.ustring.format( "<span title=\"%s\">%s%s%s</span>",
handler.link, handler.label, handler.separator,
mw.text.nowiki (id)
);
end
end
if (invalid) then
text = text .. ' ' .. set_error( 'bad_cnid');
end
return text;
end
--[[--------------------------< C S B N >----------------------------------------------------------------------
判断CSBN的合法性及产生指向豆瓣网的链接。
CSBN格式参考《谈谈国家统一书号与国际标准书号》及最新实例。
]]
local function csbn_checkCatNum (cat)
local cat_num = tonumber(cat)
return not (cat_num <=0 or cat_num >17) -- 若分类号取值不在1-17范围内,则不合法。
end
local function csbn (id)
local handler = cfg.id_handlers['CSBN'];
local text;
local invalid = false;
id = id:gsub ("%-","·");
if (nil == id:match ("^[1-9]%d?%d?%d?%d%d%d·%d+$")) then
-- CSBN由三部分组成,第一部分为中国人民大学图书分类法代号,取值1-17(前缀不补零);
-- 第二部分为出版社代号,三到五位;第三部分为种次号,取值不限。
-- 二、三部分间有小圆点;若取值不合该格式,则不合法。
-- 此外,虽然小圆点用"-"取代不合规定,但误用较多,亦有出版物采用,故兼容。
invalid = true;
else
local catNumOk = nil
local category
category = id:match ("^([1-9]%d-)%d?%d?%d%d%d·%d+$"); -- Lua无法非贪婪特定部分或指定重复次数,分别检查
if (nil == catNumOk and nil ~= category) then catNumOk = csbn_checkCatNum(category) end
category = id:match ("^([1-9]%d-)%d?%d%d%d·%d+$");
if (nil == catNumOk and nil ~= category) then catNumOk = csbn_checkCatNum(category) end
category = id:match ("^([1-9]%d-)d%d%d·%d+$");
if (nil == catNumOk and nil ~= category) then catNumOk = csbn_checkCatNum(category) end
invalid = not catNumOk;
end
-- 豆瓣网以连接号取代小圆点,故替换之。
local link_id = id:gsub ("·","%-");
text = external_link_id({link = handler.link, label = handler.label,
q = handler.q, prefix = handler.prefix,
link_id = link_id, id = id,
separator = handler.separator, encode = handler.encode});
if (invalid) then
text = text .. ' ' .. set_error( 'bad_csbn');
end
return text;
end
--[[--------------------------< D O I >------------------------------------------------------------------------
Suffix: character string of any length chosen by the registrant
This function checks a DOI name for: prefix/suffix. If the DOIdoi name contains spaces or endashes, or, if it ends
with a period or a comma, this function will emit a bad_doi error message.
DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely
if ever used in DOIdoi 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 (optionsid, inactive, access)
local idcat = options.id;""
local inactivehandler = optionscfg.DoiBrokenid_handlers['DOI'];
local access = options.access;
local ignore_invalid = options.accept;
local handler = options.handler;
local err_flag; -- error flag for errors that may not be ignored
local ignorable_err_flag; -- error flag for ((ignorable)) errors
local function is_extended_free (registrant, suffix) -- local function to check those few registrants that are mixed; identifiable by the doi suffix <incipit>
suffix = suffix:lower(); -- ascii [a-z] same as [A-Z] in doi names; see §3.4.4 Case Insensitivity of the Doi Name
if cfg.extended_registrants_t[registrant] then -- if this registrant has known free-to-read extentions
for _, incipit in ipairs (cfg.extended_registrants_t[registrant]) do -- loop through the registrant's incipits
if mw.ustring.find (suffix, '^' .. incipit:lower()) then -- ascii [a-z] same as [A-Z] in doi names
return true; -- if found done
end
end
end
end
local text;
if is_set (inactive) then
local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
if is_set(inactive_year) then
local inactive_month, good;
set_error('doi_inactive_dated', {inactive_year});
if is_set (inactive_year) then
if 4 < inactive:len() then -- inactive date has more than just a year (could be anything)
local lang_obj = mw.getContentLanguage(); -- get a language object for this wiki
good, inactive_month = pcall (lang_obj.formatDate, lang_obj, 'F', inactive); -- try to get the month name from the inactive date
if not good then
inactive_month = nil; -- something went wrong so make sure this is unset
end
end
end -- otherwise, |doi-broken-date= has something but it isn't a date
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
set_error('doi_inactive'); -- when inactive doesn't contain a recognizable year
set_message ('maint_doi_inactive');
end
inactive = substitute" (" .. cfg.messages['inactive'], .. " " .. inactive .. ");"
end
text = external_link_id({link = handler.link, label = handler.label, q = handler.q,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode, access=access}) .. (inactive or '')
if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
local registrant, suffix = mw.ustring.match (id, '^10%.([^/]+)/([^%s–]+)$'); -- registrant and suffix set when DOI has the proper basic form; both nil else
cat = ' ' .. set_error( 'bad_doi' );
if suffix then
if suffix:match ('[%.,]$') then -- |doi= has basic form but suffix has trailing dot or comma
ignorable_err_flag = true; -- set the flag so that we can emit an error message if not ignored
end
else -- here when |doi= does not have proper basic form
err_flag = true; -- set the non-ignorable error flag
ignore_invalid = false; -- unset because this error may not be ignored
end
return text .. cat
local registrant_err_patterns = { -- these patterns are for code ranges that are not supported
'^[^1-3]%d%d%d%d%.%d+$', -- 5 digits with subcode (reject 0xxxx, 40000+); accepts: 10000–39999
'^[^1-8]%d%d%d%d$', -- 5 digits without subcode (reject 0xxxx, 90000+); accepts: 10000–89999
'^[^1-9]%d%d%d%.%d+$', -- 4 digits with subcode (reject 0xxx); accepts: 1000–9999
'^[^1-9]%d%d%d$', -- 4 digits without subcode (reject 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
'[^%d%.]', -- any character that isn't a digit or a dot
}
if not err_flag then -- when DOI has proper form; <err_flag> is true when |doi= is malformed
if not ignore_invalid then -- when we're not ignoring errors
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
ignorable_err_flag = true; -- when found, mark this DOI as bad
break; -- and done
end
end
end
else -- here when ignoring invalid |doi= values
ignorable_err_flag = false; -- unset so we don't emit an error message for ignorable errors
set_message ('maint_doi_ignore'); -- add maint message when doi is properly formatted
end
end
if err_flag or ignorable_err_flag then
set_message ('err_bad_doi'); -- invalid |doi= value; emit an error message
options.coins_list_t['DOI'] = nil; -- when in error, unset so |doi= value not included in COinS
else -- here when doi has no errors or has been wrapped in accept-as-written markup
suffix = mw.ustring.match (id, '^10%.[^/]+/(.+)'); -- refetch suffix because doi may have been wrapped in accept-as-written markup
if not access and (cfg.known_free_doi_registrants_t[registrant] or is_extended_free (registrant, suffix)) then -- |doi-access=free not set and <registrant> is known to be free
set_message ('maint_doi_unflagged_free'); -- set a maint cat
end
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_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;
end
terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely
if ever used in HDLs.
Query string parameters are named here: https://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.
]]
local function hdl (optionsid, access)
local idhandler = optionscfg.idid_handlers['HDL'];
local access = options.access;
local handler = options.handler;
local query_params_t = { -- list of known query parameters from https://www.handle.net/proxy_servlet.html
'noredirect',
'ignore_aliases',
'auth',
'cert',
'index',
'type',
'urlappend',
'locatt',
'action',
}
local text = external_link_id({link = handler.link, label = handler.label, q = handler.q,
local handle, suffix, param = id:match ('(.-)(%?(%a+).+)$'); -- look for query string
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode, access=access})
local found;
if nil == id:match("^[^%s–]-/[^%s–]-[^%.,]$") then -- hdl must contain a fwd slash, must not contain spaces, endashes, and must not end with period or comma
if handle then -- when there are query strings, this is the handle identifier portion
text = text .. ' ' .. set_error( 'bad_hdl' );
for _, q in ipairs (query_params_t) do -- spin through the list of query parameters
if param:match ('^' .. q) then -- if the query string begins with one of the parameters
found = true; -- announce a find
break; -- and stop looking
end
end
end
if found then
id = handle; -- found so replace id with the handle portion; this will be URL-encoded, suffix will not
else
suffix = ''; -- make sure suffix is empty string for concatenation else
end
local text = external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
prefix = handler.prefix, id = id, suffix = suffix, separator = handler.separator, encode = handler.encode, access = access})
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
set_message ('err_bad_hdl' );
options.coins_list_t['HDL'] = nil; -- when error, unset so not included in COinS
end
return text;
end
]]
local function isbn (options_t isbn_str )
if nil ~= isbn_str:match("[^%s-0-9X]") then
local isbn_str = options_t.id;
return false, 'invalid character'; -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
local ignore_invalid = options_t.accept;
local handler = options_t.handler;
local year = options_t.Year; -- when set, valid anchor_year; may have a disambiguator which must be removed
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,
prefix = handler.prefix, id = isbn_str, separator = handler.separator});
if ignore_invalid then -- if ignoring ISBN errors
set_message ('maint_isbn_ignore'); -- add a maint category even when there is no error
else -- here when not ignoring
if not check then -- and there is an error
options_t.coins_list_t['ISBN'] = nil; -- when error, unset so not included in COinS
set_message ('err_bad_isbn', err_type); -- set an error message
return ISBN; -- return id text
end
end
return ISBN; -- return id text
end
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
local len = isbn_str:len();
if year and not ignore_invalid then --
year = year:match ('%d%d%d%d?'); -- strip disambiguator if present
if year and (1965 > tonumber(year)) then -- <year> will be nil here when |year=n.d. or |year=nd
set_message ('err_invalid_isbn_date'); -- set an error message
return internal_link_id ({link = handler.link, label = handler.label, redirect = handler.redirect,
prefix = handler.prefix, id = isbn_str, separator = handler.separator});
end
end
if nil ~= isbn_str:match ('[^%s-0-9X]') then
return return_result (false, cfg.err_msg_supl.char); -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
end
local id = isbn_str:gsub ('[%s-]', ''); -- remove hyphens and whitespace
local len = id:len();
if len ~= 10 and len ~= 13 then
return return_result (false, cfg.err_msg_supl.'length)'; -- fail if incorrect length
end
if len == 10 then
if idisbn_str:match (' "^%d*X?$'" ) == nil then -- fail if isbn_str has 'X' anywhere but last position
return return_result (false, cfg.err_msg_supl.'invalid form)';
end
if notreturn is_valid_isxn (idisbn_str, 10), then -- test isbn-10 for numerical validity'checksum';
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 idisbn_str:match (' "^%d+$'" ) == nil then
return return_result (false, cfg.err_msg_supl.char)'invalid character'; -- fail if ISBN-13isbn13 is not all digits
end
if id:match ('^97[89]%d*$') == nil then
return return_result (false, cfg.err_msg_supl.prefix); -- fail when ISBN-13 does not begin with 978 or 979
end
if idisbn_str:match (' "^9790'97[89]%d*$" ) == nil then
return return_result (false, cfg.err_msg_supl.group)'invalid prefix'; -- groupfail identifierwhen '0'isbn13 does not begin iswith reserved978 toor ISMN979
end
return return_result (is_valid_isxn_13 (idisbn_str), cfg.err_msg_supl.check)'checksum';
end
end
--[[--------------------------< A SM IA Z O N >----------------------------------------------------------------------
Formats a link to Amazon. Do simple error checking: ASINasin must be mix of 10 numeric or uppercase alpha
characters. If a mix, first character must be uppercase alpha; if all numeric, ASINsasins must be 10-digit
ISBNisbn. If 10-digit ISBNisbn, add a maintenance category so a bot or AWBawb script can replace |asin= with |isbn=.
Error message if not 10 characters, if not ISBN-10isbn10, if mixed and first character is a digit.
|asin=630....... and |asin=631....... are (apparently) not a legitimate ISBN though it checksums as one; these
do not cause this function to emit the maint_asin message
This function is positioned here because it calls isbn()
]]
local function asin (optionsid, domain)
local iderr_cat = options.id;""
local domain = options.ASINTLD;
local err_flag = nil; -- must be explicitly initialized
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_flagerr_cat = set_message' ' .. set_error ('err_bad_asinbad_asin'); -- ASINasin 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 is_valid_isxn isbn( id, 10) then -- see if ASINasin value is or validates as ISBN-10isbn10
add_maint_cat ('ASIN');
if not id:find ('^63[01]') then -- 630xxxxxxx and 631xxxxxxx are (apparently) not a valid isbn prefixes but are used by amazon as a numeric identifier
elseif not is_set (err_cat) then
err_flag = set_message ('err_bad_asin'); -- ASIN has ISBN-10 form but begins with something other than 630/1 so probably an isbn
err_cat = ' ' .. set_error ('bad_asin'); -- asin is not isbn10
end
elseif not is_set (err_flag) then
err_flag = set_message ('err_bad_asin'); -- ASIN is not ISBN-10
end
elseif not id:match("^%u[%d%u]+$") then
err_flagerr_cat = set_message' ' .. set_error ('err_bad_asinbad_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', 'za'}) then -- Japan, United Kingdom, South Africa
domain = "co." .. domain;
elseif in_array (domain, {'z.cnau', 'br', 'mx'}) then -- ChinaAustralia, Brazil, Mexico
domain = "cn";
elseif in_array (domain, {'au', 'be', 'br', 'mx', 'sg', 'tr'}) then -- Australia, Belgium, Brazil, Mexico, Singapore, Turkey
domain = "com." .. domain;
elseif not in_array (domain, {'ae', 'ca', 'cn', 'de', 'eg', 'es', 'fr', 'ie', '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, Egypt, Spain, France, Ireland, 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 = optionscfg.handlerid_handlers['ASIN'];
return external_link_id({link=handler.link,
label=handler.label, q = handler.q, prefix=handler.prefix .. domain .. "/dp/",
if not is_set (err_flag) then
id=id, encode=handler.encode, separator = handler.separator}) .. err_cat;
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})
end
--[[--------------------------< I S M N >----------------------------------------------------------------------
Determines whether an ISMN string is valid. Similar to ISBNisbn-13, ISMNismn is 13 digits beginningbegining 979-0-... and uses the
same check digit calculations. See httpshttp://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 (optionsid)
local idhandler = optionscfg.idid_handlers['ISMN'];
local handler = options.handler;
local text;
local valid_ismn = true;
local id_copy;
id_copy = id; -- save a copy because this testing is destructive
id = id:gsub (' "[%s-–]'", ''"" ); -- removestrip spaces, hyphens, and whiteendashes from the spaceismn
if 13 ~= id:len() or id:match ( "^9790%d*$" ) == nil then -- ISMNismn must be 13 digits and begin with 9790
valid_ismn = false;
else
valid_ismn=is_valid_isxn_13 (id); -- validate ISMNismn
end
-- text = internal_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect, -- use this (or external version) when there is some place to link to
-- prefix = handler.prefix, id = id_copyid, separator = handler.separator, encode = handler.encode})
text="[[" .. handler.link .. "|" .. handler.label .. "]]" .. handler.separator .. id;
text = table.concat ( -- because no place to link to yet
-- because no place to link to yet
{
make_wikilink (label_link_make (handler), handler.label),
handler.separator,
id_copy
});
if false == valid_ismn then
text = text .. ' ' .. set_error( 'bad_ismn' ) -- add an error message if the issn is invalid
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
set_message ('err_bad_ismn'); -- create an error message if the ISMN is invalid
end
return text;
end
--[[--------------------------< I S S N >----------------------------------------------------------------------
Validate and format an ISSNissn. This code fixes the case where an editor has included an ISSN in the citation but
has separated the two groups of four digits with a space. When that condition occurred, the resulting link looked
like this:
|issn=0819 4327 gives: [httpshttp://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 ISSNissn midpoint. It also validates the ISSNissn for length
and makes sure that the checkdigit agrees with the calculated value. Incorrect length (8 digits), characters
other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check ISSNissn error message. The
ISSNissn is always displayed with a hyphen, even if the ISSNissn was given as a single group of 8 digits.
]]
local function issn (optionsid, e)
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
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 text;
local valid_issn = true;
if e then
handler = cfg.id_handlers['EISSN'];
else
handler = cfg.id_handlers['ISSN'];
end
id = id:gsub (' "[%s-–]'", ''"" ); -- removestrip spaces, hyphens, and whitespaceendashes from the issn
if 8 ~= id:len() or nil == id:match ( "^%d*X?$" ) then -- validate the ISSNissn: 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 ISSNissn
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, use the show the invalid ISSNissn with error message
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})
if ignore_invalid then
set_message ('maint_issn_ignore');
else
if false == valid_issn then
options.coins_list_t['ISSN'] = nil; -- when error, unset so not included in COinS
set_message ('err_bad_issn', (options.hkey == 'EISSN') and 'e' or ''); -- create an error message if the ISSN is invalid
end
end
text = external_link_id({link = handler.link, label = handler.label, q = handler.q,
return text;
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
if false == valid_issn then
text = text .. ' ' .. set_error( 'bad_issn', e and 'e' or '' ) -- add an error message if the issn is invalid
end
return text
end
]]
local function jfm (optionsid)
local idhandler = optionscfg.idid_handlers['JFM'];
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_messageadd_maint_cat ('maint_jfm_formatjfm_format');
else -- plain number without JFMmr prefix
id_num = id; -- if here id does not have prefix
end
id = id_num; -- jfm matches pattern
else
set_messageerr_cat = ' ' .. set_error( 'err_bad_jfmbad_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
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.
http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
https://oclc-research.github.io/infoURI-Frozen/info-uri.info/info:lccn/reg.html
length = 8 then all digits
length = 9 then lccn[1] is lowercaselower case alpha
length = 10 then lccn[1] and lccn[2] are both lowercaselower case alpha or both digits
length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lowercaselower case alpha or both digits
length = 12 then lccn[1] and lccn[2] are both lowercaselower case alpha
]]
local function lccn (optionslccn)
local handler = cfg.id_handlers['LCCN'];
local id = options.id; -- local copy of the LCCN
local err_cat = ''; -- presume that LCCN is valid
local lccn_id = id;
local id = lccn; -- local copy of the lccn
local handler = options.handler;
local err_flag; -- presume that LCCN is valid
id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes)
local len = id:len(); -- get the length of the LCCNlccn
if 8 == len then
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits)
err_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_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_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_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_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_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_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_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_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_lccn' ); -- no match, set an error message
end
else
err_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_lccn' ); -- wrong length, set an error message
end
if not is_set (err_flagerr_cat) and nil ~= lccn_idlccn:find ('%s') then
err_flagerr_cat = set_message' ' .. set_error( 'err_bad_lccnbad_lccn' ); -- lccn contains a space, set an error message
end
return external_link_id({link = handler.link, label = handler.label, q = handler.q,
if is_set (err_flag) then
prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
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_id, separator = handler.separator, encode = handler.encode});
end
--[[--------------------------< M E D R X I V >-----------------------------------------------------------------
Format medRxiv ID and do simple error checking. Similar to later bioRxiv IDs, medRxiv IDs are prefixed with a
yyyy.mm.dd. date and suffixed with an optional version identifier. Ealiest date accepted is 2020.01.01
The medRxiv ID is a date followed by an eight-digit number followed by an optional version indicator 'v' and one or more digits:
https://www.medrxiv.org/content/10.1101/2020.11.16.20232009v2 -> 10.1101/2020.11.16.20232009v2
]]
local function medrxiv (options)
local id = options.id;
local handler = options.handler;
local err_msg_flag = true; -- flag; assume that there will be an error
local patterns = {
'^%d%d%d%d%d%d%d%d$', -- simple 8-digit identifier; these should be relatively rare
'^10%.1101/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%d%d%dv%d+$', -- y.m.d. date + 8-digit identifier + version (2020-01-01 and later)
'^10%.1101/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%d%d%d$', -- y.m.d. date + 8-digit identifier (2020-01-01 and later)
'^10%.64898/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%d%d%dv%d+$', -- y.m.d. date + 8-digit identifier + version (2025-12-01 and later)
'^10%.64898/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%d%d%d$', -- y.m.d. date + 8-digit identifier (2025-12-01 and later)
}
for _, pattern in ipairs (patterns) do -- spin through the patterns looking for a match
if id:match (pattern) then
local y, m, d = id:match (pattern); -- found a match, attempt to get year, month and date from the identifier
if m then -- m is nil when id is the 8-digit form
if not is_valid_rxiv_date (y, m, d, 'b') then -- validate the encoded date; 'b' for medrxiv limit
break; -- date fail; break out early so we don't unset the error message
end
end
err_msg_flag = nil; -- we found a match so unset the error message
break; -- and done
end
end -- <err_msg_flag> remains set here when no match
if err_msg_flag then
options.coins_list_t['MEDRXIV'] = nil; -- when error, unset so not included in COinS
set_message ('err_bad_medrxiv'); -- 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});
end
]]
local function mr (optionsid)
local idhandler = optionscfg.idid_handlers['MR'];
local handler = options.handler;
local id_num;
local id_len;
local err_cat = '';
id_num = id:match ('^[Mm][Rr](%d+)$'); -- identifier with mr prefix
if is_set (id_num) then
add_maint_cat ('mr_format');
set_message ('maint_mr_format'); -- add maint cat
else -- plain number without mr prefix
id_num = id:match ('^%d+$'); -- if here id is all digits
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
set_messageerr_cat = ' ' .. set_error( 'err_bad_mrbad_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
--[[--------------------------< O C L C >----------------------------------------------------------------------
Validate and format an OCLCoclc IDid. https://www.oclc.org/batchload/controlnumber.en.html {{dead link}}
archived at: https://web.archive.org/web/20161228233804/https://www.oclc.org/batchload/controlnumber.en.html
]]
local function oclc (optionsid)
local idhandler = optionscfg.idid_handlers['OCLC'];
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
number = id:match('%(OCoLC%)([1-9]%d*)'); -- get the number
if 9 < number:len() then
number = nil; -- constraincontrain to 1 to 9 digits; change this when OCLCoclc issues 10-digit numbers
end
elseif id:match('^%d+$') then -- no prefix
number = id; -- get the number
if tonumber10 < number:len(id) > handler.id_limit then
number = nil; -- unsetcontrain whento id1 to 10 digits; change this when valueoclc exceedsissues the11-digit limitnumbers
end
end
id = number; -- exclude prefix, if any, from external link
else
set_messageerr_msg = ' ' .. set_error( 'err_bad_oclcbad_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
returnlocal 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}) .. err_msg;
return text;
end
]]
local function openlibrary (optionsid, access)
local id = options.idcode;
local accesshandler = optionscfg.accessid_handlers['OL'];
local handler = options.handlerident;
local ident, code = id:gsub('^OL', ''):match("^(%d+([AMW]))$"); -- strip optional OL prefix followed immediately by digits followed by 'A', 'M', or 'W';
ident, code = id:match("^(%d+([AMW]))$"); -- optional OL prefix followed immediately by digits followed by 'A', 'M', or 'W'; remove OL prefix
local err_flag;
local prefix = { -- these are appended to the handler.prefix according to code
['A']='authors/OL',
['M']='books/OL',
['W']='works/OL',
['X']='OL' -- not a code; spoof when 'code' in id is invalid
};
if not is_set (ident) then -- if malformed return an error
return external_link_id({link=handler.link, label=handler.label, q = handler.q,
code = 'X'; -- no code or id completely invalid
prefix=handler.prefix .. 'OL',
ident = id; -- copy id to ident so that we display the flawed identifier
id=id, separator=handler.separator, encode = handler.encode,
err_flag = set_message ('err_bad_ol');
access = access}) .. ' ' .. set_error( 'bad_ol' );
end
id = ident; -- use ident without the optional OL prefix (it has been removed)
if not is_set (err_flag) then
options.coins_list_t['OL'] = handler.prefix .. prefix[code] .. ident; -- experiment for ol coins
if ( code == "A" ) then
else
return external_link_id({link=handler.link, label=handler.label, q = handler.q,
options.coins_list_t['OL'] = nil; -- when error, unset so not included in COinS
prefix=handler.prefix .. 'authors/OL',
id=id, separator=handler.separator, encode = handler.encode,
access = access})
end
if ( code == "M" ) then
return external_link_id({link=handler.link, label=handler.label, q = handler.q,
prefix=handler.prefix .. 'books/OL',
id=id, separator=handler.separator, encode = handler.encode,
access = access})
end
if ( code == "W" ) then
return external_link_id ({link = handler.link, label = handler.label, q = handler.q, redirect = handler.redirect,
return external_link_id({link=handler.link, label=handler.label, q = handler.q,
prefix = handler.prefix .. prefix[code],
prefix=handler.prefix .. 'works/OL',
id = ident, separator = handler.separator, encode = handler.encode,
id=id, separator=handler.separator, encode = handler.encode,
access = access});
access = access})
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
]]
local function pmc (optionsid, embargo)
local test_limit = 13000000; -- update this value as PMCs approach
local id = options.id;
local handler = cfg.id_handlers['PMC'];
local embargo = options.Embargo; -- TODO: lowercase?
local err_cat = ''; -- presume that PMC is valid
local handler = options.handler;
local err_flag;
local id_num;
local text;
id_num = id:match ('^[Pp][Mm][Cc](%d+)$'); -- identifier with PMCpmc prefix
if is_set (id_num) then
set_messageadd_maint_cat ('maint_pmc_formatpmc_format');
else -- plain number without PMCpmc prefix
id_num = id:match ('^%d+$'); -- if here id is all digits
end
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_limittest_limit < id_num then -- if PMC is outside test limit boundaries
err_flagerr_cat = set_message' ' .. set_error( 'err_bad_pmcbad_pmc' ); -- set an error message
else
id = tostring (id_num); -- make sure id is a string
end
else -- when id format incorrect
err_flagerr_cat = set_message' ' .. set_error( 'err_bad_pmcbad_pmc' ); -- set an error message
end
if is_set (embargo) and is_set (is_embargoed (embargo)) then -- is PMC is still embargoed?
text = table.concat ( -- still embargoed so no external link
{
make_wikilink (label_link_makemake_internal_link (handler).link, handler.label),
handler.separator,
id,
err_cat
});
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,}) .. err_cat;
auto_link = not err_flag and 'pmc' or nil -- do not auto-link when PMC has error
});
end
if err_flag then
options.coins_list_t['PMC'] = nil; -- when error, unset so not included in COinS
end
return text;
end
]]
local function pmid (optionsid)
local test_limit = 50000000; -- update this value as PMIDs approach
local id = options.id;
local handler = optionscfg.handlerid_handlers['PMID'];
local err_cat = ''; -- presume that PMID is valid
if id:match("[^%d]") then -- if PMID has anything but digits
set_messageerr_cat = ' ' .. set_error( 'err_bad_pmidbad_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_limittest_limit < id_num then -- if PMID is outside test limit boundaries
set_messageerr_cat = ' ' .. set_error( 'err_bad_pmidbad_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}) .. err_cat;
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 = handler.access});
end
--[[--------------------------< S 2 C I D >--------------------------------------------------------------------
]]
local function s2cid (optionsid, access)
local idtest_limit = options.id300000000;
local accesshandler = optionscfg.accessid_handlers['S2CID'];
local err_cat = ''; -- presume that S2CID is valid
local handler = options.handler;
local id_num = id:match ('^[1-9]%d*$'); -- id must be all digits; must not begin with 0; no open access flag
local id_num;
local text;
id_num = id:match ('^[1-9]%d*$'); -- id must be all digits; must not begin with 0; no open access flag
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_limittest_limit < id_num then -- if S2CID is outside test limit boundaries
set_messageerr_cat = ' ' .. set_error ('err_bad_s2cidbad_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
set_messageerr_cat = ' ' .. set_error ('err_bad_s2cidbad_s2cid'); -- set an error message
options.coins_list_t['S2CID'] = nil; -- when error, unset so not included in COinS
end
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, access = access}) .. err_cat;
return text;
end
--[[--------------------------< S B N >------------------------------------------------------------------------
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 (options)
local id = options.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 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
set_message ('err_bad_sbn', {err_type}); -- display an error message
return SBN;
end
else
set_message ('maint_isbn_ignore'); -- add a maint category even when there is no error (ToDo: Possibly switch to separate message for SBNs only)
end
return SBN;
end
if id:match ('[^%s-0-9X]') then
return return_result (false, cfg.err_msg_supl.char); -- fail if SBN contains anything but digits, hyphens, or the uppercase X
end
local ident = id:gsub ('[%s-]', ''); -- remove hyphens and whitespace; they interfere with the rest of the tests
if 9 ~= ident:len() then
return return_result (false, cfg.err_msg_supl.length); -- fail if incorrect length
end
if ident:match ('^%d*X?$') == nil then
return return_result (false, cfg.err_msg_supl.form); -- fail if SBN has 'X' anywhere but last position
end
return return_result (is_valid_isxn ('0' .. ident, 10), cfg.err_msg_supl.check);
end
--[[--------------------------< S S R N >----------------------------------------------------------------------
Format an SSRNssrn, do simple error checking
SSRNs are sequential numbers beginning at 100? and counting up. This code checks the SSRNssrn to see that it is
only digits and is greater than 99 and less than test_limit; the value in local variable test_limit will need
to be updated periodically as more SSRNs are issued.
]]
local function ssrn (optionsid)
local test_limit = 3500000; -- update this value as SSRNs approach
local id = options.id;
local handler = optionscfg.handlerid_handlers['SSRN'];
local err_cat = ''; -- presume that SSRN is valid
local id_num;
local text;
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_limittest_limit < id_num then -- if SSRN is outside test limit boundaries
set_messageerr_cat = ' ' .. set_error( 'err_bad_ssrnbad_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
set_messageerr_cat = ' ' .. set_error( 'err_bad_ssrnbad_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 = optionshandler.access}) .. err_cat;
return text;
]]
local function usenet_id (optionsid)
local idhandler = optionscfg.idid_handlers['USENETID'];
local handler = options.handler;
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})
if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$') then -- doesn't have '@' or has one or first or last character is '< or '>'
set_messagetext = text .. ' ' .. set_error( 'err_bad_usenet_idbad_message_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
A numerical identifier in the form nnnn.nnnnn - leading zeros in the first quartet optional
format described here: http://emis.mi.sanu.ac.rs/ZMATH/zmath/en/help/search/
temporary format is apparently eight digits. Anything else is an error
]]
local function zbl (optionsid)
local idhandler = optionscfg.idid_handlers['ZBL'];
local handlererr_cat = options.handler'';
id = id:gsub ('^[Zz][Bb][Ll]',""); -- identifier with zbl prefix; extract identifier
if (nil ~= id:match ('"^%d%d%d%d%d%d%d%d$'")) then -- is this identifier using temporary format?
set_messageadd_maint_cat ('maint_zblzbl_format'); -- yes, add maint cattemporary
else
elseif not id:match('^%d?%d?%d?%d%.%d%d%d%d%d$') then -- not temporary, is it normal format?
if (nil == id:match('^%d?%d?%d?%d%.%d%d%d%d%d$')) then -- id doesn't match the pattern
set_message ('err_bad_zbl'); -- no, set an error message
err_cat = ' ' .. set_error( 'bad_zbl' ); -- set an error message
options.coins_list_t['ZBL'] = nil; -- when error, unset so not included in COinS
end
end
return external_link_id({link = handler.link, label = handler.label, q = handler.q,
return external_link_id ({link prefix= handler.linkprefix, label id=id,separator= handler.labelseparator, q encode= handler.q,encode}) redirect.. = handler.redirect,err_cat;
prefix = handler.prefix, id = id, separator = handler.separator, encode = handler.encode});
end
--============================<< I N T E R F A C E F U N C T I O N S >>==========================================
--[[--------------------------< EB XU TI RL A C TD _ 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.
Populates ID table from arguments using configuration settings. Loops through cfg.id_handlers and searches args for
any of the parameters listed in each cfg.id_handlers['...'].parameters. If found, adds the parameter and value to
inputs:
the identifier list. Emits redundant error message if more than one alias exists in args
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 extract_ids build_id_list(args id_list, options )
local new_list, handler = {};
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;
end
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 -- k is uc 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
--[[--------------------------< E X T R A C T _ I D _ A C C E S S _ L E V E L S >--------------------------------------
table.insert( new_list, {handler.label, external_link_id( handler ) } );
elseif handler.mode == 'internal' then
Fetches custom id access levels from arguments using configuration settings. Parameters which have a predefined access
table.insert( new_list, {handler.label, internal_link_id( handler ) } );
level (e.g. arxiv) do not use this function as they are directly rendered as free without using an additional parameter.
elseif handler.mode ~= 'manual' then
throw_error( 'unknown_ID_mode' );
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
elseif k == 'ARXIV' then
table.insert( new_list, {handler.label, arxiv( v, options.Class ) } );
access-level values must match the case used in cfg.keywords_lists['id-access'] (lowercase unless there is some special reason for something else)
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 ) } );
local function extract_id_access_levels (args, id_list)
elseif k == 'BIORXIV' then
local id_accesses_list = {};
table.insert( new_list, {handler.label, biorxiv( v ) } );
for k, v in pairs (cfg.id_handlers) do
elseif k == 'CITESEERX' then
local access_param = v.custom_access; -- name of identifier's access-level parameter
table.insert( new_list, {handler.label, citeseerx( v ) } );
if is_set (access_param) then
elseif k == 'CNID' then
local access_level = args[access_param]; -- get the assigned value if there is one
table.insert( new_list, {handler.label, cnid( v ) } );
if is_set (access_level) then
elseif k == 'CSBN' then
if not in_array (access_level, cfg.keywords_lists['id-access']) then -- exact match required
table.insert( new_list, {handler.label, csbn( v ) } );
set_message ('err_invalid_param_val', {access_param, access_level});
elseif k == 'DOI' then
access_level = nil; -- invalid so unset
table.insert( new_list, {handler.label, doi( v, options.DoiBroken, handler.access ) } );
elseif k == 'EISSN' then
table.insert( new_list, {handler.label, issn( v, true ) } ); -- true distinguishes eissn from issn
elseif k == 'HDL' then
table.insert( new_list, {handler.label, hdl( v, handler.access ) } );
elseif k == 'ISBN' then
local ISBN = internal_link_id( handler );
local check;
local err_type = '';
check, err_type = isbn( v );
if not check then
if is_set(options.IgnoreISBN) then -- ISBN is invalid; if |ignore-isbn-error= set
add_maint_cat ('ignore_isbn_err'); -- ad a maint category
else
ISBN = ISBN .. set_error( 'bad_isbn', {err_type}, false, " ", "" ); -- else display an error message
end
if notelseif is_set (id_list[k]options.IgnoreISBN) then -- identifierISBN access-levelis mustOK; haveif a matching|ignore-isbn-error= identifierset
add_maint_cat ('ignore_isbn_err'); -- because |ignore-isbn-error= unnecessary
set_message ('err_param_access_requires_param', {k:lower()}); -- 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
end
table.insert( new_list, {handler.label, ISBN } );
end
elseif k == 'ISMN' then
end
table.insert( new_list, {handler.label, ismn( v ) } );
return id_accesses_list;
elseif k == 'ISSN' then
end
table.insert( new_list, {handler.label, issn( v ) } );
elseif k == 'JFM' then
table.insert( new_list, {handler.label, jfm( v ) } );
--[[--------------------------< B U I L D _ I D _ L I S T >----------------------------------------------------
elseif k == 'LCCN' then
table.insert( new_list, {handler.label, lccn( v ) } );
render the identifiers into a sorted sequence table
elseif k == 'MR' then
table.insert( new_list, {handler.label, mr( v ) } );
<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
elseif k == 'OCLC' then
<options_t> is a table of various k/v option pairs provided in the call to new_build_id_list();
table.insert( new_list, {handler.label, oclc( v ) } );
modified by this function and passed to all identifier rendering functions
elseif k == 'OL' or k == 'OLA' then
<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)
table.insert( new_list, {handler.label, openlibrary( v, handler.access ) } );
elseif k == 'PMC' then
returns a sequence table of sorted (by hkey - 'handler' key) rendered identifier strings
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
local function build_id_list (ID_list_coins_t, options_t, access_levels_t)
table.insert( new_list, {handler.label, s2cid( v, handler.access ) } );
local ID_list_t = {};
elseif k == 'SSRN' then
local accept;
table.insert( new_list, {handler.label, ssrn( v ) } );
local func_map = { --function map points to functions associated with hkey identifier
elseif k == 'USENETID' then
['ARXIV'] = arxiv,
table.insert( new_list, {handler.label, usenet_id( v ) } );
['ASIN'] = asin,
elseif k == 'ZBL' then
['BIBCODE'] = bibcode,
table.insert( new_list, {handler.label, zbl( v ) } );
['BIORXIV'] = biorxiv,
['CITESEERX'] = citeseerx,
['DOI'] = doi,
['EISSN'] = issn,
['HDL'] = hdl,
['ISBN'] = isbn,
['ISMN'] = ismn,
['ISSN'] = issn,
['JFM'] = jfm,
['JSTOR'] = jstor,
['LCCN'] = lccn,
['MEDRXIV'] = medrxiv,
['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
throw_error( 'unknown_manual_ID' );
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 byin following table.sort()
return a[1]:lower() < b[1]:lower(); -- sort by hkey
end
table.sort( (ID_list_tnew_list, comp ); -- sequence table of tables sort
for k, v in ipairs( new_list ) do
for k, v in ipairs (ID_list_t) do -- convert sequence table of tables to simple sequence table of strings
new_list[k] = v[2];
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_tnew_list;
end
--[[--------------------------< OE PX T IR OA NC ST _ CI HD E C KS >------------------------------------------------------------
Populates ID table from arguments using configuration settings. Loops through cfg.id_handlers and searches args for
check that certain option parameters have their associated identifier parameters with values
any of the parameters listed in each cfg.id_handlers['...'].parameters. If found, adds the parameter and value to
the identifier list. Emits redundant error message is more than one alias exists in args
<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 extract_ids(ID_list_coins_t, ID_support_targs )
local id_list = {}; -- list of identifiers found in args
for _, v in ipairs (ID_support_t) do
for k, v in pairs( cfg.id_handlers ) do -- k is uc identifier name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a table
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
v = select_one( args, v.parameters, 'redundant_parameters' ); -- v.parameters is a table of aliases for k; here we pick one from args if present
set_message (v[3], (v[4])); -- emit the appropriate error message
if is_set(v) then id_list[k] = v; end -- if found in args, add identifier to our list
end
end
return id_list;
end
--[[--------------------------< I D E NX T IR FA IC ET R_ I D _ LA IC SC TE S S _ GL E TV E L S >--------------------------------------
Fetches custom id access levels from arguments using configuration settings.
Creates two identifier lists: a k/v table of identifiers and their values to be used locally and for use in the
Parameters which have a predefined access level (e.g. arxiv) do not use this
COinS metadata, and a sequence table of the rendered identifier strings that will be included in the rendered
function as they are directly rendered as free without using an additional parameter.
citation.
]]
local function identifier_lists_getextract_id_access_levels( (args_targs, options_t,id_list ID_support_t)
local id_accesses_list = {};
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
for k, v in pairs( cfg.id_handlers ) do
options_check (ID_list_coins_t, ID_support_t); -- ID support parameters must have matching identifier parameters
local access_param = v.custom_access;
local ID_access_levels_t = extract_id_access_levels (args_t, ID_list_coins_t); -- get a table of identifier access levels
local k_lower = string.lower(k);
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
if is_set(access_param) then
local access_level = args[access_param];
return ID_list_t, ID_list_coins_t; -- return the tables
if is_set(access_level) then
if not in_array (access_level:lower(), cfg.keywords['id-access']) then
append_error( 'invalid_param_val', {access_param, access_level});
access_level = nil;
end
if not is_set(id_list[k]) then
append_error( 'param_access_requires_param', {k_lower});
end
if is_set(access_level) then
access_level = access_level:lower();
end
id_accesses_list[k] = access_level;
end
end
end
return id_accesses_list;
end
]]
local function set_selected_modules (cfg_table_ptr, utilities_page_ptr, error_page_ptr, links_page_ptr, validation_page_ptr)
cfg = cfg_table_ptr;
is_set = utilities_page_ptr.is_set;
has_accept_as_written = utilities_page_ptr.has_accept_as_written; -- import functions from select Module:Citation/CS1/Utilities module
is_set = utilities_page_ptr.is_set;
in_array = utilities_page_ptr.in_array;
set_messagewrap_style = utilities_page_ptr.set_messagewrap_style;
select_one = utilities_page_ptr.select_one;
append_error = error_page_ptr.append_error;
substitute = utilities_page_ptr.substitute;
set_error = error_page_ptr.set_error;
make_wikilink = utilities_page_ptr.make_wikilink;
throw_error = error_page_ptr.throw_error;
select_one = error_page_ptr.select_one;
add_maint_cat = error_page_ptr.add_maint_cat;
make_internal_link = links_page_ptr.make_internal_link;
is_valid_date_from_a_point = validation_page_ptr.is_valid_date_from_a_point;
end
return {
build_id_list = build_id_list,
auto_link_urls = auto_link_urls, -- table of identifier URLs to be used when auto-linking |title=
extract_ids = extract_ids,
extract_id_access_levels = extract_id_access_levels,
identifier_lists_get = identifier_lists_get, -- experiment to replace individual calls to build_id_list(), extract_ids, extract_id_access_levels
is_embargoed = is_embargoed;
set_selected_modules = set_selected_modules;
|