// vim: set et sw=2 ts=2: // // This file is part of Moonfire NVR, a security camera digital video recorder. // Copyright (C) 2018 Dolf Starreveld // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // In addition, as a special exception, the copyright holders give // permission to link the code of portions of this program with the // OpenSSL library under certain conditions as described in each // individual source file, and distribute linked combinations including // the two. // // You must obey the GNU General Public License in all respects for all // of the code used other than OpenSSL. If you modify file(s) with this // exception, you may extend this exception to your version of the // file(s), but you are not obligated to do so. If you do not wish to do // so, delete this exception statement from your version. If you delete // this exception statement from all source files in the program, then // also delete it here. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see . import $ from 'jquery'; import URLBuilder from './support/URLBuilder'; /** * Class to insulate rest of app from details of Moonfire API. * * Can produce URLs for specifc operations, or a request that has been * started and can have handlers attached. */ export default class MoonfireAPI { /** * Construct. * * The defaults correspond to a standard Moonfire installation on the * same host that this code runs on. * * Requesting relative URLs effectively disregards the host and port options. * * @param {String} options.host Host where the API resides * @param {Number} options.port Port on which the API resides * @param {[type]} options.relativeUrls True if we should produce relative * urls */ constructor({host = 'localhost', port = 8080, relativeUrls = true} = {}) { const url = new URL('/api/', `http://${host}`); url.protocol = 'http:'; url.hostname = host; url.port = port; console.log('API: ' + url.origin + url.pathname); this._builder = new URLBuilder(url.origin + url.pathname, relativeUrls); } /** * URL that will cause the state of the NVR to be returned. * * @param {Boolean} days True if a return of days with available recordings * is desired. * @return {String} Constructed url */ nvrUrl(days = true) { return this._builder.makeUrl('', {days: days}); } /** * URL that will cause the state of a specific recording to be returned. * * @param {String} cameraUUID UUID for the camera * @param {String} streamType "main" or "sub" * @param {String} start90k Timestamp for beginning of range of interest * @param {String} end90k Timestamp for end of range of interest * @param {String} split90k Desired maximum size of segments returned, or * Infinity for infinite range * @return {String} Constructed url */ recordingsUrl(cameraUUID, streamType, start90k, end90k, split90k = Infinity) { const query = { startTime90k: start90k, endTime90k: end90k, }; if (split90k != Infinity) { query.split90k = split90k; } return this._builder.makeUrl( 'cameras/' + cameraUUID + '/' + streamType + '/recordings', query ); } /** * URL that will playback a video segment. * * @param {String} cameraUUID UUID for the camera from whence comes the video * @param {String} streamType "main" or "sub" * @param {Recording} recording Recording model object * @param {Range90k} trimmedRange Range restricting segments * @param {Boolean} timestampTrack True if track should be timestamped * @return {String} Constructed url */ videoPlayUrl(cameraUUID, streamType, recording, trimmedRange, timestampTrack = true) { let sParam = recording.startId; if (recording.endId !== undefined) { sParam += '-' + recording.endId; } if (recording.firstUncommitted !== undefined) { sParam += '@' + recording.openId; // disambiguate. } let rel = ''; if (recording.startTime90k < trimmedRange.startTime90k) { rel += trimmedRange.startTime90k - recording.startTime90k; } rel += '-'; if (recording.endTime90k > trimmedRange.endTime90k) { rel += trimmedRange.endTime90k - recording.startTime90k; } else if (recording.growing !== undefined) { // View just the portion described by recording. rel += recording.endTime90k - recording.startTime90k; } if (rel !== '-') { sParam += '.' + rel; } console.log('Video query:', { s: sParam, ts: timestampTrack, }); return this._builder.makeUrl('cameras/' + cameraUUID + '/' + streamType + '/view.mp4', { s: sParam, ts: timestampTrack, }); } /** * Start a new AJAX request with the specified URL. * * @param {String} url URL to use * @param {String} cacheOk True if cached results are OK * @return {Request} jQuery request type */ request(url, cacheOk = false) { return $.ajax(url, { dataType: 'json', headers: { Accept: 'application/json', }, cache: cacheOk, }); } /** * Start a new AJAX request to log in. * * @param {String} username * @param {String} password * @return {Request} */ login(username, password) { return $.ajax(this._builder.makeUrl('login'), { data: { username: username, password: password, }, method: 'POST', }); } /** * Start a new AJAX request to log out. * * @param {String} csrf: the csrf request token as returned in * /api/ response JSON. * @return {Request} */ logout(csrf) { return $.ajax(this._builder.makeUrl('logout'), { data: { csrf: csrf, }, method: 'POST', }); } }