☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

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

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