Merge pull request #36421 from 3nids/basemap_path

Registry for localized data paths
qgis · May 19, 2020 · cc19fa1 · cc19fa1
2 parents 8249dcc + 1befc32
commit cc19fa1
Show file tree

Hide file tree

Showing 14 changed files with 596 additions and 46 deletions.
diff --git a/python/core/auto_generated/qgsapplication.sip.in b/python/core/auto_generated/qgsapplication.sip.in
@@ -857,6 +857,17 @@ Gets the registry of available scalebar renderers.
 Returns registry of available project storage implementations.
 
 .. versionadded:: 3.2
+%End
+
+    static QgsLocalizedDataPathRegistry *localizedDataPathRegistry() /KeepReference/;
+%Docstring
+Returns the registry of data repositories
+These are used as paths for basemaps, logos, etc. which can be referenced
+differently across work stations.
+
+.. seealso:: :py:class:`QgsLocalizedDataPathRegistry`
+
+.. versionadded:: 3.14
 %End
 
     static QString nullRepresentation();

diff --git a/python/core/auto_generated/qgslocalizeddatapathregistry.sip.in b/python/core/auto_generated/qgslocalizeddatapathregistry.sip.in
@@ -0,0 +1,71 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgslocalizeddatapathregistry.h                              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
+class QgsLocalizedDataPathRegistry
+{
+%Docstring
+A registry class to hold localized data paths which can be used for basemaps, logos, etc.
+Paths are meant to be absolute paths and are stored by order of preference.
+
+If a layer from one of the paths is loaded, it will be saved as localized in the project file.
+For instance, if you have C:\my_maps in your localized paths,
+C:\my_maps\my_country\ortho.tif will be save in your project as localized:my_country\ortho.tif
+
+The resolving of the file paths happens in QgsPathResolver.
+
+.. versionadded:: 3.14
+%End
+
+%TypeHeaderCode
+#include "qgslocalizeddatapathregistry.h"
+%End
+  public:
+    QgsLocalizedDataPathRegistry();
+
+    QString globalPath( const QString &localizedPath ) const;
+%Docstring
+Returns the global path if the file has been found in one of the paths, an empty string otherwise
+%End
+
+    QString localizedPath( const QString &globalPath ) const;
+%Docstring
+Returns the localized path if the file has been found in one of the path, an empty string otherwise
+%End
+
+    QStringList paths() const;
+%Docstring
+Returns a list of registered localized paths
+%End
+
+
+    void registerPath( const QString &path, int position = -1 );
+%Docstring
+Registers a localized path
+If ``position`` is given, the path is inserted at the given position in the list
+Since the paths are stored by order of preference, lower positions in the list take precedence.
+%End
+
+    void unregisterPath( const QString &path );
+%Docstring
+Unregisters a localized path
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgslocalizeddatapathregistry.h                              *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/core/core_auto.sip b/python/core/core_auto.sip
@@ -99,6 +99,7 @@
 %Include auto_generated/qgslegendsettings.sip
 %Include auto_generated/qgslegendstyle.sip
 %Include auto_generated/qgslocaldefaultsettings.sip
+%Include auto_generated/qgslocalizeddatapathregistry.sip
 %Include auto_generated/qgslogger.sip
 %Include auto_generated/qgsmapdecoration.sip
 %Include auto_generated/qgsmaphittest.sip

diff --git a/src/app/qgsoptions.cpp b/src/app/qgsoptions.cpp
@@ -40,6 +40,7 @@
 #include "qgsnumericformatwidget.h"
 
 #include "qgsattributetablefiltermodel.h"
+#include "qgslocalizeddatapathregistry.h"
 #include "qgsrasterformatsaveoptionswidget.h"
 #include "qgsrasterpyramidsoptionswidget.h"
 #include "qgsdatumtransformtablewidget.h"
@@ -308,6 +309,21 @@ QgsOptions::QgsOptions( QWidget *parent, Qt::WindowFlags fl, const QList<QgsOpti
   connect( mBtnAddTemplatePath, &QAbstractButton::clicked, this, &QgsOptions::addTemplatePath );
   connect( mBtnRemoveTemplatePath, &QAbstractButton::clicked, this, &QgsOptions::removeTemplatePath );
 
+  // localized data paths
+  connect( mLocalizedDataPathAddButton, &QAbstractButton::clicked, this, &QgsOptions::addLocalizedDataPath );
+  connect( mLocalizedDataPathRemoveButton, &QAbstractButton::clicked, this, &QgsOptions::removeLocalizedDataPath );
+  connect( mLocalizedDataPathUpButton, &QAbstractButton::clicked, this, &QgsOptions::moveLocalizedDataPathUp );
+  connect( mLocalizedDataPathDownButton, &QAbstractButton::clicked, this, &QgsOptions::moveLocalizedDataPathDown );
+
+  const QStringList localizedPaths = QgsApplication::localizedDataPathRegistry()->paths();
+  for ( const QString &path : localizedPaths )
+  {
+    QListWidgetItem *newItem = new QListWidgetItem( mLocalizedDataPathListWidget );
+    newItem->setText( path );
+    newItem->setFlags( Qt::ItemIsEditable | Qt::ItemIsEnabled | Qt::ItemIsSelectable );
+    mLocalizedDataPathListWidget->addItem( newItem );
+  }
+
   //paths hidden from browser
   const QStringList hiddenPathList = mSettings->value( QStringLiteral( "/browser/hiddenPaths" ) ).toStringList();
   for ( const QString &path : hiddenPathList )
@@ -1409,6 +1425,11 @@ void QgsOptions::saveOptions()
   }
   mSettings->setValue( QStringLiteral( "Layout/searchPathsForTemplates" ), pathsList, QgsSettings::Core );
 
+  pathsList.clear();
+  for ( int r = 0; r < mLocalizedDataPathListWidget->count(); r++ )
+    pathsList << mLocalizedDataPathListWidget->item( r )->text();
+  QgsApplication::localizedDataPathRegistry()->setPaths( pathsList );
+
   pathsList.clear();
   for ( int i = 0; i < mListHiddenBrowserPaths->count(); ++i )
   {
@@ -2528,6 +2549,55 @@ void QgsOptions::addColor()
   mTreeCustomColors->addColor( newColor, QgsSymbolLayerUtils::colorToName( newColor ) );
 }
 
+void QgsOptions::removeLocalizedDataPath()
+{
+  qDeleteAll( mLocalizedDataPathListWidget->selectedItems() );
+}
+
+void QgsOptions::addLocalizedDataPath()
+{
+  QString myDir = QFileDialog::getExistingDirectory(
+                    this,
+                    tr( "Choose a Directory" ),
+                    QDir::homePath(),
+                    QFileDialog::ShowDirsOnly
+                  );
+
+  if ( ! myDir.isEmpty() )
+  {
+    QListWidgetItem *newItem = new QListWidgetItem( mLocalizedDataPathListWidget );
+    newItem->setText( myDir );
+    newItem->setFlags( Qt::ItemIsEditable | Qt::ItemIsEnabled | Qt::ItemIsSelectable );
+    mLocalizedDataPathListWidget->addItem( newItem );
+    mLocalizedDataPathListWidget->setCurrentItem( newItem );
+  }
+}
+
+void QgsOptions::moveLocalizedDataPathUp()
+{
+  QList<QListWidgetItem *> selectedItems = mLocalizedDataPathListWidget->selectedItems();
+  QList<QListWidgetItem *>::iterator itemIt = selectedItems.begin();
+  for ( ; itemIt != selectedItems.end(); ++itemIt )
+  {
+    int row = mLocalizedDataPathListWidget->row( *itemIt );
+    mLocalizedDataPathListWidget->takeItem( row );
+    mLocalizedDataPathListWidget->insertItem( row - 1, *itemIt );
+  }
+}
+
+void QgsOptions::moveLocalizedDataPathDown()
+{
+  QList<QListWidgetItem *> selectedItems = mLocalizedDataPathListWidget->selectedItems();
+  QList<QListWidgetItem *>::iterator itemIt = selectedItems.begin();
+  for ( ; itemIt != selectedItems.end(); ++itemIt )
+  {
+    int row = mLocalizedDataPathListWidget->row( *itemIt );
+    mLocalizedDataPathListWidget->takeItem( row );
+    mLocalizedDataPathListWidget->insertItem( row + 1, *itemIt );
+  }
+}
+
+
 QListWidgetItem *QgsOptions::addScaleToScaleList( const QString &newScale )
 {
   QListWidgetItem *newItem = new QListWidgetItem( newScale );

diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h
@@ -241,6 +241,12 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
 
     void addColor();
 
+  private slots:
+    void removeLocalizedDataPath();
+    void addLocalizedDataPath();
+    void moveLocalizedDataPathUp();
+    void moveLocalizedDataPathDown();
+
   private:
     QgsSettings *mSettings = nullptr;
     QStringList i18nList();

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -306,6 +306,7 @@ SET(QGIS_CORE_SRCS
   qgslegendstyle.cpp
   qgslocaldefaultsettings.cpp
   qgslocalec.cpp
+  qgslocalizeddatapathregistry.cpp
   qgslogger.cpp
   qgsmapdecoration.cpp
   qgsmaphittest.cpp
@@ -854,6 +855,7 @@ SET(QGIS_CORE_HDRS
   qgslegendstyle.h
   qgslocaldefaultsettings.h
   qgslocalec.h
+  qgslocalizeddatapathregistry.h
   qgslogger.h
   qgsmapdecoration.h
   qgsmaphittest.h

diff --git a/src/core/qgsapplication.cpp b/src/core/qgsapplication.cpp
@@ -15,6 +15,7 @@
 
 #include "qgsapplication.h"
 #include "qgsauthmanager.h"
+#include "qgslocalizeddatapathregistry.h"
 #include "qgsdataitemproviderregistry.h"
 #include "qgsexception.h"
 #include "qgsgeometry.h"
@@ -2235,10 +2236,16 @@ QgsProjectStorageRegistry *QgsApplication::projectStorageRegistry()
   return members()->mProjectStorageRegistry;
 }
 
+QgsLocalizedDataPathRegistry *QgsApplication::localizedDataPathRegistry()
+{
+  return members()->mLocalizedDataPathRegistry;
+}
+
 QgsApplication::ApplicationMembers::ApplicationMembers()
 {
   // don't use initializer lists or scoped pointers - as more objects are added here we
   // will need to be careful with the order of creation/destruction
+  mLocalizedDataPathRegistry = new QgsLocalizedDataPathRegistry();
   mMessageLog = new QgsMessageLog();
   mProfiler = new QgsRuntimeProfiler();
 
@@ -2402,6 +2409,7 @@ QgsApplication::ApplicationMembers::~ApplicationMembers()
   delete mNumericFormatRegistry;
   delete mBookmarkManager;
   delete mConnectionRegistry;
+  delete mLocalizedDataPathRegistry;
 }
 
 QgsApplication::ApplicationMembers *QgsApplication::members()

diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h
@@ -32,6 +32,7 @@ class QgsFieldFormatterRegistry;
 class QgsColorSchemeRegistry;
 class QgsPaintEffectRegistry;
 class QgsProjectStorageRegistry;
+class QgsLocalizedDataPathRegistry;
 class QgsRendererRegistry;
 class QgsSvgCache;
 class QgsImageCache;
@@ -789,6 +790,15 @@ class CORE_EXPORT QgsApplication : public QApplication
      */
     static QgsProjectStorageRegistry *projectStorageRegistry() SIP_KEEPREFERENCE;
 
+    /**
+     * Returns the registry of data repositories
+     * These are used as paths for basemaps, logos, etc. which can be referenced
+     * differently across work stations.
+     * \see QgsLocalizedDataPathRegistry
+     * \since QGIS 3.14
+     */
+    static QgsLocalizedDataPathRegistry *localizedDataPathRegistry() SIP_KEEPREFERENCE;
+
     /**
      * This string is used to represent the value `NULL` throughout QGIS.
      *
@@ -913,6 +923,7 @@ class CORE_EXPORT QgsApplication : public QApplication
       QgsActionScopeRegistry *mActionScopeRegistry = nullptr;
       QgsAnnotationRegistry *mAnnotationRegistry = nullptr;
       QgsColorSchemeRegistry *mColorSchemeRegistry = nullptr;
+      QgsLocalizedDataPathRegistry *mLocalizedDataPathRegistry = nullptr;
       QgsNumericFormatRegistry *mNumericFormatRegistry = nullptr;
       QgsFieldFormatterRegistry *mFieldFormatterRegistry = nullptr;
       QgsGpsConnectionRegistry *mGpsConnectionRegistry = nullptr;

diff --git a/src/core/qgslocalizeddatapathregistry.cpp b/src/core/qgslocalizeddatapathregistry.cpp
@@ -0,0 +1,97 @@
+/***************************************************************************
+  qgslocalizeddatapathregistry.cpp
+  --------------------------------------
+  Date                 : May 2020
+  Copyright            : (C) 2020 by Denis Rouzaud
+  Email                : denis.rouzaud
+ ***************************************************************************
+ *                                                                         *
+ *   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 <QDir>
+
+#include "qgslocalizeddatapathregistry.h"
+#include "qgssettings.h"
+#include "qgis.h"
+#include "qgsreadwritelocker.h"
+
+
+QgsLocalizedDataPathRegistry::QgsLocalizedDataPathRegistry()
+{
+  readFromSettings();
+}
+
+QString QgsLocalizedDataPathRegistry::globalPath( const QString &relativePath ) const
+{
+  for ( const QDir &basePath : qgis::as_const( mPaths ) )
+    if ( basePath.exists( relativePath ) )
+      return basePath.absoluteFilePath( relativePath );
+
+  return QString();
+}
+
+QString QgsLocalizedDataPathRegistry::localizedPath( const QString &fullPath ) const
+{
+  for ( const QDir &basePath : qgis::as_const( mPaths ) )
+    if ( fullPath.startsWith( basePath.absolutePath() ) )
+      return basePath.relativeFilePath( fullPath );
+
+  return QString();
+
+}
+
+QStringList QgsLocalizedDataPathRegistry::paths() const
+{
+  QStringList paths;
+  for ( const QDir &dir : mPaths )
+    paths << dir.absolutePath();
+  return paths;
+}
+
+void QgsLocalizedDataPathRegistry::setPaths( const QStringList &paths )
+{
+  mPaths.clear();
+  for ( const QString &path : paths )
+  {
+    QDir dir( path );
+    if ( !mPaths.contains( dir ) )
+      mPaths << dir;
+  }
+
+  writeToSettings();
+}
+
+void QgsLocalizedDataPathRegistry::registerPath( const QString &path, int position )
+{
+  QDir dir( path );
+  if ( mPaths.contains( dir ) )
+    return;
+
+  if ( position >= 0 && position < mPaths.count() )
+    mPaths.insert( position, dir );
+  else
+    mPaths.append( dir );
+
+  writeToSettings();
+}
+
+void QgsLocalizedDataPathRegistry::unregisterPath( const QString &path )
+{
+  mPaths.removeAll( QDir( path ) );
+  writeToSettings();
+}
+
+void QgsLocalizedDataPathRegistry::readFromSettings()
+{
+  setPaths( QgsSettings().value( QStringLiteral( "/qgis/localized_data_paths" ) ).toStringList() );
+}
+
+void QgsLocalizedDataPathRegistry::writeToSettings()
+{
+  QgsSettings().setValue( QStringLiteral( "/qgis/localized_data_paths" ), paths() );
+}