| | 1 | <?php |
| | 2 | /** |
| | 3 | * Handles the uploading, cropping and scaling of favicons. |
| | 4 | * |
| | 5 | * @uses ico2_3.php JPEXS class for reading / writing .ICO files |
| | 6 | * |
| | 7 | * @package WordPress |
| | 8 | * @subpackage Administration |
| | 9 | * @since 3.4.1 |
| | 10 | */ |
| | 11 | |
| | 12 | // Bootstrap admin and all its goodies |
| | 13 | require_once( 'admin.php' ); |
| | 14 | |
| | 15 | define( 'FAVICON_SIZE', 32 ); // Width (and height) of the favicon (in pixels) |
| | 16 | |
| | 17 | /* Upload is a 2-step process: |
| | 18 | * 1. Process the uploaded file and show the crop UI |
| | 19 | * 2. Manipulate the pixel data, save to PNG and ICO and write to options. |
| | 20 | */ |
| | 21 | if (! current_user_can('manage_options') ) |
| | 22 | wp_die(__('Cheatin’ uh?')); |
| | 23 | check_admin_referer('favicon_upload-options'); |
| | 24 | |
| | 25 | if ( isset( $_POST['CROP_AND_SAVE'] ) ) { |
| | 26 | if ( isset( $_POST['attachment_id'] ) && is_numeric( $_POST['attachment_id'] ) ){ |
| | 27 | $image_basename = process_crop_thumbnail( $_POST['attachment_id'] ); |
| | 28 | |
| | 29 | if ( is_wp_error( $image_basename ) ) { |
| | 30 | include_once('./admin-header.php'); |
| | 31 | echo '<div class="wrap">'; |
| | 32 | echo '<h2>' . __( 'Image upload error' ) . '</h2>'; |
| | 33 | echo '<p>' . $image_basename->get_error_message() . '</p>'; |
| | 34 | echo '<p><a href="' . admin_url( 'options-general.php' ) . '">«' . __( 'Back to Settings > General' ) . '</a></p>'; |
| | 35 | echo '</div><!-- .wrap -->'; |
| | 36 | include_once('./admin-footer.php'); |
| | 37 | } else { |
| | 38 | $attachment_id = $_POST['attachment_id'] ; |
| | 39 | save_thumbnail_attachment( $image_basename . '.png', $attachment_id ); |
| | 40 | |
| | 41 | // And save the basename out to options. |
| | 42 | update_option( 'sitefavicon', basename( $image_basename ) ); |
| | 43 | |
| | 44 | /** @TODO need to find a way to notify the user that the process has completed successfully - admin_notices? */ |
| | 45 | wp_redirect( admin_url( 'options-general.php' ) ); |
| | 46 | } |
| | 47 | } else { |
| | 48 | return new WP_Error( 'attachment_id_missing', 'Form submission error.' ); |
| | 49 | } |
| | 50 | } elseif ( isset( $_REQUEST['REMOVE_FAVICON'] ) ) { |
| | 51 | remove_favicon(); |
| | 52 | } else { |
| | 53 | /** @TODO make sure that we trap for someone just pressing "Upload image" but with no image attached */ |
| | 54 | // Enqueue the JS for the cropper... |
| | 55 | add_action( 'admin_enqueue_scripts', 'enqueue_cropper' ); |
| | 56 | // ...and our own script for populating the crop form |
| | 57 | add_action( 'admin_footer', 'cropping_js', 10, 1); |
| | 58 | |
| | 59 | // Process the upload and create the attachment file in the media center |
| | 60 | $image_results = process_thumbnail_upload(); |
| | 61 | |
| | 62 | include_once('./admin-header.php'); |
| | 63 | |
| | 64 | // hack because image replication isn't fast enough. See https://wpcom.automattic.com/ticket/1294 |
| | 65 | sleep( 2 ); |
| | 66 | |
| | 67 | echo '<div class="wrap">'; |
| | 68 | |
| | 69 | if ( is_wp_error( $image_results ) ) { |
| | 70 | echo '<h2>' . __( 'Image upload error' ) . '</h2>'; |
| | 71 | echo '<p>' . $image_results->get_error_message() . '</p>'; |
| | 72 | echo '<p><a href="' . admin_url( 'options-general.php' ) . '">«' . __( 'Back to Settings > General' ) . '</a></p>'; |
| | 73 | } else { |
| | 74 | // Image upload successful. |
| | 75 | // Now we can hook in our javascript and provide the width/height of our image as the default crop size |
| | 76 | $crop_size = min( $image_results['width'], $image_results['height'] ); |
| | 77 | echo '<script type="text/javascript">var jcrop_starting_size = ' . $crop_size . '; // Initialize jcrop crop area starting size</script>'; |
| | 78 | |
| | 79 | echo '<h2>' . __( 'Crop uploaded image' ) . '</h2>'; |
| | 80 | echo '<p>' . __( 'Choose the part of the image you want to use for your favicon.' ) . '</p>'; |
| | 81 | |
| | 82 | echo '<form id="favicon-crop-form" method="post" action="' . $_SERVER['REQUEST_URI'] . '">'; // Point the form action back to this script |
| | 83 | settings_fields('favicon_upload'); |
| | 84 | |
| | 85 | echo <<<CROP_FORM |
| | 86 | <input type="hidden" name="x1" id="x1" /> |
| | 87 | <input type="hidden" name="y1" id="y1" /> |
| | 88 | <input type="hidden" name="x2" id="x2" /> |
| | 89 | <input type="hidden" name="y2" id="y2" /> |
| | 90 | <input type="hidden" name="width" id="width" /> |
| | 91 | <input type="hidden" name="height" id="height" /> |
| | 92 | <input type="hidden" name="attachment_id" id="attachment_id" value="{$image_results['attachment_id']}" /> |
| | 93 | <input type="hidden" name="scaling_factor" id="scaling_factor" value="{$image_results['scaling_factor']}" /> |
| | 94 | CROP_FORM; |
| | 95 | |
| | 96 | echo '<img src="' . $image_results['src'] . '" id="upload" width="' . $image_results['width'] . '" height="' . $image_results['height'] . '" />'; |
| | 97 | |
| | 98 | echo '<p class="submit"><input type="submit" name="CROP_AND_SAVE" value="' . __( 'Crop image' ) . ' »" /></p>'; |
| | 99 | echo '</form>'; |
| | 100 | } |
| | 101 | |
| | 102 | echo '</div><!-- .wrap -->'; |
| | 103 | |
| | 104 | include_once('./admin-footer.php'); |
| | 105 | } |
| | 106 | |
| | 107 | |
| | 108 | /** |
| | 109 | * Process the image file upload and return a WP_Error or details about the attachment image file. |
| | 110 | * |
| | 111 | * @return mixed WP_Error | $image_results array |
| | 112 | */ |
| | 113 | function process_thumbnail_upload(){ |
| | 114 | $file = wp_handle_upload( $_FILES['avatarfile'], array( 'action' => 'update') ); |
| | 115 | if ( isset($file['error']) ) die( $file['error'] ); |
| | 116 | |
| | 117 | $url = $file['url']; |
| | 118 | $file = $file['file']; |
| | 119 | $filename = basename($file); |
| | 120 | |
| | 121 | // Construct the object array |
| | 122 | $object = array( |
| | 123 | 'post_title' => $filename, |
| | 124 | 'post_content' => $url, |
| | 125 | 'post_mime_type' => 'import', |
| | 126 | 'guid' => $url |
| | 127 | ); |
| | 128 | |
| | 129 | // Save the data. Also makes replication work |
| | 130 | $id = wp_insert_attachment($object, $file); |
| | 131 | |
| | 132 | // Retrieve the image dimensions |
| | 133 | list( $orig_width, $orig_height, $type, $attr ) = getimagesize( $file ); |
| | 134 | |
| | 135 | // Do we need to scale down the image so we can display it nicely in the interactive Crop tool? |
| | 136 | if ( $orig_width > 600 || $orig_height > 600 ) { |
| | 137 | $image = wp_create_thumbnail( $file, 600 ); |
| | 138 | list( $width, $height, $type, $attr ) = getimagesize( $image ); |
| | 139 | |
| | 140 | // Update the attachment record to reflect the newly-scaled thumbnail image |
| | 141 | $thumb = basename( $image ); |
| | 142 | $metadata = array( 'thumb' => $thumb ); |
| | 143 | wp_update_attachment_metadata( $id, $metadata ); |
| | 144 | |
| | 145 | $url = str_replace( basename( $url ), $thumb, $url ); |
| | 146 | |
| | 147 | $scaling = $orig_width / $width; |
| | 148 | } else { |
| | 149 | // No scaling required; just copy original values. |
| | 150 | $width = $orig_width; |
| | 151 | $height = $orig_height; |
| | 152 | $scaling = 1; |
| | 153 | } |
| | 154 | |
| | 155 | // Check image file format |
| | 156 | $image_type = exif_imagetype( get_attached_file( $id ) ); |
| | 157 | if (! in_array( $image_type, array( IMAGETYPE_PNG, IMAGETYPE_JPEG, IMAGETYPE_BMP ) ) ) |
| | 158 | $error = new WP_Error( 'bad_file_format', __( 'Please only use PNG (.png), JPEG (.jpg) or BMP (.bmp) image files for favicons. ' ) ); |
| | 159 | |
| | 160 | // return WP_Error or the $image_results array |
| | 161 | if ( isset($error) && $error ){ |
| | 162 | return $error; |
| | 163 | } else { |
| | 164 | return array( |
| | 165 | 'attachment_id' => $id, |
| | 166 | 'src' => $url, |
| | 167 | 'width' => $width, |
| | 168 | 'height' => $height, |
| | 169 | 'scaling_factor' => $scaling |
| | 170 | ); |
| | 171 | } |
| | 172 | } |
| | 173 | |
| | 174 | /** |
| | 175 | * Create PNG and BMP image resources based on the form submission of the cropped thumbnail. |
| | 176 | * |
| | 177 | * @param int $attachment_id The ID of the original attachment's post record. |
| | 178 | * @return mixed WP_Error | Favicon file base name (ie: fully qualified file name without any TLA file extension) |
| | 179 | */ |
| | 180 | function process_crop_thumbnail( $attachment_id ){ |
| | 181 | $src_file = get_attached_file( $attachment_id ); |
| | 182 | |
| | 183 | // Highly unlikely, but let's check |
| | 184 | if (! file_exists( $src_file ) ) |
| | 185 | return new WP_Error( 'file_missing', __( 'Attachment image file missing (possible save error: check space on web server).' ) ); |
| | 186 | |
| | 187 | // Make sure we're still within accepted image types |
| | 188 | $image_type = exif_imagetype( $src_file ); |
| | 189 | if (! $image_type || ! in_array( $image_type, array( IMAGETYPE_PNG, IMAGETYPE_JPEG, IMAGETYPE_BMP ) ) ) |
| | 190 | return new WP_Error( 'bad_file_format', __( 'Please only use PNG (.png), JPEG (.jpg) or BMP (.bmp) image files for favicons. ' ) ); |
| | 191 | |
| | 192 | // Parse image file bytes |
| | 193 | $src_image = wp_load_image( $src_file ); |
| | 194 | if ( !is_resource($src_image) ) |
| | 195 | return new WP_Error( 'is_not_resource', __( 'Error loading image. You got me: I\'m stumped.' ) ); |
| | 196 | |
| | 197 | // We crop from the original, not the medium sized, display-only thumbnail |
| | 198 | $src_x = $_POST['x1'] * $_POST['scaling_factor']; |
| | 199 | $src_y = $_POST['y1'] * $_POST['scaling_factor']; |
| | 200 | $src_width = $_POST['width'] * $_POST['scaling_factor']; |
| | 201 | $src_height = $_POST['height'] * $_POST['scaling_factor']; |
| | 202 | |
| | 203 | $dst_width = $dst_height = FAVICON_SIZE; |
| | 204 | // Avoid upscaling |
| | 205 | if ( $src_width < $dst_width || $src_height < $dst_height ) { |
| | 206 | $dst_width = $src_width; |
| | 207 | $dst_height = $src_height; |
| | 208 | } |
| | 209 | |
| | 210 | $dst_image = wp_imagecreatetruecolor( $dst_width, $dst_height ); |
| | 211 | if ( function_exists( 'imageantialias' ) ) imageantialias( $dst_image, true ); |
| | 212 | imagealphablending( $dst_image, false ); |
| | 213 | imagesavealpha( $dst_image, true ); |
| | 214 | imagecopyresampled( $dst_image, $src_image, 0, 0, $src_x, $src_y, $dst_width, $dst_height, $src_width, $src_height ); |
| | 215 | imagedestroy( $src_image ); |
| | 216 | |
| | 217 | |
| | 218 | // Save the image in PNG and ICO formats |
| | 219 | $file_info = pathinfo( $src_file ); |
| | 220 | $src_basename = basename( $src_file, '.' . $file_info['extension'] ); |
| | 221 | $dst_filename = str_replace( $src_basename, $src_basename . '_' . FAVICON_SIZE . 'x' . FAVICON_SIZE, $src_file ); |
| | 222 | // Strip the TLA from the filename |
| | 223 | $dst_filename = preg_replace( '/\\.[^\\.]+$/', '', $dst_filename ); |
| | 224 | |
| | 225 | $png_filename = $dst_filename . '.png'; |
| | 226 | if (! imagepng( $dst_image, $png_filename, 0 ) ) |
| | 227 | return new WP_Error( 'png_write_error', 'Error writing PNG favicon file.' ); |
| | 228 | |
| | 229 | $ico_filename = $dst_filename . '.ico'; |
| | 230 | |
| | 231 | imagedestroy( $dst_image ); |
| | 232 | |
| | 233 | return $dst_filename; |
| | 234 | } |
| | 235 | |
| | 236 | /** |
| | 237 | * Creates an attachment post record for a newly created thumbnail |
| | 238 | * |
| | 239 | * @param string $file_name Fully qualified file name for the image asset file. |
| | 240 | * @param int $parent_attachment_id The ID of the original thumbnail's attachment post record |
| | 241 | * |
| | 242 | * @return int The ID of the newly-created thumbnail attachment post record |
| | 243 | */ |
| | 244 | function save_thumbnail_attachment( $file_name, $parent_attachment_id ){ |
| | 245 | $file_info = pathinfo( $file_name ); // So we can get the TLA later on |
| | 246 | |
| | 247 | $file_name = apply_filters( 'wp_create_file_in_uploads', $file_name, $parent_attachment_id ); // For replication |
| | 248 | |
| | 249 | $parent = get_post( $parent_attachment_id ); |
| | 250 | $parent_url = $parent->guid; |
| | 251 | |
| | 252 | // Update the attachment |
| | 253 | $mimes = get_allowed_mime_types(); |
| | 254 | $attachment_id = wp_insert_attachment( array( |
| | 255 | 'post_title' => basename( $file_name ), |
| | 256 | 'post_mime_type' => $mimes[ $file_info['extension'] ], |
| | 257 | 'context' => 'favicon' |
| | 258 | ), $file_name ); |
| | 259 | wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file_name ) ); |
| | 260 | |
| | 261 | return $attachment_id; |
| | 262 | } |
| | 263 | |
| | 264 | /** |
| | 265 | * Currently, doesn't actually "remove" the favicon images. It only deletes the option |
| | 266 | * that tells us there's a favicon, so the code isn't generated (or the default is used) |
| | 267 | */ |
| | 268 | function remove_favicon(){ |
| | 269 | update_option( 'sitefavicon', false ); |
| | 270 | |
| | 271 | /** @TODO need to find a way to notify the user that the process has completed successfully - admin_notices? */ |
| | 272 | wp_redirect( admin_url( 'options-general.php' ) ); |
| | 273 | } |
| | 274 | |
| | 275 | |
| | 276 | /** |
| | 277 | * Called in admin_enqueue_scripts to add the cropper.js script and styles |
| | 278 | */ |
| | 279 | function enqueue_cropper(){ |
| | 280 | wp_enqueue_script( 'jcrop', 'jquery' ); |
| | 281 | wp_enqueue_style('jcrop'); // We can enqueue styles within the admin_enqueue_script action hook {@link http://wpdevel.wordpress.com/2011/12/12/use-wp_enqueue_scripts-not-wp_print_styles-to-enqueue-scripts-and-styles-for-the-frontend/} |
| | 282 | } |
| | 283 | |
| | 284 | function cropping_js(){ |
| | 285 | // Purely for coding convenience and legibility |
| | 286 | $favicon_size = FAVICON_SIZE; |
| | 287 | |
| | 288 | echo <<<CROP_JS |
| | 289 | <!-- Favicon cropping --> |
| | 290 | <script type="text/javascript"> |
| | 291 | // Update the crop form |
| | 292 | function onEndCrop( coords ) { |
| | 293 | jQuery( '#x1' ).val(coords.x); |
| | 294 | jQuery( '#y1' ).val(coords.y); |
| | 295 | jQuery( '#x2' ).val(coords.x2); |
| | 296 | jQuery( '#y2' ).val(coords.y2); |
| | 297 | jQuery( '#width' ).val(coords.w); |
| | 298 | jQuery( '#height' ).val(coords.h); |
| | 299 | } |
| | 300 | |
| | 301 | // with a supplied ratio |
| | 302 | jQuery(function($) { |
| | 303 | if (! jcrop_starting_size) jcrop_starting_size = {$favicon_size}; // jcrop_starting_size should be set in the body once the image has been processed |
| | 304 | |
| | 305 | // Set up default values on the crop form |
| | 306 | jQuery( '#x1' ).val(0); |
| | 307 | jQuery( '#y1' ).val(0); |
| | 308 | jQuery( '#x2' ).val(jcrop_starting_size); |
| | 309 | jQuery( '#y2' ).val(jcrop_starting_size); |
| | 310 | jQuery( '#width' ).val(jcrop_starting_size); |
| | 311 | jQuery( '#height' ).val(jcrop_starting_size); |
| | 312 | |
| | 313 | // Initialize Jcrop |
| | 314 | $('#upload').Jcrop({ |
| | 315 | aspectRatio: 1, |
| | 316 | setSelect: [0, 0, jcrop_starting_size, jcrop_starting_size], |
| | 317 | onSelect: onEndCrop |
| | 318 | }); |
| | 319 | }); |
| | 320 | </script> |
| | 321 | CROP_JS; |
| | 322 | |
| | 323 | } |