ihaveserverhistory.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/

#pragma once

#include <QList>
#include <QtPlugin>
#include <util/sll/eitherfwd.h>
#include "imessage.h"
#include "ihistoryplugin.h"

class QModelIndex;
class QAbstractItemModel;

template<typename>
class QFuture;

namespace LC
{
namespace Azoth
{
    struct SrvHistMessage
    {
        IMessage::Direction Dir_;
        QByteArray ID_;
        QString Nick_;
        QString Body_;
        QDateTime TS_;

        QString RichBody_;
    };

    using SrvHistMessages_t = QList<SrvHistMessage>;

    enum ServerHistoryRole
    {
        LastMessageDate = Qt::UserRole + 1,
        CLEntry,
        ServerHistoryRoleMax
    };

    enum class ServerHistoryFeature
    {
        AccountSupportsHistory,
        Configurable,
        DatedFetching
    };

    struct DefaultSortParams
    {
        int Column_;
        int Role_;
        Qt::SortOrder Order_;
    };

    class IHaveServerHistory
    {
    public:
        virtual ~IHaveServerHistory () {}

        virtual bool HasFeature (ServerHistoryFeature) const = 0;

        virtual void OpenServerHistoryConfiguration () = 0;

        virtual QAbstractItemModel* GetServerContactsModel () const = 0;

        virtual void FetchServerHistory (const QModelIndex& contact,
                const QByteArray& startId, int count) = 0;

        virtual DefaultSortParams GetSortParams () const = 0;

        virtual Util::ContextTask<QList<History::SomeEntryWithMessages>> FetchServerHistory (const std::optional<QDateTime>& since) = 0;
    protected:
        virtual void serverHistoryFetched (const QModelIndex& contact,
                const QByteArray& startId, const SrvHistMessages_t& messages) = 0;
    };
}
}

Q_DECLARE_INTERFACE (LC::Azoth::IHaveServerHistory,
        "org.LeechCraft.Azoth.IHaveServerHistory/1.0")