☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

目前為 2019-11-19 提交的版本，檢視 最新版本。

此腳本不應該直接安裝，它是一個供其他腳本使用的函式庫。欲使用本函式庫，請在腳本 metadata 寫上： // @require https://update.cn-greasyfork.org/scripts/392610/751119/DKK%20Torn%20Utilities%20DEVELOPMENT.js 

  1. // ==UserScript==
  2. // @name        DKK Torn Utilities DEVELOPMENT
  3. // @description Commonly used functions in my Torn scripts.
  4. // @version     2.0.5
  5. // @exclude     *
  6. // @namespace   https://openuserjs.org/users/DeKleineKobini
  7. // @homepageURL https://www.torn.com/forums.php#/p=threads&t=16110079
  8. // ==/UserScript==
  9.  
  10. /* Classes */
  11. class DKKLog {
  12. 	
  13. 	constructor(prefix, level) {
  14. 		this.levels = {
  15. 			FATAL: 0,
  16. 			ERROR: 1,
  17. 			WARN: 2,
  18. 			INFO: 3,
  19. 			DEBUG: 4,
  20. 			TRACE: 5,
  21. 			ALL: 6,
  22. 			OFF: 7
  23. 		},
  24. 		
  25. 		this.prefix = prefix;
  26. 		this._level = level || 2;
  27. 	}
  28. 	
  29. 	get level() {
  30. 		return this._level;
  31. 	}
  32. 	
  33. 	set level(val) {
  34. 		this._level = this.levels[val];
  35. 	}
  36. 	
  37. 	logging(level, message, objs) {
  38. 		if (this._level< this.levels[level]) return;
  39.  
  40. 		let msg = `${this.prefix}[${level}] ${message}`;
  41.  
  42. 		if (objs && objs.length) console.log(msg, ...objs);
  43. 		else console.log(msg);
  44. 	}
  45. 	
  46. 	fatal(message, ...objs) { this.logging("FATAL", message, objs); }
  47. 	error(message, ...objs) { this.logging("ERROR", message, objs); }
  48. 	warn(message, ...objs) { this.logging("WARN", message, objs); }
  49. 	info(message, ...objs) { this.logging("INFO", message, objs); }
  50. 	debug(message, ...objs) { this.logging("DEBUG", message, objs); }
  51. 	trace(message, ...objs) { this.logging("TRACE", message, objs); }
  52. 	all(message, ...objs) { this.logging("ALL", message, objs); }
  53. 	
  54. }
  55.  
  56. class TornAPI {
  57. 	
  58. 	constructor(callback, local) {
  59. 		this.key = local || localStorage.getItem("dkkutils_apikey");
  60. 		if (!this.isValid()) {
  61. 			dkklog.trace("Asking for the api key.");
  62. 			
  63. 			let createPrompt = () => {
  64. 				if (!$("#dkkapi").length) {
  65. 					let selector;
  66. 					
  67. 					switch (location.pathname) {
  68. 						case "/christmas_town.php":
  69. 							selector = ".content-wrapper div[id*='root'] > div > div:eq(0)";
  70. 							break;
  71. 						default:
  72. 							selector = ".content-title";
  73. 							break;
  74. 					}
  75. 					
  76. 					$(selector).after(
  77. 						"<div><article class='dkk-widget' id='dkkapi'><header class='dkk-widget_green dkk-round'><span class='dkk-widget_title'>API Promt</span>"
  78. 						+ "<input type='text' id='dkkapi-promt' style='margin-right: 8px;'><a id='dkkapi-save' class='dkk-button-green' href='#'>Save</a>"
  79. 						+ "</header></article></div><div class='clear'></div>"
  80. 					);
  81. 				}
  82. 				
  83. 				$("#dkkapi-save").click(event => {
  84. 					event.preventDefault();
  85. 					
  86. 					this.key = $("#dkkapi-promt").val();
  87. 					
  88. 					if (this.isValid()) {
  89. 						$("#dkkapi").remove();
  90. 						localStorage.setItem("dkkutils_apikey", this.key);
  91. 						if (callback) callback(this);
  92. 					} else {
  93. 						$("#dkkapi-promt").val("");
  94. 					}
  95. 				});
  96. 			}
  97. 			
  98. 			if ($(".content-wrapper").length) createPrompt();
  99. 			else observeMutations(document, ".content-wrapper", true, createPromt, { childList: true, subtree: true });
  100. 		} else {
  101. 			if (callback) callback(this);
  102. 		}
  103. 	}
  104. 	
  105. 	isValid() {
  106. 		if (!this.key || this.key === undefined || this.key == "undefined" || this.key === null || this.key == "null" || this.key === "") return false;
  107. 		if (this.key.length != 16) return false;
  108. 		
  109. 		return true;
  110. 	}
  111. 	
  112. 	sendRequest(part, id, selections) {
  113. 		dkklog.debug(`Sending API request to ${part}/${selections} for id ${id} with key ${this.key}`);
  114. 		
  115. 		return new Promise((resolve, reject) => {
  116. 			GM_xmlhttpRequest({
  117. 				method: "GET",
  118. 				url: `https://api.torn.com/${part}/${id}?selections=${selections}&key=${this.key}`,
  119. 				onreadystatechange: (res) => {
  120. 					if (res.readyState > 3 && res.status === 200) {
  121. 						dkklog.trace("API response received.", res)
  122. 						if (!isJsonString(res.responseText)) {
  123. 							reject("JSON Error", res.responseText);
  124. 							return;
  125. 						}
  126.  
  127. 						if (json.error) {
  128. 							var code = json.error.code;
  129. 							if (code == 2) {
  130. 								this.key = null;
  131. 								localStorage.removeItem("dkkutils_apikey");
  132. 							}
  133. 							
  134. 							dkklog.warn("A TornAPI error occured.", json.error);
  135. 							reject("API Error: " + code);
  136. 						} else {
  137. 							resolve(json, JSON.parse(res.responseText));
  138. 						}
  139. 					}
  140. 				},
  141. 				onerror: function(err) {
  142. 					dkklog.error("An XHR error occured.", err)
  143. 					reject('XHR error.');
  144. 				}
  145. 			})
  146. 		});
  147. 	}
  148. 	
  149. }
  150.  
  151. /* Script Setup */
  152. var dkklog = new DKKLog("[DKK]", 2);;
  153.  
  154. loadCSS();
  155. addFunctions();
  156.  
  157. if (!unsafeWindow.scripts) unsafeWindow.scripts = { ids: [] };
  158.  
  159. function loadCSS() {
  160. 	if ($("#dkkutilscss").length) return;
  161. 	
  162. 	$("head").append("<style id='dkkutilscss'>"
  163.         + ".dkk-button, .dkk-button-green { -webkit-appearance: button; -moz-appearance: button; appearance: button; text-decoration: none; ext-shadow: rgba(0, 0, 0, 0.05) 1px 1px 2px; cursor: pointer; font-weight: 400; text-transform: none; position: relative; text-align: center; line-height: 1.2; box-shadow: rgba(255, 255, 255, 0.5) 0px 1px 1px 0px inset, rgba(0, 0, 0, 0.25) 0px 1px 1px 1px; border-width: initial; border-style: none; border-color: initial; border-image: initial; padding: 2px 10px; border-radius: 4px; } "
  164. 		+ ".dkk-button-green { background-color: rgba(255, 255, 255, 0.15); color: rgb(255, 255, 255); }"
  165. 		+ ".dkk-widget { margin-top: 10px; }"
  166.         + ".dkk-widget_red, .dkk-widget_green { background-image: linear-gradient(90deg, transparent 50%, rgba(0, 0, 0, 0.07) 0px); background-size: 4px; display: flex; align-items: center; color: rgb(255, 255, 255); font-size: 13px; letter-spacing: 1px; text-shadow: rgba(0, 0, 0, 0.65) 1px 1px 2px; padding: 6px 10px; border-radius: 5px 5px 0 0; } "
  167.         + ".dkk-widget_green { background-color: rgb(144, 176, 46); }"
  168.         + ".dkk-widget_red { background-color: rgb(251, 0, 25); }"
  169. 		+ ".dkk-widget_title { flex-grow: 1; box-sizing: border-box; }"
  170.         + ".dkk-widget_body { display: flex; padding: 0px; line-height: 1.4; background-color: rgb(242, 242, 242); }"
  171.         + ".dkk-round-bottom { border-radius: 0 0 10px 10px; }"
  172.         + ".dkk-round { border-radius: 5px; }"
  173.         + ".dkk-panel-left, .dkk-panel-right, .dkk-panel-middle { flex: 1 0 0px; max-height: 120px; overflow: auto; min-height: 60px; }"
  174.         + ".dkk-panel-left { border-left: 1px solid transparent; }"
  175.         + ".dkk-panel-middle { display: flex-direction: column; }"
  176.         + ".dkk-panel-right { display: flex-direction: column; border-radius: 0 0 5px 5px; }"
  177.         + ".dkk-data-table { width: 100%; height: 100%; border-collapse: separate; text-align: left; }"
  178.         + ".dkk-data-table > tbody > tr > th { height: 16px; white-space: nowrap; text-overflow: ellipsis; font-weight: 700; padding: 2px 10px; border-top: 1px solid rgb(255, 255, 255); border-bottom: 1px solid rgb(204, 204, 204); background: linear-gradient(rgb(255, 255, 255), rgb(215, 205, 220)); }"
  179.         + ".dkk-data-table > tbody > tr > td { padding: 2px 10px; border-top: 1px solid rgb(255, 255, 255); border-right: 1px solid rgb(204, 204, 204); border-bottom: 1px solid rgb(204, 204, 204); }"
  180. 		+ "</style>"
  181. 	);
  182. }
  183.  
  184. function addFunctions() {
  185. 	// formating for numbers
  186.     Number.prototype.format = function(n, x) {
  187.         var re = '\\d(?=(\\d{' + (x || 3) + '})+' + (n > 0 ? '\\.' : '$') + ')';
  188.         return this.toFixed(Math.max(0, ~~n)).replace(new RegExp(re, 'g'), '$&,');
  189.     };
  190. 	
  191. 	// string functions
  192.     String.prototype.replaceAll = function(text, replace) {
  193.         let str = this.toString();
  194. 		
  195. 	while (str.includes(text)) { str = str.replace(text, replace); }
  196. 		
  197.         return str;
  198.     };
  199. }
  200.  
  201. function initScript(options) {
  202. 	// some easy name conversion
  203.     if (options.name) {
  204. 		if (!options.id) options.id = options.name.replaceAll(" ", "").toLowerCase();
  205. 		if (!options.abbr) options.abbr = "";
  206. 	}
  207. 	if (!options.logging) {
  208. 		options.logging = "WARN";
  209. 	}
  210. 	
  211. 	unsafeWindow.scripts.ids.push(options.id);
  212.     unsafeWindow.scripts[options.id] = {
  213.         name: options.name,
  214.         abbr: options.abbr,
  215.         api: options.api ? true : false
  216.     };
  217. 	
  218. 	dkklog.prefix = "[" + options.abbr + "]";
  219. 	dkklog.level = options.logging;
  220. }
  221.  
  222. /* Torn General*/
  223. function getScriptUser() {
  224.     let body = $("body")
  225.     let contentWrapper = $("#mainContainer > .content-wrapper");
  226.  
  227.     return {
  228.         isJailed: body.hasClass("jail"),
  229.         isHospitalized: body.hasClass("hospital"),
  230.         isTravelling: contentWrapper.hasClass("travelling")
  231.     }
  232. }
  233.  
  234. /* Networking */
  235.  
  236. function xhrIntercept(callback) {
  237.     let oldXHROpen = window.XMLHttpRequest.prototype.open;
  238.     window.XMLHttpRequest.prototype.open = function() {
  239.         this.addEventListener('readystatechange', function() {
  240.             if (this.readyState > 3 && this.status == 200) {
  241.                 var page = this.responseURL.substring(this.responseURL.indexOf("torn.com/") + "torn.com/".length, this.responseURL.indexOf(".php"));
  242.  
  243.                 var json, uri;
  244.                 if (isJsonString(this.response)) json = JSON.parse(this.response);
  245.                 else uri = getUrlParams(this.responseURL);
  246.  
  247.                 callback(page, json, uri, this);
  248.             }
  249.         });
  250.  
  251.         return oldXHROpen.apply(this, arguments);
  252.     }
  253. }
  254.  
  255. function ajax(callback) {
  256.     $(document).ajaxComplete((event, xhr, settings) => {
  257.         if (xhr.readyState > 3 && xhr.status == 200) {
  258.             if (settings.url.indexOf("torn.com/") < 0) settings.url = "torn.com" + (settings.url.startsWith("/") ? "" : "/") + settings.url;
  259.             var page = settings.url.substring(settings.url.indexOf("torn.com/") + "torn.com/".length, settings.url.indexOf(".php"));
  260.  
  261.             var json, uri;
  262.             if (isJsonString(xhr.responseText)) json = JSON.parse(xhr.responseText);
  263.             else uri = getUrlParams(settings.url);
  264.  
  265.             callback(page, json, uri, xhr, settings);
  266.         }
  267.     });
  268. }
  269.  
  270. function interceptFetch(url, callback) {
  271.     unsafeWindow.fetch = async (input, options) => {
  272.         const response = await fetch(input, options)
  273.  
  274.         if (response.url.startsWith("https://www.torn.com/" + url)) {
  275.             let res = response.clone();
  276.  
  277.             Promise.resolve(res.json().then((json) => callback(json, res.url)));
  278.         }
  279.  
  280.         return response;
  281.     }
  282. }
  283.  
  284. /* DOM */
  285. function observeMutationsFull(root, callback, options) {
  286.     if (!options) options = {
  287.         childList: true
  288.     };
  289.  
  290.     new MutationObserver(callback).observe(root, options);
  291. }
  292.  
  293. function observeMutations(root, selector, runOnce, callback, options, callbackRemoval) {
  294.     var ran = false;
  295.     observeMutationsFull(root, function(mutations, me) {
  296.         var check = $(selector);
  297.  
  298.         if (check.length) {
  299.             if (runOnce) me.disconnect();
  300.  
  301.             ran = true;
  302.             callback(mutations, me);
  303.         } else if (ran) {
  304.             ran = false;
  305.             if (callbackRemoval) callbackRemoval(mutations, me);
  306.         }
  307.     }, options);
  308. }
  309.  
  310. /* Caching */
  311. function setCache(key, value, time, sub) {
  312.     var end = time == -1 ? -1 : Date.now() + time;
  313.  
  314.     var obj = sub ? value : {
  315.         value: value,
  316.         end: Date.now() + time
  317.     };
  318.  
  319.     GM_setValue(key, JSON.stringify(obj));
  320. }
  321.  
  322. async function getCache(key, subbed) {
  323.     let _obj = await GM_getValue(key, subbed ? "{}" : "{\"end\":0}");
  324.     let obj = JSON.parse(_obj);
  325.  
  326.     var end = obj.end;
  327.     if (!end || end == -1 || end > Date.now())
  328.         return subbed ? obj : obj.value;
  329.  
  330.     return undefined;
  331. }
  332.  
  333. function getSubCache(cache, id) {
  334.     if (cache[id]) {
  335.         var end = cache[id].end;
  336.         if (end == -1 || end > Date.now())
  337.             return cache[id].value;
  338.     }
  339.  
  340.     return undefined;
  341. }
  342.  
  343. /* General Utilities */
  344.  
  345. function isJsonString(str) {
  346.     if (!str || str == "") return false;
  347.     try {
  348.         JSON.parse(str);
  349.     } catch (e) {
  350.         return false;
  351.     }
  352.     return true;
  353. }
  354.  
  355. /**
  356.  * JavaScript Get URL Parameter (https://www.kevinleary.net/javascript-get-url-parameters/)
  357.  *
  358.  * @param String prop The specific URL parameter you want to retreive the value for
  359.  * @return String|Object If prop is provided a string value is returned, otherwise an object of all properties is returned
  360.  */
  361. function getUrlParams(url, prop) {
  362.     var params = {};
  363.     var search = decodeURIComponent(((url) ? url : window.location.href).slice(window.location.href.indexOf('?') + 1));
  364.     var definitions = search.split('&');
  365.  
  366.     definitions.forEach(function(val, key) {
  367.         var parts = val.split('=', 2);
  368.         params[parts[0]] = parts[1];
  369.     });
  370.  
  371.     return (prop && prop in params) ? params[prop] : params;
  372. }
  373.  
  374. function getSpecialSearch() {
  375.     let hash = window.location.hash;
  376.  
  377.     hash = hash.replace("#/", "?");
  378.     hash = hash.replace("#!", "?");
  379.  
  380.     return hash;
  381. }
  382.  
  383. function stripHtml(html) {
  384.     var tmp = document.createElement("DIV");
  385.     tmp.innerHTML = html;
  386.     var stripped = tmp.textContent || tmp.innerText || "";
  387.  
  388.     stripped = stripped.replaceAll("\n", "");
  389.     stripped = stripped.replaceAll("\t", "");
  390.     stripped = stripped.replaceAll("  ", " ");
  391.  
  392.     return stripped;
  393. }
  394.  
  395. function getNewDay() {
  396.     let now = new Date();
  397.     let newDay = new Date(Date.UTC(now.getFullYear(), now.getMonth(), now.getDate() - 1, 0, 0, 0));
  398.  
  399.     if (Date.now() >= newDay.getTime()) newDay.setUTCDate(newDay.getUTCDate() + 1);
  400.     if (Date.now() >= newDay.getTime()) newDay.setUTCDate(newDay.getUTCDate() + 1);
  401.  
  402.     return newDay;
  403. }
  404.  
  405. function getMillisUntilNewDay() {
  406.     return getNewDay().getTime() - Date.now();
  407. }
  408.  
  409. function _isMobile() {
  410.     return navigator.userAgent.match(/Android/i) ||
  411.         navigator.userAgent.match(/webOS/i) ||
  412.         navigator.userAgent.match(/iPhone/i) ||
  413.         navigator.userAgent.match(/iPad/i) ||
  414.         navigator.userAgent.match(/iPod/i) ||
  415.         navigator.userAgent.match(/BlackBerry/i) ||
  416.         navigator.userAgent.match(/Windows Phone/i);
  417. }
  418.  
  419. function runOnEvent(funct, event, runBefore) {
  420.     if (runBefore) funct();
  421.  
  422.     $(window).bind(event, function() {
  423.         funct();
  424.     });
  425. }
  426.  
  427. function timeSince(timeStamp) {
  428.     let now = new Date();
  429.     let secondsPast = (now.getTime() - timeStamp.getTime()) / 1000;
  430.  
  431.     if (secondsPast < 60) return parseInt(secondsPast) + 's';
  432.     else if (secondsPast < 3600) return parseInt(secondsPast / 60) + 'm';
  433.     else if (secondsPast <= 86400) return parseInt(secondsPast / 3600) + 'h';
  434.     else if (secondsPast > 86400) {
  435.         let day = timeStamp.getDate();
  436.         let month = timeStamp.toDateString().match(/ [a-zA-Z]*/)[0].replace(" ", "");
  437.         let year = timeStamp.getFullYear() == now.getFullYear() ? "" : " " + timeStamp.getFullYear();
  438.         return day + " " + month + year;
  439.     }
  440. }