Removed an excess blank line in test_utils.py.

.gitignore

@@ -37,4 +37,4 @@ excludes
 *.pot
 *.mo
 zh_Hans
-node_modules
+test_temp.py

src/accounting/utils/pagination.py

@@ -24,6 +24,7 @@ from urllib.parse import urlparse, parse_qsl, urlencode, urlunparse, \
     ParseResult
 
 from flask import request
+from werkzeug.routing import RequestRedirect
 
 from accounting.locale import gettext
 
@@ -52,6 +53,12 @@ class PageLink:
         """Whether the link should be shown on mobile screens."""
 
 
+class Redirection(RequestRedirect):
+    """The redirection."""
+    code = 302
+    """The HTTP code."""
+
+
 T = t.TypeVar("T")
 
 
@@ -69,12 +76,14 @@ class Pagination(t.Generic[T]):
         :param is_reversed: True if the default page is the last page, or False
             otherwise.
         """
+        self.__current_uri: str = request.full_path if request.query_string \
+            else request.path
+        """The current URI."""
         self.__items: list[T] = items
         """All the items."""
         self.__is_reversed: bool = is_reversed
         """Whether the default page is the last page."""
-        self.page_size: int = int(request.args.get("page-size",
-                                                   self.DEFAULT_PAGE_SIZE))
+        self.page_size: int = self.__get_page_size()
         """The number of items in a page."""
         self.__total_pages: int = 0 if len(items) == 0 \
             else int((len(items) - 1) / self.page_size) + 1
@@ -89,9 +98,6 @@ class Pagination(t.Generic[T]):
         """The items shown in the list"""
         if self.__total_pages > 0:
             self.__set_list()
-        self.__current_uri: str = request.full_path if request.query_string \
-            else request.path
-        """The current URI."""
         self.__base_uri_params: tuple[list[str], list[tuple[str, str]]] \
             = self.__get_base_uri_params()
         """The base URI parameters."""
@@ -100,6 +106,19 @@ class Pagination(t.Generic[T]):
         self.page_sizes: list[PageLink] = self.__get_page_sizes()
         """The links to switch the number of items in a page."""
 
+    def __get_page_size(self) -> int:
+        """Returns the page size.
+
+        :return: The page size.
+        :raise Redirection: When the page size is malformed.
+        """
+        if "page-size" not in request.args:
+            return self.DEFAULT_PAGE_SIZE
+        try:
+            return int(request.args["page-size"])
+        except ValueError:
+            raise Redirection(self.__uri_set("page-size", None))
+
     def __set_list(self) -> None:
         """Sets the items to show in the list.
 
@@ -107,8 +126,7 @@ class Pagination(t.Generic[T]):
         """
         self.__default_page_no = self.__total_pages if self.__is_reversed \
             else 1
-        self.page_no = int(request.args.get("page-no",
-                                            self.__default_page_no))
+        self.page_no = self.__get_page_no()
         if self.page_no < 1:
             self.page_no = 1
         if self.page_no > self.__total_pages:
@@ -119,6 +137,54 @@ class Pagination(t.Generic[T]):
             upper_bound = len(self.__items)
         self.list = self.__items[lower_bound:upper_bound]
 
+    def __get_page_no(self) -> int:
+        """Returns the page number.
+
+        :return: The page number.
+        :raise Redirection: When the page number is malformed.
+        """
+        if "page-no" not in request.args:
+            return self.__default_page_no
+        try:
+            page_no: int = int(request.args["page-no"])
+        except ValueError:
+            raise Redirection(self.__uri_set("page-no", None))
+        if page_no < 1:
+            if not self.__is_reversed:
+                raise Redirection(self.__uri_set("page-no", None))
+            raise Redirection(self.__uri_set("page-no", "1"))
+        if page_no > self.__total_pages:
+            if self.__is_reversed:
+                raise Redirection(self.__uri_set("page-no", None))
+            raise Redirection(self.__uri_set("page-no",
+                                             str(self.__total_pages)))
+        return page_no
+
+    def __uri_set(self, name: str, value: str | None) -> str:
+        """Raises current URI with a parameter set.
+
+        :param name: The name of the parameter.
+        :param value: The value, or None to remove the parameter.
+        :return: The URI with the parameter set.
+        """
+        uri_p: ParseResult = urlparse(self.__current_uri)
+        params: list[tuple[str, str]] = parse_qsl(uri_p.query)
+
+        # Try to keep the position of the parameter.
+        i: int = 0
+        is_found: bool = False
+        while i < len(params):
+            if params[i][0] == name:
+                if is_found or value is None:
+                    params = params[:i] + params[i + 1:]
+                    continue
+                params[i] = (name, value)
+            i = i + 1
+
+        parts: list[str] = list(uri_p)
+        parts[4] = urlencode(params)
+        return urlunparse(parts)
+
     def __get_base_uri_params(self) -> tuple[list[str], list[tuple[str, str]]]:
         """Returns the base URI and its parameters, with the "page-no" and
         "page-size" parameters removed.

tests/test_utils.py

@@ -0,0 +1,293 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/3
+
+#  Copyright (c) 2023 imacat.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+"""The test for the independent utilities.
+
+"""
+import unittest
+from urllib.parse import quote_plus
+
+import httpx
+from flask import Flask, request
+
+from accounting.utils.next_url import append_next, inherit_next, or_next
+from accounting.utils.pagination import Pagination
+from accounting.utils.query import parse_query_keywords
+from test_site import create_app
+from testlib import get_csrf_token
+
+
+class NextUriTestCase(unittest.TestCase):
+    """The test case for the next URI utilities."""
+
+    def test_next_uri(self) -> None:
+        """Tests the next URI utilities.
+
+        :return: None.
+        """
+        app: Flask = create_app(is_testing=True)
+        target: str = "/target"
+
+        @app.route("/test-next", methods=["GET", "POST"])
+        def test_next_view() -> str:
+            """The test view with the next URI."""
+            current_uri: str = request.full_path if request.query_string \
+                else request.path
+            self.assertEqual(append_next(target),
+                             f"{target}?next={quote_plus(current_uri)}")
+            next_uri: str = request.form["next"] if request.method == "POST" \
+                else request.args["next"]
+            self.assertEqual(inherit_next(target),
+                             f"{target}?next={quote_plus(next_uri)}")
+            self.assertEqual(or_next(target), next_uri)
+            return ""
+
+        @app.route("/test-no-next", methods=["GET", "POST"])
+        def test_no_next_view() -> str:
+            """The test view without the next URI."""
+            current_uri: str = request.full_path if request.query_string \
+                else request.path
+            self.assertEqual(append_next(target),
+                             f"{target}?next={quote_plus(current_uri)}")
+            self.assertEqual(inherit_next(target), target)
+            self.assertEqual(or_next(target), target)
+            return ""
+
+        client: httpx.Client = httpx.Client(app=app,
+                                            base_url="https://testserver")
+        client.headers["Referer"] = "https://testserver"
+        csrf_token: str = get_csrf_token(self, client, "/login")
+        response: httpx.Response
+
+        # With the next URI
+        response = client.get("/test-next?next=/next&q=abc&page-no=4")
+        self.assertEqual(response.status_code, 200)
+        response = client.post("/test-next", data={"csrf_token": csrf_token,
+                                                   "next": "/next",
+                                                   "name": "viewer"})
+        self.assertEqual(response.status_code, 200)
+
+        # Without the next URI
+        response = client.get("/test-no-next?q=abc&page-no=4")
+        self.assertEqual(response.status_code, 200)
+        response = client.post("/test-no-next", data={"csrf_token": csrf_token,
+                                                      "name": "viewer"})
+        self.assertEqual(response.status_code, 200)
+
+
+class QueryKeywordParserTestCase(unittest.TestCase):
+    """The test case for the query keyword parser."""
+
+    def test_default(self) -> None:
+        """Tests the query keyword parser.
+
+        :return: None.
+        """
+        self.assertEqual(parse_query_keywords("coffee"), ["coffee"])
+        self.assertEqual(parse_query_keywords("coffee tea"), ["coffee", "tea"])
+        self.assertEqual(parse_query_keywords("\"coffee\" \"tea cake\""),
+                         ["coffee", "tea cake"])
+
+    def test_malformed(self) -> None:
+        """Tests the malformed query.
+
+        :return: None.
+        """
+        self.assertEqual(parse_query_keywords("coffee te\"a ca\"ke"),
+                         ["coffee", "te\"a", "ca\"ke"])
+        self.assertEqual(parse_query_keywords("coffee \"tea cake"),
+                         ["coffee", "\"tea", "cake"])
+
+    def test_empty(self) -> None:
+        """Tests the empty query.
+
+        :return: None.
+        """
+        self.assertEqual(parse_query_keywords(None), [])
+        self.assertEqual(parse_query_keywords(""), [])
+
+
+class PaginationTestCase(unittest.TestCase):
+    """The test case for pagination."""
+
+    class Params:
+        """The testing parameters."""
+
+        def __init__(self, items: list[int], is_reversed: bool | None,
+                     result: list[int], is_needed: bool):
+            """Constructs the expected pagination.
+
+            :param items: All the items in the list.
+            :param is_reversed: Whether the default page is the last page.
+            :param result: The expected items on the page.
+            :param is_needed: Whether the pagination is needed.
+            """
+            self.items: list[int] = items
+            self.is_reversed: bool | None = is_reversed
+            self.result: list[int] = result
+            self.is_needed: bool = is_needed
+
+    def setUp(self) -> None:
+        """Sets up the test.
+        This is run once per test.
+
+        :return: None.
+        """
+        self.app: Flask = create_app(is_testing=True)
+        self.params = self.Params([], None, [], True)
+
+        @self.app.get("/test-pagination")
+        def test_pagination_view() -> str:
+            """The test view with the pagination."""
+            pagination: Pagination
+            if self.params.is_reversed is not None:
+                pagination = Pagination(self.params.items,
+                                        is_reversed=self.params.is_reversed)
+            else:
+                pagination = Pagination(self.params.items)
+            self.assertEqual(pagination.is_needed, self.params.is_needed)
+            self.assertEqual(pagination.list, self.params.result)
+            return ""
+
+        self.client = httpx.Client(app=self.app, base_url="https://testserver")
+        self.client.headers["Referer"] = "https://testserver"
+
+    def __test_success(self, query: str, items: range,
+                       result: range, is_needed: bool = True,
+                       is_reversed: bool | None = None) -> None:
+        """Tests the pagination.
+
+        :param query: The query string.
+        :param items: The original items.
+        :param result: The expected page content.
+        :param is_needed: Whether the pagination is needed.
+        :param is_reversed: Whether the list is reversed.
+        :return: None.
+        """
+        target: str = "/test-pagination"
+        if query != "":
+            target = f"{target}?{query}"
+        self.params = self.Params(list(items), is_reversed,
+                                  list(result), is_needed)
+        response: httpx.Response = self.client.get(target)
+        self.assertEqual(response.status_code, 200)
+
+    def __test_malformed(self, query: str, items: range, redirect_to: str,
+                         is_reversed: bool | None = None) -> None:
+        """Tests the pagination.
+
+        :param query: The query string.
+        :param items: The original items.
+        :param redirect_to: The expected target query of the redirection.
+        :param is_reversed: Whether the list is reversed.
+        :return: None.
+        """
+        target: str = "/test-pagination"
+        self.params = self.Params(list(items), is_reversed, [], True)
+        response: httpx.Response = self.client.get(f"{target}?{query}")
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.headers["Location"],
+                         f"{target}?{redirect_to}")
+
+    def test_default(self) -> None:
+        """Tests the default pagination.
+
+        :return: None.
+        """
+        # The default first page
+        self.__test_success("", range(1, 687), range(1, 11))
+        # Some page in the middle
+        self.__test_success("page-no=37", range(1, 687), range(361, 371))
+        # The last page
+        self.__test_success("page-no=69", range(1, 687), range(681, 687))
+
+    def test_page_size(self) -> None:
+        """Tests the pagination with a different page size.
+
+        :return: None.
+        """
+        # The default page with a different page size
+        self.__test_success("page-size=15", range(1, 687), range(1, 16))
+        # Some page with a different page size
+        self.__test_success("page-no=37&page-size=15", range(1, 687),
+                            range(541, 556))
+        # The last page with a different page size.
+        self.__test_success("page-no=46&page-size=15", range(1, 687),
+                            range(676, 687))
+
+    def test_not_needed(self) -> None:
+        """Tests the pagination that is not needed.
+
+        :return: None.
+        """
+        # Empty list
+        self.__test_success("", range(0, 0), range(0, 0), is_needed=False)
+        # A list that fits in one page
+        self.__test_success("", range(1, 4), range(1, 4), is_needed=False)
+        # A large page size that fits in everything
+        self.__test_success("page-size=1000", range(1, 687), range(1, 687),
+                            is_needed=False)
+
+    def test_reversed(self) -> None:
+        """Tests the default page on a reversed list.
+
+        :return: None.
+        """
+        # The default page
+        self.__test_success("", range(1, 687), range(681, 687),
+                            is_reversed=True)
+        # The default page with a different page size
+        self.__test_success("page-size=15", range(1, 687), range(676, 687),
+                            is_reversed=True)
+
+    def test_last_page(self) -> None:
+        """Tests the calculation of the items on the last page.
+
+        :return: None.
+        """
+        # The last page that fits in one page
+        self.__test_success("page-no=69", range(1, 691), range(681, 691))
+        # A danging item in the last page
+        self.__test_success("page-no=70", range(1, 692), range(691, 692))
+
+    def test_malformed(self) -> None:
+        """Tests the malformed pagination parameters.
+
+        :return: None.
+        """
+        # A malformed page size
+        self.__test_malformed("q=word&page-size=100a&page-no=37&next=%2F",
+                              range(1, 691), "q=word&page-no=37&next=%2F")
+        # A malformed page number
+        self.__test_malformed("q=word&page-size=15&page-no=37a&next=%2F",
+                              range(1, 691), "q=word&page-size=15&next=%2F")
+        # A page number beyond the last page
+        self.__test_malformed("q=word&page-size=15&page-no=100&next=%2F",
+                              range(1, 691),
+                              "q=word&page-size=15&page-no=46&next=%2F")
+        # A page number beyond the last page, on a reversed list
+        self.__test_malformed("q=word&page-size=15&page-no=100&next=%2F",
+                              range(1, 691),
+                              "q=word&page-size=15&next=%2F", is_reversed=True)
+        # A page number before the first page
+        self.__test_malformed("q=word&page-size=15&page-no=0&next=%2F",
+                              range(1, 691),
+                              "q=word&page-size=15&next=%2F")
+        # A page number before the first page, on a reversed list
+        self.__test_malformed("q=word&page-size=15&page-no=0&next=%2F",
+                              range(1, 691),
+                              "q=word&page-size=15&page-no=1&next=%2F",
+                              is_reversed=True)