RetainTree.cpp

Go to the documentation of this file.

/*
 * SNode.C - A Slim Toolkit for Network Communication
 * Copyright (C) Volker Christian <me@vchrist.at>
 *               2020, 2021, 2022, 2023, 2024, 2025
 *
 * This program 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.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
/*
 * MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#include "iot/mqtt/server/broker/RetainTree.h"
 
#include "iot/mqtt/Mqtt.h"
#include "iot/mqtt/server/broker/Broker.h"
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#include "log/Logger.h"
 
#include <algorithm>
#include <nlohmann/json.hpp>
#include <utility>
 
// IWYU pragma: no_include <nlohmann/detail/iterators/iteration_proxy.hpp>
 
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace iot::mqtt::server::broker {
 
    RetainTree::RetainTree(Broker* broker)
        : head(broker) {
    }
 
    void RetainTree::retain(Message&& message) {
        if (!message.getTopic().empty()) {
            if (!message.getMessage().empty()) {
                head.retain(message, message.getTopic());
            } else {
                head.release(message.getTopic());
            }
        }
    }
 
    void RetainTree::appear(const std::string& clientId, const std::string& topic, uint8_t qoS) {
        head.appear(clientId, topic, qoS);
    }
 
    void RetainTree::release(const std::string& topic) {
        head.release(topic);
    }
 
    void RetainTree::fromJson(const nlohmann::json& json) {
        if (!json.empty()) {
            head.fromJson(json);
        }
    }
 
    std::list<std::pair<std::string, std::string>> RetainTree::getRetainedTree() const {
        return head.getRetainTree();
    }
 
    nlohmann::json RetainTree::toJson() const {
        return head.toJson();
    }
 
    void RetainTree::clear() {
        head.clear();
    }
 
    RetainTree::TopicLevel::TopicLevel(iot::mqtt::server::broker::Broker* broker)
        : broker(broker) {
    }
 
    RetainTree::TopicLevel& RetainTree::TopicLevel::fromJson(const nlohmann::json& json) {
        subTopicLevels.clear();
 
        message.fromJson(json.value("message", nlohmann::json()));
 
        if (json.contains("topic_level")) {
            for (const auto& topicLevelItem : json["topic_level"].items()) {
                subTopicLevels.emplace(topicLevelItem.key(), TopicLevel(broker).fromJson(topicLevelItem.value()));
            }
        }
 
        return *this;
    }
    void RetainTree::TopicLevel::retain(const Message& message, std::string topic) {
        if (topic.empty()) {
            LOG(DEBUG) << "MQTT Broker: Retain:";
            LOG(DEBUG) << "MQTT Broker:   Topic: " << message.getTopic();
            LOG(DEBUG) << "MQTT Broker:   Message:\n" << iot::mqtt::Mqtt::toHexString(message.getMessage());
            LOG(DEBUG) << "MQTT Broker:     QoS: " << static_cast<uint16_t>(message.getQoS());
 
            this->message = message;
        } else {
            const std::string topicLevel = topic.substr(0, topic.find('/'));
 
            topic.erase(0, topicLevel.size() + 1);
 
            subTopicLevels.insert({topicLevel, RetainTree::TopicLevel(broker)}).first->second.retain(message, topic);
        }
    }
 
    bool RetainTree::TopicLevel::release(std::string topic) {
        if (topic.empty()) {
            LOG(DEBUG) << "MQTT Broker: Release retained:";
            LOG(DEBUG) << "MQTT Broker:   Topic: " << message.getTopic();
 
            message = Message();
        } else {
            const std::string topicLevel = topic.substr(0, topic.find('/'));
 
            auto&& it = subTopicLevels.find(topicLevel);
            if (it != subTopicLevels.end()) {
                topic.erase(0, topicLevel.size() + 1);
 
                if (it->second.release(topic)) {
                    LOG(DEBUG) << "               Erase: " << topicLevel;
 
                    subTopicLevels.erase(it);
                }
            }
        }
 
        return subTopicLevels.empty() && message.getMessage().empty();
    }
 
    void RetainTree::TopicLevel::appear(const std::string& clientId, std::string topic, uint8_t qoS) {
        if (topic.empty()) {
            if (!message.getTopic().empty()) {
                LOG(INFO) << "MQTT Broker: Retained Topic found:";
                LOG(INFO) << "MQTT Broker:   Topic: " << message.getTopic();
                LOG(INFO) << "MQTT Broker:   Message:\n" << iot::mqtt::Mqtt::toHexString(message.getMessage());
                LOG(DEBUG) << "MQTT Broker:     QoS: " << static_cast<uint16_t>(message.getQoS());
                LOG(DEBUG) << "MQTT Broker:   Client:";
                LOG(DEBUG) << "MQTT Broker:     QoS: " << static_cast<uint16_t>(qoS);
 
                LOG(INFO) << "MQTT Broker: Distributing message ...";
                broker->sendPublish(clientId, message, std::min(message.getQoS(), qoS), true);
                LOG(INFO) << "MQTT Broker: ... distributing message completed";
            }
        } else {
            const std::string topicLevel = topic.substr(0, topic.find('/'));
 
            topic.erase(0, topicLevel.size() + 1);
 
            auto foundNode = subTopicLevels.find(topicLevel);
            if (foundNode != subTopicLevels.end()) {
                foundNode->second.appear(clientId, topic, qoS);
            } else if (topicLevel == "+") {
                for (auto& [notUsed, topicTree] : subTopicLevels) {
                    topicTree.appear(clientId, topic, qoS);
                }
            } else if (topicLevel == "#") {
                appear(clientId, qoS);
            }
        }
    }
 
    std::list<std::pair<std::string, std::string>> RetainTree::TopicLevel::getRetainTree() const {
        return getRetainTree("");
    }
 
    void RetainTree::TopicLevel::appear(const std::string& clientId, uint8_t clientQoS) {
        if (!message.getTopic().empty()) {
            LOG(INFO) << "MQTT Broker: Retained Topic found:";
            LOG(INFO) << "MQTT Broker:   Topic: " << message.getTopic();
            LOG(INFO) << "MQTT Broker:   Message:\n" << iot::mqtt::Mqtt::toHexString(message.getMessage());
            LOG(DEBUG) << "MQTT Broker:     QoS: " << static_cast<uint16_t>(message.getQoS());
            LOG(DEBUG) << "MQTT Broker:   Client:";
            LOG(DEBUG) << "MQTT Broker:     QoS: " << static_cast<uint16_t>(clientQoS);
 
            LOG(INFO) << "MQTT Broker: Distributing message ...";
            broker->sendPublish(clientId, message, std::min(message.getQoS(), clientQoS), true);
            LOG(INFO) << "MQTT Broker: ... distributing message completed";
        }
 
        for (auto& [topicLevel, topicTree] : subTopicLevels) {
            topicTree.appear(clientId, clientQoS);
        }
    }
 
    std::list<std::pair<std::string, std::string>> RetainTree::TopicLevel::getRetainTree(const std::string& absoluteTopicLevel) const {
        std::list<std::pair<std::string, std::string>> topicLevelTree;
        for (const auto& [topicLevelName, nextTopicLevel] : subTopicLevels) {
            const std::string composedAbsoluteTopicLevelName = absoluteTopicLevel + topicLevelName;
 
            if (!nextTopicLevel.message.getMessage().empty()) {
                topicLevelTree.emplace_back(composedAbsoluteTopicLevelName, nextTopicLevel.message.getMessage());
            }
 
            topicLevelTree.splice(topicLevelTree.end(), nextTopicLevel.getRetainTree(composedAbsoluteTopicLevelName + "/"));
        }
 
        return topicLevelTree;
    }
 
    nlohmann::json RetainTree::TopicLevel::toJson() const {
        nlohmann::json json;
 
        if (!message.getMessage().empty()) {
            json["message"] = message.toJson();
        }
 
        for (const auto& [topicLevel, topicLevelValue] : subTopicLevels) {
            json["topic_level"][topicLevel] = topicLevelValue.toJson();
        }
 
        return json;
    }
 
    void RetainTree::TopicLevel::clear() {
        *this = TopicLevel(broker);
    }
 
} // namespace iot::mqtt::server::broker