db4e 0.16.0__py3-none-any.whl

db4e/App.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+
+# db4e/App.py
+
+#   Database 4 Everything
+#   Author: Nadim-Daniel Ghaznavi 
+#   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+#   License: GPL 3.0
+
+import os
+import sys
+from dataclasses import dataclass, field, fields
+from importlib import metadata
+from textual.app import App
+from textual.theme import Theme as TextualTheme
+from textual.widgets import Footer
+from textual.containers import Vertical
+from rich.theme import Theme as RichTheme
+from rich.traceback import Traceback
+
+try:
+    __package_name__ = metadata.metadata(__package__ or __name__)["Name"]
+    __version__ = metadata.version(__package__ or __name__)
+except Exception:
+    __package_name__ = "Db4E"
+    __version__ = "N/A"
+
+
+from db4e.Widgets.TopBar import TopBar
+from db4e.Widgets.Clock import Clock
+from db4e.Widgets.DetailPane import DetailPane
+from db4e.Widgets.NavPane import NavPane
+from db4e.Modules.ConfigMgr import ConfigMgr, Config
+from db4e.Modules.DeploymentMgr import DeploymentMgr
+from db4e.Modules.PaneCatalogue import PaneCatalogue
+from db4e.Modules.PaneMgr import PaneMgr
+from db4e.Modules.InstallMgr import InstallMgr
+from db4e.Messages.SubmitFormData import SubmitFormData
+from db4e.Messages.SwitchPane import SwitchPane
+from db4e.Messages.UpdateTopBar import UpdateTopBar
+from db4e.Messages.RefreshNavPane import RefreshNavPane
+from db4e.Messages.NavLeafSelected import NavLeafSelected
+
+RICH_THEME =RichTheme(
+    {
+        "white": "#e9e9e9",
+        "green": "#54efae",
+        "yellow": "#f6ff8f",
+        "dark_yellow": "#e6d733",
+        "red": "#fd8383",
+        "purple": "#b565f3",
+        "dark_gray": "#969aad",
+        "b dark_gray": "b #969aad",
+        "highlight": "#91abec",
+        "label": "#c5c7d2",
+        "b label": "b #c5c7d2",
+        "light_blue": "#bbc8e8",
+        "b white": "b #e9e9e9",
+        "b highlight": "b #91abec",
+        "b light_blue": "b #bbc8e8",
+        "recording": "#ff5e5e",
+        "b recording": "b #ff5e5e",
+        "panel_border": "#6171a6",
+        "table_border": "#333f62",
+    }
+)
+TEXTUAL_THEME = TextualTheme(
+    name="custom",
+    primary="white",
+    variables={
+        "white": "#e9e9e9",
+        "green": "#54efae",
+        "yellow": "#f6ff8f",
+        "dark_yellow": "#e6d733",
+        "red": "#fd8383",
+        "purple": "#b565f3",
+        "dark_gray": "#969aad",
+        "b_dark_gray": "b #969aad",
+        "highlight": "#91abec",
+        "label": "#c5c7d2",
+        "b_label": "b #c5c7d2",
+        "light_blue": "#bbc8e8",
+        "b_white": "b #e9e9e9",
+        "b_highlight": "b #91abec",
+        "b_light_blue": "b #bbc8e8",
+        "recording": "#ff5e5e",
+        "b_recording": "b #ff5e5e",
+        "panel_border": "#6171a6",
+        "table_border": "#333f62",
+    },
+)
+class Db4EApp(App):
+    TITLE = "Db4E"
+    CSS_PATH = "Db4E.tcss"
+
+    def __init__(self, config: Config, **kwargs):
+        super().__init__(**kwargs)
+        self.config = config
+        self.depl_mgr = DeploymentMgr(config)
+        self.install_mgr = InstallMgr(config)
+        self.pane_catalogue = PaneCatalogue()
+        self.initialized_flag = True if self.depl_mgr.is_initialized() else False
+        self.pane_mgr = PaneMgr(
+            config=config, catalogue=self.pane_catalogue, initialized_flag=self.initialized_flag)
+        
+        # Setup the themes
+        theme = RICH_THEME
+        self.console.push_theme(theme)
+        self.console.set_window_title(self.TITLE)
+        theme = TEXTUAL_THEME
+        self.register_theme(theme)
+        self.theme = "custom"
+
+    def compose(self):
+        self.topbar = TopBar(app_version=__version__)
+        yield self.topbar
+        yield Vertical(
+            NavPane(initialized=self.initialized_flag),
+            Clock()
+        )
+        yield self.pane_mgr
+
+    ### Message handling happens here...
+
+    # Every form sends it's data here, we need to route the messages
+    async def on_submit_form_data(self, message: SubmitFormData) -> None:
+        target_module = message.form_data['to_module']
+        target_method = message.form_data['to_method']
+
+        if target_module == 'InstallMgr':
+            if target_method == 'initial_setup':
+                results = await self.install_mgr.initial_setup(message.form_data)
+                self.pane_mgr.set_pane(name="InstallResults", data=results)
+
+    # The individual Detail panes use this to update the TopBar
+    async def on_update_top_bar(self, message: UpdateTopBar) -> None:
+        self.topbar.set_state(title=message.title, sub_title=message.sub_title )
+
+    # This is how the Detail panes is selected and loaded, including any data
+    async def on_switch_pane(self, message: SwitchPane) -> None:
+        self.pane_mgr.set_pane(message.pane_name, message.data)
+
+    # NavPane selections are routed here
+    async def on_nav_leaf_selected(self, message: NavLeafSelected) -> None:
+        category = message.parent
+        instance = message.leaf
+        print(f"Got it: {repr(category)}/{repr(instance)}")
+        if category == 'Deployments' and instance == 'Db4E Core':
+            db4e_data = self.depl_mgr.get_deployment('db4e')
+            print(f"db4e_data: {db4e_data}")
+            self.pane_mgr.set_pane(name="Db4E", data=db4e_data)
+
+    def _handle_exception(self, error: Exception) -> None:
+        self.bell()
+        self.exit(message=Traceback(show_locals=True, width=None, locals_max_length=5))
+
+def main():
+    # Set environment variables for better color support
+    os.environ["TERM"] = "xterm-256color"
+    os.environ["COLORTERM"] = "truecolor"
+
+    config_manager = ConfigMgr(__version__)
+    config = config_manager.get_config()
+    app = Db4EApp(config)
+    app.run()
+
+if __name__ == "__main__":
+    main()

db4e/Db4E.tcss

@@ -0,0 +1,104 @@
+/* Root screen layout */
+Screen {
+    layout: grid;
+    grid-size: 2;
+    grid-columns: 1fr 4fr;
+    grid-rows: 13fr 1fr;
+    grid-gutter: 0 1;
+}
+
+Clock {
+    height: 3;
+    padding: 0 2;
+    border: round;
+    align: center middle;
+    background: black;
+}
+
+DetailPane {
+    height: 1fr;
+    padding: 0 2;
+    border: round;
+    row-span: 2;
+    background: black;
+}
+
+Db4E,
+Welcome,
+InstallResults {
+    padding: 0 2;
+    border: round;
+    background: black;
+}
+
+NavPane {
+    height: 9fr;
+    padding: 0 2;
+    border: round;
+    background: black;
+}
+
+TopBar {
+    height: 3;
+    padding: 0 2;
+    border: round;
+    dock: top;
+    background: black
+}
+
+#labeled_input_label {
+    align: right middle;
+    height: 1;
+    width: 25;
+}
+
+#topbar_title {
+    content-align: center middle;
+    width: 100%;
+}
+
+#tree_deployments {
+    height: auto;
+}
+
+#tree_metrics {
+    height: auto;
+}
+
+#initial_setup_form {
+    height: 5;
+    border: round;
+}
+#initial_setup_db4e_group_label {
+    padding: 0 1;
+    width: 23;
+}
+#initial_setup_vendor_dir_label {
+    padding: 0 1;
+    width: 23;
+}
+#initial_setup_user_wallet_label {
+    padding: 0 1;
+    width: 23;
+}
+#initial_setup_db4e_group_input {
+    width: 10;
+}
+#initial_setup_vendor_dir_input {
+    width: 30;
+}
+#initial_setup_user_wallet_input {
+    width: 75;
+}
+
+.form_intro {
+    border: round;
+}
+
+Button {
+    align: center middle;
+    height: 3;
+    border: round;
+    width: 20;
+}
+

db4e/Messages/NavLeafSelected.py

@@ -0,0 +1,21 @@
+"""
+db4e/Messages/NavLeafSelected.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+
+Usage example:
+    await self.post_message(NavLeafSelected(self)
+"""
+
+from textual.widget import Widget
+from textual.message import Message
+
+class NavLeafSelected(Message):
+    def __init__(self, sender: Widget, parent: str, leaf: str) -> None:
+        super().__init__()
+        self.sender = sender
+        self.leaf = str(leaf)
+        self.parent = str(parent)

db4e/Messages/RefreshNavPane.py

@@ -0,0 +1,19 @@
+"""
+db4e/Messages/RefreshNavPane.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+
+Usage example:
+    await self.post_message(RefreshNavPane(self)
+"""
+
+from textual.widget import Widget
+from textual.message import Message
+
+class RefreshNavPane(Message):
+    def __init__(self, sender: Widget) -> None:
+        super().__init__()
+        self.sender = sender

db4e/Messages/SubmitFormData.py

@@ -0,0 +1,19 @@
+"""
+db4e/Messages/SubmitFormData.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+
+Usage example:
+    await self.post_message(SubmitFormData(self, resultData))
+"""
+
+from textual.widget import Widget
+from textual.message import Message
+
+class SubmitFormData(Message):
+    def __init__(self, sender: Widget, form_data: dict) -> None:
+        super().__init__()
+        self.form_data = form_data

db4e/Messages/SwitchPane.py

@@ -0,0 +1,21 @@
+"""
+db4e/Messages/SwitchPane.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+
+Usage example: 
+    await self.post_message(SwitchPane(self, "InstallResults", results))
+"""
+
+from textual.widget import Widget
+from textual.message import Message
+
+class SwitchPane(Message):
+    def __init__(self, sender: Widget, pane_name: str, data: dict = None):
+        super().__init__()
+        self.pane_name = str(pane_name)
+        self.data = data
+

db4e/Messages/UpdateTopBar.py

@@ -0,0 +1,20 @@
+"""
+db4e/Messages/UpdateTopBar.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+
+Usage example:
+    await self.post_message(UpdateTopBar(self, "Database 4 Everything ", "Welcome"))
+"""
+
+from textual.widget import Widget
+from textual.message import Message
+
+class UpdateTopBar(Message):
+    def __init__(self, sender: Widget, title: str, sub_title: str) -> None:
+        super().__init__()
+        self.title = title
+        self.sub_title = sub_title

db4e/Modules/ConfigMgr.py

@@ -0,0 +1,112 @@
+"""
+db4e/Modules/ConfigManager.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+"""
+
+import sys
+import argparse
+
+class ConfigMgr:
+    def __init__(self, app_version: str):
+        parser = argparse.ArgumentParser(description="Db4E command line switches")
+        parser.add_argument("-b", "--backup", action="store_true", help="Perform a db4e backup.")
+        parser.add_argument("-s", "--service", action="store_true", help="Run db4e as a service.")
+        parser.add_argument("-v", "--version", action="store_true", help="Print the db4e version.")
+        args = parser.parse_args()
+
+        ini = Config(app_version=app_version)
+        if args.backup:
+            ini.config['db4e']['op'] = 'run_backup'
+        elif args.service:
+            ini.config['db4e']['op'] = 'run_daemon'
+        elif args.version:
+            print(f'Db4e v{app_version}')
+            sys.exit(0)
+        else:
+            ini.config['db4e']['op'] = 'run_ui'
+        self.ini = ini
+
+    def get_config(self):
+        return self.ini
+    
+class Config:
+    def __init__(self, app_version: str):
+        self.config = {
+            'db4e': {
+                'app_version': app_version,
+                'op': 'run_ui',
+                'api_dir': 'api',
+                'bin_dir': 'bin',
+                'conf_dir': 'conf',
+                'db4e_dir': 'db4e',
+                'desc': 'Database 4 Everything',
+                'dev_dir': 'dev',
+                'log_dir': 'logs',
+                'process': 'db4e.sh',
+                'pypi_repository': 'https://pypi.org/pypi/db4e/json',
+                'refresh_interval': 15,
+                'run_dir': 'run',
+                'service_file': 'db4e.service', 
+                'setup_script': 'db4e-initial-setup.sh',
+                'service_install_script': 'db4e-install-service.sh',
+                'service_log_file': 'db4e.log',
+                'service_uninstaller': 'db4e-uninstall-service.sh',
+                'src_dir': 'src',
+                'systemd_dir': 'systemd',
+                'template_dir': 'Templates',
+                'vendor_dir': 'vendor',
+            },
+            'db': {
+                'backup_dir': 'backups',
+                'backup_script':'db4e-backup.sh',
+                'collection': 'mining',
+                'depl_collection': 'depl',
+                'log_collection': 'logging',
+                # How many days of data to keep in the logging collection
+                'log_retention_days': 7,
+                'max_backups': 7,
+                'metrics_collection': 'metrics',
+                'name': 'db4e',
+                'port': 27017,
+                'retry_timeout': 15,
+                'server': 'localhost',
+            },
+            'monerod': {
+                'blockchain_dir': 'monero-blockchain',
+                'config': 'monerod.ini',
+                'desc': 'Monero Blockchain Daemon',
+                'log_file': 'monerod.log',
+                'process': 'monerod',
+                'service_file': 'monerod@.service',
+                'socket_file': 'monerod@.socket',
+                'stdin_pipe': 'monerod.stdin',
+                'start_script': 'start-monerod.sh',
+                'version': '0.18.4.0',
+            },
+            'p2pool': {
+                'config': 'p2pool.ini',
+                'desc': 'P2Pool Daemon',
+                'log_file': 'p2pool.log',
+                'process': 'p2pool',
+                'service_file': 'p2pool@.service',
+                'socket_file': 'p2pool@.socket',
+                'start_script': 'start-p2pool.sh',
+                'stdin': 'p2pool.stdin',
+                'version': '4.8',                
+            },
+            'xmrig': {
+                'desc': 'XMRig Miner',
+                'conf_dir': 'conf',
+                'config': 'config.json',
+                'permissions': '-rwsr-x---',
+                'process': 'xmrig',
+                'service_file': 'xmrig@.service',
+                'version': '6.23.0',
+            }
+        }
+
+

db4e/Modules/DbMgr.py

@@ -0,0 +1,94 @@
+"""
+db4e/Modules/DbManager.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+"""
+
+import time
+from pymongo import MongoClient
+from pymongo.errors import ConnectionFailure, CollectionInvalid
+
+from db4e.Modules.ConfigMgr import Config
+from db4e.Templates.db.Deployment import DB4E_RECORD
+
+class DbMgr:
+    
+   def __init__(self, config: Config):
+      self.ini = config
+      # MongoDB settings
+      retry_timeout            = self.ini.config['db']['retry_timeout']
+      db_server                = self.ini.config['db']['server']
+      db_port                  = self.ini.config['db']['port']
+      self.max_backups         = self.ini.config['db']['max_backups']
+      self.db_name             = self.ini.config['db']['name']
+      self.db_collection       = self.ini.config['db']['collection']
+      self.depl_collection     = self.ini.config['db']['depl_collection']
+      self.log_collection      = self.ini.config['db']['log_collection']
+      self.log_retention       = self.ini.config['db']['log_retention_days']
+      self.metrics_collection  = self.ini.config['db']['metrics_collection']
+      # TODO Setup logging
+      #self.log = Db4eLogger('Db4eDb')
+
+      # Connect to MongoDB
+      db_uri = f'mongodb://{db_server}:{db_port}'
+      try:
+         self._client = MongoClient(db_uri)
+      except ConnectionFailure as e:
+         # TODO factor in the old Db4eLogger code....
+         #self.log.critical(f'Connection failed: {e}. Retrying in {retry_timeout} seconds...')
+         time.sleep(retry_timeout)
+      
+      self.db4e = self._client[self.db_name]
+
+      # Used for backups
+      self.db4e_dir = None
+      self.repo_dir = None
+      self.init_db()             
+
+   def ensure_indexes(self):
+      log_col = self.get_collection(self.log_collection)
+      if "timestamp_1" not in log_col.index_information():
+         log_col.create_index("timestamp")
+         # TODO self.log.debug("Created index on 'timestamp' for log collection.")
+
+   def find_one(self, col_name, filter):
+      col = self.get_collection(col_name)
+      return col.find_one(filter)
+
+   def get_collection(self, col_name):
+      return self.db4e[col_name]
+
+   def get_new_rec(self, rec_type):
+      if rec_type == 'db4e':
+         return DB4E_RECORD
+
+   def init_db(self):
+      # Make sure the 'db4e' database, core collections and indexes exist.
+      db_col = self.db_collection
+      log_col = self.log_collection
+      depl_col = self.depl_collection
+      metrics_col = self.metrics_collection
+      db_col_names = self.db4e.list_collection_names()
+      for aCol in [ db_col, log_col, depl_col, metrics_col ]:
+         if aCol not in db_col_names:
+            try:
+               self.db4e.create_collection(aCol)
+               if aCol == log_col:
+                  log_col = self.get_collection(log_col)
+                  log_col.create_index('timestamp')
+            except CollectionInvalid:
+               # TODO self.log.warning(f"Attempted to create existing collection: {aCol}")
+               pass
+            # TODO self.log.debug(f'Created DB collection ({aCol})')
+         self.ensure_indexes()
+
+   def insert_one(self, col_name, jdoc):
+      collection = self.get_collection(col_name)
+      return collection.insert_one(jdoc)
+   
+   def update_one(self, col_name, filter, new_values):
+      collection = self.get_collection(col_name)
+      return collection.update_one(filter, {'$set' : new_values})

db4e/Modules/DeploymentMgr.py

@@ -0,0 +1,74 @@
+"""
+db4e/Modules/DeploymentManager.py
+
+   Database 4 Everything
+   Author: Nadim-Daniel Ghaznavi 
+   Copyright (c) 2024-2025 NadimGhaznavi <https://github.com/NadimGhaznavi/db4e>
+   License: GPL 3.0
+"""
+
+import os, shutil
+from datetime import datetime, timezone
+import getpass
+
+from db4e.Modules.ConfigMgr import Config
+from db4e.Modules.DbMgr import DbMgr
+
+# The Mongo collection that houses the deployment records
+DEPL_COL = 'depl'
+
+class DeploymentMgr:
+    
+   def __init__(self, config: Config):
+      self.ini = config
+      self.db = DbMgr(config)
+      self.col_name = DEPL_COL
+
+   def add_deployment(self, rec):
+      rec['doc_type'] = 'deployment'
+      rec['updated'] = datetime.now(timezone.utc)
+      # Get the component version from the static YAML config file
+      if rec['component'] == 'db4e':
+         rec['user'] = getpass.getuser()
+      else:
+         rec['version'] = self.ini.config[rec['component']]['version']
+      self.db.insert_one(self.col_name, rec)
+
+   def is_initialized(self):
+      rec = self.db.find_one(self.col_name, {'doc_type': 'deployment', 'component': 'db4e'})
+      if rec:
+         return True
+      else:
+         return False
+
+   def get_deployment(self, component):
+      print(f"DeploymentMgr:get_deployment(): {component}")
+      # Ask the db for the component record
+      db_rec = self.db.find_one(self.col_name, {'doc_type': 'deployment', 'component': component})
+      # rec is a cursor object.
+      if db_rec:
+         rec = {}
+         component = db_rec['component']
+         if component == 'db4e':
+            rec['group'] = db_rec['group']
+            rec['install_dir'] = db_rec['install_dir']
+            rec['user'] = db_rec['user']
+            rec['user_wallet'] = db_rec['user_wallet']
+            rec['vendor_dir'] = db_rec['vendor_dir']
+         return rec
+      # No record for this deployment exists
+
+      # Check if this is the first time the app has been run
+      rec = self.db.find_one(self.col_name, {'doc_type': 'deployment', 'component': 'db4e'})
+      if not rec:
+         return False
+        
+   def get_deployment_by_instance(self, component, instance):
+      if instance == 'db4e core':
+         return self.get_deployment('db4e')
+      
+   def update_deployent(self, rec):
+      component = rec['component']
+      if component == 'db4e':
+         filter = {'doc_type': 'deployment', 'component': 'db4e'}
+         self.db.update_one(self.col_name, filter, rec)