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"
27 class ProcessBufferEvent : public QEvent {
29 inline ProcessBufferEvent() : QEvent(QEvent::User) {}
32 MessageModel::MessageModel(QObject *parent)
33 : QAbstractItemModel(parent)
35 QDateTime now = QDateTime::currentDateTime();
36 now.setTimeSpec(Qt::UTC);
37 _nextDayChange.setTimeSpec(Qt::UTC);
38 _nextDayChange.setTime_t(((now.toTime_t() / 86400) + 1) * 86400);
39 _nextDayChange.setTimeSpec(Qt::LocalTime);
40 _dayChangeTimer.setInterval(QDateTime::currentDateTime().secsTo(_nextDayChange) * 1000);
41 _dayChangeTimer.start();
42 connect(&_dayChangeTimer, SIGNAL(timeout()), this, SLOT(changeOfDay()));
45 QVariant MessageModel::data(const QModelIndex &index, int role) const {
46 int row = index.row(); int column = index.column();
47 if(row < 0 || row >= _messageList.count() || column < 0)
50 if(role == ColumnTypeRole)
53 return _messageList[row]->data(index.column(), role);
56 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
57 int row = index.row();
58 if(row < 0 || row >= _messageList.count())
61 if(_messageList[row]->setData(index.column(), value, role)) {
62 emit dataChanged(index, index);
71 bool MessageModel::insertMessage(const Message &msg, bool fakeMsg) {
72 MsgId id = msg.msgId();
73 int idx = indexForId(id);
74 if(!fakeMsg && idx < _messageList.count()) { // check for duplicate
75 if(_messageList[idx]->msgId() == id)
79 insertMessageGroup(QList<Message>() << msg);
83 void MessageModel::insertMessages(const QList<Message> &msglist) {
87 int processedMsgs = insertMessagesGracefully(msglist);
88 int remainingMsgs = msglist.count() - processedMsgs;
89 if(remainingMsgs > 0) {
90 if(msglist.first().msgId() < msglist.last().msgId()) {
91 // in Order - we have just successfully processed "processedMsg" messages from the end of the list
92 _messageBuffer << msglist.mid(0, remainingMsgs);
94 _messageBuffer << msglist.mid(processedMsgs);
96 qSort(_messageBuffer);
97 QCoreApplication::postEvent(this, new ProcessBufferEvent());
101 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
102 Q_ASSERT(!msglist.isEmpty()); // the msglist can be assumed to be non empty
103 int start = indexForId(msglist.first().msgId());
104 int end = start + msglist.count() - 1;
105 MessageModelItem *dayChangeItem = 0;
106 bool relocatedMsg = false;
108 // check if the preceeding msg is a daychange message and if so if
109 // we have to drop or relocate it at the end of this chunk
110 int prevIdx = start - 1;
111 if(_messageList.at(prevIdx)->msgType() == Message::DayChange
112 && _messageList.at(prevIdx)->timeStamp() > msglist.at(0).timestamp()) {
113 beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
114 MessageModelItem *oldItem = _messageList.takeAt(prevIdx);
115 if(msglist.last().timestamp() < oldItem->timeStamp()) {
116 // we have to reinsert it (with changed msgId -> thus we need to recreate it)
117 Message dayChangeMsg = Message::ChangeOfDay(oldItem->timeStamp());
118 dayChangeMsg.setMsgId(msglist.last().msgId());
119 dayChangeItem = createMessageModelItem(dayChangeMsg);
129 if(!dayChangeItem && start < _messageList.count()) {
130 // check if we need to insert a daychange message at the end of the this group
132 // if this assert triggers then indexForId() would have found a spot right before a DayChangeMsg
133 // this should never happen as daychange messages share the msgId with the preceeding message
134 Q_ASSERT(_messageList[start]->msgType() != Message::DayChange);
135 QDateTime nextTs = _messageList[start]->timeStamp();
136 QDateTime prevTs = msglist.last().timestamp();
137 nextTs.setTimeSpec(Qt::UTC);
138 prevTs.setTimeSpec(Qt::UTC);
139 uint nextDay = nextTs.toTime_t() / 86400;
140 uint prevDay = prevTs.toTime_t() / 86400;
141 if(nextDay != prevDay) {
142 nextTs.setTime_t(nextDay * 86400);
143 nextTs.setTimeSpec(Qt::LocalTime);
144 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
145 dayChangeMsg.setMsgId(msglist.last().msgId());
146 dayChangeItem = createMessageModelItem(dayChangeMsg);
153 Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < msglist.first().msgId());
154 Q_ASSERT(start == _messageList.count() || _messageList[start]->msgId() > msglist.last().msgId());
155 beginInsertRows(QModelIndex(), start, end);
157 foreach(Message msg, msglist) {
158 _messageList.insert(pos, createMessageModelItem(msg));
162 _messageList.insert(pos, dayChangeItem);
163 pos++; // needed for the following assert
166 Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < _messageList[start]->msgId());
167 Q_ASSERT(end + 1 == _messageList.count() || _messageList[end]->msgId() < _messageList[end + 1]->msgId());
168 Q_ASSERT(pos - 1 == end);
171 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
172 /* short description:
173 * 1) first we check where the message with the highest msgId from msglist would be inserted
174 * 2) check that position for dupe
175 * 3) determine the messageId of the preceeding msg
176 * 4) insert as many msgs from msglist with with msgId larger then the just determined id
177 * those messages are automatically less then the msg of the position we just determined in 1)
179 bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
180 // depending on the order we have to traverse from the front to the back or vice versa
182 QList<Message> grouplist;
185 int processedMsgs = 1; // we know the list isn't empty, so we at least process one message
187 bool fastForward = false;
188 QList<Message>::const_iterator iter;
190 iter = msglist.constEnd();
191 iter--; // this op is safe as we've allready passed an empty check
193 iter = msglist.constBegin();
196 idx = indexForId((*iter).msgId());
197 if(idx >= 0 && !_messageList.isEmpty())
198 dupeId = _messageList[idx]->msgId();
200 // we always compare to the previous entry...
201 // if there isn't, we can fastforward to the top
203 id = _messageList[idx - 1]->msgId();
207 if((*iter).msgId() != dupeId)
214 while(iter != msglist.constBegin()) {
217 if(!fastForward && (*iter).msgId() < id)
221 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
222 idx = indexForId((*iter).msgId());
223 if(idx >= 0 && !_messageList.isEmpty())
224 dupeId = _messageList[idx]->msgId();
226 if((*iter).msgId() != dupeId) {
227 if(!grouplist.isEmpty()) {
228 QDateTime nextTs = grouplist.value(0).timestamp();
229 QDateTime prevTs = (*iter).timestamp();
230 nextTs.setTimeSpec(Qt::UTC);
231 prevTs.setTimeSpec(Qt::UTC);
232 uint nextDay = nextTs.toTime_t() / 86400;
233 uint prevDay = prevTs.toTime_t() / 86400;
234 if(nextDay != prevDay) {
235 nextTs.setTime_t(nextDay * 86400);
236 nextTs.setTimeSpec(Qt::LocalTime);
237 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
238 dayChangeMsg.setMsgId((*iter).msgId());
239 grouplist.prepend(dayChangeMsg);
242 dupeId = (*iter).msgId();
243 grouplist.prepend(*iter);
247 while(iter != msglist.constEnd()) {
248 if(!fastForward && (*iter).msgId() < id)
252 if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
253 idx = indexForId((*iter).msgId());
254 if(idx >= 0 && !_messageList.isEmpty())
255 dupeId = _messageList[idx]->msgId();
257 if((*iter).msgId() != dupeId) {
258 if(!grouplist.isEmpty()) {
259 QDateTime nextTs = grouplist.value(0).timestamp();
260 QDateTime prevTs = (*iter).timestamp();
261 nextTs.setTimeSpec(Qt::UTC);
262 prevTs.setTimeSpec(Qt::UTC);
263 uint nextDay = nextTs.toTime_t() / 86400;
264 uint prevDay = prevTs.toTime_t() / 86400;
265 if(nextDay != prevDay) {
266 nextTs.setTime_t(nextDay * 86400);
267 nextTs.setTimeSpec(Qt::LocalTime);
268 Message dayChangeMsg = Message::ChangeOfDay(nextTs);
269 dayChangeMsg.setMsgId((*iter).msgId());
270 grouplist.prepend(dayChangeMsg);
273 dupeId = (*iter).msgId();
274 grouplist.prepend(*iter);
280 if(!grouplist.isEmpty())
281 insertMessageGroup(grouplist);
282 return processedMsgs;
285 void MessageModel::customEvent(QEvent *event) {
286 if(event->type() != QEvent::User)
291 if(_messageBuffer.isEmpty())
294 int processedMsgs = insertMessagesGracefully(_messageBuffer);
295 int remainingMsgs = _messageBuffer.count() - processedMsgs;
297 QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
298 QList<Message>::iterator removeEnd = _messageBuffer.end();
299 _messageBuffer.erase(removeStart, removeEnd);
301 if(!_messageBuffer.isEmpty())
302 QCoreApplication::postEvent(this, new ProcessBufferEvent());
305 void MessageModel::clear() {
306 beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
307 qDeleteAll(_messageList);
308 _messageList.clear();
314 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
315 int MessageModel::indexForId(MsgId id) {
316 if(_messageList.isEmpty() || id <= _messageList.value(0)->msgId())
318 if(id > _messageList.last()->msgId())
319 return _messageList.count();
322 int start = 0; int end = _messageList.count()-1;
326 int pivot = (end + start) / 2;
327 if(id <= _messageList.value(pivot)->msgId()) end = pivot;
332 void MessageModel::changeOfDay() {
333 _dayChangeTimer.setInterval(86400000);
334 if(!_messageList.isEmpty()) {
335 int idx = _messageList.count();
336 while(idx > 0 && _messageList[idx - 1]->timeStamp() > _nextDayChange) {
339 beginInsertRows(QModelIndex(), idx, idx);
340 Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
341 dayChangeMsg.setMsgId(_messageList[idx - 1]->msgId());
342 _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
345 _nextDayChange = _nextDayChange.addSecs(86400);
348 /**********************************************************************************/
350 MessageModelItem::MessageModelItem(const Message &msg) :
351 _timestamp(msg.timestamp()),
353 _bufferId(msg.bufferInfo().bufferId()),
359 QVariant MessageModelItem::data(int column, int role) const {
360 if(column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
364 case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(_msgId);
365 case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(_bufferId);
366 case MessageModel::TypeRole: return _type;
367 case MessageModel::FlagsRole: return (int)_flags;
368 case MessageModel::TimestampRole: return _timestamp;
369 default: return QVariant();
375 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2){
376 return (*m1) < (*m2);
379 bool MessageModelItem::operator<(const MessageModelItem &other) const {
380 return _msgId < other._msgId;
383 bool MessageModelItem::operator==(const MessageModelItem &other) const {
384 return _msgId == other._msgId;
387 bool MessageModelItem::operator>(const MessageModelItem &other) const {
388 return _msgId > other._msgId;
391 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem) {
392 dbg.nospace() << qPrintable(QString("MessageModelItem(MsgId:")) << msgItem.msgId()
393 << qPrintable(QString(",")) << msgItem.timeStamp()
394 << qPrintable(QString(", Type:")) << msgItem.msgType()
395 << qPrintable(QString(", Flags:")) << msgItem.msgFlags() << qPrintable(QString(")"))
396 << msgItem.data(1, Qt::DisplayRole).toString() << ":" << msgItem.data(2, Qt::DisplayRole).toString();