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