fixing a client crash that could occur when processing dynamic backlog
[quassel.git] / src / client / messagemodel.cpp
index 28872dc..07af7ac 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 
 #include "messagemodel.h"
 
-#include "message.h"
-
 #include <QEvent>
 
+#include "backlogsettings.h"
+#include "clientbacklogmanager.h"
+#include "client.h"
+#include "message.h"
+#include "networkmodel.h"
+
 class ProcessBufferEvent : public QEvent {
 public:
   inline ProcessBufferEvent() : QEvent(QEvent::User) {}
@@ -44,35 +48,33 @@ MessageModel::MessageModel(QObject *parent)
 
 QVariant MessageModel::data(const QModelIndex &index, int role) const {
   int row = index.row(); int column = index.column();
-  if(row < 0 || row >= _messageList.count() || column < 0)
+  if(row < 0 || row >= messageCount() || column < 0)
     return QVariant();
 
   if(role == ColumnTypeRole)
     return column;
 
-  return _messageList[row]->data(index.column(), role);
+  return messageItemAt(row)->data(index.column(), role);
+  // return _messageList[row]->data(index.column(), role);
 }
 
 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
   int row = index.row();
-  if(row < 0 || row >= _messageList.count())
+  if(row < 0 || row >= messageCount())
     return false;
 
-  if(_messageList[row]->setData(index.column(), value, role)) {
+  if(messageItemAt(row)->setData(index.column(), value, role)) {
     emit dataChanged(index, index);
     return true;
   }
-
   return false;
 }
 
-
-
 bool MessageModel::insertMessage(const Message &msg, bool fakeMsg) {
   MsgId id = msg.msgId();
   int idx = indexForId(id);
-  if(!fakeMsg && idx < _messageList.count()) { // check for duplicate
-    if(_messageList[idx]->msgId() == id)
+  if(!fakeMsg && idx < messageCount()) { // check for duplicate
+    if(messageItemAt(idx)->msgId() == id)
       return false;
   }
 
@@ -84,47 +86,62 @@ void MessageModel::insertMessages(const QList<Message> &msglist) {
   if(msglist.isEmpty())
     return;
 
-  int processedMsgs = insertMessagesGracefully(msglist);
-  int remainingMsgs = msglist.count() - processedMsgs;
-  if(remainingMsgs > 0) {
-    if(msglist.first().msgId() < msglist.last().msgId()) {
-      // in Order
-      _messageBuffer << msglist.mid(0, remainingMsgs);
-    } else {
-      _messageBuffer << msglist.mid(processedMsgs);
+  if(_messageBuffer.isEmpty()) {
+    int processedMsgs = insertMessagesGracefully(msglist);
+    int remainingMsgs = msglist.count() - processedMsgs;
+    if(remainingMsgs > 0) {
+      if(msglist.first().msgId() < msglist.last().msgId()) {
+       // in Order - we have just successfully processed "processedMsg" messages from the end of the list
+       _messageBuffer = msglist.mid(0, remainingMsgs);
+      } else {
+       _messageBuffer = msglist.mid(processedMsgs);
+      }
+      qSort(_messageBuffer);
+      QCoreApplication::postEvent(this, new ProcessBufferEvent());
     }
+  } else {
+    _messageBuffer << msglist;
     qSort(_messageBuffer);
-    QCoreApplication::postEvent(this, new ProcessBufferEvent());
   }
 }
 
 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
-  // the msglist can be assumed to be non empty
-  int idx = indexForId(msglist.first().msgId());
-  int start = idx;
-  int end = idx + msglist.count() - 1;
-  MessageModelItem *dayChangeItem = 0;
-
-  if(idx > 0) {
-    int prevIdx = idx - 1;
-    if(_messageList[prevIdx]->msgType() == Message::DayChange
-       && _messageList[prevIdx]->timeStamp() > msglist.value(0).timestamp()) {
+  Q_ASSERT(!msglist.isEmpty()); // the msglist can be assumed to be non empty
+//   int last = msglist.count() - 1;
+//   Q_ASSERT(0 == last || msglist.at(0).msgId() != msglist.at(last).msgId() || msglist.at(last).type() == Message::DayChange);
+  int start = indexForId(msglist.first().msgId());
+  int end = start + msglist.count() - 1;
+  Message dayChangeMsg;
+
+  if(start > 0) {
+    // check if the preceeding msg is a daychange message and if so if
+    // we have to drop or relocate it at the end of this chunk
+    int prevIdx = start - 1;
+    if(messageItemAt(prevIdx)->msgType() == Message::DayChange
+       && messageItemAt(prevIdx)->timestamp() > msglist.at(0).timestamp()) {
+
       beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
-      MessageModelItem *oldItem = _messageList.takeAt(prevIdx);
-      if(msglist.last().timestamp() < oldItem->timeStamp()) {
-       // we have to reinsert it (with changed msgId -> thus we need to recreate it)
-       Message dayChangeMsg = Message::ChangeOfDay(oldItem->timeStamp());
+      Message oldDayChangeMsg = takeMessageAt(prevIdx);
+      if(msglist.last().timestamp() < oldDayChangeMsg.timestamp()) {
+       // we have to reinsert it with a changed msgId
+       dayChangeMsg = oldDayChangeMsg;
        dayChangeMsg.setMsgId(msglist.last().msgId());
-       dayChangeItem = createMessageModelItem(dayChangeMsg);
       }
-      delete oldItem;
       endRemoveRows();
-      idx--;
+
+      start--;
+      end--;
     }
   }
 
-  if(!dayChangeItem && idx < _messageList.count() && _messageList[idx]->msgType() != Message::DayChange) {
-    QDateTime nextTs = _messageList[idx]->timeStamp();
+  if(!dayChangeMsg.isValid() && start < messageCount()) {
+    // if(!dayChangeItem && start < _messageList.count()) {
+    // check if we need to insert a daychange message at the end of the this group
+
+    // if this assert triggers then indexForId() would have found a spot right before a DayChangeMsg
+    // this should never happen as daychange messages share the msgId with the preceeding message
+    Q_ASSERT(messageItemAt(start)->msgType() != Message::DayChange);
+    QDateTime nextTs = messageItemAt(start)->timestamp();
     QDateTime prevTs = msglist.last().timestamp();
     nextTs.setTimeSpec(Qt::UTC);
     prevTs.setTimeSpec(Qt::UTC);
@@ -133,34 +150,43 @@ void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
     if(nextDay != prevDay) {
       nextTs.setTime_t(nextDay * 86400);
       nextTs.setTimeSpec(Qt::LocalTime);
-      Message dayChangeMsg = Message::ChangeOfDay(nextTs);
+      dayChangeMsg = Message::ChangeOfDay(nextTs);
       dayChangeMsg.setMsgId(msglist.last().msgId());
-      dayChangeItem = createMessageModelItem(dayChangeMsg);
     }
   }
 
-  if(dayChangeItem)
+  if(dayChangeMsg.isValid())
     end++;
 
+  Q_ASSERT(start == 0 || messageItemAt(start - 1)->msgId() < msglist.first().msgId());
+  Q_ASSERT(start == messageCount() || messageItemAt(start)->msgId() > msglist.last().msgId());
   beginInsertRows(QModelIndex(), start, end);
-  foreach(Message msg, msglist) {
-    _messageList.insert(idx, createMessageModelItem(msg));
-    idx++;
-  }
-  if(dayChangeItem) {
-    _messageList.insert(idx, dayChangeItem);
-  }
+  insertMessages__(start, msglist);
+  if(dayChangeMsg.isValid())
+    insertMessage__(start + msglist.count(), dayChangeMsg);
   endInsertRows();
+
+  Q_ASSERT(start == end || messageItemAt(start)->msgId() != messageItemAt(end)->msgId() || messageItemAt(end)->msgType() == Message::DayChange);
+  Q_ASSERT(start == 0 || messageItemAt(start - 1)->msgId() < messageItemAt(start)->msgId());
+  Q_ASSERT(end + 1 == messageCount() || messageItemAt(end)->msgId() < messageItemAt(end + 1)->msgId());
 }
 
 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
+  /* short description:
+   * 1) first we check where the message with the highest msgId from msglist would be inserted
+   * 2) check that position for dupe
+   * 3) determine the messageId of the preceeding msg
+   * 4) insert as many msgs from msglist with with msgId larger then the just determined id
+   *    those messages are automatically less then the msg of the position we just determined in 1)
+   */
   bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
   // depending on the order we have to traverse from the front to the back or vice versa
 
   QList<Message> grouplist;
-  MsgId id;
+  MsgId minId;
   MsgId dupeId;
-  int dupeCount = 0;
+  int processedMsgs = 1; // we know the list isn't empty, so we at least process one message
+  int idx;
   bool fastForward = false;
   QList<Message>::const_iterator iter;
   if(inOrder) {
@@ -170,21 +196,21 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
     iter = msglist.constBegin();
   }
 
-  int idx = indexForId((*iter).msgId());
-  if(idx >= 0 && !_messageList.isEmpty())
-    dupeId = _messageList[idx]->msgId();
+  idx = indexForId((*iter).msgId());
+  if(idx < messageCount())
+    dupeId = messageItemAt(idx)->msgId();
 
   // we always compare to the previous entry...
   // if there isn't, we can fastforward to the top
   if(idx - 1 >= 0)
-    id = _messageList[idx - 1]->msgId();
+    minId = messageItemAt(idx - 1)->msgId();
   else
     fastForward = true;
 
-  if((*iter).msgId() != dupeId)
+  if((*iter).msgId() != dupeId) {
     grouplist << *iter;
-  else
-    dupeCount++;
+    dupeId = (*iter).msgId();
+  }
 
   if(!inOrder)
     iter++;
@@ -193,9 +219,15 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
     while(iter != msglist.constBegin()) {
       iter--;
 
-      if(!fastForward && (*iter).msgId() < id)
+      if(!fastForward && (*iter).msgId() < minId)
        break;
+      processedMsgs++;
 
+      if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
+       idx = indexForId((*iter).msgId());
+       if(idx >= 0 && !messagesIsEmpty())
+         dupeId = messageItemAt(idx)->msgId();
+      }
       if((*iter).msgId() != dupeId) {
        if(!grouplist.isEmpty()) {
          QDateTime nextTs = grouplist.value(0).timestamp();
@@ -210,19 +242,23 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
            Message dayChangeMsg = Message::ChangeOfDay(nextTs);
            dayChangeMsg.setMsgId((*iter).msgId());
            grouplist.prepend(dayChangeMsg);
-           dupeCount--;
          }
        }
+       dupeId = (*iter).msgId();
        grouplist.prepend(*iter);
-      } else {
-       dupeCount++;
       }
     }
   } else {
     while(iter != msglist.constEnd()) {
-      if(!fastForward && (*iter).msgId() < id)
+      if(!fastForward && (*iter).msgId() < minId)
        break;
+      processedMsgs++;
 
+      if(grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
+       idx = indexForId((*iter).msgId());
+       if(idx >= 0 && !messagesIsEmpty())
+         dupeId = messageItemAt(idx)->msgId();
+      }
       if((*iter).msgId() != dupeId) {
        if(!grouplist.isEmpty()) {
          QDateTime nextTs = grouplist.value(0).timestamp();
@@ -237,20 +273,18 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
            Message dayChangeMsg = Message::ChangeOfDay(nextTs);
            dayChangeMsg.setMsgId((*iter).msgId());
            grouplist.prepend(dayChangeMsg);
-           dupeCount--;
          }
        }
+       dupeId = (*iter).msgId();
        grouplist.prepend(*iter);
-      } else {
-       dupeCount++;
       }
-
       iter++;
     }
   }
 
-  insertMessageGroup(grouplist);
-  return grouplist.count() + dupeCount;
+  if(!grouplist.isEmpty())
+    insertMessageGroup(grouplist);
+  return processedMsgs;
 }
 
 void MessageModel::customEvent(QEvent *event) {
@@ -268,80 +302,120 @@ void MessageModel::customEvent(QEvent *event) {
   QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
   QList<Message>::iterator removeEnd = _messageBuffer.end();
   _messageBuffer.erase(removeStart, removeEnd);
-
   if(!_messageBuffer.isEmpty())
     QCoreApplication::postEvent(this, new ProcessBufferEvent());
 }
 
 void MessageModel::clear() {
   beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
-  qDeleteAll(_messageList);
-  _messageList.clear();
+  removeAllMessages();
   endRemoveRows();
+  _messagesWaiting.clear();
 }
 
-
-
 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
 int MessageModel::indexForId(MsgId id) {
-  if(_messageList.isEmpty() || id <= _messageList.value(0)->msgId())
+  if(messagesIsEmpty() || id <= messageItemAt(0)->msgId())
     return 0;
-  if(id > _messageList.last()->msgId())
-    return _messageList.count();
+
+  if(id > lastMessageItem()->msgId())
+    return messageCount();
 
   // binary search
-  int start = 0; int end = _messageList.count()-1;
+  int start = 0; int end = messageCount() - 1;
   while(1) {
     if(end - start == 1)
       return end;
     int pivot = (end + start) / 2;
-    if(id <= _messageList.value(pivot)->msgId()) end = pivot;
+    if(id <= messageItemAt(pivot)->msgId()) end = pivot;
     else start = pivot;
   }
 }
 
 void MessageModel::changeOfDay() {
   _dayChangeTimer.setInterval(86400000);
-  qDebug() << _nextDayChange;
-  if(!_messageList.isEmpty()) {
-    int idx = _messageList.count();
-    while(idx > 0 && _messageList[idx - 1]->timeStamp() > _nextDayChange) {
+  if(!messagesIsEmpty()) {
+    int idx = messageCount();
+    while(idx > 0 && messageItemAt(idx - 1)->timestamp() > _nextDayChange) {
       idx--;
     }
     beginInsertRows(QModelIndex(), idx, idx);
     Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
-    dayChangeMsg.setMsgId(_messageList[idx - 1]->msgId());
-    _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
+    dayChangeMsg.setMsgId(messageItemAt(idx - 1)->msgId());
+    insertMessage__(idx, dayChangeMsg);
     endInsertRows();
   }
   _nextDayChange = _nextDayChange.addSecs(86400);
 }
 
-/**********************************************************************************/
+void MessageModel::requestBacklog(BufferId bufferId) {
+  if(_messagesWaiting.contains(bufferId))
+    return;
 
-MessageModelItem::MessageModelItem(const Message &msg) :
-  _timestamp(msg.timestamp()),
-  _msgId(msg.msgId()),
-  _bufferId(msg.bufferInfo().bufferId()),
-  _type(msg.type()),
-  _flags(msg.flags())
-{
+  BacklogSettings backlogSettings;
+  int requestCount = backlogSettings.dynamicBacklogAmount();
+
+  for(int i = 0; i < messageCount(); i++) {
+    if(messageItemAt(i)->bufferId() == bufferId) {
+      _messagesWaiting[bufferId] = requestCount;
+      Client::backlogManager()->emitMessagesRequested(tr("Requesting %1 messages from backlog for buffer %2:%3")
+                                                     .arg(requestCount)
+                                                     .arg(Client::networkModel()->networkName(bufferId))
+                                                     .arg(Client::networkModel()->bufferName(bufferId)));
+      Client::backlogManager()->requestBacklog(bufferId, -1, messageItemAt(i)->msgId(), requestCount);
+      return;
+    }
+  }
+}
+
+void MessageModel::messagesReceived(BufferId bufferId, int count) {
+  if(!_messagesWaiting.contains(bufferId))
+    return;
+
+  _messagesWaiting[bufferId] -= count;
+  if(_messagesWaiting[bufferId] <= 0)
+    _messagesWaiting.remove(bufferId);
 }
 
+void MessageModel::buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2) {
+  for(int i = 0; i < messageCount(); i++) {
+    if(messageItemAt(i)->bufferId() == bufferId2) {
+      messageItemAt(i)->setBufferId(bufferId1);
+      QModelIndex idx = index(i, 0);
+      emit dataChanged(idx, idx);
+    }
+  }
+}
+
+// ========================================
+//  MessageModelItem
+// ========================================
 QVariant MessageModelItem::data(int column, int role) const {
   if(column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
     return QVariant();
 
   switch(role) {
-  case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(_msgId);
-  case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(_bufferId);
-  case MessageModel::TypeRole: return _type;
-  case MessageModel::FlagsRole: return (int)_flags;
-  case MessageModel::TimestampRole: return _timestamp;
+  case MessageModel::MsgIdRole: return QVariant::fromValue<MsgId>(msgId());
+  case MessageModel::BufferIdRole: return QVariant::fromValue<BufferId>(bufferId());
+  case MessageModel::TypeRole: return msgType();
+  case MessageModel::FlagsRole: return (int)msgFlags();
+  case MessageModel::TimestampRole: return timestamp();
+  case MessageModel::RedirectedToRole: return qVariantFromValue<BufferId>(_redirectedTo);
   default: return QVariant();
   }
 }
 
+bool MessageModelItem::setData(int column, const QVariant &value, int role) {
+  Q_UNUSED(column);
+
+  switch(role) {
+  case MessageModel::RedirectedToRole:
+    _redirectedTo = value.value<BufferId>();
+    return true;
+  default:
+    return false;
+  }
+}
 
 // Stuff for later
 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2){
@@ -349,13 +423,22 @@ bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelIt
 }
 
 bool MessageModelItem::operator<(const MessageModelItem &other) const {
-  return _msgId < other._msgId;
+  return msgId() < other.msgId();
 }
 
 bool MessageModelItem::operator==(const MessageModelItem &other) const {
-  return _msgId == other._msgId;
+  return msgId() == other.msgId();
 }
 
 bool MessageModelItem::operator>(const MessageModelItem &other) const {
-  return _msgId > other._msgId;
+  return msgId() > other.msgId();
+}
+
+QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem) {
+  dbg.nospace() << qPrintable(QString("MessageModelItem(MsgId:")) << msgItem.msgId()
+               << qPrintable(QString(",")) << msgItem.timestamp()
+               << qPrintable(QString(", Type:")) << msgItem.msgType()
+               << qPrintable(QString(", Flags:")) << msgItem.msgFlags() << qPrintable(QString(")"))
+               << msgItem.data(1, Qt::DisplayRole).toString() << ":" << msgItem.data(2, Qt::DisplayRole).toString();
+  return dbg;
 }