/usr/share/dicompyler/dicompyler/preferences.py is in dicompyler 0.4.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 | #!/usr/bin/env python
# -*- coding: ISO-8859-1 -*-
# preferences.py
"""Preferences manager for dicompyler."""
# Copyright (c) 2011-2012 Aditya Panchal
# This file is part of dicompyler, released under a BSD license.
# See the file license.txt included with this distribution, also
# available at http://code.google.com/p/dicompyler/
import os
import wx
from wx.xrc import *
import wx.lib.pubsub.setuparg1
import wx.lib.pubsub.core
pub = wx.lib.pubsub.core.Publisher()
from dicompyler import guiutil, util
try:
# Only works on Python 2.6 and above
import json
except ImportError:
# Otherwise try simplejson: http://github.com/simplejson/simplejson
import simplejson as json
class PreferencesManager():
"""Class to access preferences and set up the preferences dialog."""
def __init__(self, parent, name = None, appname = "the application",
filename='preferences.txt'):
# Load the XRC file for our gui resources
res = XmlResource(util.GetResourcePath('preferences.xrc'))
self.dlgPreferences = res.LoadDialog(None, "PreferencesDialog")
self.dlgPreferences.Init(name, appname)
# Setup internal pubsub methods
pub.subscribe(self.SetPreferenceTemplate, 'preferences.updated.template')
pub.subscribe(self.SavePreferenceValues, 'preferences.updated.values')
# Setup user pubsub methods
pub.subscribe(self.GetPreferenceValue, 'preferences.requested.value')
pub.subscribe(self.GetPreferenceValues, 'preferences.requested.values')
pub.subscribe(self.SetPreferenceValue, 'preferences.updated.value')
# Initialize variables
self.preftemplate = []
self.values = {}
self.filename = os.path.join(guiutil.get_data_dir(), filename)
self.LoadPreferenceValues()
def __del__(self):
# Destroy the dialog when the preferences manager object is deleted
if self.dlgPreferences:
self.dlgPreferences.Destroy()
def Show(self):
"""Show the preferences dialog with the given preferences."""
# If the pref dialog has never been shown, load the values and show it
if not self.dlgPreferences.IsShown():
self.dlgPreferences.LoadPreferences(self.preftemplate, self.values)
self.dlgPreferences.Hide()
# Otherwise, hide the dialog and redisplay it to bring it to the front
else:
self.dlgPreferences.Hide()
self.dlgPreferences.Show()
def SetPreferenceTemplate(self, msg):
"""Set the template that the preferences will be shown in the dialog."""
self.preftemplate = msg.data
self.dlgPreferences.LoadPreferences(self.preftemplate, self.values)
def LoadPreferenceValues(self):
"""Load the saved preference values from disk."""
if os.path.isfile(self.filename):
with open(self.filename, mode='r') as f:
try:
self.values = json.load(f)
except ValueError:
self.values = {}
else:
self.values = {}
def SavePreferenceValues(self, msg):
"""Save the preference values to disk after the dialog is closed."""
self.values = msg.data
with open(self.filename, mode='w') as f:
json.dump(self.values, f, sort_keys=True, indent=4)
def GetPreferenceValue(self, msg):
"""Publish the requested value for a single preference setting."""
query = msg.data.split('.')
v = self.values
if v.has_key(query[0]):
if v[query[0]].has_key(query[1]):
if v[query[0]][query[1]].has_key(query[2]):
pub.sendMessage(msg.data, v[query[0]][query[1]][query[2]])
def GetPreferenceValues(self, msg):
"""Publish the requested values for preference setting group."""
query = msg.data.split('.')
v = self.values
if v.has_key(query[0]):
if v[query[0]].has_key(query[1]):
for setting, value in v[query[0]][query[1]].iteritems():
message = msg.data + '.' + setting
pub.sendMessage(message, value)
def SetPreferenceValue(self, msg):
"""Set the preference value for the given preference setting."""
SetValue(self.values, msg.data.keys()[0], msg.data.values()[0])
pub.sendMessage('preferences.updated.values', self.values)
pub.sendMessage(msg.data.keys()[0], msg.data.values()[0])
############################## Preferences Dialog ##############################
class PreferencesDialog(wx.Dialog):
"""Dialog to display and change preferences."""
def __init__(self):
pre = wx.PreDialog()
# the Create step is done by XRC.
self.PostCreate(pre)
def Init(self, name = None, appname = ""):
"""Method called after the panel has been initialized."""
# Hide the close button on Mac
if guiutil.IsMac():
XRCCTRL(self, 'wxID_OK').Hide()
# Set window icon
else:
self.SetIcon(guiutil.get_icon())
# Set the dialog title
if name:
self.SetTitle(name)
# Initialize controls
self.notebook = XRCCTRL(self, 'notebook')
# Modify the control and font size on Mac
for child in self.GetChildren():
guiutil.adjust_control(child)
# Bind ui events to the proper methods
self.Bind(wx.EVT_CLOSE, self.OnClose)
self.Bind(wx.EVT_WINDOW_DESTROY, self.OnClose)
wx.EVT_BUTTON(self, XRCID('wxID_OK'), self.OnClose)
# Initialize variables
self.preftemplate = []
self.values = {}
self.appname = appname
def LoadPreferences(self, preftemplate, values):
"""Update and load the data for the preferences notebook control."""
self.preftemplate = preftemplate
self.values = values
# Delete and reset all the previous preference panels
self.notebook.DeleteAllPages()
self.callbackdict = {}
# Add each preference panel to the notebook
for template in self.preftemplate:
panel = self.CreatePreferencePanel(template.values()[0])
self.notebook.AddPage(panel, template.keys()[0])
def CreatePreferencePanel(self, prefpaneldata):
"""Create a preference panel for the given data."""
panel = wx.Panel(self.notebook, -1)
border = wx.BoxSizer(wx.VERTICAL)
show_restart = False
for group in prefpaneldata:
# Create a header for each group of settings
bsizer = wx.BoxSizer(wx.VERTICAL)
bsizer.Add((0,5))
hsizer = wx.BoxSizer(wx.HORIZONTAL)
hsizer.Add((12, 0))
h = wx.StaticText(panel, -1, group.keys()[0])
font = h.GetFont()
font.SetWeight(wx.FONTWEIGHT_BOLD)
h.SetFont(font)
hsizer.Add(h)
bsizer.Add(hsizer)
bsizer.Add((0,7))
# Create a FlexGridSizer to contain the group of settings
fgsizer = wx.FlexGridSizer(len(group.values()[0]), 4, 10, 4)
fgsizer.AddGrowableCol(2, 1)
# Create controls for each setting
for setting in group.values()[0]:
fgsizer.Add((24, 0))
# Show the restart asterisk for this setting if required
restart = str('*' if 'restart' in setting else '')
if ('restart' in setting):
if (setting['restart'] == True):
show_restart = True
t = wx.StaticText(panel, -1, setting['name']+restart+':',
style=wx.ALIGN_RIGHT)
fgsizer.Add(t, 0, wx.ALIGN_CENTER_VERTICAL|wx.ALIGN_RIGHT)
sizer = wx.BoxSizer(wx.HORIZONTAL)
# Get the setting value
value = GetValue(self.values, setting)
# Save the setting value in case it hasn't been saved previously
SetValue(self.values, setting['callback'], value)
# If this is a choice setting
if (setting['type'] == 'choice'):
c = wx.Choice(panel, -1, choices=setting['values'])
c.SetStringSelection(value)
sizer.Add(c, 0, wx.ALIGN_CENTER)
# Add control to the callback dict
self.callbackdict[c] = setting['callback']
self.Bind(wx.EVT_CHOICE, self.OnUpdateChoice, c)
# If this is a checkbox setting
elif (setting['type'] == 'checkbox'):
c = wx.CheckBox(panel, -1, setting['name']+restart)
c.SetValue(value)
sizer.Add(c, 0, wx.ALIGN_CENTER)
# Remove the label preceding the checkbox
t = self.FindWindowById(c.PrevControlId(c.GetId()))
t.SetLabel('')
# Adjust the sizer preceding the label
fgsizer.GetItem(0).SetSpacer((20,0))
# Add control to the callback dict
self.callbackdict[c] = setting['callback']
self.Bind(wx.EVT_CHECKBOX, self.OnUpdateCheckbox, c)
# If this is a range setting
elif (setting['type'] == 'range'):
s = wx.Slider(panel, -1, value,
setting['values'][0], setting['values'][1],
size=(120, -1), style=wx.SL_HORIZONTAL)
sizer.Add(s, 0, wx.ALIGN_CENTER)
t = wx.StaticText(panel, -1, str(value))
sizer.Add((3, 0))
sizer.Add(t, 0, wx.ALIGN_CENTER)
sizer.Add((6, 0))
t = wx.StaticText(panel, -1, setting['units'])
sizer.Add(t, 0, wx.ALIGN_CENTER)
# Add control to the callback dict
self.callbackdict[s] = setting['callback']
self.Bind(wx.EVT_COMMAND_SCROLL_THUMBTRACK, self.OnUpdateSlider, s)
self.Bind(wx.EVT_COMMAND_SCROLL_CHANGED, self.OnUpdateSlider, s)
# If this is a directory location setting
elif (setting['type'] == 'directory'):
# Check if the value is a valid directory,
# otherwise set it to the default directory
if not os.path.isdir(value):
value = setting['default']
SetValue(self.values, setting['callback'], value)
t = wx.TextCtrl(panel, -1, value, style=wx.TE_READONLY)
sizer.Add(t, 1, wx.ALIGN_CENTER)
sizer.Add((5, 0))
b = wx.Button(panel, -1, "Browse...")
sizer.Add(b, 0, wx.ALIGN_CENTER)
# Add control to the callback dict
self.callbackdict[b] = setting['callback']
self.Bind(wx.EVT_BUTTON, self.OnUpdateDirectory, b)
# Modify the control and font size on Mac
for child in panel.GetChildren():
guiutil.adjust_control(child)
fgsizer.Add(sizer, 1, wx.EXPAND|wx.ALL)
fgsizer.Add((12, 0))
bsizer.Add(fgsizer, 0, wx.EXPAND|wx.ALL)
border.Add(bsizer, 0, wx.EXPAND|wx.ALL, 2)
border.Add((60, 20), 0, wx.EXPAND|wx.ALL)
# Show the restart text for this group if required for >= 1 setting
if show_restart:
r = wx.StaticText(panel, -1,
'* Restart ' + self.appname + \
' for this setting to take effect.',
style=wx.ALIGN_CENTER)
font = r.GetFont()
font.SetWeight(wx.FONTWEIGHT_BOLD)
r.SetFont(font)
border.Add((0,0), 1, wx.EXPAND|wx.ALL)
rhsizer = wx.BoxSizer(wx.HORIZONTAL)
rhsizer.Add((0,0), 1, wx.EXPAND|wx.ALL)
rhsizer.Add(r)
rhsizer.Add((0,0), 1, wx.EXPAND|wx.ALL)
border.Add(rhsizer, 0, wx.EXPAND|wx.ALL)
border.Add((0,5))
panel.SetSizer(border)
return panel
def OnUpdateChoice(self, evt):
"""Publish the updated choice when the value changes."""
c = evt.GetEventObject()
pub.sendMessage(self.callbackdict[c], evt.GetString())
SetValue(self.values, self.callbackdict[c], evt.GetString())
def OnUpdateCheckbox(self, evt):
"""Publish the updated checkbox when the value changes."""
c = evt.GetEventObject()
pub.sendMessage(self.callbackdict[c], evt.IsChecked())
SetValue(self.values, self.callbackdict[c], evt.IsChecked())
def OnUpdateSlider(self, evt):
"""Publish the updated number when the slider value changes."""
s = evt.GetEventObject()
# Update the associated label with the new number
t = self.FindWindowById(s.NextControlId(s.GetId()))
t.SetLabel(str(s.GetValue()))
pub.sendMessage(self.callbackdict[s], s.GetValue())
SetValue(self.values, self.callbackdict[s], s.GetValue())
def OnUpdateDirectory(self, evt):
"""Publish the updated directory when the value changes."""
b = evt.GetEventObject()
# Get the the label associated with the browse button
t = self.FindWindowById(b.PrevControlId(b.GetId()))
dlg = wx.DirDialog(self, defaultPath = t.GetValue())
if dlg.ShowModal() == wx.ID_OK:
# Update the associated label with the new directory
d = unicode(dlg.GetPath())
t.SetValue(d)
pub.sendMessage(self.callbackdict[b], d)
SetValue(self.values, self.callbackdict[b], d)
dlg.Destroy()
def OnClose(self, evt):
"""Publish the updated preference values when closing the dialog."""
pub.sendMessage('preferences.updated.values', self.values)
self.Hide()
############################ Get/Set Value Functions ###########################
def GetValue(values, setting):
"""Get the saved setting value."""
# Look for the saved value and return it if it exists
query = setting['callback'].split('.')
value = setting['default']
if values.has_key(query[0]):
if values[query[0]].has_key(query[1]):
if values[query[0]][query[1]].has_key(query[2]):
value = values[query[0]][query[1]][query[2]]
# Otherwise return the default value
return value
def SetValue(values, setting, value):
"""Save the new setting value."""
# Look if a prior value exists and replace it
query = setting.split('.')
if values.has_key(query[0]):
if values[query[0]].has_key(query[1]):
values[query[0]][query[1]][query[2]] = value
else:
values[query[0]].update({query[1]:{query[2]:value}})
else:
values[query[0]] = {query[1]:{query[2]:value}}
############################### Test Preferences ###############################
def main():
import tempfile, os
import wx
import wx.lib.pubsub.setuparg1
import wx.lib.pubsub.core
pub = wx.lib.pubsub.core.Publisher()
app = wx.App(False)
t = tempfile.NamedTemporaryFile(delete=False)
sp = wx.StandardPaths.Get()
# Create a frame as a parent for the preferences dialog
frame = wx.Frame(None, wx.ID_ANY, "Preferences Test")
frame.Centre()
frame.Show(True)
app.SetTopWindow(frame)
filename = t.name
frame.prefmgr = PreferencesManager(parent = frame, appname = 'preftest',
filename=filename)
# Set up the preferences template
grp1template = [
{'Panel 1 Preference Group 1':
[{'name':'Choice Setting',
'type':'choice',
'values':['Choice 1', 'Choice 2', 'Choice 3'],
'default':'Choice 2',
'callback':'panel1.prefgrp1.choice_setting'},
{'name':'Directory setting',
'type':'directory',
'default':unicode(sp.GetDocumentsDir()),
'callback':'panel1.prefgrp1.directory_setting'}]
},
{'Panel 1 Preference Group 2':
[{'name':'Range Setting',
'type':'range',
'values':[0, 100],
'default':50,
'units':'%',
'callback':'panel1.prefgrp2.range_setting'}]
}]
grp2template = [
{'Panel 2 Preference Group 1':
[{'name':'Range Setting',
'type':'range',
'values':[0, 100],
'default':50,
'units':'%',
'callback':'panel2.prefgrp1.range_setting',
'restart':True}]
},
{'Panel 2 Preference Group 2':
[{'name':'Directory setting',
'type':'directory',
'default':unicode(sp.GetUserDataDir()),
'callback':'panel2.prefgrp2.directory_setting'},
{'name':'Choice Setting',
'type':'choice',
'values':['Choice 1', 'Choice 2', 'Choice 3'],
'default':'Choice 2',
'callback':'panel2.prefgrp2.choice_setting'}]
}]
preftemplate = [{'Panel 1':grp1template}, {'Panel 2':grp2template}]
def print_template_value(msg):
"""Print the received template message."""
print msg.topic, msg.data
# Subscribe the template value printer to each set of preferences
pub.subscribe(print_template_value, 'panel1')
pub.subscribe(print_template_value, 'panel2')
# Notify the preferences manager that a pref template is available
pub.sendMessage('preferences.updated.template', preftemplate)
frame.prefmgr.Show()
app.MainLoop()
# Print the results of the preferences
with open(filename, mode='r') as f:
for line in f:
print line,
try:
os.remove(filename)
except WindowsError:
print '\nCould not delete: '+filename+'. Please delete it manually.'
if __name__ == '__main__':
main()
|