# -*- coding: utf-8 -*-

"""Set of base controllers, which are directly plugged into the application

object to handle publication.

:organization: Logilab

:copyright: 2001-2009 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"

from smtplib import SMTP

import simplejson

from logilab.common.decorators import cached

from cubicweb import NoSelectableObject, ValidationError, ObjectNotFound, typed_eid

from cubicweb.utils import strptime

from cubicweb.selectors import yes, match_user_groups

from cubicweb.view import STRICT_DOCTYPE, STRICT_DOCTYPE_NOEXT

from cubicweb.common.mail import format_mail

from cubicweb.web import ExplicitLogin, Redirect, RemoteCallFailed, json_dumps

from cubicweb.web.controller import Controller

from cubicweb.web.views import vid_from_rset

from cubicweb.web.views.formrenderers import FormRenderer

try:

    from cubicweb.web.facet import (FilterRQLBuilder, get_facet,

                                    prepare_facets_rqlst)

    HAS_SEARCH_RESTRICTION = True

except ImportError: # gae

    HAS_SEARCH_RESTRICTION = False

def jsonize(func):

    """decorator to sets correct content_type and calls `simplejson.dumps` on

    results

    """

    def wrapper(self, *args, **kwargs):

        self.req.set_content_type('application/json')

        return json_dumps(func(self, *args, **kwargs))

    wrapper.__name__ = func.__name__

    return wrapper

def xhtmlize(func):

    """decorator to sets correct content_type and calls `xmlize` on results"""

    def wrapper(self, *args, **kwargs):

        self.req.set_content_type(self.req.html_content_type())

        result = func(self, *args, **kwargs)

        return ''.join((self.req.document_surrounding_div(), result.strip(),

                        u'</div>'))

    wrapper.__name__ = func.__name__

    return wrapper

def check_pageid(func):

    """decorator which checks the given pageid is found in the

    user's session data

    """

    def wrapper(self, *args, **kwargs):

        data = self.req.get_session_data(self.req.pageid)

        if data is None:

            raise RemoteCallFailed(self.req._('pageid-not-found'))

        return func(self, *args, **kwargs)

    return wrapper

class LoginController(Controller):

    id = 'login'

    def publish(self, rset=None):

        """log in the instance"""

        if self.config['auth-mode'] == 'http':

            # HTTP authentication

            raise ExplicitLogin()

        else:

            # Cookie authentication

            return self.appli.need_login_content(self.req)

class LogoutController(Controller):

    id = 'logout'

    def publish(self, rset=None):

        """logout from the instance"""

        return self.appli.session_handler.logout(self.req)

class ViewController(Controller):

    """standard entry point :

    - build result set

    - select and call main template

    """

    id = 'view'

    template = 'main-template'

    def publish(self, rset=None):

        """publish a request, returning an encoded string"""

        view, rset = self._select_view_and_rset(rset)

        self.add_to_breadcrumbs(view)

        self.validate_cache(view)

        template = self.appli.main_template_id(self.req)

        return self.vreg['views'].main_template(self.req, template,

                                                rset=rset, view=view)

    def _select_view_and_rset(self, rset):

        req = self.req

        if rset is None and not hasattr(req, '_rql_processed'):

            req._rql_processed = True

            rset = self.process_rql(req.form.get('rql'))

        if rset and rset.rowcount == 1 and '__method' in req.form:

            entity = rset.get_entity(0, 0)

            try:

                method = getattr(entity, req.form.pop('__method'))

                method()

            except Redirect: # propagate redirect that might occur in method()

                raise

            except Exception, ex:

                self.exception('while handling __method')

                req.set_message(req._("error while handling __method: %s") % req._(ex))

        vid = req.form.get('vid') or vid_from_rset(req, rset, self.schema)

        try:

            view = self.vreg['views'].select(vid, req, rset=rset)

        except ObjectNotFound:

            self.warning("the view %s could not be found", vid)

            req.set_message(req._("The view %s could not be found") % vid)

            vid = vid_from_rset(req, rset, self.schema)

            view = self.vreg['views'].select(vid, req, rset=rset)

        except NoSelectableObject:

            if rset:

                req.set_message(req._("The view %s can not be applied to this query") % vid)

            else:

                req.set_message(req._("You have no access to this view or it's not applyable to current data"))

            self.warning("the view %s can not be applied to this query", vid)

            vid = vid_from_rset(req, rset, self.schema)

            view = self.vreg['views'].select(vid, req, rset=rset)

        return view, rset

    def add_to_breadcrumbs(self, view):

        # update breadcrumps **before** validating cache, unless the view

        # specifies explicitly it should not be added to breadcrumb or the

        # view is a binary view

        if view.add_to_breadcrumbs and not view.binary:

            self.req.update_breadcrumbs()

    def validate_cache(self, view):

        view.set_http_cache_headers()

        self.req.validate_cache()

    def execute_linkto(self, eid=None):

        """XXX __linkto parameter may cause security issue

        defined here since custom application controller inheriting from this

        one use this method?

        """

        req = self.req

        if not '__linkto' in req.form:

            return

        if eid is None:

            eid = typed_eid(req.form['eid'])

        for linkto in req.list_form_param('__linkto', pop=True):

            rtype, eids, target = linkto.split(':')

            assert target in ('subject', 'object')

            eids = eids.split('_')

            if target == 'subject':

                rql = 'SET X %s Y WHERE X eid %%(x)s, Y eid %%(y)s' % rtype

            else:

                rql = 'SET Y %s X WHERE X eid %%(x)s, Y eid %%(y)s' % rtype

            for teid in eids:

                req.execute(rql, {'x': eid, 'y': typed_eid(teid)}, ('x', 'y'))

def _validation_error(req, ex):

    req.cnx.rollback()

    forminfo = req.get_session_data(req.form.get('__errorurl'), pop=True)

    foreid = ex.entity

    eidmap = req.data.get('eidmap', {})

    for var, eid in eidmap.items():

        if foreid == eid:

            foreid = var

            break

    return (foreid, ex.errors)

def _validate_form(req, vreg):

    # XXX should use the `RemoteCallFailed` mechanism

    try:

        ctrl = vreg['controllers'].select('edit', req=req)

    except NoSelectableObject:

        return (False, {None: req._('not authorized')})

    try:

        ctrl.publish(None)

    except ValidationError, ex:

        return (False, _validation_error(req, ex))

    except Redirect, ex:

        try:

            req.cnx.commit() # ValidationError may be raise on commit

        except ValidationError, ex:

            return (False, _validation_error(req, ex))

        else:

            return (True, ex.location)

    except Exception, ex:

        req.cnx.rollback()

        req.exception('unexpected error while validating form')

        return (False, req._(str(ex).decode('utf-8')))

    return (False, '???')

class FormValidatorController(Controller):

    id = 'validateform'

    def response(self, domid, status, args):

        self.req.set_content_type('text/html')

        jsargs = simplejson.dumps( (status, args) )

        return """<script type="text/javascript">

 window.parent.handleFormValidationResponse('%s', null, null, %s);

</script>""" %  (domid, jsargs)

    def publish(self, rset=None):

        self.req.json_request = True

        # XXX unclear why we have a separated controller here vs

        # js_validate_form on the json controller

        status, args = _validate_form(self.req, self.vreg)

        domid = self.req.form.get('__domid', 'entityForm').encode(

            self.req.encoding)

        return self.response(domid, status, args)

class JSonController(Controller):

    id = 'json'

    def publish(self, rset=None):

        """call js_* methods. Expected form keys:

        :fname: the method name without the js_ prefix

        :args: arguments list (json)

        note: it's the responsability of js_* methods to set the correct

        response content type

        """

        self.req.json_request = True

        self.req.pageid = self.req.form.get('pageid')

        try:

            fname = self.req.form['fname']

            func = getattr(self, 'js_%s' % fname)

        except KeyError:

            raise RemoteCallFailed('no method specified')

        except AttributeError:

            raise RemoteCallFailed('no %s method' % fname)

        # no <arg> attribute means the callback takes no argument

        args = self.req.form.get('arg', ())

        if not isinstance(args, (list, tuple)):

            args = (args,)

        args = [simplejson.loads(arg) for arg in args]

        try:

            result = func(*args)

        except RemoteCallFailed:

            raise

        except Exception, ex:

            import traceback

            traceback.print_exc()

            self.exception('an exception occured while calling js_%s(%s): %s',

                           fname, args, ex)

            raise RemoteCallFailed(repr(ex))

        if result is None:

            return ''

        # get unicode on @htmlize methods, encoded string on @jsonize methods

        elif isinstance(result, unicode):

            return result.encode(self.req.encoding)

        return result

    def _rebuild_posted_form(self, names, values, action=None):

        form = {}

        for name, value in zip(names, values):

            # remove possible __action_xxx inputs

            if name.startswith('__action'):

                continue

            # form.setdefault(name, []).append(value)

            if name in form:

                curvalue = form[name]

                if isinstance(curvalue, list):

                    curvalue.append(value)

                else:

                    form[name] = [curvalue, value]

            else:

                form[name] = value

        # simulate click on __action_%s button to help the controller

        if action:

            form['__action_%s' % action] = u'whatever'

        return form

    def _exec(self, rql, args=None, eidkey=None, rocheck=True):

        """json mode: execute RQL and return resultset as json"""

        if rocheck:

            self.ensure_ro_rql(rql)

        try:

            return self.req.execute(rql, args, eidkey)

        except Exception, ex:

            self.exception("error in _exec(rql=%s): %s", rql, ex)

            return None

        return None

    @xhtmlize

    def js_view(self):

        # XXX try to use the page-content template

        req = self.req

        rql = req.form.get('rql')

        if rql:

            rset = self._exec(rql)

        else:

            rset = None

        vid = req.form.get('vid') or vid_from_rset(req, rset, self.schema)

        try:

            view = self.vreg['views'].select(vid, req, rset=rset)

        except NoSelectableObject:

            vid = req.form.get('fallbackvid', 'noresult')

            view = self.vreg['views'].select(vid, req, rset=rset)

        divid = req.form.get('divid', 'pageContent')

        # we need to call pagination before with the stream set

        stream = view.set_stream()

        if req.form.get('paginate'):

            if divid == 'pageContent':

                # mimick main template behaviour

                stream.write(u'<div id="pageContent">')

                vtitle = self.req.form.get('vtitle')

                if vtitle:

                    stream.write(u'<h1 class="vtitle">%s</h1>\n' % vtitle)

            view.pagination(req, rset, view.w, not view.need_navigation)

            if divid == 'pageContent':

                stream.write(u'<div id="contentmain">')

        view.render()

        extresources = req.html_headers.getvalue(skiphead=True)

        if extresources:

            stream.write(u'<div class="ajaxHtmlHead">\n') # XXX use a widget ?

            stream.write(extresources)

            stream.write(u'</div>\n')

        if req.form.get('paginate') and divid == 'pageContent':

            stream.write(u'</div></div>')

        return stream.getvalue()

    @xhtmlize

    def js_prop_widget(self, propkey, varname, tabindex=None):

        """specific method for CWProperty handling"""

        entity = self.vreg['etypes'].etype_class('CWProperty')(self.req)

        entity.eid = varname

        entity['pkey'] = propkey

        form = self.vreg['forms'].select('edition', self.req, entity=entity)

        form.form_build_context()

        vfield = form.field_by_name('value')

        renderer = FormRenderer(self.req)

        return vfield.render(form, renderer, tabindex=tabindex) \

               + renderer.render_help(form, vfield)

    @xhtmlize

    def js_component(self, compid, rql, registry='components', extraargs=None):

        if rql:

            rset = self._exec(rql)

        else:

            rset = None

        comp = self.vreg[registry].select(compid, self.req, rset=rset)

        if extraargs is None:

            extraargs = {}

        else: # we receive unicode keys which is not supported by the **syntax

            extraargs = dict((str(key), value)

                             for key, value in extraargs.items())