senaite.core.z3cform.widgets.uidreference

Complexity

Total Complexity

18

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	UIDReferenceWidget.get_api_url()	0	5	1
A	UIDReferenceWidget.get_query()	0	2	1
A	UIDReferenceWidget.get_input_widget_attributes()	0	26	2
A	UIDReferenceWidget.get_obj_info()	0	8	1
A	UIDReferenceWidget.render_reference()	0	6	1
A	UIDReferenceWidget.__init__()	0	3	1
A	UIDReferenceWidget.update()	0	3	1
A	UIDReferenceWidget.get_catalog()	0	2	1
A	UIDReferenceWidget.get_limit()	0	2	1
A	UIDReferenceWidget.is_multi_valued()	0	2	1
A	UIDReferenceDataConverter.toFieldValue()	0	6	1
A	UIDReferenceWidget.get_value()	0	2	1
A	UIDReferenceDataConverter.toWidgetValue()	0	9	2
A	UIDReferenceWidget.get_display_template()	0	2	1
A	UIDReferenceWidget.get_columns()	0	2	1

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

import json
import string
from collections import OrderedDict

from bika.lims import api
from senaite.core.interfaces import ISenaiteFormLayer
from senaite.core.schema.interfaces import IUIDReferenceField
from senaite.core.z3cform.interfaces import IUIDReferenceWidget
from senaite.jsonapi.interfaces import IInfo
from z3c.form import interfaces
from z3c.form.browser import widget
from z3c.form.browser.textlines import TextLinesWidget
from z3c.form.converter import TextLinesConverter
from z3c.form.interfaces import IFieldWidget
from z3c.form.widget import FieldWidget
from zope.component import adapter
from zope.interface import implementer

DISPLAY_TEMPLATE = "<a href='${url}' _target='blank'>${title} ${uid}</a>"


@adapter(IUIDReferenceField, interfaces.IWidget)
class UIDReferenceDataConverter(TextLinesConverter):
    """Converts the raw field data for widget/field usage
    """

    def toWidgetValue(self, value):
        """Converts a list of UIDs for the display/hidden widget

        returns a list of UIDs when widget is in "display" mode
        returns a unicode string when widget is in "hidden" mode
        """
        if self.widget.mode == "display":
            return value
        return super(UIDReferenceDataConverter, self).toWidgetValue(value)

    def toFieldValue(self, value):
        """Converts a unicode string to a list of UIDs
        """
        # remove any blank lines at the end
        value = value.rstrip("\r\n")
        return super(UIDReferenceDataConverter, self).toFieldValue(value)


@implementer(IUIDReferenceWidget)
class UIDReferenceWidget(TextLinesWidget):
    """Senaite UID reference widget
    """
    klass = u"senaite-uidreference-widget"

    def __init__(self, request, *args, **kw):
        super(UIDReferenceWidget, self).__init__(request)
        self.request = request

    def update(self):
        super(UIDReferenceWidget, self).update()
        widget.addFieldClass(self)

    def get_display_template(self):
        return getattr(self, "display_template", DISPLAY_TEMPLATE)

    def get_value(self):
        return self.field.get_raw(self.context)

    def get_api_url(self):
        portal = api.get_portal()
        portal_url = api.get_url(portal)
        api_url = "{}/@@API/senaite/v1".format(portal_url)
        return api_url

    def get_catalog(self):
        return getattr(self, "catalog", "portal_catalog")

    def get_query(self):
        return getattr(self, "query", {})

    def get_columns(self):
        return getattr(self, "columns", [])

    def get_limit(self):
        return getattr(self, "limit", 25)

    def is_multi_valued(self):
        return getattr(self.field, "multi_valued", False)

    def get_input_widget_attributes(self):
        """Return input widget attributes for the ReactJS component
        """
        uids = self.get_value()
        attributes = {
            "data-id": self.id,
            "data-name": self.name,
            "data-uids": uids,
            "data-api_url": self.get_api_url(),
            "data-items": OrderedDict(zip(uids, map(self.get_obj_info, uids))),
            "data-query": self.get_query(),
            "data-catalog": self.get_catalog(),
            "data-columns": self.get_columns(),
            "data-display_field": self.get_display_field(),
            "data-display_template": self.get_display_template(),
            "data-limit": self.get_limit(),
            "data-multi_valued": self.is_multi_valued(),
            "data-disabled": self.disabled or False,
            "data-readonly": self.readonly or False,
        }

        # convert all attributes to JSON
        for key, value in attributes.items():
            attributes[key] = json.dumps(value)

        return attributes

    def get_obj_info(self, uid):
        """Returns a dictionary with the object info
        """
        obj = api.get_object(uid)
        obj_info = IInfo(obj).to_dict()
        obj_info["uid"] = uid
        obj_info["url"] = api.get_url(obj)
        return obj_info

    def render_reference(self, uid):
        """Returns a rendered HTML element for the reference
        """
        template = string.Template(self.get_display_template())
        obj_info = self.get_obj_info(uid)
        return template.safe_substitute(obj_info)


@adapter(IUIDReferenceField, ISenaiteFormLayer)
@implementer(IFieldWidget)
def UIDReferenceWidgetFactory(field, request):
    """Widget factory for UIDReferenceField
    """
    return FieldWidget(field, UIDReferenceWidget(request))