httpserver.py

   1 import BaseHTTPServer
   2 import SocketServer
   3 import cgi
   4 import logging
   5 import os
   6 import re
   7 import socket
   8 import time
   9 from urllib import unquote_plus, quote
  10 from xml.sax.saxutils import escape
  11
  12 from Cheetah.Template import Template
  13 import config
  14 from plugin import GetPlugin, EncodeUnicode
  15
  16 SCRIPTDIR = os.path.dirname(__file__)
  17
  18 VIDEO_FORMATS = """<?xml version="1.0" encoding="utf-8"?>
  19 <TiVoFormats><Format>
  20 <ContentType>video/x-tivo-mpeg</ContentType><Description/>
  21 </Format></TiVoFormats>"""
  22
  23 class TivoHTTPServer(SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer):
  24     containers = {}
  25
  26     def __init__(self, server_address, RequestHandlerClass):
  27         BaseHTTPServer.HTTPServer.__init__(self, server_address,
  28                                            RequestHandlerClass)
  29         self.daemon_threads = True
  30         self.logger = logging.getLogger('pyTivo')
  31
  32     def add_container(self, name, settings):
  33         if name in self.containers or name == 'TiVoConnect':
  34             raise "Container Name in use"
  35         try:
  36             self.containers[name] = settings
  37         except KeyError:
  38             self.logger.error('Unable to add container ' + name)
  39
  40     def reset(self):
  41         self.containers.clear()
  42         for section, settings in config.getShares():
  43             self.add_container(section, settings)
  44
  45     def handle_error(self, request, client_address):
  46         self.logger.exception('Exception during request from %s' %
  47                               (client_address,))
  48
  49     def set_beacon(self, beacon):
  50         self.beacon = beacon
  51
  52 class TivoHTTPHandler(BaseHTTPServer.BaseHTTPRequestHandler):
  53     def __init__(self, request, client_address, server):
  54         self.wbufsize = 0x10000
  55         BaseHTTPServer.BaseHTTPRequestHandler.__init__(self, request,
  56             client_address, server)
  57
  58     def address_string(self):
  59         host, port = self.client_address[:2]
  60         return host
  61
  62     def do_GET(self):
  63         tsn = self.headers.getheader('TiVo_TCD_ID',
  64                                      self.headers.getheader('tsn', ''))
  65         if not self.authorize(tsn):
  66             return
  67         if tsn:
  68             ip = self.address_string()
  69             config.tivos[tsn] = ip
  70
  71             if not tsn in config.tivo_names or config.tivo_names[tsn] == tsn:
  72                 config.tivo_names[tsn] = self.server.beacon.get_name(ip)
  73
  74         if '?' in self.path:
  75             path, opts = self.path.split('?', 1)
  76             query = cgi.parse_qs(opts)
  77         else:
  78             path = self.path
  79             query = {}
  80
  81         if path == '/TiVoConnect':
  82             self.handle_query(query, tsn)
  83         else:
  84             ## Get File
  85             path = unquote_plus(path)
  86             basepath = path.split('/')[1]
  87             for name, container in self.server.containers.items():
  88                 if basepath == name:
  89                     path = os.path.join(os.path.normpath(container['path']),
  90                                         os.path.normpath(path[len(name) + 2:]))
  91                     plugin = GetPlugin(container['type'])
  92                     plugin.send_file(self, path, query)
  93                     return
  94
  95             ## Not a file not a TiVo command
  96             self.infopage()
  97
  98     def do_POST(self):
  99         tsn = self.headers.getheader('TiVo_TCD_ID',
 100                                      self.headers.getheader('tsn', ''))
 101         if not self.authorize(tsn):
 102             return
 103         ctype, pdict = cgi.parse_header(self.headers.getheader('content-type'))
 104         if ctype == 'multipart/form-data':
 105             query = cgi.parse_multipart(self.rfile, pdict)
 106         else:
 107             length = int(self.headers.getheader('content-length'))
 108             qs = self.rfile.read(length)
 109             query = cgi.parse_qs(qs, keep_blank_values=1)
 110         self.handle_query(query, tsn)
 111
 112     def handle_query(self, query, tsn):
 113         mname = False
 114         if 'Command' in query and len(query['Command']) >= 1:
 115
 116             command = query['Command'][0]
 117
 118             # If we are looking at the root container
 119             if (command == 'QueryContainer' and
 120                 (not 'Container' in query or query['Container'][0] == '/')):
 121                 self.root_container()
 122                 return
 123
 124             if 'Container' in query:
 125                 # Dispatch to the container plugin
 126                 basepath = query['Container'][0].split('/')[0]
 127                 for name, container in config.getShares(tsn):
 128                     if basepath == name:
 129                         plugin = GetPlugin(container['type'])
 130                         if hasattr(plugin, command):
 131                             method = getattr(plugin, command)
 132                             method(self, query)
 133                             return
 134                         else:
 135                             break
 136
 137             elif (command == 'QueryFormats' and 'SourceFormat' in query and
 138                   query['SourceFormat'][0].startswith('video')):
 139                 self.send_response(200)
 140                 self.end_headers()
 141                 self.wfile.write(VIDEO_FORMATS)
 142                 return
 143
 144             elif command == 'FlushServer':
 145                 # Does nothing -- included for completeness
 146                 self.send_response(200)
 147                 self.end_headers()
 148                 return
 149
 150         # If we made it here it means we couldn't match the request to
 151         # anything.
 152         self.unsupported(query)
 153
 154     def authorize(self, tsn=None):
 155         # if allowed_clients is empty, we are completely open
 156         allowed_clients = config.getAllowedClients()
 157         if not allowed_clients or (tsn and config.isTsnInConfig(tsn)):
 158             return True
 159         client_ip = self.client_address[0]
 160         for allowedip in allowed_clients:
 161             if client_ip.startswith(allowedip):
 162                 return True
 163
 164         self.send_response(404)
 165         self.send_header('Content-type', 'text/html')
 166         self.end_headers()
 167         self.wfile.write("Unauthorized.")
 168         return False
 169
 170     def log_message(self, format, *args):
 171         self.server.logger.info("%s [%s] %s" % (self.address_string(),
 172                                 self.log_date_time_string(), format%args))
 173
 174     def root_container(self):
 175         tsn = self.headers.getheader('TiVo_TCD_ID', '')
 176         tsnshares = config.getShares(tsn)
 177         tsncontainers = {}
 178         for section, settings in tsnshares:
 179             try:
 180                 settings['content_type'] = \
 181                     GetPlugin(settings['type']).CONTENT_TYPE
 182                 tsncontainers[section] = settings
 183             except Exception, msg:
 184                 self.server.logger.error(section + ' - ' + msg)
 185         t = Template(file=os.path.join(SCRIPTDIR, 'templates',
 186                                        'root_container.tmpl'),
 187                      filter=EncodeUnicode)
 188         t.containers = tsncontainers
 189         t.hostname = socket.gethostname()
 190         t.escape = escape
 191         t.quote = quote
 192         self.send_response(200)
 193         self.end_headers()
 194         self.wfile.write(t)
 195
 196     def infopage(self):
 197         self.send_response(200)
 198         self.send_header('Content-type', 'text/html')
 199         self.end_headers()
 200         t = Template(file=os.path.join(SCRIPTDIR, 'templates',
 201                                        'info_page.tmpl'))
 202         t.admin = ''
 203         for section, settings in config.getShares():
 204             if 'type' in settings and settings['type'] == 'admin':
 205                 t.admin += ('<a href="/TiVoConnect?Command=Admin&Container=' +
 206                             quote(section) +
 207                             '">Web Configuration</a><br>' +
 208                             '<a href="/TiVoConnect?Command=NPL&Container=' +
 209                             quote(section) + '">ToGo</a><br>')
 210         if t.admin == '':
 211             t.admin = ('<br><b>No Admin plugin installed in pyTivo.conf</b>' +
 212                        '<br> If you wish to use the admin plugin add the ' +
 213                        'following lines to pyTivo.conf<br><br>' +
 214                        '[Admin]<br>type=admin')
 215
 216         if (config.get_server('tivo_username') and
 217             config.get_server('tivo_password')):
 218             t.shares = 'Push from video shares:<br/>'
 219             for section, settings in config.getShares():
 220                 if settings.get('type') == 'video':
 221                     t.shares += ('<a href="TiVoConnect?Command=' +
 222                                  'QueryContainer&Container=' +
 223                                  quote(section) + '">' + section + '</a><br/>')
 224         else:
 225             t.shares = ''
 226
 227         self.wfile.write(t)
 228
 229     def unsupported(self, query):
 230         self.send_response(404)
 231         self.send_header('Content-type', 'text/html')
 232         self.end_headers()
 233         t = Template(file=os.path.join(SCRIPTDIR, 'templates',
 234                                        'unsupported.tmpl'))
 235         t.query = query
 236         self.wfile.write(t)