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