bika.lims.adapters.widgetvisibility

Complexity

Total Complexity

61

Size/Duplication

Total Lines	259
Duplicated Lines	13.13 %

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	OptionalFieldsWidgetVisibility.__call__()	0	6	3
F	SamplingWorkflowWidgetVisibility.__call__()	0	50	17
A	HideClientDiscountFields.__init__()	3	3	1
A	HideClientDiscountFields.__call__()	8	8	4
A	BatchARAdd_BatchFieldWidgetVisibility.__init__()	0	3	1
A	OptionalFieldsWidgetVisibility.__init__()	0	3	1
A	WorkflowAwareWidgetVisibility.__init__()	0	3	1
A	HideARPriceFields.__init__()	3	3	1
A	SamplingWorkflowWidgetVisibility.__init__()	0	3	1
A	BatchARAdd_BatchFieldWidgetVisibility.__call__()	0	6	4
A	HideARPriceFields.__call__()	8	8	4
C	WorkflowAwareWidgetVisibility.__call__()	0	24	9
A	ClientFieldWidgetVisibility.__init__()	0	3	1
B	ClientFieldWidgetVisibility.__call__()	0	15	6
A	SampleDateReceived.__init__()	0	3	1
B	SampleDateReceived.__call__()	0	14	6

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE
#
# Copyright 2018 by it's authors.
# Some rights reserved. See LICENSE.rst, CONTRIBUTORS.rst.
from bika.lims.api import get_tool
from bika.lims.interfaces import IAnalysisRequestsFolder, IBatch, IClient
from bika.lims.interfaces import IATWidgetVisibility
from bika.lims.utils import getHiddenAttributesForClass
from Products.CMFCore.utils import getToolByName
from Products.CMFCore.WorkflowCore import WorkflowException
from types import DictType
from zope.interface import implements

_marker = []


class WorkflowAwareWidgetVisibility(object):
    """This adapter allows the schema definition to have different widget visibility
    settings for different workflow states in the primary review_state workflow.

    With this it is possible to write:

        StringField(
            'fieldName',
            widget=StringWidget(
                label=_('field Name'),
                visible = {
                    'edit': 'visible',  # regular AT uses these and they override
                    'view': 'visible',  # everything, without 'edit' you cannot edit
                    'wf_state':    {'edit': 'invisible', 'view': 'visible'  },
                    'other_state': {'edit': 'visible',   'view': 'invisible'},
            }

    The rules about defaults, "hidden", "visible" and "invisible" are the same
    as those from the default Products.Archetypes.Widget.TypesWidget#isVisible

    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 100

    def __call__(self, context, mode, field, default):
        """
        """
        state = default if default else 'visible'
        workflow = getToolByName(self.context, 'portal_workflow')
        try:
            review_state = workflow.getInfoFor(self.context, 'review_state')
        except WorkflowException:
            return state
        vis_dic = field.widget.visible
        if type(vis_dic) is not DictType or review_state not in vis_dic:
            return state
        inner_vis_dic = vis_dic.get(review_state, state)
        if inner_vis_dic is _marker:
            state = state
        if type(inner_vis_dic) is DictType:
            state = inner_vis_dic.get(mode, state)
            state = state
        elif not inner_vis_dic:
            state = 'invisible'
        elif inner_vis_dic < 0:
            state = 'hidden'

        return state


class SamplingWorkflowWidgetVisibility(object):
    """
    This will handle Handling 'DateSampled' and 'SamplingDate' fields'
    visibilities based on Sampling Workflow (SWF)status. We must check the
    attribute saved on the sample, not the bika_setup value though. See the
    internal comments how it enables/disables WidgetVisibility depending on SWF.
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 10

    def __call__(self, context, mode, field, default):
        fields = ['Sampler', 'DateSampled', 'SamplingDate']
        state = default if default else 'invisible'
        fieldName = field.getName()
        if fieldName not in fields:
            return state

        # If object has been already created, get SWF statues from it.
        if hasattr(self.context, 'getSamplingWorkflowEnabled') and \
                context.getSamplingWorkflowEnabled() is not '':
            swf_enabled = context.getSamplingWorkflowEnabled()
        else:
            swf_enabled = context.bika_setup.getSamplingWorkflowEnabled()

        # If SWF Enabled, we mostly use the dictionary from the Field, but:
        # - DateSampled: invisible during creation.
        # - SamplingDate and Sampler: visible and editable until sample due.
        if swf_enabled:
            if fieldName == 'DateSampled':
                if mode == 'add':
                    state = 'invisible'
                    field.required = 0
            elif fieldName in fields:
                if mode == 'header_table':
                    state = 'prominent'
                elif mode == 'view':
                    state = 'visible'
        # If SamplingWorkflow is Disabled:
        #  - DateSampled: visible,
        #                 not editable after creation (appears in header_table),
        #                 required in 'add' view.
        #  - 'SamplingDate' and 'Sampler': disabled everywhere.
        else:
            if fieldName == 'DateSampled':
                if mode == 'add':
                    state = 'edit'
                    field.required = 1
                elif mode == 'edit':
                    state = 'invisible'
                elif mode == 'view':
                    state = 'visible'
                elif mode == 'header_table':
                    # In the Schema definition, DateSampled is 'prominent' for
                    # 'header_table' to let users edit it after receiving
                    # the Sample. But if SWF is disabled, DateSampled must be
                    # filled during creation and never editable.
                    state = 'visible'
            elif fieldName in fields:
                state = 'invisible'
        return state


class ClientFieldWidgetVisibility(object):
    """The Client field is editable by default in ar_add.  This adapter
    will force the Client field to be hidden when it should not be set
    by the user.
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 10

    def __call__(self, context, mode, field, default):
        state = default if default else 'hidden'
        fieldName = field.getName()
        if fieldName != 'Client':
            return state
        parent = self.context.aq_parent

        if IBatch.providedBy(parent):
            if parent.getClient():
                return 'hidden'

        if IClient.providedBy(parent):
            return 'hidden'

        return state

class BatchARAdd_BatchFieldWidgetVisibility(object):
    """This will force the 'Batch' field to 'hidden' in ar_add when the parent
    context is a Batch.
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 10

    def __call__(self, context, mode, field, default):
        state = default if default else 'visible'
        fieldName = field.getName()
        if fieldName == 'Batch' and context.aq_parent.portal_type == 'Batch':
            return 'hidden'
        return state

class OptionalFieldsWidgetVisibility(object):
    """Remove 'hidden attributes' (fields in registry bika.lims.hiddenattributes).
       fieldName = field.getName()
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 5

    def __call__(self, context, mode, field, default):
        state = default if default else 'visible'
        hiddenattributes = getHiddenAttributesForClass(context.portal_type)
        if field.getName() in hiddenattributes:
            state = "hidden"
        return state

class HideARPriceFields(object):

This code seems to be duplicated in your project.

    """Hide related fields in ARs when ShowPrices is disabled
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 3

    def __call__(self, context, mode, field, default):
        fields = ['InvoiceExclude']
        ShowPrices = context.bika_setup.getShowPrices()
        state = default if default else 'invisible'
        fieldName = field.getName()
        if fieldName in fields and not ShowPrices:
            state = 'invisible'
        return state

class HideClientDiscountFields(object):

This code seems to be duplicated in your project.

    """Hide related fields in ARs when ShowPrices is disabled
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 3

    def __call__(self, context, mode, field, default):
        fields = ['BulkDiscount', 'MemberDiscountApplies']
        ShowPrices = context.bika_setup.getShowPrices()
        state = default if default else 'invisible'
        fieldName = field.getName()
        if fieldName in fields and not ShowPrices:
            state = 'invisible'
        return state


class SampleDateReceived(object):
    """DateReceived is editable in sample context, only if all related analyses
    are not yet submitted.
    """
    implements(IATWidgetVisibility)

    def __init__(self, context):
        self.context = context
        self.sort = 3

    def __call__(self, context, mode, field, default):
        state = default if default else 'visible'
        if field.getName() == 'DateReceived':
            # if ONLY "sample_received" analyses exist, it is permitted
            # to edit the field.
            wf = get_tool('portal_workflow')
            anwf = wf['bika_analysis_workflow']
            state_ids = [s for s in anwf.states if s != 'sample_received']
            if context.getAnalyses(review_state=state_ids):
                if mode == 'edit':
                    state = 'invisible'
                elif mode == 'view':
                    state = 'visible'
        return state