☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

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

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