create-workframe 0.1.0

package/workframe-api/site_meta.py

@@ -0,0 +1,271 @@
+"""Public site metadata — OG tags, PWA manifest, link previews."""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any, Callable
+from urllib.parse import urljoin
+
+import stack_config
+
+DEFAULT_TITLE = "Workframe"
+DEFAULT_SHORT_NAME = "Workframe"
+DEFAULT_DESCRIPTION = "Project chat and workspace for Hermes agent crews"
+DEFAULT_THEME_COLOR = "#0A0A0F"
+DEFAULT_OG_IMAGE = "/assets/branding/og-default.png"
+DEFAULT_FAVICON = "/favicon.svg"
+
+BRANDING_DIR_NAME = "site-branding"
+OG_FILENAME = "og-image"
+FAVICON_FILENAME = "favicon"
+
+_MIME_BY_SUFFIX = {
+    ".png": "image/png",
+    ".jpg": "image/jpeg",
+    ".jpeg": "image/jpeg",
+    ".webp": "image/webp",
+    ".svg": "image/svg+xml",
+    ".ico": "image/x-icon",
+}
+
+
+def branding_dir() -> Path:
+    root = stack_config.DATA_DIR / BRANDING_DIR_NAME
+    root.mkdir(parents=True, exist_ok=True)
+    return root
+
+
+def _site_branding_raw() -> dict[str, Any]:
+    raw = stack_config._read_raw()
+    block = raw.get("site_branding")
+    return block if isinstance(block, dict) else {}
+
+
+def site_branding_public() -> dict[str, Any]:
+    block = _site_branding_raw()
+    return {
+        "title": str(block.get("title") or "").strip(),
+        "description": str(block.get("description") or "").strip(),
+        "theme_color": str(block.get("theme_color") or "").strip(),
+        "has_og_image": _branding_asset_path("og").is_file(),
+        "has_favicon": _branding_asset_path("favicon").is_file(),
+    }
+
+
+def patch_site_branding(body: dict[str, Any]) -> None:
+    raw = stack_config._read_raw()
+    block = raw.get("site_branding") if isinstance(raw.get("site_branding"), dict) else {}
+    for key in ("title", "description", "theme_color"):
+        if key in body:
+            block[key] = str(body.get(key) or "").strip()
+    raw["site_branding"] = block
+    stack_config._write_raw(raw)
+
+
+def _branding_asset_path(kind: str) -> Path:
+    block = _site_branding_raw()
+    rel = str(block.get(f"{kind}_file") or "").strip()
+    if rel:
+        candidate = stack_config.DATA_DIR / rel
+        if candidate.is_file():
+            return candidate
+    for suffix in (".png", ".jpg", ".jpeg", ".webp", ".svg", ".ico"):
+        candidate = branding_dir() / f"{OG_FILENAME if kind == 'og' else FAVICON_FILENAME}{suffix}"
+        if candidate.is_file():
+            return candidate
+    return branding_dir() / f"{OG_FILENAME if kind == 'og' else FAVICON_FILENAME}.png"
+
+
+def save_branding_asset(kind: str, data: bytes, content_type: str = "") -> Path:
+    if kind not in {"og", "favicon"}:
+        raise ValueError("invalid_branding_kind")
+    if not data:
+        raise ValueError("empty_asset")
+    suffix = _suffix_for_upload(content_type, data)
+    dest = branding_dir() / f"{OG_FILENAME if kind == 'og' else FAVICON_FILENAME}{suffix}"
+    dest.write_bytes(data)
+    raw = stack_config._read_raw()
+    block = raw.get("site_branding") if isinstance(raw.get("site_branding"), dict) else {}
+    block[f"{kind}_file"] = f"{BRANDING_DIR_NAME}/{dest.name}"
+    raw["site_branding"] = block
+    stack_config._write_raw(raw)
+    return dest
+
+
+def _suffix_for_upload(content_type: str, data: bytes) -> str:
+    ctype = str(content_type or "").split(";")[0].strip().lower()
+    if ctype == "image/png" or data[:8] == b"\x89PNG\r\n\x1a\n":
+        return ".png"
+    if ctype in {"image/jpeg", "image/jpg"} or data[:3] == b"\xff\xd8\xff":
+        return ".jpg"
+    if ctype == "image/webp" or data[:4] == b"RIFF" and data[8:12] == b"WEBP":
+        return ".webp"
+    if ctype == "image/svg+xml" or data.lstrip()[:5] == b"<svg " or b"<svg" in data[:200]:
+        return ".svg"
+    if ctype == "image/x-icon":
+        return ".ico"
+    return ".png"
+
+
+def _abs_url(base: str, path: str) -> str:
+    base = str(base or "").strip().rstrip("/")
+    path = str(path or "").strip()
+    if not path:
+        return ""
+    if path.startswith("http://") or path.startswith("https://"):
+        return path
+    if not base:
+        return path
+    return urljoin(f"{base}/", path.lstrip("/"))
+
+
+def _browser_asset_url(base: str, path: str) -> str:
+    """Same-origin static assets — relative paths avoid loopback leaks on HTTPS deploys."""
+    path = str(path or "").strip()
+    if path.startswith("/") and not path.startswith("//"):
+        return path
+    return _abs_url(base, path)
+
+
+def resolve_site_meta(
+    *,
+    app_base_url: str,
+    install_complete: bool,
+    workspace: dict[str, Any] | None = None,
+    normalize_logo: Callable[[str], str] | None = None,
+) -> dict[str, Any]:
+    """Merge stack overrides, primary workspace identity, and Workframe defaults."""
+    overrides = _site_branding_raw()
+    ws = workspace or {}
+
+    title = str(overrides.get("title") or "").strip()
+    if not title and install_complete:
+        title = str(ws.get("display_name") or "").strip()
+    if not title:
+        title = DEFAULT_TITLE
+
+    description = str(overrides.get("description") or "").strip()
+    if not description and install_complete:
+        description = str(ws.get("description") or "").strip()
+    if not description:
+        description = DEFAULT_DESCRIPTION
+
+    tagline = str(ws.get("tagline") or "").strip() if install_complete else ""
+
+    theme_color = str(overrides.get("theme_color") or "").strip() or DEFAULT_THEME_COLOR
+
+    og_path = _branding_asset_path("og")
+    if og_path.is_file():
+        og_image = _browser_asset_url(app_base_url, f"/api/public/branding/og{og_path.suffix}")
+    elif install_complete:
+        logo = str(ws.get("avatar_url") or "").strip()
+        if logo and normalize_logo:
+            logo = normalize_logo(logo)
+        og_image = _browser_asset_url(app_base_url, logo) if logo else _browser_asset_url(app_base_url, DEFAULT_OG_IMAGE)
+    else:
+        og_image = _browser_asset_url(app_base_url, DEFAULT_OG_IMAGE)
+
+    fav_path = _branding_asset_path("favicon")
+    if fav_path.is_file():
+        favicon = _browser_asset_url(app_base_url, f"/api/public/branding/favicon{fav_path.suffix}")
+    else:
+        favicon = _browser_asset_url(app_base_url, DEFAULT_FAVICON)
+
+    short_name = title if len(title) <= 16 else title[:15].rstrip() + "…"
+    canonical = app_base_url.rstrip("/") + "/" if app_base_url else "/"
+
+    return {
+        "ok": True,
+        "install_complete": bool(install_complete),
+        "title": title,
+        "short_name": short_name,
+        "description": description,
+        "tagline": tagline,
+        "theme_color": theme_color,
+        "og_image": og_image,
+        "favicon": favicon,
+        "canonical_url": canonical,
+        "manifest_url": _browser_asset_url(app_base_url, "/manifest.webmanifest"),
+        "source": {
+            "title": "stack" if overrides.get("title") else ("workspace" if install_complete and ws.get("display_name") else "default"),
+            "description": "stack" if overrides.get("description") else ("workspace" if install_complete and ws.get("description") else "default"),
+            "og_image": "upload" if og_path.is_file() else ("workspace_logo" if install_complete and ws.get("avatar_url") else "default"),
+            "favicon": "upload" if fav_path.is_file() else "default",
+        },
+    }
+
+
+def manifest_payload(meta: dict[str, Any]) -> dict[str, Any]:
+    icons = []
+    favicon = str(meta.get("favicon") or "").strip()
+    if favicon:
+        icons.append(
+            {
+                "src": favicon,
+                "sizes": "any",
+                "type": "image/svg+xml" if favicon.endswith(".svg") else "image/png",
+                "purpose": "any",
+            },
+        )
+    return {
+        "name": meta.get("title") or DEFAULT_TITLE,
+        "short_name": meta.get("short_name") or DEFAULT_SHORT_NAME,
+        "description": meta.get("description") or DEFAULT_DESCRIPTION,
+        "start_url": "./",
+        "display": "standalone",
+        "background_color": meta.get("theme_color") or DEFAULT_THEME_COLOR,
+        "theme_color": meta.get("theme_color") or DEFAULT_THEME_COLOR,
+        "orientation": "any",
+        "icons": icons or [{"src": "./favicon.svg", "sizes": "any", "type": "image/svg+xml", "purpose": "any"}],
+    }
+
+
+def link_preview_html(meta: dict[str, Any]) -> str:
+    title = _html_escape(str(meta.get("title") or DEFAULT_TITLE))
+    description = _html_escape(str(meta.get("description") or DEFAULT_DESCRIPTION))
+    canonical = _html_escape(str(meta.get("canonical_url") or "/"))
+    og_image = _html_escape(str(meta.get("og_image") or ""))
+    theme = _html_escape(str(meta.get("theme_color") or DEFAULT_THEME_COLOR))
+    favicon = _html_escape(str(meta.get("favicon") or DEFAULT_FAVICON))
+    return f"""<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <title>{title}</title>
+  <meta name="description" content="{description}" />
+  <meta name="theme-color" content="{theme}" />
+  <link rel="icon" href="{favicon}" />
+  <meta property="og:type" content="website" />
+  <meta property="og:site_name" content="{title}" />
+  <meta property="og:title" content="{title}" />
+  <meta property="og:description" content="{description}" />
+  <meta property="og:url" content="{canonical}" />
+  <meta property="og:image" content="{og_image}" />
+  <meta name="twitter:card" content="summary_large_image" />
+  <meta name="twitter:title" content="{title}" />
+  <meta name="twitter:description" content="{description}" />
+  <meta name="twitter:image" content="{og_image}" />
+  <meta http-equiv="refresh" content="0;url={canonical}" />
+</head>
+<body><p><a href="{canonical}">{title}</a></p></body>
+</html>
+"""
+
+
+def branding_asset_bytes(kind: str) -> tuple[bytes, str] | None:
+    path = _branding_asset_path(kind)
+    if not path.is_file():
+        return None
+    ctype = _MIME_BY_SUFFIX.get(path.suffix.lower(), "application/octet-stream")
+    return path.read_bytes(), ctype
+
+
+def _html_escape(value: str) -> str:
+    return (
+        value.replace("&", "&amp;")
+        .replace("<", "&lt;")
+        .replace(">", "&gt;")
+        .replace('"', "&quot;")
+    )