-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(messages): Multipacket message support
* Introduced ToxExt and CoreExt abstraction
* Along with interfaces for mocking and unit testing
* Add "supportedExtensions" concept to Friend
* Dispatch messages to CoreExt instead of Core when friend supports
extended messages
* Only split messages for core when extended messages are unavailable
* Offline message engine/History not altered. Currently only valid for
an existing session after extension negotiation has completed- Loading branch information
1 parent
abad3fc
commit 7474c6d
Showing
20 changed files
with
659 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| /* | ||
| 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/>. | ||
| */ | ||
|
|
||
| #include "coreext.h" | ||
| #include "toxstring.h" | ||
|
|
||
| #include <QDateTime> | ||
| #include <QTimeZone> | ||
| #include <QtCore> | ||
|
|
||
| #include <memory> | ||
| #include <cassert> | ||
|
|
||
| extern "C" { | ||
| #include <toxext/toxext.h> | ||
| #include <tox_extension_messages.h> | ||
| } | ||
|
|
||
| std::unique_ptr<CoreExt> CoreExt::makeCoreExt(Tox* core) { | ||
| auto toxExtPtr = toxext_init(core); | ||
| if (!toxExtPtr) { | ||
| return nullptr; | ||
| } | ||
|
|
||
| auto toxExt = ExtensionPtr<ToxExt>(toxExtPtr, toxext_free); | ||
| return std::unique_ptr<CoreExt>(new CoreExt(std::move(toxExt))); | ||
| } | ||
|
|
||
| CoreExt::CoreExt(ExtensionPtr<ToxExt> toxExt_) | ||
| : toxExt(std::move(toxExt_)) | ||
| , toxExtMessages(nullptr, nullptr) | ||
| { | ||
| toxExtMessages = ExtensionPtr<ToxExtensionMessages>( | ||
| tox_extension_messages_register( | ||
| toxExt.get(), | ||
| CoreExt::onExtendedMessageReceived, | ||
| CoreExt::onExtendedMessageReceipt, | ||
| CoreExt::onExtendedMessageNegotiation, | ||
| this, | ||
| TOX_EXTENSION_MESSAGES_DEFAULT_MAX_RECEIVING_MESSAGE_SIZE), | ||
| tox_extension_messages_free); | ||
| } | ||
|
|
||
| void CoreExt::process() | ||
| { | ||
| toxext_iterate(toxExt.get()); | ||
| } | ||
|
|
||
| void CoreExt::onLosslessPacket(uint32_t friendId, const uint8_t* data, size_t length) | ||
| { | ||
| if (is_toxext_packet(data, length)) { | ||
| toxext_handle_lossless_custom_packet(toxExt.get(), friendId, data, length); | ||
| } | ||
| } | ||
|
|
||
| CoreExt::Packet::Packet( | ||
| ToxExtPacketList* packetList, | ||
| ToxExtensionMessages* toxExtMessages, | ||
| uint32_t friendId, | ||
| PacketPassKey) | ||
| : toxExtMessages(toxExtMessages) | ||
| , packetList(packetList) | ||
| , friendId(friendId) | ||
| {} | ||
|
|
||
| std::unique_ptr<ICoreExtPacket> CoreExt::getPacket(uint32_t friendId) | ||
| { | ||
| return std::unique_ptr<Packet>(new Packet( | ||
| toxext_packet_list_create(toxExt.get(), friendId), | ||
| toxExtMessages.get(), | ||
| friendId, | ||
| PacketPassKey{})); | ||
| } | ||
|
|
||
| uint64_t CoreExt::Packet::addExtendedMessage(QString message) | ||
| { | ||
| if (hasBeenSent) { | ||
| assert(false); | ||
| qWarning() << "Invalid use of CoreExt::Packet"; | ||
| // Hope that UINT64_MAX will never collide with an actual receipt num | ||
| // that we care about | ||
| return UINT64_MAX; | ||
| } | ||
|
|
||
| ToxString toxString(message); | ||
| Tox_Extension_Messages_Error err; | ||
|
|
||
| return tox_extension_messages_append( | ||
| toxExtMessages, | ||
| packetList, | ||
| toxString.data(), | ||
| toxString.size(), | ||
| friendId, | ||
| &err); | ||
| } | ||
|
|
||
| bool CoreExt::Packet::send() | ||
| { | ||
| auto ret = toxext_send(packetList); | ||
| if (ret != TOXEXT_SUCCESS) { | ||
| qWarning() << "Failed to send packet"; | ||
| } | ||
| // Indicate we've sent the packet even on failure since our packetlist will | ||
| // be invalid no matter what | ||
| hasBeenSent = true; | ||
| return ret == TOXEXT_SUCCESS; | ||
| } | ||
|
|
||
| void CoreExt::onFriendStatusChanged(uint32_t friendId, Status::Status status) | ||
| { | ||
| const auto prevStatusIt = currentStatuses.find(friendId); | ||
| const auto prevStatus = prevStatusIt == currentStatuses.end() | ||
| ? Status::Status::Offline : prevStatusIt->second; | ||
|
|
||
| currentStatuses[friendId] = status; | ||
|
|
||
| // Does not depend on prevStatus since prevStatus could be newly | ||
| // constructed. In this case we should still ensure the rest of the system | ||
| // knows there is no extension support | ||
| if (status == Status::Status::Offline) { | ||
| emit extendedMessageSupport(friendId, false); | ||
| } else if (prevStatus == Status::Status::Offline) { | ||
| tox_extension_messages_negotiate(toxExtMessages.get(), friendId); | ||
| } | ||
| } | ||
|
|
||
| void CoreExt::onExtendedMessageReceived(uint32_t friendId, const uint8_t* data, size_t size, void* userData) | ||
| { | ||
| QString msg = ToxString(data, size).getQString(); | ||
| emit static_cast<CoreExt*>(userData)->extendedMessageReceived(friendId, msg); | ||
| } | ||
|
|
||
| void CoreExt::onExtendedMessageReceipt(uint32_t friendId, uint64_t receiptId, void* userData) | ||
| { | ||
| emit static_cast<CoreExt*>(userData)->extendedReceiptReceived(friendId, receiptId); | ||
| } | ||
|
|
||
| void CoreExt::onExtendedMessageNegotiation(uint32_t friendId, bool compatible, uint64_t maxMessageSize, void* userData) | ||
| { | ||
| auto coreExt = static_cast<CoreExt*>(userData); | ||
| emit coreExt->extendedMessageSupport(friendId, compatible); | ||
| } | ||
|
|
Oops, something went wrong.