Add history item to metadata

qgis · May 3, 2017 · bf2ce3d · bf2ce3d
1 parent b2f52d8
commit bf2ce3d
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 0 deletions.
diff --git a/python/core/metadata/qgslayermetadata.sip b/python/core/metadata/qgslayermetadata.sip
@@ -355,6 +355,28 @@ class QgsLayerMetadata
  \see licenses()
 %End
 
+    QStringList history() const;
+%Docstring
+ Returns a freeform description of the history or lineage of the resource.
+ \see setHistory()
+ :rtype: list of str
+%End
+
+    void setHistory( const QStringList &history );
+%Docstring
+ Sets the freeform description of the ``history`` or lineage of the resource.
+ Any existing history items will be overwritten.
+ \see addHistoryItem()
+ \see history()
+%End
+
+    void addHistoryItem( const QString &text );
+%Docstring
+ Adds a single history ``text`` to the end of the existing history list.
+ \see history()
+ \see setHistory()
+%End
+
     QString encoding() const;
 %Docstring
  Returns the character encoding of the data in the resource. An empty string will be returned if no encoding is set.

diff --git a/src/core/metadata/qgslayermetadata.cpp b/src/core/metadata/qgslayermetadata.cpp
@@ -108,6 +108,21 @@ void QgsLayerMetadata::setLicenses( const QStringList &licenses )
   mLicenses = licenses;
 }
 
+QStringList QgsLayerMetadata::history() const
+{
+  return mHistory;
+}
+
+void QgsLayerMetadata::setHistory( const QStringList &history )
+{
+  mHistory = history;
+}
+
+void QgsLayerMetadata::addHistoryItem( const QString &text )
+{
+  mHistory << text;
+}
+
 QString QgsLayerMetadata::encoding() const
 {
   return mEncoding;
@@ -204,6 +219,7 @@ void QgsLayerMetadata::saveToLayer( QgsMapLayer *layer ) const
   layer->setCustomProperty( QStringLiteral( "metadata/fees" ), mFees );
   layer->setCustomProperty( QStringLiteral( "metadata/rights" ), mRights );
   layer->setCustomProperty( QStringLiteral( "metadata/licenses" ), mLicenses );
+  layer->setCustomProperty( QStringLiteral( "metadata/history" ), mHistory );
   layer->setCustomProperty( QStringLiteral( "metadata/encoding" ), mEncoding );
   layer->setCustomProperty( QStringLiteral( "metadata/crs" ), mCrs.authid() );
   layer->setCustomProperty( QStringLiteral( "metadata/constraints" ), QVariant::fromValue( mConstraints ) );
@@ -223,6 +239,7 @@ void QgsLayerMetadata::readFromLayer( const QgsMapLayer *layer )
   mFees = layer->customProperty( QStringLiteral( "metadata/fees" ) ).toString();
   mRights = layer->customProperty( QStringLiteral( "metadata/rights" ) ).toStringList();
   mLicenses = layer->customProperty( QStringLiteral( "metadata/licenses" ) ).toStringList();
+  mHistory = layer->customProperty( QStringLiteral( "metadata/history" ) ).toStringList();
   mEncoding = layer->customProperty( QStringLiteral( "metadata/encoding" ) ).toString();
   QString crsAuthId = layer->customProperty( QStringLiteral( "metadata/crs" ) ).toString();
   mCrs = QgsCoordinateReferenceSystem::fromOgcWmsCrs( crsAuthId );

diff --git a/src/core/metadata/qgslayermetadata.h b/src/core/metadata/qgslayermetadata.h
@@ -395,6 +395,27 @@ class CORE_EXPORT QgsLayerMetadata
      */
     void setLicenses( const QStringList &licenses );
 
+    /**
+     * Returns a freeform description of the history or lineage of the resource.
+     * \see setHistory()
+     */
+    QStringList history() const;
+
+    /**
+     * Sets the freeform description of the \a history or lineage of the resource.
+     * Any existing history items will be overwritten.
+     * \see addHistoryItem()
+     * \see history()
+     */
+    void setHistory( const QStringList &history );
+
+    /**
+     * Adds a single history \a text to the end of the existing history list.
+     * \see history()
+     * \see setHistory()
+     */
+    void addHistoryItem( const QString &text );
+
     /**
      * Returns the character encoding of the data in the resource. An empty string will be returned if no encoding is set.
      * \see setEncoding()
@@ -572,6 +593,7 @@ class CORE_EXPORT QgsLayerMetadata
     ConstraintList mConstraints;
     QStringList mRights;
     QStringList mLicenses;
+    QStringList mHistory;
 
     // IMPORTANT - look up before adding anything here!!
 

diff --git a/tests/src/python/test_qgslayermetadata.py b/tests/src/python/test_qgslayermetadata.py
@@ -59,6 +59,13 @@ def testGettersSetters(self):
         m.setLicenses(['l a', 'l b'])
         self.assertEqual(m.licenses(), ['l a', 'l b'])
 
+        m.setHistory(['loaded into QGIS'])
+        self.assertEqual(m.history(), ['loaded into QGIS'])
+        m.setHistory(['accidentally deleted some features'])
+        self.assertEqual(m.history(), ['accidentally deleted some features'])
+        m.addHistoryItem('panicked and deleted more')
+        self.assertEqual(m.history(), ['accidentally deleted some features', 'panicked and deleted more'])
+
         m.setEncoding('encoding')
         self.assertEqual(m.encoding(), 'encoding')
 
@@ -192,6 +199,7 @@ def createTestMetadata(self):
         m.setConstraints([QgsLayerMetadata.Constraint('None', 'access')])
         m.setRights(['Copyright foo 2017'])
         m.setLicenses(['WTFPL'])
+        m.setHistory(['history a', 'history b'])
         m.setKeywords({'GEMET': ['kw1', 'kw2']})
         m.setEncoding('utf-8')
         m.setCrs(QgsCoordinateReferenceSystem.fromOgcWmsCrs('EPSG:4326'))
@@ -254,6 +262,7 @@ def checkExpectedMetadata(self, m):
         self.assertEqual(m.constraints()[0].type, 'access')
         self.assertEqual(m.rights(), ['Copyright foo 2017'])
         self.assertEqual(m.licenses(), ['WTFPL'])
+        self.assertEqual(m.history(), ['history a', 'history b'])
         self.assertEqual(m.encoding(), 'utf-8')
         self.assertEqual(m.keywords(), {'GEMET': ['kw1', 'kw2']})
         self.assertEqual(m.crs().authid(), 'EPSG:4326')