Happy New Year!
[quassel.git] / src / client / messagemodel.cpp
index d53449e..cbcfceb 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel IRC Team                         *
+ *   Copyright (C) 2005-2015 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #include "messagemodel.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) {}
+};
+
 
-MessageModel::MessageModel(QObject *parent) : QAbstractItemModel(parent) {
-  
-  
-  
+MessageModel::MessageModel(QObject *parent)
+    : QAbstractItemModel(parent)
+{
+    QDateTime now = QDateTime::currentDateTime();
+    now.setTimeSpec(Qt::UTC);
+    _nextDayChange.setTimeSpec(Qt::UTC);
+    _nextDayChange.setTime_t(((now.toTime_t() / 86400) + 1) * 86400);
+    _nextDayChange.setTimeSpec(Qt::LocalTime);
+    _dayChangeTimer.setInterval(QDateTime::currentDateTime().secsTo(_nextDayChange) * 1000);
+    _dayChangeTimer.start();
+    connect(&_dayChangeTimer, SIGNAL(timeout()), this, SLOT(changeOfDay()));
 }
 
-MessageModel::~MessageModel() {
-  
-  
+
+QVariant MessageModel::data(const QModelIndex &index, int role) const
+{
+    int row = index.row(); int column = index.column();
+    if (row < 0 || row >= messageCount() || column < 0)
+        return QVariant();
+
+    if (role == ColumnTypeRole)
+        return column;
+
+    return messageItemAt(row)->data(index.column(), role);
+    // return _messageList[row]->data(index.column(), role);
 }
 
-QVariant MessageModel::data(const QModelIndex &index, int role) const {
-  int row = index.row();
-  if(row < 0 || row >= _messageList.count()) return QVariant();
-  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 >= messageCount())
+        return false;
+
+    if (messageItemAt(row)->setData(index.column(), value, role)) {
+        emit dataChanged(index, index);
+        return true;
+    }
+    return false;
 }
 
-bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role) {
-  int row = index.row();
-  if(row < 0 || row >= _messageList.count()) return false;
-  if(_messageList[row]->setData(index.column(), value, role)) {
-    emit dataChanged(index, index); // FIXME make msg emit this (too)
+
+bool MessageModel::insertMessage(const Message &msg, bool fakeMsg)
+{
+    MsgId id = msg.msgId();
+    int idx = indexForId(id);
+    if (!fakeMsg && idx < messageCount()) { // check for duplicate
+        if (messageItemAt(idx)->msgId() == id)
+            return false;
+    }
+
+    insertMessageGroup(QList<Message>() << msg);
     return true;
-  }
-  return false;
 }
 
-void MessageModel::insertMessage(const Message &msg) {
-  MsgId id = msg.msgId();
-  int idx = indexForId(id); qDebug() << "inserting at" << idx << msg.text();
-  MessageItem *item = createMessageItem(msg);
-  beginInsertRows(QModelIndex(), idx, idx);
-  _messageList.insert(idx, item);
-  endInsertRows();
+
+void MessageModel::insertMessages(const QList<Message> &msglist)
+{
+    if (msglist.isEmpty())
+        return;
+
+    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);
+    }
+}
+
+
+void MessageModel::insertMessageGroup(const QList<Message> &msglist)
+{
+    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);
+            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());
+            }
+            endRemoveRows();
+
+            start--;
+            end--;
+        }
+    }
+
+    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);
+        uint nextDay = nextTs.toTime_t() / 86400;
+        uint prevDay = prevTs.toTime_t() / 86400;
+        if (nextDay != prevDay) {
+            nextTs.setTime_t(nextDay * 86400);
+            nextTs.setTimeSpec(Qt::LocalTime);
+            dayChangeMsg = Message::ChangeOfDay(nextTs);
+            dayChangeMsg.setMsgId(msglist.last().msgId());
+        }
+    }
+
+    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);
+    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 minId;
+    MsgId dupeId;
+    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) {
+        iter = msglist.constEnd();
+        iter--; // this op is safe as we've allready passed an empty check
+    }
+    else {
+        iter = msglist.constBegin();
+    }
+
+    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)
+        minId = messageItemAt(idx - 1)->msgId();
+    else
+        fastForward = true;
+
+    if ((*iter).msgId() != dupeId) {
+        grouplist << *iter;
+        dupeId = (*iter).msgId();
+    }
+
+    if (!inOrder)
+        iter++;
+
+    if (inOrder) {
+        while (iter != msglist.constBegin()) {
+            iter--;
+
+            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();
+                    QDateTime prevTs = (*iter).timestamp();
+                    nextTs.setTimeSpec(Qt::UTC);
+                    prevTs.setTimeSpec(Qt::UTC);
+                    uint nextDay = nextTs.toTime_t() / 86400;
+                    uint prevDay = prevTs.toTime_t() / 86400;
+                    if (nextDay != prevDay) {
+                        nextTs.setTime_t(nextDay * 86400);
+                        nextTs.setTimeSpec(Qt::LocalTime);
+                        Message dayChangeMsg = Message::ChangeOfDay(nextTs);
+                        dayChangeMsg.setMsgId((*iter).msgId());
+                        grouplist.prepend(dayChangeMsg);
+                    }
+                }
+                dupeId = (*iter).msgId();
+                grouplist.prepend(*iter);
+            }
+        }
+    }
+    else {
+        while (iter != msglist.constEnd()) {
+            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();
+                    QDateTime prevTs = (*iter).timestamp();
+                    nextTs.setTimeSpec(Qt::UTC);
+                    prevTs.setTimeSpec(Qt::UTC);
+                    uint nextDay = nextTs.toTime_t() / 86400;
+                    uint prevDay = prevTs.toTime_t() / 86400;
+                    if (nextDay != prevDay) {
+                        nextTs.setTime_t(nextDay * 86400);
+                        nextTs.setTimeSpec(Qt::LocalTime);
+                        Message dayChangeMsg = Message::ChangeOfDay(nextTs);
+                        dayChangeMsg.setMsgId((*iter).msgId());
+                        grouplist.prepend(dayChangeMsg);
+                    }
+                }
+                dupeId = (*iter).msgId();
+                grouplist.prepend(*iter);
+            }
+            iter++;
+        }
+    }
+
+    if (!grouplist.isEmpty())
+        insertMessageGroup(grouplist);
+    return processedMsgs;
+}
+
+
+void MessageModel::customEvent(QEvent *event)
+{
+    if (event->type() != QEvent::User)
+        return;
+
+    event->accept();
+
+    if (_messageBuffer.isEmpty())
+        return;
+
+    int processedMsgs = insertMessagesGracefully(_messageBuffer);
+    int remainingMsgs = _messageBuffer.count() - processedMsgs;
+
+    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::insertMessages(const QList<Message> &msglist) {
-  if(msglist.isEmpty()) return;
-  // FIXME make this more efficient by grouping msgs
-  foreach(Message msg, msglist) insertMessage(msg);
 
+void MessageModel::clear()
+{
+    _messagesWaiting.clear();
+    if (rowCount() > 0) {
+        beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
+        removeAllMessages();
+        endRemoveRows();
+    }
 }
 
+
 // 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[0]->data(0, MsgIdRole).value<MsgId>()) return 0;
-  if(id > _messageList.last()->data(0, MsgIdRole).value<MsgId>()) return _messageList.count();
-  // binary search
-  int start = 0; int end = _messageList.count()-1;
-  while(1) {
-    if(end - start == 1) return end;
-    int pivot = (end + start) / 2;
-    if(id <= _messageList[pivot]->data(0, MsgIdRole).value<MsgId>()) end = pivot;
-    else start = pivot;
-  }
+int MessageModel::indexForId(MsgId id)
+{
+    if (messagesIsEmpty() || id <= messageItemAt(0)->msgId())
+        return 0;
+
+    if (id > lastMessageItem()->msgId())
+        return messageCount();
+
+    // binary search
+    int start = 0; int end = messageCount() - 1;
+    while (1) {
+        if (end - start == 1)
+            return end;
+        int pivot = (end + start) / 2;
+        if (id <= messageItemAt(pivot)->msgId()) end = pivot;
+        else start = pivot;
+    }
+}
+
+
+void MessageModel::changeOfDay()
+{
+    _dayChangeTimer.setInterval(86400000);
+    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(messageItemAt(idx - 1)->msgId());
+        insertMessage__(idx, dayChangeMsg);
+        endInsertRows();
+    }
+    _nextDayChange = _nextDayChange.addSecs(86400);
+}
+
+
+void MessageModel::insertErrorMessage(BufferInfo bufferInfo, const QString &errorString)
+{
+    int idx = messageCount();
+    beginInsertRows(QModelIndex(), idx, idx);
+    Message msg(bufferInfo, Message::Error, errorString);
+    if (!messagesIsEmpty())
+        msg.setMsgId(messageItemAt(idx-1)->msgId());
+    else
+        msg.setMsgId(0);
+    insertMessage__(idx, msg);
+    endInsertRows();
+}
+
+
+void MessageModel::requestBacklog(BufferId bufferId)
+{
+    if (_messagesWaiting.contains(bufferId))
+        return;
+
+    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);
+        emit finishedBacklogFetch(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::MessageRole:
+        return QVariant::fromValue<Message>(message());
+    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)
+{
+    return (*m1) < (*m2);
+}
+
+
+bool MessageModelItem::operator<(const MessageModelItem &other) const
+{
+    return msgId() < other.msgId();
+}
+
+
+bool MessageModelItem::operator==(const MessageModelItem &other) const
+{
+    return msgId() == other.msgId();
+}
+
+
+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;
+}