Webgateway api2

components/tools/OmeroWeb/omeroweb/decorators.py

@@ -25,7 +25,8 @@
 
 import logging
 import traceback
-from django.http import Http404, HttpResponse, HttpResponseRedirect
+from django.http import Http404, HttpResponse, HttpResponseRedirect, \
+    JsonResponse
 from django.http import HttpResponseForbidden, StreamingHttpResponse
 
 from django.conf import settings
@@ -36,7 +37,6 @@
 from django.template import RequestContext
 from django.core.cache import cache
 
-from omeroweb.http import HttpJsonResponse
 from omeroweb.utils import reverse_with_params
 from omeroweb.connector import Connector
 from omero.gateway.utils import propertiesToDict
@@ -558,7 +558,9 @@ def wrapper(request, *args, **kwargs):
             # allows us to return the dict as json  (NB: BlitzGateway objects
             # don't serialize)
             if template is None or template == 'json':
-                return HttpJsonResponse(context)
+                # We still need to support non-dict data:
+                safe = type(context) is dict
+                return JsonResponse(context, safe=safe)
             else:
                 # allow additional processing of context dict
                 ctx.prepare_context(request, context, *args, **kwargs)

components/tools/OmeroWeb/omeroweb/feedback/views.py

@@ -35,9 +35,8 @@
 
 from django.conf import settings
 from django.template import loader as template_loader
-from django.http import HttpResponse, HttpResponseRedirect
+from django.http import HttpResponse, HttpResponseRedirect, JsonResponse
 from django.http import HttpResponseServerError, HttpResponseNotFound
-from django.http import HttpResponseForbidden
 from django.template import RequestContext
 from django.views.defaults import page_not_found
 from django.core.urlresolvers import reverse
@@ -131,12 +130,16 @@ def send_comment(request):
 ##############################################################################
 # handlers
 
-
 def csrf_failure(request, reason=""):
-    logger.warn('csrf_failure: Forbidden')
-    t = template_loader.get_template("403_csrf.html")
-    c = RequestContext(request, {})
-    return HttpResponseForbidden(t.render(c))
+    """
+    Always return Json response
+    since this is accepted by browser and API users
+    """
+    error = ("CSRF Error. You need to include valid CSRF tokens for any"
+             " POST, PUT, PATCH or DELETE operations."
+             " You have to include CSRF token in the POST data or"
+             " add the token to the HTTP header.")
+    return JsonResponse({"message": error}, status=403)
 
 
 def handler500(request):

components/tools/OmeroWeb/omeroweb/http.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 #
-# Copyright (C) 2011-2014 University of Dundee & Open Microscopy Environment.
+# Copyright (C) 2011-2016 University of Dundee & Open Microscopy Environment.
 # All rights reserved.
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,14 +19,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-import json
-
 from django.http import HttpResponse, HttpResponseServerError
 
 
 class HttpJavascriptResponse(HttpResponse):
     def __init__(self, content):
-        HttpResponse.__init__(self, content, content_type="text/javascript")
+        HttpResponse.__init__(self, content,
+                              content_type="application/javascript")
 
 
 class HttpJavascriptResponseServerError(HttpResponseServerError):
@@ -35,12 +34,6 @@ def __init__(self, content):
             self, content, content_type="text/javascript")
 
 
-class HttpJsonResponse(HttpResponse):
-    def __init__(self, content):
-        HttpResponse.__init__(
-            self, json.dumps(content), content_type="application/json")
-
-
 class HttpJPEGResponse(HttpResponse):
     def __init__(self, content):
         HttpResponse.__init__(self, content, content_type="image/jpeg")

components/tools/OmeroWeb/omeroweb/settings.py

@@ -472,7 +472,15 @@ def leave_none_unset_int(s):
          ("Workers silent for more than this many seconds are killed "
           "and restarted. Check Gunicorn Documentation "
           "http://docs.gunicorn.org/en/stable/settings.html#timeout")],
-
+    "omero.web.api.absolute_url":
+        ["API_ABSOLUTE_URL",
+         None,
+         str_slash,
+         ("URL to use for generating urls within API json responses. "
+          "By default this is None, and we use Django's "
+          "request.build_absolute_uri() to generate absolute urls "
+          "based on each request. If set to a string or empty string, "
+          "this will be used as prefix to relative urls.")],
 
     # Public user
     "omero.web.public.enabled":
@@ -1155,6 +1163,12 @@ def report_settings(module):
 # FEEDBACK_APP: 6 = OMERO.web
 FEEDBACK_APP = 6
 
+# For any given release of api, we may support
+# one or more versions of the api.
+# E.g. /api/v1.0/
+# TODO - need to decide how this is configured, strategy for extending etc.
+API_VERSIONS = ('0.1',)
+
 # IGNORABLE_404_STARTS:
 # Default: ('/cgi-bin/', '/_vti_bin', '/_vti_inf')
 # IGNORABLE_404_ENDS:

components/tools/OmeroWeb/omeroweb/urls.py

@@ -100,6 +100,8 @@ def redirect_urlpatterns():
     (r'^(?i)url/', include('omeroweb.webredirect.urls')),
     (r'^(?i)feedback/', include('omeroweb.feedback.urls')),
 
+    (r'^(?i)api/', include('omeroweb.webgateway.urls_api')),
+
     url(r'^index/$', 'omeroweb.webclient.views.custom_index',
         name="webindex_custom"),
 )

components/tools/OmeroWeb/omeroweb/webadmin/urls.py

@@ -26,13 +26,14 @@
 from django.conf.urls import url, patterns
 
 from omeroweb.webadmin import views
-from omeroweb.webclient import views as webclient_views
+from omeroweb.webclient.views import WebclientLoginView
 
 # url patterns
 urlpatterns = patterns(
     '',
     url(r'^$', views.index, name="waindex"),
-    url(r'^login/$', webclient_views.login, name="walogin"),
+    url(r'^login/$', WebclientLoginView.as_view(),
+        name="walogin"),
     url(r'^logout/$', views.logout, name="walogout"),
     url(r'^forgottenpassword/$', views.forgotten_password,
         name="waforgottenpassword"),

components/tools/OmeroWeb/omeroweb/webclient/urls.py

@@ -47,7 +47,7 @@
         views.load_template, {'menu': 'history'},
         name="history"),
 
-    url(r'^login/$', views.login, name="weblogin"),
+    url(r'^login/$', views.WebclientLoginView.as_view(), name="weblogin"),
     url(r'^logout/$', views.logout, name="weblogout"),
     url(r'^active_group/$',
         views.change_active_group,