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():
 100     return get_server('tivo_mind', 'mind.tivo.com:8181')
 101
 102 def getBeaconAddresses():
 103     return get_server('beacon', '255.255.255.255')
 104
 105 def getPort():
 106     return get_server('port', '9032')
 107
 108 def get169Blacklist(tsn):  # tivo does not pad 16:9 video
 109     return tsn and not isHDtivo(tsn) and not get169Letterbox(tsn)
 110     # verified Blacklist Tivo's are ('130', '240', '540')
 111     # It is assumed all remaining non-HD and non-Letterbox tivos are Blacklist
 112
 113 def get169Letterbox(tsn):  # tivo pads 16:9 video for 4:3 display
 114     return tsn and tsn[:3] in ['649']
 115
 116 def get169Setting(tsn):
 117     if not tsn:
 118         return True
 119
 120     tsnsect = '_tivo_' + tsn
 121     if config.has_section(tsnsect):
 122         if config.has_option(tsnsect, 'aspect169'):
 123             try:
 124                 return config.getboolean(tsnsect, 'aspect169')
 125             except ValueError:
 126                 pass
 127
 128     if get169Blacklist(tsn) or get169Letterbox(tsn):
 129         return False
 130
 131     return True
 132
 133 def getAllowedClients():
 134     return get_server('allowedips', '').split()
 135
 136 def getIsExternal(tsn):
 137     tsnsect = '_tivo_' + tsn
 138     if tsnsect in config.sections():
 139         if config.has_option(tsnsect, 'external'):
 140             try:
 141                 return config.getboolean(tsnsect, 'external')
 142             except ValueError:
 143                 pass
 144
 145     return False
 146
 147 def isTsnInConfig(tsn):
 148     return ('_tivo_' + tsn) in config.sections()
 149
 150 def getShares(tsn=''):
 151     shares = [(section, dict(config.items(section)))
 152               for section in config.sections()
 153               if not (section.startswith('_tivo_')
 154                       or section.startswith('logger_')
 155                       or section.startswith('handler_')
 156                       or section.startswith('formatter_')
 157                       or section in ('Server', 'loggers', 'handlers',
 158                                      'formatters')
 159               )
 160     ]
 161
 162     tsnsect = '_tivo_' + tsn
 163     if config.has_section(tsnsect) and config.has_option(tsnsect, 'shares'):
 164         # clean up leading and trailing spaces & make sure ref is valid
 165         tsnshares = []
 166         for x in config.get(tsnsect, 'shares').split(','):
 167             y = x.strip()
 168             if config.has_section(y):
 169                 tsnshares.append((y, dict(config.items(y))))
 170         if tsnshares:
 171             shares = tsnshares
 172
 173     return shares
 174
 175 def getDebug():
 176     try:
 177         return config.getboolean('Server', 'debug')
 178     except NoOptionError, ValueError:
 179         return False
 180
 181 def getOptres(tsn=None):
 182     if tsn and config.has_section('_tivo_' + tsn):
 183         try:
 184             return config.getboolean('_tivo_' + tsn, 'optres')
 185         except NoOptionError, ValueError:
 186             pass
 187     section_name = get_section(tsn)
 188     if config.has_section(section_name):
 189         try:
 190             return config.getboolean(section_name, 'optres')
 191         except NoOptionError, ValueError:
 192             pass
 193     try:
 194         return config.getboolean('Server', 'optres')
 195     except NoOptionError, ValueError:
 196         return False
 197
 198 def getPixelAR(ref):
 199     if config.has_option('Server', 'par'):
 200         try:
 201             return (True, config.getfloat('Server', 'par'))[ref]
 202         except NoOptionError, ValueError:
 203             pass
 204     return (False, 1.0)[ref]
 205
 206 def get_bin(fname):
 207     if config.has_option('Server', fname):
 208         return config.get('Server', fname)
 209     else:
 210         global bin_paths
 211         if fname in bin_paths:
 212             return bin_paths[fname]
 213         if sys.platform == 'win32':
 214             fname += '.exe'
 215         for path in ([os.path.join(os.path.dirname(__file__), 'bin')] +
 216                      os.getenv('PATH').split(os.pathsep)):
 217             fpath = os.path.join(path, fname)
 218             if os.path.exists(fpath) and os.path.isfile(fpath):
 219                 bin_paths[fname] = fpath
 220                 return fpath
 221         return None
 222
 223 def getFFmpegWait():
 224     if config.has_option('Server', 'ffmpeg_wait'):
 225         return max(int(float(config.get('Server', 'ffmpeg_wait'))), 1)
 226     else:
 227         return 10
 228
 229 def getFFmpegTemplate(tsn):
 230     tmpl = get_tsn('ffmpeg_tmpl', tsn, True)
 231     if tmpl:
 232         return tmpl
 233     return '%(video_codec)s %(video_fps)s %(video_br)s %(max_video_br)s \
 234             %(buff_size)s %(aspect_ratio)s %(audio_br)s \
 235             %(audio_fr)s %(audio_ch)s %(audio_codec)s %(audio_lang)s \
 236             %(ffmpeg_pram)s %(format)s'
 237
 238 def getFFmpegPrams(tsn):
 239     return get_tsn('ffmpeg_pram', tsn, True)
 240
 241 def isHDtivo(tsn):  # tsn's of High Definition Tivo's
 242     return bool(tsn and tsn[:3] in ['648', '652', '658', '663'])
 243
 244 def getValidWidths():
 245     return [1920, 1440, 1280, 720, 704, 544, 480, 352]
 246
 247 def getValidHeights():
 248     return [1080, 720, 480] # Technically 240 is also supported
 249
 250 # Return the number in list that is nearest to x
 251 # if two values are equidistant, return the larger
 252 def nearest(x, list):
 253     return reduce(lambda a, b: closest(x, a, b), list)
 254
 255 def closest(x, a, b):
 256     da = abs(x - a)
 257     db = abs(x - b)
 258     if da < db or (da == db and a > b):
 259         return a
 260     else:
 261         return b
 262
 263 def nearestTivoHeight(height):
 264     return nearest(height, getValidHeights())
 265
 266 def nearestTivoWidth(width):
 267     return nearest(width, getValidWidths())
 268
 269 def getTivoHeight(tsn):
 270     height = get_tsn('height', tsn)
 271     if height:
 272         return nearestTivoHeight(int(height))
 273     return [480, 1080][isHDtivo(tsn)]
 274
 275 def getTivoWidth(tsn):
 276     width = get_tsn('width', tsn)
 277     if width:
 278         return nearestTivoWidth(int(width))
 279     return [544, 1920][isHDtivo(tsn)]
 280
 281 def _trunc64(i):
 282     return max(int(strtod(i)) / 64000, 1) * 64
 283
 284 def getAudioBR(tsn=None):
 285     rate = get_tsn('audio_br', tsn)
 286     if not rate:
 287         rate = '448k'
 288     # convert to non-zero multiple of 64 to ensure ffmpeg compatibility
 289     # compare audio_br to max_audio_br and return lowest
 290     return str(min(_trunc64(rate), getMaxAudioBR(tsn))) + 'k'
 291
 292 def _k(i):
 293     return str(int(strtod(i)) / 1000) + 'k'
 294
 295 def getVideoBR(tsn=None):
 296     rate = get_tsn('video_br', tsn)
 297     if rate:
 298         return _k(rate)
 299     return ['4096K', '16384K'][isHDtivo(tsn)]
 300
 301 def getMaxVideoBR(tsn=None):
 302     rate = get_tsn('max_video_br', tsn)
 303     if rate:
 304         return _k(rate)
 305     return '30000k'
 306
 307 def getVideoPCT(tsn=None):
 308     pct = get_tsn('video_pct', tsn)
 309     if pct:
 310         return float(pct)
 311     return 85
 312
 313 def getBuffSize(tsn=None):
 314     size = get_tsn('bufsize', tsn)
 315     if size:
 316         return _k(size)
 317     return ['1024k', '4096k'][isHDtivo(tsn)]
 318
 319 def getMaxAudioBR(tsn=None):
 320     rate = get_tsn('max_audio_br', tsn)
 321     # convert to non-zero multiple of 64 for ffmpeg compatibility
 322     if rate:
 323         return _trunc64(rate)
 324     return 448
 325
 326 def get_section(tsn):
 327     return ['_tivo_SD', '_tivo_HD'][isHDtivo(tsn)]
 328
 329 def get_tsn(name, tsn=None, raw=False):
 330     if tsn and config.has_section('_tivo_' + tsn):
 331         try:
 332             return config.get('_tivo_' + tsn, name, raw)
 333         except NoOptionError:
 334             pass
 335     section_name = get_section(tsn)
 336     if config.has_section(section_name):
 337         try:
 338             return config.get(section_name, name, raw)
 339         except NoOptionError:
 340             pass
 341     try:
 342         return config.get('Server', name, raw)
 343     except NoOptionError:
 344         pass
 345     return None
 346
 347 # Parse a bitrate using the SI/IEEE suffix values as if by ffmpeg
 348 # For example, 2K==2000, 2Ki==2048, 2MB==16000000, 2MiB==16777216
 349 # Algorithm: http://svn.mplayerhq.hu/ffmpeg/trunk/libavcodec/eval.c
 350 def strtod(value):
 351     prefixes = {'y': -24, 'z': -21, 'a': -18, 'f': -15, 'p': -12,
 352                 'n': -9,  'u': -6,  'm': -3,  'c': -2,  'd': -1,
 353                 'h': 2,   'k': 3,   'K': 3,   'M': 6,   'G': 9,
 354                 'T': 12,  'P': 15,  'E': 18,  'Z': 21,  'Y': 24}
 355     p = re.compile(r'^(\d+)(?:([yzafpnumcdhkKMGTPEZY])(i)?)?([Bb])?$')
 356     m = p.match(value)
 357     if not m:
 358         raise SyntaxError('Invalid bit value syntax')
 359     (coef, prefix, power, byte) = m.groups()
 360     if prefix is None:
 361         value = float(coef)
 362     else:
 363         exponent = float(prefixes[prefix])
 364         if power == 'i':
 365             # Use powers of 2
 366             value = float(coef) * pow(2.0, exponent / 0.3)
 367         else:
 368             # Use powers of 10
 369             value = float(coef) * pow(10.0, exponent)
 370     if byte == 'B': # B == Byte, b == bit
 371         value *= 8;
 372     return value
 373
 374 def init_logging():
 375     if (config.has_section('loggers') and
 376         config.has_section('handlers') and
 377         config.has_section('formatters')):
 378
 379         logging.config.fileConfig(config_files)
 380
 381     elif getDebug():
 382         logging.basicConfig(level=logging.DEBUG)
 383     else:
 384         logging.basicConfig(level=logging.INFO)