config.py

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