Source code for ppa.unapi.views

from django.http import HttpResponse
from django.views.generic.base import TemplateView
from django.shortcuts import get_object_or_404

from ppa.archive.models import DigitizedWork

[docs]class UnAPIView(TemplateView): '''Simple unAPI service endpoint. With no parameters or only id, provides a list of available metadata formats. If id and format are specified, returns the metadata for the specified item in the requested format. See archived unAPI website for more details. ''' #: template for format information template_name = 'unapi/formats.xml' #: default content type, when serving format information content_type = 'application/xml' #: available metadata formats formats = { 'marc': {'type': 'application/marc'} } #: file extension for metadata formats, as a convenience to set #: download filename extension file_extension = { 'marc': 'mrc' }
[docs] def get(self, *args, **kwargs): '''Override get to check if id and format are specified; if they are, return the requested metadata. Otherwise, falls back to normal template view behavior and displays format information.''' # if both id and format are specified, return actual metadata item_id = self.request.GET.get('id', None) metadata_format = self.request.GET.get('format', None) if item_id and metadata_format: response = HttpResponse( content=self.get_metadata(item_id, metadata_format), content_type=self.formats[metadata_format]['type'] ) # set filename for downloadable content, to aid in testing/debugging response['Content-Disposition'] = \ 'filename="%s.%s"' % (item_id, self.file_extension[metadata_format]) return response # otherwise, return information about available formats return super(UnAPIView, self).get(*args, **kwargs)
[docs] def get_context_data(self, *args, **kwargs): '''pass formats and id to template context''' context = super(UnAPIView, self).get_context_data(*args, **kwargs) context.update({ 'formats': self.formats, 'id': self.request.GET.get('id', None) }) return context
[docs] def get_metadata(self, item_id, data_format): '''get item and requested metadata''' item = get_object_or_404(DigitizedWork, source_id=item_id) return item.get_metadata(data_format)