The WebPreviews are now controlled via a neat state machine
[quassel.git] / src / qtui / chatscene.cpp
index 393058b..c6341ec 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -22,6 +22,7 @@
 #include <QClipboard>
 #include <QDrag>
 #include <QGraphicsSceneMouseEvent>
+#include <QMenu>
 #include <QPersistentModelIndex>
 #include <QWebView>
 
 #include "chatline.h"
 #include "chatlinemodelitem.h"
 #include "chatscene.h"
+#include "chatview.h"
 #include "client.h"
 #include "clientbacklogmanager.h"
 #include "columnhandleitem.h"
+#include "iconloader.h"
 #include "messagefilter.h"
 #include "qtui.h"
 #include "qtuistyle.h"
@@ -45,7 +48,7 @@ ChatScene::ChatScene(QAbstractItemModel *model, const QString &idString, qreal w
     _chatView(parent),
     _idString(idString),
     _model(model),
-    _singleBufferScene(false),
+    _singleBufferId(BufferId()),
     _sceneRect(0, 0, width, 0),
     _firstLineRow(-1),
     _viewportHeight(0),
@@ -58,8 +61,8 @@ ChatScene::ChatScene(QAbstractItemModel *model, const QString &idString, qreal w
     _leftButtonPressed(false)
 {
   MessageFilter *filter = qobject_cast<MessageFilter*>(model);
-  if(filter) {
-    _singleBufferScene = filter->isSingleBufferFilter();
+  if(filter && filter->isSingleBufferFilter()) {
+    _singleBufferId = filter->singleBufferId();
   }
 
   ChatViewSettings defaultSettings;
@@ -94,11 +97,8 @@ ChatScene::ChatScene(QAbstractItemModel *model, const QString &idString, qreal w
     rowsInserted(QModelIndex(), 0, model->rowCount() - 1);
 
 #ifdef HAVE_WEBKIT
-  webPreview.delayTimer.setSingleShot(true);
-  connect(&webPreview.delayTimer, SIGNAL(timeout()), this, SLOT(showWebPreviewEvent()));
-  //webPreview.deleteTimer.setInterval(600000);
-  webPreview.deleteTimer.setInterval(10000);
-  connect(&webPreview.deleteTimer, SIGNAL(timeout()), this, SLOT(deleteWebPreviewEvent()));
+  webPreview.timer.setSingleShot(true);
+  connect(&webPreview.timer, SIGNAL(timeout()), this, SLOT(webPreviewNextStep()));
 #endif
   _showWebPreview = defaultSettings.showWebPreview();
   defaultSettings.notify("ShowWebPreview", this, SLOT(showWebPreviewChanged()));
@@ -549,7 +549,7 @@ bool ChatScene::isPosOverSelection(const QPointF &pos) const {
   if(hasGlobalSelection()) {
     int row = chatItem->row();
     if(row >= qMin(_selectionStart, _selectionEnd) && row <= qMax(_selectionStart, _selectionEnd))
-      return true;
+      return columnByScenePos(pos) >= _selectionMinCol;
   } else {
     return chatItem->isPosOverSelection(chatItem->mapFromScene(pos));
   }
@@ -567,10 +567,36 @@ bool ChatScene::isScrollingAllowed() const {
 
 /******** MOUSE HANDLING **************************************************************************/
 
+void ChatScene::contextMenuEvent(QGraphicsSceneContextMenuEvent *event) {
+  QPointF pos = event->scenePos();
+  QMenu menu;
+
+  // zoom actions and similar
+  chatView()->addActionsToMenu(&menu, pos);
+  menu.addSeparator();
+
+  if(isPosOverSelection(pos))
+    menu.addAction(SmallIcon("edit-copy"), tr("Copy Selection"),
+                    this, SLOT(selectionToClipboard()),
+                    QKeySequence::Copy);
+
+  // item-specific options (select link etc)
+  ChatItem *item = chatItemAt(pos);
+  if(item)
+    item->addActionsToMenu(&menu, item->mapFromScene(pos));
+  else
+    // no item -> default scene actions
+    Client::mainUi()->actionProvider()->addActions(&menu, filter(), BufferId());
+
+  menu.exec(event->screenPos());
+
+}
+
 void ChatScene::mouseMoveEvent(QGraphicsSceneMouseEvent *event) {
   if(event->buttons() == Qt::LeftButton) {
     if(!_clickHandled && (event->scenePos() - _clickPos).toPoint().manhattanLength() >= QApplication::startDragDistance()) {
-      if(_clickTimer.isActive()) _clickTimer.stop();
+      if(_clickTimer.isActive())
+        _clickTimer.stop();
       if(_clickMode == SingleClick && isPosOverSelection(_clickPos))
         initiateDrag(event->widget());
       else {
@@ -583,7 +609,7 @@ void ChatScene::mouseMoveEvent(QGraphicsSceneMouseEvent *event) {
       updateSelection(event->scenePos());
       emit mouseMoveWhileSelecting(event->scenePos());
       event->accept();
-    } else if(_clickHandled)
+    } else if(_clickHandled && _clickMode < DoubleClick)
       QGraphicsScene::mouseMoveEvent(event);
   } else
     QGraphicsScene::mouseMoveEvent(event);
@@ -598,15 +624,19 @@ void ChatScene::mousePressEvent(QGraphicsSceneMouseEvent *event) {
       clearSelection();
     }
     if(_clickMode != NoClick && _clickTimer.isActive()) {
-      _clickMode = (ClickMode)(_clickMode == TripleClick ? DoubleClick : _clickMode + 1);
-      handleClick(Qt::LeftButton, event->scenePos());
+      switch(_clickMode) {
+        case NoClick: _clickMode = SingleClick; break;
+        case SingleClick: _clickMode = DoubleClick; break;
+        case DoubleClick: _clickMode = TripleClick; break;
+        case TripleClick: _clickMode = DoubleClick; break;
+        case DragStartClick: break;
+      }
+      handleClick(Qt::LeftButton, _clickPos);
     } else {
       _clickMode = SingleClick;
       _clickPos = event->scenePos();
     }
     _clickTimer.start();
-  } else if(event->buttons() == Qt::RightButton) {
-    handleClick(Qt::RightButton, event->scenePos());
   }
   if(event->type() == QEvent::GraphicsSceneMouseDoubleClick)
     QGraphicsScene::mouseDoubleClickEvent(event);
@@ -620,7 +650,7 @@ void ChatScene::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event) {
 }
 
 void ChatScene::mouseReleaseEvent(QGraphicsSceneMouseEvent *event) {
-  if(!event->buttons() & Qt::LeftButton) {
+  if(event->button() == Qt::LeftButton && _leftButtonPressed) {
     _leftButtonPressed = false;
     if(_clickMode != NoClick) {
       if(_clickMode == SingleClick)
@@ -631,7 +661,7 @@ void ChatScene::mouseReleaseEvent(QGraphicsSceneMouseEvent *event) {
     } else {
       // no click -> drag or selection move
       if(isGloballySelecting()) {
-        putToClipboard(selection());
+        selectionToClipboard(QClipboard::Selection);
         _isSelecting = false;
         event->accept();
         return;
@@ -656,9 +686,6 @@ void ChatScene::handleClick(Qt::MouseButton button, const QPointF &scenePos) {
       chatItem->handleClick(chatItem->mapFromScene(scenePos), _clickMode);
     }
     _clickHandled = true;
-  } else if(button == Qt::RightButton) {
-    // TODO: context menu
-
   }
 }
 
@@ -673,14 +700,25 @@ void ChatScene::initiateDrag(QWidget *source) {
 
 /******** SELECTIONS ******************************************************************************/
 
-void ChatScene::putToClipboard(const QString &selection) {
-  // TODO Configure clipboards
-#   ifdef Q_WS_X11
-  QApplication::clipboard()->setText(selection, QClipboard::Selection);
-#   endif
-//# else
-  QApplication::clipboard()->setText(selection);
-//# endif
+void ChatScene::selectionToClipboard(QClipboard::Mode mode) {
+  if(!hasSelection())
+    return;
+
+  stringToClipboard(selection(), mode);
+}
+
+void ChatScene::stringToClipboard(const QString &str, QClipboard::Mode mode) {
+  switch(mode) {
+    case QClipboard::Clipboard:
+      QApplication::clipboard()->setText(str);
+      break;
+    case QClipboard::Selection:
+      if(QApplication::clipboard()->supportsSelection())
+        QApplication::clipboard()->setText(str, QClipboard::Selection);
+      break;
+    default:
+      break;
+  };
 }
 
 //!\brief Convert current selection to human-readable string.
@@ -707,6 +745,18 @@ QString ChatScene::selection() const {
   return QString();
 }
 
+bool ChatScene::hasSelection() const {
+  return hasGlobalSelection() || (selectingItem() && selectingItem()->hasSelection());
+}
+
+bool ChatScene::hasGlobalSelection() const {
+  return _selectionStart >= 0;
+}
+
+bool ChatScene::isGloballySelecting() const {
+  return _isSelecting;
+}
+
 void ChatScene::clearGlobalSelection() {
   if(hasGlobalSelection()) {
     for(int l = qMin(_selectionStart, _selectionEnd); l <= qMax(_selectionStart, _selectionEnd); l++)
@@ -731,7 +781,7 @@ void ChatScene::requestBacklog() {
   return;
 }
 
-ChatLineModel::ColumnType ChatScene::columnByScenePos(qreal x) {
+ChatLineModel::ColumnType ChatScene::columnByScenePos(qreal x) const {
   if(x < _firstColHandle->x())
     return ChatLineModel::TimestampColumn;
   if(x < _secondColHandle->x())
@@ -740,7 +790,7 @@ ChatLineModel::ColumnType ChatScene::columnByScenePos(qreal x) {
   return ChatLineModel::ContentsColumn;
 }
 
-int ChatScene::rowByScenePos(qreal y) {
+int ChatScene::rowByScenePos(qreal y) const {
   // This is somewhat hacky... we look at the contents item that is at the given y position, since
   // it has the full height. From this item, we can then determine the row index and hence the ChatLine.
   // ChatItems cover their ChatLine, so we won't get to the latter directly.
@@ -798,82 +848,129 @@ bool ChatScene::event(QEvent *e) {
   return QGraphicsScene::event(e);
 }
 
-/******** WEB PREVIEW *****************************************************************************/
-
+// ========================================
+//  Webkit Only stuff
+// ========================================
+#ifdef HAVE_WEBKIT
 void ChatScene::loadWebPreview(ChatItem *parentItem, const QString &url, const QRectF &urlRect) {
-#ifndef HAVE_WEBKIT
-  Q_UNUSED(parentItem)
-  Q_UNUSED(url)
-  Q_UNUSED(urlRect)
-#else
   if(!_showWebPreview)
     return;
 
+  if(webPreview.urlRect != urlRect)
+    webPreview.urlRect = urlRect;
+
   if(webPreview.parentItem != parentItem)
     webPreview.parentItem = parentItem;
 
   if(webPreview.url != url) {
     webPreview.url = url;
-    // load a new web view and delete the old one (if exists)
+    // prepare to load a different URL
     if(webPreview.previewItem && webPreview.previewItem->scene()) {
       removeItem(webPreview.previewItem);
       delete webPreview.previewItem;
+      webPreview.previewItem = 0;
     }
-    webPreview.previewItem = new WebPreviewItem(url);
-    webPreview.delayTimer.start(2000);
-    webPreview.deleteTimer.stop();
-  } else if(webPreview.previewItem && !webPreview.previewItem->scene()) {
-      // we just have to readd the item to the scene
-      webPreview.delayTimer.start(2000);
-      webPreview.deleteTimer.stop();
-  }
-  if(webPreview.urlRect != urlRect) {
-    webPreview.urlRect = urlRect;
-    qreal previewY = urlRect.bottom();
-    qreal previewX = urlRect.x();
-    if(previewY + webPreview.previewItem->boundingRect().height() > sceneRect().bottom())
-      previewY = urlRect.y() - webPreview.previewItem->boundingRect().height();
-
-    if(previewX + webPreview.previewItem->boundingRect().width() > sceneRect().width())
-      previewX = sceneRect().right() - webPreview.previewItem->boundingRect().width();
-
-    webPreview.previewItem->setPos(previewX, previewY);
+    webPreview.previewState = WebPreview::NoPreview;
   }
-#endif
-}
 
-void ChatScene::showWebPreviewEvent() {
-#ifdef HAVE_WEBKIT
-  if(webPreview.previewItem)
-    addItem(webPreview.previewItem);
-#endif
-}
+  if(webPreview.url.isEmpty())
+    return;
 
-void ChatScene::clearWebPreview(ChatItem *parentItem) {
-#ifndef HAVE_WEBKIT
-  Q_UNUSED(parentItem)
-#else
-  if(parentItem == 0 || webPreview.parentItem == parentItem) {
-    if(webPreview.previewItem && webPreview.previewItem->scene()) {
+  // qDebug() << Q_FUNC_INFO << webPreview.previewState;
+  switch(webPreview.previewState) {
+  case WebPreview::NoPreview:
+    webPreview.previewState = WebPreview::NewPreview;
+    webPreview.timer.start(500);
+    break;
+  case WebPreview::NewPreview:
+  case WebPreview::DelayPreview:
+  case WebPreview::ShowPreview:
+    // we're already waiting for the next step or showing the preview
+    break;
+  case WebPreview::HidePreview:
+    // we still have a valid preview
+    webPreview.previewState = WebPreview::DelayPreview;
+    webPreview.timer.start(1000);
+    break;
+  }
+  // qDebug() << "  new State:" << webPreview.previewState << webPreview.timer.isActive();
+}
+
+void ChatScene::webPreviewNextStep() {
+  // qDebug() << Q_FUNC_INFO << webPreview.previewState;
+  switch(webPreview.previewState) {
+  case WebPreview::NoPreview:
+    break;
+  case WebPreview::NewPreview:
+    Q_ASSERT(!webPreview.previewItem);
+    webPreview.previewItem = new WebPreviewItem(webPreview.url);
+    webPreview.previewState = WebPreview::DelayPreview;
+    webPreview.timer.start(1000);
+    break;
+  case WebPreview::DelayPreview:
+    Q_ASSERT(webPreview.previewItem);
+    // calc position and show
+    {
+      qreal previewY = webPreview.urlRect.bottom();
+      qreal previewX = webPreview.urlRect.x();
+      if(previewY + webPreview.previewItem->boundingRect().height() > sceneRect().bottom())
+       previewY = webPreview.urlRect.y() - webPreview.previewItem->boundingRect().height();
+
+      if(previewX + webPreview.previewItem->boundingRect().width() > sceneRect().width())
+       previewX = sceneRect().right() - webPreview.previewItem->boundingRect().width();
+
+      webPreview.previewItem->setPos(previewX, previewY);
+    }
+    addItem(webPreview.previewItem);
+    webPreview.previewState = WebPreview::ShowPreview;
+    break;
+  case WebPreview::ShowPreview:
+    qWarning() << "ChatScene::webPreviewNextStep() called while in ShowPreview Step!";
+    qWarning() << "removing preview";
+    if(webPreview.previewItem && webPreview.previewItem->scene())
       removeItem(webPreview.previewItem);
-      webPreview.deleteTimer.start();
+    // Fall through to deletion!
+  case WebPreview::HidePreview:
+    if(webPreview.previewItem) {
+      delete webPreview.previewItem;
+      webPreview.previewItem = 0;
     }
-    webPreview.delayTimer.stop();
+    webPreview.parentItem = 0;
+    webPreview.url = QString();
+    webPreview.urlRect = QRectF();
+    webPreview.previewState = WebPreview::NoPreview;
   }
-#endif
+  // qDebug() << "  new State:" << webPreview.previewState << webPreview.timer.isActive();
 }
 
-void ChatScene::deleteWebPreviewEvent() {
-#ifdef HAVE_WEBKIT
-  if(webPreview.previewItem) {
-    delete webPreview.previewItem;
-    webPreview.previewItem = 0;
-  }
-  webPreview.parentItem = 0;
-  webPreview.url = QString();
-  webPreview.urlRect = QRectF();
-#endif
+void ChatScene::clearWebPreview(ChatItem *parentItem) {
+  // qDebug() << Q_FUNC_INFO << webPreview.previewState;
+  switch(webPreview.previewState) {
+  case WebPreview::NewPreview:
+    webPreview.previewState = WebPreview::NoPreview; // we haven't loaded anything yet
+    break;
+  case WebPreview::ShowPreview:
+    if(parentItem == 0 || webPreview.parentItem == parentItem) {
+      if(webPreview.previewItem && webPreview.previewItem->scene())
+       removeItem(webPreview.previewItem);
+    }
+    // fall through into to set hidden state
+  case WebPreview::DelayPreview:
+    // we're just loading, so haven't shown the preview yet.
+    webPreview.previewState = WebPreview::HidePreview;
+    webPreview.timer.start(5000);
+    break;
+  case WebPreview::NoPreview:
+  case WebPreview::HidePreview:
+    break;
+  }
+  // qDebug() << "  new State:" << webPreview.previewState << webPreview.timer.isActive();
 }
+#endif
+
+// ========================================
+//  end of webkit only
+// ========================================
 
 void ChatScene::showWebPreviewChanged() {
   ChatViewSettings settings;