feat: support notify_file_id push notifications

For this to work we also now need to store the fileId from the sync root
folder, otherwise we would never know about new files inside the
configured sync root

Signed-off-by: Jyrki Gadinger <[email protected]>

Author: nilsding

src/common/syncjournaldb.cpp

@@ -1703,6 +1703,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/folder.cpp

@@ -92,6 +92,7 @@ Folder::Folder(const FolderDefinition &definition,
 
     connect(_accountState.data(), &AccountState::isConnectedChanged, this, &Folder::canSyncChanged);
     connect(_engine.data(), &SyncEngine::rootEtag, this, &Folder::etagRetrievedFromSyncEngine);
+    connect(_engine.data(), &SyncEngine::rootFileIdReceived, this, &Folder::rootFileIdReceivedFromSyncEngine);
 
     connect(_engine.data(), &SyncEngine::started, this, &Folder::slotSyncStarted, Qt::QueuedConnection);
     connect(_engine.data(), &SyncEngine::finished, this, &Folder::slotSyncFinished, Qt::QueuedConnection);
@@ -387,6 +388,11 @@ void Folder::etagRetrievedFromSyncEngine(const QByteArray &etag, const QDateTime
     _lastEtag = etag;
 }
 
+void Folder::rootFileIdReceivedFromSyncEngine(const qint64 fileId)
+{
+    qCDebug(lcFolder).nospace() << "retrieved root fileId=" << fileId;
+    _rootFileId = fileId;
+}
 
 void Folder::showSyncResultPopup()
 {
@@ -996,6 +1002,11 @@ void Folder::migrateBlackListPath(const QString &legacyPath)
     }
 }
 
+bool Folder::hasFileIds(const QList<qint64>& fileIds) const
+{
+    return fileIds.contains(_rootFileId) || journalDb()->hasFileIds(fileIds);
+}
+
 QString Folder::filePath(const QString& fileName)
 {
     const auto folderDir = QDir(_canonicalLocalPath);

src/gui/folder.h

@@ -309,6 +309,9 @@ class Folder : public QObject
     void blacklistPath(const QString &path);
     void migrateBlackListPath(const QString &legacyPath);
 
+    /// whether the current folder contains any of the passed fileIds
+    [[nodiscard]] bool hasFileIds(const QList<qint64>& fileIds) const;
+
 signals:
     void syncStateChange();
     void syncStarted();
@@ -422,6 +425,8 @@ private slots:
     void etagRetrieved(const QByteArray &, const QDateTime &tp);
     void etagRetrievedFromSyncEngine(const QByteArray &, const QDateTime &time);
 
+    void rootFileIdReceivedFromSyncEngine(const qint64 fileId);
+
     void slotEmitFinishedDelayed();
 
     void slotNewBigFolderDiscovered(const QString &, bool isExternal);
@@ -578,6 +583,9 @@ private slots:
     QMetaObject::Connection _officeFileLockReleaseUnlockFailure;
     QMetaObject::Connection _fileLockSuccess;
     QMetaObject::Connection _fileLockFailure;
+
+    /// The remote file ID of the current folder.
+    qint64 _rootFileId = 0;
 };
 }
 

src/gui/folderman.cpp

@@ -2079,15 +2079,35 @@ void FolderMan::slotSetupPushNotifications(const Folder::Map &folderMap)
 
 void FolderMan::slotProcessFilesPushNotification(Account *account)
 {
-    qCInfo(lcFolderMan) << "Got files push notification for account" << account;
+    qCDebug(lcFolderMan) << "received notify_file push notification account=" << account->displayName();
 
     for (auto folder : std::as_const(_folderMap)) {
         // Just run on the folders that belong to this account
         if (folder->accountState()->account() != account) {
             continue;
         }
 
-        qCInfo(lcFolderMan) << "Schedule folder" << folder << "for sync";
+        qCInfo(lcFolderMan).nospace() << "scheduling sync account=" << account->displayName() << " folder=" << folder->alias() << " reason=notify_file";
+        scheduleFolder(folder);
+    }
+}
+
+void FolderMan::slotProcessFileIdsPushNotification(Account *account, const QList<qint64> &fileIds)
+{
+    qCDebug(lcFolderMan).nospace() << "received notify_file_id push notification account=" << account->displayName() << " 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->hasFileIds(fileIds)) {
+            qCDebug(lcFolderMan).nospace() << "no matching file ids, ignoring account=" << account->displayName() << " folder=" << folder->alias();
+            continue;
+        }
+
+        qCInfo(lcFolderMan).nospace() << "scheduling sync account=" << account->displayName() << " folder=" << folder->alias() << " reason=notify_file_id";
         scheduleFolder(folder);
     }
 }
@@ -2099,6 +2119,7 @@ void FolderMan::slotConnectToPushNotifications(const AccountPtr &account)
     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/discovery.cpp

@@ -2235,6 +2235,7 @@ DiscoverySingleDirectoryJob *ProcessDirectoryJob::startAsyncServerQuery()
     }
 
     connect(serverJob, &DiscoverySingleDirectoryJob::etag, this, &ProcessDirectoryJob::etag);
+    connect(serverJob, &DiscoverySingleDirectoryJob::rootFileIdReceived, this, &ProcessDirectoryJob::rootFileIdReceived);
     connect(serverJob, &DiscoverySingleDirectoryJob::setfolderQuota, this, &ProcessDirectoryJob::setFolderQuota);
     _discoveryData->_currentlyActiveJobs++;
     _pendingAsyncJobs++;

src/libsync/discovery.h

@@ -305,6 +305,7 @@ class ProcessDirectoryJob : public QObject
     void finished();
     // The root etag of this directory was fetched
     void etag(const QByteArray &, const QDateTime &time);
+    void rootFileIdReceived(const qint64 fileId);
 
 private slots:
     void setFolderQuota(const FolderQuota &folderQuota);

src/libsync/discoveryphase.cpp

@@ -613,8 +613,17 @@ void DiscoverySingleDirectoryJob::directoryListingIteratedSlot(const QString &fi
             _localFileId = map.value(QStringLiteral("fileid")).toUtf8();
         }
         if (map.contains("id")) {
+            // this is from the "oc:id" property, the format is e.g. "00000002oc123xyz987e"
             _fileId = map.value("id").toUtf8();
         }
+        if (map.contains("fileid")) {
+            // this is from the "oc:fileid" property, this is the plain ID without any special format (e.g. "2")
+            bool ok = false;
+            if (qint64 numericFileId = map.value("fileid").toLongLong(&ok); ok) {
+                qCDebug(lcDiscovery).nospace() << "received numericFileId=" << numericFileId;
+                emit rootFileIdReceived(numericFileId);
+            }
+        }
         if (map.contains("is-encrypted") && map.value("is-encrypted") == QStringLiteral("1")) {
             _encryptionStatusCurrent = SyncFileItem::EncryptionStatus::EncryptedMigratedV2_0;
             Q_ASSERT(!_fileId.isEmpty());

src/libsync/discoveryphase.h

@@ -186,6 +186,7 @@ class DiscoverySingleDirectoryJob : public QObject
     void etag(const QByteArray &, const QDateTime &time);
     void finished(const OCC::HttpResult<QVector<OCC::RemoteInfo>> &result);
     void setfolderQuota(const FolderQuota &folderQuota);
+    void rootFileIdReceived(const qint64 fileId);
 
 private slots:
     void directoryListingIteratedSlot(const QString &, const QMap<QString, QString> &);