iobroker.rest-api 2.0.2 → 3.0.0

package/lib/api/controllers/file.js

@@ -1,74 +0,0 @@
-'use strict';
-const commonLib = require('./common.js');
-
-module.exports = {
-    readFile: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'read'}],  async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                try {
-                    const data = await req._adapter.readFileAsync(params.objectId, params.fileName, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    if (data && data.mimeType) {
-                        res.set('Content-Type', data.mimeType);
-                        res.send(data.file);
-                    } else {
-                        res.status(404).send(Buffer.from(''));
-                    }
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error);
-                }
-            }
-        });
-    },
-    deleteFile: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'delete'}],  async error => {
-                if (error) {
-                    commonLib.errorResponse(req, res, error);
-                } else {
-                    const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                    try {
-                        await req._adapter.delFileAsync(params.objectId, params.fileName, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                        res.json({success: true});
-                    } catch (err) {
-                        if (err.toString().includes('Not exists')) {
-                            res.status(404).json({error: err.toString()});
-                        } else {
-                            commonLib.errorResponse(req, res, err);
-                        }
-                    }
-                }
-        });
-    },
-    writeFile: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'write'}],  async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                try {
-                    await req._adapter.writeFileAsync(params.objectId, params.fileName, req.files.file[0].buffer, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    res.json({success: true});
-                } catch (err) {
-                    commonLib.errorResponse(req, res, err);
-                }
-            }
-        });
-    },
-    readDir: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'list'}],  async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                try {
-                    const response = await req._adapter.readDirAsync(params.objectId, params.dirName || '', {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    res.json(response);
-                } catch (err) {
-                    commonLib.errorResponse(req, res, err);
-                }
-            }
-        });
-    },
-};

package/lib/api/controllers/history.js

@@ -1,239 +0,0 @@
-'use strict';
-const commonLib = require('./common.js');
-
-const PARAMETERS = {
-    start: 'number',
-    end:'number',
-    count: 'number',
-    from: 'boolean',
-    ack: 'boolean',
-    q: 'boolean',
-    addId: 'boolean',
-    limit: 'number',
-    ignoreNull: 'boolean',
-    removeBorderValues: 'boolean',
-    returnNewestEntries: 'boolean',
-    aggregate: ['minmax', 'max', 'min', 'average', 'total', 'count', 'percentile', 'quantile', 'integral', 'none'],
-    percentile: 'number',
-    quantile: 'number',
-    integralUnit: 'string',
-    integralInterpolation: 'string',
-    enum: ['linear', 'none'],
-}
-
-const PARAMETERS_ADD = {
-    val: 'string',
-    from: 'string',
-    ack: 'boolean',
-    q: 'number',
-    ts: 'number',
-}
-
-module.exports = {
-    getHistory: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'other', operation: 'sendto'}],  async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                if (req._adapter.config.dataSource) {
-                    // check if instance is alive
-                    const state = await req._adapter.getForeignStateAsync(`system.adapter.${req._adapter.config.dataSource}.alive`);
-                    if (state.val) {
-                        const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                        req._adapter.log.debug(`Read data from: ${req._adapter.config.dataSource}`);
-
-                        const options = {};
-                        Object.keys(PARAMETERS).forEach(attr => {
-                            if (Object.hasOwnProperty.call(req.query, attr)) {
-                                if (PARAMETERS[attr] === 'boolean') {
-                                    options[attr] = req.query[attr] === 'true';
-                                } else if (PARAMETERS[attr] === 'number') {
-                                    options[attr] = parseFloat(req.query[attr]);
-                                } else if (Array.isArray(PARAMETERS[attr])) {
-                                    if (PARAMETERS[attr].includes(req.query[attr])) {
-                                        options[attr] = req.query[attr];
-                                    } else {
-                                        req._adapter.log.warn(`Unknown value ${req.query[attr]} for attribute ${attr}. Allowed: ${PARAMETERS[attr].join(', ')}`);
-                                    }
-                                } else if (PARAMETERS[attr] === 'string') {
-                                    options[attr] = req.query[attr];
-                                }
-                            }
-                        });
-
-                        req._adapter.sendTo(req._adapter.config.dataSource, 'getHistory', {id: params.stateId, options}, (result, step, error) => {
-                            if (error) {
-                                commonLib.errorResponse(req, res, error);
-                                return;
-                            }
-                            // req._adapter.log.debug(`[QUERY] sendTo result = ${JSON.stringify(result)}`);
-                            res.json(result.result);
-                        });
-                    } else {
-                        res.status(500).json({error: 'Instance is not alive', instance: req._adapter.config.dataSource});
-                    }
-                } else {
-                    res.status(422).json({error: 'No dataSource defined!'});
-                }
-            }
-        });
-    },
-    postHistory: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, req.body.options, async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                if (req._adapter.config.dataSource) {
-                    const state = await req._adapter.getForeignStateAsync(`system.adapter.${req._adapter.config.dataSource}.alive`);
-                    if (state.val) {
-                        req._adapter.log.debug(`Read data from: ${req._adapter.config.dataSource}`);
-                        const options = {
-                            id: req.body.id,
-                            options: {}
-                        };
-
-                        if (req.body.options && typeof req.body.options === 'object') {
-                            Object.keys(PARAMETERS).forEach(attr => {
-                                if (Object.hasOwnProperty.call(req.body.options, attr)) {
-                                    if (PARAMETERS[attr] === 'boolean') {
-                                        options.options[attr] = req.body.options[attr] === 'true';
-                                    } else if (PARAMETERS[attr] === 'number') {
-                                        options.options[attr] = parseFloat(req.body.options[attr]);
-                                    } else if (Array.isArray(PARAMETERS[attr])) {
-                                        if (PARAMETERS[attr].includes(req.body.options[attr])) {
-                                            options.options[attr] = req.body.options[attr];
-                                        } else {
-                                            req._adapter.log.warn(`Unknown value ${req.body.options[attr]} for attribute ${attr}. Allowed: ${PARAMETERS[attr].join(', ')}`);
-                                        }
-                                    } else if (PARAMETERS[attr] === 'string') {
-                                        options.options[attr] = req.body.options[attr];
-                                    }
-                                }
-                            });
-                        }
-
-                        req._adapter.sendTo(req._adapter.config.dataSource, 'getHistory', options, (result, step, error) => {
-                            if (error) {
-                                commonLib.errorResponse(req, res, error);
-                                return;
-                            }
-                            // req._adapter.log.debug(`[QUERY] sendTo result = ${JSON.stringify(result)}`);
-                            res.json(result.result);
-                        });
-                    } else {
-                        res.status(500).json({error: 'Instance is not alive', instance: req._adapter.config.dataSource});
-                    }
-                } else {
-                    res.status(422).json({error: 'No dataSource defined!'});
-                }
-            }
-        });
-    },
-
-    addHistoryByGet: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'other', operation: 'sendto'}],  async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                if (req._adapter.config.dataSource) {
-                    // check if instance is alive
-                    const aliveState = await req._adapter.getForeignStateAsync(`system.adapter.${req._adapter.config.dataSource}.alive`);
-                    if (aliveState.val) {
-                        const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                        req._adapter.log.debug(`Read data from: ${req._adapter.config.dataSource}`);
-                        const obj = await req._adapter.getForeignObjectAsync(params.stateId);
-
-                        if (obj && obj.type === 'state' && obj.common && obj.common.type) {
-                            const state = {};
-                            Object.keys(PARAMETERS_ADD).forEach(attr => {
-                                if (Object.hasOwnProperty.call(req.query, attr)) {
-                                    if (PARAMETERS_ADD[attr] === 'boolean') {
-                                        state[attr] = req.query[attr] === 'true';
-                                    } else if (PARAMETERS_ADD[attr] === 'number') {
-                                        state[attr] = parseFloat(req.query[attr]);
-                                    } else if (PARAMETERS_ADD[attr] === 'string') {
-                                        state[attr] = req.query[attr];
-                                    }
-                                    if (attr === 'val') {
-                                        if (obj.common.type === 'boolean') {
-                                            state.val = state.val === 'true' || state.val === '1';
-                                        } else if (obj.common.type === 'number') {
-                                            state.val = parseFloat(state.val);
-                                        }
-                                    }
-                                }
-                            });
-
-                            state.ts = state.ts || Date.now();
-
-                            req._adapter.sendTo(req._adapter.config.dataSource, 'storeState', {id: params.stateId, state}, (result, step, error) => {
-                                if (error) {
-                                    commonLib.errorResponse(req, res, error);
-                                    return;
-                                }
-                                // req._adapter.log.debug(`[QUERY] sendTo result = ${JSON.stringify(result)}`);
-                                res.json(result);
-                            });
-                        } else {
-                            res.status(404).json({error: 'State not found', stateId: params.stateId});
-                        }
-                    } else {
-                        res.status(500).json({error: 'Instance is not alive', instance: req._adapter.config.dataSource});
-                    }
-                } else {
-                    res.status(422).json({error: 'No dataSource defined!'});
-                }
-            }
-        });
-    },
-    addHistoryByPost: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, req.body.options, async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                if (req._adapter.config.dataSource) {
-                    const state = await req._adapter.getForeignStateAsync(`system.adapter.${req._adapter.config.dataSource}.alive`);
-                    if (state.val) {
-                        req._adapter.log.debug(`Read data from: ${req._adapter.config.dataSource}`);
-                        const options = {
-                            id: req.body.id,
-                            state: {}
-                        };
-
-                        if (req.body.state && typeof req.body.state === 'object') {
-                            Object.keys(PARAMETERS_ADD).forEach(attr => {
-                                if (Object.hasOwnProperty.call(req.body.state, attr)) {
-                                    if (PARAMETERS_ADD[attr] === 'boolean') {
-                                        options.state[attr] = req.body.state[attr] === 'true';
-                                    } else if (PARAMETERS_ADD[attr] === 'number') {
-                                        options.state[attr] = parseFloat(req.body.state[attr]);
-                                    } else if (PARAMETERS_ADD[attr] === 'string') {
-                                        options.state[attr] = req.body.state[attr];
-                                    }
-                                }
-                            });
-                        }
-
-                        options.state.ts = options.state.ts || Date.now();
-
-                        req._adapter.sendTo(req._adapter.config.dataSource, 'storeState', options, (result, step, error) => {
-                            if (error) {
-                                commonLib.errorResponse(req, res, error);
-                                return;
-                            }
-                            // req._adapter.log.debug(`[QUERY] sendTo result = ${JSON.stringify(result)}`);
-                            res.json(result);
-                        });
-                    } else {
-                        res.status(500).json({
-                            error: 'Instance is not alive',
-                            instance: req._adapter.config.dataSource
-                        });
-                    }
-                } else {
-                    res.status(422).json({error: 'No dataSource defined!'});
-                }
-            }
-        });
-    },
-};

package/lib/api/controllers/object.js

@@ -1,273 +0,0 @@
-'use strict';
-const commonLib = require('./common.js');
-
-module.exports = {
-    readObject: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}], error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                req._adapter.getForeignObject(params.objectId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner}, (error, obj) => {
-                    if (error) {
-                        commonLib.errorResponse(req, res, error, {objectId: req.query.objectId});
-                    } else {
-                        if (!obj) {
-                            res.status(404).json({error: 'object not found'});
-                        } else {
-                            res.json(obj);
-                        }
-                    }
-                });
-            }
-        });
-    },
-
-    updateObject: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'write'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                const body = req.body;
-                try {
-                    const obj = await req._adapter.getForeignObjectAsync(params.objectId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    if (!obj) {
-                        await req._adapter.setForeignObjectAsync(params.objectId, body, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                        res.status(200).json(body);
-                    } else {
-                        // merge objects together
-                        Object.keys(body).forEach(attr => {
-                            if (body[attr] === null || body[attr] === undefined) {
-                                delete obj[attr];
-                            } else
-                            if (typeof body[attr] === 'object') {
-                                obj[attr] = obj[attr] || {};
-                                Object.keys(body[attr]).forEach(attr2 => {
-                                    if (body[attr][attr2] === null) {
-                                        delete obj[attr][attr2];
-                                    } else {
-                                        obj[attr][attr2] = body[attr][attr2];
-                                    }
-                                })
-                            } else {
-                                obj[attr] = body[attr];
-                            }
-                        });
-                        await req._adapter.setForeignObjectAsync(params.objectId, obj, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                        res.status(200).json(obj);
-                    }
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {objectId: params.objectId});
-                }
-            }
-        });
-    },
-
-    createObject: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'write'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                const body = req.body;
-                try {
-                    const obj = await req._adapter.getForeignObjectAsync(params.objectId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    if (!obj) {
-                        await req._adapter.setForeignObjectAsync(params.objectId, body, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                        res.status(200).json(body);
-                    } else {
-                        res.status(409).json({error: 'Object already exists', id: params.objectId});
-                    }
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {objectId: params.objectId});
-                }
-            }
-        });
-    },
-
-    deleteObject: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'write'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                try {
-                    const obj = await req._adapter.getForeignObjectAsync(params.objectId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    if (!obj) {
-                        res.status(404).json({objectId: params.objectId, error: 'object not found'});
-                    } else {
-                        await req._adapter.delForeignObjectAsync(params.objectId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                        res.status(200).json({});
-                    }
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {objectId: params.objectId});
-                }
-            }
-        });
-    },
-
-    listObjects: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}], error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                req._adapter.getForeignObjects(req.query.filter || '*', req.query.type || null, {
-                    user: req._user,
-                    limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner
-                }, (error, list) => {
-                    if (error) {
-                        commonLib.errorResponse(req, res, error, {filter: req.query.filter});
-                    } else {
-                        res.json(list || []);
-                    }
-                });
-            }
-        });
-    },
-
-    subscribeObject: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-
-                let url = req.body.url;
-                if ((req.query && req.query.method === 'polling') || (req.body && req.body.method === 'polling')) {
-                    url = req.query.sid || req.headers['x-forwarded-for'] || req.socket.remoteAddress;
-                }
-
-                if (!url) {
-                    res.status(422).json({error: 'url not provided', expectedBody: {url: 'http://ipaddress:9000/hook/'}});
-                    return;
-                }
-
-                try {
-                    const obj = await req._adapter.getForeignObjectAsync(params.stateId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                    if (!obj) {
-                        res.status(404).json({error: 'object not found'});
-                    } else {
-                        await req._swaggerObject.registerSubscribe(url, params.objectId, 'object', req._user, (req.query && req.query.method) || (req.body && req.body.method));
-                        const obj = await req._adapter.getForeignStateAsync(params.objectId, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
-                        res.status(200).json(obj);
-                    }
-                } catch (error) {
-                    req._adapter.log.warn(`Cannot read ${params.objectId}: ${error}`);
-                    commonLib.errorResponse(req, res, error, {objectId: params.objectId});
-                }
-            }
-        });
-    },
-
-    unsubscribeObject: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-
-                let url = req.body.url;
-                if ((req.query && req.query.method === 'polling') || (req.body && req.body.method === 'polling')) {
-                    url = req.query.sid || req.headers['x-forwarded-for'] || req.socket.remoteAddress;
-                }
-
-                if (!url) {
-                    res.status(422).json({error: 'url not provided', expectedBody: {url: 'http://ipaddress:9000/hook/'}});
-                    return;
-                }
-                try {
-                    await req._swaggerObject.unregisterSubscribe(url, params.objectId, 'object', req._user, (req.query && req.query.method) || (req.body && req.body.method));
-                    res.status(200).json({result: 'OK'});
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {objectId: params.objectId});
-                }
-            }
-        });
-    },
-
-    subscribeObjects: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                let url = req.body.url;
-                if (req.body.method === 'polling') {
-                    url = req.query.sid || req.headers['x-forwarded-for'] || req.socket.remoteAddress;
-                }
-
-                if (!url) {
-                    res.status(422).json({error: 'url not provided', expectedBody: {url: 'http://ipaddress:9000/hook/'}});
-                    return;
-                }
-                if (!req.body.pattern) {
-                    res.status(422).json({
-                        error: 'pattern not provided',
-                        expectedBody: {url: 'http://ipaddress:9000/hook/', pattern: 'system.adapter.admin.0.*'}
-                    });
-                    return;
-                }
-                try {
-                    await req._swaggerObject.registerSubscribe(url, req.body.pattern, 'object', req._user, req.body.method);
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {pattern: req.body.pattern, url: req.body.url});
-                }
-            }
-        });
-    },
-
-    unsubscribeObjects: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                let url = req.body.url;
-                if (req.body.method === 'polling') {
-                    url = req.query.sid || req.headers['x-forwarded-for'] || req.socket.remoteAddress;
-                }
-
-                if (!url) {
-                    res.status(422).json({error: 'url not provided', expectedBody: {url: 'http://ipaddress:9000/hook/'}});
-                    return;
-                }
-
-                try {
-                    await req._swaggerObject.unregisterSubscribe(url, req.body.pattern, 'object', req._user, req.body.method);
-                    res.status(200).json({result: 'OK'});
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {pattern: req.body.pattern, url: req.body.url});
-                }
-            }
-        });
-    },
-
-    getObjectsSubscribes: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'state', operation: 'read'}], async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                let url = req.body.url;
-                if ((req.query && req.query.method === 'polling') || (req.body && req.body.method === 'polling')) {
-                    url = req.query.sid || req.headers['x-forwarded-for'] || req.socket.remoteAddress;
-                }
-
-                if (!url) {
-                    res.status(422).json({error: 'url not provided', expectedBody: {url: 'http://ipaddress:9000/hook/'}});
-                    return;
-                }
-
-                try {
-                    const result = await req._swaggerObject.getSubscribes(url, req.body.pattern, 'object');
-                    if (result === null) {
-                        res.status(404).json({error: 'URL or session not found'});
-                        return;
-                    }
-                    res.json({states: result});
-
-                } catch (error) {
-                    commonLib.errorResponse(req, res, error, {pattern: req.body.pattern, url: req.body.url});
-                }
-            }
-        });
-    },
-};