Backlog amount (initial and dynamic) can now be configured (Settings -> behavior...
[quassel.git] / src / client / messagemodel.cpp
index 41701c3..82fd71b 100644 (file)
 
 #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) {}
@@ -66,8 +70,6 @@ bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int
   return false;
 }
 
-
-
 bool MessageModel::insertMessage(const Message &msg, bool fakeMsg) {
   MsgId id = msg.msgId();
   int idx = indexForId(id);
@@ -76,10 +78,7 @@ bool MessageModel::insertMessage(const Message &msg, bool fakeMsg) {
       return false;
   }
 
-  MessageModelItem *item = createMessageModelItem(msg);
-  beginInsertRows(QModelIndex(), idx, idx);
-  _messageList.insert(idx, item);
-  endInsertRows();
+  insertMessageGroup(QList<Message>() << msg);
   return true;
 }
 
@@ -91,7 +90,7 @@ void MessageModel::insertMessages(const QList<Message> &msglist) {
   int remainingMsgs = msglist.count() - processedMsgs;
   if(remainingMsgs > 0) {
     if(msglist.first().msgId() < msglist.last().msgId()) {
-      // in Order
+      // 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);
@@ -102,22 +101,40 @@ void MessageModel::insertMessages(const QList<Message> &msglist) {
 }
 
 void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
-  int idx = indexForId(msglist.first().msgId());
-  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 start = indexForId(msglist.first().msgId());
+  int end = start + msglist.count() - 1;
+  MessageModelItem *dayChangeItem = 0;
+  bool relocatedMsg = false;
+  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(_messageList.at(prevIdx)->msgType() == Message::DayChange
+       && _messageList.at(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());
+       dayChangeMsg.setMsgId(msglist.last().msgId());
+       dayChangeItem = createMessageModelItem(dayChangeMsg);
+      }
       delete oldItem;
       endRemoveRows();
-      idx--;
+      start--;
+      end--;
+      relocatedMsg = true;
     }
   }
-  Message dayChangeMsg;
-  bool needsDayChangeMsg = false;
-  if(idx < _messageList.count() && _messageList[idx]->msgType() != Message::DayChange) {
-    QDateTime nextTs = _messageList[idx]->timeStamp();
+
+  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(_messageList[start]->msgType() != Message::DayChange);
+    QDateTime nextTs = _messageList[start]->timeStamp();
     QDateTime prevTs = msglist.last().timestamp();
     nextTs.setTimeSpec(Qt::UTC);
     prevTs.setTimeSpec(Qt::UTC);
@@ -126,32 +143,49 @@ void MessageModel::insertMessageGroup(const QList<Message> &msglist) {
     if(nextDay != prevDay) {
       nextTs.setTime_t(nextDay * 86400);
       nextTs.setTimeSpec(Qt::LocalTime);
-      dayChangeMsg = Message::ChangeOfDay(nextTs);
+      Message dayChangeMsg = Message::ChangeOfDay(nextTs);
       dayChangeMsg.setMsgId(msglist.last().msgId());
-      needsDayChangeMsg = true;
+      dayChangeItem = createMessageModelItem(dayChangeMsg);
     }
   }
-  int start = idx;
-  int end = idx + msglist.count() - 1;
+
+  if(dayChangeItem)
+    end++;
+
+  Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < msglist.first().msgId());
+  Q_ASSERT(start == _messageList.count() || _messageList[start]->msgId() > msglist.last().msgId());
   beginInsertRows(QModelIndex(), start, end);
+  int pos = start;
   foreach(Message msg, msglist) {
-    _messageList.insert(idx, createMessageModelItem(msg));
-    idx++;
+    _messageList.insert(pos, createMessageModelItem(msg));
+    pos++;
   }
-  if(needsDayChangeMsg) {
-    _messageList.insert(idx, createMessageModelItem(dayChangeMsg));
+  if(dayChangeItem) {
+    _messageList.insert(pos, dayChangeItem);
+    pos++; // needed for the following assert
   }
   endInsertRows();
+  Q_ASSERT(start == 0 || _messageList[start - 1]->msgId() < _messageList[start]->msgId());
+  Q_ASSERT(end + 1 == _messageList.count() || _messageList[end]->msgId() < _messageList[end + 1]->msgId());
+  Q_ASSERT(pos - 1 == end);
 }
 
 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 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) {
@@ -161,7 +195,7 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
     iter = msglist.constBegin();
   }
 
-  int idx = indexForId((*iter).msgId());
+  idx = indexForId((*iter).msgId());
   if(idx >= 0 && !_messageList.isEmpty())
     dupeId = _messageList[idx]->msgId();
 
@@ -174,8 +208,6 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
 
   if((*iter).msgId() != dupeId)
     grouplist << *iter;
-  else
-    dupeCount++;
 
   if(!inOrder)
     iter++;
@@ -186,7 +218,13 @@ int MessageModel::insertMessagesGracefully(const QList<Message> &msglist) {
 
       if(!fastForward && (*iter).msgId() < id)
        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 && !_messageList.isEmpty())
+         dupeId = _messageList[idx]->msgId();
+      }
       if((*iter).msgId() != dupeId) {
        if(!grouplist.isEmpty()) {
          QDateTime nextTs = grouplist.value(0).timestamp();
@@ -201,19 +239,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)
        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 && !_messageList.isEmpty())
+         dupeId = _messageList[idx]->msgId();
+      }
       if((*iter).msgId() != dupeId) {
        if(!grouplist.isEmpty()) {
          QDateTime nextTs = grouplist.value(0).timestamp();
@@ -228,20 +270,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) {
@@ -269,10 +309,9 @@ void MessageModel::clear() {
   qDeleteAll(_messageList);
   _messageList.clear();
   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())
@@ -293,7 +332,6 @@ int MessageModel::indexForId(MsgId id) {
 
 void MessageModel::changeOfDay() {
   _dayChangeTimer.setInterval(86400000);
-  qDebug() << _nextDayChange;
   if(!_messageList.isEmpty()) {
     int idx = _messageList.count();
     while(idx > 0 && _messageList[idx - 1]->timeStamp() > _nextDayChange) {
@@ -308,8 +346,38 @@ void MessageModel::changeOfDay() {
   _nextDayChange = _nextDayChange.addSecs(86400);
 }
 
-/**********************************************************************************/
+void MessageModel::requestBacklog(BufferId bufferId) {
+  if(_messagesWaiting.contains(bufferId))
+    return;
 
+  BacklogSettings backlogSettings;
+  int requestCount = backlogSettings.dynamicBacklogAmount();
+
+  for(int i = 0; i < _messageList.count(); i++) {
+    if(_messageList.at(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, requestCount, _messageList.at(i)->msgId().toInt());
+      return;
+    }
+  }
+}
+
+void MessageModel::messagesReceived(BufferId bufferId, int count) {
+  if(!_messagesWaiting.contains(bufferId))
+    return;
+
+  _messagesWaiting[bufferId] -= count;
+  if(_messagesWaiting[bufferId] <= 0)
+    _messagesWaiting.remove(bufferId);
+}
+
+// ========================================
+//  MessageModelItem
+// ========================================
 MessageModelItem::MessageModelItem(const Message &msg) :
   _timestamp(msg.timestamp()),
   _msgId(msg.msgId()),
@@ -350,3 +418,12 @@ bool MessageModelItem::operator==(const MessageModelItem &other) const {
 bool MessageModelItem::operator>(const MessageModelItem &other) const {
   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;
+}