Agent Zero AI framework
Info and Warning Banners for Welcome Screen
keyboardstaff52430f6421c7
diff --git a/python/api/banners.py b/python/api/banners.pynew file mode 100644index 000000000..a84f683f1--- /dev/null+++ b/python/api/banners.py@@ -0,0 +1,48 @@+from python.helpers.api import ApiHandler, Request, Response+from python.helpers.extension import Extension+from python.helpers import files, extract_tools+++class GetBanners(ApiHandler):+ """+ API endpoint for Welcome Screen banners.+ Add checks as extension scripts in python/extensions/banners/ or usr/extensions/banners/+ """++ async def process(self, input: dict, request: Request) -> dict | Response:+ frontend_banners = input.get("banners", [])+ frontend_context = input.get("context", {})+ backend_banners = await self._run_banner_extensions(frontend_context, frontend_banners)+ return {"banners": backend_banners}++ async def _run_banner_extensions(self, context: dict, frontend_banners: list) -> list[dict]:+ """Run all banner checks via extension point system."""+ banners = []+ for cls in self._get_banner_extensions():+ try:+ result = await cls(agent=None).execute(context=context, frontend_banners=frontend_banners)+ if result:+ banners.extend(result if isinstance(result, list) else [result])+ except Exception as e:+ print(f"Banner check failed ({cls.__name__}): {e}")+ return banners++ def _get_banner_extensions(self) -> list[type[Extension]]:+ """Load banner extension classes from extensions folders."""+ all_exts = []+ for path in ["python/extensions/banners", "usr/extensions/banners"]:+ abs_path = files.get_abs_path(path)+ if files.exists(abs_path):+ all_exts.extend(extract_tools.load_classes_from_folder(abs_path, "*", Extension))++ # Deduplicate by filename (usr overrides default), sort by name+ unique = {}+ for cls in all_exts:+ file = cls.__module__.split(".")[-1]+ if file not in unique:+ unique[file] = cls+ return sorted(unique.values(), key=lambda c: c.__module__.split(".")[-1])++ @classmethod+ def get_methods(cls) -> list[str]:+ return ["POST"]diff --git a/python/extensions/banners/_10_unsecured_connection.py b/python/extensions/banners/_10_unsecured_connection.pynew file mode 100644index 000000000..90a40d594--- /dev/null+++ b/python/extensions/banners/_10_unsecured_connection.py@@ -0,0 +1,66 @@+from python.helpers.extension import Extension+from python.helpers import dotenv+import re+++class UnsecuredConnectionCheck(Extension):+ """Check: non-local without credentials, or credentials over non-HTTPS."""++ async def execute(self, context: dict = {}, **kwargs) -> dict | list | None:+ banners = []+ hostname = context.get("hostname", "")+ protocol = context.get("protocol", "")++ auth_login = dotenv.get_dotenv_value(dotenv.KEY_AUTH_LOGIN, "")+ auth_password = dotenv.get_dotenv_value(dotenv.KEY_AUTH_PASSWORD, "")+ has_credentials = bool(auth_login and auth_login.strip() and auth_password and auth_password.strip())++ is_local = self._is_localhost(hostname)+ is_https = protocol == "https:"++ if not is_local and not has_credentials:+ banners.append({+ "id": "unsecured-connection",+ "type": "warning",+ "priority": 80,+ "title": "Unsecured Connection",+ "html": """You are accessing Agent Zero from a non-local address without authentication.+ <a href="#" onclick="document.getElementById('settings').click(); return false;">+ Configure credentials</a> in Settings → External Services → Authentication.""",+ "dismissible": True,+ "source": "backend"+ })++ if has_credentials and not is_local and not is_https:+ banners.append({+ "id": "credentials-unencrypted",+ "type": "warning",+ "priority": 90,+ "title": "Credentials May Be Sent Unencrypted",+ "html": """Your connection is not using HTTPS. Login credentials may be transmitted in plain text.+ Consider using HTTPS or a secure tunnel.""",+ "dismissible": True,+ "source": "backend"+ })++ return banners if banners else None++ def _is_localhost(self, hostname: str) -> bool:+ local_patterns = ["localhost", "127.0.0.1", "::1", "0.0.0.0"]++ if hostname in local_patterns:+ return True++ # RFC1918 private ranges+ if re.match(r"^192\.168\.\d{1,3}\.\d{1,3}$", hostname):+ return True+ if re.match(r"^10\.\d{1,3}\.\d{1,3}\.\d{1,3}$", hostname):+ return True+ if re.match(r"^172\.(1[6-9]|2\d|3[01])\.\d{1,3}\.\d{1,3}$", hostname):+ return True++ # .local domains+ if hostname.endswith(".local"):+ return True++ return Falsediff --git a/python/extensions/banners/_20_missing_api_key.py b/python/extensions/banners/_20_missing_api_key.pynew file mode 100644index 000000000..b0e8ed1fc--- /dev/null+++ b/python/extensions/banners/_20_missing_api_key.py@@ -0,0 +1,64 @@+from python.helpers.extension import Extension+from python.helpers import settings as settings_helper+import models+++class MissingApiKeyCheck(Extension):+ """Check if API keys are configured for selected model providers."""++ LOCAL_PROVIDERS = ["ollama", "lm_studio"]+ HUGGINGFACE_LOCAL_FOR_EMBEDDING = ["huggingface"]+ MODEL_TYPE_NAMES = {+ "chat": "Chat Model",+ "utility": "Utility Model",+ "browser": "Web Browser Model",+ "embedding": "Embedding Model",+ }++ async def execute(self, context: dict = {}, **kwargs) -> dict | None:+ current_settings = settings_helper.get_settings()+ model_providers = {+ "chat": current_settings.get("chat_model_provider", ""),+ "utility": current_settings.get("util_model_provider", ""),+ "browser": current_settings.get("browser_model_provider", ""),+ "embedding": current_settings.get("embed_model_provider", ""),+ }++ missing_providers = []++ for model_type, provider in model_providers.items():+ if not provider:+ continue++ provider_lower = provider.lower()+ if provider_lower in self.LOCAL_PROVIDERS:+ continue+ if model_type == "embedding" and provider_lower in self.HUGGINGFACE_LOCAL_FOR_EMBEDDING:+ continue++ api_key = models.get_api_key(provider_lower)+ if not (api_key and api_key.strip() and api_key != "None"):+ missing_providers.append({+ "model_type": self.MODEL_TYPE_NAMES.get(model_type, model_type),+ "provider": provider,+ })++ if not missing_providers:+ return None++ model_list = ", ".join(+ f"{p['model_type']} ({p['provider']})" for p in missing_providers+ )++ return {+ "id": "missing-api-key",+ "type": "error",+ "priority": 100,+ "title": "Missing API Key",+ "html": f"""No API key configured for: {model_list}.+ Agent Zero will not be able to function properly.+ <a href="#" onclick="document.getElementById('settings').click(); return false;">+ Add your API key</a> in Settings → External Services → API Keys.""",+ "dismissible": False,+ "source": "backend"+ }diff --git a/webui/components/welcome/welcome-screen.html b/webui/components/welcome/welcome-screen.htmlindex 039dcb251..a5252eb9e 100644--- a/webui/components/welcome/welcome-screen.html+++ b/webui/components/welcome/welcome-screen.html@@ -67,6 +67,32 @@</p></div></div>++ <!-- Banner Section -->+ <div class="welcome-banners" x-show="banners && banners.length > 0">+ <template x-for="banner in sortedBanners" :key="banner.id">+ <div class="welcome-banner" :class="getBannerClass(banner.type)">+ <!-- Banner Icon -->+ <div class="welcome-banner-icon">+ <span class="material-symbols-outlined" x-text="getBannerIcon(banner.type)"></span>+ </div>++ <!-- Banner Content -->+ <div class="welcome-banner-content">+ <div class="welcome-banner-title" x-text="banner.title"></div>+ <div class="welcome-banner-html" x-html="banner.html"></div>+ </div>++ <!-- Dismiss Button -->+ <button class="welcome-banner-dismiss"+ x-show="banner.dismissible !== false"+ @click.stop="dismissBanner(banner.id)"+ title="Dismiss">+ <span class="material-symbols-outlined">close</span>+ </button>+ </div>+ </template>+ </div></div></template></div>@@ -168,6 +194,134 @@line-height: 1.3;}+ /* Banner Styles */+ .welcome-banners {+ display: flex;+ flex-direction: column;+ gap: 0.75rem;+ max-width: 520px;+ width: 100%;+ margin-top: 1.5rem;+ }++ .welcome-banner {+ display: flex;+ align-items: flex-start;+ gap: 12px;+ padding: 14px 16px;+ background: var(--color-panel);+ border: 1px solid var(--color-border);+ border-radius: 8px;+ text-align: left;+ position: relative;+ transition: all 0.2s ease;+ }++ .welcome-banner:hover {+ box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15);+ }++ /* Banner Type Styles */+ .welcome-banner.banner-info {+ border-left: 4px solid #2196F3;+ }++ .welcome-banner.banner-warning {+ border-left: 4px solid #FF9800;+ }++ .welcome-banner.banner-error {+ border-left: 4px solid #F44336;+ }++ /* Banner Icon */+ .welcome-banner-icon {+ flex-shrink: 0;+ display: flex;+ align-items: center;+ justify-content: center;+ width: 24px;+ height: 24px;+ margin-top: 2px;+ }++ .welcome-banner-icon .material-symbols-outlined {+ font-size: 1.25rem;+ }++ .banner-info .welcome-banner-icon {+ color: #2196F3;+ }++ .banner-warning .welcome-banner-icon {+ color: #FF9800;+ }++ .banner-error .welcome-banner-icon {+ color: #F44336;+ }++ /* Banner Content */+ .welcome-banner-content {+ flex: 1;+ min-width: 0;+ }++ .welcome-banner-title {+ font-weight: 600;+ font-size: 0.9rem;+ color: var(--color-text);+ margin-bottom: 4px;+ line-height: 1.3;+ }++ .welcome-banner-html {+ font-size: 0.85rem;+ color: var(--color-secondary);+ line-height: 1.5;+ }++ .welcome-banner-html a {+ color: var(--color-primary);+ text-decoration: underline;+ cursor: pointer;+ }++ .welcome-banner-html a:hover {+ color: var(--color-highlight-dark);+ }++ .welcome-banner-html strong {+ color: var(--color-text);+ font-weight: 600;+ }++ /* Banner Dismiss Button */+ .welcome-banner-dismiss {+ flex-shrink: 0;+ background: transparent;+ border: none;+ border-radius: 4px;+ color: var(--color-secondary);+ cursor: pointer;+ padding: 4px;+ display: flex;+ align-items: center;+ justify-content: center;+ transition: all 0.2s ease;+ opacity: 0.6;+ }++ .welcome-banner-dismiss:hover {+ background: var(--color-border);+ color: var(--color-text);+ opacity: 1;+ }++ .welcome-banner-dismiss .material-symbols-outlined {+ font-size: 1.1rem;+ }+/* Light mode adjustments */.light-mode .welcome-title {color: #2d2d2d;@@ -189,6 +343,18 @@color: #666;}+ .light-mode .welcome-banner {+ background: var(--color-panel);+ }++ .light-mode .welcome-banner-title {+ color: var(--color-text);+ }++ .light-mode .welcome-banner-html {+ color: var(--color-primary);+ }+/* Responsive design */@media (max-width: 768px) {.welcome-container {@@ -234,8 +400,24 @@.welcome-action-title {font-size: 1.1rem;}++ .welcome-banners {+ max-width: 100%;+ }++ .welcome-banner {+ padding: 12px 14px;+ }++ .welcome-banner-title {+ font-size: 0.85rem;+ }++ .welcome-banner-html {+ font-size: 0.8rem;+ }}</style></body>-</html>\ No newline at end of file+</html>diff --git a/webui/components/welcome/welcome-store.js b/webui/components/welcome/welcome-store.jsindex 1bdf56094..6ccca103b 100644--- a/webui/components/welcome/welcome-store.js+++ b/webui/components/welcome/welcome-store.js@@ -3,15 +3,23 @@ import { getContext } from "/index.js";import { store as chatsStore } from "/components/sidebar/chats/chats-store.js";import { store as memoryStore } from "/components/settings/memory/memory-dashboard-store.js";import { store as projectsStore } from "/components/projects/projects-store.js";+import * as API from "/js/api.js";const model = {// StateisVisible: true,+ banners: [],+ bannersLoading: false,+ lastBannerRefresh: 0,init() {// Initialize visibility based on current contextthis.updateVisibility();+ if (this.isVisible) {+ this.refreshBanners();+ }+// Watch for context changes with faster polling for immediate responsesetInterval(() => {this.updateVisibility();@@ -21,7 +29,12 @@ const model = {// Update visibility based on current contextupdateVisibility() {const hasContext = !!getContext();+ const wasVisible = this.isVisible;this.isVisible = !hasContext;++ if (this.isVisible && !wasVisible) {+ this.refreshBanners();+ }},// Hide welcome screen@@ -32,6 +45,129 @@ const model = {// Show welcome screenshow() {this.isVisible = true;+ this.refreshBanners();+ },++ // Build frontend context to send to backend+ buildFrontendContext() {+ return {+ url: window.location.href,+ protocol: window.location.protocol,+ hostname: window.location.hostname,+ port: window.location.port,+ browser: navigator.userAgent,+ timestamp: new Date().toISOString(),+ };+ },++ // Frontend banner checks (most checks are on backend; add browser-only checks here)+ runFrontendBannerChecks() {+ return [];+ },++ // Call backend API for additional banners+ async runBackendBannerChecks(frontendBanners, frontendContext) {+ try {+ const response = await API.callJsonApi("/banners", {+ banners: frontendBanners,+ context: frontendContext,+ });+ return response?.banners || [];+ } catch (error) {+ console.error("Failed to fetch backend banners:", error);+ return [];+ }+ },++ // Get list of dismissed banner IDs from storage+ getDismissedBannerIds() {+ const permanent = JSON.parse(localStorage.getItem('dismissed_banners') || '[]');+ const temporary = JSON.parse(sessionStorage.getItem('dismissed_banners') || '[]');+ return new Set([...permanent, ...temporary]);+ },++ // Merge and filter banners: deduplicate by ID, skip dismissed, sort by priority+ mergeBanners(frontendBanners, backendBanners) {+ const dismissed = this.getDismissedBannerIds();+ const bannerMap = new Map();++ for (const banner of frontendBanners) {+ if (banner.id && !dismissed.has(banner.id)) {+ bannerMap.set(banner.id, banner);+ }+ }+ for (const banner of backendBanners) {+ if (banner.id && !dismissed.has(banner.id)) {+ bannerMap.set(banner.id, banner);+ }+ }++ return Array.from(bannerMap.values()).sort((a, b) => (b.priority || 0) - (a.priority || 0));+ },++ // Refresh banners: frontend checks → backend checks → merge+ async refreshBanners() {+ const now = Date.now();+ if (now - this.lastBannerRefresh < 1000) return;+ this.lastBannerRefresh = now;+ this.bannersLoading = true;++ try {+ const frontendContext = this.buildFrontendContext();+ const frontendBanners = this.runFrontendBannerChecks();+ const backendBanners = await this.runBackendBannerChecks(frontendBanners, frontendContext);+ this.banners = this.mergeBanners(frontendBanners, backendBanners);+ } catch (error) {+ console.error("Failed to refresh banners:", error);+ this.banners = this.runFrontendBannerChecks();+ } finally {+ this.bannersLoading = false;+ }+ },++ get sortedBanners() {+ return [...this.banners].sort((a, b) => (b.priority || 0) - (a.priority || 0));+ },++ /**+ * Dismiss a banner by ID.+ *+ * Usage:+ * dismissBanner('banner-id') - Temporary dismiss (sessionStorage, cleared on browser close)+ * dismissBanner('banner-id', true) - Permanent dismiss (localStorage, persists across sessions)+ *+ * Dismissed banners are filtered out in mergeBanners() and won't appear until storage is cleared.+ *+ * @param {string} bannerId - The unique ID of the banner to dismiss+ * @param {boolean} permanent - If true, store in localStorage; if false, store in sessionStorage+ */+ dismissBanner(bannerId, permanent = false) {+ this.banners = this.banners.filter(b => b.id !== bannerId);++ const storage = permanent ? localStorage : sessionStorage;+ const dismissed = JSON.parse(storage.getItem('dismissed_banners') || '[]');+ if (!dismissed.includes(bannerId)) {+ dismissed.push(bannerId);+ storage.setItem('dismissed_banners', JSON.stringify(dismissed));+ }+ },++ getBannerClass(type) {+ const classes = {+ info: 'banner-info',+ warning: 'banner-warning',+ error: 'banner-error',+ };+ return classes[type] || 'banner-info';+ },++ getBannerIcon(type) {+ const icons = {+ info: 'info',+ warning: 'warning',+ error: 'error',+ };+ return icons[type] || 'info';},// Execute an action by ID