uptime-kuma/src/util.ts

221 lines
5.8 KiB
TypeScript
Raw Normal View History

// Common Util for frontend and backend
2021-09-21 13:28:45 +00:00
//
// DOT NOT MODIFY util.js!
// Need to run "tsc" to compile if there are any changes.
//
// Backend uses the compiled file util.js
// Frontend uses util.ts
import * as _dayjs from "dayjs";
const dayjs = _dayjs;
2021-08-16 18:09:40 +00:00
export const isDev = process.env.NODE_ENV === "development";
export const appName = "Uptime Kuma";
export const DOWN = 0;
export const UP = 1;
export const PENDING = 2;
2021-09-16 06:37:57 +00:00
export const STATUS_PAGE_ALL_DOWN = 0;
export const STATUS_PAGE_ALL_UP = 1;
export const STATUS_PAGE_PARTIAL_DOWN = 2;
2021-08-23 03:33:24 +00:00
export function flipStatus(s: number) {
if (s === UP) {
return DOWN;
}
if (s === DOWN) {
return UP;
}
return s;
}
2021-08-23 03:33:24 +00:00
export function sleep(ms: number) {
return new Promise(resolve => setTimeout(resolve, ms));
}
/**
* PHP's ucfirst
* @param str
*/
2021-08-23 03:33:24 +00:00
export function ucfirst(str: string) {
if (!str) {
return str;
}
const firstLetter = str.substr(0, 1);
return firstLetter.toUpperCase() + str.substr(1);
}
2021-11-15 16:52:28 +00:00
function log(module: string, msg: any, level:string) {
2021-11-11 11:31:28 +00:00
module = module.toUpperCase();
level = level.toUpperCase();
const now = new Date().toISOString();
const formattedMessage = (typeof msg === "string") ? `${now} [${module}] ${level}: ${msg}` : msg;
if (level === "INFO") {
2021-11-15 17:02:14 +00:00
console.info(formattedMessage);
2021-11-11 11:31:28 +00:00
} else if (level === "WARN") {
console.warn(formattedMessage);
} else if (level === "ERROR") {
console.error(formattedMessage);
} else if (level === "DEBUG") {
if (isDev) {
console.debug(formattedMessage);
}
} else {
console.log(formattedMessage);
}
}
2021-08-09 05:49:37 +00:00
2021-11-15 16:52:28 +00:00
export function log_info(module: string, msg: any) {
log(module, msg, "info");
}
export function log_warn(module: string, msg: any) {
log(module, msg, "warn");
}
export function log_error(module: string, msg: any) {
log(module, msg, "error");
}
export function log_debug(module: string, msg: any) {
log(module, msg, "debug");
}
2021-08-23 03:33:24 +00:00
declare global { interface String { replaceAll(str: string, newStr: string): string; } }
2021-08-09 05:49:37 +00:00
export function polyfill() {
/**
* String.prototype.replaceAll() polyfill
* https://gomakethings.com/how-to-replace-a-section-of-a-string-with-another-one-with-vanilla-js/
* @author Chris Ferdinandi
* @license MIT
*/
if (!String.prototype.replaceAll) {
2021-08-23 03:33:24 +00:00
String.prototype.replaceAll = function (str: string, newStr: string) {
2021-08-09 05:49:37 +00:00
// If a regex pattern
if (Object.prototype.toString.call(str).toLowerCase() === "[object regexp]") {
return this.replace(str, newStr);
}
// If a string
return this.replace(new RegExp(str, "g"), newStr);
};
}
}
2021-08-16 18:09:40 +00:00
export class TimeLogger {
2021-08-23 03:33:24 +00:00
startTime: number;
2021-08-16 18:09:40 +00:00
constructor() {
this.startTime = dayjs().valueOf();
}
2021-08-23 03:33:24 +00:00
print(name: string) {
2021-10-08 05:35:04 +00:00
if (isDev && process.env.TIMELOGGER === "1") {
2021-08-16 18:09:40 +00:00
console.log(name + ": " + (dayjs().valueOf() - this.startTime) + "ms")
}
}
}
/**
* Returns a random number between min (inclusive) and max (exclusive)
*/
2021-08-23 03:33:24 +00:00
export function getRandomArbitrary(min: number, max: number) {
return Math.random() * (max - min) + min;
}
/**
* From: https://stackoverflow.com/questions/1527803/generating-random-whole-numbers-in-javascript-in-a-specific-range
*
* Returns a random integer between min (inclusive) and max (inclusive).
* The value is no lower than min (or the next integer greater than min
* if min isn't an integer) and no greater than max (or the next integer
* lower than max if max isn't an integer).
* Using Math.round() will give you a non-uniform distribution!
*/
2021-08-23 03:33:24 +00:00
export function getRandomInt(min: number, max: number) {
min = Math.ceil(min);
max = Math.floor(max);
return Math.floor(Math.random() * (max - min + 1)) + min;
}
2021-09-30 16:09:43 +00:00
2021-10-17 23:06:20 +00:00
/**
* Returns either the NodeJS crypto.randomBytes() function or its
* browser equivalent implemented via window.crypto.getRandomValues()
*/
let getRandomBytes = (
(typeof window !== 'undefined' && window.crypto)
// Browsers
? function () {
return (numBytes: number) => {
let randomBytes = new Uint8Array(numBytes);
for (let i = 0; i < numBytes; i += 65536) {
window.crypto.getRandomValues(randomBytes.subarray(i, i + Math.min(numBytes - i, 65536)));
}
return randomBytes;
};
}
// Node
: function() {
return require("crypto").randomBytes;
}
)();
export function getCryptoRandomInt(min: number, max: number):number {
// synchronous version of: https://github.com/joepie91/node-random-number-csprng
const range = max - min
if (range >= Math.pow(2, 32))
console.log("Warning! Range is too large.")
let tmpRange = range
let bitsNeeded = 0
let bytesNeeded = 0
let mask = 1
while (tmpRange > 0) {
if (bitsNeeded % 8 === 0) bytesNeeded += 1
bitsNeeded += 1
mask = mask << 1 | 1
tmpRange = tmpRange >>> 1
}
const randomBytes = getRandomBytes(bytesNeeded)
let randomValue = 0
for (let i = 0; i < bytesNeeded; i++) {
randomValue |= randomBytes[i] << 8 * i
}
randomValue = randomValue & mask;
if (randomValue <= range) {
return min + randomValue
} else {
return getCryptoRandomInt(min, max)
}
}
2021-09-30 16:09:43 +00:00
export function genSecret(length = 64) {
let secret = "";
const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
const charsLength = chars.length;
2021-10-10 19:59:23 +00:00
for ( let i = 0; i < length; i++ ) {
2021-10-10 23:18:33 +00:00
secret += chars.charAt(getCryptoRandomInt(0, charsLength - 1));
2021-09-30 16:09:43 +00:00
}
return secret;
}
export function getMonitorRelativeURL(id: string) {
return "/dashboard/" + id;
}