[DC-53] feat: remove suffix plugin (#12174)

Suffix VFS was deprecated in late 2023 for desktop client 6.0. Now with 7.0 we finally remove it.

#11365

Author: DeepDiver1975

CMakeLists.txt

@@ -101,7 +101,7 @@ add_feature_info(AppImageUpdate WITH_APPIMAGEUPDATER "Built-in libappimageupdate
 option(WITH_EXTERNAL_BRANDING "A URL to an external branding repo" "")
 
 # specify additional vfs plugins
-set(VIRTUAL_FILE_SYSTEM_PLUGINS off suffix win CACHE STRING "Name of internal plugin in src/libsync/vfs or the locations of virtual file plugins")
+set(VIRTUAL_FILE_SYSTEM_PLUGINS off win CACHE STRING "Name of internal plugin in src/libsync/vfs or the locations of virtual file plugins")
 
 if(APPLE)
   set( SOCKETAPI_TEAM_IDENTIFIER_PREFIX "" CACHE STRING "SocketApi prefix (including a following dot) that must match the codesign key's TeamIdentifier/Organizational Unit" )

THEME.cmake

@@ -29,10 +29,7 @@ endif()
 
 message(STATUS "Branding: ${APPLICATION_NAME}")
 
-# Default suffix if the theme doesn't define one
-if(NOT DEFINED APPLICATION_VIRTUALFILE_SUFFIX)
-    set(APPLICATION_VIRTUALFILE_SUFFIX "${APPLICATION_SHORTNAME}_virtual" CACHE STRING "Virtual file suffix (not including the .)")
-endif()
+set(APPLICATION_REV_DOMAIN_INSTALLER ${APPLICATION_REV_DOMAIN})
 
 # need this logic to not mess with re/uninstallations via macosx.pkgproj
 if(${APPLICATION_REV_DOMAIN} STREQUAL "com.owncloud.desktopclient")

src/common/vfs.cpp

@@ -40,20 +40,14 @@ Vfs::Vfs(QObject* parent)
 {
 }
 
-QString Vfs::underlyingFileName(const QString &fileName) const
-{
-    return fileName;
-}
-
 Vfs::~Vfs() = default;
 
 Vfs::Mode Vfs::modeFromString(const QString &str)
 {
     // Note: Strings are used for config and must be stable
     // keep in sync with: QString Utility::enumToString(Vfs::Mode mode)
-    // which is defined BELOW
-    if (str == QLatin1String("suffix")) {
-        return WithSuffix;
+    if (str == QLatin1String("off")) {
+        return Off;
     } else if (str == QLatin1String("wincfapi")) {
         return WindowsCfApi;
     }
@@ -66,8 +60,6 @@ QString Utility::enumToString(Vfs::Mode mode)
     // Note: Strings are used for config and must be stable
     // keep in sync with: Optional<Vfs::Mode> Vfs::modeFromString(const QString &str)
     switch (mode) {
-    case Vfs::Mode::WithSuffix:
-        return QStringLiteral("suffix");
     case Vfs::Mode::WindowsCfApi:
         return QStringLiteral("wincfapi");
     case Vfs::Mode::Off:
@@ -162,7 +154,7 @@ void Vfs::wipeDehydratedVirtualFiles()
         _setupParams->journal->deleteFileRecord(relativePath);
 
         // If the local file is a dehydrated placeholder, wipe it too.
-        // Otherwise leave it to allow the next sync to have a new-new conflict.
+        // Otherwise, leave it to allow the next sync to have a new-new conflict.
         const QString absolutePath = _setupParams->filesystemPath + relativePath;
         if (QFile::exists(absolutePath)) {
             // according to our db this is a dehydrated file, check it  to be sure
@@ -199,17 +191,17 @@ bool OCC::VfsPluginManager::isVfsPluginAvailable(Vfs::Mode mode) const
         auto pluginPath = pluginFileName(QStringLiteral("vfs"), name);
         QPluginLoader loader(pluginPath);
 
-        auto basemeta = loader.metaData();
-        if (basemeta.isEmpty() || !basemeta.contains(QStringLiteral("IID"))) {
+        auto baseMetaData = loader.metaData();
+        if (baseMetaData.isEmpty() || !baseMetaData.contains(QStringLiteral("IID"))) {
             qCDebug(lcPlugin) << "Plugin doesn't exist:" << loader.fileName() << "LibraryPath:" << QCoreApplication::libraryPaths();
             return false;
         }
-        if (basemeta[QStringLiteral("IID")].toString() != QLatin1String("org.owncloud.PluginFactory")) {
-            qCWarning(lcPlugin) << "Plugin has wrong IID" << loader.fileName() << basemeta[QStringLiteral("IID")];
+        if (baseMetaData[QStringLiteral("IID")].toString() != QLatin1String("org.owncloud.PluginFactory")) {
+            qCWarning(lcPlugin) << "Plugin has wrong IID" << loader.fileName() << baseMetaData[QStringLiteral("IID")];
             return false;
         }
 
-        auto metadata = basemeta[QStringLiteral("MetaData")].toObject();
+        auto metadata = baseMetaData[QStringLiteral("MetaData")].toObject();
         if (metadata[QStringLiteral("type")].toString() != QLatin1String("vfs")) {
             qCWarning(lcPlugin) << "Plugin has wrong type" << loader.fileName() << metadata[QStringLiteral("type")];
             return false;
@@ -236,10 +228,6 @@ Vfs::Mode OCC::VfsPluginManager::bestAvailableVfsMode() const
 {
     if (isVfsPluginAvailable(Vfs::WindowsCfApi)) {
         return Vfs::WindowsCfApi;
-    } else if (isVfsPluginAvailable(Vfs::WithSuffix)) {
-        return Vfs::WithSuffix;
-    } else if (isVfsPluginAvailable(Vfs::Off)) {
-        return Vfs::Off;
     }
 
     return Vfs::Off;
@@ -253,7 +241,7 @@ std::unique_ptr<Vfs> OCC::VfsPluginManager::createVfsFromPlugin(Vfs::Mode mode)
     auto pluginPath = pluginFileName(QStringLiteral("vfs"), name);
 
     if (!isVfsPluginAvailable(mode)) {
-        qCCritical(lcPlugin) << "Could not load plugin: not existant or bad metadata" << pluginPath;
+        qCCritical(lcPlugin) << "Could not load plugin: not existent or bad metadata" << pluginPath;
         return nullptr;
     }
 

src/common/vfs.h

@@ -23,7 +23,6 @@
 #include "utility.h"
 
 #include <QObject>
-#include <QScopedPointer>
 #include <QSharedPointer>
 #include <QUrl>
 #include <QVersionNumber>
@@ -53,7 +52,7 @@ struct OCSYNC_EXPORT VfsSetupParams
      */
     QString remotePath;
 
-    /// Account url, credentials etc for network calls
+    /// Account url, credentials etc. for network calls
     AccountPtr account;
 
     /** Access to the sync folder's database.
@@ -68,7 +67,7 @@ struct OCSYNC_EXPORT VfsSetupParams
     QVersionNumber providerVersion;
 
     /** when registering with the system we might use
-     *  a different presentaton to identify the accounts
+     *  a different presentation to identify the accounts
      */
     bool multipleAccountsRegistered = false;
 
@@ -111,11 +110,7 @@ class OCSYNC_EXPORT Vfs : public QObject
      *
      * Currently plugins and modes are one-to-one but that's not required.
      */
-    enum Mode {
-        Off,
-        WithSuffix,
-        WindowsCfApi
-    };
+    enum Mode { Off, WindowsCfApi };
     Q_ENUM(Mode)
     enum class ConvertToPlaceholderResult {
         Ok,
@@ -142,13 +137,6 @@ class OCSYNC_EXPORT Vfs : public QObject
 
     virtual Mode mode() const = 0;
 
-    /// For WithSuffix modes: the suffix (including the dot)
-    virtual QString fileSuffix() const = 0;
-
-    /// The fileName without fileSuffix
-    /// TODO: better naming welcome
-    virtual QString underlyingFileName(const QString &fileName) const;
-
     /// Access to the parameters the instance was start()ed with.
     const VfsSetupParams &params() const { return *_setupParams.get(); }
 
@@ -251,7 +239,7 @@ public Q_SLOTS:
     /// we encountered an error
     void error(const QString &error);
 
-    /// The vfs plugin detected that the meta data are out of sync and requests a sync with the server
+    /// The vfs plugin detected that the metadata are out of sync and requests a sync with the server
     void needSync();
 
 protected:
@@ -262,7 +250,7 @@ public Q_SLOTS:
      */
     [[nodiscard]] virtual Result<ConvertToPlaceholderResult, QString> updateMetadata(const SyncFileItem &item, const QString &filePath, const QString &replacesFile) = 0;
 
-    /** Setup the plugin for the folder.
+    /** Set up the plugin for the folder.
      *
      * For example, the VFS provider might monitor files to be able to start a file
      * hydration (download of a file's remote contents) when the user wants to open

src/csync/config.h.in

@@ -17,8 +17,6 @@
 #cmakedefine APPLICATION_EXECUTABLE "@APPLICATION_EXECUTABLE@"
 #cmakedefine APPLICATION_UPDATE_URL "@APPLICATION_UPDATE_URL@"
 #cmakedefine APPLICATION_ICON_NAME "@APPLICATION_ICON_NAME@"
-#cmakedefine APPLICATION_VIRTUALFILE_SUFFIX "@APPLICATION_VIRTUALFILE_SUFFIX@"
-#define APPLICATION_DOTVIRTUALFILE_SUFFIX "." APPLICATION_VIRTUALFILE_SUFFIX
 
 #cmakedefine SYSCONFDIR "@SYSCONFDIR@"
 

src/csync/csync_exclude.cpp

@@ -120,7 +120,7 @@ OCSYNC_EXPORT bool csync_is_windows_reserved_word(QStringView filename)
         if (static_cast<size_t>(word.size()) > len_filename) {
             break;
         }
-        // until windows 11, not only the device names where illegal file names
+        // until Windows 11, not only the device names where illegal file names
         // also COM9.png was illegal
         if ((static_cast<size_t>(word.size()) == len_filename || filename.at(word.size()) == QLatin1Char('.')) && filename.startsWith(word, Qt::CaseInsensitive)) {
             return true;
@@ -165,10 +165,6 @@ static CSYNC_EXCLUDE_TYPE _csync_excluded_common(QStringView path, bool excludeC
         }
     }
 
-    if (bname.endsWith(QLatin1String(APPLICATION_DOTVIRTUALFILE_SUFFIX), Qt::CaseInsensitive)) { // ".owncloud" placeholder
-        return CSYNC_FILE_EXCLUDE_RESERVED;
-    }
-
     // check the strlen and ignore the file if its name is longer than 254 chars.
     // whenever changing this also check createDownloadTmpFileName
     if (blen > 254) {
@@ -397,32 +393,33 @@ CSYNC_EXCLUDE_TYPE ExcludedFiles::traversalPatternMatch(QStringView path, ItemTy
         bnameStr = path.mid(lastSlash + 1);
     }
 
-    QRegularExpressionMatch m;
+    QRegularExpressionMatch regularExpressionMatch;
     if (filetype == ItemTypeDirectory) {
-        m = _bnameTraversalRegexDir.match(bnameStr);
+        regularExpressionMatch = _bnameTraversalRegexDir.matchView(bnameStr);
     } else {
-        m = _bnameTraversalRegexFile.match(bnameStr);
+        regularExpressionMatch = _bnameTraversalRegexFile.matchView(bnameStr);
     }
-    if (!m.hasMatch())
+    if (!regularExpressionMatch.hasMatch())
         return CSYNC_NOT_EXCLUDED;
-    if (m.capturedStart(QStringLiteral("exclude")) != -1) {
+    if (regularExpressionMatch.capturedStart(QStringLiteral("exclude")) != -1) {
         return CSYNC_FILE_EXCLUDE_LIST;
-    } else if (m.capturedStart(QStringLiteral("excluderemove")) != -1) {
+    } else if (regularExpressionMatch.capturedStart(QStringLiteral("excluderemove")) != -1) {
         return CSYNC_FILE_EXCLUDE_AND_REMOVE;
     }
 
     // third capture: full path matching is triggered
     QStringView pathStr = path;
 
     if (filetype == ItemTypeDirectory) {
-        m = _fullTraversalRegexDir.match(pathStr);
+        regularExpressionMatch = _fullTraversalRegexDir.matchView(pathStr);
     } else {
-        m = _fullTraversalRegexFile.match(pathStr);
+        regularExpressionMatch = _fullTraversalRegexFile.matchView(pathStr);
     }
-    if (m.hasMatch()) {
-        if (m.capturedStart(QStringLiteral("exclude")) != -1) {
+    if (regularExpressionMatch.hasMatch()) {
+        if (regularExpressionMatch.capturedStart(QStringLiteral("exclude")) != -1) {
             return CSYNC_FILE_EXCLUDE_LIST;
-        } else if (m.capturedStart(QStringLiteral("excluderemove")) != -1) {
+        }
+        if (regularExpressionMatch.capturedStart(QStringLiteral("excluderemove")) != -1) {
             return CSYNC_FILE_EXCLUDE_AND_REMOVE;
         }
     }
@@ -439,9 +436,9 @@ CSYNC_EXCLUDE_TYPE ExcludedFiles::fullPatternMatch(QStringView p, ItemType filet
 
     QRegularExpressionMatch m;
     if (filetype == ItemTypeDirectory) {
-        m = _fullRegexDir.match(p);
+        m = _fullRegexDir.matchView(p);
     } else {
-        m = _fullRegexFile.match(p);
+        m = _fullRegexFile.matchView(p);
     }
     if (m.hasMatch()) {
         if (m.capturedStart(QStringLiteral("exclude")) != -1) {

src/gui/MacOSXBundleInfo.plist

@@ -38,42 +38,5 @@
         <string>${CMAKE_OSX_DEPLOYMENT_TARGET}</string>
         <key>CFBundleAllowMixedLocalizations</key>
         <true/>
-
-<key>UTExportedTypeDeclarations</key>
-<array>
-    <dict>
-        <key>UTTypeIdentifier</key>
-        <string>${APPLICATION_REV_DOMAIN}.VIRTUALFILE</string>
-        <key>UTTypeTagSpecification</key>
-        <dict>
-            <key>public.filename-extension</key>
-            <string>${APPLICATION_VIRTUALFILE_SUFFIX}</string>
-            <key>public.mime-type</key>
-            <string>application/octet-stream</string>
-        </dict>
-        <key>UTTypeConformsTo</key>
-         <array>
-             <string>public.data</string>
-         </array>
-    </dict>
-</array>
-
-<key>CFBundleDocumentTypes</key>
-<array>
-    <dict>
-        <key>CFBundleTypeName</key>
-        <string>${APPLICATION_EXECUTABLE} Download Virtual File</string>
-        <key>CFBundleTypeRole</key>
-        <string>Editor</string>
-        <key>LSHandlerRank</key>
-        <string>Owner</string>
-        <key>LSItemContentTypes</key>
-        <array>
-            <string>${APPLICATION_REV_DOMAIN}.VIRTUALFILE</string>
-        </array>
-    </dict>
-</array>
-
-
 </dict>
 </plist>

src/gui/application.cpp

@@ -73,8 +73,6 @@ Application::Application(Platform *platform, const QString &displayLanguage, boo
     }
     if (VfsPluginManager::instance().isVfsPluginAvailable(Vfs::WindowsCfApi))
         qCInfo(lcApplication) << "VFS windows plugin is available";
-    if (VfsPluginManager::instance().isVfsPluginAvailable(Vfs::WithSuffix))
-        qCInfo(lcApplication) << "VFS suffix plugin is available";
 
     ConfigFile cfg;
 
@@ -105,7 +103,7 @@ Application::Application(Platform *platform, const QString &displayLanguage, boo
 
     // Refactoring example: this is oversimplified and really belongs in a dedicated app builder impl but the idea is illustrated:
     // don't handling everything "locally" -> request that the best entity for the job do it. Then make the proper connections between
-    // requestor and responsible handler in a clearly defined, central location (eg an app builder, but for now, this will do)
+    // requestor and responsible handler in a clearly defined, central location (e.g. an app builder, but for now, this will do)
     connect(_gui, &ownCloudGui::requestSetUpSyncFoldersForAccount, FolderMan::instance(), &FolderMan::setUpInitialSyncFolders);
 
 #ifdef WITH_AUTO_UPDATER
@@ -131,7 +129,7 @@ void Application::slotAccountStateRemoved() const
 {
     // if there is no more account, show the wizard.
     if (_gui && AccountManager::instance()->accounts().isEmpty()) {
-        // allow to add a new account if there is non any more. Always think
+        // allow to add a new account if there is none anymore. Always think
         // about single account theming!
         gui()->runNewAccountWizard();
     }
@@ -204,45 +202,6 @@ bool Application::debugMode()
     return _debugMode;
 }
 
-void Application::openVirtualFile(const QString &filename)
-{
-    QString virtualFileExt = Theme::instance()->appDotVirtualFileSuffix();
-    if (!filename.endsWith(virtualFileExt)) {
-        qWarning(lcApplication) << "Can only handle file ending in .owncloud. Unable to open" << filename;
-        return;
-    }
-    QString relativePath;
-    auto folder = FolderMan::instance()->folderForPath(filename, &relativePath);
-    if (!folder) {
-        qWarning(lcApplication) << "Can't find sync folder for" << filename;
-        // TODO: show a QMessageBox for errors
-        return;
-    }
-    folder->implicitlyHydrateFile(relativePath);
-    QString normalName = filename.left(filename.size() - virtualFileExt.size());
-    auto con = QSharedPointer<QMetaObject::Connection>::create();
-    *con = connect(folder, &Folder::syncFinished, folder, [folder, con, normalName] {
-        folder->disconnect(*con);
-        if (QFile::exists(normalName)) {
-            QDesktopServices::openUrl(QUrl::fromLocalFile(normalName));
-        }
-    });
-}
-
-bool Application::eventFilter(QObject *obj, QEvent *event)
-{
-#ifdef Q_OS_MAC
-    if (event->type() == QEvent::FileOpen) {
-        QFileOpenEvent *openEvent = static_cast<QFileOpenEvent *>(event);
-        qCDebug(lcApplication) << "QFileOpenEvent" << openEvent->file();
-        // virtual file, open it after the Folder were created (if the app is not terminated)
-        QString fn = openEvent->file();
-        QTimer::singleShot(0, this, [this, fn] { openVirtualFile(fn); });
-    }
-#endif
-    return QObject::eventFilter(obj, event);
-}
-
 std::unique_ptr<Application> Application::createInstance(Platform *platform, const QString &displayLanguage, bool debugMode)
 {
     Q_ASSERT(!_instance);