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 int processedMsgs = insertMessagesGracefully(msglist);
90 int remainingMsgs = msglist.count() - processedMsgs;
91 if(remainingMsgs > 0) {
92 if(msglist.first().msgId() < msglist.last().msgId()) {
93 // in Order - we have just successfully processed "processedMsg" messages from the end of the list
94 _messageBuffer << msglist.mid(0, remainingMsgs);
96 _messageBuffer << msglist.mid(processedMsgs);
98 qSort(_messageBuffer);
99 QCoreApplication::postEvent(this, new ProcessBufferEvent());
103 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
104 Q_ASSERT(!msglist.isEmpty()); // the msglist can be assumed to be non empty
105 int start = indexForId(msglist.first().msgId());
106 int end = start + msglist.count() - 1;
107 MessageModelItem *dayChangeItem = 0;
108 bool relocatedMsg = false;
110 // check if the preceeding msg is a daychange message and if so if
111 // we have to drop or relocate it at the end of this chunk
112 int prevIdx = start - 1;
113 if(_messageList.at(prevIdx)->msgType() == Message::DayChange
114 && _messageList.at(prevIdx)->timeStamp() > msglist.at(0).timestamp()) {
115 beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
116 MessageModelItem *oldItem = _messageList.takeAt(prevIdx);
117 if(msglist.last().timestamp() < oldItem->timeStamp()) {
118 // we have to reinsert it (with changed msgId -> thus we need to recreate it)
119 Message dayChangeMsg = Message::ChangeOfDay(oldItem->timeStamp());
120 dayChangeMsg.setMsgId(msglist.last().msgId());
121 dayChangeItem = createMessageModelItem(dayChangeMsg);
131 if(!dayChangeItem && start < _messageList.count()) {
132 // check if we need to insert a daychange message at the end of the this group
134 // if this assert triggers then indexForId() would have found a spot right before a DayChangeMsg
135 // this should never happen as daychange messages share the msgId with the preceeding message
136 Q_ASSERT(_messageList[start]->msgType() != Message::DayChange);
137 QDateTime nextTs = _messageList[start]->timeStamp();
138 QDateTime prevTs = msglist.last().timestamp();
139 nextTs.setTimeSpec(Qt::UTC);
140 prevTs.setTimeSpec(Qt::UTC);
141 uint nextDay = nextTs.toTime_t() / 86400;
142 uint prevDay = prevTs.toTime_t() / 86400;
143 if(nextDay != prevDay) {
144 nextTs.setTime_t(nextDay * 86400);
145 nextTs.setTimeSpec(Qt::LocalTime);
146 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
147 dayChangeMsg.setMsgId(msglist.last().msgId());
148 dayChangeItem = createMessageModelItem(dayChangeMsg);
155 Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < msglist.first().msgId());
156 Q_ASSERT(start == _messageList.count() || _messageList[start]->msgId() > msglist.last().msgId());
157 beginInsertRows(QModelIndex(), start, end);
159 foreach(Message msg, msglist) {
160 _messageList.insert(pos, createMessageModelItem(msg));
164 _messageList.insert(pos, dayChangeItem);
165 pos++; // needed for the following assert
168 Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < _messageList[start]->msgId());
169 Q_ASSERT(end + 1 == _messageList.count() || _messageList[end]->msgId() < _messageList[end + 1]->msgId());
170 Q_ASSERT(pos - 1 == end);
173 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
174 /* short description:
175 * 1) first we check where the message with the highest msgId from msglist would be inserted
176 * 2) check that position for dupe
177 * 3) determine the messageId of the preceeding msg
178 * 4) insert as many msgs from msglist with with msgId larger then the just determined id
179 * those messages are automatically less then the msg of the position we just determined in 1)
181 bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
182 // depending on the order we have to traverse from the front to the back or vice versa
184 QList<Message> grouplist;
187 int processedMsgs = 1; // we know the list isn't empty, so we at least process one message
189 bool fastForward = false;
190 QList<Message>::const_iterator iter;
192 iter = msglist.constEnd();
193 iter--; // this op is safe as we've allready passed an empty check
195 iter = msglist.constBegin();
198 idx = indexForId((*iter).msgId());
199 if(idx >= 0 && !_messageList.isEmpty())
200 dupeId = _messageList[idx]->msgId();
202 // we always compare to the previous entry...
203 // if there isn't, we can fastforward to the top
205 id = _messageList[idx - 1]->msgId();
209 if((*iter).msgId() != dupeId)
216 while(iter != msglist.constBegin()) {
219 if(!fastForward && (*iter).msgId() < id)
223 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
224 idx = indexForId((*iter).msgId());
225 if(idx >= 0 && !_messageList.isEmpty())
226 dupeId = _messageList[idx]->msgId();
228 if((*iter).msgId() != dupeId) {
229 if(!grouplist.isEmpty()) {
230 QDateTime nextTs = grouplist.value(0).timestamp();
231 QDateTime prevTs = (*iter).timestamp();
232 nextTs.setTimeSpec(Qt::UTC);
233 prevTs.setTimeSpec(Qt::UTC);
234 uint nextDay = nextTs.toTime_t() / 86400;
235 uint prevDay = prevTs.toTime_t() / 86400;
236 if(nextDay != prevDay) {
237 nextTs.setTime_t(nextDay * 86400);
238 nextTs.setTimeSpec(Qt::LocalTime);
239 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
240 dayChangeMsg.setMsgId((*iter).msgId());
241 grouplist.prepend(dayChangeMsg);
244 dupeId = (*iter).msgId();
245 grouplist.prepend(*iter);
249 while(iter != msglist.constEnd()) {
250 if(!fastForward && (*iter).msgId() < id)
254 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
255 idx = indexForId((*iter).msgId());
256 if(idx >= 0 && !_messageList.isEmpty())
257 dupeId = _messageList[idx]->msgId();
259 if((*iter).msgId() != dupeId) {
260 if(!grouplist.isEmpty()) {
261 QDateTime nextTs = grouplist.value(0).timestamp();
262 QDateTime prevTs = (*iter).timestamp();
263 nextTs.setTimeSpec(Qt::UTC);
264 prevTs.setTimeSpec(Qt::UTC);
265 uint nextDay = nextTs.toTime_t() / 86400;
266 uint prevDay = prevTs.toTime_t() / 86400;
267 if(nextDay != prevDay) {
268 nextTs.setTime_t(nextDay * 86400);
269 nextTs.setTimeSpec(Qt::LocalTime);
270 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
271 dayChangeMsg.setMsgId((*iter).msgId());
272 grouplist.prepend(dayChangeMsg);
275 dupeId = (*iter).msgId();
276 grouplist.prepend(*iter);
282 if(!grouplist.isEmpty())
283 insertMessageGroup(grouplist);
284 return processedMsgs;
287 void MessageModel::customEvent(QEvent *event) {
288 if(event->type() != QEvent::User)
293 if(_messageBuffer.isEmpty())
296 int processedMsgs = insertMessagesGracefully(_messageBuffer);
297 int remainingMsgs = _messageBuffer.count() - processedMsgs;
299 QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
300 QList<Message>::iterator removeEnd = _messageBuffer.end();
301 _messageBuffer.erase(removeStart, removeEnd);
303 if(!_messageBuffer.isEmpty())
304 QCoreApplication::postEvent(this, new ProcessBufferEvent());
307 void MessageModel::clear() {
308 beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
309 qDeleteAll(_messageList);
310 _messageList.clear();
312 _messagesWaiting.clear();
315 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
316 int MessageModel::indexForId(MsgId id) {
317 if(_messageList.isEmpty() || id <= _messageList.value(0)->msgId())
319 if(id > _messageList.last()->msgId())
320 return _messageList.count();
323 int start = 0; int end = _messageList.count()-1;
327 int pivot = (end + start) / 2;
328 if(id <= _messageList.value(pivot)->msgId()) end = pivot;
333 void MessageModel::changeOfDay() {
334 _dayChangeTimer.setInterval(86400000);
335 if(!_messageList.isEmpty()) {
336 int idx = _messageList.count();
337 while(idx > 0 && _messageList[idx - 1]->timeStamp() > _nextDayChange) {
340 beginInsertRows(QModelIndex(), idx, idx);
341 Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
342 dayChangeMsg.setMsgId(_messageList[idx - 1]->msgId());
343 _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
346 _nextDayChange = _nextDayChange.addSecs(86400);
349 void MessageModel::requestBacklog(BufferId bufferId) {
350 if(_messagesWaiting.contains(bufferId))
353 BacklogSettings backlogSettings;
354 int requestCount = backlogSettings.dynamicBacklogAmount();
356 for(int i = 0; i < _messageList.count(); i++) {
357 if(_messageList.at(i)->bufferId() == bufferId) {
358 _messagesWaiting[bufferId] = requestCount;
359 Client::backlogManager()->emitMessagesRequested(tr("Requesting %1 messages from backlog for buffer %2:%3")
361 .arg(Client::networkModel()->networkName(bufferId))
362 .arg(Client::networkModel()->bufferName(bufferId)));
363 Client::backlogManager()->requestBacklog(bufferId, requestCount, _messageList.at(i)->msgId().toInt());
369 void MessageModel::messagesReceived(BufferId bufferId, int count) {
370 if(!_messagesWaiting.contains(bufferId))
373 _messagesWaiting[bufferId] -= count;
374 if(_messagesWaiting[bufferId] <= 0)
375 _messagesWaiting.remove(bufferId);
378 // ========================================
380 // ========================================
381 MessageModelItem::MessageModelItem(const Message &msg) :
382 _timestamp(msg.timestamp()),
384 _bufferId(msg.bufferInfo().bufferId()),
390 QVariant MessageModelItem::data(int column, int role) const {
391 if(column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
395 case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(_msgId);
396 case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(_bufferId);
397 case MessageModel::TypeRole: return _type;
398 case MessageModel::FlagsRole: return (int)_flags;
399 case MessageModel::TimestampRole: return _timestamp;
400 default: return QVariant();
406 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2){
407 return (*m1) < (*m2);
410 bool MessageModelItem::operator<(const MessageModelItem &other) const {
411 return _msgId < other._msgId;
414 bool MessageModelItem::operator==(const MessageModelItem &other) const {
415 return _msgId == other._msgId;
418 bool MessageModelItem::operator>(const MessageModelItem &other) const {
419 return _msgId > other._msgId;
422 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem) {
423 dbg.nospace() << qPrintable(QString("MessageModelItem(MsgId:")) << msgItem.msgId()
424 << qPrintable(QString(",")) << msgItem.timeStamp()
425 << qPrintable(QString(", Type:")) << msgItem.msgType()
426 << qPrintable(QString(", Flags:")) << msgItem.msgFlags() << qPrintable(QString(")"))
427 << msgItem.data(1, Qt::DisplayRole).toString() << ":" << msgItem.data(2, Qt::DisplayRole).toString();