mind.py

   1 import cookielib
   2 import urllib2
   3 import urllib
   4 import struct
   5 import httplib
   6 import time
   7 import warnings
   8 import itertools
   9 import config
  10 import logging
  11
  12 try:
  13     import xml.etree.ElementTree as ElementTree
  14 except ImportError:
  15     try:
  16         import elementtree.ElementTree as ElementTree
  17     except ImportError:
  18         warnings.warn('Python 2.5 or higher or elementtree is needed to use the TivoPush')
  19
  20 if 'ElementTree' not in locals():
  21
  22     class Mind:
  23         def __init__(self, *arg, **karg):
  24             raise Exception('Python 2.5 or higher or elementtree is needed to use the TivoPush')
  25
  26 else:
  27
  28     class Mind:
  29         def __init__(self, username, password):
  30             self.__logger = logging.getLogger('pyTivo.mind')
  31             self.__username = username
  32             self.__password = password
  33
  34             self.__cj = cookielib.CookieJar()
  35             self.__opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(self.__cj))
  36
  37             self.__login()
  38
  39             if not self.__pcBodySearch():
  40                 self.__pcBodyStore('pyTivo', True)
  41
  42         def pushVideo(self, tsn, url, description, duration, size, title, subtitle):
  43             data = {
  44                 'bodyId' : 'tsn:' + tsn,
  45                 'description' : description,
  46                 'duration' : duration,
  47                 'encodingType' : 'mpeg2ProgramStream',
  48                 'partnerId' : 'tivo:pt.3187',
  49                 'pcBodyId' : pc_body_id,
  50                 'publishDate' : time.strftime('%Y-%m-%d %H:%M%S', time.gmtime()),
  51                 'size' : size,
  52                 'source' : 'file:/C%3A%2FDocuments%20and%20Settings%2FStephanie%2FDesktop%2FVideo',
  53                 'state' : 'complete',
  54                 'subtitle' : subtitle,
  55                 'title' : title,
  56                 'url' : url,
  57             }
  58
  59             # It looks like tivo only supports one pc per house
  60             pc_body_id = self.__pcBodySearch()[0]
  61             offer_id, content_id = self.__bodyOfferModify(data)
  62             self.__subscribe(offer_id, content_id, tsn)
  63
  64         def getDownloadRequests(self):
  65             NEEDED_VALUES = [
  66                 'bodyId',
  67                 'bodyOfferId',
  68                 'description',
  69                 'partnerId',
  70                 'pcBodyId',
  71                 'publishDate',
  72                 'source',
  73                 'state',
  74                 'subscriptionId',
  75                 'subtitle',
  76                 'title',
  77                 'url',
  78             ]
  79
  80             # It looks like tivo only supports one pc per house
  81             pc_body_id = self.__pcBodySearch()[0]
  82
  83             requests = []
  84             offer_list = self.__bodyOfferSchedule(pc_body_id)
  85
  86             for offer in offer_list.findall('bodyOffer'):
  87                 d = {}
  88                 if offer.findtext('state') != 'scheduled':
  89                     continue
  90
  91                 for n in NEEDED_VALUES:
  92                     d[n] = offer.findtext(n)
  93                 requests.append(d)
  94
  95             return requests
  96
  97         def completeDownloadRequest(self, request):
  98             request['encodingType'] = 'mpeg2ProgramStream'
  99             request['state'] = 'complete'
 100             request['type'] = 'bodyOfferModify'
 101             request['updateDate'] = time.strftime('%Y-%m-%d %H:%M%S', time.gmtime())
 102
 103             offer_id, content_id = self.__bodyOfferModify(request)
 104             self.__subscribe(offer_id, content_id, request['bodyId'][4:])
 105
 106
 107         def getXMPPLoginInfo(self):
 108             # It looks like tivo only supports one pc per house
 109             pc_body_id = self.__pcBodySearch()[0]
 110
 111             xml = self.__bodyXmppInfoGet(pc_body_id)
 112
 113             results = {}
 114             results['server'] = xml.findtext('server')
 115             results['port'] = int(xml.findtext('port'))
 116             results['username'] = xml.findtext('xmppId')
 117
 118             for sendPresence in xml.findall('sendPresence'):
 119                 results.setdefault('presence_list', []).append(sendPresence.text)
 120
 121             return results
 122
 123         def __login(self):
 124
 125             data = {
 126                 'cams_security_domain' : 'tivocom',
 127                 'cams_login_config' : 'http',
 128                 'cams_cb_username' : self.__username,
 129                 'cams_cb_password' : self.__password,
 130                 'cams_original_url' : '/mind/mind7?type=infoGet'
 131             }
 132
 133             r =  urllib2.Request(
 134                 'https://mind.tivo.com:8181/mind/login',
 135                 urllib.urlencode(data)
 136             )
 137             try:
 138                 result = self.__opener.open(r)
 139             except:
 140                 pass
 141
 142             self.__logger.debug('__login\n%s' % (data))
 143
 144         def __bodyOfferModify(self, data):
 145             """Create an offer"""
 146             r = urllib2.Request(
 147                 'https://mind.tivo.com:8181/mind/mind7?type=bodyOfferModify&bodyId=' + data['bodyId'],
 148                 dictcode(data),
 149                 {'Content-Type' : 'x-tivo/dict-binary'}
 150             )
 151             result = self.__opener.open(r)
 152
 153             xml = ElementTree.parse(result).find('.')
 154
 155             self.__logger.debug('__bodyOfferModify\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 156
 157             if xml.findtext('state') != 'complete':
 158                 raise Exception(ElementTree.tostring(xml))
 159
 160             offer_id = xml.findtext('offerId')
 161             content_id = offer_id.replace('of','ct')
 162
 163             return offer_id, content_id
 164
 165
 166         def __subscribe(self, offer_id, content_id, tsn):
 167             """Push the offer to the tivo"""
 168             data =  {
 169                 'bodyId' : 'tsn:' + tsn,
 170                 'idSetSource' : {
 171                     'contentId': content_id,
 172                     'offerId' : offer_id,
 173                     'type' : 'singleOfferSource',
 174                 },
 175                 'title' : 'pcBodySubscription',
 176                 'uiType' : 'cds',
 177             }
 178
 179             r = urllib2.Request(
 180                 'https://mind.tivo.com:8181/mind/mind7?type=subscribe&bodyId=tsn:' + tsn,
 181                 dictcode(data),
 182                 {'Content-Type' : 'x-tivo/dict-binary'}
 183             )
 184             result = self.__opener.open(r)
 185
 186             xml = ElementTree.parse(result).find('.')
 187
 188             self.__logger.debug('__subscribe\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 189
 190             return xml
 191
 192         def __bodyOfferSchedule(self, pc_body_id):
 193             """Get pending stuff for this pc"""
 194
 195             data = {'pcBodyId' : pc_body_id,}
 196             r = urllib2.Request(
 197                 'https://mind.tivo.com:8181/mind/mind7?type=bodyOfferSchedule',
 198                 dictcode(data),
 199                 {'Content-Type' : 'x-tivo/dict-binary'}
 200             )
 201             result = self.__opener.open(r)
 202
 203             xml = ElementTree.parse(result).find('.')
 204
 205             self.__logger.debug('bodyOfferSchedule\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 206
 207             return xml
 208
 209         def __pcBodySearch(self):
 210             """Find PCS"""
 211
 212             data = {}
 213             r = urllib2.Request(
 214                 'https://mind.tivo.com:8181/mind/mind7?type=pcBodySearch',
 215                 dictcode(data),
 216                 {'Content-Type' : 'x-tivo/dict-binary'}
 217             )
 218             result = self.__opener.open(r)
 219
 220             xml = ElementTree.parse(result).find('.')
 221
 222
 223             self.__logger.debug('__pcBodySearch\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 224
 225             return [id.text for id in xml.findall('pcBody/pcBodyId')]
 226
 227         def __collectionIdSearch(self, url):
 228             """Find collection ids"""
 229
 230             data = {'url' : url}
 231             r = urllib2.Request(
 232                 'https://mind.tivo.com:8181/mind/mind7?type=collectionIdSearch',
 233                 dictcode(data),
 234                 {'Content-Type' : 'x-tivo/dict-binary'}
 235             )
 236             result = self.__opener.open(r)
 237
 238             xml = ElementTree.parse( result ).find('.')
 239             collection_id = xml.findtext('collectionId')
 240
 241             self.__logger.debug('__collectionIdSearch\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 242
 243             return collection_id
 244
 245         def __pcBodyStore(self, name, replace=False):
 246             """Setup a new PC"""
 247
 248             data = {
 249                 'name' : name,
 250                 'replaceExisting' : str(replace).lower(),
 251             }
 252
 253             r = urllib2.Request(
 254                 'https://mind.tivo.com:8181/mind/mind7?type=pcBodyStore',
 255                 dictcode(data),
 256                 {'Content-Type' : 'x-tivo/dict-binary'}
 257             )
 258             result = self.__opener.open(r)
 259
 260             xml = ElementTree.parse(result).find('.')
 261
 262             self.__logger.debug('__pcBodySearch\n%s\n\n%s' % (data, ElementTree.tostring(xml)))
 263
 264             return xml
 265
 266         def __bodyXmppInfoGet(self, body_id):
 267
 268             data = {
 269                 'bodyId' : body_id,
 270             }
 271
 272             r = urllib2.Request(
 273                 'https://mind.tivo.com:8181/mind/mind7?type=bodyXmppInfoGet&bodyId=' + body_id,
 274                 dictcode(data),
 275                 {'Content-Type' : 'x-tivo/dict-binary'}
 276             )
 277
 278             result = self.__opener.open(r)
 279
 280             xml = ElementTree.parse(result).find('.')
 281
 282             self.__logger.debug('__bodyXmppInfoGe\n%s\n\n%s' % (data, ElementTree.tostring(xml)))
 283
 284             return xml
 285
 286
 287     def dictcode(d):
 288         """Helper to create x-tivo/dict-binary"""
 289         output = []
 290
 291         keys = [str(k) for k in d]
 292         keys.sort()
 293
 294         for k in keys:
 295             v = d[k]
 296
 297             output.append( varint( len(k) ) )
 298             output.append( k )
 299
 300             if isinstance(v, dict):
 301                 output.append( struct.pack('>B', 0x02) )
 302                 output.append( dictcode(v) )
 303
 304             else:
 305                 v = unicode(v).encode('utf-8')
 306                 output.append( struct.pack('>B', 0x01) )
 307                 output.append( varint( len(v) ) )
 308                 output.append( v )
 309
 310             output.append( struct.pack('>B', 0x00) )
 311
 312         output.append( struct.pack('>B', 0x80) )
 313
 314         return ''.join(output)
 315
 316     def varint(i):
 317         import sys
 318
 319         bits = []
 320         while i:
 321             bits.append(i & 0x01)
 322             i = i  >> 1
 323
 324         if not bits:
 325             output = [0]
 326         else:
 327             output = []
 328
 329         while bits:
 330             byte = 0
 331             mybits = bits[:7]
 332             del bits[:7]
 333
 334             for bit, p in zip(mybits, itertools.count()):
 335                 byte += bit * (2 ** p)
 336
 337             output.append(byte)
 338
 339         output[-1] = output[-1] | 0x80
 340         return ''.join([chr(b) for b in output])
 341
 342
 343 def getMind():
 344     username = config.getTivoUsername()
 345     password = config.getTivoPassword()
 346
 347     if not username or not password:
 348        raise Exception("tivo_username and tivo_password required")
 349
 350     m = Mind(username, password)
 351
 352     return m
 353