refactor: add a simple config file to extensions

It makes possible to automagically keep the extensions admin page updated.

lnbits/__init__.py

@@ -10,7 +10,7 @@ from . import bolt11
 from .core import core_app
 from .db import init_databases, open_db
 from .extensions.withdraw import withdraw_ext
-from .helpers import megajson
+from .helpers import ExtensionManager, megajson
 from .settings import WALLET, DEFAULT_USER_WALLET_NAME, FEE_RESERVE
 
 
@@ -33,6 +33,7 @@ Talisman(
 )
 
 # filters
+app.jinja_env.globals["EXTENSIONS"] = [ext for ext in ExtensionManager().extensions if ext.is_valid]
 app.jinja_env.filters["megajson"] = megajson
 
 # blueprints

lnbits/db.py

@@ -1,6 +1,7 @@
 import os
 import sqlite3
 
+from .helpers import ExtensionManager
 from .settings import LNBITS_PATH, LNBITS_DATA_FOLDER
 
 
@@ -50,8 +51,8 @@ def init_databases() -> None:
         ("database", os.path.join(LNBITS_PATH, "data", "schema.sql")),
     ]
 
-    for extension in [x[1] for x in os.walk(os.path.join(LNBITS_PATH, "extensions"))][0]:
+    for extension in ExtensionManager().extensions:
-        schemas.append((f"ext_{extension}", os.path.join(LNBITS_PATH, "extensions", extension, "schema.sql")))
+        schemas.append((f"ext_{extension.code}", os.path.join(extension.path, "schema.sql")))
 
     for schema in [s for s in schemas if os.path.exists(s[1])]:
         with open_db(schema[0]) as db:

lnbits/extensions/withdraw/config.json

@@ -0,0 +1,5 @@
+{
+    "name": "LNURLw",
+    "short_description": "Make LNURL withdraw links.",
+    "ion_icon": "beer"
+}

lnbits/helpers.py

@@ -1,6 +1,41 @@
 import json
+import os
 import sqlite3
 
+from types import SimpleNamespace
+from typing import List
+
+from .settings import LNBITS_PATH
+
+
+class ExtensionManager:
+    def __init__(self):
+        self._extension_folders: List[str] = [x[1] for x in os.walk(os.path.join(LNBITS_PATH, "extensions"))][0]
+
+    @property
+    def extensions(self) -> List[SimpleNamespace]:
+        output = []
+
+        for extension in self._extension_folders:
+            try:
+                with open(os.path.join(LNBITS_PATH, "extensions", extension, "config.json")) as json_file:
+                    config = json.load(json_file)
+                is_valid = True
+            except Exception:
+                config = {}
+                is_valid = False
+
+            output.append(SimpleNamespace(**{
+                **{
+                    "code": extension,
+                    "is_valid": is_valid,
+                    "path": os.path.join(LNBITS_PATH, "extensions", extension),
+                },
+                **config
+            }))
+
+        return output
+
 
 class MegaEncoder(json.JSONEncoder):
     def default(self, obj):

lnbits/templates/extensions.html

@@ -1,164 +1,118 @@
 <!-- @format -->
 
-{% extends "base.html" %} {% block messages %}
+{% extends "base.html" %}
-<a href="#" class="dropdown-toggle" data-toggle="dropdown">
+
-  <i class="fa fa-bell-o"></i>
+
-  <span class="label label-danger">!</span>
+{% block messages %}
-</a>
+	<a href="#" class="dropdown-toggle" data-toggle="dropdown">
-<ul class="dropdown-menu">
+		<i class="fa fa-bell-o"></i>
-  <li class="header"><b>Instant wallet, bookmark to save</b></li>
+		<span class="label label-danger">!</span>
-  <li></li>
+	</a>
-</ul>
+	<ul class="dropdown-menu">
-{% endblock %} {% block menuitems %}
+		<li class="header"><b>Instant wallet, bookmark to save</b></li>
-<li class="treeview">
+		<li></li>
-  <a href="#">
+	</ul>
-    <i class="fa fa-bitcoin"></i> <span>Wallets</span>
+{% endblock %}
-    <i class="fa fa-angle-left pull-right"></i>
-  </a>
-  <ul class="treeview-menu">
-    {% for w in user_wallets %}
-    <li>
-      <a href="wallet?wal={{ w.id }}&usr={{ w.user }}"
-        ><i class="fa fa-bolt"></i> {{ w.name }}</a
-      >
-    </li>
-    {% endfor %}
-    <li><a onclick="sidebarmake()">Add a wallet +</a></li>
-    <div id="sidebarmake"></div>
-  </ul>
-</li>
-
-<li class="active treeview">
-  <a href="#">
-    <i class="fa fa-th"></i> <span>Extensions</span>
-    <i class="fa fa-angle-left pull-right"></i>
-  </a>
-    <ul class="treeview-menu">
-
-
-    {% if "lnevents" in user_ext %}
-    <li>
-      <a href="lnevents?usr={{ user }}"
-        ><i class="fa fa-plus"></i> LNEvents</a>
-    </li>
-    {% endif %}
-
-    {% if "lnjoust" in user_ext %}
-    <li>
-      <a href="lnjoust?usr={{ user }}"
-        ><i class="fa fa-plus"></i> LNJoust</a>
-    </li>
-    {% endif %}
-
-    {% if "withdraw" in user_ext %}
-    <li>
-      <a href="withdraw?usr={{ user }}"
-        ><i class="fa fa-plus"></i> LNURLw</a>
-    </li>
-    {% endif %}
-            <li>
-      <a href="extensions?usr={{ user }}"
-        >Manager </a>
-    </li>
-
 
-  </ul>
+{% block menuitems %}
-</li>
+	<li class="treeview">
+		<a href="#">
+			<i class="fa fa-bitcoin"></i> <span>Wallets</span>
+			<i class="fa fa-angle-left pull-right"></i>
+		</a>
+		<ul class="treeview-menu">
+			{% for w in user_wallets %}
+			<li>
+			<a href="{{ url_for('wallet') }}?wal={{ w.id }}&usr={{ w.user }}"
+				><i class="fa fa-bolt"></i> {{ w.name }}</a
+			>
+			</li>
+			{% endfor %}
+			<li><a onclick="sidebarmake()">Add a wallet +</a></li>
+			<div id="sidebarmake"></div>
+		</ul>
+	</li>
+	<li class="active treeview">
+		<a href="#">
+			<i class="fa fa-th"></i> <span>Extensions</span>
+			<i class="fa fa-angle-left pull-right"></i>
+		</a>
+		<ul class="treeview-menu">
+			{% for extension in EXTENSIONS %}
+				{% if extension.code in user_ext %}
+					<li>
+						<a href="{{ url_for(extension.code + '.index') }}?usr={{ user }}"><i class="fa fa-plus"></i> {{ extension.name }}</a>
+					</li>
+				{% endif %}
+			{% endfor %}
+			<li>
+			<a href="{{ url_for('extensions') }}?usr={{ user }}">Manager </a></li>
+		</ul>
+	</li>
+{% endblock %}
 
-{% endblock %} {% block body %}
+{% block body %}
 <!-- Right side column. Contains the navbar and content of the page -->
 <div class="content-wrapper">
-  <!-- Content Header (Page header) -->
-  <section class="content-header">
-    <h1>
-      Wallet
-      <small
-        >Control panel
-        <div id="wonga"></div
-      ></small>
-    </h1>
-    <ol class="breadcrumb">
-      <li>
-        <a href="#"><i class="fa fa-dashboard"></i> Home</a>
-      </li>
-      <li class="active">Extensions</li>
-
-    </ol>
-    <br /><br />
-    <div class="alert alert-danger alert-dismissable">
-      <h4>
-        Bookmark to save your wallet. Wallet is in BETA, use with caution.
-      </h4>
-    </div>
-  </section>
-
-  <!-- Main content -->
-  <section class="content">
-    <!-- Small boxes (Stat box) -->
-    <div class="row">
-
-        {% if "withdraw" not in user_ext %}
-            <div class="col-lg-3 col-xs-6">
-              <!-- small box -->
-              <div class="small-box bg-blue">
-                <div class="inner">
-                  <h3>
-                    LNURLw
-                  </h3>
-                  <p>
-                    Make LNURL withdraw links
-                  </p>
-                </div>
-                <div class="icon">
-                  <i class="ion ion-beer"></i>
-                </div>
-                <a href="extensions?usr={{user}}&enable=withdraw" class="small-box-footer">
-                  Activate <i class="fa fa-arrow-circle-right"></i>
-                </a>
-              </div>
-            </div><!-- ./col -->
-         {% else %}
-
-            <div class="col-lg-3 col-xs-6">
-              <!-- small box -->
 
-              <div class="small-box bg-blue">
+	<!-- Content Header (Page header) -->
-
+	<section class="content-header">
-                <div class="inner">
+		<div id="wonga"></div>
-                   <a href="withdraw?usr={{user}}" style="color: inherit;">
+		<h1>Wallet <small>Control panel</small></h1>
-                  <h3>
+		<ol class="breadcrumb">
-                    LNURLw
+			<li>
-                  </h3>
+				<a href="#"><i class="fa fa-dashboard"></i> Home</a>
-                  <p>
+			</li>
-                    Make LNURL withdraw links
+			<li class="active">Extensions</li>
-                  </p>
+		</ol>
-
+
-                </div>
+		<br />
-                <div class="icon">
+		<br />
-
+
-                  <i class="ion ion-beer"></i>
+		<div class="alert alert-danger alert-dismissable">
-
+			<h4>Bookmark to save your wallet. Wallet is in BETA, use with caution.</h4>
-                </div>
+		</div>
-              </a>
+	</section>
-                <a href="extensions?usr={{user}}&disable=withdraw" class="small-box-footer">
+
-                  Deactivate <i class="fa fa-arrow-circle-right"></i>
+	<!-- Main content -->
-                </a>
+	<section class="content">
-
+		<!-- Small boxes (Stat box) -->
-              </div>
+		<div class="row">
-
+
-            </div><!-- ./col -->
+		{% for extension in EXTENSIONS %}
-
+			<div class="col-lg-3 col-xs-6">
-          {% endif %}
+				<!-- small box -->
-    </div>
+				<div class="small-box bg-blue">
-
+					<div class="inner">
-    <!-- /.content -->
+						{% if extension.code in user_ext %}
-  </section>
+							<a href="{{ url_for(extension.code + '.index') }}?usr={{ user }}" style="color: inherit">
-
+						{% endif %}
-  <script>
+						<h3>{{ extension.name }}</h3>
-    window.user = {{ user | megajson | safe }}
+						<p>{{ extension.short_description }}</p>
-    window.user_wallets = {{ user_wallets | megajson | safe }}
+						{% if extension.code in user_ext %}
-    window.user_ext = {{ user_ext | megajson | safe }}
+							</a>
-
+						{% endif %}
-  </script>
+					</div>
+					<div class="icon">
+						<i class="ion ion-{{ extension.ion_icon }}"></i>
+					</div>
+					{% if extension.code in user_ext %}
+						<a href="{{ url_for('extensions') }}?usr={{user}}&disable={{ extension.code }}" class="small-box-footer">Disable <i class="fa fa-arrow-circle-right"></i></a>
+					{% else %}
+						<a href="{{ url_for('extensions') }}?usr={{user}}&enable={{ extension.code }}" class="small-box-footer">Enable <i class="fa fa-arrow-circle-right"></i></a>
+					{% endif %}
+				</div>
+			</div>
+		{% endfor %}
+
+		</div>
+	<!-- /.content -->
+  	</section>
 </div>
+
+<script>
+	window.user = {{ user | megajson | safe }}
+	window.user_wallets = {{ user_wallets | megajson | safe }}
+	window.user_ext = {{ user_ext | megajson | safe }}
+</script>
 {% endblock %}