From c062c70a81a9bca0923c0b3f6453577cb898448d Mon Sep 17 00:00:00 2001 From: "Byron H." Date: Tue, 26 Sep 2023 00:36:41 -0500 Subject: [PATCH 1/3] =?UTF-8?q?Allow=20to=20create=20custom=20pages=20and?= =?UTF-8?q?=20add=20them=20to=20the=20menu.=20-=20Sponsor:=20Fundaci=C3=B3?= =?UTF-8?q?n=20Karisma?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 2 + cps/editpage.py | 105 ++++++++++++++++++++++++++++++++++ cps/listpages.py | 40 +++++++++++++ cps/main.py | 6 ++ cps/page.py | 39 +++++++++++++ cps/render_template.py | 14 ++++- cps/templates/admin.html | 1 + cps/templates/edit_page.html | 45 +++++++++++++++ cps/templates/layout.html | 6 ++ cps/templates/list_pages.html | 48 ++++++++++++++++ cps/templates/page.html | 4 ++ cps/ub.py | 13 ++++- 12 files changed, 320 insertions(+), 3 deletions(-) create mode 100644 cps/editpage.py create mode 100644 cps/listpages.py create mode 100644 cps/page.py create mode 100644 cps/templates/edit_page.html create mode 100644 cps/templates/list_pages.html create mode 100644 cps/templates/page.html diff --git a/.gitignore b/.gitignore index ff08f874..eb398718 100644 --- a/.gitignore +++ b/.gitignore @@ -35,3 +35,5 @@ gdrive_credentials client_secrets.json gmail.json /.key + +pages/ diff --git a/cps/editpage.py b/cps/editpage.py new file mode 100644 index 00000000..2664bfc7 --- /dev/null +++ b/cps/editpage.py @@ -0,0 +1,105 @@ +import os +import flask +from flask import Flask, abort, request +from functools import wraps +from pathlib import Path +from flask_login import current_user, login_required + +from .render_template import render_title_template +from . import logger, config, ub +from .constants import CONFIG_DIR as _CONFIG_DIR + +log = logger.create() + +editpage = flask.Blueprint('editpage', __name__) + +def edit_required(f): + @wraps(f) + def inner(*args, **kwargs): + if current_user.role_edit() or current_user.role_admin(): + return f(*args, **kwargs) + abort(403) + + return inner + +def _get_checkbox(dictionary, field, default): + new_value = dictionary.get(field, default) + convertor = lambda y: y == "on" + new_value = convertor(new_value) + + return new_value + +@editpage.route("/admin/page/", methods=["GET", "POST"]) +@login_required +@edit_required +def edit_page(file): + doc = "" + title = "" + name = "" + icon = "file" + is_enabled = True + order = 0 + position = "0" + + page = ub.session.query(ub.Page).filter(ub.Page.id == file).first() + if page: + title = page.title + name = page.name + icon = page.icon + is_enabled = page.is_enabled + order = page.order + position = page.position + + if request.method == "POST": + to_save = request.form.to_dict() + title = to_save.get("title", "").strip() + name = to_save.get("name", "").strip() + icon = to_save.get("icon", "").strip() + position = to_save.get("position", "").strip() + order = to_save.get("order", 0) + order = int(order) + content = to_save.get("content", "").strip() + is_enabled = _get_checkbox(to_save, "is_enabled", True) + + if page: + page.title = title + page.name = name + page.icon = icon + page.is_enabled = is_enabled + page.order = order + page.position = position + ub.session_commit("Page edited {}".format(file)) + else: + new_page = ub.Page(title=title, name=name, icon=icon, is_enabled=is_enabled, order=order, position=position) + ub.session.add(new_page) + ub.session_commit("Page added {}".format(file)) + + if (file == "new"): + file = str(new_page.id) + dir_config_path = os.path.join(_CONFIG_DIR, 'pages') + file_name = Path(name + '.md') + file_path = dir_config_path / file_name + is_path = os.path.exists(dir_config_path) + if not is_path: + try: + os.makedirs(dir_config_path) + except Exception as ex: + log.error(ex) + try: + with open(file_path, 'w') as f: + f.write(content) + f.close() + except Exception as ex: + log.error(ex) + + if file != "new": + dir_config_path = os.path.join(_CONFIG_DIR, 'pages') + file_name = Path(name + '.md') + file_path = dir_config_path / file_name + if file_path.is_file(): + with open(file_path, 'r') as f: + doc = f.read() + else: + doc = "## New file\n\nInformation" + + return render_title_template("edit_page.html", title=title, name=name, icon=icon, is_enabled=is_enabled, order=order, position=position, content=doc, file=file) diff --git a/cps/listpages.py b/cps/listpages.py new file mode 100644 index 00000000..5cfcfa26 --- /dev/null +++ b/cps/listpages.py @@ -0,0 +1,40 @@ +import flask +import json +from flask import make_response,abort +from flask_login import current_user, login_required +from functools import wraps +from flask_babel import gettext as _ + +from .render_template import render_title_template +from . import ub, db + +listpages = flask.Blueprint('listpages', __name__) + +def edit_required(f): + @wraps(f) + def inner(*args, **kwargs): + if current_user.role_edit() or current_user.role_admin(): + return f(*args, **kwargs) + abort(403) + + return inner + +@listpages.route("/admin/pages/", methods=["GET"]) +@login_required +@edit_required +def show_list(): + pages = ub.session.query(ub.Page).order_by(ub.Page.position).order_by(ub.Page.order).all() + + return render_title_template('list_pages.html', title=_("Pages List"), page="book_table", pages=pages) + +@listpages.route("/ajax/listpages") +@login_required +@edit_required +def list_pages(): + pages = ub.session.query(ub.Page).order_by(ub.Page.position).order_by(ub.Page.order).all() + table_entries = {'totalNotFiltered': len(pages), 'total': len(pages), "rows": pages} + js_list = json.dumps(table_entries, cls=db.AlchemyEncoder) + response = make_response(js_list) + response.headers["Content-Type"] = "application/json; charset=utf-8" + + return response diff --git a/cps/main.py b/cps/main.py index 286b2b27..ad990bb7 100644 --- a/cps/main.py +++ b/cps/main.py @@ -36,6 +36,9 @@ def main(): from .gdrive import gdrive from .editbooks import editbook from .about import about + from .page import page + from .listpages import listpages + from .editpage import editpage from .search import search from .search_metadata import meta from .shelf import shelf @@ -65,6 +68,9 @@ def main(): limiter.limit("3/minute",key_func=request_username)(opds) app.register_blueprint(jinjia) app.register_blueprint(about) + app.register_blueprint(page) + app.register_blueprint(listpages) + app.register_blueprint(editpage) app.register_blueprint(shelf) app.register_blueprint(admi) app.register_blueprint(remotelogin) diff --git a/cps/page.py b/cps/page.py new file mode 100644 index 00000000..f4c27419 --- /dev/null +++ b/cps/page.py @@ -0,0 +1,39 @@ +import os +import flask +import markdown +from flask import abort +from pathlib import Path +from flask_babel import gettext as _ + +from . import logger, config, ub +from .render_template import render_title_template +from .constants import CONFIG_DIR as _CONFIG_DIR + +page = flask.Blueprint('page', __name__) + +log = logger.create() + +@page.route('/page/', methods=['GET']) +def get_page(file): + page = ub.session.query(ub.Page)\ + .filter(ub.Page.name == file)\ + .filter(ub.Page.is_enabled)\ + .first() + + if page: + dir_config_path = os.path.join(_CONFIG_DIR, 'pages') + file_name = Path(file + '.md') + file_path = dir_config_path / file_name + + if file_path.is_file(): + with open(file_path, 'r') as f: + temp_md = f.read() + body = markdown.markdown(temp_md) + + return render_title_template('page.html', body=body, title=page.title, page=page.name) + else: + log.error("'%s' was accessed but file doesn't exists." % file) + abort(404) + else: + log.error("'%s' was accessed but is not enabled or it's not in database." % file) + abort(404) diff --git a/cps/render_template.py b/cps/render_template.py index 68b46459..0f6e68ef 100644 --- a/cps/render_template.py +++ b/cps/render_template.py @@ -104,14 +104,24 @@ def get_sidebar_config(kwargs=None): g.shelves_access = ub.session.query(ub.Shelf).filter( or_(ub.Shelf.is_public == 1, ub.Shelf.user_id == current_user.id)).order_by(ub.Shelf.name).all() - return sidebar, simple + top_pages = ub.session.query(ub.Page)\ + .filter(ub.Page.position == "1")\ + .filter(ub.Page.is_enabled)\ + .order_by(ub.Page.order) + bottom_pages = ub.session.query(ub.Page)\ + .filter(ub.Page.position == "0")\ + .filter(ub.Page.is_enabled)\ + .order_by(ub.Page.order) + + return sidebar, simple, top_pages, bottom_pages # Returns the template for rendering and includes the instance name def render_title_template(*args, **kwargs): - sidebar, simple = get_sidebar_config(kwargs) + sidebar, simple, top_pages, bottom_pages = get_sidebar_config(kwargs) try: return render_template(instance=config.config_calibre_web_title, sidebar=sidebar, simple=simple, + top_pages=top_pages, bottom_pages=bottom_pages, accept=constants.EXTENSIONS_UPLOAD, *args, **kwargs) except PermissionError: diff --git a/cps/templates/admin.html b/cps/templates/admin.html index ac124fe8..3f7bf788 100644 --- a/cps/templates/admin.html +++ b/cps/templates/admin.html @@ -159,6 +159,7 @@ {{_('Edit Calibre Database Configuration')}} {{_('Edit Basic Configuration')}} {{_('Edit UI Configuration')}} + {{_('List Pages')}} {% if feature_support['scheduler'] %} diff --git a/cps/templates/edit_page.html b/cps/templates/edit_page.html new file mode 100644 index 00000000..40c7a148 --- /dev/null +++ b/cps/templates/edit_page.html @@ -0,0 +1,45 @@ +{% extends "layout.html" %} +{% block body %} +
+
{{_('Back')}}
+

{{_('Edit page')}}

+
+ +
+ + +
+
+ + +
+
+ + + {{_('Icons list')}} +
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+ + {{_('Cancel')}} +
+
+{% endblock %} \ No newline at end of file diff --git a/cps/templates/layout.html b/cps/templates/layout.html index 1bee1c1d..c4716615 100644 --- a/cps/templates/layout.html +++ b/cps/templates/layout.html @@ -142,6 +142,9 @@
- +
{{_('Cancel')}} -{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/cps/templates/list_pages.html b/cps/templates/list_pages.html index 65ff4064..8527a9eb 100644 --- a/cps/templates/list_pages.html +++ b/cps/templates/list_pages.html @@ -7,30 +7,34 @@ {% block body %}

{{_(title)}}

- - - - - - - - + + + + + + + + + + + {% for page in pages %} - - - - - - + + + + + - - + {% endif %} + + + {% endfor %} +
{{_('Name')}}{{_('Title')}}{{_('Icon')}}{{_('Position')}}{{_('Enabled')}}{{_('Order')}}
{{_('Name')}}{{_('Title')}}{{_('Icon')}}{{_('Position')}}{{_('Enabled')}}{{_('Order')}}
{{page.name}}{{page.title}}{{page.icon}}{{_('bottom') if page.position == "0" else _('top')}} - {% if page.is_enabled %} +
{{page.name}}{{page.title}}{{page.icon}}{{_('bottom') if page.position == "0" else _('top')}} + {% if page.is_enabled %} - {% else %} + {% else %} - {% endif %} - {{page.order}}
{{page.order}}
{{_('New Page')}} {% endblock %} @@ -45,4 +49,4 @@ charset="UTF-8"> {% endif %} -{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/cps/templates/page.html b/cps/templates/page.html index 1d0d8c31..08629931 100644 --- a/cps/templates/page.html +++ b/cps/templates/page.html @@ -1,4 +1,4 @@ {% extends "layout.html" %} {% block body %}
{{body|safe}}
-{% endblock %} \ No newline at end of file +{% endblock %} From ce8c53c11745eac8e1fb32955e6fca49cdeef804 Mon Sep 17 00:00:00 2001 From: Jeremy Fisher Date: Sat, 9 Dec 2023 07:53:02 -0500 Subject: [PATCH 3/3] Add markdown requirement and add missing id for testing --- cps/templates/list_pages.html | 2 +- requirements.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/cps/templates/list_pages.html b/cps/templates/list_pages.html index 8527a9eb..cf89a8f6 100644 --- a/cps/templates/list_pages.html +++ b/cps/templates/list_pages.html @@ -36,7 +36,7 @@ {% endfor %} -{{_('New Page')}} +{{_('New Page')}} {% endblock %} {% block js %} diff --git a/requirements.txt b/requirements.txt index c28f2019..7fd72b4c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -18,3 +18,4 @@ flask-wtf>=0.14.2,<1.3.0 chardet>=3.0.0,<4.1.0 advocate>=1.0.0,<1.1.0 Flask-Limiter>=2.3.0,<3.6.0 +markdown>=3.5.1