3 # DialCentral - Front end for Google's Grand Central service.
4 # Copyright (C) 2008 Eric Warnke ericew AT gmail DOT com
6 # This library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License, or (at your option) any later version.
11 # This library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with this library; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 Grandcentral backend code
33 from browser_emu import MozillaEmulator
36 class GCDialer(object):
38 This class encapsulates all of the knowledge necessary to interace with the grandcentral servers
39 the functions include login, setting up a callback number, and initalting a callback
42 _gcDialingStrRe = re.compile("This may take a few seconds", re.M)
43 _accessTokenRe = re.compile(r"""<input type="hidden" name="a_t" [^>]*value="(.*)"/>""")
44 _isLoginPageRe = re.compile(r"""<form method="post" action="https://www.grandcentral.com/mobile/account/login">""")
45 _callbackRe = re.compile(r"""name="default_number" value="(\d+)" />\s+(.*)\s$""", re.M)
46 _accountNumRe = re.compile(r"""<img src="/images/mobile/inbox_logo.gif" alt="GrandCentral" />\s*(.{14})\s* """, re.M)
47 _inboxRe = re.compile(r"""<td>.*?(voicemail|received|missed|call return).*?</td>\s+<td>\s+<font size="2">\s+(.*?)\s+ \| \s+<a href="/mobile/contacts/.*?">(.*?)\s?</a>\s+<br/>\s+(.*?)\s?<a href=""", re.S)
48 _contactsRe = re.compile(r"""<a href="/mobile/contacts/detail/(\d+)">(.*?)</a>""", re.S)
49 _contactsNextRe = re.compile(r""".*<a href="/mobile/contacts(\?page=\d+)">Next</a>""", re.S)
50 _contactDetailPhoneRe = re.compile(r"""(\w+):[0-9\-\(\) \t]*?<a href="/mobile/calls/click_to_call\?destno=(\d+).*?">call</a>""", re.S)
52 _validateRe = re.compile("^[0-9]{10,}$")
54 _forwardselectURL = "http://www.grandcentral.com/mobile/settings/forwarding_select"
55 _loginURL = "https://www.grandcentral.com/mobile/account/login"
56 _setforwardURL = "http://www.grandcentral.com/mobile/settings/set_forwarding?from=settings"
57 _clicktocallURL = "http://www.grandcentral.com/mobile/calls/click_to_call?a_t=%s&destno=%s"
58 _inboxallURL = "http://www.grandcentral.com/mobile/messages/inbox?types=all"
59 _contactsURL = "http://www.grandcentral.com/mobile/contacts"
60 _contactDetailURL = "http://www.grandcentral.com/mobile/contacts/detail"
62 def __init__(self, cookieFile = None):
63 # Important items in this function are the setup of the browser emulation and cookie file
64 self._browser = MozillaEmulator(None, 0)
65 if cookieFile is None:
66 cookieFile = os.path.join(os.path.expanduser("~"), ".gc_cookies.txt")
67 self._browser.cookies.filename = cookieFile
68 if os.path.isfile(cookieFile):
69 self._browser.cookies.load()
71 self._accessToken = None
72 self._accountNum = None
73 self._callbackNumbers = {}
74 self._lastAuthed = 0.0
76 self.__contacts = None
78 def is_authed(self, force = False):
80 Attempts to detect a current session and pull the auth token ( a_t ) from the page.
81 @note Once logged in try not to reauth more than once a minute.
82 @returns If authenticated
85 if (time.time() - self._lastAuthed) < 60 and not force:
89 forwardSelectionPage = self._browser.download(self._forwardselectURL)
90 except urllib2.URLError, e:
91 warnings.warn(traceback.format_exc())
92 raise RuntimeError("%s is not accesible" % self._forwardselectURL)
94 self._browser.cookies.save()
95 if self._isLoginPageRe.search(forwardSelectionPage) is not None:
98 self._grab_token(forwardSelectionPage)
99 self._lastAuthed = time.time()
102 def login(self, username, password):
104 Attempt to login to grandcentral
105 @returns Whether login was successful or not
110 loginPostData = urllib.urlencode( {'username' : username , 'password' : password } )
113 loginSuccessOrFailurePage = self._browser.download(self._loginURL, loginPostData)
114 except urllib2.URLError, e:
115 warnings.warn(traceback.format_exc())
116 raise RuntimeError("%s is not accesible" % self._loginURL)
118 return self.is_authed()
121 self._lastAuthed = 0.0
122 self._browser.cookies.clear()
123 self._browser.cookies.save()
127 def dial(self, number):
129 This is the main function responsible for initating the callback
131 if not self.is_valid_syntax(number):
132 raise ValueError('Number is not valid: "%s"' % number)
133 elif not self.is_authed():
134 raise RuntimeError("Not Authenticated")
136 if len(number) == 11 and number[0] == 1:
137 # Strip leading 1 from 11 digit dialing
141 callSuccessPage = self._browser.download(
142 self._clicktocallURL % (self._accessToken, number),
144 {'Referer' : 'http://www.grandcentral.com/mobile/messages'}
146 except urllib2.URLError, e:
147 warnings.warn(traceback.format_exc())
148 raise RuntimeError("%s is not accesible" % self._clicktocallURL)
150 if self._gcDialingStrRe.search(callSuccessPage) is None:
151 raise RuntimeError("Grand Central returned an error")
155 def clear_caches(self):
156 self.__contacts = None
158 def is_valid_syntax(self, number):
160 @returns If This number be called ( syntax validation only )
162 return self._validateRe.match(number) is not None
164 def get_account_number(self):
166 @returns The grand central phone number
168 return self._accountNum
170 def set_sane_callback(self):
172 Try to set a sane default callback number on these preferences
173 1) 1747 numbers ( Gizmo )
174 2) anything with gizmo in the name
175 3) anything with computer in the name
178 numbers = self.get_callback_numbers()
180 for number, description in numbers.iteritems():
181 if re.compile(r"""1747""").match(number) is not None:
182 self.set_callback_number(number)
185 for number, description in numbers.iteritems():
186 if re.compile(r"""gizmo""", re.I).search(description) is not None:
187 self.set_callback_number(number)
190 for number, description in numbers.iteritems():
191 if re.compile(r"""computer""", re.I).search(description) is not None:
192 self.set_callback_number(number)
195 for number, description in numbers.iteritems():
196 self.set_callback_number(number)
199 def get_callback_numbers(self):
201 @returns a dictionary mapping call back numbers to descriptions
202 @note These results are cached for 30 minutes.
204 if time.time() - self._lastAuthed < 1800 or self.is_authed():
205 return self._callbackNumbers
209 def set_callback_number(self, callbacknumber):
211 Set the number that grandcental calls
212 @param callbacknumber should be a proper 10 digit number
214 callbackPostData = urllib.urlencode({
215 'a_t': self._accessToken,
216 'default_number': callbacknumber
219 callbackSetPage = self._browser.download(self._setforwardURL, callbackPostData)
220 except urllib2.URLError, e:
221 warnings.warn(traceback.format_exc())
222 raise RuntimeError("%s is not accesible" % self._setforwardURL)
224 self._browser.cookies.save()
227 def get_callback_number(self):
229 @returns Current callback number or None
231 for c in self._browser.cookies:
232 if c.name == "pda_forwarding_number":
236 def get_recent(self):
238 @returns Iterable of (personsName, phoneNumber, date, action)
241 recentCallsPage = self._browser.download(self._inboxallURL)
242 except urllib2.URLError, e:
243 warnings.warn(traceback.format_exc())
244 raise RuntimeError("%s is not accesible" % self._inboxallURL)
246 for match in self._inboxRe.finditer(recentCallsPage):
247 phoneNumber = match.group(4)
248 action = match.group(1)
249 date = match.group(2)
250 personsName = match.group(3)
251 yield personsName, phoneNumber, date, action
253 def get_addressbooks(self):
255 @returns Iterable of (Address Book Factory, Book Id, Book Name)
259 def open_addressbook(self, bookId):
263 def contact_source_short_name(contactId):
268 return "Grand Central"
270 def get_contacts(self):
272 @returns Iterable of (contact id, contact name)
274 if self.__contacts is None:
277 contactsPagesUrls = [self._contactsURL]
278 for contactsPageUrl in contactsPagesUrls:
280 contactsPage = self._browser.download(contactsPageUrl)
281 except urllib2.URLError, e:
282 warnings.warn(traceback.format_exc())
283 raise RuntimeError("%s is not accesible" % contactsPageUrl)
284 for contact_match in self._contactsRe.finditer(contactsPage):
285 contactId = contact_match.group(1)
286 contactName = contact_match.group(2)
287 contact = contactId, contactName
288 self.__contacts.append(contact)
291 next_match = self._contactsNextRe.match(contactsPage)
292 if next_match is not None:
293 newContactsPageUrl = self._contactsURL + next_match.group(1)
294 contactsPagesUrls.append(newContactsPageUrl)
296 for contact in self.__contacts:
299 def get_contact_details(self, contactId):
301 @returns Iterable of (Phone Type, Phone Number)
304 detailPage = self._browser.download(self._contactDetailURL + '/' + contactId)
305 except urllib2.URLError, e:
306 warnings.warn(traceback.format_exc())
307 raise RuntimeError("%s is not accesible" % self._contactDetailURL)
309 for detail_match in self._contactDetailPhoneRe.finditer(detailPage):
310 phoneType = detail_match.group(1)
311 phoneNumber = detail_match.group(2)
312 yield (phoneType, phoneNumber)
314 def _grab_token(self, data):
315 "Pull the magic cookie from the datastream"
316 atGroup = self._accessTokenRe.search(data)
318 raise RuntimeError("Could not extract authentication token from GrandCentral")
319 self._accessToken = atGroup.group(1)
321 anGroup = self._accountNumRe.search(data)
323 raise RuntimeError("Could not extract account number from GrandCentral")
324 self._accountNum = anGroup.group(1)
326 self._callbackNumbers = {}
327 for match in self._callbackRe.finditer(data):
328 self._callbackNumbers[match.group(1)] = match.group(2)
331 def test_backend(username, password):
334 print "Authenticated: ", backend.is_authed()
335 print "Login?: ", backend.login(username, password)
336 print "Authenticated: ", backend.is_authed()
337 print "Token: ", backend._token
338 print "Account: ", backend.get_account_number()
339 print "Callback: ", backend.get_callback_number()
340 # print "All Callback: ",
341 # pprint.pprint(backend.get_callback_numbers())
343 # pprint.pprint(list(backend.get_recent()))
344 # print "Contacts: ",
345 # for contact in backend.get_contacts():
347 # pprint.pprint(list(backend.get_contact_details(contact[0])))