Add read support for m.file messages (#24)

CMakeLists.txt

@@ -149,6 +149,7 @@ set(SRC_FILES
     src/EmojiPanel.cc
     src/EmojiPickButton.cc
     src/EmojiProvider.cc
+    src/FileItem.cc
     src/ImageItem.cc
     src/ImageOverlayDialog.cc
     src/InputValidator.cc
@@ -243,6 +244,7 @@ qt5_wrap_cpp(MOC_HEADERS
     include/EmojiPanel.h
     include/EmojiPickButton.h
     include/ui/FloatingButton.h
+    include/FileItem.h
     include/ImageItem.h
     include/ImageOverlayDialog.h
     include/JoinRoomDialog.h

include/FileItem.h

@@ -0,0 +1,97 @@
+/*
+ * nheko Copyright (C) 2017  Konstantinos Sideris <siderisk@auth.gr>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <QEvent>
+#include <QIcon>
+#include <QMouseEvent>
+#include <QSharedPointer>
+#include <QWidget>
+
+#include "File.h"
+#include "MatrixClient.h"
+#include "MessageEvent.h"
+
+namespace events = matrix::events;
+namespace msgs   = matrix::events::messages;
+
+constexpr int MaxWidth           = 400;
+constexpr int Height             = 70;
+constexpr int IconRadius         = 22;
+constexpr int IconDiameter       = IconRadius * 2;
+constexpr int HorizontalPadding  = 12;
+constexpr int TextPadding        = 15;
+constexpr int DownloadIconRadius = IconRadius - 4;
+
+constexpr double VerticalPadding = Height - 2 * IconRadius;
+constexpr double IconYCenter     = Height / 2;
+constexpr double IconXCenter     = HorizontalPadding + IconRadius;
+
+class FileItem : public QWidget
+{
+        Q_OBJECT
+
+        Q_PROPERTY(QColor textColor WRITE setTextColor READ textColor)
+        Q_PROPERTY(QColor iconColor WRITE setIconColor READ iconColor)
+        Q_PROPERTY(QColor backgroundColor WRITE setBackgroundColor READ backgroundColor)
+
+public:
+        FileItem(QSharedPointer<MatrixClient> client,
+                 const events::MessageEvent<msgs::File> &event,
+                 QWidget *parent = nullptr);
+
+        FileItem(QSharedPointer<MatrixClient> client,
+                 const QString &url,
+                 const QString &filename,
+                 QWidget *parent = nullptr);
+
+        QSize sizeHint() const override;
+
+        void setTextColor(const QColor &color) { textColor_ = color; }
+        void setIconColor(const QColor &color) { iconColor_ = color; }
+        void setBackgroundColor(const QColor &color) { backgroundColor_ = color; }
+
+        QColor textColor() const { return textColor_; }
+        QColor iconColor() const { return iconColor_; }
+        QColor backgroundColor() const { return backgroundColor_; }
+
+protected:
+        void paintEvent(QPaintEvent *event) override;
+        void mousePressEvent(QMouseEvent *event) override;
+
+private slots:
+        void fileDownloaded(const QString &event_id, const QByteArray &data);
+
+private:
+        QString calculateFileSize(int nbytes) const;
+        void openUrl();
+
+        QUrl url_;
+        QString text_;
+        QString readableFileSize_;
+        QString filenameToSave_;
+
+        events::MessageEvent<msgs::File> event_;
+        QSharedPointer<MatrixClient> client_;
+
+        QIcon icon_;
+
+        QColor textColor_       = QColor("white");
+        QColor iconColor_       = QColor("#38A3D8");
+        QColor backgroundColor_ = QColor("#333");
+};

include/MatrixClient.h

@@ -53,6 +53,7 @@ public:
         void fetchUserAvatar(const QString &userId, const QUrl &avatarUrl);
         void fetchOwnAvatar(const QUrl &avatar_url);
         void downloadImage(const QString &event_id, const QUrl &url);
+        void downloadFile(const QString &event_id, const QUrl &url);
         void messages(const QString &room_id, const QString &from_token, int limit = 30) noexcept;
         void uploadImage(const QString &roomid, const QString &filename);
         void joinRoom(const QString &roomIdOrAlias);
@@ -96,6 +97,7 @@ signals:
         void userAvatarRetrieved(const QString &userId, const QImage &img);
         void ownAvatarRetrieved(const QPixmap &img);
         void imageDownloaded(const QString &event_id, const QPixmap &img);
+        void fileDownloaded(const QString &event_id, const QByteArray &data);
 
         // Returned profile data for the user's account.
         void getOwnProfileResponse(const QUrl &avatar_url, const QString &display_name);

include/TimelineItem.h

@@ -24,6 +24,7 @@
 #include <QStyleOption>
 
 #include "Emote.h"
+#include "File.h"
 #include "Image.h"
 #include "MessageEvent.h"
 #include "Notice.h"
@@ -31,6 +32,7 @@
 #include "Text.h"
 
 class ImageItem;
+class FileItem;
 class Avatar;
 
 namespace events = matrix::events;
@@ -64,6 +66,10 @@ public:
                      const events::MessageEvent<msgs::Image> &e,
                      bool with_sender,
                      QWidget *parent);
+        TimelineItem(FileItem *file,
+                     const events::MessageEvent<msgs::File> &e,
+                     bool with_sender,
+                     QWidget *parent);
 
         void setUserAvatar(const QImage &pixmap);
         DescInfo descriptionMessage() const { return descriptionMsg_; }

include/TimelineView.h

@@ -25,6 +25,7 @@
 #include <QStyleOption>
 
 #include "Emote.h"
+#include "File.h"
 #include "Image.h"
 #include "MessageEvent.h"
 #include "Notice.h"
@@ -95,6 +96,8 @@ public:
                                          bool with_sender);
         TimelineItem *createTimelineItem(const events::MessageEvent<msgs::Emote> &e,
                                          bool with_sender);
+        TimelineItem *createTimelineItem(const events::MessageEvent<msgs::File> &e,
+                                         bool with_sender);
 
         // Add new events at the end of the timeline.
         int addEvents(const Timeline &timeline);

resources/res.qrc

@@ -24,6 +24,8 @@
         <file>icons/ui/angle-pointing-to-left@2x.png</file>
         <file>icons/ui/angle-arrow-down.png</file>
         <file>icons/ui/angle-arrow-down@2x.png</file>
+        <file>icons/ui/arrow-pointing-down.png</file>
+        <file>icons/ui/arrow-pointing-down@2x.png</file>
 
         <file>icons/emoji-categories/people.png</file>
         <file>icons/emoji-categories/people@2x.png</file>

resources/styles/nheko-dark.qss

@@ -22,6 +22,12 @@ FlatButton {
     qproperty-backgroundColor: #333;
 }
 
+FileItem {
+    qproperty-textColor: #caccd1;
+    qproperty-backgroundColor: #414A59;
+    qproperty-iconColor: #caccd1;
+}
+
 RaisedButton {
     qproperty-foregroundColor: #caccd1;
     qproperty-backgroundColor: #333;

resources/styles/nheko.qss

@@ -21,6 +21,12 @@ FlatButton {
     qproperty-foregroundColor: #333;
 }
 
+FileItem {
+    qproperty-textColor: #333;
+    qproperty-backgroundColor: #f2f2f2;
+    qproperty-iconColor: white;
+}
+
 RaisedButton {
     qproperty-foregroundColor: white;
 }

resources/styles/system.qss

@@ -19,6 +19,12 @@ FlatButton {
     qproperty-foregroundColor: palette(text);
 }
 
+FileItem {
+    qproperty-textColor: palette(text);
+    qproperty-backgroundColor: palette(base);
+    qproperty-iconColor: palette(window);
+}
+
 RaisedButton {
     qproperty-foregroundColor: palette(light);
 }

src/FileItem.cc

@@ -0,0 +1,220 @@
+/*
+ * nheko Copyright (C) 2017  Konstantinos Sideris <siderisk@auth.gr>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <QBrush>
+#include <QDebug>
+#include <QDesktopServices>
+#include <QFile>
+#include <QFileDialog>
+#include <QFileInfo>
+#include <QPainter>
+#include <QPixmap>
+
+#include "FileItem.h"
+#include "ImageOverlayDialog.h"
+
+namespace events = matrix::events;
+namespace msgs   = matrix::events::messages;
+
+FileItem::FileItem(QSharedPointer<MatrixClient> client,
+                   const events::MessageEvent<msgs::File> &event,
+                   QWidget *parent)
+  : QWidget(parent)
+  , event_{event}
+  , client_{client}
+{
+        setMouseTracking(true);
+        setCursor(Qt::PointingHandCursor);
+        setAttribute(Qt::WA_Hover, true);
+
+        url_              = event.msgContent().url();
+        text_             = event.content().body();
+        readableFileSize_ = calculateFileSize(event.msgContent().info().size);
+
+        icon_.addFile(":/icons/icons/ui/arrow-pointing-down.png");
+
+        QList<QString> url_parts = url_.toString().split("mxc://");
+
+        if (url_parts.size() != 2) {
+                qDebug() << "Invalid format for image" << url_.toString();
+                return;
+        }
+
+        QString media_params = url_parts[1];
+        url_                 = QString("%1/_matrix/media/r0/download/%2")
+                 .arg(client_.data()->getHomeServer().toString(), media_params);
+
+        connect(client_.data(), &MatrixClient::fileDownloaded, this, &FileItem::fileDownloaded);
+}
+
+FileItem::FileItem(QSharedPointer<MatrixClient> client,
+                   const QString &url,
+                   const QString &filename,
+                   QWidget *parent)
+  : QWidget(parent)
+  , url_{url}
+  , text_{QFileInfo(filename).fileName()}
+  , client_{client}
+{
+        setMouseTracking(true);
+        setCursor(Qt::PointingHandCursor);
+        setAttribute(Qt::WA_Hover, true);
+
+        // TODO: calculateFileSize
+        /* readableFileSize_ = calculateFileSize(event.msgContent().info().size); */
+
+        QList<QString> url_parts = url_.toString().split("mxc://");
+
+        icon_.addFile(":/icons/icons/ui/arrow-pointing-down.png");
+
+        if (url_parts.size() != 2) {
+                qDebug() << "Invalid format for image" << url_.toString();
+                return;
+        }
+
+        QString media_params = url_parts[1];
+        url_                 = QString("%1/_matrix/media/r0/download/%2")
+                 .arg(client_.data()->getHomeServer().toString(), media_params);
+}
+
+QString
+FileItem::calculateFileSize(int nbytes) const
+{
+        if (nbytes < 1024)
+                return QString("%1 B").arg(nbytes);
+
+        if (nbytes < 1024 * 1024)
+                return QString("%1 KB").arg(nbytes / 1024);
+
+        return QString("%1 MB").arg(nbytes / 1024 / 1024);
+}
+
+void
+FileItem::openUrl()
+{
+        if (url_.toString().isEmpty())
+                return;
+
+        if (!QDesktopServices::openUrl(url_))
+                qWarning() << "Could not open url" << url_.toString();
+}
+
+QSize
+FileItem::sizeHint() const
+{
+        return QSize(MaxWidth, Height);
+}
+
+void
+FileItem::mousePressEvent(QMouseEvent *event)
+{
+        if (event->button() != Qt::LeftButton)
+                return;
+
+        auto point = event->pos();
+
+        // Click on the download icon.
+        if (QRect(HorizontalPadding, VerticalPadding / 2, IconDiameter, IconDiameter)
+              .contains(point)) {
+                filenameToSave_ = QFileDialog::getSaveFileName(this, tr("Save File"), text_);
+
+                if (filenameToSave_.isEmpty())
+                        return;
+
+                client_->downloadFile(event_.eventId(), url_);
+        } else {
+                openUrl();
+        }
+}
+
+void
+FileItem::fileDownloaded(const QString &event_id, const QByteArray &data)
+{
+        if (event_id != event_.eventId())
+                return;
+
+        try {
+                QFile file(filenameToSave_);
+
+                if (!file.open(QIODevice::WriteOnly))
+                        return;
+
+                file.write(data);
+                file.close();
+        } catch (const std::exception &ex) {
+                qDebug() << "Error while saving file to:" << ex.what();
+        }
+}
+
+void
+FileItem::paintEvent(QPaintEvent *event)
+{
+        Q_UNUSED(event);
+
+        QPainter painter(this);
+        painter.setRenderHint(QPainter::Antialiasing);
+
+        QFont font("Open Sans");
+        font.setPixelSize(12);
+        font.setWeight(80);
+
+        QFontMetrics fm(font);
+
+        int computedWidth = std::min(
+          fm.width(text_) + 2 * IconRadius + VerticalPadding * 2 + TextPadding, (double)MaxWidth);
+
+        QPainterPath path;
+        path.addRoundedRect(QRectF(0, 0, computedWidth, Height), 10, 10);
+
+        painter.setPen(Qt::NoPen);
+        painter.fillPath(path, backgroundColor_);
+        painter.drawPath(path);
+
+        QPainterPath circle;
+        circle.addEllipse(QPoint(IconXCenter, IconYCenter), IconRadius, IconRadius);
+
+        painter.setPen(Qt::NoPen);
+        painter.fillPath(circle, iconColor_);
+        painter.drawPath(circle);
+
+        icon_.paint(&painter,
+                    QRect(IconXCenter - DownloadIconRadius / 2,
+                          IconYCenter - DownloadIconRadius / 2,
+                          DownloadIconRadius,
+                          DownloadIconRadius),
+                    Qt::AlignCenter,
+                    QIcon::Normal);
+
+        const int textStartX = HorizontalPadding + 2 * IconRadius + TextPadding;
+        const int textStartY = VerticalPadding + fm.ascent() / 2;
+
+        // Draw the filename.
+        QString elidedText =
+          fm.elidedText(text_,
+                        Qt::ElideRight,
+                        computedWidth - HorizontalPadding * 2 - TextPadding - 2 * IconRadius);
+
+        painter.setFont(font);
+        painter.setPen(QPen(textColor_));
+        painter.drawText(QPoint(textStartX, textStartY), elidedText);
+
+        // Draw the filesize.
+        font.setWeight(50);
+        painter.setFont(font);
+        painter.setPen(QPen(textColor_));
+        painter.drawText(QPoint(textStartX, textStartY + 1.5 * fm.ascent()), readableFileSize_);
+}

src/MatrixClient.cc

@@ -586,6 +586,32 @@ MatrixClient::downloadImage(const QString &event_id, const QUrl &url)
         });
 }
 
+void
+MatrixClient::downloadFile(const QString &event_id, const QUrl &url)
+{
+        QNetworkRequest fileRequest(url);
+
+        auto reply = get(fileRequest);
+        connect(reply, &QNetworkReply::finished, this, [this, reply, event_id]() {
+                reply->deleteLater();
+
+                int status = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt();
+
+                if (status == 0 || status >= 400) {
+                        // TODO: Handle error
+                        qWarning() << reply->errorString();
+                        return;
+                }
+
+                auto data = reply->readAll();
+
+                if (data.size() == 0)
+                        return;
+
+                emit fileDownloaded(event_id, data);
+        });
+}
+
 void
 MatrixClient::fetchOwnAvatar(const QUrl &avatar_url)
 {

src/TimelineItem.cc

@@ -24,6 +24,7 @@
 #include "Avatar.h"
 #include "AvatarProvider.h"
 #include "Config.h"
+#include "FileItem.h"
 #include "ImageItem.h"
 #include "Sync.h"
 #include "TimelineItem.h"
@@ -186,6 +187,46 @@ TimelineItem::TimelineItem(ImageItem *image,
         mainLayout_->addLayout(imageLayout);
 }
 
+TimelineItem::TimelineItem(FileItem *file,
+                           const events::MessageEvent<msgs::File> &event,
+                           bool with_sender,
+                           QWidget *parent)
+  : QWidget(parent)
+{
+        init();
+
+        event_id_ = event.eventId();
+
+        auto timestamp   = QDateTime::fromMSecsSinceEpoch(event.timestamp());
+        auto displayName = TimelineViewManager::displayName(event.sender());
+
+        QSettings settings;
+        descriptionMsg_ = {event.sender() == settings.value("auth/user_id") ? "You" : displayName,
+                           event.sender(),
+                           " sent a file",
+                           descriptiveTime(QDateTime::fromMSecsSinceEpoch(event.timestamp()))};
+
+        generateTimestamp(timestamp);
+
+        auto fileLayout = new QHBoxLayout();
+        fileLayout->setContentsMargins(0, 5, 0, 0);
+        fileLayout->addWidget(file);
+        fileLayout->addStretch(1);
+
+        if (with_sender) {
+                generateBody(displayName, "");
+                setupAvatarLayout(displayName);
+
+                mainLayout_->addLayout(headerLayout_);
+
+                AvatarProvider::resolve(event.sender(), this);
+        } else {
+                setupSimpleLayout();
+        }
+
+        mainLayout_->addLayout(fileLayout);
+}
+
 /*
  * Used to display remote notice messages.
  */

src/TimelineView.cc

@@ -21,6 +21,7 @@
 #include <QSettings>
 #include <QTimer>
 
+#include "FileItem.h"
 #include "FloatingButton.h"
 #include "ImageItem.h"
 #include "RoomMessages.h"
@@ -331,6 +332,34 @@ TimelineView::parseMessageEvent(const QJsonObject &event, TimelineDirection dire
                         updateLastSender(emote.sender(), direction);
 
                         return createTimelineItem(emote, with_sender);
+                } else if (msg_type == events::MessageEventType::File) {
+                        events::MessageEvent<msgs::File> file;
+
+                        try {
+                                file.deserialize(event);
+                        } catch (const DeserializationException &e) {
+                                qWarning() << e.what() << event;
+                                return nullptr;
+                        }
+
+                        if (isDuplicate(file.eventId()))
+                                return nullptr;
+
+                        eventIds_[file.eventId()] = true;
+
+                        QString txnid = file.unsignedData().transactionId();
+
+                        if (!txnid.isEmpty() &&
+                            isPendingMessage(txnid, file.sender(), local_user_)) {
+                                removePendingMessage(txnid);
+                                return nullptr;
+                        }
+
+                        auto withSender = isSenderRendered(file.sender(), direction);
+
+                        updateLastSender(file.sender(), direction);
+
+                        return createTimelineItem(file, withSender);
                 } else if (msg_type == events::MessageEventType::Unknown) {
                         // TODO Handle redacted messages.
                         // Silenced for now.
@@ -469,6 +498,15 @@ TimelineView::createTimelineItem(const events::MessageEvent<msgs::Image> &event,
         return item;
 }
 
+TimelineItem *
+TimelineView::createTimelineItem(const events::MessageEvent<msgs::File> &event, bool withSender)
+{
+        auto file = new FileItem(client_, event);
+        auto item = new TimelineItem(file, event, withSender, scroll_widget_);
+
+        return item;
+}
+
 TimelineItem *
 TimelineView::createTimelineItem(const events::MessageEvent<msgs::Notice> &event, bool with_sender)
 {

src/events/messages/File.cc

@@ -25,13 +25,11 @@ File::deserialize(const QJsonObject &object)
         if (!object.contains("url"))
                 throw DeserializationException("messages::File url key is missing");
 
-        if (!object.contains("filename"))
-                throw DeserializationException("messages::File filename key is missing");
-
         if (object.value("msgtype") != "m.file")
                 throw DeserializationException("invalid msgtype for file");
 
-        url_ = object.value("url").toString();
+        url_      = object.value("url").toString();
+        filename_ = object.value("filename").toString();
 
         if (object.contains("info")) {
                 auto file_info = object.value("info").toObject();