src/client/messagemodel.cpp

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