config.py

   1 import ConfigParser
   2 import getopt
   3 import logging
   4 import logging.config
   5 import os
   6 import re
   7 import random
   8 import socket
   9 import string
  10 import sys
  11 from ConfigParser import NoOptionError
  12
  13 guid = ''.join([random.choice(string.letters) for i in range(10)])
  14 our_ip = ''
  15 config = ConfigParser.ConfigParser()
  16
  17 p = os.path.dirname(__file__)
  18 config_files = ['/etc/pyTivo.conf', os.path.join(p, 'pyTivo.conf')]
  19 configs_found = []
  20
  21 tivos = {}
  22 tivo_names = {}
  23 bin_paths = {}
  24
  25 def init(argv):
  26     global config_files
  27     global configs_found
  28     global tivo_names
  29
  30     try:
  31         opts, _ = getopt.getopt(argv, 'c:e:', ['config=', 'extraconf='])
  32     except getopt.GetoptError, msg:
  33         print msg
  34
  35     for opt, value in opts:
  36         if opt in ('-c', '--config'):
  37             config_files = [value]
  38         elif opt in ('-e', '--extraconf'):
  39             config_files.append(value)
  40
  41     configs_found = config.read(config_files)
  42     if not configs_found:
  43         print ('ERROR: pyTivo.conf does not exist.\n' +
  44                'You must create this file before running pyTivo.')
  45         sys.exit(1)
  46
  47     for section in config.sections():
  48         if section.startswith('_tivo_'):
  49             tsn = section[6:]
  50             if tsn.upper() not in ['SD', 'HD']:
  51                 if config.has_option(section, 'name'):
  52                     tivo_names[tsn] = config.get(section, 'name')
  53                 else:
  54                     tivo_names[tsn] = tsn
  55
  56 def reset():
  57     global config
  58     newconfig = ConfigParser.ConfigParser()
  59     newconfig.read(config_files)
  60     config = newconfig
  61
  62 def write():
  63     f = open(configs_found[-1], 'w')
  64     config.write(f)
  65     f.close()
  66
  67 def get_server(name, default=None):
  68     if config.has_option('Server', name):
  69         return config.get('Server', name)
  70     else:
  71         return default
  72
  73 def getGUID():
  74     return guid
  75
  76 def get_ip():
  77     global our_ip
  78     if not our_ip:
  79         s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  80         s.connect(('4.2.2.1', 123))
  81         our_ip = s.getsockname()[0]
  82     return our_ip
  83
  84 def get_zc():
  85     opt = get_server('zeroconf', 'auto').lower()
  86
  87     if opt == 'auto':
  88         for section in config.sections():
  89             if section.startswith('_tivo_'):
  90                 if config.has_option(section, 'shares'):
  91                     logger = logging.getLogger('pyTivo.config')
  92                     logger.info('Shares security in use -- zeroconf disabled')
  93                     return False
  94     elif opt in ['false', 'no', 'off']:
  95         return False
  96
  97     return True
  98
  99 def get_mind(tsn):
 100     if tsn and tsn.startswith('663'):
 101         default = 'symind.tivo.com:8181'
 102     else:
 103         default = 'mind.tivo.com:8181'
 104     return get_server('tivo_mind', default)
 105
 106 def getBeaconAddresses():
 107     return get_server('beacon', '255.255.255.255')
 108
 109 def getPort():
 110     return get_server('port', '9032')
 111
 112 def get169Blacklist(tsn):  # tivo does not pad 16:9 video
 113     return tsn and not isHDtivo(tsn) and not get169Letterbox(tsn)
 114     # verified Blacklist Tivo's are ('130', '240', '540')
 115     # It is assumed all remaining non-HD and non-Letterbox tivos are Blacklist
 116
 117 def get169Letterbox(tsn):  # tivo pads 16:9 video for 4:3 display
 118     return tsn and tsn[:3] in ['649']
 119
 120 def get169Setting(tsn):
 121     if not tsn:
 122         return True
 123
 124     tsnsect = '_tivo_' + tsn
 125     if config.has_section(tsnsect):
 126         if config.has_option(tsnsect, 'aspect169'):
 127             try:
 128                 return config.getboolean(tsnsect, 'aspect169')
 129             except ValueError:
 130                 pass
 131
 132     if get169Blacklist(tsn) or get169Letterbox(tsn):
 133         return False
 134
 135     return True
 136
 137 def getAllowedClients():
 138     return get_server('allowedips', '').split()
 139
 140 def getIsExternal(tsn):
 141     tsnsect = '_tivo_' + tsn
 142     if tsnsect in config.sections():
 143         if config.has_option(tsnsect, 'external'):
 144             try:
 145                 return config.getboolean(tsnsect, 'external')
 146             except ValueError:
 147                 pass
 148
 149     return False
 150
 151 def isTsnInConfig(tsn):
 152     return ('_tivo_' + tsn) in config.sections()
 153
 154 def getShares(tsn=''):
 155     shares = [(section, dict(config.items(section)))
 156               for section in config.sections()
 157               if not (section.startswith('_tivo_')
 158                       or section.startswith('logger_')
 159                       or section.startswith('handler_')
 160                       or section.startswith('formatter_')
 161                       or section in ('Server', 'loggers', 'handlers',
 162                                      'formatters')
 163               )
 164     ]
 165
 166     tsnsect = '_tivo_' + tsn
 167     if config.has_section(tsnsect) and config.has_option(tsnsect, 'shares'):
 168         # clean up leading and trailing spaces & make sure ref is valid
 169         tsnshares = []
 170         for x in config.get(tsnsect, 'shares').split(','):
 171             y = x.strip()
 172             if config.has_section(y):
 173                 tsnshares.append((y, dict(config.items(y))))
 174         if tsnshares:
 175             shares = tsnshares
 176
 177     shares.sort()
 178
 179     if get_server('nosettings', 'false').lower() in ['false', 'no', 'off']:
 180         shares.append(('Settings', {'type': 'settings'}))
 181     if get_server('tivo_mak') and get_server('togo_path'):
 182         shares.append(('ToGo', {'type': 'togo'}))
 183
 184     return shares
 185
 186 def getDebug():
 187     try:
 188         return config.getboolean('Server', 'debug')
 189     except NoOptionError, ValueError:
 190         return False
 191
 192 def getOptres(tsn=None):
 193     if tsn and config.has_section('_tivo_' + tsn):
 194         try:
 195             return config.getboolean('_tivo_' + tsn, 'optres')
 196         except NoOptionError, ValueError:
 197             pass
 198     section_name = get_section(tsn)
 199     if config.has_section(section_name):
 200         try:
 201             return config.getboolean(section_name, 'optres')
 202         except NoOptionError, ValueError:
 203             pass
 204     try:
 205         return config.getboolean('Server', 'optres')
 206     except NoOptionError, ValueError:
 207         return False
 208
 209 def getPixelAR(ref):
 210     if config.has_option('Server', 'par'):
 211         try:
 212             return (True, config.getfloat('Server', 'par'))[ref]
 213         except NoOptionError, ValueError:
 214             pass
 215     return (False, 1.0)[ref]
 216
 217 def get_bin(fname):
 218     if config.has_option('Server', fname):
 219         return config.get('Server', fname)
 220     else:
 221         global bin_paths
 222         if fname in bin_paths:
 223             return bin_paths[fname]
 224         if sys.platform == 'win32':
 225             fname += '.exe'
 226         for path in ([os.path.join(os.path.dirname(__file__), 'bin')] +
 227                      os.getenv('PATH').split(os.pathsep)):
 228             fpath = os.path.join(path, fname)
 229             if os.path.exists(fpath) and os.path.isfile(fpath):
 230                 bin_paths[fname] = fpath
 231                 return fpath
 232         return None
 233
 234 def getFFmpegWait():
 235     if config.has_option('Server', 'ffmpeg_wait'):
 236         return max(int(float(config.get('Server', 'ffmpeg_wait'))), 1)
 237     else:
 238         return 10
 239
 240 def getFFmpegTemplate(tsn):
 241     tmpl = get_tsn('ffmpeg_tmpl', tsn, True)
 242     if tmpl:
 243         return tmpl
 244     return '%(video_codec)s %(video_fps)s %(video_br)s %(max_video_br)s \
 245             %(buff_size)s %(aspect_ratio)s %(audio_br)s \
 246             %(audio_fr)s %(audio_ch)s %(audio_codec)s %(audio_lang)s \
 247             %(ffmpeg_pram)s %(format)s'
 248
 249 def getFFmpegPrams(tsn):
 250     return get_tsn('ffmpeg_pram', tsn, True)
 251
 252 def isHDtivo(tsn):  # tsn's of High Definition Tivo's
 253     return bool(tsn and tsn[:3] in ['648', '652', '658', '663'])
 254
 255 def getValidWidths():
 256     return [1920, 1440, 1280, 720, 704, 544, 480, 352]
 257
 258 def getValidHeights():
 259     return [1080, 720, 480] # Technically 240 is also supported
 260
 261 # Return the number in list that is nearest to x
 262 # if two values are equidistant, return the larger
 263 def nearest(x, list):
 264     return reduce(lambda a, b: closest(x, a, b), list)
 265
 266 def closest(x, a, b):
 267     da = abs(x - a)
 268     db = abs(x - b)
 269     if da < db or (da == db and a > b):
 270         return a
 271     else:
 272         return b
 273
 274 def nearestTivoHeight(height):
 275     return nearest(height, getValidHeights())
 276
 277 def nearestTivoWidth(width):
 278     return nearest(width, getValidWidths())
 279
 280 def getTivoHeight(tsn):
 281     height = get_tsn('height', tsn)
 282     if height:
 283         return nearestTivoHeight(int(height))
 284     return [480, 1080][isHDtivo(tsn)]
 285
 286 def getTivoWidth(tsn):
 287     width = get_tsn('width', tsn)
 288     if width:
 289         return nearestTivoWidth(int(width))
 290     return [544, 1920][isHDtivo(tsn)]
 291
 292 def _trunc64(i):
 293     return max(int(strtod(i)) / 64000, 1) * 64
 294
 295 def getAudioBR(tsn=None):
 296     rate = get_tsn('audio_br', tsn)
 297     if not rate:
 298         rate = '448k'
 299     # convert to non-zero multiple of 64 to ensure ffmpeg compatibility
 300     # compare audio_br to max_audio_br and return lowest
 301     return str(min(_trunc64(rate), getMaxAudioBR(tsn))) + 'k'
 302
 303 def _k(i):
 304     return str(int(strtod(i)) / 1000) + 'k'
 305
 306 def getVideoBR(tsn=None):
 307     rate = get_tsn('video_br', tsn)
 308     if rate:
 309         return _k(rate)
 310     return ['4096K', '16384K'][isHDtivo(tsn)]
 311
 312 def getMaxVideoBR(tsn=None):
 313     rate = get_tsn('max_video_br', tsn)
 314     if rate:
 315         return _k(rate)
 316     return '30000k'
 317
 318 def getVideoPCT(tsn=None):
 319     pct = get_tsn('video_pct', tsn)
 320     if pct:
 321         return float(pct)
 322     return 85
 323
 324 def getBuffSize(tsn=None):
 325     size = get_tsn('bufsize', tsn)
 326     if size:
 327         return _k(size)
 328     return ['1024k', '4096k'][isHDtivo(tsn)]
 329
 330 def getMaxAudioBR(tsn=None):
 331     rate = get_tsn('max_audio_br', tsn)
 332     # convert to non-zero multiple of 64 for ffmpeg compatibility
 333     if rate:
 334         return _trunc64(rate)
 335     return 448
 336
 337 def get_section(tsn):
 338     return ['_tivo_SD', '_tivo_HD'][isHDtivo(tsn)]
 339
 340 def get_tsn(name, tsn=None, raw=False):
 341     if tsn and config.has_section('_tivo_' + tsn):
 342         try:
 343             return config.get('_tivo_' + tsn, name, raw)
 344         except NoOptionError:
 345             pass
 346     section_name = get_section(tsn)
 347     if config.has_section(section_name):
 348         try:
 349             return config.get(section_name, name, raw)
 350         except NoOptionError:
 351             pass
 352     try:
 353         return config.get('Server', name, raw)
 354     except NoOptionError:
 355         pass
 356     return None
 357
 358 # Parse a bitrate using the SI/IEEE suffix values as if by ffmpeg
 359 # For example, 2K==2000, 2Ki==2048, 2MB==16000000, 2MiB==16777216
 360 # Algorithm: http://svn.mplayerhq.hu/ffmpeg/trunk/libavcodec/eval.c
 361 def strtod(value):
 362     prefixes = {'y': -24, 'z': -21, 'a': -18, 'f': -15, 'p': -12,
 363                 'n': -9,  'u': -6,  'm': -3,  'c': -2,  'd': -1,
 364                 'h': 2,   'k': 3,   'K': 3,   'M': 6,   'G': 9,
 365                 'T': 12,  'P': 15,  'E': 18,  'Z': 21,  'Y': 24}
 366     p = re.compile(r'^(\d+)(?:([yzafpnumcdhkKMGTPEZY])(i)?)?([Bb])?$')
 367     m = p.match(value)
 368     if not m:
 369         raise SyntaxError('Invalid bit value syntax')
 370     (coef, prefix, power, byte) = m.groups()
 371     if prefix is None:
 372         value = float(coef)
 373     else:
 374         exponent = float(prefixes[prefix])
 375         if power == 'i':
 376             # Use powers of 2
 377             value = float(coef) * pow(2.0, exponent / 0.3)
 378         else:
 379             # Use powers of 10
 380             value = float(coef) * pow(10.0, exponent)
 381     if byte == 'B': # B == Byte, b == bit
 382         value *= 8;
 383     return value
 384
 385 def init_logging():
 386     if (config.has_section('loggers') and
 387         config.has_section('handlers') and
 388         config.has_section('formatters')):
 389
 390         logging.config.fileConfig(config_files)
 391
 392     elif getDebug():
 393         logging.basicConfig(level=logging.DEBUG)
 394     else:
 395         logging.basicConfig(level=logging.INFO)