# encoding: utf-8
# api: streamtuner2
# title: Config dialog
# description: Allows to configure players, options, and plugins
# version: 2.7
# type: feature
# category: ui
# config: -
# priority: core
#
# Configuration dialog for audio applications,
# general settings, and plugin activaiton and
# their options.
from uikit import *
import channels
from config import *
from pluginconf import all_plugin_meta
import re
# Settings window
#
# Interacts with main.* window (gtkBuilder widgets)
# and conf.* dictionary.
#
class configwin (AuxiliaryWindow):
# control flags
meta = plugin_meta()
# Display win_config, pre-fill text fields from global conf. object
def open(self, widget):
if self.first_open:
self.add_plugins()
self.first_open = 0
self.win_config.resize(565, 625)
self.load_config(conf.__dict__, "config_")
self.load_config(conf.plugins, "config_plugins_")
[callback() for callback in self.hooks["config_load"]]
self.win_config.show_all()
first_open = 1
# Hide window
def hide(self, *args):
self.win_config.hide()
return True
# Load values from conf. store into gtk widgets
def load_config(self, config, prefix="config_", widgets={}):
for key,val in config.items():
w = self.main.get_widget(prefix + key) or widgets.get(prefix + key)
#log.CONF("load_config()", prefix+key, "=", val, "→", type(w))
if w:
# number
if isinstance(w, gtk.SpinButton):
w.set_value(int(val))
# input field
elif isinstance(w, gtk.Entry):
w.set_text(str(val))
# checkmark
elif isinstance(w, gtk.CheckButton):
w.set_active(bool(val))
# dropdown
elif isinstance(w, ComboBoxText):
w.set_default(str(val))
# list
elif isinstance(w, gtk.ListStore):
w.clear()
if isinstance(val, dict):
for k,v in val.items():
w.append([k, v, uikit.app_bin_check(v)])
w.append(["", "", gtk.STOCK_NEW])
elif isinstance(val, list):
for row in val:
log.DATA(row)
w.append([str(e) for e in row])
if len(val):
w.append(["" for e in val[0]])
# Store gtk widget valus back into conf. dict
def save_config(self, config, prefix="config_", save=0, widgets={}):
for key,val in config.items():
w = self.main.get_widget(prefix + key) or widgets.get(prefix + key)
if w:
# int
if isinstance(w, gtk.SpinButton):
config[key] = int(w.get_value())
# text
elif isinstance(w, gtk.Entry):
config[key] = w.get_text()
# pre-defined text
elif isinstance(w, ComboBoxText):
config[key] = w.get_active_text()
# boolean
elif isinstance(w, gtk.CheckButton):
config[key] = w.get_active()
# dict
elif isinstance(w, gtk.ListStore):
if key in config and isinstance(config[key], list):
config[key] = []
for row in w:
config[key].append([str(e) for e in row])
else:
config[key] = {}
for row in w:
if row[0] and row[1]:
config[key][row[0]] = row[1]
log.CONF("config save", prefix+key, val)
# iterate over channel and feature plugins
def add_plugins(self):
ls = all_plugin_meta()
for name,meta in sorted(ls.items(), key=lambda e: e[1]["type"]+e[1]["title"].lower(), reverse=False):
if not name in conf.plugins:
conf.plugins[name] = False
conf.add_plugin_defaults(meta, name)
pack_ = self.pack_channels if meta.get("type") == "channel" else self.pack_features
self.add_plg(name, meta, pack_)
pass
# Description text
plugin_text = "<span size='larger' weight='heavy'>{title}</span> "\
+ "<span style='italic' foreground='slate blue'>({type}/{category})</span> "\
+ "<span weight='bold' foreground='#777777'>{version}</span>\n"\
+ "<span size='smaller' stretch='ultraexpanded'>{description}</span>"
# Add [x] plugin setting, and its configuration definitions, set defaults from conf.*
def add_plg(self, name, meta, pack_, prefix_="config_"):
# Plugin enable button
cb = gtk.CheckButton(name)
cb.set_sensitive(not meta.get("priority") in ("core", "required", "builtin"))
cb.get_children()[0].set_markup(self.plugin_text.format(**meta))
cb.set_tooltip_text(self._tooltip(meta))
pack_("config_plugins_"+name, cb, color=meta.get("color"), image=meta.get("png"), align=0)
# Default values are already in conf[] dict
# (now done in conf.add_plugin_defaults)
for opt in meta["config"]:
color = opt.get("color", None)
type = opt.get("type", "str")
desc = opt.get("description", "./.")
# hidden
if opt.get("hidden"):
continue
# display checkbox
elif type in ("bool", "boolean"):
cb = gtk.CheckButton(desc)
if re.search("<(\w+)[^>]*>.+</\\1>", desc):
cb.get_child().set_use_markup(True)
desc = None
# drop down list
elif type in ("select", "choose", "options"):
cb = ComboBoxText(ComboBoxText.parse_options(opt.get("select"))) # custom uikit widget
# numeric
elif type in ("int", "integer", "numeric"):
adj = gtk.Adjustment(0, 0, int(opt.get("max", 5000)), 1, 10, 0)
if ver == 2:
cb = gtk.SpinButton(adj, 1.0, 0)
else:
cb = gtk.SpinButton()
cb.set_adjustment(adj)
cb.set_digits(0)
# ListView
elif opt["type"] in ("list", "table", "array", "dict"):
cb, ls = uikit.config_treeview(opt, opt.get("columns", "Key,Value").split(","))
pack_("cfgui_tv", cb, "", None, opt=opt)
self.widgets["config_" + opt["name"]] = ls
pack_({}, uikit.label("<small>%s</small>" % desc, markup=True, size=455))
continue
# text field
else:
cb = gtk.Entry()
pack_( prefix_+opt["name"], cb, desc, color, opt=opt )
# spacer between plugins
pack_( None, gtk.HSeparator() )
# Reformat `doc` linebreaks for gtk.tooltip
def _tooltip(self, meta):
doc = meta.get("doc", "").strip()
if ver < 3:
doc = re.sub("(?<=\S) *\n(?! *\n)", " ", doc)
return doc
# Put config widgets into channels/features configwin notebooks
def pack_channels(self, id=None, w=None, label=None, color=None, image=None, align=20, opt={}):
self.plugin_options.pack_start(uikit.wrap(self.widgets, id, w, label, color, image, align, label_markup=1))
# Separate tab for non-channel plugins
def pack_features(self, id=None, w=None, label=None, color=None, image=None, align=20, opt={}):
self.feature_options.pack_start(uikit.wrap(self.widgets, id, w, label, color, image, align, label_markup=1))
# save config
def save(self, widget):
self.save_config(conf.__dict__, "config_")
self.save_config(conf.plugins, "config_plugins_")
[callback() for callback in self.hooks["config_save"]]
conf.save(nice=1)
self.hide()