home · contact · privacy
Add PostvarsParser to isolate postvars parsing/checking.
[plomtask] / plomtask / http.py
index b6019ef0761b1dc3a86d3a12f395cd5b96f40c5c..933662f51f1a9b78754371c2399969afa0ca75df 100644 (file)
 """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
+
+TEMPLATES_DIR = 'templates'
 
 
 class TaskServer(HTTPServer):
     """Variant of HTTPServer that knows .jinja as Jinja Environment."""
 
-    def __init__(self, templates_dir, 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))
+        self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR))
+
+
+class PostvarsParser:
+    """Postvars wrapper for validating and retrieving posted 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."""
+        if key not in self.postvars:
+            raise BadFormatException(f'missing value for form field: {key}')
+        return self.postvars[key][0]
+
+    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
 
 
 class TaskHandler(BaseHTTPRequestHandler):
     """Handles single HTTP request."""
     server: TaskServer
 
-    def send_html(self, html: str, code: int = 200):
-        """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):
-        """Send message in HTML formatting as HTTP response."""
-        html = self.server.jinja.get_template('msg.html').render(msg=msg)
-        self.send_html(html, code)
-
-    def do_GET(self):
+    def do_GET(self) -> None:
         """Handle any GET request."""
         try:
-            conn = DatabaseConnection(self.server.db)
-            parsed_url = urlparse(self.path)
-            site = path_split(parsed_url.path)[1]
-            params = parse_qs(parsed_url.query)
+            conn, site, params = self._init_handling()
             if 'calendar' == site:
-                html = self.do_GET_calendar(conn)
+                start = params.get('start', [''])[0]
+                end = params.get('end', [''])[0]
+                html = self.do_GET_calendar(conn, start, end)
             elif 'day' == site:
-                date = params.get('date', ['2024-01-01'])[0]
+                date = params.get('date', [todays_date()])[0]
                 html = self.do_GET_day(conn, date)
+            elif 'process' == site:
+                id_ = params.get('id', [None])[0]
+                try:
+                    id__ = int(id_) if id_ else None
+                except ValueError as e:
+                    raise BadFormatException(f'Bad ?id= value: {id_}') from e
+                html = self.do_GET_process(conn, id__)
+            elif 'processes' == site:
+                html = self.do_GET_processes(conn)
+            elif '' == site:
+                self._redirect('/day')
+                return
             else:
-                raise HandledException('Test!')
-            conn.commit()
+                raise NotFoundException(f'Unknown page: /{site}')
             conn.close()
-            self.send_html(html)
+            self._send_html(html)
         except HandledException as error:
-            self.send_msg(error)
+            self._send_msg(error, code=error.http_code)
 
-    def do_GET_calendar(self, conn: DatabaseConnection):
+    def do_GET_calendar(self, conn: DatabaseConnection,
+                        start: str, end: str) -> str:
         """Show Days."""
+        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):
+    def do_GET_day(self, conn: DatabaseConnection, date: str) -> str:
         """Show single Day."""
-        day = Day.by_date(conn, date)
+        day = Day.by_date(conn, date, create=True)
         return self.server.jinja.get_template('day.html').render(day=day)
+
+    def do_GET_process(self, conn: DatabaseConnection, id_: int | None) -> str:
+        """Show process of id_."""
+        return self.server.jinja.get_template('process.html').render(
+                process=Process.by_id(conn, id_, create=True))
+
+    def do_GET_processes(self, conn: DatabaseConnection) -> 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=True)
+            form_data = PostvarsParser(postvars)
+            if 'day' == site:
+                date = params.get('date', [''])[0]
+                self.do_POST_day(conn, date, form_data)
+            elif 'process' == site:
+                id_ = params.get('id', [''])[0]
+                try:
+                    id__ = int(id_) if id_ else None
+                except ValueError as e:
+                    raise BadFormatException(f'Bad ?id= value: {id_}') from e
+                self.do_POST_process(conn, id__, form_data)
+            conn.commit()
+            conn.close()
+            self._redirect('/')
+        except HandledException as error:
+            self._send_msg(error, code=error.http_code)
+
+    def do_POST_day(self, conn: DatabaseConnection, date: str,
+                    form_data: PostvarsParser) -> None:
+        """Update or insert Day of date and fields defined in postvars."""
+        day = Day.by_date(conn, date, create=True)
+        day.comment = form_data.get_str('comment')
+        day.save(conn)
+
+    def do_POST_process(self, conn: DatabaseConnection, id_: int | None,
+                        form_data: PostvarsParser) -> None:
+        """Update or insert Process of id_ and fields defined in postvars."""
+        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(conn)
+
+    def _init_handling(self) -> \
+            tuple[DatabaseConnection, str, dict[str, list[str]]]:
+        conn = DatabaseConnection(self.server.db)
+        parsed_url = urlparse(self.path)
+        site = path_split(parsed_url.path)[1]
+        params = parse_qs(parsed_url.query)
+        return conn, site, params
+
+    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) -> 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)