✨ Add default projects

Author: jonastahl

backend/config/defaultProjects/Single Year Example.urbs

@@ -48,7 +48,11 @@ def upload(request, project_name):
     if Project.objects.filter(user=request.user, name=project_name).exists():
         return HttpResponse("Project name already exists", status=409)
 
-    config = json.loads(request.body)
+    readConfig(request.user, project_name, json.loads(request.body))
+    return HttpResponse("Project created")
+
+
+def readConfig(user, project_name, config):
     if "CO2 limit" in config["global"]:
         co2limit = config["global"]["CO2 limit"]
     else:
@@ -58,7 +62,7 @@ def upload(request, project_name):
     else:
         costlimit = 35000000000
     project = Project(
-        user=request.user, name=project_name, co2limit=co2limit, costlimit=costlimit
+        user=user, name=project_name, co2limit=co2limit, costlimit=costlimit
     )
     project.save()
 
@@ -96,7 +100,7 @@ def upload(request, project_name):
 
             if "demand" in dataCommodity:
                 demand = Demand(
-                    name="",
+                    name="imported",
                     commodity=commodity,
                     description="",
                     steps=dataCommodity["demand"],
@@ -222,5 +226,3 @@ def upload(request, project_name):
                 steps=dataBuySellPrice,
             )
             buysellprice.save()
-
-    return HttpResponse("Project created")

backend/config/defaultProjectsLoaded/Simple Example.urbs

@@ -163,7 +163,7 @@ def upload(request, project_name):
             site, com = key.split(".")
             demand = Demand(
                 commodity=coms[site][com],
-                name="Sum",
+                name="imported",
                 quantity=1,
                 steps=demand_tab[key].tolist()[1::],
             )

backend/projects/api/configupload.py

@@ -0,0 +1,28 @@
+from django.contrib.auth.models import AbstractUser
+from django.http import HttpResponse, JsonResponse
+
+from projects.api.configupload import readConfig
+from projects.models import Project, DefProjectLoaded, DefProject
+
+
+def initUser(user: AbstractUser):
+    for default in DefProjectLoaded.objects.all():
+        readConfig(user, default.preset.name, default.preset.config)
+
+
+def list_def_projects(_):
+    defs = list(DefProject.objects.order_by("name").values("name").all())
+    return JsonResponse(defs, safe=False)
+
+
+def load_default(request, project_name):
+    preset = DefProject.objects.get(name=project_name)
+
+    if Project.objects.filter(user=request.user, name=project_name).exists():
+        return HttpResponse("A project with this name already exists", status=409)
+    if project_name == "__new":
+        return HttpResponse("Invalid name", status=400)
+
+    readConfig(request.user, project_name, preset.config)
+
+    return HttpResponse("Project created")

backend/projects/api/excelupload.py

@@ -13,6 +13,8 @@
     DefStorage,
     DefSupIm,
     DefDemand,
+    DefProject,
+    DefProjectLoaded,
 )
 
 
@@ -31,8 +33,8 @@ def handle(self, *args, **options):
         demands = {}
 
         for filename in os.listdir(folder_path):
-            if filename.endswith(".json"):
-                file_path = os.path.join(folder_path, filename)
+            file_path = os.path.join(folder_path, filename)
+            if os.path.isfile(file_path) and filename.endswith(".json"):
                 try:
                     with open(file_path, "r") as file:
                         print(f"Loading {filename}... ", end="")
@@ -218,6 +220,53 @@ def handle(self, *args, **options):
             def_demand.save()
             print("\033[92mOK\033[0m")
 
+        DefProject.objects.all().delete()
+        for filename in os.listdir(os.path.join(folder_path, "defaultProjects")):
+            file_path = os.path.join(folder_path, "defaultProjects", filename)
+            if os.path.isfile(file_path) and filename.endswith(".urbs"):
+                try:
+                    with open(file_path, "r") as file:
+                        name = ".".join(filename.split(".")[:-1])
+                        print(f"Loading default project {name}... ", end="")
+                        data = json.load(file)
+
+                        preset = DefProject()
+                        preset.name = name
+                        preset.config = data
+                        preset.save()
+
+                    print("\033[92mOK\033[0m")
+                except Exception as e:
+                    self.stdout.write(
+                        self.style.ERROR(f"Error processing file {filename}: {e}")
+                    )
+                    exit(1)
+
+        for filename in os.listdir(os.path.join(folder_path, "defaultProjectsLoaded")):
+            file_path = os.path.join(folder_path, "defaultProjectsLoaded", filename)
+            if os.path.isfile(file_path) and filename.endswith(".urbs"):
+                try:
+                    with open(file_path, "r") as file:
+                        name = ".".join(filename.split(".")[:-1])
+                        print(f"Loading default project (loaded) {name}... ", end="")
+                        data = json.load(file)
+
+                        preset = DefProject()
+                        preset.name = name
+                        preset.config = data
+                        preset.save()
+
+                        default = DefProjectLoaded()
+                        default.preset = preset
+                        default.save()
+
+                    print("\033[92mOK\033[0m")
+                except Exception as e:
+                    self.stdout.write(
+                        self.style.ERROR(f"Error processing file {filename}: {e}")
+                    )
+                    exit(1)
+
 
 def getDefault(dict, key, default):
     if key in dict:

backend/projects/api/projectpresets.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.1.4 on 2025-07-07 10:48
+
+import django.db.models.deletion
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('projects', '0009_remove_buysellprice_type'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DefProject',
+            fields=[
+                ('name', models.CharField(max_length=255, primary_key=True, serialize=False, unique=True)),
+                ('config', models.JSONField()),
+            ],
+        ),
+        migrations.CreateModel(
+            name='DefProjectLoaded',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ('preset', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='projects.defproject')),
+            ],
+        ),
+    ]

backend/projects/management/commands/load_config.py

@@ -303,3 +303,13 @@ class SimulationResult(models.Model):
     status = models.IntegerField(choices=SimulationResultStatus.choices(), null=True)
     result = models.JSONField(null=True)
     log = models.TextField(null=True)
+
+
+class DefProject(models.Model):
+    name = models.CharField(primary_key=True, max_length=255, null=False, unique=True)
+    config = models.JSONField(null=False)
+
+
+class DefProjectLoaded(models.Model):
+    id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
+    preset = models.ForeignKey(DefProject, on_delete=models.CASCADE, null=False)

backend/projects/migrations/0010_defproject_defprojectloaded.py

@@ -15,6 +15,7 @@
     dsm,
     buysellprice,
     timevareff,
+    projectpresets,
 )
 
 urlpatterns = [
@@ -178,4 +179,13 @@
         "project/<str:project_name>/configupload/",
         configupload.upload,
     ),
+    # default projects
+    path(
+        "def_projects/",
+        projectpresets.list_def_projects,
+    ),
+    path(
+        "def_projects/<str:project_name>/load/",
+        projectpresets.load_default,
+    ),
 ]

backend/projects/models.py

@@ -10,6 +10,8 @@
 from django.views.decorators.csrf import ensure_csrf_cookie
 from django.views.decorators.http import require_POST
 
+from projects.api.projectpresets import initUser
+
 
 def get_csrf(request):
     response = JsonResponse({"detail": "CSRF cookie set"})
@@ -67,7 +69,9 @@ def register(request):
         return JsonResponse({"detail": "Password is too short"}, status=400)
 
     try:
-        User.objects.create_user(**data).save()
+        user = User.objects.create_user(**data)
+        user.save()
+        initUser(user)
     except IntegrityError:
         return JsonResponse(
             {"detail": "User with this name already exists"}, status=409