src/client/backlogrequester.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #include "backlogrequester.h"
  22
  23 #include <QObject>
  24
  25 #include "backlogsettings.h"
  26 #include "bufferviewoverlay.h"
  27 #include "clientbacklogmanager.h"
  28
  29 BacklogRequester::BacklogRequester(bool buffering, RequesterType requesterType, ClientBacklogManager *backlogManager)
  30   : backlogManager(backlogManager),
  31     _isBuffering(buffering),
  32     _requesterType(requesterType),
  33     _totalBuffers(0)
  34 {
  35   Q_ASSERT(backlogManager);
  36 }
  37
  38 void BacklogRequester::setWaitingBuffers(const QSet<BufferId> &buffers) {
  39   _buffersWaiting = buffers;
  40   _totalBuffers = _buffersWaiting.count();
  41 }
  42
  43 void BacklogRequester::addWaitingBuffer(BufferId buffer) {
  44   _buffersWaiting << buffer;
  45   _totalBuffers++;
  46 }
  47
  48 bool BacklogRequester::buffer(BufferId bufferId, const MessageList &messages) {
  49   _bufferedMessages << messages;
  50   _buffersWaiting.remove(bufferId);
  51   return !_buffersWaiting.isEmpty();
  52 }
  53
  54 BufferIdList BacklogRequester::allBufferIds() const {
  55   QSet<BufferId> bufferIds = Client::bufferViewOverlay()->bufferIds();
  56   bufferIds += Client::bufferViewOverlay()->tempRemovedBufferIds();
  57   return bufferIds.toList();
  58 }
  59
  60 void BacklogRequester::flushBuffer() {
  61   if(!_buffersWaiting.isEmpty()) {
  62     qWarning() << Q_FUNC_INFO << "was called before all backlog was received:"
  63                << _buffersWaiting.count() << "buffers are waiting.";
  64   }
  65   _bufferedMessages.clear();
  66   _totalBuffers = 0;
  67   _buffersWaiting.clear();
  68 }
  69
  70 // ========================================
  71 //  FIXED BACKLOG REQUESTER
  72 // ========================================
  73 FixedBacklogRequester::FixedBacklogRequester(ClientBacklogManager *backlogManager)
  74   : BacklogRequester(true, BacklogRequester::PerBufferFixed, backlogManager)
  75 {
  76   BacklogSettings backlogSettings;
  77   _backlogCount = backlogSettings.fixedBacklogAmount();
  78 }
  79
  80 void FixedBacklogRequester::requestBacklog(const BufferIdList &bufferIds) {
  81   setWaitingBuffers(bufferIds);
  82   backlogManager->emitMessagesRequested(QObject::tr("Requesting a total of up to %1 backlog messages for %2 buffers").arg(_backlogCount * bufferIds.count()).arg(bufferIds.count()));
  83   foreach(BufferId bufferId, bufferIds) {
  84     backlogManager->requestBacklog(bufferId, -1, -1, _backlogCount);
  85   }
  86 }
  87
  88 // ========================================
  89 //  GLOBAL UNREAD BACKLOG REQUESTER
  90 // ========================================
  91 GlobalUnreadBacklogRequester::GlobalUnreadBacklogRequester(ClientBacklogManager *backlogManager)
  92   : BacklogRequester(false, BacklogRequester::GlobalUnread, backlogManager)
  93 {
  94   BacklogSettings backlogSettings;
  95   _limit = backlogSettings.globalUnreadBacklogLimit();
  96   _additional = backlogSettings.globalUnreadBacklogAdditional();
  97 }
  98
  99 void GlobalUnreadBacklogRequester::requestInitialBacklog() {
 100   MsgId oldestUnreadMessage;
 101   foreach(BufferId bufferId, allBufferIds()) {
 102     MsgId msgId = Client::networkModel()->lastSeenMsgId(bufferId);
 103     if(!oldestUnreadMessage.isValid() || oldestUnreadMessage > msgId)
 104       oldestUnreadMessage = msgId;
 105   }
 106   backlogManager->emitMessagesRequested(QObject::tr("Requesting up to %1 of all unread backlog messages (plus additional %2)").arg(_limit).arg(_additional));
 107   backlogManager->requestBacklogAll(oldestUnreadMessage, -1, _limit, _additional);
 108 }
 109
 110 // ========================================
 111 //  PER BUFFER UNREAD BACKLOG REQUESTER
 112 // ========================================
 113 PerBufferUnreadBacklogRequester::PerBufferUnreadBacklogRequester(ClientBacklogManager *backlogManager)
 114   : BacklogRequester(true, BacklogRequester::PerBufferUnread, backlogManager)
 115 {
 116   BacklogSettings backlogSettings;
 117   _limit = backlogSettings.perBufferUnreadBacklogLimit();
 118   _additional = backlogSettings.perBufferUnreadBacklogAdditional();
 119 }
 120
 121 void PerBufferUnreadBacklogRequester::requestBacklog(const BufferIdList &bufferIds) {
 122   setWaitingBuffers(bufferIds);
 123   backlogManager->emitMessagesRequested(QObject::tr("Requesting a total of up to %1 unread backlog messages for %2 buffers").arg((_limit + _additional) * bufferIds.count()).arg(bufferIds.count()));
 124   foreach(BufferId bufferId, bufferIds) {
 125     backlogManager->requestBacklog(bufferId, Client::networkModel()->lastSeenMsgId(bufferId), -1, _limit, _additional);
 126   }
 127 }