X-Git-Url: https://plomlompom.com/repos/todo?a=blobdiff_plain;f=plomtask%2Fhttp.py;h=18b77a6f0a97ccea4718261f69e23be7ab9d3866;hb=244270eed71df45faf9554d0666b816be9876f77;hp=583203e6eba7a69bbee893d502b13bd132eb69d9;hpb=493840d522103c4d6e0b02785d55f8e62d38ed78;p=plomtask diff --git a/plomtask/http.py b/plomtask/http.py index 583203e..18b77a6 100644 --- a/plomtask/http.py +++ b/plomtask/http.py @@ -1,17 +1,18 @@ """Web server stuff.""" from __future__ import annotations from dataclasses import dataclass -from typing import Any +from typing import Any, Callable from base64 import b64encode, b64decode from http.server import BaseHTTPRequestHandler from http.server import HTTPServer from urllib.parse import urlparse, parse_qs +from json import dumps as json_dumps from os.path import split as path_split from jinja2 import Environment as JinjaEnv, FileSystemLoader as JinjaFSLoader from plomtask.dating import date_in_n_days from plomtask.days import Day -from plomtask.exceptions import HandledException, BadFormatException, \ - NotFoundException +from plomtask.exceptions import (HandledException, BadFormatException, + NotFoundException) from plomtask.db import DatabaseConnection, DatabaseFile from plomtask.processes import Process, ProcessStep, ProcessStepsNode from plomtask.conditions import Condition @@ -20,16 +21,6 @@ from plomtask.todos import Todo TEMPLATES_DIR = 'templates' -@dataclass -class TodoStepsNode: - """Collect what's useful for Todo steps tree display.""" - id_: int - todo: Todo | None - process: Process | None - children: list[TodoStepsNode] - fillable: bool = False - - class TaskServer(HTTPServer): """Variant of HTTPServer that knows .jinja as Jinja Environment.""" @@ -37,7 +28,47 @@ class TaskServer(HTTPServer): *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) self.db = db_file - self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR)) + self.headers: list[tuple[str, str]] = [] + self._render_mode = 'html' + self._jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR)) + + def set_json_mode(self) -> None: + """Make server send JSON instead of HTML responses.""" + self._render_mode = 'json' + self.headers += [('Content-Type', 'application/json')] + + @staticmethod + def ctx_to_json(ctx: dict[str, object]) -> str: + """Render ctx into JSON string.""" + def walk_ctx(node: object) -> Any: + if hasattr(node, 'as_dict_into_reference'): + if hasattr(node, 'id_') and node.id_ is not None: + return node.as_dict_into_reference(library) + if hasattr(node, 'as_dict'): + return node.as_dict + if isinstance(node, (list, tuple)): + return [walk_ctx(x) for x in node] + if isinstance(node, dict): + d = {} + for k, v in node.items(): + d[k] = walk_ctx(v) + return d + if isinstance(node, HandledException): + return str(node) + return node + library: dict[str, dict[str | int, object]] = {} + for k, v in ctx.items(): + ctx[k] = walk_ctx(v) + ctx['_library'] = library + return json_dumps(ctx) + + def render(self, ctx: dict[str, object], tmpl_name: str = '') -> str: + """Render ctx according to self._render_mode..""" + tmpl_name = f'{tmpl_name}.{self._render_mode}' + if 'html' == self._render_mode: + template = self._jinja.get_template(tmpl_name) + return template.render(ctx) + return self.__class__.ctx_to_json(ctx) class InputsParser: @@ -116,26 +147,91 @@ class TaskHandler(BaseHTTPRequestHandler): _form_data: InputsParser _params: InputsParser - def do_GET(self) -> None: - """Handle any GET request.""" - try: - 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 NotFoundException(f'Unknown page: /{self._site}') - except HandledException as error: - self._send_msg(error, code=error.http_code) - finally: - self.conn.close() + def _send_page(self, + ctx: dict[str, Any], + tmpl_name: str, + code: int = 200 + ) -> None: + """Send ctx as proper HTTP response.""" + body = self.server.render(ctx, tmpl_name) + self.send_response(code) + for header_tuple in self.server.headers: + self.send_header(*header_tuple) + self.end_headers() + self.wfile.write(bytes(body, 'utf-8')) + + @staticmethod + def _request_wrapper(http_method: str, not_found_msg: str + ) -> Callable[..., Callable[[TaskHandler], None]]: + def decorator(f: Callable[..., str | None] + ) -> Callable[[TaskHandler], None]: + def wrapper(self: TaskHandler) -> None: + # pylint: disable=protected-access + # (because pylint here fails to detect the use of wrapper as a + # method to self with respective access privileges) + try: + 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) + handler_name = f'do_{http_method}_{self._site}' + if hasattr(self, handler_name): + handler = getattr(self, handler_name) + redir_target = f(self, handler) + if redir_target: + self.send_response(302) + self.send_header('Location', redir_target) + self.end_headers() + else: + msg = f'{not_found_msg}: {self._site}' + raise NotFoundException(msg) + except HandledException as error: + for cls in (Day, Todo, Condition, Process, ProcessStep): + assert hasattr(cls, 'empty_cache') + cls.empty_cache() + ctx = {'msg': error} + self._send_page(ctx, 'msg', error.http_code) + finally: + self.conn.close() + return wrapper + return decorator + + @_request_wrapper('GET', 'Unknown page') + def do_GET(self, handler: Callable[[], str | dict[str, object]] + ) -> str | None: + """Render page with result of handler, or redirect if result is str.""" + tmpl_name = f'{self._site}' + ctx_or_redir_target = handler() + if isinstance(ctx_or_redir_target, str): + return ctx_or_redir_target + self._send_page(ctx_or_redir_target, tmpl_name) + return None + + @_request_wrapper('POST', 'Unknown POST target') + def do_POST(self, handler: Callable[[], str]) -> str: + """Handle POST with handler, prepare redirection to result.""" + 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) + redir_target = handler() + self.conn.commit() + return redir_target + + # GET handlers + + def do_GET_(self) -> str: + """Return redirect target on GET /.""" + return '/day' def _do_GET_calendar(self) -> dict[str, object]: - """Show Days from ?start= to ?end=.""" + """Show Days from ?start= to ?end=. + + Both .do_GET_calendar and .do_GET_calendar_txt refer to this to do the + same, the only difference being the HTML template they are rendered to, + which .do_GET selects from their method name. + """ start = self._params.get_str('start') end = self._params.get_str('end') if not end: @@ -143,8 +239,6 @@ class TaskHandler(BaseHTTPRequestHandler): 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} @@ -159,15 +253,12 @@ class TaskHandler(BaseHTTPRequestHandler): def do_GET_day(self) -> dict[str, object]: """Show single Day of ?date=.""" date = self._params.get_str('date', date_in_n_days(0)) + day = Day.by_id_or_create(self.conn, date) make_type = self._params.get_str('make_type') - todays_todos = Todo.by_date(self.conn, date) - total_effort = 0.0 - for todo in todays_todos: - total_effort += todo.performed_effort conditions_present = [] enablers_for = {} disablers_for = {} - for todo in todays_todos: + for todo in day.todos: for condition in todo.conditions + todo.blockers: if condition not in conditions_present: conditions_present += [condition] @@ -179,9 +270,8 @@ class TaskHandler(BaseHTTPRequestHandler): 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), - 'total_effort': total_effort, + for t in day.todos if not t.parents] + return {'day': day, 'top_nodes': top_nodes, 'make_type': make_type, 'enablers_for': enablers_for, @@ -192,6 +282,15 @@ class TaskHandler(BaseHTTPRequestHandler): def do_GET_todo(self) -> dict[str, object]: """Show single Todo of ?id=.""" + @dataclass + class TodoStepsNode: + """Collect what's useful for Todo steps tree display.""" + id_: int + todo: Todo | None + process: Process | None + children: list[TodoStepsNode] # pylint: disable=undefined-variable + fillable: bool = False + def walk_process_steps(id_: int, process_step_nodes: list[ProcessStepsNode], steps_nodes: list[TodoStepsNode]) -> None: @@ -245,7 +344,8 @@ class TaskHandler(BaseHTTPRequestHandler): adoptables: dict[int, list[Todo]] = {} any_adoptables = [Todo.by_id(self.conn, t.id_) for t in Todo.by_date(self.conn, todo.date) - if t != todo] + if t.id_ is not None + and t != todo] for id_ in collect_adoptables_keys(steps_todo_to_process): adoptables[id_] = [t for t in any_adoptables if t.process.id_ == id_] @@ -284,6 +384,7 @@ class TaskHandler(BaseHTTPRequestHandler): todos.sort(key=lambda t: t.date, reverse=True) else: todos.sort(key=lambda t: t.date) + sort_by = 'title' 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} @@ -301,6 +402,7 @@ class TaskHandler(BaseHTTPRequestHandler): conditions.sort(key=lambda c: c.title.newest, reverse=True) else: conditions.sort(key=lambda c: c.title.newest) + sort_by = 'title' return {'conditions': conditions, 'sort_by': sort_by, 'pattern': pattern} @@ -308,7 +410,7 @@ class TaskHandler(BaseHTTPRequestHandler): 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) + c = Condition.by_id_or_create(self.conn, id_) 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], @@ -318,20 +420,20 @@ class TaskHandler(BaseHTTPRequestHandler): def do_GET_condition_titles(self) -> dict[str, object]: """Show title history of Condition of ?id=.""" - id_ = self._params.get_int_or_none('id') + id_ = self._params.get_int('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') + id_ = self._params.get_int('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) + process = Process.by_id_or_create(self.conn, id_) title_64 = self._params.get_str('title_b64') if title_64: title = b64decode(title_64.encode()).decode() @@ -351,19 +453,19 @@ class TaskHandler(BaseHTTPRequestHandler): def do_GET_process_titles(self) -> dict[str, object]: """Show title history of Process of ?id=.""" - id_ = self._params.get_int_or_none('id') + id_ = self._params.get_int('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') + id_ = self._params.get_int('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') + id_ = self._params.get_int('id') process = Process.by_id(self.conn, id_) return {'process': process} @@ -388,32 +490,53 @@ class TaskHandler(BaseHTTPRequestHandler): processes.sort(key=lambda p: p.title.newest, reverse=True) else: processes.sort(key=lambda p: p.title.newest) + sort_by = 'title' return {'processes': processes, 'sort_by': sort_by, 'pattern': pattern} - def do_POST(self) -> None: - """Handle any POST request.""" - 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 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, code=error.http_code) - finally: - self.conn.close() + # POST handlers + + @staticmethod + def _delete_or_post(target_class: Any, redir_target: str = '/' + ) -> Callable[..., Callable[[TaskHandler], str]]: + def decorator(f: Callable[..., str] + ) -> Callable[[TaskHandler], str]: + def wrapper(self: TaskHandler) -> str: + # pylint: disable=protected-access + # (because pylint here fails to detect the use of wrapper as a + # method to self with respective access privileges) + id_ = self._params.get_int_or_none('id') + for _ in self._form_data.get_all_str('delete'): + if id_ is None: + msg = 'trying to delete non-saved ' +\ + f'{target_class.__name__}' + raise NotFoundException(msg) + item = target_class.by_id(self.conn, id_) + item.remove(self.conn) + return redir_target + if target_class.can_create_by_id: + item = target_class.by_id_or_create(self.conn, id_) + else: + item = target_class.by_id(self.conn, id_) + return f(self, item) + return wrapper + return decorator + + def _change_versioned_timestamps(self, cls: Any, attr_name: str) -> str: + """Update history timestamps for VersionedAttribute.""" + id_ = self._params.get_int_or_none('id') + item = cls.by_id(self.conn, id_) + attr = getattr(item, attr_name) + for k, v in self._form_data.get_first_strings_starting('at:').items(): + old = k[3:] + if old[19:] != v: + attr.reset_timestamp(old, f'{v}.0') + attr.save(self.conn) + return f'/{cls.name_lowercase()}_{attr_name}s?id={item.id_}' 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 = Day.by_id_or_create(self.conn, date) day.comment = self._form_data.get_str('day_comment') day.save(self.conn) make_type = self._form_data.get_str('make_type') @@ -435,22 +558,11 @@ class TaskHandler(BaseHTTPRequestHandler): 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}&make_type={make_type}' - def do_POST_todo(self) -> str: + @_delete_or_post(Todo, '/') + def do_POST_todo(self, todo: Todo) -> str: """Update Todo and its children.""" - # pylint: disable=too-many-locals - # pylint: disable=too-many-branches - 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') processes_to_make_full = self._form_data.get_all_int('make_full') processes_to_make_empty = self._form_data.get_all_int('make_empty') @@ -486,60 +598,38 @@ class TaskHandler(BaseHTTPRequestHandler): 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')) + self._form_data.get_all_int('conditions')) + todo.set_blockers(self.conn, self._form_data.get_all_int('blockers')) 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_versioned_timestamps(self, cls: Any, attr_name: str) -> str: - """Update history timestamps for VersionedAttribute.""" - id_ = self._params.get_int_or_none('id') - item = cls.by_id(self.conn, id_) - attr = getattr(item, attr_name) - for k, v in self._form_data.get_first_strings_starting('at:').items(): - old = k[3:] - if old[19:] != v: - attr.reset_timestamp(old, f'{v}.0') - attr.save(self.conn) - cls_name = cls.__name__.lower() - return f'/{cls_name}_{attr_name}s?id={item.id_}' - def do_POST_process_descriptions(self) -> str: """Update history timestamps for Process.description.""" - return self._do_POST_versioned_timestamps(Process, 'description') + return self._change_versioned_timestamps(Process, 'description') def do_POST_process_efforts(self) -> str: """Update history timestamps for Process.effort.""" - return self._do_POST_versioned_timestamps(Process, 'effort') + return self._change_versioned_timestamps(Process, 'effort') def do_POST_process_titles(self) -> str: """Update history timestamps for Process.title.""" - return self._do_POST_versioned_timestamps(Process, 'title') + return self._change_versioned_timestamps(Process, 'title') - def do_POST_process(self) -> str: + @_delete_or_post(Process, '/processes') + def do_POST_process(self, process: Process) -> 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')) + self._form_data.get_all_int('conditions')) + process.set_blockers(self.conn, + self._form_data.get_all_int('blockers')) process.set_enables(self.conn, self._form_data.get_all_int('enables')) process.set_disables(self.conn, self._form_data.get_all_int('disables')) @@ -572,12 +662,10 @@ class TaskHandler(BaseHTTPRequestHandler): 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'): @@ -593,51 +681,22 @@ class TaskHandler(BaseHTTPRequestHandler): elif new_owner_title: title_b64_encoded = b64encode(new_owner_title.encode()).decode() params = f'has_step={process.id_}&title_b64={title_b64_encoded}' + process.save(self.conn) return f'/process?{params}' def do_POST_condition_descriptions(self) -> str: """Update history timestamps for Condition.description.""" - return self._do_POST_versioned_timestamps(Condition, 'description') + return self._change_versioned_timestamps(Condition, 'description') def do_POST_condition_titles(self) -> str: """Update history timestamps for Condition.title.""" - return self._do_POST_versioned_timestamps(Condition, 'title') + return self._change_versioned_timestamps(Condition, 'title') - def do_POST_condition(self) -> str: + @_delete_or_post(Condition, '/conditions') + def do_POST_condition(self, condition: Condition) -> 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.is_active = self._form_data.get_str('is_active') == '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: - """Our own __init__, as we're not supposed to use the original.""" - 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: - """Redirect to target.""" - self.send_response(302) - self.send_header('Location', target) - self.end_headers() - - 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: 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)