Changeset 46174

Timestamp:

09/19/2019 01:25:14 AM (20 months ago)

Author:

azaozz

Message:

Uploads: add helper functions for setting, getting, and deleting the temp upload reference used to the attachment_id when retrying to make image sub-sizes.

See #47872.

Location:

trunk/src

Files:

• js/_enqueues/vendor/plupload/handlers.js (modified) (3 diffs)
• js/_enqueues/vendor/plupload/wp-plupload.js (modified) (3 diffs)
• wp-admin/includes/ajax-actions.php (modified) (2 diffs)
• wp-admin/includes/file.php (modified) (1 diff)
• wp-admin/includes/media.php (modified) (4 diffs)

trunk/src/js/_enqueues/vendor/plupload/handlers.js

@@ -451 +451 @@
                     action: 'media-create-image-subsizes',
                     _wpnonce: _wpPluploadSettings.defaults.multipart_params._wpnonce,
-                    _wp_temp_image_ref: file.id,
+                    _wp_temp_upload_ref: file.id,
                     _wp_upload_failed_cleanup: true,
                 }
@@ -479 +479 @@
                 action: 'media-create-image-subsizes',
                 _wpnonce: wpUploaderInit.multipart_params._wpnonce,
-                _wp_temp_image_ref: file.id,
+                _wp_temp_upload_ref: file.id,
                 _legasy_support: 'true',
             }
@@ -600 +600 @@
         uploader.bind( 'BeforeUpload', function( up, file ) {
             if ( file.type && file.type.indexOf( 'image/' ) === 0 ) {
-                up.settings.multipart_params._wp_temp_image_ref = file.id;
+                up.settings.multipart_params._wp_temp_upload_ref = file.id;
             } else {
-                up.settings.multipart_params._wp_temp_image_ref = '';
+                up.settings.multipart_params._wp_temp_upload_ref = '';
             }
         } );

trunk/src/js/_enqueues/vendor/plupload/wp-plupload.js

@@ -139 +139 @@
                         action: 'media-create-image-subsizes',
                         _wpnonce: _wpPluploadSettings.defaults.multipart_params._wpnonce,
-                        _wp_temp_image_ref: file.id,
+                        _wp_temp_upload_ref: file.id,
                         _wp_upload_failed_cleanup: true,
                     }
@@ -162 +162 @@
                     action: 'media-create-image-subsizes',
                     _wpnonce: _wpPluploadSettings.defaults.multipart_params._wpnonce,
-                    _wp_temp_image_ref: file.id, // Used to find the new attachment_id.
+                    _wp_temp_upload_ref: file.id, // Used to find the new attachment_id.
                 }
             }).done( function( response ) {
@@ -325 +325 @@
         this.uploader.bind( 'BeforeUpload', function( up, file ) {
             if ( file.type && file.type.indexOf( 'image/' ) === 0 ) {
-                up.settings.multipart_params._wp_temp_image_ref = file.id;
+                up.settings.multipart_params._wp_temp_upload_ref = file.id;
             } else {
-                up.settings.multipart_params._wp_temp_image_ref = '';
+                up.settings.multipart_params._wp_temp_upload_ref = '';
             }
         } );

trunk/src/wp-admin/includes/ajax-actions.php

@@ -2423 +2423 @@
     }
 
-    // Using Plupload `file.id` as ref.
-    if ( ! empty( $_POST['_wp_temp_image_ref'] ) ) {
-        $image_ref = preg_replace( '/[^a-zA-Z0-9_]/', '', $_POST['_wp_temp_image_ref'] );
+    if ( ! empty( $_POST['_wp_temp_upload_ref'] ) ) {
+        // Uploading of images usually fails while creating the sub-sizes, either because of a timeout or out of memory.
+        // At this point the file has been uploaded and an attachment post created, but because of the PHP fatal error
+        // the cliend doesn't know the attachment ID yet.
+        // To be able to find the new attachment_id in these cases we temporarily store an upload reference sent by the client
+        // in the original upload request. It is used to save a transient with the attachment_id as value.
+        // That reference currently is Plupload's `file.id` but can be any sufficiently random alpha-numeric string.
+        $attachment_id = _wp_get_upload_ref_attachment_id( $_POST['_wp_temp_upload_ref'] );
     } else {
         wp_send_json_error( array( 'message' => __( 'Invalid file reference.' ) ) );
     }
-
-    // Uploading of images usually fails while creating the sub-sizes, either because of a timeout or out of memory.
-    // At this point the file has been uploaded and an attachment post created, but because of the PHP fatal error
-    // the cliend doesn't know the attachment ID yet.
-    // To be able to find the new attachment_id in these cases we temporarily store an upload reference sent by the client
-    // in the original upload request. It is used to save a transient with the attachment_id as value.
-    // That reference currently is Plupload's `file.id` but can be any sufficiently random alpha-numeric string.
-    $attachment_id = get_transient( '_wp_temp_image_ref:' . $image_ref );
 
     if ( empty( $attachment_id ) ) {
@@ -2482 +2479 @@
 
     // At this point the image has been uploaded successfully.
-    delete_transient( '_wp_temp_image_ref:' . $image_ref );
+    _wp_clear_upload_ref( $_POST['_wp_temp_upload_ref'] );
 
     wp_send_json_success( $response );

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

@@ -979 +979 @@
 }
 
+/**
+ * Temporarily stores the client upload reference in a transient.
+ *
+ * @since 5.3.0
+ * @access private
+ *
+ * @param string $upload_ref    The upload reference sent by the client.
+ * @param int    $attachment_id Attachment post ID.
+ * @return bool Whether the transient was set.
+ */
+function _wp_set_upload_ref( $upload_ref, $attachment_id ) {
+    $upload_ref = preg_replace( '/[^a-zA-Z0-9_]/', '', $upload_ref );
+
+    if ( ! empty( $upload_ref ) ) {
+        return set_transient( '_wp_temp_image_ref:' . $upload_ref, $attachment_id, HOUR_IN_SECONDS );
+    }
+
+    return false;
+}
+
+/**
+ * Get attachment post ID from an upload reference.
+ *
+ * @since 5.3.0
+ * @access private
+ *
+ * @param string $upload_ref    The upload reference sent by the client.
+ * @return int The attachemtn post ID. Zero if the upload reference has expired or doesn't exist.
+ */
+function _wp_get_upload_ref_attachment_id( $upload_ref ) {
+    $upload_ref = preg_replace( '/[^a-zA-Z0-9_]/', '', $upload_ref );
+
+    if ( ! empty( $upload_ref ) ) {
+        return (int) get_transient( '_wp_temp_image_ref:' . $upload_ref );
+    }
+
+    return 0;
+}
+
+/**
+ * Remove the transient that stores a temporary upload reference.
+ *
+ * @since 5.3.0
+ * @access private
+ *
+ * @param string $upload_ref    The upload reference sent by the client.
+ * @return bool Whether the transient was removed.
+ */
+function _wp_clear_upload_ref( $upload_ref ) {
+    $upload_ref = preg_replace( '/[^a-zA-Z0-9_]/', '', $upload_ref );
+
+    if ( ! empty( $upload_ref ) ) {
+        return delete_transient( '_wp_temp_image_ref:' . $upload_ref );
+    }
+
+    return false;
+}
 
 /**

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

@@ -309 +309 @@
     $name = wp_basename( $name, ".$ext" );
 
-    $url       = $file['url'];
-    $type      = $file['type'];
-    $file      = $file['file'];
-    $title     = sanitize_text_field( $name );
-    $content   = '';
-    $excerpt   = '';
-    $image_ref = false;
+    $url     = $file['url'];
+    $type    = $file['type'];
+    $file    = $file['file'];
+    $title   = sanitize_text_field( $name );
+    $content = '';
+    $excerpt = '';
+    $_ref    = false;
 
     if ( preg_match( '#^audio#', $type ) ) {
@@ -377 +377 @@
         // Use image exif/iptc data for title and caption defaults if possible.
     } elseif ( 0 === strpos( $type, 'image/' ) ) {
-        // Image file reference passed by the uploader.
-        if ( ! empty( $_POST['_wp_temp_image_ref'] ) ) {
-            $image_ref = preg_replace( '/[^a-zA-Z0-9_]/', '', $_POST['_wp_temp_image_ref'] );
-        }
-
         $image_meta = wp_read_image_metadata( $file );
 
@@ -416 +411 @@
     if ( ! is_wp_error( $attachment_id ) ) {
         // If an image, keep the upload reference until all image sub-sizes are created.
-        if ( $image_ref ) {
-            set_transient( '_wp_temp_image_ref:' . $image_ref, $attachment_id, HOUR_IN_SECONDS );
+        if ( ! empty( $_POST['_wp_temp_upload_ref'] ) && wp_attachment_is_image( $attachment_id ) ) {
+            $_ref = _wp_set_upload_ref( $_POST['_wp_temp_upload_ref'], $attachment_id );
         }
 
@@ -426 +421 @@
         // At this point the image is uploaded successfully even if there were specific errors or some sub-sizes were not created.
         // The transient is not needed any more.
-        if ( $image_ref ) {
-            delete_transient( '_wp_temp_image_ref:' . $image_ref );
+        if ( $_ref ) {
+            _wp_clear_upload_ref( $_POST['_wp_temp_upload_ref'] );
         }
     }