team-3/src/c3nav/mapdata/api.py

270 lines
11 KiB
Python
Raw Normal View History

import mimetypes
import operator
from functools import reduce
2017-05-05 16:37:03 +02:00
2017-06-11 15:10:36 +02:00
from django.db.models import Prefetch, Q
2017-05-11 19:36:49 +02:00
from django.http import HttpResponse
from django.shortcuts import redirect
2017-05-11 19:36:49 +02:00
from django.utils.translation import ugettext_lazy as _
2017-01-13 21:52:44 +01:00
from rest_framework.decorators import detail_route, list_route
2017-05-11 19:36:49 +02:00
from rest_framework.exceptions import NotFound, ValidationError
2017-05-11 21:30:29 +02:00
from rest_framework.mixins import RetrieveModelMixin
from rest_framework.response import Response
2017-05-11 21:30:29 +02:00
from rest_framework.viewsets import GenericViewSet, ReadOnlyModelViewSet
2017-07-13 19:01:47 +02:00
from c3nav.mapdata.models import AccessRestriction, Building, Door, Hole, LocationGroup, Source, Space
2017-06-22 19:27:51 +02:00
from c3nav.mapdata.models.geometry.level import LevelGeometryMixin
2017-07-08 16:29:12 +02:00
from c3nav.mapdata.models.geometry.space import POI, Area, Column, LineObstacle, Obstacle, SpaceGeometryMixin, Stair
2017-06-11 14:43:14 +02:00
from c3nav.mapdata.models.level import Level
2017-07-10 13:54:33 +02:00
from c3nav.mapdata.models.locations import (Location, LocationGroupCategory, LocationRedirect, LocationSlug,
SpecificLocation)
2017-06-22 19:27:51 +02:00
from c3nav.mapdata.utils.models import get_submodels
2017-06-11 15:10:36 +02:00
def optimize_query(qs):
if issubclass(qs.model, SpecificLocation):
2017-07-10 16:30:38 +02:00
base_qs = LocationGroup.objects.select_related('category').only('id', 'titles', 'category')
qs = qs.prefetch_related(Prefetch('groups', queryset=base_qs))
2017-06-11 15:10:36 +02:00
return qs
2017-05-11 19:36:49 +02:00
class MapdataViewSet(ReadOnlyModelViewSet):
2017-05-11 21:30:29 +02:00
def list(self, request, *args, **kwargs):
2017-06-11 15:10:36 +02:00
qs = optimize_query(self.get_queryset())
2017-05-11 19:36:49 +02:00
geometry = ('geometry' in request.GET)
2017-06-22 19:27:51 +02:00
if issubclass(qs.model, LevelGeometryMixin) and 'level' in request.GET:
2017-06-11 14:43:14 +02:00
if not request.GET['level'].isdigit():
raise ValidationError(detail={'detail': _('%s is not an integer.') % 'level'})
2017-05-11 19:36:49 +02:00
try:
2017-06-11 14:43:14 +02:00
level = Level.objects.get(pk=request.GET['level'])
except Level.DoesNotExist:
raise NotFound(detail=_('level not found.'))
qs = qs.filter(level=level)
2017-06-22 19:27:51 +02:00
if issubclass(qs.model, SpaceGeometryMixin) and 'space' in request.GET:
2017-05-11 19:36:49 +02:00
if not request.GET['space'].isdigit():
raise ValidationError(detail={'detail': _('%s is not an integer.') % 'space'})
try:
space = Space.objects.get(pk=request.GET['space'])
except Space.DoesNotExist:
raise NotFound(detail=_('space not found.'))
2017-05-11 19:36:49 +02:00
qs = qs.filter(space=space)
2017-07-10 16:36:52 +02:00
if issubclass(qs.model, LocationGroup) and 'category' in request.GET:
kwargs = {('pk' if request.GET['category'].isdigit() else 'name'): request.GET['category']}
try:
category = LocationGroupCategory.objects.get(**kwargs)
except LocationGroupCategory.DoesNotExist:
raise NotFound(detail=_('category not found.'))
qs = qs.filter(category=category)
2017-07-10 16:43:44 +02:00
if issubclass(qs.model, SpecificLocation) and 'group' in request.GET:
if not request.GET['group'].isdigit():
raise ValidationError(detail={'detail': _('%s is not an integer.') % 'group'})
try:
group = LocationGroup.objects.get(pk=request.GET['group'])
except LocationGroupCategory.DoesNotExist:
raise NotFound(detail=_('group not found.'))
qs = qs.filter(groups=group)
2017-06-11 14:43:14 +02:00
if qs.model == Level and 'on_top_of' in request.GET:
if request.GET['on_top_of'] == 'null':
qs = qs.filter(on_top_of__isnull=False)
else:
if not request.GET['on_top_of'].isdigit():
raise ValidationError(detail={'detail': _('%s is not null or an integer.') % 'on_top_of'})
try:
2017-06-11 14:43:14 +02:00
level = Level.objects.get(pk=request.GET['on_top_of'])
except Level.DoesNotExist:
raise NotFound(detail=_('level not found.'))
qs = qs.filter(on_top_of=level)
2017-05-11 19:36:49 +02:00
return Response([obj.serialize(geometry=geometry) for obj in qs.order_by('id')])
2017-05-11 21:30:29 +02:00
def retrieve(self, request, *args, **kwargs):
2017-05-11 19:36:49 +02:00
return Response(self.get_object().serialize())
2017-05-11 21:30:29 +02:00
@staticmethod
def list_types(models_list, **kwargs):
return Response([
2017-05-11 21:30:29 +02:00
model.serialize_type(**kwargs) for model in models_list
])
2017-06-11 14:43:14 +02:00
class LevelViewSet(MapdataViewSet):
2017-07-10 16:43:44 +02:00
""" Add ?on_top_of=<null or id> to filter by on_top_of, add ?group=<id> to filter by group. """
2017-06-11 14:43:14 +02:00
queryset = Level.objects.all()
2016-12-07 16:11:33 +01:00
2017-05-11 19:36:49 +02:00
@list_route(methods=['get'])
def geometrytypes(self, request):
2017-06-22 19:27:51 +02:00
return self.list_types(get_submodels(LevelGeometryMixin))
2016-12-07 16:11:33 +01:00
2017-05-12 23:37:03 +02:00
@detail_route(methods=['get'])
def svg(self, requests, pk=None):
2017-06-11 14:43:14 +02:00
level = self.get_object()
response = HttpResponse(level.render_svg(), 'image/svg+xml')
2017-05-12 23:37:03 +02:00
return response
2016-12-19 16:54:11 +01:00
2017-05-11 19:36:49 +02:00
class BuildingViewSet(MapdataViewSet):
2017-06-11 14:43:14 +02:00
""" Add ?geometry=1 to get geometries, add ?level=<id> to filter by level. """
2017-05-11 19:36:49 +02:00
queryset = Building.objects.all()
2016-12-06 23:43:57 +01:00
2016-12-19 16:54:11 +01:00
2017-05-11 19:36:49 +02:00
class SpaceViewSet(MapdataViewSet):
2017-07-10 16:43:44 +02:00
""" Add ?geometry=1 to get geometries, add ?level=<id> to filter by level, add ?group=<id> to filter by group. """
2017-05-11 19:36:49 +02:00
queryset = Space.objects.all()
2016-12-08 12:36:09 +01:00
2017-05-11 19:36:49 +02:00
@list_route(methods=['get'])
def geometrytypes(self, request):
2017-06-22 19:27:51 +02:00
return self.list_types(get_submodels(SpaceGeometryMixin))
2016-12-06 23:43:57 +01:00
2017-05-11 19:36:49 +02:00
class DoorViewSet(MapdataViewSet):
2017-06-11 14:43:14 +02:00
""" Add ?geometry=1 to get geometries, add ?level=<id> to filter by level. """
2017-05-11 19:36:49 +02:00
queryset = Door.objects.all()
class HoleViewSet(MapdataViewSet):
2017-06-08 15:19:12 +02:00
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space. """
2017-05-11 19:36:49 +02:00
queryset = Hole.objects.all()
class AreaViewSet(MapdataViewSet):
2017-07-10 16:43:44 +02:00
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space, add ?group=<id> to filter by group. """
2017-05-11 19:36:49 +02:00
queryset = Area.objects.all()
class StairViewSet(MapdataViewSet):
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space. """
queryset = Stair.objects.all()
class ObstacleViewSet(MapdataViewSet):
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space. """
queryset = Obstacle.objects.all()
class LineObstacleViewSet(MapdataViewSet):
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space. """
queryset = LineObstacle.objects.all()
2017-06-09 15:22:30 +02:00
class ColumnViewSet(MapdataViewSet):
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space. """
queryset = Column.objects.all()
2017-07-08 16:29:12 +02:00
class POIViewSet(MapdataViewSet):
2017-07-10 16:43:44 +02:00
""" Add ?geometry=1 to get geometries, add ?space=<id> to filter by space, add ?group=<id> to filter by group. """
2017-07-08 16:29:12 +02:00
queryset = POI.objects.all()
2017-05-11 19:36:49 +02:00
2017-07-10 13:54:33 +02:00
class LocationGroupCategoryViewSet(MapdataViewSet):
queryset = LocationGroupCategory.objects.all()
2017-05-11 19:36:49 +02:00
class LocationGroupViewSet(MapdataViewSet):
2017-07-10 16:36:52 +02:00
""" Add ?category=<id or name> to filter by category. """
2017-05-11 19:36:49 +02:00
queryset = LocationGroup.objects.all()
2017-05-11 21:30:29 +02:00
class LocationViewSet(RetrieveModelMixin, GenericViewSet):
2017-05-12 12:55:23 +02:00
"""
only accesses locations that have can_search or can_describe set to true.
2017-07-10 17:03:44 +02:00
add ?detailed=1 to show all attributes, add ?group=<id> to filter by group.
2017-05-12 12:55:23 +02:00
/{id}/ add ?show_redirect=1 to suppress redirects and show them as JSON.
/search/ only accesses locations that have can_search set to true. Add GET Parameter s to search.
"""
2017-05-11 19:36:49 +02:00
queryset = LocationSlug.objects.all()
lookup_field = 'slug'
2017-07-10 17:03:44 +02:00
def get_queryset(self, detailed=False, subconditions=None, group=None):
2017-06-22 20:09:58 +02:00
queryset = super().get_queryset().order_by('id')
2017-06-22 19:57:49 +02:00
conditions = []
for model in get_submodels(Location):
2017-07-10 17:03:44 +02:00
if group is not None and not hasattr(model, 'groups'):
continue
2017-06-22 20:09:58 +02:00
condition = Q(**{model._meta.default_related_name + '__isnull': False})
if subconditions:
condition &= reduce(operator.or_, (Q(**{model._meta.default_related_name+'__'+name: value})
for name, value in subconditions.items()))
2017-07-10 17:03:44 +02:00
if group is not None:
condition &= Q(**{model._meta.default_related_name+'__groups': group})
2017-06-22 20:09:58 +02:00
conditions.append(condition)
2017-06-22 19:57:49 +02:00
queryset = queryset.filter(reduce(operator.or_, conditions))
if detailed:
2017-07-10 16:30:38 +02:00
base_qs = LocationGroup.objects.all().select_related('category')
2017-06-22 19:58:08 +02:00
for model in get_submodels(SpecificLocation):
2017-06-22 20:09:58 +02:00
queryset = queryset.prefetch_related(Prefetch(model._meta.default_related_name + '__groups',
2017-07-10 16:30:38 +02:00
queryset=base_qs))
2017-06-22 20:09:58 +02:00
return queryset
def list(self, request, *args, **kwargs):
detailed = 'detailed' in request.GET
2017-07-10 17:03:44 +02:00
subconditions = {'can_search': True, 'can_describe': True}
group = None
if 'group' in request.GET:
if not request.GET['group'].isdigit():
raise ValidationError(detail={'detail': _('%s is not an integer.') % 'group'})
try:
group = LocationGroup.objects.get(pk=request.GET['group'])
except LocationGroupCategory.DoesNotExist:
raise NotFound(detail=_('group not found.'))
queryset = self.get_queryset(detailed=detailed, subconditions=subconditions, group=group)
2017-06-22 20:09:58 +02:00
return Response([obj.get_child().serialize(include_type=True, detailed=detailed) for obj in queryset])
2017-05-12 12:55:23 +02:00
def retrieve(self, request, slug=None, *args, **kwargs):
result = Location.get_by_slug(slug, self.get_queryset())
if result is None:
raise NotFound
2017-05-27 18:33:16 +02:00
result = result.get_child()
if isinstance(result, LocationRedirect):
if 'show_redirects' in request.GET:
return Response(result.serialize(include_type=True))
return redirect('../'+result.target.slug) # todo: why does redirect/reverse not work here?
2017-05-27 18:33:16 +02:00
return Response(result.serialize(include_type=True, detailed='detailed' in request.GET))
2017-05-11 21:30:29 +02:00
@list_route(methods=['get'])
def types(self, request):
2017-06-22 19:27:51 +02:00
return MapdataViewSet.list_types(get_submodels(Location), geomtype=False)
2017-05-11 21:30:29 +02:00
2017-05-12 12:54:50 +02:00
@list_route(methods=['get'])
def redirects(self, request):
return Response([obj.serialize(include_type=False) for obj in LocationRedirect.objects.all().order_by('id')])
2017-05-12 13:49:42 +02:00
@list_route(methods=['get'])
def search(self, request):
2017-06-22 20:02:29 +02:00
detailed = 'detailed' in request.GET
2017-05-12 13:49:42 +02:00
search = request.GET.get('s')
2017-06-22 20:02:29 +02:00
2017-06-22 20:09:58 +02:00
queryset = self.get_queryset(detailed=detailed, subconditions={'can_search': True})
2017-06-22 20:02:29 +02:00
2017-05-12 13:49:42 +02:00
if not search:
return Response([obj.get_child().serialize(include_type=True, detailed=detailed) for obj in queryset])
2017-05-12 13:49:42 +02:00
words = search.lower().split(' ')[:10]
2017-06-22 20:02:29 +02:00
results = queryset
2017-05-12 13:49:42 +02:00
for word in words:
results = [r for r in results if (word in r.title.lower() or (r.slug and word in r.slug.lower()))]
# todo: rank results
return Response([obj.get_child().serialize(include_type=True, detailed=detailed) for obj in results])
2017-05-12 13:49:42 +02:00
2017-05-12 01:21:53 +02:00
class SourceViewSet(MapdataViewSet):
queryset = Source.objects.all()
@detail_route(methods=['get'])
2017-05-11 19:36:49 +02:00
def image(self, request, pk=None):
return self._image(request, pk=pk)
2016-12-07 16:11:33 +01:00
2017-05-11 19:36:49 +02:00
def _image(self, request, pk=None):
source = self.get_object()
2017-07-08 15:09:56 +02:00
return HttpResponse(open(source.filepath, 'rb'), content_type=mimetypes.guess_type(source.name)[0])
2017-07-13 19:01:47 +02:00
class AccessRestrictionViewSet(MapdataViewSet):
queryset = AccessRestriction.objects.all()