File: foldereditor.py

package info (click to toggle)
syncthing-gtk 0.9.4.4%2Bds%2Bgit20221205%2B12a9702d29ab-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,888 kB
  • sloc: python: 8,077; sh: 259; xml: 134; makefile: 6
file content (321 lines) | stat: -rw-r--r-- 12,838 bytes parent folder | download | duplicates (2)
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
#!/usr/bin/env python3
"""
Syncthing-GTK - FolderEditorDialog

Universal dialog handler for all Syncthing settings and editing
"""


import logging
import os
import re

from gi.repository import Gtk

from syncthing_gtk.editordialog import EditorDialog, strip_v
from syncthing_gtk.tools import _  # gettext function
from syncthing_gtk.tools import generate_folder_id


log = logging.getLogger("FolderEditor")

COLOR_NEW = "#A0A0A0"
# Regexp to generate folder id from filename
RE_GEN_ID = re.compile("([a-zA-Z0-9\-\._]{1,64}).*")
VALUES = ["vlabel", "vid", "vpath", "vreadOnly", "vreceiveOnly", "vignorePerms",
          "vdevices", "vversioning", "vkeepVersions", "vrescanIntervalS", "vmaxAge",
          "vversionsPath", "vfsWatcherEnabled", "vcleanoutDays", "vcommand", "vorder",
          "vminDiskFreePct"
          ]
VERSIONING_TYPES = {'simple', 'staggered', 'trashcan', 'external'}


class FolderEditorDialog(EditorDialog):
    def __init__(self, app, is_new, id=None, path=None):
        EditorDialog.__init__(
            self, app, "folder-edit.ui",
            "New Shared Folder" if is_new else "Edit Shared Folder")
        self.id = id
        self.path = path
        self.is_new = is_new

    def on_btBrowse_clicked(self, *a):
        """
        Display folder browser dialog to browse for folder... folder.
        Oh god, this new terminology sucks...
        """
        if not self.is_new:
            return
        # Prepare dialog
        d = Gtk.FileChooserDialog(
            _("Select Folder for new Folder"),  # fuck me...
            self["editor"],
            Gtk.FileChooserAction.SELECT_FOLDER,
            (Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL,
             Gtk.STOCK_OK, Gtk.ResponseType.OK))
        # Set default path to home directory
        d.set_current_folder(os.path.expanduser("~"))
        # Get response
        if d.run() == Gtk.ResponseType.OK:
            self["vpath"].set_text(d.get_filename())
            if len(self["vid"].get_text().strip()) == 0:
                # ID is empty, fill it with last path element
                try:
                    lpl = os.path.split(d.get_filename())[-1]
                    id = RE_GEN_ID.search(lpl).group(0).lower()
                    self["vid"].set_text(id)
                except AttributeError:
                    # Can't regexp anything
                    pass
        d.destroy()

    def on_vid_icon_press(self, *a):
        if self["vid"].get_sensitive():
            self["vid"].set_text(generate_folder_id())

    # @Overrides
    def get_value(self, key):
        if key == "keepVersions":
            return self.get_burried_value("versioning/params/keep", self.values, 0, int)
        elif key == "maxAge":
            # seconds to days
            return self.get_burried_value("versioning/params/maxAge", self.values, 0, int) / 86400
        elif key == "cleanoutDays":
            return self.get_burried_value("versioning/params/cleanoutDays", self.values, 0, int)
        elif key == "command":
            return self.get_burried_value("versioning/params/command", self.values, "")
        elif key == "versionsPath":
            return self.get_burried_value("versioning/params/versionsPath", self.values, "")
        elif key == "readOnly":
            return self.get_burried_value("type", self.values, "") in ("readonly", "sendonly")
        elif key == "receiveOnly":
            return self.get_burried_value("type", self.values, "") in ("receiveonly")
        elif key == "versioning":
            return self.get_burried_value("versioning/type", self.values, "")
        else:
            return EditorDialog.get_value(self, key)

    # @Overrides
    def set_value(self, key, value):
        if key == "versioning":
            # Create structure if needed
            self.create_dicts(self.values, ("versioning", "type"))
            self.values["versioning"]["type"] = value
        elif key == "keepVersions":
            # Create structure if needed
            self.create_dicts(self.values, ("versioning", "params", "keep"))
            self.values["versioning"]["params"]["keep"] = str(int(value))
        elif key == "cleanoutDays":
            # Create structure if needed
            self.create_dicts(
                self.values, ("versioning", "params", "cleanoutDays"))
            self.values["versioning"]["params"]["cleanoutDays"] = str(
                int(value))
        elif key == "maxAge":
            # Create structure if needed
            self.create_dicts(self.values, ("versioning", "params", "maxAge"))
            self.values["versioning"]["params"]["maxAge"] = str(
                int(value) * 86400)  # days to seconds
        elif key == "command":
            # Create structure if needed
            self.create_dicts(self.values, ("versioning", "params", "command"))
            self.values["versioning"]["params"]["command"] = value
        elif key == "versionsPath":
            # Create structure if needed
            self.create_dicts(
                self.values, ("versioning", "params", "versionsPath"))
            self.values["versioning"]["params"]["versionsPath"] = value
        elif key in ("readOnly", "receiveonly"):
            if self["vreadOnly"].get_active():
                self.values["type"] = "sendonly"
            elif self["vreceiveOnly"].get_active():
                self.values["type"] = "receiveonly"
            else:
                self.values["type"] = "sendreceive"
        else:
            EditorDialog.set_value(self, key, value)

    # @Overrides
    def on_data_loaded(self):
        try:
            if self.is_new:
                self.values = {strip_v(x): "" for x in VALUES}
                self.checks = {
                    "vid": self.check_folder_id,
                    "vpath": self.check_path,
                    "vcommand": self.check_command,
                }
                if self.id is not None:
                    try:
                        v = [x for x in self.config["folders"]
                             if x["id"] == self.id][0]
                        self.values = v
                        self.is_new = False
                    except IndexError:
                        pass
                if self.path is not None:
                    self.set_value("path", self.path)
                    self["vpath"].set_sensitive(False)
                self.set_value("versioning", "simple")
                self.set_value("rescanIntervalS", 30)
                self.set_value("keepVersions", 10)
            else:
                try:
                    self.values = [
                        x for x in self.config["folders"] if x["id"] == self.id][0]
                except IndexError:
                    # Unknown ID. May happen in rather crazy case when user deletes folder
                    # and tries to add new before daemon is able to process everything.
                    self.is_new = True
                    return self.on_data_loaded()

                self.checks = {
                    "vcommand": self.check_command,
                }
                self["vpath"].set_sensitive(False)
                self["btBrowse"].set_sensitive(False)
        except KeyError as e:
            # ID not found in configuration. This is practically impossible,
            # so it's handled only by self-closing dialog.
            log.exception(e)
            self.close()
            return False
        return self.display_values(VALUES)

    # @Overrides
    def display_value(self, key, w):
        if key == "vdevices":
            # Very special case
            nids = [n["deviceID"] for n in self.get_value("devices")]
            for device in self.app.devices.values():
                if device["id"] != self.app.daemon.get_my_id():
                    b = Gtk.CheckButton(device.get_title(), False)
                    b.set_tooltip_text(device["id"])
                    self["vdevices"].pack_start(b, False, False, 0)
                    b.set_active(device["id"] in nids)
            self["vdevices"].show_all()
        else:
            EditorDialog.display_value(self, key, w)

    # @Overrides
    def update_special_widgets(self, *a):
        self["vid"].set_sensitive(self.id is None)
        v = self.get_value("versioning")
        if v == "":
            if self["rvversioning"].get_reveal_child():
                self["rvversioning"].set_reveal_child(False)
        else:
            for x in VERSIONING_TYPES:
                self["bxVersioning_" +
                     x].set_visible(self.get_value("versioning") == x)
            if not self["rvversioning"].get_reveal_child():
                self["rvversioning"].set_reveal_child(True)

    # @Overrides
    def on_save_requested(self):
        self.store_values(VALUES)
        if self.is_new:
            # Add new dict to configuration (edited dict is already there)
            self.config["folders"].append(self.values)
        # Post configuration back to daemon
        self.post_config()

    # @Overrides
    def store_value(self, key, w):
        if key == "vdevices":  # Still very special case
            devices = [{
                "deviceID": b.get_tooltip_text(),
            } for b in self["vdevices"].get_children()
                if b.get_active()
            ]
            self.set_value("devices", devices)
        else:
            EditorDialog.store_value(self, key, w)

    # @Overrides
    def on_saved(self):
        self.close()
        # If new folder/device was added, show dummy item UI, so user will
        # see that something happen even before daemon gets restarted
        if self.is_new:
            folder_type = "sendreceive"
            if self.get_value("readOnly"):
                folder_type = "readonly"
            elif self.get_value("receiveOnly"):
                folder_type = "receiveonly"
            box = self.app.show_folder(
                self.get_value("id"), self.get_value(
                    "label"), self.get_value("path"),
                folder_type,
                self.get_value("ignorePerms"),
                self.get_value("rescanIntervalS"),
                self.get_value("fsWatcherEnabled"),
                sorted(
                    [self.app.devices[n["deviceID"]]
                        for n in self.get_value("devices")],
                    key=lambda x: x.get_title().lower()
                )
            )
            box.set_color_hex(COLOR_NEW)
        else:
            self.app.daemon.reload_config()

    # @Overrides
    def ui_value_changed(self, w, *a):
        EditorDialog.ui_value_changed(self, w, *a)
        self.cb_check_value(w, *a)

    def check_folder_id(self, value):
        if len(value.strip()) == 0:
            # Empty value
            return False
        if value in self.app.folders:
            # Duplicate folder id
            return False
        return True

    def check_path(self, value):
        # Any non-empty path is OK
        return len(value.strip()) > 0

    def check_command(self, value):
        # Any non-empty command is OK
        return self.get_value("versioning") != "external" or len(value.strip()) > 0

    def fill_folder_id(self, rid, readonly=True):
        """ Pre-fills folder Id for new-folder dialog """
        self["vid"].set_text(rid)
        self.id = rid
        self.update_special_widgets()
        self["vid"].set_sensitive(not readonly)

    def on_folder_type_toggled(self, cb, *a):
        """ Ensures that only one folder type checkbox is checked """
        if cb.get_active():
            for x in ("vreadOnly", "vreceiveOnly"):
                if self[x] != cb and self[x].get_active():
                    self[x].set_active(False)

    def on_vfsWatcherEnabled_toggled(self, cb, *a):
        # Called when checkbox value changes to automatically change rescan interval
        if self._loading:
            return
        vrescanIntervalS = self.builder.get_object("vrescanIntervalS")
        interval = vrescanIntervalS.get_value()
        if cb.get_active():
            # fswatch enabled, increase rescan interval
            if interval < 720:
                vrescanIntervalS.set_value(interval * 60)
        else:
            # fswatch disabled, return rescan interval back
            if interval > 300:
                vrescanIntervalS.set_value(interval / 60)

    def mark_device(self, nid):
        """ Marks (checks) checkbox for specified device """
        if "vdevices" in self:  # ... only if there are checkboxes here
            for child in self["vdevices"].get_children():
                if child.get_tooltip_text() == nid:
                    label = child.get_children()[0]  # Label in checkbox
                    label.set_markup("<b>%s</b>" % (label.get_label()))
                    child.set_active(True)