# 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
-MAX_FILENAME_LENGTH = 255 # the limit in VFAT -- seems like a good baseline
+_log = logging.getLogger(__name__)
-def resize_image(entry, filename, basename, file_tail, exif_tags, workdir,
- new_size, size_limits=(0, 0)):
- """Store a resized version of an image and return its pathname.
+PIL_FILTERS = {
+ 'NEAREST': Image.NEAREST,
+ 'BILINEAR': Image.BILINEAR,
+ 'BICUBIC': Image.BICUBIC,
+ 'ANTIALIAS': Image.ANTIALIAS}
+
+MEDIA_TYPE = 'mediagoblin.media_types.image'
+
+
+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
- basename -- simple basename of the given filename
- file_tail -- ending string and extension for the resized filename
+ 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
- size_limits (optional) -- image is only resized if it exceeds this size
-
"""
- try:
- resized = Image.open(filename)
- except IOError:
- raise BadMediaFail()
+ config = mgg.global_config['media_type:mediagoblin.media_types.image']
+
resized = exif_fix_image_orientation(resized, exif_tags) # Fix orientation
- if ((resized.size[0] > size_limits[0]) or
- (resized.size[1] > size_limits[1])):
- resized.thumbnail(new_size, Image.ANTIALIAS)
+ 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())))
- # Truncate basename as needed so len(basename + file_tail) <= 255
- resized_filename = (basename[:MAX_FILENAME_LENGTH - len(file_tail)] +
- file_tail)
- resized_filepath = create_pub_filepath(entry, resized_filename)
+ resized.thumbnail(new_size, resize_filter)
# Copy the new file to the conversion subdir, then remotely.
- tmp_resized_filename = os.path.join(workdir, resized_filename)
+ 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, resized_filepath)
- return resized_filepath
+ resized.save(resized_file, quality=config['quality'])
+ proc_state.store_public(keyname, tmp_resized_filename, target_name)
-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)
-
- queued_filepath = entry.queued_media_file
- queued_filename = workbench.localized_file(
- mgg.queue_store, queued_filepath,
- 'source')
-
- filename_bits = os.path.splitext(queued_filename)
- basename = os.path.split(filename_bits[0])[1]
- extension = filename_bits[1].lower()
-
- # EXIF extraction
- exif_tags = extract_exif(queued_filename)
- gps_data = get_gps_data(exif_tags)
-
- # Always create a small thumbnail
- thumb_filepath = resize_image(entry, queued_filename, basename,
- '.thumbnail' + extension, exif_tags,
- conversions_subdir, THUMB_SIZE)
-
- # 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
+
+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.
- medium_filepath = resize_image(entry, queued_filename, basename,
- '.medium' + extension, exif_tags,
- conversions_subdir, MEDIUM_SIZE, MEDIUM_SIZE)
-
- # we have to re-read because unlike PIL, not everything reads
- # things in string representation :)
- queued_file = file(queued_filename, 'rb')
-
- with queued_file:
- #create_pub_filepath(entry, queued_filepath[-1])
- original_filepath = create_pub_filepath(entry, basename + extension)
-
- with mgg.public_store.get_file(original_filepath, 'wb') \
- as original_file:
- original_file.write(queued_file.read())
-
- # Remove queued media file from storage and database
- mgg.queue_store.delete_file(queued_filepath)
- entry.queued_media_file = []
-
- # 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
-
- # Insert exif data into database
- media_data = entry.setdefault('media_data', {})
-
- # TODO: Fix for sql media_data, when exif is in sql
- if media_data is not None:
- media_data['exif'] = {
- 'clean': clean_exif(exif_tags)}
- media_data['exif']['useful'] = get_useful(
- media_data['exif']['clean'])
-
- 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)
-
- # clean up workbench
- workbench.destroy_self()
+ # 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', '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 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')
+
+ return None
+
+
+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)
+
+ 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)
+
+ if len(exif_all):
+ self.entry.media_data_init(exif_all=exif_all)
+
+ 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)
+
+ def reprocess(self, reprocess_info):
+ new_size = None
+
+ # Did they specify a size?
+ if reprocess_info.get('max_width'):
+ max_width = reprocess_info['max_width']
+ max_height = reprocess_info['max_height']
+
+ 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