156 lines
4.9 KiB
C++
156 lines
4.9 KiB
C++
// SPDX-License-Identifier: LGPL-3.0-or-later
|
|
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
*
|
|
* Copyright (C) 2013 - 2024, nymea GmbH
|
|
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
|
|
*
|
|
* This file is part of nymea.
|
|
*
|
|
* nymea is free software: you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public License
|
|
* as published by the Free Software Foundation, either version 3
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* nymea 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with nymea. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#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;
|
|
class LogEngine;
|
|
class Logger;
|
|
|
|
namespace nymeaserver {
|
|
|
|
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);
|
|
|
|
QMetaType::Type getActionParamType(const ActionTypeId &actionTypeId, const ParamTypeId ¶mTypeId);
|
|
QMetaType::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 RuleId &ruleId, const QList<RuleAction> &ruleActions);
|
|
|
|
|
|
private:
|
|
ThingManager *m_thingManager = nullptr;
|
|
TimeManager *m_timeManager = nullptr;
|
|
Logger *m_logger = 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
|