@warren-bank/hls-proxy 3.4.0 → 3.4.2

package/README.md

@@ -136,6 +136,8 @@ options:
 --tls-cert <filepath>
 --tls-key <filepath>
 --tls-pass <filepath>
+--manifest-extension <ext>
+--segment-extension <ext>
 ```
 
 #### Options:
@@ -147,11 +149,15 @@ options:
     * _--tls-pass_
   * the values assigned to these options enable the use of a self-signed security certificate that is included in both the git repo and npm package, within the directory:
     * [`./hls-proxy/servers/cert`](https://github.com/warren-bank/HLS-Proxy/tree/master/hls-proxy/servers/cert)
+  * when all of these option are properly specified:
+    * the `https:` protocol is used by all URLs in modified HLS manifests
 * _--host_ is an IP or hostname with an optional port number that can be resolved and is reachable by clients
   * ex: `192.168.0.100:8080`
   * used to modify URLs in .m3u8 files
   * when this option is specified without a port number:
     * the value of the _--port_ option is appended
+  * when this option is specified and the port number is `443`:
+    * the `https:` protocol is used by all URLs in modified HLS manifests
   * when this option is not specified:
     * the value of the ["Host"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Host) HTTP request header is used
 * _--port_ is the port number that the server listens on
@@ -361,6 +367,10 @@ options:
 * _--tls-key_ is the filepath to the private key for the _--tls-cert_ security certificate
 * _--tls-pass_ is the filepath to a text file containing the security passphrase for the _--tls-key_ private key
   * optional, not required when the _--tls-key_ private key was created without a security passphrase
+* _--manifest-extension_ is the file extension associated with HLS manifests
+  * default value: `m3u8`
+* _--segment-extension_ is the file extension associated with media segments
+  * default value: `ts`
 
 #### Examples:
 
@@ -595,8 +605,10 @@ curl --silent --insecure "$URL"
     * m3u8 manifest parser uses regex patterns to identify all URL patterns without any special knowledge of the m3u8 manifest specification
     * internal `proxy` module exports a function that accepts an instance of [`http.Server`](https://nodejs.org/api/http.html#class-httpserver) and adds event listeners to process requests
   - system requirements:
-    * Node.js v6.4.0 and higher
-      - required features: [`Proxy` constructor](https://node.green/#ES2015-built-ins-Proxy-constructor-requires-new), [`Proxy` 'apply' handler](https://node.green/#ES2015-built-ins-Proxy--apply--handler), [`Reflect.apply`](https://node.green/#ES2015-built-ins-Reflect-Reflect-apply)
+    * Node.js version: v8.6.0 (and higher)
+      - transitive [dependency](https://github.com/warren-bank/HLS-Proxy/blob/v1.0.1/package.json#L13-L14) requirements:
+        * v8.06.00+: [`@warren-bank/node-process-argv`](https://github.com/warren-bank/node-process-argv#requirements)
+        * v8.06.00+: [`@warren-bank/node-request`](https://github.com/warren-bank/node-request#requirements)
 * `v2.x`
   - commit history is in branch: [`v02`](https://github.com/warren-bank/HLS-Proxy/commits/v02)
   - summary:
@@ -606,8 +618,10 @@ curl --silent --insecure "$URL"
       - added to an [`Express.js`](https://github.com/expressjs/express) application as middleware to handle a custom route
         * important limitation: since `/` is a valid character in a base64 encoded URL, the path for a custom route needs to end with a character that is not allowed in base64 encoding (ex: `'/proxy_/*'`)
   - system requirements:
-    * Node.js v6.4.0 and higher
-      - required features: [`Proxy` constructor](https://node.green/#ES2015-built-ins-Proxy-constructor-requires-new), [`Proxy` 'apply' handler](https://node.green/#ES2015-built-ins-Proxy--apply--handler), [`Reflect.apply`](https://node.green/#ES2015-built-ins-Reflect-Reflect-apply)
+    * Node.js version: v8.6.0 (and higher)
+      - transitive [dependency](https://github.com/warren-bank/HLS-Proxy/blob/v2.0.3/package.json#L13-L14) requirements:
+        * v8.06.00+: [`@warren-bank/node-process-argv`](https://github.com/warren-bank/node-process-argv#requirements)
+        * v8.06.00+: [`@warren-bank/node-request`](https://github.com/warren-bank/node-request#requirements)
 * `v3.x`
   - commit history is in branch: [`v03`](https://github.com/warren-bank/HLS-Proxy/commits/v03)
   - summary:
@@ -618,8 +632,12 @@ curl --silent --insecure "$URL"
         * important requirement: the path for a custom route needs to include exactly one unnamed [parameter](https://expressjs.com/en/guide/routing.html#route-parameters) that matches the base64 encoded URL and (optionally) a file extension (ex: `'/proxy/*'`)
         * the use of nested routers is supported
   - system requirements:
-    * Node.js v16.0.0 and higher
-      - required features: [`Proxy` constructor](https://node.green/#ES2015-built-ins-Proxy-constructor-requires-new), [`Proxy` 'apply' handler](https://node.green/#ES2015-built-ins-Proxy--apply--handler), [`Reflect.apply`](https://node.green/#ES2015-built-ins-Reflect-Reflect-apply), [`RegExp` 'd' flag](https://node.green/#ES2022-features-RegExp-Match-Indices---hasIndices-----d--flag-)
+    * Node.js version: v16.0.0 (and higher)
+      - transitive [dependency](https://github.com/warren-bank/HLS-Proxy/blob/v3.4.0/package.json#L13-L14) requirements:
+        * v8.06.00+: [`@warren-bank/node-process-argv`](https://github.com/warren-bank/node-process-argv#requirements)
+        * v8.06.00+: [`@warren-bank/node-request`](https://github.com/warren-bank/node-request#requirements)
+      - [ES6 support](http://node.green/)
+        * v16.00.00+: [`RegExp` 'd' flag](https://node.green/#ES2022-features-RegExp-Match-Indices---hasIndices-----d--flag-)
 
 - - - -
 

package/hls-proxy/bin/hlsd.js

@@ -45,7 +45,9 @@ const middleware = require('../proxy')({
   cache_storage_fs_dirpath:             argv_vals["--cache-storage-fs-dirpath"],
   debug_level:                          argv_vals["-v"],
   acl_whitelist:                        argv_vals["--acl-whitelist"],
-  http_proxy:                           argv_vals["--http-proxy"]
+  http_proxy:                           argv_vals["--http-proxy"],
+  manifest_extension:                   argv_vals["--manifest-extension"],
+  segment_extension:                    argv_vals["--segment-extension"]
 })
 
 if (middleware.connection)

package/hls-proxy/bin/lib/help.js

@@ -32,6 +32,8 @@ options:
 --tls-cert <filepath>
 --tls-key <filepath>
 --tls-pass <filepath>
+--manifest-extension <ext>
+--segment-extension <ext>
 `
 
 module.exports = help

package/hls-proxy/bin/lib/process_argv.js

@@ -38,7 +38,10 @@ const argv_flags = {
 
   "--tls-cert":                             {file: "path-exists"},
   "--tls-key":                              {file: "path-exists"},
-  "--tls-pass":                             {file: "path-exists"}
+  "--tls-pass":                             {file: "path-exists"},
+
+  "--manifest-extension":                   {},
+  "--segment-extension":                    {}
 }
 
 const argv_flag_aliases = {

package/hls-proxy/manifest_parser.js

@@ -110,7 +110,7 @@ const parse_HHMMSS_to_seconds = function(str) {
 //   prefetch_urls: [],
 //   modified_m3u8: ''
 // }
-const parse_manifest = function(m3u8_content, m3u8_url, referer_url, hooks, cache_segments, debug, vod_start_at_ms, redirected_base_url, should_prefetch_url) {
+const parse_manifest = function(m3u8_content, m3u8_url, referer_url, hooks, cache_segments, debug, vod_start_at_ms, redirected_base_url, should_prefetch_url, manifest_extension, segment_extension) {
   const m3u8_lines = m3u8_content.split(regexs.m3u8_line_separator)
   m3u8_content = null
 
@@ -123,7 +123,7 @@ const parse_manifest = function(m3u8_content, m3u8_url, referer_url, hooks, cach
       redirect_embedded_url(embedded_url, hooks, m3u8_url, debug)
       if (validate_embedded_url(embedded_url)) {
         finalize_embedded_url(embedded_url, vod_start_at_ms, debug)
-        encode_embedded_url(embedded_url, redirected_base_url, debug)
+        encode_embedded_url(embedded_url, redirected_base_url, debug, manifest_extension, segment_extension)
         get_prefetch_url(embedded_url, should_prefetch_url, prefetch_urls)
         modify_m3u8_line(embedded_url, m3u8_lines)
       }
@@ -330,13 +330,23 @@ const finalize_embedded_url = function(embedded_url, vod_start_at_ms, debug) {
   }
 }
 
-const encode_embedded_url = function(embedded_url, redirected_base_url, debug) {
-  embedded_url.encoded_url = (embedded_url.unencoded_url)
-    ? `${redirected_base_url}/${ utils.base64_encode(embedded_url.unencoded_url) }.${embedded_url.url_type || 'other'}`
-    : ''
+const encode_embedded_url = function(embedded_url, redirected_base_url, debug, manifest_extension, segment_extension) {
+  if (embedded_url.unencoded_url) {
+    let file_extension = embedded_url.url_type
+    if (file_extension) {
+      if (manifest_extension && (file_extension === 'm3u8'))
+        file_extension = manifest_extension
+      if (segment_extension && (file_extension === 'ts'))
+        file_extension = segment_extension
+    }
+
+    embedded_url.encoded_url = `${redirected_base_url}/${ utils.base64_encode(embedded_url.unencoded_url) }.${file_extension || 'other'}`
 
-  if (embedded_url.encoded_url)
     debug(3, 'redirecting (proxied):', embedded_url.encoded_url)
+  }
+  else {
+    embedded_url.encoded_url = ''
+  }
 }
 
 const get_prefetch_url = function(embedded_url, should_prefetch_url, prefetch_urls = []) {
@@ -362,7 +372,7 @@ const modify_m3u8_line = function(embedded_url, m3u8_lines) {
 }
 
 const modify_m3u8_content = function(params, segment_cache, m3u8_content, m3u8_url, referer_url, redirected_base_url) {
-  const {hooks, cache_segments, max_segments, debug_level} = params
+  const {hooks, cache_segments, max_segments, debug_level, manifest_extension, segment_extension} = params
 
   const {has_cache, get_time_since_last_access, is_expired, prefetch_segment} = segment_cache
 
@@ -419,7 +429,7 @@ const modify_m3u8_content = function(params, segment_cache, m3u8_content, m3u8_u
     : null
 
   {
-    const parsed_manifest = parse_manifest(m3u8_content, m3u8_url, referer_url, hooks, cache_segments, debug, vod_start_at_ms, redirected_base_url, should_prefetch_url)
+    const parsed_manifest = parse_manifest(m3u8_content, m3u8_url, referer_url, hooks, cache_segments, debug, vod_start_at_ms, redirected_base_url, should_prefetch_url, manifest_extension, segment_extension)
     is_vod          = !!parsed_manifest.meta_data.is_vod                  // default: false => hls live stream
     seg_duration_ms = parsed_manifest.meta_data.seg_duration_ms || 10000  // default: 10 seconds in ms
     prefetch_urls   = parsed_manifest.prefetch_urls

package/hls-proxy/segment_cache_storage/filesystem/index.js

@@ -1,56 +1,56 @@
-const crypto = require('crypto')
-const fs     = require('fs')
-const path   = require('path')
-
-const {denodeify} = require('@warren-bank/node-request')
-
-const $fs = {
-  writeFile: denodeify(fs.writeFile),
-  readFile:  denodeify(fs.readFile),
-  rm:        denodeify(fs.rm)
-}
-
-module.exports = function(dirpath) {
-
-  // synchronous (private)
-  const get_random_filename = (state) => {
-    let random_bytes, fname, fpath
-
-    while (true) {
-      random_bytes = get_random_bytes()
-      fname        = convert_random_bytes_to_filename(random_bytes)
-      fpath        = path.join(dirpath, fname)
-
-      if (!fs.existsSync(fpath)) {
-        state.fpath = fpath
-        return
-      }
-    }
-  }
-
-  // synchronous (private)
-  const get_random_bytes = () => crypto.randomBytes(30)
-
-  // synchronous (private)
-  const convert_random_bytes_to_filename = (buffer) => buffer.toString('base64').replaceAll('/', '_')
-
-  // async
-  const set = async (state, blob) => {
-    get_random_filename(state)
-
-    await $fs.writeFile(state.fpath, blob)
-  }
-
-  // async
-  const get = async (state) => {
-    return await $fs.readFile(state.fpath, {encoding: null})
-  }
-
-  // async
-  const remove = async (state) => {
-    await $fs.rm(state.fpath, {force: true})
-    delete state.fpath
-  }
-
-  return {set, get, remove}
-}
+const crypto = require('crypto')
+const fs     = require('fs')
+const path   = require('path')
+
+const {denodeify} = require('@warren-bank/node-request')
+
+const $fs = {
+  writeFile: denodeify(fs.writeFile),
+  readFile:  denodeify(fs.readFile),
+  rm:        denodeify(fs.rm)
+}
+
+module.exports = function(dirpath) {
+
+  // synchronous (private)
+  const get_random_filename = (state) => {
+    let random_bytes, fname, fpath
+
+    while (true) {
+      random_bytes = get_random_bytes()
+      fname        = convert_random_bytes_to_filename(random_bytes)
+      fpath        = path.join(dirpath, fname)
+
+      if (!fs.existsSync(fpath)) {
+        state.fpath = fpath
+        return
+      }
+    }
+  }
+
+  // synchronous (private)
+  const get_random_bytes = () => crypto.randomBytes(30)
+
+  // synchronous (private)
+  const convert_random_bytes_to_filename = (buffer) => buffer.toString('base64').replaceAll('/', '_')
+
+  // async
+  const set = async (state, blob) => {
+    get_random_filename(state)
+
+    await $fs.writeFile(state.fpath, blob)
+  }
+
+  // async
+  const get = async (state) => {
+    return await $fs.readFile(state.fpath, {encoding: null})
+  }
+
+  // async
+  const remove = async (state) => {
+    await $fs.rm(state.fpath, {force: true})
+    delete state.fpath
+  }
+
+  return {set, get, remove}
+}

package/hls-proxy/segment_cache_storage/index.js

@@ -1,14 +1,14 @@
-module.exports = function(params) {
-  const {cache_storage, cache_storage_fs_dirpath} = params
-
-  if (cache_storage) {
-    if (cache_storage === 'memory')
-      return require('./memory')()
-
-    if ((cache_storage === 'filesystem') && cache_storage_fs_dirpath)
-      return require('./filesystem')(cache_storage_fs_dirpath)
-  }
-
-  // default
-  return require('./memory')()
-}
+module.exports = function(params) {
+  const {cache_storage, cache_storage_fs_dirpath} = params
+
+  if (cache_storage) {
+    if (cache_storage === 'memory')
+      return require('./memory')()
+
+    if ((cache_storage === 'filesystem') && cache_storage_fs_dirpath)
+      return require('./filesystem')(cache_storage_fs_dirpath)
+  }
+
+  // default
+  return require('./memory')()
+}

package/hls-proxy/segment_cache_storage/memory/index.js

@@ -1,17 +1,17 @@
-module.exports = function() {
-
-  // async
-  const set = async (state, blob) => {
-    state.databuffer = blob
-  }
-
-  // async
-  const get = async (state) => state.databuffer
-
-  // async
-  const remove = async (state) => {
-    delete state.databuffer
-  }
-
-  return {set, get, remove}
-}
+module.exports = function() {
+
+  // async
+  const set = async (state, blob) => {
+    state.databuffer = blob
+  }
+
+  // async
+  const get = async (state) => state.databuffer
+
+  // async
+  const remove = async (state) => {
+    delete state.databuffer
+  }
+
+  return {set, get, remove}
+}

package/hls-proxy/utils.js

@@ -17,18 +17,25 @@ const base64_decode = function(str) {
 }
 
 const parse_req_url = function(params, req) {
-  const {is_secure, host} = params
+  const {is_secure, host, manifest_extension, segment_extension} = params
 
   const result = {redirected_base_url: '', url_type: '', url: '', referer_url: ''}
 
   const matches = regexs.req_url.exec( expressjs.get_proxy_req_url(req) )
 
   if (matches) {
-    result.redirected_base_url = `${ is_secure ? 'https' : 'http' }://${host || req.headers.host}${expressjs.get_base_req_url(req) || matches[1] || ''}`
+    result.redirected_base_url = `${ (is_secure || (host && host.endsWith(':443'))) ? 'https' : 'http' }://${host || req.headers.host}${expressjs.get_base_req_url(req) || matches[1] || ''}`
 
-    if (matches[3])
+    if (matches[3]) {
       result.url_type = matches[3].toLowerCase().trim()
 
+      if (manifest_extension && (result.url_type === manifest_extension))
+        result.url_type = 'm3u8'
+
+      if (segment_extension && (result.url_type === segment_extension))
+        result.url_type = 'ts'
+    }
+
     let url, url_lc, index
 
     url    = base64_decode( decodeURIComponent( matches[2] ) ).trim()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warren-bank/hls-proxy",
   "description": "Node.js server to proxy HLS video streams",
-  "version":     "3.4.0",
+  "version":     "3.4.2",
   "scripts": {
     "start":     "node hls-proxy/bin/hlsd.js",
     "sudo": "sudo node hls-proxy/bin/hlsd.js"