src/client/clientbacklogmanager.cpp

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