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 {
  35 }
  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
  45 void ClientBacklogManager::receiveBacklog(BufferId bufferId, MsgId first, MsgId last, int limit, int additional, QVariantList msgs)
  46 {
  47     Q_UNUSED(first) Q_UNUSED(last) Q_UNUSED(limit) 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
  72 void ClientBacklogManager::receiveBacklogAll(MsgId first, MsgId last, int limit, int additional, QVariantList msgs)
  73 {
  74     Q_UNUSED(first) Q_UNUSED(last) Q_UNUSED(limit) Q_UNUSED(additional)
  75
  76     MessageList msglist;
  77     foreach(QVariant v, msgs) {
  78         Message msg = v.value<Message>();
  79         msg.setFlags(msg.flags() | Message::Backlog);
  80         msglist << msg;
  81     }
  82
  83     dispatchMessages(msglist);
  84 }
  85
  86
  87 void ClientBacklogManager::requestInitialBacklog()
  88 {
  89     if (_initBacklogRequested) {
  90         Q_ASSERT(_requester);
  91         qWarning() << "ClientBacklogManager::requestInitialBacklog() called twice in the same session! (Backlog has already been requested)";
  92         return;
  93     }
  94
  95     BacklogSettings settings;
  96     switch (settings.requesterType()) {
  97     case BacklogRequester::GlobalUnread:
  98         _requester = new GlobalUnreadBacklogRequester(this);
  99         break;
 100     case BacklogRequester::PerBufferUnread:
 101         _requester = new PerBufferUnreadBacklogRequester(this);
 102         break;
 103     case BacklogRequester::PerBufferFixed:
 104     default:
 105         _requester = new FixedBacklogRequester(this);
 106     };
 107
 108     _requester->requestInitialBacklog();
 109     _initBacklogRequested = true;
 110     if (_requester->isBuffering()) {
 111         updateProgress(0, _requester->totalBuffers());
 112     }
 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
 129 void ClientBacklogManager::checkForBacklog(const QList<BufferId> &bufferIds)
 130 {
 131     // we ingore all backlogrequests until we had our initial request
 132     if (!_initBacklogRequested) {
 133         return;
 134     }
 135
 136     if (!_requester) {
 137         // during client start up this message is to be expected in some situations.
 138         qDebug() << "ClientBacklogManager::checkForBacklog(): no active backlog requester.";
 139         return;
 140     }
 141     switch (_requester->type()) {
 142     case BacklogRequester::GlobalUnread:
 143         break;
 144     case BacklogRequester::PerBufferUnread:
 145     case BacklogRequester::PerBufferFixed:
 146     default:
 147     {
 148         BufferIdList buffers = filterNewBufferIds(bufferIds);
 149         if (!buffers.isEmpty())
 150             _requester->requestBacklog(buffers);
 151     }
 152     };
 153 }
 154
 155
 156 bool ClientBacklogManager::isBuffering()
 157 {
 158     return _requester && _requester->isBuffering();
 159 }
 160
 161
 162 void ClientBacklogManager::dispatchMessages(const MessageList &messages, bool sort)
 163 {
 164     if (messages.isEmpty())
 165         return;
 166
 167     MessageList msgs = messages;
 168
 169     clock_t start_t = clock();
 170     if (sort)
 171         qSort(msgs);
 172     Client::messageProcessor()->process(msgs);
 173     clock_t end_t = clock();
 174
 175     emit messagesProcessed(tr("Processed %1 messages in %2 seconds.").arg(messages.count()).arg((float)(end_t - start_t) / CLOCKS_PER_SEC));
 176 }
 177
 178
 179 void ClientBacklogManager::reset()
 180 {
 181     delete _requester;
 182     _requester = nullptr;
 183     _initBacklogRequested = false;
 184     _buffersRequested.clear();
 185 }