92197cb97c
This moves all the things and rules logic away from NymeaCore into their respective modules where it belongs. One major change is the removal of the removePolicy functionality. This was somewhat broken as it was only working for rules but not for all the other modules like scripts, experiences etc. After an attempt to create something that works with all modules it really seemed that this does not make a lot of sence after all, given that updating rules would in most cases leave something very broken behind and removing them was the only sane thing to do. On the other hand, experience plugins may not work well with such a policy eithre as they may require to do their own special thing. So in the end the removePolicy was dropped altogether. Apps should instead figure out themselves what removal of a thing may imply and inform the user about that beforehand.
161 lines
5.3 KiB
C++
161 lines
5.3 KiB
C++
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
*
|
|
* Copyright 2013 - 2020, nymea GmbH
|
|
* Contact: contact@nymea.io
|
|
*
|
|
* This file is part of nymea.
|
|
* This project including source code and documentation is protected by
|
|
* copyright law, and remains the property of nymea GmbH. All rights, including
|
|
* reproduction, publication, editing and translation, are reserved. The use of
|
|
* this project is subject to the terms of a license agreement to be concluded
|
|
* with nymea GmbH in accordance with the terms of use of nymea GmbH, available
|
|
* under https://nymea.io/license
|
|
*
|
|
* GNU General Public License Usage
|
|
* Alternatively, this project may be redistributed and/or modified under the
|
|
* terms of the GNU General Public License as published by the Free Software
|
|
* Foundation, GNU version 3. This project 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 project. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* For any further details and any questions please contact us under
|
|
* contact@nymea.io or see our FAQ/Licensing Information on
|
|
* https://nymea.io/license/faq
|
|
*
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#ifndef RULEENGINE_H
|
|
#define RULEENGINE_H
|
|
|
|
#include "rule.h"
|
|
#include "stateevaluator.h"
|
|
#include "types/event.h"
|
|
|
|
#include "integrations/thingmanager.h"
|
|
|
|
#include <QObject>
|
|
#include <QList>
|
|
#include <QUuid>
|
|
#include <QSettings>
|
|
|
|
Q_DECLARE_LOGGING_CATEGORY(dcRuleEngine)
|
|
Q_DECLARE_LOGGING_CATEGORY(dcRuleEngineDebug)
|
|
|
|
class ThingManager;
|
|
|
|
namespace nymeaserver {
|
|
|
|
class LogEngine;
|
|
class TimeManager;
|
|
|
|
class RuleEngine : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
enum RuleError {
|
|
RuleErrorNoError,
|
|
RuleErrorInvalidRuleId,
|
|
RuleErrorRuleNotFound,
|
|
RuleErrorThingNotFound,
|
|
RuleErrorEventTypeNotFound,
|
|
RuleErrorStateTypeNotFound,
|
|
RuleErrorActionTypeNotFound,
|
|
RuleErrorInvalidParameter,
|
|
RuleErrorInvalidRuleFormat,
|
|
RuleErrorMissingParameter,
|
|
RuleErrorInvalidRuleActionParameter,
|
|
RuleErrorInvalidStateEvaluatorValue,
|
|
RuleErrorTypesNotMatching,
|
|
RuleErrorNotExecutable,
|
|
RuleErrorInvalidTimeDescriptor,
|
|
RuleErrorInvalidRepeatingOption,
|
|
RuleErrorInvalidCalendarItem,
|
|
RuleErrorInvalidTimeEventItem,
|
|
RuleErrorContainsEventBasesAction,
|
|
RuleErrorNoExitActions,
|
|
RuleErrorInterfaceNotFound
|
|
};
|
|
Q_ENUM(RuleError)
|
|
|
|
explicit RuleEngine(ThingManager *thingManager, TimeManager *timeManager, LogEngine *logEngine, QObject *parent = nullptr);
|
|
~RuleEngine();
|
|
|
|
RuleError addRule(const Rule &rule, bool fromEdit = false);
|
|
RuleError editRule(const Rule &rule);
|
|
|
|
QList<Rule> rules() const;
|
|
QList<RuleId> ruleIds() const;
|
|
|
|
RuleError removeRule(const RuleId &ruleId, bool fromEdit = false);
|
|
|
|
RuleError enableRule(const RuleId &ruleId);
|
|
RuleError disableRule(const RuleId &ruleId);
|
|
|
|
RuleError executeActions(const RuleId &ruleId);
|
|
RuleError executeExitActions(const RuleId &ruleId);
|
|
|
|
Rule findRule(const RuleId &ruleId);
|
|
QList<RuleId> findRules(const ThingId &thingId) const;
|
|
QList<ThingId> thingsInRules() const;
|
|
|
|
void removeThingFromRule(const RuleId &id, const ThingId &thingId);
|
|
|
|
signals:
|
|
void ruleAdded(const Rule &rule);
|
|
void ruleRemoved(const RuleId &ruleId);
|
|
void ruleConfigurationChanged(const Rule &rule);
|
|
void ruleActiveChanged(const Rule &rule);
|
|
|
|
private slots:
|
|
void init();
|
|
void onEventTriggered(const Event &event);
|
|
void onDateTimeChanged(const QDateTime &dateTime);
|
|
void onThingRemoved(const ThingId &thingId);
|
|
|
|
private:
|
|
QList<Rule> evaluateEvent(const Event &event);
|
|
QList<Rule> evaluateTime(const QDateTime &dateTime);
|
|
|
|
bool containsEvent(const Rule &rule, const Event &event, const ThingClassId &thingClassId);
|
|
bool containsState(const StateEvaluator &stateEvaluator, const Event &stateChangeEvent);
|
|
|
|
RuleError checkRuleAction(const RuleAction &ruleAction, const Rule &rule);
|
|
RuleError checkRuleActionParam(const RuleActionParam &ruleActionParam, const ActionType &actionType, const Rule &rule);
|
|
|
|
QVariant::Type getActionParamType(const ActionTypeId &actionTypeId, const ParamTypeId ¶mTypeId);
|
|
QVariant::Type getEventParamType(const EventTypeId &eventTypeId, const ParamTypeId ¶mTypeId);
|
|
|
|
void appendRule(const Rule &rule);
|
|
void saveRule(const Rule &rule);
|
|
void saveRuleActions(NymeaSettings *settings, const QList<RuleAction> &ruleActions);
|
|
QList<RuleAction> loadRuleActions(NymeaSettings *settings);
|
|
|
|
void executeRuleActions(const QList<RuleAction> ruleActions);
|
|
|
|
|
|
private:
|
|
ThingManager *m_thingManager = nullptr;
|
|
TimeManager *m_timeManager = nullptr;
|
|
LogEngine *m_logEngine = nullptr;
|
|
|
|
QList<RuleId> m_ruleIds; // Keeping a list of RuleIds to keep sorting order...
|
|
QHash<RuleId, Rule> m_rules; // ...but use a Hash for faster finding
|
|
QList<RuleId> m_activeRules;
|
|
|
|
QDateTime m_lastEvaluationTime;
|
|
|
|
QList<RuleId> m_executingRules;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
Q_DECLARE_METATYPE(nymeaserver::RuleEngine::RuleError)
|
|
|
|
|
|
#endif // RULEENGINE_H
|