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