Module

std/http/file_server.ts

Deno standard library
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694
#!/usr/bin/env -S deno run --allow-net --allow-read// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
// This program serves files in the current directory over HTTP.// TODO(bartlomieju): Stream responses instead of reading them into memory.// TODO(bartlomieju): Add tests like these:// https://github.com/indexzero/http-server/blob/master/test/http-server-test.js
import { extname, posix } from "../path/mod.ts";import { listenAndServe, listenAndServeTls } from "./server.ts";import { Status, STATUS_TEXT } from "./http_status.ts";import { parse } from "../flags/mod.ts";import { assert } from "../_util/assert.ts";import { readRange } from "../io/util.ts";
interface EntryInfo { mode: string; size: string; url: string; name: string;}
export interface FileServerArgs { _: string[]; // -p --port p?: number; port?: number; // --cors cors?: boolean; // --no-dir-listing "dir-listing"?: boolean; dotfiles?: boolean; // --host host?: string; // -c --cert c?: string; cert?: string; // -k --key k?: string; key?: string; // -h --help h?: boolean; help?: boolean;}
const encoder = new TextEncoder();
const serverArgs = parse(Deno.args) as FileServerArgs;const target = posix.resolve(serverArgs._[0] ?? "");
const MEDIA_TYPES: Record<string, string> = { ".md": "text/markdown", ".html": "text/html", ".htm": "text/html", ".json": "application/json", ".map": "application/json", ".txt": "text/plain", ".ts": "text/typescript", ".tsx": "text/tsx", ".js": "application/javascript", ".jsx": "text/jsx", ".gz": "application/gzip", ".css": "text/css", ".wasm": "application/wasm", ".mjs": "application/javascript", ".otf": "font/otf", ".ttf": "font/ttf", ".woff": "font/woff", ".woff2": "font/woff2", ".conf": "text/plain", ".list": "text/plain", ".log": "text/plain", ".ini": "text/plain", ".vtt": "text/vtt", ".yaml": "text/yaml", ".yml": "text/yaml", ".mid": "audio/midi", ".midi": "audio/midi", ".mp3": "audio/mp3", ".mp4a": "audio/mp4", ".m4a": "audio/mp4", ".ogg": "audio/ogg", ".spx": "audio/ogg", ".opus": "audio/ogg", ".wav": "audio/wav", ".webm": "audio/webm", ".aac": "audio/x-aac", ".flac": "audio/x-flac", ".mp4": "video/mp4", ".mp4v": "video/mp4", ".mkv": "video/x-matroska", ".mov": "video/quicktime", ".svg": "image/svg+xml", ".avif": "image/avif", ".bmp": "image/bmp", ".gif": "image/gif", ".heic": "image/heic", ".heif": "image/heif", ".jpeg": "image/jpeg", ".jpg": "image/jpeg", ".png": "image/png", ".tiff": "image/tiff", ".psd": "image/vnd.adobe.photoshop", ".ico": "image/vnd.microsoft.icon", ".webp": "image/webp", ".es": "application/ecmascript", ".epub": "application/epub+zip", ".jar": "application/java-archive", ".war": "application/java-archive", ".webmanifest": "application/manifest+json", ".doc": "application/msword", ".dot": "application/msword", ".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", ".dotx": "application/vnd.openxmlformats-officedocument.wordprocessingml.template", ".cjs": "application/node", ".bin": "application/octet-stream", ".pkg": "application/octet-stream", ".dump": "application/octet-stream", ".exe": "application/octet-stream", ".deploy": "application/octet-stream", ".img": "application/octet-stream", ".msi": "application/octet-stream", ".pdf": "application/pdf", ".pgp": "application/pgp-encrypted", ".asc": "application/pgp-signature", ".sig": "application/pgp-signature", ".ai": "application/postscript", ".eps": "application/postscript", ".ps": "application/postscript", ".rdf": "application/rdf+xml", ".rss": "application/rss+xml", ".rtf": "application/rtf", ".apk": "application/vnd.android.package-archive", ".key": "application/vnd.apple.keynote", ".numbers": "application/vnd.apple.keynote", ".pages": "application/vnd.apple.pages", ".geo": "application/vnd.dynageo", ".gdoc": "application/vnd.google-apps.document", ".gslides": "application/vnd.google-apps.presentation", ".gsheet": "application/vnd.google-apps.spreadsheet", ".kml": "application/vnd.google-earth.kml+xml", ".mkz": "application/vnd.google-earth.kmz", ".icc": "application/vnd.iccprofile", ".icm": "application/vnd.iccprofile", ".xls": "application/vnd.ms-excel", ".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", ".xlm": "application/vnd.ms-excel", ".ppt": "application/vnd.ms-powerpoint", ".pot": "application/vnd.ms-powerpoint", ".pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation", ".potx": "application/vnd.openxmlformats-officedocument.presentationml.template", ".xps": "application/vnd.ms-xpsdocument", ".odc": "application/vnd.oasis.opendocument.chart", ".odb": "application/vnd.oasis.opendocument.database", ".odf": "application/vnd.oasis.opendocument.formula", ".odg": "application/vnd.oasis.opendocument.graphics", ".odp": "application/vnd.oasis.opendocument.presentation", ".ods": "application/vnd.oasis.opendocument.spreadsheet", ".odt": "application/vnd.oasis.opendocument.text", ".rar": "application/vnd.rar", ".unityweb": "application/vnd.unity", ".dmg": "application/x-apple-diskimage", ".bz": "application/x-bzip", ".crx": "application/x-chrome-extension", ".deb": "application/x-debian-package", ".php": "application/x-httpd-php", ".iso": "application/x-iso9660-image", ".sh": "application/x-sh", ".sql": "application/x-sql", ".srt": "application/x-subrip", ".xml": "application/xml", ".zip": "application/zip",};
/** Returns the content-type based on the extension of a path. */function contentType(path: string): string | undefined { return MEDIA_TYPES[extname(path)];}
// Generates a SHA-1 hash for the provided stringasync function createEtagHash(message: string) { const byteToHex = (b: number) => b.toString(16).padStart(2, "00"); const hashType = "SHA-1"; // Faster, and this isn't a security sensitive cryptographic use case
// see: https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest const msgUint8 = new TextEncoder().encode(message); const hashBuffer = await crypto.subtle.digest(hashType, msgUint8); const hashArray = Array.from(new Uint8Array(hashBuffer)); const hashHex = hashArray.map(byteToHex).join(""); return hashHex;}
function modeToString(isDir: boolean, maybeMode: number | null): string { const modeMap = ["---", "--x", "-w-", "-wx", "r--", "r-x", "rw-", "rwx"];
if (maybeMode === null) { return "(unknown mode)"; } const mode = maybeMode.toString(8); if (mode.length < 3) { return "(unknown mode)"; } let output = ""; mode .split("") .reverse() .slice(0, 3) .forEach((v): void => { output = modeMap[+v] + output; }); output = `(${isDir ? "d" : "-"}${output})`; return output;}
function fileLenToString(len: number): string { const multiplier = 1024; let base = 1; const suffix = ["B", "K", "M", "G", "T"]; let suffixIndex = 0;
while (base * multiplier < len) { if (suffixIndex >= suffix.length - 1) { break; } base *= multiplier; suffixIndex++; }
return `${(len / base).toFixed(2)}${suffix[suffixIndex]}`;}
/** * Returns an HTTP Response with the requested file as the body. * @param req The server request context used to cleanup the file handle. * @param filePath Path of the file to serve. */export async function serveFile( req: Request, filePath: string,): Promise<Response> { const [file, fileInfo] = await Promise.all([ Deno.open(filePath), Deno.stat(filePath), ]);
const headers = setBaseHeaders();
// Set mime-type using the file extension in filePath const contentTypeValue = contentType(filePath); if (contentTypeValue) { headers.set("content-type", contentTypeValue); }
// Set date header if access timestamp is available if (fileInfo.atime instanceof Date) { const date = new Date(fileInfo.atime); headers.set("date", date.toUTCString()); }
// Set last modified header if access timestamp is available if (fileInfo.mtime instanceof Date) { const lastModified = new Date(fileInfo.mtime); headers.set("last-modified", lastModified.toUTCString());
// Create a simple etag that is an md5 of the last modified date and filesize concatenated const simpleEtag = await createEtagHash( `${lastModified.toJSON()}${fileInfo.size}`, ); headers.set("etag", simpleEtag);
// If a `if-none-match` header is present and the value matches the tag or // if a `if-modified-since` header is present and the value is bigger than // the access timestamp value, then return 304 const ifNoneMatch = req.headers.get("if-none-match"); const ifModifiedSince = req.headers.get("if-modified-since"); if ( (ifNoneMatch && ifNoneMatch === simpleEtag) || (ifNoneMatch === null && ifModifiedSince && fileInfo.mtime.getTime() < (new Date(ifModifiedSince).getTime() + 1000)) ) { const status = Status.NotModified; const statusText = STATUS_TEXT.get(status);
return new Response(null, { status, statusText, headers, }); } }
// Get and parse the "range" header const range = req.headers.get("range") as string; const rangeRe = /bytes=(\d+)-(\d+)?/; const parsed = rangeRe.exec(range);
// Use the parsed value if available, fallback to the start and end of the entire file const start = parsed && parsed[1] ? +parsed[1] : 0; const end = parsed && parsed[2] ? +parsed[2] : Math.max(0, fileInfo.size - 1);
let status = Status.OK;
// If there is a range, set the status to 206, and set the "Content-range" header. if (range && parsed) { status = Status.PartialContent; headers.set("content-range", `bytes ${start}-${end}/${fileInfo.size}`); }
// Return 416 if `start` isn't less than or equal to `end`, or `start` or `end` are greater than the file's size const maxRange = (typeof fileInfo.size === "number" ? Math.max(0, fileInfo.size - 1) : 0);
if ( range && !parsed || (typeof start !== "number" || start > end || start > maxRange || end > maxRange) ) { const status = Status.RequestedRangeNotSatisfiable; const statusText = STATUS_TEXT.get(status);
return new Response(statusText, { status, statusText, headers, }); }
let body = null;
try { // Read the selected range of the file const bytes = await readRange(file, { start, end });
// Set content length and response body headers.set("content-length", bytes.length.toString()); body = bytes; } catch (e) { // Fallback on URIError (400 Bad Request) if unable to read range throw URIError(String(e)); }
file.close();
const statusText = STATUS_TEXT.get(status);
return new Response(body, { status, statusText, headers, });}
// TODO(bartlomieju): simplify this after deno.stat and deno.readDir are fixedasync function serveDir( req: Request, dirPath: string,): Promise<Response> { const showDotfiles = serverArgs.dotfiles ?? true; const dirUrl = `/${posix.relative(target, dirPath)}`; const listEntry: EntryInfo[] = [];
// if ".." makes sense if (dirUrl !== "/") { const prevPath = posix.join(dirPath, ".."); const fileInfo = await Deno.stat(prevPath); listEntry.push({ mode: modeToString(true, fileInfo.mode), size: "", name: "../", url: posix.join(dirUrl, ".."), }); }
for await (const entry of Deno.readDir(dirPath)) { if (!showDotfiles && entry.name[0] === ".") { continue; } const filePath = posix.join(dirPath, entry.name); const fileUrl = posix.join(dirUrl, entry.name); if (entry.name === "index.html" && entry.isFile) { // in case index.html as dir... return serveFile(req, filePath); } const fileInfo = await Deno.stat(filePath); listEntry.push({ mode: modeToString(entry.isDirectory, fileInfo.mode), size: entry.isFile ? fileLenToString(fileInfo.size ?? 0) : "", name: `${entry.name}${entry.isDirectory ? "/" : ""}`, url: `${fileUrl}${entry.isDirectory ? "/" : ""}`, }); } listEntry.sort((a, b) => a.name.toLowerCase() > b.name.toLowerCase() ? 1 : -1 ); const formattedDirUrl = `${dirUrl.replace(/\/$/, "")}/`; const page = encoder.encode(dirViewerTemplate(formattedDirUrl, listEntry));
const headers = setBaseHeaders(); headers.set("content-type", "text/html");
return new Response(page, { status: Status.OK, headers });}
function serveFallback(_req: Request, e: Error): Promise<Response> { if (e instanceof URIError) { return Promise.resolve( new Response(STATUS_TEXT.get(Status.BadRequest), { status: Status.BadRequest, }), ); } else if (e instanceof Deno.errors.NotFound) { return Promise.resolve( new Response(STATUS_TEXT.get(Status.NotFound), { status: Status.NotFound, }), ); }
return Promise.resolve( new Response(STATUS_TEXT.get(Status.InternalServerError), { status: Status.InternalServerError, }), );}
function serverLog(req: Request, res: Response): void { const d = new Date().toISOString(); const dateFmt = `[${d.slice(0, 10)} ${d.slice(11, 19)}]`; const s = `${dateFmt} "${req.method} ${req.url}" ${res.status}`; console.log(s);}
function setBaseHeaders(): Headers { const headers = new Headers(); headers.set("server", "deno");
// Set "accept-ranges" so that the client knows it can make range requests on future requests headers.set("accept-ranges", "bytes"); headers.set("date", new Date().toUTCString());
return headers;}
function setCORS(res: Response): void { res.headers.append("access-control-allow-origin", "*"); res.headers.append( "access-control-allow-headers", "Origin, X-Requested-With, Content-Type, Accept, Range", );}
function dirViewerTemplate(dirname: string, entries: EntryInfo[]): string { return html` <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta http-equiv="X-UA-Compatible" content="ie=edge" /> <title>Deno File Server</title> <style> :root { --background-color: #fafafa; --color: rgba(0, 0, 0, 0.87); } @media (prefers-color-scheme: dark) { :root { --background-color: #303030; --color: #fff; } } @media (min-width: 960px) { main { max-width: 960px; } body { padding-left: 32px; padding-right: 32px; } } @media (min-width: 600px) { main { padding-left: 24px; padding-right: 24px; } } body { background: var(--background-color); color: var(--color); font-family: "Roboto", "Helvetica", "Arial", sans-serif; font-weight: 400; line-height: 1.43; font-size: 0.875rem; } a { color: #2196f3; text-decoration: none; } a:hover { text-decoration: underline; } table th { text-align: left; } table td { padding: 12px 24px 0 0; } </style> </head> <body> <main> <h1>Index of ${dirname}</h1> <table> <tr> <th>Mode</th> <th>Size</th> <th>Name</th> </tr> ${ entries.map( (entry) => html` <tr> <td class="mode"> ${entry.mode} </td> <td> ${entry.size} </td> <td> <a href="${entry.url}">${entry.name}</a> </td> </tr> `, ) } </table> </main> </body> </html> `;}
function html(strings: TemplateStringsArray, ...values: unknown[]): string { const l = strings.length - 1; let html = "";
for (let i = 0; i < l; i++) { let v = values[i]; if (v instanceof Array) { v = v.join(""); } const s = strings[i] + v; html += s; } html += strings[l]; return html;}
function normalizeURL(url: string): string { let normalizedUrl = url;
try { //allowed per https://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html const absoluteURI = new URL(normalizedUrl); normalizedUrl = absoluteURI.pathname; } catch (e) { //wasn't an absoluteURI if (!(e instanceof TypeError)) { throw e; } }
try { normalizedUrl = decodeURI(normalizedUrl); } catch (e) { if (!(e instanceof URIError)) { 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;}
function main(): void { const CORSEnabled = serverArgs.cors ? true : false; const port = serverArgs.port ?? serverArgs.p ?? 4507; const host = serverArgs.host ?? "0.0.0.0"; const addr = `${host}:${port}`; const certFile = serverArgs.cert ?? serverArgs.c ?? ""; const keyFile = serverArgs.key ?? serverArgs.k ?? ""; const dirListingEnabled = serverArgs["dir-listing"] ?? true;
if (keyFile || certFile) { if (keyFile === "" || certFile === "") { console.log("--key and --cert are required for TLS"); serverArgs.h = true; } }
if (serverArgs.h ?? serverArgs.help) { console.log(`Deno File Server Serves a local directory in HTTP.
INSTALL: deno install --allow-net --allow-read https://deno.land/std/http/file_server.ts
USAGE: file_server [path] [options]
OPTIONS: -h, --help Prints help information -p, --port <PORT> Set port --cors Enable CORS via the "Access-Control-Allow-Origin" header --host <HOST> Hostname (default is 0.0.0.0) -c, --cert <FILE> TLS certificate file (enables TLS) -k, --key <FILE> TLS key file (enables TLS) --no-dir-listing Disable directory listing --no-dotfiles Do not show dotfiles
All TLS options are required when one is provided.`); Deno.exit(); }
const handler = async (req: Request): Promise<Response> => { let response: Response;
try { const normalizedUrl = normalizeURL(req.url); let fsPath = posix.join(target, normalizedUrl);
if (fsPath.indexOf(target) !== 0) { fsPath = target; }
const fileInfo = await Deno.stat(fsPath);
if (fileInfo.isDirectory) { if (dirListingEnabled) { response = await serveDir(req, fsPath); } else { throw new Deno.errors.NotFound(); } } else { response = await serveFile(req, fsPath); } } catch (e) { const err = e instanceof Error ? e : new Error("[non-error thrown]"); console.error(err.message); response = await serveFallback(req, err); }
if (CORSEnabled) { assert(response!); setCORS(response); }
serverLog(req, response!);
return response!; };
let proto = "http";
if (keyFile || certFile) { proto += "s"; listenAndServeTls(addr, certFile, keyFile, handler); } else { listenAndServe(addr, handler); }
console.log( `${proto.toUpperCase()} server listening on ${proto}://${ addr.replace("0.0.0.0", "localhost") }/`, );}
if (import.meta.main) { main();}