Merge lp:~phablet-team/messaging-framework/destroyable_channels into lp:messaging-framework

[Gustavo Pichorim Boiko]

Add support for the Channel.Interface.Destroyable interface in chat rooms.

Add support for the Channel.Interface.Destroyable interface in chat rooms.

[Roberto Mier Escandon (rmescandon)]

Nice! I thought this kind of Telepathy implementations would only be included in TelepathyQt project, but looks nice this way. I'm thinking about a bunch of other implementations that we would need in future.
Just a comment below, and a question here:
Shouldn't this interface belong to a namespace, let's say, "messaging::tp::qt" or directly "Tp"?

Maybe in future we can shorten them by removing obvious ones

review: Needs Information

[lp:~phablet-team/messaging-framework/destroyable_channels]

27. By Gustavo Pichorim Boiko on 2016-06-08

Move all headers to include/ and make the classes local (not exported)

28. By Gustavo Pichorim Boiko on 2016-06-08

Move the classes to their own namespace.

[Gustavo Pichorim Boiko (boiko)]

> Nice! I thought this kind of Telepathy implementations would only be included
> in TelepathyQt project, but looks nice this way. I'm thinking about a bunch of
> other implementations that we would need in future.

Yes, at some point we should propose them for upstream, but to make things quicker we can keep them here for now.

> Just a comment below, and a question here:
> Shouldn't this interface belong to a namespace, let's say, "messaging::tp::qt"
> or directly "Tp"?

Good point. Moved them to messaging::qt::tp::interfaces.

>
> Maybe in future we can shorten them by removing obvious ones

Yep.

[lp:~phablet-team/messaging-framework/destroyable_channels]

29. By Gustavo Pichorim Boiko on 2016-06-08

Update TODO

[Roberto Mier Escandon (rmescandon)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== added file 'TODO'
--- TODO	1970-01-01 00:00:00 +0000
+++ TODO	2016-06-08 16:25:42 +0000
@@ -0,0 +1,7 @@
+General items
+-------------
+- Move telepathy interfaces to telepathy-qt
+
+Tests needed
+------------
+- test that calling Destroy() on DBus actually calls group_manager::dissolve_group()

=== added directory 'include/messaging/qt/tp/interfaces'
=== added file 'include/messaging/qt/tp/interfaces/base_channel_destroyable.h'
--- include/messaging/qt/tp/interfaces/base_channel_destroyable.h	1970-01-01 00:00:00 +0000
+++ include/messaging/qt/tp/interfaces/base_channel_destroyable.h	2016-06-08 16:25:42 +0000
@@ -0,0 +1,73 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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/>.
+ */
+
+#ifndef MESSAGING_QT_TP_INTERFACES_BASE_CHANNEL_DESTROYABLE_H_
+#define MESSAGING_QT_TP_INTERFACES_BASE_CHANNEL_DESTROYABLE_H_
+
+#include <TelepathyQt/BaseChannel>
+#include <messaging/visibility.h>
+
+namespace messaging
+{
+namespace qt
+{
+namespace tp
+{
+namespace interfaces
+{
+
+class BaseChannelDestroyableInterface;
+typedef Tp::SharedPtr<BaseChannelDestroyableInterface> BaseChannelDestroyableInterfacePtr;
+
+class MESSAGING_FW_LOCAL BaseChannelDestroyableInterface : public Tp::AbstractChannelInterface
+{
+    Q_OBJECT
+    Q_DISABLE_COPY(BaseChannelDestroyableInterface)
+
+public:
+    static BaseChannelDestroyableInterfacePtr create() {
+        return BaseChannelDestroyableInterfacePtr(new BaseChannelDestroyableInterface());
+    }
+    template<typename BaseChannelDestroyableInterfaceSubclass>
+    static Tp::SharedPtr<BaseChannelDestroyableInterfaceSubclass> create() {
+        return Tp::SharedPtr<BaseChannelDestroyableInterfaceSubclass>(
+                   new BaseChannelDestroyableInterfaceSubclass());
+    }
+    virtual ~BaseChannelDestroyableInterface();
+
+    QVariantMap immutableProperties() const;
+
+    void destroy();
+
+    typedef Tp::Callback1<void, Tp::DBusError*> DestroyCallback;
+    void setDestroyCallback(const DestroyCallback &cb);
+private:
+    BaseChannelDestroyableInterface();
+    void createAdaptor();
+
+    class Adaptee;
+    friend class Adaptee;
+    struct Private;
+    friend struct Private;
+    Private *mPriv;
+};
+
+}
+}
+}
+}
+
+#endif // MESSAGING_QT_TP_INTERFACES_BASE_CHANNEL_DESTROYABLE_H_

=== added file 'include/messaging/qt/tp/interfaces/base_channel_destroyable_internal.h'
--- include/messaging/qt/tp/interfaces/base_channel_destroyable_internal.h	1970-01-01 00:00:00 +0000
+++ include/messaging/qt/tp/interfaces/base_channel_destroyable_internal.h	2016-06-08 16:25:42 +0000
@@ -0,0 +1,53 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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/>.
+ */
+
+#ifndef MESSAGING_QT_TP_INTERFACES_BASE_CHANNEL_DESTROYABLE_INTERNAL_H_
+#define MESSAGING_QT_TP_INTERFACES_BASE_CHANNEL_DESTROYABLE_INTERNAL_H_
+
+#include <TelepathyQt/_gen/svc-channel.h>
+#include <messaging/qt/tp/interfaces/base_channel_destroyable.h>
+#include <messaging/visibility.h>
+
+namespace messaging
+{
+namespace qt
+{
+namespace tp
+{
+namespace interfaces
+{
+
+class MESSAGING_FW_LOCAL BaseChannelDestroyableInterface::Adaptee : public QObject
+{
+    Q_OBJECT
+public:
+    Adaptee(BaseChannelDestroyableInterface *interface);
+    ~Adaptee();
+
+public Q_SLOTS:
+    void destroy(const Tp::Service::ChannelInterfaceDestroyableAdaptor::DestroyContextPtr &context);
+
+public:
+    BaseChannelDestroyableInterface *mInterface;
+};
+
+}
+}
+}
+}
+
+#endif // MESSAGING_QT_TP_INTERFACES_BASE_CHANNEL_DESTROYABLE_INTERNAL_H_
+

=== modified file 'include/messaging/qt/tp/text_channel.h'
--- include/messaging/qt/tp/text_channel.h	2016-05-18 21:37:35 +0000
+++ include/messaging/qt/tp/text_channel.h	2016-06-08 16:25:42 +0000
@@ -20,6 +20,7 @@
 #include <messaging/chat.h>
 #include <messaging/messenger.h>
 #include <messaging/qt/runtime.h>
+#include <messaging/qt/tp/interfaces/base_channel_destroyable.h>
 
 #include <TelepathyQt/BaseChannel>
 #include <TelepathyQt/Types>
@@ -167,6 +168,9 @@
     // Handler action on remove members request
     void remove_members(const Tp::UIntList& handles, const QString& message, Tp::DBusError* error);
 
+    // channel destruction request. only supported in group chats
+    void destroy(Tp::DBusError* error);
+
     // Helper functions encapsulating setup tasks.
     void register_callbacks_once();
     void plug_interfaces_once();
@@ -177,6 +181,7 @@
     Tp::BaseChannelRoomInterfacePtr bcri;
     Tp::BaseChannelRoomConfigInterfacePtr bcrci;
     Tp::BaseChannelGroupInterfacePtr bcgi;
+    interfaces::BaseChannelDestroyableInterfacePtr bcdi;
 
     // NOTE(rmescandon): this is a temporal member in the class not needed from Telepathy Qt >= 0.9.7.0 which
     // includes Tp::BaseChannel::connection() method to obtain it whenever is needed.

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2016-05-30 16:43:03 +0000
+++ src/CMakeLists.txt	2016-06-08 16:25:42 +0000
@@ -1,7 +1,10 @@
 # Expose internal headers under sensible paths to the impl.
 include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/messaging ${PROCESS_CPP_INCLUDE_DIRS} ${LibPhoneNumber_INCLUDE_DIRS})
 
-qt5_wrap_cpp(MESSAGING_FW_MOCS ${CMAKE_SOURCE_DIR}/include/messaging/qt/tp/protocol.h ${CMAKE_SOURCE_DIR}/include/messaging/qt/tp/connection.h)
+qt5_wrap_cpp(MESSAGING_FW_MOCS ${CMAKE_SOURCE_DIR}/include/messaging/qt/tp/protocol.h
+                               ${CMAKE_SOURCE_DIR}/include/messaging/qt/tp/connection.h
+                               ${CMAKE_SOURCE_DIR}/include/messaging/qt/tp/interfaces/base_channel_destroyable.h
+                               ${CMAKE_SOURCE_DIR}/include/messaging/qt/tp/interfaces/base_channel_destroyable_internal.h)
 
 # The general messaging-fw shared library.
 add_library(
@@ -40,6 +43,8 @@
   messaging/qt/tp/protocol.cpp
   messaging/qt/tp/text_channel.cpp
 
+  messaging/qt/tp/interfaces/base_channel_destroyable.cpp
+
   messaging/runner.cpp)
 
 target_link_libraries(

=== added directory 'src/messaging/qt/tp/interfaces'
=== added file 'src/messaging/qt/tp/interfaces/base_channel_destroyable.cpp'
--- src/messaging/qt/tp/interfaces/base_channel_destroyable.cpp	1970-01-01 00:00:00 +0000
+++ src/messaging/qt/tp/interfaces/base_channel_destroyable.cpp	2016-06-08 16:25:42 +0000
@@ -0,0 +1,107 @@
+/*
+ * Copyright © 2016 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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/>.
+ */
+
+#include <TelepathyQt/DBusObject>
+#include <messaging/qt/tp/interfaces/base_channel_destroyable.h>
+#include <messaging/qt/tp/interfaces/base_channel_destroyable_internal.h>
+
+namespace mqt = messaging::qt;
+
+// Chan.I.Destroyable
+mqt::tp::interfaces::BaseChannelDestroyableInterface::Adaptee::Adaptee(BaseChannelDestroyableInterface *interface)
+    : QObject(interface),
+      mInterface(interface)
+{
+}
+
+mqt::tp::interfaces::BaseChannelDestroyableInterface::Adaptee::~Adaptee()
+{
+}
+
+struct TP_QT_NO_EXPORT mqt::tp::interfaces::BaseChannelDestroyableInterface::Private {
+    Private(BaseChannelDestroyableInterface *parent)
+        :adaptee(new BaseChannelDestroyableInterface::Adaptee(parent)) {
+    }
+
+    DestroyCallback destroyCB;
+    BaseChannelDestroyableInterface::Adaptee *adaptee;
+};
+
+void mqt::tp::interfaces::BaseChannelDestroyableInterface::Adaptee::destroy(const Tp::Service::ChannelInterfaceDestroyableAdaptor::DestroyContextPtr &context)
+{
+    if (!mInterface->mPriv->destroyCB.isValid()) {
+        context->setFinishedWithError(TP_QT_ERROR_NOT_IMPLEMENTED, QLatin1String("Not implemented"));
+        return;
+    }
+
+    Tp::DBusError error;
+    mInterface->mPriv->destroyCB(&error);
+    if (error.isValid()) {
+        context->setFinishedWithError(error.name(), error.message());
+        return;
+    }
+    context->setFinished();
+}
+
+/**
+ * \class BaseChannelDestroyableInterface
+ *
+ * \brief Base class for implementations of Channel.Interface.Destroyable
+ *
+ */
+
+/**
+ * Class constructor.
+ */
+mqt::tp::interfaces::BaseChannelDestroyableInterface::BaseChannelDestroyableInterface()
+    : Tp::AbstractChannelInterface(TP_QT_IFACE_CHANNEL_INTERFACE_DESTROYABLE),
+      mPriv(new Private(this))
+{
+}
+
+void mqt::tp::interfaces::BaseChannelDestroyableInterface::setDestroyCallback(const DestroyCallback &cb)
+{
+    mPriv->destroyCB = cb;
+}
+
+/**
+ * Class destructor.
+ */
+mqt::tp::interfaces::BaseChannelDestroyableInterface::~BaseChannelDestroyableInterface()
+{
+    delete mPriv;
+}
+
+/**
+ * Return the immutable properties of this interface.
+ *
+ * Immutable properties cannot change after the interface has been registered
+ * on a service on the bus with registerInterface().
+ *
+ * \return The immutable properties of this interface.
+ */
+QVariantMap mqt::tp::interfaces::BaseChannelDestroyableInterface::immutableProperties() const
+{
+    QVariantMap map;
+    return map;
+}
+
+void mqt::tp::interfaces::BaseChannelDestroyableInterface::createAdaptor()
+{
+    (void) new Tp::Service::ChannelInterfaceDestroyableAdaptor(dbusObject()->dbusConnection(),
+            mPriv->adaptee, dbusObject());
+}
+

=== modified file 'src/messaging/qt/tp/text_channel.cpp'
--- src/messaging/qt/tp/text_channel.cpp	2016-06-06 18:42:21 +0000
+++ src/messaging/qt/tp/text_channel.cpp	2016-06-08 16:25:42 +0000
@@ -281,6 +281,8 @@
         Tp::ChannelGroupFlags groupFlags = Tp::ChannelGroupFlagCanAdd|Tp::ChannelGroupFlagCanRemove;
         bcgi = Tp::BaseChannelGroupInterface::create(groupFlags, tp_connection->selfHandle());
 
+        bcdi = mqt::tp::interfaces::BaseChannelDestroyableInterface::create();
+
         // we need to set the initial group members
         on_members_updated(group->initial_invitees());
     }
@@ -599,6 +601,16 @@
     group_manager->remove_members(users);
 }
 
+void mqt::tp::TextChannel::destroy(Tp::DBusError* error)
+{
+    std::shared_ptr<messaging::GroupManager> group_manager = chat->interface<GroupManager>();
+    if (!group_manager) {
+        error->set(TP_QT_ERROR_NOT_AVAILABLE, "Text channel is not a room");
+        return;
+    }
+    group_manager->dissolve_group();
+}
+
 void mqt::tp::TextChannel::register_callbacks_once()
 {
     bcmi->setSendMessageCallback(Tp::memFun(this, &TextChannel::send_message));
@@ -608,6 +620,12 @@
         bcgi->setAddMembersCallback(Tp::memFun(this, &TextChannel::add_members));
         bcgi->setRemoveMembersCallback(Tp::memFun(this, &TextChannel::remove_members));
     }
+
+    // if the room interface is available, we can plug the destroyable one too
+    if (!bcri.isNull())
+    {
+        bcdi->setDestroyCallback(Tp::memFun(this, &TextChannel::destroy));
+    }
 }
 
 void mqt::tp::TextChannel::plug_interfaces_once()
@@ -617,6 +635,7 @@
     plug_interface_if_available(bcri);
     plug_interface_if_available(bcrci);
     plug_interface_if_available(bcgi);
+    plug_interface_if_available(bcdi);
 }
 
 void mqt::tp::TextChannel::plug_interface_if_available(const Tp::AbstractChannelInterfacePtr &interface)

=== modified file 'tests/unit/messaging/qt_telepathy_adapter_test.cpp'
--- tests/unit/messaging/qt_telepathy_adapter_test.cpp	2016-05-04 20:03:23 +0000
+++ tests/unit/messaging/qt_telepathy_adapter_test.cpp	2016-06-08 16:25:42 +0000
@@ -714,6 +714,7 @@
                         ASSERT_TRUE(channel->hasInterface(TP_QT_IFACE_CHANNEL_INTERFACE_ROOM));
                         ASSERT_TRUE(channel->hasInterface(TP_QT_IFACE_CHANNEL_INTERFACE_ROOM_CONFIG));
                         ASSERT_TRUE(channel->hasInterface(TP_QT_IFACE_CHANNEL_INTERFACE_GROUP));
+                        ASSERT_TRUE(channel->hasInterface(TP_QT_IFACE_CHANNEL_INTERFACE_DESTROYABLE));
 
                         // check that the group has the invitee contact
                         ASSERT_EQ(channel->groupContacts(false).count(), 1);