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