"""SPARQL integration

:organization: Logilab

:copyright: 2009-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.

:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr

:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses

"""

__docformat__ = "restructuredtext en"

import rql

from yams import xy

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.select('forms', 'sparql', self._cw)

        self.w(form.render())

        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 rql.TypeResolverException:

                self.w(self._cw._('can not resolve entity types:') + u' ' + unicode('ex'))

            except UnsupportedQuery:

                self.w(self._cw._('we are not yet ready to handle this query'))

            except xy.UnsupportedVocabulary, ex:

                self.w(self._cw._('unknown vocabulary:') + u' ' + unicode('ex'))

            if vid == 'sparqlxml':

                url = self._cw.build_url('view', rql=qinfo.finalize(), vid=vid)

                raise Redirect(url)

            rset = self._cw.execute(qinfo.finalize())

            self.wview(vid, rset, 'null')

## sparql resultset views #####################################################

YAMS_XMLSCHEMA_MAPPING = {

    'String': 'string',

    'Int': 'integer',

    'Float': 'float',

    'Boolean': 'boolean',

    'Datetime': 'dateTime',

    'Date': 'date',

    'Time': 'time',

    # XXX the following types don't have direct mapping

    'Decimal': 'string',

    'Interval': 'duration',

    'Password': 'string',

    'Bytes': 'base64Binary',

    }

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 xrange(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.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__)