beacon.py

   1 import logging
   2 import re
   3 import struct
   4 import time
   5 from socket import *
   6 from threading import Timer
   7 from urllib import quote
   8
   9 import Zeroconf
  10
  11 import config
  12 from plugin import GetPlugin
  13
  14 SHARE_TEMPLATE = '/TiVoConnect?Command=QueryContainer&Container=%s'
  15 PLATFORM_MAIN = 'pyTivo'
  16 PLATFORM_VIDEO = 'pc/pyTivo'    # For the nice icon
  17
  18 class ZCListener:
  19     def __init__(self, names):
  20         self.names = names
  21
  22     def removeService(self, server, type, name):
  23         if name in self.names:
  24             self.names.remove(name)
  25
  26     def addService(self, server, type, name):
  27         self.names.append(name)
  28
  29 class ZCBroadcast:
  30     def __init__(self, logger):
  31         """ Announce our shares via Zeroconf. """
  32         self.share_names = []
  33         self.share_info = []
  34         self.logger = logger
  35         self.rz = Zeroconf.Zeroconf()
  36         address = inet_aton(config.get_ip())
  37         port = int(config.getPort())
  38         for section, settings in config.getShares():
  39             ct = GetPlugin(settings['type']).CONTENT_TYPE
  40             if ct.startswith('x-container/'):
  41                 if 'video' in ct:
  42                     platform = PLATFORM_VIDEO
  43                 else:
  44                     platform = PLATFORM_MAIN
  45                 logger.info('Registering: %s' % section)
  46                 self.share_names.append(section)
  47                 desc = {'path': SHARE_TEMPLATE % quote(section),
  48                         'platform': platform, 'protocol': 'http'}
  49                 tt = ct.split('/')[1]
  50                 info = Zeroconf.ServiceInfo('_%s._tcp.local.' % tt,
  51                     '%s._%s._tcp.local.' % (section, tt),
  52                     address, port, 0, 0, desc)
  53                 self.rz.registerService(info)
  54                 self.share_info.append(info)
  55
  56     def scan(self):
  57         """ Look for TiVos using Zeroconf. """
  58         VIDS = '_tivo-videos._tcp.local.'
  59         names = []
  60
  61         # Get the names of servers offering TiVo videos
  62         browser = Zeroconf.ServiceBrowser(self.rz, VIDS, ZCListener(names))
  63
  64         # Give them half a second to respond
  65         time.sleep(0.5)
  66
  67         # Now get the addresses -- this is the slow part
  68         for name in names:
  69             info = self.rz.getServiceInfo(VIDS, name)
  70             if info and 'TSN' in info.properties:
  71                 tsn = info.properties['TSN']
  72                 address = inet_ntoa(info.getAddress())
  73                 config.tivos[tsn] = address
  74                 name = name.replace('.' + VIDS, '')
  75                 self.logger.info(name)
  76                 config.tivo_names[tsn] = name
  77
  78     def shutdown(self):
  79         self.logger.info('Unregistering: %s' % ' '.join(self.share_names))
  80         for info in self.share_info:
  81             self.rz.unregisterService(info)
  82         self.rz.close()
  83
  84 class Beacon:
  85     def __init__(self):
  86         self.UDPSock = socket(AF_INET, SOCK_DGRAM)
  87         self.UDPSock.setsockopt(SOL_SOCKET, SO_BROADCAST, 1)
  88         self.services = []
  89
  90         self.platform = PLATFORM_VIDEO
  91         for section, settings in config.getShares():
  92             ct = GetPlugin(settings['type']).CONTENT_TYPE
  93             if ct in ('x-container/tivo-music', 'x-container/tivo-photos'):
  94                 self.platform = PLATFORM_MAIN
  95                 break
  96
  97         if config.get_zc():
  98             logger = logging.getLogger('pyTivo.beacon')
  99             try:
 100                 logger.info('Announcing shares...')
 101                 self.bd = ZCBroadcast(logger)
 102             except:
 103                 logger.error('Zeroconf failure')
 104                 self.bd = None
 105             else:
 106                 logger.info('Scanning for TiVos...')
 107                 self.bd.scan()
 108         else:
 109             self.bd = None
 110
 111     def add_service(self, service):
 112         self.services.append(service)
 113         self.send_beacon()
 114
 115     def format_services(self):
 116         return ';'.join(self.services)
 117
 118     def format_beacon(self, conntype, services=True):
 119         beacon = ['tivoconnect=1',
 120                   'method=%s' % conntype,
 121                   'identity=%s' % config.getGUID(),
 122                   'machine=%s' % gethostname(),
 123                   'platform=%s' % self.platform]
 124
 125         if services:
 126             beacon.append('services=' + self.format_services())
 127         else:
 128             beacon.append('services=TiVoMediaServer:0/http')
 129
 130         return '\n'.join(beacon)
 131
 132     def send_beacon(self):
 133         beacon_ips = config.getBeaconAddresses()
 134         for beacon_ip in beacon_ips.split():
 135             if beacon_ip != 'listen':
 136                 try:
 137                     self.UDPSock.sendto(self.format_beacon('broadcast'),
 138                                         (beacon_ip, 2190))
 139                 except error, e:
 140                     print e
 141
 142     def start(self):
 143         self.send_beacon()
 144         self.timer = Timer(60, self.start)
 145         self.timer.start()
 146
 147     def stop(self):
 148         self.timer.cancel()
 149         if self.bd:
 150             self.bd.shutdown()
 151
 152     def listen(self):
 153         """ For the direct-connect, TCP-style beacon """
 154         import thread
 155
 156         def server():
 157             TCPSock = socket(AF_INET, SOCK_STREAM)
 158             TCPSock.bind(('', 2190))
 159             TCPSock.listen(5)
 160
 161             while True:
 162                 # Wait for a connection
 163                 client, address = TCPSock.accept()
 164
 165                 # Accept the client's beacon
 166                 client_length = struct.unpack('!I', client.recv(4))[0]
 167                 client_message = client.recv(client_length)
 168
 169                 # Send ours
 170                 message = self.format_beacon('connected')
 171                 client.send(struct.pack('!I', len(message)))
 172                 client.send(message)
 173                 client.close()
 174
 175         thread.start_new_thread(server, ())
 176
 177     def get_name(self, address):
 178         """ Exchange beacons, and extract the machine name. """
 179         our_beacon = self.format_beacon('connected', False)
 180         machine_name = re.compile('machine=(.*)\n').search
 181
 182         try:
 183             tsock = socket()
 184             tsock.connect((address, 2190))
 185
 186             tsock.send(struct.pack('!I', len(our_beacon)))
 187             tsock.send(our_beacon)
 188
 189             length = struct.unpack('!I', tsock.recv(4))[0]
 190             tivo_beacon = tsock.recv(length)
 191
 192             tsock.close()
 193
 194             name = machine_name(tivo_beacon).groups()[0]
 195         except:
 196             name = address
 197
 198         return name