bika.lims.validators.AnalysisSpecificationsValidator.validate_service() - Code Metrics - Inspection of "Fix reference definition range validation (#2452)" - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 2.x ( 777ce6...78af08 )

by Jordi
created 2023-12-20 13:31 UTC
AnalysisSpecificationsValidator.validate_service() F

↳ Parent: bika.lims.validators
Complexity

Conditions
Size

Total Lines	40
Code Lines	25
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	25
dl	0
loc	40
rs	0
c	0
b	0
f	0
cc	20
nop	3
How to fix Complexity

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE.
#
# SENAITE.CORE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright 2018-2021 by it's authors.
# Some rights reserved, see README and LICENSE.

import re
import string
import types
from time import strptime as _strptime

from bika.lims import api
from bika.lims import bikaMessageFactory as _
from bika.lims import logger
from bika.lims.api import APIError
from bika.lims.catalog import SETUP_CATALOG
from senaite.core.i18n import translate as _t
from bika.lims.utils import to_utf8
from Products.CMFCore.utils import getToolByName
from Products.CMFPlone.utils import safe_unicode
from Products.validation import validation
from Products.validation.interfaces.IValidator import IValidator
from Products.ZCTextIndex.ParseTree import ParseError
from zope.interface import implements


class IdentifierTypeAttributesValidator:

    """Validate IdentifierTypeAttributes to ensure that attributes are
    not duplicated.
    """

    implements(IValidator)
    name = "identifiertypeattributesvalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        request = instance.REQUEST
        form = request.get('form', {})
        fieldname = kwargs['field'].getName()
        form_value = form.get(fieldname, False)
        if form_value is False:
            # not required...
            return True
        if value == instance.get(fieldname):
            # no change.
            return True

        return True


validation.register(IdentifierTypeAttributesValidator())


class IdentifierValidator:

    """some actual validation should go here.
    I'm leaving this stub registered, but adding no extra validation.
    """

    implements(IValidator)
    name = "identifiervalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        request = instance.REQUEST
        form = request.get('form', {})
        fieldname = kwargs['field'].getName()
        form_value = form.get(fieldname, False)
        if form_value is False:
            # not required...
            return True
        if value == instance.get(fieldname):
            # no change.
            return True

        return True


validation.register(IdentifierValidator())


class UniqueFieldValidator:
    """Verifies if a field value is unique within the same container
    """
    implements(IValidator)
    name = "uniquefieldvalidator"

    def get_parent_objects(self, context):
        """Return all objects of the same type from the parent object
        """
        parent_object = api.get_parent(context)
        portal_type = api.get_portal_type(context)
        return parent_object.objectValues(portal_type)

    def query_parent_objects(self, context, query=None):
        """Return the objects of the same type from the parent object

        :param query: Catalog query to narrow down the objects
        :type query: dict
        :returns: Content objects of the same portal type in the parent
        """

        # return the object values if we have no catalog query
        if query is None:
            return self.get_parent_objects(context)

        # avoid undefined reference of catalog in except...
        catalog = None

        # try to fetch the results via the catalog
        try:
            catalogs = api.get_catalogs_for(context)
            catalog = catalogs[0]
            return map(api.get_object, catalog(query))
        except (IndexError, UnicodeDecodeError, ParseError, APIError) as e:
            # fall back to the object values of the parent
            logger.warn("UniqueFieldValidator: Catalog query {} failed "
                        "for catalog {} ({}) -> returning object values of {}"
                        .format(query, repr(catalog), str(e),
                                repr(api.get_parent(context))))
            return self.get_parent_objects(context)

    def make_catalog_query(self, context, field, value):
        """Create a catalog query for the field
        """

        # get the catalogs for the context
        catalogs = api.get_catalogs_for(context)
        # context not in any catalog?
        if not catalogs:
            logger.warn("UniqueFieldValidator: Context '{}' is not assigned"
                        "to any catalog!".format(repr(context)))
            return None

        # take the first catalog
        catalog = catalogs[0]

        # Check if the field accessor is indexed
        field_index = field.getName()
        accessor = field.getAccessor(context)
        if accessor:
            field_index = accessor.__name__

        # return if the field is not indexed
        if field_index not in catalog.indexes():
            return None

        # build a catalog query
        query = {
            "portal_type": api.get_portal_type(context),
            "path": {
                "query": api.get_parent_path(context),
                "depth": 1,
            }
        }
        query[field_index] = value
        logger.info("UniqueFieldValidator:Query={}".format(query))
        return query

    def __call__(self, value, *args, **kwargs):
        context = kwargs['instance']
        uid = api.get_uid(context)
        field = kwargs['field']
        fieldname = field.getName()
        translate = getToolByName(context, 'translation_service').translate

        # return directly if nothing changed
        if value == field.get(context):
            return True

        # Fetch the parent object candidates by catalog or by objectValues
        #
        # N.B. We want to use the catalog to speed things up, because using
        # `parent.objectValues` is very expensive if the parent object contains
        # many items and causes the UI to block too long
        catalog_query = self.make_catalog_query(context, field, value)
        parent_objects = self.query_parent_objects(
            context, query=catalog_query)

        for item in parent_objects:
            if hasattr(item, 'UID') and item.UID() != uid and \
               fieldname in item.Schema() and \
               str(item.Schema()[fieldname].get(item)) == str(value).strip():
                # We have to compare them as strings because
                # even if a number (as an  id) is saved inside
                # a string widget and string field, it will be
                # returned as an int. I don't know if it is
                # caused because is called with
                # <item.Schema()[fieldname].get(item)>,
                # but it happens...
                msg = _(
                    "Validation failed: '${value}' is not unique",
                    mapping={
                        'value': safe_unicode(value)
                    })
                return to_utf8(translate(msg))
        return True


validation.register(UniqueFieldValidator())


class InvoiceBatch_EndDate_Validator:
    """ Verifies that the End Date is after the Start Date """

    implements(IValidator)
    name = "invoicebatch_EndDate_validator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs.get('instance')
        request = kwargs.get('REQUEST')

        if request and request.form.get('BatchStartDate'):
            startdate = _strptime(request.form.get('BatchStartDate'), '%Y-%m-%d %H:%M')
        else:
            startdate = _strptime(instance.getBatchStartDate(), '%Y-%m-%d %H:%M')

        enddate = _strptime(value, '%Y-%m-%d %H:%M')

        translate = api.get_tool('translation_service', instance).translate
        if not enddate >= startdate:
            msg = _("Start date must be before End Date")
            return to_utf8(translate(msg))
        return True


validation.register(InvoiceBatch_EndDate_Validator())


class ServiceKeywordValidator:
    """Validate AnalysisService Keywords
    must match isUnixLikeName
    may not be the same as another service keyword
    may not be the same as any InterimField id.
    """

    implements(IValidator)
    name = "servicekeywordvalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        if instance.getKeyword() == value:
            # Nothing changed
            return

        # The validators module get imported early in __init__.py,
        # and this line causes this (indirect) import error:
        #
        # from bika.lims.browser.fields.uidreferencefield import get_backreferences
        # ImportError: cannot import name SuperModel
        #
        # Mental note from ramonski:
        # Probably because *all* fields get imported in
        # bika.lims.browser.fields.__init__.py and the ZCA is not yet fully
        # initialized.
        #
        # https://github.com/senaite/senaite.docker/issues/14
        from bika.lims.api.analysisservice import check_keyword
        err_msg = check_keyword(value, instance)
        if err_msg:
            ts = api.get_tool("translation_service")
            return to_utf8(ts.translate(err_msg))
        return True


validation.register(ServiceKeywordValidator())


class InterimFieldsValidator:
    """Validating InterimField keywords.
        XXX Applied as a subfield validator but validates entire field.
        keyword must match isUnixLikeName
        keyword may not be the same as any service keyword.
        keyword must be unique in this InterimFields field
        keyword must be unique for interimfields which share the same title.
        title must be unique for interimfields which share the same keyword.
    """

    implements(IValidator)
    name = "interimfieldsvalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        fieldname = kwargs['field'].getName()
        request = kwargs.get('REQUEST', {})
        form = request.form
        interim_fields = form.get(fieldname, [])

        translate = getToolByName(instance, 'translation_service').translate
        bsc = getToolByName(instance, 'senaite_catalog_setup')

        # We run through the validator once per form submit, and check all
        # values
        # this value in request prevents running once per subfield value.
        key = instance.id + fieldname
        if instance.REQUEST.get(key, False):
            return True

        for x in range(len(interim_fields)):
            row = interim_fields[x]
            keys = row.keys()
            if 'title' not in keys:
                instance.REQUEST[key] = to_utf8(
                    translate(_("Validation failed: title is required")))
                return instance.REQUEST[key]
            if 'keyword' not in keys:
                instance.REQUEST[key] = to_utf8(
                    translate(_("Validation failed: keyword is required")))
                return instance.REQUEST[key]
            if not re.match(r"^[A-Za-z\w\d\-\_]+$", row['keyword']):
                instance.REQUEST[key] = _(
                    "Validation failed: keyword contains invalid characters")
                return instance.REQUEST[key]

        # keywords and titles used once only in the submitted form
        keywords = {}
        titles = {}
        for field in interim_fields:
            if 'keyword' in field:
                if field['keyword'] in keywords:
                    keywords[field['keyword']] += 1
                else:
                    keywords[field['keyword']] = 1
            if 'title' in field:
                if field['title'] in titles:
                    titles[field['title']] += 1
                else:
                    titles[field['title']] = 1
        for k in [k for k in keywords.keys() if keywords[k] > 1]:
            msg = _(
                "Validation failed: '${keyword}': duplicate keyword",
                mapping={
                    'keyword': safe_unicode(k)
                })
            instance.REQUEST[key] = to_utf8(translate(msg))
            return instance.REQUEST[key]
        for t in [t for t in titles.keys() if titles[t] > 1]:
            msg = _(
                "Validation failed: '${title}': duplicate title",
                mapping={
                    'title': safe_unicode(t)
                })
            instance.REQUEST[key] = to_utf8(translate(msg))
            return instance.REQUEST[key]

        # check all keywords against all AnalysisService keywords for dups
        services = bsc(portal_type='AnalysisService', getKeyword=value)
        if services:
            msg = _(
                "Validation failed: '${title}': "
                "This keyword is already in use by service '${used_by}'",
                mapping={
                    'title': safe_unicode(value),
                    'used_by': safe_unicode(services[0].Title)
                })
            instance.REQUEST[key] = to_utf8(translate(msg))
            return instance.REQUEST[key]

        # any duplicated interimfield titles must share the same keyword
        # any duplicated interimfield keywords must share the same title
        calcs = bsc(portal_type='Calculation')
        keyword_titles = {}
        title_keywords = {}
        for calc in calcs:
            if calc.UID == instance.UID():
                continue
            calc = calc.getObject()
            for field in calc.getInterimFields():
                keyword_titles[field['keyword']] = field['title']
                title_keywords[field['title']] = field['keyword']
        for field in interim_fields:
            if field['keyword'] != value:
                continue
            if 'title' in field and \

               field['title'] in title_keywords.keys() and \
               title_keywords[field['title']] != field['keyword']:
                msg = _(
                    "Validation failed: column title '${title}' "
                    "must have keyword '${keyword}'",
                    mapping={
                        'title': safe_unicode(field['title']),
                        'keyword': safe_unicode(title_keywords[field['title']])
                    })
                instance.REQUEST[key] = to_utf8(translate(msg))
                return instance.REQUEST[key]
            if 'keyword' in field and \

               field['keyword'] in keyword_titles.keys() and \
               keyword_titles[field['keyword']] != field['title']:
                msg = _(
                    "Validation failed: keyword '${keyword}' "
                    "must have column title '${title}'",
                    mapping={
                        'keyword': safe_unicode(field['keyword']),
                        'title': safe_unicode(keyword_titles[field['keyword']])
                    })
                instance.REQUEST[key] = to_utf8(translate(msg))
                return instance.REQUEST[key]

        # Check if choices subfield is valid
        for interim in interim_fields:
            message = self.validate_choices(interim)
            if message:
                # Not a valid choice
                instance.REQUEST[key] = message
                return message

        instance.REQUEST[key] = True
        return True

    def validate_choices(self, interim):
        """Checks whether the choices are valid for the given interim
        """
        result_type = interim.get("result_type", "")
        choices = interim.get("choices")
        if not choices:
            # No choices set, result type should remain empty or multivalue
            if result_type in ["", "multivalue"]:
                return
            return _t(_("Control type is not supported for empty choices"))

        # Choices are expressed like "value0:text0|value1:text1|..|valuen:textn"
        choices = choices.split("|") or []
        try:
            choices = dict(map(lambda ch: ch.strip().split(":"), choices))
        except ValueError:
            return _t(_(
                "No valid format in choices field. Supported format is: "
                "<value-0>:<text>|<value-1>:<text>|<value-n>:<text>"))

        # Empty keys (that match with the result value) are not allowed
        keys = map(lambda k: k.strip(), choices.keys())
        empties = filter(None, keys)
        if len(empties) != len(keys):
            return _t(_("Empty keys are not supported"))

        # No duplicate keys allowed
        unique_keys = list(set(keys))
        if len(unique_keys) != len(keys):
            return _t(_("Duplicate keys in choices field"))

        # We need at least 2 choices
        if len(keys) < 2:
            return _t(_("At least, two options for choices field are required"))

        # Multivalue is not supported with choices
        if result_type in ["multivalue"]:
            return _t(_(
                "Multiple values control type is not supported for choices"
            ))

validation.register(InterimFieldsValidator())


class FormulaValidator:
    """ Validate keywords in calculation formula entry
    """
    implements(IValidator)
    name = "formulavalidator"

    def __call__(self, value, *args, **kwargs):
        if not value:
            return True
        instance = kwargs["instance"]
        request = api.get_request()
        form = request.form
        interim_fields = form.get("InterimFields", [])
        translate = getToolByName(instance, "translation_service").translate
        catalog = api.get_tool(SETUP_CATALOG)
        interim_keywords = filter(None, map(
            lambda i: i.get("keyword"), interim_fields))
        keywords = re.compile(r"\[([^\.^\]]+)\]").findall(value)

        for keyword in keywords:
            # Check if the service keyword exists and is active.
            dep_service = catalog(getKeyword=keyword, is_active=True)
            if not dep_service and keyword not in interim_keywords:
                msg = _(
                    "Validation failed: Keyword '${keyword}' is invalid",
                    mapping={
                        'keyword': safe_unicode(keyword)
                    })
                return to_utf8(translate(msg))

        # Allow to use Wildcards, LDL and UDL values in calculations
        allowedwds = ["LDL", "UDL", "BELOWLDL", "ABOVEUDL"]
        keysandwildcards = re.compile(r"\[([^\]]+)\]").findall(value)
        keysandwildcards = [k for k in keysandwildcards if "." in k]
        keysandwildcards = [k.split(".", 1) for k in keysandwildcards]
        errwilds = [k[1] for k in keysandwildcards if k[0] not in keywords]
        if len(errwilds) > 0:
            msg = _(
                "Wildcards for interims are not allowed: ${wildcards}",
                mapping={
                    "wildcards": safe_unicode(", ".join(errwilds))
                })
            return to_utf8(translate(msg))

        wildcards = [k[1] for k in keysandwildcards if k[0] in keywords]
        wildcards = [wd for wd in wildcards if wd not in allowedwds]
        if len(wildcards) > 0:
            msg = _(
                "Invalid wildcards found: ${wildcards}",
                mapping={
                    "wildcards": safe_unicode(", ".join(wildcards))
                })
            return to_utf8(translate(msg))

        return True


validation.register(FormulaValidator())


class CoordinateValidator:
    """ Validate latitude or longitude field values
    """
    implements(IValidator)
    name = "coordinatevalidator"

    def __call__(self, value, **kwargs):
        if not value:
            return True

        instance = kwargs['instance']
        fieldname = kwargs['field'].getName()
        request = instance.REQUEST

        form = request.form
        form_value = form.get(fieldname)

        translate = getToolByName(instance, 'translation_service').translate

        try:
            degrees = int(form_value['degrees'])
        except ValueError:
            return to_utf8(
                translate(_("Validation failed: degrees must be numeric")))

        try:
            minutes = int(form_value['minutes'])
        except ValueError:
            return to_utf8(
                translate(_("Validation failed: minutes must be numeric")))

        try:
            seconds = int(form_value['seconds'])
        except ValueError:
            return to_utf8(
                translate(_("Validation failed: seconds must be numeric")))

        if not 0 <= minutes <= 59:
            return to_utf8(
                translate(_("Validation failed: minutes must be 0 - 59")))

        if not 0 <= seconds <= 59:
            return to_utf8(
                translate(_("Validation failed: seconds must be 0 - 59")))

        bearing = form_value['bearing']

        if fieldname == 'Latitude':

            if not 0 <= degrees <= 90:
                return to_utf8(
                    translate(_("Validation failed: degrees must be 0 - 90")))
            if degrees == 90:
                if minutes != 0:
                    return to_utf8(
                        translate(
                            _("Validation failed: degrees is 90; "
                              "minutes must be zero")))
                if seconds != 0:
                    return to_utf8(
                        translate(
                            _("Validation failed: degrees is 90; "
                              "seconds must be zero")))
            if bearing.lower() not in 'sn':
                return to_utf8(
                    translate(_("Validation failed: Bearing must be N/S")))

        if fieldname == 'Longitude':

            if not 0 <= degrees <= 180:
                return to_utf8(
                    translate(_("Validation failed: degrees must be 0 - 180")))
            if degrees == 180:
                if minutes != 0:
                    return to_utf8(
                        translate(
                            _("Validation failed: degrees is 180; "
                              "minutes must be zero")))
                if seconds != 0:
                    return to_utf8(
                        translate(
                            _("Validation failed: degrees is 180; "
                              "seconds must be zero")))
            if bearing.lower() not in 'ew':
                return to_utf8(
                    translate(_("Validation failed: Bearing must be E/W")))

        return True


validation.register(CoordinateValidator())


class ResultOptionsValueValidator(object):
    """Validator for the subfield "ResultValue" of ResultOptions field
    """

    implements(IValidator)
    name = "result_options_value_validator"

    def __call__(self, value, *args, **kwargs):
        # Result Value must be floatable
        if not api.is_floatable(value):
            return _t(_("Result Value must be a number"))

        # Get all records
        instance = kwargs['instance']
        field_name = kwargs['field'].getName()
        request = instance.REQUEST
        records = request.form.get(field_name)

        # Result values must be unique
        value = api.to_float(value)
        values = map(lambda ro: ro.get("ResultValue"), records)
        values = filter(api.is_floatable, values)
        values = map(api.to_float, values)
        duplicates = filter(lambda val: val == value, values)
        if len(duplicates) > 1:
            return _t(_("Result Value must be unique"))

        return True


validation.register(ResultOptionsValueValidator())


class ResultOptionsTextValidator(object):
    """Validator for the subfield "ResultText" of ResultsOption field
    """

    implements(IValidator)
    name = "result_options_text_validator"

    def __call__(self, value, *args, **kwargs):
        # Result Text is required
        if not value or not value.strip():
            return _t(_("Display Value is required"))

        # Get all records
        instance = kwargs['instance']
        field_name = kwargs['field'].getName()
        request = instance.REQUEST
        records = request.form.get(field_name)

        # Result Text must be unique
        original_texts = map(lambda ro: ro.get("ResultText"), records)
        duplicates = filter(lambda text: text == value, original_texts)
        if len(duplicates) > 1:
            return _t(_("Display Value must be unique"))

        return True


validation.register(ResultOptionsTextValidator())


class RestrictedCategoriesValidator:
    """ Verifies that client Restricted categories include all categories
    required by service dependencies. """

    implements(IValidator)
    name = "restrictedcategoriesvalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        # fieldname = kwargs['field'].getName()
        # request = kwargs.get('REQUEST', {})
        # form = request.get('form', {})

        translate = getToolByName(instance, 'translation_service').translate
        bsc = getToolByName(instance, 'senaite_catalog_setup')
        # uc = getToolByName(instance, 'uid_catalog')

        failures = []

        for category in value:
            if not category:
                continue
            services = bsc(portal_type="AnalysisService", category_uid=category)
            for service in services:
                service = service.getObject()
                calc = service.getCalculation()
                deps = calc and calc.getDependentServices() or []
                for dep in deps:
                    if dep.getCategoryUID() not in value:
                        title = dep.getCategoryTitle()
                        if title not in failures:
                            failures.append(title)
        if failures:
            msg = _(
                "Validation failed: The selection requires the following "
                "categories to be selected: ${categories}",
                mapping={
                    'categories': safe_unicode(','.join(failures))
                })
            return to_utf8(translate(msg))

        return True


validation.register(RestrictedCategoriesValidator())


class PrePreservationValidator:
    """ Validate PrePreserved Containers.
        User must select a Preservation.
    """
    implements(IValidator)
    name = "container_prepreservation_validator"

    def __call__(self, value, *args, **kwargs):
        # If not prepreserved, no validation required.
        if not value:
            return True

        instance = kwargs['instance']
        # fieldname = kwargs['field'].getName()
        request = kwargs.get('REQUEST', {})
        form = request.form
        preservation = form.get('Preservation')

        if type(preservation) in (list, tuple):
            preservation = preservation[0]

        if preservation:
            return True

        translate = getToolByName(instance, 'translation_service').translate
        # bsc = getToolByName(instance, 'senaite_catalog_setup')

        if not preservation:
            msg = _("Validation failed: PrePreserved containers "
                    "must have a preservation selected.")
            return to_utf8(translate(msg))


validation.register(PrePreservationValidator())


class StandardIDValidator:
    r"""Matches against regular expression:
       [^A-Za-z\w\d\-\_]
    """

    implements(IValidator)
    name = "standard_id_validator"

    def __call__(self, value, *args, **kwargs):

        regex = r"[^A-Za-z\w\d\-\_]"

        instance = kwargs['instance']
        # fieldname = kwargs['field'].getName()
        # request = kwargs.get('REQUEST', {})
        # form = request.get('form', {})

        translate = getToolByName(instance, 'translation_service').translate

        # check the value against all AnalysisService keywords
        if re.findall(regex, value):
            msg = _("Validation failed: keyword contains invalid "
                    "characters")
            return to_utf8(translate(msg))

        return True


validation.register(StandardIDValidator())


def get_record_value(request, uid, keyword, default=None):
    """Returns the value for the keyword and uid from the request"""
    value = request.get(keyword)
    if not value:
        return default
    if not isinstance(value, list):
        return default
    return value[0].get(uid, default) or default


class AnalysisSpecificationsValidator:
    """Min value must be below max value
       Warn min value must be below min value or empty
       Warn max value must above max value or empty
       Percentage value must be between 0 and 100
       Values must be numbers
    """

    implements(IValidator)
    name = "analysisspecs_validator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs["instance"]
        request = kwargs.get("REQUEST") or {}
        fieldname = kwargs["field"].getName()

        # This value in request prevents running once per subfield value.
        # self.name returns the name of the validator. This allows other
        # subfield validators to be called if defined (eg. in other add-ons)
        key = "{}-{}-{}".format(self.name, instance.getId(), fieldname)
        if instance.REQUEST.get(key, False):
            return True

        # Walk through all AS UIDs and validate each parameter for that AS
        service_uids = request.get("uids", [])
        for uid in service_uids:
            err_msg = self.validate_service(request, uid)
            if not err_msg:
                continue

            # Validation failed
            service = api.get_object_by_uid(uid)
            title = api.get_title(service)

            err_msg = "{}: {}".format(title, _(err_msg))
            translate = api.get_tool("translation_service").translate
            instance.REQUEST[key] = to_utf8(translate(safe_unicode(err_msg)))
            return instance.REQUEST[key]

        instance.REQUEST[key] = True
        return True

    def validate_service(self, request, uid):
        """Validates the specs values from request for the service uid. Returns
        a non-translated message if the validation failed.
        """
        spec_min = get_record_value(request, uid, "min")
        spec_max = get_record_value(request, uid, "max")

        warn_min = get_record_value(request, uid, "warn_min")
        warn_max = get_record_value(request, uid, "warn_max")

        if not spec_min and not spec_max:
            # Neither min nor max values have been set, dismiss
            return None

        # Allow to have empty min/max borders, e.g. only max being set
        if spec_min and not api.is_floatable(spec_min):
            return _("'Min' value must be numeric")
        if spec_max and not api.is_floatable(spec_max):
            return _("'Max' value must be numeric")

        # Check if min is smaller than max range
        if spec_min and spec_max:
            if api.to_float(spec_min) > api.to_float(spec_max):
                return _("'Max' value must be above 'Min' value")

        # Handle warn min
        if warn_min and not api.is_floatable(warn_min):
            return _("'Warn Min' value must be numeric or empty")
        if warn_min and spec_min:
            if api.to_float(warn_min) > api.to_float(spec_min):
                return _("'Warn Min' value must be below 'Min' value")

        # Handle warn max
        if warn_max and not api.is_floatable(warn_max):
            return _("'Warn Max' value must be numeric or empty")
        if warn_max and spec_max:
            if api.to_float(warn_max) < api.to_float(spec_max):
                return _("'Warn Max' value must be above 'Max' value")

        return None


validation.register(AnalysisSpecificationsValidator())


class UncertaintiesValidator:
    """Uncertainties may be specified as numeric values or percentages.
    Min value must be below max value.
    Uncertainty must not be < 0.
    """

    implements(IValidator)
    name = "uncertainties_validator"

    def __call__(self, subf_value, *args, **kwargs):

        instance = kwargs['instance']
        request = kwargs.get('REQUEST', {})
        fieldname = kwargs['field'].getName()
        translate = getToolByName(instance, 'translation_service').translate

        # We run through the validator once per form submit, and check all
        # values
        # this value in request prevents running once per subfield value.
        key = instance.id + fieldname
        if instance.REQUEST.get(key, False):
            return True

        for i, value in enumerate(request[fieldname]):

            # Values must be numbers
            try:
                minv = float(value['intercept_min'])
            except ValueError:
                instance.REQUEST[key] = to_utf8(
                    translate(
                        _("Validation failed: Min values must be numeric")))
                return instance.REQUEST[key]
            try:
                maxv = float(value['intercept_max'])
            except ValueError:
                instance.REQUEST[key] = to_utf8(
                    translate(
                        _("Validation failed: Max values must be numeric")))
                return instance.REQUEST[key]

            # values may be percentages; the rest of the numeric validation must
            # still pass once the '%' is stripped off.
            err = value['errorvalue']
            perc = False
            if err.endswith('%'):
                perc = True
                err = err[:-1]
            try:
                err = float(err)
            except ValueError:
                instance.REQUEST[key] = to_utf8(
                    translate(
                        _("Validation failed: Error values must be numeric")))
                return instance.REQUEST[key]

            if perc and (err < 0 or err > 100):
                # Error percentage must be between 0 and 100
                instance.REQUEST[key] = to_utf8(
                    translate(
                        _("Validation failed: Error percentage must be between 0 "
                          "and 100")))
                return instance.REQUEST[key]

            # Min value must be < max
            if minv > maxv:
                instance.REQUEST[key] = to_utf8(
                    translate(
                        _("Validation failed: Max values must be greater than Min "
                          "values")))
                return instance.REQUEST[key]

            # Error values must be >-1
            if err < 0:
                instance.REQUEST[key] = to_utf8(
                    translate(
                        _("Validation failed: Error value must be 0 or greater"
                          )))
                return instance.REQUEST[key]

        instance.REQUEST[key] = True
        return True


validation.register(UncertaintiesValidator())


class DurationValidator:
    """Simple stuff - just checking for integer values.
    """

    implements(IValidator)
    name = "duration_validator"

    def __call__(self, value, *args, **kwargs):

        instance = kwargs['instance']
        request = kwargs.get('REQUEST') or {}
        fieldname = kwargs['field'].getName()
        translate = getToolByName(instance, 'translation_service').translate

        value = request.get(fieldname) or None
        if value:
            for v in value.values():
                try:
                    int(v)
                except Exception:
                    return to_utf8(
                        translate(_("Validation failed: Values must be numbers")))
        return True


validation.register(DurationValidator())


class PercentValidator:

    """ Floatable, >=0, <=100. """

    implements(IValidator)
    name = "percentvalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        # fieldname = kwargs['field'].getName()
        # request = kwargs.get('REQUEST', {})
        # form = request.get('form', {})

        translate = getToolByName(instance, 'translation_service').translate

        try:
            value = float(value)
        except Exception:
            msg = _("Validation failed: percent values must be numbers")
            return to_utf8(translate(msg))

        if value < 0 or value > 100:
            msg = _(
                "Validation failed: percent values must be between 0 and 100")
            return to_utf8(translate(msg))

        return True


validation.register(PercentValidator())


def _toIntList(numstr, acceptX=0):
    """
    Convert ans string to a list removing all invalid characters.
    Receive: a string as a number
    """
    res = []
    # Converting and removing invalid characters
    for i in numstr:
        if i in string.digits and i not in string.letters:
            res.append(int(i))

    # Converting control number into ISBN
    if acceptX and (numstr[-1] in 'Xx'):
        res.append(10)
    return res


def _sumLists(a, b):
    """
    Algorithm to check validity of NBI and NIF.
    Receives string with a umber to validate.
    """
    val = 0
    for i in map(lambda a, b: a * b, a, b):
        val += i
    return val


class NIBvalidator:
    """
    Validates if the introduced NIB is correct.
    """

    implements(IValidator)
    name = "NIBvalidator"

    def __call__(self, value, *args, **kwargs):
        """
        Check the NIB number
        value:: string with NIB.
        """
        instance = kwargs['instance']
        translate = getToolByName(instance, 'translation_service').translate
        LEN_NIB = 21
        table = (73, 17, 89, 38, 62, 45, 53, 15, 50, 5, 49, 34, 81, 76, 27, 90,
                 9, 30, 3)

        # convert to entire numbers list
        nib = _toIntList(value)

        # checking the length of the number
        if len(nib) != LEN_NIB:
            msg = _('Incorrect NIB number: %s' % value)
            return to_utf8(translate(msg))
        # last numbers algorithm validator
        return nib[-2] * 10 + nib[-1] == 98 - _sumLists(table, nib[:-2]) % 97


validation.register(NIBvalidator())


class IBANvalidator:
    """
    Validates if the introduced NIB is correct.
    """

    implements(IValidator)
    name = "IBANvalidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        translate = getToolByName(instance, 'translation_service').translate

        # remove spaces from formatted
        IBAN = ''.join(c for c in value if c.isalnum())

        IBAN = IBAN[4:] + IBAN[:4]
        country = IBAN[-4:-2]

        if country not in country_dic:
            msg = _('Unknown IBAN country %s' % country)
            return to_utf8(translate(msg))

        length_c, name_c = country_dic[country]

        if len(IBAN) != length_c:
            diff = len(IBAN) - length_c
            msg = _('Wrong IBAN length by %s: %s' %
                    (('short by %i' % -diff)
                     if diff < 0 else ('too long by %i' % diff), value))
            return to_utf8(translate(msg))
        # Validating procedure
        elif int("".join(str(letter_dic[x]) for x in IBAN)) % 97 != 1:
            msg = _('Incorrect IBAN number: %s' % value)
            return to_utf8(translate(msg))

        else:
            # Accepted:
            return True


validation.register(IBANvalidator())

# Utility to check the integrity of an IBAN bank account No.
# based on https://www.daniweb.com/software-development/python/code/382069
# /iban-number-check-refreshed
# Dictionaries - Refer to ISO 7064 mod 97-10
letter_dic = {
    "A": 10,
    "B": 11,
    "C": 12,
    "D": 13,
    "E": 14,
    "F": 15,
    "G": 16,
    "H": 17,
    "I": 18,
    "J": 19,
    "K": 20,
    "L": 21,
    "M": 22,
    "N": 23,
    "O": 24,
    "P": 25,
    "Q": 26,
    "R": 27,
    "S": 28,
    "T": 29,
    "U": 30,
    "V": 31,
    "W": 32,
    "X": 33,
    "Y": 34,
    "Z": 35,
    "0": 0,
    "1": 1,
    "2": 2,
    "3": 3,
    "4": 4,
    "5": 5,
    "6": 6,
    "7": 7,
    "8": 8,
    "9": 9
}

# ISO 3166-1 alpha-2 country code
country_dic = {
    "AL": [28, "Albania"],
    "AD": [24, "Andorra"],
    "AT": [20, "Austria"],
    "BE": [16, "Belgium"],
    "BA": [20, "Bosnia"],
    "BG": [22, "Bulgaria"],
    "HR": [21, "Croatia"],
    "CY": [28, "Cyprus"],
    "CZ": [24, "Czech Republic"],
    "DK": [18, "Denmark"],
    "EE": [20, "Estonia"],
    "FO": [18, "Faroe Islands"],
    "FI": [18, "Finland"],
    "FR": [27, "France"],
    "DE": [22, "Germany"],
    "GI": [23, "Gibraltar"],
    "GR": [27, "Greece"],
    "GL": [18, "Greenland"],
    "HU": [28, "Hungary"],
    "IS": [26, "Iceland"],
    "IE": [22, "Ireland"],
    "IL": [23, "Israel"],
    "IT": [27, "Italy"],
    "LV": [21, "Latvia"],
    "LI": [21, "Liechtenstein"],
    "LT": [20, "Lithuania"],
    "LU": [20, "Luxembourg"],
    "MK": [19, "Macedonia"],
    "MT": [31, "Malta"],
    "MU": [30, "Mauritius"],
    "MC": [27, "Monaco"],
    "ME": [22, "Montenegro"],
    "NL": [18, "Netherlands"],
    "NO": [15, "Northern Ireland"],
    "PO": [28, "Poland"],
    "PT": [25, "Portugal"],
    "RO": [24, "Romania"],
    "SM": [27, "San Marino"],
    "SA": [24, "Saudi Arabia"],
    "RS": [22, "Serbia"],
    "SK": [24, "Slovakia"],
    "SI": [19, "Slovenia"],
    "ES": [24, "Spain"],
    "SE": [24, "Sweden"],
    "CH": [21, "Switzerland"],
    "TR": [26, "Turkey"],
    "TN": [24, "Tunisia"],
    "GB": [22, "United Kingdom"]
}


class SortKeyValidator:

    """ Check for out of range values.
    """

    implements(IValidator)
    name = "SortKeyValidator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        translate = getToolByName(instance, 'translation_service').translate
        try:
            value = float(value)
        except Exception:
            msg = _("Validation failed: value must be float")
            return to_utf8(translate(msg))

        if value < 0 or value > 1000:
            msg = _("Validation failed: value must be between 0 and 1000")
            return to_utf8(translate(msg))

        return True


validation.register(SortKeyValidator())


class InlineFieldValidator:
    """ Inline Field Validator

    calls a field function for validation
    """

    implements(IValidator)
    name = "inline_field_validator"

    def __call__(self, value, *args, **kwargs):
        field = kwargs['field']
        request = kwargs['REQUEST']
        instance = kwargs['instance']

        # extract the request values
        data = request.get(field.getName())

        # check if the field contains a callable
        validator = getattr(field, self.name, None)

        # validator is a callable
        if callable(validator):
            return validator(instance, request, field, data)

        # validator is a string, check if the instance has a method with this name
        if type(validator) in types.StringTypes:
            instance_validator = getattr(instance, validator, None)
            if callable(instance_validator):
                return instance_validator(request, field, data)

        return True


validation.register(InlineFieldValidator())


class NoWhiteSpaceValidator:
    """ String, not containing space(s). """

    implements(IValidator)
    name = "no_white_space_validator"

    def __call__(self, value, *args, **kwargs):
        instance = kwargs['instance']
        translate = getToolByName(instance, 'translation_service').translate

        if value and " " in value:
            msg = _("Invalid value: Please enter a value without spaces.")
            return to_utf8(translate(msg))

        return True


validation.register(NoWhiteSpaceValidator())


class ImportValidator(object):
    """Checks if a dotted name can be imported or not
    """
    implements(IValidator)
    name = "importvalidator"

    def __call__(self, mod, **kwargs):

        # some needed tools
        instance = kwargs['instance']
        translate = getToolByName(instance, 'translation_service').translate

        try:
            # noinspection PyUnresolvedReferences
            import importlib
            importlib.import_module(mod)
        except ImportError:
            msg = _("Validation failed: Could not import module '%s'" % mod)
            return to_utf8(translate(msg))

        return True


validation.register(ImportValidator())


class DefaultResultValidator(object):
    """Validate AnalysisService's DefaultResult field value
    """
    implements(IValidator)
    name = "service_defaultresult_validator"

    def __call__(self, value, **kwargs):
        instance = kwargs['instance']
        request = kwargs.get('REQUEST', {})
        field_name = kwargs['field'].getName()
        translate = getToolByName(instance, 'translation_service').translate

        default_result = request.get(field_name, None)
        if default_result:
            # Default result must be one of the available result options
            options = request.get("ResultOptions", None)
            if options:
                values = map(lambda ro: ro.get("ResultValue"), options)
                if default_result not in values:
                    msg = _("Default result must be one of the following "
                            "result options: {}").format(", ".join(values))
                    return to_utf8(translate(msg))

            elif not request.get("StringResult"):
                # Default result must be numeric
                if not api.is_floatable(default_result):
                    msg = _("Default result is not numeric")
                    return to_utf8(translate(msg))

        return True


validation.register(DefaultResultValidator())


class ServiceConditionsValidator(object):
    """Validate AnalysisService Conditions field
    """
    implements(IValidator)
    name = "service_conditions_validator"

    def __call__(self, field_value, **kwargs):
        instance = kwargs["instance"]
        request = kwargs.get("REQUEST", {})
        translate = getToolByName(instance, "translation_service").translate
        field_name = kwargs["field"].getName()

        # This value in request prevents running once per subfield value.
        # self.name returns the name of the validator. This allows other
        # subfield validators to be called if defined (eg. in other add-ons)
        key = "{}-{}-{}".format(self.name, instance.getId(), field_name)
        if instance.REQUEST.get(key, False):
            return True

        # Walk through all records set for this records field
        field_name_value = "{}_value".format(field_name)
        records = request.get(field_name_value, [])
        for record in records:
            # Validate the record
            msg = self.validate_record(record)
            if msg:
                return to_utf8(translate(msg))

        instance.REQUEST[key] = True
        return True

    def validate_record(self, record):
        control_type = record.get("type")
        choices = record.get("choices")
        required = record.get("required") == "on"
        default = record.get("default")

        if control_type == "select":
            # choices is required, check if the value for subfield is ok
            if not choices:
                return _("Validation failed: value for Choices subfield is "
                         "required when the control type of choice is "
                         "'Select'")

            # Choices must follow the format  'choice 1|choice 2|choice 3'
            choices_arr = filter(None, choices.split('|'))
            if len(choices_arr) <= 1:
                return _("Validation failed: Please use the character '|' "
                         "to separate the available options in 'Choices' "
                         "subfield")
        elif control_type == "checkbox":
            # required checkboxes need a default value to be submitted
            if required and not default:
                return _("Validation failed: Please set a default value "
                         "when defining a required checkbox condition.")
        else:
            # choices should be left empty
            if choices:
                return _("Validation failed: value for Choices subfield is "
                         "only required for when the control type of choice "
                         "is 'Select'")

        # The type of the default value must match with the selected type
        default_value = record.get("default")
        if default_value:
            if control_type == "number":
                if not api.is_floatable(default_value):
                    return _("Validation failed: '{}' is not numeric").format(
                        default_value)


validation.register(ServiceConditionsValidator())

senaite / senaite.core

Push — 2.x ( 777ce6...78af08 )

AnalysisSpecificationsValidator.validate_service() F

Complexity

Size

Duplication

Importance

How to fix Complexity

Complexity

Duplication Side-by-Side

Filter issues like
