You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
269 lines
8.0 KiB
269 lines
8.0 KiB
from __future__ import with_statement
|
|
|
|
from hashlib import md5
|
|
|
|
from couchpotato.api import addApiView
|
|
from couchpotato.core.event import addEvent, fireEvent
|
|
from couchpotato.core.helpers.database import HashIndex
|
|
from couchpotato.core.helpers.encoding import toUnicode
|
|
from six.moves import configparser
|
|
from couchpotato.core.helpers.variable import mergeDicts, tryInt, tryFloat
|
|
import six
|
|
|
|
|
|
class Settings(object):
|
|
|
|
options = {}
|
|
types = {}
|
|
|
|
def __init__(self):
|
|
|
|
addApiView('settings', self.view, docs = {
|
|
'desc': 'Return the options and its values of settings.conf. Including the default values and group ordering used on the settings page.',
|
|
'return': {'type': 'object', 'example': """{
|
|
// objects like in __init__.py of plugin
|
|
"options": {
|
|
"moovee" : {
|
|
"groups" : [{
|
|
"description" : "SD movies only",
|
|
"name" : "#alt.binaries.moovee",
|
|
"options" : [{
|
|
"default" : false,
|
|
"name" : "enabled",
|
|
"type" : "enabler"
|
|
}],
|
|
"tab" : "providers"
|
|
}],
|
|
"name" : "moovee"
|
|
}
|
|
},
|
|
// object structured like settings.conf
|
|
"values": {
|
|
"moovee": {
|
|
"enabled": false
|
|
}
|
|
}
|
|
}"""}
|
|
})
|
|
|
|
addApiView('settings.save', self.saveView, docs = {
|
|
'desc': 'Save setting to config file (settings.conf)',
|
|
'params': {
|
|
'section': {'desc': 'The section name in settings.conf'},
|
|
'name': {'desc': 'The option name'},
|
|
'value': {'desc': 'The value you want to save'},
|
|
}
|
|
})
|
|
|
|
addEvent('database.setup', self.databaseSetup)
|
|
|
|
self.file = None
|
|
self.p = None
|
|
self.log = None
|
|
|
|
def setFile(self, config_file):
|
|
self.file = config_file
|
|
|
|
self.p = configparser.RawConfigParser()
|
|
self.p.read(config_file)
|
|
|
|
from couchpotato.core.logger import CPLog
|
|
self.log = CPLog(__name__)
|
|
|
|
self.connectEvents()
|
|
|
|
def databaseSetup(self):
|
|
fireEvent('database.setup_index', 'property', PropertyIndex)
|
|
|
|
def parser(self):
|
|
return self.p
|
|
|
|
def sections(self):
|
|
return self.p.sections()
|
|
|
|
def connectEvents(self):
|
|
addEvent('settings.options', self.addOptions)
|
|
addEvent('settings.register', self.registerDefaults)
|
|
addEvent('settings.save', self.save)
|
|
|
|
def registerDefaults(self, section_name, options = None, save = True):
|
|
if not options: options = {}
|
|
|
|
self.addSection(section_name)
|
|
|
|
for option_name, option in options.items():
|
|
self.setDefault(section_name, option_name, option.get('default', ''))
|
|
|
|
# Migrate old settings from old location to the new location
|
|
if option.get('migrate_from'):
|
|
if self.p.has_option(option.get('migrate_from'), option_name):
|
|
previous_value = self.p.get(option.get('migrate_from'), option_name)
|
|
self.p.set(section_name, option_name, previous_value)
|
|
self.p.remove_option(option.get('migrate_from'), option_name)
|
|
|
|
if option.get('type'):
|
|
self.setType(section_name, option_name, option.get('type'))
|
|
|
|
if save:
|
|
self.save()
|
|
|
|
def set(self, section, option, value):
|
|
return self.p.set(section, option, value)
|
|
|
|
def get(self, option = '', section = 'core', default = None, type = None):
|
|
try:
|
|
|
|
try: type = self.types[section][option]
|
|
except: type = 'unicode' if not type else type
|
|
|
|
if hasattr(self, 'get%s' % type.capitalize()):
|
|
return getattr(self, 'get%s' % type.capitalize())(section, option)
|
|
else:
|
|
return self.getUnicode(section, option)
|
|
|
|
except:
|
|
return default
|
|
|
|
def delete(self, option = '', section = 'core'):
|
|
self.p.remove_option(section, option)
|
|
self.save()
|
|
|
|
def getEnabler(self, section, option):
|
|
return self.getBool(section, option)
|
|
|
|
def getBool(self, section, option):
|
|
try:
|
|
return self.p.getboolean(section, option)
|
|
except:
|
|
return self.p.get(section, option) == 1
|
|
|
|
def getInt(self, section, option):
|
|
try:
|
|
return self.p.getint(section, option)
|
|
except:
|
|
return tryInt(self.p.get(section, option))
|
|
|
|
def getFloat(self, section, option):
|
|
try:
|
|
return self.p.getfloat(section, option)
|
|
except:
|
|
return tryFloat(self.p.get(section, option))
|
|
|
|
def getUnicode(self, section, option):
|
|
value = self.p.get(section, option)
|
|
if six.PY2:
|
|
value = value.decode('unicode_escape')
|
|
|
|
return toUnicode(value).strip()
|
|
|
|
def getValues(self):
|
|
values = {}
|
|
for section in self.sections():
|
|
values[section] = {}
|
|
for option in self.p.items(section):
|
|
(option_name, option_value) = option
|
|
values[section][option_name] = self.get(option_name, section)
|
|
return values
|
|
|
|
def save(self):
|
|
with open(self.file, 'w') as configfile:
|
|
self.p.write(configfile)
|
|
|
|
self.log.debug('Saved settings')
|
|
|
|
def addSection(self, section):
|
|
if not self.p.has_section(section):
|
|
self.p.add_section(section)
|
|
|
|
def setDefault(self, section, option, value):
|
|
if not self.p.has_option(section, option):
|
|
self.p.set(section, option, value)
|
|
|
|
def setType(self, section, option, type):
|
|
if not self.types.get(section):
|
|
self.types[section] = {}
|
|
|
|
self.types[section][option] = type
|
|
|
|
def addOptions(self, section_name, options):
|
|
|
|
if not self.options.get(section_name):
|
|
self.options[section_name] = options
|
|
else:
|
|
self.options[section_name] = mergeDicts(self.options[section_name], options)
|
|
|
|
def getOptions(self):
|
|
return self.options
|
|
|
|
def view(self, **kwargs):
|
|
return {
|
|
'options': self.getOptions(),
|
|
'values': self.getValues()
|
|
}
|
|
|
|
def saveView(self, **kwargs):
|
|
|
|
section = kwargs.get('section')
|
|
option = kwargs.get('name')
|
|
value = kwargs.get('value')
|
|
|
|
# See if a value handler is attached, use that as value
|
|
new_value = fireEvent('setting.save.%s.%s' % (section, option), value, single = True)
|
|
|
|
self.set(section, option, (new_value if new_value else value).encode('unicode_escape'))
|
|
self.save()
|
|
|
|
# After save (for re-interval etc)
|
|
fireEvent('setting.save.%s.%s.after' % (section, option), single = True)
|
|
fireEvent('setting.save.%s.*.after' % section, single = True)
|
|
|
|
return {
|
|
'success': True,
|
|
}
|
|
|
|
def getProperty(self, identifier):
|
|
from couchpotato import get_db
|
|
|
|
db = get_db()
|
|
prop = None
|
|
try:
|
|
propert = db.get('property', identifier, with_doc = True)
|
|
prop = propert['doc']['value']
|
|
except:
|
|
pass # self.log.debug('Property "%s" doesn\'t exist: %s', (identifier, traceback.format_exc(0)))
|
|
|
|
return prop
|
|
|
|
def setProperty(self, identifier, value = ''):
|
|
from couchpotato import get_db
|
|
|
|
db = get_db()
|
|
|
|
try:
|
|
p = db.get('property', identifier, with_doc = True)
|
|
p['doc'].update({
|
|
'identifier': identifier,
|
|
'value': toUnicode(value),
|
|
})
|
|
db.update(p['doc'])
|
|
except:
|
|
db.insert({
|
|
'_t': 'property',
|
|
'identifier': identifier,
|
|
'value': toUnicode(value),
|
|
})
|
|
|
|
|
|
class PropertyIndex(HashIndex):
|
|
_version = 1
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
kwargs['key_format'] = '32s'
|
|
super(PropertyIndex, self).__init__(*args, **kwargs)
|
|
|
|
def make_key(self, key):
|
|
return md5(key).hexdigest()
|
|
|
|
def make_key_value(self, data):
|
|
if data.get('_t') == 'property':
|
|
return md5(data['identifier']).hexdigest(), None
|
|
|