1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
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 >= messageCount() || column < 0)
54 if(role == ColumnTypeRole)
57 return messageItemAt(row)->data(index.column(), role);
58 // return _messageList[row]->data(index.column(), role);
61 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
62 int row = index.row();
63 if(row < 0 || row >= messageCount())
66 if(messageItemAt(row)->setData(index.column(), value, role)) {
67 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 < messageCount()) { // check for duplicate
77 if(messageItemAt(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 Message dayChangeMsg;
115 // MessageModelItem *dayChangeItem = 0;
116 bool relocatedMsg = false;
118 // check if the preceeding msg is a daychange message and if so if
119 // we have to drop or relocate it at the end of this chunk
120 int prevIdx = start - 1;
121 if(messageItemAt(prevIdx)->msgType() == Message::DayChange
122 && messageItemAt(prevIdx)->timestamp() > msglist.at(0).timestamp()) {
123 beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
124 // MessageModelItem *oldItem = _messageList.takeAt(prevIdx);
125 // if(msglist.last().timestamp() < oldItem->timestamp()) {
126 // // we have to reinsert it (with changed msgId -> thus we need to recreate it)
127 // Message dayChangeMsg = Message::ChangeOfDay(oldItem->timestamp());
128 // dayChangeMsg.setMsgId(msglist.last().msgId());
129 // dayChangeItem = createMessageModelItem(dayChangeMsg);
134 dayChangeMsg = takeMessageAt(prevIdx);
135 if(msglist.last().timestamp() < dayChangeMsg.timestamp()) {
136 // we have to reinsert it with a changed msgId
137 dayChangeMsg.setMsgId(msglist.last().msgId());
146 if(!dayChangeMsg.isValid() && start < messageCount()) {
147 // if(!dayChangeItem && start < _messageList.count()) {
148 // check if we need to insert a daychange message at the end of the this group
150 // if this assert triggers then indexForId() would have found a spot right before a DayChangeMsg
151 // this should never happen as daychange messages share the msgId with the preceeding message
152 Q_ASSERT(messageItemAt(start)->msgType() != Message::DayChange);
153 QDateTime nextTs = messageItemAt(start)->timestamp();
154 QDateTime prevTs = msglist.last().timestamp();
155 nextTs.setTimeSpec(Qt::UTC);
156 prevTs.setTimeSpec(Qt::UTC);
157 uint nextDay = nextTs.toTime_t() / 86400;
158 uint prevDay = prevTs.toTime_t() / 86400;
159 if(nextDay != prevDay) {
160 nextTs.setTime_t(nextDay * 86400);
161 nextTs.setTimeSpec(Qt::LocalTime);
162 dayChangeMsg = Message::ChangeOfDay(nextTs);
163 dayChangeMsg.setMsgId(msglist.last().msgId());
167 if(dayChangeMsg.isValid())
170 Q_ASSERT(start == 0 || messageItemAt(start - 1)->msgId() < msglist.first().msgId());
171 Q_ASSERT(start == messageCount() || messageItemAt(start)->msgId() > msglist.last().msgId());
172 beginInsertRows(QModelIndex(), start, end);
174 // foreach(Message msg, msglist) {
175 // _messageList.insert(pos, createMessageModelItem(msg));
178 // if(dayChangeItem) {
179 // _messageList.insert(pos, dayChangeItem);
180 // pos++; // needed for the following assert
182 insertMessages__(start, msglist);
183 if(dayChangeMsg.isValid())
184 insertMessage__(start + msglist.count(), dayChangeMsg);
187 // Q_ASSERT(start == end || _messageList.at(start)->msgId() != _messageList.at(end)->msgId() || _messageList.at(end)->msgType() == Message::DayChange);
188 Q_ASSERT(start == 0 || messageItemAt(start - 1)->msgId() < messageItemAt(start)->msgId());
189 Q_ASSERT(end + 1 == messageCount() || messageItemAt(end)->msgId() < messageItemAt(end + 1)->msgId());
190 // Q_ASSERT(pos - 1 == end);
193 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
194 /* short description:
195 * 1) first we check where the message with the highest msgId from msglist would be inserted
196 * 2) check that position for dupe
197 * 3) determine the messageId of the preceeding msg
198 * 4) insert as many msgs from msglist with with msgId larger then the just determined id
199 * those messages are automatically less then the msg of the position we just determined in 1)
201 bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
202 // depending on the order we have to traverse from the front to the back or vice versa
204 QList<Message> grouplist;
207 int processedMsgs = 1; // we know the list isn't empty, so we at least process one message
209 bool fastForward = false;
210 QList<Message>::const_iterator iter;
212 iter = msglist.constEnd();
213 iter--; // this op is safe as we've allready passed an empty check
215 iter = msglist.constBegin();
218 idx = indexForId((*iter).msgId());
219 if(idx < messageCount())
220 dupeId = messageItemAt(idx)->msgId();
222 // we always compare to the previous entry...
223 // if there isn't, we can fastforward to the top
225 minId = messageItemAt(idx - 1)->msgId();
229 if((*iter).msgId() != dupeId) {
231 dupeId = (*iter).msgId();
238 while(iter != msglist.constBegin()) {
241 if(!fastForward && (*iter).msgId() < minId)
245 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
246 idx = indexForId((*iter).msgId());
247 if(idx >= 0 && !messagesIsEmpty())
248 dupeId = messageItemAt(idx)->msgId();
250 if((*iter).msgId() != dupeId) {
251 if(!grouplist.isEmpty()) {
252 QDateTime nextTs = grouplist.value(0).timestamp();
253 QDateTime prevTs = (*iter).timestamp();
254 nextTs.setTimeSpec(Qt::UTC);
255 prevTs.setTimeSpec(Qt::UTC);
256 uint nextDay = nextTs.toTime_t() / 86400;
257 uint prevDay = prevTs.toTime_t() / 86400;
258 if(nextDay != prevDay) {
259 nextTs.setTime_t(nextDay * 86400);
260 nextTs.setTimeSpec(Qt::LocalTime);
261 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
262 dayChangeMsg.setMsgId((*iter).msgId());
263 grouplist.prepend(dayChangeMsg);
266 dupeId = (*iter).msgId();
267 grouplist.prepend(*iter);
271 while(iter != msglist.constEnd()) {
272 if(!fastForward && (*iter).msgId() < minId)
276 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
277 idx = indexForId((*iter).msgId());
278 if(idx >= 0 && !messagesIsEmpty())
279 dupeId = messageItemAt(idx)->msgId();
281 if((*iter).msgId() != dupeId) {
282 if(!grouplist.isEmpty()) {
283 QDateTime nextTs = grouplist.value(0).timestamp();
284 QDateTime prevTs = (*iter).timestamp();
285 nextTs.setTimeSpec(Qt::UTC);
286 prevTs.setTimeSpec(Qt::UTC);
287 uint nextDay = nextTs.toTime_t() / 86400;
288 uint prevDay = prevTs.toTime_t() / 86400;
289 if(nextDay != prevDay) {
290 nextTs.setTime_t(nextDay * 86400);
291 nextTs.setTimeSpec(Qt::LocalTime);
292 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
293 dayChangeMsg.setMsgId((*iter).msgId());
294 grouplist.prepend(dayChangeMsg);
297 dupeId = (*iter).msgId();
298 grouplist.prepend(*iter);
304 if(!grouplist.isEmpty())
305 insertMessageGroup(grouplist);
306 return processedMsgs;
309 void MessageModel::customEvent(QEvent *event) {
310 if(event->type() != QEvent::User)
315 if(_messageBuffer.isEmpty())
318 int processedMsgs = insertMessagesGracefully(_messageBuffer);
319 int remainingMsgs = _messageBuffer.count() - processedMsgs;
321 QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
322 QList<Message>::iterator removeEnd = _messageBuffer.end();
323 _messageBuffer.erase(removeStart, removeEnd);
324 if(!_messageBuffer.isEmpty())
325 QCoreApplication::postEvent(this, new ProcessBufferEvent());
328 void MessageModel::clear() {
329 beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
332 _messagesWaiting.clear();
335 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
336 int MessageModel::indexForId(MsgId id) {
337 if(messagesIsEmpty() || id <= messageItemAt(0)->msgId())
340 if(id > lastMessageItem()->msgId())
341 return messageCount();
344 int start = 0; int end = messageCount() - 1;
348 int pivot = (end + start) / 2;
349 if(id <= messageItemAt(pivot)->msgId()) end = pivot;
354 void MessageModel::changeOfDay() {
355 _dayChangeTimer.setInterval(86400000);
356 if(!messagesIsEmpty()) {
357 int idx = messageCount();
358 while(idx > 0 && messageItemAt(idx - 1)->timestamp() > _nextDayChange) {
361 beginInsertRows(QModelIndex(), idx, idx);
362 Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
363 dayChangeMsg.setMsgId(messageItemAt(idx - 1)->msgId());
364 insertMessage__(idx, dayChangeMsg);
367 _nextDayChange = _nextDayChange.addSecs(86400);
370 void MessageModel::requestBacklog(BufferId bufferId) {
371 if(_messagesWaiting.contains(bufferId))
374 BacklogSettings backlogSettings;
375 int requestCount = backlogSettings.dynamicBacklogAmount();
377 for(int i = 0; i < messageCount(); i++) {
378 if(messageItemAt(i)->bufferId() == bufferId) {
379 _messagesWaiting[bufferId] = requestCount;
380 Client::backlogManager()->emitMessagesRequested(tr("Requesting %1 messages from backlog for buffer %2:%3")
382 .arg(Client::networkModel()->networkName(bufferId))
383 .arg(Client::networkModel()->bufferName(bufferId)));
384 Client::backlogManager()->requestBacklog(bufferId, -1, messageItemAt(i)->msgId(), requestCount);
390 void MessageModel::messagesReceived(BufferId bufferId, int count) {
391 if(!_messagesWaiting.contains(bufferId))
394 _messagesWaiting[bufferId] -= count;
395 if(_messagesWaiting[bufferId] <= 0)
396 _messagesWaiting.remove(bufferId);
399 void MessageModel::buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2) {
400 for(int i = 0; i < messageCount(); i++) {
401 if(messageItemAt(i)->bufferId() == bufferId2) {
402 messageItemAt(i)->setBufferId(bufferId1);
403 QModelIndex idx = index(i, 0);
404 emit dataChanged(idx, idx);
409 // ========================================
411 // ========================================
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 msgType();
420 case MessageModel::FlagsRole: return (int)msgFlags();
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();