Merge lp:~phablet-team/telephony-service/add-participants-model into lp:telephony-service/staging

[Tiago Salem Herrmann]

Add ParticipantsModel

Add ParticipantsModel

[lp:~phablet-team/telephony-service/add-participants-model]

1241. By Tiago Salem Herrmann on 2017-02-15

Add missing files

1242. By Tiago Salem Herrmann on 2017-02-16

add missing cpp file

1243. By Tiago Salem Herrmann on 2017-02-16

add more props to participants

1244. By Tiago Salem Herrmann on 2017-02-16

include all participants

1245. By Tiago Salem Herrmann on 2017-02-16

change string comparison method

1246. By Tiago Salem Herrmann on 2017-02-16

fallback to threadId if no participant is provided

1247. By Tiago Salem Herrmann on 2017-02-17

merge parent

1248. By Tiago Salem Herrmann on 2017-02-24

Fix sorting

1249. By Tiago Salem Herrmann on 2017-03-03

merge parent branch

[Gustavo Pichorim Boiko (boiko)]

Some things need to be addressed, but in general it looks good.

review: Needs Fixing

[lp:~phablet-team/telephony-service/add-participants-model]

1250. By Tiago Salem Herrmann on 2017-03-22

use enums instead of uints and disconnect old instances of ChatEntry from the model

[Tiago Salem Herrmann (tiagosh)]

done

[Gustavo Pichorim Boiko (boiko)]

Looks good now, thanks!

review: Approve

=== modified file 'Ubuntu/Telephony/CMakeLists.txt'
--- Ubuntu/Telephony/CMakeLists.txt	2016-07-05 03:34:11 +0000
+++ Ubuntu/Telephony/CMakeLists.txt	2017-03-22 16:46:15 +0000
@@ -2,6 +2,7 @@
 
 set(plugin_SRCS
     presencerequest.cpp
+    participantsmodel.cpp
     components.cpp
     )
 

=== modified file 'Ubuntu/Telephony/components.cpp'
--- Ubuntu/Telephony/components.cpp	2016-11-23 19:28:18 +0000
+++ Ubuntu/Telephony/components.cpp	2017-03-22 16:46:15 +0000
@@ -39,6 +39,7 @@
 #include "accountentry.h"
 #include "accountlist.h"
 #include "audiooutput.h"
+#include "participantsmodel.h"
 
 #include <QQmlEngine>
 #include <qqml.h>
@@ -87,5 +88,6 @@
     qmlRegisterType<ContactWatcher>(uri, 0, 1, "ContactWatcher");
     qmlRegisterType<Participant>(uri, 0, 1, "Participant");
     qmlRegisterType<PresenceRequest>(uri, 0, 1, "PresenceRequest");
+    qmlRegisterType<ParticipantsModel>(uri, 0, 1, "ParticipantsModel");
     qmlRegisterType<PhoneUtils>(uri, 0, 1, "PhoneUtils");
 }

=== added file 'Ubuntu/Telephony/participantsmodel.cpp'
--- Ubuntu/Telephony/participantsmodel.cpp	1970-01-01 00:00:00 +0000
+++ Ubuntu/Telephony/participantsmodel.cpp	2017-03-22 16:46:15 +0000
@@ -0,0 +1,233 @@
+/*
+ * Copyright (C) 2013-2017 Canonical, Ltd.
+ *
+ * Authors:
+ *  Gustavo Pichorim Boiko <[e-mail]>
+ *  Tiago Salem Herrmann <[e-mail]>
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free 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; version 3.
+ *
+ * telephony-service 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "participantsmodel.h"
+#include <participant.h>
+#include <QDebug>
+
+Q_DECLARE_METATYPE(Participant)
+
+ParticipantsModel::ParticipantsModel(QObject *parent) :
+    QAbstractListModel(parent), mWaitingForQml(false), mCanFetchMore(true)
+{
+    qRegisterMetaType<Participant>();
+    mRoles[AliasRole] = "alias";
+    mRoles[IdentifierRole] = "identifier";
+    mRoles[RolesRole] = "roles";
+    mRoles[StateRole] = "state";
+
+    connect(this, SIGNAL(rowsInserted(QModelIndex,int,int)), this, SIGNAL(countChanged()));
+    connect(this, SIGNAL(rowsRemoved(QModelIndex,int,int)), this, SIGNAL(countChanged()));
+    connect(this, SIGNAL(modelReset()), this, SIGNAL(countChanged()));
+}
+
+bool ParticipantsModel::canFetchMore(const QModelIndex &parent) const
+{
+    return !mParticipantsCache.isEmpty();
+}
+
+ParticipantsModel::~ParticipantsModel()
+{
+}
+
+void ParticipantsModel::fetchMore(const QModelIndex &parent)
+{
+    if (parent.isValid() ) {
+        return;
+    }
+
+    int max = 14;
+    while (max >= 0 && !mParticipantsCache.isEmpty()) {
+        addParticipant(mParticipantsCache.takeFirst());
+        max--;
+    }
+
+    if (mParticipantsCache.isEmpty()) {
+        mCanFetchMore = false;
+        Q_EMIT canFetchMoreChanged();
+    }
+}
+
+int ParticipantsModel::rowCount(const QModelIndex &parent) const
+{
+    if (parent.isValid()) {
+        return 0;
+    }
+
+    return mParticipants.count();
+}
+
+QHash<int, QByteArray> ParticipantsModel::roleNames() const
+{
+    return mRoles;
+}
+
+void ParticipantsModel::addParticipantCache(Participant *participant)
+{
+    int pos = positionForItem(participant->identifier(), true);
+    mParticipantsCache.insert(pos, participant);
+}
+
+void ParticipantsModel::addParticipant(Participant *participant)
+{
+    int pos = positionForItem(participant->identifier());
+    beginInsertRows(QModelIndex(), pos, pos);
+    mParticipants.insert(pos, participant);
+    endInsertRows();
+}
+
+void ParticipantsModel::removeParticipant(Participant *participant)
+{
+    int pos = mParticipants.indexOf(participant);
+    if (pos >= 0) {
+        beginRemoveRows(QModelIndex(), pos, pos);
+        mParticipants.removeAt(pos);
+        endRemoveRows();
+    }
+    pos = mParticipantsCache.indexOf(participant);
+    if (pos >= 0) {
+        mParticipantsCache.removeAt(pos);
+    }
+}
+
+QVariant ParticipantsModel::data(const QModelIndex &index, int role) const
+{
+    if (!index.isValid() || index.row() < 0 || index.row() >= rowCount()) {
+        return QVariant();
+    }
+    switch (role) {
+    case IdentifierRole:
+        return mParticipants[index.row()]->identifier();
+    break;
+    case AliasRole:
+        return mParticipants[index.row()]->alias();
+    break;
+    case StateRole:
+        return 0;
+    break;
+    case RolesRole:
+        return mParticipants[index.row()]->roles();
+    break;
+    }
+    return QVariant();
+}
+
+bool ParticipantsModel::lessThan(const QString &left, const QString &right) const
+{
+    // this method will push participant with names starting with non-letter
+    // characters to the end of the list
+    if (left.isEmpty() || right.isEmpty()) {
+        return false;
+    }
+    if (left.at(0).isLetter() && right.at(0).isLetter()) {
+        return left.localeAwareCompare(right) < 0;
+    }
+    if (!left.at(0).isLetter() && right.at(0).isLetter()) {
+        return false;
+    }
+    if (left.at(0).isLetter() && !right.at(0).isLetter()) {
+        return true;
+    }
+
+    return false;
+}
+
+int ParticipantsModel::positionForItem(const QString &item, bool cache) const
+{
+    // do a binary search for the item position on the list
+    int lowerBound = 0;
+    int upperBound = cache ? mParticipantsCache.count() - 1 : rowCount() - 1;
+    if (upperBound < 0) {
+        return 0;
+    }
+
+    while (true) {
+        int pos = (upperBound + lowerBound) / 2;
+        const QString posItem = cache ? mParticipantsCache[pos]->identifier() : index(pos).data(IdentifierRole).toString();
+        if (lowerBound == pos) {
+            if (lessThan(item, posItem)) {
+                return pos;
+            }
+        }
+        if (lessThan(posItem, item)) {
+            lowerBound = pos + 1;          // its in the upper
+            if (lowerBound > upperBound) {
+                return pos += 1;
+            }
+        } else if (lowerBound > upperBound) {
+            return pos;
+        } else {
+            upperBound = pos - 1;          // its in the lower
+        }
+    }
+}
+
+void ParticipantsModel::classBegin()
+{
+    mWaitingForQml = true;
+}
+
+void ParticipantsModel::componentComplete()
+{
+    mWaitingForQml = false;
+}
+
+QVariant ParticipantsModel::get(int row) const
+{
+    QVariantMap data;
+    QModelIndex idx = index(row, 0);
+    if (idx.isValid()) {
+        QHash<int, QByteArray> roles = roleNames();
+        Q_FOREACH(int role, roles.keys()) {
+            data.insert(roles[role], idx.data(role));
+        }
+    }
+
+    return data;
+}
+
+ChatEntry* ParticipantsModel::chatEntry() const
+{
+    return mChatEntry;
+}
+
+void ParticipantsModel::setChatEntry(ChatEntry *entry)
+{
+    if (mChatEntry == entry) {
+        return;
+    }
+    ChatEntry *previousChatEntry = mChatEntry;
+    mChatEntry = entry;
+    if (!entry) {
+        return;
+    }
+    previousChatEntry->disconnect(this);
+    connect(mChatEntry, SIGNAL(participantAdded(Participant *)), SLOT(addParticipant(Participant *)));
+    connect(mChatEntry, SIGNAL(participantRemoved(Participant *)), SLOT(removeParticipant(Participant *)));
+    Q_FOREACH(Participant *participant, mChatEntry->allParticipants()) {
+        addParticipantCache(participant);
+    }
+    fetchMore();
+    mCanFetchMore = !mParticipantsCache.isEmpty();
+    Q_EMIT canFetchMoreChanged();
+    Q_EMIT chatEntryChanged();
+}

=== added file 'Ubuntu/Telephony/participantsmodel.h'
--- Ubuntu/Telephony/participantsmodel.h	1970-01-01 00:00:00 +0000
+++ Ubuntu/Telephony/participantsmodel.h	2017-03-22 16:46:15 +0000
@@ -0,0 +1,92 @@
+/*
+ * Copyright (C) 2013-2017 Canonical, Ltd.
+ *
+ * Authors:
+ *  Gustavo Pichorim Boiko <[e-mail]>
+ *  Tiago Salem Herrmann <[e-mail]>
+ *
+ * This file is part of telephony-service.
+ *
+ * telephony-service is free 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; version 3.
+ *
+ * telephony-service 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef PARTICIPANTSMODEL_H
+#define PARTICIPANTSMODEL_H
+
+#include "chatentry.h"
+#include <QAbstractListModel>
+#include <QStringList>
+#include <QQmlParserStatus>
+#include <QQmlListProperty>
+
+class Participant;
+
+class ParticipantsModel : public QAbstractListModel, public QQmlParserStatus
+{
+    Q_OBJECT
+    Q_INTERFACES(QQmlParserStatus)
+    Q_PROPERTY(int count READ rowCount NOTIFY countChanged)
+    Q_PROPERTY(bool canFetchMore READ canFetchMore NOTIFY canFetchMoreChanged)
+    Q_PROPERTY(ChatEntry* chatEntry READ chatEntry WRITE setChatEntry NOTIFY chatEntryChanged)
+    Q_ENUMS(Role)
+
+public:
+    enum Role {
+        IdentifierRole = Qt::UserRole,
+        AliasRole,
+        RolesRole,
+        StateRole
+    };
+
+    explicit ParticipantsModel(QObject *parent = 0);
+    ~ParticipantsModel();
+
+    Q_INVOKABLE virtual bool canFetchMore(const QModelIndex &parent = QModelIndex()) const;
+    Q_INVOKABLE virtual void fetchMore(const QModelIndex &parent = QModelIndex());
+    virtual QHash<int, QByteArray> roleNames() const;
+    virtual QVariant data(const QModelIndex &index, int role) const;
+    int rowCount(const QModelIndex &parent = QModelIndex()) const;
+
+    Q_INVOKABLE virtual QVariant get(int row) const;
+
+    Q_INVOKABLE void setChatEntry(ChatEntry *entry);
+    ChatEntry* chatEntry() const;
+
+    void addParticipantCache(Participant *participant);
+
+    void classBegin();
+    void componentComplete();
+
+private Q_SLOTS:
+    void addParticipant(Participant *participant);
+    void removeParticipant(Participant *participant);
+
+Q_SIGNALS:
+    void countChanged();
+    void canFetchMoreChanged();
+    void chatEntryChanged();
+
+protected:
+    bool lessThan(const QString &left, const QString &right) const;
+    int positionForItem(const QString &item, bool cache = false) const;
+
+private:
+    QHash<int, QByteArray> mRoles;
+    QList<Participant*> mParticipants;
+    bool mWaitingForQml;
+    bool mCanFetchMore;
+    ChatEntry *mChatEntry;
+    QList<Participant*> mParticipantsCache;
+};
+
+#endif // PARTICIPANTSMODEL_H

=== modified file 'handler/texthandler.cpp'
--- handler/texthandler.cpp	2017-03-22 16:46:14 +0000
+++ handler/texthandler.cpp	2017-03-22 16:46:15 +0000
@@ -168,8 +168,14 @@
     if (chatType == Tp::HandleTypeNone && targetIds.size() == 1) {
         chatType = Tp::HandleTypeContact;
     }
+
     QString roomId = properties["threadId"].toString();
 
+    // try to use the threadId as participantId if empty
+    if (chatType == Tp::HandleTypeContact && targetIds.isEmpty()) {
+        targetIds << roomId;
+    }
+
     Q_FOREACH(const Tp::TextChannelPtr &channel, mChannels) {
         int count = 0;
         AccountEntry *channelAccount = TelepathyHelper::instance()->accountForConnection(channel->connection());

=== modified file 'libtelephonyservice/chatentry.cpp'
--- libtelephonyservice/chatentry.cpp	2017-03-22 16:46:14 +0000
+++ libtelephonyservice/chatentry.cpp	2017-03-22 16:46:15 +0000
@@ -141,15 +141,18 @@
     updateParticipants(mParticipants,
                        groupMembersAdded,
                        groupMembersRemoved,
-                       account);
+                       account,
+                       Participant::ParticipantStateRegular);
     updateParticipants(mLocalPendingParticipants,
                        groupLocalPendingMembersAdded,
                        groupMembersRemoved + groupMembersAdded, // if contacts move to the main list, remove from the pending one
-                       account);
+                       account,
+                       Participant::ParticipantStateRemotePending);
     updateParticipants(mRemotePendingParticipants,
                        groupRemotePendingMembersAdded,
                        groupMembersRemoved + groupMembersAdded, // if contacts move to the main list, remove from the pending one
-                       account);
+                       account,
+                       Participant::ParticipantStateLocalPending);
 
     // generate the list of participant IDs again
     mParticipantIds.clear();
@@ -265,6 +268,11 @@
     return mAutoRequest;
 }
 
+QList<Participant*> ChatEntry::allParticipants() const
+{
+    return mParticipants + mLocalPendingParticipants + mRemotePendingParticipants;
+}
+
 bool ChatEntry::canUpdateConfiguration() const
 {
     return mCanUpdateConfiguration;
@@ -575,9 +583,6 @@
 
     // FIXME: check how to handle multiple channels in a better way,
     // for now, use the info from the last available channel
-    Q_FOREACH(Participant *participant, mParticipants) {
-        participant->deleteLater();
-    }
     clearParticipants();
 
     onGroupMembersChanged(channel->groupContacts(false),
@@ -669,26 +674,31 @@
 void ChatEntry::clearParticipants()
 {
     Q_FOREACH(Participant *participant, mParticipants) {
+        Q_EMIT participantRemoved(participant);
         participant->deleteLater();
     }
     Q_FOREACH(Participant *participant, mLocalPendingParticipants) {
+        Q_EMIT participantRemoved(participant);
         participant->deleteLater();
     }
     Q_FOREACH(Participant *participant, mRemotePendingParticipants) {
+        Q_EMIT participantRemoved(participant);
         participant->deleteLater();
     }
     mParticipants.clear();
     mLocalPendingParticipants.clear();
     mRemotePendingParticipants.clear();
+    mRolesMap.clear();
     mSelfContactRoles = 0;
 }
 
-void ChatEntry::updateParticipants(QList<Participant *> &list, const Tp::Contacts &added, const Tp::Contacts &removed, AccountEntry *account)
+void ChatEntry::updateParticipants(QList<Participant *> &list, const Tp::Contacts &added, const Tp::Contacts &removed, AccountEntry *account, Participant::ParticipantState pending)
 {
     // first look for removed members
     Q_FOREACH(Tp::ContactPtr contact, removed) {
         Q_FOREACH(Participant *participant, list) {
             if (account->compareIds(contact->id(), participant->identifier())) {
+                Q_EMIT participantRemoved(participant);
                 participant->deleteLater();
                 list.removeOne(participant);
                 break;
@@ -703,7 +713,9 @@
     // FIXME: check for duplicates?
     Q_FOREACH(Tp::ContactPtr contact, added) {
         uint handle = contact->handle().at(0);
-        list << new Participant(contact->id(), mRolesMap[handle], handle, this);
+        Participant* participant = new Participant(contact->id(), mRolesMap[handle], handle, QString(), pending, this);
+        Q_EMIT participantAdded(participant);
+        list << participant;
     }
 }
 
@@ -794,6 +806,7 @@
         rolesInterface->disconnect(this);
         rolesInterface = 0;
     }
+    clearParticipants();
     Q_EMIT activeChanged();
     Q_EMIT groupFlagsChanged();
     Q_EMIT selfContactRolesChanged();

=== modified file 'libtelephonyservice/chatentry.h'
--- libtelephonyservice/chatentry.h	2017-03-22 16:46:14 +0000
+++ libtelephonyservice/chatentry.h	2017-03-22 16:46:15 +0000
@@ -25,8 +25,10 @@
 
 #include <QObject>
 #include <QQmlParserStatus>
+#include <QQmlListProperty>
 #include <TelepathyQt/TextChannel>
 #include "rolesinterface.h"
+#include "participant.h"
 
 class AccountEntry;
 class Participant;
@@ -146,6 +148,8 @@
     void classBegin();
     void componentComplete();
 
+    QList<Participant*> allParticipants() const;
+
 public Q_SLOTS:
     // FIXME: void or return something?
     void sendMessage(const QString &accountId, const QString &message, const QVariant &attachments = QVariant(), const QVariantMap &properties = QVariantMap());
@@ -165,7 +169,7 @@
     QVariantMap generateProperties() const;
 
     void clearParticipants();
-    void updateParticipants(QList<Participant*> &list, const Tp::Contacts &added, const Tp::Contacts &removed, AccountEntry *account);
+    void updateParticipants(QList<Participant*> &list, const Tp::Contacts &added, const Tp::Contacts &removed, AccountEntry *account, Participant::ParticipantState = Participant::ParticipantStateRegular);
 
 private Q_SLOTS:
     void onTextChannelAvailable(const Tp::TextChannelPtr &channel);
@@ -207,6 +211,9 @@
     void chatReady();
     void startChatFailed();
 
+    void participantAdded(Participant *participant);
+    void participantRemoved(Participant *participant);
+
 private:
     QList<Tp::TextChannelPtr> mChannels;
     QStringList mParticipantIds;

=== modified file 'libtelephonyservice/participant.cpp'
--- libtelephonyservice/participant.cpp	2016-09-26 20:38:38 +0000
+++ libtelephonyservice/participant.cpp	2017-03-22 16:46:15 +0000
@@ -22,8 +22,8 @@
 
 #include "participant.h"
 
-Participant::Participant(const QString &identifier, uint roles, uint handle, QObject *parent)
-: ContactWatcher(parent), mRoles(roles), mHandle(handle)
+Participant::Participant(const QString &identifier, uint roles, uint handle, const QString &avatar, uint state, QObject *parent)
+: ContactWatcher(parent), mRoles(roles), mHandle(handle), mAvatar(avatar), mState(state)
 {
     classBegin();
     setIdentifier(identifier);
@@ -61,3 +61,14 @@
 {
     return mHandle;
 }
+
+uint Participant::state() const
+{
+    return mState;
+}
+
+QString Participant::avatar() const
+{
+    return mAvatar;
+}
+

=== modified file 'libtelephonyservice/participant.h'
--- libtelephonyservice/participant.h	2016-09-26 20:38:38 +0000
+++ libtelephonyservice/participant.h	2017-03-22 16:46:15 +0000
@@ -29,8 +29,14 @@
 {
     Q_OBJECT
     Q_PROPERTY(uint roles READ roles NOTIFY rolesChanged)
+    Q_ENUMS(ParticipantState)
 public:
-    explicit Participant(const QString &identifier, uint roles, uint handle, QObject *parent = 0);
+    enum ParticipantState {
+        ParticipantStateRegular = 0,
+        ParticipantStateRemotePending = 1,
+        ParticipantStateLocalPending = 2,
+    };
+    explicit Participant(const QString &identifier, uint roles, uint handle, const QString &avatar = QString(), uint state = 0, QObject *parent = 0);
     explicit Participant(QObject *parent = 0);
     explicit Participant(const Participant &other);
     ~Participant();
@@ -38,6 +44,8 @@
     void setRoles(uint roles);
     uint roles() const;
     uint handle() const;
+    QString avatar() const;
+    uint state() const;
 
 Q_SIGNAL
     void rolesChanged();
@@ -45,6 +53,8 @@
 private:
     uint mRoles;
     uint mHandle;
+    QString mAvatar;
+    uint mState;
 };
 
 #endif // PARTICIPANT_H