☰

# GRO Index Search Helper

Adds additional functionality to the UK General Register Office (GRO) BMD index search

当前为 2016-11-11 提交的版本，查看 最新版本。

  1. // ==UserScript==
  2. // @name        # GRO Index Search Helper
  3. // @description Adds additional functionality to the UK General Register Office (GRO) BMD index search
  4. // @namespace   cuffie81.scripts
  5. // @include     https://www.gro.gov.uk/gro/content/certificates/indexes_search.asp
  6. // @version     1.4
  7. // @grant       none
  8. // @require     https://code.jquery.com/jquery-2.2.4.min.js
  9. // @require     https://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.0.5/handlebars.min.js
  10. // ==/UserScript==
  11.  
  12. /*
  13. ======================INLINE_RESOURCE_BEGIN======================
  14. ***********RESOURCE_START=Template-EW_Birth*************
  15. <style type="text/css">
  16. 	div[results-view='EW_Birth'] td
  17. 	{
  18. 		padding: 5px 3px;
  19. 		font-size: 75%;
  20. 		color: #663333;
  21. 		vertical-align: top;
  22. 	}
  23. 	
  24. 	div[results-view='EW_Birth'] thead td
  25. 	{
  26. 		font-weight: bold;
  27. 	}
  28. 	
  29. 	div[results-view='EW_Birth'] tbody tr:nth-child(4n+1),
  30. 	div[results-view='EW_Birth'] tbody tr:nth-child(4n+2)
  31. 	{
  32. 		background-color: #F9E8A5;
  33. 	}
  34. 	
  35. 	div[results-view='EW_Birth'] tr.rec-actions a
  36. 	{
  37. 		padding: 0px 5px;
  38. 		font-size: 90%;
  39. 		color: #663333;
  40. 		text-decoration: none;
  41. 	}
  42. </style>
  43. <div results-view='EW_Birth' style='display: none; margin-bottom: 25px'>
  44. 	<table style='width: 100%; border-collapse: collapse'>
  45. 		<thead>
  46. 			<tr>
  47. 				<td class='main_text' style='padding: 5px 3px; font-weight: bold; width: 12%'>Date</td>
  48. 				<td>Name</td>
  49. 				<td>Mother</td>
  50. 				<td style='max-width: 30%'>District</td>
  51. 				<td>Vol</td>
  52. 				<td>Page</td>
  53. 			</tr>
  54. 		</thead>
  55. 		<tbody>
  56. 		{{#each items}}
  57. 			<tr class='rec'>
  58. 				<td>{{year}} Q{{quarter}}</td>
  59. 				<td><span class='forenames'>{{forenames}}</span> <span class='surname'>{{surname}}</span></td>
  60. 				<td>{{mother}}</td>
  61. 				<td>{{district}}</td>
  62. 				<td>{{volume}}</td>
  63. 				<td>{{page}}</td>
  64. 			</tr>
  65. 			<tr class='rec-actions' style='display: none'>
  66. 				<td colspan='6' style='text-align: right'>
  67. 				{{#actions}}
  68. 					<a href='{{url}}' {{#if title}}title='{{title}}'{{/if}}>{{text}}</a>
  69. 				{{/actions}}
  70. 				</td>
  71. 			</tr>
  72. 		{{/each}}
  73. 		</tbody>
  74. 	</table>
  75. </div>
  76. *************RESOURCE_END*************
  77.  
  78. ***********RESOURCE_START=Template-EW_Death*************
  79. <style type="text/css">
  80. 	div[results-view='EW_Death'] td
  81. 	{
  82. 		padding: 5px 3px;
  83. 		font-size: 75%;
  84. 		color: #663333;
  85. 		vertical-align: top;
  86. 	}
  87. 	
  88. 	div[results-view='EW_Death'] thead td
  89. 	{
  90. 		font-weight: bold;
  91. 	}
  92. 	
  93. 	div[results-view='EW_Death'] tbody tr:nth-child(4n+1),
  94. 	div[results-view='EW_Death'] tbody tr:nth-child(4n+2)
  95. 	{
  96. 		background-color: #F9E8A5;
  97. 	}
  98. 	
  99. 	div[results-view='EW_Death'] tr.rec-actions a
  100. 	{
  101. 		padding: 0px 5px;
  102. 		font-size: 90%;
  103. 		color: #663333;
  104. 		text-decoration: none;
  105. 	}
  106. </style>
  107. <div results-view='EW_Death' style='display: none; margin-bottom: 25px'>
  108. 	<table style='width: 100%; border-collapse: collapse'>
  109. 		<thead>
  110. 			<tr>
  111. 				<td style='width: 12%'>Date</td>
  112. 				<td>Name</td>
  113. 				<td>Age{{#if ageCautionThreshold}}*{{/if}}</td>
  114. 				<td>Birth</td>
  115. 				<td style='max-width: 30%'>District</td>
  116. 				<td>Vol</td>
  117. 				<td>Page</td>
  118. 			</tr>
  119. 		</thead>
  120. 		<tbody>
  121. 		{{#each items}}
  122. 			<tr class='rec'>
  123. 				<td>{{year}} Q{{quarter}}</td>
  124. 				<td><span class='forenames'>{{forenames}}</span> <span class='surname'>{{surname}}</span></td>
  125. 				<td>{{age}}{{#if ageCaution}}*{{/if}}</td>
  126. 				<td>{{birth}}
  127. 				<td>{{district}}</td>
  128. 				<td>{{volume}}</td>
  129. 				<td>{{page}}</td>
  130. 			</tr>
  131. 			<tr class='rec-actions' style='display: none'>
  132. 				<td colspan='7' style='text-align: right'>
  133. 				{{#actions}}
  134. 					<a href='{{url}}' {{#if title}}title='{{title}}'{{/if}}>{{text}}</a>
  135. 				{{/actions}}
  136. 				</td>
  137. 			</tr>
  138. 		{{/each}}
  139. 		</tbody>
  140. 	</table>
  141. 	{{#if ageCautionThreshold}}
  142. 		<p class='main_text'>* Ages are assumed to be years but <i>may</i> be months. Ages below {{ageCautionThreshold}} should be treated with caution.</p>
  143. 	{{/if}}
  144. </div>
  145. *************RESOURCE_END*************
  146.  
  147. ======================INLINE_RESOURCE_END======================
  148. */
  149.  
  150. this.$ = this.jQuery = jQuery.noConflict(true);
  151.  
  152. $(function()
  153. {
  154. 	
  155. 	var initialiseSearchForm = function()
  156. 	{
  157. 		// Hide the reset button
  158. 		$("form[name='SearchIndexes'] input[type='submit'][value='Reset']").hide();
  159.  
  160. 		// Hide superfluous text
  161. 		$("table[summary*='contains the search form fields'] > tbody > tr:nth-of-type(2)").hide(); 
  162. 		$("table[summary*='contains the search form fields'] > tbody > tr:nth-of-type(3) td.main_text[colspan='5']").parent().hide(); 
  163.  
  164. 		// Add gender and year navigation buttons, and style them
  165. 		var searchButton = $("form[name='SearchIndexes'] input[type='submit'][value='Search']")
  166.  
  167. 		$("<input class='formButton' id='groish_BtnGenderToggle' type='button' value='Gender' />").insertBefore($(searchButton));
  168. 		$("<input class='formButton' id='groish_BtnYearsPrev' type='button' value='&lt; Years' />").insertBefore($(searchButton));
  169. 		$("<input class='formButton' id='groish_BtnYearsNext' type='button' value='Years &gt;' />").insertBefore($(searchButton));
  170.  
  171. 		var buttonContainer = $("form[name='SearchIndexes'] input[type='submit'][value='Search']").closest("td");
  172. 		$(buttonContainer).css("padding-bottom", "10px");
  173. 		$(buttonContainer).find("input[type='button']").css("margin-right", "20px");
  174. 		$(buttonContainer).find("input[type='submit'], input[type='button']").css("min-width", "100px").css("font-size", "13px").css("padding", "4px 10px");
  175.  
  176. 		// Add button event handlers
  177. 		$("input#groish_BtnYearsPrev").click(function() { navigateYears(false); });
  178. 		$("input#groish_BtnYearsNext").click(function() { navigateYears(true); });
  179. 		$("input#groish_BtnGenderToggle").click(function() { toggleGender(); });
  180. 		
  181. 	}
  182. 	
  183. 	var initialiseResultViews = function(recordType, resources)
  184. 	{
  185. 		
  186. 		//console.log("start: initialiseResultViews");
  187. 		
  188. 		// Move default results table into a view container
  189. 		var defaultTable = $("form[name='SearchIndexes'] h3:contains('Results:')").closest("table").css("width", "100%").addClass("groish_ResultsTable");
  190. 		$(defaultTable).before($("<div results-view='default' />"));
  191. 		var defaultView = $("div[results-view='default']");
  192. 		$(defaultView).append($("table.groish_ResultsTable"));
  193.  
  194. 		// Move header row to before default view
  195. 		$(defaultView).before($("<div class='groish_ResultsHeader' style='margin: 10px 0px; position: relative' />"));
  196. 		$(".groish_ResultsHeader").append($("table.groish_ResultsTable h3:contains('Results:')"));
  197.  
  198. 		// Move pager row contents to after default view
  199. 		$(defaultView).after($("table.groish_ResultsTable > tbody > tr:last table:first"));
  200. 		$("div[results-view='default'] + table").css("width", "100%").addClass("groish_ResultsInfo");
  201.  
  202.  
  203. 		// Add alternate view
  204. 		var results = getResults(recordType);
  205. 		//console.log(results);
  206. 		if (results != null && recordType && results.items != null && results.items.length > 0)
  207. 		{
  208. 			// Get template and add alternate view
  209. 			var template =  resources["Template-" + recordType].toString();
  210. 			var compiledTemplate = Handlebars.compile(template);
  211. 			var html = compiledTemplate(results);
  212. 			$(defaultView).after($(html));
  213.  
  214. 			// Add event handler to hide/show actions row
  215. 			// TODO: Make adding view event handlers more dynamic, so they can be specific to the view
  216. 			$("div[results-view][results-view!='default'] tbody tr.rec").click(function(index)
  217. 			{
  218. 				$(this).next("tr.rec-actions:not(:empty)").toggle();
  219. 			});
  220.  
  221. 			
  222. 			// Add click handlers to results header, to toggle views
  223. 			$(".groish_ResultsHeader").append($("<div id='groish_ViewSwitcher' class='main_text' style='display:inline-block; position: absolute; color: #993333; font-weight: bold; right: 10px; bottom: 0px; cursor: pointer'>Switch view</div>"))
  224. 									.click(function() { switchResultsView(); });
  225. 			//$("form[name='SearchIndexes'] h3:contains('Results:')").click(function() { switchResultsView(); });
  226.  
  227. 			// Show the last used view
  228. 			var viewName = sessionStorage.getItem("groish_view." + recordType);
  229. 			//console.log("initialising view: %s", viewName);
  230. 			if (viewName && $("div[results-view='" + viewName + "']:hidden").length == 1)
  231. 			{
  232. 				//console.log("setting active view: %s", viewName);
  233. 				$("div[results-view][results-view!='" + viewName + "']").hide();
  234. 				$("div[results-view][results-view='" + viewName + "']").show();
  235. 			}
  236. 		}
  237. 		
  238. 		//console.log("end: initialiseResultViews");
  239. 	}
  240. 	
  241. 	var switchResultsView = function()
  242. 	{
  243. 		//console.log("switchResultsView");
  244. 	
  245. 		var recordType = getRecordType();
  246. 		var views = $("div[results-view]");
  247. 		if (views.length > 1)
  248. 		{
  249. 			var curIndex = -1;
  250. 			$(views).each(function(index)
  251. 			{
  252. 				if ($(this).css("display") != "none")
  253. 					curIndex = index;
  254. 			});
  255.  
  256. 			//console.log("current view index: %s", curIndex);
  257. 			if (curIndex !== -1)
  258. 			{
  259. 				var newIndex = ((curIndex == (views.length-1)) ? 0 : curIndex+1);
  260. 				$(views).hide();
  261. 				$("div[results-view]:eq(" + newIndex + ")").show();
  262.  
  263. 				// Get the name and save it
  264. 				var viewName = $("div[results-view]:eq(" + newIndex + ")").attr("results-view")
  265. 				sessionStorage.setItem("groish_view." + recordType, viewName); //save it
  266. 				//console.log("new view: %s", viewName);
  267. 			}
  268. 		}
  269. 	}
  270. 	
  271. 	var getResults = function(recordType)
  272. 	{
  273. 		//console.log("start: getResults");
  274. 		
  275. 		var results = { "ageCautionThreshold": 24, "items": [] };
  276. 		
  277. 		// Lookup record type - birth or death
  278. 		if (recordType !== null && (recordType === "EW_Birth" || recordType === "EW_Death"))
  279. 		{
  280. 			$("div[results-view='default'] > table > tbody > tr")
  281. 				.has("img[src='./graphics/order_certificate_button.gif']")
  282. 				.each(function(index)
  283. 					{
  284. 				
  285. 						// Get names and reference
  286. 						var names 			= $(this).find("td:eq(0)").text().replace(/\u00a0/g, " ").replace(/\s\s+/g, ' ').trim();
  287. 						var ref 			= $(this).next().find("td:eq(0)").text();
  288.  
  289. 						// Clean up reference
  290. 						ref = ref.replace(/\u00a0/g, " ");
  291. 						ref = ref.replace(/\s\s+/g, ' ');
  292. 						ref = ref.replace(/GRO Reference: /g, "");
  293. 						ref = ref.replace(/M Quarter in/g, "Q1");
  294. 						ref = ref.replace(/J Quarter in/g, "Q2");
  295. 						ref = ref.replace(/S Quarter in/g, "Q3");
  296. 						ref = ref.replace(/D Quarter in/g, "Q4");
  297.  
  298. 						var age = 0;
  299. 						if (recordType === "EW_Death")
  300. 						{
  301. 							var ageArr = /^([0-9]{1,3})$/.exec($(this).find("td:eq(1)").text().replace(/\u00a0/g, " ").replace(/\s\s+/g, ' ').trim());
  302. 							if (ageArr)
  303. 								age = parseInt(ageArr[1], 10);
  304. 						}
  305. 				
  306. 						var mother = null;
  307. 						if (recordType === "EW_Birth")
  308. 							mother = toTitleCase($(this).find("td:eq(1)").text().replace(/\u00a0/g, " ").replace(/\s\s+/g, ' ')).trim();
  309. 				
  310. 						var actions			= [];
  311. 						var orderCertUrl	= $(this).find("a[href^='indexes_order.asp']:eq(0)").prop("href");
  312. 						var orderPdfUrl		= $(this).next().find("a[href^='indexes_order.asp']:eq(0)").prop("href");
  313.  
  314. 						if (orderCertUrl) actions.push( {"text": "Order Certificate", "url": orderCertUrl });
  315. 						if (orderPdfUrl)  actions.push( {"text": "Order Research Copy", "title": "PDF", "url": orderPdfUrl });
  316.  
  317. 						// Parse forenames, surname, year, quarter, district, vol, page
  318. 						var namesArr 	= /([a-z' -]+),([a-z' -]*)/gi.exec(names);
  319. 						var refArr 		= /([0-9]{4}) Q([1-4]) ([a-z\.\-,\(\)0-9\&' ]*)Volume ([a-z0-9]+) Page ([0-9]+)/gi.exec(ref); // NB: the district may not be set in some cases
  320. 				
  321. 						//console.log("index: %d, namesArr: %s, refArr: %s", index, namesArr, refArr);
  322.  
  323. 						if (namesArr !== null && refArr !== null)
  324. 						{
  325. 							var forenames 	= toTitleCase(namesArr[2]).trim();
  326. 							var surname 	= toTitleCase(namesArr[1]).trim();
  327. 							var year 		= parseInt(refArr[1], 10);
  328. 							var quarter 	= parseInt(refArr[2], 10);
  329. 							var district 	= toTitleCase(refArr[3]).trim();
  330. 							var volume		= refArr[4].toLowerCase();
  331. 							var page		= refArr[5];
  332.  
  333. 							//console.log("forenames: %s, surname: %s, age: %d, year: %s, quarter: %s, district: %s, vol: %s, page: %s", forenames, surname, age, year, quarter, district, volume, page);
  334. 							
  335. 							var record =
  336. 								{
  337. 									"forenames": 	forenames,
  338. 									"surname": 		surname,
  339. 									"age": 			age,
  340. 									"ageCaution": 	(age != null && age > 0 && age <= results.ageCautionThreshold),
  341. 									"birth": 		(age != null ? year - age : null),
  342. 									"mother": 		mother,
  343. 									"year": 		year,
  344. 									"quarter": 		quarter,
  345. 									"district": 	district,
  346. 									"volume": 		volume,
  347. 									"page": 		page,
  348. 									"actions": 		actions
  349. 								};
  350.  
  351. 							results.items.push(record);
  352. 							//console.log(record);
  353. 						}
  354. 						else
  355. 						{
  356. 							//console.log("Failed to read record: %d", index);
  357. 						}
  358. 					});
  359. 		}
  360.  
  361. 		// Sort records
  362. 		if (results.items.length > 0)
  363. 		{
  364. 			results.items.sort(function(a, b)
  365. 			{
  366. 				if (a.year == b.year && a.quarter == b.quarter)
  367. 					return 0;
  368. 				else if ((a.year > b.year) || (a.year == b.year && a.quarter > b.quarter))
  369. 					return 1;
  370. 				else
  371. 					return -1;
  372. 			});
  373. 		}
  374. 		
  375. 		//console.log("end: getResults");
  376.  
  377. 		return results;
  378. 	}
  379.  
  380.  
  381. 	var toTitleCase = function(str)
  382. 	{
  383. 		return str.replace(/([^\W_]+[^\s-]*) */g, function(txt){return txt.charAt(0).toUpperCase() + txt.substr(1).toLowerCase();});
  384. 	}
  385.  
  386. 	var toggleGender = function()
  387. 	{
  388. 		var curGender = $("form[name='SearchIndexes'] select#Gender").val();
  389. 		$("form[name='SearchIndexes'] select#Gender").val((curGender === "F" ? "M" : "F"));
  390. 		$("form[name='SearchIndexes'] input[type='submit'][value='Search']").click();
  391. 	}
  392.  
  393. 	var navigateYears = function(forward)
  394. 	{
  395. 		// Get min and max years
  396. 		var minYear = parseInt($("form[name='SearchIndexes'] select#Year option:eq(2)").val(), 10);
  397. 		var maxYear = parseInt($("form[name='SearchIndexes'] select#Year option:last").val(), 10);
  398.  
  399. 		//console.log("Year range: %s - %s", minYear, maxYear);
  400.  
  401. 		if (!isNaN(minYear) && !isNaN(maxYear))
  402. 		{
  403. 			// Read current year and range
  404. 			var curYear = parseInt($("form[name='SearchIndexes'] select#Year").val(), 10);
  405. 			var curRange = parseInt($("form[name='SearchIndexes'] select#Range").val(), 10);
  406.  
  407. 			if (!isNaN(curYear) && !isNaN(curRange))
  408. 			{
  409. 				// Calculate the new year
  410. 				var step = (curRange * 2) + 1;
  411. 				var newYear = (forward ? curYear+step : curYear-step);
  412. 				newYear = Math.min(Math.max(newYear, minYear), maxYear);
  413.  
  414. 				// Update the year and submit the search
  415. 				$("form[name='SearchIndexes'] select#Year").val(newYear);
  416. 				$("form[name='SearchIndexes'] input[type='submit'][value='Search']").click();
  417. 			}
  418.  
  419. 			//console.log("Current year: %d +-%d (%d-%d), New year: %d (%d-%d)", curYear, curRange, curYear-curRange, curYear+curRange, newYear, newYear-curRange, newYear+curRange);
  420. 		}
  421. 	}
  422. 	
  423. 	var getRecordType = function()
  424. 	{
  425. 		return $("form[name='SearchIndexes'] input[type='radio'][name='index']:checked").val();
  426. 	}
  427.  
  428. 	// https://gist.github.com/aidanhs/5534196
  429. 	var getInlineResources = function()
  430. 	{
  431. 		var resource = {}, len, match, resourceBlocks, inlineResourcesMatch = (/^=+INLINE_RESOURCE_BEGIN=+$([\s\S]*?)^=+INLINE_RESOURCE_END=+$/m).exec(GM_info.scriptSource);
  432. 		resourceBlocks = (inlineResourcesMatch && inlineResourcesMatch[1].match(/^\**RESOURCE_START[\s\S]*?^\**RESOURCE_END\**$/mg)) || null;
  433. 		len = (resourceBlocks && resourceBlocks.length) || 0;
  434.  
  435. 		for (var i = 0; i < len; i++)
  436. 		{
  437. 			match = (/^\**RESOURCE_START=(.*?)\**$\s*^([\s\S]*)^\**RESOURCE_END\**$/m).exec(resourceBlocks[i]);
  438. 			resource[match[1]] = match[2];
  439. 		}
  440.  
  441. 		return resource;
  442. 	}
  443.  
  444. 	
  445. 	// Get the ball rolling...
  446. 	var resources = getInlineResources();
  447. 	var recordType = getRecordType();
  448. 	
  449. 	initialiseSearchForm();
  450. 	initialiseResultViews(recordType, resources);
  451. });
  452.  
  453.