giving the chatscene more control over the webpreview thus making it less crashy
[quassel.git] / src / qtui / chatitem.cpp
index c2f2425..df093d7 100644 (file)
 #include "chatitem.h"
 #include "chatlinemodel.h"
 #include "qtui.h"
+#include "qtuistyle.h"
 
-ChatItem::ChatItem(int col, QAbstractItemModel *model, QGraphicsItem *parent)
+ChatItem::ChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent)
   : QGraphicsItem(parent),
-    _fontMetrics(0),
-    _col(col),
-    _lines(0),
-    _layoutData(0),
+    _data(0),
+    _boundingRect(0, 0, width, height),
     _selectionMode(NoSelection),
     _selectionStart(-1)
 {
-  Q_ASSERT(model);
-  QModelIndex index = model->index(row(), col);
-  _fontMetrics = QtUi::style()->fontMetrics(model->data(index, ChatLineModel::FormatRole).value<UiStyle::FormatList>().at(0).second);
   setAcceptHoverEvents(true);
   setZValue(20);
+  setPos(pos);
 }
 
 ChatItem::~ChatItem() {
-  delete _layoutData;
+  delete _data;
 }
 
 QVariant ChatItem::data(int role) const {
@@ -60,26 +57,6 @@ QVariant ChatItem::data(int role) const {
   return model()->data(index, role);
 }
 
-qreal ChatItem::setGeometry(qreal w, qreal h) {
-  if(w == _boundingRect.width()) return _boundingRect.height();
-  prepareGeometryChange();
-  _boundingRect.setWidth(w);
-  if(h < 0) h = computeHeight();
-  _boundingRect.setHeight(h);
-  if(haveLayout()) updateLayout();
-  return h;
-}
-
-qreal ChatItem::computeHeight() {
-  if(data(ChatLineModel::ColumnTypeRole).toUInt() != ChatLineModel::ContentsColumn)
-    return fontMetrics()->lineSpacing(); // only contents can be multi-line
-
-  _lines = 1;
-  WrapColumnFinder finder(this);
-  while(finder.nextWrapColumn() > 0) _lines++;
-  return _lines * fontMetrics()->lineSpacing();
-}
-
 QTextLayout *ChatItem::createLayout(QTextOption::WrapMode wrapMode, Qt::Alignment alignment) {
   QTextLayout *layout = new QTextLayout(data(MessageModel::DisplayRole).toString());
 
@@ -94,72 +71,38 @@ QTextLayout *ChatItem::createLayout(QTextOption::WrapMode wrapMode, Qt::Alignmen
   return layout;
 }
 
-void ChatItem::setLayout(QTextLayout *layout) {
-  if(!_layoutData)
-    _layoutData = new LayoutData;
-  _layoutData->layout = layout;
-}
-
 void ChatItem::updateLayout() {
-  switch(data(ChatLineModel::ColumnTypeRole).toUInt()) {
-    case ChatLineModel::TimestampColumn:
-      if(!haveLayout()) setLayout(createLayout(QTextOption::WrapAnywhere, Qt::AlignLeft));
-      // fallthrough
-    case ChatLineModel::SenderColumn:
-      if(!haveLayout()) setLayout(createLayout(QTextOption::WrapAnywhere, Qt::AlignRight));
-      layout()->beginLayout();
-      {
-        QTextLine line = layout()->createLine();
-        if(line.isValid()) {
-          line.setLineWidth(width());
-          line.setPosition(QPointF(0,0));
-        }
-        layout()->endLayout();
-      }
-      break;
-    case ChatLineModel::ContentsColumn: {
-      if(!haveLayout()) setLayout(createLayout(QTextOption::WrapAnywhere));
-
-      // Now layout
-      ChatLineModel::WrapList wrapList = data(ChatLineModel::WrapListRole).value<ChatLineModel::WrapList>();
-      if(!wrapList.count()) return; // empty chatitem
-
-      qreal h = 0;
-      WrapColumnFinder finder(this);
-      layout()->beginLayout();
-      forever {
-        QTextLine line = layout()->createLine();
-        if(!line.isValid())
-          break;
-
-        int col = finder.nextWrapColumn();
-        line.setNumColumns(col >= 0 ? col - line.textStart() : layout()->text().length());
-        line.setPosition(QPointF(0, h));
-        h += line.height() + fontMetrics()->leading();
-      }
-      layout()->endLayout();
-    }
-    break;
+  if(!privateData()) {
+    setPrivateData(new ChatItemPrivate(createLayout()));
   }
+  QTextLayout *layout_ = layout();
+  layout_->beginLayout();
+  QTextLine line = layout_->createLine();
+  if(line.isValid()) {
+    line.setLineWidth(width());
+    line.setPosition(QPointF(0,0));
+  }
+  layout_->endLayout();
 }
 
-void ChatItem::clearLayoutData() {
-  delete _layoutData;
-  _layoutData = 0;
+void ChatItem::clearLayout() {
+  delete _data;
+  _data = 0;
 }
 
 // NOTE: This is not the most time-efficient implementation, but it saves space by not caching unnecessary data
 //       This is a deliberate trade-off. (-> selectFmt creation, data() call)
 void ChatItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) {
   Q_UNUSED(option); Q_UNUSED(widget);
-  if(!haveLayout()) updateLayout();
+  if(!hasLayout())
+    updateLayout();
   painter->setClipRect(boundingRect()); // no idea why QGraphicsItem clipping won't work
   //if(_selectionMode == FullSelection) {
     //painter->save();
     //painter->fillRect(boundingRect(), QApplication::palette().brush(QPalette::Highlight));
     //painter->restore();
   //}
-  QVector<QTextLayout::FormatRange> formats;
+  QVector<QTextLayout::FormatRange> formats = additionalFormats();
   if(_selectionMode != NoSelection) {
     QTextLayout::FormatRange selectFmt;
     selectFmt.format.setForeground(QApplication::palette().brush(QPalette::HighlightedText));
@@ -174,12 +117,29 @@ void ChatItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
     formats.append(selectFmt);
   }
   layout()->draw(painter, QPointF(0,0), formats, boundingRect());
+
+  // Debuging Stuff
+  // uncomment the following lines to draw the bounding rect and the row number in alternating colors
+//   if(row() % 2)
+//     painter->setPen(Qt::red);
+//   else
+//     painter->setPen(Qt::blue);
+//   QString rowString = QString::number(row());
+//   QRect rowRect = painter->fontMetrics().boundingRect(rowString);
+//   QPointF topPoint = _boundingRect.topLeft();
+//   topPoint.ry() += rowRect.height();
+//   painter->drawText(topPoint, rowString);
+//   QPointF bottomPoint = _boundingRect.bottomRight();
+//   bottomPoint.rx() -= rowRect.width();
+//   painter->drawText(bottomPoint, rowString);
+//   painter->drawRect(_boundingRect.adjusted(0, 0, -1, -1));
 }
 
 qint16 ChatItem::posToCursor(const QPointF &pos) {
   if(pos.y() > height()) return data(MessageModel::DisplayRole).toString().length();
   if(pos.y() < 0) return 0;
-  if(!haveLayout()) updateLayout();
+  if(!hasLayout())
+    updateLayout();
   for(int l = layout()->lineCount() - 1; l >= 0; l--) {
     QTextLine line = layout()->lineAt(l);
     if(pos.y() >= line.y()) {
@@ -197,10 +157,8 @@ void ChatItem::setFullSelection() {
 }
 
 void ChatItem::clearSelection() {
-  if(_selectionMode != NoSelection) {
-    _selectionMode = NoSelection;
-    update();
-  }
+  _selectionMode = NoSelection;
+  update();
 }
 
 void ChatItem::continueSelecting(const QPointF &pos) {
@@ -223,32 +181,30 @@ QList<QRectF> ChatItem::findWords(const QString &searchWord, Qt::CaseSensitivity
     searchIdx = plainText.indexOf(searchWord, searchIdx + 1, caseSensitive);
   }
 
-  if(!haveLayout())
+  bool hadLayout = hasLayout();
+  if(!hadLayout)
     updateLayout();
 
   foreach(int idx, indexList) {
     QTextLine line = layout()->lineForTextPosition(idx);
     qreal x = line.cursorToX(idx);
     qreal width = line.cursorToX(idx + searchWord.count()) - x;
-    qreal height = fontMetrics()->lineSpacing();
+    qreal height = line.height();
     qreal y = height * line.lineNumber();
     resultList << QRectF(x, y, width, height);
   }
+
+  if(!hadLayout)
+    clearLayout();
   return resultList;
 }
 
-
 void ChatItem::mousePressEvent(QGraphicsSceneMouseEvent *event) {
   if(event->buttons() == Qt::LeftButton) {
-    if(_selectionMode == NoSelection) {
-      chatScene()->setSelectingItem(this);  // removes earlier selection if exists
-      _selectionStart = _selectionEnd = posToCursor(event->pos());
-      //_selectionMode = PartialSelection;
-    } else {
-      chatScene()->setSelectingItem(0);
-      _selectionMode = NoSelection;
-      update();
-    }
+    chatScene()->setSelectingItem(this);
+    _selectionStart = _selectionEnd = posToCursor(event->pos());
+    _selectionMode = NoSelection; // will be set to PartialSelection by mouseMoveEvent
+    update();
     event->accept();
   } else {
     event->ignore();
@@ -261,8 +217,7 @@ void ChatItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event) {
       qint16 end = posToCursor(event->pos());
       if(end != _selectionEnd) {
         _selectionEnd = end;
-        if(_selectionStart != _selectionEnd) _selectionMode = PartialSelection;
-        else _selectionMode = NoSelection;
+        _selectionMode = (_selectionStart != _selectionEnd ? PartialSelection : NoSelection);
         update();
       }
     } else {
@@ -287,84 +242,307 @@ void ChatItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event) {
   }
 }
 
-void ChatItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event) {
-  // FIXME dirty and fast hack to make http:// urls klickable
+// ************************************************************
+// SenderChatItem
+// ************************************************************
+
+// ************************************************************
+// ContentsChatItem
+// ************************************************************
+ContentsChatItem::ContentsChatItem(const qreal &width, const QPointF &pos, QGraphicsItem *parent)
+  : ChatItem(0, 0, pos, parent)
+{
+  const QAbstractItemModel *model_ = model();
+  QModelIndex index = model_->index(row(), column());
+  _fontMetrics = QtUi::style()->fontMetrics(model_->data(index, ChatLineModel::FormatRole).value<UiStyle::FormatList>().at(0).second);
+
+  setGeometryByWidth(width);
+}
+
+qreal ContentsChatItem::setGeometryByWidth(qreal w) {
+  if(w != width()) {
+    setWidth(w);
+    // compute height
+    int lines = 1;
+    WrapColumnFinder finder(this);
+    while(finder.nextWrapColumn() > 0)
+      lines++;
+    setHeight(lines * fontMetrics()->lineSpacing());
+  }
+  return height();
+}
+
+void ContentsChatItem::updateLayout() {
+  if(!privateData()) {
+    ContentsChatItemPrivate *data = new ContentsChatItemPrivate(createLayout(QTextOption::WrapAnywhere), findClickables(), this);
+    setPrivateData(data);
+  }
+
+  // Now layout
+  ChatLineModel::WrapList wrapList = data(ChatLineModel::WrapListRole).value<ChatLineModel::WrapList>();
+  if(!wrapList.count()) return; // empty chatitem
+
+  qreal h = 0;
+  WrapColumnFinder finder(this);
+  layout()->beginLayout();
+  forever {
+    QTextLine line = layout()->createLine();
+    if(!line.isValid())
+      break;
+
+    int col = finder.nextWrapColumn();
+    line.setNumColumns(col >= 0 ? col - line.textStart() : layout()->text().length());
+    line.setPosition(QPointF(0, h));
+    h += fontMetrics()->lineSpacing();
+  }
+  layout()->endLayout();
+}
+
+// NOTE: This method is not threadsafe and not reentrant!
+//       (RegExps are not constant while matching, and they are static here for efficiency)
+QList<ContentsChatItem::Clickable> ContentsChatItem::findClickables() {
+  // For matching URLs
+  static QString urlEnd("(?:>|[,.;:\"]*\\s|\\b|$)");
+  static QString urlChars("(?:[\\w\\-~@/?&=+$()!%#]|[,.;:]\\w)");
+
+  static QRegExp regExp[] = {
+    // URL
+    // QRegExp(QString("((?:https?://|s?ftp://|irc://|mailto:|www\\.)%1+|%1+\\.[a-z]{2,4}(?:?=/%1+|\\b))%2").arg(urlChars, urlEnd)),
+    QRegExp(QString("((?:(?:https?://|s?ftp://|irc://|mailto:)|www)%1+)%2").arg(urlChars, urlEnd)),
+
+    // Channel name
+    // We don't match for channel names starting with + or &, because that gives us a lot of false positives.
+    QRegExp("((?:#|![A-Z0-9]{5})[^,:\\s]+(?::[^,:\\s]+)?)\\b")
+
+    // TODO: Nicks, we'll need a filtering for only matching known nicknames further down if we do this
+  };
+
+  static const int regExpCount = 2;  // number of regexps in the array above
+
+  qint16 matches[] = { 0, 0, 0 };
+  qint16 matchEnd[] = { 0, 0, 0 };
 
-  QRegExp regex("\\b([hf]t{1,2}ps?://[^\\s]+)\\b");
   QString str = data(ChatLineModel::DisplayRole).toString();
-  int idx = posToCursor(event->pos());
-  int mi = 0;
+
+  QList<Clickable> result;
+  qint16 idx = 0;
+  qint16 minidx;
+  int type = -1;
+
   do {
-    mi = regex.indexIn(str, mi);
-    if(mi < 0) break;
-    if(idx >= mi && idx < mi + regex.matchedLength()) {
-      QDesktopServices::openUrl(QUrl(regex.capturedTexts()[1]));
-      break;
+    type = -1;
+    minidx = str.length();
+    for(int i = 0; i < regExpCount; i++) {
+      if(matches[i] < 0 || matchEnd[i] > str.length()) continue;
+      if(idx >= matchEnd[i]) {
+        matches[i] = str.indexOf(regExp[i], qMax(matchEnd[i], idx));
+        if(matches[i] >= 0) matchEnd[i] = matches[i] + regExp[i].cap(1).length();
+      }
+      if(matches[i] >= 0 && matches[i] < minidx) {
+        minidx = matches[i];
+        type = i;
+      }
     }
-    mi += regex.matchedLength();
-  } while(mi >= 0);
-  event->accept();
+    if(type >= 0) {
+      idx = matchEnd[type];
+      if(type == Clickable::Url && str.at(idx-1) == ')') {  // special case: closing paren only matches if we had an open one
+        if(!str.mid(matches[type], matchEnd[type]-matches[type]).contains('(')) matchEnd[type]--;
+      }
+      result.append(Clickable((Clickable::Type)type, matches[type], matchEnd[type] - matches[type]));
+    }
+  } while(type >= 0);
+
+  /* testing
+  if(!result.isEmpty()) qDebug() << str;
+  foreach(Clickable click, result) {
+    qDebug() << str.mid(click.start, click.length);
+  }
+  */
+  return result;
 }
 
-void ChatItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event) {
-  //qDebug() << (void*)this << "entering";
-  event->ignore();
+QVector<QTextLayout::FormatRange> ContentsChatItem::additionalFormats() const {
+  // mark a clickable if hovered upon
+  QVector<QTextLayout::FormatRange> fmt;
+  if(privateData()->currentClickable.isValid()) {
+    Clickable click = privateData()->currentClickable;
+    QTextLayout::FormatRange f;
+    f.start = click.start;
+    f.length = click.length;
+    f.format.setFontUnderline(true);
+    fmt.append(f);
+  }
+  return fmt;
 }
 
-void ChatItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event) {
-  //qDebug() << (void*)this << "leaving";
-  event->ignore();
+void ContentsChatItem::endHoverMode() {
+  if(hasLayout()) {
+    if(privateData()->currentClickable.isValid()) {
+      setCursor(Qt::ArrowCursor);
+      privateData()->currentClickable = Clickable();
+    }
+    clearWebPreview();
+    update();
+  }
 }
 
-void ChatItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event) {
-  //qDebug() << (void*)this << event->pos();
-  event->ignore();
+void ContentsChatItem::mousePressEvent(QGraphicsSceneMouseEvent *event) {
+  privateData()->hasDragged = false;
+  ChatItem::mousePressEvent(event);
 }
 
+void ContentsChatItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event) {
+  if(!event->buttons() && !privateData()->hasDragged) {
+    // got a click
+    Clickable click = privateData()->currentClickable;
+    if(click.isValid()) {
+      QString str = data(ChatLineModel::DisplayRole).toString().mid(click.start, click.length);
+      switch(click.type) {
+        case Clickable::Url:
+         if(!str.contains("://"))
+           str = "http://" + str;
+          QDesktopServices::openUrl(str);
+          break;
+        case Clickable::Channel:
+          // TODO join or whatever...
+          break;
+        default:
+          break;
+      }
+    }
+  }
+  ChatItem::mouseReleaseEvent(event);
+}
+
+void ContentsChatItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event) {
+  // mouse move events always mean we're not hovering anymore...
+  endHoverMode();
+  // also, check if we have dragged the mouse
+  if(hasLayout() && !privateData()->hasDragged && event->buttons() & Qt::LeftButton
+    && (event->buttonDownScreenPos(Qt::LeftButton) - event->screenPos()).manhattanLength() >= QApplication::startDragDistance())
+    privateData()->hasDragged = true;
+  ChatItem::mouseMoveEvent(event);
+}
+
+void ContentsChatItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event) {
+  endHoverMode();
+  event->accept();
+}
+
+void ContentsChatItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event) {
+  bool onClickable = false;
+  qint16 idx = posToCursor(event->pos());
+  for(int i = 0; i < privateData()->clickables.count(); i++) {
+    Clickable click = privateData()->clickables.at(i);
+    if(idx >= click.start && idx < click.start + click.length) {
+      if(click.type == Clickable::Url) {
+        onClickable = true;
+       showWebPreview(click);
+      } else if(click.type == Clickable::Channel) {
+        // TODO: don't make clickable if it's our own name
+        //onClickable = true; //FIXME disabled for now
+      }
+      if(onClickable) {
+        setCursor(Qt::PointingHandCursor);
+        privateData()->currentClickable = click;
+        update();
+        break;
+      }
+    }
+  }
+  if(!onClickable) endHoverMode();
+  event->accept();
+}
+
+void ContentsChatItem::showWebPreview(const Clickable &click) {
+#ifdef HAVE_WEBKIT
+  if(!hasLayout())
+    updateLayout();
+
+  QTextLine line = layout()->lineForTextPosition(click.start);
+  qreal x = line.cursorToX(click.start);
+  qreal width = line.cursorToX(click.start + click.length) - x;
+  qreal height = line.height();
+  qreal y = height * line.lineNumber();
+
+  QPointF topLeft = scenePos() + QPointF(x, y);
+  QRectF urlRect = QRectF(topLeft.x(), topLeft.y(), width, height);
+
+  QString url = data(ChatLineModel::DisplayRole).toString().mid(click.start, click.length);
+  if(!url.contains("://"))
+    url = "http://" + url;
+  chatScene()->loadWebPreview(this, url, urlRect);
+#endif
+}
+
+void ContentsChatItem::clearWebPreview() {
+#ifdef HAVE_WEBKIT
+  chatScene()->clearWebPreview(this);
+#endif
+}
 
 /*************************************************************************************************/
 
-ChatItem::WrapColumnFinder::WrapColumnFinder(ChatItem *_item) : item(_item) {
-  wrapList = item->data(ChatLineModel::WrapListRole).value<ChatLineModel::WrapList>();
-  wordidx = 0;
-  layout = 0;
-  lastwrapcol = 0;
-  lastwrappos = 0;
-  w = 0;
+ContentsChatItem::WrapColumnFinder::WrapColumnFinder(ChatItem *_item)
+  : item(_item),
+    layout(0),
+    wrapList(item->data(ChatLineModel::WrapListRole).value<ChatLineModel::WrapList>()),
+    wordidx(0),
+    lineCount(0),
+    choppedTrailing(0)
+{
 }
 
-ChatItem::WrapColumnFinder::~WrapColumnFinder() {
+ContentsChatItem::WrapColumnFinder::~WrapColumnFinder() {
   delete layout;
 }
 
-qint16 ChatItem::WrapColumnFinder::nextWrapColumn() {
-  while(wordidx < wrapList.count()) {
-    w += wrapList.at(wordidx).width;
-    if(w >= item->width()) {
-      if(lastwrapcol >= wrapList.at(wordidx).start) {
-        // first word, and it doesn't fit
-        if(!line.isValid()) {
-          layout = item->createLayout(QTextOption::NoWrap);
-          layout->beginLayout();
-          line = layout->createLine();
-          line.setLineWidth(item->width());
-          layout->endLayout();
-        }
-        int idx = line.xToCursor(lastwrappos + item->width(), QTextLine::CursorOnCharacter);
-        qreal x = line.cursorToX(idx, QTextLine::Trailing);
-        w = w - wrapList.at(wordidx).width - (x - lastwrappos);
-        lastwrappos = x;
-        lastwrapcol = idx;
-        return idx;
-      }
-      // not the first word, so just wrap before this
-      lastwrapcol = wrapList.at(wordidx).start;
-      lastwrappos = lastwrappos + w - wrapList.at(wordidx).width;
-      w = 0;
-      return lastwrapcol;
+qint16 ContentsChatItem::WrapColumnFinder::nextWrapColumn() {
+  if(wordidx >= wrapList.count())
+    return -1;
+
+  lineCount++;
+  qreal targetWidth = lineCount * item->width() + choppedTrailing;
+
+  qint16 start = wordidx;
+  qint16 end = wrapList.count() - 1;
+
+  // check if the whole line fits
+  if(wrapList.at(end).endX <= targetWidth) //  || start == end)
+    return -1;
+
+  // check if we have a very long word that needs inter word wrap
+  if(wrapList.at(start).endX > targetWidth) {
+    if(!line.isValid()) {
+      layout = item->createLayout(QTextOption::NoWrap);
+      layout->beginLayout();
+      line = layout->createLine();
+      layout->endLayout();
     }
-    w += wrapList.at(wordidx).trailing;
-    wordidx++;
+    return line.xToCursor(targetWidth, QTextLine::CursorOnCharacter);
   }
+
+  while(true) {
+    if(start + 1 == end) {
+      wordidx = end;
+      const ChatLineModel::Word &lastWord = wrapList.at(start); // the last word we were able to squeeze in
+
+      // both cases should be cought preliminary
+      Q_ASSERT(lastWord.endX <= targetWidth); // ensure that "start" really fits in
+      Q_ASSERT(end < wrapList.count()); // ensure that start isn't the last word
+
+      choppedTrailing += lastWord.trailing - (targetWidth - lastWord.endX);
+      return wrapList.at(wordidx).start;
+    }
+
+    qint16 pivot = (end + start) / 2;
+    if(wrapList.at(pivot).endX > targetWidth) {
+      end = pivot;
+    } else {
+      start = pivot;
+    }
+  }
+  Q_ASSERT(false);
   return -1;
 }
+