Basic plugins framework

src/core/CMakeLists.txt

@@ -79,6 +79,7 @@ set(QFIELD_CORE_SRCS
     networkreply.cpp
     orderedrelationmodel.cpp
     peliasgeocoder.cpp
+    pluginmanager.cpp
     resourcesource.cpp
     printlayoutlistmodel.cpp
     projectinfo.cpp
@@ -189,6 +190,7 @@ set(QFIELD_CORE_HDRS
     networkreply.h
     orderedrelationmodel.h
     peliasgeocoder.h
+    pluginmanager.h
     resourcesource.h
     printlayoutlistmodel.h
     projectinfo.h

src/core/appinterface.cpp

@@ -27,6 +27,7 @@
 #include <QDirIterator>
 #include <QFileInfo>
 #include <QImageReader>
+#include <QQuickItem>
 #include <qgsapplication.h>
 #include <qgsmessagelog.h>
 #include <qgsproject.h>
@@ -40,6 +41,64 @@ AppInterface::AppInterface( QgisMobileapp *app )
 {
 }
 
+QObject *AppInterface::findItemByObjectName( const QString &name ) const
+{
+  if ( !mApp->rootObjects().isEmpty() )
+  {
+    return mApp->rootObjects().at( 0 )->findChild<QObject *>( name );
+  }
+  return nullptr;
+}
+
+void AppInterface::addItemToPluginsToolbar( QQuickItem *item ) const
+{
+  if ( !mApp->rootObjects().isEmpty() )
+  {
+    QQuickItem *toolbar = mApp->rootObjects().at( 0 )->findChild<QQuickItem *>( QStringLiteral( "pluginsToolbar" ) );
+    item->setParentItem( toolbar );
+  }
+}
+
+void AppInterface::addItemToMainMenuActionsToolbar( QQuickItem *item ) const
+{
+  if ( !mApp->rootObjects().isEmpty() )
+  {
+    QQuickItem *toolbar = mApp->rootObjects().at( 0 )->findChild<QQuickItem *>( QStringLiteral( "mainMenuActionsToolbar" ) );
+    item->setParentItem( toolbar );
+
+    // Place the item to the left of the Undo/Redo buttons
+    const QList<QQuickItem *> childItems = toolbar->childItems();
+    item->stackBefore( childItems.at( childItems.size() - 3 ) );
+  }
+}
+
+void AppInterface::addItemToCanvasActionsToolbar( QQuickItem *item ) const
+{
+  if ( !mApp->rootObjects().isEmpty() )
+  {
+    QQuickItem *toolbar = mApp->rootObjects().at( 0 )->findChild<QQuickItem *>( QStringLiteral( "canvasMenuActionsToolbar" ) );
+    item->setParentItem( toolbar );
+  }
+}
+
+QObject *AppInterface::mainWindow() const
+{
+  if ( !mApp->rootObjects().isEmpty() )
+  {
+    return mApp->rootObjects().at( 0 );
+  }
+  return nullptr;
+}
+
+QObject *AppInterface::mapCanvas() const
+{
+  if ( !mApp->rootObjects().isEmpty() )
+  {
+    return mApp->rootObjects().at( 0 )->findChild<QObject *>( "mapCanvas" );
+  }
+  return nullptr;
+}
+
 void AppInterface::removeRecentProject( const QString &path )
 {
   return mApp->removeRecentProject( path );

src/core/appinterface.h

@@ -25,6 +25,7 @@
 class QgisMobileapp;
 class QgsRectangle;
 class QgsFeature;
+class QQuickItem;
 
 class AppInterface : public QObject
 {
@@ -94,6 +95,36 @@ class AppInterface : public QObject
      */
     Q_INVOKABLE void clearProject() const;
 
+    /**
+     * Returns the item matching the provided object \a name
+     */
+    Q_INVOKABLE QObject *findItemByObjectName( const QString &name ) const;
+
+    /**
+     * Adds an \a item in the plugins toolbar container
+     */
+    Q_INVOKABLE void addItemToPluginsToolbar( QQuickItem *item ) const;
+
+    /**
+     * Adds an \a item in the main menu action toolbar container
+     */
+    Q_INVOKABLE void addItemToMainMenuActionsToolbar( QQuickItem *item ) const;
+
+    /**
+     * Adds an \a item in the main menu action toolbar container
+     */
+    Q_INVOKABLE void addItemToCanvasActionsToolbar( QQuickItem *item ) const;
+
+    /**
+     * Returns the main window.
+     */
+    Q_INVOKABLE QObject *mainWindow() const;
+
+    /**
+     * Returns the main map canvas.
+     */
+    Q_INVOKABLE QObject *mapCanvas() const;
+
     static void setInstance( AppInterface *instance ) { sAppInterface = instance; }
     static AppInterface *instance() { return sAppInterface; }
 

src/core/pluginmanager.cpp

@@ -0,0 +1,136 @@
+/***************************************************************************
+ pluginmanager.h - PluginManager
+
+ ---------------------
+ begin                : 14.05.2024
+ copyright            : (C) 2024 by Mathieu Pellerin
+ email                : mathieu (at) opengis.ch
+ ***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#include "pluginmanager.h"
+
+#include <QDir>
+#include <QFileInfo>
+#include <QQmlApplicationEngine>
+#include <QQmlComponent>
+#include <QQmlContext>
+#include <QSettings>
+#include <qgsmessagelog.h>
+
+PluginManager::PluginManager( QQmlEngine *engine )
+  : QObject( engine )
+  , mEngine( engine )
+{
+  connect( mEngine, &QQmlEngine::warnings, this, &PluginManager::handleWarnings );
+}
+
+void PluginManager::loadPlugin( const QString &pluginPath, const QString &pluginName, bool skipPermissionCheck )
+{
+  if ( !skipPermissionCheck )
+  {
+    QSettings settings;
+    settings.beginGroup( QStringLiteral( "/qfield/plugins/%1" ).arg( pluginPath ) );
+    const QStringList keys = settings.childKeys();
+    if ( keys.contains( QStringLiteral( "permissionGranted" ) ) )
+    {
+      if ( !settings.value( QStringLiteral( "permissionGranted" ) ).toBool() )
+      {
+        return;
+      }
+    }
+    else
+    {
+      mPermissionRequestPluginPath = pluginPath;
+      emit pluginPermissionRequested( pluginName );
+      return;
+    }
+  }
+
+  if ( mLoadedPlugins.contains( pluginPath ) )
+  {
+    unloadPlugin( pluginPath );
+  }
+
+  QQmlComponent component( mEngine, pluginPath, this );
+  if ( component.status() == QQmlComponent::Status::Error )
+  {
+    for ( const QQmlError &error : component.errors() )
+    {
+      QgsMessageLog::logMessage( error.toString(), QStringLiteral( "Plugin Manager" ), Qgis::MessageLevel::Critical );
+    }
+    return;
+  }
+  QObject *object = component.create( mEngine->rootContext() );
+  mLoadedPlugins.insert( pluginPath, QPointer<QObject>( object ) );
+}
+
+void PluginManager::unloadPlugin( const QString &pluginPath )
+{
+  if ( mLoadedPlugins.contains( pluginPath ) )
+  {
+    if ( mLoadedPlugins[pluginPath] )
+    {
+      mLoadedPlugins[pluginPath]->deleteLater();
+      mLoadedPlugins.remove( pluginPath );
+    }
+  }
+}
+
+void PluginManager::handleWarnings( const QList<QQmlError> &warnings )
+{
+  for ( const QQmlError &warning : warnings )
+  {
+    if ( warning.url().isLocalFile() )
+    {
+      if ( mLoadedPlugins.keys().contains( warning.url().toLocalFile() ) )
+      {
+        QgsMessageLog::logMessage( warning.toString(), QStringLiteral( "Plugin Manager" ), Qgis::MessageLevel::Warning );
+      }
+    }
+  }
+}
+
+void PluginManager::grantRequestedPluginPermission( bool permanent )
+{
+  if ( permanent )
+  {
+    QSettings settings;
+    settings.beginGroup( QStringLiteral( "/qfield/plugins/%1" ).arg( mPermissionRequestPluginPath ) );
+    settings.setValue( QStringLiteral( "permissionGranted" ), true );
+    settings.endGroup();
+  }
+
+  loadPlugin( mPermissionRequestPluginPath, QString(), true );
+  mPermissionRequestPluginPath.clear();
+}
+
+void PluginManager::denyRequestedPluginPermission( bool permanent )
+{
+  if ( permanent )
+  {
+    QSettings settings;
+    settings.beginGroup( QStringLiteral( "/qfield/plugins/%1" ).arg( mPermissionRequestPluginPath ) );
+    settings.setValue( QStringLiteral( "permissionGranted" ), false );
+    settings.endGroup();
+  }
+
+  mPermissionRequestPluginPath.clear();
+}
+
+QString PluginManager::findProjectPlugin( const QString &projectPath )
+{
+  const QFileInfo fi( projectPath );
+  const QString pluginPath = QStringLiteral( "%1/%2.qml" ).arg( fi.absolutePath(), fi.completeBaseName() );
+  if ( QFileInfo::exists( pluginPath ) )
+  {
+    return pluginPath;
+  }
+  return QString();
+}

src/core/pluginmanager.h

@@ -0,0 +1,52 @@
+/***************************************************************************
+ pluginmanager.h - PluginManager
+
+ ---------------------
+ begin                : 14.05.2024
+ copyright            : (C) 2024 by Mathieu Pellerin
+ email                : mathieu (at) opengis.ch
+ ***************************************************************************
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ ***************************************************************************/
+
+#ifndef PLUGINMANAGER_H
+#define PLUGINMANAGER_H
+
+#include <QObject>
+#include <QQmlEngine>
+
+class PluginManager : public QObject
+{
+    Q_OBJECT
+
+  public:
+    explicit PluginManager( QQmlEngine *engine );
+    ~PluginManager() override = default;
+
+    void loadPlugin( const QString &pluginPath, const QString &pluginName, bool skipPermissionCheck = false );
+    void unloadPlugin( const QString &pluginPath );
+
+    Q_INVOKABLE void grantRequestedPluginPermission( bool permanent = false );
+    Q_INVOKABLE void denyRequestedPluginPermission( bool permanent = false );
+
+    static QString findProjectPlugin( const QString &projectPath );
+
+  signals:
+    void pluginPermissionRequested( const QString &pluginName );
+
+  private slots:
+    void handleWarnings( const QList<QQmlError> &warnings );
+
+  private:
+    QQmlEngine *mEngine = nullptr;
+    QMap<QString, QPointer<QObject>> mLoadedPlugins;
+
+    QString mPermissionRequestPluginPath;
+};
+
+#endif // PLUGINMANAGER_H