import re import six import datetime from urllib import urlencode from django.conf import settings from django.http import HttpResponse from django.core.exceptions import ObjectDoesNotExist from django.core.urlresolvers import reverse from django.utils.encoding import force_text import debug # pyflakes:ignore import tastypie import tastypie.resources from tastypie.api import Api from tastypie.bundle import Bundle from tastypie.serializers import Serializer as BaseSerializer from tastypie.exceptions import BadRequest, ApiFieldError from tastypie.utils.mime import determine_format, build_content_type from tastypie.utils import is_valid_jsonp_callback_value from tastypie.fields import ApiField import debug # pyflakes:ignore _api_list = [] class ModelResource(tastypie.resources.ModelResource): def generate_cache_key(self, *args, **kwargs): """ Creates a unique-enough cache key. This is based off the current api_name/resource_name/args/kwargs. """ #smooshed = ["%s=%s" % (key, value) for key, value in kwargs.items()] smooshed = urlencode(kwargs) # Use a list plus a ``.join()`` because it's faster than concatenation. return "%s:%s:%s:%s" % (self._meta.api_name, self._meta.resource_name, ':'.join(args), smooshed) class Serializer(BaseSerializer): def to_html(self, data, options=None): """ Reserved for future usage. The desire is to provide HTML output of a resource, making an API available to a browser. This is on the TODO list but not currently implemented. """ from django.template.loader import render_to_string as render options = options or {} serialized = self.to_simple_html(data, options) return render("api/base.html", {"data": serialized}) def to_simple_html(self, data, options): """ """ from django.template.loader import render_to_string as render # if isinstance(data, (list, tuple)): return render("api/listitem.html", {"data": [self.to_simple_html(item, options) for item in data]}) if isinstance(data, dict): return render("api/dictitem.html", {"data": dict((key, self.to_simple_html(val, options)) for (key, val) in data.items())}) elif isinstance(data, Bundle): return render("api/dictitem.html", {"data":dict((key, self.to_simple_html(val, options)) for (key, val) in data.data.items())}) elif hasattr(data, 'dehydrated_type'): debug.show('data') if getattr(data, 'dehydrated_type', None) == 'related' and data.is_m2m == False: return render("api/relitem.html", {"fk": data.fk_resource, "val": self.to_simple_html(data.value, options)}) elif getattr(data, 'dehydrated_type', None) == 'related' and data.is_m2m == True: render("api/listitem.html", {"data": [self.to_simple_html(bundle, options) for bundle in data.m2m_bundles]}) else: return self.to_simple_html(data.value, options) elif isinstance(data, datetime.datetime): return self.format_datetime(data) elif isinstance(data, datetime.date): return self.format_date(data) elif isinstance(data, datetime.time): return self.format_time(data) elif isinstance(data, bool): return data elif isinstance(data, (six.integer_types, float)): return data elif data is None: return None elif isinstance(data, basestring) and data.startswith("/api/v1/"): # XXX Will not work for Python 3 return render("api/relitem.html", {"fk": data, "val": data.split('/')[-2]}) else: return force_text(data) for _app in settings.INSTALLED_APPS: _module_dict = globals() if '.' in _app: _root, _name = _app.split('.', 1) if _root == 'ietf': if not '.' in _name: _api = Api(api_name=_name) _module_dict[_name] = _api _api_list.append((_name, _api)) def top_level(request): available_resources = {} apitop = reverse('ietf.api.top_level') for name in sorted([ name for name, api in _api_list if len(api._registry) > 0 ]): available_resources[name] = { 'list_endpoint': '%s/%s/' % (apitop, name), } serializer = Serializer() desired_format = determine_format(request, serializer) options = {} if 'text/javascript' in desired_format: callback = request.GET.get('callback', 'callback') if not is_valid_jsonp_callback_value(callback): raise BadRequest('JSONP callback name is invalid.') options['callback'] = callback serialized = serializer.serialize(available_resources, desired_format, options) return HttpResponse(content=serialized, content_type=build_content_type(desired_format)) def autodiscover(): """ Auto-discover INSTALLED_APPS resources.py modules and fail silently when not present. This forces an import on them to register any admin bits they may want. """ from django.conf import settings from django.utils.importlib import import_module from django.utils.module_loading import module_has_submodule for app in settings.INSTALLED_APPS: mod = import_module(app) # Attempt to import the app's admin module. try: import_module('%s.resources' % (app, )) except: # Decide whether to bubble up this error. If the app just # doesn't have an admin module, we can ignore the error # attempting to import it, otherwise we want it to bubble up. if module_has_submodule(mod, "resources"): raise TIMEDELTA_REGEX = re.compile('^(?P\d+d)?\s?(?P\d+h)?\s?(?P\d+m)?\s?(?P\d+s?)$') class TimedeltaField(ApiField): dehydrated_type = 'timedelta' help_text = "A timedelta field, with duration expressed in seconds. Ex: 132" def convert(self, value): if value is None: return None if isinstance(value, six.string_types): match = TIMEDELTA_REGEX.search(value) if match: data = match.groupdict() return datetime.timedelta(int(data['days']), int(data['hours']), int(data['minutes']), int(data['seconds'])) else: raise ApiFieldError("Timedelta provided to '%s' field doesn't appear to be a valid timedelta string: '%s'" % (self.instance_name, value)) return value def hydrate(self, bundle): value = super(TimedeltaField, self).hydrate(bundle) if value and not hasattr(value, 'seconds'): if isinstance(value, six.string_types): try: match = TIMEDELTA_REGEX.search(value) if match: data = match.groupdict() value = datetime.timedelta(int(data['days']), int(data['hours']), int(data['minutes']), int(data['seconds'])) else: raise ValueError() except (ValueError, TypeError): raise ApiFieldError("Timedelta provided to '%s' field doesn't appear to be a valid datetime string: '%s'" % (self.instance_name, value)) else: raise ApiFieldError("Datetime provided to '%s' field must be a string: %s" % (self.instance_name, value)) return value class ToOneField(tastypie.fields.ToOneField): "Subclass of tastypie.fields.ToOneField which adds caching in the dehydrate method." def dehydrate(self, bundle, for_list=True): foreign_obj = None if callable(self.attribute): previous_obj = bundle.obj foreign_obj = self.attribute(bundle) elif isinstance(self.attribute, six.string_types): foreign_obj = bundle.obj for attr in self._attrs: previous_obj = foreign_obj try: foreign_obj = getattr(foreign_obj, attr, None) except ObjectDoesNotExist: foreign_obj = None if not foreign_obj: if not self.null: if callable(self.attribute): raise ApiFieldError("The related resource for resource %s could not be found." % (previous_obj)) else: raise ApiFieldError("The model '%r' has an empty attribute '%s' and doesn't allow a null value." % (previous_obj, attr)) return None fk_resource = self.get_related_resource(foreign_obj) # Up to this point we've copied the code from tastypie 0.13.1. Now # we add caching. cache_key = fk_resource.generate_cache_key('related', pk=foreign_obj.pk, for_list=for_list, ) dehydrated = fk_resource._meta.cache.get(cache_key) if dehydrated is None: fk_bundle = Bundle(obj=foreign_obj, request=bundle.request) dehydrated = self.dehydrate_related(fk_bundle, fk_resource, for_list=for_list) fk_resource._meta.cache.set(cache_key, dehydrated) return dehydrated