feat: support notify_file_id push notifications

Signed-off-by: Jyrki Gadinger <nilsding@nilsding.org>

Author: nilsding

src/common/syncjournaldb.cpp

@@ -1681,6 +1681,40 @@ bool SyncJournalDb::updateLocalMetadata(const QString &filename,
     return true;
 }
 
+bool SyncJournalDb::hasFileIds(const QList<qint64> &fileIds)
+{
+    QMutexLocker locker(&_mutex);
+
+    if (!checkConnect()) {
+        return false;
+    }
+
+    QStringList fileIdStrings = {};
+    for (const auto &fileId : fileIds) {
+        fileIdStrings.append(QString::number(fileId));
+    }
+
+    // quick workaround for looking up pure numeric file IDs: simply `round()` that field!
+    // this will return the file ID as e.g. 12345.0, but that's still good enough to use it
+    // with the IN operator -- e.g. (12345, 1337, 29001)
+    SqlQuery query(
+        QLatin1String{"SELECT 1 FROM metadata WHERE ROUND(fileid) IN (%1) LIMIT 1;"}
+            .arg(fileIdStrings.join(QLatin1String{", "})).toLocal8Bit(),
+        _db
+    );
+
+    if (!query.exec()) {
+        qCWarning(lcDb) << "file id query failed:" << query.error();
+        return false;
+    }
+
+    if (query.next().hasData && query.intValue(0) == 1) {
+        return true;
+    }
+
+    return false;
+}
+
 Optional<SyncJournalDb::HasHydratedDehydrated> SyncJournalDb::hasHydratedOrDehydratedFiles(const QByteArray &filename)
 {
     QMutexLocker locker(&_mutex);

src/common/syncjournaldb.h

@@ -74,6 +74,8 @@ class OCSYNC_EXPORT SyncJournalDb : public QObject
     [[nodiscard]] bool updateLocalMetadata(const QString &filename,
         qint64 modtime, qint64 size, quint64 inode, const SyncJournalFileLockInfo &lockInfo);
 
+    [[nodiscard]] bool hasFileIds(const QList<qint64> &fileIds);
+
     /// Return value for hasHydratedOrDehydratedFiles()
     struct HasHydratedDehydrated
     {

src/gui/folderman.cpp

@@ -2079,7 +2079,7 @@ void FolderMan::slotSetupPushNotifications(const Folder::Map &folderMap)
 
 void FolderMan::slotProcessFilesPushNotification(Account *account)
 {
-    qCInfo(lcFolderMan) << "Got files push notification for account" << account;
+    qCInfo(lcFolderMan) << "Got files push notification for account" << account->displayName();
 
     for (auto folder : std::as_const(_folderMap)) {
         // Just run on the folders that belong to this account
@@ -2092,13 +2092,34 @@ void FolderMan::slotProcessFilesPushNotification(Account *account)
     }
 }
 
+void FolderMan::slotProcessFileIdsPushNotification(Account *account, const QList<qint64> &fileIds)
+{
+    qCInfo(lcFolderMan) << "Got file id push notification for account" << account->displayName() << "and fileIds" << fileIds;
+
+    for (auto folder : std::as_const(_folderMap)) {
+        // Just run on the folders that belong to this account
+        if (folder->accountState()->account() != account) {
+            continue;
+        }
+
+        if (!folder->journalDb()->hasFileIds(fileIds)) {
+            qCDebug(lcFolderMan) << "Folder" << folder->path() << "does not contain any of these file ids, ignoring";
+            continue;
+        }
+
+        qCInfo(lcFolderMan) << "Schedule folder" << folder->path() << "for sync";
+        scheduleFolder(folder);
+    }
+}
+
 void FolderMan::slotConnectToPushNotifications(const AccountPtr &account)
 {
     const auto pushNotifications = account->pushNotifications();
 
     if (pushNotificationsFilesReady(account)) {
         qCInfo(lcFolderMan) << "Push notifications ready";
         connect(pushNotifications, &PushNotifications::filesChanged, this, &FolderMan::slotProcessFilesPushNotification, Qt::UniqueConnection);
+        connect(pushNotifications, &PushNotifications::fileIdsChanged, this, &FolderMan::slotProcessFileIdsPushNotification, Qt::UniqueConnection);
     }
 }
 

src/gui/folderman.h

@@ -329,6 +329,7 @@ private slots:
 
     void slotSetupPushNotifications(const OCC::Folder::Map &);
     void slotProcessFilesPushNotification(OCC::Account *account);
+    void slotProcessFileIdsPushNotification(OCC::Account *account, const QList<qint64> &fileIds);
     void slotConnectToPushNotifications(const OCC::AccountPtr &account);
 
     void slotLeaveShare(const QString &localFile, const QByteArray &folderToken = {});

src/libsync/pushnotifications.cpp

@@ -7,9 +7,13 @@
 #include "creds/abstractcredentials.h"
 #include "account.h"
 
+#include <QJsonArray>
+
 namespace {
 static constexpr int MAX_ALLOWED_FAILED_AUTHENTICATION_ATTEMPTS = 3;
 static constexpr int PING_INTERVAL = 30 * 1000;
+
+static constexpr QLatin1String NOTIFY_FILE_ID_PREFIX = QLatin1String{"notify_file_id "};
 }
 
 namespace OCC {
@@ -102,7 +106,9 @@ void PushNotifications::onWebSocketTextMessageReceived(const QString &message)
 {
     qCInfo(lcPushNotifications) << "Received push notification:" << message;
 
-    if (message == "notify_file") {
+    if (message.startsWith(NOTIFY_FILE_ID_PREFIX)) {
+        handleNotifyFileId(message);
+    } else if (message == "notify_file") {
         handleNotifyFile();
     } else if (message == "notify_activity") {
         handleNotifyActivity();
@@ -124,7 +130,7 @@ void PushNotifications::onWebSocketError(QAbstractSocket::SocketError error)
         return;
     }
 
-    qCWarning(lcPushNotifications) << "Websocket error on with account" << _account->url() << error;
+    qCWarning(lcPushNotifications) << "Websocket error on with account" << _account->displayName() << _account->url() << error;
     closeWebSocket();
     emit connectionLost();
 }
@@ -153,7 +159,7 @@ bool PushNotifications::tryReconnectToWebSocket()
 
 void PushNotifications::onWebSocketSslErrors(const QList<QSslError> &errors)
 {
-    qCWarning(lcPushNotifications) << "Websocket ssl errors on with account" << _account->url() << errors;
+    qCWarning(lcPushNotifications) << "Websocket ssl errors on with account" << _account->displayName() << _account->url() << errors;
     closeWebSocket();
     emit authenticationFailed();
 }
@@ -164,7 +170,7 @@ void PushNotifications::openWebSocket()
     const auto capabilities = _account->capabilities();
     const auto webSocketUrl = capabilities.pushNotificationsWebSocketUrl();
 
-    qCInfo(lcPushNotifications) << "Open connection to websocket on" << webSocketUrl << "for account" << _account->url();
+    qCInfo(lcPushNotifications) << "Open connection to websocket on" << webSocketUrl << "for account" << _account->displayName() << _account->url();
     connect(_webSocket, QOverload<QAbstractSocket::SocketError>::of(&QWebSocket::errorOccurred), this, &PushNotifications::onWebSocketError);
     connect(_webSocket, &QWebSocket::sslErrors, this, &PushNotifications::onWebSocketSslErrors);
     _webSocket->open(webSocketUrl);
@@ -184,6 +190,8 @@ void PushNotifications::handleAuthenticated()
 {
     qCInfo(lcPushNotifications) << "Authenticated successful on websocket";
     _failedAuthenticationAttemptsCount = 0;
+    qCDebug(lcPushNotifications) << "Requesting opt-in to 'notify_file_id' notifications";
+    _webSocket->sendTextMessage("listen notify_file_id");
     _isReady = true;
     startPingTimer();
     emit ready();
@@ -202,6 +210,35 @@ void PushNotifications::handleNotifyFile()
     emitFilesChanged();
 }
 
+void PushNotifications::handleNotifyFileId(const QString &message)
+{
+    qCInfo(lcPushNotifications) << "File-ID push notification arrived";
+
+    QList<qint64> fileIds{};
+    QJsonParseError parseError;
+    const auto fileIdsJson = message.mid(NOTIFY_FILE_ID_PREFIX.length());
+    const auto jsonDoc = QJsonDocument::fromJson(fileIdsJson.toUtf8(), &parseError);
+
+    if (parseError.error != QJsonParseError::NoError) {
+        qCWarning(lcPushNotifications).nospace() << "could not parse received list of file IDs error=" << parseError.error << " errorString=" << parseError.errorString() << " fileIdsJson=" << fileIdsJson;
+        return;
+    }
+
+    if (const auto jsonArray = jsonDoc.array(); jsonDoc.isArray()) {
+        for (const auto& fileid : jsonArray) {
+            if (const auto fid = fileid.toInteger(); fileid.isDouble()) {
+                fileIds.push_back(fid);
+            }
+        }
+    }
+
+    if (fileIds.empty()) {
+        return;
+    }
+
+    emit fileIdsChanged(_account, fileIds);
+}
+
 void PushNotifications::handleInvalidCredentials()
 {
     qCInfo(lcPushNotifications) << "Invalid credentials submitted to websocket";

src/libsync/pushnotifications.h

@@ -65,6 +65,11 @@ class OWNCLOUDSYNC_EXPORT PushNotifications : public QObject
      */
     void filesChanged(OCC::Account *account);
 
+    /**
+     * Will be emitted if specific files on the server changed
+     */
+    void fileIdsChanged(OCC::Account *account, const QList<qint64> &fileIds);
+
     /**
      * Will be emitted if activities have been changed on the server
      */
@@ -111,6 +116,7 @@ private slots:
 
     void handleAuthenticated();
     void handleNotifyFile();
+    void handleNotifyFileId(const QString &message);
     void handleInvalidCredentials();
     void handleNotifyNotification();
     void handleNotifyActivity();