Merge lp:~libqtelegram-team/telegram-app/app-dev-cpp-push-helper into lp:telegram-app/app-dev

[Michał Karnicki]

Rewrote push helper in C++.

Add 'grouping' of notifications (no counter in notification of grouped messages yet).
Add clearing counter / notifications when logging out.

Requires lib: lp:~libqtelegram-team/libqtelegram/dev-cpp-push-helper
https://code.launchpad.net/~libqtelegram-team/libqtelegram/app-dev-cpp-push-helper/+merge/250608

Tested:
- reading msg on PC and opening Tg clears counter/notifications
- opening Tg and reading msg on PC clears counter/notifications
- opening chat clears counter
- most of incoming push notification types listed in pushhelper.cpp

[Michał Karnicki (karni)]

Roberto, any idea why I need to use line 101 instead of 97 (which doesn't work)?

[Roberto Mier Escandon (rmescandon)]

helper should manage CHAT_MESSAGE_NOTEXT push received message from telegram servers (see https://core.telegram.org/api/push-updates)

review: Needs Fixing

[Giulio Collura (gcollura)]

As discussed extensively on IRC, this is working and looking fine. Thanks karni!

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2015-02-23 15:00:09 +0000
+++ .bzrignore	2015-02-24 16:42:37 +0000
@@ -2,6 +2,7 @@
 click
 *.click
 library
+push
 push.py
 config.h
 manifest.json

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-02-03 19:03:00 +0000
+++ CMakeLists.txt	2015-02-24 16:42:37 +0000
@@ -190,9 +190,35 @@
     QML_JS_TARGET ALL SOURCES ${QML_JS_FILES}
 )
 
+add_custom_target(
+    "_project_files" ALL SOURCES
+
+    "manifest.json.in"
+    "apparmor-telegram.json"
+    "push.json"
+    "apparmor-push.json"
+    "content-hub.json"
+    "telegram.desktop.in.in"
+
+    "config.h.in"
+    "push.cpp"
+    "pushhelper.h"
+    "pushhelper.cpp"
+    "pushclient.h"
+    "pushclient.cpp"
+
+    "push.py"
+    "countries.py"
+
+    "HACKING.md"
+    "README.md"
+    "README.translations"
+    "LICENSE"
+)
+
 configure_file(
     config.h.in
-    ${CMAKE_CURRENT_BINARY_DIR}/config.h @ONL
+    ${CMAKE_CURRENT_BINARY_DIR}/config.h @ONLY
 )
 
 set(telegram_app_SRCS
@@ -218,3 +244,14 @@
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
 )
 
+add_executable(push
+    push.cpp
+    pushhelper.cpp
+    pushclient.cpp
+)
+qt5_use_modules(push
+    Core
+    DBus
+)
+install(PROGRAMS ${CMAKE_CURRENT_BINARY_DIR}/push
+        DESTINATION ${CMAKE_INSTALL_BINDIR})

=== modified file 'config.h.in'
--- config.h.in	2014-11-03 09:57:18 +0000
+++ config.h.in	2015-02-24 16:42:37 +0000
@@ -1,2 +1,1 @@
-
 #define TELEGRAM_VERSION "@APP_VERSION@"

=== added file 'push.cpp'
--- push.cpp	1970-01-01 00:00:00 +0000
+++ push.cpp	2015-02-24 16:42:37 +0000
@@ -0,0 +1,25 @@
+#include <QCoreApplication>
+#include <QStringList>
+#include <QTimer>
+
+#include "pushhelper.h"
+
+int main(int argc, char *argv[]) {
+    if (argc != 3) {
+        qFatal("Usage: %s infile outfile", argv[0]);
+    }
+
+    QCoreApplication app(argc, argv);
+    QStringList args = app.arguments();
+
+    PushHelper pushHelper("com.ubuntu.telegram_telegram",
+                          QString(args.at(1)), QString(args.at(2)), &app);
+
+//    QObject::connect(&pushHelper, SIGNAL(done()), &app, SLOT(quit()));
+    pushHelper.process();
+
+    // TODO check why I need this and the connect above doesn't work.
+    QTimer::singleShot(500, &app, SLOT(quit()));
+
+    return app.exec();
+}

=== modified file 'push.json'
--- push.json	2014-09-02 21:51:24 +0000
+++ push.json	2015-02-24 16:42:37 +0000
@@ -1,4 +1,4 @@
 {
-    "exec": "push.py",
+    "exec": "push",
     "app_id": "com.ubuntu.telegram_telegram"
 }

=== added file 'pushclient.cpp'
--- pushclient.cpp	1970-01-01 00:00:00 +0000
+++ pushclient.cpp	2015-02-24 16:42:37 +0000
@@ -0,0 +1,113 @@
+/*
+Copyright 2014 Canonical Ltd.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License, version 3
+as published by the Free Software Foundation.
+
+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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this program.  If not, see
+<http://www.gnu.org/licenses/>.
+*/
+
+#include "pushclient.h"
+#include <QtDBus/QDBusConnection>
+#include <QtDBus/QDBusMessage>
+#include <QtDBus/QDBusPendingCall>
+#include <QtDBus/QDBusPendingReply>
+#include <QTimer>
+
+#define PUSH_SERVICE "com.ubuntu.PushNotifications"
+#define POSTAL_SERVICE "com.ubuntu.Postal"
+#define PUSH_PATH "/com/ubuntu/PushNotifications"
+#define POSTAL_PATH "/com/ubuntu/Postal"
+#define PUSH_IFACE "com.ubuntu.PushNotifications"
+#define POSTAL_IFACE "com.ubuntu.Postal"
+
+PushClient::PushClient(QObject *parent) : QObject(parent) {
+}
+
+void PushClient::registerApp(const QString &appId) {
+    pkgname = appId.split("_").at(0);
+    pkgname = pkgname.replace(".","_2e").replace("-","_2d");
+    Q_EMIT appIdChanged(appId);
+}
+
+QString PushClient::getAppId() {
+    return appId;
+}
+
+QString PushClient::getToken() {
+    return token;
+}
+
+void PushClient::emitError() {
+    Q_EMIT error(status);
+}
+
+void PushClient::clearPersistent(const QStringList &tags) {
+    QDBusConnection bus = QDBusConnection::sessionBus();
+    QString path(POSTAL_PATH);
+    path += "/" + pkgname;
+    QDBusMessage message = QDBusMessage::createMethodCall(
+                POSTAL_SERVICE, path, POSTAL_IFACE, "ClearPersistent");
+    message << this->appId;
+    for (int i = 0; i < tags.size(); ++i) {
+		message << tags.at(i);
+	}
+    bus.send(message);
+
+    QDBusPendingCall pcall = bus.asyncCall(message);
+    QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(pcall, this);
+    connect(watcher, SIGNAL(finished(QDBusPendingCallWatcher*)),
+                  this, SLOT(clearPersistentFinished(QDBusPendingCallWatcher*)));
+}
+
+void PushClient::clearPersistentFinished(QDBusPendingCallWatcher *watcher) {
+    QDBusPendingReply<void> reply = *watcher;
+
+    if (reply.isError()) {
+        Q_EMIT error(reply.error().message());
+    } else {
+        Q_EMIT persistentCleared();
+    }
+    watcher->deleteLater();
+}
+
+void PushClient::setCount(int count) {
+    QDBusConnection bus = QDBusConnection::sessionBus();
+    QString path(POSTAL_PATH);
+    bool visible = count != 0;
+    counter = count;
+    path += "/" + pkgname;
+    QDBusMessage message = QDBusMessage::createMethodCall(POSTAL_SERVICE, path, POSTAL_IFACE, "setCounter");
+    message << this->appId << count << visible;
+    QDBusPendingCall pcall = bus.asyncCall(message);
+    QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(pcall, this);
+    connect(watcher, SIGNAL(finished(QDBusPendingCallWatcher*)),
+                  this, SLOT(setCounterFinished(QDBusPendingCallWatcher*)));
+}
+
+void PushClient::setCounterFinished(QDBusPendingCallWatcher *watcher) {
+    QDBusPendingReply<void> reply = *watcher;
+    if (reply.isError()) {
+        Q_EMIT error(reply.error().message());
+    }
+    else {
+        Q_EMIT countChanged(counter);
+    }
+    watcher->deleteLater();
+}
+
+int PushClient::getCount() {
+    return counter;
+}
+
+void PushClient::setAppId(const QString &appId) {
+    this->appId = appId;
+}

=== added file 'pushclient.h'
--- pushclient.h	1970-01-01 00:00:00 +0000
+++ pushclient.h	2015-02-24 16:42:37 +0000
@@ -0,0 +1,76 @@
+/*
+Copyright 2014 Canonical Ltd.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License, version 3
+as published by the Free Software Foundation.
+
+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 Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this program.  If not, see
+<http://www.gnu.org/licenses/>.
+*/
+
+#ifndef PUSHCLIENT_H
+#define PUSHCLIENT_H
+
+#include <QObject>
+#include <QString>
+#include <QStringList>
+
+class QDBusPendingCallWatcher;
+
+class PushClient : public QObject {
+    Q_OBJECT
+
+public:
+    explicit PushClient(QObject *parent = 0);
+
+    QString getAppId();
+    void setAppId(const QString &appId);
+    QString getToken();
+    QString getStatus() { return this->status; }
+    int getCount();
+    void setCount(int count);
+
+    void registerApp(const QString &appid);
+
+    Q_PROPERTY(QString appId WRITE setAppId READ getAppId NOTIFY appIdChanged);
+    Q_PROPERTY(QString token READ getToken NOTIFY tokenChanged);
+    Q_PROPERTY(QStringList notifications NOTIFY notificationsChanged);
+    Q_PROPERTY(QString status READ getStatus NOTIFY statusChanged);
+    Q_PROPERTY(int count READ getCount WRITE setCount NOTIFY countChanged)
+
+signals:
+    void appIdChanged(const QString &appId);
+    void tokenChanged(const QString &token);
+    void statusChanged(const QString &status);
+    void countChanged(int count);
+    void notificationsChanged(const QStringList &notifications);
+    void persistentChanged(const QStringList &tags);
+    void persistentCleared();
+
+    void error(const QString &error);
+
+public slots:
+    void emitError();
+    void clearPersistent(const QStringList &tags);
+
+private slots:
+    void setCounterFinished(QDBusPendingCallWatcher *watcher);
+    void clearPersistentFinished(QDBusPendingCallWatcher *watcher);
+
+private:
+    QString appId;
+    QString pkgname;
+    QString token;
+    QString status;
+    QStringList notifications;
+    int counter;
+};
+
+#endif // PUSHCLIENT_H

=== added file 'pushhelper.cpp'
--- pushhelper.cpp	1970-01-01 00:00:00 +0000
+++ pushhelper.cpp	2015-02-24 16:42:37 +0000
@@ -0,0 +1,290 @@
+#include <QDebug>
+#include <QFile>
+#include <QJsonDocument>
+#include <QJsonArray>
+#include <QStringList>
+#include <QTextStream>
+
+#include "pushhelper.h"
+
+PushHelper::PushHelper(QString appId, QString infile, QString outfile,
+                       QObject *parent) : QObject(parent) {
+    connect(&mPushClient, SIGNAL(persistentCleared()),
+                    this, SLOT(notificationDismissed()));
+
+    mPushClient.setAppId(appId);
+    mPushClient.registerApp(appId);
+    mInfile = infile;
+    mOutfile = outfile;
+}
+
+PushHelper::~PushHelper() {
+}
+
+void PushHelper::process() {
+    QString tag = "";
+
+    QJsonObject pushMessage = readPushMessage(mInfile);
+    mPostalMessage = pushToPostalMessage(pushMessage, tag);
+    if (!tag.isEmpty()) {
+        dismissNotification(tag);
+    }
+}
+
+void PushHelper::notificationDismissed() {
+    writePostalMessage(mPostalMessage, mOutfile);
+    Q_EMIT done();
+}
+
+QJsonObject PushHelper::readPushMessage(const QString &filename) {
+    QFile file(filename);
+    file.open(QIODevice::ReadOnly | QIODevice::Text);
+
+    QString val = file.readAll();
+    file.close();
+    return QJsonDocument::fromJson(val.toUtf8()).object();
+}
+
+void PushHelper::writePostalMessage(const QJsonObject &postalMessage, const QString &filename) {
+    QFile out;
+    out.setFileName(filename);
+    out.open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate);
+
+    QTextStream(&out) << QJsonDocument(postalMessage).toJson();
+    out.close();
+}
+
+QJsonObject PushHelper::pushToPostalMessage(const QJsonObject &push, QString &tag) {
+    QString summary = "";
+    QString body = "";
+    qint32 count = 0;
+
+    QJsonObject message = push["message"].toObject();
+    QJsonObject custom = message["custom"].toObject();
+
+    QString key = "";
+    if (message.keys().contains("loc_key")) {
+        key = message["loc_key"].toString();
+    }
+    QJsonArray args;
+    if (message.keys().contains("loc_args")) {
+        args = message["loc_args"].toArray();
+    }
+
+    QString chatId = "0"; // More useful as string in this context.
+    if (custom.keys().contains("from_id")) {
+        chatId = custom["from_id"].toString();
+    }
+    if (custom.keys().contains("chat_id")) {
+        chatId = custom["chat_id"].toString();
+    }
+
+    QString tg = QString("Telegram");
+    summary = args[0].toString();
+
+    if (key == "MESSAGE_TEXT") {
+
+        body = args[1].toString();
+
+    } else if (key == "MESSAGE_NOTEXT") {
+
+        body = "sent you a message";
+
+    } else if (key == "MESSAGE_PHOTO") {
+
+        body = "sent you a photo";
+
+    } else if (key == "MESSAGE_VIDEO") {
+
+        body = "sent you a video";
+
+    } else if (key == "MESSAGE_DOC") {
+
+        body = "sent you a document";
+
+    } else if (key == "MESSAGE_AUDIO") {
+
+        body = "sent you a voice message";
+
+    } else if (key == "MESSAGE_CONTACT") {
+
+        body = "shared a contact with you";
+
+    } else if (key == "MESSAGE_GEO") {
+
+        body = "sent you a map";
+
+    } else if (key == "CHAT_MESSAGE_TEXT") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + ": " + args[2].toString();
+
+    } else if (key == "CHAT_MESSAGE_NOTEXT") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a message to the group";
+
+    } else if (key == "CHAT_MESSAGE_PHOTO") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a photo to the group";
+
+    } else if (key == "CHAT_MESSAGE_VIDEO") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a video to the group";
+
+    } else if (key == "CHAT_MESSAGE_DOC") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a document to the group";
+
+    } else if (key == "CHAT_MESSAGE_AUDIO") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a voice message to the group";
+
+    } else if (key == "CHAT_MESSAGE_CONTACT") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a contact to the group";
+
+    } else if (key == "CHAT_MESSAGE_GEO") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " sent a map to the group";
+
+    } else if (key == "CHAT_CREATED") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " invited you to the group";
+
+    } else if (key == "CHAT_TITLE_EDITED") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " changed group name";
+
+    } else if (key == "CHAT_PHOTO_EDITED") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " changed group photo";
+
+    } else if (key == "CHAT_ADD_MEMBER") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " invited " + args[2].toString();
+
+    } else if (key == "CHAT_ADD_YOU") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " invited you to the group";
+
+    } else if (key == "CHAT_DELETE_MEMBER") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " kicked " + args[2].toString();
+
+    } else if (key == "CHAT_DELETE_YOU") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " kicked you from the group";
+
+    } else if (key == "CHAT_LEFT") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " has left the group";
+
+    } else if (key == "CHAT_RETURNED") {
+
+        summary = args[1].toString();
+        body = args[0].toString() + " has returned to the group";
+
+    } else if (key == "GEOCHAT_CHECKIN") {
+
+        summary = "@ " + args[1].toString();
+        body = args[0].toString() + " has checked-in";
+
+    } else if (key == "CONTACT_JOINED") {
+
+        summary = tg;
+        body = args[0].toString() + " joined Telegram!";
+
+    } else if (key == "AUTH_UNKNOWN") {
+
+        summary = args[0].toString();
+        body = "New login from unrecognized device";
+
+    } else if (key == "AUTH_REGION") {
+
+        summary = args[0].toString() + " @ " + args[1].toString();
+        body = "New login from unrecognized device";
+
+    } else if (key == "CONTACT_PHOTO") {
+
+        body = "updated profile photo";
+
+    } else if (key == "ENCRYPTION_REQUEST") {
+
+        summary = tg;
+        body = "You have a new message";
+
+    } else if (key == "ENCRYPTION_ACCEPT") {
+
+        summary = tg;
+        body = "You have a new message";
+
+    } else if (key == "ENCRYPTED_MESSAGE") {
+
+        summary = tg;
+        body = "You have a new message";
+
+    } else {
+        qDebug() << "Unhandled push type: " << key;
+        return QJsonObject();
+    }
+
+    QJsonArray actions = QJsonArray();
+    QString actionUri = QString("telegram://chat/%1").arg(chatId);
+    actions.append(actionUri);
+
+    if (message.keys().contains("badge")) {
+        count = message["badge"].toInt();
+    } else if (push.keys().contains("notification")) {
+        // Legacy. Notification section is only used to retrieve the unread count.
+        count = push["notification"]
+                .toObject()["emblem-counter"]
+                .toObject()["count"]
+                .toInt();
+    }
+
+    tag = chatId;
+
+    QJsonObject card;
+    card["summary"] = summary;
+    card["body"]    = body;
+    card["actions"] = actions;
+    card["popup"]   = true;             // TODO make setting
+    card["persist"] = true;             // TODO make setting
+
+    QJsonObject emblem;
+    emblem["count"] = count;
+    emblem["visible"] = count > 0;
+
+    QJsonObject notification;
+    notification["tag"] = tag;
+    notification["card"] = card;
+    notification["emblem-counter"] = emblem;
+    notification["sound"] = true;       // TODO make setting
+    notification["vibrate"] = true;     // TODO make setting
+
+    QJsonObject postalMessage = QJsonObject();
+    postalMessage["notification"] = notification;
+
+    return postalMessage;
+}
+
+void PushHelper::dismissNotification(const QString &tag) {
+    QStringList tags;
+    tags << tag;
+    mPushClient.clearPersistent(tags);
+}

=== added file 'pushhelper.h'
--- pushhelper.h	1970-01-01 00:00:00 +0000
+++ pushhelper.h	2015-02-24 16:42:37 +0000
@@ -0,0 +1,41 @@
+#ifndef PUSH_HELPER_H
+#define PUSH_HELPER_H
+
+#include <QObject>
+#include <QString>
+#include <QJsonObject>
+
+#include "pushclient.h"
+
+/**
+ * See: https://core.telegram.org/api/push-updates
+ */
+class PushHelper : public QObject {
+    Q_OBJECT
+
+public:
+    PushHelper(QString appId, QString infile, QString outfile, QObject *parent = 0);
+    ~PushHelper();
+    void process();
+
+Q_SIGNALS:
+    void done();
+
+public Q_SLOTS:
+    void notificationDismissed();
+
+protected:
+    QJsonObject readPushMessage(const QString &filename);
+    void writePostalMessage(const QJsonObject &postalMessage, const QString &filename);
+    QJsonObject pushToPostalMessage(const QJsonObject &push, QString &tag);
+    void dismissNotification(const QString &tag);
+
+private:
+    PushClient mPushClient;
+    QString mInfile;
+    QString mOutfile;
+
+    QJsonObject mPostalMessage;
+};
+
+#endif

=== added file 'scripts/pushlog.sh'
--- scripts/pushlog.sh	1970-01-01 00:00:00 +0000
+++ scripts/pushlog.sh	2015-02-24 16:42:37 +0000
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+adb shell "tail -f /home/phablet/.cache/upstart/ubuntu-push-client.log"

=== removed directory 'src.moved'
=== removed file 'src.moved/_sctelegram.ini'
--- src.moved/_sctelegram.ini	2014-11-21 19:07:32 +0000
+++ src.moved/_sctelegram.ini	1970-01-01 00:00:00 +0000
@@ -1,8 +0,0 @@
-[ScopeConfig]
-DisplayName=Telegram
-Description=This is a Telegram scope
-Author=Victor Palau
-Art=contacts.Art
-Icon=./tasks.png
-SearchHint=search for a message
-HotKey=tasks.HotKey

=== modified file 'telegram.qml'
--- telegram.qml	2015-02-23 19:56:40 +0000
+++ telegram.qml	2015-02-24 16:42:37 +0000
@@ -573,6 +573,9 @@
                     showIntro = false;
                 }
 
+                pushClient.count = 0;
+                pushClient.clearPersistent([]);
+
                 logoutResetSession(showIntro);
                 logoutResetUI(showIntro);
             }
@@ -695,6 +698,9 @@
 
             onUnreadCountChanged: {
                 pushClient.count = unreadCount;
+                if (unreadCount === 0) {
+                    pushClient.clearPersistent([]);
+                }
             }
 
             // We need to clean-up and streamline our APIs ;)