"""Web server stuff."""
+from typing import Any
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.todos import Todo
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 ParamsParser:
+ """Wrapper for validating and retrieving GET params."""
+
+ def __init__(self, params: dict[str, list[str]]) -> None:
+ self.params = params
+
+ def get_str(self, key: str, default: str = '') -> str:
+ """Retrieve string value of key from self.params."""
+ if key not in self.params or 0 == len(self.params[key]):
+ return default
+ return self.params[key][0]
+
+ def get_int_or_none(self, key: str) -> int | None:
+ """Retrieve int value of key from self.params, on empty return None."""
+ if key not in self.params or \
+ 0 == len(''.join(list(self.params[key]))):
+ return None
+ val_str = self.params[key][0]
+ try:
+ return int(val_str)
+ except ValueError as e:
+ raise BadFormatException(f'Bad ?{key}= value: {val_str}') from e
+
+
+class PostvarsParser:
+ """Postvars wrapper for validating and retrieving form data."""
+
+ def __init__(self, postvars: dict[str, list[str]]) -> None:
+ self.postvars = postvars
+
+ def get_str(self, key: str) -> str:
+ """Retrieve string value of key from self.postvars."""
+ all_str = self.get_all_str(key)
+ if 0 == len(all_str):
+ raise BadFormatException(f'missing value for key: {key}')
+ return all_str[0]
+
+ def get_int(self, key: str) -> int:
+ """Retrieve int value of key from self.postvars."""
+ val = self.get_str(key)
+ try:
+ return int(val)
+ except ValueError as e:
+ msg = f'cannot int form field value: {val}'
+ raise BadFormatException(msg) from e
+
+ def get_int_or_none(self, key: str) -> int | None:
+ """Retrieve int value of key from self.postvars, or None."""
+ if key not in self.postvars or \
+ 0 == len(''.join(list(self.postvars[key]))):
+ return None
+ return self.get_int(key)
+
+ 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: {val}'
+ raise BadFormatException(msg) from e
+
+ def get_all_str(self, key: str) -> list[str]:
+ """Retrieve list of string values at key from self.postvars."""
+ if key not in self.postvars:
+ return []
+ return self.postvars[key]
+
+ def get_all_int(self, key: str) -> list[int]:
+ """Retrieve list of int values at key from self.postvars."""
+ 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: {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:
- html = self.do_GET_calendar(conn)
- elif 'day' == site:
- date = params.get('date', ['2024-01-01'])[0]
- html = self.do_GET_day(conn, date)
+ if site in {'calendar', 'day', 'process', 'processes', 'todo'}:
+ html = getattr(self, f'do_GET_{site}')(conn, params)
+ elif '' == site:
+ self._redirect('/day')
+ return
else:
- raise HandledException('Test!')
- conn.commit()
- conn.close()
+ raise NotFoundException(f'Unknown page: /{site}')
self._send_html(html)
except HandledException as error:
- self._send_msg(error)
+ self._send_msg(error, code=error.http_code)
+ finally:
+ conn.close()
- def do_GET_calendar(self, conn: DatabaseConnection):
- """Show Days."""
+ def do_GET_calendar(self, conn: DatabaseConnection,
+ params: ParamsParser) -> str:
+ """Show Days from ?start= to ?end=."""
+ start = params.get_str('start')
+ end = params.get_str('end')
+ days = Day.all(conn, date_range=(start, end), fill_gaps=True)
return self.server.jinja.get_template('calendar.html').render(
- days=Day.all(conn))
+ days=days, start=start, end=end)
- def do_GET_day(self, conn: DatabaseConnection, date: str):
- """Show single Day."""
+ def do_GET_day(self, conn: DatabaseConnection,
+ params: ParamsParser) -> str:
+ """Show single Day of ?date=."""
+ date = params.get_str('date', todays_date())
day = Day.by_date(conn, date, create=True)
- return self.server.jinja.get_template('day.html').render(day=day)
+ todos = Todo.by_date(conn, date)
+ return self.server.jinja.get_template('day.html').render(
+ day=day, processes=Process.all(conn), todos=todos)
+
+ def do_GET_todo(self, conn: DatabaseConnection, params:
+ ParamsParser) -> str:
+ """Show single Todo of ?id=."""
+ id_ = params.get_int_or_none('id')
+ todo = Todo.by_id(conn, id_)
+ candidates = Todo.by_date(conn, todo.day.date)
+ return self.server.jinja.get_template('todo.html').render(
+ todo=todo, candidates=candidates)
- def do_POST(self):
+ def do_GET_process(self, conn: DatabaseConnection,
+ params: ParamsParser) -> str:
+ """Show process of ?id=."""
+ id_ = params.get_int_or_none('id')
+ process = Process.by_id(conn, id_, create=True)
+ owners = process.used_as_step_by(conn)
+ return self.server.jinja.get_template('process.html').render(
+ process=process, steps=process.get_steps(conn),
+ owners=owners, candidates=Process.all(conn))
+
+ def do_GET_processes(self, conn: DatabaseConnection,
+ _: ParamsParser) -> str:
+ """Show all Processes."""
+ return self.server.jinja.get_template('processes.html').render(
+ processes=Process.all(conn))
+
+ def do_POST(self) -> None:
"""Handle any POST request."""
try:
conn, site, params = 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', ['2024-01-01'])[0]
- self.do_POST_day(conn, date, postvars)
- conn.commit()
- conn.close()
+ keep_blank_values=True, strict_parsing=True)
+ form_data = PostvarsParser(postvars)
+ if site in ('day', 'process', 'todo'):
+ getattr(self, f'do_POST_{site}')(conn, params, form_data)
+ conn.commit()
+ else:
+ msg = f'Page not known as POST target: /{site}'
+ raise NotFoundException(msg)
self._redirect('/')
except HandledException as error:
- self._send_msg(error)
+ self._send_msg(error, code=error.http_code)
+ finally:
+ conn.close()
- def do_POST_day(self, conn: DatabaseConnection, date: str, postvars: dict):
- """Update or insert Day of date and fields defined in postvars."""
- comment = postvars['comment'][0]
+ def do_POST_day(self, conn: DatabaseConnection, params: ParamsParser,
+ form_data: PostvarsParser) -> None:
+ """Update or insert Day of date and Todos mapped to it."""
+ date = params.get_str('date')
day = Day.by_date(conn, date, create=True)
- day.comment = comment
+ day.comment = form_data.get_str('comment')
day.save(conn)
+ process_id = form_data.get_int_or_none('new_todo')
+ if process_id is not None:
+ process = Process.by_id(conn, process_id)
+ todo = Todo(None, process, False, day)
+ todo.save(conn)
+
+ def do_POST_todo(self, conn: DatabaseConnection, params: ParamsParser,
+ form_data: PostvarsParser) -> None:
+ """Update Todo and its children."""
+ id_ = params.get_int_or_none('id')
+ todo = Todo.by_id(conn, id_)
+ child_id = form_data.get_int_or_none('adopt')
+ if child_id is not None:
+ child = Todo.by_id(conn, child_id)
+ todo.add_child(child)
+ if len(form_data.get_all_str('done')) > 0:
+ if not todo.is_doable:
+ raise BadFormatException('cannot set undoable Todo to done')
+ todo.is_done = True
+ else:
+ todo.is_done = False
+ todo.save(conn)
+
+ def do_POST_process(self, conn: DatabaseConnection, params: ParamsParser,
+ form_data: PostvarsParser) -> None:
+ """Update or insert Process of ?id= and fields defined in postvars."""
+ id_ = params.get_int_or_none('id')
+ process = Process.by_id(conn, id_, create=True)
+ process.title.set(form_data.get_str('title'))
+ process.description.set(form_data.get_str('description'))
+ process.effort.set(form_data.get_float('effort'))
+ process.save_without_steps(conn)
+ assert process.id_ is not None # for mypy
+ process.explicit_steps = []
+ for step_id in form_data.get_all_int('steps'):
+ for step_process_id in\
+ form_data.get_all_int(f'new_step_to_{step_id}'):
+ process.add_step(conn, None, step_process_id, step_id)
+ if step_id not in form_data.get_all_int('keep_step'):
+ continue
+ step_process_id = form_data.get_int(f'step_{step_id}_process_id')
+ parent_id = form_data.get_int_or_none(f'step_{step_id}_parent_id')
+ process.add_step(conn, step_id, step_process_id, parent_id)
+ for step_process_id in form_data.get_all_int('new_top_step'):
+ process.add_step(conn, None, step_process_id, None)
+ process.fix_steps(conn)
- def _init_handling(self):
+ def _init_handling(self) -> tuple[DatabaseConnection, str, ParamsParser]:
conn = DatabaseConnection(self.server.db)
parsed_url = urlparse(self.path)
site = path_split(parsed_url.path)[1]
- params = parse_qs(parsed_url.query)
+ params = ParamsParser(parse_qs(parsed_url.query, strict_parsing=True))
return conn, site, params
- 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)