X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=plomtask%2Fhttp.py;h=2b630a22376edf6f0a51c10a2de6a4fe4ae20ff6;hb=30aef71506f7d6215b04cddaba8fddba1788f883;hp=e812471a9c8eb5bd0d0dccb6df1f5546ee16a20d;hpb=5a1e4ec7d9671dd9aa40d05e2af0d7ab25ea8911;p=plomtask diff --git a/plomtask/http.py b/plomtask/http.py index e812471..2b630a2 100644 --- a/plomtask/http.py +++ b/plomtask/http.py @@ -1,12 +1,19 @@ """Web server stuff.""" +from typing import Any +from base64 import b64encode, b64decode 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, todays_date -from plomtask.misc import HandledException -from plomtask.db import DatabaseConnection +from plomtask.dating import date_in_n_days +from plomtask.days import Day +from plomtask.exceptions import HandledException, BadFormatException, \ + NotFoundException +from plomtask.db import DatabaseConnection, DatabaseFile +from plomtask.processes import Process, ProcessStep +from plomtask.conditions import Condition +from plomtask.todos import Todo TEMPLATES_DIR = 'templates' @@ -14,87 +21,458 @@ TEMPLATES_DIR = 'templates' class TaskServer(HTTPServer): """Variant of HTTPServer that knows .jinja as Jinja Environment.""" - def __init__(self, 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)) +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, site, params = self._init_handling() - if 'calendar' == site: - start = params.get('start', [''])[0] - end = params.get('end', [''])[0] - html = self.do_GET_calendar(conn, start, end) - elif 'day' == site: - date = params.get('date', [todays_date()])[0] - html = self.do_GET_day(conn, date) + self._init_handling() + if hasattr(self, f'do_GET_{self.site}'): + 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') + if not end: + end = date_in_n_days(60) + ret = Day.by_date_range_with_limits(self.conn, (start, end), 'id') + days, start, end = ret + days = Day.with_filled_gaps(days, start, end) + for day in days: + day.collect_calendarized_todos(self.conn) + today = date_in_n_days(0) + return {'start': start, 'end': end, 'days': days, 'today': today} + + def do_GET_day(self) -> dict[str, object]: + """Show single Day of ?date=.""" + date = self.params.get_str('date', date_in_n_days(0)) + todays_todos = Todo.by_date(self.conn, date) + conditions_present = [] + enablers_for = {} + disablers_for = {} + for todo in todays_todos: + for condition in todo.conditions + todo.blockers: + if condition not in conditions_present: + conditions_present += [condition] + enablers_for[condition.id_] = [p for p in + Process.all(self.conn) + if condition in p.enables] + disablers_for[condition.id_] = [p for p in + Process.all(self.conn) + if condition in p.disables] + seen_todos: set[int] = set() + top_nodes = [t.get_step_tree(seen_todos) + for t in todays_todos if not t.parents] + return {'day': Day.by_id(self.conn, date, create=True), + 'top_nodes': top_nodes, + 'enablers_for': enablers_for, + 'disablers_for': disablers_for, + 'conditions_present': conditions_present, + 'processes': Process.all(self.conn)} - def do_GET_calendar(self, conn: DatabaseConnection, start: str, end: str): - """Show Days.""" - return self.server.jinja.get_template('calendar.html').render( - days=Day.all(conn, date_range=(start, end)), - start=start, end=end) + 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_day(self, conn: DatabaseConnection, date: str): - """Show single Day.""" - day = Day.by_date(conn, date, create=True) - return self.server.jinja.get_template('day.html').render(day=day) + def do_GET_todos(self) -> dict[str, object]: + """Show Todos from ?start= to ?end=, of ?process=, ?comment= pattern""" + sort_by = self.params.get_str('sort_by') + start = self.params.get_str('start') + end = self.params.get_str('end') + process_id = self.params.get_int_or_none('process_id') + comment_pattern = self.params.get_str('comment_pattern') + todos = [] + ret = Todo.by_date_range_with_limits(self.conn, (start, end)) + todos_by_date_range, start, end = ret + todos = [t for t in todos_by_date_range + if comment_pattern in t.comment + and ((not process_id) or t.process.id_ == process_id)] + if sort_by == 'doneness': + todos.sort(key=lambda t: t.is_done) + elif sort_by == '-doneness': + todos.sort(key=lambda t: t.is_done, reverse=True) + elif sort_by == 'title': + todos.sort(key=lambda t: t.title_then) + elif sort_by == '-title': + todos.sort(key=lambda t: t.title_then, reverse=True) + elif sort_by == 'comment': + todos.sort(key=lambda t: t.comment) + elif sort_by == '-comment': + todos.sort(key=lambda t: t.comment, reverse=True) + elif sort_by == '-date': + todos.sort(key=lambda t: t.date, reverse=True) + else: + todos.sort(key=lambda t: t.date) + return {'start': start, 'end': end, 'process_id': process_id, + 'comment_pattern': comment_pattern, 'todos': todos, + 'all_processes': Process.all(self.conn), 'sort_by': sort_by} - def do_POST(self): + def do_GET_conditions(self) -> dict[str, object]: + """Show all Conditions.""" + pattern = self.params.get_str('pattern') + conditions = Condition.matching(self.conn, pattern) + sort_by = self.params.get_str('sort_by') + if sort_by == 'is_active': + conditions.sort(key=lambda c: c.is_active) + elif sort_by == '-is_active': + conditions.sort(key=lambda c: c.is_active, reverse=True) + elif sort_by == '-title': + conditions.sort(key=lambda c: c.title.newest, reverse=True) + else: + conditions.sort(key=lambda c: c.title.newest) + return {'conditions': conditions, + 'sort_by': sort_by, + 'pattern': pattern} + + def do_GET_condition(self) -> dict[str, object]: + """Show Condition of ?id=.""" + id_ = self.params.get_int_or_none('id') + c = Condition.by_id(self.conn, id_, create=True) + ps = Process.all(self.conn) + return {'condition': c, 'is_new': c.id_ is None, + 'enabled_processes': [p for p in ps if c in p.conditions], + 'disabled_processes': [p for p in ps if c in p.blockers], + 'enabling_processes': [p for p in ps if c in p.enables], + 'disabling_processes': [p for p in ps if c in p.disables]} + + def do_GET_condition_titles(self) -> dict[str, object]: + """Show title history of Condition of ?id=.""" + id_ = self.params.get_int_or_none('id') + condition = Condition.by_id(self.conn, id_) + return {'condition': condition} + + def do_GET_condition_descriptions(self) -> dict[str, object]: + """Show description historys of Condition of ?id=.""" + id_ = self.params.get_int_or_none('id') + condition = Condition.by_id(self.conn, id_) + return {'condition': condition} + + 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) + title_64 = self.params.get_str('title_b64') + if title_64: + title = b64decode(title_64.encode()).decode() + process.title.set(title) + owners = process.used_as_step_by(self.conn) + for step_id in self.params.get_all_int('step_to'): + owners += [Process.by_id(self.conn, step_id)] + preset_top_step = None + for process_id in self.params.get_all_int('has_step'): + preset_top_step = process_id + return {'process': process, 'is_new': process.id_ is None, + 'preset_top_step': preset_top_step, + 'steps': process.get_steps(self.conn), 'owners': owners, + 'n_todos': len(Todo.by_process_id(self.conn, process.id_)), + 'process_candidates': Process.all(self.conn), + 'condition_candidates': Condition.all(self.conn)} + + def do_GET_process_titles(self) -> dict[str, object]: + """Show title history of Process of ?id=.""" + id_ = self.params.get_int_or_none('id') + process = Process.by_id(self.conn, id_) + return {'process': process} + + def do_GET_process_descriptions(self) -> dict[str, object]: + """Show description historys of Process of ?id=.""" + id_ = self.params.get_int_or_none('id') + process = Process.by_id(self.conn, id_) + return {'process': process} + + def do_GET_process_efforts(self) -> dict[str, object]: + """Show default effort history of Process of ?id=.""" + id_ = self.params.get_int_or_none('id') + process = Process.by_id(self.conn, id_) + return {'process': process} + + def do_GET_processes(self) -> dict[str, object]: + """Show all Processes.""" + pattern = self.params.get_str('pattern') + processes = Process.matching(self.conn, pattern) + sort_by = self.params.get_str('sort_by') + if sort_by == 'steps': + processes.sort(key=lambda p: len(p.explicit_steps)) + elif sort_by == '-steps': + processes.sort(key=lambda p: len(p.explicit_steps), reverse=True) + elif sort_by == 'effort': + processes.sort(key=lambda p: p.effort.newest) + elif sort_by == '-effort': + processes.sort(key=lambda p: p.effort.newest, reverse=True) + elif sort_by == '-title': + processes.sort(key=lambda p: p.title.newest, reverse=True) + else: + processes.sort(key=lambda p: p.title.newest) + return {'processes': processes, 'sort_by': sort_by, 'pattern': pattern} + + def do_POST(self) -> None: """Handle any POST request.""" + # pylint: disable=attribute-defined-outside-init try: - conn, site, params = self._init_handling() + self._init_handling() length = int(self.headers['content-length']) postvars = parse_qs(self.rfile.read(length).decode(), - keep_blank_values=1) - if 'day' == site: - date = params.get('date', [None])[0] - self.do_POST_day(conn, date, postvars) - conn.commit() - conn.close() - self._redirect('/') + keep_blank_values=True, strict_parsing=True) + self.form_data = InputsParser(postvars) + if hasattr(self, f'do_POST_{self.site}'): + 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) + 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('day_comment') + day.save(self.conn) + for process_id in sorted(self.form_data.get_all_int('new_todo')): + Todo.create_with_children(self.conn, process_id, date) + done_ids = self.form_data.get_all_int('done') + comments = self.form_data.get_all_str('comment') + efforts = self.form_data.get_all_str('effort') + for i, todo_id in enumerate(self.form_data.get_all_int('todo_id')): + todo = Todo.by_id(self.conn, todo_id) + todo.is_done = todo_id in done_ids + if len(comments) > 0: + todo.comment = comments[i] + if len(efforts) > 0: + todo.effort = float(efforts[i]) if efforts[i] else None + todo.save(self.conn) + for condition in todo.enables: + condition.save(self.conn) + for condition in todo.disables: + condition.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') + for _ in self.form_data.get_all_str('delete'): + todo = Todo .by_id(self.conn, id_) + todo.remove(self.conn) + return '/' + 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) + effort = self.form_data.get_str('effort', ignore_strict=True) + todo.effort = float(effort) if effort else None + todo.set_conditions(self.conn, self.form_data.get_all_int('condition')) + todo.set_blockers(self.conn, self.form_data.get_all_int('blocker')) + 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.calendarize = len(self.form_data.get_all_str('calendarize')) > 0 + todo.comment = self.form_data.get_str('comment', ignore_strict=True) + 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.""" + # pylint: disable=too-many-branches + 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_blockers(self.conn, self.form_data.get_all_int('blocker')) + 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.calendarize = self.form_data.get_all_str('calendarize') != [] + process.save(self.conn) + assert isinstance(process.id_, int) + steps: list[ProcessStep] = [] + for step_id in self.form_data.get_all_int('keep_step'): + if step_id not in self.form_data.get_all_int('steps'): + raise BadFormatException('trying to keep unknown step') + for step_id in self.form_data.get_all_int('steps'): + 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 += [ProcessStep(step_id, process.id_, step_process_id, + parent_id)] + 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 += [ProcessStep(None, process.id_, step_process_id, + step_id)] + new_step_title = None + for step_identifier in self.form_data.get_all_str('new_top_step'): + try: + step_process_id = int(step_identifier) + steps += [ProcessStep(None, process.id_, step_process_id, + None)] + except ValueError: + new_step_title = step_identifier + process.uncache() + process.set_steps(self.conn, steps) + process.set_step_suppressions(self.conn, + self.form_data.get_all_int('suppresses')) + process.save(self.conn) + owners_to_set = [] + new_owner_title = None + for owner_identifier in self.form_data.get_all_str('step_of'): + try: + owners_to_set += [int(owner_identifier)] + except ValueError: + new_owner_title = owner_identifier + process.set_owners(self.conn, owners_to_set) + params = f'id={process.id_}' + if new_step_title: + title_b64_encoded = b64encode(new_step_title.encode()).decode() + params = f'step_to={process.id_}&title_b64={title_b64_encoded}' + elif new_owner_title: + title_b64_encoded = b64encode(new_owner_title.encode()).decode() + params = f'has_step={process.id_}&title_b64={title_b64_encoded}' + return f'/process?{params}' - def do_POST_day(self, conn: DatabaseConnection, date: str, postvars: dict): - """Update or insert Day of date and fields defined in postvars.""" - day = Day.by_date(conn, date, create=True) - day.comment = postvars['comment'][0] - day.save(conn) + 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.is_active = self.form_data.get_all_str('is_active') != [] + 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): - conn = DatabaseConnection(self.server.db) + def _init_handling(self) -> None: + # pylint: disable=attribute-defined-outside-init + self.conn = DatabaseConnection(self.server.db) parsed_url = urlparse(self.path) - site = path_split(parsed_url.path)[1] - params = parse_qs(parsed_url.query) - return conn, site, params + 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): + 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)