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
  11 try:
  12     import xml.etree.ElementTree as ElementTree
  13 except ImportError:
  14     try:
  15         import elementtree.ElementTree as ElementTree
  16     except ImportError:
  17         warnings.warn('Python 2.5 or higher or elementtree is needed to use the TivoPush')
  18
  19 if 'ElementTree' not in locals():
  20
  21     class Mind:
  22         def __init__(self, *arg, **karg):
  23             raise Exception('Python 2.5 or higher or elementtree is needed to use the TivoPush')
  24
  25 else:
  26
  27     class Mind:
  28         def __init__(self, username, password, debug=False):
  29             self.__username = username
  30             self.__password = password
  31
  32             self.__debug = debug
  33
  34             self.__cj = cookielib.CookieJar()
  35             self.__opener = urllib2.build_opener(urllib2.HTTPSHandler(debuglevel=1), 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 __log(self, message):
 124             if self.__debug:
 125                 print message
 126                 print
 127
 128         def __login(self):
 129
 130             data = {
 131                 'cams_security_domain' : 'tivocom',
 132                 'cams_login_config' : 'http',
 133                 'cams_cb_username' : self.__username,
 134                 'cams_cb_password' : self.__password,
 135                 'cams_original_url' : '/mind/mind7?type=infoGet'
 136             }
 137
 138             r =  urllib2.Request(
 139                 'https://mind.tivo.com:8181/mind/login',
 140                 urllib.urlencode(data)
 141             )
 142             try:
 143                 result = self.__opener.open(r)
 144             except:
 145                 pass
 146
 147             self.__log('__login\n%s' % (data))
 148
 149         def __bodyOfferModify(self, data):
 150             """Create an offer"""
 151             r = urllib2.Request(
 152                 'https://mind.tivo.com:8181/mind/mind7?type=bodyOfferModify&bodyId=' + data['bodyId'],
 153                 dictcode(data),
 154                 {'Content-Type' : 'x-tivo/dict-binary'}
 155             )
 156             result = self.__opener.open(r)
 157
 158             xml = ElementTree.parse(result).find('.')
 159
 160             self.__log('__bodyOfferModify\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 161
 162             if xml.findtext('state') != 'complete':
 163                 raise Exception(ElementTree.tostring(xml))
 164
 165             offer_id = xml.findtext('offerId')
 166             content_id = offer_id.replace('of','ct')
 167
 168             return offer_id, content_id
 169
 170
 171         def __subscribe(self, offer_id, content_id, tsn):
 172             """Push the offer to the tivo"""
 173             data =  {
 174                 'bodyId' : 'tsn:' + tsn,
 175                 'idSetSource' : {
 176                     'contentId': content_id,
 177                     'offerId' : offer_id,
 178                     'type' : 'singleOfferSource',
 179                 },
 180                 'title' : 'pcBodySubscription',
 181                 'uiType' : 'cds',
 182             }
 183
 184             r = urllib2.Request(
 185                 'https://mind.tivo.com:8181/mind/mind7?type=subscribe&bodyId=tsn:' + tsn,
 186                 dictcode(data),
 187                 {'Content-Type' : 'x-tivo/dict-binary'}
 188             )
 189             result = self.__opener.open(r)
 190
 191             xml = ElementTree.parse(result).find('.')
 192
 193             self.__log('__subscribe\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 194
 195             return xml
 196
 197         def __bodyOfferSchedule(self, pc_body_id):
 198             """Get pending stuff for this pc"""
 199
 200             data = {'pcBodyId' : pc_body_id,}
 201             r = urllib2.Request(
 202                 'https://mind.tivo.com:8181/mind/mind7?type=bodyOfferSchedule',
 203                 dictcode(data),
 204                 {'Content-Type' : 'x-tivo/dict-binary'}
 205             )
 206             result = self.__opener.open(r)
 207
 208             xml = ElementTree.parse(result).find('.')
 209
 210             self.__log('bodyOfferSchedule\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 211
 212             return xml
 213
 214         def __pcBodySearch(self):
 215             """Find PCS"""
 216
 217             data = {}
 218             r = urllib2.Request(
 219                 'https://mind.tivo.com:8181/mind/mind7?type=pcBodySearch',
 220                 dictcode(data),
 221                 {'Content-Type' : 'x-tivo/dict-binary'}
 222             )
 223             result = self.__opener.open(r)
 224
 225             xml = ElementTree.parse(result).find('.')
 226
 227
 228             self.__log('__pcBodySearch\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 229
 230             return [id.text for id in xml.findall('pcBody/pcBodyId')]
 231
 232         def __collectionIdSearch(self, url):
 233             """Find collection ids"""
 234
 235             data = {'url' : url}
 236             r = urllib2.Request(
 237                 'https://mind.tivo.com:8181/mind/mind7?type=collectionIdSearch',
 238                 dictcode(data),
 239                 {'Content-Type' : 'x-tivo/dict-binary'}
 240             )
 241             result = self.__opener.open(r)
 242
 243             xml = ElementTree.parse( result ).find('.')
 244             collection_id = xml.findtext('collectionId')
 245
 246             self.__log('__collectionIdSearch\n%s\n\n%sg' % (data, ElementTree.tostring(xml)))
 247
 248             return collection_id
 249
 250         def __pcBodyStore(self, name, replace=False):
 251             """Setup a new PC"""
 252
 253             data = {
 254                 'name' : name,
 255                 'replaceExisting' : str(replace).lower(),
 256             }
 257
 258             r = urllib2.Request(
 259                 'https://mind.tivo.com:8181/mind/mind7?type=pcBodyStore',
 260                 dictcode(data),
 261                 {'Content-Type' : 'x-tivo/dict-binary'}
 262             )
 263             result = self.__opener.open(r)
 264
 265             xml = ElementTree.parse(result).find('.')
 266
 267             self.__log('__pcBodySearch\n%s\n\n%s' % (data, ElementTree.tostring(xml)))
 268
 269             return xml
 270
 271         def __bodyXmppInfoGet(self, body_id):
 272
 273             data = {
 274                 'bodyId' : body_id,
 275             }
 276
 277             r = urllib2.Request(
 278                 'https://mind.tivo.com:8181/mind/mind7?type=bodyXmppInfoGet&bodyId=' + body_id,
 279                 dictcode(data),
 280                 {'Content-Type' : 'x-tivo/dict-binary'}
 281             )
 282
 283             result = self.__opener.open(r)
 284
 285             xml = ElementTree.parse(result).find('.')
 286
 287             self.__log('__bodyXmppInfoGe\n%s\n\n%s' % (data, ElementTree.tostring(xml)))
 288
 289             return xml
 290
 291
 292     def dictcode(d):
 293         """Helper to create x-tivo/dict-binary"""
 294         output = []
 295
 296         keys = [str(k) for k in d]
 297         keys.sort()
 298
 299         for k in keys:
 300             v = d[k]
 301
 302             output.append( varint( len(k) ) )
 303             output.append( k )
 304
 305             if isinstance(v, dict):
 306                 output.append( struct.pack('>B', 0x02) )
 307                 output.append( dictcode(v) )
 308
 309             else:
 310                 v = unicode(v).encode('utf-8')
 311                 output.append( struct.pack('>B', 0x01) )
 312                 output.append( varint( len(v) ) )
 313                 output.append( v )
 314
 315             output.append( struct.pack('>B', 0x00) )
 316
 317         output.append( struct.pack('>B', 0x80) )
 318
 319         return ''.join(output)
 320
 321     def varint(i):
 322         import sys
 323
 324         bits = []
 325         while i:
 326             bits.append(i & 0x01)
 327             i = i  >> 1
 328
 329         if not bits:
 330             output = [0]
 331         else:
 332             output = []
 333
 334         while bits:
 335             byte = 0
 336             mybits = bits[:7]
 337             del bits[:7]
 338
 339             for bit, p in zip(mybits, itertools.count()):
 340                 byte += bit * (2 ** p)
 341
 342             output.append(byte)
 343
 344         output[-1] = output[-1] | 0x80
 345         return ''.join([chr(b) for b in output])
 346
 347
 348 def getMind():
 349     username = config.getTivoUsername()
 350     password = config.getTivoPassword()
 351
 352     if not username or not password:
 353        raise Exception("tivo_username and tivo_password required")
 354
 355     m = Mind(username, password, True)
 356
 357     return m
 358