~nherriot/bcm/tags

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# -*- coding: utf-8 -*-
# Copyright (C) 2008-2009  Warp Networks, S.L.
# Author:  Pablo Martí
#
# This program 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; either version 2 of the License, or
# (at your option) any later version.
#
# 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.
"""Contact related classes and utilities"""

from zope.interface import implements

from wader.common.encoding import to_u
from wader.common.interfaces import IContact


class Contact(object):
    """I am a Contact on Wader"""

    implements(IContact)

    def __init__(self, name, number, index=None):
        super(Contact, self).__init__()
        self.name = to_u(name)
        self.number = to_u(number)
        self.index = index

    def __repr__(self):
        if not self.index:
            return '<Contact name=%s number=%s>' % (self.name, self.number)

        args = (self.name, self.number, self.index)
        return '<Contact name=%s number=%s index=%d>' % args

    __str__ = __repr__

    def __eq__(self, c):
        if self.index and c.index:
            return self.index == c.index

        return self.name == c.name and self.number == c.number

    def __ne__(self, c):
        return not self.__eq__(c)

    def to_csv(self):
        """See :meth:`wader.common.interfaces.IContact.to_csv`"""
        name = '"%s"' % self.name
        number = '"%s"' % self.number
        return [name, number]


class ContactStore(object):
    """
    I am a contact store

    A central point to perform operations on the different contact
    backends (see :class:`~wader.common.interfaces.IContactProvider`)
    """

    def __init__(self):
        super(ContactStore, self).__init__()
        self._providers = []

    def add_provider(self, provider):
        """Adds ``provider`` to the list of registered providers"""
        self._providers.append(provider)

    def remove_provider(self, provider):
        """Removes ``provider`` to the list of registered providers"""
        self._providers.remove(provider)

    def close(self):
        """Frees resources"""
        while self._providers:
            provider = self._providers.pop()
            provider.close()

    def _call_method(self, name, *args):
        """
        Executes method ``name`` using ``args`` in all the registered providers
        """
        ret = []
        for prov in self._providers:
            result = getattr(prov, name)(*args)
            if isinstance(result, list):
                ret.extend(getattr(prov, name)(*args))
            else:
                ret.append(result)
        return ret

    def add_contact(self, data):
        """:meth:`~wader.common.interfaces.IContactProvider.add_contact`"""
        return self._call_method('add_contact', data)[0]

    def edit_contact(self, data):
        """:meth:`~wader.common.interfaces.IContactProvider.edit_contact`"""
        return self._call_method('edit_contact', data)[0]

    def find_contacts_by_name(self, name):
        """
        :meth:`~wader.common.interfaces.IContactProvider.find_contacts_by_name`
        """
        return self._call_method('find_contacts_by_name', name)

    def find_contacts_by_number(self, number):
        """
        see `IContactProvider.find_contacts_by_number`
        """
        # first try a full match, if succeeds return result
        # otherwise try to remove 3 chars and if succeeds return result
        # i.e. match '723123112' instead of '+44723123112' (UK, ES)
        # otherwise try to remove 4 chars and if succeeds return result
        # i.e. match '821372121' instead of '+353821372121' (IE)
        # otherwise we failed
        for n in [0, 3, 4]:
            # finding out if a generator returns None is a bit cumbersome
            # so we just consume the generator and create a list
            match = list(self._find_contacts_by_number(number[n:]))
            if match:
                return match

        return []

    def _find_contacts_by_number(self, number):
        return self._call_method('find_contacts_by_number', number)

    def list_contacts(self):
        """:meth:`~wader.common.interfaces.IContactProvider.list_contacts`"""
        return self._call_method('list_contacts')

    def remove_contact(self, contact):
        """:meth:`~wader.common.interfaces.IContactProvider.remove_contact`"""
        self._call_method('remove_contact', contact)