[FEATURE] Projects in PostgreSQL

Merge of pull request #6752
qgis · Apr 9, 2018 · f378a23 · f378a23
2 parents bff8976 + d6e7043
commit f378a23
Show file tree

Hide file tree

Showing 56 changed files with 1,979 additions and 88 deletions.
diff --git a/python/core/core_auto.sip b/python/core/core_auto.sip
@@ -91,6 +91,8 @@
 %Include qgsprojectbadlayerhandler.sip
 %Include qgsprojectfiletransform.sip
 %Include qgsprojectproperty.sip
+%Include qgsprojectstorage.sip
+%Include qgsprojectstorageregistry.sip
 %Include qgsprojectversion.sip
 %Include qgsproperty.sip
 %Include qgspropertycollection.sip

diff --git a/python/core/qgsapplication.sip.in b/python/core/qgsapplication.sip.in
@@ -735,6 +735,13 @@ Returns registry of available 3D renderers.
    not available in Python bindings
 
 .. versionadded:: 3.0
+%End
+
+    static QgsProjectStorageRegistry *projectStorageRegistry();
+%Docstring
+Returns registry of available project storage implementations.
+
+.. versionadded:: 3.2
 %End
 
     static QString nullRepresentation();

diff --git a/python/core/qgsdataitem.sip.in b/python/core/qgsdataitem.sip.in
@@ -586,6 +586,9 @@ Data item that can be used to represent QGIS projects.
 
     virtual bool hasDragEnabled() const;
 
+    virtual QgsMimeDataUtils::Uri mimeUri() const;
+
+
 };
 
 class QgsErrorItem : QgsDataItem

diff --git a/python/core/qgsdatasourceuri.sip.in b/python/core/qgsdatasourceuri.sip.in
@@ -274,6 +274,20 @@ Returns the srid
     void setSrid( const QString &srid );
 %Docstring
 Sets the srid
+%End
+
+    static SslMode decodeSslMode( const QString &sslMode );
+%Docstring
+Decodes SSL mode string into enum value. If the string is not recognized, SslPrefer is returned.
+
+.. versionadded:: 3.2
+%End
+
+    static QString encodeSslMode( SslMode sslMode );
+%Docstring
+Encodes SSL mode enum value into a string.
+
+.. versionadded:: 3.2
 %End
 
 };

diff --git a/python/core/qgsproject.sip.in b/python/core/qgsproject.sip.in
@@ -97,13 +97,51 @@ representation.
 .. seealso:: :py:func:`fileInfo`
 %End
 
-    QFileInfo fileInfo() const;
+ QFileInfo fileInfo() const /Deprecated/;
 %Docstring
 Returns QFileInfo object for the project's associated file.
 
+.. note::
+
+   The use of this method is discouraged since QGIS 3.2 as it only works with project files stored
+   in the file system. It is recommended to use absoluteFilePath(), baseName(), lastModifiedTime() as
+   replacements that are aware of the fact that projects may be saved in other project storages.
+
 .. seealso:: :py:func:`fileName`
 
 .. versionadded:: 2.9
+\deprecated
+%End
+
+    QgsProjectStorage *projectStorage() const;
+%Docstring
+Returns pointer to project storage implementation that handles read/write of the project file.
+If the project file is stored in the local file system, returns null pointer.
+The project storage object is inferred from fileName() of the project.
+
+.. versionadded:: 3.2
+%End
+
+    QDateTime lastModified() const;
+%Docstring
+Returns last modified time of the project file as returned by the file system (or other project storage).
+
+.. versionadded:: 3.2
+%End
+
+    QString absoluteFilePath() const;
+%Docstring
+Returns full absolute path to the project file if the project is stored in a file system - derived from fileName().
+Returns empty string when the project is stored in a project storage (there is no concept of paths for custom project storages).
+
+.. versionadded:: 3.2
+%End
+
+    QString baseName() const;
+%Docstring
+Returns the base name of the project file without the path and without extension - derived from fileName().
+
+.. versionadded:: 3.2
 %End
 
     QgsCoordinateReferenceSystem crs() const;

diff --git a/python/core/qgsprojectstorage.sip.in b/python/core/qgsprojectstorage.sip.in
@@ -0,0 +1,117 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgsprojectstorage.h                                         *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+
+class QgsProjectStorage
+{
+%Docstring
+Abstract interface for project storage - to be implemented by various backends
+and registered in QgsProjectStorageRegistry.
+
+.. versionadded:: 3.2
+%End
+
+%TypeHeaderCode
+#include "qgsprojectstorage.h"
+%End
+  public:
+
+    class Metadata
+{
+%Docstring
+Metadata associated with a project
+
+.. versionadded:: 3.2
+%End
+
+%TypeHeaderCode
+#include "qgsprojectstorage.h"
+%End
+      public:
+        QString name;
+        QDateTime lastModified;
+    };
+
+    virtual ~QgsProjectStorage();
+
+    virtual QString type() = 0;
+%Docstring
+Unique identifier of the project storage type. If type() returns "memory", all project file names
+starting with "memory:" will have read/write redirected through that storage implementation.
+%End
+
+    virtual QStringList listProjects( const QString &uri ) = 0;
+%Docstring
+Returns list of all projects for given URI (specific to each storage backend)
+%End
+
+    virtual bool readProject( const QString &uri, QIODevice *device, QgsReadWriteContext &context ) = 0;
+%Docstring
+Reads project file content stored in the backend at the specified URI to the given device
+(could be e.g. a temporary file or a memory buffer). The device is expected to be empty
+when passed to readProject() so that the method can write all data to it and then rewind
+it using seek(0) to make it ready for reading in :py:class:`QgsProject`.
+%End
+
+    virtual bool writeProject( const QString &uri, QIODevice *device, QgsReadWriteContext &context ) = 0;
+%Docstring
+Writes project file content stored in given device (could be e.g. a temporary file or a memory buffer)
+using the backend to the specified URI. The device is expected to contain all project file data
+and having position at the start of the content when passed to writeProject() so that the method
+can read all data from it until it reaches its end.
+%End
+
+    virtual bool removeProject( const QString &uri ) = 0;
+%Docstring
+Removes an existing project at the given URI. Returns true if the removal
+was successful.
+%End
+
+    virtual bool renameProject( const QString &uri, const QString &uriNew );
+%Docstring
+Rename an existing project at the given URI to a different URI. Returns true if renaming
+was successful.
+%End
+
+    virtual bool readProjectStorageMetadata( const QString &uri, QgsProjectStorage::Metadata &metadata /Out/ );
+%Docstring
+Reads project metadata (e.g. last modified time) if this is supported by the storage implementation.
+Returns true if the metadata were read with success.
+%End
+
+    virtual QString visibleName();
+%Docstring
+Returns human-readable name of the storage. Used as the menu item text in QGIS. Empty name
+indicates that the storage does not implement GUI support (showLoadGui() and showSaveGui()).
+The name may be translatable and ideally unique as well.
+%End
+
+    virtual QString showLoadGui();
+%Docstring
+Opens GUI to allow user to select a project to be loaded (GUI specific to this storage type).
+Returns project URI if user has picked a project or empty string if the GUI was canceled.
+%End
+
+    virtual QString showSaveGui();
+%Docstring
+Opens GUI to allow user to select where a project should be saved (GUI specific to this storage type).
+Returns project URI if user has picked a destination or empty string if the GUI was canceled.
+%End
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgsprojectstorage.h                                         *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/core/qgsprojectstorageregistry.sip.in b/python/core/qgsprojectstorageregistry.sip.in
@@ -0,0 +1,61 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgsprojectstorageregistry.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+
+class QgsProjectStorageRegistry
+{
+%Docstring
+Registry of storage backends that QgsProject may use.
+This is a singleton that should be accessed through :py:func:`QgsApplication.projectStorageRegistry()`
+
+.. versionadded:: 3.2
+%End
+
+%TypeHeaderCode
+#include "qgsprojectstorageregistry.h"
+%End
+  public:
+    ~QgsProjectStorageRegistry();
+
+    QgsProjectStorage *projectStorageFromType( const QString &type );
+%Docstring
+Returns storage implementation if the storage type matches one. Returns null pointer otherwise (it is a normal file)
+%End
+
+    QgsProjectStorage *projectStorageFromUri( const QString &uri );
+%Docstring
+Returns storage implementation if the URI matches one. Returns null pointer otherwise (it is a normal file)
+%End
+
+    QList<QgsProjectStorage *> projectStorages() const;
+%Docstring
+Returns a list of registered project storage implementations
+%End
+
+    void registerProjectStorage( QgsProjectStorage *storage /Transfer/ );
+%Docstring
+Registers a storage backend and takes ownership of it
+%End
+
+    void unregisterProjectStorage( QgsProjectStorage *storage );
+%Docstring
+Unregisters a storage backend and destroys its instance
+%End
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/core/qgsprojectstorageregistry.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/gui/qgsbrowserdockwidget.sip.in b/python/gui/qgsbrowserdockwidget.sip.in
@@ -116,7 +116,7 @@ Splitter has been moved
 %End
 
   signals:
-    void openFile( const QString & );
+    void openFile( const QString &fileName, const QString &fileTypeHint = QString() );
 %Docstring
 Emitted when a file needs to be opened
 %End