☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

此脚本不应直接安装，它是一个供其他脚本使用的外部库。如果您需要使用该库，请在脚本元属性加入：// @require https://update.cn-greasyfork.org/scripts/392610/752829/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.3.6
  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. 		if (!GM_xmlhttpRequest) dkk.fatal("GM_xmlhttpRequest was not found.");
  60. 		
  61. 		this.key = local || localStorage.getItem("dkkutils_apikey");
  62. 		if (!this.isValid()) {
  63. 			dkklog.trace("Asking for the api key.");
  64. 			
  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. 			let createPrompt = () => {
  77. 				if (!$("#dkkapi").length) {
  78. 					dkklog.trace("Creating prompt to ask for api key.");
  79. 					
  80. 					$(selector).after(
  81. 						"<div><article class='dkk-widget' id='dkkapi'><header class='dkk-widget_green dkk-round'><span class='dkk-widget_title'>API Promt</span>"
  82. 						+ "<input type='text' id='dkkapi-promt' style='margin-right: 8px;'><a id='dkkapi-save' class='dkk-button-green' href='#'>Save</a>"
  83. 						+ "</header></article></div><div class='clear'></div>"
  84. 					);
  85. 				}
  86. 				
  87. 				$("#dkkapi-save").click(event => {
  88. 					event.preventDefault();
  89. 					
  90. 					this.key = $("#dkkapi-promt").val();
  91. 					
  92. 					if (this.isValid()) {
  93. 						dkklog.trace("Saving api key.");
  94. 						$("#dkkapi").remove();
  95. 						localStorage.setItem("dkkutils_apikey", this.key);
  96. 						if (callback) callback(this);
  97. 					} else {
  98. 						dkklog.trace("Wrong api key inputted.");
  99. 						$("#dkkapi-promt").val("");
  100. 					}
  101. 				});
  102. 			}
  103. 			
  104. 			if ($(selector).length) createPrompt();
  105. 			else observeMutations(document, selector, true, createPrompt, { childList: true, subtree: true });
  106. 		} else {
  107. 			dkklog.trace("Succesfully retreived api key from localStorage.");
  108. 			if (callback) callback(this);
  109. 		}
  110. 	}
  111. 	
  112. 	isValid() {
  113. 		if (!this.key || this.key === undefined || this.key == "undefined" || this.key === null || this.key == "null" || this.key === "") return false;
  114. 		if (this.key.length != 16) return false;
  115. 		
  116. 		return true;
  117. 	}
  118. 	
  119. 	sendRequest(part, id, selections) {
  120. 		dkklog.debug(`Sending API request to ${part}/${selections} for id ${id}.`);
  121. 		
  122. 		return new Promise((resolve, reject) => {
  123. 			if (!GM_xmlhttpRequest) {
  124. 				dkk.fatal("GM_xmlhttpRequest was not found.")
  125. 				reject("GM_xmlhttpRequest was not found.")
  126. 				return;
  127. 			}
  128. 			GM_xmlhttpRequest({
  129. 				method: "GET",
  130. 				url: `https://api.torn.com/${part}/${id}?selections=${selections}&key=${this.key}`,
  131. 				onreadystatechange: (res) => {
  132. 					if (res.readyState > 3 && res.status === 200) {
  133. 						dkklog.trace("API response received.", res)
  134. 						if (!isJsonString(res.responseText)) {
  135. 							reject("JSON Error", res.responseText);
  136. 							return;
  137. 						}
  138.  
  139. 						let json = JSON.parse(res.responseText);
  140. 						
  141. 						if (json.error) {
  142. 							var code = json.error.code;
  143. 							if (code == 2) {
  144. 								this.key = null;
  145. 								localStorage.removeItem("dkkutils_apikey");
  146. 							}
  147. 							
  148. 							dkklog.warn("A TornAPI error occured.", json.error);
  149. 							reject("API Error: " + code);
  150. 						} else {
  151. 							resolve(json);
  152. 						}
  153. 					}
  154. 				},
  155. 				onerror: function(err) {
  156. 					dkklog.error("An XHR error occured.", err)
  157. 					reject('XHR error.');
  158. 				}
  159. 			})
  160. 		});
  161. 	}
  162. 	
  163. }
  164.  
  165. class CurrentUser {
  166. 	
  167. 	constructor() {
  168. 		if ($("#mainContainer").length) this.update();
  169. 		else observeMutations(document, "#mainContainer", true, this.update, { childList: true, subtree: true });
  170. 	}
  171. 	
  172. 	update() {
  173. 		let body = $("body")
  174. 		let contentWrapper = $("#mainContainer > .content-wrapper");
  175. 		
  176. 		this.isJailed = body.hasClass("jail");
  177. 		this.isHospitalized = body.hasClass("hospital"); // TODO - check based on css ???
  178. 		this.isTravelling = contentWrapper.hasClass("travelling"); // TODO - test
  179. 	}
  180. 	
  181. }
  182.  
  183. class Storage {
  184. 	
  185. 	constructor(key, type) {
  186. 		this.key = key;
  187. 		
  188. 		if (!type) type = "localStorage";
  189.  
  190. 		// - localStorage
  191. 		// - GM
  192. 		
  193. 		this.type = type;
  194. 		
  195. 		this.validate();
  196. 	}
  197. 	
  198. 	validate() {
  199. 		switch (this.type) {
  200. 			case "GM":
  201. 				if (!GM_setValue) dkk.fatal("GM_setValue was not found.");
  202. 				if (!GM_getValue) dkk.fatal("GM_getValue was not found.");
  203. 				if (!GM_deleteValue) dkk.error("GM_deleteValue was not found.");
  204. 				break;
  205. 		}
  206. 	}
  207. 	
  208. 	get(defaultObject) {
  209. 		switch (this.type) {
  210. 			case "GM":
  211. 				return new Promise(async (resolve, reject) => {
  212. 					let val = await GM_getValue(this.key);
  213. 					
  214. 					if (!val) val = defaultObject;
  215. 					else if (isJsonString(val)) {
  216. 						val = JSON.parse(val);
  217. 						
  218. 						if (val.expire && val.expire != -1 && val.expire > Date.now()) {
  219. 							resolve();
  220. 							return;
  221. 						}
  222. 						
  223. 						val = val.value;
  224. 					}
  225. 					
  226. 					resolve(val);
  227. 				});
  228. 				
  229. 				break;
  230. 			case "localStorage":
  231. 				let val = localStorage.getItem(this.key);
  232. 			
  233. 			    if (!val) val = defaultObject;
  234. 				else if (isJsonString(val)) {
  235. 					val = JSON.parse(val);
  236. 					
  237. 					if (val.expire && val.expire != -1 && val.expire > Date.now()) return null;
  238. 					
  239. 					val = val.value;
  240. 				}
  241. 			
  242. 				return val;
  243. 			default:
  244. 				return;
  245. 		}
  246. 	}
  247. 	
  248. 	set(value, time) {
  249. 		let type = typeof value;
  250. 		// if ((type != "string" && type != "number" && type != boolean))
  251. 		
  252. 		let store = { value: value };
  253. 		if (time) store.expire = Date.now() + time;
  254. 		
  255. 		store = JSON.stringify(store);
  256. 		
  257. 		switch (this.type) {
  258. 			case "GM":
  259. 				GM_setValue(this.key, store);
  260. 				break;
  261. 			case "localStorage":
  262. 				localStorage.setItem(this.key, store);
  263. 				break;
  264. 		}
  265. 	}
  266. 	
  267. 	remove() {
  268. 		switch (this.type) {
  269. 			case "GM":
  270. 				GM_deleteValue(this.key);
  271. 				break;
  272. 			case "localStorage":
  273. 				localStorage.removeItem(this.key);
  274. 				break;
  275. 		}
  276. 	}
  277. 	
  278. }
  279.  
  280. /* Script Setup */
  281. var dkklog = new DKKLog("[DKK]", 2);
  282.  
  283. loadCSS();
  284. addFunctions();
  285.  
  286. if (!unsafeWindow.scripts) unsafeWindow.scripts = { ids: [] };
  287.  
  288. function loadCSS() {
  289. 	addCSS("main",
  290. 		".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; } "
  291. 		+ ".dkk-button-green { background-color: rgba(255, 255, 255, 0.15); color: rgb(255, 255, 255); }"
  292. 		+ ".dkk-widget { margin-top: 10px; }"
  293.         + ".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; } "
  294.         + ".dkk-widget_green { background-color: rgb(144, 176, 46); }"
  295.         + ".dkk-widget_red { background-color: rgb(251, 0, 25); }"
  296. 		+ ".dkk-widget_title { flex-grow: 1; box-sizing: border-box; }"
  297.         + ".dkk-widget_body { display: flex; padding: 0px; line-height: 1.4; background-color: rgb(242, 242, 242); }"
  298.         + ".dkk-round-bottom { border-radius: 0 0 10px 10px; }"
  299.         + ".dkk-round { border-radius: 5px; }"
  300.         + ".dkk-panel-left, .dkk-panel-right, .dkk-panel-middle { flex: 1 0 0px; max-height: 120px; overflow: auto; min-height: 60px; }"
  301.         + ".dkk-panel-left { border-left: 1px solid transparent; }"
  302.         + ".dkk-panel-middle { display: flex-direction: column; }"
  303.         + ".dkk-panel-right { display: flex-direction: column; border-radius: 0 0 5px 5px; }"
  304.         + ".dkk-data-table { width: 100%; height: 100%; border-collapse: separate; text-align: left; }"
  305.         + ".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)); }"
  306.         + ".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); }"
  307. 	)
  308. }
  309.  
  310. function addFunctions() {
  311. 	// formating for numbers
  312.     Number.prototype.format = function(n, x) {
  313.         var re = '\\d(?=(\\d{' + (x || 3) + '})+' + (n > 0 ? '\\.' : '$') + ')';
  314.         return this.toFixed(Math.max(0, ~~n)).replace(new RegExp(re, 'g'), '$&,');
  315.     };
  316. 	
  317. 	// string functions
  318.     String.prototype.replaceAll = function(text, replace) {
  319.         let str = this.toString();
  320. 		
  321. 	while (str.includes(text)) { str = str.replace(text, replace); }
  322. 		
  323.         return str;
  324.     };
  325. }
  326.  
  327. function initScript(options) {
  328. 	// some easy name conversion
  329.     if (options.name) {
  330. 		if (!options.id) options.id = options.name.replaceAll(" ", "").toLowerCase();
  331. 		if (!options.abbr) options.abbr = options.name;
  332. 	}
  333. 	if (!options.logging) {
  334. 		options.logging = "WARN";
  335. 	}
  336. 	
  337. 	unsafeWindow.scripts.ids.push(options.id);
  338.     unsafeWindow.scripts[options.id] = {
  339.         name: options.name,
  340.         abbr: options.abbr
  341.     };
  342. 	
  343. 	dkklog.prefix = "[" + options.abbr + "]";
  344. 	dkklog.level = options.logging;
  345. }
  346.  
  347. /* Torn General*/
  348. function getScriptUser() {
  349.     let body = $("body")
  350.     let contentWrapper = $("#mainContainer > .content-wrapper");
  351.  
  352.     return {
  353.         isJailed: body.hasClass("jail"),
  354.         isHospitalized: body.hasClass("hospital"),
  355.         isTravelling: contentWrapper.hasClass("travelling")
  356.     }
  357. }
  358.  
  359. /* Networking */
  360.  
  361. function xhrIntercept(callback) {
  362.     let oldXHROpen = window.XMLHttpRequest.prototype.open;
  363.     window.XMLHttpRequest.prototype.open = function() {
  364.         this.addEventListener('readystatechange', function() {
  365.             if (this.readyState > 3 && this.status == 200) {
  366.                 var page = this.responseURL.substring(this.responseURL.indexOf("torn.com/") + "torn.com/".length, this.responseURL.indexOf(".php"));
  367.  
  368.                 var json, uri;
  369.                 if (isJsonString(this.response)) json = JSON.parse(this.response);
  370.                 else uri = getUrlParams(this.responseURL);
  371.  
  372.                 callback(page, json, uri, this);
  373.             }
  374.         });
  375.  
  376.         return oldXHROpen.apply(this, arguments);
  377.     }
  378. }
  379.  
  380. function ajax(callback) {
  381.     $(document).ajaxComplete((event, xhr, settings) => {
  382.         if (xhr.readyState > 3 && xhr.status == 200) {
  383.             if (settings.url.indexOf("torn.com/") < 0) settings.url = "torn.com" + (settings.url.startsWith("/") ? "" : "/") + settings.url;
  384.             var page = settings.url.substring(settings.url.indexOf("torn.com/") + "torn.com/".length, settings.url.indexOf(".php"));
  385.  
  386.             var json, uri;
  387.             if (isJsonString(xhr.responseText)) json = JSON.parse(xhr.responseText);
  388.             else uri = getUrlParams(settings.url);
  389.  
  390.             callback(page, json, uri, xhr, settings);
  391.         }
  392.     });
  393. }
  394.  
  395. function interceptFetch(url, callback) {
  396.     unsafeWindow.fetch = async (input, options) => {
  397.         const response = await fetch(input, options)
  398.  
  399.         if (response.url.startsWith("https://www.torn.com/" + url)) {
  400.             let res = response.clone();
  401.  
  402.             Promise.resolve(res.json().then((json) => callback(json, res.url)));
  403.         }
  404.  
  405.         return response;
  406.     }
  407. }
  408.  
  409. /* DOM */
  410. function observeMutationsFull(root, callback, options) {
  411.     if (!options) options = {
  412.         childList: true
  413.     };
  414.  
  415.     new MutationObserver(callback).observe(root, options);
  416. }
  417.  
  418. function observeMutations(root, selector, runOnce, callback, options, callbackRemoval) {
  419.     var ran = false;
  420.     observeMutationsFull(root, function(mutations, me) {
  421.         var check = $(selector);
  422.  
  423.         if (check.length) {
  424.             if (runOnce) me.disconnect();
  425.  
  426.             ran = true;
  427.             callback(mutations, me);
  428.         } else if (ran) {
  429.             ran = false;
  430.             if (callbackRemoval) callbackRemoval(mutations, me);
  431.         }
  432.     }, options);
  433. }
  434.  
  435. /* Caching - outdated */
  436. function setCache(key, value, time, sub) {
  437.     var end = time == -1 ? -1 : Date.now() + time;
  438.  
  439.     var obj = sub ? value : {
  440.         value: value,
  441.         end: Date.now() + time
  442.     };
  443.  
  444.     GM_setValue(key, JSON.stringify(obj));
  445. }
  446.  
  447. async function getCache(key, subbed) {
  448.     let _obj = await GM_getValue(key, subbed ? "{}" : "{\"end\":0}");
  449.     let obj = JSON.parse(_obj);
  450.  
  451.     var end = obj.end;
  452.     if (!end || end == -1 || end > Date.now())
  453.         return subbed ? obj : obj.value;
  454.  
  455.     return undefined;
  456. }
  457.  
  458. function getSubCache(cache, id) {
  459.     if (cache[id]) {
  460.         var end = cache[id].end;
  461.         if (end == -1 || end > Date.now())
  462.             return cache[id].value;
  463.     }
  464.  
  465.     return undefined;
  466. }
  467.  
  468. /* General Utilities */
  469. function addCSS(id, css) {
  470. 	if ($("#dkkcss-" + id).length) return;
  471. 	if (!$("#dkkcss").length) $("head").append("<div id='dkkcss'></div>")
  472. 	
  473. 	$("#dkkcss").append(`<style id='dkkcss-${id}'>${css}</style`);
  474. }
  475.  
  476. function removeCSS(idd) {
  477. 	$("#dkkcss-" + id).remove();
  478. }
  479.  
  480. function isJsonString(str) {
  481.     if (!str || str == "") return false;
  482.     try {
  483.         JSON.parse(str);
  484.     } catch (e) {
  485.         return false;
  486.     }
  487.     return true;
  488. }
  489.  
  490. /**
  491.  * JavaScript Get URL Parameter (https://www.kevinleary.net/javascript-get-url-parameters/)
  492.  *
  493.  * @param String prop The specific URL parameter you want to retreive the value for
  494.  * @return String|Object If prop is provided a string value is returned, otherwise an object of all properties is returned
  495.  */
  496. function getUrlParams(url, prop) {
  497.     var params = {};
  498.     var search = decodeURIComponent(((url) ? url : window.location.href).slice(window.location.href.indexOf('?') + 1));
  499.     var definitions = search.split('&');
  500.  
  501.     definitions.forEach(function(val, key) {
  502.         var parts = val.split('=', 2);
  503.         params[parts[0]] = parts[1];
  504.     });
  505.  
  506.     return (prop && prop in params) ? params[prop] : params;
  507. }
  508.  
  509. function getSpecialSearch() {
  510.     let hash = window.location.hash;
  511.  
  512.     hash = hash.replace("#/", "?");
  513.     hash = hash.replace("#!", "?");
  514.  
  515.     return hash;
  516. }
  517.  
  518. function stripHtml(html) {
  519.     var tmp = document.createElement("DIV");
  520.     tmp.innerHTML = html;
  521.     var stripped = tmp.textContent || tmp.innerText || "";
  522.  
  523.     stripped = stripped.replaceAll("\n", "");
  524.     stripped = stripped.replaceAll("\t", "");
  525.     stripped = stripped.replaceAll("  ", " ");
  526.  
  527.     return stripped;
  528. }
  529.  
  530. function getNewDay() {
  531.     let now = new Date();
  532.     let newDay = new Date(Date.UTC(now.getFullYear(), now.getMonth(), now.getDate() - 1, 0, 0, 0));
  533.  
  534.     if (Date.now() >= newDay.getTime()) newDay.setUTCDate(newDay.getUTCDate() + 1);
  535.     if (Date.now() >= newDay.getTime()) newDay.setUTCDate(newDay.getUTCDate() + 1);
  536.  
  537.     return newDay;
  538. }
  539.  
  540. function getMillisUntilNewDay() {
  541.     return getNewDay().getTime() - Date.now();
  542. }
  543.  
  544. function _isMobile() {
  545.     return navigator.userAgent.match(/Android/i) ||
  546.         navigator.userAgent.match(/webOS/i) ||
  547.         navigator.userAgent.match(/iPhone/i) ||
  548.         navigator.userAgent.match(/iPad/i) ||
  549.         navigator.userAgent.match(/iPod/i) ||
  550.         navigator.userAgent.match(/BlackBerry/i) ||
  551.         navigator.userAgent.match(/Windows Phone/i);
  552. }
  553.  
  554. function runOnEvent(funct, event, runBefore) {
  555.     if (runBefore) funct();
  556.  
  557.     $(window).bind(event, function() {
  558.         funct();
  559.     });
  560. }
  561.  
  562. function timeSince(timeStamp) {
  563.     let now = new Date();
  564.     let secondsPast = (now.getTime() - timeStamp.getTime()) / 1000;
  565.  
  566.     if (secondsPast < 60) return parseInt(secondsPast) + 's';
  567.     else if (secondsPast < 3600) return parseInt(secondsPast / 60) + 'm';
  568.     else if (secondsPast <= 86400) return parseInt(secondsPast / 3600) + 'h';
  569.     else if (secondsPast > 86400) {
  570.         let day = timeStamp.getDate();
  571.         let month = timeStamp.toDateString().match(/ [a-zA-Z]*/)[0].replace(" ", "");
  572.         let year = timeStamp.getFullYear() == now.getFullYear() ? "" : " " + timeStamp.getFullYear();
  573.         return day + " " + month + year;
  574.     }
  575. }