homebridge-lib 6.3.7 → 6.3.8

package/lib/UpnpClient.js

@@ -1,217 +0,0 @@
-// homebridge-lib/lib/UpnpClient.js
-//
-// Library for Homebridge plugins.
-// Copyright © 2018-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const homebridgeLib = require('../index')
-
-const dgram = require('dgram')
-const events = require('events')
-
-const listener = {}
-
-// Convert raw UPnP message to message object.
-function convert (rawMessage) {
-  const message = {}
-  const lines = rawMessage.toString().trim().split('\r\n')
-  if (lines && lines[0]) {
-    message.status = lines[0]
-    for (const line of lines) {
-      const fields = line.split(': ')
-      if (fields.length === 2) {
-        message[fields[0].toLowerCase()] = fields[1]
-      }
-    }
-  }
-  return message
-}
-
-/** Universal Plug and Play client.
-  * @extends EventEmitter
-  */
-class UpnpClient extends events.EventEmitter {
-  /** Create a new instance of a Universal Plug and Play client.
-    * @param {object} params - Paramters.
-    * @param {function} [params.filter=() => { return true }] - Function to
-    * filter which UPnP messages should result in a
-    * {@link UpnpClient#event:deviceAlive deviceAlive} or a
-    * {@link UpnpClient#event:deviceFound deviceFound} event.
-    * @param {integer} [params.timemout=5] - Timeout (in seconds) for
-    * {@link UpnpClient@search search()} to listen for responses.
-    * @param {string} [params.class='upnp:rootdevice'] - Filter on class which UPnP
-    * messages should result in a
-    * {@link UpnpClient#event:deviceAlive deviceAlive} or a
-    * {@link UpnpClient#event:deviceFound deviceFound} event.
-    */
-  constructor (params = {}) {
-    super()
-    this._options = {
-      filter: () => { return true },
-      hostname: '239.255.255.250',
-      port: 1900,
-      timeout: 5,
-      class: 'upnp:rootdevice'
-    }
-    const optionParser = new homebridgeLib.OptionParser(this._options)
-    optionParser.functionKey('filter')
-    // optionParser.hostKey() // TODO: need global listener per hostname.
-    optionParser.stringKey('class', true)
-    optionParser.intKey('timeout', 1, 60)
-    optionParser.parse(params)
-    this.requestId = 0
-  }
-
-  _onError (error) {
-    listener.socket = null
-    /** Emitted in case of error.
-      * @event UpnpClient#error
-      * @param {Error} error - The error.
-      */
-    this.emit('error', error)
-  }
-
-  _onListening () {
-    if (listener.init === this) {
-      listener.host = listener.socket.address().address +
-        ':' + listener.socket.address().port
-      listener.socket.addMembership(this._options.hostname)
-      delete listener.init
-    }
-    /** Emitted when listening to UPnP alive broadcasts.
-      * @event UpnpClient#listening
-      * @param {string} host - IP address and port listening on.
-      */
-    this.emit('listening', listener.host)
-  }
-
-  _onMessage (buffer, rinfo) {
-    const rawMessage = buffer.toString().trim()
-    const message = convert(rawMessage)
-    if (
-      message.status !== 'NOTIFY * HTTP/1.1' ||
-      message.nts !== 'ssdp:alive'
-    ) {
-      return
-    }
-    if (
-      this._options.class !== 'ssdp:all' &&
-      message.nt !== this._options.class
-    ) {
-      return
-    }
-    if (this._options.filter(message)) {
-      /** Emitted for each alive message received, that passes the filers.
-        * @event UpnpClient#deviceAlive
-        * @param {string} address - IP address of the device.
-        * @param {object} message - The parsed message.
-        * @param {string} rawMessage - The raw message.
-        */
-      this.emit('deviceAlive', rinfo.address, message, rawMessage)
-    }
-  }
-
-  /** Listen for UPnP alive broadcast messages.
-    */
-  async listen () {
-    if (listener.socket == null) {
-      listener.socket = dgram.createSocket({ type: 'udp4', reuseAddr: true })
-      listener.init = this
-      listener.socket.bind(this._options.port)
-    } else if (listener.init != null) {
-      const [host] = await events.once(listener.init, 'listening')
-      this.emit('listening', host)
-    } else {
-      this.emit('listening', listener.host)
-    }
-
-    listener.socket
-      .on('error', this._onError.bind(this))
-      .on('listening', this._onListening.bind(this))
-      .on('message', this._onMessage.bind(this))
-  }
-
-  /** Stop listening for UPnP alive broadcast messages.
-    */
-  async stopListen () {
-    if (listener.socket != null) {
-      listener.socket
-        .removeListener('error', this._onError.bind(this))
-        .removeListener('listening', this._onListening.bind(this))
-        .removeListener('message', this._onMessage.bind(this))
-      this.emit('stopListening', listener.host)
-    }
-  }
-
-  /** Issue a UPnP search message and listen for responses.
-    */
-  search () {
-    const socket = dgram.createSocket({ type: 'udp4' })
-    const request = Buffer.from([
-      'M-SEARCH * HTTP/1.1',
-      `HOST: ${this._options.hostname}:${this._options.port}`,
-      'MAN: "ssdp:discover"',
-      `MX: ${this._options.timeout}`,
-      `ST: ${this._options.class}`,
-      ''
-    ].join('\r\n'))
-    let host
-
-    socket
-      .on('error', (error) => {
-        this.emit('error', error)
-      })
-      .on('listening', () => {
-        host = socket.address().address + ':' + socket.address().port
-        /** Emitted when searching for UPnP devices.
-          * @event UpnpClient#searching
-          * @param {string} host - IP address and port listening on.
-          */
-        this.emit('searching', host)
-      })
-      .on('message', (buffer, rinfo) => {
-        const rawMessage = buffer.toString().trim()
-        const message = convert(rawMessage)
-        if (message.status !== 'HTTP/1.1 200 OK') {
-          return
-        }
-        if (
-          this._options.class !== 'ssdp:all' &&
-          message.st !== this._options.class
-        ) {
-          return
-        }
-        if (this._options.filter(message)) {
-          /** Emitted for each response received, that passes the filers.
-            * @event UpnpClient#deviceFound
-            * @param {string} address - IP address of the device.
-            * @param {object} message - The parsed message.
-            * @param {string} rawMessage - The raw message.
-            */
-          this.emit('deviceFound', rinfo.address, message, rawMessage)
-        }
-      })
-
-    const requestInfo = {
-      host: this._options.hostname + ':' + this._options.port,
-      id: ++this.requestId,
-      method: 'M-SEARCH',
-      resource: '*'
-    }
-    this.emit('request', requestInfo)
-    socket.send(
-      request, 0, request.length, this._options.port, this._options.hostname
-    )
-    setTimeout(() => {
-      socket.close()
-      /** Emitted when searching has finished.
-        * @event UpnpClient#searchDone
-        * @param {string} host - IP address and port listening on.
-        */
-      this.emit('searchDone', host)
-    }, this._options.timeout * 1000)
-  }
-}
-
-module.exports = UpnpClient

package/lib/UpnpTool.js

@@ -1,148 +0,0 @@
-#!/usr/bin/env node
-
-// homebridge-lib/cli/upnp.js
-//
-// Logger for UPnP device announcements.
-// Copyright © 2018-2023 Erik Baauw. All rights reserved.
-
-'use strict'
-
-const homebridgeLib = require('../index')
-
-const { b, u } = homebridgeLib.CommandLineTool
-
-const usage = `${b('upnp')} [${b('-hVDadnprsz')}] [${b('-c')} ${u('class')}] [${b('-t')} ${u('timeout')}]`
-const help = `UPnP tool.
-
-Search for UPnP devices and print found devices as JSON.
-When running as daemon or service, log UPnP alive broadcasts as JSON.
-
-Usage: ${usage}
-
-Parameters:
-  ${b('-h')}, ${b('--help')}
-  Print this help and exit.
-
-  ${b('-V')}, ${b('--version')}
-  Print version and exit.
-
-  ${b('-D')}, ${b('--debug')}
-  Print debug messages.
-
-  ${b('-a')}, ${b('--all')}
-  Short for ${b('-c ssdp:all')}.
-
-  ${b('-c')} ${u('class')}, ${b('--class=')}${u('class')}
-  Search for ${u('class')} instead of default ${b('ssdp:rootdevice')}.
-
-  ${b('-d')}, ${b('--daemon')}
-  Run as daemon.  Listen for UPnP alive broadcasts instead of searching.
-
-  ${b('-n')}, ${b('--noWhiteSpace')}
-  Do not include spaces nor newlines in JSON output.
-
-  ${b('-p')}, ${b('--hue')}
-  Search for Philips Hue bridges and/or deCONZ gateways.
-
-  ${b('-r')}, ${b('--raw')}
-  Do not parse messages, output raw message data instead of JSON.
-
-  ${b('-s')}, ${b('--service')}
-  Run as daemon.  Listen for UPnP alive broadcasts instead of searching.
-
-  ${b('-t')} ${u('timeout')}, ${b('--timeout=')}${u('timeout')}
-  Search for ${u('timeout')} seconds instead of default ${b('5')}.
-
-  ${b('-z')}, ${b('--sonos')}
-  Search for Sonos Zone Players.`
-
-class UpnpTool extends homebridgeLib.CommandLineTool {
-  constructor () {
-    super()
-    this.usage = usage
-    this.options = {
-      noWhiteSpace: false
-    }
-    this.upnp = {}
-  }
-
-  parseArguments () {
-    const parser = new homebridgeLib.CommandLineParser()
-    parser
-      .help('h', 'help', help)
-      .version('V', 'version')
-      .flag('D', 'debug', () => { this.setOptions({ debug: true }) })
-      .flag('a', 'all', (key) => { this.upnp.class = 'ssdp:all' })
-      .option('c', 'class', (value, key) => { this.upnp.class = value })
-      .flag('d', 'daemon', (key) => { this.options.mode = 'daemon' })
-      .flag('n', 'noWhiteSpace', () => { this.options.noWhiteSpace = true })
-      .flag('r', 'raw', (key) => { this.options.raw = true })
-      .flag('s', 'service', (key) => { this.options.mode = 'service' })
-      .option('t', 'timeout', (value, key) => {
-        this.upnp.timeout = homebridgeLib.OptionParser.toInt(
-          'timeout', value, 1, 60, true
-        )
-      })
-      .flag('p', 'hue', (key) => {
-        this.upnp.filter = (message) => {
-          return /^[0-9A-F]{16}$/.test(message['hue-bridgeid'])
-        }
-      })
-      .flag('z', 'sonos', (key) => {
-        this.upnp.class = 'urn:schemas-upnp-org:device:ZonePlayer:1'
-      })
-      .parse()
-  }
-
-  async destroy () {
-    if (this.upnpClient == null) {
-      return
-    }
-    return this.upnpClient.stopListen()
-  }
-
-  async main () {
-    try {
-      this.parseArguments()
-      const jsonFormatter = new homebridgeLib.JsonFormatter({
-        noWhiteSpace: this.options.noWhiteSpace
-      })
-      this.upnpClient = new homebridgeLib.UpnpClient(this.upnp)
-      this.upnpClient
-        .on('error', (error) => { this.error(error) })
-        .on('listening', (host) => { this.debug('listening on %s', host) })
-        .on('stopListening', (host) => { this.debug('stopped listening on %s', host) })
-        .on('deviceAlive', (address, obj, message) => {
-          if (!this.options.raw) {
-            message = jsonFormatter.stringify(obj)
-          }
-          this.log('%s: %s', address, message)
-        })
-        .on('searching', (host) => { this.debug('listening on %s', host) })
-        .on('request', (request) => {
-          this.debug(
-            '%s: request %d: %s %s', request.host, request.id,
-            request.method, request.resource
-          )
-        })
-        .on('searchDone', (host) => { this.debug('search done') })
-        .on('deviceFound', (address, obj, message) => {
-          if (!this.options.raw) {
-            message = jsonFormatter.stringify(obj)
-          }
-          this.print('%s: %s', address, message)
-        })
-
-      if (this.options.mode) {
-        this.setOptions({ mode: this.options.mode })
-        this.upnpClient.listen()
-      } else {
-        this.upnpClient.search()
-      }
-    } catch (error) {
-      await this.fatal(error)
-    }
-  }
-}
-
-module.exports = UpnpTool