Add QgsProject::getAttachmentIdentifier and QgsProject::resolveAttachementIdentifier

manisandro · manisandro · commit c57509d79fda · 2021-07-26T17:20:16.000+02:00
diff --git a/python/core/auto_generated/project/qgsproject.sip.in b/python/core/auto_generated/project/qgsproject.sip.in
@@ -1295,6 +1295,28 @@ Removes the attached file
 
 .. seealso:: :py:func:`createAttachedFile`
 
+.. versionadded:: 3.22
+%End
+
+    QString getAttachmentIdentifier( const QString &attachedFile ) const;
+%Docstring
+Returns an identifier for an attachment file path
+
+:param attachedFile: An attachment file path
+
+:return: An identifier for the attached file
+
+.. versionadded:: 3.22
+%End
+
+    QString resolveAttachementIdentifier( const QString &identifier ) const;
+%Docstring
+Resolves an attachment identifier to a attachment file path
+
+:param identifier: An attachment identifier
+
+:return: The attachment file path, or an empty string if the identifier is invalid
+
 .. versionadded:: 3.22
 %End
 
diff --git a/src/core/project/qgsproject.cpp b/src/core/project/qgsproject.cpp
@@ -3700,6 +3700,20 @@ bool QgsProject::removeAttachedFile( const QString &path )
   return mArchive->removeFile( path );
 }
 
+QString QgsProject::getAttachmentIdentifier( const QString &attachedFile ) const
+{
+  return QStringLiteral( "attachment:///%1" ).arg( QFileInfo( attachedFile ).fileName() );
+}
+
+QString QgsProject::resolveAttachementIdentifier( const QString &identifier ) const
+{
+  if ( identifier.startsWith( "attachment:///" ) )
+  {
+    return QDir( mArchive->dir() ).absoluteFilePath( identifier.mid( 14 ) );
+  }
+  return QString();
+}
+
 const QgsProjectMetadata &QgsProject::metadata() const
 {
   return mMetadata;
diff --git a/src/core/project/qgsproject.h b/src/core/project/qgsproject.h
@@ -1362,6 +1362,22 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera
      */
     bool removeAttachedFile( const QString &path );
 
+    /**
+     * Returns an identifier for an attachment file path
+     * \param attachedFile An attachment file path
+     * \return An identifier for the attached file
+     * \since QGIS 3.22
+     */
+    QString getAttachmentIdentifier( const QString &attachedFile ) const;
+
+    /**
+     * Resolves an attachment identifier to a attachment file path
+     * \param identifier An attachment identifier
+     * \return The attachment file path, or an empty string if the identifier is invalid
+     * \since QGIS 3.22
+     */
+    QString resolveAttachementIdentifier( const QString &identifier ) const;
+
     /**
      * Returns a reference to the project's metadata store.
      * \see setMetadata()
diff --git a/tests/src/core/testqgsproject.cpp b/tests/src/core/testqgsproject.cpp
@@ -58,6 +58,7 @@ class TestQgsProject : public QObject
     void testDefaultRelativePaths();
     void testAttachmentsQgs();
     void testAttachmentsQgz();
+    void testAttachmentIdentifier();
 };
 
 void TestQgsProject::init()
@@ -884,6 +885,18 @@ void TestQgsProject::testAttachmentsQgz()
 
 }
 
+void TestQgsProject::testAttachmentIdentifier()
+{
+  // Verify attachment identifiers
+  {
+    QgsProject p;
+    QString attachmentFileName = p.createAttachedFile( "test.jpg" );
+    QString attachmentId = p.getAttachmentIdentifier( attachmentFileName );
+    QCOMPARE( p.resolveAttachementIdentifier( attachmentId ), attachmentFileName );
+  }
+
+}
+
 
 QGSTEST_MAIN( TestQgsProject )
 #include "testqgsproject.moc"
