Changeset 56689

Timestamp:

09/25/2023 10:14:11 PM (3 years ago)

Author:

costdev

Message:

Filesystem API: Introduce filters for before/after unzipping archives.

This introduces the following new filters which wrap the process of unzipping an archive:

• pre_unzip_file - Filters archive unzipping to allow an override with a custom process.
• unzip_file - Filters the result of unzipping an archive.

Both filters pass the following:

• string $file - Full path and filename of ZIP archive.
• string $to - Full path on the filesystem to extract archive to.
• string[] $needed_dirs - A full list of required folders that need to be created.
• float|false $required_space - The space required to unzip the file and copy its contents, with a 10% buffer.

Props dfavor, azaozz, oglekler, afragen, costdev.
Fixes #37719.

Location:

trunk

Files:

• src/wp-admin/includes/file.php (modified) (8 diffs)
• tests/phpunit/data/filesystem (added)
• tests/phpunit/tests/filesystem/_unzipFilePclzip.php (added)
• tests/phpunit/tests/filesystem/_unzipFileZiparchive.php (added)

trunk/src/wp-admin/includes/file.php

@@ -1698 +1698 @@
         }
 
+        // Enough space to unzip the file and copy its contents, with a 10% buffer.
+        $required_space = $uncompressed_size * 2.1;
+
         /*
          * disk_free_space() could return false. Assume that any falsey value is an error.
@@ -1706 +1709 @@
                 $available_space = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
 
-                if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) {
+                if ( $available_space && ( $required_space > $available_space ) ) {
                         return new WP_Error(
                                 'disk_full_unzip_file',
@@ -1747 +1750 @@
                 }
         }
-        unset( $needed_dirs );
+
+        /**
+         * Filters archive unzipping to override with a custom process.
+         *
+         * @since 6.4.0
+         *
+         * @param null|true|WP_Error $result         The result of the override. True on success, otherwise WP Error. Default null.
+         * @param string             $file           Full path and filename of ZIP archive.
+         * @param string             $to             Full path on the filesystem to extract archive to.
+         * @param string[]           $needed_dirs    A full list of required folders that need to be created.
+         * @param float              $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
+         */
+        $pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
+
+        if ( null !== $pre ) {
+                // Ensure the ZIP file archive has been closed.
+                $z->close();
+
+                return $pre;
+        }
 
         for ( $i = 0; $i < $z->numFiles; $i++ ) {
@@ -1782 +1804 @@
         $z->close();
 
-        return true;
+        /**
+         * Filters the result of unzipping an archive.
+         *
+         * @since 6.4.0
+         *
+         * @param true|WP_Error $result         The result of unzipping the archive. True on success, otherwise WP_Error. Default true.
+         * @param string        $file           Full path and filename of ZIP archive.
+         * @param string        $to             Full path on the filesystem the archive was extracted to.
+         * @param string[]      $needed_dirs    A full list of required folders that were created.
+         * @param float         $required_space The space required to unzip the file and copy its contents, with a 10% buffer.
+         */
+        $result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
+
+        unset( $needed_dirs );
+
+        return $result;
 }
 
@@ -1839 +1876 @@
         }
 
+        // Enough space to unzip the file and copy its contents, with a 10% buffer.
+        $required_space = $uncompressed_size * 2.1;
+
         /*
          * disk_free_space() could return false. Assume that any falsey value is an error.
@@ -1847 +1887 @@
                 $available_space = function_exists( 'disk_free_space' ) ? @disk_free_space( WP_CONTENT_DIR ) : false;
 
-                if ( $available_space && ( $uncompressed_size * 2.1 ) > $available_space ) {
+                if ( $available_space && ( $required_space > $available_space ) ) {
                         return new WP_Error(
                                 'disk_full_unzip_file',
@@ -1888 +1928 @@
                 }
         }
-        unset( $needed_dirs );
+
+        /** This filter is documented in src/wp-admin/includes/file.php */
+        $pre = apply_filters( 'pre_unzip_file', null, $file, $to, $needed_dirs, $required_space );
+
+        if ( null !== $pre ) {
+                return $pre;
+        }
 
         // Extract the files from the zip.
@@ -1910 +1956 @@
         }
 
-        return true;
+        /** This action is documented in src/wp-admin/includes/file.php */
+        $result = apply_filters( 'unzip_file', true, $file, $to, $needed_dirs, $required_space );
+
+        unset( $needed_dirs );
+
+        return $result;
 }