src/client/clientbacklogmanager.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2019 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 <algorithm>
  24 #include <ctime>
  25
  26 #include <QDebug>
  27
  28 #include "abstractmessageprocessor.h"
  29 #include "backlogrequester.h"
  30 #include "backlogsettings.h"
  31 #include "client.h"
  32 #include "util.h"
  33
  34 ClientBacklogManager::ClientBacklogManager(QObject* parent)
  35     : BacklogManager(parent)
  36 {}
  37
  38 QVariantList ClientBacklogManager::requestBacklog(BufferId bufferId, MsgId first, MsgId last, int limit, int additional)
  39 {
  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 {
  46     Q_UNUSED(first)
  47     Q_UNUSED(last)
  48     Q_UNUSED(limit)
  49     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 void ClientBacklogManager::receiveBacklogAll(MsgId first, MsgId last, int limit, int additional, QVariantList msgs)
  74 {
  75     Q_UNUSED(first)
  76     Q_UNUSED(last)
  77     Q_UNUSED(limit)
  78     Q_UNUSED(additional)
  79
  80     MessageList msglist;
  81     foreach (QVariant v, msgs) {
  82         Message msg = v.value<Message>();
  83         msg.setFlags(msg.flags() | Message::Backlog);
  84         msglist << msg;
  85     }
  86
  87     dispatchMessages(msglist);
  88 }
  89
  90 void ClientBacklogManager::requestInitialBacklog()
  91 {
  92     if (_initBacklogRequested) {
  93         Q_ASSERT(_requester);
  94         qWarning() << "ClientBacklogManager::requestInitialBacklog() called twice in the same session! (Backlog has already been requested)";
  95         return;
  96     }
  97
  98     BacklogSettings settings;
  99     switch (settings.requesterType()) {
 100     case BacklogRequester::GlobalUnread:
 101         _requester = new GlobalUnreadBacklogRequester(this);
 102         break;
 103     case BacklogRequester::PerBufferUnread:
 104         _requester = new PerBufferUnreadBacklogRequester(this);
 105         break;
 106     case BacklogRequester::PerBufferFixed:
 107     default:
 108         _requester = new FixedBacklogRequester(this);
 109     };
 110
 111     _requester->requestInitialBacklog();
 112     _initBacklogRequested = true;
 113     if (_requester->isBuffering()) {
 114         updateProgress(0, _requester->totalBuffers());
 115     }
 116 }
 117
 118 BufferIdList ClientBacklogManager::filterNewBufferIds(const BufferIdList& bufferIds)
 119 {
 120     BufferIdList newBuffers;
 121     QSet<BufferId> availableBuffers = toQSet(Client::networkModel()->allBufferIds());
 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 void ClientBacklogManager::checkForBacklog(const QList<BufferId>& bufferIds)
 131 {
 132     // we ingore all backlogrequests until we had our initial request
 133     if (!_initBacklogRequested) {
 134         return;
 135     }
 136
 137     if (!_requester) {
 138         // during client start up this message is to be expected in some situations.
 139         qDebug() << "ClientBacklogManager::checkForBacklog(): no active backlog requester.";
 140         return;
 141     }
 142     switch (_requester->type()) {
 143     case BacklogRequester::GlobalUnread:
 144         break;
 145     case BacklogRequester::PerBufferUnread:
 146     case BacklogRequester::PerBufferFixed:
 147     default: {
 148         BufferIdList buffers = filterNewBufferIds(bufferIds);
 149         if (!buffers.isEmpty())
 150             _requester->requestBacklog(buffers);
 151     }
 152     };
 153 }
 154
 155 bool ClientBacklogManager::isBuffering()
 156 {
 157     return _requester && _requester->isBuffering();
 158 }
 159
 160 void ClientBacklogManager::dispatchMessages(const MessageList& messages, bool sort)
 161 {
 162     if (messages.isEmpty())
 163         return;
 164
 165     MessageList msgs = messages;
 166
 167     clock_t start_t = clock();
 168     if (sort)
 169         std::sort(msgs.begin(), msgs.end());
 170     Client::messageProcessor()->process(msgs);
 171     clock_t end_t = clock();
 172
 173     emit messagesProcessed(tr("Processed %1 messages in %2 seconds.").arg(messages.count()).arg((float)(end_t - start_t) / CLOCKS_PER_SEC));
 174 }
 175
 176 void ClientBacklogManager::reset()
 177 {
 178     delete _requester;
 179     _requester = nullptr;
 180     _initBacklogRequested = false;
 181     _buffersRequested.clear();
 182 }