Async connect/disconnect. Moved everything to a new Async and Timeout which cleans...
[theonering] / src / aliasing.py
1 import logging
2
3 import telepathy
4
5 import tp
6 import util.misc as misc_utils
7 import handle
8
9
10 _moduleLogger = logging.getLogger('aliasing')
11
12
13 def _make_pretty_with_areacodde(phonenumber):
14         prettynumber = "(%s)" % (phonenumber[0:3], )
15         if 3 < len(phonenumber):
16                 prettynumber += " %s" % (phonenumber[3:6], )
17                 if 6 < len(phonenumber):
18                         prettynumber += "-%s" % (phonenumber[6:], )
19         return prettynumber
20
21
22 def _make_pretty_local(phonenumber):
23         prettynumber = "%s" % (phonenumber[0:3], )
24         if 3 < len(phonenumber):
25                 prettynumber += "-%s" % (phonenumber[3:], )
26         return prettynumber
27
28
29 def _make_pretty_international(phonenumber):
30         if phonenumber.startswith("0"):
31                 prettynumber = "+%s " % (phonenumber[0:3], )
32                 if 3 < len(phonenumber):
33                         prettynumber += _make_pretty_with_areacodde(phonenumber[3:])
34         if phonenumber.startswith("1"):
35                 prettynumber = "1 "
36                 prettynumber += _make_pretty_with_areacodde(phonenumber[1:])
37         return prettynumber
38
39
40 def make_pretty(phonenumber):
41         """
42         Function to take a phone number and return the pretty version
43         pretty numbers:
44                 if phonenumber begins with 0:
45                         ...-(...)-...-....
46                 if phonenumber begins with 1: ( for gizmo callback numbers )
47                         1 (...)-...-....
48                 if phonenumber is 13 digits:
49                         (...)-...-....
50                 if phonenumber is 10 digits:
51                         ...-....
52         >>> make_pretty("12")
53         '12'
54         >>> make_pretty("1234567")
55         '123-4567'
56         >>> make_pretty("2345678901")
57         '+1 (234) 567-8901'
58         >>> make_pretty("12345678901")
59         '+1 (234) 567-8901'
60         >>> make_pretty("01234567890")
61         '+012 (345) 678-90'
62         >>> make_pretty("+01234567890")
63         '+012 (345) 678-90'
64         >>> make_pretty("+12")
65         '+1 (2)'
66         >>> make_pretty("+123")
67         '+1 (23)'
68         >>> make_pretty("+1234")
69         '+1 (234)'
70         """
71         if phonenumber is None or phonenumber is "":
72                 return ""
73
74         phonenumber = misc_utils.normalize_number(phonenumber)
75
76         if phonenumber[0] == "+":
77                 prettynumber = _make_pretty_international(phonenumber[1:])
78                 if not prettynumber.startswith("+"):
79                         prettynumber = "+"+prettynumber
80         elif 8 < len(phonenumber) and phonenumber[0] in ("0", "1"):
81                 prettynumber = _make_pretty_international(phonenumber)
82         elif 7 < len(phonenumber):
83                 prettynumber = _make_pretty_with_areacodde(phonenumber)
84         elif 3 < len(phonenumber):
85                 prettynumber = _make_pretty_local(phonenumber)
86         else:
87                 prettynumber = phonenumber
88         return prettynumber.strip()
89
90
91 class AliasingMixin(tp.ConnectionInterfaceAliasing):
92
93         def __init__(self):
94                 tp.ConnectionInterfaceAliasing.__init__(self)
95
96         @property
97         def session(self):
98                 """
99                 @abstract
100                 """
101                 raise NotImplementedError("Abstract property called")
102
103         @property
104         def callbackNumberParameter(self):
105                 """
106                 @abstract
107                 """
108                 raise NotImplementedError("Abstract property called")
109
110         def get_handle_by_id(self, handleType, handleId):
111                 """
112                 @abstract
113                 """
114                 raise NotImplementedError("Abstract function called")
115
116         @misc_utils.log_exception(_moduleLogger)
117         def GetAliasFlags(self):
118                 return 0
119
120         @misc_utils.log_exception(_moduleLogger)
121         def RequestAliases(self, contactHandleIds):
122                 _moduleLogger.debug("Called RequestAliases")
123                 return [self._get_alias(handleId) for handleId in contactHandleIds]
124
125         @misc_utils.log_exception(_moduleLogger)
126         def GetAliases(self, contactHandleIds):
127                 _moduleLogger.debug("Called GetAliases")
128
129                 idToAlias = dict(
130                         (handleId, self._get_alias(handleId))
131                         for handleId in contactHandleIds
132                 )
133                 return idToAlias
134
135         @misc_utils.log_exception(_moduleLogger)
136         def SetAliases(self, aliases):
137                 _moduleLogger.debug("Called SetAliases")
138                 # first validate that no other handle types are included
139                 for handleId, alias in aliases.iteritems():
140                         h = self.get_handle_by_id(telepathy.HANDLE_TYPE_CONTACT, handleId)
141                         if isinstance(h, handle.ConnectionHandle):
142                                 break
143                 else:
144                         raise telepathy.errors.PermissionDenied("No user customizable aliases")
145
146                 uglyNumber = misc_utils.normalize_number(alias)
147                 if len(uglyNumber) == 0:
148                         # Reset to the original from login if one was provided
149                         uglyNumber = self.callbackNumberParameter
150                 if not misc_utils.is_valid_number(uglyNumber):
151                         raise telepathy.errors.InvalidArgument("Invalid phone number %r" % (uglyNumber, ))
152
153                 # Update callback
154                 self.session.backend.set_callback_number(uglyNumber)
155
156                 # Inform of change
157                 userAlias = make_pretty(uglyNumber)
158                 changedAliases = ((handleId, userAlias), )
159                 self.AliasesChanged(changedAliases)
160
161         def _get_alias(self, handleId):
162                 h = self.get_handle_by_id(telepathy.HANDLE_TYPE_CONTACT, handleId)
163                 if isinstance(h, handle.ConnectionHandle):
164                         aliasNumber = self.session.backend.get_callback_number()
165                         userAlias = make_pretty(aliasNumber)
166                         return userAlias
167                 else:
168                         number = h.phoneNumber
169                         try:
170                                 contactAlias = self.session.addressbook.get_contact_name(number)
171                         except KeyError:
172                                 contactAlias = make_pretty(number)
173                         return contactAlias