src/client/backlogrequester.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2019 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #ifndef BACKLOGREQUESTER_H
  22 #define BACKLOGREQUESTER_H
  23
  24 #include <QList>
  25
  26 #include "client.h"
  27 #include "message.h"
  28 #include "networkmodel.h"
  29 #include "types.h"
  30
  31 class ClientBacklogManager;
  32
  33 class BacklogRequester
  34 {
  35 public:
  36     enum RequesterType
  37     {
  38         InvalidRequester = 0,
  39         PerBufferFixed,
  40         PerBufferUnread,
  41         GlobalUnread
  42     };
  43
  44     BacklogRequester(bool buffering, RequesterType requesterType, ClientBacklogManager* backlogManger);
  45     virtual ~BacklogRequester() = default;
  46
  47     inline bool isBuffering() { return _isBuffering; }
  48     inline RequesterType type() { return _requesterType; }
  49     inline const QList<Message>& bufferedMessages() { return _bufferedMessages; }
  50
  51     inline int buffersWaiting() const { return _buffersWaiting.count(); }
  52     inline int totalBuffers() const { return _totalBuffers; }
  53
  54     bool buffer(BufferId bufferId, const MessageList& messages);  //! returns false if it was the last missing backlogpart
  55
  56     virtual void requestBacklog(const BufferIdList& bufferIds) = 0;
  57     virtual inline void requestInitialBacklog() { requestBacklog(allBufferIds()); }
  58
  59     virtual void flushBuffer();
  60
  61 protected:
  62     BufferIdList allBufferIds() const;
  63     inline void setWaitingBuffers(const QList<BufferId>& buffers) { setWaitingBuffers(buffers.toSet()); }
  64     void setWaitingBuffers(const QSet<BufferId>& buffers);
  65     void addWaitingBuffer(BufferId buffer);
  66
  67     ClientBacklogManager* backlogManager;
  68
  69 private:
  70     bool _isBuffering;
  71     RequesterType _requesterType;
  72     MessageList _bufferedMessages;
  73     int _totalBuffers;
  74     QSet<BufferId> _buffersWaiting;
  75 };
  76
  77 // ========================================
  78 //  FIXED BACKLOG REQUESTER
  79 // ========================================
  80 class FixedBacklogRequester : public BacklogRequester
  81 {
  82 public:
  83     FixedBacklogRequester(ClientBacklogManager* backlogManager);
  84     void requestBacklog(const BufferIdList& bufferIds) override;
  85
  86 private:
  87     int _backlogCount;
  88 };
  89
  90 // ========================================
  91 //  GLOBAL UNREAD BACKLOG REQUESTER
  92 // ========================================
  93 class GlobalUnreadBacklogRequester : public BacklogRequester
  94 {
  95 public:
  96     GlobalUnreadBacklogRequester(ClientBacklogManager* backlogManager);
  97     void requestInitialBacklog() override;
  98     void requestBacklog(const BufferIdList&) override {}
  99
 100 private:
 101     int _limit;
 102     int _additional;
 103 };
 104
 105 // ========================================
 106 //  PER BUFFER UNREAD BACKLOG REQUESTER
 107 // ========================================
 108 class PerBufferUnreadBacklogRequester : public BacklogRequester
 109 {
 110 public:
 111     PerBufferUnreadBacklogRequester(ClientBacklogManager* backlogManager);
 112     void requestBacklog(const BufferIdList& bufferIds) override;
 113
 114 private:
 115     int _limit;
 116     int _additional;
 117 };
 118
 119 #endif  // BACKLOGREQUESTER_H