coreext.h

Go to the documentation of this file.

/*
    Copyright © 2019-2020 by The qTox Project Contributors
 
    This file is part of qTox, a Qt-based graphical interface for Tox.
 
    qTox is libre 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.
 
    qTox 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 qTox.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "src/model/status.h"
#include "icoreextpacket.h"
 
#include <QObject>
#include <QMap>
 
#include <bitset>
#include <memory>
#include <mutex>
#include <unordered_map>
 
struct Tox;
struct ToxExt;
struct ToxExtensionMessages;
struct ToxExtPacketList;
 
class CoreExt : public QObject, public ICoreExtPacketAllocator
{
    Q_OBJECT
private:
    // PassKey idiom to prevent others from making PacketBuilders
    struct PacketPassKey {};
public:
 
    static std::unique_ptr<CoreExt> makeCoreExt(Tox* core);
 
    // We do registration with our own pointer, need to ensure we're in a stable location
    CoreExt(CoreExt const& other) = delete;
    CoreExt(CoreExt&& other) = delete;
    CoreExt& operator=(CoreExt const& other) = delete;
    CoreExt& operator=(CoreExt&& other) = delete;
 
    void process();
 
    void onLosslessPacket(uint32_t friendId, const uint8_t* data, size_t length);
 
    class Packet : public ICoreExtPacket
    {
    public:
        Packet(
            ToxExtPacketList* packetList,
            ToxExtensionMessages* toxExtMessages,
            uint32_t friendId,
            std::mutex* toxext_mutex,
            PacketPassKey);
 
        // Delete copy constructor, we shouldn't be able to copy
        Packet(Packet const& other) = delete;
 
        Packet(Packet&& other)
        {
            toxExtMessages = other.toxExtMessages;
            packetList = other.packetList;
            friendId = other.friendId;
            hasBeenSent = other.hasBeenSent;
            toxext_mutex = other.toxext_mutex;
            other.toxExtMessages = nullptr;
            other.packetList = nullptr;
            other.friendId = 0;
            other.hasBeenSent = false;
            other.toxext_mutex = nullptr;
        }
 
        uint64_t addExtendedMessage(QString message) override;
 
        bool send() override;
    private:
        std::mutex* toxext_mutex;
        bool hasBeenSent = false;
        // Note: non-owning pointer
        ToxExtensionMessages* toxExtMessages;
        // Note: packetList is freed on send() call
        ToxExtPacketList* packetList;
        uint32_t friendId;
    };
 
    std::unique_ptr<ICoreExtPacket> getPacket(uint32_t friendId) override;
 
    uint64_t getMaxExtendedMessageSize();
 
signals:
    void extendedMessageReceived(uint32_t friendId, const QString& message);
    void extendedReceiptReceived(uint32_t friendId, uint64_t receiptId);
    void extendedMessageSupport(uint32_t friendId, bool supported);
 
public slots:
    void onFriendStatusChanged(uint32_t friendId, Status::Status status);
 
private:
 
    static void onExtendedMessageReceived(uint32_t friendId, const uint8_t* data, size_t size, void* userData);
    static void onExtendedMessageReceipt(uint32_t friendId, uint64_t receiptId, void* userData);
    static void onExtendedMessageNegotiation(uint32_t friendId, bool compatible, uint64_t maxMessageSize, void* userData);
 
    // A little extra cost to hide the deleters, but this lets us fwd declare
    // and prevent any extension headers from leaking out to the rest of the
    // system
    template <class T>
    using ExtensionPtr = std::unique_ptr<T, void(*)(T*)>;
 
    CoreExt(ExtensionPtr<ToxExt> toxExt);
 
    std::mutex toxext_mutex;
    std::unordered_map<uint32_t, Status::Status> currentStatuses;
    ExtensionPtr<ToxExt> toxExt;
    ExtensionPtr<ToxExtensionMessages> toxExtMessages;
};