RetroShare/retroshare-gui/src/gui/common/FriendListModel.h

/*******************************************************************************
 * retroshare-gui/src/gui/msgs/RsFriendListModel.h                             *
 *                                                                             *
 * Copyright 2019 by Cyril Soler <csoler@users.sourceforge.net>                *
 *                                                                             *
 * This program is free software: you can redistribute it and/or modify        *
 * it under the terms of the GNU Affero General Public License as              *
 * published by the Free Software Foundation, either version 3 of the          *
 * License, or (at your option) any later version.                             *
 *                                                                             *
 * 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 Affero General Public License for more details.                         *
 *                                                                             *
 * You should have received a copy of the GNU Affero General Public License    *
 * along with this program. If not, see <https://www.gnu.org/licenses/>.       *
 *                                                                             *
 *******************************************************************************/

#pragma once

#include <QModelIndex>
#include <QColor>

#include "retroshare/rsmsgs.h"
#include "retroshare/rspeers.h"

// This class holds the actual hierarchy of posts, represented by identifiers
// It is responsible for auto-updating when necessary and holds a mutex to allow the Model to
// safely access the data.

// The model contains a post in place 0 that is the parent of all posts.

typedef uint32_t ForumModelIndex;

// This class is the item model used by Qt to display the information

class RsFriendListModel : public QAbstractItemModel
{
	Q_OBJECT

public:
	explicit RsFriendListModel(QObject *parent = NULL);
	~RsFriendListModel(){}

    class RsNodeDetails: public RsPeerDetails {};// in the near future, there will be a specific class for Profile/Node details in replacement of RsPeerDetails
    class RsProfileDetails: public RsPeerDetails {};

	struct HierarchicalGroupInformation
	{
		RsGroupInfo group;
		std::vector<uint32_t> child_indices;	// index in the array of hierarchical profiles
        uint32_t parent_row;
	};
	struct HierarchicalProfileInformation
	{
        uint32_t profile_index;					// index in the array of profiles. We cannot store the profile here because of duplication
		uint32_t parent_group_index;			// index in the array of hierarchical groups
		std::vector<uint32_t> child_indices;	// index in the array of hierarchical nodes
        uint32_t parent_row;
	};
	struct HierarchicalNodeInformation
	{
        uint32_t node_index;					// index in the array of nodes
		uint32_t parent_profile_index;			// index in the array of hierarchical profiles
        uint32_t parent_row;
	};

	enum Columns {
		COLUMN_THREAD_NAME         = 0x00,
		COLUMN_THREAD_LAST_CONTACT = 0x01,
		COLUMN_THREAD_IP           = 0x02,
		COLUMN_THREAD_ID           = 0x03,
		COLUMN_THREAD_NB_COLUMNS   = 0x04
	};

	enum Roles{ SortRole           = Qt::UserRole+1,
              	StatusRole         = Qt::UserRole+2,
              	UnreadRole         = Qt::UserRole+3,
              	FilterRole         = Qt::UserRole+4,
              	MsgIdRole          = Qt::UserRole+5,
              	MsgFlagsRole       = Qt::UserRole+6,
              	SrcIdRole          = Qt::UserRole+7,
              };

    enum FilterType{ FILTER_TYPE_NONE = 0x00,
        			 FILTER_TYPE_ID   = 0x01,
                     FILTER_TYPE_NAME = 0x02
                   };

    enum EntryType{ ENTRY_TYPE_UNKNOWN = 0x00,
                    ENTRY_TYPE_GROUP   = 0x01,
                    ENTRY_TYPE_PROFILE = 0x02,
                    ENTRY_TYPE_NODE    = 0x03
                  };

    struct EntryIndex
    {
        EntryIndex(EntryType t,uint32_t i) : type(t),ind(i) {}
        EntryIndex() : type(ENTRY_TYPE_UNKNOWN),ind(0) {}

        EntryType type;
        uint32_t ind;
    };

	QModelIndex root() const{ return createIndex(0,0,(void*)NULL) ;}
	QModelIndex getIndexOfGroup(const RsNodeGroupId& mid) const;

    static const QString FilterString ;

    // This method will asynchroneously update the data

	void setDisplayGroups(bool b);

    EntryType getType(const QModelIndex&) const;
    bool getGroupData  (const QModelIndex&,RsGroupInfo     &) const;
    bool getProfileData(const QModelIndex&,RsProfileDetails&) const;
    bool getNodeData   (const QModelIndex&,RsNodeDetails   &) const;

    void setFilter(FilterType filter_type, const QStringList& strings) ;

    // Overloaded methods from QAbstractItemModel

    int rowCount(const QModelIndex& parent = QModelIndex()) const override;
    int columnCount(const QModelIndex &parent = QModelIndex()) const override;
    bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;

    QModelIndex index(int row, int column, const QModelIndex & parent = QModelIndex()) const override;
    QModelIndex parent(const QModelIndex& child) const override;
    Qt::ItemFlags flags(const QModelIndex& index) const  override;

    QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;

	void clear() ;

private:
    QVariant sizeHintRole  (int col) const;

	QVariant displayRole   (const EntryIndex &e, int col) const;

	QVariant decorationRole(const EntryIndex& fmpe, int col) const;
	QVariant toolTipRole   (const EntryIndex &fmpe, int col) const;
	QVariant userRole      (const EntryIndex& fmpe, int col) const;
	QVariant statusRole    (const EntryIndex& fmpe, int col) const;
	QVariant sortRole      (const EntryIndex& fmpe, int col) const;
	QVariant fontRole      (const EntryIndex& fmpe, int col) const;
	QVariant textColorRole (const EntryIndex& fmpe, int col) const;

	QVariant filterRole    (const EntryIndex& e, int col) const;

    /*!
     * \brief debug_dump
     * 			Dumps the hierarchy of posts in the terminal, to allow checking whether the internal representation is correct.
     */
    void debug_dump() const;

public slots:
	void updateInternalData();

signals:
    void dataLoaded();	// emitted after the messages have been set. Can be used to updated the UI.
    void friendListChanged();	// emitted after the messages have been set. Can be used to updated the UI.
    void dataAboutToLoad();

private:
	bool passesFilter(const EntryIndex &e, int column) const;

	void preMods() ;
	void postMods() ;

    void *getParentRef(void *ref,int& row) const;
    void *getChildRef(void *ref,int row) const;
    int  getChildrenCount(void *ref) const;

    static bool convertIndexToInternalId(const EntryIndex& e,quintptr& ref);
	static bool convertInternalIdToIndex(quintptr ref, EntryIndex& e);

	uint32_t updateFilterStatus(ForumModelIndex i,int column,const QStringList& strings);

    QStringList mFilterStrings;
    FilterType  mFilterType;

    bool mDisplayGroups ;

    // A given profile may belong to multiple groups, so the hierarchy is stored using the 3 variables below.

    std::vector<HierarchicalGroupInformation>   mGroups;
    std::vector<HierarchicalProfileInformation> mProfiles;
    std::vector<HierarchicalNodeInformation>    mLocations;

    std::vector<RsProfileDetails> mProfileDetails;
    std::vector<RsNodeDetails>    mNodeDetails;
};