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