Deduplicate Qt plugins deployment

Author: dantti

src/deployers/BasicPluginsDeployer.cpp

@@ -28,8 +28,26 @@ BasicPluginsDeployer::BasicPluginsDeployer(std::string moduleName,
                                                                   qtTranslationsPath(std::move(qtTranslationsPath)),
                                                                   qtDataPath(std::move(qtDataPath)) {}
 
-bool BasicPluginsDeployer::deploy() {
-    // currently this is a no-op, but we might add more functionality later on, such as some kinds of default
-    // attempts to copy data based on the moduleName
+bool BasicPluginsDeployer::deploy()
+{
+    for (const auto &pluginName : qtPluginsToBeDeployed()) {
+        ldLog() << "Deploying" << pluginName << "plugins" << std::endl;
+        for (fs::directory_iterator i(qtPluginsPath / pluginName); i != fs::directory_iterator();
+             ++i) {
+            if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins" / pluginName))
+                return false;
+        }
+    }
+
+    return customDeploy();
+}
+
+bool BasicPluginsDeployer::customDeploy()
+{
     return true;
 }
+
+std::vector<std::string> BasicPluginsDeployer::qtPluginsToBeDeployed() const
+{
+    return {};
+}

src/deployers/BasicPluginsDeployer.h

@@ -49,7 +49,25 @@ namespace linuxdeploy {
                 virtual ~BasicPluginsDeployer() = default;
 
             public:
-                bool deploy() override;
+                /**
+                 * This method deploys the plugins returned by \sa qtPluginsToBeDeployed()
+                 * and call \sa customDeploy() to finalize the deployment.
+                 */
+                bool deploy() override final;
+
+            protected:
+                /**
+                 * The \sa deploy() method can deploy Qt plugins that follow the default
+                 * name and path scheme, but some modules are special so
+                 * they should write custom deployment code.
+                 */
+                virtual bool customDeploy();
+
+                /**
+                 * Returns a list of Qt plugin names that should be deployed and
+                 * follow the default name and path scheme.
+                 */
+                virtual std::vector<std::string> qtPluginsToBeDeployed() const;
             };
         }
     }

src/deployers/BearerPluginsDeployer.cpp

@@ -10,19 +10,7 @@
 using namespace linuxdeploy::plugin::qt;
 using namespace linuxdeploy::core::log;
 
-namespace fs = std::filesystem;
-
-bool BearerPluginsDeployer::deploy() {
-    // calling the default code is optional, but it won't hurt for now
-    if (!BasicPluginsDeployer::deploy())
-        return false;
-
-    ldLog() << "Deploying bearer plugins" << std::endl;
-
-    for (fs::directory_iterator i(qtPluginsPath / "bearer"); i != fs::directory_iterator(); ++i) {
-        if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins/bearer/"))
-            return false;
-    }
-
-    return true;
+std::vector<std::string> BearerPluginsDeployer::qtPluginsToBeDeployed() const
+{
+    return {"bearer"};
 }

src/deployers/BearerPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool deploy() override;
+                std::vector<std::string> qtPluginsToBeDeployed() const override;
             };
         }
     }

src/deployers/GamepadPluginsDeployer.cpp

@@ -10,19 +10,7 @@
 using namespace linuxdeploy::plugin::qt;
 using namespace linuxdeploy::core::log;
 
-namespace fs = std::filesystem;
-
-bool GamepadPluginsDeployer::deploy() {
-    // calling the default code is optional, but it won't hurt for now
-    if (!BasicPluginsDeployer::deploy())
-        return false;
-
-    ldLog() << "Deploying Gamepad plugins" << std::endl;
-
-    for (fs::directory_iterator i(qtPluginsPath / "gamepads"); i != fs::directory_iterator(); ++i) {
-        if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins/gamepads/"))
-            return false;
-    }
-
-    return true;
+std::vector<std::string> GamepadPluginsDeployer::qtPluginsToBeDeployed() const
+{
+    return {"gamepads"};
 }

src/deployers/GamepadPluginsDeployer.h

@@ -5,12 +5,13 @@
 namespace linuxdeploy {
     namespace plugin {
         namespace qt {
-            class GamepadPluginsDeployer : public BasicPluginsDeployer {
+            class GamepadPluginsDeployer : public BasicPluginsDeployer
+            {
             public:
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool deploy() override;
+                std::vector<std::string> qtPluginsToBeDeployed() const override;
             };
         }
     }

src/deployers/LocationPluginsDeployer.cpp

@@ -10,19 +10,7 @@
 using namespace linuxdeploy::plugin::qt;
 using namespace linuxdeploy::core::log;
 
-namespace fs = std::filesystem;
-
-bool LocationPluginsDeployer::deploy() {
-    // calling the default code is optional, but it won't hurt for now
-    if (!BasicPluginsDeployer::deploy())
-        return false;
-
-    ldLog() << "Deploying Location plugins" << std::endl;
-
-    for (fs::directory_iterator i(qtPluginsPath / "geoservices"); i != fs::directory_iterator(); ++i) {
-        if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins/geoservices/"))
-            return false;
-    }
-
-    return true;
+std::vector<std::string> LocationPluginsDeployer::qtPluginsToBeDeployed() const
+{
+    return {"geoservices"};
 }

src/deployers/LocationPluginsDeployer.h

@@ -5,12 +5,13 @@
 namespace linuxdeploy {
     namespace plugin {
         namespace qt {
-            class LocationPluginsDeployer : public BasicPluginsDeployer {
+            class LocationPluginsDeployer : public BasicPluginsDeployer
+            {
             public:
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool deploy() override;
+                std::vector<std::string> qtPluginsToBeDeployed() const override;
             };
         }
     }

src/deployers/Multimedia5PluginsDeployer.cpp

@@ -10,26 +10,7 @@
 using namespace linuxdeploy::plugin::qt;
 using namespace linuxdeploy::core::log;
 
-namespace fs = std::filesystem;
-
-bool Multimedia5PluginsDeployer::deploy() {
-    // calling the default code is optional, but it won't hurt for now
-    if (!BasicPluginsDeployer::deploy())
-        return false;
-
-    ldLog() << "Deploying mediaservice plugins" << std::endl;
-
-    for (fs::directory_iterator i(qtPluginsPath / "mediaservice"); i != fs::directory_iterator(); ++i) {
-        if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins/mediaservice/"))
-            return false;
-    }
-
-    ldLog() << "Deploying audio plugins" << std::endl;
-
-    for (fs::directory_iterator i(qtPluginsPath / "audio"); i != fs::directory_iterator(); ++i) {
-        if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins/audio/"))
-            return false;
-    }
-
-    return true;
+std::vector<std::string> Multimedia5PluginsDeployer::qtPluginsToBeDeployed() const
+{
+    return {"mediaservice", "audio"};
 }

src/deployers/Multimedia5PluginsDeployer.h

@@ -5,12 +5,13 @@
 namespace linuxdeploy {
     namespace plugin {
         namespace qt {
-            class Multimedia5PluginsDeployer : public BasicPluginsDeployer {
+            class Multimedia5PluginsDeployer : public BasicPluginsDeployer
+            {
             public:
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool deploy() override;
+                std::vector<std::string> qtPluginsToBeDeployed() const override;
             };
         }
     }