cubicweb/web/views/sparql.py
changeset 11057 0b59724cb3f2
parent 10666 7f6b5f023884
child 11767 432f87a63057
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cubicweb/web/views/sparql.py	Sat Jan 16 13:48:51 2016 +0100
@@ -0,0 +1,145 @@
+# copyright 2003-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
+#
+# This file is part of CubicWeb.
+#
+# CubicWeb is free software: you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 2.1 of the License, or (at your option)
+# any later version.
+#
+# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
+"""SPARQL integration"""
+
+__docformat__ = "restructuredtext en"
+from cubicweb import _
+
+from six.moves import range
+
+from yams import xy
+from rql import TypeResolverException
+
+from lxml import etree
+from lxml.builder import E
+
+from cubicweb.view import StartupView, AnyRsetView
+from cubicweb.web import Redirect, form, formfields, formwidgets as fwdgs
+from cubicweb.web.views import forms
+try:
+    from cubicweb.spa2rql import Sparql2rqlTranslator, UnsupportedQuery
+except ImportError:
+    # fyzz not available (only a recommends)
+    Sparql2rqlTranslator = None
+
+class SparqlForm(forms.FieldsForm):
+    __regid__ = 'sparql'
+    sparql = formfields.StringField(help=_('type here a sparql query'))
+    resultvid = formfields.StringField(choices=((_('table'), 'table'),
+                                                (_('sparql xml'), 'sparqlxml')),
+                                       widget=fwdgs.Radio,
+                                       value='table')
+    form_buttons = [fwdgs.SubmitButton()]
+    @property
+    def action(self):
+        return self._cw.url()
+
+
+class SparqlFormView(form.FormViewMixIn, StartupView):
+    __regid__ = 'sparql'
+    def call(self):
+        form = self._cw.vreg['forms'].select('sparql', self._cw)
+        form.render(w=self.w)
+        sparql = self._cw.form.get('sparql')
+        vid = self._cw.form.get('resultvid', 'table')
+        if sparql:
+            try:
+                qinfo = Sparql2rqlTranslator(self._cw.vreg.schema).translate(sparql)
+            except TypeResolverException as exc:
+                self.w(self._cw._('can not resolve entity types:') + u' ' + unicode(exc))
+            except UnsupportedQuery:
+                self.w(self._cw._('we are not yet ready to handle this query'))
+            except xy.UnsupportedVocabulary as exc:
+                self.w(self._cw._('unknown vocabulary:') + u' ' + unicode(exc))
+            else:
+                rql, args = qinfo.finalize()
+                if vid == 'sparqlxml':
+                    url = self._cw.build_url('view', rql=rql % args, vid=vid)
+                    raise Redirect(url)
+                rset = self._cw.execute(rql, args)
+                self.wview(vid, rset, 'null')
+
+
+## sparql resultset views #####################################################
+
+YAMS_XMLSCHEMA_MAPPING = {
+    'String': 'string',
+
+    'Boolean': 'boolean',
+    'Int': 'integer',
+    'BigInt': 'integer',
+    'Float': 'float',
+
+    'Datetime': 'dateTime',
+    'TZDatetime': 'dateTime',
+    'Date': 'date',
+    'Time': 'time',
+    'TZTime': 'time',
+
+    # XXX the following types don't have direct mapping
+    'Decimal': 'string',
+    'Interval': 'duration',
+    'Bytes': 'base64Binary',
+    'Password': 'string',
+    }
+
+def xmlschema(yamstype):
+    return 'http://www.w3.org/2001/XMLSchema#%s' % YAMS_XMLSCHEMA_MAPPING[yamstype]
+
+class SparqlResultXmlView(AnyRsetView):
+    """The spec can be found here: http://www.w3.org/TR/rdf-sparql-XMLres/
+    """
+    __regid__ = 'sparqlxml'
+    content_type = 'application/sparql-results+xml'
+    templatable = False
+
+    def call(self):
+        # XXX handle UNION
+        rqlst = self.cw_rset.syntax_tree().children[0]
+        varnames = [var.name for var in rqlst.selection]
+        results = E.results()
+        for rowidx in range(len(self.cw_rset)):
+            result = E.result()
+            for colidx, varname in enumerate(varnames):
+                result.append(self.cell_binding(rowidx, colidx, varname))
+            results.append(result)
+        sparql = E.sparql(E.head(*(E.variable(name=name) for name in varnames)),
+                          results)
+        self.w(u'<?xml version="1.0"?>\n')
+        self.w(etree.tostring(sparql, encoding=unicode, pretty_print=True))
+
+    def cell_binding(self, row, col, varname):
+        celltype = self.cw_rset.description[row][col]
+        if self._cw.vreg.schema.eschema(celltype).final:
+            cellcontent = self._cw.view('cell', self.cw_rset, row=row, col=col)
+            return E.binding(E.literal(cellcontent,
+                                       datatype=xmlschema(celltype)),
+                             name=varname)
+        else:
+            entity = self.cw_rset.get_entity(row, col)
+            return E.binding(E.uri(entity.absolute_url()), name=varname)
+
+    def set_request_content_type(self):
+        """overriden to set the correct filetype and filename"""
+        self._cw.set_content_type(self.content_type,
+                                  filename='sparql.xml',
+                                  encoding=self._cw.encoding)
+
+def registration_callback(vreg):
+    if Sparql2rqlTranslator is not None:
+        vreg.register_all(globals().values(), __name__)