Merge remote-tracking branch 'refs/remotes/rodney757/reprocessing'
[mediagoblin.git] / mediagoblin / media_types / image / processing.py
index 6eb8302cbc85446fa7ad39500b580d7ae738c885..a0ad2ce81d36e0781d9885f2940d825b332adf79 100644 (file)
@@ -26,7 +26,7 @@ from mediagoblin import mg_globals as mgg
 from mediagoblin.processing import (
     BadMediaFail, FilenameBuilder,
     MediaProcessor, ProcessingManager,
-    request_from_args, get_orig_filename,
+    request_from_args, get_process_filename,
     store_public, copy_original)
 from mediagoblin.tools.exif import exif_fix_image_orientation, \
     extract_exif, clean_exif, get_gps_data, get_useful, \
@@ -44,7 +44,7 @@ MEDIA_TYPE = 'mediagoblin.media_types.image'
 
 
 def resize_image(entry, resized, keyname, target_name, new_size,
-                 exif_tags, workdir):
+                 exif_tags, workdir, quality, filter):
     """
     Store a resized version of an image and return its pathname.
 
@@ -56,17 +56,16 @@ def resize_image(entry, resized, keyname, target_name, new_size,
     exif_tags -- EXIF data for the original image
     workdir -- directory path for storing converted image files
     new_size -- 2-tuple size for the resized image
+    quality -- level of compression used when resizing images
+    filter -- One of BICUBIC, BILINEAR, NEAREST, ANTIALIAS
     """
-    config = mgg.global_config['media_type:mediagoblin.media_types.image']
-
     resized = exif_fix_image_orientation(resized, exif_tags)  # Fix orientation
 
-    filter_config = config['resize_filter']
     try:
-        resize_filter = PIL_FILTERS[filter_config.upper()]
+        resize_filter = PIL_FILTERS[filter.upper()]
     except KeyError:
         raise Exception('Filter "{0}" not found, choose one of {1}'.format(
-            unicode(filter_config),
+            unicode(filter),
             u', '.join(PIL_FILTERS.keys())))
 
     resized.thumbnail(new_size, resize_filter)
@@ -74,19 +73,34 @@ def resize_image(entry, resized, keyname, target_name, new_size,
     # Copy the new file to the conversion subdir, then remotely.
     tmp_resized_filename = os.path.join(workdir, target_name)
     with file(tmp_resized_filename, 'w') as resized_file:
-        resized.save(resized_file, quality=config['quality'])
+        resized.save(resized_file, quality=quality)
     store_public(entry, keyname, tmp_resized_filename, target_name)
 
+    # store the thumb/medium info
+    image_info = {'width': new_size[0],
+                  'height': new_size[1],
+                  'quality': quality,
+                  'filter': filter}
+
+    entry.set_file_metadata(keyname, **image_info)
+
 
 def resize_tool(entry,
                 force, keyname, orig_file, target_name,
-                conversions_subdir, exif_tags, new_size=None):
+                conversions_subdir, exif_tags, quality, filter, new_size=None):
     # Use the default size if new_size was not given
     if not new_size:
         max_width = mgg.global_config['media:' + keyname]['max_width']
         max_height = mgg.global_config['media:' + keyname]['max_height']
         new_size = (max_width, max_height)
 
+    # If thumb or medium is already the same quality and size, then don't
+    # reprocess
+    if _skip_resizing(entry, keyname, new_size, quality, filter):
+        _log.info('{0} of same size and quality already in use, skipping '
+                  'resizing of media {1}.'.format(keyname, entry.id))
+        return
+
     # If the size of the original file exceeds the specified size for the desized
     # file, a target_name file is created and later associated with the media
     # entry.
@@ -101,8 +115,35 @@ def resize_tool(entry,
         or exif_image_needs_rotation(exif_tags):
         resize_image(
             entry, im, unicode(keyname), target_name,
-            new_size,
-            exif_tags, conversions_subdir)
+            tuple(new_size),
+            exif_tags, conversions_subdir,
+            quality, filter)
+
+
+def _skip_resizing(entry, keyname, size, quality, filter):
+    """
+    Determines wither the saved thumb or medium is of the same quality and size
+    """
+    image_info = entry.get_file_metadata(keyname)
+
+    if not image_info:
+        return False
+
+    skip = True
+
+    if image_info.get('width') != size[0]:
+        skip = False
+
+    elif image_info.get('height') != size[1]:
+        skip = False
+
+    elif image_info.get('filter') != filter:
+        skip = False
+
+    elif image_info.get('quality') != quality:
+        skip = False
+
+    return skip
 
 
 SUPPORTED_FILETYPES = ['png', 'gif', 'jpg', 'jpeg', 'tiff']
@@ -131,52 +172,56 @@ class CommonImageProcessor(MediaProcessor):
     """
     Provides a base for various media processing steps
     """
-    # Common resizing step
-    def resize_step(self):
-        pass
-
-    @classmethod
-    def _add_width_height_args(cls, parser):
-        parser.add_argument(
-            "--width", default=None,
-            help=(
-                "Width of the resized image (if not using defaults)"))
-        parser.add_argument(
-            "--height", default=None,
-            help=(
-                "Height of the resized image (if not using defaults)"))
+    # list of acceptable file keys in order of prefrence for reprocessing
+    acceptable_files = ['original', 'medium']
 
     def common_setup(self):
         """
         Set up the workbench directory and pull down the original file
         """
+        self.image_config = mgg.global_config['plugins'][
+            'mediagoblin.media_types.image']
+
         ## @@: Should this be two functions?
         # Conversions subdirectory to avoid collisions
         self.conversions_subdir = os.path.join(
-            self.workbench.dir, 'convirsions')
+            self.workbench.dir, 'conversions')
         os.mkdir(self.conversions_subdir)
 
-        # Pull down and set up the original file
-        self.orig_filename = get_orig_filename(
-            self.entry, self.workbench)
-        self.name_builder = FilenameBuilder(self.orig_filename)
+        # Pull down and set up the processing file
+        self.process_filename = get_process_filename(
+            self.entry, self.workbench, self.acceptable_files)
+        self.name_builder = FilenameBuilder(self.process_filename)
 
         # Exif extraction
-        self.exif_tags = extract_exif(self.orig_filename)
+        self.exif_tags = extract_exif(self.process_filename)
+
+    def generate_medium_if_applicable(self, size=None, quality=None,
+                                      filter=None):
+        if not quality:
+            quality = self.image_config['quality']
+        if not filter:
+            filter = self.image_config['resize_filter']
 
-    def generate_medium_if_applicable(self, size=None):
-        resize_tool(self.entry, False, 'medium', self.orig_filename,
+        resize_tool(self.entry, False, 'medium', self.process_filename,
                     self.name_builder.fill('{basename}.medium{ext}'),
-                    self.conversions_subdir, self.exif_tags, size)
+                    self.conversions_subdir, self.exif_tags, quality,
+                    filter, size)
 
-    def generate_thumb(self, size=None):
-        resize_tool(self.entry, True, 'thumb', self.orig_filename,
+    def generate_thumb(self, size=None, quality=None, filter=None):
+        if not quality:
+            quality = self.image_config['quality']
+        if not filter:
+            filter = self.image_config['resize_filter']
+
+        resize_tool(self.entry, True, 'thumb', self.process_filename,
                     self.name_builder.fill('{basename}.thumbnail{ext}'),
-                    self.conversions_subdir, self.exif_tags, size)
+                    self.conversions_subdir, self.exif_tags, quality,
+                    filter, size)
 
     def copy_original(self):
         copy_original(
-            self.entry, self.orig_filename,
+            self.entry, self.process_filename,
             self.name_builder.fill('{basename}{ext}'))
 
     def extract_metadata(self):
@@ -203,11 +248,13 @@ class InitialProcessor(CommonImageProcessor):
     description = "Initial processing"
 
     @classmethod
-    def media_is_eligible(cls, entry):
+    def media_is_eligible(cls, entry=None, state=None):
         """
         Determine if this media type is eligible for processing
         """
-        return entry.state in (
+        if not state:
+            state = entry.state
+        return state in (
             "unprocessed", "failed")
 
     ###############################
@@ -232,17 +279,27 @@ class InitialProcessor(CommonImageProcessor):
             metavar=('max_width', 'max_height'),
             type=int)
 
+        parser.add_argument(
+            '--filter',
+            choices=['BICUBIC', 'BILINEAR', 'NEAREST', 'ANTIALIAS'])
+
+        parser.add_argument(
+            '--quality',
+            type=int,
+            help='level of compression used when resizing images')
+
         return parser
 
     @classmethod
     def args_to_request(cls, args):
         return request_from_args(
-            args, ['size', 'thumb_size'])
+            args, ['size', 'thumb_size', 'filter', 'quality'])
 
-    def process(self, size=None, thumb_size=None):
+    def process(self, size=None, thumb_size=None, quality=None, filter=None):
         self.common_setup()
-        self.generate_medium_if_applicable(size=size)
-        self.generate_thumb(size=thumb_size)
+        self.generate_medium_if_applicable(size=size, filter=filter,
+                                           quality=quality)
+        self.generate_thumb(size=thumb_size, filter=filter, quality=quality)
         self.copy_original()
         self.extract_metadata()
         self.delete_queue_file()
@@ -254,13 +311,16 @@ class Resizer(CommonImageProcessor):
     """
     name = 'resize'
     description = 'Resize image'
+    thumb_size = 'size'
 
     @classmethod
-    def media_is_eligible(cls, entry):
+    def media_is_eligible(cls, entry=None, state=None):
         """
         Determine if this media type is eligible for processing
         """
-        return entry.state in 'processed'
+        if not state:
+            state = entry.state
+        return state in 'processed'
 
     ###############################
     # Command line interface things
@@ -278,6 +338,15 @@ class Resizer(CommonImageProcessor):
             metavar=('max_width', 'max_height'),
             type=int)
 
+        parser.add_argument(
+            '--filter',
+            choices=['BICUBIC', 'BILINEAR', 'NEAREST', 'ANTIALIAS'])
+
+        parser.add_argument(
+            '--quality',
+            type=int,
+            help='level of compression used when resizing images')
+
         parser.add_argument(
             'file',
             choices=['medium', 'thumb'])
@@ -287,14 +356,15 @@ class Resizer(CommonImageProcessor):
     @classmethod
     def args_to_request(cls, args):
         return request_from_args(
-            args, ['size', 'file'])
+            args, ['size', 'file', 'quality', 'filter'])
 
-    def process(self, file, size=None):
+    def process(self, file, size=None, filter=None, quality=None):
         self.common_setup()
         if file == 'medium':
-            self.generate_medium_if_applicable(size=size)
+            self.generate_medium_if_applicable(size=size, filter=filter,
+                                              quality=quality)
         elif file == 'thumb':
-            self.generate_thumb(size=size)
+            self.generate_thumb(size=size, filter=filter, quality=quality)
 
 
 class ImageProcessingManager(ProcessingManager):