[api] Add a new QgsZipUtils::unzip() parameter to skip consistency check

nirvn · github-actions[bot] · commit a02d15ea8976 · 2023-03-14T07:11:35.000Z
diff --git a/python/core/auto_generated/qgsziputils.sip.in b/python/core/auto_generated/qgsziputils.sip.in
@@ -25,12 +25,13 @@ extension, ``False`` otherwise.
 :return: ``True`` if the file is zipped, ``False`` otherwise
 %End
 
-  bool unzip( const QString &zip, const QString &dir, QStringList &files /Out/ );
+  bool unzip( const QString &zip, const QString &dir, QStringList &files /Out/, bool checkConsistency = true );
 %Docstring
 Unzip a zip file in an output directory.
 
 :param zip: The zip filename
 :param dir: The output directory
+:param checkConsistency: Perform additional stricter consistency checks on the archive, and error if they fail (since QGIS 3.30)
 
 :return: - ``False`` if the zip filename does not exist, the output directory
          - files: The absolute path of unzipped files
diff --git a/src/core/qgsziputils.cpp b/src/core/qgsziputils.cpp
@@ -34,7 +34,7 @@ bool QgsZipUtils::isZipFile( const QString &filename )
   return QFileInfo( filename ).suffix().compare( QLatin1String( "qgz" ), Qt::CaseInsensitive ) == 0;
 }
 
-bool QgsZipUtils::unzip( const QString &zipFilename, const QString &dir, QStringList &files )
+bool QgsZipUtils::unzip( const QString &zipFilename, const QString &dir, QStringList &files, bool checkConsistency )
 {
   files.clear();
 
@@ -66,7 +66,7 @@ bool QgsZipUtils::unzip( const QString &zipFilename, const QString &dir, QString
 
   int rc = 0;
   const QByteArray fileNamePtr = zipFilename.toUtf8();
-  struct zip *z = zip_open( fileNamePtr.constData(), ZIP_CHECKCONS, &rc );
+  struct zip *z = zip_open( fileNamePtr.constData(), checkConsistency ? ZIP_CHECKCONS : 0, &rc );
 
   if ( rc == ZIP_ER_OK && z )
   {
diff --git a/src/core/qgsziputils.h b/src/core/qgsziputils.h
@@ -42,11 +42,12 @@ namespace QgsZipUtils
    * \param zip The zip filename
    * \param dir The output directory
    * \param files The absolute path of unzipped files
+   * \param checkConsistency Perform additional stricter consistency checks on the archive, and error if they fail (since QGIS 3.30)
    * \returns FALSE if the zip filename does not exist, the output directory
    * does not exist or is not writable.
    * \since QGIS 3.0
    */
-  CORE_EXPORT bool unzip( const QString &zip, const QString &dir, QStringList &files SIP_OUT );
+  CORE_EXPORT bool unzip( const QString &zip, const QString &dir, QStringList &files SIP_OUT, bool checkConsistency = true );
 
   /**
    * Zip the list of files in the zip file. If the zip file already exists or is

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ bool QgsZipUtils::isZipFile( const QString &filename )`
`34`	`34`	`return QFileInfo( filename ).suffix().compare( QLatin1String( "qgz" ), Qt::CaseInsensitive ) == 0;`
`35`	`35`	`}`
`36`	`36`
`37`		`-bool QgsZipUtils::unzip( const QString &zipFilename, const QString &dir, QStringList &files )`
	`37`	`+bool QgsZipUtils::unzip( const QString &zipFilename, const QString &dir, QStringList &files, bool checkConsistency )`
`38`	`38`	`{`
`39`	`39`	`files.clear();`
`40`	`40`
`@@ -66,7 +66,7 @@ bool QgsZipUtils::unzip( const QString &zipFilename, const QString &dir, QString`
`66`	`66`
`67`	`67`	`int rc = 0;`
`68`	`68`	`const QByteArray fileNamePtr = zipFilename.toUtf8();`
`69`		`- struct zip *z = zip_open( fileNamePtr.constData(), ZIP_CHECKCONS, &rc );`
	`69`	`+ struct zip *z = zip_open( fileNamePtr.constData(), checkConsistency ? ZIP_CHECKCONS : 0, &rc );`
`70`	`70`
`71`	`71`	`if ( rc == ZIP_ER_OK && z )`
`72`	`72`	`{`