Jump to content

Module:Citation/CS1/Identifiers

Edit links
Permanently protected module
From Wikipedia, the free encyclopedia

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------]]localhas_accept_as_written,is_set,in_array,set_message,select_one,-- functions in Module:Citation/CS1/Utilitiessubstitute,make_wikilink;localz;-- table of tables defined in Module:Citation/CS1/Utilitieslocalcfg;-- table of configuration tables that are defined in Module:Citation/CS1/Configuration--[[--------------------------< 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]]localauto_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 :<lang code>:<article title> when <q> has an <article title> for <lang code>; nil elsefor identifiers that do not have q, returns nilfor wikis that do not have mw.wikibase installed, returns nil]]localfunctionwikidata_article_name_get(q)ifnotis_set(q)or(qandnotmw.wikibase)then-- when no q number or when a q number but mw.wikibase not installed on this wikireturnnil;-- abandonendlocalwd_article;localthis_wiki_code=cfg.this_wiki_code;-- Wikipedia subdomain; 'en' for en.wikipedia.orgwd_article=mw.wikibase.getSitelink(q,this_wiki_code..'wiki');-- fetch article title from WD; nil when no title available at this wikiifwd_articlethenwd_article=table.concat({':',this_wiki_code,':',wd_article});-- interwiki-style link without brackets if taken from WD; leading colon requiredendreturnwd_article;-- article title from WD; nil elseend--[[--------------------------< L I N K _ L A B E L _ M A K E >------------------------------------------------common function to create identifier link label from handler table or from Wikidatareturns the first available of 1. redirect from local wiki's handler table (if enabled) 2. Wikidata (if there is a Wikidata entry for this identifier in the local wiki's language) 3. label specified in the local wiki's handler table]]localfunctionlink_label_make(handler)localwd_article;ifnot(cfg.use_identifier_redirectsandis_set(handler.redirect))then-- redirect has priority so if enabled and available don't fetch from Wikidata because expensivewd_article=wikidata_article_name_get(handler.q);-- if Wikidata has an article title for this wiki, get it;endreturn(cfg.use_identifier_redirectsandis_set(handler.redirect)andhandler.redirect)orwd_articleorhandler.link;end--[[--------------------------< E X T E R N A L _ L I N K _ I D >----------------------------------------------Formats a wiki-style external link]]localfunctionexternal_link_id(options)localurl_string=options.id;localext_link;localthis_wiki_code=cfg.this_wiki_code;-- Wikipedia subdomain; 'en' for en.wikipedia.orglocalwd_article;-- article title from Wikidataifoptions.encode==trueoroptions.encode==nilthenurl_string=mw.uri.encode(url_string,'PATH');endifoptions.auto_linkandis_set(options.access)thenauto_link_urls[options.auto_link]=table.concat({options.prefix,url_string,options.suffix});endext_link=mw.ustring.format('[%s%s%s %s]',options.prefix,url_string,options.suffixor"",mw.text.nowiki(options.id));ifis_set(options.access)thenext_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 lockendreturntable.concat({make_wikilink(link_label_make(options),options.label),-- redirect, Wikidata link, or locally specified link (in that order)options.separatoror'&nbsp;',ext_link});end--[[--------------------------< I N T E R N A L _ L I N K _ I D >----------------------------------------------Formats a wiki-style internal linkTODO: 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:.]]localfunctioninternal_link_id(options)localid=mw.ustring.gsub(options.id,'%d',cfg.date_names.local_digits);-- translate 'local' digits to Western 0-9returntable.concat({make_wikilink(link_label_make(options),options.label),-- wiki-link the identifier labeloptions.separatoror'&nbsp;',-- add the separatormake_wikilink(table.concat({options.prefix,id,-- translated to Western digitsoptions.suffixor''}),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= againsttoday's date. If embargo date is in the future, returns the content of |pmc-embargo-date=; otherwise, returnsan empty string because the embargo has expired or because |pmc-embargo-date= was not set in this cite.]]localfunctionis_embargoed(embargo)ifis_set(embargo)thenlocallang=mw.getContentLanguage();localgood1,embargo_date,todays_date;good1,embargo_date=pcall(lang.formatDate,lang,'U',embargo);todays_date=lang:formatDate('U');ifgood1then-- if embargo date is a good dateiftonumber(embargo_date)>=tonumber(todays_date)then-- is embargo date is in the future?returnembargo;-- still embargoedelseset_message('maint_pmc_embargo');-- embargo has expired; add main catreturn'';-- unset because embargo has expiredendendendreturn'';-- |pmc-embargo-date= not set return empty stringend--[=[-------------------------< I S _ V A L I D _ R X I V _ D A T E >------------------------------------------for biorxiv, returns true if: 2019-12-11T00:00Z <= biorxiv_date < today + 2 daysfor medrxiv, returns true if: 2020-01-01T00:00Z <= medrxiv_date < today + 2 daysThe 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}} = 1576022400The medrxiv identifier has a start date of 2020-01-01. The Unix timestamp for that date is {{#time:U|2020-01-01}} = 1577836800<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<today> is the current date at time 00:00:00 UTC plus 48 hours if today's date is 2023-01-01T00:00:00 then adding 24 hours gives 2023-01-02T00:00:00 – one second more than today adding 24 hours gives 2023-01-03T00:00:00 – one second more than tomorrowinputs: <y>, <m>, <d> – year, month, day parts of the date from the birxiv or medrxiv identifier <select> 'b' for biorxiv, 'm' for medrxiv; defaults to 'b']=]localfunctionis_valid_rxiv_date(y,m,d,select)if0==tonumber(m)and12<tonumber(m)then-- <m> must be a number 1–12returnfalse;endif0==tonumber(d)and31<tonumber(d)then-- <d> must be a number 1–31; TODO: account for month length and leap yer?returnfalse;endlocalrxiv_date=table.concat({y,m,d},'-');-- make ymd date stringlocalgood1,good2;localrxiv_ts,tomorrow_ts;-- to hold Unix timestamps representing the dateslocallang_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 tomorrowifgood1andgood2then-- lang.formatDate() returns a timestamp in the local script which tonumber() may not understandrxiv_ts=tonumber(rxiv_ts)orlang_object:parseFormattedNumber(rxiv_ts);-- convert to numbers for the comparison;tomorrow_ts=tonumber(tomorrow_ts)orlang_object:parseFormattedNumber(tomorrow_ts);elsereturnfalse;-- one or both failed to convert to Unix timestampendlocallimit_ts=((selectand('m'==select))and1577836800)or1576022400;-- choose the appropriate limit timesatmpreturn((limit_ts<=rxiv_ts)and(rxiv_ts<tomorrow_ts))-- limit_ts <= rxiv_date < tomorrow's dateend--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------ISBN-10 and ISSN validator code calculates checksum across all ISBN/ISSN 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, ISBN/ISSN must be checked for lengthand stripped of dashes, spaces and other non-ISxN characters.]]localfunctionis_valid_isxn(isxn_str,len)localtemp=0;isxn_str={isxn_str:byte(1,len)};-- make a table of byte values '0' → 0x30 .. '9' → 0x39, 'X' → 0x58len=len+1;-- adjust to be a loop counterfori,vinipairs(isxn_str)do-- loop through all of the bytes and calculate the checksumifv==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 decimalelsetemp=temp+tonumber(string.char(v))*(len-i);endendreturntemp%11==0;-- returns true if calculation result is zeroend--[[--------------------------< IS _ V A L I D _ I S X N _ 1 3 >-----------------------------------------------ISBN-13 and ISMN validator code calculates checksum across all 13 ISBN/ISMN digits including the check digit.If the number is valid, the result will be 0. Before calling this function, ISBN-13/ISMN must be checked for lengthand stripped of dashes, spaces and other non-ISxN-13 characters.]]localfunctionis_valid_isxn_13(isxn_str)localtemp=0;isxn_str={isxn_str:byte(1,13)};-- make a table of byte values '0' → 0x30 .. '9' → 0x39fori,vinipairs(isxn_str)dotemp=temp+(3-2*(i%2))*tonumber(string.char(v));-- multiply odd index digits by 1, even index digits by 3 and sum; includes check digitendreturntemp%10==0;-- sum modulo 10 is zero when ISBN-13/ISMN is correctend--[[--------------------------< N O R M A L I Z E _ L C C N >--------------------------------------------------LCCN normalization (https://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.3. If there is a hyphen in the string: a. Remove it. b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out): 1. All these characters should be digits, and there should be six or less. (not done in this function) 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 LCCN for lccn() to validate. There is no error checking (step 3.b.1) performed in this function.]]localfunctionnormalize_lccn(lccn)lccn=lccn:gsub("%s","");-- 1. strip whitespaceifnil~=string.find(lccn,'/')thenlccn=lccn:match("(.-)/");-- 2. remove forward slash and all character to the right of itendlocalprefixlocalsuffixprefix,suffix=lccn:match("(.+)%-(.+)");-- 3.a remove hyphen by splitting the string into prefix and suffixifnil~=suffixthen-- if there was a hyphensuffix=string.rep("0",6-string.len(suffix))..suffix;-- 3.b.2 left fill the suffix with 0s if suffix length less than 6lccn=prefix..suffix;-- reassemble the LCCNendreturnlccn;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: https://arxiv.org/help/arxiv_identifierformat and error check arXiv identifier. There are three valid forms of the identifier:the first form, valid only between date codes 9107 and 0703, is: arXiv:<archive>.<class>/<date code><number><version>where: <archive> is a string of alpha characters - may be hyphenated; no other punctuation <class> is a string of alpha characters - may be hyphenated; no other punctuation; not the same as |class= parameter which is not supported in this form <date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01 first digit of YY for this form can only 9 and 0 <number> is a three-digit number <version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)the second form, valid from April 2007 through December 2014 is: arXiv:<date code>.<number><version>where: <date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01 <number> is a four-digit number <version> is a 1 or more digit number preceded with a lowercase v; no spacesthe third form, valid from January 2015 is: arXiv:<date code>.<number><version>where: <date code> and <version> are as defined for 0704-1412 <number> is a five-digit number]]localfunctionarxiv(options)localid=options.id;localclass=options.Class;-- TODO: lowercase?localhandler=options.handler;localyear,month,version;localerr_msg=false;-- assume no error messagelocaltext;-- output textifid:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%d$")orid:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%dv%d+$")then-- test for the 9107-0703 format with or without versionyear,month=id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$");year=tonumber(year);month=tonumber(month);if((not(90<yearor8>year))or(1>monthor12<month))or-- if invalid year or invalid month((91==yearand7>month)or(7==yearand3<month))then-- if years ok, are starting and ending months ok?err_msg=true;-- flag for error messageendelseifid:match("^%d%d[01]%d%.%d%d%d%d$")orid:match("^%d%d[01]%d%.%d%d%d%dv%d+$")then-- test for the 0704-1412 with or without versionyear,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>monthor12<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_msg=true;-- flag for error messageendelseifid:match("^%d%d[01]%d%.%d%d%d%d%d$")orid:match("^%d%d[01]%d%.%d%d%d%d%dv%d+$")then-- test for the 1501- format with or without versionyear,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>monthor12<month))then-- is year invalid or is month invalid? (doesn't test for future years)err_msg=true;-- flag for error messageendelseerr_msg=true;-- not a recognized format; flag for error messageendiferr_msgthenoptions.coins_list_t['ARXIV']=nil;-- when error, unset so not included in COinSendlocalerr_msg_t={};iferr_msgthenset_message('err_bad_arxiv');endtext=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});ifis_set(class)thenifid:match('^%d+')thentext=table.concat({text,' [[https://arxiv.org/archive/',class,' ',class,']]'});-- external link within square brackets, not wikilinkelseset_message('err_class_ignored');endendreturntext;end--[[--------------------------< B I B C O D E >--------------------------------------------------------------------Validates (sort of) and formats a bibcode ID.Format for bibcodes is specified here: https://adsabs.harvard.edu/abs_doc/help_pages/data.html#bibcodesBut, this: 2015arXiv151206696F is apparently valid so apparently, the only things that really matter are length, 19 charactersand first four digits must be a year. This function makes these tests: length must be 19 characters characters in position 1–4 must be digits and must represent a year in the range of 1000 – next year 5 must be a letter 6–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]]localfunctionbibcode(options)localid=options.id;localaccess=options.access;localhandler=options.handler;localignore_invalid=options.accept;localerr_type;localerr_msg='';localyear;localtext=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});if19~=id:len()thenerr_type=cfg.err_msg_supl.length;elseyear=id:match("^(%d%d%d%d)[%a][%w&%.][%w&%.][%w&%.][%w.]+[%a%.]$");ifnotyearthen-- if nil then no pattern matcherr_type=cfg.err_msg_supl.value;-- so value errorelselocalnext_year=tonumber(os.date('%Y'))+1;-- get the current year as a number and add one for next yearyear=tonumber(year);-- convert year portion of bibcode to a numberif(1000>year)or(year>next_year)thenerr_type=cfg.err_msg_supl.year;-- year out of boundsendifid:find('&%.')thenerr_type=cfg.err_msg_supl.journal;-- journal abbreviation must not have '&.' (if it does it's missing a letter)endifid:match('.........%.tmp%.')then-- temporary bibcodes when positions 10–14 are '.tmp.'set_message('maint_bibcode');endendendifis_set(err_type)andnotignore_invalidthen-- if there was an error detected and accept-as-written markup not usedset_message('err_bad_bibcode',{err_type});options.coins_list_t['BIBCODE']=nil;-- when error, unset so not included in COinSendreturntext;end--[[--------------------------< B I O R X I V >-----------------------------------------------------------------Format bioRxiv ID and do simple error checking. Before 2019-12-11, biorXiv IDs were 10.1101/ followed by exactly6 digits. After 2019-12-11, biorXiv IDs retained the six-digit identifier but prefixed that with a yyyy.mm.dd. date and suffixed with an optional version identifier.The bioRxiv ID is the string of characters: https://doi.org/10.1101/078733 -> 10.1101/078733or 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.123456v2see https://www.biorxiv.org/about-biorxiv]]localfunctionbiorxiv(options)localid=options.id;localhandler=options.handler;localerr_msg=true;-- flag; assume that there will be an errorlocalpatterns={'^10%.1101/%d%d%d%d%d%d$',-- simple 6-digit identifier (before 2019-12-11)'^10%.1101/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%dv%d+$',-- y.m.d. date + 6-digit identifier + version (after 2019-12-11)'^10%.1101/(20%d%d)%.(%d%d)%.(%d%d)%.%d%d%d%d%d%d$',-- y.m.d. date + 6-digit identifier (after 2019-12-11)}for_,patterninipairs(patterns)do-- spin through the patterns looking for a matchifid:match(pattern)thenlocaly,m,d=id:match(pattern);-- found a match, attempt to get year, month and date from the identifierifmthen-- m is nil when id is the six-digit formifnotis_valid_rxiv_date(y,m,d,'b')then-- validate the encoded date; 'b' for biorxiv limitbreak;-- date fail; break out early so we don't unset the error messageendenderr_msg=nil;-- we found a match so unset the error messagebreak;-- and doneendend-- err_cat remains set here when no matchiferr_msgthenoptions.coins_list_t['BIORXIV']=nil;-- when error, unset so not included in COinSset_message('err_bad_biorxiv');-- and set the error messageendreturnexternal_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--[[--------------------------< C I T E S E E R X >------------------------------------------------------------CiteSeerX use their own notion of "doi" (not to be confused with the identifiers resolved via doi.org).The description of the structure of this identifier can be found at Help_talk:Citation_Style_1/Archive_26#CiteSeerX_id_structure]]localfunctionciteseerx(options)localid=options.id;localhandler=options.handler;localmatched;localtext=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?$");ifnotmatchedthenset_message('err_bad_citeseerx');options.coins_list_t['CITESEERX']=nil;-- when error, unset so not included in COinSendreturntext;end--[[--------------------------< D O I >------------------------------------------------------------------------Formats a DOI and checks for DOI errors.DOI names contain two parts: prefix and suffix separated by a forward slash. Prefix: directory indicator '10.' followed by a registrant code Suffix: character string of any length chosen by the registrantThis function checks a DOI name for: prefix/suffix. If the DOI name contains spaces or endashes, or, if it endswith 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 rarelyif ever used in DOI names.https://www.doi.org/doi_handbook/2_Numbering.html -- 2.2 Syntax of a DOI namehttps://www.doi.org/doi_handbook/2_Numbering.html#2.2.2 -- 2.2.2 DOI prefix]]localfunctiondoi(options)localid=options.id;localinactive=options.DoiBrokenlocalaccess=options.access;localignore_invalid=options.accept;localhandler=options.handler;localerr_flag;localfunctionis_extended_free(registrant,suffix)-- local function to check those few registrants that are mixed; identifiable by the doi suffix <incipit>ifcfg.extended_registrants_t[registrant]then-- if this registrant has known free-to-read extentionsfor_,incipitinipairs(cfg.extended_registrants_t[registrant])do-- loop through the registrant's incipitsifmw.ustring.find(suffix,'^'..incipit)then-- if foundreturntrue;endendendendlocaltext;ifis_set(inactive)thenlocalinactive_year=inactive:match("%d%d%d%d");-- try to get the year portion from the inactive datelocalinactive_month,good;ifis_set(inactive_year)thenif4<inactive:len()then-- inactive date has more than just a year (could be anything)locallang_obj=mw.getContentLanguage();-- get a language object for this wikigood,inactive_month=pcall(lang_obj.formatDate,lang_obj,'F',inactive);-- try to get the month name from the inactive dateifnotgoodtheninactive_month=nil;-- something went wrong so make sure this is unsetendendend-- otherwise, |doi-broken-date= has something but it isn't a dateifis_set(inactive_year)andis_set(inactive_month)thenset_message('maint_doi_inactive_dated',{inactive_year,inactive_month,' '});elseifis_set(inactive_year)thenset_message('maint_doi_inactive_dated',{inactive_year,'',''});elseset_message('maint_doi_inactive');endinactive=" ("..cfg.messages['inactive']..' '..inactive..')';endlocalsuffix;localregistrant,suffix=mw.ustring.match(id,'^10%.([^/]+)/([^%s–]-[^%.,])$');-- registrant and suffix set when DOI has the proper basic formlocalregistrant_err_patterns={-- these patterns are for code ranges that are not supported '^[^1-3]%d%d%d%d%.%d+$',-- 5 digits with subcode (0xxxx, 40000+); accepts: 10000–39999'^[^1-7]%d%d%d%d$',-- 5 digits without subcode (0xxxx, 60000+); accepts: 10000–69999'^[^1-9]%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'[^%d%.]',-- any character that isn't a digit or a dot}ifnotignore_invalidthenifregistrantthen-- when DOI has proper formfori,patterninipairs(registrant_err_patterns)do-- spin through error patternsifregistrant:match(pattern)then-- to validate registrant codeserr_flag=set_message('err_bad_doi');-- when found, mark this DOI as badbreak;-- and doneendendelseerr_flag=set_message('err_bad_doi');-- invalid directory or malformedendelseset_message('maint_doi_ignore');endiferr_flagthenoptions.coins_list_t['DOI']=nil;-- when error, unset so not included in COinSelseifnotaccessand(cfg.known_free_doi_registrants_t[registrant]oris_extended_free(registrant,suffix))then-- |doi-access=free not set and <registrant> is known to be freeset_message('maint_doi_unflagged_free');-- set a maint catendendtext=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_flagoris_set(inactive)orignore_invalid)and'doi'ornil-- 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})..(inactiveor'');returntext;end--[[--------------------------< H D L >------------------------------------------------------------------------Formats an HDL with minor error checking.HDL names contain two parts: prefix and suffix separated by a forward slash. Prefix: character string using any character in the UCS-2 character set except '/' Suffix: character string of any length using any character in the UCS-2 character set chosen by the registrantThis function checks a HDL name for: prefix/suffix. If the HDL name contains spaces, endashes, or, if it endswith a period or a comma, this function will emit a bad_hdl error message.HDL names are case-insensitive and can incorporate any printable Unicode characters so the test for endashes andterminal punctuation may not be technically correct but it appears, that in practice these characters are rarelyif ever used in HDLs.Query string parameters are named here: https://www.handle.net/proxy_servlet.html. query strings are not displayedbut since '?' is an allowed character in an HDL, '?' followed by one of the query parameters is the only way wehave to detect the query string so that it isn't URL-encoded with the rest of the identifier.]]localfunctionhdl(options)localid=options.id;localaccess=options.access;localhandler=options.handler;localquery_params={-- list of known query parameters from https://www.handle.net/proxy_servlet.html'noredirect','ignore_aliases','auth','cert','index','type','urlappend','locatt','action',}localhdl,suffix,param=id:match('(.-)(%?(%a+).+)$');-- look for query stringlocalfound;ifhdlthen-- when there are query strings, this is the handle identifier portionfor_,qinipairs(query_params)do-- spin through the list of query parametersifparam:match('^'..q)then-- if the query string begins with one of the parametersfound=true;-- announce a findbreak;-- and stop lookingendendendiffoundthenid=hdl;-- found so replace id with the handle portion; this will be URL-encoded, suffix will notelsesuffix='';-- make sure suffix is empty string for concatenation elseendlocaltext=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})ifnil==id:match("^[^%s–]-/[^%s–]-[^%.,]$")then-- HDL must contain a forward slash, must not contain spaces, endashes, and must not end with period or commaset_message('err_bad_hdl');options.coins_list_t['HDL']=nil;-- when error, unset so not included in COinSendreturntext;end--[[--------------------------< I S B N >----------------------------------------------------------------------Determines whether an ISBN string is valid]]localfunctionisbn(options_t)localisbn_str=options_t.id;localignore_invalid=options_t.accept;localhandler=options_t.handler;localyear=options_t.Year;-- when set, valid anchor_year; may have a disambiguator which must be removedlocalfunctionreturn_result(check,err_type)-- local function to handle the various returnslocalISBN=internal_link_id({link=handler.link,label=handler.label,redirect=handler.redirect,prefix=handler.prefix,id=isbn_str,separator=handler.separator});ifignore_invalidthen-- if ignoring ISBN errorsset_message('maint_isbn_ignore');-- add a maint category even when there is no errorelse-- here when not ignoringifnotcheckthen-- and there is an erroroptions_t.coins_list_t['ISBN']=nil;-- when error, unset so not included in COinSset_message('err_bad_isbn',err_type);-- set an error messagereturnISBN;-- return id textendendreturnISBN;-- return id textendifyearandnotignore_invalidthen-- year=year:match('%d%d%d%d?');-- strip disambiguator if presentifyearand(1965>tonumber(year))thenset_message('err_invalid_isbn_date');-- set an error messagereturninternal_link_id({link=handler.link,label=handler.label,redirect=handler.redirect,prefix=handler.prefix,id=isbn_str,separator=handler.separator});endendifnil~=isbn_str:match('[^%s-0-9X]')thenreturnreturn_result(false,cfg.err_msg_supl.char);-- fail if isbn_str contains anything but digits, hyphens, or the uppercase Xendlocalid=isbn_str:gsub('[%s-]','');-- remove hyphens and whitespacelocallen=id:len();iflen~=10andlen~=13thenreturnreturn_result(false,cfg.err_msg_supl.length);-- fail if incorrect lengthendiflen==10thenifid:match('^%d*X?$')==nilthen-- fail if isbn_str has 'X' anywhere but last positionreturnreturn_result(false,cfg.err_msg_supl.form);endifnotis_valid_isxn(id,10)then-- test isbn-10 for numerical validityreturnreturn_result(false,cfg.err_msg_supl.check);-- fail if isbn-10 is not numerically validendifid:find('^63[01]')then-- 630xxxxxxx and 631xxxxxxx are (apparently) not valid isbn group ids but are used by amazon as numeric identifiers (asin)returnreturn_result(false,cfg.err_msg_supl.group);-- fail if isbn-10 begins with 630/1endreturnreturn_result(true,cfg.err_msg_supl.check);-- pass if isbn-10 is numerically validelseifid:match('^%d+$')==nilthenreturnreturn_result(false,cfg.err_msg_supl.char);-- fail if ISBN-13 is not all digitsendifid:match('^97[89]%d*$')==nilthenreturnreturn_result(false,cfg.err_msg_supl.prefix);-- fail when ISBN-13 does not begin with 978 or 979endifid:match('^9790')thenreturnreturn_result(false,cfg.err_msg_supl.group);-- group identifier '0' is reserved to ISMNendreturnreturn_result(is_valid_isxn_13(id),cfg.err_msg_supl.check);endend--[[--------------------------< A S I N >----------------------------------------------------------------------Formats a link to Amazon. Do simple error checking: ASIN must be mix of 10 numeric or uppercase alphacharacters. If a mix, first character must be uppercase alpha; if all numeric, ASINs must be 10-digitISBN. If 10-digit ISBN, add a maintenance category so a bot or AWB script can replace |asin= with |isbn=.Error message if not 10 characters, if not ISBN-10, if mixed and first character is a digit.|asin=630....... and |asin=631....... are (apparently) not a legitimate ISBN though it checksums as one; thesedo not cause this function to emit the maint_asin messageThis function is positioned here because it calls isbn()]]localfunctionasin(options)localid=options.id;localdomain=options.ASINTLD;localerr_flag;ifnotid:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$")thenerr_flag=set_message('err_bad_asin');-- ASIN is not a mix of 10 uppercase alpha and numeric characterselseifid:match("^%d%d%d%d%d%d%d%d%d[%dX]$")then-- if 10-digit numeric (or 9 digits with terminal X)ifis_valid_isxn(id,10)then-- see if ASIN value is or validates as ISBN-10ifnotid:find('^63[01]')then-- 630xxxxxxx and 631xxxxxxx are (apparently) not a valid isbn prefixes but are used by amazon as a numeric identifiererr_flag=set_message('err_bad_asin');-- ASIN has ISBN-10 form but begins with something other than 630/1 so probably an isbn endelseifnotis_set(err_flag)thenerr_flag=set_message('err_bad_asin');-- ASIN is not ISBN-10endelseifnotid:match("^%u[%d%u]+$")thenerr_flag=set_message('err_bad_asin');-- asin doesn't begin with uppercase alphaendendif(notis_set(domain))orin_array(domain,{'us'})then-- default: United Statesdomain="com";elseifin_array(domain,{'jp','uk'})then-- Japan, United Kingdomdomain="co."..domain;elseifin_array(domain,{'z.cn'})then-- Chinadomain="cn";elseifin_array(domain,{'au','br','mx','sg','tr'})then-- Australia, Brazil, Mexico, Singapore, Turkeydomain="com."..domain;elseifnotin_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 valueendlocalhandler=options.handler;ifnotis_set(err_flag)thenoptions.coins_list_t['ASIN']=handler.prefix..domain.."/dp/"..id;-- asin for coinselseoptions.coins_list_t['ASIN']=nil;-- when error, unset so not included in COinSendreturnexternal_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 ISBN-13, ISMN is 13 digits beginning 979-0-... and uses thesame check digit calculations. See https://www.ismn-international.org/download/Web_ISMN_Users_Manual_2008-6.pdfsection 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:)]]localfunctionismn(options)localid=options.id;localhandler=options.handler;localtext;localvalid_ismn=true;localid_copy;id_copy=id;-- save a copy because this testing is destructiveid=id:gsub('[%s-]','');-- remove hyphens and white spaceif13~=id:len()orid:match("^9790%d*$")==nilthen-- ISMN must be 13 digits and begin with 9790valid_ismn=false;elsevalid_ismn=is_valid_isxn_13(id);-- validate ISMNend-- 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_copy, separator = handler.separator, encode = handler.encode})text=table.concat(-- because no place to link to yet{make_wikilink(link_label_make(handler),handler.label),handler.separator,id_copy});iffalse==valid_ismnthenoptions.coins_list_t['ISMN']=nil;-- when error, unset so not included in COinS; not really necessary here because ismn not made part of COinSset_message('err_bad_ismn');-- create an error message if the ISMN is invalidendreturntext;end--[[--------------------------< I S S N >----------------------------------------------------------------------Validate and format an ISSN. This code fixes the case where an editor has included an ISSN in the citation buthas separated the two groups of four digits with a space. When that condition occurred, the resulting link lookedlike this: |issn=0819 4327 gives: [https://www.worldcat.org/issn/0819 4327 0819 4327] -- can't have spaces in an external linkThis code now prevents that by inserting a hyphen at the ISSN midpoint. It also validates the ISSN for lengthand makes sure that the checkdigit agrees with the calculated value. Incorrect length (8 digits), charactersother than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check ISSN error message. TheISSN is always displayed with a hyphen, even if the ISSN was given as a single group of 8 digits.]]localfunctionissn(options)localid=options.id;localhandler=options.handler;localignore_invalid=options.accept;localissn_copy=id;-- save a copy of unadulterated ISSN; use this version for display if ISSN does not validatelocaltext;localvalid_issn=true;id=id:gsub('[%s-]','');-- remove hyphens and whitespaceif8~=id:len()ornil==id:match("^%d*X?$")then-- validate the ISSN: 8 digits long, containing only 0-9 or X in the last positionvalid_issn=false;-- wrong length or improper characterelsevalid_issn=is_valid_isxn(id,8);-- validate ISSNendiftrue==valid_issnthenid=string.sub(id,1,4).."-"..string.sub(id,5);-- if valid, display correctly formatted versionelseid=issn_copy;-- if not valid, show the invalid ISSN with error messageendtext=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})ifignore_invalidthenset_message('maint_issn_ignore');elseiffalse==valid_issnthenoptions.coins_list_t['ISSN']=nil;-- when error, unset so not included in COinSset_message('err_bad_issn',(options.hkey=='EISSN')and'e'or'');-- create an error message if the ISSN is invalidendendreturntext;end--[[--------------------------< J F M >-----------------------------------------------------------------------A numerical identifier in the form nn.nnnn.nn]]localfunctionjfm(options)localid=options.id;localhandler=options.handler;localid_num;id_num=id:match('^[Jj][Ff][Mm](.*)$');-- identifier with jfm prefix; extract identifierifis_set(id_num)thenset_message('maint_jfm_format');else-- plain number without JFM prefixid_num=id;-- if here id does not have prefixendifid_numandid_num:match('^%d%d%.%d%d%d%d%.%d%d$')thenid=id_num;-- jfm matches patternelseset_message('err_bad_jfm');-- set an error messageoptions.coins_list_t['JFM']=nil;-- when error, unset so not included in COinSendreturnexternal_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--[[--------------------------< J S T O R >--------------------------------------------------------------------Format a JSTOR with some error checking]]localfunctionjstor(options)localid=options.id;localaccess=options.access;localhandler=options.handler;ifid:find('[Jj][Ss][Tt][Oo][Rr]')orid:find('^https?://')orid:find('%s')thenset_message('err_bad_jstor');-- set an error messageoptions.coins_list_t['JSTOR']=nil;-- when error, unset so not included in COinSendreturnexternal_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--[[--------------------------< L C C N >----------------------------------------------------------------------Format LCCN link and do simple error checking. LCCN is a character string 8-12 characters long. The length ofthe 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.htmllength = 8 then all digitslength = 9 then lccn[1] is lowercase alphalength = 10 then lccn[1] and lccn[2] are both lowercase alpha or both digitslength = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lowercase alpha or both digitslength = 12 then lccn[1] and lccn[2] are both lowercase alpha]]localfunctionlccn(options)locallccn=options.id;localhandler=options.handler;localerr_flag;-- presume that LCCN is validlocalid=lccn;-- local copy of the LCCNid=normalize_lccn(id);-- get canonical form (no whitespace, hyphens, forward slashes)locallen=id:len();-- get the length of the LCCNif8==lenthenifid:match("[^%d]")then-- if LCCN has anything but digits (nil if only digits)err_flag=set_message('err_bad_lccn');-- set an error messageendelseif9==lenthen-- LCCN should be addddddddifnil==id:match("%l%d%d%d%d%d%d%d%d")then-- does it match our pattern?err_flag=set_message('err_bad_lccn');-- set an error messageendelseif10==lenthen-- LCCN should be aadddddddd or ddddddddddifid:match("[^%d]")then-- if LCCN has anything but digits (nil if only digits) ...ifnil==id:match("^%l%l%d%d%d%d%d%d%d%d")then-- ... see if it matches our patternerr_flag=set_message('err_bad_lccn');-- no match, set an error messageendendelseif11==lenthen-- LCCN should be aaadddddddd or addddddddddifnot(id:match("^%l%l%l%d%d%d%d%d%d%d%d")orid:match("^%l%d%d%d%d%d%d%d%d%d%d"))then-- see if it matches one of our patternserr_flag=set_message('err_bad_lccn');-- no match, set an error messageendelseif12==lenthen-- LCCN should be aaddddddddddifnotid:match("^%l%l%d%d%d%d%d%d%d%d%d%d")then-- see if it matches our patternerr_flag=set_message('err_bad_lccn');-- no match, set an error messageendelseerr_flag=set_message('err_bad_lccn');-- wrong length, set an error messageendifnotis_set(err_flag)andnil~=lccn:find('%s')thenerr_flag=set_message('err_bad_lccn');-- lccn contains a space, set an error messageendifis_set(err_flag)thenoptions.coins_list_t['LCCN']=nil;-- when error, unset so not included in COinSendreturnexternal_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});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 ayyyy.mm.dd. date and suffixed with an optional version identifier. Ealiest date accepted is 2020.01.01The 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]]localfunctionmedrxiv(options)localid=options.id;localhandler=options.handler;localerr_msg_flag=true;-- flag; assume that there will be an errorlocalpatterns={'%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)}for_,patterninipairs(patterns)do-- spin through the patterns looking for a matchifid:match(pattern)thenlocaly,m,d=id:match(pattern);-- found a match, attempt to get year, month and date from the identifierifmthen-- m is nil when id is the 8-digit formifnotis_valid_rxiv_date(y,m,d,'b')then-- validate the encoded date; 'b' for medrxiv limitbreak;-- date fail; break out early so we don't unset the error messageendenderr_msg_flag=nil;-- we found a match so unset the error messagebreak;-- and doneendend-- <err_msg_flag> remains set here when no matchiferr_msg_flagthenoptions.coins_list_t['MEDRXIV']=nil;-- when error, unset so not included in COinSset_message('err_bad_medrxiv');-- and set the error messageendreturnexternal_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--[[--------------------------< M R >--------------------------------------------------------------------------A seven digit number; if not seven digits, zero-fill leading digits to make seven digits.]]localfunctionmr(options)localid=options.id;localhandler=options.handler;localid_num;localid_len;id_num=id:match('^[Mm][Rr](%d+)$');-- identifier with mr prefixifis_set(id_num)thenset_message('maint_mr_format');-- add maint catelse-- plain number without mr prefixid_num=id:match('^%d+$');-- if here id is all digitsendid_len=id_numandid_num:len()or0;if(7>=id_len)and(0~=id_len)thenid=string.rep('0',7-id_len)..id_num;-- zero-fill leading digitselseset_message('err_bad_mr');-- set an error messageoptions.coins_list_t['MR']=nil;-- when error, unset so not included in COinSendreturnexternal_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--[[--------------------------< O C L C >----------------------------------------------------------------------Validate and format an OCLC ID. 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]]localfunctionoclc(options)localid=options.id;localhandler=options.handler;localnumber;ifid: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 numberelseifid:match('^ocn%d%d%d%d%d%d%d%d%d$')then-- ocn prefix and 9 digits; 001 field (12 characters)number=id:match('ocn(%d+)');-- get the numberelseifid:match('^on%d%d%d%d%d%d%d%d%d%d+$')then-- on prefix and 10 or more digits; 001 field (12 characters)number=id:match('^on(%d%d%d%d%d%d%d%d%d%d+)$');-- get the numberelseifid:match('^%(OCoLC%)[1-9]%d*$')then-- (OCoLC) prefix and variable number digits; no leading zeros; 035 fieldnumber=id:match('%(OCoLC%)([1-9]%d*)');-- get the numberif9<number:len()thennumber=nil;-- constrain to 1 to 9 digits; change this when OCLC issues 10-digit numbersendelseifid:match('^%d+$')then-- no prefixnumber=id;-- get the numberiftonumber(id)>handler.id_limitthennumber=nil;-- unset when id value exceeds the limitendendifnumberthen-- proper formatid=number;-- exclude prefix, if any, from external linkelseset_message('err_bad_oclc')-- add an error message if the id is malformedoptions.coins_list_t['OCLC']=nil;-- when error, unset so not included in COinSendreturnexternal_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--[[--------------------------< O P E N L I B R A R Y >--------------------------------------------------------Formats an OpenLibrary link, and checks for associated errors.]]localfunctionopenlibrary(options)localid=options.id;localaccess=options.access;localhandler=options.handler;localident,code=id:gsub('^OL',''):match("^(%d+([AMW]))$");-- strip optional OL prefix followed immediately by digits followed by 'A', 'M', or 'W';localerr_flag;localprefix={-- 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};ifnotidentthencode='X';-- no code or id completely invalidident=id;-- copy id to ident so that we display the flawed identifiererr_flag=set_message('err_bad_ol');endifnotis_set(err_flag)thenoptions.coins_list_t['OL']=handler.prefix..prefix[code]..ident;-- experiment for ol coinselseoptions.coins_list_t['OL']=nil;-- when error, unset so not included in COinSendreturnexternal_link_id({link=handler.link,label=handler.label,q=handler.q,redirect=handler.redirect,prefix=handler.prefix..prefix[code],id=ident,separator=handler.separator,encode=handler.encode,access=access});end--[[--------------------------< O S T I >----------------------------------------------------------------------Format OSTI and do simple error checking. OSTIs are sequential numbers beginning at 1 and counting up. Thiscode 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]]localfunctionosti(options)localid=options.id;localaccess=options.access;localhandler=options.handler;ifid:match("[^%d]")then-- if OSTI has anything but digitsset_message('err_bad_osti');-- set an error messageoptions.coins_list_t['OSTI']=nil;-- when error, unset so not included in COinSelse-- OSTI is only digitslocalid_num=tonumber(id);-- convert id to a number for range testingif1018>id_numorhandler.id_limit<id_numthen-- if OSTI is outside test limit boundariesset_message('err_bad_osti');-- set an error messageoptions.coins_list_t['OSTI']=nil;-- when error, unset so not included in COinSendendreturnexternal_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--[[--------------------------< P M C >------------------------------------------------------------------------Format a PMC, do simple error checking, and check for embargoed articles.The embargo parameter takes a date for a value. If the embargo date is in the future the PMC identifier will notbe linked to the article. If the embargo date is today or in the past, or if it is empty or omitted, then thePMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.PMC embargo date testing is done in function is_embargoed () which is called earlier because when the citationhas |pmc=<value> but does not have a |url= then |title= is linked with the PMC link. Function is_embargoed ()returns the embargo date if the PMC article is still embargoed, otherwise it returns an empty string.PMCs are sequential numbers beginning at 1 and counting up. This code checks the PMC to see that it contains only digits and is lessthan test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.]]localfunctionpmc(options)localid=options.id;localembargo=options.Embargo;-- TODO: lowercase?localhandler=options.handler;localerr_flag;localid_num;localtext;id_num=id:match('^[Pp][Mm][Cc](%d+)$');-- identifier with PMC prefixifis_set(id_num)thenset_message('maint_pmc_format');else-- plain number without PMC prefixid_num=id:match('^%d+$');-- if here id is all digitsendifis_set(id_num)then-- id_num has a value so test itid_num=tonumber(id_num);-- convert id_num to a number for range testingif1>id_numorhandler.id_limit<id_numthen-- if PMC is outside test limit boundarieserr_flag=set_message('err_bad_pmc');-- set an error messageelseid=tostring(id_num);-- make sure id is a stringendelse-- when id format incorrecterr_flag=set_message('err_bad_pmc');-- set an error messageendifis_set(embargo)andis_set(is_embargoed(embargo))then-- is PMC is still embargoed?text=table.concat(-- still embargoed so no external link{make_wikilink(link_label_make(handler),handler.label),handler.separator,id,});elsetext=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 articleprefix=handler.prefix,id=id,separator=handler.separator,encode=handler.encode,access=handler.access,auto_link=noterr_flagand'pmc'ornil-- do not auto-link when PMC has error});endiferr_flagthenoptions.coins_list_t['PMC']=nil;-- when error, unset so not included in COinSendreturntext;end--[[--------------------------< P M I D >----------------------------------------------------------------------Format PMID and do simple error checking. PMIDs are sequential numbers beginning at 1 and counting up. Thiscode checks the PMID to see that it contains only digits and is less than test_limit; the value in local variabletest_limit will need to be updated periodically as more PMIDs are issued.]]localfunctionpmid(options)localid=options.id;localhandler=options.handler;ifid:match("[^%d]")then-- if PMID has anything but digitsset_message('err_bad_pmid');-- set an error messageoptions.coins_list_t['PMID']=nil;-- when error, unset so not included in COinSelse-- PMID is only digitslocalid_num=tonumber(id);-- convert id to a number for range testingif1>id_numorhandler.id_limit<id_numthen-- if PMID is outside test limit boundariesset_message('err_bad_pmid');-- set an error messageoptions.coins_list_t['PMID']=nil;-- when error, unset so not included in COinSendendreturnexternal_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. Thiscode 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/]]localfunctionrfc(options)localid=options.id;localhandler=options.handler;ifid:match("[^%d]")then-- if RFC has anything but digitsset_message('err_bad_rfc');-- set an error messageoptions.coins_list_t['RFC']=nil;-- when error, unset so not included in COinSelse-- RFC is only digitslocalid_num=tonumber(id);-- convert id to a number for range testingif1>id_numorhandler.id_limit<id_numthen-- if RFC is outside test limit boundariesset_message('err_bad_rfc');-- set an error messageoptions.coins_list_t['RFC']=nil;-- when error, unset so not included in COinSendendreturnexternal_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 >--------------------------------------------------------------------Format an S2CID, do simple error checkingS2CIDs are sequential numbers beginning at 1 and counting up. This code checks the S2CID to see that it is onlydigits and is less than test_limit; the value in local variable test_limit will need to be updated periodicallyas more S2CIDs are issued.]]localfunctions2cid(options)localid=options.id;localaccess=options.access;localhandler=options.handler;localid_num;localtext;id_num=id:match('^[1-9]%d*$');-- id must be all digits; must not begin with 0; no open access flagifis_set(id_num)then-- id_num has a value so test itid_num=tonumber(id_num);-- convert id_num to a number for range testingifhandler.id_limit<id_numthen-- if S2CID is outside test limit boundariesset_message('err_bad_s2cid');-- set an error messageoptions.coins_list_t['S2CID']=nil;-- when error, unset so not included in COinSendelse-- when id format incorrectset_message('err_bad_s2cid');-- set an error messageoptions.coins_list_t['S2CID']=nil;-- when error, unset so not included in COinSendtext=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});returntext;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 digitssbn 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:)]]localfunctionsbn(options)localid=options.id;localignore_invalid=options.accept;localhandler=options.handler;localfunctionreturn_result(check,err_type)-- local function to handle the various returnslocalSBN=internal_link_id({link=handler.link,label=handler.label,redirect=handler.redirect,prefix=handler.prefix,id=id,separator=handler.separator});ifnotignore_invalidthen-- if not ignoring SBN errorsifnotcheckthenoptions.coins_list_t['SBN']=nil;-- when error, unset so not included in COinS; not really necessary here because sbn not made part of COinSset_message('err_bad_sbn',{err_type});-- display an error messagereturnSBN;endelseset_message('maint_isbn_ignore');-- add a maint category even when there is no error (ToDo: Possibly switch to separate message for SBNs only)endreturnSBN;endifid:match('[^%s-0-9X]')thenreturnreturn_result(false,cfg.err_msg_supl.char);-- fail if SBN contains anything but digits, hyphens, or the uppercase Xendlocalident=id:gsub('[%s-]','');-- remove hyphens and whitespace; they interfere with the rest of the testsif9~=ident:len()thenreturnreturn_result(false,cfg.err_msg_supl.length);-- fail if incorrect lengthendifident:match('^%d*X?$')==nilthenreturnreturn_result(false,cfg.err_msg_supl.form);-- fail if SBN has 'X' anywhere but last positionendreturnreturn_result(is_valid_isxn('0'..ident,10),cfg.err_msg_supl.check);end--[[--------------------------< S S R N >----------------------------------------------------------------------Format an SSRN, do simple error checkingSSRNs are sequential numbers beginning at 100? and counting up. This code checks the SSRN to see that it isonly digits and is greater than 99 and less than test_limit; the value in local variable test_limit will needto be updated periodically as more SSRNs are issued.]]localfunctionssrn(options)localid=options.id;localhandler=options.handler;localid_num;localtext;id_num=id:match('^%d+$');-- id must be all digitsifis_set(id_num)then-- id_num has a value so test itid_num=tonumber(id_num);-- convert id_num to a number for range testingif100>id_numorhandler.id_limit<id_numthen-- if SSRN is outside test limit boundariesset_message('err_bad_ssrn');-- set an error messageoptions.coins_list_t['SSRN']=nil;-- when error, unset so not included in COinSendelse-- when id format incorrectset_message('err_bad_ssrn');-- set an error messageoptions.coins_list_t['SSRN']=nil;-- when error, unset so not included in COinSendtext=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=options.access});returntext;end--[[--------------------------< U S E N E T _ I D >------------------------------------------------------------Validate and format a usenet message id. Simple error checking, looks for 'id-left@id-right' not enclosed in'<' and/or '>' angle brackets.]]localfunctionusenet_id(options)localid=options.id;localhandler=options.handler;localtext=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})ifnotid:match('^.+@.+$')ornotid:match('^[^<].*[^>]$')then-- doesn't have '@' or has one or first or last character is '< or '>'set_message('err_bad_usenet_id')-- add an error message if the message id is invalidoptions.coins_list_t['USENETID']=nil;-- when error, unset so not included in COinSendreturntext;end--[[--------------------------< Z B L >-----------------------------------------------------------------------A numerical identifier in the form nnnn.nnnnn - leading zeros in the first quartet optionalformat described here: http://emis.mi.sanu.ac.rs/ZMATH/zmath/en/help/search/temporary format is apparently eight digits. Anything else is an error]]localfunctionzbl(options)localid=options.id;localhandler=options.handler;ifid:match('^%d%d%d%d%d%d%d%d$')then-- is this identifier using temporary format?set_message('maint_zbl');-- yes, add maint catelseifnotid:match('^%d?%d?%d?%d%.%d%d%d%d%d$')then-- not temporary, is it normal format?set_message('err_bad_zbl');-- no, set an error messageoptions.coins_list_t['ZBL']=nil;-- when error, unset so not included in COinSendreturnexternal_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--============================<< I N T E R F A C E F U N C T I O N S >>==========================================--[[--------------------------< E X T R A C T _ I D S >------------------------------------------------------------Populates ID table from arguments using configuration settings. Loops through cfg.id_handlers and searches args forany of the parameters listed in each cfg.id_handlers['...'].parameters. If found, adds the parameter and value tothe identifier list. Emits redundant error message if more than one alias exists in args]]localfunctionextract_ids(args)localid_list={};-- list of identifiers found in argsfork,vinpairs(cfg.id_handlers)do-- k is uppercase identifier name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a tablev=select_one(args,v.parameters,'err_redundant_parameters');-- v.parameters is a table of aliases for k; here we pick one from args if presentifis_set(v)thenid_list[k]=v;end-- if found in args, add identifier to our listendreturnid_list;end--[[--------------------------< 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 accesslevel (e.g. arxiv) do not use this 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) keywordaccess-level values must match the case used in cfg.keywords_lists['id-access'] (lowercase unless there is some special reason for something else)]]localfunctionextract_id_access_levels(args,id_list)localid_accesses_list={};fork,vinpairs(cfg.id_handlers)dolocalaccess_param=v.custom_access;-- name of identifier's access-level parameterifis_set(access_param)thenlocalaccess_level=args[access_param];-- get the assigned value if there is oneifis_set(access_level)thenifnotin_array(access_level,cfg.keywords_lists['id-access'])then-- exact match requiredset_message('err_invalid_param_val',{access_param,access_level});access_level=nil;-- invalid so unsetendifnotis_set(id_list[k])then-- identifier access-level must have a matching identifierset_message('err_param_access_requires_param',{k:lower()});-- parameter name is uppercase in cfg.id_handlers (k); lowercase for error messageendid_accesses_list[k]=cfg.keywords_xlate[access_level];-- get translated keywordendendendreturnid_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]]localfunctionbuild_id_list(ID_list_coins_t,options_t,access_levels_t)localID_list_t={};localaccept;localfunc_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,['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,}forhkey,vinpairs(ID_list_coins_t)dov,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 booleanoptions_t.hkey=hkey;-- ~/Configuration handler keyoptions_t.id=v;-- add that identifier value to the options tableoptions_t.accept=accept;-- add the accept boolean flagoptions_t.access=access_levels_t[hkey];-- add the access level for those that have an |<identifier-access= parameteroptions_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 metadataoptions_t.coins_list_t[hkey]=v;-- id value without accept-as-written markup for metadataifoptions_t.handler.accessandnotin_array(options_t.handler.access,cfg.keywords_lists['id-access'])thenerror(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 keywordsendiffunc_map[hkey]thenlocalid_text=func_map[hkey](options_t);-- call the function to get identifier text and any error messagetable.insert(ID_list_t,{hkey,id_text});-- add identifier text to the output sequence tableelseerror(cfg.messages['unknown_ID_key']..hkey);-- here when func_map doesn't have a function for hkeyendendlocalfunctioncomp(a,b)-- used by following table.sort()returna[1]:lower()<b[1]:lower();-- sort by hkeyendtable.sort(ID_list_t,comp);-- sequence table of tables sort fork,vinipairs(ID_list_t)do-- convert sequence table of tables to simple sequence table of stringsID_list_t[k]=v[2];-- v[2] is the identifier rendering from the call to the various functions in func_map{}endreturnID_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 messagereturns nothing; on error emits an appropriate error message]]localfunctionoptions_check(ID_list_coins_t,ID_support_t)for_,vinipairs(ID_support_t)doifis_set(v[1])andnotID_list_coins_t[v[2]]then-- when support parameter has a value but matching identifier parameter is missing or emptyset_message(v[3],(v[4]));-- emit the appropriate error messageendendend--[[--------------------------< 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 theCOinS metadata, and a sequence table of the rendered identifier strings that will be included in the renderedcitation.]]localfunctionidentifier_lists_get(args_t,options_t,ID_support_t)localID_list_coins_t=extract_ids(args_t);-- get a table of identifiers and their values for use locally and for use in COinSoptions_check(ID_list_coins_t,ID_support_t);-- ID support parameters must have matching identifier parameters localID_access_levels_t=extract_id_access_levels(args_t,ID_list_coins_t);-- get a table of identifier access levelslocalID_list_t=build_id_list(ID_list_coins_t,options_t,ID_access_levels_t);-- get a sequence table of rendered identifier stringsreturnID_list_t,ID_list_coins_t;-- return the tablesend--[[--------------------------< S E T _ S E L E C T E D _ M O D U L E S >--------------------------------------Sets local cfg table and imported functions table to same (live or sandbox) as that used by the other modules.]]localfunctionset_selected_modules(cfg_table_ptr,utilities_page_ptr)cfg=cfg_table_ptr;has_accept_as_written=utilities_page_ptr.has_accept_as_written;-- import functions from select Module:Citation/CS1/Utilities moduleis_set=utilities_page_ptr.is_set;in_array=utilities_page_ptr.in_array;set_message=utilities_page_ptr.set_message;select_one=utilities_page_ptr.select_one;substitute=utilities_page_ptr.substitute;make_wikilink=utilities_page_ptr.make_wikilink;z=utilities_page_ptr.z;-- table of tables in Module:Citation/CS1/Utilitiesend--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------]]return{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_levelsis_embargoed=is_embargoed;set_selected_modules=set_selected_modules;}
Retrieved from "https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Identifiers&oldid=1285235979"
close