183274e3b7989bc1d66a917df635733018e25ca9
[quassel.git] / src / client / messagemodel.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
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 "messagemodel.h"
22
23 #include "message.h"
24
25 #include <QEvent>
26
27 class ProcessBufferEvent : public QEvent {
28 public:
29   inline ProcessBufferEvent() : QEvent(QEvent::User) {}
30 };
31
32 MessageModel::MessageModel(QObject *parent)
33   : QAbstractItemModel(parent)
34 {
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()));
43 }
44
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)
48     return QVariant();
49
50   if(role == ColumnTypeRole)
51     return column;
52
53   return _messageList[row]->data(index.column(), role);
54 }
55
56 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
57   int row = index.row();
58   if(row < 0 || row >= _messageList.count())
59     return false;
60
61   if(_messageList[row]->setData(index.column(), value, role)) {
62     emit dataChanged(index, index);
63     return true;
64   }
65
66   return false;
67 }
68
69
70
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)
76       return false;
77   }
78
79   MessageModelItem *item = createMessageModelItem(msg);
80   beginInsertRows(QModelIndex(), idx, idx);
81   _messageList.insert(idx, item);
82   endInsertRows();
83   return true;
84 }
85
86 void MessageModel::insertMessages(const QList<Message> &msglist) {
87   if(msglist.isEmpty())
88     return;
89
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
95       _messageBuffer << msglist.mid(0, remainingMsgs);
96     } else {
97       _messageBuffer << msglist.mid(processedMsgs);
98     }
99     qSort(_messageBuffer);
100     QCoreApplication::postEvent(this, new ProcessBufferEvent());
101   }
102 }
103
104 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
105   int idx = indexForId(msglist.first().msgId());
106   if(idx > 0) {
107     int prevIdx = idx - 1;
108     if(_messageList[prevIdx]->msgType() == Message::DayChange
109        && _messageList[prevIdx]->timeStamp() > msglist.value(0).timestamp()) {
110       beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
111       MessageModelItem *oldItem = _messageList.takeAt(prevIdx);
112       delete oldItem;
113       endRemoveRows();
114       idx--;
115     }
116   }
117   int start = idx;
118   int end = idx + msglist.count() - 1;
119
120   Message dayChangeMsg;
121   bool needsDayChangeMsg = false;
122   if(idx < _messageList.count() && _messageList[idx]->msgType() != Message::DayChange) {
123     QDateTime nextTs = _messageList[idx]->timeStamp();
124     QDateTime prevTs = msglist.last().timestamp();
125     nextTs.setTimeSpec(Qt::UTC);
126     prevTs.setTimeSpec(Qt::UTC);
127     uint nextDay = nextTs.toTime_t() / 86400;
128     uint prevDay = prevTs.toTime_t() / 86400;
129     if(nextDay != prevDay) {
130       nextTs.setTime_t(nextDay * 86400);
131       nextTs.setTimeSpec(Qt::LocalTime);
132       dayChangeMsg = Message::ChangeOfDay(nextTs);
133       dayChangeMsg.setMsgId(msglist.last().msgId());
134       needsDayChangeMsg = true;
135       end++;
136     }
137   }
138   beginInsertRows(QModelIndex(), start, end);
139   foreach(Message msg, msglist) {
140     _messageList.insert(idx, createMessageModelItem(msg));
141     idx++;
142   }
143   if(needsDayChangeMsg) {
144     _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
145   }
146   endInsertRows();
147 }
148
149 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
150   bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
151   // depending on the order we have to traverse from the front to the back or vice versa
152
153   QList<Message> grouplist;
154   MsgId id;
155   MsgId dupeId;
156   int dupeCount = 0;
157   bool fastForward = false;
158   QList<Message>::const_iterator iter;
159   if(inOrder) {
160     iter = msglist.constEnd();
161     iter--; // this op is safe as we've allready passed an empty check
162   } else {
163     iter = msglist.constBegin();
164   }
165
166   int idx = indexForId((*iter).msgId());
167   if(idx >= 0 && !_messageList.isEmpty())
168     dupeId = _messageList[idx]->msgId();
169
170   // we always compare to the previous entry...
171   // if there isn't, we can fastforward to the top
172   if(idx - 1 >= 0)
173     id = _messageList[idx - 1]->msgId();
174   else
175     fastForward = true;
176
177   if((*iter).msgId() != dupeId)
178     grouplist << *iter;
179   else
180     dupeCount++;
181
182   if(!inOrder)
183     iter++;
184
185   if(inOrder) {
186     while(iter != msglist.constBegin()) {
187       iter--;
188
189       if(!fastForward && (*iter).msgId() < id)
190         break;
191
192       if((*iter).msgId() != dupeId) {
193         if(!grouplist.isEmpty()) {
194           QDateTime nextTs = grouplist.value(0).timestamp();
195           QDateTime prevTs = (*iter).timestamp();
196           nextTs.setTimeSpec(Qt::UTC);
197           prevTs.setTimeSpec(Qt::UTC);
198           uint nextDay = nextTs.toTime_t() / 86400;
199           uint prevDay = prevTs.toTime_t() / 86400;
200           if(nextDay != prevDay) {
201             nextTs.setTime_t(nextDay * 86400);
202             nextTs.setTimeSpec(Qt::LocalTime);
203             Message dayChangeMsg = Message::ChangeOfDay(nextTs);
204             dayChangeMsg.setMsgId((*iter).msgId());
205             grouplist.prepend(dayChangeMsg);
206             dupeCount--;
207           }
208         }
209         grouplist.prepend(*iter);
210       } else {
211         dupeCount++;
212       }
213     }
214   } else {
215     while(iter != msglist.constEnd()) {
216       if(!fastForward && (*iter).msgId() < id)
217         break;
218
219       if((*iter).msgId() != dupeId) {
220         if(!grouplist.isEmpty()) {
221           QDateTime nextTs = grouplist.value(0).timestamp();
222           QDateTime prevTs = (*iter).timestamp();
223           nextTs.setTimeSpec(Qt::UTC);
224           prevTs.setTimeSpec(Qt::UTC);
225           uint nextDay = nextTs.toTime_t() / 86400;
226           uint prevDay = prevTs.toTime_t() / 86400;
227           if(nextDay != prevDay) {
228             nextTs.setTime_t(nextDay * 86400);
229             nextTs.setTimeSpec(Qt::LocalTime);
230             Message dayChangeMsg = Message::ChangeOfDay(nextTs);
231             dayChangeMsg.setMsgId((*iter).msgId());
232             grouplist.prepend(dayChangeMsg);
233             dupeCount--;
234           }
235         }
236         grouplist.prepend(*iter);
237       } else {
238         dupeCount++;
239       }
240
241       iter++;
242     }
243   }
244
245   insertMessageGroup(grouplist);
246   return grouplist.count() + dupeCount;
247 }
248
249 void MessageModel::customEvent(QEvent *event) {
250   if(event->type() != QEvent::User)
251     return;
252
253   event->accept();
254
255   if(_messageBuffer.isEmpty())
256     return;
257
258   int processedMsgs = insertMessagesGracefully(_messageBuffer);
259   int remainingMsgs = _messageBuffer.count() - processedMsgs;
260
261   QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
262   QList<Message>::iterator removeEnd = _messageBuffer.end();
263   _messageBuffer.erase(removeStart, removeEnd);
264
265   if(!_messageBuffer.isEmpty())
266     QCoreApplication::postEvent(this, new ProcessBufferEvent());
267 }
268
269 void MessageModel::clear() {
270   beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
271   qDeleteAll(_messageList);
272   _messageList.clear();
273   endRemoveRows();
274 }
275
276
277
278 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
279 int MessageModel::indexForId(MsgId id) {
280   if(_messageList.isEmpty() || id <= _messageList.value(0)->msgId())
281     return 0;
282   if(id > _messageList.last()->msgId())
283     return _messageList.count();
284
285   // binary search
286   int start = 0; int end = _messageList.count()-1;
287   while(1) {
288     if(end - start == 1)
289       return end;
290     int pivot = (end + start) / 2;
291     if(id <= _messageList.value(pivot)->msgId()) end = pivot;
292     else start = pivot;
293   }
294 }
295
296 void MessageModel::changeOfDay() {
297   _dayChangeTimer.setInterval(86400000);
298   qDebug() << _nextDayChange;
299   if(!_messageList.isEmpty()) {
300     int idx = _messageList.count();
301     while(idx > 0 && _messageList[idx - 1]->timeStamp() > _nextDayChange) {
302       idx--;
303     }
304     beginInsertRows(QModelIndex(), idx, idx);
305     Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
306     dayChangeMsg.setMsgId(_messageList[idx - 1]->msgId());
307     _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
308     endInsertRows();
309   }
310   _nextDayChange = _nextDayChange.addSecs(86400);
311 }
312
313 /**********************************************************************************/
314
315 MessageModelItem::MessageModelItem(const Message &msg) :
316   _timestamp(msg.timestamp()),
317   _msgId(msg.msgId()),
318   _bufferId(msg.bufferInfo().bufferId()),
319   _type(msg.type()),
320   _flags(msg.flags())
321 {
322 }
323
324 QVariant MessageModelItem::data(int column, int role) const {
325   if(column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
326     return QVariant();
327
328   switch(role) {
329   case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(_msgId);
330   case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(_bufferId);
331   case MessageModel::TypeRole: return _type;
332   case MessageModel::FlagsRole: return (int)_flags;
333   case MessageModel::TimestampRole: return _timestamp;
334   default: return QVariant();
335   }
336 }
337
338
339 // Stuff for later
340 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2){
341   return (*m1) < (*m2);
342 }
343
344 bool MessageModelItem::operator<(const MessageModelItem &other) const {
345   return _msgId < other._msgId;
346 }
347
348 bool MessageModelItem::operator==(const MessageModelItem &other) const {
349   return _msgId == other._msgId;
350 }
351
352 bool MessageModelItem::operator>(const MessageModelItem &other) const {
353   return _msgId > other._msgId;
354 }