Merge branch 'master' of git://github.com/gallery/gallery3

1 files changed, 142 insertions, 55 deletions

diff --git a/modules/gallery/helpers/graphics.php b/modules/gallery/helpers/graphics.php
index e7c5da68..e66908c4 100644
--- a/modules/gallery/helpers/graphics.php
+++ b/modules/gallery/helpers/graphics.php
@@ -1,7 +1,7 @@
 <?php defined("SYSPATH") or die("No direct script access.");
 /**
  * Gallery - a web based photo album viewer and editor
- * Copyright (C) 2000-2012 Bharat Mediratta
+ * Copyright (C) 2000-2013 Bharat Mediratta
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -115,36 +115,12 @@ class graphics_Core {
    * @param Item_Model $item
    */
   static function generate($item) {
-    if ($item->is_album()) {
-      if (!$cover = $item->album_cover()) {
-        // This album has no cover; there's nothing to generate.  Because of an old bug, it's
-        // possible that there's an album cover item id that points to an invalid item.  In that
-        // case, just null out the album cover item id.  It's not optimal to do that at this low
-        // level, but it's not trivial to find these cases quickly in an upgrade script and if we
-        // don't do this, the album may be permanently marked as "needs rebuilding"
-        //
-        // ref: http://sourceforge.net/apps/trac/gallery/ticket/1172
-        //      http://gallery.menalto.com/node/96926
-        if ($item->album_cover_item_id) {
-          $item->album_cover_item_id = null;
-          $item->save();
-        }
-        return;
-      }
-      $input_file = $cover->file_path();
-      $input_item = $cover;
-    } else {
-      $input_file = $item->file_path();
-      $input_item = $item;
-    }
-
     if ($item->thumb_dirty) {
       $ops["thumb"] = $item->thumb_path();
     }
-    if ($item->resize_dirty && !$item->is_album() && !$item->is_movie()) {
+    if ($item->resize_dirty && $item->is_photo()) {
       $ops["resize"] = $item->resize_path();
     }
-
     if (empty($ops)) {
       $item->thumb_dirty = 0;
       $item->resize_dirty = 0;
@@ -154,10 +130,11 @@ class graphics_Core {
 
     try {
       foreach ($ops as $target => $output_file) {
-        if ($input_item->is_movie()) {
-          // Convert the movie filename to a JPG first, delete anything that might already be there
-          $output_file = legal_file::change_extension($output_file, "jpg");
-          unlink($output_file);
+        $working_file = $item->file_path();
+        // Delete anything that might already be there
+        @unlink($output_file);
+        switch ($item->type) {
+        case "movie":
           // Run movie_extract_frame events, which can either:
           //  - generate an output file, bypassing the ffmpeg-based movie::extract_frame
           //  - add to the options sent to movie::extract_frame (e.g. change frame extract time,
@@ -165,27 +142,70 @@ class graphics_Core {
           // Note that the args are similar to those of the events in gallery_graphics
           $movie_options_wrapper = new stdClass();
           $movie_options_wrapper->movie_options = array();
-          module::event("movie_extract_frame", $input_file, $output_file,
-                        $movie_options_wrapper, $input_item);
+          module::event("movie_extract_frame", $working_file, $output_file,
+                        $movie_options_wrapper, $item);
           // If no output_file generated by events, run movie::extract_frame with movie_options
           clearstatcache();
           if (@filesize($output_file) == 0) {
             try {
-              movie::extract_frame($input_file, $output_file, $movie_options_wrapper->movie_options);
+              movie::extract_frame($working_file, $output_file, $movie_options_wrapper->movie_options);
+              // If we're here, we know ffmpeg is installed and the movie is valid.  Because the
+              // user may not always have had ffmpeg installed, the movie's width, height, and
+              // mime type may need updating.  Let's use this opportunity to make sure they're
+              // correct.  It's not optimal to do it at this low level, but it's not trivial to find
+              // these cases quickly in an upgrade script.
+              list ($width, $height, $mime_type) = movie::get_file_metadata($working_file);
+              // Only set them if they need updating to avoid marking them as "changed"
+              if (($item->width != $width) || ($item->height != $height) ||
+                  ($item->mime_type != $mime_type)) {
+                $item->width = $width;
+                $item->height = $height;
+                $item->mime_type = $mime_type;
+              }
             } catch (Exception $e) {
-              // Didn't work, likely because of MISSING_FFMPEG - copy missing_movie instead
-              copy(MODPATH . "gallery/images/missing_movie.jpg", $output_file);
+              // Didn't work, likely because of MISSING_FFMPEG - use placeholder
+              graphics::_replace_image_with_placeholder($item, $target);
+              break;
             }
           }
           $working_file = $output_file;
-        } else {
-          $working_file = $input_file;
-        }
 
-        foreach (self::_get_rules($target) as $rule) {
-          $args = array($working_file, $output_file, unserialize($rule->args), $item);
-          call_user_func_array($rule->operation, $args);
-          $working_file = $output_file;
+        case "photo":
+          // Run the graphics rules (for both movies and photos)
+          foreach (self::_get_rules($target) as $rule) {
+            $args = array($working_file, $output_file, unserialize($rule->args), $item);
+            call_user_func_array($rule->operation, $args);
+            $working_file = $output_file;
+          }
+          break;
+
+        case "album":
+          if (!$cover = $item->album_cover()) {
+            // This album has no cover; copy its placeholder image.  Because of an old bug, it's
+            // possible that there's an album cover item id that points to an invalid item.  In that
+            // case, just null out the album cover item id.  It's not optimal to do that at this low
+            // level, but it's not trivial to find these cases quickly in an upgrade script and if we
+            // don't do this, the album may be permanently marked as "needs rebuilding"
+            //
+            // ref: http://sourceforge.net/apps/trac/gallery/ticket/1172
+            //      http://galleryproject.org/node/96926
+            if ($item->album_cover_item_id) {
+              $item->album_cover_item_id = null;
+              $item->save();
+            }
+            graphics::_replace_image_with_placeholder($item, $target);
+            break;
+          }
+          if ($cover->thumb_dirty) {
+            graphics::generate($cover);
+          }
+          if (!$cover->thumb_dirty) {
+            // Make the album cover from the cover item's thumb.  Run gallery_graphics::resize with
+            // null options and it will figure out if this is a direct copy or conversion to jpg.
+            $working_file = $cover->thumb_path();
+            gallery_graphics::resize($working_file, $output_file, null, $item);
+          }
+          break;
         }
       }
 
@@ -193,33 +213,93 @@ class graphics_Core {
         if (file_exists($item->thumb_path())) {
           $item->thumb_dirty = 0;
         } else {
-          copy(MODPATH . "gallery/images/missing_photo.png", $item->thumb_path());
+          Kohana_Log::add("error", "Failed to rebuild thumb image: $item->title");
+          graphics::_replace_image_with_placeholder($item, "thumb");
         }
-        $dims = getimagesize($item->thumb_path());
-        $item->thumb_width = $dims[0];
-        $item->thumb_height = $dims[1];
       }
 
       if (!empty($ops["resize"]))  {
         if (file_exists($item->resize_path())) {
           $item->resize_dirty = 0;
         } else {
-          copy(MODPATH . "gallery/images/missing_photo.png", $item->resize_path());
+          Kohana_Log::add("error", "Failed to rebuild resize image: $item->title");
+          graphics::_replace_image_with_placeholder($item, "resize");
         }
-        $dims = getimagesize($item->resize_path());
-        $item->resize_width = $dims[0];
-        $item->resize_height = $dims[1];
       }
+      graphics::_update_item_dimensions($item);
       $item->save();
     } catch (Exception $e) {
-      // Something went wrong rebuilding the image.  Leave it dirty and move on.
-      // @todo we should handle this better.
-      Kohana_Log::add("error", "Caught exception rebuilding image: {$item->title}\n" .
+      // Something went wrong rebuilding the image.  Replace with the placeholder images,
+      // leave it dirty and move on.
+      Kohana_Log::add("error", "Caught exception rebuilding images: {$item->title}\n" .
                       $e->getMessage() . "\n" . $e->getTraceAsString());
+      if ($item->is_photo()) {
+        graphics::_replace_image_with_placeholder($item, "resize");
+      }
+      graphics::_replace_image_with_placeholder($item, "thumb");
+      try {
+        graphics::_update_item_dimensions($item);
+      } catch (Exception $e) {
+        // Looks like get_file_metadata couldn't identify our placeholders.  We should never get
+        // here, but in the odd case we do, we need to do something.  Let's put in hardcoded values.
+        if ($item->is_photo()) {
+          list ($item->resize_width, $item->resize_height) = array(200, 200);
+        }
+        list ($item->thumb_width, $item->thumb_height) = array(200, 200);
+      }
+      $item->save();
       throw $e;
     }
   }
 
+  private static function _update_item_dimensions($item) {
+    if ($item->is_photo()) {
+      list ($item->resize_width, $item->resize_height) =
+        photo::get_file_metadata($item->resize_path());
+    }
+    list ($item->thumb_width, $item->thumb_height) =
+      photo::get_file_metadata($item->thumb_path());
+  }
+
+  private static function _replace_image_with_placeholder($item, $target) {
+    if ($item->is_album() && !$item->album_cover_item_id) {
+      $input_path = MODPATH . "gallery/images/missing_album_cover.jpg";
+    } else if ($item->is_movie() || ($item->is_album() && $item->album_cover()->is_movie())) {
+      $input_path = MODPATH . "gallery/images/missing_movie.jpg";
+    } else {
+      $input_path = MODPATH . "gallery/images/missing_photo.jpg";
+    }
+
+    if ($target == "thumb") {
+      $output_path = $item->thumb_path();
+      $size = module::get_var("gallery", "thumb_size", 200);
+    } else {
+      $output_path = $item->resize_path();
+      $size = module::get_var("gallery", "resize_size", 640);
+    }
+    $options = array("width" => $size, "height" => $size, "master" => Image::AUTO);
+
+    try {
+      // Copy/convert/resize placeholder as needed.
+      gallery_graphics::resize($input_path, $output_path, $options, null);
+    } catch (Exception $e) {
+      // Copy/convert/resize didn't work.  Add to the log and copy the jpg version (which could have
+      // a non-jpg extension).  This is less than ideal, but it's better than putting nothing
+      // there and causing theme views to act strangely because a file is missing.
+      // @todo we should handle this better.
+      Kohana_Log::add("error", "Caught exception converting placeholder for missing image: " .
+                      $item->title . "\n" . $e->getMessage() . "\n" . $e->getTraceAsString());
+      copy($input_path, $output_path);
+    }
+
+    if (!file_exists($output_path)) {
+      // Copy/convert/resize didn't throw an exception, but still didn't work - do the same as above.
+      // @todo we should handle this better.
+      Kohana_Log::add("error", "Failed to convert placeholder for missing image: $item->title");
+      copy($input_path, $output_path);
+    }
+  }
+
   private static function _get_rules($target) {
     if (empty(self::$_rules_cache[$target])) {
       $rules = array();
@@ -256,12 +336,19 @@ class graphics_Core {
   }
 
   /**
-   * Mark thumbnails and resizes as dirty.  They will have to be rebuilt.
+   * Mark thumbnails and resizes as dirty.  They will have to be rebuilt.  Optionally, only those of
+   * a specified type and/or mime type can be marked (e.g. $type="movie" to rebuild movies only).
    */
-  static function mark_dirty($thumbs, $resizes) {
+  static function mark_dirty($thumbs, $resizes, $type=null, $mime_type=null) {
     if ($thumbs || $resizes) {
       $db = db::build()
         ->update("items");
+      if ($type) {
+        $db->where("type", "=", $type);
+      }
+      if ($mime_type) {
+        $db->where("mime_type", "=", $mime_type);
+      }
       if ($thumbs) {
         $db->set("thumb_dirty", 1);
       }