open-swarm 0.1.1745275181__py3-none-any.whl → 0.1.1748636295__py3-none-any.whl

swarm/urls.py

@@ -1,72 +1,89 @@
-"""
-Swarm URL Configuration
-"""
-import logging
 from django.contrib import admin
-from django.urls import path, include, reverse_lazy
+from django.urls import path, re_path, include
+from django.http import HttpResponse
 from django.conf import settings
-from django.views.generic import RedirectView
-from django.contrib.auth import views as auth_views
-
-from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView, SpectacularSwaggerView
+from django.conf.urls.static import static
+import os
+import logging
 
-from swarm.views.chat_views import ChatCompletionsView, HealthCheckView
-# *** Uncomment and correct the import path ***
-from swarm.views.api_views import ModelsListView
-# from swarm.views.webui_views import index as webui_index # Rename to avoid conflict
+# Import specific views from their modules
+from swarm.views.core_views import index as core_index_view, serve_swarm_config, custom_login
+from swarm.views.chat_views import chat_completions
+from swarm.views.model_views import list_models
+from swarm.views.message_views import ChatMessageViewSet
+from drf_spectacular.views import SpectacularSwaggerView, SpectacularAPIView as HiddenSpectacularAPIView
+from rest_framework.routers import DefaultRouter
 
 logger = logging.getLogger(__name__)
 
-# ==============================================================================
-# API URL Patterns (v1)
-# ==============================================================================
-api_urlpatterns = [
-    path('chat/completions', ChatCompletionsView.as_view(), name='chat_completions'),
-    # *** Uncomment this URL pattern ***
-    path('models', ModelsListView.as_view(), name='list_models'),
-    path('health', HealthCheckView.as_view(), name='health_check'),
-    # Add other v1 API endpoints here
-]
-
-# ==============================================================================
-# Schema URL Patterns
-# ==============================================================================
-schema_urlpatterns = [
-    path('schema/', SpectacularAPIView.as_view(), name='schema'),
-    path('schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
-    path('schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
-]
+def favicon(request):
+    favicon_path = settings.BASE_DIR / 'assets' / 'images' / 'favicon.ico'
+    try:
+        with open(favicon_path, 'rb') as f:
+            favicon_data = f.read()
+        return HttpResponse(favicon_data, content_type="image/x-icon")
+    except FileNotFoundError:
+        logger.warning("Favicon not found.")
+        return HttpResponse(status=404)
 
-# ==============================================================================
-# Main URL Patterns
-# ==============================================================================
-urlpatterns = [
-    # Redirect root based on DEBUG setting
-    path('', RedirectView.as_view(pattern_name='swagger-ui', permanent=False) if settings.DEBUG else RedirectView.as_view(pattern_name='login', permanent=False)),
+ENABLE_ADMIN = os.getenv("ENABLE_ADMIN", "false").lower() in ("true", "1", "t")
+ENABLE_WEBUI = os.getenv("ENABLE_WEBUI", "true").lower() in ("true", "1", "t")
 
-    # API v1 endpoints
-    path('v1/', include(api_urlpatterns)),
+logger.debug(f"ENABLE_WEBUI={'true' if ENABLE_WEBUI else 'false'}")
+logger.debug(f"ENABLE_ADMIN={'true' if ENABLE_ADMIN else 'false'}")
 
-    # Schema endpoints
-    path('api/', include(schema_urlpatterns)),
+router = DefaultRouter()
+# Ensure ChatMessageViewSet is available before registering
+if ChatMessageViewSet:
+    router.register(r'v1/chat/messages', ChatMessageViewSet, basename='chatmessage')
+else:
+     logger.warning("ChatMessageViewSet not imported correctly, skipping API registration.")
 
-    # Django Admin (Optional)
-    path('admin/', admin.site.urls) if getattr(settings, 'ENABLE_ADMIN', False) else path('admin/', RedirectView.as_view(url=reverse_lazy('login'))),
+# Base URL patterns required by Swarm core
+# Use the imported view functions directly
+base_urlpatterns = [
+    re_path(r'^health/?$', lambda request: HttpResponse("OK"), name='health_check'),
+    re_path(r'^v1/chat/completions/?$', chat_completions, name='chat_completions'),
+    re_path(r'^v1/models/?$', list_models, name='list_models'),
+    re_path(r'^schema/?$', HiddenSpectacularAPIView.as_view(), name='schema'),
+    re_path(r'^swagger-ui/?$', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+]
 
-    # Authentication Views (Django Built-in)
-    path('login/', auth_views.LoginView.as_view(template_name='swarm/login.html'), name='login'),
-    path('logout/', auth_views.LogoutView.as_view(next_page=reverse_lazy('login')), name='logout'),
+# Optional Admin URLs
+admin_urlpatterns = [path('admin/', admin.site.urls)] if ENABLE_ADMIN else []
 
-    # Web UI (Optional) - Conditionally include based on settings
-    # *** Ensure this line remains commented out or removed if webui_index is not defined ***
-    # path('webui/', webui_index, name='webui_index') if getattr(settings, 'ENABLE_WEBUI', False) else path('webui/', RedirectView.as_view(url=reverse_lazy('login'))),
-]
+# Optional Web UI URLs
+webui_urlpatterns = []
+if ENABLE_WEBUI:
+    webui_urlpatterns = [
+        path('', core_index_view, name='index'),
+        path('favicon.ico', favicon, name='favicon'),
+        path('config/swarm_config.json', serve_swarm_config, name='serve_swarm_config'),
+        path('accounts/login/', custom_login, name='custom_login'),
+    ]
+    if settings.DEBUG:
+         if settings.STATIC_URL and settings.STATIC_ROOT:
+              webui_urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
+         else:
+              logger.warning("STATIC_URL or STATIC_ROOT not configured, static files may not serve correctly in DEBUG mode.")
 
-# Debug logging (optional)
-logger.debug(f"ENABLE_ADMIN={getattr(settings, 'ENABLE_ADMIN', False)}")
-logger.debug(f"ENABLE_WEBUI={getattr(settings, 'ENABLE_WEBUI', False)}")
+# --- Blueprint URLs are now added dynamically via blueprint_base.py -> django_utils.py ---
+blueprint_urlpatterns = [] # Start with empty list, populated by utils
 
-# Example of how to conditionally add URLs based on settings
-# if getattr(settings, 'ENABLE_SOMETHING', False):
-#     urlpatterns.append(path('something/', include('something.urls')))
+# Combine all URL patterns
+urlpatterns = webui_urlpatterns + admin_urlpatterns + base_urlpatterns + blueprint_urlpatterns + router.urls
 
+# Log final URL patterns (consider moving this to where patterns are finalized if issues persist)
+if settings.DEBUG:
+    try:
+        from django.urls import get_resolver
+        # Note: get_resolver(None) might not reflect dynamically added URLs perfectly here.
+        # Logging within django_utils might be more accurate for dynamic additions.
+        final_patterns = get_resolver(None).url_patterns
+        logger.debug(f"Initial resolved URL patterns ({len(final_patterns)} total):")
+        # for pattern in final_patterns:
+        #      try: pattern_repr = str(pattern)
+        #      except: pattern_repr = f"[Pattern for {getattr(pattern, 'name', 'unnamed')}]"
+        #      logger.debug(f"  {pattern_repr}")
+    except Exception as e:
+        logger.error(f"Could not log initial URL patterns: {e}")

swarm/utils/context_utils.py

@@ -23,16 +23,10 @@ def _is_valid_message(msg: Any) -> bool:
     role = msg.get("role")
     if not role or not isinstance(role, str): logger.warning(f"Skipping msg missing role: {str(msg)[:150]}"); return False
     content = msg.get("content"); tool_calls = msg.get("tool_calls"); tool_call_id = msg.get("tool_call_id")
-    # Validate based on role: content must be a string for system/user/tool; assistant may have tool calls
-    if role == "system":
-        is_valid = isinstance(content, str)
-    elif role == "user":
-        is_valid = isinstance(content, str)
-    elif role == "assistant":
-        # Assistant valid if it has string content or at least one tool call
-        is_valid = isinstance(content, str) or (isinstance(tool_calls, list) and len(tool_calls) > 0)
-    elif role == "tool":
-        is_valid = isinstance(content, str) and tool_call_id is not None
+    if role == "system": is_valid = content is not None
+    elif role == "user": is_valid = content is not None
+    elif role == "assistant": is_valid = content is not None or (isinstance(tool_calls, list) and len(tool_calls) > 0)
+    elif role == "tool": is_valid = content is not None and tool_call_id is not None
     else: is_valid = False
     if not is_valid: logger.warning(f"Skipping msg failing validity check for role '{role}': {str(msg)[:150]}")
     return is_valid

swarm/utils/general_utils.py

@@ -118,27 +118,6 @@ def _search_and_process_jmespath(expression: str, payload: dict) -> str:
 
     return str(chat_id) if chat_id is not None else ""
 
-# ---------------------------------------------------------------------------
-# Debug utilities
-# ---------------------------------------------------------------------------
-
-_DEBUG_ENV_VARS = ("SWARM_DEBUG", "DEBUG", "OPEN_SWARM_DEBUG")
-
-
-def is_debug_enabled() -> bool:
-    """Return True if any recognised debug environment variable is truthy.
-
-    A value is considered *truthy* when it is set and **not** one of
-    "0", "false", "off" (case‑insensitive).
-    """
-    import os
-
-    for var in _DEBUG_ENV_VARS:
-        val = os.getenv(var)
-        if val and val.lower() not in ("0", "false", "off"):
-            return True
-    return False
-
 
 def extract_chat_id(payload: dict) -> str:
     """

swarm/utils/redact.py

@@ -13,43 +13,56 @@ DEFAULT_SENSITIVE_KEYS = ["secret", "password", "api_key", "apikey", "token", "a
 def redact_sensitive_data(
     data: Union[str, Dict, List],
     sensitive_keys: Optional[List[str]] = None,
-    reveal_chars: int = 0,
+    reveal_chars: int = 4,
     mask: str = "[REDACTED]"
 ) -> Union[str, Dict, List]:
     """
     Recursively redact sensitive information from dictionaries or lists based on keys.
-    By default, fully masks sensitive values (returns only the mask).
-    If reveal_chars > 0, partially masks (preserves reveal_chars at start/end).
-    If a custom mask is provided, always use it (for test compatibility).
+    Applies partial redaction to string values associated with sensitive keys.
     Does NOT redact standalone strings.
+
+    Args:
+        data: Input data to redact (dict or list). Other types returned as is.
+        sensitive_keys: List of dictionary keys to treat as sensitive. Defaults to common keys.
+        reveal_chars: Number of initial/trailing characters to reveal (0 means full redaction).
+        mask: String used for redaction in the middle or for full redaction of strings.
+
+    Returns:
+        Redacted data structure of the same type as input.
     """
-    keys_to_redact = set((k.lower() for k in (sensitive_keys or DEFAULT_SENSITIVE_KEYS)))
-    def smart_mask(val: str) -> str:
-        if not isinstance(val, str):
-            return val
-        if mask != "[REDACTED]":
-            return mask
-        if reveal_chars == 0:
-            return mask
-        if len(val) >= 2 * reveal_chars + 1:
-            return val[:reveal_chars] + mask + val[-reveal_chars:]
-        return mask
+    keys_to_redact = sensitive_keys if sensitive_keys is not None else DEFAULT_SENSITIVE_KEYS
+    keys_to_redact_lower = {key.lower() for key in keys_to_redact}
+
     if isinstance(data, dict):
         redacted_dict = {}
-        for k, v in data.items():
-            if isinstance(k, str) and k.lower() in keys_to_redact:
-                redacted_dict[k] = smart_mask(v)
-            elif isinstance(v, (dict, list)):
-                redacted_dict[k] = redact_sensitive_data(v, sensitive_keys, reveal_chars, mask)
+        for key, value in data.items():
+            if isinstance(key, str) and key.lower() in keys_to_redact_lower:
+                if isinstance(value, str):
+                    val_len = len(value)
+                    if reveal_chars > 0 and val_len > reveal_chars * 2:
+                        redacted_dict[key] = f"{value[:reveal_chars]}{mask}{value[-reveal_chars:]}"
+                    elif val_len > 0:
+                         # Use the provided mask string directly for full redaction
+                         redacted_dict[key] = mask
+                    else:
+                         redacted_dict[key] = "" # Redact empty string as empty
+                else:
+                    # Use specific placeholder for non-strings
+                    redacted_dict[key] = "[REDACTED NON-STRING]"
             else:
-                redacted_dict[k] = v
+                # Recursively redact nested structures if key is not sensitive
+                redacted_dict[key] = redact_sensitive_data(value, keys_to_redact, reveal_chars, mask)
         return redacted_dict
+
     elif isinstance(data, list):
+        # Recursively redact items in a list ONLY if they are dicts or lists themselves.
         processed_list = []
         for item in data:
             if isinstance(item, (dict, list)):
-                processed_list.append(redact_sensitive_data(item, sensitive_keys, reveal_chars, mask))
+                processed_list.append(redact_sensitive_data(item, keys_to_redact, reveal_chars, mask))
             else:
-                processed_list.append(item)
+                processed_list.append(item) # Keep non-dict/list items (like strings) unchanged
         return processed_list
+
+    # Return data unchanged if it's not a dict or list (including standalone strings)
     return data

swarm/views/api_views.py

@@ -1,55 +1,46 @@
-import time
-import logging
-from rest_framework.views import APIView
-from rest_framework.response import Response
-from rest_framework import status
+"""
+API-specific views and viewsets for Open Swarm MCP Core.
+"""
+from rest_framework.viewsets import ModelViewSet
 from rest_framework.permissions import AllowAny
-# *** Import async_to_sync ***
-from asgiref.sync import async_to_sync
+from drf_spectacular.views import SpectacularAPIView as BaseSpectacularAPIView
+from drf_spectacular.utils import extend_schema
+from swarm.utils.logger_setup import setup_logger
+from swarm.models import ChatMessage
+from swarm.serializers import ChatMessageSerializer
 
-from swarm.views.utils import get_available_blueprints
+logger = setup_logger(__name__)
 
-logger = logging.getLogger(__name__)
+class HiddenSpectacularAPIView(BaseSpectacularAPIView):
+    exclude_from_schema = True
 
-class ModelsListView(APIView):
-    """
-    API view to list available models (blueprints) compatible with OpenAI's /v1/models format.
-    """
+class ChatMessageViewSet(ModelViewSet):
+    """API viewset for managing chat messages."""
+    authentication_classes = []
     permission_classes = [AllowAny]
+    queryset = ChatMessage.objects.all()
+    serializer_class = ChatMessageSerializer
 
-    def get(self, request, *args, **kwargs):
-        try:
-            # *** Use async_to_sync to call the async function ***
-            available_blueprints = async_to_sync(get_available_blueprints)()
-
-            models_data = []
-            current_time = int(time.time())
-            if isinstance(available_blueprints, dict):
-                blueprint_ids = available_blueprints.keys()
-            elif isinstance(available_blueprints, list):
-                 blueprint_ids = available_blueprints
-            else:
-                 logger.error(f"Unexpected type from get_available_blueprints: {type(available_blueprints)}")
-                 blueprint_ids = []
-
-            for blueprint_id in blueprint_ids:
-                models_data.append({
-                    "id": blueprint_id,
-                    "object": "model",
-                    "created": current_time,
-                    "owned_by": "open-swarm",
-                })
-
-            response_payload = {
-                "object": "list",
-                "data": models_data,
-            }
-            return Response(response_payload, status=status.HTTP_200_OK)
-
-        except Exception as e:
-            logger.exception("Error retrieving available models.")
-            return Response(
-                {"error": "Failed to retrieve models list."},
-                status=status.HTTP_500_INTERNAL_SERVER_ERROR
-            )
+    @extend_schema(summary="List all chat messages")
+    def list(self, request, *args, **kwargs):
+        return super().list(request, *args, **kwargs)
 
+    @extend_schema(summary="Retrieve a chat message by its unique id")
+    def retrieve(self, request, *args, **kwargs):
+        return super().retrieve(request, *args, **kwargs)
+
+    @extend_schema(summary="Create a new chat message")
+    def create(self, request, *args, **kwargs):
+        return super().create(request, *args, **kwargs)
+
+    @extend_schema(summary="Update an existing chat message")
+    def update(self, request, *args, **kwargs):
+        return super().update(request, *args, **kwargs)
+
+    @extend_schema(summary="Partially update a chat message")
+    def partial_update(self, request, *args, **kwargs):
+        return super().partial_update(request, *args, **kwargs)
+
+    @extend_schema(summary="Delete a chat message by its unique id")
+    def destroy(self, request, *args, **kwargs):
+        return super().destroy(request, *args, **kwargs)