iobroker.squeezeboxrpc 2.0.2 → 3.0.0

package/lib/squeezenode/squeezerequest.js

@@ -1,273 +0,0 @@
-/*
- The MIT License (MIT)
-
- Copyright (c) 2013-2015 Piotr Raczynski, pio[dot]raczynski[at]gmail[dot]com
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
- */
-
-const jayson = require('jayson');
-// const inherits = require('super');
-let AWS;
-
-// address "<http|https>://|hostbame[:port]"
-// transport "<[0-9]*|sqs[://region]|ssh://password:username@hostname:port"
-// sqs password = {send: "Queue URL, recv "Queue URL" }
-
-/**
- * Request function for Squeezebox server
- *
- * @param address The address of the Squeezebox server
- * @param port The port number, or a string of the form "ssh://password:username@hostname:port" for an SSH tunnel
- * @param username The username for basic authentication
- * @param password The password for basic authentication
- */
-function SqueezeRequest(address, port, username, password) {
-    // FIXME URI
-    this.address = typeof address !== 'string' ? 'localhost' : address;
-    this.port = port !== undefined ? port : 9000;
-    this.username = username;
-    this.password = password;
-    this.id = `squeezenode.${process.pid}`; // FIXME lamba seems to be 1 always add instance?
-    this.queue = [];
-    let client;
-    /**
-     * Function to handle responses
-     *
-     * @param err An error message
-     * @param reply The reply
-     * @param callback The function to call with the result
-     */
-    function handle(err, reply, callback) {
-        let result = {};
-        if (err) {
-            result = err;
-            result.ok = false;
-        } else {
-            result = reply;
-            result.ok = true;
-        }
-
-        if (callback) {
-            callback(result);
-        }
-    }
-
-    // Set up to use an AWS SQS queue URL to communicate
-    if (typeof port === 'string' && port.substr(0, 3) === 'ssh') {
-        const { URL } = require('node:url');
-        const turl = new URL(this.port);
-        const surl = new URL(this.address);
-        const fp = 9192;
-        const Tunnel = require('tunnel-ssh');
-        const tunnel_config = {
-            // transport url
-            host: turl.hostname,
-            port: turl.port ? turl.port : 22,
-            username: turl.username,
-            // server url
-            dstPort: surl.port ? surl.port : 9000,
-            dstHost: surl.hostname,
-            // forward url?
-            localPort: fp,
-            //localHost: ,
-            keepAlive: true,
-        };
-        const tp = decodeURIComponent(turl.password);
-        console.log(tp);
-        if (tp.substr(0, 7) === 'file://') {
-            tunnel_config['privateKey'] = require('node:fs').readFileSync(tp.substr(7));
-        } else {
-            tunnel_config['password'] = turl.password;
-        }
-        console.log(tunnel_config);
-        this.ssh_tunnel = Tunnel(tunnel_config, function (error) {
-            if (error) {
-                console.log(error);
-            }
-        });
-
-        // Use a listener to handle errors outside the callback
-        this.ssh_tunnel.on('error', function (err) {
-            console.error('SSH Tunnel:', err);
-            console.log('Tunnel error');
-        });
-        this.address = `${surl.protocol}//localhost`;
-        this.port = fp;
-        console.log(surl);
-    }
-
-    if (typeof this.port === 'string' && this.port.substr(0, 6) === 'awssqs') {
-        AWS = require('aws-sdk');
-        this.request = request_sqs;
-        // FIXME decode region from url
-        this.sqs = new AWS.SQS({ region: 'us-west-2' });
-        this.sendq = { QueueUrl: password.send, MessageGroupId: this.id };
-        this.recvq = { QueueUrl: password.recv, WaitTimeSeconds: 0, MaxNumberOfMessages: 10 };
-        this.reciving = true;
-
-        this.sqs.receiveMessage(this.recvq, function (err, reply) {
-            this.recvq.MaxNumberOfMessages = 1;
-            this.recvq.WaitTimeSeconds = 20;
-            if (reply.Messages) {
-                let msg = reply.Messages.pop();
-                while (msg) {
-                    const deleteParams = {
-                        QueueUrl: this.recvq.QueueUrl,
-                        ReceiptHandle: msg.ReceiptHandle,
-                    };
-                    this.sqs.deleteMessage(deleteParams, function (/* err, data */) {
-                        //
-                    });
-                    msg = reply.Messages.pop();
-                }
-            }
-            request_sqs_dispatch_queue();
-        }); //Drain Q.
-    } else {
-        // Use JSON RPC to communicate
-        this.request = request_rpc;
-
-        const jsonrpc =
-            typeof this.port === 'number' ? `${this.address}:${this.port}/jsonrpc.js` : `${this.address}/jsonrpc.js`;
-        client =
-            this.address.substr(0, 5) === 'https'
-                ? jayson.client.https(jsonrpc)
-                : (client = jayson.client.http(jsonrpc));
-        client.options.version = 1;
-
-        // FIXME URL
-        // Add a header for basic authentication if a username and password are given
-        if (username && password) {
-            if (!client.options.headers) {
-                client.options.headers = {};
-            }
-            client.options.headers['Authorization'] = formatBasicHeader(username, password);
-        }
-    }
-
-    /**
-     * Request function for JSON RPC
-     *
-     * @param player The target player
-     * @param params Request parameters
-     * @param callback The function to call with the result
-     */
-
-    function request_rpc(player, params, callback) {
-        client.request('slim.request', [player, params], this.id, function (err, reply) {
-            handle(err, reply, callback);
-        });
-    }
-
-    /**
-     * Request function to use AWS SQS
-     *
-     * @param player The target player
-     * @param params Request parameters
-     * @param callback The function to call with the result
-     */
-
-    function request_sqs_dispatch(player, params, callback) {
-        this.sendq['MessageBody'] = JSON.stringify({
-            params: [player, params],
-            id: this.id + process.hrtime(),
-            version: '1.0',
-            method: 'slim.request',
-        }); // FIXME id not on pid but an uuid? for instrance from env?
-        this.sendq['MessageDeduplicationId'] = this.sendq.MessageGroupId + process.hrtime();
-        //console.log("send ",that.sendq['MessageBody']);
-        this.sqs.sendMessage(this.sendq, function (err, data) {
-            if (err) {
-                handle(err, data, callback);
-                console.error('Send Error ', err);
-            } else {
-                // successful response - callback for reply
-                this.reciving = true;
-                this.sqs.receiveMessage(this.recvq, function (err, reply) {
-                    //console.log("reply data ",reply);
-                    let message_data = {};
-                    if (reply.Messages) {
-                        //id check?
-
-                        message_data = reply.Messages.pop();
-
-                        //delete and drain?
-
-                        let msg = message_data;
-                        message_data = JSON.parse(message_data.Body);
-                        //console.log("reply ",message_data);
-                        while (msg) {
-                            const deleteParams = {
-                                QueueUrl: this.recvq.QueueUrl,
-                                ReceiptHandle: msg.ReceiptHandle,
-                            };
-                            // FIXME delete error
-                            this.sqs.deleteMessage(deleteParams, function (err /* , data */) {
-                                if (err) {
-                                    console.error('Delete Error', err);
-                                } else {
-                                    //console.log("Message Deleted", data);
-                                }
-                            });
-                            msg = reply.Messages.pop();
-                        }
-                    } else {
-                        console.warn('no msgs ', err);
-                        err = 'No reply message recvied';
-                    }
-
-                    handle(err, message_data, callback);
-                    request_sqs_dispatch_queue();
-                });
-            }
-        });
-    }
-
-    // We need to serialise requests and responces for queue use
-
-    function request_sqs(player, params, callback) {
-        if (this.reciving) {
-            this.queue.push([player, params, callback]);
-        } else {
-            request_sqs_dispatch(player, params, callback);
-        }
-    }
-
-    function request_sqs_dispatch_queue() {
-        const args = this.queue.pop();
-        if (args) {
-            request_sqs_dispatch.apply(null, args);
-        } else {
-            this.reciving = false;
-        }
-    }
-}
-
-/**
- * Function to format the header for basic authentication.
- */
-
-function formatBasicHeader(username, password) {
-    const tok = `${username}:${password}`;
-    const hash = new Buffer.from(tok).toString('base64');
-    return `Basic ${hash}`;
-}
-
-module.exports = SqueezeRequest;

package/lib/squeezenode/squeezeserver.js

@@ -1,352 +0,0 @@
-/*
- The MIT License (MIT)
-
- Copyright (c) 2013 Piotr Raczynski, pio[dot]raczynski[at]gmail[dot]com
-
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to deal
- in the Software without restriction, including without limitation the rights
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
- */
-
-const inherits = require('super');
-const fs = require('node:fs');
-const SqueezeRequest = require(`${__dirname}/squeezerequest`);
-const SqueezePlayer = require(`${__dirname}/squeezeplayer`);
-
-/**
- * Create a SqueezeServer object
- *
- * @param address The URL of the server
- * @param port The port that the server listens on
- * @param username The username for authentication
- * @param password The password for authentication
- * @param sa A flag to skip apps
- * @param sp A flag to skip players
- */
-function SqueezeServer(address, port, username, password, sa, sp) {
-    SqueezeServer.super_.apply(this, arguments);
-    const defaultPlayer = '00:00:00:00:00:00';
-    this.players = [];
-    this.apps = [];
-    const subs = {};
-
-    /**
-     * Subscribe to an event on a channel
-     *
-     * @param channel The channel that received the event
-     * @param sub The callback for the event
-     */
-
-    this.on = function (channel, sub) {
-        subs[channel] = subs[channel] || [];
-        subs[channel].push(sub);
-    };
-
-    /**
-     * Send an event.
-     *
-     * @param channel The even channel
-     */
-
-    this.emit = function (channel) {
-        const args = [].slice.call(arguments, 1);
-        for (const sub in subs[channel]) {
-            subs[channel][sub].apply(void 0, args);
-        }
-    };
-
-    /**
-     * Method to the the number of players.
-     *
-     * @param callback The function to call with the result.
-     */
-
-    this.getPlayerCount = function (callback) {
-        this.request(defaultPlayer, ['player', 'count', '?'], callback);
-    };
-
-    /**
-     * Method to get the ID of a player given it's index
-     *
-     * @param index The index of the player to get the ID for
-     * @param callback The function to call with the result.
-     */
-
-    this.getPlayerId = function (index, callback) {
-        this.request(defaultPlayer, ['player', 'id', index, '?'], callback);
-    };
-
-    /**
-     * Method to get the IP address of a player
-     *
-     * @param playerId The ID or index of the player
-     * @param callback The function to call with the result.
-     */
-
-    this.getPlayerIp = function (playerId, callback) {
-        this.request(defaultPlayer, ['player', 'ip', playerId, '?'], callback);
-    };
-
-    /**
-     * Method to get the name of a player.
-     *
-     * @param playerId The ID or index of the player
-     * @param callback The function to call with the result.
-     */
-
-    this.getPlayerName = function (playerId, callback) {
-        this.request(defaultPlayer, ['player', 'name', playerId, '?'], callback);
-    };
-
-    /**
-     * Get a list of the synchronization group members
-     *
-     * @param callback The function to call with the result.
-     */
-
-    this.getSyncGroups = function (callback) {
-        this.request(defaultPlayer, ['syncgroups', '?'], callback);
-    };
-
-    /**
-     * Get a list of the apps installed in the server
-     *
-     * @param callback The function to call with the result.
-     */
-
-    this.getApps = function (callback) {
-        this.request(defaultPlayer, ['apps', 0, 100], callback);
-    };
-
-    //
-
-    /**
-     * Get the content of a music folder.
-     *
-     * @param folderId The ID of the folder to get. Pass 0 or empty string "" to display root of music folder
-     * @param callback The function to call with the result.
-     */
-
-    this.musicfolder = function (folderId, callback) {
-        this.request(defaultPlayer, ['musicfolder', 0, 100, `folder_id:${folderId}`], callback);
-    };
-
-    /**
-     * Get a information about the players.
-     *
-     * @param callback The function to call with the result.
-     */
-
-    this.getPlayers = callback => {
-        this.request(defaultPlayer, ['players', 0, 100], function (reply) {
-            if (reply.ok) {
-                reply.result = reply.result.players_loop;
-            }
-            callback(reply);
-        });
-    };
-
-    /**
-     * Get a list of the artists from the server
-     *
-     * @param callback The callback to call with the result
-     * @param limit The maximum number of results
-     */
-
-    this.getArtists = (callback, limit) => {
-        this.request(defaultPlayer, ['artists', 0, limit], function (reply) {
-            if (reply.ok) {
-                reply.result = reply.result.artists_loop;
-            }
-            callback(reply);
-        });
-    };
-
-    /**
-     * Get a list of the albums from the server
-     *
-     * @param callback The callback to call with the result
-     * @param limit The maximum number of results
-     */
-
-    this.getAlbums = (callback, limit) => {
-        this.request(defaultPlayer, ['albums', 0, limit], function (reply) {
-            if (reply.ok) {
-                reply.result = reply.result.albums_loop;
-            }
-            callback(reply);
-        });
-    };
-
-    /**
-     * Get a list of the genre's from the server
-     *
-     * @param callback The callback to call with the result
-     * @param limit The maximum number of results
-     */
-
-    this.getGenres = (callback, limit) => {
-        this.request(defaultPlayer, ['genres', 0, limit], function (reply) {
-            if (reply.ok) {
-                reply.result = reply.result.genres_loop;
-            }
-            callback(reply);
-        });
-    };
-
-    /**
-     * Get a 'info' list from the server
-     *
-     * @param callback The callback to call with the result
-     * @param limit The maximum number of results
-     * @param slot The query to make to the server [genres, albums, artists, playlists ]
-     */
-
-    this.getInfo = (callback, limit, slot) => {
-        this.request(defaultPlayer, [slot, 0, limit], function (reply) {
-            if (reply.ok) {
-                reply.result = reply.result[`${slot}_loop`];
-            }
-            callback(reply);
-        });
-    };
-
-    this.registerPlayers = players => {
-        for (const pl in players) {
-            if (!this.players[players[pl].playerid]) {
-                // player not on the list
-                this.players[players[pl].playerid] = new SqueezePlayer(
-                    players[pl].playerid,
-                    players[pl].name,
-                    this.address,
-                    this.port,
-                    this.username,
-                    this.password,
-                );
-            }
-        }
-    };
-
-    /**
-     * Get Player oject for name, needs the players registred and normisles names with a lc search removeving puntuation
-     *
-     * @param name string
-     * @param only reten the one player if only one
-     */
-    this.findPlayerObjectByName = function (name, only) {
-        name = this.normalizePlayer(name);
-
-        // Look for the player in the players list that matches the given name. Then return the corresponding player object
-        // from the squeezeserver stored by the player's id
-
-        for (const id in this.players) {
-            if (
-                this.normalizePlayer(this.players[id].name) === name || // name matches the requested player
-                (name === '' && only && this.players.length === 1) // name is undefined and there's only one player,
-                // so assume that's the one we want.
-            ) {
-                return this.players[id];
-            }
-        }
-        return undefined;
-    };
-
-    /**
-     *  Do any necessary clean up of player names
-     *
-     * @param playerName The name of the player to clean up
-     * @param filter optional fn(str) returns str
-     * @returns The normalized player name
-     */
-
-    this.normalizePlayer = function (playerName) {
-        playerName || (playerName = ''); // protect against `playerName` being undefined
-        playerName = playerName.replace('-', ' ');
-        playerName = playerName.replace('   ', '  ');
-        playerName = playerName.replace('  ', '  ');
-        playerName = playerName.toLowerCase(playerName);
-
-        return playerName;
-    };
-
-    /**
-     * Find out if we can contact the server and get some basic information
-     *
-     * @param skipApps A flag to skip getting information about the apps
-     */
-
-    this.register = function (skipApps, skipPlayers) {
-        if (!skipPlayers) {
-            // Get the list of players from the server
-            this.getPlayers(reply => {
-                // Process the player information and create Player objects for each one
-                if (reply.ok) {
-                    this.registerPlayers(reply.result);
-                }
-
-                // Send a signal that we are done
-                if (skipApps) {
-                    this.emit('register', reply, undefined);
-                } else {
-                    this.emit('registerPlayers', reply);
-                }
-            });
-        }
-
-        if (!skipApps) {
-            // Once the players have been obtained, request a list of the apps
-            this.on('registerPlayers', reply => {
-                this.getApps(areply => {
-                    if (areply.ok) {
-                        const apps = areply.result.appss_loop;
-                        const dir = `${__dirname}/`;
-                        fs.readdir(dir, (err, files) => {
-                            files.forEach(file => {
-                                const fil = file.substr(0, file.lastIndexOf('.'));
-                                for (const pl in apps) {
-                                    if (fil === apps[pl].cmd) {
-                                        const app = require(dir + file);
-                                        this.apps[apps[pl].cmd] = new app(
-                                            defaultPlayer,
-                                            apps[pl].name,
-                                            apps[pl].cmd,
-                                            this.address,
-                                            this.port,
-                                            this.username,
-                                            this.password,
-                                        );
-                                        /* workaround, app needs existing player id so first is used here */
-                                    }
-                                }
-                            });
-
-                            this.emit('register', reply, areply);
-                        });
-                    } else {
-                        this.emit('register', reply, areply);
-                    }
-                });
-            });
-        }
-    };
-
-    this.register(sa, sp);
-}
-
-inherits(SqueezeServer, SqueezeRequest);
-
-module.exports = SqueezeServer;