zip extension version 1.22.0 for libzip 1.10.0

- add new error macros (ER_DATA_LENGTH and ER_NOT_ALLOWED)
- add new archive global flags (ER_AFL_*)
- add ZipArchive::setArchiveFlag and ZipArchive::getArchiveFlag methods

New methods are available since libzip 0.11,
but really usable with new global flags

Author: remicollet

ext/zip/php_zip.c

@@ -2097,6 +2097,40 @@ PHP_METHOD(ZipArchive, getArchiveComment)
 }
 /* }}} */
 
+PHP_METHOD(ZipArchive, setArchiveFlag)
+{
+	struct zip *intern;
+	zval *self = ZEND_THIS;
+	zend_long flag, value;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "ll", &flag, &value) == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	ZIP_FROM_OBJECT(intern, self);
+
+	if (zip_set_archive_flag(intern, flag, (int)value)) {
+		RETURN_FALSE;
+	} else {
+		RETURN_TRUE;
+	}
+}
+
+PHP_METHOD(ZipArchive, getArchiveFlag)
+{
+	struct zip *intern;
+	zval *self = ZEND_THIS;
+	zend_long flag, flags = 0;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS(), "l|l", &flag, &flags) == FAILURE) {
+		RETURN_THROWS();
+	}
+
+	ZIP_FROM_OBJECT(intern, self);
+
+	RETURN_LONG(zip_get_archive_flag(intern, flag, flags));
+}
+
 /* {{{ Set or remove (NULL/'') the comment of an entry using its Name */
 PHP_METHOD(ZipArchive, setCommentName)
 {

ext/zip/php_zip.h

@@ -31,7 +31,7 @@ extern zend_module_entry zip_module_entry;
 #define ZIP_OVERWRITE ZIP_TRUNCATE
 #endif
 
-#define PHP_ZIP_VERSION "1.21.1"
+#define PHP_ZIP_VERSION "1.22.0"
 
 #ifdef HAVE_LIBZIP_VERSION
 #define LIBZIP_VERSION_STR zip_libzip_version()

ext/zip/php_zip.stub.php

@@ -492,6 +492,56 @@ class ZipArchive implements Countable
     public const ER_CANCELLED = UNKNOWN;
 #endif
 
+    /* since 1.10.0 */
+#ifdef ZIP_ER_DATA_LENGTH
+    /**
+     * N Unexpected length of data
+     * @var int
+     * @cvalue ZIP_ER_DATA_LENGTH
+     */
+    public const ER_DATA_LENGTH = UNKNOWN;
+#endif
+#ifdef ZIP_ER_NOT_ALLOWED
+    /**
+     * Not allowed in torrentzip
+     * @var int
+     * @cvalue ZIP_ER_NOT_ALLOWED
+     */
+    public const ER_NOT_ALLOWED = UNKNOWN;
+#endif
+#ifdef ZIP_AFL_RDONLY
+    /**
+     * read only -- cannot be cleared
+     * @var int
+     * @cvalue ZIP_AFL_RDONLY
+     */
+    public const AFL_RDONLY = UNKNOWN;
+#endif
+#ifdef ZIP_AFL_IS_TORRENTZIP
+    /**
+     * current archive is torrentzipped
+     * @var int
+     * @cvalue ZIP_AFL_IS_TORRENTZIP
+     */
+    public const AFL_IS_TORRENTZIP = UNKNOWN;
+#endif
+#ifdef ZIP_AFL_WANT_TORRENTZIP
+    /**
+     * write archive in torrentzip format
+     * @var int
+     * @cvalue ZIP_AFL_WANT_TORRENTZIP
+     */
+    public const AFL_WANT_TORRENTZIP = UNKNOWN;
+#endif
+#ifdef ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
+    /**
+     * don't remove file if archive is empty
+     * @var int
+     * @cvalue ZIP_AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
+     */
+    public const AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE = UNKNOWN;
+#endif
+
 #ifdef ZIP_OPSYS_DEFAULT
     /**
      * @var int
@@ -722,6 +772,10 @@ public function setArchiveComment(string $comment): bool {}
     /** @tentative-return-type */
     public function getArchiveComment(int $flags = 0): string|false {}
 
+    public function setArchiveFlag(int $flag, int $value): bool {}
+
+    public function getArchiveFlag(int $flag, int $flags = 0): int {}
+
     /** @tentative-return-type */
     public function setCommentIndex(int $index, string $comment): bool {}
 

ext/zip/php_zip_arginfo.h

@@ -0,0 +1,39 @@
+--TEST--
+ZipArchive::getArchiveFlag and setArchiveFlag
+--EXTENSIONS--
+zip
+--SKIPIF--
+<?php
+if(version_compare(ZipArchive::LIBZIP_VERSION, '1.10.0', '<')) die('skip libzip < 1.10.0');?>
+--FILE--
+<?php
+$zip = new ZipArchive();
+
+echo "Open write\n";
+$zip->open(__DIR__ . "/test.zip");
+var_dump($zip->getArchiveFlag(ZipArchive::AFL_RDONLY));
+var_dump($zip->setArchiveFlag(ZipArchive::AFL_RDONLY, 1), $zip->status === ZipArchive::ER_OK);
+var_dump($zip->getArchiveFlag(ZipArchive::AFL_RDONLY));
+$zip->close();
+
+echo "\nOpen read\n";
+$zip->open(__DIR__ . "/test.zip", ZipArchive::RDONLY);
+var_dump($zip->getArchiveFlag(ZipArchive::AFL_RDONLY));
+var_dump($zip->setArchiveFlag(ZipArchive::AFL_RDONLY, 0), $zip->status !== ZipArchive::ER_OK);
+var_dump($zip->getArchiveFlag(ZipArchive::AFL_RDONLY));
+$zip->close();
+
+
+?>
+--EXPECTF--
+Open write
+int(0)
+bool(true)
+bool(true)
+int(1)
+
+Open read
+int(1)
+bool(false)
+bool(true)
+int(1)