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