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