widgets.py

from django.contrib.admin import widgets as admin_widgets
from django.forms import widgets as form_widgets
from django.forms import TextInput, Select, Textarea, fields
from django.utils.safestring import mark_safe
from django.core.urlresolvers import reverse
from django import forms
from django.utils import formats, translation
from django.utils.translation import ugettext as _
from django.contrib.admin.templatetags.admin_static import static
from suit import utils


class LinkedSelect(Select):
    """
    Linked select - Adds link to foreign item, when used with foreign key field
    """

    def __init__(self, attrs=None, choices=()):
        attrs = _make_attrs(attrs, classes="linked-select")
        super(LinkedSelect, self).__init__(attrs, choices)


class EnclosedInput(TextInput):
    """
    Widget for bootstrap appended/prepended inputs
    """

    def __init__(self, attrs=None, prepend=None, append=None):
        """
        For prepend, append parameters use string like %, $ or html
        """
        self.prepend = prepend
        self.append = append
        super(EnclosedInput, self).__init__(attrs=attrs)

    def enclose_value(self, value):
        """
        If value doesn't starts with html open sign "<", enclose in add-on tag
        """
        cls = 'addon'
        if value.startswith("<"):
            cls = 'btn'
        if value.startswith("glyphicon-"):
            value = '<i class="glyphicon %s"></i>' % value
        return '<span class="input-group-%s">%s</span>' % (cls, value)

    def render(self, name, value, attrs=None):
        output = super(EnclosedInput, self).render(name, value, attrs)
        div_classes = []
        if self.prepend:
            # div_classes.append('input-prepend')
            self.prepend = self.enclose_value(self.prepend)
            output = ''.join((self.prepend, output))
        if self.append:
            # div_classes.append('input-append')
            self.append = self.enclose_value(self.append)
            output = ''.join((output, self.append))

        return mark_safe(
            '<div class="input-group %s">%s</div>' % (
                ' '.join(div_classes), output))


class AutosizedTextarea(Textarea):
    """
    Autosized Textarea - textarea height dynamically grows based on user input
    """

    def __init__(self, attrs=None):
        new_attrs = _make_attrs(attrs, {"rows": 2}, "autosize")
        super(AutosizedTextarea, self).__init__(new_attrs)

    @property
    def media(self):
        return forms.Media(js=[static("suit/js/jquery.autosize-min.js")])

    def render(self, name, value, attrs=None):
        output = super(AutosizedTextarea, self).render(name, value, attrs)
        output += mark_safe(
            "<script type=\"text/javascript\">Suit.$('#id_%s').autosize("
            ");</script>"
            % name)
        return output


class SuitDateWidget(forms.DateInput):
    @property
    def media(self):
        js = ['datepicker/bootstrap-datepicker.js']
        dp_lang = self.language()
        if dp_lang != 'en':
            js.append('datepicker/locales/bootstrap-datepicker.%s.js' % dp_lang)
        return forms.Media(
            js=[static("suit/js/%s" % path) for path in js],
            css={'all': [static("suit/js/datepicker/css/datepicker3.css")]}
        )

    def __init__(self, attrs=None, format=None):
        attrs = attrs or {}
        self.format = format
        super(SuitDateWidget, self).__init__(attrs=attrs, format=format)

    def language(self):
        lang = str(translation.get_language() or 'en')[:2].lower()
        dp_lang = lang
        if lang.startswith('zh'):
            dp_lang = {
                'zh-cn': 'zh-CN',
                'zh-tw': 'zh-TW'
            }.get(lang, 'en')
        return dp_lang

    def date_format(self):
        return self.format or formats.get_format(self.format_key)[0]

    def datepicker_date_format(self, django_format):
        mapping = {
            '%Y': 'yyyy',
            '%y': 'yy',
            '%m': 'mm',
            '%b': 'M',  # Oct, Nov
            '%B': 'MM',  # October, November
            '%d': 'dd',
            '%M': 'i',
            '%S': 's',
            '.%f': '',  # Microseconds are not supported by datepicker
        }
        for dj_fmt, dp_fmt in mapping.items():
            django_format = django_format.replace(dj_fmt, dp_fmt)

        django_format = django_format.replace('%', '')
        return django_format

    def render(self, name, value, attrs=None):
        output = super(SuitDateWidget, self).render(name, value, attrs)

        # Because we wrap input tag in input-group we must copy data-* attrs
        # for datepicker formats
        attrs = utils.attrs_by_prefix(output, 'data-date-')
        if 'data-date-format' not in attrs:
            attrs['data-date-format'] = self.datepicker_date_format(
                self.date_format())

        attrs = utils.dict_to_attrs(attrs)

        return mark_safe(
            '<div class="input-group date" %s>%s<span '
            'class="input-group-addon"><i class="glyphicon '
            'glyphicon-th"></i></span></div>' % (
                attrs, output))


class SuitDateTimeWidget(forms.DateTimeInput, SuitDateWidget):
    def __init__(self, attrs=None, format=None):
        self.format = format
        attrs = attrs or {}
        attrs['data-date-show-time'] = 'true'
        super(SuitDateTimeWidget, self).__init__(attrs, format)


class SuitTimeWidget(admin_widgets.AdminTimeWidget):
    def __init__(self, attrs=None, format=None):
        defaults = {'placeholder': _('Time:')[:-1]}
        new_attrs = _make_attrs(attrs, defaults, "vTimeField input-small")
        super(SuitTimeWidget, self).__init__(attrs=new_attrs, format=format)

    def render(self, name, value, attrs=None):
        output = super(SuitTimeWidget, self).render(name, value, attrs)
        return mark_safe(
            '<div class="input-append suit-date suit-time">%s<span '
            'class="add-on"><i class="icon-time"></i></span></div>' %
            output)


class SuitSplitDateTimeWidget(forms.SplitDateTimeWidget):
    """
    A SplitDateTime Widget that has some admin-specific styling.
    """

    def __init__(self, attrs=None):
        widgets = [SuitDateWidget, SuitTimeWidget]
        forms.MultiWidget.__init__(self, widgets, attrs)

    def format_output(self, rendered_widgets):
        out_tpl = '<div class="datetime">%s %s</div>'
        return mark_safe(out_tpl % (rendered_widgets[0], rendered_widgets[1]))


def _make_attrs(attrs, defaults=None, classes=None):
    result = defaults.copy() if defaults else {}
    if attrs:
        result.update(attrs)
    if classes:
        result["class"] = " ".join((classes, result.get("class", "")))
    return result


def wrap_as_input_group(s, append=''):
    return mark_safe('<div class="input-group">%s</div>%s' % (s, append))


def add_bs3_markup():
    def _build_attrs(self, *args, **kwargs):
        """
        Merge bs3_class attribute with existing class
        """
        attrs = self.build_attrs_original(*args, **kwargs) or {}
        bs3_class = attrs.pop('bs3_class', '')
        if bs3_class:
            css_class = attrs.get('class')
            css_classes = [css_class] if css_class else []
            css_classes.append(bs3_class)
            attrs['class'] = ' '.join(css_classes)
        return attrs


    def _widget_attrs(self, widget):
        """
        Add Bootstrap 3 form-control CSS class
        """
        apply_to = (fields.CharField, fields.BaseTemporalField,
                    fields.IntegerField, fields.ChoiceField)
        attrs = self.widget_attrs_original(widget) or {}
        if issubclass(self.__class__, apply_to) and not \
                issubclass(widget.__class__, (
                        form_widgets.HiddenInput, form_widgets.RadioSelect)):
            attrs.update({'bs3_class': 'form-control'})
        return attrs

    # Override widget_attrs and build_attrs globally to add form-control class
    fields.Field.widget_attrs_original = fields.Field.widget_attrs
    fields.Field.widget_attrs = _widget_attrs
    form_widgets.Widget.build_attrs_original = form_widgets.Widget.build_attrs
    form_widgets.Widget.build_attrs = _build_attrs

    ###########
    #
    # Adjust markup for special widgets
    # I monkey patched, to support all the inherited classes in 3rd party apps
    #

    # Select dropdown + PLUS button
    def render_RelatedFieldWidgetWrapper(self, name, value, *args, **kwargs):
        """
        Method is a clone from original widget, with adjusted markup
        """
        from django.contrib.admin.views.main import TO_FIELD_VAR

        rel_to = self.rel.to
        info = (rel_to._meta.app_label, rel_to._meta.model_name)
        self.widget.choices = self.choices
        output = ['<div class="input-group">',
                  self.widget.render(name, value, *args, **kwargs)]
        if self.can_add_related:
            related_url = reverse('admin:%s_%s_add' % info,
                                  current_app=self.admin_site.name)
            url_params = '?%s=%s' % (
                TO_FIELD_VAR, self.rel.get_related_field().name)
            # TODO: "add_id_" is hard-coded here. This should instead use the
            # correct API to determine the ID dynamically.
            output.append(
                '<span class="input-group-btn">'
                '<a href="%s%s" class="add-another btn btn-default" '
                'id="add_id_%s" onclick="return showAddAnotherPopup(this);" '
                'title="%s"><span class="glyphicon glyphicon-plus-sign '
                'color-success"></span></a></span>'
                % (related_url, url_params, name, _('Add Another')))

        output.append('</div>')
        return mark_safe(''.join(output))

    admin_widgets.RelatedFieldWidgetWrapper.render = \
        render_RelatedFieldWidgetWrapper

    # Select dropdown + PLUS button
    def render_ForeignKeyRawIdWidget(self, name, value, attrs=None):
        rel_to = self.rel.to
        if attrs is None:
            attrs = {}
        extra = []
        if rel_to in self.admin_site._registry:
            # The related object is registered with the same AdminSite
            related_url = reverse(
                'admin:%s_%s_changelist' % (
                    rel_to._meta.app_label,
                    rel_to._meta.model_name,
                ),
                current_app=self.admin_site.name,
            )

            params = self.url_parameters()
            if params:
                url = '?' + '&amp;'.join(
                    '%s=%s' % (k, v) for k, v in params.items())
            else:
                url = ''
            if "class" not in attrs:
                attrs['class'] = 'vForeignKeyRawIdAdminField'
                # The JavaScript code looks for this hook.
            # TODO: "lookup_id_" is hard-coded here. This should instead use
            # the correct API to determine the ID dynamically.
            extra.append(
                '<span class="input-group-btn"><a href="%s%s" '
                'class="related-lookup btn btn-default" id="lookup_id_%s" '
                'onclick="return showRelatedObjectLookupPopup(this);" '
                'title="%s"><span class="glyphicon '
                'glyphicon-search"></span></a></span>' %
                (related_url, url, name, _('Lookup')))

        output = ['<div class="input-group">',
                  super(self.__class__, self).render(name, value, attrs)]
        output.extend(extra)
        output.append('</div>')
        if value:
            output.append(self.label_for_value(value))

        return mark_safe(''.join(output))

    admin_widgets.ForeignKeyRawIdWidget.render = render_ForeignKeyRawIdWidget