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