From 749def2b983d2338272c0891d15de20df22e2eea Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 22 Jun 2017 16:38:29 +0900 Subject: Enable sending RoomMessageEvents 1. PostMessageJob is now SendEventJob, which reflects two things: first, it's a PUT instead of a POST (POST for /send is not supported by the latest spec anyway), so that we could enable tracking transaction ids for local echo in the near future; second, it's no more just about messages, the job can support sending any room events (topic changes etc.). 2. Room::postMessage() now uses the new RoomMessageEvent API to send m.room.message events. --- CMakeLists.txt | 2 +- connection.cpp | 4 ++-- jobs/postmessagejob.cpp | 64 ------------------------------------------------- jobs/postmessagejob.h | 46 ----------------------------------- jobs/sendeventjob.cpp | 41 +++++++++++++++++++++++++++++++ jobs/sendeventjob.h | 57 +++++++++++++++++++++++++++++++++++++++++++ libqmatrixclient.pri | 4 ++-- room.cpp | 17 +++++++------ room.h | 8 +++++-- 9 files changed, 119 insertions(+), 124 deletions(-) delete mode 100644 jobs/postmessagejob.cpp delete mode 100644 jobs/postmessagejob.h create mode 100644 jobs/sendeventjob.cpp create mode 100644 jobs/sendeventjob.h diff --git a/CMakeLists.txt b/CMakeLists.txt index ad7c5a34..1d118d82 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -63,7 +63,7 @@ set(libqmatrixclient_SRCS jobs/basejob.cpp jobs/checkauthmethods.cpp jobs/passwordlogin.cpp - jobs/postmessagejob.cpp + jobs/sendeventjob.cpp jobs/postreceiptjob.cpp jobs/joinroomjob.cpp jobs/leaveroomjob.cpp diff --git a/connection.cpp b/connection.cpp index 56ceb068..f9f1490c 100644 --- a/connection.cpp +++ b/connection.cpp @@ -23,7 +23,7 @@ #include "room.h" #include "jobs/passwordlogin.h" #include "jobs/logoutjob.h" -#include "jobs/postmessagejob.h" +#include "jobs/sendeventjob.h" #include "jobs/postreceiptjob.h" #include "jobs/joinroomjob.h" #include "jobs/leaveroomjob.h" @@ -187,7 +187,7 @@ void Connection::stopSync() void Connection::postMessage(Room* room, const QString& type, const QString& message) const { - callApi(room->id(), type, message); + callApi(room->id(), type, message); } PostReceiptJob* Connection::postReceipt(Room* room, RoomEvent* event) const diff --git a/jobs/postmessagejob.cpp b/jobs/postmessagejob.cpp deleted file mode 100644 index df30614c..00000000 --- a/jobs/postmessagejob.cpp +++ /dev/null @@ -1,64 +0,0 @@ -/****************************************************************************** - * Copyright (C) 2015 Felix Rohrbach - * - * This library 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 2.1 of the License, or (at your option) any later version. - * - * This library 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 library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - */ - -#include "postmessagejob.h" -#include "util.h" - -using namespace QMatrixClient; - -class PostMessageJob::Private -{ - public: - QString eventId; // unused yet -}; - -PostMessageJob::PostMessageJob(const ConnectionData* connection, - const QString& roomId, const QString& type, - const QString& plainText) - : BaseJob(connection, HttpVerb::Post, "PostMessageJob", - QStringLiteral("_matrix/client/r0/rooms/%1/send/m.room.message").arg(roomId), - Query(), - Data({ { "msgtype", type }, { "body", plainText } }) ) - , d(new Private) -{ } - -PostMessageJob::PostMessageJob(const ConnectionData* connection, - const QString& roomId, const QString& type, - const QString& plainText, const QString& richText) - : BaseJob(connection, HttpVerb::Post, "PostMessageJob", - QStringLiteral("_matrix/client/r0/rooms/%1/send/m.room.message").arg(roomId), - Query(), - Data({ { "msgtype", type }, { "body", plainText } - , { "format", QStringLiteral("org.matrix.custom.html") } - , { "formatted_body", richText } }) ) - , d(new Private) -{ } - -PostMessageJob::~PostMessageJob() -{ - delete d; -} - -BaseJob::Status PostMessageJob::parseJson(const QJsonDocument& data) -{ - if( data.object().contains("event_id") ) - return Success; - - qCDebug(JOBS) << data; - return { UserDefinedError, "No event_id in the JSON response" }; -} diff --git a/jobs/postmessagejob.h b/jobs/postmessagejob.h deleted file mode 100644 index f4ae809b..00000000 --- a/jobs/postmessagejob.h +++ /dev/null @@ -1,46 +0,0 @@ -/****************************************************************************** - * Copyright (C) 2015 Felix Rohrbach - * - * This library 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 2.1 of the License, or (at your option) any later version. - * - * This library 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 library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - */ - -#pragma once - -#include "basejob.h" - -namespace QMatrixClient -{ - class PostMessageJob: public BaseJob - { - public: - /** Constructs a plain text message job */ - PostMessageJob(const ConnectionData* connection, const QString& roomId, - const QString& type, const QString& plainText); - /** Constructs a rich text message job */ - PostMessageJob(const ConnectionData* connection, const QString& roomId, - const QString& type, const QString& plainText, - const QString& richText); - virtual ~PostMessageJob(); - - //bool success(); - - protected: - Status parseJson(const QJsonDocument& data) override; - - private: - class Private; - Private* d; - }; -} // namespace QMatrixClient diff --git a/jobs/sendeventjob.cpp b/jobs/sendeventjob.cpp new file mode 100644 index 00000000..f3c95fe8 --- /dev/null +++ b/jobs/sendeventjob.cpp @@ -0,0 +1,41 @@ +/****************************************************************************** + * Copyright (C) 2015 Felix Rohrbach + * + * This library 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 2.1 of the License, or (at your option) any later version. + * + * This library 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 library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include "sendeventjob.h" + +#include "events/roommessageevent.h" + +using namespace QMatrixClient; + +SendEventJob::SendEventJob(const ConnectionData* connection, + const QString& roomId, const QString& type, + const QString& plainText) + : SendEventJob(connection, roomId, + new RoomMessageEvent(plainText, type)) +{ } + +BaseJob::Status SendEventJob::parseJson(const QJsonDocument& data) +{ + _eventId = data.object().value("event_id").toString(); + if (!_eventId.isEmpty()) + return Success; + + qCDebug(JOBS) << data; + return { UserDefinedError, "No event_id in the JSON response" }; +} + diff --git a/jobs/sendeventjob.h b/jobs/sendeventjob.h new file mode 100644 index 00000000..180fdd19 --- /dev/null +++ b/jobs/sendeventjob.h @@ -0,0 +1,57 @@ +/****************************************************************************** + * Copyright (C) 2015 Felix Rohrbach + * + * This library 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 2.1 of the License, or (at your option) any later version. + * + * This library 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 library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#pragma once + +#include "basejob.h" + +#include "connectiondata.h" + +namespace QMatrixClient +{ + class SendEventJob: public BaseJob + { + public: + /** Constructs a job that sends an arbitrary room event */ + template + SendEventJob(const ConnectionData* connection, const QString& roomId, + const EvT* event) + : BaseJob(connection, HttpVerb::Put, "SendEventJob", + QStringLiteral("_matrix/client/r0/rooms/%1/send/%2/%3") + .arg(roomId).arg(EvT::TypeId) + .arg(event->transactionId()), + Query(), + Data(event->toJson())) + { } + + /** + * Constructs a plain text message job (for compatibility with + * the old PostMessageJob API). + */ + SendEventJob(const ConnectionData* connection, const QString& roomId, + const QString& type, const QString& plainText); + + QString eventId() const { return _eventId; } + + protected: + Status parseJson(const QJsonDocument& data) override; + + private: + QString _eventId; + }; +} // namespace QMatrixClient diff --git a/libqmatrixclient.pri b/libqmatrixclient.pri index d2d4c088..c352e186 100644 --- a/libqmatrixclient.pri +++ b/libqmatrixclient.pri @@ -21,7 +21,7 @@ HEADERS += \ $$PWD/jobs/basejob.h \ $$PWD/jobs/checkauthmethods.h \ $$PWD/jobs/passwordlogin.h \ - $$PWD/jobs/postmessagejob.h \ + $$PWD/jobs/sendeventjob.h \ $$PWD/jobs/postreceiptjob.h \ $$PWD/jobs/joinroomjob.h \ $$PWD/jobs/leaveroomjob.h \ @@ -49,7 +49,7 @@ SOURCES += \ $$PWD/jobs/basejob.cpp \ $$PWD/jobs/checkauthmethods.cpp \ $$PWD/jobs/passwordlogin.cpp \ - $$PWD/jobs/postmessagejob.cpp \ + $$PWD/jobs/sendeventjob.cpp \ $$PWD/jobs/postreceiptjob.cpp \ $$PWD/jobs/joinroomjob.cpp \ $$PWD/jobs/leaveroomjob.cpp \ diff --git a/room.cpp b/room.cpp index 24745b9b..cfdd33ac 100644 --- a/room.cpp +++ b/room.cpp @@ -21,14 +21,12 @@ #include #include -#include #include // for efficient string concats (operator%) #include #include "connection.h" #include "state.h" #include "user.h" -#include "events/roommessageevent.h" #include "events/roomnameevent.h" #include "events/roomaliasesevent.h" #include "events/roomcanonicalaliasevent.h" @@ -36,7 +34,7 @@ #include "events/roommemberevent.h" #include "events/typingevent.h" #include "events/receiptevent.h" -#include "jobs/postmessagejob.h" +#include "jobs/sendeventjob.h" #include "jobs/roommessagesjob.h" #include "jobs/postreceiptjob.h" #include "jobs/leaveroomjob.h" @@ -560,13 +558,18 @@ void Room::updateData(SyncRoomData&& data) void Room::postMessage(const QString& type, const QString& plainText) { - connection()->callApi(id(), type, plainText); + connection()->callApi(id(), type, plainText); } -void Room::postMessage(const QString& type, const QString& plainText, - const QString& richText) +void Room::postMessage(const QString& plainText, MessageEventType type) { - connection()->callApi(id(), type, plainText, richText); + RoomMessageEvent rme(plainText, type); + postMessage(&rme); +} + +void Room::postMessage(RoomMessageEvent* event) +{ + connection()->callApi(id(), event); } void Room::getPreviousContent(int limit) diff --git a/room.h b/room.h index 60278107..03827a55 100644 --- a/room.h +++ b/room.h @@ -27,6 +27,7 @@ #include #include "jobs/syncjob.h" +#include "events/roommessageevent.h" #include "joinstate.h" namespace QMatrixClient @@ -142,9 +143,12 @@ namespace QMatrixClient MemberSorter memberSorter() const; public slots: + void postMessage(const QString& plainText, + MessageEventType type = MessageEventType::Text); + void postMessage(RoomMessageEvent* event); + /** @deprecated */ void postMessage(const QString& type, const QString& plainText); - void postMessage(const QString& type, const QString& plainText, - const QString& richText); + void getPreviousContent(int limit = 10); void leaveRoom() const; -- cgit v1.2.3