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