Ticket #32075: 32075.6.diff

src/wp-admin/admin.php

@@ -138 +138 @@
         require(ABSPATH . 'wp-admin/menu.php');
 
 if ( current_user_can( 'manage_options' ) ) {
-        /**
-         * Filters the maximum memory limit available for administration screens.
-         *
-         * This only applies to administrators, who may require more memory for tasks like updates.
-         * Memory limits when processing images (uploaded or edited by users of any role) are
-         * handled separately.
-         *
-         * The WP_MAX_MEMORY_LIMIT constant specifically defines the maximum memory limit available
-         * when in the administration back end. The default is 256M, or 256 megabytes of memory.
-         *
-         * @since 3.0.0
-         *
-         * @param string 'WP_MAX_MEMORY_LIMIT' The maximum WordPress memory limit. Default 256M.
-         */
-        @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+        wp_raise_memory_limit( 'admin' );
 }
 
 /**

src/wp-admin/includes/file.php

@@ -570 +570 @@
                 return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
 
         // Unzip can use a lot of memory, but not this much hopefully
-        /** This filter is documented in wp-admin/admin.php */
-        @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+        wp_raise_memory_limit( 'admin' );
 
         $needed_dirs = array();
         $to = trailingslashit($to);

src/wp-admin/includes/image-edit.php

@@ -586 +586 @@
 function stream_preview_image( $post_id ) {
         $post = get_post( $post_id );
 
-        /** This filter is documented in wp-admin/admin.php */
-        @ini_set( 'memory_limit', apply_filters( 'admin_memory_limit', WP_MAX_MEMORY_LIMIT ) );
+        wp_raise_memory_limit( 'admin' );
 
         $img = wp_get_image_editor( _load_image_to_edit_path( $post_id ) );
 

src/wp-includes/class-wp-image-editor-gd.php

@@ -96 +96 @@
                 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
                         return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
-                /**
-                 * Filters the memory limit allocated for image manipulation.
-                 *
-                 * @since 3.5.0
-                 *
-                 * @param int|string $limit Maximum memory limit to allocate for images. Default WP_MAX_MEMORY_LIMIT.
-                 *                          Accepts an integer (bytes), or a shorthand string notation, such as '256M'.
-                 */
-                $image_memory_limit = apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT );
-
                 // Set artificially high because GD uses uncompressed images in memory.
-                @ini_set( 'memory_limit', $image_memory_limit );
+                wp_raise_memory_limit( 'image' );
 
                 $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
 

src/wp-includes/class-wp-image-editor-imagick.php

@@ -137 +137 @@
                 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
                         return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
 
-                /** This filter is documented in wp-includes/class-wp-image-editor-gd.php */
-                $image_memory_limit = apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT );
-
                 /*
                  * Even though Imagick uses less PHP memory than GD, set higher limit
                  * for users that have low PHP.ini limits.
                  */
-                @ini_set( 'memory_limit', $image_memory_limit );
+                wp_raise_memory_limit( 'image' );
 
                 try {
                         $this->image = new Imagick( $this->file );

src/wp-includes/default-constants.php

@@ -17 +17 @@
 function wp_initial_constants() {
         global $blog_id;
 
-        // set memory limits
-        if ( !defined('WP_MEMORY_LIMIT') ) {
-                if ( is_multisite() ) {
-                        define('WP_MEMORY_LIMIT', '64M');
+        /**#@+
+         * Constants for expressing human-readable data sizes in their respective number of bytes.
+         *
+         * @since 4.4.0
+         */
+        define( 'KB_IN_BYTES', 1024 );
+        define( 'MB_IN_BYTES', 1024 * KB_IN_BYTES );
+        define( 'GB_IN_BYTES', 1024 * MB_IN_BYTES );
+        define( 'TB_IN_BYTES', 1024 * GB_IN_BYTES );
+        /**#@-*/
+
+        $current_limit     = @ini_get( 'memory_limit' );
+        $current_limit_int = wp_convert_hr_to_bytes( $current_limit );
+
+        // Define memory limits.
+        if ( ! defined( 'WP_MEMORY_LIMIT' ) ) {
+                if ( false === wp_is_ini_value_changeable( 'memory_limit' ) ) {
+                        define( 'WP_MEMORY_LIMIT', $current_limit );
+                } elseif ( is_multisite() ) {
+                        define( 'WP_MEMORY_LIMIT', '64M' );
                 } else {
-                        define('WP_MEMORY_LIMIT', '40M');
+                        define( 'WP_MEMORY_LIMIT', '40M' );
                 }
         }
 
         if ( ! defined( 'WP_MAX_MEMORY_LIMIT' ) ) {
-                define( 'WP_MAX_MEMORY_LIMIT', '256M' );
+                if ( false === wp_is_ini_value_changeable( 'memory_limit' ) ) {
+                        define( 'WP_MAX_MEMORY_LIMIT', $current_limit );
+                } elseif ( -1 === $current_limit_int || $current_limit_int > 256 * MB_IN_BYTES ) {
+                        define( 'WP_MAX_MEMORY_LIMIT', $current_limit );
+                } else {
+                        define( 'WP_MAX_MEMORY_LIMIT', '256M' );
+                }
         }
 
+        // Set memory limits.
+        $wp_limit_int = wp_convert_hr_to_bytes( WP_MEMORY_LIMIT );
+        if ( -1 !== $current_limit_int && ( -1 === $wp_limit_int || $wp_limit_int > $current_limit_int ) ) {
+                @ini_set( 'memory_limit', WP_MEMORY_LIMIT );
+        }
+
         if ( ! isset($blog_id) )
                 $blog_id = 1;
 
-        // set memory limits.
-        if ( function_exists( 'memory_get_usage' ) ) {
-                $current_limit = @ini_get( 'memory_limit' );
-                $current_limit_int = intval( $current_limit );
-                if ( false !== strpos( $current_limit, 'G' ) )
-                        $current_limit_int *= 1024;
-                $wp_limit_int = intval( WP_MEMORY_LIMIT );
-                if ( false !== strpos( WP_MEMORY_LIMIT, 'G' ) )
-                        $wp_limit_int *= 1024;
-
-                if ( -1 != $current_limit && ( -1 == WP_MEMORY_LIMIT || $current_limit_int < $wp_limit_int ) )
-                        @ini_set( 'memory_limit', WP_MEMORY_LIMIT );
-        }
-
         if ( !defined('WP_CONTENT_DIR') )
                 define( 'WP_CONTENT_DIR', ABSPATH . 'wp-content' ); // no trailing slash, full paths only - WP_CONTENT_URL is defined further down
 
@@ -110 +124 @@
         define( 'MONTH_IN_SECONDS',  30 * DAY_IN_SECONDS    );
         define( 'YEAR_IN_SECONDS',  365 * DAY_IN_SECONDS    );
         /**#@-*/
-
-        /**#@+
-         * Constants for expressing human-readable data sizes in their respective number of bytes.
-         *
-         * @since 4.4.0
-         */
-        define( 'KB_IN_BYTES', 1024 );
-        define( 'MB_IN_BYTES', 1024 * KB_IN_BYTES );
-        define( 'GB_IN_BYTES', 1024 * MB_IN_BYTES );
-        define( 'TB_IN_BYTES', 1024 * GB_IN_BYTES );
-        /**#@-*/
 }
 
 /**

src/wp-includes/deprecated.php

@@ -3175 +3175 @@
         if ( ! function_exists('imagecreatefromstring') )
                 return __('The GD image library is not installed.');
 
-        /** This filter is documented in wp-includes/class-wp-image-editor-gd.php */
-        $image_memory_limit = apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT );
-
         // Set artificially high because GD uses uncompressed images in memory.
-        @ini_set( 'memory_limit', $image_memory_limit );
+        wp_raise_memory_limit( 'image' );
 
         $image = imagecreatefromstring( file_get_contents( $file ) );
 

src/wp-includes/functions.php

@@ -5350 +5350 @@
         // Strip timezone information
         return preg_replace( '/(?:Z|[+-]\d{2}(?::\d{2})?)$/', '', $formatted );
 }
+
+/**
+ * Attempts to raise the PHP memory limit for memory intensive processes.
+ *
+ * Only allows raising the existing limit and prevents lowering it.
+ *
+ * @since 4.6.0
+ *
+ * @param string $context Context in which the function is called.
+ *                        Either 'admin' or 'image'. Defaults to 'admin'.
+ * @return bool|int|string The limit that was attempted to set or false on failure.
+ */
+function wp_raise_memory_limit( $context = 'admin' ) {
+        // Exit early if the limit cannot be changed.
+        if ( false === wp_is_ini_value_changeable( 'memory_limit' ) ) {
+                return false;
+        }
+
+        $current_limit     = @ini_get( 'memory_limit' );
+        $current_limit_int = wp_convert_hr_to_bytes( $current_limit );
+
+        if ( -1 === $current_limit_int ) {
+                return false;
+        }
+
+        $wp_max_limit     = WP_MAX_MEMORY_LIMIT;
+        $wp_max_limit_int = wp_convert_hr_to_bytes( $wp_max_limit );
+        $filtered_limit   = $wp_max_limit;
+
+        switch ( $context ) {
+                case 'admin':
+                        /**
+                         * Filters the memory limit available for administration screens.
+                         *
+                         * This only applies to administrators, who may require more memory for tasks like updates.
+                         * Memory limits when processing images (uploaded or edited by users of any role) are
+                         * handled separately.
+                         *
+                         * The WP_MAX_MEMORY_LIMIT constant specifically defines the maximum memory limit available
+                         * when in the administration back end. The default is 256M (256 megabytes
+                         * of memory) or the original `memory_limit` php.ini value if this is higher.
+                         *
+                         * @since 3.0.0
+                         * @since 4.6.0 The default takes the original `memory_limit` into account.
+                         *
+                         * @param int|string $filtered_limit The maximum WordPress memory limit.
+                         *                                   Accepts an integer (bytes), or a shorthand string
+                         *                                   notation, such as '256M'.
+                         */
+                        $filtered_limit = apply_filters( 'admin_memory_limit', $filtered_limit );
+                        break;
+
+                case 'image':
+                        /**
+                         * Filters the memory limit allocated for image manipulation.
+                         *
+                         * @since 3.5.0
+                         * @since 4.6.0 The default takes the original `memory_limit` into account.
+                         *
+                         * @param int|string $filtered_limit Maximum memory limit to allocate for images.
+                         *                                   Default 256M or the original php.ini memory_limit,
+                         *                                   whichever is higher.
+                         *                                   Accepts an integer (bytes), or a shorthand string
+                         *                                   notation, such as '256M'.
+                         */
+                        $filtered_limit = apply_filters( 'image_memory_limit', $filtered_limit );
+                        break;
+
+                default:
+                        /**
+                         * Filters the memory limit allocated for arbitrary contexts.
+                         *
+                         * The dynamic portion of the hook name, `$context`, refers to an arbitrary
+                         * context passed on calling the function. This allows for plugins to define
+                         * their own contexts for raising the memory limit.
+                         *
+                         * @since 4.6.0
+                         *
+                         * @param int|string $filtered_limit Maximum memory limit to allocate for images.
+                         *                                   Default 256M or the original php.ini memory_limit,
+                         *                                   whichever is higher.
+                         *                                   Accepts an integer (bytes), or a shorthand string
+                         *                                   notation, such as '256M'.
+                         */
+                        $filtered_limit = apply_filters( "{$context}_memory_limit", $filtered_limit );
+                        break;
+        }
+
+        $filtered_limit_int = wp_convert_hr_to_bytes( $filtered_limit );
+
+        if ( -1 === $filtered_limit_int || ( $filtered_limit_int > $wp_max_limit_int && $filtered_limit_int > $current_limit_int ) ) {
+                @ini_set( 'memory_limit', $filtered_limit );
+
+                return $filtered_limit;
+        } elseif ( -1 === $wp_max_limit_int || $wp_max_limit_int > $current_limit_int ) {
+                @ini_set( 'memory_limit', $wp_max_limit );
+
+                return $wp_max_limit;
+        } else {
+                return false;
+        }
+}

src/wp-includes/load.php

@@ -974 +974 @@
         }
         return false;
 }
+
+/**
+ * Converts a shorthand byte value to an integer byte value.
+ *
+ * @since 2.3.0
+ *
+ * @param string $value A shorthand byte value.
+ * @return int An integer byte value.
+ */
+function wp_convert_hr_to_bytes( $value ) {
+        $value = trim( $value );
+        $last  = strtolower( substr( $value, -1 ) );
+
+        switch ( $last ) {
+                // Note: the `break` statement is left out on purpose!
+                case 'g':
+                        $value *= 1024;
+                case 'm':
+                        $value *= 1024;
+                case 'k':
+                        $value *= 1024;
+                default:
+                        // Left empty on purpose.
+                        break;
+        }
+
+        // Deal with large (float) values which run into the maximum integer size.
+        return (int) min( PHP_INT_MAX, $value );
+}
+
+/**
+ * Determines whether a PHP ini value is changeable at runtime.
+ *
+ * @since 4.6.0
+ *
+ * @link http://php.net/manual/en/function.ini-get-all.php
+ *
+ * @param string $setting The name of the ini setting to check.
+ * @return bool True if the value is changeable at runtime. False otherwise.
+ */
+function wp_is_ini_value_changeable( $setting ) {
+        static $ini_all;
+
+        if ( ! isset( $ini_all ) ) {
+                $ini_all = ini_get_all();
+        }
+
+        return isset( $ini_all[ $setting ]['access'] ) &&
+               ( INI_ALL === $ini_all[ $setting ]['access'] || INI_USER === $ini_all[ $setting ]['access'] );
+}

src/wp-includes/media.php

@@ -2777 +2777 @@
 }
 
 /**
- * Converts a shorthand byte value to an integer byte value.
- *
- * @since 2.3.0
- *
- * @param string $size A shorthand byte value.
- * @return int An integer byte value.
- */
-function wp_convert_hr_to_bytes( $size ) {
-        $size  = strtolower( $size );
-        $bytes = (int) $size;
-        if ( strpos( $size, 'k' ) !== false )
-                $bytes = intval( $size ) * KB_IN_BYTES;
-        elseif ( strpos( $size, 'm' ) !== false )
-                $bytes = intval($size) * MB_IN_BYTES;
-        elseif ( strpos( $size, 'g' ) !== false )
-                $bytes = intval( $size ) * GB_IN_BYTES;
-        return $bytes;
-}
-
-/**
  * Determines the maximum upload size allowed in php.ini.
  *
  * @since 2.5.0

tests/phpunit/tests/functions.php

@@ -887 +887 @@
 
                 $this->assertNull( wp_ext2type( 'unknown_format' ) );
         }
+
+        /**
+         * Test raising the memory limit.
+         *
+         * Unfortunately as the default for 'WP_MAX_MEMORY_LIMIT' in the
+         * test suite is -1, we can not test the memory limit negotiations.
+         *
+         * @ticket 32075
+         */
+        function test_wp_raise_memory_limit() {
+                ini_set( 'memory_limit', '40M' );
+                $this->assertSame( -1, wp_raise_memory_limit() );
+                $this->assertEquals( '-1', ini_get( 'memory_limit' ) );
+        }
 }

tests/phpunit/tests/load.php

@@ +1 @@
+<?php
+
+/**
+ * @group load.php
+ */
+class Tests_Load extends WP_UnitTestCase {
+
+        /**
+         * Test converting PHP ini byte values to integer byte values.
+         *
+         * @dataProvider data_wp_convert_hr_to_bytes
+         */
+        function test_wp_convert_hr_to_bytes( $value, $expected ) {
+                $this->assertSame( $expected, wp_convert_hr_to_bytes( $value ) );
+        }
+
+        function data_wp_convert_hr_to_bytes() {
+                $array = array(
+                        // Integer input
+                        array( -1, -1 ), // = no memory limit
+                        array( 8388608, 8388608 ), // 8M
+
+                        // String input (memory limit shorthand values)
+                        array( '32k', 32768 ),
+                        array( '64K', 65536 ),
+                        array( '128m', 134217728 ),
+                        array( '256M', 268435456 ),
+                        array( '1g', 1073741824 ),
+                        array( '1024', 1024 ), // No letter will be interpreted as integer value.
+
+                        // Edge cases
+                        array( 'g', 0 ),
+                        array( 'null', 0 ),
+                        array( 'off', 0 ),
+                );
+
+                // Test while running into maximum integer size limit on 32bit systems.
+                if ( 2147483647 === PHP_INT_MAX ) {
+                        $array[] = array( '2G', 2147483647 );
+                        $array[] = array( '4G', 2147483647 );
+                } else {
+                        $array[] = array( '2G', 2147483648 );
+                        $array[] = array( '4G', 4294967296 );
+                }
+
+                return $array;
+        }
+
+        /**
+         * Test the determining of the changability of a PHP ini value.
+         *
+         * @dataProvider data_wp_is_ini_value_changable
+         */
+        function test_wp_is_ini_value_changable( $setting, $expected ) {
+                $this->assertSame( $expected, wp_is_ini_value_changeable( $setting ) );
+        }
+
+        function data_wp_is_ini_value_changable() {
+                $array = array(
+                        array( 'memory_limit', true ), // PHP_INI_ALL
+                        array( 'log_errors', true ), // PHP_INI_ALL
+                        array( 'upload_max_filesize', false ), // PHP_INI_PERDIR
+                        array( 'upload_tmp_dir', false ), // PHP_INI_SYSTEM
+                );
+
+                if ( extension_loaded( 'Tidy' ) && version_compare( PHP_VERSION, '7.0.0', '>' ) ) {
+                        $array[] = array( 'tidy.clean_output', true ); // PHP_INI_USER
+                }
+
+                return $array;
+        }
+}