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