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