Coverage for madrona/features/views : 10%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
|
""" Return the specified instance by uid for editing. If a target_klass is provided, uid will be checked for consistency. If the request has no logged-in user, a 401 Response will be returned. If the item is not found, a 404 Response will be returned. If the user is not authorized to edit the item (not the owner or a staff user), a 403 Not Authorized Response will be returned.
usage:
instance = get_object_for_editing(request, 'mlpa_mpa_12', target_klass=Mpa) if isinstance(instance, HttpResponse): return instance
""" if target_klass and not target_klass.model_uid() in uid: return HttpResponse("Target class %s doesn't match the provided uid %s" % (target_klass, uid), status=401) try: instance = get_feature_by_uid(uid) except ValueError: return HttpResponse("Uid not valid: %s" % uid, status=401) except: return HttpResponse("Feature not found - %s" % uid, status=404)
if not request.user.is_authenticated(): return HttpResponse('You must be logged in.', status=401) # Check that user owns the object or is staff if not request.user.is_staff and request.user != instance.user: return HttpResponseForbidden( 'You do not have permission to modify this object.') return instance
""" Return the specified instance by uid for viewing. If a target_klass is provided, uid will be checked for consistency. If the request has no authenticated user, a 401 Response will be returned. If the item is not found, a 404 Response will be returned. If the user is not authorized to view the item (not the owner or part of a group the item is shared with), a 403 Not Authorized Response will be returned.
usage:
instance = get_object_for_viewing(request, 'mlpa_mpa_12', target_klass=Mpa) if isinstance(instance, HttpResponse): return instance
""" if target_klass and not target_klass.model_uid() in uid: return HttpResponse("Target class %s doesn't match the provided uid %s" % (target_klass, uid), status=401) try: instance = get_feature_by_uid(uid) except ValueError: return HttpResponse("Uid not valid: %s" % uid, status=401) except: return HttpResponse("Feature not found - %s" % uid, status=404)
viewable, response = instance.is_viewable(request.user) if viewable: return instance else: return response
# RESTful Generic Views
""" Handles all requests to views setup via features.register using Link objects.
Assuming a valid request, this generic view will call the view specified by the link including an instance or instances argument containing the relavent Feature(s).
If the incoming request is invalid, any one of the following errors may be returned:
401: login required 403: user does not have permission (not admin user or doesn't own object to be edited) 404: feature(s) could not be found 400: requested for feature classes not supported by this view 5xx: server error """ if link is None: raise Exception('handle_link configured without link kwarg!') uids = uids.split(',') # check that the number of instances matches the link.select property if len(uids) > 1 and link.select is 'single': # too many return HttpResponse( 'Not Supported Error: Requested %s for multiple instances' % ( link.title, ), status=400) singles = ('single', 'multiple single', 'single multiple') if len(uids) is 1 and link.select not in singles: # not enough return HttpResponse( 'Not Supported Error: Requested %s for single instance' % ( link.title, ), status=400) instances = [] for uid in uids: if link.rel == 'edit': if link.method.lower() == 'post' and request.method == 'GET': resp = HttpResponse('Invalid Method', status=405) resp['Allow'] = 'POST' return resp if link.edits_original is False: # users who can view the object can then make copies inst = get_object_for_viewing(request, uid) else: inst = get_object_for_editing(request, uid) else: inst = get_object_for_viewing(request, uid)
if isinstance(inst, HttpResponse): return inst else: instances.append(inst) for instance in instances: if link.generic and instance.__class__ not in link.models: return HttpResponse( 'Not Supported Error: Requested for "%s" feature class. This \ generic link only supports requests for feature classes %s' % ( instance.__class__.__name__, ', '.join([m.__name__ for m in link.models])), status=400)
if link.select is 'single': return link.view(request, instances[0], **link.extra_kwargs) else: return link.view(request, instances, **link.extra_kwargs)
""" When calling, provide the request object, reference to the resource class, and the primary key of the object to delete.
Possible response codes:
200: delete operation successful 401: login required 403: user does not have permission (not admin user or doesn't own object) 404: resource for deletion could not be found 5xx: server error """ if model is None: return HttpResponse('Model not specified in feature urls', status=500) if request.method == 'DELETE': if model is None or uid is None: raise Exception('delete view not configured properly.') instance = get_object_for_editing(request, uid, target_klass=model) if isinstance(instance, HttpResponse): # get_object_for_editing is trying to return a 404, 401, or 403 return instance instance.delete() return HttpResponse('{"status": 200}') else: return HttpResponse('DELETE http method must be used to delete', status=405)
""" Generic view to delete multiple instances """ deleted = [] if request.method == 'DELETE': for instance in instances: uid = instance.uid instance.delete() deleted.append(uid) return HttpResponse('{"status": 200}') else: return HttpResponse('DELETE http method must be used to delete', status=405)
""" When calling, provide the request object and a ModelForm class
POST: Create a new instance from filled out ModelForm
201: Created. Response body includes representation of resource 400: Validation error. Response body includes form. Form should be displayed back to the user for correction. 401: Not logged in. 5xx: Server error. """ config = model.get_options() form_class = config.get_form_class() if not request.user.is_authenticated(): return HttpResponse('You must be logged in.', status=401) title = 'New %s' % (config.slug, ) if request.method == 'POST': values = request.POST.copy() values.__setitem__('user', request.user.pk) if request.FILES: form = form_class(values, request.FILES, label_suffix='') else: form = form_class(values, label_suffix='') if form.is_valid(): m = form.save(commit=False) ''' Note on the following 3 lines: We need to call form.save_m2m after save but before run, this is accomplished in the Feature model save method ''' kwargs = {} kwargs['form'] = form m.save(**kwargs)
return to_response( status=201, location=m.get_absolute_url(), select=m.uid, show=m.uid ) else: context = config.form_context user = request.user context.update({ 'form': form, 'title': title, 'action': action, 'is_ajax': request.is_ajax(), 'MEDIA_URL': settings.MEDIA_URL, 'is_spatial': issubclass(model, SpatialFeature), 'is_collection': issubclass(model, FeatureCollection), 'user': user, }) context = decorate_with_manipulators(context, form_class) c = RequestContext(request, context) t = loader.get_template(config.form_template) return HttpResponse(t.render(c), status=400) else: return HttpResponse('Invalid http method', status=405)
""" Serves a form for creating new objects
GET only """ config = model.get_options() form_class = config.get_form_class() if action is None: raise Exception('create_form view is not configured properly.') if not request.user.is_authenticated(): return HttpResponse('You must be logged in.', status=401) title = 'New %s' % (config.verbose_name) user = request.user context = config.form_context if request.method == 'GET': context.update({ 'form': form_class(label_suffix=''), 'title': title, 'action': action, 'is_ajax': request.is_ajax(), 'MEDIA_URL': settings.MEDIA_URL, 'is_spatial': issubclass(model, SpatialFeature), 'is_collection': issubclass(model, FeatureCollection), 'user': user, }) context = decorate_with_manipulators(context, form_class) return render_to_response(config.form_template, context) else: return HttpResponse('Invalid http method', status=405)
""" Returns a form for editing features """ instance = get_object_for_editing(request, uid, target_klass=model) if isinstance(instance, HttpResponse): # get_object_for_editing is trying to return a 404, 401, or 403 return instance try: instance.get_absolute_url() except: raise Exception( 'Model to be edited must have get_absolute_url defined.') try: instance.name except: raise Exception('Model to be edited must have a name attribute.')
user = request.user config = model.get_options() if request.method == 'GET': form_class = config.get_form_class() form = form_class(instance=instance, label_suffix='') context = config.form_context context.update({ 'form': form, 'title': "Edit '%s'" % (instance.name, ), 'action': instance.get_absolute_url(), 'is_ajax': request.is_ajax(), 'MEDIA_URL': settings.MEDIA_URL, 'is_spatial': issubclass(model, SpatialFeature), 'is_collection': issubclass(model, FeatureCollection), 'user': user, }) context = decorate_with_manipulators(context, form_class) return render_to_response(config.form_template, context) else: return HttpResponse('Invalid http method', status=405)
""" When calling, provide the request object, a model class, and the primary key of the instance to be updated.
POST: Update instance.
possible response codes:
200: OK. Object updated and in response body. 400: Form validation error. Present form back to user. 401: Not logged in. 403: Forbidden. User is not staff or does not own object. 404: Instance for uid not found. 5xx: Server error. """ config = model.get_options() instance = get_object_for_editing(request, uid, target_klass=model) if isinstance(instance, HttpResponse): # get_object_for_editing is trying to return a 404, 401, or 403 return instance try: instance.get_absolute_url() except: raise Exception('Model must have get_absolute_url defined.') try: instance.name except: raise Exception('Model to be edited must have a name attribute.')
if request.method == 'POST': values = request.POST.copy() # Even if request.user is different (ie request.user is staff) # user is still set to the original owner to prevent staff from # 'stealing' values.__setitem__('user', instance.user.pk) form_class = config.get_form_class() if request.FILES: form = form_class( values, request.FILES, instance=instance, label_suffix='') else: form = form_class(values, instance=instance, label_suffix='') if form.is_valid(): m = form.save(commit=False) kwargs = {} kwargs['form'] = form m.save(**kwargs)
return to_response( status=200, select=m.uid, show=m.uid, parent=m.collection, ) else: context = config.form_context context.update({ 'form': form, 'title': "Edit '%s'" % (instance.name, ), 'action': instance.get_absolute_url(), 'is_ajax': request.is_ajax(), 'MEDIA_URL': settings.MEDIA_URL, 'is_spatial': issubclass(model, SpatialFeature), 'is_collection': issubclass(model, FeatureCollection), }) context = decorate_with_manipulators(context, form_class) c = RequestContext(request, context) t = loader.get_template(config.form_template) return HttpResponse(t.render(c), status=400) else: return HttpResponse("""Invalid http method. Yes we know, PUT is supposed to be used rather than POST, but it was much easier to implement as POST :)""", status=405)
""" Provides a resource for a django model that can be utilized by the madrona.features client module.
Implements actions for the following http actions:
POST: Update an object DELETE: Delete it GET: Provide a page representing the model. For MPAs, this is the MPA attributes screen. The madrona client will display this page in the sidebar whenever the object is brought into focus.
To implement GET, this view needs to be passed a view function that returns an HttpResponse or a template can be specified that will be passed the instance and an optional extra_context
Uses madrona.features.views.update and madrona.feature.views.delete """ if model is None: return HttpResponse('Model not specified in feature urls', status=500) config = model.get_options() if request.method == 'DELETE': return delete(request, model, uid) elif request.method == 'GET': instance = get_object_for_viewing(request, uid, target_klass=model) if isinstance(instance, HttpResponse): # Object is not viewable so we return httpresponse # should contain the appropriate error code return instance
t = config.get_show_template() context = config.show_context context.update({ 'instance': instance, 'MEDIA_URL': settings.MEDIA_URL, 'is_ajax': request.is_ajax(), 'template': t.name, })
return HttpResponse(t.render(RequestContext(request, context))) elif request.method == 'POST': return update(request, model, uid)
if model is None: return HttpResponse('Model not specified in feature urls', status=500) if request.method == 'POST': if uid is None: return create(request, model, request.build_absolute_uri()) else: return HttpResponse('Invalid http method', status=405) elif request.method == 'GET': if uid is None: # Get the create form return create_form( request, model, action=request.build_absolute_uri()) else: # get the update form return update_form(request, model, uid) else: return HttpResponse('Invalid http method', status=405)
# TODO: Refactor this so that it is part of Feature.Options.edit_context try: extra_context['json'] = simplejson.dumps(get_manipulators_for_model(form_class.Meta.model)) except: extra_context['json'] = False return extra_context
""" Generic view that can be used to copy any feature classes. Supports requests referencing multiple instances.
To copy, this view will call the copy() method with the request's user as it's sole argument. The Feature base class has a generic copy method, but developers can override it. A poorly implemented copy method that does not return the copied instance will raise an exception here.
This view returns a space-delimited list of the Feature uid's for selection in the user-interface after this operation via the X-Madrona-Select response header. """ copies = [] # setting this here because somehow the copies and instances vars get # confused untoggle = ' '.join([i.uid for i in instances]) for instance in instances: copy = instance.copy(request.user) if not copy or not isinstance(copy, Feature): raise Exception('copy method on feature class %s did not return \ Feature instance.' % (instance.__class__.__name__, )) copies.append(copy) return to_response( status=200, select=copies, untoggle=untoggle, ) return response
return kml_core(request, instances, kmz=False)
return kml_core(request, instances, kmz=True)
""" Generic view for KML representation of feature classes. Can be overridden in options but this provided a default. """ from madrona.kmlapp.views import get_styles, create_kmz from django.template.loader import get_template from madrona.common import default_mimetypes as mimetypes from madrona.features.models import FeatureCollection
user = request.user try: session_key = request.COOKIES['sessionid'] except: session_key = 0
# Get features, collection from instances features = [] collections = []
# If there is only a single instance with a kml_full property, # just return the contents verbatim if len(instances) == 1: from madrona.common.utils import is_text filename = slugify(instances[0].name) try: kml = instances[0].kml_full response = HttpResponse() if is_text(kml) and kmz: # kml_full is text, but they want as KMZ kmz = create_kmz(kml, 'mm/doc.kml') response['Content-Type'] = mimetypes.KMZ response['Content-Disposition'] = 'attachment; filename=%s.kmz' % filename response.write(kmz) return response elif is_text(kml) and not kmz: # kml_full is text, they just want kml response['Content-Type'] = mimetypes.KML response['Content-Disposition'] = 'attachment; filename=%s.kml' % filename response.write(kml) return response else: # If the kml_full returns binary, always return kmz # even if they asked for kml response['Content-Type'] = mimetypes.KMZ response['Content-Disposition'] = 'attachment; filename=%s.kmz' % filename response.write(kml) # actually its kmz but whatevs return response except AttributeError: pass
for instance in instances: viewable, response = instance.is_viewable(user) if not viewable: return viewable, response
if isinstance(instance, FeatureCollection): collections.append(instance) else: features.append(instance)
styles = get_styles(features,collections,links=False)
t = get_template('kmlapp/myshapes.kml') context = Context({ 'user': user, 'features': features, 'collections': collections, 'use_network_links': False, 'request_path': request.path, 'styles': styles, 'session_key': session_key, 'shareuser': None, 'sharegroup': None, 'feature_id': None, }) kml = t.render(context) response = HttpResponse() filename = '_'.join([slugify(i.name) for i in instances])
if kmz: kmz = create_kmz(kml, 'mm/doc.kml') response['Content-Type'] = mimetypes.KMZ response['Content-Disposition'] = 'attachment; filename=%s.kmz' % filename response.write(kmz) else: response['Content-Type'] = mimetypes.KML response['Content-Disposition'] = 'attachment; filename=%s.kml' % filename response.write(kml) response.write('\n') return response
""" Generic view for showing the sharing form for an object
POST: Update the sharing status of an object GET: Provide an html form for selecting groups to which the feature will be shared. """ if model is None: return HttpResponse('Model not specified in feature urls', status=500) if uid is None: return HttpResponse('Instance UID not specified', status=500)
obj = get_object_for_editing(request, uid, target_klass=model)
if isinstance(obj, HttpResponse): return obj if not isinstance(obj, Feature): return HttpResponse('Instance is not a Feature', status=500)
obj_type_verbose = obj._meta.verbose_name
if request.method == 'GET': # Display the form # Which groups is this object already shared to? already_shared_groups = obj.sharing_groups.all()
# Get a list of user's groups that have sharing permissions groups = user_sharing_groups(request.user)
return render_to_response('sharing/share_form.html', {'groups': groups, 'already_shared_groups': already_shared_groups, 'obj': obj, 'obj_type_verbose': obj_type_verbose, 'user':request.user, 'MEDIA_URL': settings.MEDIA_URL, 'action': request.build_absolute_uri()})
elif request.method == 'POST': group_ids = [int(x) for x in request.POST.getlist('sharing_groups')] groups = Group.objects.filter(pk__in=group_ids)
try: obj.share_with(groups) return to_response( status=200, select=obj, parent=obj.collection, ) except Exception as e: return HttpResponse( 'Unable to share objects with those specified groups: %r.' % e, status=500)
else: return HttpResponse("Received unexpected " + request.method + " request.", status=400)
config = collection_model.get_options() collection_instance = get_object_for_editing(request, collection_uid, target_klass=collection_model) if isinstance(collection_instance, HttpResponse): return instance
if request.method == 'POST': uids = uids.split(',') instances = [] for uid in uids: inst = get_object_for_editing(request, uid)
if isinstance(inst, HttpResponse): return inst else: instances.append(inst)
if action == 'remove': for instance in instances: instance.remove_from_collection() elif action == 'add': for instance in instances: instance.add_to_collection(collection_instance) else: return HttpResponse("Invalid action %s." % action, status=500)
return to_response( status=200, select=instances, parent=collection_instance, ) else: return HttpResponse("Invalid http method.", status=405)
def workspace(request, username, is_owner): user = request.user if request.method == 'GET': if user.is_anonymous() and is_owner: return HttpResponse("Anonymous user can't access workspace as owner", status=403) res = HttpResponse(workspace_json(user, is_owner), status=200) res['Content-Type'] = mimetypes.JSON return res else: return HttpResponse("Invalid http method.", status=405)
def feature_tree_css(request): from madrona.features import registered_models if request.method == 'GET': styles = [] for model in registered_models: try: css = model.css() if css: styles.append(css) except: logger.ERROR("Something is wrong with %s.css() class method" % model) pass
res = HttpResponse('\n'.join(styles), status=200) res['Content-Type'] = 'text/css' return res else: return HttpResponse("Invalid http method.", status=405)
untoggle=None, location=None): """Will return an appropriately structured response that the client can interpret to carry out the following actions:
select Accepts a list of features. Tells the client to select these features in the user interface after an editing operation
show Accepts a single feature. Client will show that feature's attribute window in the sidebar
untoggle Accepts a list of features. Useful for toggling the visibility of original features that are being copied so there are not multiple overlapping copies on the map
parent Gives a hint to the client that the edited feature falls within a particular FeatureCollection. Without this hint the client may not in all cases be able to perform select and show behaviors.
These behaviors are intended to be specified to the client using X-Madrona- style headers in the response. Unfortunately, we have to post some forms via an iframe in order to upload files. This makes it impossible to get the response headers on the client end. This function therefor currently also returns all headers in a json structure in the response body. """ headers = { "status": status, "Location": location, "X-Madrona-Select": to_csv(select), "X-Madrona-Parent-Hint": to_csv(parent), "X-Madrona-Show": to_csv(show), "X-Madrona-UnToggle": to_csv(untoggle), } headers = dict((k,v) for k,v in headers.items() if v != '' and v != None) response = HttpResponse(simplejson.dumps(headers), status=status) for k,v in headers.items(): if k != 'status' and k != 'Location': response[k] = v return response
if not features or isinstance(features, unicode): return features elif isinstance(features, Feature): return features.uid elif len(features) != 0: return ' '.join([f.uid for f in features]) else: return features
""" Util function to determine if a user owns any features """ from madrona.features import registered_models for model in registered_models: try: if len(model.objects.filter(user=user)) > 0: return True except: pass return False
""" Generic view for GeoJSON representation of feature classes. Can be overridden but this is provided a default.
To override, feature class needs a geojson object that returns a geojson feature string (no trailing comma)::
{ "type": "Feature", "geometry": {"type": "Point", "coordinates": [102.0, 0.5]}, "properties": {"prop0": "value0"} }
GeoJSON Feature collections *cannot* be nested within other feature collections http://lists.geojson.org/pipermail/geojson-geojson.org/2008-October/000464.html Thus collections can be treated using one of the following strategies:
``flat``: (DEFAULT) The collection is "flattened" to contain all the features in a single featurecollection (lossy)
``nest_feature_set``: the collection is represented as an empty geometry with a special feature_set property; a list of UIDs to fetch (requires a client with knowledge of this convention)
Pass by URL GET parameter like ?strategy=nest_feature_set """ from madrona.common import default_mimetypes as mimetypes from madrona.common.jsonutils import get_properties_json, get_feature_json, srid_to_urn, srid_to_proj from madrona.features.models import FeatureCollection, SpatialFeature, Feature from django.contrib.gis.gdal import DataSource import tempfile import os import json
strategy = request.GET.get('strategy', default='flat') strategy = strategy.lower()
if settings.GEOJSON_SRID: srid_setting = settings.GEOJSON_SRID else: srid_setting = settings.GEOMETRY_DB_SRID srid = int(request.GET.get('srid', default=srid_setting)) if srid <= 32766: # assumed max EPSG code crs = srid_to_urn(srid) else: crs = srid_to_proj(srid)
if settings.GEOJSON_DOWNLOAD: download = 'noattach' not in request.GET else: download = 'attach' in request.GET
feature_jsons = [] for i in instances: gj = None try: gj = i.geojson(srid) except AttributeError: pass
if gj is None: props = get_properties_json(i) if issubclass(i.__class__, FeatureCollection): if strategy == 'nest_feature_set': # collections are treated as null geoms with 'feature_set' property props['feature_set'] = [x.uid for x in i.feature_set()] gj = get_feature_json('null', json.dumps(props)) else: # assume 'flat' strategy and recurse feats = [f for f in i.feature_set(recurse=True) if not isinstance(f, FeatureCollection)] gjs = [] for f in feats: try: geom = x.geometry_final.transform(srid, clone=True).json except: geom = 'null' props = get_properties_json(f) gjs.append(get_feature_json(geom, json.dumps(props))) gj = ', \n'.join(gjs)
else: try: # Eventually support an Option to configure the geometry field? geom = i.geometry_final.transform(srid, clone=True).json except: geom = 'null' gj = get_feature_json(geom, json.dumps(props))
if gj is not None: feature_jsons.append(gj)
geojson = """{ "type": "FeatureCollection", "crs": { "type": "name", "properties": {"name": "%s"}}, "features": [ %s ] }""" % (crs, ', \n'.join(feature_jsons),)
##### Not reliable, extent call throws unknown OGR error, even with valid datasource #tmpfile = tempfile.mktemp() + ".json" #with open(tmpfile, 'w') as fh: # fh.write(geojson) #ds = DataSource(tmpfile) #bbox = list(ds[0].extent.tuple) #if bbox and len(bbox) == 4: # # requires "bbox": null, in the geojson # geojson.replace('"bbox": null,', '"bbox": %s,' % str(bbox)) #del ds #os.remove(tmpfile)
response = HttpResponse() response['Content-Type'] = mimetypes.JSON if download: filename = '_'.join([slugify(i.name) for i in instances])[:40] response['Content-Disposition'] = 'attachment; filename=%s.geojson' % filename response.write(geojson) return response |