☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

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

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