import escapeRegExp from "lodash/escapeRegExp"; import env from "../env"; import { isBrowser } from "./browser"; import { parseDomain } from "./domains"; /** * Prepends the CDN url to the given path (If a CDN is configured). * * @param path The path to prepend the CDN url to. * @returns The path with the CDN url prepended. */ export function cdnPath(path: string): string { return `${env.CDN_URL ?? ""}${path}`; } /** * Extracts the file name from a given url. * * @param url The url to extract the file name from. * @returns The file name. */ export function fileNameFromUrl(url: string) { try { const parsed = new URL(url); return parsed.pathname.split("/").pop(); } catch (_err) { return; } } /** * Returns true if the given string is a link to inside the application. * * @param url The url to check. * @returns True if the url is internal, false otherwise. */ export function isInternalUrl(href: string) { // empty strings are never internal if (href === "") { return false; } // relative paths are always internal if (href[0] === "/") { return true; } const outline = isBrowser ? parseDomain(window.location.href) : parseDomain(env.URL); const domain = parseDomain(href); return ( (outline.host === domain.host && outline.port === domain.port) || (isBrowser && window.location.hostname === domain.host && window.location.port === domain.port) ); } /** * Returns true if the given string is a link to a documement. * * @param options Parsing options. * @returns True if a document, false otherwise. */ export function isDocumentUrl(url: string) { try { const parsed = new URL(url, env.URL); return ( isInternalUrl(url) && (parsed.pathname.startsWith("/doc/") || parsed.pathname.startsWith("/d/")) ); } catch (_err) { return false; } } /** * Returns true if the given string is a link to a collection. * * @param options Parsing options. * @returns True if a collection, false otherwise. */ export function isCollectionUrl(url: string) { try { const parsed = new URL(url, env.URL); return isInternalUrl(url) && parsed.pathname.startsWith("/collection/"); } catch (_err) { return false; } } /** * Returns true if the given string is a url. * * @param text The url to check. * @param options Parsing options. * @returns True if a url, false otherwise. */ export function isUrl( text: string, options?: { /** Require the url to have a hostname. */ requireHostname?: boolean; /** Require the url not to use HTTP, custom protocols are ok. */ requireHttps?: boolean; } ) { if (text.match(/\n/)) { return false; } try { const url = new URL(text); const blockedProtocols = ["javascript:", "file:", "vbscript:", "data:"]; if (blockedProtocols.includes(url.protocol)) { return false; } if (url.hostname) { return true; } if (options?.requireHttps && url.protocol === "http:") { return false; } return ( url.protocol !== "" && (url.pathname.startsWith("//") || url.pathname.startsWith("http")) && !options?.requireHostname ); } catch (_err) { return false; } } /** * Temporary prefix applied to links in document that are not yet persisted. */ export const creatingUrlPrefix = "creating#"; /** * Returns true if the given string is a link to outside the application. * * @param url The url to check. * @returns True if the url is external, false otherwise. */ export function isExternalUrl(url: string) { return ( !!url && !isInternalUrl(url) && !url.startsWith(creatingUrlPrefix) && (!env.CDN_URL || !url.startsWith(env.CDN_URL)) ); } /** * Returns match if the given string is a base64 encoded url. * * @param url The url to check. * @returns A RegExp match if the url is base64, false otherwise. */ export function isBase64Url(url: string) { const match = url.match(/^data:([a-z]+\/[^;]+);base64,(.*)/i); return match ? match : false; } /** * For use in the editor, this function will ensure that a url is * potentially valid, and filter out unsupported and malicious protocols. * * @param url The url to sanitize * @returns The sanitized href */ export function sanitizeUrl(url: string | null | undefined) { if (!url) { return undefined; } if ( !isUrl(url, { requireHostname: false }) && !url.startsWith("/") && !url.startsWith("#") && !url.startsWith("mailto:") && !url.startsWith("sms:") && !url.startsWith("fax:") && !url.startsWith("tel:") ) { return `https://${url}`; } return url; } /** * Returns a regex to match the given url. * * @param url The url to create a regex for. * @returns A regex to match the url. */ export function urlRegex(url: string | null | undefined): RegExp | undefined { if (!url || !isUrl(url)) { return undefined; } const urlObj = new URL(sanitizeUrl(url) as string); return new RegExp(escapeRegExp(`${urlObj.protocol}//${urlObj.host}`)); } /** * Extracts LIKELY urls from the given text, note this does not validate the urls. * * @param text The text to extract urls from. * @returns An array of likely urls. */ export function getUrls(text: string) { return Array.from(text.match(/(?:https?):\/\/[^\s]+/gi) || []); }