FabOMatic 0.4.2__py3-none-any.whl

FabOMatic/__init__.py

@@ -0,0 +1 @@
+from .__main__ import start

FabOMatic/__main__.py

@@ -0,0 +1,85 @@
+"""Main module of the backend."""
+
+import logging
+import threading
+from time import sleep
+
+from FabOMatic.database.DatabaseBackend import DatabaseBackend
+from FabOMatic.mqtt.MQTTInterface import MQTTInterface
+from FabOMatic.logic.MsgMapper import MsgMapper
+from FabOMatic.logger import configure_logger
+
+
+class Backend:
+    """Backend class."""
+
+    def __init__(self, config_file: str = None):
+        if config_file is None:
+            self._db = DatabaseBackend()
+            self._mqtt = MQTTInterface()
+        else:
+            self._db = DatabaseBackend(config_file)
+            self._mqtt = MQTTInterface(config_file)
+
+        self._mapper = MsgMapper(self._mqtt, self._db)
+        self._mapper.registerHandlers()
+        self._flaskThread = None
+
+    def connect(self) -> bool:
+        """Connect to the MQTT broker and the database."""
+        try:
+            session = self._db.getSession()
+            logging.info(f"Session info: {session.info}")
+            self._db.createAndUpdateDatabase()
+            self._mqtt.connect()
+            return True
+        except Exception as ex:
+            logging.error("Connection failed: %s", ex, exc_info=True)
+            return False
+
+    @property
+    def connected(self) -> bool:
+        """Check if the MQTT broker is connected."""
+        return self._mqtt.connected
+
+    def disconnect(self):
+        """Disconnect from the MQTT broker"""
+        self._mqtt.disconnect()
+
+    def publishStats(self):
+        self._mqtt.publishStats()
+
+
+_flaskThread: threading.Thread = None
+
+
+def _startApp() -> None:
+    from FabOMatic.web.webapplication import app
+
+    app.run(host="0.0.0.0", port=23336, debug=True, use_reloader=False, ssl_context="adhoc")
+
+
+def startServer() -> None:
+    global _flaskThread
+    _flaskThread = threading.Thread(target=lambda: _startApp(), daemon=True)
+    _flaskThread.start()
+
+
+def start(loglevel):
+    """Main function of the backend."""
+    configure_logger(loglevel)
+    logging.info("Starting backend...")
+    back = Backend()
+    startServer()
+
+    while True:
+        if not back.connected:
+            if not back.connect():
+                logging.error("Failed to connect to Database or MQTT broker")
+        else:
+            back.publishStats()
+        sleep(5)
+
+
+if __name__ == "__main__":
+    start(10)

FabOMatic/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

FabOMatic/alembic/env.py

@@ -0,0 +1,78 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+from FabOMatic.database.DatabaseBackend import getDatabaseUrl
+from alembic import context
+from FabOMatic.database import models
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None and config.attributes.get("configure_logger", True):
+    fileConfig(config.config_file_name, disable_existing_loggers=False)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = models.Base.metadata
+
+print("Using database=", config.get_main_option("sqlalchemy.url"))
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section, {}),
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(connection=connection, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

FabOMatic/alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

FabOMatic/alembic/versions/123b2cca325f_added_boards_table.py

@@ -0,0 +1,38 @@
+"""Added Boards table
+
+Revision ID: 123b2cca325f
+Revises: 88feb1b31a1f
+Create Date: 2024-02-20 23:00:47.808587
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = '123b2cca325f'
+down_revision: Union[str, None] = '88feb1b31a1f'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('boards',
+    sa.Column('board_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('machine_id', sa.Integer(), nullable=False),
+    sa.Column('ip_address', sa.String(), nullable=False),
+    sa.Column('fw_version', sa.String(), nullable=False),
+    sa.Column('last_seen', sa.Float(), nullable=False),
+    sa.ForeignKeyConstraint(['machine_id'], ['machines.machine_id'], ),
+    sa.PrimaryKeyConstraint('board_id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('boards')
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/2dc275252e0e_initial_database_creation.py

@@ -0,0 +1,135 @@
+"""Initial database creation
+
+Revision ID: 2dc275252e0e
+Revises: 
+Create Date: 2024-01-28 16:25:31.644671
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = '2dc275252e0e'
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('machine_types',
+    sa.Column('type_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('type_name', sa.String(), nullable=False),
+    sa.Column('type_timeout_min', sa.Integer(), nullable=False),
+    sa.PrimaryKeyConstraint('type_id'),
+    sa.UniqueConstraint('type_name')
+    )
+    op.create_index('idx_machine_types_type_name_unique', 'machine_types', ['type_name'], unique=True)
+    op.create_table('roles',
+    sa.Column('role_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('role_name', sa.String(), nullable=False),
+    sa.Column('authorize_all', sa.Boolean(), nullable=False),
+    sa.Column('reserved', sa.Boolean(), nullable=False),
+    sa.Column('maintenance', sa.Boolean(), nullable=False),
+    sa.Column('backend_admin', sa.Boolean(), nullable=False),
+    sa.PrimaryKeyConstraint('role_id'),
+    sa.UniqueConstraint('role_name')
+    )
+    op.create_index('idx_roles_role_name_unique', 'roles', ['role_name'], unique=True)
+    op.create_table('machines',
+    sa.Column('machine_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('machine_name', sa.String(), nullable=False),
+    sa.Column('machine_type_id', sa.Integer(), nullable=True),
+    sa.Column('machine_hours', sa.Float(), nullable=False),
+    sa.Column('blocked', sa.Boolean(), nullable=False),
+    sa.Column('last_seen', sa.Float(), nullable=True),
+    sa.ForeignKeyConstraint(['machine_type_id'], ['machine_types.type_id'], ),
+    sa.PrimaryKeyConstraint('machine_id'),
+    sa.UniqueConstraint('machine_name')
+    )
+    op.create_index('idx_machines_machine_name_unique', 'machines', ['machine_name'], unique=True)
+    op.create_table('users',
+    sa.Column('user_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('name', sa.String(), nullable=False),
+    sa.Column('surname', sa.String(), nullable=False),
+    sa.Column('role_id', sa.Integer(), nullable=False),
+    sa.Column('card_UUID', sa.String(), nullable=True),
+    sa.Column('disabled', sa.Boolean(), nullable=False),
+    sa.Column('deleted', sa.Boolean(), nullable=False),
+    sa.Column('password_hash', sa.String(length=128), nullable=True),
+    sa.Column('email', sa.String(), nullable=True),
+    sa.ForeignKeyConstraint(['role_id'], ['roles.role_id'], ),
+    sa.PrimaryKeyConstraint('user_id'),
+    sa.UniqueConstraint('card_UUID')
+    )
+    op.create_index('idx_users_card_UUID_unique', 'users', ['card_UUID'], unique=True)
+    op.create_table('authorizations',
+    sa.Column('authorization_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('user_id', sa.Integer(), nullable=False),
+    sa.Column('machine_id', sa.Integer(), nullable=False),
+    sa.ForeignKeyConstraint(['machine_id'], ['machines.machine_id'], ),
+    sa.ForeignKeyConstraint(['user_id'], ['users.user_id'], ),
+    sa.PrimaryKeyConstraint('authorization_id'),
+    sa.UniqueConstraint('user_id', 'machine_id', name='uix_1')
+    )
+    op.create_table('maintenances',
+    sa.Column('maintenance_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('hours_between', sa.Float(), nullable=False),
+    sa.Column('description', sa.String(), nullable=False),
+    sa.Column('machine_id', sa.Integer(), nullable=False),
+    sa.Column('attachment', sa.String(), nullable=True),
+    sa.ForeignKeyConstraint(['machine_id'], ['machines.machine_id'], ),
+    sa.PrimaryKeyConstraint('maintenance_id')
+    )
+    op.create_table('unknown_cards',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('card_UUID', sa.String(), nullable=False),
+    sa.Column('timestamp', sa.Float(), nullable=False),
+    sa.Column('machine_id', sa.Integer(), nullable=False),
+    sa.ForeignKeyConstraint(['machine_id'], ['machines.machine_id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_table('uses',
+    sa.Column('use_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('user_id', sa.Integer(), nullable=False),
+    sa.Column('machine_id', sa.Integer(), nullable=False),
+    sa.Column('start_timestamp', sa.Float(), nullable=False),
+    sa.Column('last_seen', sa.Float(), nullable=False),
+    sa.Column('end_timestamp', sa.Float(), nullable=True),
+    sa.ForeignKeyConstraint(['machine_id'], ['machines.machine_id'], ),
+    sa.ForeignKeyConstraint(['user_id'], ['users.user_id'], ),
+    sa.PrimaryKeyConstraint('use_id')
+    )
+    op.create_table('interventions',
+    sa.Column('intervention_id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('maintenance_id', sa.Integer(), nullable=False),
+    sa.Column('machine_id', sa.Integer(), nullable=False),
+    sa.Column('user_id', sa.Integer(), nullable=False),
+    sa.Column('timestamp', sa.Float(), nullable=False),
+    sa.ForeignKeyConstraint(['machine_id'], ['machines.machine_id'], ),
+    sa.ForeignKeyConstraint(['maintenance_id'], ['maintenances.maintenance_id'], ),
+    sa.ForeignKeyConstraint(['user_id'], ['users.user_id'], ),
+    sa.PrimaryKeyConstraint('intervention_id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('interventions')
+    op.drop_table('uses')
+    op.drop_table('unknown_cards')
+    op.drop_table('maintenances')
+    op.drop_table('authorizations')
+    op.drop_index('idx_users_card_UUID_unique', table_name='users')
+    op.drop_table('users')
+    op.drop_index('idx_machines_machine_name_unique', table_name='machines')
+    op.drop_table('machines')
+    op.drop_index('idx_roles_role_name_unique', table_name='roles')
+    op.drop_table('roles')
+    op.drop_index('idx_machine_types_type_name_unique', table_name='machine_types')
+    op.drop_table('machine_types')
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/3cb12dfd8d6e_maintenance_added_short_lcd_message.py

@@ -0,0 +1,30 @@
+"""Maintenance: added short lcd message
+
+Revision ID: 3cb12dfd8d6e
+Revises: e544554c7d29
+Create Date: 2024-04-24 22:17:20.179783
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = '3cb12dfd8d6e'
+down_revision: Union[str, None] = 'e544554c7d29'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('maintenances', sa.Column('lcd_message', sa.String(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('maintenances', 'lcd_message')
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/3f3f601505a6_added_replay_columns_for_use_and_.py

@@ -0,0 +1,33 @@
+"""Added replay columns for Use and Intervention
+
+Revision ID: 3f3f601505a6
+Revises: dfd2b0db0016
+Create Date: 2024-05-30 23:09:40.723754
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "3f3f601505a6"
+down_revision: Union[str, None] = "dfd2b0db0016"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("interventions", sa.Column("replay", sa.Boolean(), nullable=True))
+    op.add_column("uses", sa.Column("replay", sa.Boolean(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("uses", "replay")
+    op.drop_column("interventions", "replay")
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/88feb1b31a1f_added_grace_period_column_on_machinetype.py

@@ -0,0 +1,32 @@
+"""Added grace period column on MachineType
+
+Revision ID: 88feb1b31a1f
+Revises: 2dc275252e0e
+Create Date: 2024-02-18 21:20:47.213287
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "88feb1b31a1f"
+down_revision: Union[str, None] = "2dc275252e0e"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("machine_types", sa.Column("grace_period_min", sa.Integer(), nullable=True))
+    # ### end Alembic commands ###
+    op.execute("UPDATE machine_types SET grace_period_min=2 WHERE grace_period_min IS NULL")
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("machine_types", "grace_period_min")
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/aa9ed3e094d5_maintenance_added_url_field_and_removed_.py

@@ -0,0 +1,60 @@
+"""Maintenance: added URL field and removed attachments.
+
+Revision ID: aa9ed3e094d5
+Revises: 3cb12dfd8d6e
+Create Date: 2024-04-24 22:39:03.511051
+
+"""
+
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "aa9ed3e094d5"
+down_revision: Union[str, None] = "3cb12dfd8d6e"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+from alembic import op
+from sqlalchemy import engine_from_config
+from sqlalchemy import inspect
+
+
+def _table_has_column(table, column):
+    config = op.get_context().config
+    engine = engine_from_config(config.get_section(config.config_ini_section), prefix="sqlalchemy.")
+    insp = inspect(engine)
+    has_column = False
+    for col in insp.get_columns(table):
+        if column not in col["name"]:
+            continue
+        has_column = True
+    return has_column
+
+
+def _is_sqllite():
+    return op.get_context().dialect.name == "sqlite"
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    if not _table_has_column("maintenances", "instructions_url"):
+        op.add_column("maintenances", sa.Column("instructions_url", sa.String(), nullable=True))
+    if _table_has_column("maintenances", "attachment"):
+        if not _is_sqllite():
+            op.drop_column("maintenances", "attachment")
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    if _table_has_column("maintenances", "instructions_url"):
+        if not _is_sqllite():
+            op.drop_column("maintenances", "instructions_url")
+
+    if not _table_has_column("maintenances", "attachment"):
+        op.add_column("maintenances", sa.Column("attachment", sa.String(), nullable=True))
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/dfd2b0db0016_machine_types_added_possibility_to_.py

@@ -0,0 +1,30 @@
+"""Machine types: added possibility to disable authorization
+
+Revision ID: dfd2b0db0016
+Revises: aa9ed3e094d5
+Create Date: 2024-05-05 20:27:50.705509
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'dfd2b0db0016'
+down_revision: Union[str, None] = 'aa9ed3e094d5'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('machine_types', sa.Column('access_management', sa.Integer(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('machine_types', 'access_management')
+    # ### end Alembic commands ###

FabOMatic/alembic/versions/e544554c7d29_boards_added_columns_for_serial_number_.py

@@ -0,0 +1,32 @@
+"""Boards: added columns for serial number and free heap
+
+Revision ID: e544554c7d29
+Revises: 123b2cca325f
+Create Date: 2024-04-21 13:24:54.520194
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'e544554c7d29'
+down_revision: Union[str, None] = '123b2cca325f'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('boards', sa.Column('serial', sa.String(), nullable=True))
+    op.add_column('boards', sa.Column('heap', sa.Integer(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('boards', 'heap')
+    op.drop_column('boards', 'serial')
+    # ### end Alembic commands ###

FabOMatic/babel.cfg

@@ -0,0 +1,3 @@
+[python: **.py]
+
+[jinja2: **/templates/**.html]

FabOMatic/conf/settings.toml

@@ -0,0 +1,24 @@
+[database]
+url = "sqlite:///database.sqldb"    # Database source. Will be seeded if empty.
+name = "fablab"                     # Name of the database
+
+[MQTT]
+broker = "fabpi"            # Name / IP of the MQTT broker
+port = 1883                 # MQTT broker port
+client_id = "backend-3"     # MQTT Client name
+topic = "machine"           # Machine topic to be monitored. All subtopics with <topic>/<ID> will be subscribed. Do not include leading or trailing slashes.
+reply_subtopic = "/reply"   # appended to the <topic>/<id> for replies by backend. E.g. machine/1/reply
+stats_topic = "stats"       # Stats will be published in this topic on MQTT server.
+user = ""                   # Auth not used
+
+[web]
+secret_key = "ç°32è+3242039ikòlòà"              # Used for encryption by Flask. Change it to a random string.
+default_admin_email = "admin@fablab.org"        # Email of the admin, used for 1st login and seeding.
+
+
+[email]
+server = "smtp.google.com"
+port = 587
+use_tls = true
+username = ""
+password = ""