-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.py
338 lines (292 loc) · 11.1 KB
/
config.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
338
"""
Configuration module
"""
import json
from os import makedirs
from os.path import dirname, exists, expanduser, isfile, join
import clipboard
import utils
from getters.getterFactory import GetterFactory
from reader.entry import Entry
from visual.instantiator import available_uis
class Config:
"""Configuration class"""
conf_dict = None
def __init__(self, conf_dict=None):
if conf_dict is not None:
self.conf_dict = conf_dict
self.user_setting_keys = ["bibtex_getter", "bibtex_getter_params", "pdf_getter", "pdf_getter_params",
"pdf_dir", "ui", "tmp_dir", "bib_path", "view_columns", "sort_column",
"search_result_size", "list_result_size", "searcher", "editor"]
self.modified = False
def get_searcher(self):
s = self.get_user_setting('searcher')
if s is None:
return "fuzzy"
def get_visual(self):
try:
return self.get_user_setting('ui')
except KeyError:
return "ttables"
def get_selection_commands(self):
return self.conf_dict["selection_commands"]
def get_controls(self):
return self.conf_dict["controls"]
def get_pdf_apis(self):
self.get()["pdf_apis"]
def get_bibtex_apis(self):
self.get()["bibtex_apis"]
def get_num_retrieved_bibtex(self):
self.get()["num_retrieved_bibtex"]
def get_view_columns(self):
cols = self.get_user_setting('view_columns')
cols = self.get_default_view_columns() if not cols else cols
return cols
def get_sort_column(self):
cols = self.get_view_columns()
scol = None
try:
scol = self.get_user_setting('sort_column')
except KeyError:
pass
scol = self.get_default_sort_column() if not scol else scol
scol = cols[0] if scol not in cols else scol
return scol
def update_dict(self, ddict):
self.conf_dict = ddict
def get_user_settings(self):
return self.conf_dict["user_settings"]
def get_editor(self):
return self.get_user_setting("editor", default="vim")
def get_user_setting(self, key, default=None):
try:
return self.get_user_settings()[key]
except KeyError:
return default
def get_debug(self):
return self.get()["debug"]
def get_ui(self):
return self.get_user_setting("ui")
def get_config_file_dir(self):
return self.config_file_dir
def get_tmp_dir(self):
return self.get_user_settings()["tmp_dir"]
def get_default_view_columns(self):
return ["ID", "title"]
def get_default_sort_column(self):
return "ID"
def get_search_result_size(self):
try:
return self.get_user_settings()["search_result_size"]
except KeyError:
return 10
def get_list_result_size(self):
try:
return self.get_user_settings()["list_result_size"]
except KeyError:
return 30
def get_pdf_dir(self):
default = join(dirname(self.get_user_setting("bib_path")), "pdfs")
return self.get_user_setting("pdf_dir", default=default)
def write(self, conf, path=None):
try:
backup = utils.Backup(self.get_filepath(), join(self.get_tmp_dir()))
with open(self.get_filepath(), "w") as f:
json.dump(conf, f)
return True, ""
except Exception as ex:
backup.restore()
return False, str(ex)
def save_if_modified(self, verify_write=True, called_explicitely=True):
# collection
modified_status = "*has been modified*" if self.modified else "has not been modified"
if verify_write:
# for explicit calls, do not ask for verification
if called_explicitely:
pass
else:
# if auto-called and not modified, do nothing
if not self.modified:
return
# else verify
if not self.visual.yes_no("The configuration {}. Overwrite?".format(modified_status), default_yes=False):
return
# write
self.write(self.get())
def validate_setting(self, key, value):
"""Validate setting values"""
valid, msg = True, "OK"
if key in "bibtex_getter pdf_getter".split():
avail = GetterFactory.get_names()
if value not in avail:
valid = False
msg = f"No getters named {value}. Available ones are {avail}"
elif key == "view_columns":
if type(value) == str:
value = value.split()
invalids = [v for v in value if v not in Entry.useful_keys]
if invalids:
valid = False
msg = f"Invalid column(s) set: {invalids}. Available ones are {Entry.useful_keys}"
elif key == "sort_column":
if value not in Entry.useful_keys:
valid = False
msg = f"Invalid sort column set: {value}. Available ones are {Entry.useful_keys}"
elif key in ["search_result_size", "list_result_size"]:
try:
value = int(value)
if value <= 0:
raise ValueError
except ValueError:
msg = f"Search / list result size has to be an integer"
valid = False
elif key == "ui":
if value not in available_uis:
msg = f"Ui {value} is undefined. Available ones are {available_uis}"
valid = False
else:
# un validate-able setting
pass
return key, value, valid, msg
def update_user_setting(self, key, value):
"""Function to update a key-value user-level setting"""
if key not in self.user_setting_keys:
return False, f"Undefined user setting {key}"
key, value, valid, errmsg = self.validate_setting(key, value)
if not valid:
return False, errmsg
config = self.get()
config["user_settings"][key] = value
return True, ""
def update_setting(self, key, value):
"""Function to update a program-level key-value setting"""
config = self.get()
config[key] = value
# configuration file path
def get_filepath(self):
return join(expanduser("~"), ".config", "bib", "config.json")
# build configuration
def create(self):
conf = {}
# get path to bib file
bib_filepath = input("Give path to bibliography file (you can copy/paste): ")
# check it
if not exists(bib_filepath):
print("Specified path does not exist.")
exit(1)
if not isfile(bib_filepath):
print("Specified path is not a file.")
exit(1)
browser_cmd = input("Give browser command: ")
# populate configuration
conf["bib_path"] = bib_filepath
conf["browser"] = browser_cmd
return conf
@staticmethod
def get_defaults(bib_path):
conf = {}
# controls
conf["controls"] = {
"search": "/",
"down": "j",
"edit": "e",
"filter": "fi",
"bibtex_show": "bs",
"bibtex_copy": "bc",
"get": "g",
"up": "k",
"list": "l",
"check": "ch",
"clear": "",
"unselect": "us",
"delete": "del",
"repeat": "r",
"show": "sh",
"merge": "m",
"quit": "q",
"save": "sa",
"cite": "ci",
"cite_multi": "cm",
"pdf_file": "fp",
"debug": "deb",
"pdf_search": "fs",
"pdf_web": "fw",
"pdf_open": "o",
"history_show": "hs",
"history_input": "hi",
"history_reset": "hr",
"history_jump": "hj",
"history_back": "hb",
"history_log": "hl",
"history_forward": "hf",
"settings": "se",
"tag": "ta"
}
# controls that can act on selection(s)
conf["selection_commands"] = ["list", "delete", "cite", "cite_multi", "tag", "pdf_file", "pdf_web", "pdf_open"]
conf["pdf_apis"] = ["scholar", "scihub", "bibsonomy"]
conf["bibtex_apis"] = ["gscholar", "scholarly", "bibsonomy"]
conf["doi_apis"] = ["crossref"]
conf["actions"] = ["merge", "inspect"]
conf["num_retrieved_bibtex"] = 5
# fill in key-value pairs like the example config belowbelow
"""
"user_settings": {
"bibtex_getter": "bibsonomy",
"bibtex_getter_params": ["username", "passwd"],
"pdf_getter": "scholar",
"pdf_getter_params": "firefox",
"pdf_dir": "/path/to/my/pdfs",
"visual": "ttables",
"tmp_dir": "/tmp/bib",
"bib_path": "/path/to/library.bib",
"view_columns": ["ID", "author", "title", "inserted"],
"sort_column": "ID"
},
"""
conf["user_settings"] = {"ui": "default"}
conf["user_settings"]["bib_path"] = bib_path
conf["user_settings"]["pdf_dir"] = join(dirname(bib_path), "pdfs")
conf["user_settings"]["tmp_dir"] = "/tmp/bib/"
return conf
def get(self):
if self.conf_dict is not None:
return self.conf_dict
# backup copied data, in case we are adding an entry
copied_data = utils.paste(single_line=False)
initialized = False
conf_filepath = self.get_filepath()
conf_dir = dirname(conf_filepath)
self.config_file_dir = conf_dir
# check for existence of config file
if not exists(conf_filepath):
# if not existing, create it interactively
print("Configuration file {} does not exist, creating.".format(conf_filepath))
bib_path = input("Give full path to library bibtex file: ")
initialized = True
# write config file for addbib
if not exists(conf_dir):
print("Creating configuration directory to {}".format(conf_dir))
makedirs(dirname(conf_filepath))
conf = Config.get_defaults(bib_path)
print("Writing configuration to {}".format(conf_filepath))
with open(conf_filepath, "w") as f:
json.dump(conf, f)
else:
# if it exists, just read it
with open(conf_filepath, "r") as f:
conf = json.load(f)
conf["created_new"] = initialized
# restore copied data
clipboard.copy(copied_data)
self.conf_dict = conf
# put empty settings keys
for sett_key in self.user_setting_keys:
if sett_key not in conf["user_settings"]:
conf["user_settings"][sett_key] = None
return conf
def get_namedtuple(self, conf_dict=None):
if conf_dict is None:
conf_dict = self.get()
nt = utils.to_namedtuple(conf_dict, "conf")
return nt