Improved bulk compression

Author: Jacob Middag

src/class-tiny-metadata.php

@@ -25,6 +25,7 @@ class Tiny_Metadata {
     private $id;
     private $values;
     private $filenames;
+    private $urls;
 
     public function __construct($id, $wp_metadata=null) {
         $this->id = $id;
@@ -41,21 +42,26 @@ public function __construct($id, $wp_metadata=null) {
 
     private function parse_wp_metadata($wp_metadata) {
         $this->filenames = array();
+        $this->urls = array();
         if (!is_array($wp_metadata)) {
             return;
         }
 
         $path_info = pathinfo($wp_metadata['file']);
         $upload_dir = wp_upload_dir();
-        $prefix = $upload_dir['basedir'] . '/';
+        $path_prefix = $upload_dir['basedir'] . '/';
+        $url_prefix = $upload_dir['baseurl'] . '/';
         if (isset($path_info['dirname'])) {
-            $prefix .= $path_info['dirname'] .'/';
+            $path_prefix .= $path_info['dirname'] .'/';
+            $url_prefix .= $path_info['dirname'] .'/';
         }
 
-        $this->filenames[self::ORIGINAL] = "$prefix${path_info['basename']}";
+        $this->filenames[self::ORIGINAL] = "$path_prefix${path_info['basename']}";
+        $this->urls[self::ORIGINAL] = "$url_prefix${path_info['basename']}";
         if (isset($wp_metadata['sizes']) && is_array($wp_metadata['sizes'])) {
             foreach ($wp_metadata['sizes'] as $size => $info) {
-                $this->filenames[$size] = "$prefix${info['file']}";
+                $this->filenames[$size] = "$path_prefix${info['file']}";
+                $this->urls[$size] = "$url_prefix${info['file']}";
             }
         }
     }
@@ -84,6 +90,10 @@ public function get_filename($size=self::ORIGINAL) {
         return isset($this->filenames[$size]) ? $this->filenames[$size] : null;
     }
 
+    public function get_url($size=self::ORIGINAL) {
+        return isset($this->urls[$size]) ? $this->urls[$size] : null;
+    }
+
     public function get_value($size=self::ORIGINAL) {
         return isset($this->values[$size]) ? $this->values[$size] : null;
     }

src/class-tiny-notices.php

@@ -106,8 +106,8 @@ public function dismiss() {
         exit();
     }
 
-    public function show($name, $message, $dismissable=true) {
+    public function show($name, $message, $klass='error', $dismissable=true) {
         $link = $dismissable ? "&nbsp;<a href=\"#\" data-name=\"$name\" class=\"tiny-dismiss\">" . self::translate_escape('Dismiss') . '</a>' : '';
-        add_action('admin_notices', create_function('', "echo '<div class=\"updated\"><p>Compress JPEG & PNG images: $message$link</p></div>';"));
+        add_action('admin_notices', create_function('', "echo '<div class=\"$klass\"><p>Compress JPEG & PNG images: $message$link</p></div>';"));
     }
 }

src/class-tiny-plugin.php

@@ -31,6 +31,9 @@ public static function jpeg_quality() {
     public function __construct() {
         parent::__construct();
         $this->settings = new Tiny_Settings();
+        if (is_admin()) {
+            add_action('admin_menu', $this->get_method('admin_menu'));
+        }
     }
 
     public function set_compressor($compressor) {
@@ -52,6 +55,14 @@ public function admin_init() {
         add_action('admin_enqueue_scripts', $this->get_method('enqueue_scripts'));
     }
 
+    public function admin_menu() {
+        add_management_page(
+            self::translate('Compress JPEG & PNG Images'), self::translate('Compress all images'),
+            'upload_files', 'tiny-bulk-compress', $this->get_method('bulk_compress_page')
+        );
+
+    }
+
     public function enqueue_scripts($hook) {
         wp_enqueue_style(self::NAME .'_admin', plugins_url('/styles/admin.css', __FILE__),
             array(), self::plugin_version());
@@ -63,54 +74,81 @@ public function enqueue_scripts($hook) {
         // Wordpress < 3.3 does not handle multi dimensional arrays
         wp_localize_script($handle, 'tinyCompress', array(
             'nonce' => wp_create_nonce('tiny-compress'),
-            'L10nBulkAction' => self::translate('Compress all uncompressed sizes'),
+            'L10nAllDone' => self::translate('All images are processed'),
+            'L10nBulkAction' => self::translate('Compress all'),
+            'L10nCompressing' => self::translate('Compressing'),
+            'L10nError' => self::translate('Error'),
+            'L10nInternalError' => self::translate('Internal error'),
+            'L10nOutOf' => self::translate('out of'),
+            'L10nWaiting' => self::translate('Waiting'),
         ));
         wp_enqueue_script($handle);
     }
 
-    public function compress_attachment($metadata, $attachment_id) {
+    private function compress($metadata, $attachment_id) {
         $mime_type = get_post_mime_type($attachment_id);
         $tiny_metadata = new Tiny_Metadata($attachment_id, $metadata);
 
         if ($this->settings->get_compressor() === null || strpos($mime_type, 'image/') !== 0) {
             return $metadata;
         }
 
+        $success = 0;
+        $failed = 0;
+
         $compressor = $this->settings->get_compressor();
         $sizes = $this->settings->get_tinify_sizes();
         foreach ($tiny_metadata->get_missing_sizes($sizes) as $size) {
             try {
                 $response = $compressor->compress_file($tiny_metadata->get_filename($size));
                 $tiny_metadata->add_response($response, $size);
+                $success++;
             } catch (Tiny_Exception $e) {
                 $tiny_metadata->add_exception($e, $size);
+                $failed++;
             }
         }
-
         $tiny_metadata->update();
+
+        return array($tiny_metadata, array('success' => $success, 'failed' => $failed));
+    }
+
+    public function compress_attachment($metadata, $attachment_id) {
+        $this->compress($metadata, $attachment_id);
         return $metadata;
     }
 
     public function compress_image() {
         if (!$this->check_ajax_referer()) {
             exit();
         }
+        $json = !empty($_POST['json']) && $_POST['json'];
         if (!current_user_can('upload_files')) {
-            echo self::translate("You don't have permission to work with uploaded files") . '.';
+            $message = self::translate("You don't have permission to work with uploaded files") . '.';
+            echo $json ? json_encode(array('error' => $message)) : $message;
             exit();
         }
         if (empty($_POST['id'])) {
-            echo self::translate("Not a valid media file") . '.';
+            $message = self::translate("Not a valid media file") . '.';
+            echo $json ? json_encode(array('error' => $message)) : $message;
             exit();
         }
         $id = intval($_POST['id']);
         $metadata = wp_get_attachment_metadata($id);
         if (!is_array($metadata)) {
-            echo self::translate("Could not find metadata of media file") . '.';
+            $message = self::translate("Could not find metadata of media file") . '.';
+            echo $json ? json_encode(array('error' => $message)) : $message;
+            exit;
         }
 
-        $this->compress_attachment($metadata, $id);
-        $this->render_media_column(self::MEDIA_COLUMN, $id);
+        list($tiny_metadata, $result) = $this->compress($metadata, $id);
+        if ($json) {
+            $result['status'] = $this->settings->get_status();
+            $result['thumbnail'] = $tiny_metadata->get_url('thumbnail');
+            echo json_encode($result);
+        } else {
+            echo $this->render_media_column(self::MEDIA_COLUMN, $id);
+        }
 
         exit();
     }
@@ -122,12 +160,13 @@ public function bulk_compress() {
             return;
         }
 
-        foreach ($_REQUEST['media'] as $id) {
-            $metadata = wp_get_attachment_metadata($id);
-            if (is_array($metadata)) {
-                $this->compress_attachment($metadata, $id);
-            }
-        }
+        $ids = implode('-', array_map('intval', $_REQUEST['media']));
+        wp_redirect(add_query_arg(
+            '_wpnonce',
+            wp_create_nonce('tiny-bulk-compress'),
+            admin_url("tools.php?page=tiny-bulk-compress&ids=$ids")
+        ));
+        exit();
     }
 
     public function add_media_columns($columns) {
@@ -162,4 +201,48 @@ public function render_media_column($column, $id) {
             }
         }
     }
+
+    public function bulk_compress_page() {
+        echo '<div class="wrap" id="tiny-bulk-compress">';
+        echo '<h2>' . self::translate('Compress JPEG & PNG Images') . '</h2>';
+        if (empty($_POST['tiny-bulk-compress']) && empty($_REQUEST['ids'])) {
+            echo '<p>' . self::translate_escape("Use this tool to compress all images via the Tiny API service") . '.</p>';
+            echo '<p>' . self::translate_escape("To begin, just press the button below") . '.</p>';
+
+            echo '<form method="POST" action="?page=tiny-bulk-compress">';
+            echo '<input type="hidden" name="_wpnonce" value="' . wp_create_nonce('tiny-bulk-compress') . '">';
+            echo '<input type="hidden" name="tiny-bulk-compress" value="1">';
+            echo '<p><button class="button" type="submit">'. self::translate_escape('Compress all images') .'</p>';
+            echo '</form>';
+        } else {
+            check_admin_referer('tiny-bulk-compress');
+
+            if (!empty($_REQUEST['ids'])) {
+                $ids = implode(',', array_map('intval', explode('-', $_REQUEST['ids'])));
+                $cond = "AND ID IN($ids)";
+            } else {
+                $cond = "";
+            }
+
+            global $wpdb;
+            // Get all ids and names of the images and not the whole objects which will only fill memory
+            $items = $wpdb->get_results("SELECT ID, post_title FROM $wpdb->posts WHERE post_type = 'attachment' AND post_mime_type LIKE 'image/%' $cond ORDER BY ID DESC", ARRAY_A);
+
+            echo '<p>';
+            echo self::translate_escape("Please be patient while the images are being compressed") . '. ';
+            echo self::translate_escape("This can take a while if you have many images") . '. ';
+            echo self::translate_escape("Do not navigate away from this page because it will stop the process") . '. ';
+            echo self::translate_escape("You will be notified via this page when the processing is done") . '.';
+            echo "</p>";
+
+            echo '<div id="tiny-status"><p>'. self::translate_escape('Compressions this month') . sprintf(' <span>%d</span></p></div>', $this->settings->get_status());
+            echo '<div id="tiny-progress"><p>'. self::translate_escape('Processing') . ': <span>0</span> ' . self::translate_escape('out of') . sprintf(' %d </p></div>', count($items));
+            echo '<div id="tiny-images">';
+            echo '</div>';
+
+            echo '<script type="text/javascript">jQuery(function() { tinyBulkCompress('. json_encode($items) . ')})</script>';
+        }
+
+        echo '</div>';
+    }
 }

src/class-tiny-settings.php

@@ -32,10 +32,15 @@ public function __construct() {
     }
 
     public function admin_init() {
+        if (current_user_can('manage_options') && empty($this->get_api_key())) {
+            $link = sprintf('<a href="options-media.php#%s">%s</a>', self::NAME,
+                self::translate_escape('Please fill in an API key to start compressing images'));
+            $this->notices->show('setting', $link, 'error', false);
+        }
         try {
             $this->compressor = Tiny_Compress::get_compressor($this->get_api_key(), $this->get_method('after_compress_callback'));
         } catch (Tiny_Exception $e) {
-            $this->notices->show('compressor_exception', self::translate_escape($e->getMessage()), false);
+            $this->notices->show('compressor_exception', self::translate_escape($e->getMessage()), 'error', false);
         }
 
         $section = self::get_prefixed_name('settings');
@@ -53,10 +58,10 @@ public function admin_init() {
         register_setting('media', $field);
         add_settings_field($field, self::translate('Connection status'), $this->get_method('render_pending_status'), 'media', $section);
 
-        add_action('wp_ajax_tiny_compress_status', $this->get_method('get_status'));
+        add_action('wp_ajax_tiny_compress_status', $this->get_method('connection_status'));
     }
 
-    public function get_status() {
+    public function connection_status() {
         $this->render_status();
         exit();
     }
@@ -69,6 +74,10 @@ public function set_compressor($compressor) {
         $this->compressor = $compressor;
     }
 
+    public function get_status() {
+        return intval(get_option(self::get_prefixed_name('status')));
+    }
+
     protected function get_api_key() {
         if (defined('TINY_API_KEY')) {
             return TINY_API_KEY;
@@ -140,6 +149,7 @@ public function get_tinify_sizes() {
     }
 
     public function render_section() {
+        echo '<span id="' . self::NAME . '"></span>';
     }
 
     public function render_api_key() {
@@ -208,7 +218,12 @@ public function after_compress_callback($details, $headers) {
 
     public function render_status() {
         $details = null;
-        $status = $this->compressor->get_status($details);
+        try {
+            $status = $this->compressor->get_status($details);
+        } catch (Tiny_Exception $e) {
+            $status = false;
+            $details = array('message' => $e->getMessage());
+        }
         if ($status) {
             echo '<p><img src="images/yes.png"> ' . self::translate_escape('API connection successful') . '</p>';
         } else {

src/class-tiny-wp-base.php

@@ -46,7 +46,9 @@ protected static function translate_escape($phrase) {
 
     public function __construct() {
         add_action('init', $this->get_method('init'));
-        add_action('admin_init', $this->get_method('admin_init'));
+        if (is_admin()) {
+            add_action('admin_init', $this->get_method('admin_init'));
+        }
     }
 
     protected function get_method($name) {

src/config/tiny-config.php

@@ -1,5 +1,5 @@
 <?php
 
 class Tiny_Config {
-    const URL = 'http://webservice/shrink';
+    const URL = 'https://api.tinypng.com/shrink';
 }