fixed bug #728
[mediagoblin.git] / mediagoblin / gmg_commands / reprocess.py
index 50434bd272752246291a43d8d0a374745366537d..85cae6df0301c65c4ac94acc2ffb851bbfc29501 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/>.
+
+from __future__ import print_function
+
+import argparse
+import os
+
+from mediagoblin import mg_globals
 from mediagoblin.db.models import MediaEntry
 from mediagoblin.gmg_commands import util as commands_util
+from mediagoblin.submit.lib import run_process_media
 from mediagoblin.tools.translate import lazy_pass_to_ugettext as _
 from mediagoblin.tools.pluginapi import hook_handle
+from mediagoblin.processing import (
+    ProcessorDoesNotExist, ProcessorNotEligible,
+    get_entry_and_processing_manager, get_processing_manager_for_type,
+    ProcessingManagerDoesNotExist)
 
 
 def reprocess_parser_setup(subparser):
     subparser.add_argument(
-        '--available', '-a',
-        action="store_true",
-        help="List available actions for a given media entry")
-    subparser.add_argument(
-        '--all', '-A',
+        '--celery',
+        action='store_true',
+        help="Don't process eagerly, pass off to celery")
+
+    subparsers = subparser.add_subparsers(dest="reprocess_subcommand")
+
+    ###################
+    # available command
+    ###################
+    available_parser = subparsers.add_parser(
+        "available",
+        help="Find out what actions are available for this media")
+
+    available_parser.add_argument(
+        "id_or_type",
+        help="Media id or media type to check")
+
+    available_parser.add_argument(
+        "--action-help",
         action="store_true",
-        help="Reprocess all media entries")
-    subparser.add_argument(
-        '--state', '-s',
-        help="Reprocess media entries in this state"
-             " such as 'failed' or 'processed'")
-    subparser.add_argument(
-        '--type', '-t',
-        help="The type of media to be reprocessed such as 'video' or 'image'")
-    subparser.add_argument(
+        help="List argument help for each action available")
+
+    available_parser.add_argument(
+        "--state",
+        help="The state of media you would like to reprocess")
+
+
+    #############
+    # run command
+    #############
+
+    run_parser = subparsers.add_parser(
+        "run",
+        help="Run a reprocessing on one or more media")
+
+    run_parser.add_argument(
         'media_id',
-        nargs='*',
         help="The media_entry id(s) you wish to reprocess.")
 
+    run_parser.add_argument(
+        'reprocess_command',
+        help="The reprocess command you intend to run")
+
+    run_parser.add_argument(
+        'reprocess_args',
+        nargs=argparse.REMAINDER,
+        help="rest of arguments to the reprocessing tool")
+
+
+    ################
+    # thumbs command
+    ################
+    thumbs = subparsers.add_parser(
+        'thumbs',
+        help='Regenerate thumbs for all processed media')
+
+    thumbs.add_argument(
+        '--size',
+        nargs=2,
+        type=int,
+        metavar=('max_width', 'max_height'))
+
+    #################
+    # initial command
+    #################
+    subparsers.add_parser(
+        'initial',
+        help='Reprocess all failed media')
+
+    ##################
+    # bulk_run command
+    ##################
+    bulk_run_parser = subparsers.add_parser(
+        'bulk_run',
+        help='Run reprocessing on a given media type or state')
+
+    bulk_run_parser.add_argument(
+        'type',
+        help='The type of media you would like to process')
 
-class MismatchingMediaTypes(Exception):
+    bulk_run_parser.add_argument(
+        '--state',
+        default='processed',
+        nargs='?',
+        help='The state of the media you would like to process. Defaults to' \
+             " 'processed'")
+
+    bulk_run_parser.add_argument(
+        'reprocess_command',
+        help='The reprocess command you intend to run')
+
+    bulk_run_parser.add_argument(
+        'reprocess_args',
+        nargs=argparse.REMAINDER,
+        help='The rest of the arguments to the reprocessing tool')
+
+    ###############
+    # help command?
+    ###############
+
+
+def available(args):
+    # Get the media type, either by looking up media id, or by specific type
+    try:
+        media_id = int(args.id_or_type)
+        media_entry, manager = get_entry_and_processing_manager(media_id)
+        media_type = media_entry.media_type
+    except ValueError:
+        media_type = args.id_or_type
+        media_entry = None
+        manager = get_processing_manager_for_type(media_type)
+    except ProcessingManagerDoesNotExist:
+        entry = MediaEntry.query.filter_by(id=args.id_or_type).first()
+        print('No such processing manager for {0}'.format(entry.media_type))
+
+    if args.state:
+        processors = manager.list_all_processors_by_state(args.state)
+    elif media_entry is None:
+        processors = manager.list_all_processors()
+    else:
+        processors = manager.list_eligible_processors(media_entry)
+
+    print("Available processors:")
+    print("=====================")
+    print("")
+
+    if args.action_help:
+        for processor in processors:
+            print(processor.name)
+            print("-" * len(processor.name))
+
+            parser = processor.generate_parser()
+            parser.print_help()
+            print("")
+
+    else:
+        for processor in processors:
+            if processor.description:
+                print(" - %s: %s" % (processor.name, processor.description))
+            else:
+                print(" - %s" % processor.name)
+
+
+def run(args, media_id=None):
+    if not media_id:
+        media_id = args.media_id
+    try:
+        media_entry, manager = get_entry_and_processing_manager(media_id)
+
+        # TODO: (maybe?) This could probably be handled entirely by the
+        # processor class...
+        try:
+            processor_class = manager.get_processor(
+                args.reprocess_command, media_entry)
+        except ProcessorDoesNotExist:
+            print('No such processor "%s" for media with id "%s"' % (
+                args.reprocess_command, media_entry.id))
+            return
+        except ProcessorNotEligible:
+            print('Processor "%s" exists but media "%s" is not eligible' % (
+                args.reprocess_command, media_entry.id))
+            return
+
+        reprocess_parser = processor_class.generate_parser()
+        reprocess_args = reprocess_parser.parse_args(args.reprocess_args)
+        reprocess_request = processor_class.args_to_request(reprocess_args)
+        run_process_media(
+            media_entry,
+            reprocess_action=args.reprocess_command,
+            reprocess_info=reprocess_request)
+
+    except ProcessingManagerDoesNotExist:
+        entry = MediaEntry.query.filter_by(id=media_id).first()
+        print('No such processing manager for {0}'.format(entry.media_type))
+
+
+def bulk_run(args):
+    """
+    Bulk reprocessing of a given media_type
+    """
+    query = MediaEntry.query.filter_by(media_type=args.type,
+                                       state=args.state)
+
+    for entry in query:
+        run(args, entry.id)
+
+
+def thumbs(args):
     """
-    Error that should be raised if the media_types are not the same
+    Regenerate thumbs for all processed media
     """
-    pass
-
-
-def _set_media_type(args):
-    if len(args[0].media_id) == 1:
-        media_type = MediaEntry.query.filter_by(id=args[0].media_id[0])\
-                .first().media_type.split('.')[-1]
-
-        if not args[0].type:
-            args[0].type = media_type
-        elif args[0].type != media_type:
-            raise MismatchingMediaTypes(_('The type that you set does not'
-                                          ' match the type of the given'
-                                          ' media_id.'))
-    elif len(args[0].media_id) > 1:
-        media_types = []
-
-        for id in args[0].media_id:
-            media_types.append(MediaEntry.query.filter_by(id=id).first()\
-                               .media_type.split('.')[-1])
-        for type in media_types:
-            if media_types[0] != type:
-                raise MismatchingMediaTypes((u'You cannot reprocess different'
-                        ' media_types at the same time.'))
-
-        if not args[0].type:
-            args[0].type = media_types[0]
-        elif args[0].type != media_types[0]:
-            raise MismatchingMediaTypes(_('The type that you set does not'
-                                          ' match the type of the given'
-                                          ' media_ids.'))
-
-    elif not args[0].type:
-        raise MismatchingMediaTypes(_('You must provide either a media_id or'
-                                      ' set the --type flag'))
-
-
-def _reprocess_all(args):
-    if not args[0].type:
-        if args[0].state == 'failed':
-            if args[0].available:
-                print '\n Available reprocess actions for all failed' \
-                      ' media_entries: \n \t --initial_processing'
+    query = MediaEntry.query.filter_by(state='processed')
+
+    for entry in query:
+        try:
+            media_entry, manager = get_entry_and_processing_manager(entry.id)
+
+            # TODO: (maybe?) This could probably be handled entirely by the
+            # processor class...
+            try:
+                processor_class = manager.get_processor(
+                    'resize', media_entry)
+            except ProcessorDoesNotExist:
+                print('No such processor "%s" for media with id "%s"' % (
+                    'resize', media_entry.id))
+                return
+            except ProcessorNotEligible:
+                print('Processor "%s" exists but media "%s" is not eligible' % (
+                    'resize', media_entry.id))
                 return
+
+            reprocess_parser = processor_class.generate_parser()
+
+            # prepare filetype and size to be passed into reprocess_parser
+            if args.size:
+                extra_args = 'thumb --{0} {1} {2}'.format(
+                    processor_class.thumb_size,
+                    args.size[0],
+                    args.size[1])
             else:
-                #TODO reprocess all failed entries
-                pass
-        else:
-            raise Exception(_('You must set --type when trying to reprocess'
-                              ' all media_entries, unless you set --state'
-                              ' to "failed".'))
+                extra_args = 'thumb'
 
-    _run_reprocessing(args)
+            reprocess_args = reprocess_parser.parse_args(extra_args.split())
+            reprocess_request = processor_class.args_to_request(reprocess_args)
+            run_process_media(
+                media_entry,
+                reprocess_action='resize',
+                reprocess_info=reprocess_request)
 
+        except ProcessingManagerDoesNotExist:
+            print('No such processing manager for {0}'.format(entry.media_type))
 
-def _run_reprocessing(args):
-    if args[0].available:
-        return hook_handle(('reprocess_action', args[0].type), args)
-    else:
-        return hook_handle(('media_reprocess', args[0].type), args)
+
+def initial(args):
+    """
+    Reprocess all failed media
+    """
+    query = MediaEntry.query.filter_by(state='failed')
+
+    for entry in query:
+        try:
+            media_entry, manager = get_entry_and_processing_manager(entry.id)
+            run_process_media(
+                media_entry,
+                reprocess_action='initial')
+        except ProcessingManagerDoesNotExist:
+            print('No such processing manager for {0}'.format(entry.media_type))
 
 
 def reprocess(args):
-    commands_util.setup_app(args[0])
+    # Run eagerly unless explicetly set not to
+    if not args.celery:
+        os.environ['CELERY_ALWAYS_EAGER'] = 'true'
+
+    commands_util.setup_app(args)
+
+    if args.reprocess_subcommand == "run":
+        run(args)
 
-    if not args[0].state:
-        args[0].state = 'processed'
+    elif args.reprocess_subcommand == "available":
+        available(args)
 
-    if args[0].all:
-        return _reprocess_all(args)
+    elif args.reprocess_subcommand == "bulk_run":
+        bulk_run(args)
 
-    _set_media_type(args)
+    elif args.reprocess_subcommand == "thumbs":
+        thumbs(args)
 
-    return _run_reprocessing(args)
+    elif args.reprocess_subcommand == "initial":
+        initial(args)