☰

DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

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

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