home · contact · privacy
Fix minor ProcessStep POST handling bugs.
[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         for day in days:
117             day.collect_calendarized_todos(self.conn)
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         disablers_for = {}
127         for todo in todays_todos:
128             for condition in todo.conditions + todo.blockers:
129                 if condition not in conditions_present:
130                     conditions_present += [condition]
131                     enablers_for[condition.id_] = [p for p in
132                                                    Process.all(self.conn)
133                                                    if condition in p.enables]
134                     disablers_for[condition.id_] = [p for p in
135                                                     Process.all(self.conn)
136                                                     if condition in p.disables]
137         seen_todos: set[int] = set()
138         top_nodes = [t.get_step_tree(seen_todos)
139                      for t in todays_todos if not t.parents]
140         return {'day': Day.by_id(self.conn, date, create=True),
141                 'top_nodes': top_nodes,
142                 'enablers_for': enablers_for,
143                 'disablers_for': disablers_for,
144                 'conditions_present': conditions_present,
145                 'processes': Process.all(self.conn)}
146
147     def do_GET_todo(self) -> dict[str, object]:
148         """Show single Todo of ?id=."""
149         id_ = self.params.get_int('id')
150         todo = Todo.by_id(self.conn, id_)
151         return {'todo': todo,
152                 'todo_candidates': Todo.by_date(self.conn, todo.date),
153                 'condition_candidates': Condition.all(self.conn)}
154
155     def do_GET_conditions(self) -> dict[str, object]:
156         """Show all Conditions."""
157         pattern = self.params.get_str('pattern')
158         conditions = Condition.matching(self.conn, pattern)
159         sort_by = self.params.get_str('sort_by')
160         if sort_by == 'is_active':
161             conditions.sort(key=lambda c: c.is_active)
162         elif sort_by == '-is_active':
163             conditions.sort(key=lambda c: c.is_active, reverse=True)
164         elif sort_by == '-title':
165             conditions.sort(key=lambda c: c.title.newest, reverse=True)
166         else:
167             conditions.sort(key=lambda c: c.title.newest)
168         return {'conditions': conditions,
169                 'sort_by': sort_by,
170                 'pattern': pattern}
171
172     def do_GET_condition(self) -> dict[str, object]:
173         """Show Condition of ?id=."""
174         id_ = self.params.get_int_or_none('id')
175         return {'condition': Condition.by_id(self.conn, id_, create=True)}
176
177     def do_GET_condition_titles(self) -> dict[str, object]:
178         """Show title history of Condition of ?id=."""
179         id_ = self.params.get_int_or_none('id')
180         condition = Condition.by_id(self.conn, id_)
181         return {'condition': condition}
182
183     def do_GET_condition_descriptions(self) -> dict[str, object]:
184         """Show description historys of Condition of ?id=."""
185         id_ = self.params.get_int_or_none('id')
186         condition = Condition.by_id(self.conn, id_)
187         return {'condition': condition}
188
189     def do_GET_process(self) -> dict[str, object]:
190         """Show Process of ?id=."""
191         id_ = self.params.get_int_or_none('id')
192         process = Process.by_id(self.conn, id_, create=True)
193         return {'process': process,
194                 'steps': process.get_steps(self.conn),
195                 'owners': process.used_as_step_by(self.conn),
196                 'step_candidates': Process.all(self.conn),
197                 'condition_candidates': Condition.all(self.conn)}
198
199     def do_GET_process_titles(self) -> dict[str, object]:
200         """Show title history of Process of ?id=."""
201         id_ = self.params.get_int_or_none('id')
202         process = Process.by_id(self.conn, id_)
203         return {'process': process}
204
205     def do_GET_process_descriptions(self) -> dict[str, object]:
206         """Show description historys of Process of ?id=."""
207         id_ = self.params.get_int_or_none('id')
208         process = Process.by_id(self.conn, id_)
209         return {'process': process}
210
211     def do_GET_process_efforts(self) -> dict[str, object]:
212         """Show default effort history of Process of ?id=."""
213         id_ = self.params.get_int_or_none('id')
214         process = Process.by_id(self.conn, id_)
215         return {'process': process}
216
217     def do_GET_processes(self) -> dict[str, object]:
218         """Show all Processes."""
219         pattern = self.params.get_str('pattern')
220         processes = Process.matching(self.conn, pattern)
221         sort_by = self.params.get_str('sort_by')
222         if sort_by == 'steps':
223             processes.sort(key=lambda c: len(c.explicit_steps))
224         elif sort_by == '-steps':
225             processes.sort(key=lambda c: len(c.explicit_steps), reverse=True)
226         elif sort_by == '-title':
227             processes.sort(key=lambda c: c.title.newest, reverse=True)
228         else:
229             processes.sort(key=lambda c: c.title.newest)
230         return {'processes': processes, 'sort_by': sort_by, 'pattern': pattern}
231
232     def do_POST(self) -> None:
233         """Handle any POST request."""
234         # pylint: disable=attribute-defined-outside-init
235         try:
236             self._init_handling()
237             length = int(self.headers['content-length'])
238             postvars = parse_qs(self.rfile.read(length).decode(),
239                                 keep_blank_values=True, strict_parsing=True)
240             self.form_data = InputsParser(postvars)
241             if hasattr(self, f'do_POST_{self.site}'):
242                 redir_target = getattr(self, f'do_POST_{self.site}')()
243                 self.conn.commit()
244             else:
245                 msg = f'Page not known as POST target: /{self.site}'
246                 raise NotFoundException(msg)
247             self._redirect(redir_target)
248         except HandledException as error:
249             self._send_msg(error, code=error.http_code)
250         finally:
251             self.conn.close()
252
253     def do_POST_day(self) -> str:
254         """Update or insert Day of date and Todos mapped to it."""
255         date = self.params.get_str('date')
256         day = Day.by_id(self.conn, date, create=True)
257         day.comment = self.form_data.get_str('day_comment')
258         day.save(self.conn)
259         new_todos = []
260         for process_id in self.form_data.get_all_int('new_todo'):
261             process = Process.by_id(self.conn, process_id)
262             todo = Todo(None, process, False, day.date)
263             todo.save(self.conn)
264             new_todos += [todo]
265         adopted = True
266         while adopted:
267             adopted = False
268             existing_todos = Todo.by_date(self.conn, date)
269             for todo in new_todos:
270                 if todo.adopt_from(existing_todos):
271                     adopted = True
272                 todo.make_missing_children(self.conn)
273                 todo.save(self.conn)
274         done_ids = self.form_data.get_all_int('done')
275         comments = self.form_data.get_all_str('comment')
276         efforts = self.form_data.get_all_str('effort')
277         for i, todo_id in enumerate(self.form_data.get_all_int('todo_id')):
278             todo = Todo.by_id(self.conn, todo_id)
279             todo.is_done = todo_id in done_ids
280             if len(comments) > 0:
281                 todo.comment = comments[i]
282             if len(efforts) > 0:
283                 todo.effort = float(efforts[i]) if efforts[i] else None
284             todo.save(self.conn)
285             for condition in todo.enables:
286                 condition.save(self.conn)
287             for condition in todo.disables:
288                 condition.save(self.conn)
289         return f'/day?date={date}'
290
291     def do_POST_todo(self) -> str:
292         """Update Todo and its children."""
293         id_ = self.params.get_int('id')
294         for _ in self.form_data.get_all_str('delete'):
295             todo = Todo .by_id(self.conn, id_)
296             todo.remove(self.conn)
297             return '/'
298         todo = Todo.by_id(self.conn, id_)
299         adopted_child_ids = self.form_data.get_all_int('adopt')
300         for child in todo.children:
301             if child.id_ not in adopted_child_ids:
302                 assert isinstance(child.id_, int)
303                 child = Todo.by_id(self.conn, child.id_)
304                 todo.remove_child(child)
305         for child_id in adopted_child_ids:
306             if child_id in [c.id_ for c in todo.children]:
307                 continue
308             child = Todo.by_id(self.conn, child_id)
309             todo.add_child(child)
310         effort = self.form_data.get_str('effort', ignore_strict=True)
311         todo.effort = float(effort) if effort else None
312         todo.set_conditions(self.conn, self.form_data.get_all_int('condition'))
313         todo.set_blockers(self.conn, self.form_data.get_all_int('blocker'))
314         todo.set_enables(self.conn, self.form_data.get_all_int('enables'))
315         todo.set_disables(self.conn, self.form_data.get_all_int('disables'))
316         todo.is_done = len(self.form_data.get_all_str('done')) > 0
317         todo.calendarize = len(self.form_data.get_all_str('calendarize')) > 0
318         todo.comment = self.form_data.get_str('comment', ignore_strict=True)
319         todo.save(self.conn)
320         for condition in todo.enables:
321             condition.save(self.conn)
322         for condition in todo.disables:
323             condition.save(self.conn)
324         return f'/todo?id={todo.id_}'
325
326     def do_POST_process(self) -> str:
327         """Update or insert Process of ?id= and fields defined in postvars."""
328         id_ = self.params.get_int_or_none('id')
329         for _ in self.form_data.get_all_str('delete'):
330             process = Process.by_id(self.conn, id_)
331             process.remove(self.conn)
332             return '/processes'
333         process = Process.by_id(self.conn, id_, create=True)
334         process.title.set(self.form_data.get_str('title'))
335         process.description.set(self.form_data.get_str('description'))
336         process.effort.set(self.form_data.get_float('effort'))
337         process.set_conditions(self.conn,
338                                self.form_data.get_all_int('condition'))
339         process.set_blockers(self.conn, self.form_data.get_all_int('blocker'))
340         process.set_enables(self.conn, self.form_data.get_all_int('enables'))
341         process.set_disables(self.conn, self.form_data.get_all_int('disables'))
342         process.calendarize = self.form_data.get_all_str('calendarize') != []
343         process.save(self.conn)
344         steps: list[tuple[int | None, int, int | None]] = []
345         for step_id in self.form_data.get_all_int('keep_step'):
346             if step_id not in self.form_data.get_all_int('steps'):
347                 raise BadFormatException('trying to keep unknown step')
348         for step_id in self.form_data.get_all_int('steps'):
349             for step_process_id in self.form_data.get_all_int(
350                     f'new_step_to_{step_id}'):
351                 steps += [(None, step_process_id, step_id)]
352             if step_id not in self.form_data.get_all_int('keep_step'):
353                 continue
354             step_process_id = self.form_data.get_int(
355                     f'step_{step_id}_process_id')
356             parent_id = self.form_data.get_int_or_none(
357                     f'step_{step_id}_parent_id')
358             steps += [(step_id, step_process_id, parent_id)]
359         for step_process_id in self.form_data.get_all_int('new_top_step'):
360             steps += [(None, step_process_id, None)]
361         process.set_steps(self.conn, steps)
362         process.save(self.conn)
363         return f'/process?id={process.id_}'
364
365     def do_POST_condition(self) -> str:
366         """Update/insert Condition of ?id= and fields defined in postvars."""
367         id_ = self.params.get_int_or_none('id')
368         for _ in self.form_data.get_all_str('delete'):
369             condition = Condition.by_id(self.conn, id_)
370             condition.remove(self.conn)
371             return '/conditions'
372         condition = Condition.by_id(self.conn, id_, create=True)
373         condition.is_active = self.form_data.get_all_str('is_active') != []
374         condition.title.set(self.form_data.get_str('title'))
375         condition.description.set(self.form_data.get_str('description'))
376         condition.save(self.conn)
377         return f'/condition?id={condition.id_}'
378
379     def _init_handling(self) -> None:
380         # pylint: disable=attribute-defined-outside-init
381         self.conn = DatabaseConnection(self.server.db)
382         parsed_url = urlparse(self.path)
383         self.site = path_split(parsed_url.path)[1]
384         params = parse_qs(parsed_url.query, strict_parsing=True)
385         self.params = InputsParser(params, False)
386
387     def _redirect(self, target: str) -> None:
388         self.send_response(302)
389         self.send_header('Location', target)
390         self.end_headers()
391
392     def _send_html(self, html: str, code: int = 200) -> None:
393         """Send HTML as proper HTTP response."""
394         self.send_response(code)
395         self.end_headers()
396         self.wfile.write(bytes(html, 'utf-8'))
397
398     def _send_msg(self, msg: Exception, code: int = 400) -> None:
399         """Send message in HTML formatting as HTTP response."""
400         html = self.server.jinja.get_template('msg.html').render(msg=msg)
401         self._send_html(html, code)