-
Notifications
You must be signed in to change notification settings - Fork 0
/
settings.py
337 lines (298 loc) · 12.4 KB
/
settings.py
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
import tkinter as tk
import tkinter.ttk as ttk
import tkinter.filedialog as tk_fid
from demomgr.dialogues._base import BaseDialog
from demomgr.dialogues._diagresult import DIAGSIG
from demomgr import constants as CNST
from demomgr.helpers import convertunit, frmd_label, int_validator
from demomgr.tk_widgets import PasswordButton
from demomgr.tk_widgets.misc import DynamicLabel
_TK_VARTYPES = {
"str": tk.StringVar,
"int": tk.IntVar,
"bool": tk.BooleanVar,
"double": tk.DoubleVar,
}
class Settings(BaseDialog):
"""
Settings dialog that offers a bunch of configuration options.
After the dialog is closed:
`self.result.state` will be SUCCESS if user hit OK, else FAILURE.
`self.result.data` will be a dict with the following keys:
"datagrabmode": How the demo information should be gathered.
0 for None, 1 for _events.txt, 2 for .json .
"previewdemos": Whether to preview demos in the main view. (bool)
"steampath": Path to steam (str)
"hlaepath": Path to HLAE (str)
"evtblocksz": Chunk size _events.txt should be read in. (int)
"ui_theme": Interface theme. Key of same name must be in
constants. (str)
"lazyreload": Whether to lazily refresh singular UI elements instead
of reloading entire UI on changes as single demo deletion or
bookmark setting. (bool)
Widget state remembering:
0: Last visited section
"""
def __init__(self, parent, cfg, remember):
"""
parent: Tkinter widget that is the parent of this dialog.
cfg: Program configuration. (dict)
remember: List of arbitrary values, see class docstring.
"""
super().__init__(parent, "Settings")
self.cfg = cfg
self._create_tk_var("int", "datagrabmode_var", cfg.data_grab_mode.value)
self._create_tk_var("int", "file_manager_mode_var", cfg.file_manager_mode.value)
self._create_tk_var("bool", "preview_var", cfg.preview_demos)
self._create_tk_var("str", "date_fmt_var", cfg.date_format)
self._create_tk_var("str", "steampath_var", cfg.steam_path or "")
self._create_tk_var("str", "hlaepath_var", cfg.hlae_path or "")
self._create_tk_var("str", "file_manager_path_var", cfg.file_manager_path or "")
self._create_tk_var("str", "ui_style_var", cfg.ui_theme)
self._create_tk_var("bool", "lazyreload_var", cfg.lazy_reload)
self._create_tk_var("str", "rcon_pwd_var", cfg.rcon_pwd or "")
self._selected_pane = None
self.ui_remember = remember
self.blockszvals = {convertunit(i, "B"): i for i in (2**pw for pw in range(12, 28))}
def body(self, master):
"""UI setup."""
self.protocol("WM_DELETE_WINDOW", self.done)
master.grid_columnconfigure((0, 1), weight = 1)
mainframe = ttk.Frame(master)
mainframe.grid_columnconfigure(1, weight = 1)
mainframe.grid_rowconfigure(0, weight = 1)
suboptions_pane = ttk.Frame(mainframe)
suboptions_pane.grid_columnconfigure(0, weight = 1)
display_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "Display")
)
display_labelframe.grid_columnconfigure(0, weight = 1)
ttk.Checkbutton(
display_labelframe, variable = self.preview_var, text = "Show demo header information",
style = "Contained.TCheckbutton"
).grid(sticky = "w", ipadx = 4) # Preview
lazyreload_btn = ttk.Checkbutton(
display_labelframe, variable = self.lazyreload_var, text = "Lazy reload of main demo view",
style = "Contained.TCheckbutton"
)
lazyreload_txt = DynamicLabel(
200, 300, display_labelframe,
text = (
"Will not reload the entire directory on minor changes such as "
"bookmark modification."
), justify = tk.LEFT, style = "Contained.TLabel"
)
lazyreload_btn.grid(sticky = "w", ipadx = 4, pady = (2, 0))
lazyreload_txt.grid(sticky = "w", padx = (8, 0)) # Lazy reload
ui_style_labelframe = ttk.Labelframe(
display_labelframe, style = "Contained.TLabelframe", padding = 8,
labelwidget = frmd_label(display_labelframe, "UI Style")
) # Style LF
for i in CNST.THEME_PACKAGES.keys():
b = ttk.Radiobutton(
ui_style_labelframe, variable = self.ui_style_var, text = i, value = i,
style = "Contained.TRadiobutton"
)
b.grid(ipadx = 4, sticky = "w") # Style btns
ttk.Radiobutton(
ui_style_labelframe, variable = self.ui_style_var, text = "Default", value = "_DEFAULT",
style = "Contained.TRadiobutton"
).grid(ipadx = 4, sticky = "w") # Default style
ui_style_labelframe.grid(sticky = "news", pady = 4)
date_format_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "Date format")
)
date_format_labelframe.grid_columnconfigure(0, weight = 1)
self.date_fmt_combobox = ttk.Combobox(
date_format_labelframe, state = "readonly", values = CNST.DATE_FORMATS
)
self.date_fmt_combobox.grid(sticky = "ew")
path_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "Paths")
)
path_labelframe.grid_columnconfigure(1, weight = 1)
for i, (name, tk_var, dir_only) in enumerate((
("Steam:", self.steampath_var, True),
("HLAE:", self.hlaepath_var, True),
("File manager:", self.file_manager_path_var, False),
)):
desc_label = ttk.Label(path_labelframe, style = "Contained.TLabel", text = name)
path_entry = ttk.Entry(path_labelframe, textvariable = tk_var)
if dir_only:
# ugly parameter binding
def _tmp_handler(var = tk_var):
return self._sel_dir(var)
else:
def _tmp_handler(var = tk_var):
return self._sel_file(var)
change_btn = ttk.Button(
path_labelframe, text = "Change...", command = _tmp_handler, style = "Contained.TButton"
)
desc_label.grid(row = i, column = 0, sticky = "e")
path_entry.grid(row = i, column = 1, padx = (3, 0), sticky = "ew")
change_btn.grid(row = i, column = 2, padx = (3, 0))
datagrab_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "Get demo information via...")
)
datagrab_labelframe.grid_columnconfigure(0, weight = 1)
for enum_attr in (
CNST.DATA_GRAB_MODE.NONE,
CNST.DATA_GRAB_MODE.EVENTS,
CNST.DATA_GRAB_MODE.JSON,
):
b = ttk.Radiobutton(
datagrab_labelframe, value = enum_attr.value, variable = self.datagrabmode_var,
text = enum_attr.get_display_name(), style = "Contained.TRadiobutton"
)
b.grid(sticky = "w", ipadx = 4)
eventread_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8,
labelwidget = frmd_label(suboptions_pane, "Read _events.txt in chunks of size...")
)
eventread_labelframe.grid_columnconfigure(0, weight = 1)
self.blockszselector = ttk.Combobox(
eventread_labelframe, state = "readonly", values = tuple(self.blockszvals.keys())
)
self.blockszselector.grid(sticky = "ew")
rcon_pwd_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "RCON password")
)
rcon_pwd_labelframe.grid_columnconfigure(0, weight = 1)
rcon_entry = ttk.Entry(rcon_pwd_labelframe, textvariable = self.rcon_pwd_var, show = "\u25A0")
rcon_entry.grid(column = 0, row = 0, sticky = "ew")
entry_visibility_toggle = PasswordButton(rcon_pwd_labelframe, text = "Show")
entry_visibility_toggle.bind_to_entry(rcon_entry)
entry_visibility_toggle.grid(column = 1, row = 0)
int_val_id = master.register(int_validator)
rcon_port_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "RCON port")
)
rcon_port_labelframe.grid_columnconfigure(0, weight = 1)
self.rcon_port_entry = ttk.Entry(
rcon_port_labelframe, validate = "key", validatecommand = (int_val_id, "%S", "%P")
)
self.rcon_port_entry.insert(0, str(self.cfg.rcon_port))
self.rcon_port_entry.grid(column = 0, row = 0, sticky = "ew")
file_manager_labelframe = ttk.LabelFrame(
suboptions_pane, padding = 8, labelwidget = frmd_label(suboptions_pane, "File manager")
)
for name, enum_attr in (
("Windows explorer", CNST.FILE_MANAGER_MODE.WINDOWS_EXPLORER),
("Custom (Paths > File manager)", CNST.FILE_MANAGER_MODE.USER_DEFINED),
):
b = ttk.Radiobutton(
file_manager_labelframe, value = enum_attr.value,
variable = self.file_manager_mode_var, text = name,
style = "Contained.TRadiobutton"
)
b.grid(sticky = "w", ipadx = 4)
# Set comboboxes
tmp = convertunit(self.cfg.events_blocksize, "B")
if tmp in self.blockszvals:
self.blockszselector.set(tmp)
else:
self.blockszselector.set(next(iter(self.blockszvals)))
tmp = self.cfg.date_format
if tmp in CNST.DATE_FORMATS:
self.date_fmt_combobox.set(tmp)
else:
self.date_fmt_combobox.set(CNST.DATE_FORMATS[0])
# Set up main interface
self._INTERFACE = {
"Interface": (display_labelframe, date_format_labelframe),
"Information reading": (datagrab_labelframe, eventread_labelframe),
"Paths": (path_labelframe, ),
"RCON": (rcon_pwd_labelframe, rcon_port_labelframe),
"File manager": (file_manager_labelframe, ),
}
self._create_tk_var("int", "_selectedpane_var", 0)
sidebar_outerframe = ttk.Frame(mainframe, style = "Border.TFrame")
sidebar_outerframe.grid_columnconfigure(0, weight = 1)
sidebar_outerframe.grid_rowconfigure(0, weight = 1)
sidebar = ttk.Frame(sidebar_outerframe, style = "Contained.TFrame")
tmp_inibtn = None
for i, k in enumerate(self._INTERFACE):
def _handler(self = self, k = k):
self._reload_options_pane(k)
curbtn = ttk.Radiobutton(
sidebar, text = k, value = i, command = _handler,
variable = self._selectedpane_var, style = "Contained.TRadiobutton"
)
curbtn.grid(column = 0, row = i, sticky = "w", ipadx = 4, padx = 4)
# Fallback to 0 if remember value is scuffed
if i == 0 or i == self.ui_remember[0]:
tmp_inibtn = curbtn
sidebar.grid(column = 0, row = 0, sticky = "nesw", padx = 1, pady = 1)
sidebar_outerframe.grid(column = 0, row = 0, sticky = "nesw")
suboptions_pane.grid(column = 1, row = 0, sticky = "nesw")
mainframe.grid(column = 0, row = 0, columnspan = 2, sticky = "news")
btconfirm = ttk.Button(master, text = "Save", command = lambda: self.done(1))
btcancel = ttk.Button(master, text = "Cancel", command = lambda: self.done(0))
btconfirm.grid(column = 0, row = 1, padx = (0, 3), pady = (3, 0), sticky = "news")
btcancel.grid(column = 1, row = 1, padx = (3, 0), pady = (3, 0), sticky = "news")
tmp_inibtn.invoke()
def _create_tk_var(self, type_, name, inivalue):
"""
Creates a tkinter variable of type "str", "int", "bool", "double",
registers it as an attribute of the dialog with name `name` and sets
it to `inivalue`.
"""
if hasattr(self, name):
raise ValueError(f"Variable {name} already exists.")
var = _TK_VARTYPES[type_]()
var.set(inivalue)
setattr(self, name, var)
def done(self, save=False):
self.withdraw()
self.update_idletasks()
self.result.remember = [self._selectedpane_var.get()]
if save:
self.result.state = DIAGSIG.SUCCESS
self.result.data = {
"data_grab_mode": CNST.DATA_GRAB_MODE(self.datagrabmode_var.get()),
"file_manager_mode": CNST.FILE_MANAGER_MODE(self.file_manager_mode_var.get()),
"preview_demos": self.preview_var.get(),
"date_format": self.date_fmt_combobox.get(),
"steam_path": self.steampath_var.get() or None,
"hlae_path": self.hlaepath_var.get() or None,
"file_manager_path": self.file_manager_path_var.get() or None,
"events_blocksize": self.blockszvals[self.blockszselector.get()],
"ui_theme": self.ui_style_var.get(),
"lazy_reload": self.lazyreload_var.get(),
"rcon_pwd": self.rcon_pwd_var.get() or None,
"rcon_port": int(self.rcon_port_entry.get() or 0),
}
else:
self.result.state = DIAGSIG.FAILURE
self.destroy()
def _sel_dir(self, variable):
"""
Prompt the user to select a directory, then modify the tkinter
variable `variable` with the selected value.
"""
variable.set(tk_fid.askdirectory())
def _sel_file(self, variable):
"""
Same as `_sel_dir`, just with a file.
"""
variable.set(tk_fid.askopenfilename())
def _reload_options_pane(self, key):
"""
Clears and repopulates right pane with the widgets in
self._INTERFACE[`key`]
"""
if self._selected_pane == key:
return
# When the user resizes the window, other panes will produce an ugly
# amount of empty space. This resets user-requested width.
self.wm_geometry("")
if self._selected_pane is not None:
for widget in self._INTERFACE[self._selected_pane]:
widget.grid_forget()
self._selected_pane = key
for i, widget in enumerate(self._INTERFACE[key]):
pady = (
3 * (i != 0),
3 * (i != len(self._INTERFACE[key]) - 1),
)
widget.grid(column = 0, row = i, sticky = "nesw", padx = (3, 0), pady = pady)