src/webui/www/private/scripts/misc.js

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2014  Gabriele <pmzqla.git@gmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 "use strict";
  30
  31 window.qBittorrent ??= {};
  32 window.qBittorrent.Misc ??= (() => {
  33     const exports = () => {
  34         return {
  35             createDebounceHandler: createDebounceHandler,
  36             friendlyUnit: friendlyUnit,
  37             friendlyDuration: friendlyDuration,
  38             friendlyPercentage: friendlyPercentage,
  39             friendlyFloat: friendlyFloat,
  40             parseHtmlLinks: parseHtmlLinks,
  41             parseVersion: parseVersion,
  42             escapeHtml: escapeHtml,
  43             naturalSortCollator: naturalSortCollator,
  44             safeTrim: safeTrim,
  45             toFixedPointString: toFixedPointString,
  46             containsAllTerms: containsAllTerms,
  47             sleep: sleep,
  48             // variables
  49             FILTER_INPUT_DELAY: 400,
  50             MAX_ETA: 8640000
  51         };
  52     };
  53
  54     const createDebounceHandler = (delay, func) => {
  55         let timer = -1;
  56         return (...params) => {
  57             clearTimeout(timer);
  58             timer = setTimeout(() => {
  59                 func(...params);
  60
  61                 timer = -1;
  62             }, delay);
  63         };
  64     };
  65
  66     /*
  67      * JS counterpart of the function in src/misc.cpp
  68      */
  69     const friendlyUnit = function(value, isSpeed) {
  70         const units = [
  71             "QBT_TR(B)QBT_TR[CONTEXT=misc]",
  72             "QBT_TR(KiB)QBT_TR[CONTEXT=misc]",
  73             "QBT_TR(MiB)QBT_TR[CONTEXT=misc]",
  74             "QBT_TR(GiB)QBT_TR[CONTEXT=misc]",
  75             "QBT_TR(TiB)QBT_TR[CONTEXT=misc]",
  76             "QBT_TR(PiB)QBT_TR[CONTEXT=misc]",
  77             "QBT_TR(EiB)QBT_TR[CONTEXT=misc]"
  78         ];
  79
  80         if ((value === undefined) || (value === null) || (value < 0))
  81             return "QBT_TR(Unknown)QBT_TR[CONTEXT=misc]";
  82
  83         let i = 0;
  84         while ((value >= 1024.0) && (i < 6)) {
  85             value /= 1024.0;
  86             ++i;
  87         }
  88
  89         function friendlyUnitPrecision(sizeUnit) {
  90             if (sizeUnit <= 2) // KiB, MiB
  91                 return 1;
  92             else if (sizeUnit === 3) // GiB
  93                 return 2;
  94             else // TiB, PiB, EiB
  95                 return 3;
  96         }
  97
  98         let ret;
  99         if (i === 0) {
 100             ret = value + " " + units[i];
 101         }
 102         else {
 103             const precision = friendlyUnitPrecision(i);
 104             const offset = Math.pow(10, precision);
 105             // Don't round up
 106             ret = (Math.floor(offset * value) / offset).toFixed(precision) + " " + units[i];
 107         }
 108
 109         if (isSpeed)
 110             ret += "QBT_TR(/s)QBT_TR[CONTEXT=misc]";
 111         return ret;
 112     };
 113
 114     /*
 115      * JS counterpart of the function in src/misc.cpp
 116      */
 117     const friendlyDuration = function(seconds, maxCap = -1) {
 118         if ((seconds < 0) || ((seconds >= maxCap) && (maxCap >= 0)))
 119             return "∞";
 120         if (seconds === 0)
 121             return "0";
 122         if (seconds < 60)
 123             return "QBT_TR(< 1m)QBT_TR[CONTEXT=misc]";
 124         let minutes = seconds / 60;
 125         if (minutes < 60)
 126             return "QBT_TR(%1m)QBT_TR[CONTEXT=misc]".replace("%1", Math.floor(minutes));
 127         let hours = minutes / 60;
 128         minutes %= 60;
 129         if (hours < 24)
 130             return "QBT_TR(%1h %2m)QBT_TR[CONTEXT=misc]".replace("%1", Math.floor(hours)).replace("%2", Math.floor(minutes));
 131         let days = hours / 24;
 132         hours %= 24;
 133         if (days < 365)
 134             return "QBT_TR(%1d %2h)QBT_TR[CONTEXT=misc]".replace("%1", Math.floor(days)).replace("%2", Math.floor(hours));
 135         const years = days / 365;
 136         days %= 365;
 137         return "QBT_TR(%1y %2d)QBT_TR[CONTEXT=misc]".replace("%1", Math.floor(years)).replace("%2", Math.floor(days));
 138     };
 139
 140     const friendlyPercentage = function(value) {
 141         let percentage = (value * 100).round(1);
 142         if (isNaN(percentage) || (percentage < 0))
 143             percentage = 0;
 144         if (percentage > 100)
 145             percentage = 100;
 146         return percentage.toFixed(1) + "%";
 147     };
 148
 149     const friendlyFloat = function(value, precision) {
 150         return parseFloat(value).toFixed(precision);
 151     };
 152
 153     /*
 154      * JS counterpart of the function in src/misc.cpp
 155      */
 156     const parseHtmlLinks = function(text) {
 157         const exp = /(\b(https?|ftp|file):\/\/[-\w+&@#/%?=~|!:,.;]*[-\w+&@#/%=~|])/gi;
 158         return text.replace(exp, "<a target='_blank' rel='noopener noreferrer' href='$1'>$1</a>");
 159     };
 160
 161     const parseVersion = function(versionString) {
 162         const failure = {
 163             valid: false
 164         };
 165
 166         if (typeof versionString !== "string")
 167             return failure;
 168
 169         const tryToNumber = (str) => {
 170             const num = Number(str);
 171             return (isNaN(num) ? str : num);
 172         };
 173
 174         const ver = versionString.split(".", 4).map(val => tryToNumber(val));
 175         return {
 176             valid: true,
 177             major: ver[0],
 178             minor: ver[1],
 179             fix: ver[2],
 180             patch: ver[3]
 181         };
 182     };
 183
 184     const escapeHtml = (() => {
 185         const div = document.createElement("div");
 186         return (str) => {
 187             div.textContent = str;
 188             return div.innerHTML;
 189         };
 190     })();
 191
 192     // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator#parameters
 193     const naturalSortCollator = new Intl.Collator(undefined, { numeric: true, usage: "sort" });
 194
 195     const safeTrim = function(value) {
 196         try {
 197             return value.trim();
 198         }
 199         catch (e) {
 200             if (e instanceof TypeError)
 201                 return "";
 202             throw e;
 203         }
 204     };
 205
 206     const toFixedPointString = function(number, digits) {
 207         // Do not round up number
 208         const power = Math.pow(10, digits);
 209         return (Math.floor(power * number) / power).toFixed(digits);
 210     };
 211
 212     /**
 213      *
 214      * @param {String} text the text to search
 215      * @param {Array<String>} terms terms to search for within the text
 216      * @returns {Boolean} true if all terms match the text, false otherwise
 217      */
 218     const containsAllTerms = function(text, terms) {
 219         const textToSearch = text.toLowerCase();
 220         return terms.every((term) => {
 221             const isTermRequired = (term[0] === "+");
 222             const isTermExcluded = (term[0] === "-");
 223             if (isTermRequired || isTermExcluded) {
 224                 // ignore lonely +/-
 225                 if (term.length === 1)
 226                     return true;
 227
 228                 term = term.substring(1);
 229             }
 230
 231             const textContainsTerm = (textToSearch.indexOf(term) !== -1);
 232             return isTermExcluded ? !textContainsTerm : textContainsTerm;
 233         });
 234     };
 235
 236     const sleep = (ms) => {
 237         return new Promise((resolve) => {
 238             setTimeout(resolve, ms);
 239         });
 240     };
 241
 242     return exports();
 243 })();
 244 Object.freeze(window.qBittorrent.Misc);