Happy New Year!
[quassel.git] / src / client / backlogrequester.cpp
index a08227d..4a1e286 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-09 by the Quassel Project                          *
+ *   Copyright (C) 2005-2015 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,7 +15,7 @@
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #include "backlogrequester.h"
 #include <QObject>
 
 #include "backlogsettings.h"
+#include "bufferviewoverlay.h"
 #include "clientbacklogmanager.h"
 
-BacklogRequester::BacklogRequester(bool buffering, ClientBacklogManager *backlogManager)
-  : backlogManager(backlogManager),
+BacklogRequester::BacklogRequester(bool buffering, RequesterType requesterType, ClientBacklogManager *backlogManager)
+    : backlogManager(backlogManager),
     _isBuffering(buffering),
+    _requesterType(requesterType),
     _totalBuffers(0)
 {
-  Q_ASSERT(backlogManager);
+    Q_ASSERT(backlogManager);
 }
 
-void BacklogRequester::setWaitingBuffers(const QSet<BufferId> &buffers) {
-  _buffersWaiting = buffers;
-  _totalBuffers = _buffersWaiting.count();
+
+void BacklogRequester::setWaitingBuffers(const QSet<BufferId> &buffers)
+{
+    _buffersWaiting = buffers;
+    _totalBuffers = _buffersWaiting.count();
+}
+
+
+void BacklogRequester::addWaitingBuffer(BufferId buffer)
+{
+    _buffersWaiting << buffer;
+    _totalBuffers++;
 }
 
-void BacklogRequester::addWaitingBuffer(BufferId buffer) {
-  _buffersWaiting << buffer;
-  _totalBuffers++;
+
+bool BacklogRequester::buffer(BufferId bufferId, const MessageList &messages)
+{
+    _bufferedMessages << messages;
+    _buffersWaiting.remove(bufferId);
+    return !_buffersWaiting.isEmpty();
 }
 
-bool BacklogRequester::buffer(BufferId bufferId, const MessageList &messages) {
-  _bufferedMessages << messages;
-  _buffersWaiting.remove(bufferId);
-  return !_buffersWaiting.isEmpty();
+
+BufferIdList BacklogRequester::allBufferIds() const
+{
+    QSet<BufferId> bufferIds = Client::bufferViewOverlay()->bufferIds();
+    bufferIds += Client::bufferViewOverlay()->tempRemovedBufferIds();
+    return bufferIds.toList();
 }
 
+
+void BacklogRequester::flushBuffer()
+{
+    if (!_buffersWaiting.isEmpty()) {
+        qWarning() << Q_FUNC_INFO << "was called before all backlog was received:"
+                   << _buffersWaiting.count() << "buffers are waiting.";
+    }
+    _bufferedMessages.clear();
+    _totalBuffers = 0;
+    _buffersWaiting.clear();
+}
+
+
 // ========================================
 //  FIXED BACKLOG REQUESTER
 // ========================================
 FixedBacklogRequester::FixedBacklogRequester(ClientBacklogManager *backlogManager)
-  : BacklogRequester(true, backlogManager)
+    : BacklogRequester(true, BacklogRequester::PerBufferFixed, backlogManager)
 {
-  BacklogSettings backlogSettings;
-  _backlogCount = backlogSettings.fixedBacklogAmount();
+    BacklogSettings backlogSettings;
+    _backlogCount = backlogSettings.fixedBacklogAmount();
 }
 
-void FixedBacklogRequester::requestBacklog() {
-  QList<BufferId> allBuffers = allBufferIds();
-  setWaitingBuffers(allBuffers);
-  backlogManager->emitMessagesRequested(QObject::tr("Requesting a total of up to %1 backlog messages for %2 buffers").arg(_backlogCount * allBuffers.count()).arg(allBuffers.count()));
-  foreach(BufferId bufferId, allBuffers) {
-    backlogManager->requestBacklog(bufferId, -1, -1, _backlogCount);
-  }
+
+void FixedBacklogRequester::requestBacklog(const BufferIdList &bufferIds)
+{
+    setWaitingBuffers(bufferIds);
+    backlogManager->emitMessagesRequested(QObject::tr("Requesting a total of up to %1 backlog messages for %2 buffers").arg(_backlogCount * bufferIds.count()).arg(bufferIds.count()));
+    foreach(BufferId bufferId, bufferIds) {
+        backlogManager->requestBacklog(bufferId, -1, -1, _backlogCount);
+    }
 }
 
+
 // ========================================
 //  GLOBAL UNREAD BACKLOG REQUESTER
 // ========================================
 GlobalUnreadBacklogRequester::GlobalUnreadBacklogRequester(ClientBacklogManager *backlogManager)
-  : BacklogRequester(false, backlogManager)
+    : BacklogRequester(false, BacklogRequester::GlobalUnread, backlogManager)
 {
-  BacklogSettings backlogSettings;
-  _limit = backlogSettings.globalUnreadBacklogLimit();
-  _additional = backlogSettings.globalUnreadBacklogAdditional();
+    BacklogSettings backlogSettings;
+    _limit = backlogSettings.globalUnreadBacklogLimit();
+    _additional = backlogSettings.globalUnreadBacklogAdditional();
 }
 
-void GlobalUnreadBacklogRequester::requestBacklog() {
-  MsgId oldestUnreadMessage;
-  foreach(BufferId bufferId, allBufferIds()) {
-    MsgId msgId = Client::networkModel()->lastSeenMsgId(bufferId);
-    if(!oldestUnreadMessage.isValid() || oldestUnreadMessage > msgId)
-      oldestUnreadMessage = msgId;
-  }
-  backlogManager->emitMessagesRequested(QObject::tr("Requesting up to %1 of all unread backlog messages (plus additional %2)").arg(_limit).arg(_additional));
-  backlogManager->requestBacklogAll(oldestUnreadMessage, -1, _limit, _additional);
+
+void GlobalUnreadBacklogRequester::requestInitialBacklog()
+{
+    MsgId oldestUnreadMessage;
+    foreach(BufferId bufferId, allBufferIds()) {
+        MsgId msgId = Client::networkModel()->lastSeenMsgId(bufferId);
+        if (!oldestUnreadMessage.isValid() || oldestUnreadMessage > msgId)
+            oldestUnreadMessage = msgId;
+    }
+    backlogManager->emitMessagesRequested(QObject::tr("Requesting up to %1 of all unread backlog messages (plus additional %2)").arg(_limit).arg(_additional));
+    backlogManager->requestBacklogAll(oldestUnreadMessage, -1, _limit, _additional);
 }
 
+
 // ========================================
 //  PER BUFFER UNREAD BACKLOG REQUESTER
 // ========================================
 PerBufferUnreadBacklogRequester::PerBufferUnreadBacklogRequester(ClientBacklogManager *backlogManager)
-  : BacklogRequester(true, backlogManager)
+    : BacklogRequester(true, BacklogRequester::PerBufferUnread, backlogManager)
 {
-  BacklogSettings backlogSettings;
-  _limit = backlogSettings.perBufferUnreadBacklogLimit();
-  _additional = backlogSettings.perBufferUnreadBacklogAdditional();
+    BacklogSettings backlogSettings;
+    _limit = backlogSettings.perBufferUnreadBacklogLimit();
+    _additional = backlogSettings.perBufferUnreadBacklogAdditional();
 }
 
-void PerBufferUnreadBacklogRequester::requestBacklog() {
-  QList<BufferId> allBuffers = allBufferIds();
-  setWaitingBuffers(allBuffers);
-  backlogManager->emitMessagesRequested(QObject::tr("Requesting a total of up to %1 unread backlog messages for %2 buffers").arg((_limit + _additional) * allBuffers.count()).arg(allBuffers.count()));
-  foreach(BufferId bufferId, allBuffers) {
-    backlogManager->requestBacklog(bufferId, Client::networkModel()->lastSeenMsgId(bufferId), -1, _limit, _additional);
-  }
+
+void PerBufferUnreadBacklogRequester::requestBacklog(const BufferIdList &bufferIds)
+{
+    setWaitingBuffers(bufferIds);
+    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()));
+    foreach(BufferId bufferId, bufferIds) {
+        backlogManager->requestBacklog(bufferId, Client::networkModel()->lastSeenMsgId(bufferId), -1, _limit, _additional);
+    }
 }