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
468
469
470
471
472
473
474
475
476
477from docxtpl import DocxTemplate
import datetime
import re
from pathlib import Path
import os
import argparse
import sys
import docx
import asciimatics
from asciimatics.widgets import (
Frame,
ListBox,
Layout,
Divider,
Text,
Button,
TextBox,
Widget,
DatePicker,
DropdownList,
MultiColumnListBox,
PopUpDialog,
)
from asciimatics.event import KeyboardEvent
from asciimatics.scene import Scene
from asciimatics.screen import Screen
from asciimatics.exceptions import ResizeScreenError, NextScene, StopApplication
import sys
import sqlite3
class EscapeFrame(Frame):
def process_event(self, event):
if isinstance(event, KeyboardEvent) and event.key_code == Screen.KEY_ESCAPE:
self.cancel()
else:
super().process_event(event)
def cancel(self):
# do nothing by default
pass
class ValidationError(Exception):
def __init__(self, msg):
Exception.__init__(self, msg)
def adapt_date_iso(val):
"""Adapt datetime.date to ISO 8601 date."""
return val.isoformat()
def convert_date(val):
"""Convert ISO 8601 date to datetime.date object."""
return datetime.date.fromisoformat(val.decode())
sqlite3.register_adapter(datetime.date, adapt_date_iso)
sqlite3.register_converter("date", convert_date)
class RefLetterModel:
def __init__(self):
# Create a database in RAM.
self._db = sqlite3.connect(
"reference_list.sqlite3", detect_types=sqlite3.PARSE_DECLTYPES
)
self._db.row_factory = sqlite3.Row
# Create the basic refletter table.
self._db.cursor().execute(
"""
CREATE TABLE if not exists refletters(
id INTEGER PRIMARY KEY,
name TEXT,
ref_date DATE,
start_year TEXT,
end_year TEXT,
target TEXT,
how_known TEXT,
recommendation TEXT)
"""
)
self._db.commit()
# Current refletter when editing.
self.current_id = None
def add(self, refletter):
cursor = self._db.cursor()
cursor.execute(
"""
INSERT INTO refletters(name, ref_date, start_year, end_year, how_known,recommendation)
VALUES(:name, :ref_date, :start_year, :end_year, :how_known, :recommendation)""",
refletter,
)
row_id = cursor.lastrowid
self._db.commit()
new_id = (
self._db.cursor()
.execute("SELECT id from refletters where rowid=?", [row_id])
.fetchone()["id"]
)
return new_id
def duplicate(self):
if self.current_id is not None:
data = dict(self.get_current_refletter())
del data["id"]
data["ref_date"] = datetime.date.today()
self.current_id = self.add(data)
def get_summary(self):
def str_not_none(s):
if s == None:
return ""
else:
return str(s)
summary_lines = (
self._db.cursor()
.execute(
"SELECT ref_date,name,target,id from refletters order by ref_date desc"
)
.fetchall()
)
return [
((str(d), str_not_none(n), str_not_none(t)), record_id)
for d, n, t, record_id in summary_lines
]
def get_refletter(self, refletter_id):
return (
self._db.cursor()
.execute(
"SELECT id, * from refletters WHERE id=:id",
{"id": refletter_id},
)
.fetchone()
)
def get_current_refletter(self):
if self.current_id is None:
return {
"ref_date": datetime.date.today(),
"target": "",
"name": "",
"start_year": "",
"end_year": "",
"how_known": "",
"recommendation": "",
}
else:
details = dict(self.get_refletter(self.current_id))
if details["end_year"] is None:
details["end_year"] = ""
if type(details["start_year"]) == str:
details["start_year"] = int(details["start_year"])
return details
def validate_refletter(self, details):
def check_val(details, val):
if val not in details:
return True
if details[val] is None:
return True
if len(str(details[val])) == 0:
return True
return False
if check_val(details, "start_year"):
raise ValidationError(f"Start year missing{details}")
elif check_val(details, "recommendation"):
raise ValidationError(
f"Missing recommendation:{details} {list(details.keys())}"
)
elif check_val(details, "how_known"):
raise ValidationError("Missing how you know them")
def update_current_refletter(self, details):
self.validate_refletter(details)
if self.current_id is None:
self.add(details)
else:
columns = ",".join(["%s=:%s" % (col, col) for col in details.keys()])
self._db.cursor().execute(
f"""
UPDATE refletters SET {columns} WHERE id=:id""",
details,
)
self._db.commit()
def delete_refletter(self, refletter_id):
self._db.cursor().execute(
"""
DELETE FROM refletters WHERE id=:id""",
{"id": refletter_id},
)
self._db.commit()
def write_docx(self):
if self.current_id is not None:
data = dict(self.get_current_refletter())
self.validate_refletter(data)
date_text = data["ref_date"].strftime("%d %b %Y")
data["has_end"] = len(data["end_year"].strip()) != 0
context = {
"ref_date": date_text,
"start_date": "Sep %s" % data["start_year"],
"has_end": data["has_end"],
"how_known": data["how_known"],
"end_date": "June %s" % data["end_year"],
"recommendation_text": data["recommendation"],
"student_name": data["name"],
"target": data["target"],
}
name_clean = re.sub(r"\W+", "_", data["name"])
filename = Path(
datetime.date.today().strftime(f"%Y-%m-%d-{name_clean}.docx")
)
doc = DocxTemplate("reference_template.docx")
try:
doc.render(context)
except docx.opc.exceptions.PackageNotFoundError:
return False
doc.save(filename)
pdf_name = str(filename.absolute().with_suffix(".pdf"))
if sys.platform == "win32":
import comtypes
import comtypes.client
word = comtypes.client.CreateObject("Word.Application")
word.Visible = 1
doc = word.Documents.Open(str(filename.absolute()))
doc.SaveAs(pdf_name, 17)
doc.Close()
os.startfile(pdf_name)
else:
# TODO: other OS support for
# docx -> pdf conversion
os.startfile(filename)
return True
class LetterList(EscapeFrame):
def __init__(self, screen, model):
super(LetterList, self).__init__(
screen,
screen.height,
screen.width,
on_load=self._reload_list,
hover_focus=True,
can_scroll=False,
title="List of references",
)
# Save off the model that accesses the contacts database.
self._model = model
self.palette = custom_colour_theme
# Create the form for displaying the list of contacts.
self._list_view = MultiColumnListBox(
Widget.FILL_FRAME,
columns=["<15%", "<40%", "<40%"],
options=model.get_summary(),
name="letters",
add_scroll_bar=True,
on_change=self._on_pick,
on_select=self._edit,
)
self._generate_button = Button("Generate (F5)", self._generate)
self._copy_button = Button("Copy", self._copy)
self._edit_button = Button("Edit", self._edit)
self._delete_button = Button("Delete", self._delete)
layout = Layout([100], fill_frame=True)
self.add_layout(layout)
layout.add_widget(self._list_view)
layout.add_widget(Divider())
layout2 = Layout([1, 1, 1, 1, 1, 1])
self.add_layout(layout2)
layout2.add_widget(Button("Add", self._add), 0)
layout2.add_widget(self._copy_button, 1)
layout2.add_widget(self._edit_button, 2)
layout2.add_widget(self._delete_button, 3)
layout2.add_widget(self._generate_button, 4)
layout2.add_widget(Button("Quit", self._quit), 5)
self.fix()
self._on_pick()
def _on_pick(self):
self._edit_button.disabled = self._list_view.value is None
self._delete_button.disabled = self._list_view.value is None
self._copy_button.disabled = self._list_view.value is None
def _reload_list(self, new_value=None):
self._list_view.options = self._model.get_summary()
self._list_view.value = new_value
def reset(self):
super(LetterList, self).reset()
if self._model.current_id is not None:
self._list_view.value = self._model.current_id
def process_event(self, event):
if isinstance(event, KeyboardEvent) and event.key_code == Screen.KEY_F5:
self._generate()
else:
super().process_event(event)
def _add(self):
self._model.current_id = None
raise NextScene("Edit Reference")
def _copy(self):
self.save()
self._model.current_id = self.data["letters"]
self._model.duplicate()
raise NextScene("Edit Reference")
def _generate(self):
self.save()
self._model.current_id = self.data["letters"]
if self._model.write_docx() == False:
self._scene.add_effect(
PopUpDialog(
self.screen,
"Couldn't write docx file - is the template open and locked in word?",
buttons=["OK"],
)
)
def _edit(self):
self.save()
self._model.current_id = self.data["letters"]
raise NextScene("Edit Reference")
def _delete(self):
self.save()
self._model.delete_contact(self.data["letters"])
self._reload_list()
def cancel(self):
self._quit()
@staticmethod
def _quit():
raise StopApplication("User pressed quit")
class LetterView(EscapeFrame):
def __init__(self, screen, model):
super(LetterView, self).__init__(
screen,
screen.height * 2 // 3,
screen.width * 2 // 3,
hover_focus=True,
can_scroll=False,
title="Reference Details",
reduce_cpu=True,
)
# Save off the model that accesses the contacts database.
self._model = model
# Create the form for displaying the list of contacts.
layout = Layout([100], fill_frame=True)
self.add_layout(layout)
layout.add_widget(Text("Name:", "name"))
layout.add_widget(DatePicker("Reference date:", "ref_date"))
year_range = range(
datetime.date.today().year - 10, datetime.date.today().year + 1
)
year_range = list(reversed(year_range))
layout.add_widget(
DropdownList(
options=[(str(x), x) for x in year_range],
label="Start year:",
name="start_year",
)
)
layout.add_widget(
DropdownList(
options=[("Still here", "")] + [(str(x), x) for x in year_range],
label="End year:",
name="end_year",
)
)
layout.add_widget(Text("Target course or university:", "target"))
layout.add_widget(Text("How known:", "how_known"))
layout.add_widget(
TextBox(
Widget.FILL_FRAME,
"Recommendation:",
"recommendation",
as_string=True,
line_wrap=True,
)
)
layout2 = Layout([1, 1, 1, 1])
self.add_layout(layout2)
layout2.add_widget(Button("OK", self._ok), 0)
layout2.add_widget(Button("Cancel", self.cancel), 3)
self.fix()
def reset(self):
# Do standard reset to clear out form, then populate with new data.
super(LetterView, self).reset()
self.data = self._model.get_current_refletter()
def _strip_full_stops(self, fields):
for f in fields:
self.data[f] = self.data[f].strip()
if self.data[f].endswith("."):
self.data[f] = self.data[f][:-1]
def _ok(self):
self.save()
self._strip_full_stops(["target", "how_known", "recommendation"])
try:
self._model.update_current_refletter(self.data)
raise NextScene("Main")
except ValidationError as e:
message = e.args[0]
self._scene.add_effect(
PopUpDialog(self.screen, f"{message}: please fix", buttons=["OK"])
)
raise e
def is_dirty(self):
self.save()
return (self._model.get_current_refletter()!=self.data)
def cancel(self):
if self.is_dirty():
def quit_if_1(v):
if v==1:
raise NextScene("Main")
self._scene.add_effect(
PopUpDialog(
self.screen,
"You've made changes, dump them?",
buttons=["Cancel","OK"],on_close=quit_if_1
))
else:
raise NextScene("Main")
custom_colour_theme = dict(asciimatics.widgets.utilities.THEMES["default"])
custom_colour_theme["selected_field"] = (
Screen.COLOUR_BLACK,
Screen.A_NORMAL,
Screen.COLOUR_CYAN,
)
def run_scenes(screen, scene, letters):
scenes = [
Scene([LetterList(screen, letters)], -1, name="Main"),
Scene([LetterView(screen, letters)], -1, name="Edit Reference"),
]
screen.play(scenes, stop_on_resize=True, start_scene=scene, allow_int=True)
def run():
letters = RefLetterModel()
last_scene = None
while True:
try:
Screen.wrapper(
run_scenes, catch_interrupt=True, arguments=[last_scene, letters]
)
sys.exit(0)
except ResizeScreenError as e:
last_scene = e.scene