"""Set of HTML automatic forms to create, delete, copy or edit a single entity

or a list of entities of the same type

: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"

_ = unicode

from copy import copy

from simplejson import dumps

from logilab.mtconverter import xml_escape

from logilab.common.decorators import cached

from cubicweb import neg_role

from cubicweb.selectors import (match_kwargs, one_line_rset, non_final_entity,

                                specified_etype_implements, yes)

from cubicweb.view import EntityView

from cubicweb.common import tags

from cubicweb.web import stdmsgs, eid_param

from cubicweb.web import uicfg

from cubicweb.web.form import FormViewMixIn, FieldNotFound

from cubicweb.web.formfields import guess_field

from cubicweb.web.formwidgets import Button, SubmitButton, ResetButton

from cubicweb.web.views import forms

def relation_id(eid, rtype, role, reid):

    """return an identifier for a relation between two entities"""

    if role == 'subject':

        return u'%s:%s:%s' % (eid, rtype, reid)

    return u'%s:%s:%s' % (reid, rtype, eid)

def toggleable_relation_link(eid, nodeid, label='x'):

    """return javascript snippet to delete/undelete a relation between two

    entities

    """

    js = u"javascript: togglePendingDelete('%s', %s);" % (

        nodeid, xml_escape(dumps(eid)))

    return u'[<a class="handle" href="%s" id="handle%s">%s</a>]' % (

        js, nodeid, label)

class DeleteConfForm(forms.CompositeForm):

    id = 'deleteconf'

    __select__ = non_final_entity()

    domid = 'deleteconf'

    copy_nav_params = True

    form_buttons = [Button(stdmsgs.YES, cwaction='delete'),

                    Button(stdmsgs.NO, cwaction='cancel')]

    @property

    def action(self):

        return self.build_url('edit')

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

        super(DeleteConfForm, self).__init__(*args, **kwargs)

        done = set()

        for entity in self.rset.entities():

            if entity.eid in done:

                continue

            done.add(entity.eid)

            subform = self.vreg['forms'].select('base', self.req, entity=entity,

                                                mainform=False)

            self.add_subform(subform)

class DeleteConfFormView(FormViewMixIn, EntityView):

    """form used to confirm deletion of some entities"""

    id = 'deleteconf'

    title = _('delete')

    # don't use navigation, all entities asked to be deleted should be displayed

    # else we will only delete the displayed page

    need_navigation = False

    def call(self, onsubmit=None):

        """ask for confirmation before real deletion"""

        req, w = self.req, self.w

        _ = req._

        w(u'<script type="text/javascript">updateMessage(\'%s\');</script>\n'

          % _('this action is not reversible!'))

        # XXX above message should have style of a warning

        w(u'<h4>%s</h4>\n' % _('Do you want to delete the following element(s) ?'))

        form = self.vreg['forms'].select(self.id, req, rset=self.rset,

                                         onsubmit=onsubmit)

        w(u'<ul>\n')

        for entity in self.rset.entities():

            # don't use outofcontext view or any other that may contain inline edition form

            w(u'<li>%s</li>' % tags.a(entity.view('textoutofcontext'),

                                      href=entity.absolute_url()))

        w(u'</ul>\n')

        w(form.form_render())

class ClickAndEditFormView(FormViewMixIn, EntityView):

    """form used to permit ajax edition of a relation or attribute of an entity

    in a view, if logged user have the permission to edit it.

    (double-click on the field to see an appropriate edition widget).

    """

    id = 'doreledit'

    __select__ = non_final_entity() & match_kwargs('rtype')

    # FIXME editableField class could be toggleable from userprefs

    # add metadata to allow edition of metadata attributes (not considered by

    # edition form by default)

    attrcategories = ('primary', 'secondary', 'metadata')

    _onclick = u"showInlineEditionForm(%(eid)s, '%(rtype)s', '%(divid)s')"

    _onsubmit = ("return inlineValidateRelationForm('%(rtype)s', '%(role)s', '%(eid)s', "

                 "'%(divid)s', %(reload)s, '%(vid)s', '%(default)s', '%(lzone)s');")

    _cancelclick = "hideInlineEdit(%s,\'%s\',\'%s\')"

                           'alt="%(msg)s"/>')

    _landingzonemsg = _('click to edit this field')

    # default relation vids according to cardinality

    _one_rvid = 'incontext'

    _many_rvid = 'csv'

    def cell_call(self, row, col, rtype=None, role='subject',

                  reload=False,      # controls reloading the whole page after change

                  rvid=None,         # vid to be applied to other side of rtype (non final relations only)

                  default=None,      # default value

                  landing_zone=None  # prepend value with a separate html element to click onto

                                     # (esp. needed when values are links)

                  ):

        """display field to edit entity's `rtype` relation on click"""

        assert rtype

        assert role in ('subject', 'object'), '%s is not an acceptable role value' % role

        self.req.add_js('cubicweb.edition.js')

        self.req.add_css('cubicweb.form.css')

        if default is None:

            default = xml_escape(self.req._('<no value>'))

        entity = self.entity(row, col)

        rschema = entity.schema.rschema(rtype)

        lzone = self._build_landing_zone(landing_zone)

        # compute value, checking perms, build form

        if rschema.final:

            form = self._build_form(entity, rtype, role, 'edition', default, reload, lzone,

                                    attrcategories=self.attrcategories)

            if not self.should_edit_attribute(entity, rschema, role, form):

                self.w(entity.printable_value(rtype))

                return

            value = entity.printable_value(rtype) or default

            self.relation_form(lzone, value, form,

                               self._build_renderer(entity, rtype, role))

        else:

            if rvid is None:

                rvid = self._compute_best_vid(entity.e_schema, rschema, role)

            rset = entity.related(rtype, role)

            if rset:

                value = self.view(rvid, rset)

            else:

                value = default

            if not self.should_edit_relation(entity, rschema, role, rvid):

                if rset:

                    self.w(value)

                return

            form = self._build_form(entity, rtype, role, 'base', default, reload, lzone,

                                    dict(vid=rvid, lzone=lzone))

            field = guess_field(entity.e_schema, entity.schema.rschema(rtype), role)

            form.append_field(field)

            self.relation_form(lzone, value, form,

                               self._build_renderer(entity, rtype, role))

    def should_edit_attribute(self, entity, rschema, role, form):

        rtype = str(rschema)

        ttype = rschema.targets(entity.id, role)[0]

        afs = uicfg.autoform_section.etype_get(entity.id, rtype, role, ttype)

        if not (afs in self.attrcategories and entity.has_perm('update')):

            return False

        try:

            form.field_by_name(rtype, role)

        except FieldNotFound:

            return False

        return True

    def should_edit_relation(self, entity, rschema, role, rvid):

        if ((role == 'subject' and not rschema.has_perm(self.req, 'add',

                                                        fromeid=entity.eid))

            or

            (role == 'object' and not rschema.has_perm(self.req, 'add',

                                                       toeid=entity.eid))):

            return False

        return True

    def relation_form(self, lzone, value, form, renderer):

        """xxx-reledit div (class=field)

              +-xxx div (class="editableField")

              |   +-landing zone

              +   +-value

              +-form-xxx div

        """

        w = self.w

        w(u'<div id="%s-reledit" class="field">' % form.event_args['divid'])

        w(value)

        w(u'</div>')

        w(form.form_render(renderer=renderer))

        w(u'</div>')

    def _compute_best_vid(self, eschema, rschema, role):

        if eschema.cardinality(rschema, role) in '+*':

            return self._many_rvid

        return self._one_rvid

    def _build_landing_zone(self, lzone):

        return lzone or self._defaultlandingzone % {'msg' : xml_escape(self.req._(self._landingzonemsg))}

    def _build_renderer(self, entity, rtype, role):

        return self.vreg['formrenderers'].select(

            'base', self.req, entity=entity, display_label=False,

            display_help=False, display_fields=[(rtype, role)], table_class='',

            button_bar_class='buttonbar', display_progress_div=False)

    def _build_args(self, entity, rtype, role, formid, default, reload, lzone,

                    extradata=None):

        divid = '%s-%s-%s' % (rtype, role, entity.eid)

        event_args = {'divid' : divid, 'eid' : entity.eid, 'rtype' : rtype,

                      'reload' : dumps(reload), 'default' : default, 'role' : role, 'vid' : u'',

                      'lzone' : lzone}

        if extradata:

            event_args.update(extradata)

        return divid, event_args

    def _build_form(self, entity, rtype, role, formid, default, reload, lzone,

                  extradata=None, **formargs):

        divid, event_args = self._build_args(entity, rtype, role, formid, default,

                                      reload, lzone, extradata)

        onsubmit = self._onsubmit % event_args

        cancelclick = self._cancelclick % (entity.eid, rtype, divid)

        form = self.vreg['forms'].select(

            formid, self.req, entity=entity, domid='%s-form' % divid,

            cssstyle='display: none', onsubmit=onsubmit, action='#',

            form_buttons=[SubmitButton(), Button(stdmsgs.BUTTON_CANCEL,

                                                 onclick=cancelclick)],

            **formargs)

        form.event_args = event_args

        return form

class DummyForm(object):

    __slots__ = ('event_args',)

    def form_render(self, **_args):

        return u''

    def append_field(self, *args):

        pass

class AutoClickAndEditFormView(ClickAndEditFormView):

    """same as ClickAndEditFormView but checking if the view *should* be applied

    by checking uicfg configuration and composite relation property.

    """

    id = 'reledit'

    _onclick = (u"loadInlineEditionForm(%(eid)s, '%(rtype)s', '%(role)s', "

                "'%(divid)s', %(reload)s, '%(vid)s', '%(default)s', '%(lzone)s');")

    def should_edit_attribute(self, entity, rschema, role, _form):

        rtype = str(rschema)

        ttype = rschema.targets(entity.id, role)[0]

        afs = uicfg.autoform_section.etype_get(entity.id, rtype, role, ttype)

        if not (afs in self.attrcategories and entity.has_perm('update')):

            return False

        return True

    def should_edit_relation(self, entity, rschema, role, rvid):

        eschema = entity.e_schema

        rtype = str(rschema)

        # XXX check autoform_section. what if 'generic'?

        dispctrl = uicfg.primaryview_display_ctrl.etype_get(eschema, rtype, role)

        vid = dispctrl.get('vid', 'reledit')

        if vid != 'reledit': # reledit explicitly disabled

            self.wview(vid, entity.related(rtype, role), 'null')

            return False

        if eschema.role_rproperty(role, rschema, 'composite') == role:

            self.wview(rvid, entity.related(rtype, role), 'null')

            return False

        return super(AutoClickAndEditFormView, self).should_edit_relation(

            entity, rschema, role, rvid)

    def _build_form(self, entity, rtype, role, formid, default, reload, lzone,

                  extradata=None, **formargs):

        _divid, event_args = self._build_args(entity, rtype, role, formid, default,

                                              reload, lzone, extradata)

        form = DummyForm()

        form.event_args = event_args

        return form

    def _build_renderer(self, entity, rtype, role):

        pass

class EditionFormView(FormViewMixIn, EntityView):

    """display primary entity edition form"""

    id = 'edition'

    # add yes() so it takes precedence over deprecated views in baseforms,

    # though not baseforms based customized view

    __select__ = one_line_rset() & non_final_entity() & yes()

    title = _('edition')

    def cell_call(self, row, col, **kwargs):

        entity = self.complete_entity(row, col)

        self.render_form(entity)

    def render_form(self, entity):

        """fetch and render the form"""

        self.form_title(entity)

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

                                         row=entity.row, col=entity.col, entity=entity,

                                         submitmsg=self.submited_message())

        self.init_form(form, entity)

        self.w(form.form_render(formvid=u'edition'))

    def init_form(self, form, entity):

        """customize your form before rendering here"""

        pass

    def form_title(self, entity):

        """the form view title"""

        ptitle = self.req._(self.title)

        self.w(u'<div class="formTitle"><span>%s %s</span></div>' % (

            entity.dc_type(), ptitle and '(%s)' % ptitle))

    def submited_message(self):

        """return the message that will be displayed on successful edition"""

        return self.req._('entity edited')

class CreationFormView(EditionFormView):

    """display primary entity creation form"""

    id = 'creation'

    __select__ = specified_etype_implements('Any') & yes()

    title = _('creation')

    def call(self, **kwargs):

        """creation view for an entity"""

        # at this point we know etype is a valid entity type, thanks to our

        # selector

        etype = kwargs.pop('etype', self.req.form.get('etype'))

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

        self.initialize_varmaker()

        entity.eid = self.varmaker.next()

        self.render_form(entity)

    def form_title(self, entity):