karrio-server-core 2025.5rc31__py3-none-any.whl → 2026.1.1__py3-none-any.whl

karrio/server/iam/migrations/0003_remove_permission_groups.py

@@ -0,0 +1,91 @@
+# Generated migration to remove permission groups
+
+from django.db import migrations
+
+
+def remove_permission_groups(apps, schema_editor):
+    """
+    Remove all permission groups that were created by setup_groups().
+
+    This migration removes the following groups:
+    - manage_apps
+    - manage_carriers (deprecated)
+    - read_carriers
+    - write_carriers
+    - manage_orders
+    - manage_team
+    - manage_org_owner
+    - manage_webhooks
+    - manage_data
+    - manage_shipments
+    - manage_system
+    """
+    Group = apps.get_model("user", "Group")
+    ContextPermission = apps.get_model("iam", "ContextPermission")
+
+    # List of groups to remove
+    groups_to_remove = [
+        "manage_apps",
+        "manage_carriers",
+        "read_carriers",
+        "write_carriers",
+        "manage_orders",
+        "manage_team",
+        "manage_org_owner",
+        "manage_webhooks",
+        "manage_data",
+        "manage_shipments",
+        "manage_system",
+        "manage_pickups",
+        "manage_trackers",
+    ]
+
+    # First, remove the groups from all ContextPermissions
+    for group_name in groups_to_remove:
+        group = Group.objects.filter(name=group_name).first()
+        if group:
+            # Remove this group from all context permissions
+            for ctx_perm in ContextPermission.objects.filter(groups=group):
+                ctx_perm.groups.remove(group)
+
+    # Then delete the groups themselves
+    Group.objects.filter(name__in=groups_to_remove).delete()
+
+
+def reverse_migration(apps, schema_editor):
+    """
+    Reverse migration - recreate groups (without permissions, which were set dynamically).
+    Note: This won't restore the full permission setup, only creates empty groups.
+    """
+    Group = apps.get_model("user", "Group")
+
+    groups_to_create = [
+        "manage_apps",
+        "manage_carriers",
+        "read_carriers",
+        "write_carriers",
+        "manage_orders",
+        "manage_team",
+        "manage_org_owner",
+        "manage_webhooks",
+        "manage_data",
+        "manage_shipments",
+        "manage_system",
+        "manage_pickups",
+        "manage_trackers",
+    ]
+
+    for group_name in groups_to_create:
+        Group.objects.get_or_create(name=group_name)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("iam", "0002_setup_carrier_permission_groups"),
+        ("user", "0004_group"),
+    ]
+
+    operations = [
+        migrations.RunPython(remove_permission_groups, reverse_migration),
+    ]

karrio/server/iam/permissions.py

@@ -1,134 +1,7 @@
-import typing
-import logging
-from django.db import models
-from django.contrib.auth import get_user_model
-from django.contrib.auth.models import Permission
-
-import karrio.server.core.utils as utils
-import karrio.server.user.models as users
-import karrio.server.iam.serializers as serializers
-
-logger = logging.getLogger(__name__)
-User = get_user_model()
-
-
-@utils.skip_on_loadata
-@utils.async_wrapper
-@utils.tenant_aware
-def setup_groups(**_):
-    """This function create all standard group permissions if they don't exsist."""
-    print("> setting up permissions")
-
-    # manage_apps
-    setup_group(
-        serializers.PermissionGroup.manage_apps.name,
-        permissions=Permission.objects.filter(content_type__app_label="apps"),
-    )
-
-    # manage_carriers
-    setup_group(
-        serializers.PermissionGroup.manage_carriers.name,
-        permissions=[
-            *Permission.objects.filter(content_type__app_label="providers"),
-            *Permission.objects.filter(
-                models.Q(content_type__app_label="orgs")
-                & models.Q(name__icontains="carrier")
-            ),
-        ],
-        override=True,
-    )
-
-    # manage_orders
-    setup_group(
-        serializers.PermissionGroup.manage_orders.name,
-        permissions=Permission.objects.filter(content_type__app_label="orders"),
-    )
-
-    # manage_team
-    setup_group(
-        serializers.PermissionGroup.manage_team.name,
-        permissions=(
-            Permission.objects.filter(
-                content_type__app_label="orgs", name__icontains="organization"
-            ).exclude(name__icontains="owner")
-        ),
-        override=True,
-    )
-
-    # manage_org_owner
-    setup_group(
-        serializers.PermissionGroup.manage_org_owner.name,
-        permissions=Permission.objects.filter(
-            content_type__model="OrganizationOwner".lower()
-        ),
-    )
-
-    # manage_webhooks
-    setup_group(
-        serializers.PermissionGroup.manage_webhooks.name,
-        permissions=Permission.objects.filter(content_type__model="Webhook".lower()),
-    )
-
-    # manage_data
-    setup_group(
-        serializers.PermissionGroup.manage_data.name,
-        permissions=[
-            *Permission.objects.filter(
-                content_type__app_label__in=["data", "graph", "documents"]
-            ),
-            *Permission.objects.filter(
-                content_type__app_label="audit", name__icontains="view"
-            ),
-            *Permission.objects.filter(
-                content_type__app_label="rest_framework_tracking",
-                name__icontains="view",
-            ),
-        ],
-        override=True,
-    )
-
-    # manage_shipments
-    setup_group(
-        serializers.PermissionGroup.manage_shipments.name,
-        permissions=[
-            *Permission.objects.filter(content_type__app_label="manager"),
-            *Permission.objects.filter(
-                models.Q(content_type__app_label="orgs")
-                & (
-                    models.Q(name__icontains="address")
-                    | models.Q(name__icontains="parcel")
-                    | models.Q(name__icontains="commodity")
-                    | models.Q(name__icontains="customs")
-                    | models.Q(name__icontains="pickup")
-                    | models.Q(name__icontains="tracker")
-                    | models.Q(name__icontains="shipment")
-                )
-            ),
-        ],
-    )
-
-    # manage_system
-    setup_group(
-        serializers.PermissionGroup.manage_system.name,
-        permissions=Permission.objects.filter(
-            content_type__app_label__in=[
-                "admin",
-                "user",
-                "pricing",
-                "providers",
-                "audit",
-                "database",
-                "rest_framework_tracking",
-            ]
-        ),
-    )
-
-
-def setup_group(
-    name: str, permissions: typing.List[Permission], override: bool = False
-):
-    group, created = users.Group.objects.get_or_create(name=name)
-
-    if created or override:
-        group.permissions.set(permissions)
-        group.save()
+# This module previously contained permission group setup logic.
+# The setup_groups() function has been removed to:
+# 1. Fix Django warning about database access during app initialization
+# 2. Prepare for a better RBAC implementation in the future
+#
+# The PermissionGroup enum and ROLES_GROUPS mapping are preserved in
+# karrio.server.iam.serializers for organization role management.

karrio/server/iam/serializers.py

@@ -9,7 +9,9 @@ class PermissionGroup(lib.StrEnum):
     manage_orders = "manage_orders"
     manage_data = "manage_data"
     manage_pickups = "manage_pickups"
-    manage_carriers = "manage_carriers"
+    manage_carriers = "manage_carriers"  # Deprecated: use read_carriers + write_carriers
+    read_carriers = "read_carriers"
+    write_carriers = "write_carriers"
     manage_trackers = "manage_trackers"
     manage_webhooks = "manage_webhooks"
     manage_shipments = "manage_shipments"
@@ -22,7 +24,8 @@ ROLES_GROUPS: typing.Dict[str, typing.List[str]] = {
         PermissionGroup.manage_org_owner.value,
         PermissionGroup.manage_team.value,
         PermissionGroup.manage_apps.value,
-        PermissionGroup.manage_carriers.value,
+        PermissionGroup.read_carriers.value,
+        PermissionGroup.write_carriers.value,
         PermissionGroup.manage_webhooks.value,
         PermissionGroup.manage_data.value,
         PermissionGroup.manage_orders.value,
@@ -33,10 +36,12 @@ ROLES_GROUPS: typing.Dict[str, typing.List[str]] = {
     "admin": [
         PermissionGroup.manage_team.value,
         PermissionGroup.manage_apps.value,
-        PermissionGroup.manage_carriers.value,
+        PermissionGroup.read_carriers.value,
+        PermissionGroup.write_carriers.value,
     ],
     "developer": [
         PermissionGroup.manage_webhooks.value,
+        PermissionGroup.read_carriers.value,
     ],
     "member": [
         PermissionGroup.manage_data.value,
@@ -44,5 +49,6 @@ ROLES_GROUPS: typing.Dict[str, typing.List[str]] = {
         PermissionGroup.manage_pickups.value,
         PermissionGroup.manage_trackers.value,
         PermissionGroup.manage_shipments.value,
+        PermissionGroup.read_carriers.value,
     ],
 }

karrio/server/iam/signals.py

@@ -1,17 +1,15 @@
-import logging
 from django.db.models import signals
 
+from karrio.server.core.logging import logger
 import karrio.server.core.utils as utils
 import karrio.server.user.models as user
 import karrio.server.iam.models as models
 
-logger = logging.getLogger(__name__)
-
 
 def register_all():
     signals.post_delete.connect(context_object_deleted, sender=user.Token)
 
-    logger.info("karrio.iam signals registered...")
+    logger.info("Signal registration complete", module="karrio.iam")
 
 
 @utils.disable_for_loaddata

karrio/server/providers/admin.py

@@ -354,7 +354,7 @@ class LabelTemplateAdmin(admin.ModelAdmin):
         return False
 
 
-@utils.skip_on_commands()
+@utils.skip_on_commands(["loaddata", "migrate", "makemigrations", "shell"])
 def register_carrier_admins():
     for carrier_name, display_name in ref.REFERENCES["carriers"].items():
         proxy = providers.create_carrier_proxy(carrier_name, display_name)

karrio/server/providers/migrations/0085_populate_dhl_parcel_de_oauth_credentials.py

@@ -0,0 +1,82 @@
+# Generated by Django migration to populate missing required credentials for DHL Parcel DE
+# This migration ensures existing dhl_parcel_de connections have all required fields
+# (username, password, client_id, client_secret) to prevent initialization errors
+# after the settings schema was updated.
+
+from django.db import migrations
+from django.utils import timezone
+
+
+# Required fields for dhl_parcel_de that have no default values
+REQUIRED_FIELDS = ["username", "password", "client_id", "client_secret"]
+
+
+def populate_dhl_parcel_de_required_credentials(apps, schema_editor):
+    """
+    Find all dhl_parcel_de carrier connections that are missing required fields
+    and populate them with placeholder timestamp values.
+    """
+    Carrier = apps.get_model("providers", "Carrier")
+    db_alias = schema_editor.connection.alias
+
+    # Find all dhl_parcel_de carriers
+    dhl_parcel_de_carriers = Carrier.objects.using(db_alias).filter(
+        carrier_code="dhl_parcel_de"
+    )
+
+    timestamp = timezone.now().strftime("%Y%m%d%H%M%S")
+
+    for carrier in dhl_parcel_de_carriers:
+        credentials = carrier.credentials or {}
+        updated = False
+
+        # Check and populate all missing required fields
+        for field in REQUIRED_FIELDS:
+            if not credentials.get(field):
+                credentials[field] = f"PLACEHOLDER_{timestamp}"
+                updated = True
+
+        if updated:
+            carrier.credentials = credentials
+            carrier.save(using=db_alias, update_fields=["credentials"])
+
+
+def reverse_dhl_parcel_de_required_credentials(apps, schema_editor):
+    """
+    Remove placeholder credentials (for rollback).
+    Only removes credentials that were set by this migration (contain PLACEHOLDER_).
+    """
+    Carrier = apps.get_model("providers", "Carrier")
+    db_alias = schema_editor.connection.alias
+
+    dhl_parcel_de_carriers = Carrier.objects.using(db_alias).filter(
+        carrier_code="dhl_parcel_de"
+    )
+
+    for carrier in dhl_parcel_de_carriers:
+        credentials = carrier.credentials or {}
+        updated = False
+
+        # Only remove if it's a placeholder value
+        for field in REQUIRED_FIELDS:
+            if credentials.get(field, "").startswith("PLACEHOLDER_"):
+                del credentials[field]
+                updated = True
+
+        if updated:
+            carrier.credentials = credentials
+            carrier.save(using=db_alias, update_fields=["credentials"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("providers", "0084_alter_servicelevel_currency"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            populate_dhl_parcel_de_required_credentials,
+            reverse_dhl_parcel_de_required_credentials,
+        ),
+    ]

karrio/server/providers/migrations/0086_rename_dhl_parcel_de_customer_number_to_billing_number.py

@@ -0,0 +1,71 @@
+# Generated by Django migration to rename customer_number to billing_number
+# for DHL Parcel DE connections. This keeps existing configuration values
+# when the field was renamed in the settings schema.
+
+from django.db import migrations
+
+
+def rename_customer_number_to_billing_number(apps, schema_editor):
+    """
+    Find all dhl_parcel_de carrier connections that have customer_number
+    and rename it to billing_number to preserve the configuration value.
+    """
+    Carrier = apps.get_model("providers", "Carrier")
+    db_alias = schema_editor.connection.alias
+
+    # Find all dhl_parcel_de carriers
+    dhl_parcel_de_carriers = Carrier.objects.using(db_alias).filter(
+        carrier_code="dhl_parcel_de"
+    )
+
+    for carrier in dhl_parcel_de_carriers:
+        credentials = carrier.credentials or {}
+
+        # Check if customer_number exists and billing_number doesn't
+        if credentials.get("customer_number") and not credentials.get("billing_number"):
+            # Copy customer_number value to billing_number
+            credentials["billing_number"] = credentials["customer_number"]
+            # Remove old customer_number field
+            del credentials["customer_number"]
+
+            carrier.credentials = credentials
+            carrier.save(using=db_alias, update_fields=["credentials"])
+
+
+def rename_billing_number_to_customer_number(apps, schema_editor):
+    """
+    Reverse migration: rename billing_number back to customer_number.
+    """
+    Carrier = apps.get_model("providers", "Carrier")
+    db_alias = schema_editor.connection.alias
+
+    dhl_parcel_de_carriers = Carrier.objects.using(db_alias).filter(
+        carrier_code="dhl_parcel_de"
+    )
+
+    for carrier in dhl_parcel_de_carriers:
+        credentials = carrier.credentials or {}
+
+        # Check if billing_number exists and customer_number doesn't
+        if credentials.get("billing_number") and not credentials.get("customer_number"):
+            # Copy billing_number value back to customer_number
+            credentials["customer_number"] = credentials["billing_number"]
+            # Remove the billing_number field
+            del credentials["billing_number"]
+
+            carrier.credentials = credentials
+            carrier.save(using=db_alias, update_fields=["credentials"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("providers", "0085_populate_dhl_parcel_de_oauth_credentials"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            rename_customer_number_to_billing_number,
+            rename_billing_number_to_customer_number,
+        ),
+    ]

karrio/server/providers/migrations/0087_alter_carrier_capabilities.py

@@ -0,0 +1,38 @@
+# Generated by Django 5.2.9 on 2025-12-03 05:47
+
+import functools
+import karrio.server.core.fields
+import karrio.server.core.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("providers", "0086_rename_dhl_parcel_de_customer_number_to_billing_number"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="carrier",
+            name="capabilities",
+            field=karrio.server.core.fields.MultiChoiceField(
+                choices=[
+                    ("pickup", "pickup"),
+                    ("rating", "rating"),
+                    ("shipping", "shipping"),
+                    ("tracking", "tracking"),
+                    ("paperless", "paperless"),
+                    ("manifest", "manifest"),
+                    ("duties", "duties"),
+                    ("insurance", "insurance"),
+                    ("webhook", "webhook"),
+                    ("oauth", "oauth"),
+                ],
+                default=functools.partial(
+                    karrio.server.core.models._identity, *(), **{"value": []}
+                ),
+                help_text="Select the capabilities of the carrier that you want to enable",
+            ),
+        ),
+    ]

karrio/server/providers/migrations/0088_servicelevel_surcharges.py

@@ -0,0 +1,24 @@
+# Generated by Django - Add surcharges field to ServiceLevel
+
+from django.db import migrations, models
+import karrio.server.core.models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('providers', '0087_alter_carrier_capabilities'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='servicelevel',
+            name='surcharges',
+            field=models.JSONField(
+                blank=True,
+                default=karrio.server.core.models.field_default([]),
+                help_text='Service-level surcharges (fuel, handling, residential, etc.)',
+                null=True,
+            ),
+        ),
+    ]

karrio/server/providers/migrations/0089_servicelevel_cost_max_volume.py

@@ -0,0 +1,31 @@
+# Generated by Django - Add cost and max_volume fields to ServiceLevel
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('providers', '0088_servicelevel_surcharges'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='servicelevel',
+            name='cost',
+            field=models.FloatField(
+                blank=True,
+                null=True,
+                help_text='Base COGS (Cost of Goods Sold) - internal cost tracking',
+            ),
+        ),
+        migrations.AddField(
+            model_name='servicelevel',
+            name='max_volume',
+            field=models.FloatField(
+                blank=True,
+                null=True,
+                help_text='Maximum volume in liters for volumetric weight calculation',
+            ),
+        ),
+    ]

karrio/server/providers/migrations/0090_ratesheet_surcharges_servicelevel_zone_surcharge_ids.py

@@ -0,0 +1,47 @@
+# Generated by Django - Add surcharges to RateSheet and zone_ids/surcharge_ids to ServiceLevel
+
+from django.db import migrations, models
+import karrio.server.core.models as core
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('providers', '0089_servicelevel_cost_max_volume'),
+    ]
+
+    operations = [
+        # Add surcharges field to RateSheet (shared surcharge definitions)
+        migrations.AddField(
+            model_name='ratesheet',
+            name='surcharges',
+            field=models.JSONField(
+                blank=True,
+                null=True,
+                default=core.field_default([]),
+                help_text="Shared surcharge definitions: [{'id': 'surch_1', 'name': 'Fuel', 'amount': 8.5, 'surcharge_type': 'percentage'}]",
+            ),
+        ),
+        # Add zone_ids to ServiceLevel (references shared zones)
+        migrations.AddField(
+            model_name='servicelevel',
+            name='zone_ids',
+            field=models.JSONField(
+                blank=True,
+                null=True,
+                default=core.field_default([]),
+                help_text="List of zone IDs this service applies to: ['zone_1', 'zone_2']",
+            ),
+        ),
+        # Add surcharge_ids to ServiceLevel (references shared surcharges)
+        migrations.AddField(
+            model_name='servicelevel',
+            name='surcharge_ids',
+            field=models.JSONField(
+                blank=True,
+                null=True,
+                default=core.field_default([]),
+                help_text="List of surcharge IDs to apply: ['surch_fuel', 'surch_residential']",
+            ),
+        ),
+    ]