from datetime import datetime import json import warnings # Needs to be imported like this to allow @patch to work in tests from django.utils.six.moves.urllib import request as urllib_request from django.utils.six.moves.urllib.request import Request from django.utils.six.moves.urllib.error import URLError from django.utils.six.moves.urllib.parse import urlencode from django.utils.module_loading import import_string from django.conf import settings from wagtail.wagtailembeds.oembed_providers import get_oembed_provider from wagtail.wagtailembeds.models import Embed from wagtail.utils.deprecation import RemovedInWagtail14Warning class EmbedException(Exception): pass class EmbedNotFoundException(EmbedException): pass class EmbedlyException(EmbedException): pass class AccessDeniedEmbedlyException(EmbedlyException): pass def embedly(url, max_width=None, key=None): from embedly import Embedly # Get embedly key if key is None: try: key = settings.WAGTAILEMBEDS_EMBEDLY_KEY except AttributeError: key = settings.EMBEDLY_KEY warnings.warn( "EMBEDLY_KEY is now deprecated. Use WAGTAILEMBEDS_EMBEDLY_KEY instead", RemovedInWagtail14Warning) # Get embedly client client = Embedly(key=key) # Call embedly if max_width is not None: oembed = client.oembed(url, maxwidth=max_width, better=False) else: oembed = client.oembed(url, better=False) # Check for error if oembed.get('error'): if oembed['error_code'] in [401, 403]: raise AccessDeniedEmbedlyException elif oembed['error_code'] == 404: raise EmbedNotFoundException else: raise EmbedlyException # Convert photos into HTML if oembed['type'] == 'photo': html = '' % (oembed['url'], ) else: html = oembed.get('html') # Return embed as a dict return { 'title': oembed['title'] if 'title' in oembed else '', 'author_name': oembed['author_name'] if 'author_name' in oembed else '', 'provider_name': oembed['provider_name'] if 'provider_name' in oembed else '', 'type': oembed['type'], 'thumbnail_url': oembed.get('thumbnail_url'), 'width': oembed.get('width'), 'height': oembed.get('height'), 'html': html, } def oembed(url, max_width=None): # Find provider provider = get_oembed_provider(url) if provider is None: raise EmbedNotFoundException # Work out params params = {'url': url, 'format': 'json'} if max_width: params['maxwidth'] = max_width # Perform request request = Request(provider + '?' + urlencode(params)) request.add_header('User-agent', 'Mozilla/5.0') try: r = urllib_request.urlopen(request) except URLError: raise EmbedNotFoundException oembed = json.loads(r.read().decode('utf-8')) # Convert photos into HTML if oembed['type'] == 'photo': html = '' % (oembed['url'], ) else: html = oembed.get('html') # Return embed as a dict return { 'title': oembed['title'] if 'title' in oembed else '', 'author_name': oembed['author_name'] if 'author_name' in oembed else '', 'provider_name': oembed['provider_name'] if 'provider_name' in oembed else '', 'type': oembed['type'], 'thumbnail_url': oembed.get('thumbnail_url'), 'width': oembed.get('width'), 'height': oembed.get('height'), 'html': html, } def get_default_finder(): # Check if the user has set the embed finder manually if hasattr(settings, 'WAGTAILEMBEDS_EMBED_FINDER'): return import_string(settings.WAGTAILEMBEDS_EMBED_FINDER) # Use embedly if the embedly key is set if hasattr(settings, 'WAGTAILEMBEDS_EMBEDLY_KEY') or hasattr(settings, 'EMBEDLY_KEY'): return embedly # Fall back to oembed return oembed def get_embed(url, max_width=None, finder=None): # Check database try: return Embed.objects.get(url=url, max_width=max_width) except Embed.DoesNotExist: pass # Get/Call finder if not finder: finder = get_default_finder() embed_dict = finder(url, max_width) # Make sure width and height are valid integers before inserting into database try: embed_dict['width'] = int(embed_dict['width']) except (TypeError, ValueError): embed_dict['width'] = None try: embed_dict['height'] = int(embed_dict['height']) except (TypeError, ValueError): embed_dict['height'] = None # Make sure html field is valid if 'html' not in embed_dict or not embed_dict['html']: embed_dict['html'] = '' # Create database record embed, created = Embed.objects.get_or_create( url=url, max_width=max_width, defaults=embed_dict, ) # Save embed.last_updated = datetime.now() embed.save() return embed