☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

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

此脚本不应直接安装。它是供其他脚本使用的外部库，要使用该库请加入元指令 // @require https://update.cn-greasyfork.org/scripts/392610/750734/DKK%20Torn%20Utilities%20DEVELOPMENT.js 

  1. // ==UserScript==
  2. // @name        DKK Torn Utilities DEVELOPMENT
  3. // @description Commonly used functions in my Torn scripts.
  4. // @version     1.8.7
  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. addFunctions();
  12.  
  13. function addFunctions() {
  14. 	// formating for numbers
  15.     Number.prototype.format = function(n, x) {
  16.         var re = '\\d(?=(\\d{' + (x || 3) + '})+' + (n > 0 ? '\\.' : '$') + ')';
  17.         return this.toFixed(Math.max(0, ~~n)).replace(new RegExp(re, 'g'), '$&,');
  18.     };
  19. }
  20.  
  21. function initScript(options) {
  22. 	// some easy name conversion
  23.     if (options.name) {
  24. 		if (!options.id) options.id = replaceAll(options.name, " ", "").toLowerCase();
  25. 		if (!options.abbr) options.abbr = "";
  26. 	}
  27. 	if (!options.logging) {
  28. 		options.logging = "ERROR";
  29. 	}
  30. 	
  31. 	// actually init
  32. 	if (options.api){
  33. 		if (options.apikey) _setAPI(options.apikey);
  34.         requireAPI();
  35. 	}
  36. 	
  37. 	if (!window.scripts) window.scripts = { ids: [] };
  38. 	window.scripts.ids.push(options.id);
  39.     window.scripts[options.id] = {
  40.         name: options.name,
  41.         abbr: options.short,
  42.         api: options.api ? true : false
  43.     };
  44. 	
  45. 	dkklog.level = dkklog.levels[options.logging];
  46. 	dkklog.prefix = "[" + options.abbr + "]";
  47. }
  48.  
  49. /* Messaging */
  50. var dkklog = {
  51. 	prefix: "[DKK]",
  52. 	level: 2, // show warnings by default 
  53. 	
  54. 	levels: {
  55. 		FATAL: 0,
  56. 		ERROR: 1,
  57. 		WARN: 2,
  58. 		INFO: 3,
  59. 		DEBUG: 4,
  60. 		TRACE: 5,
  61. 		ALL: 6,
  62. 		OFF: 7
  63. 	},
  64. 	
  65. 	logging: function (level, message, ...objs) {
  66. 		if (dkklog.loggingLevel < dkklog.levels[level]) return;
  67.  
  68. 		let msg = `${Object.getOwnPropertyNames(dkklog.levels)[dkklog.prefix]}[${dkklog.level}] ${message}`;
  69.  
  70. 		if (objs.length > 0) {
  71. 			console.log(msg, ...objs);
  72. 		} else {
  73. 			console.log(msg);
  74. 		}
  75.  
  76. 	},
  77. 	fatal: function (message) { dkklog.logging("FATAL", message); },
  78. 	error: (message) => dkklog.logging("ERROR", message),
  79. 	warn: (message) => dkklog.logging("WARN", message),
  80. 	info: (message) => dkklog.logging("INFO", message),
  81. 	debug: function (message, ...objs) { dkklog.logging("DEBUG", message, objs); },
  82. 	trace: (message) => dkklog.logging("TRACE", message),
  83. 	all: (message) => dkklog.logging("ALL", message)
  84. }
  85.  
  86. /* Torn API */
  87. var apiKey;
  88.  
  89. const API_LENGTH = 16;
  90. const STORAGE_LOCATION = "dkkutils_apikey";
  91.  
  92. function requireAPI() {
  93.     dkklog.debug("Require API")
  94.     apiKey = getAPI();
  95.     if (!_isValidAPIKey(apiKey)) {
  96.         dkklog.debug("Require API - no valid api found")
  97.         let response = prompt("Please enter your API key: ");
  98.         if (_isValidAPIKey(response)) {
  99.             setAPI(response);
  100.         } else {
  101.             dkklog.debug("Require API - no valid api given")
  102.             alert("Given API key was not valid, script might not work.\nRefresh to try again.")
  103.         }
  104.     }
  105. }
  106.  
  107. function _isValidAPIKey(key) {
  108.     if (!key) key = apiKey;
  109.  
  110.     if (!key || key === undefined || key == "undefined" || key === null || key == "null" || key === "") return false;
  111.     if (key.length != API_LENGTH) return false;
  112.  
  113.     return true;
  114. }
  115.  
  116. function sendAPIRequest(part, id, selections, key) {
  117.     dkklog.debug(`Sending API request to ${part}/${selections} on id ${id}`);
  118.     if (!key) key = apiKey;
  119.  
  120.     return new Promise((resolve, reject) => {
  121.         GM_xmlhttpRequest({
  122.             method: "GET",
  123.             url: `https://api.torn.com/${part}/${id}?selections=${selections}&key=${key}`,
  124.             onreadystatechange: function(res) {
  125.                 if (res.readyState > 3 && res.status === 200) {
  126.                     dkklog.debug("API response received.")
  127.                     if (!isJsonString(res.responseText)) {
  128.                         reject("JSON Error", res.responseText);
  129.                         return;
  130.                     }
  131.  
  132.                     var json = JSON.parse(res.responseText);
  133.                     resolve(json);
  134.  
  135.                     if (json.error) {
  136.                         var code = json.error.code;
  137.                         dkklog.debug("API Error: " + code)
  138.                         if (code == 2) setAPI(null);
  139.                     }
  140.                 }
  141.             },
  142.             onerror: function(err) {
  143.                 console.log(err);
  144.                 reject('XHR error.');
  145.             }
  146.         })
  147.     }).catch(e => {
  148.         console.log(e);
  149.     });
  150. }
  151.  
  152. function setAPI(key) {
  153.     if (!_isValidAPIKey(key)) {
  154.         localStorage.removeItem(STORAGE_LOCATION);
  155.         dkklog.debug("Removed key from storage.")
  156.     } else {
  157.         localStorage.setItem(STORAGE_LOCATION, key);
  158.         dkklog.debug(`Added key '${key}' to storage. '${localStorage.getItem(STORAGE_LOCATION)}'`)
  159.     }
  160.  
  161.     apiKey = key;
  162. }
  163.  
  164. function _setAPI(key) {
  165.     if (!_isValidAPIKey(key)) localStorage.removeItem(STORAGE_LOCATION);
  166.     else localStorage.setItem(STORAGE_LOCATION, key);
  167.  
  168.     apiKey = key;
  169. }
  170.  
  171. function getAPI() {
  172.     let utilsKey = localStorage.getItem(STORAGE_LOCATION);
  173.     if (_isValidAPIKey(utilsKey)) {
  174.         dkklog.debug("getAPI - from own storage '" + utilsKey.length + "'");
  175.         return utilsKey;
  176.     } else {
  177.         dkklog.debug("getAPI - from own storage is invalid '" + utilsKey + "'");
  178.     }
  179.  
  180.     let key = localStorage.getItem("_apiKey") || localStorage.getItem("x_apikey") || localStorage.getItem("jebster.torn") || localStorage.getItem("TornApiKey");
  181.  
  182.     if (_isValidAPIKey(key)) {
  183.         dkklog.debug("getAPI - from other storage");
  184.         setAPI(key);
  185.     } else if (localStorage.getItem("_apiKey")) {
  186.         dkklog.debug("getAPI - removed 1");
  187.         localStorage.removeItem("_apiKey");
  188.     } else if (localStorage.getItem("x_apikey")) {
  189.         dkklog.debug("getAPI - removed 2");
  190.         localStorage.removeItem("x_apikey");
  191.     } else if (localStorage.getItem("jebster.torn")) {
  192.         dkklog.debug("getAPI - removed 3");
  193.         localStorage.removeItem("jebster.torn");
  194.     } else if (localStorage.getItem("_apiKey")) {
  195.         dkklog.debug("getAPI - removed 4");
  196.         localStorage.removeItem("TornApiKey");
  197.     }
  198.  
  199.     return utilsKey;
  200. }
  201.  
  202. /* Torn General*/
  203. function getScriptUser() {
  204.     let body = $("body")
  205.     let contentWrapper = $("#mainContainer > .content-wrapper");
  206.  
  207.     return {
  208.         isJailed: body.hasClass("jail"),
  209.         isHospitalized: body.hasClass("hospital"),
  210.         isTravelling: contentWrapper.hasClass("travelling")
  211.     }
  212. }
  213.  
  214. /* Networking */
  215.  
  216. function xhrIntercept(callback) {
  217.     let oldXHROpen = window.XMLHttpRequest.prototype.open;
  218.     window.XMLHttpRequest.prototype.open = function() {
  219.         this.addEventListener('readystatechange', function() {
  220.             if (this.readyState > 3 && this.status == 200) {
  221.                 var page = this.responseURL.substring(this.responseURL.indexOf("torn.com/") + "torn.com/".length, this.responseURL.indexOf(".php"));
  222.  
  223.                 var json, uri;
  224.                 if (isJsonString(this.response)) json = JSON.parse(this.response);
  225.                 else uri = getUrlParams(this.responseURL);
  226.  
  227.                 callback(page, json, uri, this);
  228.             }
  229.         });
  230.  
  231.         return oldXHROpen.apply(this, arguments);
  232.     }
  233. }
  234.  
  235. function ajax(callback) {
  236.     $(document).ajaxComplete((event, xhr, settings) => {
  237.         if (xhr.readyState > 3 && xhr.status == 200) {
  238.             if (settings.url.indexOf("torn.com/") < 0) settings.url = "torn.com" + (settings.url.startsWith("/") ? "" : "/") + settings.url;
  239.             var page = settings.url.substring(settings.url.indexOf("torn.com/") + "torn.com/".length, settings.url.indexOf(".php"));
  240.  
  241.             var json, uri;
  242.             if (isJsonString(xhr.responseText)) json = JSON.parse(xhr.responseText);
  243.             else uri = getUrlParams(settings.url);
  244.  
  245.             callback(page, json, uri, xhr, settings);
  246.         }
  247.     });
  248. }
  249.  
  250. function interceptFetch(url, callback) {
  251.     unsafeWindow.fetch = async (input, options) => {
  252.         const response = await fetch(input, options)
  253.  
  254.         if (response.url.startsWith("https://www.torn.com/" + url)) {
  255.             let res = response.clone();
  256.  
  257.             Promise.resolve(res.json().then((json) => callback(json, res.url)));
  258.         }
  259.  
  260.         return response;
  261.     }
  262. }
  263.  
  264. /* DOM */
  265. function observeMutationsFull(root, callback, options) {
  266.     if (!options) options = {
  267.         childList: true
  268.     };
  269.  
  270.     new MutationObserver(callback).observe(root, options);
  271. }
  272.  
  273. function observeMutations(root, selector, runOnce, callback, options, callbackRemoval) {
  274.     var ran = false;
  275.     observeMutationsFull(root, function(mutations, me) {
  276.         var check = $(selector);
  277.  
  278.         if (check.length) {
  279.             if (runOnce) me.disconnect();
  280.  
  281.             ran = true;
  282.             callback(mutations, me);
  283.         } else if (ran) {
  284.             ran = false;
  285.             if (callbackRemoval) callbackRemoval(mutations, me);
  286.         }
  287.     }, options);
  288. }
  289.  
  290. /* Caching */
  291. function setCache(key, value, time, sub) {
  292.     var end = time == -1 ? -1 : Date.now() + time;
  293.  
  294.     var obj = sub ? value : {
  295.         value: value,
  296.         end: Date.now() + time
  297.     };
  298.  
  299.     GM_setValue(key, JSON.stringify(obj));
  300. }
  301.  
  302. async function getCache(key, subbed) {
  303.     let _obj = await GM_getValue(key, subbed ? "{}" : "{\"end\":0}");
  304.     let obj = JSON.parse(_obj);
  305.  
  306.     var end = obj.end;
  307.     if (!end || end == -1 || end > Date.now())
  308.         return subbed ? obj : obj.value;
  309.  
  310.     return undefined;
  311. }
  312.  
  313. function getSubCache(cache, id) {
  314.     if (cache[id]) {
  315.         var end = cache[id].end;
  316.         if (end == -1 || end > Date.now())
  317.             return cache[id].value;
  318.     }
  319.  
  320.     return undefined;
  321. }
  322.  
  323. /* General Utilities */
  324.  
  325. function isJsonString(str) {
  326.     if (!str || str == "") return false;
  327.     try {
  328.         JSON.parse(str);
  329.     } catch (e) {
  330.         return false;
  331.     }
  332.     return true;
  333. }
  334.  
  335. /**
  336.  * JavaScript Get URL Parameter (https://www.kevinleary.net/javascript-get-url-parameters/)
  337.  *
  338.  * @param String prop The specific URL parameter you want to retreive the value for
  339.  * @return String|Object If prop is provided a string value is returned, otherwise an object of all properties is returned
  340.  */
  341. function getUrlParams(url, prop) {
  342.     var params = {};
  343.     var search = decodeURIComponent(((url) ? url : window.location.href).slice(window.location.href.indexOf('?') + 1));
  344.     var definitions = search.split('&');
  345.  
  346.     definitions.forEach(function(val, key) {
  347.         var parts = val.split('=', 2);
  348.         params[parts[0]] = parts[1];
  349.     });
  350.  
  351.     return (prop && prop in params) ? params[prop] : params;
  352. }
  353.  
  354. function getSpecialSearch() {
  355.     let hash = window.location.hash;
  356.  
  357.     hash = hash.replace("#/", "?");
  358.     hash = hash.replace("#!", "?");
  359.  
  360.     return hash;
  361. }
  362.  
  363. function replaceAll(str, text, replace) {
  364.     while (contains(str, text)) {
  365.         str = str.replace(text, replace);
  366.     }
  367.     return str;
  368. }
  369.  
  370. function contains(str, text) {
  371.     return str.indexOf(text) >= 0;
  372. }
  373.  
  374. function stripHtml(html) {
  375.     var tmp = document.createElement("DIV");
  376.     tmp.innerHTML = html;
  377.     var stripped = tmp.textContent || tmp.innerText || "";
  378.  
  379.     stripped = replaceAll(stripped, "\n", "");
  380.     stripped = replaceAll(stripped, "\t", "");
  381.     stripped = replaceAll(stripped, "  ", " ");
  382.  
  383.     return stripped;
  384. }
  385.  
  386. function getNewDay() {
  387.     let now = new Date();
  388.     let newDay = new Date(Date.UTC(now.getFullYear(), now.getMonth(), now.getDate() - 1, 0, 0, 0));
  389.  
  390.     if (Date.now() >= newDay.getTime()) newDay.setUTCDate(newDay.getUTCDate() + 1);
  391.     if (Date.now() >= newDay.getTime()) newDay.setUTCDate(newDay.getUTCDate() + 1);
  392.  
  393.     return newDay;
  394. }
  395.  
  396. function getMillisUntilNewDay() {
  397.     return getNewDay().getTime() - Date.now();
  398. }
  399.  
  400. function _isMobile() {
  401.     return navigator.userAgent.match(/Android/i) ||
  402.         navigator.userAgent.match(/webOS/i) ||
  403.         navigator.userAgent.match(/iPhone/i) ||
  404.         navigator.userAgent.match(/iPad/i) ||
  405.         navigator.userAgent.match(/iPod/i) ||
  406.         navigator.userAgent.match(/BlackBerry/i) ||
  407.         navigator.userAgent.match(/Windows Phone/i);
  408. }
  409.  
  410. function runOnEvent(funct, event, runBefore) {
  411.     if (runBefore) funct();
  412.  
  413.     $(window).bind(event, function() {
  414.         funct();
  415.     });
  416. }
  417.  
  418. function timeSince(timeStamp) {
  419.     let now = new Date();
  420.     let secondsPast = (now.getTime() - timeStamp.getTime()) / 1000;
  421.  
  422.     if (secondsPast < 60) return parseInt(secondsPast) + 's';
  423.     else if (secondsPast < 3600) return parseInt(secondsPast / 60) + 'm';
  424.     else if (secondsPast <= 86400) return parseInt(secondsPast / 3600) + 'h';
  425.     else if (secondsPast > 86400) {
  426.         let day = timeStamp.getDate();
  427.         let month = timeStamp.toDateString().match(/ [a-zA-Z]*/)[0].replace(" ", "");
  428.         let year = timeStamp.getFullYear() == now.getFullYear() ? "" : " " + timeStamp.getFullYear();
  429.         return day + " " + month + year;
  430.     }
  431. }