endoreg-db 0.3.8__tar.gz → 0.3.10__tar.gz

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: endoreg-db
-Version: 0.3.8
+Version: 0.3.10
 Summary: EndoReg Db Django App
 License: GNU3
 Author: Thomas J. Lux

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/data/__init__.py

@@ -55,6 +55,10 @@ CASE_TEMPLATE_RULE_VALUE_TYPE_DATA_DIR = CASE_TEMPLATE_BASE_DIR / "rule_value_ty
 # NETWORK
 NETWORK_DEVICE_DATA_DIR = DATA_DIR / "network_device"
 NETWORK_DEVICE_TYPE_DATA_DIR = DATA_DIR / "network_device_type"
+AGL_SERVICE_DATA_DIR = DATA_DIR / "agl_service"
+
+# LOGS
+LOG_TYPE_DATA_DIR = DATA_DIR / "log_type"
 
 # To Do
 LAB_VALUE_DATA_DIR = DATA_DIR / "lab_value"

endoreg_db-0.3.10/endoreg_db/data/agl_service/data.yaml

@@ -0,0 +1,19 @@
+- model: endoreg_db.agl_service
+  fields:
+    name: "agl-home-django"
+    description: "AGL Home Django service"
+    devices: [
+      "agl-server-04",
+    ]
+    port: 9100
+    url: "https://home.endo-reg.net/"
+
+- model: endoreg_db.agl_service
+  fields:
+    name: "endoreg-client-manager"
+    description: "AGL Home Django service"
+    devices: [
+      "agl-gpu-client-dev",
+    ]
+    port: 9000
+    url: "https://home.endo-reg.net/"

endoreg_db-0.3.10/endoreg_db/data/log_type/data.yaml

@@ -0,0 +1,57 @@
+- model: endoreg_db.log_type
+  fields:
+    name: 'service-alive'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'service-error'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'service-info'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'service-warning'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'service-status'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'service-task'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'device-alive'
+    description: 'Data log type'
+
+- model: endoreg_db.log_type
+  fields:
+    name: 'device-error'
+    description: 'Data log type'
+
+# device-status
+- model: endoreg_db.log_type
+  fields:
+    name: 'device-status'
+    description: 'Data log type'
+
+# device-task
+- model: endoreg_db.log_type
+  fields:
+    name: 'device-task'
+    description: 'Data log type'
+
+# device-info
+- model: endoreg_db.log_type
+  fields:
+    name: 'device-info'
+    description: 'Data log type'

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/data/network_device/data.yaml

@@ -4,6 +4,12 @@
     device_type: "agl-server"
     ip: "172.16.255.1"
 
+- model: endoreg_db.network_device
+  fields:
+    name: "agl-server-02"
+    device_type: "agl-server"
+    ip: "172.16.255.2"
+
 - model: endoreg_db.network_device
   fields:
     name: "agl-server-03"
@@ -14,4 +20,10 @@
   fields:
     name: "agl-server-04"
     device_type: "agl-server"
-    ip: "172.16.255.4"
+    ip: "172.16.255.4"
+
+- model: endoreg_db.network_device
+  fields:
+    name: "agl-gpu-client-dev"
+    device_type: "agl-gpu-client"
+    ip: "172.16.255.140"

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/data/network_device_type/data.yaml

@@ -6,3 +6,7 @@
 - model: endoreg_db.network_device_type
   fields:
     name: "coloreg-client"
+
+- model: endoreg_db.network_device_type
+  fields:
+    name: "agl-gpu-client"

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/management/commands/load_base_db_data.py

@@ -20,6 +20,10 @@ class Command(BaseCommand):
         self.stdout.write(self.style.SUCCESS("Running load_network_data..."))
         call_command('load_network_data', verbose=verbose)
 
+        # Run the load_logging_data command
+        self.stdout.write(self.style.SUCCESS("Running load_logging_data..."))
+        call_command('load_logging_data', verbose=verbose)
+
         # Run the load_profession_data command
         self.stdout.write(self.style.SUCCESS("Running load_profession_data..."))
         call_command('load_profession_data', verbose=verbose)

endoreg_db-0.3.10/endoreg_db/management/commands/load_logging_data.py

@@ -0,0 +1,39 @@
+from django.core.management.base import BaseCommand
+from endoreg_db.models import LogType as MODEL_0
+from ...utils import load_model_data_from_yaml
+from ...data import LOG_TYPE_DATA_DIR as SOURCE_DIR
+
+IMPORT_MODELS = [ # string as model key, serves as key in IMPORT_METADATA
+    MODEL_0.__name__,
+]
+
+IMPORT_METADATA = {
+    MODEL_0.__name__: {
+        "dir": SOURCE_DIR, # e.g. "interventions"
+        "model": MODEL_0, # e.g. Intervention
+        "foreign_keys": [], # e.g. ["intervention_types"]
+        "foreign_key_models": [] # e.g. [InterventionType]
+    }
+}
+
+class Command(BaseCommand):
+    help = """Load all .yaml files in the data/intervention directory
+    into the Intervention and InterventionType model"""
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            '--verbose',
+            action='store_true',
+            help='Display verbose output',
+        )
+
+    def handle(self, *args, **options):
+        verbose = options['verbose']
+        for model_name in IMPORT_MODELS:
+            _metadata = IMPORT_METADATA[model_name]
+            load_model_data_from_yaml(
+                self,
+                model_name,
+                _metadata,
+                verbose
+            )

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/management/commands/load_network_data.py

@@ -1,14 +1,16 @@
 from django.core.management.base import BaseCommand
-from endoreg_db.models import NetworkDevice, NetworkDeviceType
+from endoreg_db.models import NetworkDevice, NetworkDeviceType, AglService
 from ...utils import load_model_data_from_yaml
-from ...data import NETWORK_DEVICE_DATA_DIR, NETWORK_DEVICE_TYPE_DATA_DIR
+from ...data import NETWORK_DEVICE_DATA_DIR, NETWORK_DEVICE_TYPE_DATA_DIR, AGL_SERVICE_DATA_DIR
 
 MODEL_0 = NetworkDeviceType
 MODEL_1 = NetworkDevice
+MODEL_2 = AglService
 
 IMPORT_MODELS = [ # string as model key, serves as key in IMPORT_METADATA
     MODEL_0.__name__,
-    MODEL_1.__name__
+    MODEL_1.__name__,
+    MODEL_2.__name__,
 ]
 
 IMPORT_METADATA = {
@@ -23,6 +25,12 @@ IMPORT_METADATA = {
         "model": MODEL_1, # e.g. Intervention
         "foreign_keys": ["device_type"], # e.g. ["intervention_types"]
         "foreign_key_models": [NetworkDeviceType] # e.g. [InterventionType]
+    },
+    MODEL_2.__name__: {
+        "dir": AGL_SERVICE_DATA_DIR, # e.g. "interventions"
+        "model": MODEL_2, # e.g. Intervention
+        "foreign_keys": ["devices"], # e.g. ["intervention_types"]
+        "foreign_key_models": [NetworkDevice] # e.g. [InterventionType]
     }
 }
 

endoreg_db-0.3.10/endoreg_db/migrations/0069_delete_networkdevicetypemanager_networkdevice_online.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.15 on 2024-08-10 16:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('endoreg_db', '0068_networkdevicetype_networkdevicetypemanager_and_more'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='NetworkDeviceTypeManager',
+        ),
+        migrations.AddField(
+            model_name='networkdevice',
+            name='online',
+            field=models.BooleanField(default=False),
+        ),
+    ]

endoreg_db-0.3.10/endoreg_db/migrations/0070_logtype_alter_rawpdffile_file_networkdevicelogentry_and_more.py

@@ -0,0 +1,71 @@
+# Generated by Django 4.2.15 on 2024-08-11 19:16
+
+from django.conf import settings
+import django.core.files.storage
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('endoreg_db', '0069_delete_networkdevicetypemanager_networkdevice_online'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='LogType',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255)),
+                ('description', models.CharField(max_length=255)),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('updated', models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                'ordering': ['name'],
+            },
+        ),
+        migrations.AlterField(
+            model_name='rawpdffile',
+            name='file',
+            field=models.FileField(storage=django.core.files.storage.FileSystemStorage(location='/home/agl-admin/agl-monitor/agl_monitor/agl_monitor/erc_data/raw_pdf'), upload_to='raw_pdf/', validators=[django.core.validators.FileExtensionValidator(allowed_extensions=['pdf'])]),
+        ),
+        migrations.CreateModel(
+            name='NetworkDeviceLogEntry',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('timestamp', models.DateTimeField(auto_now_add=True)),
+                ('ip_address', models.GenericIPAddressField(blank=True, null=True)),
+                ('user_agent', models.CharField(blank=True, max_length=256, null=True)),
+                ('message', models.TextField()),
+                ('json_content', models.JSONField(blank=True, null=True)),
+                ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='endoreg_db.networkdevice')),
+                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Network Device Log Entry',
+                'verbose_name_plural': 'Network Device Log Entries',
+            },
+        ),
+        migrations.CreateModel(
+            name='AglService',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255)),
+                ('description', models.CharField(max_length=255)),
+                ('online', models.BooleanField(default=False)),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('updated', models.DateTimeField(auto_now=True)),
+                ('port', models.IntegerField(blank=True, null=True)),
+                ('protocol', models.CharField(blank=True, max_length=255, null=True)),
+                ('url', models.URLField(blank=True, null=True)),
+                ('devices', models.ManyToManyField(related_name='services', to='endoreg_db.networkdevice')),
+            ],
+            options={
+                'ordering': ['name'],
+            },
+        ),
+    ]

endoreg_db-0.3.10/endoreg_db/migrations/0071_aglservicelogentry.py

@@ -0,0 +1,33 @@
+# Generated by Django 4.2.15 on 2024-08-11 19:19
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('endoreg_db', '0070_logtype_alter_rawpdffile_file_networkdevicelogentry_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AglServiceLogEntry',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('timestamp', models.DateTimeField(auto_now_add=True)),
+                ('ip_address', models.GenericIPAddressField(blank=True, null=True)),
+                ('user_agent', models.CharField(blank=True, max_length=256, null=True)),
+                ('message', models.TextField()),
+                ('json_content', models.JSONField(blank=True, null=True)),
+                ('service', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='endoreg_db.aglservice')),
+                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'AGL Service Log Entry',
+                'verbose_name_plural': 'AGL Service Log Entries',
+            },
+        ),
+    ]

endoreg_db-0.3.10/endoreg_db/migrations/0072_alter_rawpdffile_file.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.15 on 2024-08-11 19:52
+
+import django.core.files.storage
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('endoreg_db', '0071_aglservicelogentry'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='rawpdffile',
+            name='file',
+            field=models.FileField(storage=django.core.files.storage.FileSystemStorage(location='/mnt/hdd-sensitive/Pseudo/import/pdf'), upload_to='raw_pdf/', validators=[django.core.validators.FileExtensionValidator(allowed_extensions=['pdf'])]),
+        ),
+    ]

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/models/__init__.py

@@ -5,6 +5,7 @@ from .report_reader import ReportReaderConfig, ReportReaderFlag
 from .emission import *
 from .persons import *
 from .network import *
+from .logging import *
 
 from .case_template import *
 # from .other.distribution import (

endoreg_db-0.3.10/endoreg_db/models/logging/__init__.py

@@ -0,0 +1,4 @@
+from .base import AbstractLogEntry
+from .network_device import NetworkDeviceLogEntry
+from .log_type import LogType
+from .agl_service import AglServiceLogEntry

endoreg_db-0.3.10/endoreg_db/models/logging/agl_service.py

@@ -0,0 +1,18 @@
+from django.db import models
+from .base import AbstractLogEntry
+
+class AglServiceLogEntry(AbstractLogEntry):
+    """
+    Model for log entries related to AGL services.
+    """
+    service = models.ForeignKey("AglService", on_delete=models.CASCADE)
+    device = models.ForeignKey(
+        "NetworkDevice", on_delete=models.CASCADE, null=True, blank=True
+    )
+
+    class Meta:
+        verbose_name = "AGL Service Log Entry"
+        verbose_name_plural = "AGL Service Log Entries"
+
+    def __str__(self):
+        return f"{self.timestamp} - {self.user} - {self.ip_address} - {self.service} - {self.message}"

endoreg_db-0.3.10/endoreg_db/models/logging/base.py

@@ -0,0 +1,22 @@
+# django model for logging, first define an abstract base model
+from django.db import models
+from django.conf import settings
+
+class AbstractLogEntry(models.Model):
+    """
+    Abstract base model for log entries.
+    """
+
+    class Meta:
+        abstract = True
+
+    timestamp = models.DateTimeField(auto_now_add=True)
+    user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True, blank=True)
+    ip_address = models.GenericIPAddressField(null=True, blank=True)
+    user_agent = models.CharField(max_length=256, null=True, blank=True)
+    message = models.TextField()
+    json_content = models.JSONField(null=True, blank=True)
+    
+
+    def __str__(self):
+        return f"{self.timestamp} - {self.user} - {self.ip_address} - {self.message}"

endoreg_db-0.3.10/endoreg_db/models/logging/log_type.py

@@ -0,0 +1,23 @@
+from django.db import models
+
+class LogTypeManager(models.Manager):
+    # Custom manager for LogType; defines name as natural key
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+
+class LogType(models.Model):
+    name = models.CharField(max_length=255)
+    description = models.CharField(max_length=255)
+    created = models.DateTimeField(auto_now_add=True)
+    updated = models.DateTimeField(auto_now=True)
+    objects = LogTypeManager()
+    
+    def __str__(self):
+        return self.name
+    
+    class Meta:
+        ordering = ['name']
+        
+    def natural_key(self):
+        return (self.name,)

endoreg_db-0.3.10/endoreg_db/models/logging/network_device.py

@@ -0,0 +1,16 @@
+from django.db import models
+from .base import AbstractLogEntry
+
+class NetworkDeviceLogEntry(AbstractLogEntry):
+    """
+    Model for log entries related to network devices.
+    """
+    device = models.ForeignKey("NetworkDevice", on_delete=models.CASCADE)
+
+    class Meta:
+        verbose_name = "Network Device Log Entry"
+        verbose_name_plural = "Network Device Log Entries"
+
+    def __str__(self):
+        return f"{self.timestamp} - {self.user} - {self.ip_address} - {self.device} - {self.message}"
+

endoreg_db-0.3.10/endoreg_db/models/network/__init__.py

@@ -0,0 +1,3 @@
+from .network_device import NetworkDevice
+from .network_device_type import NetworkDeviceType
+from .agl_service import AglService

endoreg_db-0.3.10/endoreg_db/models/network/agl_service.py

@@ -0,0 +1,38 @@
+from django.db import models
+
+class AglServiceManager(models.Manager):
+    # Custom manager for AglService; defines name as natural key
+    def get_by_natural_key(self, name):
+        return self.get(name=name)
+    
+class AglService(models.Model):
+    name = models.CharField(max_length=255)
+    description = models.CharField(max_length=255)
+    online = models.BooleanField(default=False)
+    created = models.DateTimeField(auto_now_add=True)
+    updated = models.DateTimeField(auto_now=True)
+    objects = AglServiceManager()
+    devices = models.ManyToManyField("NetworkDevice", related_name="services")
+    port = models.IntegerField(blank=True, null=True)
+    protocol = models.CharField(max_length=255, blank=True, null=True)
+    url = models.URLField(blank=True, null=True)
+
+    def alive_log(self, user, ip_address, user_agent):
+        from ..logging import AglServiceLogEntry
+        AglServiceLogEntry.objects.create(
+            user=user,
+            ip_address=ip_address,
+            user_agent=user_agent,
+            message=f"Service {self.name} is alive.",
+            service=self
+        )
+
+    def __str__(self):
+        return self.name
+
+    class Meta:
+        ordering = ['name']
+        
+    def natural_key(self):
+        return (self.name,)
+    

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/endoreg_db/models/network/network_device.py

@@ -12,6 +12,7 @@ class NetworkDevice(models.Model):
     ip = models.GenericIPAddressField(blank=True, null=True)
     description = models.CharField(max_length=255)
     device_type = models.ForeignKey("NetworkDeviceType", on_delete=models.CASCADE)
+    online = models.BooleanField(default=False)
     created = models.DateTimeField(auto_now_add=True)
     updated = models.DateTimeField(auto_now=True)
     objects = NetworkDeviceManager()
@@ -24,4 +25,29 @@ class NetworkDevice(models.Model):
         ordering = ['name']
         
     def natural_key(self):
-        return (self.name,)
+        return (self.name,)
+    
+    def ping(self):
+        target_ip = self.ip
+
+        # Import the required module
+        import subprocess
+
+        # Define the command
+        command = ['ping', '-c', '1', target_ip]
+
+        # Run the command
+        process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+
+        # Wait for the process to terminate
+        process.wait()
+
+        # Check the return code
+        return_code = process.returncode
+        
+        # Return True if the return code is 0, False otherwise
+        self.online = return_code == 0
+        self.save()
+        return self.online
+    
+

{endoreg_db-0.3.8 → endoreg_db-0.3.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "endoreg-db"
-version = "0.3.8"
+version = "0.3.10"
 description = "EndoReg Db Django App"
 authors = ["Thomas J. Lux"]
 license = "GNU3"

endoreg_db-0.3.8/endoreg_db/models/network/__init__.py

@@ -1,2 +0,0 @@
-from .network_device import NetworkDevice
-from .network_device_type import NetworkDeviceType