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