src/client/clientbacklogmanager.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 "clientbacklogmanager.h"
  22
  23 #include "abstractmessageprocessor.h"
  24 #include "backlogsettings.h"
  25 #include "backlogrequester.h"
  26 #include "client.h"
  27
  28 #include <ctime>
  29
  30 #include <QDebug>
  31
  32 INIT_SYNCABLE_OBJECT(ClientBacklogManager)
  33 ClientBacklogManager::ClientBacklogManager(QObject *parent)
  34   : BacklogManager(parent),
  35   _requester(0),
  36   _initBacklogRequested(false)
  37 {
  38 }
  39
  40 QVariantList ClientBacklogManager::requestBacklog(BufferId bufferId, MsgId first, MsgId last, int limit, int additional) {
  41   _buffersRequested << bufferId;
  42   return BacklogManager::requestBacklog(bufferId, first, last, limit, additional);
  43 }
  44
  45 void ClientBacklogManager::receiveBacklog(BufferId bufferId, MsgId first, MsgId last, int limit, int additional, QVariantList msgs) {
  46   Q_UNUSED(first) Q_UNUSED(last) Q_UNUSED(limit) Q_UNUSED(additional)
  47
  48   emit messagesReceived(bufferId, msgs.count());
  49
  50   MessageList msglist;
  51   foreach(QVariant v, msgs) {
  52     Message msg = v.value<Message>();
  53     msg.setFlags(msg.flags() | Message::Backlog);
  54     msglist << msg;
  55   }
  56
  57   if(isBuffering()) {
  58     bool lastPart = !_requester->buffer(bufferId, msglist);
  59     updateProgress(_requester->totalBuffers() - _requester->buffersWaiting(), _requester->totalBuffers());
  60     if(lastPart) {
  61       dispatchMessages(_requester->bufferedMessages(), true);
  62       _requester->flushBuffer();
  63     }
  64   } else {
  65     dispatchMessages(msglist);
  66   }
  67 }
  68
  69 void ClientBacklogManager::receiveBacklogAll(MsgId first, MsgId last, int limit, int additional, QVariantList msgs) {
  70   Q_UNUSED(first) Q_UNUSED(last) Q_UNUSED(limit) Q_UNUSED(additional)
  71
  72   MessageList msglist;
  73   foreach(QVariant v, msgs) {
  74     Message msg = v.value<Message>();
  75     msg.setFlags(msg.flags() | Message::Backlog);
  76     msglist << msg;
  77   }
  78
  79   dispatchMessages(msglist);
  80 }
  81
  82 void ClientBacklogManager::requestInitialBacklog() {
  83   if(_initBacklogRequested) {
  84     Q_ASSERT(_requester);
  85     qWarning() << "ClientBacklogManager::requestInitialBacklog() called twice in the same session! (Backlog has already been requested)";
  86     return;
  87   }
  88
  89   BacklogSettings settings;
  90   switch(settings.requesterType()) {
  91   case BacklogRequester::GlobalUnread:
  92     _requester = new GlobalUnreadBacklogRequester(this);
  93     break;
  94   case BacklogRequester::PerBufferUnread:
  95     _requester = new PerBufferUnreadBacklogRequester(this);
  96     break;
  97   case BacklogRequester::PerBufferFixed:
  98   default:
  99     _requester = new FixedBacklogRequester(this);
 100   };
 101
 102   _requester->requestInitialBacklog();
 103   _initBacklogRequested = true;
 104   if(_requester->isBuffering()) {
 105     updateProgress(0, _requester->totalBuffers());
 106   }
 107 }
 108
 109 BufferIdList ClientBacklogManager::filterNewBufferIds(const BufferIdList &bufferIds) {
 110   BufferIdList newBuffers;
 111   QSet<BufferId> availableBuffers = Client::networkModel()->allBufferIds().toSet();
 112   foreach(BufferId bufferId, bufferIds) {
 113     if(_buffersRequested.contains(bufferId) || !availableBuffers.contains(bufferId))
 114       continue;
 115     newBuffers << bufferId;
 116   }
 117   return newBuffers;
 118 }
 119
 120 void ClientBacklogManager::checkForBacklog(const QList<BufferId> &bufferIds) {
 121   // we ingore all backlogrequests until we had our initial request
 122   if(!_initBacklogRequested) {
 123     return;
 124   }
 125
 126   if(!_requester) {
 127     // during client start up this message is to be expected in some situations.
 128     qDebug() << "ClientBacklogManager::checkForBacklog(): no active backlog requester.";
 129     return;
 130   }
 131   switch(_requester->type()) {
 132   case BacklogRequester::GlobalUnread:
 133     break;
 134   case BacklogRequester::PerBufferUnread:
 135   case BacklogRequester::PerBufferFixed:
 136   default:
 137     {
 138       BufferIdList buffers = filterNewBufferIds(bufferIds);
 139       if(!buffers.isEmpty())
 140         _requester->requestBacklog(buffers);
 141     }
 142   };
 143 }
 144
 145 bool ClientBacklogManager::isBuffering() {
 146   return _requester && _requester->isBuffering();
 147 }
 148
 149 void ClientBacklogManager::dispatchMessages(const MessageList &messages, bool sort) {
 150   if(messages.isEmpty())
 151     return;
 152
 153   MessageList msgs = messages;
 154
 155   clock_t start_t = clock();
 156   if(sort)
 157     qSort(msgs);
 158   Client::messageProcessor()->process(msgs);
 159   clock_t end_t = clock();
 160
 161   emit messagesProcessed(tr("Processed %1 messages in %2 seconds.").arg(messages.count()).arg((float)(end_t - start_t) / CLOCKS_PER_SEC));
 162 }
 163
 164 void ClientBacklogManager::reset() {
 165   delete _requester;
 166   _requester = 0;
 167   _initBacklogRequested = false;
 168   _buffersRequested.clear();
 169 }