"""form renderers, responsible to layout a form to html

:organization: Logilab

:copyright: 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 logilab.common import dictattr

from logilab.mtconverter import xml_escape

from simplejson import dumps

from cubicweb.common import tags

from cubicweb.appobject import AppRsetObject

from cubicweb.selectors import entity_implements, yes

from cubicweb.web import eid_param

from cubicweb.web import formwidgets as fwdgs

from cubicweb.web.widgets import checkbox

from cubicweb.web.formfields import HiddenInitialValueField

class FormRenderer(AppRsetObject):

    """basic renderer displaying fields in a two columns table label | value

    +--------------+--------------+

    | field1 label | field1 input |

    +--------------+--------------+

    | field1 label | field2 input |

    +--------------+--------------+

    +---------+

    | buttons |

    +---------+

    """

    __registry__ = 'formrenderers'

    id = 'default'

    _options = ('display_fields', 'display_label', 'display_help',

                'display_progress_div', 'table_class', 'button_bar_class',

                # add entity since it may be given to select the renderer

                'entity')

    display_fields = None # None -> all fields

    display_label = True

    display_help = True

    display_progress_div = True

    table_class = u'attributeForm'

    button_bar_class = u'formButtonBar'

    def __init__(self, req=None, rset=None, row=None, col=None, **kwargs):

        super(FormRenderer, self).__init__(req, rset, row, col)

        if self._set_options(kwargs):

            raise ValueError('unconsumed arguments %s' % kwargs)

    def _set_options(self, kwargs):

        for key in self._options:

            try:

                setattr(self, key, kwargs.pop(key))

            except KeyError:

                continue

        return kwargs

    # renderer interface ######################################################

    def render(self, form, values):

        self._set_options(values)

        form.add_media()

        data = []

        w = data.append

        w(self.open_form(form, values))

        if self.display_progress_div:

            w(u'<div id="progress">%s</div>' % self.req._('validating...'))

        w(u'<fieldset>')

        w(tags.input(type=u'hidden', name=u'__form_id',

                     value=values.get('formvid', form.id)))

        if form.redirect_path:

            w(tags.input(type='hidden', name='__redirectpath', value=form.redirect_path))

        self.render_fields(w, form, values)

        self.render_buttons(w, form)

        w(u'</fieldset>')

        w(u'</form>')

        errormsg = self.error_message(form)

        if errormsg:

            data.insert(0, errormsg)

        return '\n'.join(data)

    def render_label(self, form, field):

        if field.label is None:

            return u''

        label = self.req._(field.label)

        attrs = {'for': form.context[field]['id']}

        if field.required:

            attrs['class'] = 'required'

        return tags.label(label, **attrs)

    def render_help(self, form, field):

        help = []

        descr = field.help

        if callable(descr):

            descr = descr(form)

        if descr:

            help.append('<div class="helper">%s</div>' % self.req._(descr))

        example = field.example_format(self.req)

        if example:

            help.append('<div class="helper">(%s: %s)</div>'

                        % (self.req._('sample format'), example))

        return u' '.join(help)

    # specific methods (mostly to ease overriding) #############################

    def error_message(self, form):

        """return formatted error message

        This method should be called once inlined field errors has been consumed

        """

        req = self.req

        errex = form.form_valerror

        # get extra errors

        if errex is not None:

            errormsg = req._('please correct the following errors:')

            displayed = form.form_displayed_errors

            errors = sorted((field, err) for field, err in errex.errors.items()

                            if not field in displayed)

            if errors:

                if len(errors) > 1:

                    templstr = '<li>%s</li>\n'

                else:

                    templstr = ' %s\n'

                for field, err in errors:

                    if field is None:

                        errormsg += templstr % err

                    else:

                        errormsg += templstr % '%s: %s' % (req._(field), err)

                if len(errors) > 1:

                    errormsg = '<ul>%s</ul>' % errormsg

            return u'<div class="errorMessage">%s</div>' % errormsg

        return u''

    def open_form(self, form, values):

        if form.form_needs_multipart:

            enctype = 'multipart/form-data'

        else:

            enctype = 'application/x-www-form-urlencoded'

        if form.action is None:

            action = self.req.build_url('edit')

        else:

            action = form.action

        tag = ('<form action="%s" method="post" enctype="%s"' % (

            xml_escape(action or '#'), enctype))

        if form.domid:

            tag += ' id="%s"' % form.domid

        if form.onsubmit:

            tag += ' onsubmit="%s"' % xml_escape(form.onsubmit % dictattr(form))

        if form.cssstyle:

            tag += ' style="%s"' % xml_escape(form.cssstyle)

        if form.cssclass:

            tag += ' class="%s"' % xml_escape(form.cssclass)

        if form.cwtarget:

            tag += ' cubicweb:target="%s"' % xml_escape(form.cwtarget)

        return tag + '>'

    def display_field(self, form, field):

        if isinstance(field, HiddenInitialValueField):

            field = field.visible_field

        return (self.display_fields is None

                or field.name in form.internal_fields

                or (field.name, field.role) in self.display_fields

                or (field.name, field.role) in form.internal_fields)

    def render_fields(self, w, form, values):

        form.form_build_context(values)

        fields = self._render_hidden_fields(w, form)

        if fields:

            self._render_fields(fields, w, form)

        self.render_child_forms(w, form, values)

    def render_child_forms(self, w, form, values):

        # render

        for childform in getattr(form, 'forms', []):

            self.render_fields(w, childform, values)

    def _render_hidden_fields(self, w, form):

        fields = form.fields[:]

        for field in form.fields:

            if not self.display_field(form, field):

                fields.remove(field)

            elif not field.is_visible():

                w(field.render(form, self))

                fields.remove(field)

        return fields

    def _render_fields(self, fields, w, form):

        byfieldset = {}

        for field in fields:

            byfieldset.setdefault(field.fieldset, []).append(field)

        if form.fieldsets_in_order:

            fieldsets = form.fieldsets_in_order

        else:

            fieldsets = byfieldset.keys()

        for fieldset in fieldsets:

            try:

                fields = byfieldset.pop(fieldset)

            except KeyError:

                self.warning('no such fieldset: %s (%s)', fieldset, form)

                continue

            w(u'<fieldset class="%s">' % (fieldset or u'default'))

            if fieldset:

                w(u'<legend>%s</legend>' % self.req._(fieldset))

            w(u'<table class="%s">' % self.table_class)

            for field in fields:

                w(u'<tr class="%s_%s_row">' % (field.name, field.role))

                if self.display_label:

                    w(u'<th class="labelCol">%s</th>' % self.render_label(form, field))

                error = form.form_field_error(field)

                if error:

                    w(u'<td class="error">')

                    w(error)

                else:

                    w(u'<td>')

                w(field.render(form, self))

                if self.display_help:

                    w(self.render_help(form, field))

                w(u'</td></tr>')

            w(u'</table></fieldset>')

        if byfieldset:

            self.warning('unused fieldsets: %s', ', '.join(byfieldset))

    def render_buttons(self, w, form):

        if not form.form_buttons:

            return

        w(u'<table class="%s">\n<tr>\n' % self.button_bar_class)

        for button in form.form_buttons:

            w(u'<td>%s</td>\n' % button.render(form))

        w(u'</tr></table>')

class BaseFormRenderer(FormRenderer):

    """use form_renderer_id = 'base' if you want base FormRenderer layout even

    when selected for an entity

    """

    id = 'base'

class EntityBaseFormRenderer(BaseFormRenderer):

    """use form_renderer_id = 'base' if you want base FormRenderer layout even

    when selected for an entity

    """

    __select__ = entity_implements('Any')

    def display_field(self, form, field):

        if not super(EntityBaseFormRenderer, self).display_field(form, field):

            if isinstance(field, HiddenInitialValueField):

                field = field.visible_field

            ismeta = form.edited_entity.e_schema.is_metadata(field.name)

            return ismeta is not None and (

                ismeta[0] in self.display_fields or

                (ismeta[0], 'subject') in self.display_fields)

        return True

class HTableFormRenderer(FormRenderer):

    """display fields horizontally in a table

    +--------------+--------------+---------+

    | field1 label | field2 label |         |

    +--------------+--------------+---------+

    | field1 input | field2 input | buttons

    +--------------+--------------+---------+

    """

    id = 'htable'

    display_help = False

    def _render_fields(self, fields, w, form):

        w(u'<table border="0">')

        w(u'<tr>')

        for field in fields:

            if self.display_label:

                w(u'<th class="labelCol">%s</th>' % self.render_label(form, field))

            if self.display_help:

                w(self.render_help(form, field))

        # empty slot for buttons

        w(u'<th class="labelCol">&nbsp;</th>')

        w(u'</tr>')

        w(u'<tr>')

        for field in fields:

            error = form.form_field_error(field)

            if error:

                w(u'<td class="error">')

                w(error)

            else:

                w(u'<td>')

            w(field.render(form, self))

            w(u'</td>')

        w(u'<td>')

        for button in form.form_buttons:

            w(button.render(form))

        w(u'</td>')

        w(u'</tr>')

        w(u'</table>')

    def render_buttons(self, w, form):

        pass

class EntityCompositeFormRenderer(FormRenderer):

    """specific renderer for multiple entities edition form (muledit)"""

    id = 'composite'

    _main_display_fields = None

    def render_fields(self, w, form, values):

        if not form.is_subform:

            w(u'<table class="listing">')

        super(EntityCompositeFormRenderer, self).render_fields(w, form, values)

        if not form.is_subform:

            w(u'</table>')

            if self._main_display_fields:

                super(EntityCompositeFormRenderer, self)._render_fields(

                    self._main_display_fields, w, form)

    def _render_fields(self, fields, w, form):

        if form.is_subform:

            entity = form.edited_entity

            values = form.form_previous_values

            qeid = eid_param('eid', entity.eid)

            w(u'<tr class="%s">' % (entity.row % 2 and u'even' or u'odd'))

            # XXX turn this into a widget used on the eid field

            for field in fields:

                error = form.form_field_error(field)

                if error:

                    w(u'<td class="error">')

                    w(error)

                else:

                    w(u'<td>')

                    field.widget.attrs['onchange'] = cbsetstate

                elif isinstance(field.widget, fwdgs.Input):

                    field.widget.attrs['onkeypress'] = cbsetstate

                w(u'<div>%s</div>' % field.render(form, self))

                w(u'</td></tr>')

        else:

            self._main_display_fields = fields

            subfields = [field for field in form.forms[0].fields

                         if self.display_field(form, field)

                         and field.is_visible()]

            if subfields:

                # main form, display table headers

                w(u'<tr class="header">')

                w(u'<th align="left">%s</th>' %

                  tags.input(type='checkbox',

                             title=self.req._('toggle check boxes'),

                             onclick="setCheckboxesState('eid', this.checked)"))

                for field in subfields:

                    w(u'<th>%s</th>' % self.req._(field.label))

                w(u'</tr>')

class EntityFormRenderer(EntityBaseFormRenderer):

    """specific renderer for entity edition form (edition)"""

    id = 'default'

    # needs some additional points in some case (XXX explain cases)