chore: rename fundamentals to base (#9119)

2026-08-02 18:09:58 +08:00 · 2024-12-13 06:27:12 +00:00
parent 8c24f2b906
commit 4c23991047
185 changed files with 183 additions and 193 deletions
@@ -0,0 +1,96 @@
+import { isIP } from 'node:net';
+
+import { Injectable } from '@nestjs/common';
+import type { Response } from 'express';
+
+import { Config } from '../config';
+
+@Injectable()
+export class URLHelper {
+  private readonly redirectAllowHosts: string[];
+
+  readonly origin: string;
+  readonly baseUrl: string;
+  readonly home: string;
+
+  constructor(private readonly config: Config) {
+    if (this.config.server.externalUrl) {
+      if (!this.verify(this.config.server.externalUrl)) {
+        throw new Error(
+          'Invalid `server.externalUrl` configured. It must be a valid url.'
+        );
+      }
+
+      const externalUrl = new URL(this.config.server.externalUrl);
+
+      this.origin = externalUrl.origin;
+      this.baseUrl =
+        externalUrl.origin + externalUrl.pathname.replace(/\/$/, '');
+    } else {
+      this.origin = [
+        this.config.server.https ? 'https' : 'http',
+        '://',
+        this.config.server.host,
+        this.config.server.host === 'localhost' || isIP(this.config.server.host)
+          ? `:${this.config.server.port}`
+          : '',
+      ].join('');
+      this.baseUrl = this.origin + this.config.server.path;
+    }
+
+    this.home = this.baseUrl;
+    this.redirectAllowHosts = [this.baseUrl];
+  }
+
+  stringify(query: Record<string, any>) {
+    return new URLSearchParams(query).toString();
+  }
+
+  url(path: string, query: Record<string, any> = {}) {
+    const url = new URL(path, this.origin);
+
+    for (const key in query) {
+      url.searchParams.set(key, query[key]);
+    }
+
+    return url;
+  }
+
+  link(path: string, query: Record<string, any> = {}) {
+    return this.url(path, query).toString();
+  }
+
+  safeRedirect(res: Response, to: string) {
+    try {
+      const finalTo = new URL(decodeURIComponent(to), this.baseUrl);
+
+      for (const host of this.redirectAllowHosts) {
+        const hostURL = new URL(host);
+        if (
+          hostURL.origin === finalTo.origin &&
+          finalTo.pathname.startsWith(hostURL.pathname)
+        ) {
+          return res.redirect(finalTo.toString().replace(/\/$/, ''));
+        }
+      }
+    } catch {
+      // just ignore invalid url
+    }
+
+    // redirect to home if the url is invalid
+    return res.redirect(this.home);
+  }
+
+  verify(url: string | URL) {
+    try {
+      if (typeof url === 'string') {
+        url = new URL(url);
+      }
+      if (!['http:', 'https:'].includes(url.protocol)) return false;
+      if (!url.hostname) return false;
+      return true;
+    } catch {
+      return false;
+    }
+  }
+}