change get_queued_filename to get_orig_filename and modified function
[mediagoblin.git] / mediagoblin / media_types / image / processing.py
index b61e717d60c8fd1a851b99caee045eef08c6fef0..665a2931b3f3c040f2f7e2689cfb1bc416d5f342 100644 (file)
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import Image
+try:
+    from PIL import Image
+except ImportError:
+    import Image
 import os
+import logging
 
 from mediagoblin import mg_globals as mgg
-from mediagoblin.processing import BadMediaFail, \
-    create_pub_filepath, THUMB_SIZE, MEDIUM_SIZE
+from mediagoblin.processing import BadMediaFail, FilenameBuilder
 from mediagoblin.tools.exif import exif_fix_image_orientation, \
-    extract_exif, clean_exif, get_gps_data, get_useful
+    extract_exif, clean_exif, get_gps_data, get_useful, \
+    exif_image_needs_rotation
 
-def process_image(entry):
-    """
-    Code to process an image
-    """
-    workbench = mgg.workbench_manager.create_workbench()
-    # Conversions subdirectory to avoid collisions
-    conversions_subdir = os.path.join(
-        workbench.dir, 'conversions')
-    os.mkdir(conversions_subdir)
+_log = logging.getLogger(__name__)
 
-    queued_filepath = entry.queued_media_file
-    queued_filename = workbench.localized_file(
-        mgg.queue_store, queued_filepath,
-        'source')
+PIL_FILTERS = {
+    'NEAREST': Image.NEAREST,
+    'BILINEAR': Image.BILINEAR,
+    'BICUBIC': Image.BICUBIC,
+    'ANTIALIAS': Image.ANTIALIAS}
 
-    filename_bits = os.path.splitext(queued_filename)
-    basename = os.path.split(filename_bits[0])[1]
-    extension = filename_bits[1].lower()
+MEDIA_TYPE = 'mediagoblin.media_types.image'
 
-    # EXIF extraction
-    exif_tags = extract_exif(queued_filename)
-    gps_data = get_gps_data(exif_tags)
 
+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:
+    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
+    """
+    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()]
+    except KeyError:
+        raise Exception('Filter "{0}" not found, choose one of {1}'.format(
+            unicode(filter_config),
+            u', '.join(PIL_FILTERS.keys())))
+
+    resized.thumbnail(new_size, resize_filter)
+
+    # 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'])
+    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:
-        thumb = Image.open(queued_filename)
+        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)
 
-    thumb = exif_fix_image_orientation(thumb, exif_tags)
 
-    thumb.thumbnail(THUMB_SIZE, Image.ANTIALIAS)
+SUPPORTED_FILETYPES = ['png', 'gif', 'jpg', 'jpeg', 'tiff']
 
-    # Copy the thumb to the conversion subdir, then remotely.
-    thumb_filename = 'thumbnail' + extension
-    thumb_filepath = create_pub_filepath(entry, thumb_filename)
 
-    tmp_thumb_filename = os.path.join(
-        conversions_subdir, thumb_filename)
+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
 
-    with file(tmp_thumb_filename, 'w') as thumb_file:
-        thumb.save(thumb_file)
+        if clean_ext in SUPPORTED_FILETYPES:
+            _log.info('Found file extension in supported filetypes')
+            return MEDIA_TYPE
+        else:
+            _log.debug('Media present, extension not found in {0}'.format(
+                    SUPPORTED_FILETYPES))
+    else:
+        _log.warning('Need additional information (keyword argument \'media\')'
+                     ' to be able to handle sniffing')
 
-    mgg.public_store.copy_local_to_storage(
-        tmp_thumb_filename, thumb_filepath)
+    return None
 
-    # 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)
 
-    # Fix orientation
-    medium = exif_fix_image_orientation(medium, exif_tags)
+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.
+    """
+    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)
 
-    if medium.size[0] > MEDIUM_SIZE[0] or medium.size[1] > MEDIUM_SIZE[1]:
-        medium.thumbnail(MEDIUM_SIZE, Image.ANTIALIAS)
+        os.mkdir(self.conversions_subdir)
 
-    medium_filename = 'medium' + extension
-    medium_filepath = create_pub_filepath(entry, medium_filename)
+    def initial_processing(self):
+        # Is there any GPS data
+        gps_data = get_gps_data(self.exif_tags)
 
-    tmp_medium_filename = os.path.join(
-        conversions_subdir, medium_filename)
+         # 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)
 
-    with file(tmp_medium_filename, 'w') as medium_file:
-        medium.save(medium_file)
+        # 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)
 
-    mgg.public_store.copy_local_to_storage(
-        tmp_medium_filename, medium_filepath)
+        # Copy our queued local workbench to its final destination
+        self.proc_state.copy_original(self.name_builder.fill('{basename}{ext}'))
 
-    # we have to re-read because unlike PIL, not everything reads
-    # things in string representation :)
-    queued_file = file(queued_filename, 'rb')
+        # Remove queued media file from storage and database
+        self.proc_state.delete_queue_file()
 
-    with queued_file:
-        #create_pub_filepath(entry, queued_filepath[-1])
-        original_filepath = create_pub_filepath(entry, basename + extension) 
+        # Insert exif data into database
+        exif_all = clean_exif(self.exif_tags)
 
-        with mgg.public_store.get_file(original_filepath, 'wb') \
-            as original_file:
-            original_file.write(queued_file.read())
+        if len(exif_all):
+            self.entry.media_data_init(exif_all=exif_all)
 
-    # Remove queued media file from storage and database
-    mgg.queue_store.delete_file(queued_filepath)
-    entry.queued_media_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 media file information into database
-    media_files_dict = entry.setdefault('media_files', {})
-    media_files_dict['thumb'] = thumb_filepath
-    media_files_dict['original'] = original_filepath
-    media_files_dict['medium'] = medium_filepath
+    def reprocess(self, reprocess_info):
+        new_size = None
 
-    # Insert exif data into database
-    media_data = entry.setdefault('media_data', {})
-    media_data['exif'] = {
-        'clean': clean_exif(exif_tags)}
-    media_data['exif']['useful'] = get_useful(
-        media_data['exif']['clean'])
+        # 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)
 
-    # clean up workbench
-    workbench.destroy_self()
+        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