change get_queued_filename to get_orig_filename and modified function
[mediagoblin.git] / mediagoblin / media_types / image / processing.py
index 93f9d03e0593ced0ecde48bb416f3623c2b12d41..665a2931b3f3c040f2f7e2689cfb1bc416d5f342 100644 (file)
@@ -22,8 +22,7 @@ import os
 import logging
 
 from mediagoblin import mg_globals as mgg
-from mediagoblin.processing import BadMediaFail, \
-    create_pub_filepath, FilenameBuilder
+from mediagoblin.processing import BadMediaFail, FilenameBuilder
 from mediagoblin.tools.exif import exif_fix_image_orientation, \
     extract_exif, clean_exif, get_gps_data, get_useful, \
     exif_image_needs_rotation
@@ -36,30 +35,28 @@ PIL_FILTERS = {
     'BICUBIC': Image.BICUBIC,
     'ANTIALIAS': Image.ANTIALIAS}
 
+MEDIA_TYPE = 'mediagoblin.media_types.image'
 
-def resize_image(entry, filename, new_path, exif_tags, workdir, new_size,
-                 size_limits=(0, 0)):
+
+def resize_image(proc_state, resized, keyname, target_name, new_size,
+                 exif_tags, workdir):
     """
     Store a resized version of an image and return its pathname.
 
     Arguments:
-    entry -- the entry for the image to resize
-    filename -- the filename of the original image being resized
-    new_path -- public file path for the new resized image
+    proc_state -- the processing state for the image to resize
+    resized -- an image from Image.open() of the original image being resized
+    keyname -- Under what key to save in the db.
+    target_name -- public file path for the new resized image
     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
     """
-    try:
-        resized = Image.open(filename)
-    except IOError:
-        raise BadMediaFail()
-    resized = exif_fix_image_orientation(resized, exif_tags)  # Fix orientation
+    config = mgg.global_config['media_type:mediagoblin.media_types.image']
 
-    filter_config = \
-            mgg.global_config['media_type:mediagoblin.media_types.image']\
-                ['resize_filter']
+    resized = exif_fix_image_orientation(resized, exif_tags)  # Fix orientation
 
+    filter_config = config['resize_filter']
     try:
         resize_filter = PIL_FILTERS[filter_config.upper()]
     except KeyError:
@@ -70,23 +67,53 @@ def resize_image(entry, filename, new_path, exif_tags, workdir, new_size,
     resized.thumbnail(new_size, resize_filter)
 
     # Copy the new file to the conversion subdir, then remotely.
-    tmp_resized_filename = os.path.join(workdir, new_path[-1])
+    tmp_resized_filename = os.path.join(workdir, target_name)
     with file(tmp_resized_filename, 'w') as resized_file:
-        resized.save(resized_file)
-    mgg.public_store.copy_local_to_storage(tmp_resized_filename, new_path)
+        resized.save(resized_file, quality=config['quality'])
+    proc_state.store_public(keyname, tmp_resized_filename, target_name)
+
+
+def resize_tool(proc_state, force, keyname, target_name,
+                conversions_subdir, exif_tags, new_size=None):
+    # filename -- the filename of the original image being resized
+    filename = proc_state.get_orig_filename()
 
+    # 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 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.
+    # Also created if the file needs rotation, or if forced.
+    try:
+        im = Image.open(filename)
+    except IOError:
+        raise BadMediaFail()
+    if force \
+        or im.size[0] > new_size[0]\
+        or im.size[1] > new_size[1]\
+        or exif_image_needs_rotation(exif_tags):
+        resize_image(
+            proc_state, im, unicode(keyname), target_name,
+            new_size,
+            exif_tags, conversions_subdir)
 
-SUPPORTED_FILETYPES = ['png', 'gif', 'jpg', 'jpeg']
+
+SUPPORTED_FILETYPES = ['png', 'gif', 'jpg', 'jpeg', 'tiff']
 
 
 def sniff_handler(media_file, **kw):
+    _log.info('Sniffing {0}'.format(MEDIA_TYPE))
     if kw.get('media') is not None:  # That's a double negative!
         name, ext = os.path.splitext(kw['media'].filename)
         clean_ext = ext[1:].lower()  # Strip the . from ext and make lowercase
 
         if clean_ext in SUPPORTED_FILETYPES:
             _log.info('Found file extension in supported filetypes')
-            return True
+            return MEDIA_TYPE
         else:
             _log.debug('Media present, extension not found in {0}'.format(
                     SUPPORTED_FILETYPES))
@@ -94,72 +121,76 @@ def sniff_handler(media_file, **kw):
         _log.warning('Need additional information (keyword argument \'media\')'
                      ' to be able to handle sniffing')
 
-    return False
+    return None
 
 
-def process_image(proc_state):
+def process_image(proc_state, reprocess_info=None):
     """Code to process an image. Will be run by celery.
 
     A Workbench() represents a local tempory dir. It is automatically
     cleaned up when this function exits.
     """
-    entry = proc_state.entry
-    workbench = proc_state.workbench
-
-    # Conversions subdirectory to avoid collisions
-    conversions_subdir = os.path.join(
-        workbench.dir, 'conversions')
-    os.mkdir(conversions_subdir)
-
-    queued_filename = proc_state.get_queued_filename()
-    name_builder = FilenameBuilder(queued_filename)
-
-    # EXIF extraction
-    exif_tags = extract_exif(queued_filename)
-    gps_data = get_gps_data(exif_tags)
-
-    # Always create a small thumbnail
-    thumb_filepath = create_pub_filepath(
-        entry, name_builder.fill('{basename}.thumbnail{ext}'))
-    resize_image(entry, queued_filename, thumb_filepath,
-                exif_tags, conversions_subdir,
-                (mgg.global_config['media:thumb']['max_width'],
-                 mgg.global_config['media:thumb']['max_height']))
-    entry.media_files[u'thumb'] = thumb_filepath
-
-    # If the size of the original file exceeds the specified size of a `medium`
-    # file, a `.medium.jpg` files is created and later associated with the media
-    # entry.
-    medium = Image.open(queued_filename)
-    if medium.size[0] > mgg.global_config['media:medium']['max_width'] \
-        or medium.size[1] > mgg.global_config['media:medium']['max_height'] \
-        or exif_image_needs_rotation(exif_tags):
-        medium_filepath = create_pub_filepath(
-            entry, name_builder.fill('{basename}.medium{ext}'))
-        resize_image(
-            entry, queued_filename, medium_filepath,
-            exif_tags, conversions_subdir,
-            (mgg.global_config['media:medium']['max_width'],
-             mgg.global_config['media:medium']['max_height']))
-        entry.media_files[u'medium'] = medium_filepath
+    def init(self, proc_state):
+        self.proc_state = proc_state
+        self.entry = proc_state.entry
+        self.workbench = proc_state.workbench
+
+        # Conversions subdirectory to avoid collisions
+        self.conversions_subdir = os.path.join(
+            self.workbench.dir, 'convirsions')
+
+        self.orig_filename = proc_state.get_orig_filename()
+        self.name_builder = FilenameBuilder(self.orig_filename)
+
+        # Exif extraction
+        self.exif_tags = extract_exif(self.orig_filename)
+
+        os.mkdir(self.conversions_subdir)
+
+    def initial_processing(self):
+        # Is there any GPS data
+        gps_data = get_gps_data(self.exif_tags)
+
+         # Always create a small thumbnail
+        resize_tool(self.proc_state, True, 'thumb', self.orig_filename,
+                    self.name_builder.fill('{basename}.thumbnail{ext}'),
+                    self.conversions_subdir, self.exif_tags)
+
+        # Possibly create a medium
+        resize_tool(self.proc_state, False, 'medium', self.orig_filename,
+                    self.name_builder.fill('{basename}.medium{ext}'),
+                    self.conversions_subdir, self.exif_tags)
+
+        # Copy our queued local workbench to its final destination
+        self.proc_state.copy_original(self.name_builder.fill('{basename}{ext}'))
+
+        # Remove queued media file from storage and database
+        self.proc_state.delete_queue_file()
+
+        # Insert exif data into database
+        exif_all = clean_exif(self.exif_tags)
 
-    # Copy our queued local workbench to its final destination
-    proc_state.copy_original(name_builder.fill('{basename}{ext}'))
+        if len(exif_all):
+            self.entry.media_data_init(exif_all=exif_all)
 
-    # Remove queued media file from storage and database
-    proc_state.delete_queue_file()
+        if len(gps_data):
+            for key in list(gps_data.keys()):
+                gps_data['gps_' + key] = gps_data.pop(key)
+            self.entry.media_data_init(**gps_data)
 
-    # Insert exif data into database
-    exif_all = clean_exif(exif_tags)
+    def reprocess(self, reprocess_info):
+        new_size = None
 
-    if len(exif_all):
-        entry.media_data_init(exif_all=exif_all)
+        # Did they specify a size?
+        if reprocess_info.get('max_width'):
+            max_width = reprocess_info['max_width']
+            max_height = reprocess_info['max_height']
 
-    if len(gps_data):
-        for key in list(gps_data.keys()):
-            gps_data['gps_' + key] = gps_data.pop(key)
-        entry.media_data_init(**gps_data)
+            new_size = (max_width, max_height)
 
+        resize_tool(self.proc_state, False, reprocess_info['resize'],
+                    self.name_builder.fill('{basename}.medium{ext}'),
+                    self.conversions_subdir, self.exif_tags, new_size)
 
 if __name__ == '__main__':
     import sys