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