refactoring LayersProxyModel to RecordingLayersProxyModel

Author: VitorVieiraZ

app/CMakeLists.txt

@@ -65,7 +65,7 @@ set(MM_SRCS
     invitationsmodel.cpp
     invitationsproxymodel.cpp
     layersmodel.cpp
-    layersproxymodel.cpp
+    recordinglayersproxymodel.cpp
     main.cpp
     mapthemesmodel.cpp
     notificationmodel.cpp
@@ -149,7 +149,7 @@ set(MM_HDRS
     invitationsmodel.h
     invitationsproxymodel.h
     layersmodel.h
-    layersproxymodel.h
+    recordinglayersproxymodel.h
     mapthemesmodel.h
     notificationmodel.h
     projectsmodel.h

app/activeproject.cpp

@@ -186,8 +186,8 @@ bool ActiveProject::forceLoad( const QString &filePath, bool force )
     setProjectRole( role );
 
     updateMapTheme();
-    updateActiveLayer();
     updateMapSettingsLayers();
+    updateActiveLayer();
 
     emit localProjectChanged( mLocalProject );
     emit projectReloaded( mQgsProject );
@@ -465,11 +465,11 @@ void ActiveProject::setMapTheme( const QString &themeName )
 
 void ActiveProject::updateActiveLayer()
 {
-  if ( !InputUtils::layerVisible( mActiveLayer.layer(), mQgsProject ) )
+  if ( !mMapSettings->layers().contains( mActiveLayer.layer() ) )
   {
     QgsMapLayer *defaultAppSettingsLayer = InputUtils::mapLayerFromName( mAppSettings.defaultLayer(), mQgsProject );
 
-    if ( InputUtils::recordingAllowed( defaultAppSettingsLayer, mQgsProject ) )
+    if ( recordingAllowed( defaultAppSettingsLayer ) )
     {
       setActiveLayer( defaultAppSettingsLayer );
       return;
@@ -481,7 +481,7 @@ void ActiveProject::updateActiveLayer()
     for ( auto it = layers.cbegin(); it != layers.cend(); ++it )
     {
       QgsMapLayer *layer = it.value();
-      if ( InputUtils::recordingAllowed( layer, mQgsProject ) )
+      if ( recordingAllowed( layer ) )
       {
         defaultLayer = layer;
         break;
@@ -519,8 +519,8 @@ void ActiveProject::switchLayerTreeNodeVisibility( QgsLayerTreeNode *node )
   node->setItemVisibilityChecked( !node->isVisible() );
 
   updateMapTheme();
-  updateActiveLayer();
   updateMapSettingsLayers();
+  updateActiveLayer();
 }
 
 const QString &ActiveProject::mapTheme() const
@@ -546,7 +546,7 @@ bool ActiveProject::projectHasRecordingLayers() const
   const QMap<QString, QgsMapLayer *> layers = mQgsProject->mapLayers();
   for ( auto it = layers.constBegin(); it != layers.constEnd(); ++it )
   {
-    if ( InputUtils::recordingAllowed( it.value(), mQgsProject ) )
+    if ( recordingAllowed( it.value() ) )
       return true;
   }
 
@@ -567,3 +567,20 @@ void ActiveProject::setProjectRole( const QString &role )
     emit projectRoleChanged();
   }
 }
+
+bool ActiveProject::recordingAllowed( QgsMapLayer *layer ) const
+{
+  if ( !layer )
+    return false;
+
+  return QgsMapLayerProxyModel::layerMatchesFilters( layer, Qgis::LayerFilter::HasGeometry | Qgis::LayerFilter::WritableLayer ) && layer->id() != positionTrackingLayerId();
+}
+
+QString ActiveProject::positionTrackingLayerId() const
+{
+  if ( !mQgsProject )
+    return QString();
+
+  return mQgsProject->readEntry( QStringLiteral( "Mergin" ), QStringLiteral( "PositionTracking/TrackingLayer" ), QString() );
+}
+

app/activeproject.h

@@ -18,7 +18,7 @@
 #include "inputconfig.h"
 #include "appsettings.h"
 #include "activelayer.h"
-#include "layersproxymodel.h"
+#include "recordinglayersproxymodel.h"
 #include "localprojectsmanager.h"
 #include "autosynccontroller.h"
 #include "inputmapsettings.h"
@@ -116,12 +116,21 @@ class ActiveProject: public QObject
 
     //! Returns true if the project has at least one layer that allows recording
     Q_INVOKABLE bool projectHasRecordingLayers() const;
+
     /**
      * Returns role/permission level of current user for this project
      */
     Q_INVOKABLE QString projectRole() const;
     void setProjectRole( const QString &role );
 
+    /**
+     * Returns true if the layer allows recording:
+     */
+    bool recordingAllowed( QgsMapLayer *layer ) const ;
+
+    //! Returns position tracking layer ID if exists
+    Q_INVOKABLE QString positionTrackingLayerId() const;
+
   signals:
     void qgsProjectChanged();
     void localProjectChanged( LocalProject project );

app/inpututils.cpp

@@ -2257,20 +2257,6 @@ bool InputUtils::isPositionTrackingLayer( QgsMapLayer *layer, QgsProject *projec
   return layer->id() == trackingLayerId;
 }
 
-bool InputUtils::recordingAllowed( QgsMapLayer *layer, QgsProject *project )
-{
-  if ( !layer || !layer->isValid() || !project )
-    return false;
-
-  QgsVectorLayer *vectorLayer = qobject_cast<QgsVectorLayer *>( layer );
-
-  return ( vectorLayer &&
-           !vectorLayer->readOnly() &&
-           layerHasGeometry( vectorLayer ) &&
-           layerVisible( layer, project ) &&
-           !isPositionTrackingLayer( layer, project ) );
-}
-
 QgsMapLayer *InputUtils::mapLayerFromName( const QString &layerName, QgsProject *project )
 {
   if ( !project || layerName.isEmpty() )

app/inpututils.h

@@ -604,11 +604,6 @@ class InputUtils: public QObject
      */
     Q_INVOKABLE static bool isPositionTrackingLayer( QgsMapLayer *layer, QgsProject *project );
 
-    /**
-     * Returns true if the layer allows recording
-     */
-    static bool recordingAllowed( QgsMapLayer *layer, QgsProject *project );
-
     /**
      * Returns QgsMapLayer pointer for given layer name and project.
      * If layer with given name does not exist or there is no project, returns nullptr.

app/layersmodel.cpp

@@ -54,6 +54,7 @@ QVariant LayersModel::data( const QModelIndex &index, int role ) const
       else return MMStyle::rasterLayerNoColorOverlayIcon();
     }
     case LayerIdRole: return layer->id();
+    case LayerVisible: return ( mProject && InputUtils::layerVisible( layer, mProject ) );
   }
   return QVariant();
 }

app/layersmodel.h

@@ -15,6 +15,7 @@
 #include <QPointer>
 
 #include "inputconfig.h"
+#include "inpututils.h"
 #include "qgsmaplayer.h"
 #include "qgsmaplayermodel.h"
 
@@ -37,7 +38,8 @@ class LayersModel : public QgsMapLayerModel
       VectorLayerRole,
       HasGeometryRole,
       IconSourceRole,
-      LayerIdRole
+      LayerIdRole,
+      LayerVisible
     };
     Q_ENUM( LayerRoles )
 

app/main.cpp

@@ -46,7 +46,7 @@
 #include "merginsubscriptioninfo.h"
 #include "merginsubscriptionstatus.h"
 #include "merginprojectstatusmodel.h"
-#include "layersproxymodel.h"
+#include "recordinglayersproxymodel.h"
 #include "layersmodel.h"
 #include "activelayer.h"
 #include "merginuserauth.h"
@@ -350,7 +350,7 @@ void initDeclarative()
   qmlRegisterType< MeasurementMapTool >( "mm", 1, 0, "MeasurementMapTool" );
 
   // layers model
-  qmlRegisterType<LayersProxyModel>( "mm", 1, 0, "LayersProxyModel" );
+  qmlRegisterType<RecordingLayersProxyModel>( "mm", 1, 0, "RecordingLayersProxyModel" );
   qmlRegisterType<LayersModel>( "mm", 1, 0, "LayersModel" );
 }
 

app/qml/map/MMMapController.qml

@@ -814,11 +814,10 @@ Item {
 
       onClosed: activeLayerPanelLoader.active = false
 
-      list.model: MM.LayersProxyModel {
+      list.model: MM.RecordingLayersProxyModel {
         id: recordingLayersModel
 
-        qgsProject: __activeProject.qgsProject
-        modelType: MM.LayersProxyModel.ActiveLayerSelection
+        exceptedLayerIds: __activeProject.positionTrackingLayerId()
         model: MM.LayersModel {}
       }
 

app/layersproxymodel.cpp app/recordinglayersproxymodel.cppapp/layersproxymodel.cpp renamed to app/recordinglayersproxymodel.cpp

@@ -8,21 +8,19 @@
  ***************************************************************************/
 
 #include "qgsvectorlayer.h"
-#include "layersproxymodel.h"
+#include "recordinglayersproxymodel.h"
 
 #include "qgsproject.h"
 #include "qgslayertree.h"
 
-LayersProxyModel::LayersProxyModel( QObject *parent ) :
+RecordingLayersProxyModel::RecordingLayersProxyModel( QObject *parent ) :
   QgsMapLayerProxyModel{ parent }
 {
-  QObject::connect( this, &LayersProxyModel::rowsInserted, this, &LayersProxyModel::countChanged );
-  QObject::connect( this, &LayersProxyModel::rowsRemoved, this, &LayersProxyModel::countChanged );
-
-  updateFilterFunction();
+  QObject::connect( this, &RecordingLayersProxyModel::rowsInserted, this, &RecordingLayersProxyModel::countChanged );
+  QObject::connect( this, &RecordingLayersProxyModel::rowsRemoved, this, &RecordingLayersProxyModel::countChanged );
 }
 
-bool LayersProxyModel::filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const
+bool RecordingLayersProxyModel::filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const
 {
   if ( !QgsMapLayerProxyModel::filterAcceptsRow( source_row, source_parent ) )
     return false;
@@ -31,10 +29,10 @@ bool LayersProxyModel::filterAcceptsRow( int source_row, const QModelIndex &sour
   QModelIndex index = mModel->index( source_row, 0, source_parent );
   QgsMapLayer *layer = mModel->layerFromIndex( index );
 
-  return filterFunction( layer );
+  return mModel->data( index, LayersModel::LayerVisible ).toBool();
 }
 
-QList<QgsMapLayer *> LayersProxyModel::layers() const
+QList<QgsMapLayer *> RecordingLayersProxyModel::layers() const
 {
   QList<QgsMapLayer *> filteredLayers;
 
@@ -52,12 +50,12 @@ QList<QgsMapLayer *> LayersProxyModel::layers() const
   return filteredLayers;
 }
 
-void LayersProxyModel::refreshData()
+void RecordingLayersProxyModel::refreshData()
 {
   invalidate();
 }
 
-QgsMapLayer *LayersProxyModel::firstUsableLayer() const
+QgsMapLayer *RecordingLayersProxyModel::firstUsableLayer() const
 {
   QList<QgsMapLayer *> filteredLayers = layers();
 
@@ -69,7 +67,7 @@ QgsMapLayer *LayersProxyModel::firstUsableLayer() const
   return nullptr;
 }
 
-QModelIndex LayersProxyModel::indexFromLayerId( QString layerId ) const
+QModelIndex RecordingLayersProxyModel::indexFromLayerId( QString layerId ) const
 {
   if ( layerId.isEmpty() )
     return QModelIndex();
@@ -79,7 +77,7 @@ QModelIndex LayersProxyModel::indexFromLayerId( QString layerId ) const
   return mModel->indexFromLayer( layer ); // return source model index to skip converting indexes in proxy model
 }
 
-QgsVectorLayer *LayersProxyModel::layerFromLayerId( QString layerId ) const
+QgsVectorLayer *RecordingLayersProxyModel::layerFromLayerId( QString layerId ) const
 {
   QList<QgsMapLayer *> filteredLayers = layers();
 
@@ -95,7 +93,7 @@ QgsVectorLayer *LayersProxyModel::layerFromLayerId( QString layerId ) const
   return nullptr;
 }
 
-QgsVectorLayer *LayersProxyModel::layerFromLayerName( const QString &layerName ) const
+QgsVectorLayer *RecordingLayersProxyModel::layerFromLayerName( const QString &layerName ) const
 {
   QList<QgsMapLayer *> filteredLayers = layers();
 
@@ -111,76 +109,23 @@ QgsVectorLayer *LayersProxyModel::layerFromLayerName( const QString &layerName )
   return nullptr;
 }
 
-QVariant LayersProxyModel::getData( QModelIndex index, int role ) const
+QVariant RecordingLayersProxyModel::getData( QModelIndex index, int role ) const
 {
   return sourceModel()->data( index, role );
 }
 
-QgsProject *LayersProxyModel::qgsProject() const
-{
-  return mProject;
-}
-
-void LayersProxyModel::setQgsProject( QgsProject *project )
-{
-  if ( mProject != project )
-  {
-    mProject = project;
-    emit qgsProjectChanged();
-  }
-}
-
-LayersProxyModel::LayerModelTypes LayersProxyModel::modelType() const
-{
-  return mModelType;
-}
-
-void LayersProxyModel::setModelType( LayerModelTypes type )
-{
-  if ( mModelType != type )
-  {
-    mModelType = type;
-
-    updateFilterFunction();
-
-    emit modelTypeChanged();
-  }
-}
-
-LayersModel *LayersProxyModel::model() const
+LayersModel *RecordingLayersProxyModel::model() const
 {
   return mModel;
 }
 
-void LayersProxyModel::setModel( LayersModel *model )
+void RecordingLayersProxyModel::setModel( LayersModel *model )
 {
   if ( mModel != model )
   {
     mModel = model;
     setSourceModel( mModel );
+    setFilters( Qgis::LayerFilter::HasGeometry | Qgis::LayerFilter::WritableLayer );
     emit modelChanged();
   }
 }
-
-void LayersProxyModel::updateFilterFunction()
-{
-  beginResetModel();
-
-  switch ( mModelType )
-  {
-    case ActiveLayerSelection:
-      filterFunction = [this]( QgsMapLayer * layer )
-      {
-        return InputUtils::recordingAllowed( layer, mProject );
-      };
-      break;
-    default:
-      filterFunction = []( QgsMapLayer * )
-      {
-        return true;
-      };
-      break;
-  }
-
-  endResetModel();
-}