src/client/messagemodel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 by the Quassel Project                        *
   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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #include "messagemodel.h"
  22
  23 #include <QEvent>
  24
  25 #include "backlogsettings.h"
  26 #include "clientbacklogmanager.h"
  27 #include "client.h"
  28 #include "message.h"
  29 #include "networkmodel.h"
  30
  31 class ProcessBufferEvent : public QEvent
  32 {
  33 public:
  34     inline ProcessBufferEvent() : QEvent(QEvent::User) {}
  35 };
  36
  37
  38 MessageModel::MessageModel(QObject *parent)
  39     : QAbstractItemModel(parent)
  40 {
  41     QDateTime now = QDateTime::currentDateTime();
  42     now.setTimeSpec(Qt::UTC);
  43     _nextDayChange.setTimeSpec(Qt::UTC);
  44     _nextDayChange.setMSecsSinceEpoch(
  45                 ((now.toMSecsSinceEpoch() / DAY_IN_MSECS) + 1) * DAY_IN_MSECS);
  46     _nextDayChange.setTimeSpec(Qt::LocalTime);
  47     _dayChangeTimer.setInterval(QDateTime::currentDateTime().secsTo(_nextDayChange) * 1000);
  48     _dayChangeTimer.start();
  49     connect(&_dayChangeTimer, SIGNAL(timeout()), this, SLOT(changeOfDay()));
  50 }
  51
  52
  53 QVariant MessageModel::data(const QModelIndex &index, int role) const
  54 {
  55     int row = index.row(); int column = index.column();
  56     if (row < 0 || row >= messageCount() || column < 0)
  57         return QVariant();
  58
  59     if (role == ColumnTypeRole)
  60         return column;
  61
  62     return messageItemAt(row)->data(index.column(), role);
  63     // return _messageList[row]->data(index.column(), role);
  64 }
  65
  66
  67 bool MessageModel::setData(const QModelIndex &index, const QVariant &value, int role)
  68 {
  69     int row = index.row();
  70     if (row < 0 || row >= messageCount())
  71         return false;
  72
  73     if (messageItemAt(row)->setData(index.column(), value, role)) {
  74         emit dataChanged(index, index);
  75         return true;
  76     }
  77     return false;
  78 }
  79
  80
  81 bool MessageModel::insertMessage(const Message &msg, bool fakeMsg)
  82 {
  83     MsgId id = msg.msgId();
  84     int idx = indexForId(id);
  85     if (!fakeMsg && idx < messageCount()) { // check for duplicate
  86         if (messageItemAt(idx)->msgId() == id)
  87             return false;
  88     }
  89
  90     insertMessageGroup(QList<Message>() << msg);
  91     return true;
  92 }
  93
  94
  95 void MessageModel::insertMessages(const QList<Message> &msglist)
  96 {
  97     if (msglist.isEmpty())
  98         return;
  99
 100     if (_messageBuffer.isEmpty()) {
 101         int processedMsgs = insertMessagesGracefully(msglist);
 102         int remainingMsgs = msglist.count() - processedMsgs;
 103         if (remainingMsgs > 0) {
 104             if (msglist.first().msgId() < msglist.last().msgId()) {
 105                 // in Order - we have just successfully processed "processedMsg" messages from the end of the list
 106                 _messageBuffer = msglist.mid(0, remainingMsgs);
 107             }
 108             else {
 109                 _messageBuffer = msglist.mid(processedMsgs);
 110             }
 111             qSort(_messageBuffer);
 112             QCoreApplication::postEvent(this, new ProcessBufferEvent());
 113         }
 114     }
 115     else {
 116         _messageBuffer << msglist;
 117         qSort(_messageBuffer);
 118     }
 119 }
 120
 121
 122 void MessageModel::insertMessageGroup(const QList<Message> &msglist)
 123 {
 124     Q_ASSERT(!msglist.isEmpty()); // the msglist can be assumed to be non empty
 125 //   int last = msglist.count() - 1;
 126 //   Q_ASSERT(0 == last || msglist.at(0).msgId() != msglist.at(last).msgId() || msglist.at(last).type() == Message::DayChange);
 127     int start = indexForId(msglist.first().msgId());
 128     int end = start + msglist.count() - 1;
 129     Message dayChangeMsg;
 130
 131     if (start > 0) {
 132         // check if the preceeding msg is a daychange message and if so if
 133         // we have to drop or relocate it at the end of this chunk
 134         int prevIdx = start - 1;
 135         if (messageItemAt(prevIdx)->msgType() == Message::DayChange
 136             && messageItemAt(prevIdx)->timestamp() > msglist.at(0).timestamp()) {
 137             beginRemoveRows(QModelIndex(), prevIdx, prevIdx);
 138             Message oldDayChangeMsg = takeMessageAt(prevIdx);
 139             if (msglist.last().timestamp() < oldDayChangeMsg.timestamp()) {
 140                 // we have to reinsert it with a changed msgId
 141                 dayChangeMsg = oldDayChangeMsg;
 142                 dayChangeMsg.setMsgId(msglist.last().msgId());
 143             }
 144             endRemoveRows();
 145
 146             start--;
 147             end--;
 148         }
 149     }
 150
 151     if (!dayChangeMsg.isValid() && start < messageCount()) {
 152         // if(!dayChangeItem && start < _messageList.count()) {
 153         // check if we need to insert a daychange message at the end of the this group
 154
 155         // if this assert triggers then indexForId() would have found a spot right before a DayChangeMsg
 156         // this should never happen as daychange messages share the msgId with the preceeding message
 157         Q_ASSERT(messageItemAt(start)->msgType() != Message::DayChange);
 158         QDateTime nextTs = messageItemAt(start)->timestamp();
 159         QDateTime prevTs = msglist.last().timestamp();
 160         nextTs.setTimeSpec(Qt::UTC);
 161         prevTs.setTimeSpec(Qt::UTC);
 162         qint64 nextDay = nextTs.toMSecsSinceEpoch() / DAY_IN_MSECS;
 163         qint64 prevDay = prevTs.toMSecsSinceEpoch() / DAY_IN_MSECS;
 164         if (nextDay != prevDay) {
 165             nextTs.setMSecsSinceEpoch(nextDay * DAY_IN_MSECS);
 166             nextTs.setTimeSpec(Qt::LocalTime);
 167             dayChangeMsg = Message::ChangeOfDay(nextTs);
 168             dayChangeMsg.setMsgId(msglist.last().msgId());
 169         }
 170     }
 171
 172     if (dayChangeMsg.isValid())
 173         end++;
 174
 175     Q_ASSERT(start == 0 || messageItemAt(start - 1)->msgId() < msglist.first().msgId());
 176     Q_ASSERT(start == messageCount() || messageItemAt(start)->msgId() > msglist.last().msgId());
 177     beginInsertRows(QModelIndex(), start, end);
 178     insertMessages__(start, msglist);
 179     if (dayChangeMsg.isValid())
 180         insertMessage__(start + msglist.count(), dayChangeMsg);
 181     endInsertRows();
 182
 183     Q_ASSERT(start == end || messageItemAt(start)->msgId() != messageItemAt(end)->msgId() || messageItemAt(end)->msgType() == Message::DayChange);
 184     Q_ASSERT(start == 0 || messageItemAt(start - 1)->msgId() < messageItemAt(start)->msgId());
 185     Q_ASSERT(end + 1 == messageCount() || messageItemAt(end)->msgId() < messageItemAt(end + 1)->msgId());
 186 }
 187
 188
 189 int MessageModel::insertMessagesGracefully(const QList<Message> &msglist)
 190 {
 191     /* short description:
 192      * 1) first we check where the message with the highest msgId from msglist would be inserted
 193      * 2) check that position for dupe
 194      * 3) determine the messageId of the preceeding msg
 195      * 4) insert as many msgs from msglist with with msgId larger then the just determined id
 196      *    those messages are automatically less then the msg of the position we just determined in 1)
 197      */
 198     bool inOrder = (msglist.first().msgId() < msglist.last().msgId());
 199     // depending on the order we have to traverse from the front to the back or vice versa
 200
 201     QList<Message> grouplist;
 202     MsgId minId;
 203     MsgId dupeId;
 204     int processedMsgs = 1; // we know the list isn't empty, so we at least process one message
 205     int idx;
 206     bool fastForward = false;
 207     QList<Message>::const_iterator iter;
 208     if (inOrder) {
 209         iter = msglist.constEnd();
 210         --iter; // this op is safe as we've allready passed an empty check
 211     }
 212     else {
 213         iter = msglist.constBegin();
 214     }
 215
 216     idx = indexForId((*iter).msgId());
 217     if (idx < messageCount())
 218         dupeId = messageItemAt(idx)->msgId();
 219
 220     // we always compare to the previous entry...
 221     // if there isn't, we can fastforward to the top
 222     if (idx - 1 >= 0)
 223         minId = messageItemAt(idx - 1)->msgId();
 224     else
 225         fastForward = true;
 226
 227     if ((*iter).msgId() != dupeId) {
 228         grouplist << *iter;
 229         dupeId = (*iter).msgId();
 230     }
 231
 232     if (!inOrder)
 233         ++iter;
 234
 235     if (inOrder) {
 236         while (iter != msglist.constBegin()) {
 237             --iter;
 238
 239             if (!fastForward && (*iter).msgId() <= minId)
 240                 break;
 241             processedMsgs++;
 242
 243             if (grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
 244                 idx = indexForId((*iter).msgId());
 245                 if (idx >= 0 && !messagesIsEmpty())
 246                     dupeId = messageItemAt(idx)->msgId();
 247             }
 248             if ((*iter).msgId() != dupeId) {
 249                 if (!grouplist.isEmpty()) {
 250                     QDateTime nextTs = grouplist.value(0).timestamp();
 251                     QDateTime prevTs = (*iter).timestamp();
 252                     nextTs.setTimeSpec(Qt::UTC);
 253                     prevTs.setTimeSpec(Qt::UTC);
 254                     qint64 nextDay = nextTs.toMSecsSinceEpoch() / DAY_IN_MSECS;
 255                     qint64 prevDay = prevTs.toMSecsSinceEpoch() / DAY_IN_MSECS;
 256                     if (nextDay != prevDay) {
 257                         nextTs.setMSecsSinceEpoch(nextDay * DAY_IN_MSECS);
 258                         nextTs.setTimeSpec(Qt::LocalTime);
 259                         Message dayChangeMsg = Message::ChangeOfDay(nextTs);
 260                         dayChangeMsg.setMsgId((*iter).msgId());
 261                         grouplist.prepend(dayChangeMsg);
 262                     }
 263                 }
 264                 dupeId = (*iter).msgId();
 265                 grouplist.prepend(*iter);
 266             }
 267         }
 268     }
 269     else {
 270         while (iter != msglist.constEnd()) {
 271             if (!fastForward && (*iter).msgId() <= minId)
 272                 break;
 273             processedMsgs++;
 274
 275             if (grouplist.isEmpty()) { // as long as we don't have a starting point, we have to update the dupeId
 276                 idx = indexForId((*iter).msgId());
 277                 if (idx >= 0 && !messagesIsEmpty())
 278                     dupeId = messageItemAt(idx)->msgId();
 279             }
 280             if ((*iter).msgId() != dupeId) {
 281                 if (!grouplist.isEmpty()) {
 282                     QDateTime nextTs = grouplist.value(0).timestamp();
 283                     QDateTime prevTs = (*iter).timestamp();
 284                     nextTs.setTimeSpec(Qt::UTC);
 285                     prevTs.setTimeSpec(Qt::UTC);
 286                     qint64 nextDay = nextTs.toMSecsSinceEpoch() / DAY_IN_MSECS;
 287                     qint64 prevDay = prevTs.toMSecsSinceEpoch() / DAY_IN_MSECS;
 288                     if (nextDay != prevDay) {
 289                         nextTs.setMSecsSinceEpoch(nextDay * DAY_IN_MSECS);
 290                         nextTs.setTimeSpec(Qt::LocalTime);
 291                         Message dayChangeMsg = Message::ChangeOfDay(nextTs);
 292                         dayChangeMsg.setMsgId((*iter).msgId());
 293                         grouplist.prepend(dayChangeMsg);
 294                     }
 295                 }
 296                 dupeId = (*iter).msgId();
 297                 grouplist.prepend(*iter);
 298             }
 299             ++iter;
 300         }
 301     }
 302
 303     if (!grouplist.isEmpty())
 304         insertMessageGroup(grouplist);
 305     return processedMsgs;
 306 }
 307
 308
 309 void MessageModel::customEvent(QEvent *event)
 310 {
 311     if (event->type() != QEvent::User)
 312         return;
 313
 314     event->accept();
 315
 316     if (_messageBuffer.isEmpty())
 317         return;
 318
 319     int processedMsgs = insertMessagesGracefully(_messageBuffer);
 320     int remainingMsgs = _messageBuffer.count() - processedMsgs;
 321
 322     QList<Message>::iterator removeStart = _messageBuffer.begin() + remainingMsgs;
 323     QList<Message>::iterator removeEnd = _messageBuffer.end();
 324     _messageBuffer.erase(removeStart, removeEnd);
 325     if (!_messageBuffer.isEmpty())
 326         QCoreApplication::postEvent(this, new ProcessBufferEvent());
 327 }
 328
 329
 330 void MessageModel::clear()
 331 {
 332     _messagesWaiting.clear();
 333     if (rowCount() > 0) {
 334         beginRemoveRows(QModelIndex(), 0, rowCount() - 1);
 335         removeAllMessages();
 336         endRemoveRows();
 337     }
 338 }
 339
 340
 341 // returns index of msg with given Id or of the next message after that (i.e., the index where we'd insert this msg)
 342 int MessageModel::indexForId(MsgId id)
 343 {
 344     if (messagesIsEmpty() || id <= messageItemAt(0)->msgId())
 345         return 0;
 346
 347     if (id > lastMessageItem()->msgId())
 348         return messageCount();
 349
 350     // binary search
 351     int start = 0; int end = messageCount() - 1;
 352     while (1) {
 353         if (end - start == 1)
 354             return end;
 355         int pivot = (end + start) / 2;
 356         if (id <= messageItemAt(pivot)->msgId()) end = pivot;
 357         else start = pivot;
 358     }
 359 }
 360
 361
 362 void MessageModel::changeOfDay()
 363 {
 364     _dayChangeTimer.setInterval(DAY_IN_MSECS);
 365     if (!messagesIsEmpty()) {
 366         int idx = messageCount();
 367         while (idx > 0 && messageItemAt(idx - 1)->timestamp() > _nextDayChange) {
 368             idx--;
 369         }
 370         beginInsertRows(QModelIndex(), idx, idx);
 371         Message dayChangeMsg = Message::ChangeOfDay(_nextDayChange);
 372         dayChangeMsg.setMsgId(messageItemAt(idx - 1)->msgId());
 373         insertMessage__(idx, dayChangeMsg);
 374         endInsertRows();
 375     }
 376     _nextDayChange = _nextDayChange.addMSecs(DAY_IN_MSECS);
 377 }
 378
 379
 380 void MessageModel::insertErrorMessage(BufferInfo bufferInfo, const QString &errorString)
 381 {
 382     int idx = messageCount();
 383     beginInsertRows(QModelIndex(), idx, idx);
 384     Message msg(bufferInfo, Message::Error, errorString);
 385     if (!messagesIsEmpty())
 386         msg.setMsgId(messageItemAt(idx-1)->msgId());
 387     else
 388         msg.setMsgId(0);
 389     insertMessage__(idx, msg);
 390     endInsertRows();
 391 }
 392
 393
 394 void MessageModel::requestBacklog(BufferId bufferId)
 395 {
 396     if (_messagesWaiting.contains(bufferId))
 397         return;
 398
 399     BacklogSettings backlogSettings;
 400     int requestCount = backlogSettings.dynamicBacklogAmount();
 401
 402     for (int i = 0; i < messageCount(); i++) {
 403         if (messageItemAt(i)->bufferId() == bufferId) {
 404             _messagesWaiting[bufferId] = requestCount;
 405             Client::backlogManager()->emitMessagesRequested(tr("Requesting %1 messages from backlog for buffer %2:%3")
 406                 .arg(requestCount)
 407                 .arg(Client::networkModel()->networkName(bufferId))
 408                 .arg(Client::networkModel()->bufferName(bufferId)));
 409             Client::backlogManager()->requestBacklog(bufferId, -1, messageItemAt(i)->msgId(), requestCount);
 410             return;
 411         }
 412     }
 413 }
 414
 415
 416 void MessageModel::messagesReceived(BufferId bufferId, int count)
 417 {
 418     if (!_messagesWaiting.contains(bufferId))
 419         return;
 420
 421     _messagesWaiting[bufferId] -= count;
 422     if (_messagesWaiting[bufferId] <= 0) {
 423         _messagesWaiting.remove(bufferId);
 424         emit finishedBacklogFetch(bufferId);
 425     }
 426 }
 427
 428
 429 void MessageModel::buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2)
 430 {
 431     for (int i = 0; i < messageCount(); i++) {
 432         if (messageItemAt(i)->bufferId() == bufferId2) {
 433             messageItemAt(i)->setBufferId(bufferId1);
 434             QModelIndex idx = index(i, 0);
 435             emit dataChanged(idx, idx);
 436         }
 437     }
 438 }
 439
 440
 441 // ========================================
 442 //  MessageModelItem
 443 // ========================================
 444 QVariant MessageModelItem::data(int column, int role) const
 445 {
 446     if (column < MessageModel::TimestampColumn || column > MessageModel::ContentsColumn)
 447         return QVariant();
 448
 449     switch (role) {
 450     case MessageModel::MessageRole:
 451         return QVariant::fromValue<Message>(message());
 452     case MessageModel::MsgIdRole:
 453         return QVariant::fromValue<MsgId>(msgId());
 454     case MessageModel::BufferIdRole:
 455         return QVariant::fromValue<BufferId>(bufferId());
 456     case MessageModel::TypeRole:
 457         return msgType();
 458     case MessageModel::FlagsRole:
 459         return (int)msgFlags();
 460     case MessageModel::TimestampRole:
 461         return timestamp();
 462     case MessageModel::RedirectedToRole:
 463         return qVariantFromValue<BufferId>(_redirectedTo);
 464     default:
 465         return QVariant();
 466     }
 467 }
 468
 469
 470 bool MessageModelItem::setData(int column, const QVariant &value, int role)
 471 {
 472     Q_UNUSED(column);
 473
 474     switch (role) {
 475     case MessageModel::RedirectedToRole:
 476         _redirectedTo = value.value<BufferId>();
 477         return true;
 478     default:
 479         return false;
 480     }
 481 }
 482
 483
 484 // Stuff for later
 485 bool MessageModelItem::lessThan(const MessageModelItem *m1, const MessageModelItem *m2)
 486 {
 487     return (*m1) < (*m2);
 488 }
 489
 490
 491 bool MessageModelItem::operator<(const MessageModelItem &other) const
 492 {
 493     return msgId() < other.msgId();
 494 }
 495
 496
 497 bool MessageModelItem::operator==(const MessageModelItem &other) const
 498 {
 499     return msgId() == other.msgId();
 500 }
 501
 502
 503 bool MessageModelItem::operator>(const MessageModelItem &other) const
 504 {
 505     return msgId() > other.msgId();
 506 }
 507
 508
 509 QDebug operator<<(QDebug dbg, const MessageModelItem &msgItem)
 510 {
 511     dbg.nospace() << qPrintable(QString("MessageModelItem(MsgId:")) << msgItem.msgId()
 512     << qPrintable(QString(",")) << msgItem.timestamp()
 513     << qPrintable(QString(", Type:")) << msgItem.msgType()
 514     << qPrintable(QString(", Flags:")) << msgItem.msgFlags() << qPrintable(QString(")"))
 515     << msgItem.data(1, Qt::DisplayRole).toString() << ":" << msgItem.data(2, Qt::DisplayRole).toString();
 516     return dbg;
 517 }