senaite.core.content.clientcontact.ClientContact.Title() - Code Metrics - Inspection of "AT2DX: Contact to ClientContact" - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.x (#1958)

by Jordi

created 2022-04-16 08:18 UTC

ClientContact.Title() A

↳ Parent: senaite.core.content.clientcontact

Complexity

Conditions

Size

Total Lines	3
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nop	1

# -*- 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-2022 by it's authors.
# Some rights reserved, see README and LICENSE.

import re

from AccessControl import ClassSecurityInfo
from bika.lims import api
from bika.lims import senaiteMessageFactory as _
from bika.lims.api.mail import is_valid_email_address
from bika.lims.interfaces import IClient
from bika.lims.interfaces import IDeactivable
from plone.autoform import directives
from plone.dexterity.content import Container
from plone.supermodel import model
from Products.CMFCore import permissions
from senaite.core.interfaces import IClientContact
from senaite.core.schema import AddressField
from senaite.core.schema import UIDReferenceField
from senaite.core.schema.addressfield import PHYSICAL_ADDRESS
from senaite.core.schema.addressfield import POSTAL_ADDRESS
from senaite.core.z3cform.widgets.uidreference import UIDReferenceWidgetFactory
from six import string_types
from zope import schema
from zope.interface import implementer
from zope.interface import Invalid
from zope.interface import invariant


def is_valid_phone(phone):
    """Returns whether the given phone is valid or not
    """
    # XXX Better validate with phonenumbers library here?
    # https://pypi.org/project/phonenumbers/
    phone = phone.strip()
    match = re.match(r"^[+(]?\d+(?:[- )(]+\d+)+$", phone)
    if not match:
        return False
    return True


class IClientContactSchema(model.Schema):
    """Client's Contact Schema interface
    """

    salutation = schema.TextLine(
        title=_(u"Salutation"),
        description=_(
            u"Greeting title eg. Mr, Mrs, Dr"
        ),
        required=False,
    )

    firstname = schema.TextLine(
        title=_(u"Firstname"),
        required=True,
    )

    lastname = schema.TextLine(
        title=_(u"Lastname"),
        required=True,
    )

    directives.omitted("username")
    username = schema.TextLine(
        title=_(u"Username"),
        required=False,
    )

    email = schema.TextLine(
        title=_(u"Email"),
        required=False,
    )

    business_phone = schema.TextLine(
        title=_(u"Phone (business)"),
        required=False,
    )

    mobile_phone = schema.TextLine(
        title=_(u"Phone (mobile)"),
        required=False,
    )

    home_phone = schema.TextLine(
        title=_(u"Phone (home)"),
        required=False,
    )

    job_title = schema.TextLine(
        title=_(u"Job title"),
        required=False,
    )

    department = schema.TextLine(
        title=_(u"Department"),
        required=False,
    )

    address = AddressField(
        title=_(u"Address"),
        address_types=[
            PHYSICAL_ADDRESS,
            POSTAL_ADDRESS,
        ]
    )

    cc_contacts = UIDReferenceField(
        title=_(u"Contacts to CC"),
        description=_(
            u"Contacts that will receive a copy of the notification emails "
            u"sent to this contact. Only contacts from same client are allowed"
        ),
        allowed_types=("ClientContact", ),
        multi_valued=True,
        required=False,
    )

    directives.widget(
        "cc_contacts",
        UIDReferenceWidgetFactory,
        catalog="portal_catalog",
        query="get_cc_contacts_query",
        display_template="<a href='${url}'>${title}</a>",
        columns=[
            {
                "name": "title",
                "width": "30",
                "align": "left",
                "label": _(u"Title"),
            }, {
                "name": "description",
                "width": "70",
                "align": "left",
                "label": _(u"Description"),
            },
        ],
        limit=15,

    )

    # Notification preferences fieldset
    model.fieldset(
        "notification_preferences",
        label=_(u"Notification preferences"),
        fields=["cc_contacts",]
    )

    @invariant
    def validate_email(self):
        """Checks if the email is correct
        """
        email = self.email
        if not email:
            return

        email = email.strip()
        if not is_valid_email_address(email):
            raise Invalid(_("Email is not valid"))

    def validate_phone(self, field_name):
        phone = getattr(self, field_name)
        if not phone:
            return

        if not is_valid_phone(phone):
            raise Invalid(_("Phone is not valid"))

    @invariant
    def validate_business_phone(self):
        """Checks if the business phone is correct
        """
        self.validate_phone("business_phone")

    @invariant
    def validate_home_phone(self):
        """Checks if the home phone is correct
        """
        self.validate_phone("home_phone")

    @invariant
    def validate_mobile_phone(self):
        """Checks if the mobile phone is correct
        """
        self.validate_phone("mobile_phone")


@implementer(IClientContact, IClientContactSchema, IDeactivable)
class ClientContact(Container):
    """Client Contact type
    """
    # Catalogs where this type will be catalogued
    _catalogs = ["portal_catalog"]

    security = ClassSecurityInfo()

    @security.private
    def accessor(self, fieldname):
        """Return the field accessor for the fieldname
        """
        schema = api.get_schema(self)
        if fieldname not in schema:
            return None
        return schema[fieldname].get

    @security.private
    def mutator(self, fieldname):
        """Return the field mutator for the fieldname
        """
        schema = api.get_schema(self)
        if fieldname not in schema:
            return None
        return schema[fieldname].set

    @security.protected(permissions.View)
    def Title(self):
        return self.getFullname()

    @security.private
    def set_string_value(self, field_name, value, validator=None):
        if not isinstance(value, string_types):
            value = u""

        value = value.strip()
        if validator:
            validator(value)

        mutator = self.mutator(field_name)
        mutator(self, api.safe_unicode(value))

    @security.private
    def get_string_value(self, field_name, default=""):
        accessor = self.accessor(field_name)
        value = accessor(self) or default
        return value.encode("utf-8")

    @security.protected(permissions.ModifyPortalContent)
    def setSalutation(self, value):
        self.set_string_value("salutation", value)

    @security.protected(permissions.View)
    def getSalutation(self):
        return self.get_string_value("salutation")

    @security.protected(permissions.ModifyPortalContent)
    def setFirstname(self, value):
        self.set_string_value("firstname", value)

    @security.protected(permissions.View)
    def getFirstname(self):
        return self.get_string_value("firstname")

    @security.protected(permissions.ModifyPortalContent)
    def setLastname(self, value):
        self.set_string_value("lastname", value)

    @security.protected(permissions.View)
    def getLastname(self):
        return self.get_string_value("lastname")

    @security.protected(permissions.ModifyPortalContent)
    def setUsername(self, value):
        self.set_string_value("username", value)

    @security.protected(permissions.View)
    def getUsername(self):
        return self.get_string_value("username")

    @security.protected(permissions.ModifyPortalContent)
    def setEmail(self, value):
        def validate_email(email):
            if email and not is_valid_email_address(email):
                raise ValueError("Email is not valid")

        self.set_string_value("email", value, validator=validate_email)

    @security.protected(permissions.View)
    def getEmail(self):
        return self.get_string_value("email")

    @security.protected(permissions.ModifyPortalContent)
    def setBusinessPhone(self, value):
        def validate_phone(phone):
            if phone and not is_valid_phone(phone):
                raise ValueError("Phone is not valid")

        self.set_string_value("business_phone", value, validator=validate_phone)

    @security.protected(permissions.View)
    def getBusinessPhone(self):
        return self.get_string_value("business_phone")

    @security.protected(permissions.ModifyPortalContent)
    def setMobilePhone(self, value):
        def validate_phone(phone):
            if phone and not is_valid_phone(phone):
                raise ValueError("Phone is not valid")

        self.set_string_value("mobile_phone", value, validator=validate_phone)

    @security.protected(permissions.View)
    def getMobilePhone(self):
        return self.get_string_value("mobile_phone")

    @security.protected(permissions.ModifyPortalContent)
    def setHomePhone(self, value):
        def validate_phone(phone):
            if phone and not is_valid_phone(phone):
                raise ValueError("Phone is not valid")

        self.set_string_value("home_phone", value, validator=validate_phone)

    @security.protected(permissions.View)
    def getHomePhone(self):
        return self.get_string_value("home_phone")

    @security.protected(permissions.ModifyPortalContent)
    def setJobTitle(self, value):
        self.set_string_value("job_title", value)

    @security.protected(permissions.View)
    def getJobTitle(self):
        return self.get_string_value("job_title")

    @security.protected(permissions.ModifyPortalContent)
    def setDepartment(self, value):
        self.set_string_value("department", value)

    @security.protected(permissions.View)
    def getDepartment(self):
        return self.get_string_value("department")

    @security.protected(permissions.ModifyPortalContent)
    def setAddress(self, value):
        mutator = self.mutator("address")
        mutator(self, value)

    @security.protected(permissions.View)
    def getAddress(self):
        accessor = self.accessor("address")
        return accessor(self)

    @security.protected(permissions.ModifyPortalContent)
    def setCCContacts(self, value):
        mutator = self.mutator("cc_contacts")
        mutator(self, value)

    @security.protected(permissions.View)
    def getCCContacts(self, as_objects=False):
        accessor = self.accessor("cc_contacts")
        uids = accessor(self, as_objects=as_objects) or []
        return [uid.encode("utf.8") for uid in uids]

    @security.protected(permissions.View)
    def getFullname(self):
        """Returns the fullname of this Client Contact
        """
        full = filter(None, [self.getFirstname(), self.getLastname()])
        return " ".join(full)

    @security.protected(permissions.View)
    def getClient(self):
        """Returns the client this Client Contact belongs to
        """
        obj = api.get_parent(self)
        if IClient.providedBy(obj):
            return obj
        return None

    @security.private
    def get_cc_contacts_query(self):
        """Returns the default query for the cc_contacts field. Only contacts
        from same client as the current one are displayed, if client set
        """
        query = {
            "portal_type": "ClientContact",
            "is_active": True,
            "sort_on": "title",
            "sort_order": "ascending",
        }
        client = self.getClient()
        if client:
            query.update({
                "path": {
                    "query": api.get_path(client),
                    "level": 0
                }
            })

        return query


1			# -- coding: utf-8 --
2			#
3			# This file is part of SENAITE.CORE.
4			#
5			# SENAITE.CORE is free software: you can redistribute it and/or modify it under
6			# the terms of the GNU General Public License as published by the Free Software
7			# Foundation, version 2.
8			#
9			# This program is distributed in the hope that it will be useful, but WITHOUT
10			# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11			# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12			# details.
13			#
14			# You should have received a copy of the GNU General Public License along with
15			# this program; if not, write to the Free Software Foundation, Inc., 51
16			# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17			#
18			# Copyright 2018-2022 by it's authors.
19			# Some rights reserved, see README and LICENSE.
20
21			import re
22
23			from AccessControl import ClassSecurityInfo
24			from bika.lims import api
25			from bika.lims import senaiteMessageFactory as _
26			from bika.lims.api.mail import is_valid_email_address
27			from bika.lims.interfaces import IClient
28			from bika.lims.interfaces import IDeactivable
29			from plone.autoform import directives
30			from plone.dexterity.content import Container
31			from plone.supermodel import model
32			from Products.CMFCore import permissions
33			from senaite.core.interfaces import IClientContact
34			from senaite.core.schema import AddressField
35			from senaite.core.schema import UIDReferenceField
36			from senaite.core.schema.addressfield import PHYSICAL_ADDRESS
37			from senaite.core.schema.addressfield import POSTAL_ADDRESS
38			from senaite.core.z3cform.widgets.uidreference import UIDReferenceWidgetFactory
39			from six import string_types
40			from zope import schema
41			from zope.interface import implementer
42			from zope.interface import Invalid
43			from zope.interface import invariant
44
45
46			def is_valid_phone(phone):
47			"""Returns whether the given phone is valid or not
48			"""
49			# XXX Better validate with phonenumbers library here?
50			# https://pypi.org/project/phonenumbers/
51			phone = phone.strip()
52			match = re.match(r"^[+(]?\d+(?:[- )(]+\d+)+$", phone)
53			if not match:
54			return False
55			return True
56
57
58			class IClientContactSchema(model.Schema):
59			"""Client's Contact Schema interface
60			"""
61
62			salutation = schema.TextLine(
63			title=_(u"Salutation"),
64			description=_(
65			u"Greeting title eg. Mr, Mrs, Dr"
66			),
67			required=False,
68			)
69
70			firstname = schema.TextLine(
71			title=_(u"Firstname"),
72			required=True,
73			)
74
75			lastname = schema.TextLine(
76			title=_(u"Lastname"),
77			required=True,
78			)
79
80			directives.omitted("username")
81			username = schema.TextLine(
82			title=_(u"Username"),
83			required=False,
84			)
85
86			email = schema.TextLine(
87			title=_(u"Email"),
88			required=False,
89			)
90
91			business_phone = schema.TextLine(
92			title=_(u"Phone (business)"),
93			required=False,
94			)
95
96			mobile_phone = schema.TextLine(
97			title=_(u"Phone (mobile)"),
98			required=False,
99			)
100
101			home_phone = schema.TextLine(
102			title=_(u"Phone (home)"),
103			required=False,
104			)
105
106			job_title = schema.TextLine(
107			title=_(u"Job title"),
108			required=False,
109			)
110
111			department = schema.TextLine(
112			title=_(u"Department"),
113			required=False,
114			)
115
116			address = AddressField(
117			title=_(u"Address"),
118			address_types=[
119			PHYSICAL_ADDRESS,
120			POSTAL_ADDRESS,
121			]
122			)
123
124			cc_contacts = UIDReferenceField(
125			title=_(u"Contacts to CC"),
126			description=_(
127			u"Contacts that will receive a copy of the notification emails "
128			u"sent to this contact. Only contacts from same client are allowed"
129			),
130			allowed_types=("ClientContact", ),
131			multi_valued=True,
132			required=False,
133			)
134
135			directives.widget(
136			"cc_contacts",
137			UIDReferenceWidgetFactory,
138			catalog="portal_catalog",
139			query="get_cc_contacts_query",
140			display_template="<a href='${url}'>${title}</a>",
141			columns=[
142			{
143			"name": "title",
144			"width": "30",
145			"align": "left",
146			"label": _(u"Title"),
147			}, {
148			"name": "description",
149			"width": "70",
150			"align": "left",
151			"label": _(u"Description"),
152			},
153			],
154			limit=15,
155
156			)
157
158			# Notification preferences fieldset
159			model.fieldset(
160			"notification_preferences",
161			label=_(u"Notification preferences"),
162			fields=["cc_contacts",]
163			)
164
165			@invariant
166			def validate_email(self):
167			"""Checks if the email is correct
168			"""
169			email = self.email
170			if not email:
171			return
172
173			email = email.strip()
174			if not is_valid_email_address(email):
175			raise Invalid(_("Email is not valid"))
176
177			def validate_phone(self, field_name):
178			phone = getattr(self, field_name)
179			if not phone:
180			return
181
182			if not is_valid_phone(phone):
183			raise Invalid(_("Phone is not valid"))
184
185			@invariant
186			def validate_business_phone(self):
187			"""Checks if the business phone is correct
188			"""
189			self.validate_phone("business_phone")
190
191			@invariant
192			def validate_home_phone(self):
193			"""Checks if the home phone is correct
194			"""
195			self.validate_phone("home_phone")
196
197			@invariant
198			def validate_mobile_phone(self):
199			"""Checks if the mobile phone is correct
200			"""
201			self.validate_phone("mobile_phone")
202
203
204			@implementer(IClientContact, IClientContactSchema, IDeactivable)
205			class ClientContact(Container):
206			"""Client Contact type
207			"""
208			# Catalogs where this type will be catalogued
209			_catalogs = ["portal_catalog"]
210
211			security = ClassSecurityInfo()
212
213			@security.private
214			def accessor(self, fieldname):
215			"""Return the field accessor for the fieldname
216			"""
217			schema = api.get_schema(self)
218			if fieldname not in schema:
219			return None
220			return schema[fieldname].get
221
222			@security.private
223			def mutator(self, fieldname):
224			"""Return the field mutator for the fieldname
225			"""
226			schema = api.get_schema(self)
227			if fieldname not in schema:
228			return None
229			return schema[fieldname].set
230
231			@security.protected(permissions.View)
232			def Title(self):
233			return self.getFullname()
234
235			@security.private
236			def set_string_value(self, field_name, value, validator=None):
237			if not isinstance(value, string_types):
238			value = u""
239
240			value = value.strip()
241			if validator:
242			validator(value)
243
244			mutator = self.mutator(field_name)
245			mutator(self, api.safe_unicode(value))
246
247			@security.private
248			def get_string_value(self, field_name, default=""):
249			accessor = self.accessor(field_name)
250			value = accessor(self) or default
251			return value.encode("utf-8")
252
253			@security.protected(permissions.ModifyPortalContent)
254			def setSalutation(self, value):
255			self.set_string_value("salutation", value)
256
257			@security.protected(permissions.View)
258			def getSalutation(self):
259			return self.get_string_value("salutation")
260
261			@security.protected(permissions.ModifyPortalContent)
262			def setFirstname(self, value):
263			self.set_string_value("firstname", value)
264
265			@security.protected(permissions.View)
266			def getFirstname(self):
267			return self.get_string_value("firstname")
268
269			@security.protected(permissions.ModifyPortalContent)
270			def setLastname(self, value):
271			self.set_string_value("lastname", value)
272
273			@security.protected(permissions.View)
274			def getLastname(self):
275			return self.get_string_value("lastname")
276
277			@security.protected(permissions.ModifyPortalContent)
278			def setUsername(self, value):
279			self.set_string_value("username", value)
280
281			@security.protected(permissions.View)
282			def getUsername(self):
283			return self.get_string_value("username")
284
285			@security.protected(permissions.ModifyPortalContent)
286			def setEmail(self, value):
287			def validate_email(email):
288			if email and not is_valid_email_address(email):
289			raise ValueError("Email is not valid")
290
291			self.set_string_value("email", value, validator=validate_email)
292
293			@security.protected(permissions.View)
294			def getEmail(self):
295			return self.get_string_value("email")
296
297			@security.protected(permissions.ModifyPortalContent)
298			def setBusinessPhone(self, value):
299			def validate_phone(phone):
300			if phone and not is_valid_phone(phone):
301			raise ValueError("Phone is not valid")
302
303			self.set_string_value("business_phone", value, validator=validate_phone)
304
305			@security.protected(permissions.View)
306			def getBusinessPhone(self):
307			return self.get_string_value("business_phone")
308
309			@security.protected(permissions.ModifyPortalContent)
310			def setMobilePhone(self, value):
311			def validate_phone(phone):
312			if phone and not is_valid_phone(phone):
313			raise ValueError("Phone is not valid")
314
315			self.set_string_value("mobile_phone", value, validator=validate_phone)
316
317			@security.protected(permissions.View)
318			def getMobilePhone(self):
319			return self.get_string_value("mobile_phone")
320
321			@security.protected(permissions.ModifyPortalContent)
322			def setHomePhone(self, value):
323			def validate_phone(phone):
324			if phone and not is_valid_phone(phone):
325			raise ValueError("Phone is not valid")
326
327			self.set_string_value("home_phone", value, validator=validate_phone)
328
329			@security.protected(permissions.View)
330			def getHomePhone(self):
331			return self.get_string_value("home_phone")
332
333			@security.protected(permissions.ModifyPortalContent)
334			def setJobTitle(self, value):
335			self.set_string_value("job_title", value)
336
337			@security.protected(permissions.View)
338			def getJobTitle(self):
339			return self.get_string_value("job_title")
340
341			@security.protected(permissions.ModifyPortalContent)
342			def setDepartment(self, value):
343			self.set_string_value("department", value)
344
345			@security.protected(permissions.View)
346			def getDepartment(self):
347			return self.get_string_value("department")
348
349			@security.protected(permissions.ModifyPortalContent)
350			def setAddress(self, value):
351			mutator = self.mutator("address")
352			mutator(self, value)
353
354			@security.protected(permissions.View)
355			def getAddress(self):
356			accessor = self.accessor("address")
357			return accessor(self)
358
359			@security.protected(permissions.ModifyPortalContent)
360			def setCCContacts(self, value):
361			mutator = self.mutator("cc_contacts")
362			mutator(self, value)
363
364			@security.protected(permissions.View)
365			def getCCContacts(self, as_objects=False):
366			accessor = self.accessor("cc_contacts")
367			uids = accessor(self, as_objects=as_objects) or []
368			return [uid.encode("utf.8") for uid in uids]
369
370			@security.protected(permissions.View)
371			def getFullname(self):
372			"""Returns the fullname of this Client Contact
373			"""
374			full = filter(None, [self.getFirstname(), self.getLastname()])
375			return " ".join(full)
376
377			@security.protected(permissions.View)
378			def getClient(self):
379			"""Returns the client this Client Contact belongs to
380			"""
381			obj = api.get_parent(self)
382			if IClient.providedBy(obj):
383			return obj
384			return None
385
386			@security.private
387			def get_cc_contacts_query(self):
388			"""Returns the default query for the cc_contacts field. Only contacts
389			from same client as the current one are displayed, if client set
390			"""
391			query = {
392			"portal_type": "ClientContact",
393			"is_active": True,
394			"sort_on": "title",
395			"sort_order": "ascending",
396			}
397			client = self.getClient()
398			if client:
399			query.update({
400			"path": {
401			"query": api.get_path(client),
402			"level": 0
403			}
404			})
405
406			return query
407

senaite / senaite.core

Pull Request — 2.x (#1958)

ClientContact.Title() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like