Add update checker management command and documentation

api_app/core/tasks.py

@@ -0,0 +1,12 @@
+from celery import shared_task
+
+from api_app.core.update_checker import check_for_update
+
+
+@shared_task(name="intelowl.scheduled_update_check")
+def scheduled_update_check():
+    """
+    Periodic task to check for IntelOwl updates.
+    Intended to be triggered via celery beat.
+    """
+    check_for_update()

api_app/core/update_checker.py

@@ -0,0 +1,129 @@
+import logging
+
+import requests
+from django.conf import settings
+from django.utils.timezone import now
+
+from api_app.models import UpdateCheckStatus
+from api_app.user_events_manager.queryset import UserEventQuerySet
+
+logger = logging.getLogger(__name__)
+
+
+def normalize_version(v):
+    """
+    Convert '1.2.3' → (1, 2, 3) so versions can be compared.
+    Stops at the first non-numeric part.
+    """
+    parts = []
+    for x in v.split("."):
+        if x.isdigit():
+            parts.append(int(x))
+        else:
+            break
+    return tuple(parts)
+
+
+def fetch_latest_version():
+    """
+    Fetch the latest IntelOwl version string from the update URL.
+    Returns a version string without any leading 'v', or None on error.
+    """
+    update_url = getattr(settings, "UPDATE_CHECK_URL", None)
+
+    if not update_url:
+        return None, "UPDATE_CHECK_URL not configured"
+
+    try:
+        resp = requests.get(
+            update_url,
+            headers={"User-Agent": "IntelOwl-Update-Checker"},
+            timeout=5,
+        )
+        resp.raise_for_status()
+    except requests.RequestException as exc:
+        logger.error(f"update check failed: {exc}")
+        return None, "Failed to fetch release information"
+
+    try:
+        data = resp.json()
+    except ValueError:
+        logger.error("invalid JSON in update response")
+        return None, "Invalid response from update server"
+
+    tag = data.get("tag_name")
+    if not tag:
+        return None, "Release response missing tag_name"
+
+    return tag.lstrip("v"), None
+
+
+def check_for_update():
+    """
+    Compare the running IntelOwl version with the latest available one.
+
+    Returns:
+        (success: bool, message: str)
+    """
+    current_version_str = getattr(settings, "INTEL_OWL_VERSION", None)
+    if not current_version_str:
+        return False, "INTEL_OWL_VERSION setting missing"
+
+    latest_str, error = fetch_latest_version()
+    if error:
+        return False, error
+
+    current_version_str = str(current_version_str).lstrip("v")
+
+    current = normalize_version(current_version_str)
+    latest = normalize_version(latest_str)
+
+    state, _ = UpdateCheckStatus.objects.get_or_create(pk=1)
+    state.last_checked_at = now()
+
+    if not current or not latest:
+        state.save(update_fields=["last_checked_at"])
+        if latest_str != current_version_str:
+            return (
+                True,
+                f"Update available: {latest_str} (current: {current_version_str})",
+            )
+        return True, f"IntelOwl version up to date ({current_version_str})"
+
+    if latest > current:
+        if state.latest_version != latest_str or not state.notified:
+            logger.warning(
+                "New IntelOwl version available: %s (current: %s)",
+                latest_str,
+                current_version_str,
+            )
+
+            UserEventQuerySet.notify_admins(
+                title="New IntelOwl version available",
+                message=(
+                    f"Version {latest_str} is available "
+                    f"(current: {current_version_str})"
+                ),
+                persistent=True,
+                severity="warning",
+            )
+
+            state.latest_version = latest_str
+            state.notified = True
+
+        state.save(update_fields=["latest_version", "notified", "last_checked_at"])
+        return (
+            True,
+            f"New IntelOwl version available: {latest_str} "
+            f"(current: {current_version_str})",
+        )
+
+    state.save(update_fields=["last_checked_at"])
+
+    if latest < current:
+        return (
+            True,
+            f"Local version ahead of release: " f"{current_version_str} > {latest_str}",
+        )
+
+    return True, f"IntelOwl version up to date ({current_version_str})"

api_app/management/commands/check_updates.py

@@ -0,0 +1,15 @@
+from django.core.management.base import BaseCommand
+
+from api_app.core.update_checker import check_for_update
+
+
+class Command(BaseCommand):
+    help = "Check for newer IntelOwl releases"
+
+    def handle(self, *args, **options):
+        success, message = check_for_update()
+
+        if success:
+            self.stdout.write(self.style.SUCCESS(message))
+        else:
+            self.stdout.write(self.style.ERROR(message))

api_app/models.py

@@ -67,6 +67,44 @@
 logger = logging.getLogger(__name__)
 
 
+class UpdateCheckStatus(models.Model):
+    """
+    Stores global state for IntelOwl update checks.
+    This model is intended to be used as a singleton (accessed via get_or_create(pk=1)).
+    Ensures that update notifications are emitted only once per version.
+    """
+
+    latest_version = models.CharField(
+        max_length=50,
+        null=True,
+        blank=True,
+        help_text="Latest version detected during update check",
+    )
+    notified = models.BooleanField(
+        default=False,
+        help_text="Whether a notification has already been sent for this version",
+    )
+    last_checked_at = models.DateTimeField(
+        null=True,
+        blank=True,
+        help_text="Last time the update check was executed",
+    )
+
+    created_at = models.DateTimeField(default=now, editable=False)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        verbose_name = "Update check status"
+        verbose_name_plural = "Update check status"
+
+    def __str__(self) -> str:
+        return (
+            f"UpdateCheckStatus("
+            f"latest_version={self.latest_version}, "
+            f"notified={self.notified})"
+        )
+
+
 class PythonModule(models.Model):
     """
     Represents a Python module model used in the application.

intel_owl/settings/commons.py

@@ -54,3 +54,10 @@
 GIT_SSH_SCRIPT_PATH = (
     PROJECT_LOCATION / "api_app" / "analyzers_manager" / "ssh_gitpython.sh"
 )
+
+# Update checker settings
+UPDATE_CHECK_URL = get_secret(
+    "UPDATE_CHECK_URL",
+    "https://api.github.com/repos/intelowlproject/IntelOwl/releases/latest",
+)
+INTEL_OWL_VERSION = VERSION