Added the currency management.

src/accounting/currency/__init__.py

@@ -0,0 +1,38 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/6
+
+#  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 currency management.
+
+"""
+from flask import Flask, Blueprint
+
+
+def init_app(app: Flask, bp: Blueprint) -> None:
+    """Initialize the application.
+
+    :param bp: The blueprint of the accounting application.
+    :param app: The Flask application.
+    :return: None.
+    """
+    from .converters import CurrencyConverter
+    app.url_map.converters["currency"] = CurrencyConverter
+
+    from .views import bp as currency_bp, api_bp as currency_api_bp
+    bp.register_blueprint(currency_bp, url_prefix="/currencies")
+    bp.register_blueprint(currency_api_bp, url_prefix="/api/currencies")
+
+    from .commands import init_currencies_command
+    app.cli.add_command(init_currencies_command)

src/accounting/currency/commands.py

@@ -0,0 +1,78 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/6
+
+#  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 console commands for the currency management.
+
+"""
+import os
+
+import click
+from flask.cli import with_appcontext
+
+from accounting.database import db
+from accounting.models import Currency, CurrencyL10n
+from accounting.utils.user import has_user, get_user_pk
+
+CurrencyData = tuple[str, str, str, str]
+
+
+def __validate_username(ctx: click.core.Context, param: click.core.Option,
+                        value: str) -> str:
+    """Validates the username for the click console command.
+
+    :param ctx: The console command context.
+    :param param: The console command option.
+    :param value: The username.
+    :raise click.BadParameter: When validation fails.
+    :return: The username.
+    """
+    value = value.strip()
+    if value == "":
+        raise click.BadParameter("Username empty.")
+    if not has_user(value):
+        raise click.BadParameter(f"User {value} does not exist.")
+    return value
+
+
+@click.command("accounting-init-currencies")
+@click.option("-u", "--username", metavar="USERNAME", prompt=True,
+              help="The username.", callback=__validate_username,
+              default=lambda: os.getlogin())
+@with_appcontext
+def init_currencies_command(username: str) -> None:
+    """Initializes the currencies."""
+    data: list[CurrencyData] = [
+        ("TWD", "New Taiwan dollar", "新臺幣", "新台币"),
+        ("USD", "United States dollar", "美元", "美元"),
+    ]
+    creator_pk: int = get_user_pk(username)
+    existing: list[Currency] = Currency.query.all()
+    existing_code: set[str] = {x.code for x in existing}
+    to_add: list[CurrencyData] = [x for x in data if x[0] not in existing_code]
+    if len(to_add) == 0:
+        click.echo("No more currency to add.")
+        return
+
+    db.session.bulk_save_objects(
+        [Currency(code=x[0], name_l10n=x[1],
+                  created_by_id=creator_pk, updated_by_id=creator_pk)
+         for x in data])
+    db.session.bulk_save_objects(
+        [CurrencyL10n(currency_code=x[0], locale=y[0], name=y[1])
+         for x in data for y in (("zh_Hant", x[2]), ("zh_Hans", x[3]))])
+    db.session.commit()
+
+    click.echo(F"{len(to_add)} added.  Currencies initialized.")

src/accounting/currency/converters.py

@@ -0,0 +1,48 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/6
+
+#  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 path converters for the currency management.
+
+"""
+from flask import abort
+from werkzeug.routing import BaseConverter
+
+from accounting.database import db
+from accounting.models import Currency
+
+
+class CurrencyConverter(BaseConverter):
+    """The currency converter to convert the currency code and to the
+    corresponding currency in the routes."""
+
+    def to_python(self, value: str) -> Currency:
+        """Converts a currency code to a currency.
+
+        :param value: The currency code.
+        :return: The corresponding currency.
+        """
+        currency: Currency | None = db.session.get(Currency, value)
+        if currency is None:
+            abort(404)
+        return currency
+
+    def to_url(self, value: Currency) -> str:
+        """Converts a currency to its code.
+
+        :param value: The currency.
+        :return: The code.
+        """
+        return value.code

src/accounting/currency/forms.py

@@ -0,0 +1,93 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/6
+
+#  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 forms for the currency management.
+
+"""
+from __future__ import annotations
+
+import sqlalchemy as sa
+from flask_wtf import FlaskForm
+from wtforms import StringField, ValidationError
+from wtforms.validators import DataRequired, Regexp, NoneOf
+
+from accounting.database import db
+from accounting.locale import lazy_gettext
+from accounting.models import Currency
+from accounting.utils.strip_text import strip_text
+from accounting.utils.user import get_current_user_pk
+
+
+class CurrencyForm(FlaskForm):
+    """The form to create or edit a currency."""
+    CODE_BLOCKLIST: list[str] = ["create", "store", "exists-code"]
+    """The reserved codes that are not available."""
+
+    class CodeUnique:
+        """The validator to check if the code is unique."""
+        def __call__(self, form: CurrencyForm, field: StringField) -> None:
+            if field.data == "":
+                return
+            if form.obj_code is not None and form.obj_code == field.data:
+                return
+            if db.session.get(Currency, field.data) is not None:
+                raise ValidationError(lazy_gettext(
+                    "Code conflicts with another currency."))
+
+    code = StringField(
+        filters=[strip_text],
+        validators=[DataRequired(lazy_gettext("Please fill in the code.")),
+                    Regexp(r"^[A-Z]{3}$",
+                           message=lazy_gettext(
+                               "Code can only be composed of 3 upper-cased"
+                               " letters.")),
+                    NoneOf(CODE_BLOCKLIST, message=lazy_gettext(
+                        "This code is not available.")),
+                    CodeUnique()])
+    """The code.  It may not conflict with another currency."""
+    name = StringField(
+        filters=[strip_text],
+        validators=[DataRequired(lazy_gettext("Please fill in the name."))])
+    """The name."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.obj_code: str | None = None
+        """The current code of the currency, or None when adding a new
+        currency."""
+
+    def populate_obj(self, obj: Currency) -> None:
+        """Populates the form data into a currency object.
+
+        :param obj: The currency object.
+        :return: None.
+        """
+        is_new: bool = obj.code is None
+        obj.code = self.code.data
+        obj.name = self.name.data
+        if is_new:
+            current_user_pk: int = get_current_user_pk()
+            obj.created_by_id = current_user_pk
+            obj.updated_by_id = current_user_pk
+
+    def post_update(self, obj) -> None:
+        """The post-processing after the update.
+
+        :return: None
+        """
+        current_user_pk: int = get_current_user_pk()
+        obj.updated_by_id = current_user_pk
+        obj.updated_at = sa.func.now()

src/accounting/currency/query.py

@@ -0,0 +1,44 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/6
+
+#  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 currency query.
+
+"""
+import sqlalchemy as sa
+from flask import request
+
+from accounting.models import Currency, CurrencyL10n
+from accounting.utils.query import parse_query_keywords
+
+
+def get_currency_query() -> list[Currency]:
+    """Returns the base accounts, optionally filtered by the query.
+
+    :return: The base accounts.
+    """
+    keywords: list[str] = parse_query_keywords(request.args.get("q"))
+    if len(keywords) == 0:
+        return Currency.query.order_by(Currency.code).all()
+    conditions: list[sa.BinaryExpression] = []
+    for k in keywords:
+        l10n: list[CurrencyL10n] = CurrencyL10n.query\
+            .filter(CurrencyL10n.name.contains(k)).all()
+        l10n_matches: set[str] = {x.account_code for x in l10n}
+        conditions.append(sa.or_(Currency.code.contains(k),
+                                 Currency.name_l10n.contains(k),
+                                 Currency.code.in_(l10n_matches)))
+    return Currency.query.filter(*conditions)\
+        .order_by(Currency.code).all()

src/accounting/currency/views.py

@@ -0,0 +1,178 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/6
+
+#  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 views for the currency management.
+
+"""
+from urllib.parse import urlencode, parse_qsl
+
+from flask import Blueprint, render_template, redirect, session, request, \
+    flash, url_for
+from werkzeug.datastructures import ImmutableMultiDict
+
+from accounting.database import db
+from accounting.locale import lazy_gettext
+from accounting.models import Currency
+from accounting.utils.next_url import inherit_next, or_next
+from accounting.utils.pagination import Pagination
+from accounting.utils.permission import has_permission, can_view, can_edit
+from .forms import CurrencyForm
+
+bp: Blueprint = Blueprint("currency", __name__)
+"""The view blueprint for the currency management."""
+api_bp: Blueprint = Blueprint("currency-api", __name__)
+"""The view blueprint for the currency management API."""
+
+
+@bp.get("", endpoint="list")
+@has_permission(can_view)
+def list_currencies() -> str:
+    """Lists the currencies.
+
+    :return: The currency list.
+    """
+    from .query import get_currency_query
+    currencies: list[Currency] = get_currency_query()
+    pagination: Pagination = Pagination[Currency](currencies)
+    return render_template("accounting/currency/list.html",
+                           list=pagination.list, pagination=pagination)
+
+
+@bp.get("/create", endpoint="create")
+@has_permission(can_edit)
+def show_add_currency_form() -> str:
+    """Shows the form to add a currency.
+
+    :return: The form to add a currency.
+    """
+    if "form" in session:
+        form = CurrencyForm(ImmutableMultiDict(parse_qsl(session["form"])))
+        del session["form"]
+        form.validate()
+    else:
+        form = CurrencyForm()
+    return render_template("accounting/currency/create.html",
+                           form=form)
+
+
+@bp.post("/store", endpoint="store")
+@has_permission(can_edit)
+def add_currency() -> redirect:
+    """Adds a currency.
+
+    :return: The redirection to the currency detail on success, or the currency
+        creation form on error.
+    """
+    form = CurrencyForm(request.form)
+    if not form.validate():
+        for key in form.errors:
+            for error in form.errors[key]:
+                flash(error, "error")
+        session["form"] = urlencode(list(request.form.items()))
+        return redirect(inherit_next(url_for("accounting.currency.create")))
+    currency: Currency = Currency()
+    form.populate_obj(currency)
+    db.session.add(currency)
+    db.session.commit()
+    flash(lazy_gettext("The currency is added successfully"), "success")
+    return redirect(inherit_next(url_for("accounting.currency.detail",
+                                         currency=currency)))
+
+
+@bp.get("/<currency:currency>", endpoint="detail")
+@has_permission(can_view)
+def show_currency_detail(currency: Currency) -> str:
+    """Shows the currency detail.
+
+    :param currency: The currency.
+    :return: The detail.
+    """
+    return render_template("accounting/currency/detail.html", obj=currency)
+
+
+@bp.get("/<currency:currency>/edit", endpoint="edit")
+@has_permission(can_edit)
+def show_currency_edit_form(currency: Currency) -> str:
+    """Shows the form to edit a currency.
+
+    :param currency: The currency.
+    :return: The form to edit the currency.
+    """
+    form: CurrencyForm
+    if "form" in session:
+        form = CurrencyForm(ImmutableMultiDict(parse_qsl(session["form"])))
+        del session["form"]
+        form.validate()
+    else:
+        form = CurrencyForm(obj=currency)
+    return render_template("accounting/currency/edit.html",
+                           currency=currency, form=form)
+
+
+@bp.post("/<currency:currency>/update", endpoint="update")
+@has_permission(can_edit)
+def update_currency(currency: Currency) -> redirect:
+    """Updates a currency.
+
+    :param currency: The currency.
+    :return: The redirection to the currency detail on success, or the currency
+        edit form on error.
+    """
+    form = CurrencyForm(request.form)
+    form.obj_code = currency.code
+    if not form.validate():
+        for key in form.errors:
+            for error in form.errors[key]:
+                flash(error, "error")
+        session["form"] = urlencode(list(request.form.items()))
+        return redirect(inherit_next(url_for("accounting.currency.edit",
+                                             currency=currency)))
+    with db.session.no_autoflush:
+        form.populate_obj(currency)
+    if not currency.is_modified:
+        flash(lazy_gettext("The currency was not modified."), "success")
+        return redirect(inherit_next(url_for("accounting.currency.detail",
+                                             currency=currency)))
+    form.post_update(currency)
+    db.session.commit()
+    flash(lazy_gettext("The currency is updated successfully."), "success")
+    return redirect(inherit_next(url_for("accounting.currency.detail",
+                                         currency=currency)))
+
+
+@bp.post("/<currency:currency>/delete", endpoint="delete")
+@has_permission(can_edit)
+def delete_currency(currency: Currency) -> redirect:
+    """Deletes a currency.
+
+    :param currency: The currency.
+    :return: The redirection to the currency list on success, or the currency
+        detail on error.
+    """
+    currency.delete()
+    db.session.commit()
+    flash(lazy_gettext("The currency is deleted successfully."), "success")
+    return redirect(or_next(url_for("accounting.currency.list")))
+
+
+@api_bp.get("/exists-code", endpoint="exists")
+@has_permission(can_edit)
+def exists_code() -> dict[str, bool]:
+    """Validates whether a currency code exists.
+
+    :return: Whether the currency code exists.
+    """
+    return {"exists": db.session.get(Currency, request.args["q"]) is not None}