[api] Add useful ZIP files listing function to QgsZipUtils

nirvn · nirvn · commit 4caeb63a4c72 · 2023-03-13T16:36:06.000+07:00
diff --git a/python/core/auto_generated/qgsziputils.sip.in b/python/core/auto_generated/qgsziputils.sip.in
@@ -56,6 +56,13 @@ also returned.
 
 
 
+  const QStringList files( const QString &zip );
+%Docstring
+Returns the list of files within a ``zip`` file
+
+.. versionadded:: 3.30
+%End
+
 };
 
 /************************************************************************
diff --git a/src/core/qgsziputils.cpp b/src/core/qgsziputils.cpp
@@ -293,3 +293,35 @@ bool QgsZipUtils::encodeGzip( const QByteArray &bytesIn, QByteArray &bytesOut )
   deflateEnd( &strm );
   return true;
 }
+
+const QStringList QgsZipUtils::files( const QString &zip )
+{
+  if ( zip.isEmpty() && !QFileInfo::exists( zip ) )
+  {
+    return QStringList();
+  }
+  QStringList files;
+
+  int rc = 0;
+  const QByteArray fileNamePtr = zip.toUtf8();
+  struct zip *z = zip_open( fileNamePtr.constData(), 0, &rc );
+
+  if ( rc == ZIP_ER_OK && z )
+  {
+    const int count = zip_get_num_files( z );
+    if ( count != -1 )
+    {
+      struct zip_stat stat;
+
+      for ( int i = 0; i < count; i++ )
+      {
+        zip_stat_index( z, i, 0, &stat );
+        files << QString( stat.name );
+      }
+    }
+
+    zip_close( z );
+  }
+
+  return files;
+}
diff --git a/src/core/qgsziputils.h b/src/core/qgsziputils.h
@@ -84,6 +84,13 @@ namespace QgsZipUtils
    */
   CORE_EXPORT bool encodeGzip( const QByteArray &bytesIn, QByteArray &bytesOut ) SIP_SKIP;
 
+  /**
+   * Returns the list of files within a \a zip file
+   *
+   * \since QGIS 3.30
+   */
+  CORE_EXPORT const QStringList files( const QString &zip );
+
 };
 
 #endif //QGSZIPUTILS_H
diff --git a/tests/src/python/test_qgsziputils.py b/tests/src/python/test_qgsziputils.py
@@ -121,6 +121,19 @@ def test_zip_unzip_ok(self):
         self.assertTrue(rc)
         self.assertEqual(len(files), 3)
 
+    def test_zip_files(self):
+        zip = tmpPath()
+
+        f0 = os.path.join(unitTestDataPath(), 'multipoint.shp')
+        f1 = os.path.join(unitTestDataPath(), 'lines.shp')
+        f2 = os.path.join(unitTestDataPath(), 'joins.qgs')
+
+        rc = QgsZipUtils.zip(zip, [f0, f1, f2])
+        self.assertTrue(rc)
+
+        files = QgsZipUtils.files(zip)
+        self.assertEqual(files, ['multipoint.shp', 'lines.shp', 'joins.qgs'])
+
 
 if __name__ == '__main__':
     unittest.main()
