home · contact · privacy
Refactor from_table_row methods of core DB models.
[plomtask] / plomtask / http.py
index 5d165ecf90f1ca6ebaed77e55b73a5d55ff428b8..55120fffe0de409ab74d3e9354cfd8a95e4506ad 100644 (file)
@@ -10,6 +10,7 @@ from plomtask.exceptions import HandledException, BadFormatException, \
         NotFoundException
 from plomtask.db import DatabaseConnection, DatabaseFile
 from plomtask.processes import Process
+from plomtask.conditions import Condition
 from plomtask.todos import Todo
 
 TEMPLATES_DIR = 'templates'
@@ -25,81 +26,63 @@ class TaskServer(HTTPServer):
         self.jinja = JinjaEnv(loader=JinjaFSLoader(TEMPLATES_DIR))
 
 
-class ParamsParser:
-    """Wrapper for validating and retrieving GET params."""
+class InputsParser:
+    """Wrapper for validating and retrieving dict-like HTTP inputs."""
 
-    def __init__(self, params: dict[str, list[str]]) -> None:
-        self.params = params
+    def __init__(self, dict_: dict[str, list[str]],
+                 strictness: bool = True) -> None:
+        self.inputs = dict_
+        self.strict = strictness
 
-    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]):
+    def get_str(self, key: str, default: str = '',
+                ignore_strict: bool = False) -> str:
+        """Retrieve single/first string value of key, or default."""
+        if key not in self.inputs.keys() or 0 == len(self.inputs[key]):
+            if self.strict and not ignore_strict:
+                raise BadFormatException(f'no value found for key {key}')
             return default
-        return self.params[key][0]
+        return self.inputs[key][0]
+
+    def get_int(self, key: str) -> int:
+        """Retrieve single/first value of key as int, error if empty."""
+        val = self.get_int_or_none(key)
+        if val is None:
+            raise BadFormatException(f'unexpected empty value for: {key}')
+        return val
 
     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]))):
+        """Retrieve single/first value of key as int, return None if empty."""
+        val = self.get_str(key, ignore_strict=True)
+        if val == '':
             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}'
+            msg = f'cannot int form field value for key {key}: {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}'
+            msg = f'cannot float form field value for key {key}: {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:
+        """Retrieve list of string values at key."""
+        if key not in self.inputs.keys():
             return []
-        return self.postvars[key]
+        return self.inputs[key]
 
     def get_all_int(self, key: str) -> list[int]:
-        """Retrieve list of int values at key from self.postvars."""
+        """Retrieve list of int values at key."""
         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}'
+            msg = f'cannot int a form field value for key {key} in: {all_str}'
             raise BadFormatException(msg) from e
 
 
@@ -110,138 +93,173 @@ class TaskHandler(BaseHTTPRequestHandler):
     def do_GET(self) -> None:
         """Handle any GET request."""
         try:
-            conn, site, params = self._init_handling()
-            if site in {'calendar', 'day', 'process', 'processes', 'todo'}:
-                html = getattr(self, f'do_GET_{site}')(conn, params)
-            elif '' == site:
+            self._init_handling()
+            if self.site in {'calendar', 'day', 'process', 'processes', 'todo',
+                             'condition', 'conditions'}:
+                template = f'{self.site}.html'
+                ctx = getattr(self, f'do_GET_{self.site}')()
+                html = self.server.jinja.get_template(template).render(**ctx)
+                self._send_html(html)
+            elif '' == self.site:
                 self._redirect('/day')
-                return
             else:
-                raise NotFoundException(f'Unknown page: /{site}')
-            self._send_html(html)
+                raise NotFoundException(f'Unknown page: /{self.site}')
         except HandledException as error:
             self._send_msg(error, code=error.http_code)
         finally:
-            conn.close()
+            self.conn.close()
 
-    def do_GET_calendar(self, conn: DatabaseConnection,
-                        params: ParamsParser) -> str:
+    def do_GET_calendar(self) -> dict[str, object]:
         """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:
+        start = self.params.get_str('start')
+        end = self.params.get_str('end')
+        days = Day.all(self.conn, date_range=(start, end), fill_gaps=True)
+        return {'start': start, 'end': end, 'days': days}
+
+    def do_GET_day(self) -> dict[str, object]:
         """Show single Day of ?date=."""
-        date = params.get_str('date', todays_date())
-        day = Day.by_date(conn, date, create=True)
-        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:
+        date = self.params.get_str('date', todays_date())
+        conditions_listing = []
+        for condition in Condition.all(self.conn):
+            enablers = Todo.enablers_for_at(self.conn, condition, date)
+            disablers = Todo.disablers_for_at(self.conn, condition, date)
+            conditions_listing += [{
+                    'condition': condition,
+                    'enablers': enablers,
+                    'disablers': disablers}]
+        return {'day': Day.by_date(self.conn, date, create=True),
+                'todos': Todo.by_date(self.conn, date),
+                'processes': Process.all(self.conn),
+                'conditions_listing': conditions_listing}
+
+    def do_GET_todo(self) -> dict[str, object]:
         """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_GET_process(self, conn: DatabaseConnection,
-                       params: ParamsParser) -> str:
+        id_ = self.params.get_int_or_none('id')
+        todo = Todo.by_id(self.conn, id_)
+        return {'todo': todo,
+                'todo_candidates': Todo.by_date(self.conn, todo.date),
+                'condition_candidates': Condition.all(self.conn)}
+
+    def do_GET_conditions(self) -> dict[str, object]:
+        """Show all Conditions."""
+        return {'conditions': Condition.all(self.conn)}
+
+    def do_GET_condition(self) -> dict[str, object]:
+        """Show Condition of ?id=."""
+        id_ = self.params.get_int_or_none('id')
+        return {'condition': Condition.by_id(self.conn, id_, create=True)}
+
+    def do_GET_process(self) -> dict[str, object]:
         """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:
+        id_ = self.params.get_int_or_none('id')
+        process = Process.by_id(self.conn, id_, create=True)
+        return {'process': process,
+                'steps': process.get_steps(self.conn),
+                'owners': process.used_as_step_by(self.conn),
+                'process_candidates': Process.all(self.conn),
+                'condition_candidates': Condition.all(self.conn)}
+
+    def do_GET_processes(self) -> dict[str, object]:
         """Show all Processes."""
-        return self.server.jinja.get_template('processes.html').render(
-                processes=Process.all(conn))
+        return {'processes': Process.all(self.conn)}
 
     def do_POST(self) -> None:
         """Handle any POST request."""
+        # pylint: disable=attribute-defined-outside-init
         try:
-            conn, site, params = self._init_handling()
+            self._init_handling()
             length = int(self.headers['content-length'])
             postvars = parse_qs(self.rfile.read(length).decode(),
                                 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()
+            self.form_data = InputsParser(postvars)
+            if self.site in ('day', 'process', 'todo', 'condition'):
+                getattr(self, f'do_POST_{self.site}')()
+                self.conn.commit()
             else:
-                msg = f'Page not known as POST target: /{site}'
+                msg = f'Page not known as POST target: /{self.site}'
                 raise NotFoundException(msg)
             self._redirect('/')
         except HandledException as error:
             self._send_msg(error, code=error.http_code)
         finally:
-            conn.close()
+            self.conn.close()
 
-    def do_POST_day(self, conn: DatabaseConnection, params: ParamsParser,
-                    form_data: PostvarsParser) -> None:
+    def do_POST_day(self) -> 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 = form_data.get_str('comment')
-        day.save(conn)
-        process_id = form_data.get_int_or_none('new_todo')
+        date = self.params.get_str('date')
+        day = Day.by_date(self.conn, date, create=True)
+        day.comment = self.form_data.get_str('comment')
+        day.save(self.conn)
+        process_id = self.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)
+            process = Process.by_id(self.conn, process_id)
+            todo = Todo(None, process, False, day.date)
+            todo.save(self.conn)
 
-    def do_POST_todo(self, conn: DatabaseConnection, params: ParamsParser,
-                     form_data: PostvarsParser) -> None:
+    def do_POST_todo(self) -> 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')
+        id_ = self.params.get_int_or_none('id')
+        todo = Todo.by_id(self.conn, id_)
+        child_id = self.form_data.get_int_or_none('adopt')
         if child_id is not None:
-            child = Todo.by_id(conn, child_id)
+            child = Todo.by_id(self.conn, child_id)
             todo.add_child(child)
-        todo.is_done = len(form_data.get_all_str('done')) > 0
-        todo.save(conn)
-
-    def do_POST_process(self, conn: DatabaseConnection, params: ParamsParser,
-                        form_data: PostvarsParser) -> None:
+        todo.set_conditions(self.conn, self.form_data.get_all_int('condition'))
+        todo.set_fulfills(self.conn, self.form_data.get_all_int('fulfills'))
+        todo.set_undoes(self.conn, self.form_data.get_all_int('undoes'))
+        todo.is_done = len(self.form_data.get_all_str('done')) > 0
+        todo.save(self.conn)
+        for condition in todo.fulfills:
+            condition.save(self.conn)
+        for condition in todo.undoes:
+            condition.save(self.conn)
+
+    def do_POST_process(self) -> 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)
+        id_ = self.params.get_int_or_none('id')
+        process = Process.by_id(self.conn, id_, create=True)
+        process.title.set(self.form_data.get_str('title'))
+        process.description.set(self.form_data.get_str('description'))
+        process.effort.set(self.form_data.get_float('effort'))
+        process.set_conditions(self.conn,
+                               self.form_data.get_all_int('condition'))
+        process.set_fulfills(self.conn, self.form_data.get_all_int('fulfills'))
+        process.set_undoes(self.conn, self.form_data.get_all_int('undoes'))
+        process.save_core(self.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'):
+        steps: list[tuple[int | None, int, int | None]] = []
+        for step_id in self.form_data.get_all_int('steps'):
+            for step_process_id in self.form_data.get_all_int(
+                    f'new_step_to_{step_id}'):
+                steps += [(None, step_process_id, step_id)]
+            if step_id not in self.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) -> tuple[DatabaseConnection, str, ParamsParser]:
-        conn = DatabaseConnection(self.server.db)
+            step_process_id = self.form_data.get_int(
+                    f'step_{step_id}_process_id')
+            parent_id = self.form_data.get_int_or_none(
+                    f'step_{step_id}_parent_id')
+            steps += [(step_id, step_process_id, parent_id)]
+        for step_process_id in self.form_data.get_all_int('new_top_step'):
+            steps += [(None, step_process_id, None)]
+        process.set_steps(self.conn, steps)
+        process.save(self.conn)
+
+    def do_POST_condition(self) -> None:
+        """Update/insert Condition of ?id= and fields defined in postvars."""
+        id_ = self.params.get_int_or_none('id')
+        condition = Condition.by_id(self.conn, id_, create=True)
+        condition.title.set(self.form_data.get_str('title'))
+        condition.description.set(self.form_data.get_str('description'))
+        condition.save(self.conn)
+
+    def _init_handling(self) -> None:
+        # pylint: disable=attribute-defined-outside-init
+        self.conn = DatabaseConnection(self.server.db)
         parsed_url = urlparse(self.path)
-        site = path_split(parsed_url.path)[1]
-        params = ParamsParser(parse_qs(parsed_url.query, strict_parsing=True))
-        return conn, site, params
+        self.site = path_split(parsed_url.path)[1]
+        params = parse_qs(parsed_url.query, strict_parsing=True)
+        self.params = InputsParser(params, False)
 
     def _redirect(self, target: str) -> None:
         self.send_response(302)