koa-files 2.3.7 → 2.3.8

package/cjs/utils.cjs

@@ -1,7 +1,7 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.7
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
@@ -12,9 +12,11 @@
 const fs = require('fs');
 const path = require('path');
 
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+function _interopDefault(e) {
+  return e && e.__esModule ? e : { default: e };
+}
 
-const fs__default = /*#__PURE__*/_interopDefault(fs);
+const fs__default = /*#__PURE__*/ _interopDefault(fs);
 
 /**
  * @module utils
@@ -24,122 +26,117 @@ const fs__default = /*#__PURE__*/_interopDefault(fs);
 const CHARS = Array.from('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
 /**
  * @function isOutRoot
- * @description Test path is out of bound of root
- * @param {string} path
- * @param {string} root
- * @returns {boolean}
+ * @description Check if path is out of root
+ * @param path The path to check
+ * @param root The root path
  */
 function isOutRoot(path$1, root) {
-    path$1 = path.relative(root, path$1);
-    return /\.\.(?:[\\/]|$)/.test(path$1) || path.isAbsolute(path$1);
+  path$1 = path.relative(root, path$1);
+  return /\.\.(?:[\\/]|$)/.test(path$1) || path.isAbsolute(path$1);
 }
 /**
  * @function unixify
- * @description Convert path separators to posix/unix-style forward slashes
- * @param {string} path
- * @returns {string}
+ * @description Convert path to unix style
+ * @param path The path to convert
  */
 function unixify(path) {
-    return path.replace(/\\/g, '/');
+  return path.replace(/\\/g, '/');
 }
 /**
  * @function decodeURI
- * @description Decode URI component.
- * @param {string} URI
- * @returns {string|-1}
+ * @description Decode URI component
+ * @param URI The URI to decode
  */
 function decodeURI(URI) {
-    try {
-        return decodeURIComponent(URI);
-    }
-    catch (error) {
-        return -1;
-    }
+  try {
+    return decodeURIComponent(URI);
+  } catch (error) {
+    return -1;
+  }
 }
 /**
  * @function boundaryGenerator
- * @description Create boundary
- * @returns {string}
+ * @description Generate a boundary
  */
 function boundaryGenerator() {
-    let boundary = '';
-    // Create boundary
-    for (let i = 0; i < 38; i++) {
-        boundary += CHARS[Math.floor(Math.random() * 62)];
-    }
-    // Return boundary
-    return boundary;
+  let boundary = '';
+  // Create boundary
+  for (let i = 0; i < 38; i++) {
+    boundary += CHARS[Math.floor(Math.random() * 62)];
+  }
+  // Return boundary
+  return boundary;
 }
 /**
  * @function fstat
- * @param {string} path
- * @returns {Promise<Stats>}
+ * @description Get file stats
+ * @param path The file path
  */
 function fstat(path) {
-    return new Promise((resolve, reject) => {
-        fs__default.default.stat(path, (error, stats) => {
-            error ? reject(error) : resolve(stats);
-        });
+  return new Promise((resolve, reject) => {
+    fs__default.default.stat(path, (error, stats) => {
+      error ? reject(error) : resolve(stats);
     });
+  });
 }
 /**
  * @function hasTrailingSlash
- * @param {string} path
- * @returns {boolean}
+ * @description Check if path has trailing slash
+ * @param path The path to check
  */
 function hasTrailingSlash(path) {
-    return /\/$/.test(path);
+  return /\/$/.test(path);
 }
 /**
  * @function parseTokens
- * @description Parse a HTTP tokens.
- * @param {string[]} value
+ * @description Parse HTTP tokens
+ * @param value The tokens value string
  */
 function parseTokens(value) {
-    let end = 0;
-    let start = 0;
-    let tokens = [];
-    // gather tokens
-    for (let i = 0, length = value.length; i < length; i++) {
-        switch (value.charCodeAt(i)) {
-            case 0x20:
-                // ' '
-                if (start === end) {
-                    start = end = i + 1;
-                }
-                break;
-            case 0x2c:
-                // ','
-                tokens.push(value.substring(start, end));
-                start = end = i + 1;
-                break;
-            default:
-                end = i + 1;
-                break;
+  let end = 0;
+  let start = 0;
+  let tokens = [];
+  // gather tokens
+  for (let i = 0, length = value.length; i < length; i++) {
+    switch (value.charCodeAt(i)) {
+      case 0x20:
+        // ' '
+        if (start === end) {
+          start = end = i + 1;
         }
+        break;
+      case 0x2c:
+        // ','
+        tokens.push(value.substring(start, end));
+        start = end = i + 1;
+        break;
+      default:
+        end = i + 1;
+        break;
     }
-    // final token
-    tokens.push(value.substring(start, end));
-    return tokens;
+  }
+  // final token
+  tokens.push(value.substring(start, end));
+  return tokens;
 }
 /**
- * @function isETagFresh
- * @param {string} match
- * @param {string} etag
- * @returns {boolean}
+ * @function isETag
+ * @description Check if etag is valid
+ * @param value The value to check
  */
-function isETagFresh(match, etag) {
-    return parseTokens(match).some(match => {
-        return match === etag || match === 'W/' + etag || 'W/' + match === etag;
-    });
+function isETag(value) {
+  return /^(?:W\/)?"[\s\S]+"$/.test(value);
 }
 /**
- * @function isETag
- * @param {string} etag
- * @returns {boolean}
+ * @function isETagFresh
+ * @description Check if etag is fresh
+ * @param match The match value
+ * @param etag The etag value
  */
-function isETag(etag) {
-    return /(?:W\/)?"(?:[ !#-\x7E\x80-\xFF]*|\r\n[\t ]|\\.)*"/.test(etag);
+function isETagFresh(match, etag) {
+  return parseTokens(match).some(match => {
+    return match === etag || match === 'W/' + etag || 'W/' + match === etag;
+  });
 }
 
 exports.boundaryGenerator = boundaryGenerator;

package/esm/Files.js

@@ -0,0 +1,378 @@
+/**
+ * @package koa-files
+ * @license MIT
+ * @version 2.3.8
+ * @author nuintun <nuintun@qq.com>
+ * @description A static files serving middleware for koa.
+ * @see https://github.com/nuintun/koa-files#readme
+ */
+
+import etag from 'etag';
+import destroy from 'destroy';
+import fs from 'fs';
+import { PassThrough } from 'stream';
+import parseRange from 'range-parser';
+import { resolve, extname, join } from 'path';
+import { unixify, isETagFresh, isETag, boundaryGenerator, decodeURI, isOutRoot, fstat, hasTrailingSlash } from './utils.js';
+
+/**
+ * @module Files
+ * @license MIT
+ * @author nuintun
+ */
+/**
+ * @class Files
+ */
+class Files {
+  /**
+   * @constructor
+   * @description Create files service
+   * @param root Files service root
+   * @param options Files service options
+   */
+  constructor(root, options = {}) {
+    this.options = options;
+    this.root = unixify(resolve(root));
+  }
+  /**
+   * @private
+   * @method isConditionalGET
+   * @description Check if request is conditional GET
+   * @param context Koa context
+   */
+  isConditionalGET(context) {
+    const { request } = context;
+    return !!(
+      request.get('If-Match') ||
+      request.get('If-None-Match') ||
+      request.get('If-Modified-Since') ||
+      request.get('if-Unmodified-Since')
+    );
+  }
+  /**
+   * @private
+   * @method isPreconditionFailure
+   * @description Check if request precondition failure
+   * @param context Koa context
+   */
+  isPreconditionFailure(context) {
+    const { request, response } = context;
+    // If-Match
+    const match = request.get('If-Match');
+    if (match) {
+      const etag = response.get('ETag');
+      return !etag || (match !== '*' && !isETagFresh(match, etag));
+    }
+    // If-Unmodified-Since
+    const unmodifiedSince = Date.parse(request.get('If-Unmodified-Since'));
+    if (!isNaN(unmodifiedSince)) {
+      const lastModified = Date.parse(response.get('Last-Modified'));
+      return isNaN(lastModified) || lastModified > unmodifiedSince;
+    }
+    return false;
+  }
+  /**
+   * @private
+   * @method isRangeFresh
+   * @description Check if request range fresh
+   * @param context Koa context
+   */
+  isRangeFresh(context) {
+    const { request, response } = context;
+    const ifRange = request.get('If-Range');
+    // No If-Range
+    if (!ifRange) {
+      return true;
+    }
+    // If-Range as etag
+    if (isETag(ifRange)) {
+      const etag = response.get('ETag');
+      return !!(etag && isETagFresh(ifRange, etag));
+    }
+    // If-Range as modified date
+    const lastModified = response.get('Last-Modified');
+    return Date.parse(lastModified) <= Date.parse(ifRange);
+  }
+  /**
+   * @private
+   * @method isIgnore
+   * @description Check if path is ignore
+   * @param path File path
+   */
+  isIgnore(path) {
+    const { ignore } = this.options;
+    return (typeof ignore === 'function' ? ignore(path) : false) === true;
+  }
+  /**
+   * @private
+   * @method parseRange
+   * @description Parse range
+   * @param context Koa context
+   * @param stats File stats
+   */
+  parseRange(context, stats) {
+    const { size } = stats;
+    const { request } = context;
+    // Content-Length
+    let contentLength = size;
+    // Ranges
+    const ranges = [];
+    // Range support
+    if (this.options.acceptRanges !== false) {
+      const range = request.get('Range');
+      // Range fresh
+      if (range && this.isRangeFresh(context)) {
+        // Parse range -1 -2 or []
+        const parsed = parseRange(size, range, { combine: true });
+        // -1 signals an unsatisfiable range
+        // -2 signals a malformed header string
+        if (parsed === -1 || parsed === -2) {
+          return parsed;
+        }
+        // Ranges ok, support multiple ranges
+        if (parsed.type === 'bytes') {
+          // Set 206 status
+          context.status = 206;
+          // Multiple ranges
+          if (parsed.length > 1) {
+            // Reset content-length
+            contentLength = 0;
+            // Range boundary
+            const boundary = `<${boundaryGenerator()}>`;
+            const suffix = `\r\n--${boundary}--\r\n`;
+            const contentType = `Content-Type: ${context.type}`;
+            context.type = `multipart/byteranges; boundary=${boundary}`;
+            // Map ranges
+            parsed.forEach(({ start, end }, index) => {
+              // The first prefix boundary no \r\n
+              const prefixHead = index > 0 ? '\r\n' : '';
+              const contentRange = `Content-Range: bytes ${start}-${end}/${size}`;
+              const prefix = `${prefixHead}--${boundary}\r\n${contentType}\r\n${contentRange}\r\n\r\n`;
+              // Compute content-length
+              contentLength += end - start + 1 + Buffer.byteLength(prefix);
+              // Cache range
+              ranges.push({ start, end, prefix });
+            });
+            // The last add suffix boundary
+            ranges[ranges.length - 1].suffix = suffix;
+            // Compute content-length
+            contentLength += Buffer.byteLength(suffix);
+          } else {
+            const { start, end } = parsed[0];
+            context.set('Content-Range', `bytes ${start}-${end}/${size}`);
+            // Compute content-length
+            contentLength = end - start + 1;
+            // Cache range
+            ranges.push({ start, end });
+          }
+        }
+      }
+    }
+    // Set Content-Length
+    context.length = contentLength;
+    return ranges.length ? ranges : [{ start: 0 }];
+  }
+  /**
+   * @private
+   * @method setupHeaders
+   * @description Setup headers
+   * @param context Koa context
+   * @param path File path
+   * @param stats File stats
+   */
+  setupHeaders(context, path, stats) {
+    const { options } = this;
+    const { toString } = Object.prototype;
+    const { acceptRanges, cacheControl, lastModified } = options;
+    // Set status
+    context.status = 200;
+    // Set Content-Type
+    context.type = extname(path);
+    // ETag
+    if (options.etag !== false) {
+      // Set ETag
+      context.set('ETag', etag(stats));
+    }
+    // Accept-Ranges
+    if (acceptRanges !== false) {
+      // Set Accept-Ranges
+      context.set('Accept-Ranges', 'bytes');
+    }
+    // Last-Modified
+    if (lastModified !== false) {
+      // Set mtime utc string
+      context.set('Last-Modified', stats.mtime.toUTCString());
+    }
+    // Cache-Control
+    if (cacheControl && toString.call(cacheControl) === '[object String]') {
+      // Set Cache-Control
+      context.set('Cache-Control', cacheControl);
+    }
+  }
+  /**
+   * @private
+   * @method read
+   * @description Read file
+   * @param path File path
+   * @param range Read range
+   * @param buffer Destination stream
+   * @param end Is destory destination stream after read
+   */
+  read(path, range, buffer, end) {
+    return new Promise((resolve, reject) => {
+      // Create file stream
+      const file = fs.createReadStream(path, range);
+      // File read stream open
+      if (range.prefix) {
+        file.once('open', () => {
+          // Write prefix boundary
+          buffer.write(range.prefix);
+        });
+      }
+      // File read stream error
+      file.once('error', error => {
+        // Unpipe
+        file.unpipe(buffer);
+        // Destroy file stream
+        destroy(file);
+        // Reject
+        reject(error);
+      });
+      // File read stream end
+      if (range.suffix) {
+        file.once('end', () => {
+          // Push suffix boundary
+          buffer.write(range.suffix);
+        });
+      }
+      // File read stream close
+      file.once('close', () => {
+        // Unpipe
+        file.unpipe(buffer);
+        // Destroy file stream
+        destroy(file);
+        // Resolve
+        resolve(true);
+      });
+      // Write data to buffer
+      file.pipe(buffer, { end });
+    });
+  }
+  /**
+   * @private
+   * @method send
+   * @description Send file
+   * @param context Koa context
+   * @param path File path
+   * @param ranges Read ranges
+   */
+  async send(context, path, ranges) {
+    // Ranges length
+    let { length } = ranges;
+    // Set stream body, highWaterMark 64kb
+    const stream = new PassThrough({ highWaterMark: 65536 });
+    // Set response body
+    context.body = stream;
+    // Read file ranges
+    try {
+      for (const range of ranges) {
+        await this.read(path, range, stream, --length === 0);
+      }
+    } catch (error) {
+      // End stream when read exception
+      stream.end();
+    }
+  }
+  /**
+   * @public
+   * @method response
+   * @description Response to koa context
+   * @param context Koa context
+   */
+  async response(context) {
+    const { root } = this;
+    // Only support GET and HEAD (405)
+    if (context.method !== 'GET' && context.method !== 'HEAD') {
+      return false;
+    }
+    // Get path of file
+    const pathname = decodeURI(context.path);
+    const path = pathname === -1 ? pathname : unixify(join(root, pathname));
+    // Path -1 or null byte(s)
+    if (path === -1 || path.includes('\0')) {
+      return context.throw(400);
+    }
+    // Malicious path (403)
+    if (isOutRoot(path, root)) {
+      return false;
+    }
+    // Is ignore path or file (403)
+    if (this.isIgnore(path)) {
+      return false;
+    }
+    // File stats
+    let stats;
+    // Get file stats
+    try {
+      stats = await fstat(path);
+    } catch (error) {
+      // 404 | 500
+      return false;
+    }
+    // File not exist (404 | 500)
+    if (!stats) {
+      return false;
+    }
+    // Is directory (403)
+    if (stats.isDirectory()) {
+      return false;
+    }
+    // Not a directory but has trailing slash (404)
+    if (hasTrailingSlash(path)) {
+      return false;
+    }
+    // Setup headers
+    this.setupHeaders(context, path, stats);
+    // Conditional get support
+    if (this.isConditionalGET(context)) {
+      // Request precondition failure
+      if (this.isPreconditionFailure(context)) {
+        return context.throw(412);
+      }
+      // Request fresh (304)
+      if (context.fresh) {
+        // Set status
+        context.status = 304;
+        // Set body null
+        context.body = null;
+        return true;
+      }
+    }
+    // Head request
+    if (context.method === 'HEAD') {
+      // Set content-length
+      context.length = stats.size;
+      // Set body null
+      context.body = null;
+      return true;
+    }
+    // Parsed ranges
+    const ranges = this.parseRange(context, stats);
+    // 416
+    if (ranges === -1) {
+      // Set content-range
+      context.set('Content-Range', `bytes */${stats.size}`);
+      // Unsatisfiable 416
+      return context.throw(416);
+    }
+    // 400
+    if (ranges === -2) {
+      return context.throw(400);
+    }
+    // Send file
+    this.send(context, path, ranges);
+    return true;
+  }
+}
+
+export { Files as default };

package/esm/index.js

@@ -1,13 +1,13 @@
 /**
  * @package koa-files
  * @license MIT
- * @version 2.3.7
+ * @version 2.3.8
  * @author nuintun <nuintun@qq.com>
  * @description A static files serving middleware for koa.
  * @see https://github.com/nuintun/koa-files#readme
  */
 
-import Send from './Send.js';
+import Files from './Files.js';
 
 /**
  * @module index
@@ -20,18 +20,18 @@ import Send from './Send.js';
  * @param {Options} options
  */
 function server(root, options) {
-    const send = new Send(root, options);
-    if (options && options.defer) {
-        return async (context, next) => {
-            await next();
-            await send.response(context);
-        };
-    }
+  const files = new Files(root, options);
+  if (options && options.defer) {
     return async (context, next) => {
-        if (!(await send.response(context))) {
-            await next();
-        }
+      await next();
+      await files.response(context);
     };
+  }
+  return async (context, next) => {
+    if (!(await files.response(context))) {
+      await next();
+    }
+  };
 }
 
 export { server as default };