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     shares.extend([('Settings', {'type': 'settings'}),
 174                    ('ToGo', {'type': 'togo'})])
 175     return shares
 176
 177 def getDebug():
 178     try:
 179         return config.getboolean('Server', 'debug')
 180     except NoOptionError, ValueError:
 181         return False
 182
 183 def getOptres(tsn=None):
 184     if tsn and config.has_section('_tivo_' + tsn):
 185         try:
 186             return config.getboolean('_tivo_' + tsn, 'optres')
 187         except NoOptionError, ValueError:
 188             pass
 189     section_name = get_section(tsn)
 190     if config.has_section(section_name):
 191         try:
 192             return config.getboolean(section_name, 'optres')
 193         except NoOptionError, ValueError:
 194             pass
 195     try:
 196         return config.getboolean('Server', 'optres')
 197     except NoOptionError, ValueError:
 198         return False
 199
 200 def getPixelAR(ref):
 201     if config.has_option('Server', 'par'):
 202         try:
 203             return (True, config.getfloat('Server', 'par'))[ref]
 204         except NoOptionError, ValueError:
 205             pass
 206     return (False, 1.0)[ref]
 207
 208 def get_bin(fname):
 209     if config.has_option('Server', fname):
 210         return config.get('Server', fname)
 211     else:
 212         global bin_paths
 213         if fname in bin_paths:
 214             return bin_paths[fname]
 215         if sys.platform == 'win32':
 216             fname += '.exe'
 217         for path in ([os.path.join(os.path.dirname(__file__), 'bin')] +
 218                      os.getenv('PATH').split(os.pathsep)):
 219             fpath = os.path.join(path, fname)
 220             if os.path.exists(fpath) and os.path.isfile(fpath):
 221                 bin_paths[fname] = fpath
 222                 return fpath
 223         return None
 224
 225 def getFFmpegWait():
 226     if config.has_option('Server', 'ffmpeg_wait'):
 227         return max(int(float(config.get('Server', 'ffmpeg_wait'))), 1)
 228     else:
 229         return 10
 230
 231 def getFFmpegTemplate(tsn):
 232     tmpl = get_tsn('ffmpeg_tmpl', tsn, True)
 233     if tmpl:
 234         return tmpl
 235     return '%(video_codec)s %(video_fps)s %(video_br)s %(max_video_br)s \
 236             %(buff_size)s %(aspect_ratio)s %(audio_br)s \
 237             %(audio_fr)s %(audio_ch)s %(audio_codec)s %(audio_lang)s \
 238             %(ffmpeg_pram)s %(format)s'
 239
 240 def getFFmpegPrams(tsn):
 241     return get_tsn('ffmpeg_pram', tsn, True)
 242
 243 def isHDtivo(tsn):  # tsn's of High Definition Tivo's
 244     return bool(tsn and tsn[:3] in ['648', '652', '658', '663'])
 245
 246 def getValidWidths():
 247     return [1920, 1440, 1280, 720, 704, 544, 480, 352]
 248
 249 def getValidHeights():
 250     return [1080, 720, 480] # Technically 240 is also supported
 251
 252 # Return the number in list that is nearest to x
 253 # if two values are equidistant, return the larger
 254 def nearest(x, list):
 255     return reduce(lambda a, b: closest(x, a, b), list)
 256
 257 def closest(x, a, b):
 258     da = abs(x - a)
 259     db = abs(x - b)
 260     if da < db or (da == db and a > b):
 261         return a
 262     else:
 263         return b
 264
 265 def nearestTivoHeight(height):
 266     return nearest(height, getValidHeights())
 267
 268 def nearestTivoWidth(width):
 269     return nearest(width, getValidWidths())
 270
 271 def getTivoHeight(tsn):
 272     height = get_tsn('height', tsn)
 273     if height:
 274         return nearestTivoHeight(int(height))
 275     return [480, 1080][isHDtivo(tsn)]
 276
 277 def getTivoWidth(tsn):
 278     width = get_tsn('width', tsn)
 279     if width:
 280         return nearestTivoWidth(int(width))
 281     return [544, 1920][isHDtivo(tsn)]
 282
 283 def _trunc64(i):
 284     return max(int(strtod(i)) / 64000, 1) * 64
 285
 286 def getAudioBR(tsn=None):
 287     rate = get_tsn('audio_br', tsn)
 288     if not rate:
 289         rate = '448k'
 290     # convert to non-zero multiple of 64 to ensure ffmpeg compatibility
 291     # compare audio_br to max_audio_br and return lowest
 292     return str(min(_trunc64(rate), getMaxAudioBR(tsn))) + 'k'
 293
 294 def _k(i):
 295     return str(int(strtod(i)) / 1000) + 'k'
 296
 297 def getVideoBR(tsn=None):
 298     rate = get_tsn('video_br', tsn)
 299     if rate:
 300         return _k(rate)
 301     return ['4096K', '16384K'][isHDtivo(tsn)]
 302
 303 def getMaxVideoBR(tsn=None):
 304     rate = get_tsn('max_video_br', tsn)
 305     if rate:
 306         return _k(rate)
 307     return '30000k'
 308
 309 def getVideoPCT(tsn=None):
 310     pct = get_tsn('video_pct', tsn)
 311     if pct:
 312         return float(pct)
 313     return 85
 314
 315 def getBuffSize(tsn=None):
 316     size = get_tsn('bufsize', tsn)
 317     if size:
 318         return _k(size)
 319     return ['1024k', '4096k'][isHDtivo(tsn)]
 320
 321 def getMaxAudioBR(tsn=None):
 322     rate = get_tsn('max_audio_br', tsn)
 323     # convert to non-zero multiple of 64 for ffmpeg compatibility
 324     if rate:
 325         return _trunc64(rate)
 326     return 448
 327
 328 def get_section(tsn):
 329     return ['_tivo_SD', '_tivo_HD'][isHDtivo(tsn)]
 330
 331 def get_tsn(name, tsn=None, raw=False):
 332     if tsn and config.has_section('_tivo_' + tsn):
 333         try:
 334             return config.get('_tivo_' + tsn, name, raw)
 335         except NoOptionError:
 336             pass
 337     section_name = get_section(tsn)
 338     if config.has_section(section_name):
 339         try:
 340             return config.get(section_name, name, raw)
 341         except NoOptionError:
 342             pass
 343     try:
 344         return config.get('Server', name, raw)
 345     except NoOptionError:
 346         pass
 347     return None
 348
 349 # Parse a bitrate using the SI/IEEE suffix values as if by ffmpeg
 350 # For example, 2K==2000, 2Ki==2048, 2MB==16000000, 2MiB==16777216
 351 # Algorithm: http://svn.mplayerhq.hu/ffmpeg/trunk/libavcodec/eval.c
 352 def strtod(value):
 353     prefixes = {'y': -24, 'z': -21, 'a': -18, 'f': -15, 'p': -12,
 354                 'n': -9,  'u': -6,  'm': -3,  'c': -2,  'd': -1,
 355                 'h': 2,   'k': 3,   'K': 3,   'M': 6,   'G': 9,
 356                 'T': 12,  'P': 15,  'E': 18,  'Z': 21,  'Y': 24}
 357     p = re.compile(r'^(\d+)(?:([yzafpnumcdhkKMGTPEZY])(i)?)?([Bb])?$')
 358     m = p.match(value)
 359     if not m:
 360         raise SyntaxError('Invalid bit value syntax')
 361     (coef, prefix, power, byte) = m.groups()
 362     if prefix is None:
 363         value = float(coef)
 364     else:
 365         exponent = float(prefixes[prefix])
 366         if power == 'i':
 367             # Use powers of 2
 368             value = float(coef) * pow(2.0, exponent / 0.3)
 369         else:
 370             # Use powers of 10
 371             value = float(coef) * pow(10.0, exponent)
 372     if byte == 'B': # B == Byte, b == bit
 373         value *= 8;
 374     return value
 375
 376 def init_logging():
 377     if (config.has_section('loggers') and
 378         config.has_section('handlers') and
 379         config.has_section('formatters')):
 380
 381         logging.config.fileConfig(config_files)
 382
 383     elif getDebug():
 384         logging.basicConfig(level=logging.DEBUG)
 385     else:
 386         logging.basicConfig(level=logging.INFO)