iobroker.squeezeboxrpc
Version:
ioBroker Logitech Squeezebox Adapter over JSON/RPC-Protocol
274 lines (245 loc) • 9.98 kB
JavaScript
/*
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('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('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;