Module:Check isxn - Revision history

ZooWiki: 1 revision imported

2023-11-28T20:04:14Z

1 revision imported

← Older revision	Revision as of 20:04, 28 November 2023
(No difference)

Kinsey Reports>Trappist the monk: sync from sandbox;

2022-11-03T23:27:58Z

sync from sandbox;

← Older revision		Revision as of 23:27, 3 November 2022
Line 1:		Line 1:
	-- This ~~template~~ is ~~a copy of~~ the ISXN validation code ~~from [[~~Module:Citation/CS1]]		--[[
	~~-- which~~ allows ~~for~~ validating ISBN, ISMN, and ISSN without invoking a citation template
			This code is derived from the ISXN validation code at Module:Citation/CS1. It allows validating ISBN,
			ISMN, and ISSN without invoking a citation template.

			]]

	local p = {}		local p = {}


			--[[--------------------------< E R R _ M S G _ S U P L _ T >--------------------------------------------------

			error message supplements for check_isbn(); adapted from a similarly named table at Module:Citation/CS1/Configuration

			]]

			local err_msg_supl_t = {
			['char'] = 'invalid character',
			['check'] = 'checksum',
			['form'] = 'invalid form',
			['group'] = 'invalid group id',
			['length'] = 'length',
			['prefix'] = 'invalid prefix',
			}


	--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------		--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------
Line 44:		Line 65:
	return temp % 10 == 0; -- sum modulo 10 is zero when isbn-13/ismn is correct		return temp % 10 == 0; -- sum modulo 10 is zero when isbn-13/ismn is correct
	end		end


	--[[--------------------------< C H E C K _ I S B N >------------------------------------------------------------		--[[--------------------------< C H E C K _ I S B N >------------------------------------------------------------

	Determines whether an ISBN string is valid		Determines whether an ISBN string is valid. Implements an ISBN validity check for {{ISBN}}, {{ISBNT}}, {{SBN}}, and
			{{Format ISBN}}.

	]]		]]

	local function check_isbn( isbn_str, ~~error_string~~ )		local function check_isbn (isbn_str, frame)
	if nil ~= isbn_str:match("[^%s-0-9X]") then -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X		local function return_result (check, err_type) -- local function to render the various error returns
	~~return error_string;~~		if not check then -- <check> false when there is an error
			local template = ((frame.args.template_name and '' ~= frame.args.template_name) and frame.args.template_name) or nil; -- get template name
			if not template then
			return '<span class="error" style="font-size:100%"> calling template requires template_name parameter</span>';
			end

			local out_t = {'<span class="error" style="font-size:100%">'}; -- open the error message span
			table.insert (out_t, ' Parameter error in {{[[Template:'); -- open 'template' markup; open wikilink with Template namespace
			table.insert (out_t, template); -- template name wikilink
			table.insert (out_t, '\|'); -- its pipe
			table.insert (out_t, template); -- wikilink label
			table.insert (out_t, ']]}}: '); -- close wikilink; close 'template' markup
			table.insert (out_t, err_type); -- type of isbn error
			table.insert (out_t, '</span>') -- close the error message span
			if 0 == mw.title.getCurrentTitle().namespace then -- categorize only when this template is used in mainspace
			local category = table.concat ({'[[Category:Pages with ISBN errors]]'});
			table.insert (out_t, category);
			end
			return table.concat (out_t); -- make a big string and done
			end
			return ''; -- no error, return an empty string
			end

			if nil ~= isbn_str:match ('[^%s-0-9X]') then
			return return_result (false, err_msg_supl_t.char); -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
	end		end
	~~isbn_str~~ = isbn_str:gsub( "-~~", "" ):gsub( " "~~, "" ); -- remove hyphens and ~~spaces~~
	local len = ~~isbn_str~~:len();		local id = isbn_str:gsub ('[%s-]', ''); -- remove hyphens and whitespace

			local len = id:len();

	if len ~= 10 and len ~= 13 then		if len ~= 10 and len ~= 13 then
	return ~~error_string~~;		return return_result (false, err_msg_supl_t.length); -- fail if incorrect length
	end		end

	if len == 10 then		if len == 10 then
	if ~~isbn_str~~:match( "^%d*X?$" ) == nil then		if id:match ('^%d*X?$') == nil then -- fail if isbn_str has 'X' anywhere but last position
	return ~~error_string~~;		return return_result (false, err_msg_supl_t.form);
	end		end
	return is_valid_isxn(~~isbn_str~~, 10) ~~and '' or error_string~~;		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, err_msg_supl_t.group); -- fail if isbn-10 begins with 630/1
			end
			return return_result (is_valid_isxn (id, 10), err_msg_supl_t.check); -- pass if isbn-10 is numerically valid (checksum)
	else		else
	~~local temp~~ = 0;		if id:match ('^%d+$') == nil then
	if ~~isbn_str~~:match( "^97[89]%d*$" ) == nil then -- ~~isbn13 begins~~ with 978 or 979~~; ismn begins with 979~~		return return_result (false, err_msg_supl_t.char); -- fail if ISBN-13 is not all digits
	return ~~error_string~~;		end
			if id:match ('^97[89]%d*$') == nil then
			return return_result (false, err_msg_supl_t.prefix); -- fail when ISBN-13 does not begin with 978 or 979
			end
			if id:match ('^9790') then
			return return_result (false, err_msg_supl_t.group); -- group identifier '0' is reserved to ISMN
	end		end
	return is_valid_isxn_13 (~~isbn_str~~) ~~and '' or error_string~~;		return return_result (is_valid_isxn_13 (id), err_msg_supl_t.check); -- pass if isbn-10 is numerically valid (checksum)
	end		end
	end		end


	--[[--------------------------< C H E C K _ I S M N >------------------------------------------------------------		--[[--------------------------< C H E C K _ I S M N >------------------------------------------------------------
Line 98:		Line 156:
	return valid_ismn and '' or error_string		return valid_ismn and '' or error_string
	end		end


	--[[--------------------------< I S S N >----------------------------------------------------------------------		--[[--------------------------< I S S N >----------------------------------------------------------------------
Line 136:		Line 195:

	function p.check_isbn(frame)		function p.check_isbn(frame)
	return check_isbn(frame.args[1] or frame:getParent().args[1], frame~~.args['error'] or frame:getParent().args['error'] or 'error'~~)		return check_isbn(frame.args[1] or frame:getParent().args[1], frame)
	end		end

Ookami: 12 revisions imported

2020-09-02T00:01:14Z

12 revisions imported

← Older revision	Revision as of 00:01, 2 September 2020
(No difference)

Adam52: 1 revision imported

2020-08-22T20:23:48Z

1 revision imported

← Older revision	Revision as of 20:23, 22 August 2020
(No difference)

wk>The Anome: Changed protection level for "Module:Check isxn": High-risk Lua module ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite))

2017-05-31T10:38:54Z

Changed protection level for "Module:Check isxn": High-risk Lua module ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite))

← Older revision	Revision as of 10:38, 31 May 2017
(No difference)

meta>Frietjes: Undid revision 712696584 by Frietjes (talk)

2016-03-30T16:27:01Z

Undid revision 712696584 by Frietjes (talk)

@@ Line 145: / Line 145: @@
 function p.check_issn(frame)
 	return check_issn(frame.args[1] or frame:getParent().args[1], frame.args['error'] or frame:getParent().args['error'] or 'error')
 end
 return p

meta>Frietjes: add entry points for checking lists

2016-03-30T16:10:40Z

add entry points for checking lists

@@ Line 145: / Line 145: @@
 function p.check_issn(frame)
 	return check_issn(frame.args[1] or frame:getParent().args[1], frame.args['error'] or frame:getParent().args['error'] or 'error')
 end
 return p

meta>Frietjes: fix return value

2016-03-11T16:04:31Z

fix return value

← Older revision		Revision as of 16:04, 11 March 2016
Line 52:		Line 52:

	local function check_isbn( isbn_str, error_string )		local function check_isbn( isbn_str, error_string )
	if nil ~= isbn_str:match("[^%s-0-9X]") then ~~return false; end~~ -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X		if nil ~= isbn_str:match("[^%s-0-9X]") then -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
			return error_string;
			end
	isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces		isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
	local len = isbn_str:len();		local len = isbn_str:len();
Line 61:		Line 63:

	if len == 10 then		if len == 10 then
	if isbn_str:match( "^%d*X?$" ) == nil then return ~~false~~; end		if isbn_str:match( "^%d*X?$" ) == nil then
			return error_string;
			end
	return is_valid_isxn(isbn_str, 10) and '' or error_string;		return is_valid_isxn(isbn_str, 10) and '' or error_string;
	else		else
	local temp = 0;		local temp = 0;
	if isbn_str:match( "^97[89]%d*$" ) == nil then ~~return false; end~~ -- isbn13 begins with 978 or 979; ismn begins with 979		if isbn_str:match( "^97[89]%d*$" ) == nil then -- isbn13 begins with 978 or 979; ismn begins with 979
			return error_string;
			end
	return is_valid_isxn_13 (isbn_str) and '' or error_string;		return is_valid_isxn_13 (isbn_str) and '' or error_string;
	end		end

meta>Trappist the monk: X;

2016-01-05T03:23:29Z

← Older revision		Revision as of 03:23, 5 January 2016
Line 111:		Line 111:
	local valid_issn = true;		local valid_issn = true;

	if not id:match ('^%d%d%d%d%-%d%d%d%d$') then		if not id:match ('^%d%d%d%d%-%d%d%d[%dX]$') then
	return error_string;		return error_string;
	end		end

meta>Trappist the monk: test issn for correct format;

2016-01-05T01:35:44Z

test issn for correct format;

← Older revision		Revision as of 01:35, 5 January 2016
Line 51:		Line 51:
	]]		]]

	function check_isbn( isbn_str, error_string )		local function check_isbn( isbn_str, error_string )
	if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X		if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
	isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces		isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
Line 78:		Line 78:
	]]		]]

	function check_ismn (id, error_string)		local function check_ismn (id, error_string)
	local text;		local text;
	local valid_ismn = true;		local valid_ismn = true;
Line 106:		Line 106:
	]]		]]

	function check_issn(id, error_string)		local function check_issn(id, error_string)
	local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate		local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
	local text;		local text;
	local valid_issn = true;		local valid_issn = true;

			if not id:match ('^%d%d%d%d%-%d%d%d%d$') then
			return error_string;
			end

	id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the issn		id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the issn

Line 121:		Line 125:
	return valid_issn and '' or error_string		return valid_issn and '' or error_string
	end		end


			------------------------------< E N T R Y P O I N T S >--------------------------------------------------====

	function p.check_isbn(frame)		function p.check_isbn(frame)