Update upstream source from tag 'upstream/0.7.0'

Update to upstream version '0.7.0'
with Debian dir 30dcb77a77433e4a54eab77c0b82ae925dead2d8

1 files changed, 40 insertions, 66 deletions

diff --git a/lib/events/roomevent.h b/lib/events/roomevent.h
index 621652cb..203434f6 100644
--- a/lib/events/roomevent.h
+++ b/lib/events/roomevent.h
@@ -1,20 +1,5 @@
-/******************************************************************************
- * Copyright (C) 2018 Kitsune Ral <kitsune-ral@users.sf.net>
- *
- * 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
- */
+// SPDX-FileCopyrightText: 2018 Kitsune Ral <kitsune-ral@users.sf.net>
+// SPDX-License-Identifier: LGPL-2.1-or-later
 
 #pragma once
 
@@ -25,33 +10,22 @@
 namespace Quotient {
 class RedactionEvent;
 
-/** This class corresponds to m.room.* events */
-class RoomEvent : public Event {
-    Q_GADGET
-    Q_PROPERTY(QString id READ id)
-    Q_PROPERTY(QDateTime timestamp READ timestamp CONSTANT)
-    Q_PROPERTY(QString roomId READ roomId CONSTANT)
-    Q_PROPERTY(QString senderId READ senderId CONSTANT)
-    Q_PROPERTY(QString redactionReason READ redactionReason)
-    Q_PROPERTY(bool isRedacted READ isRedacted)
-    Q_PROPERTY(QString transactionId READ transactionId WRITE setTransactionId)
+// That check could look into Event and find most stuff already deleted...
+// NOLINTNEXTLINE(cppcoreguidelines-special-member-functions)
+class QUOTIENT_API RoomEvent : public Event {
 public:
-    using factory_t = EventFactory<RoomEvent>;
+    QUO_BASE_EVENT(RoomEvent, {}, Event::BaseMetaType)
 
-    // RedactionEvent is an incomplete type here so we cannot inline
-    // constructors and destructors and we cannot use 'using'.
-    RoomEvent(Type type, event_mtype_t matrixType,
-              const QJsonObject& contentJson = {});
-    RoomEvent(Type type, const QJsonObject& json);
-    ~RoomEvent() override;
+    ~RoomEvent() override; // Don't inline this - see the private section
 
     QString id() const;
     QDateTime originTimestamp() const;
-    [[deprecated("Use originTimestamp()")]] QDateTime timestamp() const {
-        return originTimestamp();
-    }
     QString roomId() const;
     QString senderId() const;
+    //! \brief Determine whether the event has been replaced
+    //!
+    //! \return true if this event has been overridden by another event
+    //!         with `"rel_type": "m.replace"`; false otherwise
     bool isReplaced() const;
     QString replacedBy() const;
     bool isRedacted() const { return bool(_redactedBecause); }
@@ -63,48 +37,48 @@ public:
     QString transactionId() const;
     QString stateKey() const;
 
+    //! \brief Fill the pending event object with the room id
     void setRoomId(const QString& roomId);
+    //! \brief Fill the pending event object with the sender id
     void setSender(const QString& senderId);
-
-    /**
-     * Sets the transaction id for locally created events. This should be
-     * done before the event is exposed to any code using the respective
-     * Q_PROPERTY.
-     *
-     * \param txnId - transaction id, normally obtained from
-     * Connection::generateTxnId()
-     */
+    //! \brief Fill the pending event object with the transaction id
+    //! \param txnId - transaction id, normally obtained from
+    //!        Connection::generateTxnId()
     void setTransactionId(const QString& txnId);
 
-    /**
-     * Sets event id for locally created events
-     *
-     * When a new event is created locally, it has no server id yet.
-     * This function allows to add the id once the confirmation from
-     * the server is received. There should be no id set previously
-     * in the event. It's the responsibility of the code calling addId()
-     * to notify clients that use Q_PROPERTY(id) about its change
-     */
+    //! \brief Add an event id to locally created events after they are sent
+    //!
+    //! When a new event is created locally, it has no id; the homeserver
+    //! assigns it once the event is sent. This function allows to add the id
+    //! once the confirmation from the server is received. There should be no id
+    //! set previously in the event. It's the responsibility of the code calling
+    //! addId() to notify clients about the change; there's no signal or
+    //! callback for that in RoomEvent.
     void addId(const QString& newId);
 
+#ifdef Quotient_E2EE_ENABLED
+    void setOriginalEvent(event_ptr_tt<RoomEvent>&& originalEvent);
+    const RoomEvent* originalEvent() const { return _originalEvent.get(); }
+    const QJsonObject encryptedJson() const;
+#endif
+
+protected:
+    explicit RoomEvent(const QJsonObject& json);
+    void dumpTo(QDebug dbg) const override;
+
 private:
+    // RedactionEvent is an incomplete type here so we cannot inline
+    // constructors using it and also destructors (with 'using', in particular).
     event_ptr_tt<RedactionEvent> _redactedBecause;
+
+#ifdef Quotient_E2EE_ENABLED
+    event_ptr_tt<RoomEvent> _originalEvent;
+#endif
 };
 using RoomEventPtr = event_ptr_tt<RoomEvent>;
 using RoomEvents = EventsArray<RoomEvent>;
 using RoomEventsRange = Range<RoomEvents>;
 
-class CallEventBase : public RoomEvent {
-public:
-    CallEventBase(Type type, event_mtype_t matrixType, const QString& callId,
-                  int version, const QJsonObject& contentJson = {});
-    CallEventBase(Type type, const QJsonObject& json);
-    ~CallEventBase() override = default;
-    bool isCallEvent() const override { return true; }
-
-    QString callId() const { return content<QString>("call_id"_ls); }
-    int version() const { return content<int>("version"_ls); }
-};
 } // namespace Quotient
 Q_DECLARE_METATYPE(Quotient::RoomEvent*)
 Q_DECLARE_METATYPE(const Quotient::RoomEvent*)