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