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))
27 class ParamsParser: # pylint: disable=too-few-public-methods
28 """Wrapper for validating and retrieving GET params."""
30 def __init__(self, params: dict[str, list[str]]) -> None:
33 def get_str(self, key: str, default: str = '') -> str:
34 """Retrieve string value of key from self.params."""
35 if key not in self.params:
37 return self.params[key][0]
39 def get_int_or_none(self, key: str) -> int | None:
40 """Retrieve int value of key yfrom self.params, on fail return None."""
41 if key not in self.params or not self.params[key]:
43 val = self.params[key][0]
46 except ValueError as e:
47 raise BadFormatException(f'Bad ?{key}= value: {val}') from e
51 """Postvars wrapper for validating and retrieving form data."""
53 def __init__(self, postvars: dict[str, list[str]]) -> None:
54 self.postvars = postvars
56 def get_str(self, key: str) -> str:
57 """Retrieve string value of key from self.postvars."""
58 if key not in self.postvars:
59 raise BadFormatException(f'missing value for form field: {key}')
60 return self.postvars[key][0]
62 def get_float(self, key: str) -> float:
63 """Retrieve float value of key from self.postvars."""
64 val = self.get_str(key)
67 except ValueError as e:
68 msg = f'cannot float form field value: {val}'
69 raise BadFormatException(msg) from e
72 class TaskHandler(BaseHTTPRequestHandler):
73 """Handles single HTTP request."""
76 def do_GET(self) -> None:
77 """Handle any GET request."""
79 conn, site, params = self._init_handling()
80 if site in {'calendar', 'day', 'process', 'processes'}:
81 html = getattr(self, f'do_GET_{site}')(conn, params)
83 self._redirect('/day')
86 raise NotFoundException(f'Unknown page: /{site}')
89 except HandledException as error:
90 self._send_msg(error, code=error.http_code)
92 def do_GET_calendar(self, conn: DatabaseConnection,
93 params: ParamsParser) -> str:
94 """Show Days from ?start= to ?end=."""
95 start = params.get_str('start')
96 end = params.get_str('end')
97 days = Day.all(conn, date_range=(start, end), fill_gaps=True)
98 return self.server.jinja.get_template('calendar.html').render(
99 days=days, start=start, end=end)
101 def do_GET_day(self, conn: DatabaseConnection,
102 params: ParamsParser) -> str:
103 """Show single Day of ?date=."""
104 date = params.get_str('date', todays_date())
105 day = Day.by_date(conn, date, create=True)
106 return self.server.jinja.get_template('day.html').render(day=day)
108 def do_GET_process(self, conn: DatabaseConnection,
109 params: ParamsParser) -> str:
110 """Show process of ?id=."""
111 id_ = params.get_int_or_none('id')
112 return self.server.jinja.get_template('process.html').render(
113 process=Process.by_id(conn, id_, create=True))
115 def do_GET_processes(self, conn: DatabaseConnection,
116 _: ParamsParser) -> str:
117 """Show all Processes."""
118 return self.server.jinja.get_template('processes.html').render(
119 processes=Process.all(conn))
121 def do_POST(self) -> None:
122 """Handle any POST request."""
124 conn, site, params = self._init_handling()
125 length = int(self.headers['content-length'])
126 postvars = parse_qs(self.rfile.read(length).decode(),
127 keep_blank_values=True)
128 form_data = PostvarsParser(postvars)
129 if site in ('day', 'process'):
130 getattr(self, f'do_POST_{site}')(conn, params, form_data)
134 except HandledException as error:
135 self._send_msg(error, code=error.http_code)
137 def do_POST_day(self, conn: DatabaseConnection, params: ParamsParser,
138 form_data: PostvarsParser) -> None:
139 """Update or insert Day of date and fields defined in postvars."""
140 date = params.get_str('date')
141 day = Day.by_date(conn, date, create=True)
142 day.comment = form_data.get_str('comment')
145 def do_POST_process(self, conn: DatabaseConnection, params: ParamsParser,
146 form_data: PostvarsParser) -> None:
147 """Update or insert Process of id_ and fields defined in postvars."""
148 id_ = params.get_int_or_none('id')
149 process = Process.by_id(conn, id_, create=True)
150 process.title.set(form_data.get_str('title'))
151 process.description.set(form_data.get_str('description'))
152 process.effort.set(form_data.get_float('effort'))
155 def _init_handling(self) -> tuple[DatabaseConnection, str, ParamsParser]:
156 conn = DatabaseConnection(self.server.db)
157 parsed_url = urlparse(self.path)
158 site = path_split(parsed_url.path)[1]
159 params = ParamsParser(parse_qs(parsed_url.query))
160 return conn, site, params
162 def _redirect(self, target: str) -> None:
163 self.send_response(302)
164 self.send_header('Location', target)
167 def _send_html(self, html: str, code: int = 200) -> None:
168 """Send HTML as proper HTTP response."""
169 self.send_response(code)
171 self.wfile.write(bytes(html, 'utf-8'))
173 def _send_msg(self, msg: Exception, code: int = 400) -> None:
174 """Send message in HTML formatting as HTTP response."""
175 html = self.server.jinja.get_template('msg.html').render(msg=msg)
176 self._send_html(html, code)