@warren-bank/hls-proxy 3.6.1 → 3.6.3

package/README.md

@@ -1,4 +1,4 @@
-### [_HLS Proxy_](https://github.com/warren-bank/HLS-Proxy) : HTTP Live Streaming Proxy
+### [_Node.js HLS Proxy_](https://github.com/warren-bank/node-HLS-Proxy) : HTTP Live Streaming Proxy for the [_Node JS_ Runtime](https://nodejs.org/)
 
 #### Basic Functionality:
 
@@ -175,7 +175,7 @@ options:
     * _--tls-key_
     * _--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)
+    * [`./hls-proxy/servers/cert`](./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
@@ -445,7 +445,7 @@ options:
 #### How to: Install:
 
 ```bash
-git clone "https://github.com/warren-bank/HLS-Proxy.git"
+git clone "https://github.com/warren-bank/node-HLS-Proxy.git"
 cd "HLS-Proxy"
 npm install
 ```
@@ -627,24 +627,24 @@ curl --silent --insecure "$URL"
   * usage test result:
     * [doesn't appear to work with HTML5 video players or Chromecast](https://github.com/streamlink/streamlink/issues/1704#issuecomment-413661578)
     * the server starts and works as it was intended, but something about the format of the data it "streams" is incompatible
-    * [VLC](https://portableapps.com/apps/music_video/vlc_portable) can play the video stream from the server, and be used to [render the video on Chromecast](https://github.com/warren-bank/HLS-Proxy/blob/master/.related/.recipes/01.%20Streamlink/notes.txt)
+    * [VLC](https://portableapps.com/apps/music_video/vlc_portable) can play the video stream from the server, and be used to [render the video on Chromecast](./.related/.recipes/01.%20Streamlink/notes.txt)
 
 - - - -
 
 #### Major Versions:
 
 * `v1.x`
-  - commit history is in branch: [`v01`](https://github.com/warren-bank/HLS-Proxy/commits/v01)
+  - commit history is in branch: [`v01`](https://github.com/warren-bank/node-HLS-Proxy/commits/v01)
   - summary:
     * 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 version: v8.6.0 (and higher)
-      - transitive [dependency](https://github.com/warren-bank/HLS-Proxy/blob/v1.0.1/package.json#L13-L14) requirements:
+      - transitive [dependency](https://github.com/warren-bank/node-HLS-Proxy/blob/v1.0.1/package.json#L13-L14) requirements:
         * v08.06.00+: [`@warren-bank/node-process-argv`](https://github.com/warren-bank/node-process-argv#requirements)
         * v08.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)
+  - commit history is in branch: [`v02`](https://github.com/warren-bank/node-HLS-Proxy/commits/v02)
   - summary:
     * m3u8 manifest parser uses regex patterns to identify all URL patterns without any special knowledge of the m3u8 manifest specification
     * internal `proxy` module exports an Object containing event listeners to process requests that can be either:
@@ -653,11 +653,11 @@ curl --silent --insecure "$URL"
         * 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 version: v8.6.0 (and higher)
-      - transitive [dependency](https://github.com/warren-bank/HLS-Proxy/blob/v2.0.3/package.json#L13-L14) requirements:
+      - transitive [dependency](https://github.com/warren-bank/node-HLS-Proxy/blob/v2.0.3/package.json#L13-L14) requirements:
         * v08.06.00+: [`@warren-bank/node-process-argv`](https://github.com/warren-bank/node-process-argv#requirements)
         * v08.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)
+  - commit history is in branch: [`v03`](https://github.com/warren-bank/node-HLS-Proxy/commits/v03)
   - summary:
     * m3u8 manifest parser uses special knowledge of the m3u8 manifest specification to contextually identify URLs
     * internal `proxy` module exports an Object containing event listeners to process requests that can be either:
@@ -667,7 +667,7 @@ curl --silent --insecure "$URL"
         * the use of nested routers is supported
   - system requirements:
     * Node.js version: v8.6.0 (and higher)
-      - transitive [dependency](https://github.com/warren-bank/HLS-Proxy/blob/v3.5.1/package.json#L13-L14) requirements:
+      - transitive [dependency](https://github.com/warren-bank/node-HLS-Proxy/blob/v3.5.1/package.json#L13-L14) requirements:
         * v08.06.00+: [`@warren-bank/node-process-argv`](https://github.com/warren-bank/node-process-argv#requirements)
         * v08.06.00+: [`@warren-bank/node-request`](https://github.com/warren-bank/node-request#requirements)
 

package/hls-proxy/manifest_parser.js

@@ -118,15 +118,16 @@ const parse_manifest = function(m3u8_content, m3u8_url, referer_url, querystring
 
   const meta_data     = {}
   const embedded_urls = extract_embedded_urls(m3u8_lines, m3u8_url, referer_url, (cache_segments ? meta_data : null))
-  const qs_headers    = !!querystring_req_headers ? utils.base64_encode(JSON.stringify(querystring_req_headers)) : null
   const prefetch_urls = []
 
   if (embedded_urls && Array.isArray(embedded_urls) && embedded_urls.length) {
+    const querystring = get_querystring(querystring_req_headers, qs_password)
+
     embedded_urls.forEach(embedded_url => {
       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, hooks, redirected_base_url, debug, manifest_extension, segment_extension, qs_headers, qs_password)
+        encode_embedded_url(embedded_url, hooks, redirected_base_url, debug, manifest_extension, segment_extension, querystring)
         get_prefetch_url(embedded_url, should_prefetch_url, prefetch_urls)
         modify_m3u8_line(embedded_url, m3u8_lines)
       }
@@ -234,6 +235,26 @@ const extract_meta_data = function(meta_data, m3u8_line, matching_landmark) {
   }
 }
 
+const get_querystring = function(querystring_req_headers, qs_password) {
+  const qs_headers = !!querystring_req_headers ? utils.base64_encode(JSON.stringify(querystring_req_headers)) : null
+  let qs_pairs     = []
+  let querystring  = ''
+
+  if (qs_headers)
+    qs_pairs.push(['headers', qs_headers])
+
+  if (qs_password)
+    qs_pairs.push(['password', qs_password])
+
+  if (qs_pairs.length) {
+    qs_pairs = qs_pairs.map(pair => `${pair[0]}=${encodeURIComponent(pair[1])}`)
+
+    querystring = '?' + qs_pairs.join('&')
+  }
+
+  return querystring
+}
+
 const redirect_embedded_url = function(embedded_url, hooks, m3u8_url, debug) {
   if (hooks && (hooks instanceof Object) && hooks.redirect && (typeof hooks.redirect === 'function')) {
     let url, url_type, referer_url, result
@@ -333,7 +354,7 @@ const finalize_embedded_url = function(embedded_url, vod_start_at_ms, debug) {
   }
 }
 
-const encode_embedded_url = function(embedded_url, hooks, redirected_base_url, debug, manifest_extension, segment_extension, qs_headers, qs_password) {
+const encode_embedded_url = function(embedded_url, hooks, redirected_base_url, debug, manifest_extension, segment_extension, querystring) {
   if (embedded_url.unencoded_url) {
     let file_extension = embedded_url.url_type
     if (file_extension) {
@@ -353,15 +374,8 @@ const encode_embedded_url = function(embedded_url, hooks, redirected_base_url, d
       debug(3, 'redirecting (proxied, post-hook):', embedded_url.encoded_url)
     }
 
-    let qs_pairs = []
-    if (qs_headers)
-      qs_pairs.push(['headers', qs_headers])
-    if (qs_password)
-      qs_pairs.push(['password', qs_password])
-    if (qs_pairs.length) {
-      qs_pairs = qs_pairs.map(pair => `${pair[0]}=${encodeURIComponent(pair[1])}`)
-
-      embedded_url.encoded_url += '?' + qs_pairs.join('&')
+    if (querystring) {
+      embedded_url.encoded_url += querystring
       debug(3, 'redirecting (proxied, with querystring):', embedded_url.encoded_url)
     }
   }

package/hls-proxy/servers/start_http.js

@@ -5,7 +5,7 @@ const start_server = function({port}) {
 
   const server = http.createServer()
 
-  server.listen(port, function () {
+  server.listen(port, '0.0.0.0', function () {
     console.log(`HTTP server is listening on port: ${port}`)
   })
 

package/hls-proxy/servers/start_https.js

@@ -18,7 +18,7 @@ const start_server = function({port, tls_cert, tls_key, tls_pass}) {
 
   const server = https.createServer(ssl_options)
 
-  server.listen(port, function () {
+  server.listen(port, '0.0.0.0', function () {
     console.log(`HTTPS server is listening on port: ${port}`)
   })
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warren-bank/hls-proxy",
   "description": "Node.js server to proxy HLS video streams",
-  "version":     "3.6.1",
+  "version":     "3.6.3",
   "scripts": {
     "start":     "node hls-proxy/bin/hlsd.js",
     "sudo": "sudo node hls-proxy/bin/hlsd.js"
@@ -23,12 +23,12 @@
     "email":  "warren.r.bank@gmail.com",
     "url":    "https://github.com/warren-bank"
   },
-  "homepage": "https://github.com/warren-bank/HLS-Proxy",
+  "homepage": "https://github.com/warren-bank/node-HLS-Proxy",
   "repository": {
     "type":   "git",
-    "url":    "https://github.com/warren-bank/HLS-Proxy"
+    "url":    "https://github.com/warren-bank/node-HLS-Proxy"
   },
   "bugs": {
-    "url":    "https://github.com/warren-bank/HLS-Proxy/issues"
+    "url":    "https://github.com/warren-bank/node-HLS-Proxy/issues"
   }
 }