Merge pull request #37 from codekitchen-community/settings-page

Add settings page to manager

Author: tkzt

manager/fw_manager/__init__.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from datetime import datetime
 
 from flask_bootstrap import Bootstrap5
 from flask import Flask
@@ -20,4 +21,10 @@ def create_app():
     db.init_app(app)
     blueprints.init_app(app)
 
+    @app.context_processor
+    def make_template_context():
+        return dict(
+            year=datetime.now().year,
+        )
+
     return app

manager/fw_manager/blueprints/manager.py

@@ -1,5 +1,4 @@
 import os.path
-from datetime import datetime
 from pathlib import Path
 from uuid import uuid4
 
@@ -12,12 +11,13 @@
 from werkzeug.security import check_password_hash
 
 from ..utils import make_resp
-from ..models import User, Image, db
-from ..forms import UploadImageForm, EditImageForm
+from ..models import User, Image, Site, db
+from ..forms import UploadImageForm, EditImageForm, SettingsForm
 
 IMG_FOLDER = os.environ.get("IMG_FOLDER_NAME", "img")
 THUMBNAIL_FOLDER = os.environ.get("THUMBNAIL_FOLDER_NAME", "thumbnail")
 THUMBNAIL_MAX_WIDTH = int(os.environ.get("THUMBNAIL_MAX_WIDTH", 600))
+DEFAULT_NO_IMAGE_TIP = os.environ.get("DEFAULT_NO_IMAGE_TIP", "No image.")
 
 
 manager_bp = Blueprint("manager", __name__)
@@ -69,12 +69,29 @@ def images_page():
     return render_template(
         "manager.html",
         pagination=pagination,
-        year=datetime.now().year,
         add_form=UploadImageForm(),
         edit_form=EditImageForm(),
     )
 
 
+@manager_bp.route("/settings", methods=["GET", "POST"])
+@auth.login_required
+def settings_page():
+    form = SettingsForm()
+    site = Site.query.first()
+    if form.validate_on_submit():
+        site.title = form.site_title.data
+        site.description = form.site_description.data
+        site.no_image_tip = form.no_image_tip.data
+        db.session.commit()
+        return redirect(url_for(".images_page"))
+    if request.method == "GET":
+        form.site_title.data = site.title
+        form.site_description.data = site.description
+        form.no_image_tip.data = site.no_image_tip or DEFAULT_NO_IMAGE_TIP
+    return render_template("settings.html", form=form)
+
+
 @manager_bp.post("/images")
 @auth.login_required
 def add_image():

manager/fw_manager/blueprints/retriever.py

@@ -1,6 +1,6 @@
 from flask import request, Blueprint
 
-from ..models import Image
+from ..models import db, Image, Site
 
 
 retriever_bp = Blueprint("retriever", __name__)
@@ -15,4 +15,12 @@ def get_images():
         page=page, per_page=page_size, error_out=False
     )
     images = [p.as_dict() for p in pagination.items]
-    return {"images": images, "pages": pagination.pages, "total": pagination.total}
+    site = db.session.scalar(db.select(Site))
+    return {
+        "images": images,
+        "pages": pagination.pages,
+        "total": pagination.total,
+        "site_title": site.title,
+        "site_description": site.description,
+        "no_image_tip": site.no_image_tip,
+    }

manager/fw_manager/commands.py

@@ -2,7 +2,7 @@
 from flask import Flask
 from werkzeug.security import generate_password_hash
 
-from .models import db, User
+from .models import db, User, Site
 
 
 @click.command(name="create-tables")
@@ -27,6 +27,8 @@ def create_tables(username, password) -> None:
         click.echo("Creating admin...")
         user = User(username=username, password_hash=generate_password_hash(password))
         db.session.add(user)
+    site = Site(title="Fine Weather")
+    db.session.add(site)
     click.echo("Done.")
     db.session.commit()
 

manager/fw_manager/forms.py

@@ -1,6 +1,6 @@
 from flask_wtf import FlaskForm
 from flask_wtf.file import FileRequired
-from wtforms.fields.simple import StringField, FileField
+from wtforms.fields.simple import StringField, FileField, SubmitField, TextAreaField
 from wtforms.validators import InputRequired, Length
 
 ALLOWED_IMAGE_TYPES = ["jpeg", "gif", "png"]
@@ -31,3 +31,19 @@ class EditImageForm(FlaskForm):
     position = StringField("Position")
     description = StringField("Description")
     time = StringField("Time")
+
+
+class SettingsForm(FlaskForm):
+    site_title = StringField(
+        "Site title",
+        validators=[InputRequired(), Length(1, 100)],
+    )
+    site_description = TextAreaField(
+        "Site description",
+        validators=[InputRequired(), Length(1, 1000)],
+    )
+    no_image_tip = TextAreaField(
+        "Tips to show when no image",
+        validators=[InputRequired(), Length(1, 500)],
+    )
+    submit = SubmitField("Submit")

manager/fw_manager/models.py

@@ -61,6 +61,12 @@ class User(Base):
     password_hash: so.Mapped[str]
 
 
+class Site(Base):
+    title: so.Mapped[str]
+    description: so.Mapped[Optional[str]]
+    no_image_tip: so.Mapped[Optional[str]]
+
+
 class Image(Base):
     uri: so.Mapped[str] = so.mapped_column(unique=True)
     thumbnail_uri: so.Mapped[str]

manager/fw_manager/templates/base.html

@@ -0,0 +1,77 @@
+{% from 'bootstrap5/utils.html' import render_icon %}
+{% from 'bootstrap5/form.html' import render_form %}
+{% from 'bootstrap5/pagination.html' import render_pagination %}
+{% from 'bootstrap5/nav.html' import render_nav_item %}
+<!doctype html>
+<html lang="en">
+
+<head>
+    {% block head %}
+    <!-- Required meta tags -->
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+    {% block styles %}
+    <!-- Bootstrap CSS -->
+    {{ bootstrap.load_css() }}
+    <style>
+        html {
+            height: 100%;
+        }
+
+        body {
+            min-height: 100%;
+        }
+
+        .img-thumbnail {
+            height: 50px;
+        }
+
+        .toast-header .badge {
+            width: 16px;
+            height: 16px;
+        }
+    </style>
+    {% endblock %}
+
+    <title>{% block title %}FineWeather Manager{% endblock %}</title>
+    <link rel="shortcut icon" href="{{ url_for('static', filename='favicon.svg') }}">
+    {% endblock %}
+</head>
+
+<body class="bg-light d-flex flex-column">
+    <div class="container-lg mt-3 mb-4">
+    <nav class="navbar navbar-expand-lg navbar-dark" style="background-color: #4c1d9575;">
+        <div class="container-fluid">
+          <a class="navbar-brand" href="#">FineWeather Manager</a>
+          <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
+            <span class="navbar-toggler-icon"></span>
+          </button>
+          <div class="collapse navbar-collapse" id="navbarSupportedContent">
+            <ul class="navbar-nav me-auto mb-2 mb-lg-0">
+              {{ render_nav_item('manager.images_page', 'Home') }}
+              {{ render_nav_item('manager.settings_page', 'Settings') }}
+            </ul>
+          </div>
+        </div>
+    </nav>
+    </div>
+    {% block content %}
+    {% endblock %}
+    
+    {% block scripts %}
+    <!-- Optional JavaScript -->
+    {{ bootstrap.load_js() }}
+    {% endblock %}
+</body>
+
+<footer
+    class="d-flex flex-wrap justify-content-between align-items-center py-3 my-2 flex-grow-0">
+    <div class="m-auto">
+        <p class="text-muted">
+            &copy; {{ year }} CodeKitchen Community
+        </p>
+    </div>
+</footer>
+
+</html>