1 """Web server stuff."""
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, \
11 from plomtask.db import DatabaseConnection, DatabaseFile
12 from plomtask.processes import Process
14 TEMPLATES_DIR = 'templates'
17 class TaskServer(HTTPServer):
18 """Variant of HTTPServer that knows .jinja as Jinja Environment."""
20 def __init__(self, db_file: DatabaseFile,
21 *args: Any, **kwargs: Any) -> None:
22 super().__init__(*args, **kwargs)
24 self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR))
28 """Postvars wrapper for validating and retrieving posted form data."""
30 def __init__(self, postvars: dict[str, list[str]]) -> None:
31 self.postvars = postvars
33 def get_str(self, key: str) -> str:
34 """Retrieve string value of key from self.postvars."""
35 if key not in self.postvars:
36 raise BadFormatException(f'missing value for form field: {key}')
37 return self.postvars[key][0]
39 def get_float(self, key: str) -> float:
40 """Retrieve float value of key from self.postvars."""
41 val = self.get_str(key)
44 except ValueError as e:
45 msg = f'cannot float form field value: {val}'
46 raise BadFormatException(msg) from e
49 class TaskHandler(BaseHTTPRequestHandler):
50 """Handles single HTTP request."""
53 def do_GET(self) -> None:
54 """Handle any GET request."""
56 conn, site, params = self._init_handling()
57 if 'calendar' == site:
58 start = params.get('start', [''])[0]
59 end = params.get('end', [''])[0]
60 html = self.do_GET_calendar(conn, start, end)
62 date = params.get('date', [todays_date()])[0]
63 html = self.do_GET_day(conn, date)
64 elif 'process' == site:
65 id_ = params.get('id', [None])[0]
67 id__ = int(id_) if id_ else None
68 except ValueError as e:
69 raise BadFormatException(f'Bad ?id= value: {id_}') from e
70 html = self.do_GET_process(conn, id__)
71 elif 'processes' == site:
72 html = self.do_GET_processes(conn)
74 self._redirect('/day')
77 raise NotFoundException(f'Unknown page: /{site}')
80 except HandledException as error:
81 self._send_msg(error, code=error.http_code)
83 def do_GET_calendar(self, conn: DatabaseConnection,
84 start: str, end: str) -> str:
86 days = Day.all(conn, date_range=(start, end), fill_gaps=True)
87 return self.server.jinja.get_template('calendar.html').render(
88 days=days, start=start, end=end)
90 def do_GET_day(self, conn: DatabaseConnection, date: str) -> str:
91 """Show single Day."""
92 day = Day.by_date(conn, date, create=True)
93 return self.server.jinja.get_template('day.html').render(day=day)
95 def do_GET_process(self, conn: DatabaseConnection, id_: int | None) -> str:
96 """Show process of id_."""
97 return self.server.jinja.get_template('process.html').render(
98 process=Process.by_id(conn, id_, create=True))
100 def do_GET_processes(self, conn: DatabaseConnection) -> str:
101 """Show all Processes."""
102 return self.server.jinja.get_template('processes.html').render(
103 processes=Process.all(conn))
105 def do_POST(self) -> None:
106 """Handle any POST request."""
108 conn, site, params = self._init_handling()
109 length = int(self.headers['content-length'])
110 postvars = parse_qs(self.rfile.read(length).decode(),
111 keep_blank_values=True)
112 form_data = PostvarsParser(postvars)
114 date = params.get('date', [''])[0]
115 self.do_POST_day(conn, date, form_data)
116 elif 'process' == site:
117 id_ = params.get('id', [''])[0]
119 id__ = int(id_) if id_ else None
120 except ValueError as e:
121 raise BadFormatException(f'Bad ?id= value: {id_}') from e
122 self.do_POST_process(conn, id__, form_data)
126 except HandledException as error:
127 self._send_msg(error, code=error.http_code)
129 def do_POST_day(self, conn: DatabaseConnection, date: str,
130 form_data: PostvarsParser) -> None:
131 """Update or insert Day of date and fields defined in postvars."""
132 day = Day.by_date(conn, date, create=True)
133 day.comment = form_data.get_str('comment')
136 def do_POST_process(self, conn: DatabaseConnection, id_: int | None,
137 form_data: PostvarsParser) -> None:
138 """Update or insert Process of id_ and fields defined in postvars."""
139 process = Process.by_id(conn, id_, create=True)
140 process.title.set(form_data.get_str('title'))
141 process.description.set(form_data.get_str('description'))
142 process.effort.set(form_data.get_float('effort'))
145 def _init_handling(self) -> \
146 tuple[DatabaseConnection, str, dict[str, list[str]]]:
147 conn = DatabaseConnection(self.server.db)
148 parsed_url = urlparse(self.path)
149 site = path_split(parsed_url.path)[1]
150 params = parse_qs(parsed_url.query)
151 return conn, site, params
153 def _redirect(self, target: str) -> None:
154 self.send_response(302)
155 self.send_header('Location', target)
158 def _send_html(self, html: str, code: int = 200) -> None:
159 """Send HTML as proper HTTP response."""
160 self.send_response(code)
162 self.wfile.write(bytes(html, 'utf-8'))
164 def _send_msg(self, msg: Exception, code: int = 400) -> None:
165 """Send message in HTML formatting as HTTP response."""
166 html = self.server.jinja.get_template('msg.html').render(msg=msg)
167 self._send_html(html, code)