home · contact · privacy
Add basic sorting features to Condition, Process table views.
[plomtask] / plomtask / http.py
1 """Web server stuff."""
2 from typing import Any
3 from http.server import BaseHTTPRequestHandler
4 from http.server import HTTPServer
5 from urllib.parse import urlparse, parse_qs
6 from os.path import split as path_split
7 from jinja2 import Environment as JinjaEnv, FileSystemLoader as JinjaFSLoader
8 from plomtask.days import Day, todays_date
9 from plomtask.exceptions import HandledException, BadFormatException, \
10         NotFoundException
11 from plomtask.db import DatabaseConnection, DatabaseFile
12 from plomtask.processes import Process
13 from plomtask.conditions import Condition
14 from plomtask.todos import Todo
15
16 TEMPLATES_DIR = 'templates'
17
18
19 class TaskServer(HTTPServer):
20     """Variant of HTTPServer that knows .jinja as Jinja Environment."""
21
22     def __init__(self, db_file: DatabaseFile,
23                  *args: Any, **kwargs: Any) -> None:
24         super().__init__(*args, **kwargs)
25         self.db = db_file
26         self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR))
27
28
29 class InputsParser:
30     """Wrapper for validating and retrieving dict-like HTTP inputs."""
31
32     def __init__(self, dict_: dict[str, list[str]],
33                  strictness: bool = True) -> None:
34         self.inputs = dict_
35         self.strict = strictness
36
37     def get_str(self, key: str, default: str = '',
38                 ignore_strict: bool = False) -> str:
39         """Retrieve single/first string value of key, or default."""
40         if key not in self.inputs.keys() or 0 == len(self.inputs[key]):
41             if self.strict and not ignore_strict:
42                 raise BadFormatException(f'no value found for key {key}')
43             return default
44         return self.inputs[key][0]
45
46     def get_int(self, key: str) -> int:
47         """Retrieve single/first value of key as int, error if empty."""
48         val = self.get_int_or_none(key)
49         if val is None:
50             raise BadFormatException(f'unexpected empty value for: {key}')
51         return val
52
53     def get_int_or_none(self, key: str) -> int | None:
54         """Retrieve single/first value of key as int, return None if empty."""
55         val = self.get_str(key, ignore_strict=True)
56         if val == '':
57             return None
58         try:
59             return int(val)
60         except ValueError as e:
61             msg = f'cannot int form field value for key {key}: {val}'
62             raise BadFormatException(msg) from e
63
64     def get_float(self, key: str) -> float:
65         """Retrieve float value of key from self.postvars."""
66         val = self.get_str(key)
67         try:
68             return float(val)
69         except ValueError as e:
70             msg = f'cannot float form field value for key {key}: {val}'
71             raise BadFormatException(msg) from e
72
73     def get_all_str(self, key: str) -> list[str]:
74         """Retrieve list of string values at key."""
75         if key not in self.inputs.keys():
76             return []
77         return self.inputs[key]
78
79     def get_all_int(self, key: str) -> list[int]:
80         """Retrieve list of int values at key."""
81         all_str = self.get_all_str(key)
82         try:
83             return [int(s) for s in all_str if len(s) > 0]
84         except ValueError as e:
85             msg = f'cannot int a form field value for key {key} in: {all_str}'
86             raise BadFormatException(msg) from e
87
88
89 class TaskHandler(BaseHTTPRequestHandler):
90     """Handles single HTTP request."""
91     server: TaskServer
92
93     def do_GET(self) -> None:
94         """Handle any GET request."""
95         try:
96             self._init_handling()
97             if hasattr(self, f'do_GET_{self.site}'):
98                 template = f'{self.site}.html'
99                 ctx = getattr(self, f'do_GET_{self.site}')()
100                 html = self.server.jinja.get_template(template).render(**ctx)
101                 self._send_html(html)
102             elif '' == self.site:
103                 self._redirect('/day')
104             else:
105                 raise NotFoundException(f'Unknown page: /{self.site}')
106         except HandledException as error:
107             self._send_msg(error, code=error.http_code)
108         finally:
109             self.conn.close()
110
111     def do_GET_calendar(self) -> dict[str, object]:
112         """Show Days from ?start= to ?end=."""
113         start = self.params.get_str('start')
114         end = self.params.get_str('end')
115         days = Day.all(self.conn, date_range=(start, end), fill_gaps=True)
116         return {'start': start, 'end': end, 'days': days}
117
118     def do_GET_day(self) -> dict[str, object]:
119         """Show single Day of ?date=."""
120         date = self.params.get_str('date', todays_date())
121         todays_todos = Todo.by_date(self.conn, date)
122         conditions_present = []
123         enablers_for = {}
124         for todo in todays_todos:
125             for condition in todo.conditions:
126                 if condition not in conditions_present:
127                     conditions_present += [condition]
128                     enablers_for[condition.id_] = [p for p in
129                                                    Process.all(self.conn)
130                                                    if condition in p.enables]
131         seen_todos: set[int] = set()
132         top_nodes = [t.get_step_tree(seen_todos)
133                      for t in todays_todos if not t.parents]
134         return {'day': Day.by_id(self.conn, date, create=True),
135                 'top_nodes': top_nodes,
136                 'enablers_for': enablers_for,
137                 'conditions_present': conditions_present,
138                 'processes': Process.all(self.conn)}
139
140     def do_GET_todo(self) -> dict[str, object]:
141         """Show single Todo of ?id=."""
142         id_ = self.params.get_int('id')
143         todo = Todo.by_id(self.conn, id_)
144         return {'todo': todo,
145                 'todo_candidates': Todo.by_date(self.conn, todo.date),
146                 'condition_candidates': Condition.all(self.conn)}
147
148     def do_GET_conditions(self) -> dict[str, object]:
149         """Show all Conditions."""
150         conditions = Condition.all(self.conn)
151         sort_by = self.params.get_str('sort_by')
152         if sort_by == 'is_active':
153             conditions.sort(key=lambda c: c.is_active)
154         elif sort_by == '-is_active':
155             conditions.sort(key=lambda c: c.is_active, reverse=True)
156         elif sort_by == '-title':
157             conditions.sort(key=lambda c: c.title.newest, reverse=True)
158         else:
159             conditions.sort(key=lambda c: c.title.newest)
160         return {'conditions': conditions, 'sort_by': sort_by}
161
162     def do_GET_condition(self) -> dict[str, object]:
163         """Show Condition of ?id=."""
164         id_ = self.params.get_int_or_none('id')
165         return {'condition': Condition.by_id(self.conn, id_, create=True)}
166
167     def do_GET_condition_titles(self) -> dict[str, object]:
168         """Show title history of Condition of ?id=."""
169         id_ = self.params.get_int_or_none('id')
170         condition = Condition.by_id(self.conn, id_)
171         return {'condition': condition}
172
173     def do_GET_condition_descriptions(self) -> dict[str, object]:
174         """Show description historys of Condition of ?id=."""
175         id_ = self.params.get_int_or_none('id')
176         condition = Condition.by_id(self.conn, id_)
177         return {'condition': condition}
178
179     def do_GET_process(self) -> dict[str, object]:
180         """Show Process of ?id=."""
181         id_ = self.params.get_int_or_none('id')
182         process = Process.by_id(self.conn, id_, create=True)
183         return {'process': process,
184                 'steps': process.get_steps(self.conn),
185                 'owners': process.used_as_step_by(self.conn),
186                 'step_candidates': Process.all(self.conn),
187                 'condition_candidates': Condition.all(self.conn)}
188
189     def do_GET_process_titles(self) -> dict[str, object]:
190         """Show title history of Process of ?id=."""
191         id_ = self.params.get_int_or_none('id')
192         process = Process.by_id(self.conn, id_)
193         return {'process': process}
194
195     def do_GET_process_descriptions(self) -> dict[str, object]:
196         """Show description historys of Process of ?id=."""
197         id_ = self.params.get_int_or_none('id')
198         process = Process.by_id(self.conn, id_)
199         return {'process': process}
200
201     def do_GET_process_efforts(self) -> dict[str, object]:
202         """Show default effort history of Process of ?id=."""
203         id_ = self.params.get_int_or_none('id')
204         process = Process.by_id(self.conn, id_)
205         return {'process': process}
206
207     def do_GET_processes(self) -> dict[str, object]:
208         """Show all Processes."""
209         processes = Process.all(self.conn)
210         sort_by = self.params.get_str('sort_by')
211         if sort_by == 'steps':
212             processes.sort(key=lambda c: len(c.explicit_steps))
213         elif sort_by == '-steps':
214             processes.sort(key=lambda c: len(c.explicit_steps), reverse=True)
215         elif sort_by == '-title':
216             processes.sort(key=lambda c: c.title.newest, reverse=True)
217         else:
218             processes.sort(key=lambda c: c.title.newest)
219         return {'processes': processes, 'sort_by': sort_by}
220
221     def do_POST(self) -> None:
222         """Handle any POST request."""
223         # pylint: disable=attribute-defined-outside-init
224         try:
225             self._init_handling()
226             length = int(self.headers['content-length'])
227             postvars = parse_qs(self.rfile.read(length).decode(),
228                                 keep_blank_values=True, strict_parsing=True)
229             self.form_data = InputsParser(postvars)
230             if hasattr(self, f'do_POST_{self.site}'):
231                 redir_target = getattr(self, f'do_POST_{self.site}')()
232                 self.conn.commit()
233             else:
234                 msg = f'Page not known as POST target: /{self.site}'
235                 raise NotFoundException(msg)
236             self._redirect(redir_target)
237         except HandledException as error:
238             self._send_msg(error, code=error.http_code)
239         finally:
240             self.conn.close()
241
242     def do_POST_day(self) -> str:
243         """Update or insert Day of date and Todos mapped to it."""
244         date = self.params.get_str('date')
245         day = Day.by_id(self.conn, date, create=True)
246         day.comment = self.form_data.get_str('day_comment')
247         day.save(self.conn)
248         new_todos = []
249         for process_id in self.form_data.get_all_int('new_todo'):
250             process = Process.by_id(self.conn, process_id)
251             todo = Todo(None, process, False, day.date)
252             todo.save(self.conn)
253             new_todos += [todo]
254         adopted = True
255         while adopted:
256             adopted = False
257             existing_todos = Todo.by_date(self.conn, date)
258             for todo in new_todos:
259                 if todo.adopt_from(existing_todos):
260                     adopted = True
261                 todo.make_missing_children(self.conn)
262                 todo.save(self.conn)
263         done_ids = self.form_data.get_all_int('done')
264         comments = self.form_data.get_all_str('comment')
265         for i, todo_id in enumerate(self.form_data.get_all_int('todo_id')):
266             todo = Todo.by_id(self.conn, todo_id)
267             todo.is_done = todo_id in done_ids
268             if len(comments) > 0:
269                 todo.comment = comments[i]
270             todo.save(self.conn)
271             for condition in todo.enables:
272                 condition.save(self.conn)
273             for condition in todo.disables:
274                 condition.save(self.conn)
275         return f'/day?date={date}'
276
277     def do_POST_todo(self) -> str:
278         """Update Todo and its children."""
279         id_ = self.params.get_int('id')
280         for _ in self.form_data.get_all_str('delete'):
281             todo = Todo .by_id(self.conn, id_)
282             todo.remove(self.conn)
283             return '/'
284         todo = Todo.by_id(self.conn, id_)
285         adopted_child_ids = self.form_data.get_all_int('adopt')
286         for child in todo.children:
287             if child.id_ not in adopted_child_ids:
288                 assert isinstance(child.id_, int)
289                 child = Todo.by_id(self.conn, child.id_)
290                 todo.remove_child(child)
291         for child_id in adopted_child_ids:
292             if child_id in [c.id_ for c in todo.children]:
293                 continue
294             child = Todo.by_id(self.conn, child_id)
295             todo.add_child(child)
296         todo.set_conditions(self.conn, self.form_data.get_all_int('condition'))
297         todo.set_enables(self.conn, self.form_data.get_all_int('enables'))
298         todo.set_disables(self.conn, self.form_data.get_all_int('disables'))
299         todo.is_done = len(self.form_data.get_all_str('done')) > 0
300         todo.comment = self.form_data.get_str('comment', ignore_strict=True)
301         todo.save(self.conn)
302         for condition in todo.enables:
303             condition.save(self.conn)
304         for condition in todo.disables:
305             condition.save(self.conn)
306         return f'/todo?id={todo.id_}'
307
308     def do_POST_process(self) -> str:
309         """Update or insert Process of ?id= and fields defined in postvars."""
310         id_ = self.params.get_int_or_none('id')
311         for _ in self.form_data.get_all_str('delete'):
312             process = Process.by_id(self.conn, id_)
313             process.remove(self.conn)
314             return '/processes'
315         process = Process.by_id(self.conn, id_, create=True)
316         process.title.set(self.form_data.get_str('title'))
317         process.description.set(self.form_data.get_str('description'))
318         process.effort.set(self.form_data.get_float('effort'))
319         process.set_conditions(self.conn,
320                                self.form_data.get_all_int('condition'))
321         process.set_enables(self.conn, self.form_data.get_all_int('enables'))
322         process.set_disables(self.conn, self.form_data.get_all_int('disables'))
323         process.save(self.conn)
324         process.explicit_steps = []
325         steps: list[tuple[int | None, int, int | None]] = []
326         for step_id in self.form_data.get_all_int('steps'):
327             for step_process_id in self.form_data.get_all_int(
328                     f'new_step_to_{step_id}'):
329                 steps += [(None, step_process_id, step_id)]
330             if step_id not in self.form_data.get_all_int('keep_step'):
331                 continue
332             step_process_id = self.form_data.get_int(
333                     f'step_{step_id}_process_id')
334             parent_id = self.form_data.get_int_or_none(
335                     f'step_{step_id}_parent_id')
336             steps += [(step_id, step_process_id, parent_id)]
337         for step_process_id in self.form_data.get_all_int('new_top_step'):
338             steps += [(None, step_process_id, None)]
339         process.set_steps(self.conn, steps)
340         process.save(self.conn)
341         return f'/process?id={process.id_}'
342
343     def do_POST_condition(self) -> str:
344         """Update/insert Condition of ?id= and fields defined in postvars."""
345         id_ = self.params.get_int_or_none('id')
346         for _ in self.form_data.get_all_str('delete'):
347             condition = Condition.by_id(self.conn, id_)
348             condition.remove(self.conn)
349             return '/conditions'
350         condition = Condition.by_id(self.conn, id_, create=True)
351         condition.is_active = self.form_data.get_all_str('is_active') != []
352         condition.title.set(self.form_data.get_str('title'))
353         condition.description.set(self.form_data.get_str('description'))
354         condition.save(self.conn)
355         return f'/condition?id={condition.id_}'
356
357     def _init_handling(self) -> None:
358         # pylint: disable=attribute-defined-outside-init
359         self.conn = DatabaseConnection(self.server.db)
360         parsed_url = urlparse(self.path)
361         self.site = path_split(parsed_url.path)[1]
362         params = parse_qs(parsed_url.query, strict_parsing=True)
363         self.params = InputsParser(params, False)
364
365     def _redirect(self, target: str) -> None:
366         self.send_response(302)
367         self.send_header('Location', target)
368         self.end_headers()
369
370     def _send_html(self, html: str, code: int = 200) -> None:
371         """Send HTML as proper HTTP response."""
372         self.send_response(code)
373         self.end_headers()
374         self.wfile.write(bytes(html, 'utf-8'))
375
376     def _send_msg(self, msg: Exception, code: int = 400) -> None:
377         """Send message in HTML formatting as HTTP response."""
378         html = self.server.jinja.get_template('msg.html').render(msg=msg)
379         self._send_html(html, code)