feat: use keyvalue for persistent values

Author: Abdur-rahmaanJ

pythoncms/app.py

@@ -36,7 +36,7 @@
 
 from shopyo_admin import MyAdminIndexView
 from shopyo_admin import DefaultModelView
-from modules.box__default.settings.models import Settings
+from modules.box__default.keyvalue.models import KeyValue
 from init import db
 
 
@@ -141,7 +141,7 @@ def setup_flask_admin(app):
         template_mode="bootstrap4",
         index_view=MyAdminIndexView(),
     )
-    admin.add_view(DefaultModelView(Settings, db.session))
+    admin.add_view(DefaultModelView(KeyValue, db.session))
     admin.add_link(MenuLink(name="Logout", category="", url="/auth/logout?next=/admin"))
 
 

pythoncms/conftest.py

@@ -13,7 +13,7 @@
 from flask_login import current_user as _current_user
 from init import db as _db
 from modules.box__default.auth.models import User
-from modules.box__default.settings.models import Settings
+from modules.box__default.keyvalue.models import Settings
 from sqlalchemy import event
 
 # run in shopyo/shopyo

pythoncms/modules/box__default/info/templates/info/dashboard.html

@@ -13,7 +13,7 @@
             Site title<br>
             <input 
             class="form-control"
-            name="site_title" value="{{get_setting('SITE_TITLE')}}">
+            name="site_title" value="{{get_value('SITE_TITLE')}}">
             <br>
             Site description<br>
             <textarea 
@@ -23,7 +23,7 @@
                 name="site_description" 
                 class="form-control"
 
-                >{{get_setting('SITE_DESCRIPTION')}}</textarea>
+                >{{get_value('SITE_DESCRIPTION')}}</textarea>
             <br>
             <input type="hidden" name="csrf_token" value="{{csrf_token()}}" 
             >

pythoncms/modules/box__default/info/view.py

@@ -20,14 +20,14 @@
 #     context.update({"pages": pages})
 #     return render_template("page/all_pages.html", **context)
 
-from modules.box__default.settings.helpers import set_setting
-from modules.box__default.settings.helpers import get_setting
+from modules.box__default.keyvalue.helpers import set_value
+from modules.box__default.keyvalue.helpers import get_value
 
 @module_blueprint.route(mhelp.info["dashboard"], methods=['POST', 'GET'])
 @login_required
 def index():
     if request.method == 'POST':
         print(request.form)
-        set_setting('SITE_TITLE', request.form['site_title'])
-        set_setting('SITE_DESCRIPTION', request.form['site_description'])
-    return mhelp.render('dashboard.html', get_setting=get_setting)
+        set_value('SITE_TITLE', request.form['site_title'])
+        set_value('SITE_DESCRIPTION', request.form['site_description'])
+    return mhelp.render('dashboard.html', get_value=get_value)

…odules/box__default/settings/__init__.py …odules/box__default/keyvalue/__init__.pypythoncms/modules/box__default/settings/__init__.py renamed to pythoncms/modules/box__default/keyvalue/__init__.py pythoncms/modules/box__default/settings/__init__.py renamed to pythoncms/modules/box__default/keyvalue/__init__.py

@@ -0,0 +1,3 @@
+from .helpers import *
+
+available_everywhere = {"get_value": get_value}

pythoncms/modules/box__default/keyvalue/global.py

@@ -0,0 +1,34 @@
+from .models import KeyValue
+from init import db
+
+def set_value(key, value):
+    keyvalue = KeyValue.query.filter(KeyValue.key == key).first()
+    if keyvalue:
+        keyvalue.value = value
+        keyvalue.update()
+    else:
+        s = KeyValue(key=key,value=value)
+        db.session.add(s)
+        db.session.commit()
+
+
+def get_value(key):
+    """
+    Used as key-value lookup from KeyValue table
+
+    Parameters
+    ----------
+    name: str
+        name of key
+
+    Returns
+    -------
+    str
+        value of key
+    """
+    s = KeyValue.query.filter(KeyValue.key == key).first()
+
+    if s:
+        return s.value
+    else:
+        return ''

pythoncms/modules/box__default/keyvalue/helpers.py

@@ -1,11 +1,11 @@
 {
-	"display_string": "Settings",
+	"display_string": "KeyValue",
 	"type": "hide",
 	"icons":{
 		"fa": "fa fa-envelope",
 		"boxicons": "bx bxs-leaf",
 		"file": "icon.svg"
 	},
-	"url_prefix": "/settings",
-	"module_name": "settings"
+	"url_prefix": "/keyvalue",
+	"module_name": "keyvalue"
 }

…/modules/box__default/settings/info.json …/modules/box__default/keyvalue/info.jsonpythoncms/modules/box__default/settings/info.json renamed to pythoncms/modules/box__default/keyvalue/info.json pythoncms/modules/box__default/settings/info.json renamed to pythoncms/modules/box__default/keyvalue/info.json

@@ -1,11 +1,11 @@
 from init import db
 
 
-class Settings(db.Model):
-    __tablename__ = "settings"
+class KeyValue(db.Model):
+    __tablename__ = "keyvalue"
     id = db.Column(db.Integer, primary_key=True)
 
-    setting = db.Column(db.String(100), unique=True)
+    key = db.Column(db.String(100), unique=True)
     value = db.Column(db.String(100))
 
     def add(self):