X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fhttp.py;h=7e2b241aec468a8b6c29221b6f146a702b990883;hb=23012cd370777b60a25839788d131173d2abee91;hp=afcaa116173145bb2ab5b2547937d5458d3e2666;hpb=9e32ae00d4435932d55695be4e757ff109c76f26;p=plomtask diff --git a/plomtask/http.py b/plomtask/http.py index afcaa11..7e2b241 100644 --- a/plomtask/http.py +++ b/plomtask/http.py @@ -1,64 +1,308 @@ """Web server stuff.""" +from typing import Any, NamedTuple from http.server import BaseHTTPRequestHandler from http.server import HTTPServer from urllib.parse import urlparse, parse_qs from os.path import split as path_split from jinja2 import Environment as JinjaEnv, FileSystemLoader as JinjaFSLoader -from plomtask.days import Day -from plomtask.misc import HandledException -from plomtask.db import DatabaseConnection +from plomtask.days import Day, todays_date +from plomtask.exceptions import HandledException, BadFormatException, \ + NotFoundException +from plomtask.db import DatabaseConnection, DatabaseFile +from plomtask.processes import Process +from plomtask.conditions import Condition +from plomtask.todos import Todo + +TEMPLATES_DIR = 'templates' class TaskServer(HTTPServer): """Variant of HTTPServer that knows .jinja as Jinja Environment.""" - def __init__(self, templates_dir, db_file, *args, **kwargs): + def __init__(self, db_file: DatabaseFile, + *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) self.db = db_file - self.jinja = JinjaEnv(loader=JinjaFSLoader(templates_dir)) + self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR)) + + +class InputsParser: + """Wrapper for validating and retrieving dict-like HTTP inputs.""" + + def __init__(self, dict_: dict[str, list[str]], + strictness: bool = True) -> None: + self.inputs = dict_ + self.strict = strictness + + def get_str(self, key: str, default: str = '', + ignore_strict: bool = False) -> str: + """Retrieve single/first string value of key, or default.""" + if key not in self.inputs.keys() or 0 == len(self.inputs[key]): + if self.strict and not ignore_strict: + raise BadFormatException(f'no value found for key {key}') + return default + return self.inputs[key][0] + + def get_int(self, key: str) -> int: + """Retrieve single/first value of key as int, error if empty.""" + val = self.get_int_or_none(key) + if val is None: + raise BadFormatException(f'unexpected empty value for: {key}') + return val + + def get_int_or_none(self, key: str) -> int | None: + """Retrieve single/first value of key as int, return None if empty.""" + val = self.get_str(key, ignore_strict=True) + if val == '': + return None + try: + return int(val) + except ValueError as e: + msg = f'cannot int form field value for key {key}: {val}' + raise BadFormatException(msg) from e + + def get_float(self, key: str) -> float: + """Retrieve float value of key from self.postvars.""" + val = self.get_str(key) + try: + return float(val) + except ValueError as e: + msg = f'cannot float form field value for key {key}: {val}' + raise BadFormatException(msg) from e + + def get_all_str(self, key: str) -> list[str]: + """Retrieve list of string values at key.""" + if key not in self.inputs.keys(): + return [] + return self.inputs[key] + + def get_all_int(self, key: str) -> list[int]: + """Retrieve list of int values at key.""" + all_str = self.get_all_str(key) + try: + return [int(s) for s in all_str if len(s) > 0] + except ValueError as e: + msg = f'cannot int a form field value for key {key} in: {all_str}' + raise BadFormatException(msg) from e class TaskHandler(BaseHTTPRequestHandler): """Handles single HTTP request.""" server: TaskServer - def do_GET(self): + def do_GET(self) -> None: """Handle any GET request.""" try: - conn = DatabaseConnection(self.server.db) - parsed_url = urlparse(self.path) - site = path_split(parsed_url.path)[1] - params = parse_qs(parsed_url.query) - if 'calendar' == site: - html = self.do_GET_calendar(conn) - elif 'day' == site: - date = params.get('date', ['2024-01-01'])[0] - html = self.do_GET_day(conn, date) + self._init_handling() + if self.site in {'calendar', 'day', 'process', 'processes', 'todo', + 'condition', 'conditions'}: + template = f'{self.site}.html' + ctx = getattr(self, f'do_GET_{self.site}')() + html = self.server.jinja.get_template(template).render(**ctx) + self._send_html(html) + elif '' == self.site: + self._redirect('/day') else: - raise HandledException('Test!') - conn.commit() - conn.close() - self._send_html(html) + raise NotFoundException(f'Unknown page: /{self.site}') except HandledException as error: - self._send_msg(error) + self._send_msg(error, code=error.http_code) + finally: + self.conn.close() + + def do_GET_calendar(self) -> dict[str, object]: + """Show Days from ?start= to ?end=.""" + start = self.params.get_str('start') + end = self.params.get_str('end') + days = Day.all(self.conn, date_range=(start, end), fill_gaps=True) + return {'start': start, 'end': end, 'days': days} + + def do_GET_day(self) -> dict[str, object]: + """Show single Day of ?date=.""" + + class ConditionListing(NamedTuple): + """Listing of Condition augmented with its enablers, disablers.""" + condition: Condition + enablers: list[Todo] + disablers: list[Todo] - def do_GET_calendar(self, conn: DatabaseConnection): - """Show Days.""" - return self.server.jinja.get_template('calendar.html').render( - days=Day.all(conn)) + date = self.params.get_str('date', todays_date()) + top_todos = [t for t in Todo.by_date(self.conn, date) if not t.parents] + seen_todos: set[int] = set() + seen_conditions: set[int] = set() + todo_trees = [t.get_step_tree(seen_todos, seen_conditions) + for t in top_todos] + condition_listings: list[ConditionListing] = [] + for cond in Condition.all(self.conn): + enablers = Todo.enablers_for_at(self.conn, cond, date) + disablers = Todo.disablers_for_at(self.conn, cond, date) + condition_listings += [ConditionListing(cond, enablers, disablers)] + return {'day': Day.by_id(self.conn, date, create=True), + 'todo_trees': todo_trees, + 'processes': Process.all(self.conn), + 'condition_listings': condition_listings} - def do_GET_day(self, conn: DatabaseConnection, date: str): - """Show single Day.""" - day = Day.by_date(conn, date) - return self.server.jinja.get_template('day.html').render(day=day) + def do_GET_todo(self) -> dict[str, object]: + """Show single Todo of ?id=.""" + id_ = self.params.get_int('id') + todo = Todo.by_id(self.conn, id_) + return {'todo': todo, + 'todo_candidates': Todo.by_date(self.conn, todo.date), + 'condition_candidates': Condition.all(self.conn)} + + def do_GET_conditions(self) -> dict[str, object]: + """Show all Conditions.""" + return {'conditions': Condition.all(self.conn)} + + def do_GET_condition(self) -> dict[str, object]: + """Show Condition of ?id=.""" + id_ = self.params.get_int_or_none('id') + return {'condition': Condition.by_id(self.conn, id_, create=True)} + + def do_GET_process(self) -> dict[str, object]: + """Show process of ?id=.""" + id_ = self.params.get_int_or_none('id') + process = Process.by_id(self.conn, id_, create=True) + return {'process': process, + 'steps': process.get_steps(self.conn), + 'owners': process.used_as_step_by(self.conn), + 'step_candidates': Process.all(self.conn), + 'condition_candidates': Condition.all(self.conn)} + + def do_GET_processes(self) -> dict[str, object]: + """Show all Processes.""" + return {'processes': Process.all(self.conn)} + + def do_POST(self) -> None: + """Handle any POST request.""" + # pylint: disable=attribute-defined-outside-init + try: + self._init_handling() + length = int(self.headers['content-length']) + postvars = parse_qs(self.rfile.read(length).decode(), + keep_blank_values=True, strict_parsing=True) + self.form_data = InputsParser(postvars) + if self.site in ('day', 'process', 'todo', 'condition'): + redir_target = getattr(self, f'do_POST_{self.site}')() + self.conn.commit() + else: + msg = f'Page not known as POST target: /{self.site}' + raise NotFoundException(msg) + self._redirect(redir_target) + except HandledException as error: + self._send_msg(error, code=error.http_code) + finally: + self.conn.close() + + def do_POST_day(self) -> str: + """Update or insert Day of date and Todos mapped to it.""" + date = self.params.get_str('date') + day = Day.by_id(self.conn, date, create=True) + day.comment = self.form_data.get_str('comment') + day.save(self.conn) + existing_todos = Todo.by_date(self.conn, date) + for process_id in self.form_data.get_all_int('new_todo'): + process = Process.by_id(self.conn, process_id) + todo = Todo(None, process, False, day.date) + todo.save(self.conn) + todo.adopt_from(existing_todos) + todo.make_missing_children(self.conn) + todo.save(self.conn) + return f'/day?date={date}' + + def do_POST_todo(self) -> str: + """Update Todo and its children.""" + id_ = self.params.get_int('id') + todo = Todo.by_id(self.conn, id_) + adopted_child_ids = self.form_data.get_all_int('adopt') + for child in todo.children: + if child.id_ not in adopted_child_ids: + assert isinstance(child.id_, int) + child = Todo.by_id(self.conn, child.id_) + todo.remove_child(child) + for child_id in adopted_child_ids: + if child_id in [c.id_ for c in todo.children]: + continue + child = Todo.by_id(self.conn, child_id) + todo.add_child(child) + todo.set_conditions(self.conn, self.form_data.get_all_int('condition')) + todo.set_enables(self.conn, self.form_data.get_all_int('enables')) + todo.set_disables(self.conn, self.form_data.get_all_int('disables')) + todo.is_done = len(self.form_data.get_all_str('done')) > 0 + todo.save(self.conn) + for condition in todo.enables: + condition.save(self.conn) + for condition in todo.disables: + condition.save(self.conn) + return f'/todo?id={todo.id_}' + + def do_POST_process(self) -> str: + """Update or insert Process of ?id= and fields defined in postvars.""" + id_ = self.params.get_int_or_none('id') + for _ in self.form_data.get_all_str('delete'): + process = Process.by_id(self.conn, id_) + process.remove(self.conn) + return '/processes' + process = Process.by_id(self.conn, id_, create=True) + process.title.set(self.form_data.get_str('title')) + process.description.set(self.form_data.get_str('description')) + process.effort.set(self.form_data.get_float('effort')) + process.set_conditions(self.conn, + self.form_data.get_all_int('condition')) + process.set_enables(self.conn, self.form_data.get_all_int('enables')) + process.set_disables(self.conn, self.form_data.get_all_int('disables')) + process.save_core(self.conn) + process.explicit_steps = [] + steps: list[tuple[int | None, int, int | None]] = [] + for step_id in self.form_data.get_all_int('steps'): + for step_process_id in self.form_data.get_all_int( + f'new_step_to_{step_id}'): + steps += [(None, step_process_id, step_id)] + if step_id not in self.form_data.get_all_int('keep_step'): + continue + step_process_id = self.form_data.get_int( + f'step_{step_id}_process_id') + parent_id = self.form_data.get_int_or_none( + f'step_{step_id}_parent_id') + steps += [(step_id, step_process_id, parent_id)] + for step_process_id in self.form_data.get_all_int('new_top_step'): + steps += [(None, step_process_id, None)] + process.set_steps(self.conn, steps) + process.save(self.conn) + return f'/process?id={process.id_}' + + def do_POST_condition(self) -> str: + """Update/insert Condition of ?id= and fields defined in postvars.""" + id_ = self.params.get_int_or_none('id') + for _ in self.form_data.get_all_str('delete'): + condition = Condition.by_id(self.conn, id_) + condition.remove(self.conn) + return '/conditions' + condition = Condition.by_id(self.conn, id_, create=True) + condition.title.set(self.form_data.get_str('title')) + condition.description.set(self.form_data.get_str('description')) + condition.save(self.conn) + return f'/condition?id={condition.id_}' + + def _init_handling(self) -> None: + # pylint: disable=attribute-defined-outside-init + self.conn = DatabaseConnection(self.server.db) + parsed_url = urlparse(self.path) + self.site = path_split(parsed_url.path)[1] + params = parse_qs(parsed_url.query, strict_parsing=True) + self.params = InputsParser(params, False) + + def _redirect(self, target: str) -> None: + self.send_response(302) + self.send_header('Location', target) + self.end_headers() - def _send_html(self, html: str, code: int = 200): + def _send_html(self, html: str, code: int = 200) -> None: """Send HTML as proper HTTP response.""" self.send_response(code) self.end_headers() self.wfile.write(bytes(html, 'utf-8')) - def _send_msg(self, msg: str, code: int = 400): + def _send_msg(self, msg: Exception, code: int = 400) -> None: """Send message in HTML formatting as HTTP response.""" html = self.server.jinja.get_template('msg.html').render(msg=msg) self._send_html(html, code)