Changeset ee5437 in indico

Timestamp:

08/23/11 15:38:44 (21 months ago)

Author:

Jose Benito <jose.benito.gonzalez@…>

Branches:

master, hello-world-walkthrough, ipv6, v0.98-series, v0.98.2, v0.98.3, v0.98b2, v0.99, 051b2622c51afb171a1dedb46a0df4fbb0cbd02e, 4c7d4152dff271ba5df5a8606605969cab454080

Children:

1b4ee3

Parents:

f3a845

git-author:

Pedro Ferreira <jose.pedro.ferreira@…> (04/15/11 15:50:31)

git-committer:

Jose Benito <jose.benito.gonzalez@…> (08/23/11 15:38:44)

Message:

[IMP] Fairly functional API version

• Export of category event lists to JSON and XML;
• Timezone support;
• Moved date/time conversion from fossilize to JSON parsing;
• This way, could reuse fossilization for metadata extraction;

Location:

indico

Files:

• MaKaC/services/interface/rpc/json.py (modified) (2 diffs)
• MaKaC/webinterface/pages/conferences.py (modified) (5 diffs)
• MaKaC/webinterface/pages/sessions.py (modified) (4 diffs)
• util/fossilize/__init__.py (modified) (1 diff)
• util/fossilize/conversion.py (modified) (1 diff)
• util/json.py (modified) (3 diffs)
• util/metadata/__init__.py (added)
• util/metadata/html.py (added)
• util/metadata/json.py (added)
• util/metadata/serializer.py (added)
• util/metadata/xml.py (added)
• web/http_api/export.py (modified) (5 diffs)
• web/http_api/fossils.py (added)
• web/http_api/handlers.py (modified) (2 diffs)

indico/MaKaC/services/interface/rpc/json.py

@@ -20 +20 @@
 from MaKaC.common.security import Sanitization
 
-import simplejson
 from MaKaC.common.fossilize import fossilize, NonFossilizableException
 from MaKaC.fossils.error import ICausedErrorFossil
@@ -35 +34 @@
 
 from MaKaC.common.logger import Logger
-
-# Test if simplejson escapes forward slashes. It changed its behaviour im some version.
-if '\\/' in simplejson.dumps('/'):
-    dumps = simplejson.dumps
-else:
-    def dumps(*args, **kwargs):
-        return simplejson.dumps(*args, **kwargs).replace('/', '\\/')
+from indico.util.json import dumps
 
 class Json:

indico/MaKaC/webinterface/pages/conferences.py

@@ -23 +23 @@
 import string
 import random
-import simplejson
-import os.path
+from indico.util import json
 
 from datetime import timedelta,datetime
@@ -1336 +1335 @@
             vars['getItemType'] = lambda item : self._getItemType(item)
             vars['getLocationInfo'] = MaKaC.common.utils.getLocationInfo
-            vars['dumps'] = simplejson.dumps
+            vars['dumps'] = json.dumps
         else:
             outGen = outputGenerator(self._rh._aw)
@@ -1471 +1470 @@
         vars = wcomponents.WTemplated.getVars( self )
         tz = DisplayTZ(self._aw,self._conf).getDisplayTZ()
-        vars["ttdata"] = simplejson.dumps(schedule.ScheduleToJson.process(self._conf.getSchedule(),
+        vars["ttdata"] = json.dumps(schedule.ScheduleToJson.process(self._conf.getSchedule(),
                                                                           tz, self._aw,
                                                                           useAttrCache = True))
         eventInfo = fossilize(self._conf, IConferenceEventInfoFossil, tz = tz)
         eventInfo['isCFAEnabled'] = self._conf.getAbstractMgr().isActive()
-        vars['eventInfo'] = simplejson.dumps(eventInfo)
+        vars['eventInfo'] = json.dumps(eventInfo)
         vars['timetableLayout'] = vars.get('ttLyt','')
         return vars
@@ -3428 +3427 @@
         vars["editURL"]=quoteattr(str(urlHandlers.UHConfModScheduleDataEdit.getURL(self._conf)))
 
-        vars['ttdata'] = simplejson.dumps(schedule.ScheduleToJson.process(self._conf.getSchedule(), tz, None,
+        vars['ttdata'] = json.dumps(schedule.ScheduleToJson.process(self._conf.getSchedule(), tz, None,
                                                                             days = None, mgmtMode = True))
         vars['customLinks'] = self._customLinks
@@ -3434 +3433 @@
         eventInfo = fossilize(self._conf, IConferenceEventInfoFossil, tz = tz)
         eventInfo['isCFAEnabled'] = self._conf.getAbstractMgr().isActive()
-        vars['eventInfo'] = simplejson.dumps(eventInfo)
+        vars['eventInfo'] = json.dumps(eventInfo)
 
         return vars

indico/MaKaC/webinterface/pages/sessions.py

@@ -45 +45 @@
 from pytz import timezone
 from MaKaC.common.timezoneUtils import DisplayTZ
-import simplejson
+from indico.util import json
 import pytz
 import copy
@@ -387 +387 @@
     def _getTimeTableHTML(self):
 
-        ttdata = simplejson.dumps(schedule.ScheduleToJson.process(self._session.getSchedule(), self._tz,
+        ttdata = json.encode(schedule.ScheduleToJson.process(self._session.getSchedule(), self._tz,
                                                                            None, days = None, mgmtMode = False))
 
         eventInfo = fossilize(self._session.getConference(), IConferenceEventInfoFossil, tz=self._tz)
         eventInfo['timetableSession'] = fossilize(self._session, ISessionFossil, tz=self._tz)
-        eventInfo = simplejson.dumps(eventInfo)
+        eventInfo = json.encode(eventInfo)
 
         return """
@@ -1450 +1450 @@
         vars["timezone"]= tz
 
-        vars['ttdata'] = simplejson.dumps(schedule.ScheduleToJson.process(self._session.getSchedule(), tz,
+        vars['ttdata'] = json.encode(schedule.ScheduleToJson.process(self._session.getSchedule(), tz,
                                                                            None, days = None, mgmtMode = True))
 
@@ -1456 +1456 @@
         eventInfo['timetableSession'] = fossilize(self._session, ISessionFossil, tz=tz)
         eventInfo['isCFAEnabled'] = self._session.getConference().getAbstractMgr().isActive()
-        vars['eventInfo'] = simplejson.dumps(eventInfo)
+        vars['eventInfo'] = json.encode(eventInfo)
 
         return vars

indico/util/fossilize/__init__.py

@@ -187 +187 @@
         else:
             interface = interfaceArg
-
-        if not interface.providedBy(self):
-
-            raise WrongFossilTypeException("Interface '%s' not provided"
-                                           " by '%s'" %
-                                           (interface.__name__,
-                                            self.__class__.__name__))
 
         return interface

indico/util/fossilize/conversion.py

@@ -35 +35 @@
             else:
                 date = dt
-            return {'date': str(date.date()), 'time': str(date.time())}
+            return date
         else:
             return None

indico/util/json.py

@@ -24 +24 @@
     import json as _json
 
+from datetime import datetime
 from indico.util.i18n import LazyProxy
 
+# Test if simplejson escapes forward slashes. It changed its behaviour im some version.
+if '\\/' in _json.dumps('/'):
+    _json_dumps = simplejson.dumps
+else:
+    def _json_dumps(*args, **kwargs):
+        return _json.dumps(*args, **kwargs).replace('/', '\\/')
 
-class I18nJSONEncoder(_json.JSONEncoder):
+class _JSONEncoder(_json.JSONEncoder):
     """
-    Custom JSON encoder that supports i18n lazy strings
+    Custom JSON encoder that supports more types
     """
     def default(self, o):
         if isinstance(o, LazyProxy):
             return str(o)
+        elif type(o) is datetime:
+            return {'date': str(o.date()), 'time': str(o.time()), 'tz': str(o.tzinfo)}
         return _json.JSONEncoder.default(self, o)
 
@@ -41 +50 @@
     Simple wrapper around json.dumps()
     """
-    return _json.dumps(obj, cls=I18nJSONEncoder, **kwargs)
+    if kwargs.pop('pretty', False):
+        kwargs['indent'] = 4 * ' '
+    return _json_dumps(obj, cls=_JSONEncoder, **kwargs)
 
 
@@ -55 +66 @@
     Mako filter
     """
-    return _json.dumps(obj)
+    return _json_dumps(obj)

indico/web/http_api/export.py

@@ -34 +34 @@
 # indico imports
 from indico.util.date_time import nowutc
+from indico.util.fossilize import fossilize
+
+from indico.util.metadata import Serializer
+from indico.web.http_api.fossils import IConferenceMetadataFossil
 
 # indico legacy imports
@@ -49 +53 @@
 
     def category(cls, idlist, dformat, fromDT, toDT, location=None, limit=None,
-               orderBy=None, descending=False, detail="events"):
+               orderBy=None, descending=False, detail="events", pretty=False):
         """
         TODO: Document this
         """
 
-    def event(cls, idlist, dformat, orderBy=None, descending=False, detail="events"):
+    def event(cls, idlist, dformat, orderBy=None, descending=False, detail="events",
+              pretty=False):
         """
         TODO: Document this
@@ -130 +135 @@
 
     def category(self, idlist, dformat, fromDT, toDT, location=None, limit=None,
-                 orderBy=None, descending=False, detail="events", tz=None):
+                 orderBy=None, descending=False, detail="events", tzName=None, pretty=False):
 
         self._dbi.startRequest()
 
-        if tz == None:
+        if tzName == None:
             info = HelperMaKaCInfo.getMaKaCInfoInstance()
-            tz = pytz.timezone(info.getTimezone())
+            tzName = info.getTimezone()
+
+        tz = pytz.timezone(tzName)
 
         fromDT = ExportInterface._getDateTime('from', fromDT, tz) if fromDT != None else None
@@ -156 +163 @@
                     break
                 if obj not in exclude:
-                    results.append(obj.id)
+                    results.append(fossilize(obj, IConferenceMetadataFossil, tz=tz))
                     exclude.add(obj)
                     counter += 1
@@ -164 +171 @@
         self._dbi.endRequest(False)
 
-        return dumps(results)
+        serializer = Serializer.create(dformat, pretty=pretty)
+
+        # TODO: set content-type
+
+        return serializer(results)
 
     def event(self, idlist, dformat, orderBy=None, descending=False, detail="events"):

indico/web/http_api/handlers.py

@@ -68 +68 @@
         descending = get_query_parameter(qdata, ['c', 'descending'], False)
         detail = get_query_parameter(qdata, ['d', 'detail'], 'events')
+        pretty = get_query_parameter(qdata, ['p', 'pretty'], 'no')
+        tz = get_query_parameter(qdata, ['tz'], None)
 
         expInt = ExportInterface(DBMgr.getInstance())
@@ -78 +80 @@
 
             return expInt.category(idlist, dformat, fromDT, toDT, location,
-                                   limit, orderBy, descending, detail)
+                                   limit, orderBy, descending, detail, tz,
+                                   True if pretty == 'yes' else False)
     else:
         # TODO: usage page