home · contact · privacy
In HTTP module, wrap params parsing into ParamsParser.
[plomtask] / plomtask / http.py
index 4ce72ec69e823f07f4ce718cd82aea66024f9c0d..86db94d34ee5ea13630a3d550e9b9116cbfb1e48 100644 (file)
@@ -1,11 +1,15 @@
-"""plom's task manager"""
+"""Web server stuff."""
+from typing import Any
 from http.server import BaseHTTPRequestHandler
 from http.server import HTTPServer
-from urllib.parse import urlparse
+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.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'
 
@@ -13,42 +17,160 @@ TEMPLATES_DIR = 'templates'
 class TaskServer(HTTPServer):
     """Variant of HTTPServer that knows .jinja as Jinja Environment."""
 
-    def __init__(self, *args, **kwargs):
-        x = super().__init__(*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:  # pylint: disable=too-few-public-methods
+    """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:
+            return default
+        return self.params[key][0]
+
+    def get_int_or_none(self, key: str) -> int | None:
+        """Retrieve int value of key yfrom self.params, on fail return None."""
+        if key not in self.params or not self.params[key]:
+            return None
+        val = self.params[key][0]
+        try:
+            return int(val)
+        except ValueError as e:
+            raise BadFormatException(f'Bad ?{key}= value: {val}') 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."""
+        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):
+    def do_GET(self) -> None:
+        """Handle any GET request."""
+        try:
+            conn, site, params = self._init_handling()
+            if site in {'calendar', 'day', 'process', 'processes'}:
+                html = getattr(self, f'do_GET_{site}')(conn, params)
+            elif '' == site:
+                self._redirect('/day')
+                return
+            else:
+                raise NotFoundException(f'Unknown page: /{site}')
+            conn.close()
+            self._send_html(html)
+        except HandledException as error:
+            self._send_msg(error, code=error.http_code)
+
+    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=days, start=start, end=end)
+
+    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)
+
+    def do_GET_process(self, conn: DatabaseConnection,
+                       params: ParamsParser) -> str:
+        """Show process of ?id=."""
+        id_ = params.get_int_or_none('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,
+                         _: 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=True)
+            form_data = PostvarsParser(postvars)
+            if site in ('day', 'process'):
+                getattr(self, f'do_POST_{site}')(conn, params, 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, params: ParamsParser,
+                    form_data: PostvarsParser) -> None:
+        """Update or insert Day of date and fields defined in postvars."""
+        date = params.get_str('date')
+        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, 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(conn)
+
+    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 = ParamsParser(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: 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)
-
-    def do_GET(self):
-        """Handle any GET request."""
-        try:
-            parsed_url = urlparse(self.path)
-            site = path_split(parsed_url.path)[1]
-            if 'calendar' == site:
-                html = self.do_GET_calendar()
-            else:
-                raise HandledException('Test!')
-            self.send_html(html)
-        except HandledException as error:
-            self.send_msg(error)
-
-    def do_GET_calendar(self):
-        """Show sorted Days."""
-        days = [Day('2024-01-03'), Day('2024-01-01'), Day('2024-01-02')]
-        days.sort()
-        return self.server.jinja.get_template('calendar.html').render(
-                days=days)
+        self._send_html(html, code)