@warren-bank/hls-proxy 0.20.4 → 0.22.0

package/README.md

@@ -154,7 +154,7 @@ options:
     * HTTP proxy binds to: `80`
     * HTTPS proxy binds to: `443`
 * _--req-headers_ is the filepath to a JSON data _Object_ containing key:value pairs
-  * each _key_ is the name of an HTTP header to send in in every outbound request
+  * each _key_ is the name of an HTTP header to send in every outbound request
 * _--origin_ is the value of the corresponding HTTP request header
 * _--referer_ is the value of the corresponding HTTP request header
 * _--useragent_ is the value of the corresponding HTTP request header
@@ -201,6 +201,22 @@ options:
   * each _key_ is the name of a hook function
   * each _value_ is the implementation of the corresponding _Function_
   * hook function signatures:
+    * `"add_request_options": (url, is_m3u8) => request_options`
+      * conditionally add HTTP request options
+      * inputs:
+        * `url`
+          * string URL
+        * `is_m3u8`
+          * boolean that indicates whether `url` will request an HLS manifest
+      * return value:
+        * _Object_ having attributes that are combined with _--req-options_ and used to send the outbound request to `url`
+    * `"add_request_headers": (url, is_m3u8) => request_headers`
+      * conditionally add HTTP request headers
+      * return value:
+        * _Object_ containing key:value pairs that are combined with _--req-headers_
+          * each _key_ is the name of an HTTP header to send in the outbound request to `url`
+    * `"modify_m3u8_content": (m3u8_content, m3u8_url) => new_m3u8_content`
+      * conditionally modify the content of .m3u8 files __before__ they are parsed to extract URLs
     * `"redirect": (url) => new_url`
       * conditionally redirect the URLs encountered in .m3u8 files __before__ they are modified to pass through the proxy
     * `"prefetch": (url) => boolean`

package/hls-proxy/proxy.js

@@ -49,21 +49,30 @@ const proxy = function({server, host, is_secure, req_headers, req_options, hooks
     res.setHeader('Access-Control-Max-Age',           '86400')
   }
 
-  const get_request_options = function(url, referer_url) {
-    if (!req_options && !req_headers && !referer_url) return url
+  const get_request_options = function(url, is_m3u8, referer_url) {
+    const additional_req_options = (hooks && (hooks instanceof Object) && hooks.add_request_options && (typeof hooks.add_request_options === 'function'))
+      ? hooks.add_request_options(url, is_m3u8)
+      : null
+
+    const additional_req_headers = (hooks && (hooks instanceof Object) && hooks.add_request_headers && (typeof hooks.add_request_headers === 'function'))
+      ? hooks.add_request_headers(url, is_m3u8)
+      : null
+
+    if (!req_options && !additional_req_options && !req_headers && !additional_req_headers && !referer_url) return url
 
     const request_options = Object.assign(
       {},
       parse_url(url),
-      (req_options || {})
+      (req_options            || {}),
+      (additional_req_options || {})
     )
 
-    if (!req_headers && !referer_url) return request_options
-
     request_options.headers = Object.assign(
       {},
-      (request_options.headers || {}),
-      (req_headers || {}),
+      ((           req_options &&            req_options.headers) ?            req_options.headers : {}),
+      ((additional_req_options && additional_req_options.headers) ? additional_req_options.headers : {}),
+      (req_headers             || {}),
+      (additional_req_headers  || {}),
       (referer_url ? {"referer": referer_url, "origin": referer_url.replace(regexs.origin, '$1')} : {})
     )
 
@@ -94,6 +103,10 @@ const proxy = function({server, host, is_secure, req_headers, req_options, hooks
   )}
 
   const modify_m3u8_content = function(m3u8_content, m3u8_url, referer_url) {
+    if (hooks && (hooks instanceof Object) && hooks.modify_m3u8_content && (typeof hooks.modify_m3u8_content === 'function')) {
+      m3u8_content = hooks.modify_m3u8_content(m3u8_content, m3u8_url) || m3u8_content
+    }
+
     const base_urls = {
       "relative": m3u8_url.replace(/[\?#].*$/, '').replace(/[^\/]+$/, ''),
       "absolute": m3u8_url.replace(/(:\/\/[^\/]+).*$/, '$1')
@@ -470,7 +483,7 @@ const proxy = function({server, host, is_secure, req_headers, req_options, hooks
       }
     }
 
-    const options = get_request_options(url, referer_url)
+    const options = get_request_options(url, is_m3u8, referer_url)
     debug(1, 'proxying:', url)
     debug(3, 'm3u8:', (is_m3u8 ? 'true' : 'false'))
 

package/hls-proxy/segment_cache.js

@@ -166,7 +166,7 @@ module.exports = function({should_prefetch_url, debug, debug_level, request, get
       index = ts.length
       ts[index] = {key: get_privatekey_from_url(url), databuffer: false}
 
-      let options = get_request_options(url, referer_url)
+      let options = get_request_options(url, /* is_m3u8= */ false, referer_url)
       promise = request(options, '', {binary: true, stream: false})
       .then(({redirects, response}) => {
         debug(1, `prefetch (complete, ${response.length} bytes):`, debug_url)

package/package.json

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