home · contact · privacy
Refactor VersionedAttribute history pages templates.
[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 self.site in {'calendar', 'day', 'process', 'process_titles',
98                              'process_descriptions', 'process_efforts',
99                              'processes', 'todo', 'condition', 'conditions'}:
100                 template = f'{self.site}.html'
101                 ctx = getattr(self, f'do_GET_{self.site}')()
102                 html = self.server.jinja.get_template(template).render(**ctx)
103                 self._send_html(html)
104             elif '' == self.site:
105                 self._redirect('/day')
106             else:
107                 raise NotFoundException(f'Unknown page: /{self.site}')
108         except HandledException as error:
109             self._send_msg(error, code=error.http_code)
110         finally:
111             self.conn.close()
112
113     def do_GET_calendar(self) -> dict[str, object]:
114         """Show Days from ?start= to ?end=."""
115         start = self.params.get_str('start')
116         end = self.params.get_str('end')
117         days = Day.all(self.conn, date_range=(start, end), fill_gaps=True)
118         return {'start': start, 'end': end, 'days': days}
119
120     def do_GET_day(self) -> dict[str, object]:
121         """Show single Day of ?date=."""
122         date = self.params.get_str('date', todays_date())
123         todays_todos = Todo.by_date(self.conn, date)
124         conditions_present = []
125         enablers_for = {}
126         for todo in todays_todos:
127             for condition in todo.conditions:
128                 if condition not in conditions_present:
129                     conditions_present += [condition]
130                     enablers_for[condition.id_] = [p for p in
131                                                    Process.all(self.conn)
132                                                    if condition in p.enables]
133         seen_todos: set[int] = set()
134         top_nodes = [t.get_step_tree(seen_todos)
135                      for t in todays_todos if not t.parents]
136         return {'day': Day.by_id(self.conn, date, create=True),
137                 'top_nodes': top_nodes,
138                 'enablers_for': enablers_for,
139                 'conditions_present': conditions_present,
140                 'processes': Process.all(self.conn)}
141
142     def do_GET_todo(self) -> dict[str, object]:
143         """Show single Todo of ?id=."""
144         id_ = self.params.get_int('id')
145         todo = Todo.by_id(self.conn, id_)
146         return {'todo': todo,
147                 'todo_candidates': Todo.by_date(self.conn, todo.date),
148                 'condition_candidates': Condition.all(self.conn)}
149
150     def do_GET_conditions(self) -> dict[str, object]:
151         """Show all Conditions."""
152         return {'conditions': Condition.all(self.conn)}
153
154     def do_GET_condition(self) -> dict[str, object]:
155         """Show Condition of ?id=."""
156         id_ = self.params.get_int_or_none('id')
157         return {'condition': Condition.by_id(self.conn, id_, create=True)}
158
159     def do_GET_process(self) -> dict[str, object]:
160         """Show Process of ?id=."""
161         id_ = self.params.get_int_or_none('id')
162         process = Process.by_id(self.conn, id_, create=True)
163         return {'process': process,
164                 'steps': process.get_steps(self.conn),
165                 'owners': process.used_as_step_by(self.conn),
166                 'step_candidates': Process.all(self.conn),
167                 'condition_candidates': Condition.all(self.conn)}
168
169     def do_GET_process_titles(self) -> dict[str, object]:
170         """Show title history of Process of ?id=."""
171         id_ = self.params.get_int_or_none('id')
172         process = Process.by_id(self.conn, id_)
173         return {'process': process}
174
175     def do_GET_process_descriptions(self) -> dict[str, object]:
176         """Show description historys of Process of ?id=."""
177         id_ = self.params.get_int_or_none('id')
178         process = Process.by_id(self.conn, id_)
179         return {'process': process}
180
181     def do_GET_process_efforts(self) -> dict[str, object]:
182         """Show default effort history of Process of ?id=."""
183         id_ = self.params.get_int_or_none('id')
184         process = Process.by_id(self.conn, id_)
185         return {'process': process}
186
187     def do_GET_processes(self) -> dict[str, object]:
188         """Show all Processes."""
189         return {'processes': Process.all(self.conn)}
190
191     def do_POST(self) -> None:
192         """Handle any POST request."""
193         # pylint: disable=attribute-defined-outside-init
194         try:
195             self._init_handling()
196             length = int(self.headers['content-length'])
197             postvars = parse_qs(self.rfile.read(length).decode(),
198                                 keep_blank_values=True, strict_parsing=True)
199             self.form_data = InputsParser(postvars)
200             if self.site in ('day', 'process', 'todo', 'condition'):
201                 redir_target = getattr(self, f'do_POST_{self.site}')()
202                 self.conn.commit()
203             else:
204                 msg = f'Page not known as POST target: /{self.site}'
205                 raise NotFoundException(msg)
206             self._redirect(redir_target)
207         except HandledException as error:
208             self._send_msg(error, code=error.http_code)
209         finally:
210             self.conn.close()
211
212     def do_POST_day(self) -> str:
213         """Update or insert Day of date and Todos mapped to it."""
214         date = self.params.get_str('date')
215         day = Day.by_id(self.conn, date, create=True)
216         day.comment = self.form_data.get_str('day_comment')
217         day.save(self.conn)
218         new_todos = []
219         for process_id in self.form_data.get_all_int('new_todo'):
220             process = Process.by_id(self.conn, process_id)
221             todo = Todo(None, process, False, day.date)
222             todo.save(self.conn)
223             new_todos += [todo]
224         adopted = True
225         while adopted:
226             adopted = False
227             existing_todos = Todo.by_date(self.conn, date)
228             for todo in new_todos:
229                 if todo.adopt_from(existing_todos):
230                     adopted = True
231                 todo.make_missing_children(self.conn)
232                 todo.save(self.conn)
233         done_ids = self.form_data.get_all_int('done')
234         comments = self.form_data.get_all_str('comment')
235         for i, todo_id in enumerate(self.form_data.get_all_int('todo_id')):
236             todo = Todo.by_id(self.conn, todo_id)
237             todo.is_done = todo_id in done_ids
238             if len(comments) > 0:
239                 todo.comment = comments[i]
240             todo.save(self.conn)
241             for condition in todo.enables:
242                 condition.save(self.conn)
243             for condition in todo.disables:
244                 condition.save(self.conn)
245         return f'/day?date={date}'
246
247     def do_POST_todo(self) -> str:
248         """Update Todo and its children."""
249         id_ = self.params.get_int('id')
250         for _ in self.form_data.get_all_str('delete'):
251             todo = Todo .by_id(self.conn, id_)
252             todo.remove(self.conn)
253             return '/'
254         todo = Todo.by_id(self.conn, id_)
255         adopted_child_ids = self.form_data.get_all_int('adopt')
256         for child in todo.children:
257             if child.id_ not in adopted_child_ids:
258                 assert isinstance(child.id_, int)
259                 child = Todo.by_id(self.conn, child.id_)
260                 todo.remove_child(child)
261         for child_id in adopted_child_ids:
262             if child_id in [c.id_ for c in todo.children]:
263                 continue
264             child = Todo.by_id(self.conn, child_id)
265             todo.add_child(child)
266         todo.set_conditions(self.conn, self.form_data.get_all_int('condition'))
267         todo.set_enables(self.conn, self.form_data.get_all_int('enables'))
268         todo.set_disables(self.conn, self.form_data.get_all_int('disables'))
269         todo.is_done = len(self.form_data.get_all_str('done')) > 0
270         todo.comment = self.form_data.get_str('comment', ignore_strict=True)
271         todo.save(self.conn)
272         for condition in todo.enables:
273             condition.save(self.conn)
274         for condition in todo.disables:
275             condition.save(self.conn)
276         return f'/todo?id={todo.id_}'
277
278     def do_POST_process(self) -> str:
279         """Update or insert Process of ?id= and fields defined in postvars."""
280         id_ = self.params.get_int_or_none('id')
281         for _ in self.form_data.get_all_str('delete'):
282             process = Process.by_id(self.conn, id_)
283             process.remove(self.conn)
284             return '/processes'
285         process = Process.by_id(self.conn, id_, create=True)
286         process.title.set(self.form_data.get_str('title'))
287         process.description.set(self.form_data.get_str('description'))
288         process.effort.set(self.form_data.get_float('effort'))
289         process.set_conditions(self.conn,
290                                self.form_data.get_all_int('condition'))
291         process.set_enables(self.conn, self.form_data.get_all_int('enables'))
292         process.set_disables(self.conn, self.form_data.get_all_int('disables'))
293         process.save(self.conn)
294         process.explicit_steps = []
295         steps: list[tuple[int | None, int, int | None]] = []
296         for step_id in self.form_data.get_all_int('steps'):
297             for step_process_id in self.form_data.get_all_int(
298                     f'new_step_to_{step_id}'):
299                 steps += [(None, step_process_id, step_id)]
300             if step_id not in self.form_data.get_all_int('keep_step'):
301                 continue
302             step_process_id = self.form_data.get_int(
303                     f'step_{step_id}_process_id')
304             parent_id = self.form_data.get_int_or_none(
305                     f'step_{step_id}_parent_id')
306             steps += [(step_id, step_process_id, parent_id)]
307         for step_process_id in self.form_data.get_all_int('new_top_step'):
308             steps += [(None, step_process_id, None)]
309         process.set_steps(self.conn, steps)
310         process.save(self.conn)
311         return f'/process?id={process.id_}'
312
313     def do_POST_condition(self) -> str:
314         """Update/insert Condition of ?id= and fields defined in postvars."""
315         id_ = self.params.get_int_or_none('id')
316         for _ in self.form_data.get_all_str('delete'):
317             condition = Condition.by_id(self.conn, id_)
318             condition.remove(self.conn)
319             return '/conditions'
320         condition = Condition.by_id(self.conn, id_, create=True)
321         condition.is_active = self.form_data.get_all_str('is_active') != []
322         condition.title.set(self.form_data.get_str('title'))
323         condition.description.set(self.form_data.get_str('description'))
324         condition.save(self.conn)
325         return f'/condition?id={condition.id_}'
326
327     def _init_handling(self) -> None:
328         # pylint: disable=attribute-defined-outside-init
329         self.conn = DatabaseConnection(self.server.db)
330         parsed_url = urlparse(self.path)
331         self.site = path_split(parsed_url.path)[1]
332         params = parse_qs(parsed_url.query, strict_parsing=True)
333         self.params = InputsParser(params, False)
334
335     def _redirect(self, target: str) -> None:
336         self.send_response(302)
337         self.send_header('Location', target)
338         self.end_headers()
339
340     def _send_html(self, html: str, code: int = 200) -> None:
341         """Send HTML as proper HTTP response."""
342         self.send_response(code)
343         self.end_headers()
344         self.wfile.write(bytes(html, 'utf-8'))
345
346     def _send_msg(self, msg: Exception, code: int = 400) -> None:
347         """Send message in HTML formatting as HTTP response."""
348         html = self.server.jinja.get_template('msg.html').render(msg=msg)
349         self._send_html(html, code)