git.maemo.org Git - theonering/blob - src/gvoice/backend.py

   1 #!/usr/bin/python
   2
   3 """
   4 DialCentral - Front end for Google's GoogleVoice service.
   5 Copyright (C) 2008  Eric Warnke ericew AT gmail DOT com
   6
   7 This library is free software; you can redistribute it and/or
   8 modify it under the terms of the GNU Lesser General Public
   9 License as published by the Free Software Foundation; either
  10 version 2.1 of the License, or (at your option) any later version.
  11
  12 This library is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 Lesser General Public License for more details.
  16
  17 You should have received a copy of the GNU Lesser General Public
  18 License along with this library; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 Google Voice backend code
  22
  23 Resources
  24         http://thatsmith.com/2009/03/google-voice-addon-for-firefox/
  25         http://posttopic.com/topic/google-voice-add-on-development
  26 """
  27
  28 from __future__ import with_statement
  29
  30 import os
  31 import re
  32 import urllib
  33 import urllib2
  34 import time
  35 import datetime
  36 import itertools
  37 import logging
  38 import inspect
  39
  40 from xml.etree import ElementTree
  41
  42 try:
  43         import simplejson as _simplejson
  44         simplejson = _simplejson
  45 except ImportError:
  46         simplejson = None
  47
  48 import browser_emu
  49
  50
  51 _moduleLogger = logging.getLogger("gvoice.backend")
  52
  53
  54 class NetworkError(RuntimeError):
  55         pass
  56
  57
  58 class MessageText(object):
  59
  60         ACCURACY_LOW = "med1"
  61         ACCURACY_MEDIUM = "med2"
  62         ACCURACY_HIGH = "high"
  63
  64         def __init__(self):
  65                 self.accuracy = None
  66                 self.text = None
  67
  68         def __str__(self):
  69                 return self.text
  70
  71         def to_dict(self):
  72                 return to_dict(self)
  73
  74         def __eq__(self, other):
  75                 return self.accuracy == other.accuracy and self.text == other.text
  76
  77
  78 class Message(object):
  79
  80         def __init__(self):
  81                 self.whoFrom = None
  82                 self.body = None
  83                 self.when = None
  84
  85         def __str__(self):
  86                 return "%s (%s): %s" % (
  87                         self.whoFrom,
  88                         self.when,
  89                         "".join(str(part) for part in self.body)
  90                 )
  91
  92         def to_dict(self):
  93                 selfDict = to_dict(self)
  94                 selfDict["body"] = [text.to_dict() for text in self.body] if self.body is not None else None
  95                 return selfDict
  96
  97         def __eq__(self, other):
  98                 return self.whoFrom == other.whoFrom and self.when == other.when and self.body == other.body
  99
 100
 101 class Conversation(object):
 102
 103         TYPE_VOICEMAIL = "Voicemail"
 104         TYPE_SMS = "SMS"
 105
 106         def __init__(self):
 107                 self.type = None
 108                 self.id = None
 109                 self.contactId = None
 110                 self.name = None
 111                 self.location = None
 112                 self.prettyNumber = None
 113                 self.number = None
 114
 115                 self.time = None
 116                 self.relTime = None
 117                 self.messages = None
 118                 self.isRead = None
 119                 self.isSpam = None
 120                 self.isTrash = None
 121                 self.isArchived = None
 122
 123         def __cmp__(self, other):
 124                 cmpValue = cmp(self.contactId, other.contactId)
 125                 if cmpValue != 0:
 126                         return cmpValue
 127
 128                 cmpValue = cmp(self.time, other.time)
 129                 if cmpValue != 0:
 130                         return cmpValue
 131
 132                 cmpValue = cmp(self.id, other.id)
 133                 if cmpValue != 0:
 134                         return cmpValue
 135
 136         def to_dict(self):
 137                 selfDict = to_dict(self)
 138                 selfDict["messages"] = [message.to_dict() for message in self.messages] if self.messages is not None else None
 139                 return selfDict
 140
 141
 142 class GVoiceBackend(object):
 143         """
 144         This class encapsulates all of the knowledge necessary to interact with the GoogleVoice servers
 145         the functions include login, setting up a callback number, and initalting a callback
 146         """
 147
 148         PHONE_TYPE_HOME = 1
 149         PHONE_TYPE_MOBILE = 2
 150         PHONE_TYPE_WORK = 3
 151         PHONE_TYPE_GIZMO = 7
 152
 153         def __init__(self, cookieFile = None):
 154                 # Important items in this function are the setup of the browser emulation and cookie file
 155                 self._browser = browser_emu.MozillaEmulator(1)
 156                 self._loadedFromCookies = self._browser.load_cookies(cookieFile)
 157
 158                 self._token = ""
 159                 self._accountNum = ""
 160                 self._lastAuthed = 0.0
 161                 self._callbackNumber = ""
 162                 self._callbackNumbers = {}
 163
 164                 # Suprisingly, moving all of these from class to self sped up startup time
 165
 166                 self._validateRe = re.compile("^\+?[0-9]{10,}$")
 167
 168                 self._loginURL = "https://www.google.com/accounts/ServiceLoginAuth"
 169
 170                 SECURE_URL_BASE = "https://www.google.com/voice/"
 171                 SECURE_MOBILE_URL_BASE = SECURE_URL_BASE + "mobile/"
 172                 self._forwardURL = SECURE_MOBILE_URL_BASE + "phones"
 173                 self._tokenURL = SECURE_URL_BASE + "m"
 174                 self._callUrl = SECURE_URL_BASE + "call/connect"
 175                 self._callCancelURL = SECURE_URL_BASE + "call/cancel"
 176                 self._sendSmsURL = SECURE_URL_BASE + "sms/send"
 177
 178                 self._isDndURL = "https://www.google.com/voice/m/donotdisturb"
 179                 self._isDndRe = re.compile(r"""<input.*?id="doNotDisturb".*?checked="(.*?)"\s*/>""")
 180                 self._setDndURL = "https://www.google.com/voice/m/savednd"
 181
 182                 self._downloadVoicemailURL = SECURE_URL_BASE + "media/send_voicemail/"
 183                 self._markAsReadURL = SECURE_URL_BASE + "m/mark"
 184                 self._archiveMessageURL = SECURE_URL_BASE + "m/archive"
 185
 186                 self._XML_SEARCH_URL = SECURE_URL_BASE + "inbox/search/"
 187                 self._XML_ACCOUNT_URL = SECURE_URL_BASE + "contacts/"
 188                 # HACK really this redirects to the main pge and we are grabbing some javascript
 189                 self._XML_CONTACTS_URL = "http://www.google.com/voice/inbox/search/contact"
 190                 self._XML_RECENT_URL = SECURE_URL_BASE + "inbox/recent/"
 191
 192                 self.XML_FEEDS = (
 193                         'inbox', 'starred', 'all', 'spam', 'trash', 'voicemail', 'sms',
 194                         'recorded', 'placed', 'received', 'missed'
 195                 )
 196                 self._XML_INBOX_URL = SECURE_URL_BASE + "inbox/recent/inbox"
 197                 self._XML_STARRED_URL = SECURE_URL_BASE + "inbox/recent/starred"
 198                 self._XML_ALL_URL = SECURE_URL_BASE + "inbox/recent/all"
 199                 self._XML_SPAM_URL = SECURE_URL_BASE + "inbox/recent/spam"
 200                 self._XML_TRASH_URL = SECURE_URL_BASE + "inbox/recent/trash"
 201                 self._XML_VOICEMAIL_URL = SECURE_URL_BASE + "inbox/recent/voicemail/"
 202                 self._XML_SMS_URL = SECURE_URL_BASE + "inbox/recent/sms/"
 203                 self._XML_RECORDED_URL = SECURE_URL_BASE + "inbox/recent/recorded/"
 204                 self._XML_PLACED_URL = SECURE_URL_BASE + "inbox/recent/placed/"
 205                 self._XML_RECEIVED_URL = SECURE_URL_BASE + "inbox/recent/received/"
 206                 self._XML_MISSED_URL = SECURE_URL_BASE + "inbox/recent/missed/"
 207
 208                 self._galxRe = re.compile(r"""<input.*?name="GALX".*?value="(.*?)".*?/>""", re.MULTILINE | re.DOTALL)
 209                 self._tokenRe = re.compile(r"""<input.*?name="_rnr_se".*?value="(.*?)"\s*/>""")
 210                 self._accountNumRe = re.compile(r"""<b class="ms\d">(.{14})</b></div>""")
 211                 self._callbackRe = re.compile(r"""\s+(.*?):\s*(.*?)<br\s*/>\s*$""", re.M)
 212
 213                 self._contactsBodyRe = re.compile(r"""gcData\s*=\s*({.*?});""", re.MULTILINE | re.DOTALL)
 214                 self._seperateVoicemailsRegex = re.compile(r"""^\s*<div id="(\w+)"\s* class=".*?gc-message.*?">""", re.MULTILINE | re.DOTALL)
 215                 self._exactVoicemailTimeRegex = re.compile(r"""<span class="gc-message-time">(.*?)</span>""", re.MULTILINE)
 216                 self._relativeVoicemailTimeRegex = re.compile(r"""<span class="gc-message-relative">(.*?)</span>""", re.MULTILINE)
 217                 self._voicemailNameRegex = re.compile(r"""<a class=.*?gc-message-name-link.*?>(.*?)</a>""", re.MULTILINE | re.DOTALL)
 218                 self._voicemailNumberRegex = re.compile(r"""<input type="hidden" class="gc-text gc-quickcall-ac" value="(.*?)"/>""", re.MULTILINE)
 219                 self._prettyVoicemailNumberRegex = re.compile(r"""<span class="gc-message-type">(.*?)</span>""", re.MULTILINE)
 220                 self._voicemailLocationRegex = re.compile(r"""<span class="gc-message-location">.*?<a.*?>(.*?)</a></span>""", re.MULTILINE)
 221                 self._messagesContactIDRegex = re.compile(r"""<a class=".*?gc-message-name-link.*?">.*?</a>\s*?<span .*?>(.*?)</span>""", re.MULTILINE)
 222                 self._voicemailMessageRegex = re.compile(r"""(<span id="\d+-\d+" class="gc-word-(.*?)">(.*?)</span>|<a .*? class="gc-message-mni">(.*?)</a>)""", re.MULTILINE)
 223                 self._smsFromRegex = re.compile(r"""<span class="gc-message-sms-from">(.*?)</span>""", re.MULTILINE | re.DOTALL)
 224                 self._smsTimeRegex = re.compile(r"""<span class="gc-message-sms-time">(.*?)</span>""", re.MULTILINE | re.DOTALL)
 225                 self._smsTextRegex = re.compile(r"""<span class="gc-message-sms-text">(.*?)</span>""", re.MULTILINE | re.DOTALL)
 226
 227         def is_quick_login_possible(self):
 228                 """
 229                 @returns True then is_authed might be enough to login, else full login is required
 230                 """
 231                 return self._loadedFromCookies or 0.0 < self._lastAuthed
 232
 233         def is_authed(self, force = False):
 234                 """
 235                 Attempts to detect a current session
 236                 @note Once logged in try not to reauth more than once a minute.
 237                 @returns If authenticated
 238                 """
 239                 isRecentledAuthed = (time.time() - self._lastAuthed) < 120
 240                 isPreviouslyAuthed = self._token is not None
 241                 if isRecentledAuthed and isPreviouslyAuthed and not force:
 242                         return True
 243
 244                 try:
 245                         page = self._get_page(self._forwardURL)
 246                         self._grab_account_info(page)
 247                 except Exception, e:
 248                         _moduleLogger.exception(str(e))
 249                         return False
 250
 251                 self._browser.save_cookies()
 252                 self._lastAuthed = time.time()
 253                 return True
 254
 255         def _get_token(self):
 256                 tokenPage = self._get_page(self._tokenURL)
 257
 258                 galxTokens = self._galxRe.search(tokenPage)
 259                 if galxTokens is not None:
 260                         galxToken = galxTokens.group(1)
 261                 else:
 262                         galxToken = ""
 263                         _moduleLogger.debug("Could not grab GALX token")
 264                 return galxToken
 265
 266         def _login(self, username, password, token):
 267                 loginData = {
 268                         'Email' : username,
 269                         'Passwd' : password,
 270                         'service': "grandcentral",
 271                         "ltmpl": "mobile",
 272                         "btmpl": "mobile",
 273                         "PersistentCookie": "yes",
 274                         "GALX": token,
 275                         "continue": self._forwardURL,
 276                 }
 277
 278                 loginSuccessOrFailurePage = self._get_page(self._loginURL, loginData)
 279                 return loginSuccessOrFailurePage
 280
 281         def login(self, username, password):
 282                 """
 283                 Attempt to login to GoogleVoice
 284                 @returns Whether login was successful or not
 285                 """
 286                 self.logout()
 287                 galxToken = self._get_token()
 288                 loginSuccessOrFailurePage = self._login(username, password, galxToken)
 289
 290                 try:
 291                         self._grab_account_info(loginSuccessOrFailurePage)
 292                 except Exception, e:
 293                         # Retry in case the redirect failed
 294                         # luckily is_authed does everything we need for a retry
 295                         loggedIn = self.is_authed(True)
 296                         if not loggedIn:
 297                                 _moduleLogger.exception(str(e))
 298                                 return False
 299                         _moduleLogger.info("Redirection failed on initial login attempt, auto-corrected for this")
 300
 301                 self._browser.save_cookies()
 302                 self._lastAuthed = time.time()
 303                 return True
 304
 305         def logout(self):
 306                 self._browser.clear_cookies()
 307                 self._browser.save_cookies()
 308                 self._token = None
 309                 self._lastAuthed = 0.0
 310
 311         def is_dnd(self):
 312                 isDndPage = self._get_page(self._isDndURL)
 313
 314                 dndGroup = self._isDndRe.search(isDndPage)
 315                 if dndGroup is None:
 316                         return False
 317                 dndStatus = dndGroup.group(1)
 318                 isDnd = True if dndStatus.strip().lower() == "true" else False
 319                 return isDnd
 320
 321         def set_dnd(self, doNotDisturb):
 322                 dndPostData = {
 323                         "doNotDisturb": 1 if doNotDisturb else 0,
 324                 }
 325
 326                 dndPage = self._get_page_with_token(self._setDndURL, dndPostData)
 327
 328         def call(self, outgoingNumber):
 329                 """
 330                 This is the main function responsible for initating the callback
 331                 """
 332                 outgoingNumber = self._send_validation(outgoingNumber)
 333                 subscriberNumber = None
 334                 phoneType = guess_phone_type(self._callbackNumber) # @todo Fix this hack
 335
 336                 callData = {
 337                                 'outgoingNumber': outgoingNumber,
 338                                 'forwardingNumber': self._callbackNumber,
 339                                 'subscriberNumber': subscriberNumber or 'undefined',
 340                                 'phoneType': str(phoneType),
 341                                 'remember': '1',
 342                 }
 343                 _moduleLogger.info("%r" % callData)
 344
 345                 page = self._get_page_with_token(
 346                         self._callUrl,
 347                         callData,
 348                 )
 349                 self._parse_with_validation(page)
 350                 return True
 351
 352         def cancel(self, outgoingNumber=None):
 353                 """
 354                 Cancels a call matching outgoing and forwarding numbers (if given).
 355                 Will raise an error if no matching call is being placed
 356                 """
 357                 page = self._get_page_with_token(
 358                         self._callCancelURL,
 359                         {
 360                         'outgoingNumber': outgoingNumber or 'undefined',
 361                         'forwardingNumber': self._callbackNumber or 'undefined',
 362                         'cancelType': 'C2C',
 363                         },
 364                 )
 365                 self._parse_with_validation(page)
 366
 367         def send_sms(self, phoneNumber, message):
 368                 phoneNumber = self._send_validation(phoneNumber)
 369                 page = self._get_page_with_token(
 370                         self._sendSmsURL,
 371                         {
 372                                 'phoneNumber': phoneNumber,
 373                                 'text': message
 374                         },
 375                 )
 376                 self._parse_with_validation(page)
 377
 378         def search(self, query):
 379                 """
 380                 Search your Google Voice Account history for calls, voicemails, and sms
 381                 Returns ``Folder`` instance containting matching messages
 382                 """
 383                 page = self._get_page(
 384                         self._XML_SEARCH_URL,
 385                         {"q": query},
 386                 )
 387                 json, html = extract_payload(page)
 388                 return json
 389
 390         def get_feed(self, feed):
 391                 actualFeed = "_XML_%s_URL" % feed.upper()
 392                 feedUrl = getattr(self, actualFeed)
 393
 394                 page = self._get_page(feedUrl)
 395                 json, html = extract_payload(page)
 396
 397                 return json
 398
 399         def download(self, messageId, adir):
 400                 """
 401                 Download a voicemail or recorded call MP3 matching the given ``msg``
 402                 which can either be a ``Message`` instance, or a SHA1 identifier.
 403                 Saves files to ``adir`` (defaults to current directory).
 404                 Message hashes can be found in ``self.voicemail().messages`` for example.
 405                 Returns location of saved file.
 406                 """
 407                 page = self._get_page(self._downloadVoicemailURL, {"id": messageId})
 408                 fn = os.path.join(adir, '%s.mp3' % messageId)
 409                 with open(fn, 'wb') as fo:
 410                         fo.write(page)
 411                 return fn
 412
 413         def is_valid_syntax(self, number):
 414                 """
 415                 @returns If This number be called ( syntax validation only )
 416                 """
 417                 return self._validateRe.match(number) is not None
 418
 419         def get_account_number(self):
 420                 """
 421                 @returns The GoogleVoice phone number
 422                 """
 423                 return self._accountNum
 424
 425         def get_callback_numbers(self):
 426                 """
 427                 @returns a dictionary mapping call back numbers to descriptions
 428                 @note These results are cached for 30 minutes.
 429                 """
 430                 if not self.is_authed():
 431                         return {}
 432                 return self._callbackNumbers
 433
 434         def set_callback_number(self, callbacknumber):
 435                 """
 436                 Set the number that GoogleVoice calls
 437                 @param callbacknumber should be a proper 10 digit number
 438                 """
 439                 self._callbackNumber = callbacknumber
 440                 _moduleLogger.info("Callback number changed: %r" % self._callbackNumber)
 441                 return True
 442
 443         def get_callback_number(self):
 444                 """
 445                 @returns Current callback number or None
 446                 """
 447                 return self._callbackNumber
 448
 449         def get_recent(self):
 450                 """
 451                 @returns Iterable of (personsName, phoneNumber, exact date, relative date, action)
 452                 """
 453                 for action, url in (
 454                         ("Received", self._XML_RECEIVED_URL),
 455                         ("Missed", self._XML_MISSED_URL),
 456                         ("Placed", self._XML_PLACED_URL),
 457                 ):
 458                         flatXml = self._get_page(url)
 459
 460                         allRecentHtml = self._grab_html(flatXml)
 461                         allRecentData = self._parse_history(allRecentHtml)
 462                         for recentCallData in allRecentData:
 463                                 recentCallData["action"] = action
 464                                 yield recentCallData
 465
 466         def get_contacts(self):
 467                 """
 468                 @returns Iterable of (contact id, contact name)
 469                 """
 470                 page = self._get_page(self._XML_CONTACTS_URL)
 471                 contactsBody = self._contactsBodyRe.search(page)
 472                 if contactsBody is None:
 473                         raise RuntimeError("Could not extract contact information")
 474                 accountData = _fake_parse_json(contactsBody.group(1))
 475                 for contactId, contactDetails in accountData["contacts"].iteritems():
 476                         # A zero contact id is the catch all for unknown contacts
 477                         if contactId != "0":
 478                                 yield contactId, contactDetails
 479
 480         def get_conversations(self):
 481                 voicemailPage = self._get_page(self._XML_VOICEMAIL_URL)
 482                 voicemailHtml = self._grab_html(voicemailPage)
 483                 voicemailJson = self._grab_json(voicemailPage)
 484                 parsedVoicemail = self._parse_voicemail(voicemailHtml)
 485                 voicemails = self._merge_conversation_sources(parsedVoicemail, voicemailJson)
 486
 487                 smsPage = self._get_page(self._XML_SMS_URL)
 488                 smsHtml = self._grab_html(smsPage)
 489                 smsJson = self._grab_json(smsPage)
 490                 parsedSms = self._parse_sms(smsHtml)
 491                 smss = self._merge_conversation_sources(parsedSms, smsJson)
 492                 decoratedSms = self._decorate_sms(smss)
 493
 494                 allConversations = itertools.chain(voicemails, decoratedSms)
 495                 return allConversations
 496
 497         def mark_message(self, messageId, asRead):
 498                 postData = {
 499                         "read": 1 if asRead else 0,
 500                         "id": messageId,
 501                 }
 502
 503                 markPage = self._get_page(self._markAsReadURL, postData)
 504
 505         def archive_message(self, messageId):
 506                 postData = {
 507                         "id": messageId,
 508                 }
 509
 510                 markPage = self._get_page(self._archiveMessageURL, postData)
 511
 512         def _grab_json(self, flatXml):
 513                 xmlTree = ElementTree.fromstring(flatXml)
 514                 jsonElement = xmlTree.getchildren()[0]
 515                 flatJson = jsonElement.text
 516                 jsonTree = parse_json(flatJson)
 517                 return jsonTree
 518
 519         def _grab_html(self, flatXml):
 520                 xmlTree = ElementTree.fromstring(flatXml)
 521                 htmlElement = xmlTree.getchildren()[1]
 522                 flatHtml = htmlElement.text
 523                 return flatHtml
 524
 525         def _grab_account_info(self, page):
 526                 tokenGroup = self._tokenRe.search(page)
 527                 if tokenGroup is None:
 528                         raise RuntimeError("Could not extract authentication token from GoogleVoice")
 529                 self._token = tokenGroup.group(1)
 530
 531                 anGroup = self._accountNumRe.search(page)
 532                 if anGroup is not None:
 533                         self._accountNum = anGroup.group(1)
 534                 else:
 535                         _moduleLogger.debug("Could not extract account number from GoogleVoice")
 536
 537                 self._callbackNumbers = {}
 538                 for match in self._callbackRe.finditer(page):
 539                         callbackNumber = match.group(2)
 540                         callbackName = match.group(1)
 541                         self._callbackNumbers[callbackNumber] = callbackName
 542                 if len(self._callbackNumbers) == 0:
 543                         _moduleLogger.debug("Could not extract callback numbers from GoogleVoice (the troublesome page follows):\n%s" % page)
 544
 545         def _send_validation(self, number):
 546                 if not self.is_valid_syntax(number):
 547                         raise ValueError('Number is not valid: "%s"' % number)
 548                 elif not self.is_authed():
 549                         raise RuntimeError("Not Authenticated")
 550
 551                 if len(number) == 11 and number[0] == 1:
 552                         # Strip leading 1 from 11 digit dialing
 553                         number = number[1:]
 554                 return number
 555
 556         def _parse_history(self, historyHtml):
 557                 splitVoicemail = self._seperateVoicemailsRegex.split(historyHtml)
 558                 for messageId, messageHtml in itergroup(splitVoicemail[1:], 2):
 559                         exactTimeGroup = self._exactVoicemailTimeRegex.search(messageHtml)
 560                         exactTime = exactTimeGroup.group(1).strip() if exactTimeGroup else ""
 561                         exactTime = datetime.datetime.strptime(exactTime, "%m/%d/%y %I:%M %p")
 562                         relativeTimeGroup = self._relativeVoicemailTimeRegex.search(messageHtml)
 563                         relativeTime = relativeTimeGroup.group(1).strip() if relativeTimeGroup else ""
 564                         locationGroup = self._voicemailLocationRegex.search(messageHtml)
 565                         location = locationGroup.group(1).strip() if locationGroup else ""
 566
 567                         nameGroup = self._voicemailNameRegex.search(messageHtml)
 568                         name = nameGroup.group(1).strip() if nameGroup else ""
 569                         numberGroup = self._voicemailNumberRegex.search(messageHtml)
 570                         number = numberGroup.group(1).strip() if numberGroup else ""
 571                         prettyNumberGroup = self._prettyVoicemailNumberRegex.search(messageHtml)
 572                         prettyNumber = prettyNumberGroup.group(1).strip() if prettyNumberGroup else ""
 573                         contactIdGroup = self._messagesContactIDRegex.search(messageHtml)
 574                         contactId = contactIdGroup.group(1).strip() if contactIdGroup else ""
 575
 576                         yield {
 577                                 "id": messageId.strip(),
 578                                 "contactId": contactId,
 579                                 "name": name,
 580                                 "time": exactTime,
 581                                 "relTime": relativeTime,
 582                                 "prettyNumber": prettyNumber,
 583                                 "number": number,
 584                                 "location": location,
 585                         }
 586
 587         @staticmethod
 588         def _interpret_voicemail_regex(group):
 589                 quality, content, number = group.group(2), group.group(3), group.group(4)
 590                 text = MessageText()
 591                 if quality is not None and content is not None:
 592                         text.accuracy = quality
 593                         text.text = content
 594                         return text
 595                 elif number is not None:
 596                         text.accuracy = MessageText.ACCURACY_HIGH
 597                         text.text = number
 598                         return text
 599
 600         def _parse_voicemail(self, voicemailHtml):
 601                 splitVoicemail = self._seperateVoicemailsRegex.split(voicemailHtml)
 602                 for messageId, messageHtml in itergroup(splitVoicemail[1:], 2):
 603                         conv = Conversation()
 604                         conv.type = Conversation.TYPE_VOICEMAIL
 605                         conv.id = messageId.strip()
 606
 607                         exactTimeGroup = self._exactVoicemailTimeRegex.search(messageHtml)
 608                         exactTimeText = exactTimeGroup.group(1).strip() if exactTimeGroup else ""
 609                         conv.time = datetime.datetime.strptime(exactTimeText, "%m/%d/%y %I:%M %p")
 610                         relativeTimeGroup = self._relativeVoicemailTimeRegex.search(messageHtml)
 611                         conv.relTime = relativeTimeGroup.group(1).strip() if relativeTimeGroup else ""
 612                         locationGroup = self._voicemailLocationRegex.search(messageHtml)
 613                         conv.location = locationGroup.group(1).strip() if locationGroup else ""
 614
 615                         nameGroup = self._voicemailNameRegex.search(messageHtml)
 616                         conv.name = nameGroup.group(1).strip() if nameGroup else ""
 617                         numberGroup = self._voicemailNumberRegex.search(messageHtml)
 618                         conv.number = numberGroup.group(1).strip() if numberGroup else ""
 619                         prettyNumberGroup = self._prettyVoicemailNumberRegex.search(messageHtml)
 620                         conv.prettyNumber = prettyNumberGroup.group(1).strip() if prettyNumberGroup else ""
 621                         contactIdGroup = self._messagesContactIDRegex.search(messageHtml)
 622                         conv.contactId = contactIdGroup.group(1).strip() if contactIdGroup else ""
 623
 624                         messageGroups = self._voicemailMessageRegex.finditer(messageHtml)
 625                         messageParts = [
 626                                 self._interpret_voicemail_regex(group)
 627                                 for group in messageGroups
 628                         ] if messageGroups else ((MessageText.ACCURACY_LOW, "No Transcription"), )
 629                         message = Message()
 630                         message.body = messageParts
 631                         message.whoFrom = conv.name
 632                         message.when = conv.time.strftime("%I:%M %p")
 633                         conv.messages = (message, )
 634
 635                         yield conv
 636
 637         @staticmethod
 638         def _interpret_sms_message_parts(fromPart, textPart, timePart):
 639                 text = MessageText()
 640                 text.accuracy = MessageText.ACCURACY_MEDIUM
 641                 text.text = textPart
 642
 643                 message = Message()
 644                 message.body = (text, )
 645                 message.whoFrom = fromPart
 646                 message.when = timePart
 647
 648                 return message
 649
 650         def _parse_sms(self, smsHtml):
 651                 splitSms = self._seperateVoicemailsRegex.split(smsHtml)
 652                 for messageId, messageHtml in itergroup(splitSms[1:], 2):
 653                         conv = Conversation()
 654                         conv.type = Conversation.TYPE_SMS
 655                         conv.id = messageId.strip()
 656
 657                         exactTimeGroup = self._exactVoicemailTimeRegex.search(messageHtml)
 658                         exactTimeText = exactTimeGroup.group(1).strip() if exactTimeGroup else ""
 659                         conv.time = datetime.datetime.strptime(exactTimeText, "%m/%d/%y %I:%M %p")
 660                         relativeTimeGroup = self._relativeVoicemailTimeRegex.search(messageHtml)
 661                         conv.relTime = relativeTimeGroup.group(1).strip() if relativeTimeGroup else ""
 662                         conv.location = ""
 663
 664                         nameGroup = self._voicemailNameRegex.search(messageHtml)
 665                         conv.name = nameGroup.group(1).strip() if nameGroup else ""
 666                         numberGroup = self._voicemailNumberRegex.search(messageHtml)
 667                         conv.number = numberGroup.group(1).strip() if numberGroup else ""
 668                         prettyNumberGroup = self._prettyVoicemailNumberRegex.search(messageHtml)
 669                         conv.prettyNumber = prettyNumberGroup.group(1).strip() if prettyNumberGroup else ""
 670                         contactIdGroup = self._messagesContactIDRegex.search(messageHtml)
 671                         conv.contactId = contactIdGroup.group(1).strip() if contactIdGroup else ""
 672
 673                         fromGroups = self._smsFromRegex.finditer(messageHtml)
 674                         fromParts = (group.group(1).strip() for group in fromGroups)
 675                         textGroups = self._smsTextRegex.finditer(messageHtml)
 676                         textParts = (group.group(1).strip() for group in textGroups)
 677                         timeGroups = self._smsTimeRegex.finditer(messageHtml)
 678                         timeParts = (group.group(1).strip() for group in timeGroups)
 679
 680                         messageParts = itertools.izip(fromParts, textParts, timeParts)
 681                         messages = [self._interpret_sms_message_parts(*parts) for parts in messageParts]
 682                         conv.messages = messages
 683
 684                         yield conv
 685
 686         def _decorate_sms(self, parsedTexts):
 687                 return parsedTexts
 688
 689         @staticmethod
 690         def _merge_conversation_sources(parsedMessages, json):
 691                 for message in parsedMessages:
 692                         jsonItem = json["messages"][message.id]
 693                         message.isRead = jsonItem["isRead"]
 694                         message.isSpam = jsonItem["isSpam"]
 695                         message.isTrash = jsonItem["isTrash"]
 696                         message.isArchived = "inbox" not in jsonItem["labels"]
 697                         yield message
 698
 699         def _get_page(self, url, data = None, refererUrl = None):
 700                 headers = {}
 701                 if refererUrl is not None:
 702                         headers["Referer"] = refererUrl
 703
 704                 encodedData = urllib.urlencode(data) if data is not None else None
 705
 706                 try:
 707                         page = self._browser.download(url, encodedData, None, headers)
 708                 except urllib2.URLError, e:
 709                         _moduleLogger.error("Translating error: %s" % str(e))
 710                         raise NetworkError("%s is not accesible" % url)
 711
 712                 return page
 713
 714         def _get_page_with_token(self, url, data = None, refererUrl = None):
 715                 if data is None:
 716                         data = {}
 717                 data['_rnr_se'] = self._token
 718
 719                 page = self._get_page(url, data, refererUrl)
 720
 721                 return page
 722
 723         def _parse_with_validation(self, page):
 724                 json = parse_json(page)
 725                 validate_response(json)
 726                 return json
 727
 728
 729 def itergroup(iterator, count, padValue = None):
 730         """
 731         Iterate in groups of 'count' values. If there
 732         aren't enough values, the last result is padded with
 733         None.
 734
 735         >>> for val in itergroup([1, 2, 3, 4, 5, 6], 3):
 736         ...     print tuple(val)
 737         (1, 2, 3)
 738         (4, 5, 6)
 739         >>> for val in itergroup([1, 2, 3, 4, 5, 6], 3):
 740         ...     print list(val)
 741         [1, 2, 3]
 742         [4, 5, 6]
 743         >>> for val in itergroup([1, 2, 3, 4, 5, 6, 7], 3):
 744         ...     print tuple(val)
 745         (1, 2, 3)
 746         (4, 5, 6)
 747         (7, None, None)
 748         >>> for val in itergroup("123456", 3):
 749         ...     print tuple(val)
 750         ('1', '2', '3')
 751         ('4', '5', '6')
 752         >>> for val in itergroup("123456", 3):
 753         ...     print repr("".join(val))
 754         '123'
 755         '456'
 756         """
 757         paddedIterator = itertools.chain(iterator, itertools.repeat(padValue, count-1))
 758         nIterators = (paddedIterator, ) * count
 759         return itertools.izip(*nIterators)
 760
 761
 762 def safe_eval(s):
 763         _TRUE_REGEX = re.compile("true")
 764         _FALSE_REGEX = re.compile("false")
 765         s = _TRUE_REGEX.sub("True", s)
 766         s = _FALSE_REGEX.sub("False", s)
 767         return eval(s, {}, {})
 768
 769
 770 def _fake_parse_json(flattened):
 771         return safe_eval(flattened)
 772
 773
 774 def _actual_parse_json(flattened):
 775         return simplejson.loads(flattened)
 776
 777
 778 if simplejson is None:
 779         parse_json = _fake_parse_json
 780 else:
 781         parse_json = _actual_parse_json
 782
 783
 784 def extract_payload(flatXml):
 785         xmlTree = ElementTree.fromstring(flatXml)
 786
 787         jsonElement = xmlTree.getchildren()[0]
 788         flatJson = jsonElement.text
 789         jsonTree = parse_json(flatJson)
 790
 791         htmlElement = xmlTree.getchildren()[1]
 792         flatHtml = htmlElement.text
 793
 794         return jsonTree, flatHtml
 795
 796
 797 def validate_response(response):
 798         """
 799         Validates that the JSON response is A-OK
 800         """
 801         try:
 802                 assert 'ok' in response and response['ok']
 803         except AssertionError:
 804                 raise RuntimeError('There was a problem with GV: %s' % response)
 805
 806
 807 def guess_phone_type(number):
 808         if number.startswith("747") or number.startswith("1747"):
 809                 return GVoiceBackend.PHONE_TYPE_GIZMO
 810         else:
 811                 return GVoiceBackend.PHONE_TYPE_MOBILE
 812
 813
 814 def set_sane_callback(backend):
 815         """
 816         Try to set a sane default callback number on these preferences
 817         1) 1747 numbers ( Gizmo )
 818         2) anything with gizmo in the name
 819         3) anything with computer in the name
 820         4) the first value
 821         """
 822         numbers = backend.get_callback_numbers()
 823
 824         priorityOrderedCriteria = [
 825                 ("1747", None),
 826                 (None, "gizmo"),
 827                 (None, "computer"),
 828                 (None, "sip"),
 829                 (None, None),
 830         ]
 831
 832         for numberCriteria, descriptionCriteria in priorityOrderedCriteria:
 833                 for number, description in numbers.iteritems():
 834                         if numberCriteria is not None and re.compile(numberCriteria).match(number) is None:
 835                                 continue
 836                         if descriptionCriteria is not None and re.compile(descriptionCriteria).match(description) is None:
 837                                 continue
 838                         backend.set_callback_number(number)
 839                         return
 840
 841
 842 def _is_not_special(name):
 843         return not name.startswith("_") and name[0].lower() == name[0] and "_" not in name
 844
 845
 846 def to_dict(obj):
 847         members = inspect.getmembers(obj)
 848         return dict((name, value) for (name, value) in members if _is_not_special(name))
 849
 850
 851 def grab_debug_info(username, password):
 852         cookieFile = os.path.join(".", "raw_cookies.txt")
 853         try:
 854                 os.remove(cookieFile)
 855         except OSError:
 856                 pass
 857
 858         backend = GVoiceBackend(cookieFile)
 859         browser = backend._browser
 860
 861         _TEST_WEBPAGES = [
 862                 ("forward", backend._forwardURL),
 863                 ("token", backend._tokenURL),
 864                 ("login", backend._loginURL),
 865                 ("isdnd", backend._isDndURL),
 866                 ("account", backend._XML_ACCOUNT_URL),
 867                 ("contacts", backend._XML_CONTACTS_URL),
 868
 869                 ("voicemail", backend._XML_VOICEMAIL_URL),
 870                 ("sms", backend._XML_SMS_URL),
 871
 872                 ("recent", backend._XML_RECENT_URL),
 873                 ("placed", backend._XML_PLACED_URL),
 874                 ("recieved", backend._XML_RECEIVED_URL),
 875                 ("missed", backend._XML_MISSED_URL),
 876         ]
 877
 878         # Get Pages
 879         print "Grabbing pre-login pages"
 880         for name, url in _TEST_WEBPAGES:
 881                 try:
 882                         page = browser.download(url)
 883                 except StandardError, e:
 884                         print e.message
 885                         continue
 886                 print "\tWriting to file"
 887                 with open("not_loggedin_%s.txt" % name, "w") as f:
 888                         f.write(page)
 889
 890         # Login
 891         print "Attempting login"
 892         galxToken = backend._get_token()
 893         loginSuccessOrFailurePage = backend._login(username, password, galxToken)
 894         with open("loggingin.txt", "w") as f:
 895                 print "\tWriting to file"
 896                 f.write(loginSuccessOrFailurePage)
 897         try:
 898                 backend._grab_account_info(loginSuccessOrFailurePage)
 899         except Exception:
 900                 # Retry in case the redirect failed
 901                 # luckily is_authed does everything we need for a retry
 902                 loggedIn = backend.is_authed(True)
 903                 if not loggedIn:
 904                         raise
 905
 906         # Get Pages
 907         print "Grabbing post-login pages"
 908         for name, url in _TEST_WEBPAGES:
 909                 try:
 910                         page = browser.download(url)
 911                 except StandardError, e:
 912                         print str(e)
 913                         continue
 914                 print "\tWriting to file"
 915                 with open("loggedin_%s.txt" % name, "w") as f:
 916                         f.write(page)
 917
 918         # Cookies
 919         browser.save_cookies()
 920         print "\tWriting cookies to file"
 921         with open("cookies.txt", "w") as f:
 922                 f.writelines(
 923                         "%s: %s\n" % (c.name, c.value)
 924                         for c in browser._cookies
 925                 )
 926
 927
 928 def main():
 929         import sys
 930         logging.basicConfig(level=logging.DEBUG)
 931         args = sys.argv
 932         if 3 <= len(args):
 933                 username = args[1]
 934                 password = args[2]
 935
 936         grab_debug_info(username, password)
 937
 938
 939 if __name__ == "__main__":
 940         main()