DKK Torn Utilities DEVELOPMENT

Commonly used functions in my Torn scripts.

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

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