1 """Web server stuff."""
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, \
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
16 TEMPLATES_DIR = 'templates'
19 class TaskServer(HTTPServer):
20 """Variant of HTTPServer that knows .jinja as Jinja Environment."""
22 def __init__(self, db_file: DatabaseFile,
23 *args: Any, **kwargs: Any) -> None:
24 super().__init__(*args, **kwargs)
26 self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR))
30 """Wrapper for validating and retrieving dict-like HTTP inputs."""
32 def __init__(self, dict_: dict[str, list[str]],
33 strictness: bool = True) -> None:
35 self.strict = strictness
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}')
44 return self.inputs[key][0]
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)
50 raise BadFormatException(f'unexpected empty value for: {key}')
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)
60 except ValueError as e:
61 msg = f'cannot int form field value for key {key}: {val}'
62 raise BadFormatException(msg) from e
64 def get_float(self, key: str) -> float:
65 """Retrieve float value of key from self.postvars."""
66 val = self.get_str(key)
69 except ValueError as e:
70 msg = f'cannot float form field value for key {key}: {val}'
71 raise BadFormatException(msg) from e
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():
77 return self.inputs[key]
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)
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
89 class TaskHandler(BaseHTTPRequestHandler):
90 """Handles single HTTP request."""
93 def do_GET(self) -> None:
94 """Handle any GET request."""
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')
106 raise NotFoundException(f'Unknown page: /{self.site}')
107 except HandledException as error:
108 self._send_msg(error, code=error.http_code)
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}
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 conditions_listing = []
123 for condition in Condition.all(self.conn):
124 enablers = Todo.enablers_for_at(self.conn, condition, date)
125 disablers = Todo.disablers_for_at(self.conn, condition, date)
126 conditions_listing += [{
127 'condition': condition,
128 'enablers': enablers,
129 'disablers': disablers}]
130 return {'day': Day.by_date(self.conn, date, create=True),
131 'todos': Todo.by_date(self.conn, date),
132 'processes': Process.all(self.conn),
133 'conditions_listing': conditions_listing}
135 def do_GET_todo(self) -> dict[str, object]:
136 """Show single Todo of ?id=."""
137 id_ = self.params.get_int_or_none('id')
138 todo = Todo.by_id(self.conn, id_)
139 return {'todo': todo,
140 'todo_candidates': Todo.by_date(self.conn, todo.day.date),
141 'condition_candidates': Condition.all(self.conn)}
143 def do_GET_conditions(self) -> dict[str, object]:
144 """Show all Conditions."""
145 return {'conditions': Condition.all(self.conn)}
147 def do_GET_condition(self) -> dict[str, object]:
148 """Show Condition of ?id=."""
149 id_ = self.params.get_int_or_none('id')
150 return {'condition': Condition.by_id(self.conn, id_, create=True)}
152 def do_GET_process(self) -> dict[str, object]:
153 """Show process of ?id=."""
154 id_ = self.params.get_int_or_none('id')
155 process = Process.by_id(self.conn, id_, create=True)
156 return {'process': process,
157 'steps': process.get_steps(self.conn),
158 'owners': process.used_as_step_by(self.conn),
159 'process_candidates': Process.all(self.conn),
160 'condition_candidates': Condition.all(self.conn)}
162 def do_GET_processes(self) -> dict[str, object]:
163 """Show all Processes."""
164 return {'processes': Process.all(self.conn)}
166 def do_POST(self) -> None:
167 """Handle any POST request."""
168 # pylint: disable=attribute-defined-outside-init
170 self._init_handling()
171 length = int(self.headers['content-length'])
172 postvars = parse_qs(self.rfile.read(length).decode(),
173 keep_blank_values=True, strict_parsing=True)
174 self.form_data = InputsParser(postvars)
175 if self.site in ('day', 'process', 'todo', 'condition'):
176 getattr(self, f'do_POST_{self.site}')()
179 msg = f'Page not known as POST target: /{self.site}'
180 raise NotFoundException(msg)
182 except HandledException as error:
183 self._send_msg(error, code=error.http_code)
187 def do_POST_day(self) -> None:
188 """Update or insert Day of date and Todos mapped to it."""
189 date = self.params.get_str('date')
190 day = Day.by_date(self.conn, date, create=True)
191 day.comment = self.form_data.get_str('comment')
193 process_id = self.form_data.get_int_or_none('new_todo')
194 if process_id is not None:
195 process = Process.by_id(self.conn, process_id)
196 todo = Todo(None, process, False, day)
199 def do_POST_todo(self) -> None:
200 """Update Todo and its children."""
201 id_ = self.params.get_int_or_none('id')
202 todo = Todo.by_id(self.conn, id_)
203 child_id = self.form_data.get_int_or_none('adopt')
204 if child_id is not None:
205 child = Todo.by_id(self.conn, child_id)
206 todo.add_child(child)
207 todo.set_conditions(self.conn, self.form_data.get_all_int('condition'))
208 todo.set_fulfills(self.conn, self.form_data.get_all_int('fulfills'))
209 todo.set_undoes(self.conn, self.form_data.get_all_int('undoes'))
210 todo.is_done = len(self.form_data.get_all_str('done')) > 0
212 for condition in todo.fulfills:
213 condition.save(self.conn)
214 for condition in todo.undoes:
215 condition.save(self.conn)
217 def do_POST_process(self) -> None:
218 """Update or insert Process of ?id= and fields defined in postvars."""
219 id_ = self.params.get_int_or_none('id')
220 process = Process.by_id(self.conn, id_, create=True)
221 process.title.set(self.form_data.get_str('title'))
222 process.description.set(self.form_data.get_str('description'))
223 process.effort.set(self.form_data.get_float('effort'))
224 process.set_conditions(self.conn,
225 self.form_data.get_all_int('condition'))
226 process.set_fulfills(self.conn, self.form_data.get_all_int('fulfills'))
227 process.set_undoes(self.conn, self.form_data.get_all_int('undoes'))
228 process.save_without_steps(self.conn)
229 assert process.id_ is not None # for mypy
230 process.explicit_steps = []
231 for step_id in self.form_data.get_all_int('steps'):
232 for step_process_id in\
233 self.form_data.get_all_int(f'new_step_to_{step_id}'):
234 process.add_step(self.conn, None, step_process_id, step_id)
235 if step_id not in self.form_data.get_all_int('keep_step'):
237 step_process_id = self.form_data.get_int(
238 f'step_{step_id}_process_id')
239 parent_id = self.form_data.get_int_or_none(
240 f'step_{step_id}_parent_id')
241 process.add_step(self.conn, step_id, step_process_id, parent_id)
242 for step_process_id in self.form_data.get_all_int('new_top_step'):
243 process.add_step(self.conn, None, step_process_id, None)
244 process.fix_steps(self.conn)
246 def do_POST_condition(self) -> None:
247 """Update/insert Condition of ?id= and fields defined in postvars."""
248 id_ = self.params.get_int_or_none('id')
249 condition = Condition.by_id(self.conn, id_, create=True)
250 condition.title.set(self.form_data.get_str('title'))
251 condition.description.set(self.form_data.get_str('description'))
252 condition.save(self.conn)
254 def _init_handling(self) -> None:
255 # pylint: disable=attribute-defined-outside-init
256 self.conn = DatabaseConnection(self.server.db)
257 parsed_url = urlparse(self.path)
258 self.site = path_split(parsed_url.path)[1]
259 params = parse_qs(parsed_url.query, strict_parsing=True)
260 self.params = InputsParser(params, False)
262 def _redirect(self, target: str) -> None:
263 self.send_response(302)
264 self.send_header('Location', target)
267 def _send_html(self, html: str, code: int = 200) -> None:
268 """Send HTML as proper HTTP response."""
269 self.send_response(code)
271 self.wfile.write(bytes(html, 'utf-8'))
273 def _send_msg(self, msg: Exception, code: int = 400) -> None:
274 """Send message in HTML formatting as HTTP response."""
275 html = self.server.jinja.get_template('msg.html').render(msg=msg)
276 self._send_html(html, code)