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