模块:ISOdate

来自萌娘共享
跳转至： 导航、 搜索

此模块的文档可以在模块:ISOdate/doc创建 

  1. --[[  
  2.  
  3. This module is intended for processing of date strings.
  4.  
  5. Please do not modify this code without applying the changes first at Module:ISOdate/sandbox and testing 
  6. at Module:ISOdate/sandbox/testcases and Module talk:ISOdate/sandbox/testcases.
  7.  
  8. Authors and maintainers:
  9. * User:Parent5446 - original version of the function mimicking template:ISOdate
  10. * User:Jarekt - original version of the functions mimicking template:Date and template:ISOyear
  11.  
  12. ]]
  13.  
  14.  
  15. local p = {}
  16.  
  17. -- =======================================
  18. -- === Dependencies ======================
  19. -- =======================================
  20. local D = require('Module:Date')
  21.  
  22. --[[
  23. ISOyear
  24.  
  25. This function returns year part of date string.
  26.  
  27. Usage:
  28. {{#invoke:ISOdate|ISOyear|target_string}}
  29.  
  30. Parameters
  31.     1: The date string 
  32.  
  33. Error Handling:
  34.    If the string does not look like it contain the year than the function will not return anything.
  35.    That is the preferred treatment for the template:Creator which is the main (only?) template calling it.
  36. ]]
  37. function p.ISOyear( frame )
  38. 	 return p._ISOyear( frame.args[1] )
  39. end
  40.  
  41. function p._ISOyear( input )
  42. 	if not input then
  43. 		return ''
  44. 	end
  45. 	input = mw.text.trim( input )
  46.     
  47. 	-- if empty string then return it
  48. 	if input == "" then
  49. 		return input
  50. 	end
  51.     
  52. 	-- if number then return it
  53. 	if tonumber( input ) then
  54. 		return mw.ustring.format( '%04i', input )
  55. 	end
  56.     
  57. 	-- otherwise use regular expression match
  58. 	input = mw.ustring.match( input, '^+?(-?%d%d?%d?%d?)-' )
  59. 	if input and tonumber( input ) then
  60. 		return mw.ustring.format( '%04i', input )
  61. 	else
  62. 		return ''
  63. 	end
  64. end
  65.  
  66. --[[
  67. ISOdate
  68.  
  69. This function is the core part of the ISOdate template. 
  70.  
  71. Usage:
  72. {{#invoke:ISOdate|ISOdate|target_string|lang=}}
  73.  
  74. Parameters:
  75.      1: The date string 
  76.   lang: The language to display it in
  77.   form: Language format (genitive, etc.) for some languages
  78.  class: CSS class for the <time> node
  79.  
  80.  Error Handling:
  81.    If the string does not look like it contain the proper ISO date than the function will return the original string.
  82.    
  83.    That is the preferred treatment for the template:Information (and similar templates) which calling it.
  84. ]]
  85. function p.ISOdate(frame)
  86. 	local datestr, succeded
  87. 	local args = frame.args
  88. 	if not (args.lang and mw.language.isSupportedLanguage(args.lang)) then 
  89. 		args.lang = frame:callParserFunction( "int", "lang" ) -- get user's chosen language 
  90. 	end
  91. 	datestr, succeded = p._ISOdate(
  92. 		mw.text.trim(args[1]),
  93. 		args.lang,                  -- language
  94. 		args.case  or '',           -- allows to specify grammatical case for the month for languages that use them
  95. 		args.class or 'dtstart',    -- allows to set the html class of the time node where the date is included. 
  96. 		args.trim_year or '100-999' -- by default pad one and 2 digit years to be 4 digit long, while keeping 3 digit years as is	
  97. 	)
  98. 	return datestr
  99. end
  100.  
  101. function p._ISOdate(datestr, lang, case, class, trim_year)
  102.  
  103. 	-- pattern: regexp - regular expresion to test; dlen - number of date elements; tail = which element is a "tail" if any
  104. 	-- regexp hints:
  105. 	--  1) Strings starting with "^" and ending with "$" indicate whole string match
  106. 	--  2) optional tail part copied as-is and following the main parsed part of the date have to be separated from the date by a whitespace, so "(\s.+)?"
  107. 	local patterns = {
  108. 		-- strings starting with YYYY-MM-DD HH:MM:SS. Year 4 digits (if we know seconds than it was within the last 100 years), the rest 1-2
  109. 		-- date and time can be separated by space or "T" and there could be a "Z" on the end indicating "Zulu" time zone
  110. 		{dlen=6, tail=7, regexp="^+?(%d%d%d%d)-(%d%d?)-(%d%d?)[ T](%d%d?):(%d%d?):(%d%d?)Z?(%s.*)"}, 
  111. 		{dlen=6, tail=0, regexp="^+?(%d%d%d%d)-(%d%d?)-(%d%d?)[ T](%d%d?):(%d%d?):(%d%d?)Z?$"}, 
  112. 		-- strings starting with YYYY-MM-DD HH:MM. Year 4 digits, the rest 1-2
  113. 		-- (if one knows hour and minute than it was probably after a year 1000)
  114. 		{dlen=5, tail=6, regexp="^+?(%d%d%d%d)-(%d%d?)-(%d%d?)[ T](%d%d?):(%d%d?)(%s.+)"},
  115. 		{dlen=5, tail=0, regexp="^+?(%d%d%d%d)-(%d%d?)-(%d%d?)[ T](%d%d?):(%d%d?)$"},
  116. 		-- strings starting with YYYY-MM-DD. Year 1-4 digits, the rest 1-2
  117. 		{dlen=3, tail=4, regexp="^+?(%d%d?%d?%d?)-(%d%d?)-(%d%d?)(%s.+)"},
  118. 		{dlen=3, tail=0, regexp="^+?(%d%d?%d?%d?)-(%d%d?)-(%d%d?)$"},
  119. 		-- strings starting with YYYY-MM. Year 3-4 digits, month 2 digits
  120. 		-- (want to avoit converting to dates strings like 10-5 = 5
  121. 		{dlen=2, tail=3, regexp="^+?(%d%d%d%d?)-(%d%d)(%s.+)"}, 
  122. 		-- if whole string is in YYYY-MM form: If Year 1-4 digits, month 1-2 digits
  123. 		{dlen=2, tail=0, regexp="^+?(%d%d?%d?%d?)-(%d%d?)$"}, 
  124. 		-- string starts with a number -> it has to be 3 or 4 digit long to be a year
  125. 		{dlen=1, tail=2, regexp="^+?(%d%d%d%d?)(%s.+)"},	
  126. 		 -- if whole string is a number (1-4 digit long) than it will be interpreted as a year
  127. 		{dlen=1, tail=0, regexp="^+?(%d%d?%d?%d?)$"},
  128. 	}
  129. 	
  130. 	-- create datevec based on which variables are provided
  131. 	local datevec, tail, formatNum
  132. 	datevec, tail, formatNum = p.test_date_formats(datestr or '', patterns)
  133. 	if datevec[1]=='' or datevec[1]==nil then
  134. 		-- quickly return if datestr does not look like date (it could be a template)
  135. 		return datestr, false
  136. 	end
  137.  
  138. 	-- call p._Date function to format date string
  139. 	local succeded, datestr2
  140. 	succeded, datestr2 = pcall( D._Date, datevec, lang, case, class, trim_year)
  141. 	if succeded and datestr2~='' then
  142. 		return mw.text.trim( datestr2 .. tail), true
  143. 	else -- in case of errors return the original string
  144. 		return datestr, false
  145. 	end	
  146. end
  147.  
  148. function p.ISOdate_extended(frame)
  149. 	-- pattern: regexp - regular expresion to test; dlen - number of date elements; tail = which element is a "tail" if any
  150. 	-- regexp hints:
  151. 	--  1) Strings starting with "^" and ending with "$" indicate whole string match
  152. 	--  2) optional tail part copied as-is and following the main parsed part of the date have to be separated from the date by a whitespace, so "(\s.+)?"
  153.  
  154. 	local datestr, succeded
  155. 	local args = frame.args
  156. 	if not (args.lang and mw.language.isSupportedLanguage(args.lang)) then 
  157. 		args.lang = frame:callParserFunction( "int", "lang" ) -- get user's chosen language 
  158. 	end
  159. 	datestr, succeded = p._ISOdate(
  160. 		mw.text.trim(args[1]),
  161. 		args.lang,                  -- language
  162. 		args.case  or '',           -- allows to specify grammatical case for the month for languages that use them
  163. 		args.class or 'dtstart',    -- allows to set the html class of the time node where the date is included. 
  164. 		args.trim_year or '100-999' -- by default pad one and 2 digit years to be 4 digit long, while keeping 3 digit years as is	
  165. 	)
  166. 	if succeded then
  167. 		return datestr
  168. 	end
  169.  
  170. 	local patterns = {
  171. 		-- Exended set of recognized formats: like MM/DD/YYYY
  172. 		{dlen=3, tail=4, regexp="^(%d%d?)[-./](%d%d?)[-./](%d%d%d%d)(%s.+)"},
  173. 		{dlen=3, tail=0, regexp="^(%d%d?)[-./](%d%d?)[-./](%d%d%d%d)$"},
  174. 		{dlen=3, tail=0, regexp="^(%d%d?)%s(%w+)%s(%d%d%d%d)$"},
  175. 		{dlen=3, tail=0, regexp="^(%w+)%s(%d%d?),%s(%d%d%d%d)$"},
  176. 	}
  177. 	
  178. 	local datevec, tail, formatNum, category = ''
  179. 	datevec, tail, formatNum = p.test_date_formats(frame.args[1], patterns)
  180. 	if formatNum==1 or formatNum==2 then
  181. 		vec = datevec;
  182. 		if tonumber(datevec[1])>12 then
  183. 			frame.args[1] = string.format('%04i-%02i-%02i', datevec[3], datevec[2], datevec[1] )
  184. 			category = '[[Category:Date in DD/MM/YYYY format]]'
  185. 			return mw.text.trim( p.ISOdate(frame) .. tail);
  186. 		elseif tonumber(datevec[2])>12 then
  187. 			frame.args[1] = string.format('%04i-%02i-%02i', datevec[3], datevec[1], datevec[2] )
  188. 			category = '[[Category:Date in MM/DD/YYYY format]]'
  189. 			return mw.text.trim( p.ISOdate(frame) .. tail);
  190. 		end
  191. 	elseif (formatNum==3 or formatNum==4) and (datevec[3]=='' or datevec[3]~=nil) then
  192. 		local str = mw.getCurrentFrame():callParserFunction( "#time", { 'Y-m-d', datestr} )
  193. 		local vec = {str:match( "^(%d%d?%d?%d?)-(%d%d?)-(%d%d?)$" )}
  194. 		if vec and vec[1]~=nil then
  195. 			frame.args[1] = string.format('%04i-%02i-%02i', vec[1], vec[2], vec[3] )
  196. 			category = '[[Category:Date in word format]]'
  197. 			return p.ISOdate(frame);
  198. 		end
  199. 	end	
  200. 	return datestr
  201. end
  202.  
  203. function p.test_date_formats(datestr, patterns)
  204. 	-- pattern: regexp - regular expresion to test; dlen - number of date elements; tail = which element is a "tail" if any
  205.  
  206. 	local datevec = {'','','','','',''}
  207. 	local tail = ''
  208. 	local vec, pat
  209. 	local formatNum = 0
  210. 	for i, pat in ipairs( patterns ) do
  211. 		vec = {datestr:match( pat.regexp )}
  212. 		if vec and vec[1]~=nil then
  213. 			for j=1,pat.dlen do
  214. 				datevec[j] = vec[j]
  215. 			end
  216. 			if pat.tail>0 and vec[pat.tail]~=nil then
  217. 				tail = mw.ustring.gsub(' ' .. vec[pat.tail], ' +', ' ')
  218. 			end
  219. 			formatNum = i
  220. 			break
  221. 		end
  222. 	end
  223. 	return datevec, tail, formatNum
  224. end
  225.  
  226. return p
取自“https://commons.moegirl.org.cn/index.php?title=模块:ISOdate&oldid=1181980”