Refactor Hyperion JSON-API (#1727)

include/hyperion/AuthManager.h

@@ -3,6 +3,8 @@
 #include <utils/Logger.h>
 #include <utils/settings.h>
 
+#include <db/AuthTable.h>
+
 //qt
 #include <QMap>
 #include <QVector>
@@ -41,24 +43,12 @@ public:
 	///
 	QString getID() const { return _uuid; }
 
-	///
-	/// @brief Check authorization is required according to the user setting
-	/// @return       True if authorization required else false
-	///
-	bool isAuthRequired() const { return _authRequired; }
-
 	///
 	/// @brief Check if authorization is required for local network connections
 	/// @return       True if authorization required else false
 	///
 	bool isLocalAuthRequired() const { return _localAuthRequired; }
 
-	///
-	/// @brief Check if authorization is required for local network connections for admin access
-	/// @return       True if authorization required else false
-	///
-	bool isLocalAdminAuthRequired() const { return _localAdminAuthRequired; }
-
 	///
 	/// @brief Reset Hyperion user
 	/// @return        True on success else false
@@ -172,7 +162,7 @@ public slots:
 	/// @param usr the defined user
 	/// @return       The token
 	///
-	QString getUserToken(const QString &usr = "Hyperion") const;
+	QString getUserToken(const QString &usr = hyperion::DEFAULT_USER) const;
 
 	///
 	/// @brief Get all available token entries
@@ -230,15 +220,9 @@ private:
 	/// All pending requests
 	QMap<QString, AuthDefinition> _pendingRequests;
 
-	/// Reflect state of global auth
-	bool _authRequired;
-
 	/// Reflect state of local auth
 	bool _localAuthRequired;
 
-	/// Reflect state of local admin auth
-	bool _localAdminAuthRequired;
-
 	/// Timer for counting against pendingRequest timeouts
 	QTimer *_timer;
 

include/hyperion/Hyperion.h

@@ -67,6 +67,7 @@ class Hyperion : public QObject
 	Q_OBJECT
 public:
 	///  Type definition of the info structure used by the priority muxer
+	using InputsMap = PriorityMuxer::InputsMap;
 	using InputInfo = PriorityMuxer::InputInfo;
 
 	///
@@ -107,7 +108,7 @@ public:
 	///
 	QString getActiveDeviceType() const;
 
-	bool getReadOnlyMode() {return _readOnlyMode; }
+	bool getReadOnlyMode() const {return _readOnlyMode; }
 
 public slots:
 
@@ -235,13 +236,13 @@ public slots:
 	///	@param priority The priority channel of the effect
 	/// @param timeout The timeout of the effect (after the timout, the effect will be cleared)
 	int setEffect(const QString &effectName
-				, const QJsonObject &args
-				, int priority
-				, int timeout = PriorityMuxer::ENDLESS
-				, const QString &pythonScript = ""
-				, const QString &origin="System"
-				, const QString &imageData = ""
-	);
+				  , const QJsonObject &args
+				  , int priority
+				  , int timeout = PriorityMuxer::ENDLESS
+				  , const QString &pythonScript = ""
+				  , const QString &origin="System"
+				  , const QString &imageData = ""
+				);
 
 	/// Get the list of available effects
 	/// @return The list of available effects
@@ -303,7 +304,14 @@ public slots:
 	QList<int> getActivePriorities() const;
 
 	///
-	/// Returns the information of a specific priorrity channel
+	/// Returns the information of all priority channels.
+	///
+	/// @return The information fo all priority channels
+	///
+	PriorityMuxer::InputsMap getPriorityInfo() const;
+
+	///
+	/// Returns the information of a specific priority channel
 	///
 	/// @param[in] priority  The priority channel
 	///
@@ -346,7 +354,7 @@ public slots:
 	/// @brief Get the component Register
 	/// return Component register pointer
 	///
-	ComponentRegister* getComponentRegister() { return _componentRegister; }
+	ComponentRegister* getComponentRegister() const { return _componentRegister; }
 
 	///
 	/// @brief Called from components to update their current state. DO NOT CALL FROM USERS

include/hyperion/HyperionIManager.h

@@ -55,10 +55,16 @@ public slots:
 	Hyperion* getHyperionInstance(quint8 instance = 0);
 
 	///
-	/// @brief Get instance data of all instaces in db + running state
+	/// @brief Get instance data of all instances in db + running state
 	///
 	QVector<QVariantMap> getInstanceData() const;
 
+
+	///
+	/// @brief Get all instance indicies of running instances
+	///
+	QList<quint8> getRunningInstanceIdx() const;
+
 	///
 	/// @brief Start a Hyperion instance
 	/// @param instance     Instance index

include/hyperion/PriorityMuxer.h

@@ -141,6 +141,13 @@ public:
 	///
 	QList<int> getPriorities() const;
 
+    ///
+    /// Returns the information of all priority channels.
+    ///
+    /// @return The information fo all priority channels
+    ///
+    InputsMap getInputInfo() const;
+
 	///
 	/// Returns the information of a specified priority channel.
 	/// If a priority is no longer available the _lowestPriorityInfo (255) is returned