# 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/>.
+from __future__ import print_function
+
try:
from PIL import Image
except ImportError:
import logging
import argparse
+import six
+
from mediagoblin import mg_globals as mgg
-from mediagoblin.db.models import MediaEntry
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.submit.lib import run_process_media
from mediagoblin.tools.exif import exif_fix_image_orientation, \
extract_exif, clean_exif, get_gps_data, get_useful, \
exif_image_needs_rotation
-from mediagoblin.tools.translate import lazy_pass_to_ugettext as _
_log = logging.getLogger(__name__)
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.
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),
+ six.text_type(filter),
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'])
+ 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}
-def resize_tool(entry,
- force, keyname, target_name,
- conversions_subdir, exif_tags, new_size=None):
- # filename -- the filename of the original image being resized
- filename = target_name
+ entry.set_file_metadata(keyname, **image_info)
+
+def resize_tool(entry,
+ force, keyname, orig_file, target_name,
+ 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.
# Also created if the file needs rotation, or if forced.
try:
- im = Image.open(filename)
+ im = Image.open(orig_file)
except IOError:
raise BadMediaFail()
if force \
or im.size[1] > new_size[1]\
or exif_image_needs_rotation(exif_tags):
resize_image(
- entry, 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
+ entry, im, six.text_type(keyname), target_name,
+ tuple(new_size),
+ exif_tags, conversions_subdir,
+ quality, filter)
-class ProcessImage(object):
- """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 _skip_resizing(entry, keyname, size, quality, filter):
"""
- def __init__(self, proc_state=None):
- if 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 reprocess_action(self, args):
- """
- List the available actions for media in a given state
- """
- if args[0].state == 'processed':
- print _('\n Available reprocessing actions for processed images:'
- '\n \t --resize: thumb or medium'
- '\n Options:'
- '\n \t --size: max_width max_height (defaults to'
- 'config specs)')
- return True
-
- def _parser(self, args):
- """
- Parses the unknown args from the gmg parser
- """
- parser = argparse.ArgumentParser()
- parser.add_argument(
- '--resize',
- choices=['thumb', 'medium'])
- parser.add_argument(
- '--size',
- nargs=2,
- metavar=('max_width', 'max_height'),
- type=int)
- parser.add_argument(
- '--initial_processing',
- action='store_true')
-
- return parser.parse_args(args[1])
-
- def _check_eligible(self, entry_args, reprocess_args):
- """
- Check to see if we can actually process the given media as requested
- """
-
- if entry_args.state == 'processed':
- if reprocess_args.initial_processing:
- raise Exception(_('You can not run --initial_processing on'
- ' media that has already been processed.'))
-
- if entry_args.state == 'failed':
- if reprocess_args.resize:
- raise Exception(_('You can not run --resize on media that has'
- ' not been processed.'))
- if reprocess_args.size:
- _log.warn('With --initial_processing, the --size flag will be'
- ' ignored.')
-
- if entry_args.state == 'processing':
- raise Exception(_('We currently do not support reprocessing on'
- ' media that is in the "processing" state.'))
-
- 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):
- """
- This function actually does the reprocessing when called by
- ProcessMedia in gmg/processing/task.py
- """
- new_size = None
-
- # Did they specify a size? They must specify either both or none, so
- # we only need to check if one is present
- if reprocess_info.get('max_width'):
- max_width = reprocess_info['max_width']
- max_height = reprocess_info['max_height']
+ Determines wither the saved thumb or medium is of the same quality and size
+ """
+ image_info = entry.get_file_metadata(keyname)
- new_size = (max_width, max_height)
+ if not image_info:
+ return False
- resize_tool(self.proc_state, False, reprocess_info['resize'],
- self.name_builder.fill('{basename}.medium{ext}'),
- self.conversions_subdir, self.exif_tags, new_size)
+ skip = True
- def media_reprocess(self, args):
- """
- This function handles the all of the reprocessing logic, before calling
- gmg/submit/lib/run_process_media
- """
- reprocess_args = self._parser(args)
- entry_args = args[0]
+ if image_info.get('width') != size[0]:
+ skip = False
- # Can we actually process the given media as requested?
- self._check_eligible(entry_args, reprocess_args)
+ elif image_info.get('height') != size[1]:
+ skip = False
- # Do we want to re-try initial processing?
- if reprocess_args.initial_processing:
- for id in entry_args.media_id:
- entry = MediaEntry.query.filter_by(id=id).first()
- run_process_media(entry)
+ elif image_info.get('filter') != filter:
+ skip = False
- # Are we wanting to resize the thumbnail or medium?
- elif reprocess_args.resize:
+ elif image_info.get('quality') != quality:
+ skip = False
- # reprocess all given media entries
- for id in entry_args.media_id:
- entry = MediaEntry.query.filter_by(id=id).first()
+ return skip
- # For now we can only reprocess with the original file
- if not entry.media_files.get('original'):
- raise Exception(_('The original file for this media entry'
- ' does not exist.'))
- reprocess_info = self._get_reprocess_info(reprocess_args)
- run_process_media(entry, reprocess_info=reprocess_info)
+SUPPORTED_FILETYPES = ['png', 'gif', 'jpg', 'jpeg', 'tiff']
- # If we are here, they forgot to tell us how to reprocess
- else:
- _log.warn('You must set either --resize or --initial_processing'
- ' flag to reprocess an image.')
- def _get_reprocess_info(self, args):
- """ Returns a dict with the info needed for reprocessing"""
- reprocess_info = {'resize': args.resize}
+def sniff_handler(media_file, filename):
+ _log.info('Sniffing {0}'.format(MEDIA_TYPE))
+ name, ext = os.path.splitext(filename)
+ clean_ext = ext[1:].lower() # Strip the . from ext and make lowercase
- if args.size:
- reprocess_info['max_width'] = args.size[0]
- reprocess_info['max_height'] = args.size[1]
+ 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))
- return reprocess_info
+ return None
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)
+ self.conversions_subdir, self.exif_tags, quality,
+ filter, size)
+
+ 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']
- def generate_thumb(self, size=None):
- resize_tool(self.entry, True, 'thumb', self.orig_filename,
+ resize_tool(self.entry, True, 'thumb', self.process_filename,
self.name_builder.fill('{basename}.thumbnail{ext}'),
- self.conversions_subdir, self.exif_tags)
+ 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):
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")
###############################
parser.add_argument(
'--thumb-size',
nargs=2,
+ 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()
+
+
+class Resizer(CommonImageProcessor):
+ """
+ Resizing process steps for processed media
+ """
+ name = 'resize'
+ description = 'Resize image'
+ thumb_size = 'size'
+
+ @classmethod
+ def media_is_eligible(cls, entry=None, state=None):
+ """
+ Determine if this media type is eligible for processing
+ """
+ if not state:
+ state = entry.state
+ return state in 'processed'
+
+ ###############################
+ # Command line interface things
+ ###############################
+
+ @classmethod
+ def generate_parser(cls):
+ parser = argparse.ArgumentParser(
+ description=cls.description,
+ prog=cls.name)
+
+ parser.add_argument(
+ '--size',
+ nargs=2,
+ 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'])
+
+ return parser
+
+ @classmethod
+ def args_to_request(cls, args):
+ return request_from_args(
+ args, ['size', 'file', 'quality', 'filter'])
+
+ def process(self, file, size=None, filter=None, quality=None):
+ self.common_setup()
+ if file == 'medium':
+ self.generate_medium_if_applicable(size=size, filter=filter,
+ quality=quality)
+ elif file == 'thumb':
+ self.generate_thumb(size=size, filter=filter, quality=quality)
class ImageProcessingManager(ProcessingManager):
def __init__(self):
super(self.__class__, self).__init__()
self.add_processor(InitialProcessor)
+ self.add_processor(Resizer)
if __name__ == '__main__':
clean = clean_exif(result)
useful = get_useful(clean)
- print pp.pprint(
- clean)
+ print(pp.pprint(clean))
projects / mediagoblin.git / blobdiff