Merge remote-tracking branch 'refs/remotes/elrond/sql/final'

[mediagoblin.git] / mediagoblin / media_types / __init__.py

# GNU MediaGoblin -- federated, autonomous media hosting
# Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# 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 os
import sys
import logging
import tempfile

from mediagoblin import mg_globals
from mediagoblin.tools.translate import lazy_pass_to_ugettext as _

_log = logging.getLogger(__name__)

class FileTypeNotSupported(Exception):
    pass

class InvalidFileType(Exception):
    pass


def sniff_media(media):
    '''
    Iterate through the enabled media types and find those suited
    for a certain file.
    '''

    try:
        return get_media_type_and_manager(media.filename)
    except FileTypeNotSupported:
        _log.info('No media handler found by file extension. Doing it the expensive way...')
        # Create a temporary file for sniffers suchs as GStreamer-based
        # Audio video
        media_file = tempfile.NamedTemporaryFile()
        media_file.write(media.file.read())
        media.file.seek(0)

        for media_type, manager in get_media_managers():
            _log.info('Sniffing {0}'.format(media_type))
            if manager['sniff_handler'](media_file, media=media):
                _log.info('{0} accepts the file'.format(media_type))
                return media_type, manager
            else:
                _log.debug('{0} did not accept the file'.format(media_type))

    raise FileTypeNotSupported(
        # TODO: Provide information on which file types are supported
        _(u'Sorry, I don\'t support that file type :('))


def get_media_types():
    """
    Generator, yields the available media types
    """
    for media_type in mg_globals.app_config['media_types']:
        yield media_type


def get_media_managers():
    '''
    Generator, yields all enabled media managers
    '''
    for media_type in get_media_types():
        __import__(media_type)

        yield media_type, sys.modules[media_type].MEDIA_MANAGER


def get_media_manager(_media_type):
    '''
    Get the MEDIA_MANAGER based on a media type string

    Example::
        get_media_type('mediagoblin.media_types.image')
    '''
    if not _media_type:
        return False

    for media_type, manager in get_media_managers():
        if media_type in _media_type:
            return manager

    # Nope?  Then raise an error
    raise FileTypeNotSupported(
        "MediaManager not in enabled types.  Check media_types in config?")


def get_media_type_and_manager(filename):
    '''
    Try to find the media type based on the file name, extension
    specifically. This is used as a speedup, the sniffing functionality
    then falls back on more in-depth bitsniffing of the source file.
    '''
    if filename.find('.') > 0:
        # Get the file extension
        ext = os.path.splitext(filename)[1].lower()

        for media_type, manager in get_media_managers():
            # Omit the dot from the extension and match it against
            # the media manager
            if ext[1:] in manager['accepted_extensions']:
                return media_type, manager
    else:
        _log.info('File {0} has no file extension, let\'s hope the sniffers get it.'.format(
            filename))

    raise FileTypeNotSupported(
        _(u'Sorry, I don\'t support that file type :('))