http.ts

/*
 * http.ts
 *
 * Copyright (C) 2020-2023 Posit Software, PBC
 */

import { existsSync } from "../deno_ral/fs.ts";
import { basename, extname, join, normalize, posix } from "../deno_ral/path.ts";
import { error, info } from "../deno_ral/log.ts";

import * as colors from "fmt/colors";

import {
  contentType,
  isHtmlContent,
  isPdfContent,
  isTextContent,
  kTextHtml,
} from "./mime.ts";
import { logError } from "./log.ts";
import { pathWithForwardSlashes } from "./path.ts";
import { FileResponse, HttpFileRequestOptions } from "./http-types.ts";

export function isAbsoluteRef(href: string) {
  return /^(?:http|https)\:\/\/.+/.test(href);
}

export function isFileRef(href: string) {
  return !/^\w+:/.test(href) && !href.startsWith("#");
}

export function httpFileRequestHandler(
  options: HttpFileRequestOptions,
) {
  async function serveFile(
    filePath: string,
    req: Request,
  ): Promise<Response> {
    // read file (allow custom handler first shot at html files)
    let fileResponse: FileResponse | undefined;
    if (options.onFile) {
      fileResponse = await options.onFile(filePath, req);
    }
    if (!fileResponse) {
      fileResponse = {
        contentType: contentType(filePath),
        body: Deno.readFileSync(filePath),
      };
    }

    return httpContentResponse(fileResponse.body, fileResponse.contentType);
  }

  function serveFallback(
    req: Request,
    e: Error,
    fsPath?: string,
  ): Promise<Response> {
    const encoder = new TextEncoder();
    if (e instanceof URIError) {
      return Promise.resolve(
        new Response(encoder.encode("BadRequest"), { status: 400 }),
      );
    } else if (e instanceof Deno.errors.NotFound) {
      const url = normalizeURL(req.url);
      const handle404 = options.on404
        ? options.on404(url, req)
        : { print: true, response: { body: encoder.encode("Not Found") } };

      // Ignore 404s from specific files
      const ignoreFileNames = [
        "favicon.ico",
        "listings.json",
        /jupyter-.*.js/,
        /apple-touch-icon-/,
      ];

      handle404.print = handle404.print &&
        !!options.printUrls &&
        (!fsPath || (
          !ignoreFileNames.find((name) => {
            return basename(fsPath).match(name);
          }) &&
          extname(fsPath) !== ".map"
        ));
      if (handle404.print) {
        printUrl(url, false);
      }
      return Promise.resolve(
        new Response(handle404.response.body, {
          status: 404,
          headers: {
            "Content-Type": kTextHtml,
          },
        }),
      );
    } else {
      error(`500 (Internal Error): ${(e as Error).message}`, { bold: true });
      return Promise.resolve(
        new Response(encoder.encode("Internal server error"), {
          status: 500,
        }),
      );
    }
  }

  return async (req: Request): Promise<Response> => {
    // custom request handler
    if (options.onRequest) {
      const response = await options.onRequest(req);
      if (response) {
        return response;
      }
    }

    // handle file requests
    let response: Response | undefined;
    let fsPath: string | undefined;
    try {
      // establish base dir and fsPath (w/ slashes normalized to /)
      const baseDir = pathWithForwardSlashes(options.baseDir);
      const normalizedUrl = normalizeURL(req.url);
      fsPath = pathWithForwardSlashes(baseDir + normalizedUrl!);

      // don't let the path escape the serveDir
      if (fsPath.indexOf(baseDir) !== 0) {
        fsPath = baseDir;
      }
      const fileInfo = existsSync(fsPath) ? Deno.statSync(fsPath) : undefined;
      if (fileInfo && fileInfo.isDirectory) {
        fsPath = join(fsPath, options.defaultFile || "index.html");
      }
      if (fileInfo?.isDirectory && !normalizedUrl.endsWith("/")) {
        response = serveRedirect(normalizedUrl + "/");
      } else {
        response = await serveFile(fsPath, req);

        // if we are serving the default file and its not html
        // then provide content-disposition: attachment
        if (
          normalizedUrl === "/" && !isBrowserPreviewable(fsPath)
        ) {
          response.headers.append(
            "content-disposition",
            'attachment; filename="' + options.defaultFile + '"',
          );
        }
        if (options.printUrls === "all") {
          printUrl(normalizedUrl);
        }
      }
    } catch (e) {
      if (!(e instanceof Error)) throw e;
      // it's possible for an exception to occur before we've normalized the path
      // so we need to renormalize it here
      if (fsPath) {
        fsPath = normalize(fsPath);
      }
      response = await serveFallback(
        req,
        e,
        fsPath,
      );
    }
    return response!;
  };
}

export function httpContentResponse(
  content: Uint8Array | string,
  contentType?: string,
): Response {
  if (typeof content === "string") {
    content = new TextEncoder().encode(content);
  }
  // content headers
  const headers = new Headers();
  headers.set("Content-Length", content.byteLength.toString());
  if (contentType) {
    headers.set("Content-Type", contentType);
  }
  headers.set("Cache-Control", "no-store, max-age=0");
  return new Response(content, {
    status: 200,
    headers,
  });
}

export function normalizeURL(url: string): string {
  let normalizedUrl = url;
  try {
    normalizedUrl = decodeURI(normalizedUrl);
  } catch (e) {
    if (!(e instanceof URIError)) {
      throw e;
    }
  }

  try {
    //allowed per https://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html
    const absoluteURI = new URL(normalizedUrl);
    normalizedUrl = decodeURI(absoluteURI.pathname);
  } catch (e) { //wasn't an absoluteURI
    if (!(e instanceof TypeError)) {
      throw e;
    }
  }

  if (normalizedUrl[0] !== "/") {
    throw new URIError("The request URI is malformed.");
  }

  normalizedUrl = posix.normalize(normalizedUrl);
  const startOfParams = normalizedUrl.indexOf("?");
  return startOfParams > -1
    ? normalizedUrl.slice(0, startOfParams)
    : normalizedUrl;
}

export function isBrowserPreviewable(file?: string) {
  return (
    isHtmlContent(file) ||
    isPdfContent(file) ||
    isTextContent(file)
  );
}

export function maybeDisplaySocketError(e: unknown) {
  if (
    !(e instanceof Deno.errors.NotFound) &&
    !(e instanceof Deno.errors.BrokenPipe) &&
    !(e instanceof Deno.errors.NotConnected) &&
    !(e instanceof Deno.errors.ConnectionAborted) &&
    !(e instanceof Deno.errors.ConnectionReset) &&
    !(e instanceof Deno.errors.ConnectionRefused) &&
    !(e instanceof DOMException)
  ) {
    logError(e as Error);
  }
}

export function serveRedirect(url: string): Response {
  const headers = new Headers();
  headers.set("Cache-Control", "no-store, max-age=0");
  headers.set("Location", url);
  return new Response(null, {
    status: 301,
    headers,
  });
}

function printUrl(url: string, found = true) {
  const format = !found ? colors.red : undefined;
  const urlDisplay = url + (found ? "" : " (404: Not Found)");
  if (
    isHtmlContent(url) || url.endsWith("/") || extname(url) === ""
  ) {
    info(`GET: ${urlDisplay}`, {
      bold: false,
      format: format || colors.green,
    });
  } else if (!found) {
    info(urlDisplay, { dim: found, format, indent: 2 });
  }
}