1 /***************************************************************************
2 * Copyright (C) 2005-08 by the Quassel IRC Team *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #include "messagemodel.h"
25 #include "backlogsettings.h"
26 #include "clientbacklogmanager.h"
29 #include "networkmodel.h"
31 class ProcessBufferEvent : public QEvent {
33 inline ProcessBufferEvent() : QEvent(QEvent::User) {}
36 MessageModel::MessageModel(QObject *parent)
37 : QAbstractItemModel(parent)
39 QDateTime now = QDateTime::currentDateTime();
40 now.setTimeSpec(Qt::UTC);
41 _nextDayChange.setTimeSpec(Qt::UTC);
42 _nextDayChange.setTime_t(((now.toTime_t() / 86400) + 1) * 86400);
43 _nextDayChange.setTimeSpec(Qt::LocalTime);
44 _dayChangeTimer.setInterval(QDateTime::currentDateTime().secsTo(_nextDayChange) * 1000);
45 _dayChangeTimer.start();
46 connect(&_dayChangeTimer, SIGNAL(timeout()), this, SLOT(changeOfDay()));
49 QVariant MessageModel::data(const QModelIndex &index, int role) const {
50 int row = index.row(); int column = index.column();
51 if(row < 0 || row >= _messageList.count() || column < 0)
54 if(role == ColumnTypeRole)
57 return _messageList[row]->data(index.column(), role);
60 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
61 int row = index.row();
62 if(row < 0 || row >= _messageList.count())
65 if(_messageList[row]->setData(index.column(), value, role)) {
66 emit dataChanged(index, index);
73 bool MessageModel::insertMessage(const Message &msg, bool fakeMsg) {
74 MsgId id = msg.msgId();
75 int idx = indexForId(id);
76 if(!fakeMsg && idx < _messageList.count()) { // check for duplicate
77 if(_messageList[idx]->msgId() == id)
81 insertMessageGroup(QList<Message>() << msg);
85 void MessageModel::insertMessages(const QList<Message> &msglist) {
89 if(_messageBuffer.isEmpty()) {
90 int processedMsgs = insertMessagesGracefully(msglist);
91 int remainingMsgs = msglist.count() - processedMsgs;
92 if(remainingMsgs > 0) {
93 if(msglist.first().msgId() < msglist.last().msgId()) {
94 // in Order - we have just successfully processed "processedMsg" messages from the end of the list
95 _messageBuffer = msglist.mid(0, remainingMsgs);
97 _messageBuffer = msglist.mid(processedMsgs);
99 qSort(_messageBuffer);
100 QCoreApplication::postEvent(this, new ProcessBufferEvent());
103 _messageBuffer << msglist;
104 qSort(_messageBuffer);
108 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
109 Q_ASSERT(!msglist.isEmpty()); // the msglist can be assumed to be non empty
110 // int last = msglist.count() - 1;
111 // Q_ASSERT(0 == last || msglist.at(0).msgId() != msglist.at(last).msgId() || msglist.at(last).type() == Message::DayChange);
112 int start = indexForId(msglist.first().msgId());
113 int end = start + msglist.count() - 1;
114 MessageModelItem *dayChangeItem = 0;
115 bool relocatedMsg = false;
117 // check if the preceeding msg is a daychange message and if so if
118 // we have to drop or relocate it at the end of this chunk
119 int prevIdx = start - 1;
120 if(_messageList.at(prevIdx)->msgType() == Message::DayChange
121 && _messageList.at(prevIdx)->timeStamp() > msglist.at(0).timestamp()) {
122 beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
123 MessageModelItem *oldItem = _messageList.takeAt(prevIdx);
124 if(msglist.last().timestamp() < oldItem->timeStamp()) {
125 // we have to reinsert it (with changed msgId -> thus we need to recreate it)
126 Message dayChangeMsg = Message::ChangeOfDay(oldItem->timeStamp());
127 dayChangeMsg.setMsgId(msglist.last().msgId());
128 dayChangeItem = createMessageModelItem(dayChangeMsg);
138 if(!dayChangeItem && start < _messageList.count()) {
139 // check if we need to insert a daychange message at the end of the this group
141 // if this assert triggers then indexForId() would have found a spot right before a DayChangeMsg
142 // this should never happen as daychange messages share the msgId with the preceeding message
143 Q_ASSERT(_messageList[start]->msgType() != Message::DayChange);
144 QDateTime nextTs = _messageList[start]->timeStamp();
145 QDateTime prevTs = msglist.last().timestamp();
146 nextTs.setTimeSpec(Qt::UTC);
147 prevTs.setTimeSpec(Qt::UTC);
148 uint nextDay = nextTs.toTime_t() / 86400;
149 uint prevDay = prevTs.toTime_t() / 86400;
150 if(nextDay != prevDay) {
151 nextTs.setTime_t(nextDay * 86400);
152 nextTs.setTimeSpec(Qt::LocalTime);
153 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
154 dayChangeMsg.setMsgId(msglist.last().msgId());
155 dayChangeItem = createMessageModelItem(dayChangeMsg);
162 Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < msglist.first().msgId());
163 Q_ASSERT(start == _messageList.count() || _messageList[start]->msgId() > msglist.last().msgId());
164 beginInsertRows(QModelIndex(), start, end);
166 foreach(Message msg, msglist) {
167 _messageList.insert(pos, createMessageModelItem(msg));
171 _messageList.insert(pos, dayChangeItem);
172 pos++; // needed for the following assert
176 // Q_ASSERT(start == end || _messageList.at(start)->msgId() != _messageList.at(end)->msgId() || _messageList.at(end)->msgType() == Message::DayChange);
177 Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < _messageList[start]->msgId());
178 Q_ASSERT(end + 1 == _messageList.count() || _messageList[end]->msgId() < _messageList[end + 1]->msgId());
179 Q_ASSERT(pos - 1 == end);
182 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
183 /* short description:
184 * 1) first we check where the message with the highest msgId from msglist would be inserted
185 * 2) check that position for dupe
186 * 3) determine the messageId of the preceeding msg
187 * 4) insert as many msgs from msglist with with msgId larger then the just determined id
188 * those messages are automatically less then the msg of the position we just determined in 1)
190 bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
191 // depending on the order we have to traverse from the front to the back or vice versa
193 QList<Message> grouplist;
196 int processedMsgs = 1; // we know the list isn't empty, so we at least process one message
198 bool fastForward = false;
199 QList<Message>::const_iterator iter;
201 iter = msglist.constEnd();
202 iter--; // this op is safe as we've allready passed an empty check
204 iter = msglist.constBegin();
207 idx = indexForId((*iter).msgId());
208 if(idx < _messageList.count())
209 dupeId = _messageList[idx]->msgId();
211 // we always compare to the previous entry...
212 // if there isn't, we can fastforward to the top
214 minId = _messageList[idx - 1]->msgId();
218 if((*iter).msgId() != dupeId) {
220 dupeId = (*iter).msgId();
227 while(iter != msglist.constBegin()) {
230 if(!fastForward && (*iter).msgId() < minId)
234 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
235 idx = indexForId((*iter).msgId());
236 if(idx >= 0 && !_messageList.isEmpty())
237 dupeId = _messageList[idx]->msgId();
239 if((*iter).msgId() != dupeId) {
240 if(!grouplist.isEmpty()) {
241 QDateTime nextTs = grouplist.value(0).timestamp();
242 QDateTime prevTs = (*iter).timestamp();
243 nextTs.setTimeSpec(Qt::UTC);
244 prevTs.setTimeSpec(Qt::UTC);
245 uint nextDay = nextTs.toTime_t() / 86400;
246 uint prevDay = prevTs.toTime_t() / 86400;
247 if(nextDay != prevDay) {
248 nextTs.setTime_t(nextDay * 86400);
249 nextTs.setTimeSpec(Qt::LocalTime);
250 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
251 dayChangeMsg.setMsgId((*iter).msgId());
252 grouplist.prepend(dayChangeMsg);
255 dupeId = (*iter).msgId();
256 grouplist.prepend(*iter);
260 while(iter != msglist.constEnd()) {
261 if(!fastForward && (*iter).msgId() < minId)
265 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
266 idx = indexForId((*iter).msgId());
267 if(idx >= 0 && !_messageList.isEmpty())
268 dupeId = _messageList[idx]->msgId();
270 if((*iter).msgId() != dupeId) {
271 if(!grouplist.isEmpty()) {
272 QDateTime nextTs = grouplist.value(0).timestamp();
273 QDateTime prevTs = (*iter).timestamp();
274 nextTs.setTimeSpec(Qt::UTC);
275 prevTs.setTimeSpec(Qt::UTC);
276 uint nextDay = nextTs.toTime_t() / 86400;
277 uint prevDay = prevTs.toTime_t() / 86400;
278 if(nextDay != prevDay) {
279 nextTs.setTime_t(nextDay * 86400);
280 nextTs.setTimeSpec(Qt::LocalTime);
281 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
282 dayChangeMsg.setMsgId((*iter).msgId());
283 grouplist.prepend(dayChangeMsg);
286 dupeId = (*iter).msgId();
287 grouplist.prepend(*iter);
293 if(!grouplist.isEmpty())
294 insertMessageGroup(grouplist);
295 return processedMsgs;
298 void MessageModel::customEvent(QEvent *event) {
299 if(event->type() != QEvent::User)
304 if(_messageBuffer.isEmpty())
307 int processedMsgs = insertMessagesGracefully(_messageBuffer);
308 int remainingMsgs = _messageBuffer.count() - processedMsgs;
310 QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
311 QList<Message>::iterator removeEnd = _messageBuffer.end();
312 _messageBuffer.erase(removeStart, removeEnd);
313 if(!_messageBuffer.isEmpty())
314 QCoreApplication::postEvent(this, new ProcessBufferEvent());
317 void MessageModel::clear() {
318 beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
319 qDeleteAll(_messageList);
320 _messageList.clear();
322 _messagesWaiting.clear();
325 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
326 int MessageModel::indexForId(MsgId id) {
327 if(_messageList.isEmpty() || id <= _messageList.value(0)->msgId())
329 if(id > _messageList.last()->msgId())
330 return _messageList.count();
333 int start = 0; int end = _messageList.count()-1;
337 int pivot = (end + start) / 2;
338 if(id <= _messageList.value(pivot)->msgId()) end = pivot;
343 void MessageModel::changeOfDay() {
344 _dayChangeTimer.setInterval(86400000);
345 if(!_messageList.isEmpty()) {
346 int idx = _messageList.count();
347 while(idx > 0 && _messageList[idx - 1]->timeStamp() > _nextDayChange) {
350 beginInsertRows(QModelIndex(), idx, idx);
351 Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
352 dayChangeMsg.setMsgId(_messageList[idx - 1]->msgId());
353 _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
356 _nextDayChange = _nextDayChange.addSecs(86400);
359 void MessageModel::requestBacklog(BufferId bufferId) {
360 if(_messagesWaiting.contains(bufferId))
363 BacklogSettings backlogSettings;
364 int requestCount = backlogSettings.dynamicBacklogAmount();
366 for(int i = 0; i < _messageList.count(); i++) {
367 if(_messageList.at(i)->bufferId() == bufferId) {
368 _messagesWaiting[bufferId] = requestCount;
369 Client::backlogManager()->emitMessagesRequested(tr("Requesting %1 messages from backlog for buffer %2:%3")
371 .arg(Client::networkModel()->networkName(bufferId))
372 .arg(Client::networkModel()->bufferName(bufferId)));
373 Client::backlogManager()->requestBacklog(bufferId, -1, _messageList.at(i)->msgId(), requestCount);
379 void MessageModel::messagesReceived(BufferId bufferId, int count) {
380 if(!_messagesWaiting.contains(bufferId))
383 _messagesWaiting[bufferId] -= count;
384 if(_messagesWaiting[bufferId] <= 0)
385 _messagesWaiting.remove(bufferId);
388 void MessageModel::buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2) {
389 for(int i = 0; i < _messageList.count(); i++) {
390 if(_messageList[i]->bufferId() == bufferId2) {
391 _messageList[i]->setBufferId(bufferId1);
392 QModelIndex idx = index(i, 0);
393 emit dataChanged(idx, idx);
398 // ========================================
400 // ========================================
401 MessageModelItem::MessageModelItem(const Message &msg) :
402 _timestamp(msg.timestamp()),
404 _bufferId(msg.bufferInfo().bufferId()),
408 if(!msg.sender().contains('!'))
409 _flags |= Message::ServerMsg;
412 QVariant MessageModelItem::data(int column, int role) const {
413 if(column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
417 case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(_msgId);
418 case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(_bufferId);
419 case MessageModel::TypeRole: return _type;
420 case MessageModel::FlagsRole: return (int)_flags;
421 case MessageModel::TimestampRole: return _timestamp;
422 case MessageModel::RedirectedToRole: return qVariantFromValue<BufferId>(_redirectedTo);
423 default: return QVariant();
427 bool MessageModelItem::setData(int column, const QVariant &value, int role) {
431 case MessageModel::RedirectedToRole:
432 _redirectedTo = value.value<BufferId>();
440 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2){
441 return (*m1) < (*m2);
444 bool MessageModelItem::operator<(const MessageModelItem &other) const {
445 return _msgId < other._msgId;
448 bool MessageModelItem::operator==(const MessageModelItem &other) const {
449 return _msgId == other._msgId;
452 bool MessageModelItem::operator>(const MessageModelItem &other) const {
453 return _msgId > other._msgId;
456 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem) {
457 dbg.nospace() << qPrintable(QString("MessageModelItem(MsgId:")) << msgItem.msgId()
458 << qPrintable(QString(",")) << msgItem.timeStamp()
459 << qPrintable(QString(", Type:")) << msgItem.msgType()
460 << qPrintable(QString(", Flags:")) << msgItem.msgFlags() << qPrintable(QString(")"))
461 << msgItem.data(1, Qt::DisplayRole).toString() << ":" << msgItem.data(2, Qt::DisplayRole).toString();