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