Compare commits
61 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 08aa4b5e15 | |||
| b1676482f0 | |||
| e46cd6e488 | |||
| edd2fdd3fb | |||
| a4a0c1462b | |||
| 196e63c08e | |||
| 518ac1d59d | |||
| ad699dc69a | |||
| a8e247d288 | |||
| 318d517575 | |||
| db137be5b1 | |||
| 83cec0f75a | |||
| cda9914d50 | |||
| 3acefbfbe8 | |||
| 4d10c5c91e | |||
| 810ff6fe85 | |||
| b2d3d940f2 | |||
| 8b1d828c59 | |||
| 824a9e5cad | |||
| 1cbc204e88 | |||
| 561c323e67 | |||
| 5c604b40c6 | |||
| cc8db6a034 | |||
| e0ad133221 | |||
| 0e27a03aaf | |||
| e2dfa20789 | |||
| 8e8b58d2d2 | |||
| 76ecaabd98 | |||
| 3f14dc3bd9 | |||
| 50a78714cc | |||
| 3bf01c91f1 | |||
| 7aa14284dd | |||
| 24933e980d | |||
| e10624df6b | |||
| 1a1ebd3821 | |||
| d3d61067db | |||
| 23b605becf | |||
| c07f8615e4 | |||
| 9b209a15bf | |||
| 30258bd2c0 | |||
| 2c8ca490ea | |||
| 9e8a8e81b9 | |||
| f5b2534fdb | |||
| 8b3916c3fa | |||
| 13e71046f8 | |||
| 58e3674325 | |||
| 828d84caa3 | |||
| c18e93406a | |||
| 9af18ba090 | |||
| fff50a1580 | |||
| f8e9967c3a | |||
| 7bc493eb45 | |||
| b97b970a45 | |||
| 593e0c367d | |||
| 8e0817a64b | |||
| dfc7e44565 | |||
| c9c4f99fbf | |||
| 37cc11c9ee | |||
| 9c773c07e8 | |||
| c04612e159 | |||
| 5796012189 |
98
CHANGELOG.md
98
CHANGELOG.md
@@ -11,6 +11,104 @@ Sections:
|
||||
|
||||
---
|
||||
|
||||
## [0.6.0] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Restore feature with selection of the last available backups (up to 5 per domain).
|
||||
- New API endpoints to list and restore backups:
|
||||
- `GET /api/bcs/backups?repo_id=...`
|
||||
- `POST /api/bcs/restore?repo_id=...&backup_id=...`
|
||||
|
||||
### Safety
|
||||
- Restoring a backup triggers a “restart required” prompt to apply the recovered integration state.
|
||||
|
||||
### Notes
|
||||
- This is a major release milestone consolidating install/update/uninstall, backup/rollback, and restore workflows.
|
||||
|
||||
## [0.5.11] - 2026-01-18
|
||||
|
||||
### Added
|
||||
- Automatic backup of existing custom components before install or update.
|
||||
- Backup retention with a configurable limit per domain.
|
||||
|
||||
### Safety
|
||||
- Automatic rollback is triggered if an install or update fails after a backup was created.
|
||||
|
||||
## [0.5.10] - 2026-01-17
|
||||
|
||||
### Added
|
||||
- Store view controls: Filter and Sort dropdowns alongside the existing Category selector.
|
||||
|
||||
### Fixed
|
||||
- Search input focus is preserved while typing (cursor no longer jumps out after re-render).
|
||||
|
||||
## [0.5.9] - 2026-01-17
|
||||
|
||||
### Changed
|
||||
- README is now collapsible with a preview by default (Show more / Show less).
|
||||
- Improved mobile readability by keeping long README content contained without affecting the page layout.
|
||||
|
||||
## [0.5.8] - 2026-01-17
|
||||
|
||||
### Changed
|
||||
- Mobile UI layout stabilized to prevent horizontal shifting.
|
||||
- README rendering no longer expands the page width on mobile devices.
|
||||
- Tables and code blocks inside README now scroll within their container.
|
||||
- Floating action buttons removed to avoid UI overlap on small screens.
|
||||
- Header icon buttons improved for better visibility in light and dark mode.
|
||||
|
||||
## [0.5.7] - 2026-01-17
|
||||
|
||||
### Changed
|
||||
- Mobile UI improvements: removed floating action buttons to prevent overlay issues.
|
||||
- Improved responsive layout to avoid horizontal overflow (badges, URLs, descriptions).
|
||||
- README rendering on mobile is more stable (better wrapping and image scaling).
|
||||
- Header icon buttons are more readable in both light and dark mode.
|
||||
|
||||
## [0.5.6] - 2026-01-17
|
||||
|
||||
### Added
|
||||
- Repository uninstall support directly from the Store UI.
|
||||
- New backend API endpoint: `POST /api/bcs/uninstall`.
|
||||
- Automatic **reconcile**: repositories are marked as not installed when their `custom_components` directories are removed manually.
|
||||
|
||||
### Changed
|
||||
- Installation & Updates section extended with an Uninstall button.
|
||||
- Store state now remains consistent even after manual file system changes.
|
||||
|
||||
### Fixed
|
||||
- Repositories remained marked as installed after manual deletion of their domains.
|
||||
- UI cache issues caused by outdated static assets.
|
||||
|
||||
## [0.5.5] - 2026-01-16
|
||||
|
||||
### Fixed
|
||||
- Update entities now refresh their displayed name after store refreshes, so repository names replace fallback IDs (e.g. `index:1`) reliably.
|
||||
|
||||
## [0.5.4] - 2026-01-16
|
||||
|
||||
### Added
|
||||
- Native **Repair fix flow** for restart-required situations.
|
||||
- “Restart required” issues are now **fixable** and provide a confirmation dialog with a real restart action.
|
||||
|
||||
### Changed
|
||||
- Restart-required issues are automatically cleared after Home Assistant restarts.
|
||||
- Update entities now fully align with official Home Assistant behavior (Updates screen + Repairs integration).
|
||||
|
||||
### Fixed
|
||||
- Fixed integration startup issues caused by incorrect file placement.
|
||||
- Resolved circular import and missing setup errors during Home Assistant startup.
|
||||
- Ensured YAML-based setup remains fully supported.
|
||||
|
||||
## [0.5.3] - 2026-01-16
|
||||
|
||||
### Added
|
||||
- Native Home Assistant Update entities for installed repositories (shown under **Settings → System → Updates**).
|
||||
- Human-friendly update names based on repository name (instead of internal repo IDs like `index:1`).
|
||||
|
||||
### Changed
|
||||
- Update UI now behaves like official Home Assistant integrations (update action is triggered via the HA Updates screen).
|
||||
|
||||
## [0.5.2] - 2026-01-16
|
||||
|
||||
### Added
|
||||
|
||||
2
bcs.yaml
2
bcs.yaml
@@ -4,7 +4,7 @@ description: >
|
||||
Supports GitHub, GitLab, Gitea and Bahmcloud repositories with
|
||||
a central index, UI panel and API, similar to HACS but independent.
|
||||
|
||||
category: Store
|
||||
category: integration
|
||||
|
||||
author: Bahmcloud
|
||||
maintainer: Bahmcloud
|
||||
|
||||
@@ -6,6 +6,7 @@ from datetime import timedelta
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.components.panel_custom import async_register_panel
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.helpers.discovery import async_load_platform
|
||||
|
||||
from .core import BCSCore, BCSConfig, BCSError
|
||||
|
||||
@@ -26,6 +27,10 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
|
||||
await core.async_initialize()
|
||||
|
||||
# Provide native Update entities in Settings -> System -> Updates.
|
||||
# This integration is YAML-based (async_setup), therefore we load the platform manually.
|
||||
await async_load_platform(hass, "update", DOMAIN, {}, config)
|
||||
|
||||
from .views import (
|
||||
StaticAssetsView,
|
||||
BCSApiView,
|
||||
@@ -33,6 +38,9 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
BCSCustomRepoView,
|
||||
BCSInstallView,
|
||||
BCSUpdateView,
|
||||
BCSUninstallView,
|
||||
BCSBackupsView,
|
||||
BCSRestoreView,
|
||||
BCSRestartView,
|
||||
)
|
||||
|
||||
@@ -42,6 +50,9 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
hass.http.register_view(BCSCustomRepoView(core))
|
||||
hass.http.register_view(BCSInstallView(core))
|
||||
hass.http.register_view(BCSUpdateView(core))
|
||||
hass.http.register_view(BCSUninstallView(core))
|
||||
hass.http.register_view(BCSBackupsView(core))
|
||||
hass.http.register_view(BCSRestoreView(core))
|
||||
hass.http.register_view(BCSRestartView(core))
|
||||
|
||||
await async_register_panel(
|
||||
@@ -49,7 +60,7 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||
frontend_url_path="bahmcloud-store",
|
||||
webcomponent_name="bahmcloud-store-panel",
|
||||
# IMPORTANT: bump v to avoid caching old JS
|
||||
module_url="/api/bahmcloud_store_static/panel.js?v=101",
|
||||
module_url="/api/bahmcloud_store_static/panel.js?v=103",
|
||||
sidebar_title="Bahmcloud Store",
|
||||
sidebar_icon="mdi:store",
|
||||
require_admin=True,
|
||||
|
||||
@@ -15,7 +15,8 @@ from urllib.parse import parse_qsl, urlencode, urlsplit, urlunsplit, urlparse
|
||||
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||
from homeassistant.components import persistent_notification
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
||||
from homeassistant.helpers import issue_registry as ir
|
||||
from homeassistant.util import yaml as ha_yaml
|
||||
|
||||
from .storage import BCSStorage, CustomRepo
|
||||
@@ -26,6 +27,9 @@ _LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DOMAIN = "bahmcloud_store"
|
||||
|
||||
SIGNAL_UPDATED = f"{DOMAIN}_updated"
|
||||
RESTART_REQUIRED_ISSUE_ID = "restart_required"
|
||||
|
||||
|
||||
class BCSError(Exception):
|
||||
"""BCS core error."""
|
||||
@@ -86,11 +90,18 @@ class BCSCore:
|
||||
self._install_lock = asyncio.Lock()
|
||||
self._installed_cache: dict[str, Any] = {}
|
||||
|
||||
# Phase F2: backups before install/update
|
||||
self._backup_root = Path(self.hass.config.path(".bcs_backups"))
|
||||
self._backup_keep_per_domain: int = 5
|
||||
|
||||
async def async_initialize(self) -> None:
|
||||
"""Async initialization that avoids blocking file IO."""
|
||||
self.version = await self._read_manifest_version_async()
|
||||
await self._refresh_installed_cache()
|
||||
|
||||
# After a successful HA restart, restart-required is no longer relevant.
|
||||
self._clear_restart_required_issue()
|
||||
|
||||
async def _read_manifest_version_async(self) -> str:
|
||||
def _read() -> str:
|
||||
try:
|
||||
@@ -107,12 +118,44 @@ class BCSCore:
|
||||
self._listeners.append(cb)
|
||||
|
||||
def signal_updated(self) -> None:
|
||||
# Notify entities/platforms (e.g. update entities) that BCS data changed.
|
||||
async_dispatcher_send(self.hass, SIGNAL_UPDATED)
|
||||
for cb in list(self._listeners):
|
||||
try:
|
||||
cb()
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def _mark_restart_required(self) -> None:
|
||||
"""Show a 'restart required' issue in Home Assistant Settings.
|
||||
|
||||
IMPORTANT:
|
||||
- is_fixable=True enables the "Fix/OK" button
|
||||
- the real action is implemented in repairs.py (fix flow)
|
||||
"""
|
||||
try:
|
||||
ir.async_create_issue(
|
||||
self.hass,
|
||||
DOMAIN,
|
||||
RESTART_REQUIRED_ISSUE_ID,
|
||||
is_fixable=True, # <-- IMPORTANT: show "Fix" button
|
||||
is_persistent=False,
|
||||
severity=ir.IssueSeverity.WARNING,
|
||||
translation_key=RESTART_REQUIRED_ISSUE_ID,
|
||||
)
|
||||
except Exception:
|
||||
_LOGGER.debug("Failed to create restart required issue", exc_info=True)
|
||||
|
||||
def _clear_restart_required_issue(self) -> None:
|
||||
"""Remove restart required issue after HA restarted."""
|
||||
try:
|
||||
if hasattr(ir, "async_delete_issue"):
|
||||
ir.async_delete_issue(self.hass, DOMAIN, RESTART_REQUIRED_ISSUE_ID)
|
||||
elif hasattr(ir, "async_remove_issue"):
|
||||
ir.async_remove_issue(self.hass, DOMAIN, RESTART_REQUIRED_ISSUE_ID)
|
||||
except Exception:
|
||||
_LOGGER.debug("Failed to clear restart required issue", exc_info=True)
|
||||
|
||||
async def full_refresh(self, source: str = "manual") -> None:
|
||||
"""Single refresh entry-point used by both timer and manual button."""
|
||||
_LOGGER.info("BCS full refresh triggered (source=%s)", source)
|
||||
@@ -122,6 +165,11 @@ class BCSCore:
|
||||
def get_repo(self, repo_id: str) -> RepoItem | None:
|
||||
return self.repos.get(repo_id)
|
||||
|
||||
def get_installed(self, repo_id: str) -> dict[str, Any] | None:
|
||||
"""Return cached installation info for a repo_id (no I/O)."""
|
||||
data = (self._installed_cache or {}).get(repo_id)
|
||||
return data if isinstance(data, dict) else None
|
||||
|
||||
async def refresh(self) -> None:
|
||||
index_repos, refresh_seconds = await self._load_index_repos()
|
||||
self.refresh_seconds = refresh_seconds
|
||||
@@ -322,7 +370,6 @@ class BCSCore:
|
||||
if isinstance(d, list):
|
||||
installed_domains = [str(x) for x in d if str(x).strip()]
|
||||
|
||||
# IMPORTANT: this is the ref we installed (tag/release/branch)
|
||||
v = inst.get("installed_version")
|
||||
installed_version = str(v) if v is not None else None
|
||||
|
||||
@@ -367,7 +414,6 @@ class BCSCore:
|
||||
)
|
||||
|
||||
def _pick_ref_for_install(self, repo: RepoItem) -> str:
|
||||
# Prefer latest_version (release/tag/atom-derived), fallback to default branch, then main.
|
||||
if repo.latest_version and str(repo.latest_version).strip():
|
||||
return str(repo.latest_version).strip()
|
||||
if repo.default_branch and str(repo.default_branch).strip():
|
||||
@@ -375,13 +421,6 @@ class BCSCore:
|
||||
return "main"
|
||||
|
||||
def _build_zip_url(self, repo_url: str, ref: str) -> str:
|
||||
"""Build a public ZIP download URL (provider-neutral, no tokens).
|
||||
|
||||
Supports:
|
||||
- GitHub: codeload
|
||||
- GitLab: /-/archive/
|
||||
- Gitea (incl. Bahmcloud): /archive/<ref>.zip
|
||||
"""
|
||||
ref = (ref or "").strip()
|
||||
if not ref:
|
||||
raise BCSInstallError("Missing ref for ZIP download")
|
||||
@@ -447,6 +486,189 @@ class BCSCore:
|
||||
return candidate
|
||||
return None
|
||||
|
||||
async def _ensure_backup_root(self) -> None:
|
||||
"""Create backup root directory if needed."""
|
||||
def _mkdir() -> None:
|
||||
self._backup_root.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
await self.hass.async_add_executor_job(_mkdir)
|
||||
|
||||
async def _backup_domain(self, domain: str) -> Path | None:
|
||||
"""Backup an existing domain folder.
|
||||
|
||||
Returns the created backup path, or None if the domain folder does not exist.
|
||||
"""
|
||||
dest_root = Path(self.hass.config.path("custom_components"))
|
||||
target = dest_root / domain
|
||||
|
||||
if not target.exists() or not target.is_dir():
|
||||
return None
|
||||
|
||||
await self._ensure_backup_root()
|
||||
|
||||
ts = time.strftime("%Y%m%d_%H%M%S")
|
||||
domain_root = self._backup_root / domain
|
||||
backup_path = domain_root / ts
|
||||
|
||||
def _do_backup() -> None:
|
||||
domain_root.mkdir(parents=True, exist_ok=True)
|
||||
if backup_path.exists():
|
||||
shutil.rmtree(backup_path, ignore_errors=True)
|
||||
shutil.copytree(target, backup_path, dirs_exist_ok=True)
|
||||
|
||||
# Retention: keep only the newest N backups per domain.
|
||||
try:
|
||||
backups = [p for p in domain_root.iterdir() if p.is_dir()]
|
||||
backups.sort(key=lambda p: p.name, reverse=True)
|
||||
for old in backups[self._backup_keep_per_domain :]:
|
||||
shutil.rmtree(old, ignore_errors=True)
|
||||
except Exception:
|
||||
# Never fail install/update because of retention cleanup.
|
||||
pass
|
||||
|
||||
await self.hass.async_add_executor_job(_do_backup)
|
||||
_LOGGER.info("BCS backup created: domain=%s path=%s", domain, backup_path)
|
||||
return backup_path
|
||||
|
||||
async def _restore_domain_from_backup(self, domain: str, backup_path: Path) -> None:
|
||||
"""Restore a domain folder from a backup."""
|
||||
dest_root = Path(self.hass.config.path("custom_components"))
|
||||
target = dest_root / domain
|
||||
|
||||
def _restore() -> None:
|
||||
if not backup_path.exists() or not backup_path.is_dir():
|
||||
return
|
||||
if target.exists():
|
||||
shutil.rmtree(target, ignore_errors=True)
|
||||
shutil.copytree(backup_path, target, dirs_exist_ok=True)
|
||||
|
||||
await self.hass.async_add_executor_job(_restore)
|
||||
_LOGGER.info("BCS rollback applied: domain=%s from=%s", domain, backup_path)
|
||||
|
||||
async def list_repo_backups(self, repo_id: str) -> list[dict[str, Any]]:
|
||||
"""List available backup sets for an installed repository.
|
||||
|
||||
Returns a list of items sorted newest->oldest:
|
||||
{"id": "YYYYMMDD_HHMMSS", "label": "YYYY-MM-DD HH:MM:SS", "complete": bool, "domains": [...] }
|
||||
|
||||
A backup set is considered *complete* if the timestamp exists for all
|
||||
domains of the repository.
|
||||
"""
|
||||
inst = self.get_installed(repo_id) or {}
|
||||
domains = inst.get("domains") or []
|
||||
if not isinstance(domains, list) or not domains:
|
||||
return []
|
||||
|
||||
dom_list = [str(d) for d in domains if str(d).strip()]
|
||||
if not dom_list:
|
||||
return []
|
||||
|
||||
# Collect timestamps per domain.
|
||||
per_domain: dict[str, list[str]] = {}
|
||||
for d in dom_list:
|
||||
per_domain[d] = await self._list_domain_backup_ids(d)
|
||||
|
||||
# Build a map id -> domains where it exists
|
||||
id_map: dict[str, set[str]] = {}
|
||||
for d, ids in per_domain.items():
|
||||
for bid in ids:
|
||||
id_map.setdefault(bid, set()).add(d)
|
||||
|
||||
all_domains = set(dom_list)
|
||||
items: list[dict[str, Any]] = []
|
||||
for bid, present in id_map.items():
|
||||
complete = present == all_domains
|
||||
label = self._format_backup_id(bid)
|
||||
items.append({"id": bid, "label": label, "complete": complete, "domains": sorted(present)})
|
||||
|
||||
# Sort newest first by id (lexicographic works for timestamp format).
|
||||
items.sort(key=lambda x: str(x.get("id") or ""), reverse=True)
|
||||
|
||||
# Keep newest 5 entries overall (UI expects up to 5).
|
||||
return items[: self._backup_keep_per_domain]
|
||||
|
||||
async def restore_repo_backup(self, repo_id: str, backup_id: str) -> dict[str, Any]:
|
||||
"""Restore a previously created backup set for a repository."""
|
||||
repo_id = str(repo_id or "").strip()
|
||||
backup_id = str(backup_id or "").strip()
|
||||
if not repo_id:
|
||||
raise BCSInstallError("Missing repo_id")
|
||||
if not backup_id:
|
||||
raise BCSInstallError("Missing backup_id")
|
||||
|
||||
inst = self.get_installed(repo_id)
|
||||
if not inst:
|
||||
raise BCSInstallError("Repository is not installed")
|
||||
|
||||
domains = inst.get("domains") or []
|
||||
if not isinstance(domains, list) or not domains:
|
||||
raise BCSInstallError("No installed domains found")
|
||||
|
||||
dom_list = [str(d) for d in domains if str(d).strip()]
|
||||
if not dom_list:
|
||||
raise BCSInstallError("No installed domains found")
|
||||
|
||||
# Ensure the backup exists for all domains.
|
||||
missing: list[str] = []
|
||||
for d in dom_list:
|
||||
p = self._backup_root / d / backup_id
|
||||
if not p.exists() or not p.is_dir():
|
||||
missing.append(d)
|
||||
if missing:
|
||||
raise BCSInstallError(f"Selected backup is not available for all domains: missing={missing}")
|
||||
|
||||
async with self._install_lock:
|
||||
_LOGGER.info("BCS restore started: repo_id=%s backup_id=%s domains=%s", repo_id, backup_id, dom_list)
|
||||
|
||||
# Safety: create a new backup of current state before restoring.
|
||||
for d in dom_list:
|
||||
try:
|
||||
await self._backup_domain(d)
|
||||
except Exception:
|
||||
_LOGGER.debug("BCS pre-restore backup failed for domain=%s", d, exc_info=True)
|
||||
|
||||
# Apply restore.
|
||||
for d in dom_list:
|
||||
await self._restore_domain_from_backup(d, self._backup_root / d / backup_id)
|
||||
|
||||
await self._refresh_installed_cache()
|
||||
self._mark_restart_required()
|
||||
self.signal_updated()
|
||||
|
||||
_LOGGER.info("BCS restore complete: repo_id=%s backup_id=%s", repo_id, backup_id)
|
||||
return {"ok": True, "repo_id": repo_id, "backup_id": backup_id, "domains": dom_list, "restart_required": True}
|
||||
|
||||
async def _list_domain_backup_ids(self, domain: str) -> list[str]:
|
||||
"""List backup ids for a domain (newest->oldest)."""
|
||||
domain = str(domain or "").strip()
|
||||
if not domain:
|
||||
return []
|
||||
|
||||
root = self._backup_root / domain
|
||||
|
||||
def _list() -> list[str]:
|
||||
if not root.exists() or not root.is_dir():
|
||||
return []
|
||||
ids = [p.name for p in root.iterdir() if p.is_dir()]
|
||||
ids.sort(reverse=True)
|
||||
return ids
|
||||
|
||||
ids = await self.hass.async_add_executor_job(_list)
|
||||
return ids[: self._backup_keep_per_domain]
|
||||
|
||||
@staticmethod
|
||||
def _format_backup_id(backup_id: str) -> str:
|
||||
"""Format backup id YYYYMMDD_HHMMSS -> YYYY-MM-DD HH:MM:SS."""
|
||||
s = str(backup_id or "").strip()
|
||||
if len(s) != 15 or "_" not in s:
|
||||
return s
|
||||
try:
|
||||
d, t = s.split("_", 1)
|
||||
return f"{d[0:4]}-{d[4:6]}-{d[6:8]} {t[0:2]}:{t[2:4]}:{t[4:6]}"
|
||||
except Exception:
|
||||
return s
|
||||
|
||||
|
||||
async def _copy_domain_dir(self, src_domain_dir: Path, domain: str) -> None:
|
||||
dest_root = Path(self.hass.config.path("custom_components"))
|
||||
target = dest_root / domain
|
||||
@@ -480,21 +702,93 @@ class BCSCore:
|
||||
return await self.hass.async_add_executor_job(_read)
|
||||
|
||||
async def _refresh_installed_cache(self) -> None:
|
||||
"""Refresh installed cache and reconcile with filesystem.
|
||||
|
||||
If a user manually deletes a domain folder under /config/custom_components,
|
||||
we automatically remove the installed flag from our storage so the Store UI
|
||||
does not show stale "installed" state.
|
||||
"""
|
||||
try:
|
||||
items = await self.storage.list_installed_repos()
|
||||
cache: dict[str, Any] = {}
|
||||
|
||||
# Determine which installed repos still exist on disk.
|
||||
cc_root = Path(self.hass.config.path("custom_components"))
|
||||
to_remove: list[str] = []
|
||||
|
||||
for it in items:
|
||||
domains = [str(d) for d in (it.domains or []) if str(d).strip()]
|
||||
|
||||
# A repo is considered "present" if at least one of its domains
|
||||
# exists and contains a manifest.json.
|
||||
present = False
|
||||
for d in domains:
|
||||
p = cc_root / d
|
||||
if p.is_dir() and (p / "manifest.json").exists():
|
||||
present = True
|
||||
break
|
||||
|
||||
if not present:
|
||||
to_remove.append(it.repo_id)
|
||||
continue
|
||||
|
||||
cache[it.repo_id] = {
|
||||
"domains": it.domains,
|
||||
"installed_version": it.installed_version, # BCS ref
|
||||
"installed": True,
|
||||
"domains": domains,
|
||||
"installed_version": it.installed_version,
|
||||
"installed_manifest_version": it.installed_manifest_version,
|
||||
"ref": it.ref,
|
||||
"installed_at": it.installed_at,
|
||||
}
|
||||
|
||||
# Remove stale installed entries from storage.
|
||||
for rid in to_remove:
|
||||
try:
|
||||
await self.storage.remove_installed_repo(rid)
|
||||
_LOGGER.info("BCS reconcile: removed stale installed repo_id=%s", rid)
|
||||
except Exception:
|
||||
_LOGGER.debug("BCS reconcile: failed removing stale repo_id=%s", rid, exc_info=True)
|
||||
|
||||
self._installed_cache = cache
|
||||
except Exception:
|
||||
self._installed_cache = {}
|
||||
|
||||
async def uninstall_repo(self, repo_id: str) -> dict[str, Any]:
|
||||
"""Uninstall a repository by deleting its installed domains and clearing storage."""
|
||||
async with self._install_lock:
|
||||
inst = await self.storage.get_installed_repo(repo_id)
|
||||
if not inst:
|
||||
# Already uninstalled.
|
||||
await self._refresh_installed_cache()
|
||||
self.signal_updated()
|
||||
return {"ok": True, "repo_id": repo_id, "removed": [], "restart_required": False}
|
||||
|
||||
cc_root = Path(self.hass.config.path("custom_components"))
|
||||
removed: list[str] = []
|
||||
|
||||
def _remove_dir(path: Path) -> None:
|
||||
if path.exists() and path.is_dir():
|
||||
shutil.rmtree(path, ignore_errors=True)
|
||||
|
||||
for domain in inst.domains:
|
||||
d = str(domain).strip()
|
||||
if not d:
|
||||
continue
|
||||
target = cc_root / d
|
||||
await self.hass.async_add_executor_job(_remove_dir, target)
|
||||
removed.append(d)
|
||||
|
||||
await self.storage.remove_installed_repo(repo_id)
|
||||
await self._refresh_installed_cache()
|
||||
|
||||
# Show restart required in Settings.
|
||||
if removed:
|
||||
self._mark_restart_required()
|
||||
|
||||
_LOGGER.info("BCS uninstall complete: repo_id=%s removed_domains=%s", repo_id, removed)
|
||||
self.signal_updated()
|
||||
return {"ok": True, "repo_id": repo_id, "removed": removed, "restart_required": bool(removed)}
|
||||
|
||||
async def install_repo(self, repo_id: str) -> dict[str, Any]:
|
||||
repo = self.get_repo(repo_id)
|
||||
if not repo:
|
||||
@@ -506,74 +800,110 @@ class BCSCore:
|
||||
|
||||
_LOGGER.info("BCS install started: repo_id=%s ref=%s zip_url=%s", repo_id, ref, zip_url)
|
||||
|
||||
with tempfile.TemporaryDirectory(prefix="bcs_install_") as td:
|
||||
tmp = Path(td)
|
||||
zip_path = tmp / "repo.zip"
|
||||
extract_dir = tmp / "extract"
|
||||
extract_dir.mkdir(parents=True, exist_ok=True)
|
||||
installed_domains: list[str] = []
|
||||
backups: dict[str, Path] = {}
|
||||
created_new: set[str] = set()
|
||||
|
||||
await self._download_zip(zip_url, zip_path)
|
||||
await self._extract_zip(zip_path, extract_dir)
|
||||
try:
|
||||
with tempfile.TemporaryDirectory(prefix="bcs_install_") as td:
|
||||
tmp = Path(td)
|
||||
zip_path = tmp / "repo.zip"
|
||||
extract_dir = tmp / "extract"
|
||||
extract_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
cc_root = self._find_custom_components_root(extract_dir)
|
||||
if not cc_root:
|
||||
raise BCSInstallError("custom_components folder not found in repository ZIP")
|
||||
await self._download_zip(zip_url, zip_path)
|
||||
await self._extract_zip(zip_path, extract_dir)
|
||||
|
||||
installed_domains: list[str] = []
|
||||
for domain_dir in cc_root.iterdir():
|
||||
if not domain_dir.is_dir():
|
||||
continue
|
||||
manifest = domain_dir / "manifest.json"
|
||||
if not manifest.exists():
|
||||
continue
|
||||
cc_root = self._find_custom_components_root(extract_dir)
|
||||
if not cc_root:
|
||||
raise BCSInstallError("custom_components folder not found in repository ZIP")
|
||||
|
||||
domain = domain_dir.name
|
||||
await self._copy_domain_dir(domain_dir, domain)
|
||||
installed_domains.append(domain)
|
||||
dest_root = Path(self.hass.config.path("custom_components"))
|
||||
|
||||
if not installed_domains:
|
||||
raise BCSInstallError("No integrations found under custom_components/ (missing manifest.json)")
|
||||
for domain_dir in cc_root.iterdir():
|
||||
if not domain_dir.is_dir():
|
||||
continue
|
||||
manifest = domain_dir / "manifest.json"
|
||||
if not manifest.exists():
|
||||
continue
|
||||
|
||||
# informational only (many repos are wrong here)
|
||||
installed_manifest_version = await self._read_installed_manifest_version(installed_domains[0])
|
||||
domain = domain_dir.name
|
||||
target = dest_root / domain
|
||||
|
||||
# IMPORTANT: BCS "installed_version" is the ref we installed (tag/release/branch),
|
||||
# so update logic won't break when manifest.json is 0.0.0 or outdated.
|
||||
installed_version = ref
|
||||
# Backup only if we are going to overwrite an existing domain.
|
||||
if target.exists() and target.is_dir():
|
||||
bkp = await self._backup_domain(domain)
|
||||
if bkp:
|
||||
backups[domain] = bkp
|
||||
else:
|
||||
created_new.add(domain)
|
||||
|
||||
await self.storage.set_installed_repo(
|
||||
repo_id=repo_id,
|
||||
url=repo.url,
|
||||
domains=installed_domains,
|
||||
installed_version=installed_version,
|
||||
installed_manifest_version=installed_manifest_version,
|
||||
ref=ref,
|
||||
)
|
||||
await self._refresh_installed_cache()
|
||||
await self._copy_domain_dir(domain_dir, domain)
|
||||
installed_domains.append(domain)
|
||||
|
||||
persistent_notification.async_create(
|
||||
self.hass,
|
||||
"Bahmcloud Store installation finished. A Home Assistant restart is required to load the integration.",
|
||||
title="Bahmcloud Store",
|
||||
notification_id="bcs_restart_required",
|
||||
)
|
||||
if not installed_domains:
|
||||
raise BCSInstallError("No integrations found under custom_components/ (missing manifest.json)")
|
||||
|
||||
_LOGGER.info(
|
||||
"BCS install complete: repo_id=%s domains=%s installed_ref=%s manifest_version=%s",
|
||||
repo_id,
|
||||
installed_domains,
|
||||
installed_version,
|
||||
installed_manifest_version,
|
||||
)
|
||||
self.signal_updated()
|
||||
return {
|
||||
"ok": True,
|
||||
"repo_id": repo_id,
|
||||
"domains": installed_domains,
|
||||
"installed_version": installed_version,
|
||||
"installed_manifest_version": installed_manifest_version,
|
||||
"restart_required": True,
|
||||
}
|
||||
installed_manifest_version = await self._read_installed_manifest_version(installed_domains[0])
|
||||
installed_version = ref
|
||||
|
||||
await self.storage.set_installed_repo(
|
||||
repo_id=repo_id,
|
||||
url=repo.url,
|
||||
domains=installed_domains,
|
||||
installed_version=installed_version,
|
||||
installed_manifest_version=installed_manifest_version,
|
||||
ref=ref,
|
||||
)
|
||||
await self._refresh_installed_cache()
|
||||
|
||||
self._mark_restart_required()
|
||||
|
||||
_LOGGER.info(
|
||||
"BCS install complete: repo_id=%s domains=%s installed_ref=%s manifest_version=%s",
|
||||
repo_id,
|
||||
installed_domains,
|
||||
installed_version,
|
||||
installed_manifest_version,
|
||||
)
|
||||
self.signal_updated()
|
||||
return {
|
||||
"ok": True,
|
||||
"repo_id": repo_id,
|
||||
"domains": installed_domains,
|
||||
"installed_version": installed_version,
|
||||
"installed_manifest_version": installed_manifest_version,
|
||||
"restart_required": True,
|
||||
}
|
||||
|
||||
except Exception as e:
|
||||
# Roll back any domains we touched.
|
||||
_LOGGER.error("BCS install failed, attempting rollback: repo_id=%s error=%s", repo_id, e)
|
||||
|
||||
dest_root = Path(self.hass.config.path("custom_components"))
|
||||
|
||||
# Restore backed-up domains.
|
||||
for domain, bkp in backups.items():
|
||||
try:
|
||||
await self._restore_domain_from_backup(domain, bkp)
|
||||
except Exception:
|
||||
_LOGGER.debug("BCS rollback failed for domain=%s", domain, exc_info=True)
|
||||
|
||||
# Remove newly created domains if the install did not complete.
|
||||
for domain in created_new:
|
||||
try:
|
||||
target = dest_root / domain
|
||||
def _rm() -> None:
|
||||
if target.exists() and target.is_dir():
|
||||
shutil.rmtree(target, ignore_errors=True)
|
||||
await self.hass.async_add_executor_job(_rm)
|
||||
except Exception:
|
||||
_LOGGER.debug("BCS cleanup failed for new domain=%s", domain, exc_info=True)
|
||||
|
||||
# Re-raise as install error for clean API response.
|
||||
if isinstance(e, BCSInstallError):
|
||||
raise
|
||||
raise BCSInstallError(str(e)) from e
|
||||
|
||||
async def update_repo(self, repo_id: str) -> dict[str, Any]:
|
||||
_LOGGER.info("BCS update started: repo_id=%s", repo_id)
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
{
|
||||
"domain": "bahmcloud_store",
|
||||
"name": "Bahmcloud Store",
|
||||
"version": "0.5.2",
|
||||
"version": "0.6.0",
|
||||
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
||||
"platforms": ["update"],
|
||||
"requirements": [],
|
||||
"codeowners": ["@bahmcloud"],
|
||||
"iot_class": "local_polling"
|
||||
|
||||
@@ -29,6 +29,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
|
||||
this._installingRepoId = null;
|
||||
this._updatingRepoId = null;
|
||||
this._uninstallingRepoId = null;
|
||||
this._restartRequired = false;
|
||||
this._lastActionMsg = null;
|
||||
}
|
||||
@@ -141,6 +142,36 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
}
|
||||
}
|
||||
|
||||
async _uninstallRepo(repoId) {
|
||||
if (!repoId) return;
|
||||
if (this._installingRepoId || this._updatingRepoId || this._uninstallingRepoId) return;
|
||||
|
||||
const r = this._repoById(repoId);
|
||||
const name = this._safeText(r?.name) || repoId;
|
||||
|
||||
const ok = window.confirm(`Uninstall "${name}"?\n\nThis will delete the integration folder(s) from /config/custom_components. A restart will be required.`);
|
||||
if (!ok) return;
|
||||
|
||||
this._uninstallingRepoId = repoId;
|
||||
this._lastActionMsg = null;
|
||||
this.requestUpdate();
|
||||
|
||||
try {
|
||||
const resp = await this._hass.callApi("post", `bcs/uninstall?repo_id=${encodeURIComponent(repoId)}`, {});
|
||||
if (resp && resp.ok) {
|
||||
this._restartRequired = !!resp.restart_required;
|
||||
this._lastActionMsg = "Uninstalled. Restart required.";
|
||||
} else {
|
||||
this._lastActionMsg = (resp && resp.message) ? String(resp.message) : "Uninstall failed.";
|
||||
}
|
||||
} catch (e) {
|
||||
this._lastActionMsg = e && e.message ? e.message : "Uninstall failed.";
|
||||
} finally {
|
||||
this._uninstallingRepoId = null;
|
||||
await this._load();
|
||||
}
|
||||
}
|
||||
|
||||
async _restartHA() {
|
||||
if (!this._hass) return;
|
||||
try {
|
||||
@@ -436,15 +467,15 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
|
||||
<div class="mobilebar">
|
||||
<div class="left">
|
||||
<div class="iconbtn" id="menuBtn" title="Menu">☰</div>
|
||||
<div class="iconbtn" id="backBtn" title="Back">←</div>
|
||||
<div class="iconbtn" id="menuBtn" title="Menu">鈽<EFBFBD></div>
|
||||
<div class="iconbtn" id="backBtn" title="Back">鈫<EFBFBD></div>
|
||||
<div>
|
||||
<div style="font-weight:700;">Bahmcloud Store</div>
|
||||
<div class="muted small" id="subtitle">Store</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="right">
|
||||
<div class="iconbtn" id="refreshBtn" title="Refresh">⟳</div>
|
||||
<div class="iconbtn" id="refreshBtn" title="Refresh">鉄<EFBFBD></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -506,7 +537,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
: "";
|
||||
|
||||
if (this._loading) {
|
||||
content.innerHTML = `${err}<div class="card">Loading…</div>`;
|
||||
content.innerHTML = `${err}<div class="card">Loading鈥<EFBFBD></div>`;
|
||||
fabs.innerHTML = "";
|
||||
return;
|
||||
}
|
||||
@@ -608,7 +639,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
if (updateAvailable) badges.push("Update");
|
||||
|
||||
const badgeHtml = badges.length
|
||||
? `<div class="badge">${this._esc(badges.join(" · "))}</div>`
|
||||
? `<div class="badge">${this._esc(badges.join(" 路 "))}</div>`
|
||||
: `<div class="badge">${this._esc(this._safeText(r?.provider || "repo"))}</div>`;
|
||||
|
||||
return `
|
||||
@@ -628,7 +659,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
|
||||
return `
|
||||
<div class="filters">
|
||||
<input id="q" placeholder="Search…" value="${this._esc(this._search)}" />
|
||||
<input id="q" placeholder="Search鈥<EFBFBD>" value="${this._esc(this._search)}" />
|
||||
<select id="cat">
|
||||
<option value="all">All categories</option>
|
||||
${categories.map((c) => `<option value="${this._esc(c)}" ${this._category === c ? "selected" : ""}>${this._esc(c)}</option>`).join("")}
|
||||
@@ -640,7 +671,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="muted small">Version: ${this._esc(this._data.version || "-")} · Repositories: ${repos.length}</div>
|
||||
<div class="muted small">Version: ${this._esc(this._data.version || "-")} 路 Repositories: ${repos.length}</div>
|
||||
|
||||
<div class="grid" style="margin-top:12px;">
|
||||
${cards || `<div class="card">No repositories found.</div>`}
|
||||
@@ -713,7 +744,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
].filter(Boolean);
|
||||
|
||||
const readmeBlock = this._readmeLoading
|
||||
? `<div class="card">Loading README…</div>`
|
||||
? `<div class="card">Loading README鈥<EFBFBD></div>`
|
||||
: this._readmeText
|
||||
? `
|
||||
<div class="card">
|
||||
@@ -748,12 +779,14 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
|
||||
const busyInstall = this._installingRepoId === repoId;
|
||||
const busyUpdate = this._updatingRepoId === repoId;
|
||||
const busy = busyInstall || busyUpdate;
|
||||
const busyUninstall = this._uninstallingRepoId === repoId;
|
||||
const busy = busyInstall || busyUpdate || busyUninstall;
|
||||
|
||||
const updateAvailable = installed && !!latestVersion && (!installedVersion || latestVersion !== installedVersion);
|
||||
|
||||
const installBtn = `<button class="primary" id="btnInstall" ${installed || busy ? "disabled" : ""}>${busyInstall ? "Installing…" : installed ? "Installed" : "Install"}</button>`;
|
||||
const updateBtn = `<button class="primary" id="btnUpdate" ${!updateAvailable || busy ? "disabled" : ""}>${busyUpdate ? "Updating…" : updateAvailable ? "Update" : "Up to date"}</button>`;
|
||||
const installBtn = `<button class="primary" id="btnInstall" ${installed || busy ? "disabled" : ""}>${busyInstall ? "Installing鈥<EFBFBD>" : installed ? "Installed" : "Install"}</button>`;
|
||||
const updateBtn = `<button class="primary" id="btnUpdate" ${!updateAvailable || busy ? "disabled" : ""}>${busyUpdate ? "Updating鈥<EFBFBD>" : updateAvailable ? "Update" : "Up to date"}</button>`;
|
||||
const uninstallBtn = `<button id="btnUninstall" ${!installed || busy ? "disabled" : ""}>${busyUninstall ? "Uninstalling鈥<67>" : "Uninstall"}</button>`;
|
||||
|
||||
const restartHint = this._restartRequired
|
||||
? `
|
||||
@@ -777,7 +810,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
<div>
|
||||
<div><strong style="font-size:16px;">${this._esc(name)}</strong></div>
|
||||
<div class="muted">${this._esc(desc)}</div>
|
||||
<div class="muted small" style="margin-top:8px;">${this._esc(infoBits.join(" · "))}</div>
|
||||
<div class="muted small" style="margin-top:8px;">${this._esc(infoBits.join(" 路 "))}</div>
|
||||
<div class="muted small" style="margin-top:8px;">
|
||||
<a href="${this._esc(url)}" target="_blank" rel="noreferrer">Open repository</a>
|
||||
</div>
|
||||
@@ -805,6 +838,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
<div class="row" style="margin-top:14px; gap:10px; flex-wrap:wrap;">
|
||||
${installBtn}
|
||||
${updateBtn}
|
||||
${uninstallBtn}
|
||||
</div>
|
||||
|
||||
${restartHint}
|
||||
@@ -820,6 +854,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
// Always wire action buttons (even if README is already loaded)
|
||||
const btnInstall = root.getElementById("btnInstall");
|
||||
const btnUpdate = root.getElementById("btnUpdate");
|
||||
const btnUninstall = root.getElementById("btnUninstall");
|
||||
const btnRestart = root.getElementById("btnRestart");
|
||||
|
||||
if (btnInstall) {
|
||||
@@ -836,6 +871,13 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
});
|
||||
}
|
||||
|
||||
if (btnUninstall) {
|
||||
btnUninstall.addEventListener("click", () => {
|
||||
if (btnUninstall.disabled) return;
|
||||
if (this._detailRepoId) this._uninstallRepo(this._detailRepoId);
|
||||
});
|
||||
}
|
||||
|
||||
if (btnRestart) {
|
||||
btnRestart.addEventListener("click", () => this._restartHA());
|
||||
}
|
||||
@@ -848,7 +890,7 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
mount.innerHTML = this._readmeHtml;
|
||||
this._postprocessRenderedMarkdown(mount);
|
||||
} else {
|
||||
mount.innerHTML = `<div class="muted">Rendered HTML not available. Use “Show raw Markdown”.</div>`;
|
||||
mount.innerHTML = `<div class="muted">Rendered HTML not available. Use 鈥淪how raw Markdown鈥<EFBFBD>.</div>`;
|
||||
}
|
||||
} else {
|
||||
mount.innerHTML = "";
|
||||
@@ -883,10 +925,10 @@ class BahmcloudStorePanel extends HTMLElement {
|
||||
|
||||
return `
|
||||
<div class="fabs">
|
||||
<button class="fabbtn primary" id="fabOpen" title="Open repository">↗</button>
|
||||
<button class="fabbtn" id="fabReload" title="Reload README">⟳</button>
|
||||
<button class="fabbtn" id="fabInstall" title="${installDisabled ? (installed ? "Already installed" : "Installing…") : "Install"}" ${installDisabled ? "disabled" : ""}>+</button>
|
||||
<button class="fabbtn" id="fabUpdate" title="${updateDisabled ? (!installed ? "Not installed" : "No update available") : "Update"}" ${updateDisabled ? "disabled" : ""}>↑</button>
|
||||
<button class="fabbtn primary" id="fabOpen" title="Open repository">鈫<EFBFBD></button>
|
||||
<button class="fabbtn" id="fabReload" title="Reload README">鉄<EFBFBD></button>
|
||||
<button class="fabbtn" id="fabInstall" title="${installDisabled ? (installed ? "Already installed" : "Installing鈥<EFBFBD>") : "Install"}" ${installDisabled ? "disabled" : ""}>锛<EFBFBD></button>
|
||||
<button class="fabbtn" id="fabUpdate" title="${updateDisabled ? (!installed ? "Not installed" : "No update available") : "Update"}" ${updateDisabled ? "disabled" : ""}>鈫<EFBFBD></button>
|
||||
<button class="fabbtn" id="fabInfo" title="About">i</button>
|
||||
</div>
|
||||
`;
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,10 +1,24 @@
|
||||
body { font-family: system-ui, sans-serif; margin:0; }
|
||||
.wrap { padding: 16px; max-width: 1000px; margin: 0 auto; }
|
||||
.card { border: 1px solid #ddd; border-radius: 10px; padding: 12px; margin: 10px 0; }
|
||||
.row { display:flex; justify-content:space-between; gap: 12px; align-items: flex-start; }
|
||||
.row { display:flex; justify-content:space-between; gap: 12px; align-items: flex-start; flex-wrap: wrap; min-width:0; }
|
||||
.badge { border: 1px solid #bbb; border-radius: 999px; padding: 2px 8px; font-size: 12px; height: fit-content; }
|
||||
.muted { color: #666; font-size: 13px; margin-top: 4px; }
|
||||
.actions { display:flex; gap: 8px; margin-top: 10px; }
|
||||
button { padding: 8px 12px; cursor:pointer; }
|
||||
button[disabled] { opacity: 0.6; cursor: not-allowed; }
|
||||
a { color: inherit; }
|
||||
|
||||
/* Basic markdown safety (in case styles.css is used by older panels) */
|
||||
.md { max-width: 100%; overflow-x: auto; }
|
||||
.md table { display:block; max-width:100%; overflow-x:auto; }
|
||||
.md img { max-width: 100%; height: auto; }
|
||||
|
||||
/* README UX (E2): collapsible preview (standalone page only) */
|
||||
.readmeWrap{ border:1px solid #ddd; border-radius:10px; padding:12px; background: #f7f7f7; max-width:100%; }
|
||||
.readmeWrap.collapsed{ max-height:260px; overflow:hidden; position:relative; }
|
||||
.readmeWrap.collapsed::after{ content:""; position:absolute; left:0; right:0; bottom:0; height:56px; background: linear-gradient(to bottom, rgba(247,247,247,0), #f7f7f7); pointer-events:none; }
|
||||
.readmeWrap.expanded{ max-height:70vh; overflow:auto; }
|
||||
.readmeActions{ display:flex; justify-content:flex-end; margin-top:10px; }
|
||||
button.link{ border:none; background:transparent; padding:6px 10px; color:#1E88E5; }
|
||||
button.link:hover{ text-decoration:underline; }
|
||||
|
||||
55
custom_components/bahmcloud_store/repairs.py
Normal file
55
custom_components/bahmcloud_store/repairs.py
Normal file
@@ -0,0 +1,55 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.repairs import RepairsFlow
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant import data_entry_flow
|
||||
|
||||
from .core import RESTART_REQUIRED_ISSUE_ID
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class BCSRestartRequiredFlow(RepairsFlow):
|
||||
"""Repairs flow to restart Home Assistant after BCS install/update."""
|
||||
|
||||
def __init__(self, hass: HomeAssistant) -> None:
|
||||
self.hass = hass
|
||||
|
||||
async def async_step_init(
|
||||
self, user_input: dict[str, str] | None = None
|
||||
) -> data_entry_flow.FlowResult:
|
||||
return await self.async_step_confirm(user_input)
|
||||
|
||||
async def async_step_confirm(
|
||||
self, user_input: dict[str, str] | None = None
|
||||
) -> data_entry_flow.FlowResult:
|
||||
if user_input is not None:
|
||||
_LOGGER.info("BCS repairs flow: restarting Home Assistant (user confirmed)")
|
||||
await self.hass.services.async_call(
|
||||
"homeassistant",
|
||||
"restart",
|
||||
{},
|
||||
blocking=False,
|
||||
)
|
||||
return self.async_create_entry(title="", data={})
|
||||
|
||||
return self.async_show_form(
|
||||
step_id="confirm",
|
||||
data_schema=vol.Schema({}),
|
||||
)
|
||||
|
||||
|
||||
async def async_create_fix_flow(
|
||||
hass: HomeAssistant,
|
||||
issue_id: str,
|
||||
data: dict[str, str | int | float | None] | None,
|
||||
) -> RepairsFlow:
|
||||
"""Create a repairs flow for BCS fixable issues."""
|
||||
if issue_id == RESTART_REQUIRED_ISSUE_ID:
|
||||
return BCSRestartRequiredFlow(hass)
|
||||
|
||||
raise data_entry_flow.UnknownHandler
|
||||
18
custom_components/bahmcloud_store/strings.json
Normal file
18
custom_components/bahmcloud_store/strings.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"issues": {
|
||||
"restart_required": {
|
||||
"title": "Restart required",
|
||||
"description": "One or more integrations were installed or updated by Bahmcloud Store. Restart Home Assistant to load the changes."
|
||||
}
|
||||
},
|
||||
"repair_flow": {
|
||||
"restart_required": {
|
||||
"step": {
|
||||
"confirm": {
|
||||
"title": "Restart Home Assistant",
|
||||
"description": "Bahmcloud Store installed or updated integrations. Restart Home Assistant now to apply the changes."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,11 +1,142 @@
|
||||
from __future__ import annotations
|
||||
|
||||
# NOTE:
|
||||
# Update entities will be implemented once installation/provider resolution is in place.
|
||||
# This stub prevents platform load errors and keeps the integration stable in 0.3.0.
|
||||
import logging
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.components.update import UpdateEntity, UpdateEntityFeature
|
||||
from homeassistant.core import HomeAssistant, callback
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.entity import EntityCategory
|
||||
|
||||
from .core import DOMAIN, SIGNAL_UPDATED, BCSCore
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def _pretty_repo_name(core: BCSCore, repo_id: str) -> str:
|
||||
"""Return a human-friendly name for a repo update entity."""
|
||||
try:
|
||||
repo = core.get_repo(repo_id)
|
||||
if repo and getattr(repo, "name", None):
|
||||
name = str(repo.name).strip()
|
||||
if name:
|
||||
return name
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
if repo_id.startswith("index:"):
|
||||
return f"BCS Index {repo_id.split(':', 1)[1]}"
|
||||
if repo_id.startswith("custom:"):
|
||||
return f"BCS Custom {repo_id.split(':', 1)[1]}"
|
||||
return f"BCS {repo_id}"
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class _RepoKey:
|
||||
repo_id: str
|
||||
|
||||
|
||||
class BCSRepoUpdateEntity(UpdateEntity):
|
||||
"""Update entity representing a BCS-managed repository."""
|
||||
|
||||
_attr_entity_category = EntityCategory.DIAGNOSTIC
|
||||
_attr_supported_features = UpdateEntityFeature.INSTALL
|
||||
|
||||
def __init__(self, core: BCSCore, repo_id: str) -> None:
|
||||
self._core = core
|
||||
self._repo_id = repo_id
|
||||
self._in_progress = False
|
||||
|
||||
# Stable unique id (do NOT change)
|
||||
self._attr_unique_id = f"{DOMAIN}:{repo_id}"
|
||||
|
||||
self._refresh_display_name()
|
||||
|
||||
def _refresh_display_name(self) -> None:
|
||||
pretty = _pretty_repo_name(self._core, self._repo_id)
|
||||
self._attr_name = pretty
|
||||
self._attr_title = pretty
|
||||
|
||||
@property
|
||||
def available(self) -> bool:
|
||||
repo = self._core.get_repo(self._repo_id)
|
||||
installed = self._core.get_installed(self._repo_id)
|
||||
return repo is not None and installed is not None
|
||||
|
||||
@property
|
||||
def in_progress(self) -> bool | None:
|
||||
return self._in_progress
|
||||
|
||||
@property
|
||||
def installed_version(self) -> str | None:
|
||||
installed = self._core.get_installed(self._repo_id) or {}
|
||||
v = installed.get("installed_version") or installed.get("ref")
|
||||
return str(v) if v else None
|
||||
|
||||
@property
|
||||
def latest_version(self) -> str | None:
|
||||
repo = self._core.get_repo(self._repo_id)
|
||||
if not repo:
|
||||
return None
|
||||
v = getattr(repo, "latest_version", None)
|
||||
return str(v) if v else None
|
||||
|
||||
@property
|
||||
def update_available(self) -> bool:
|
||||
latest = self.latest_version
|
||||
installed = self.installed_version
|
||||
if not latest or not installed:
|
||||
return False
|
||||
return latest != installed
|
||||
|
||||
def version_is_newer(self, latest_version: str, installed_version: str) -> bool:
|
||||
return latest_version != installed_version
|
||||
|
||||
@property
|
||||
def release_url(self) -> str | None:
|
||||
repo = self._core.get_repo(self._repo_id)
|
||||
return getattr(repo, "url", None) if repo else None
|
||||
|
||||
async def async_install(self, version: str | None, backup: bool, **kwargs: Any) -> None:
|
||||
if version is not None:
|
||||
_LOGGER.debug("BCS update entity requested specific version=%s (ignored)", version)
|
||||
|
||||
self._in_progress = True
|
||||
self.async_write_ha_state()
|
||||
|
||||
try:
|
||||
await self._core.update_repo(self._repo_id)
|
||||
finally:
|
||||
self._in_progress = False
|
||||
self.async_write_ha_state()
|
||||
|
||||
|
||||
@callback
|
||||
def _sync_entities(core: BCSCore, existing: dict[str, BCSRepoUpdateEntity], async_add_entities: AddEntitiesCallback) -> None:
|
||||
"""Ensure there is one update entity per installed repo AND keep names in sync."""
|
||||
installed_map = getattr(core, "_installed_cache", {}) or {}
|
||||
new_entities: list[BCSRepoUpdateEntity] = []
|
||||
|
||||
for repo_id, data in installed_map.items():
|
||||
if not isinstance(data, dict):
|
||||
continue
|
||||
|
||||
if repo_id in existing:
|
||||
# IMPORTANT: Update display name after refresh, when repo.name becomes available.
|
||||
existing[repo_id]._refresh_display_name()
|
||||
continue
|
||||
|
||||
ent = BCSRepoUpdateEntity(core, repo_id)
|
||||
existing[repo_id] = ent
|
||||
new_entities.append(ent)
|
||||
|
||||
if new_entities:
|
||||
async_add_entities(new_entities)
|
||||
|
||||
for ent in existing.values():
|
||||
ent.async_write_ha_state()
|
||||
|
||||
|
||||
async def async_setup_platform(
|
||||
@@ -14,4 +145,18 @@ async def async_setup_platform(
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
discovery_info=None,
|
||||
):
|
||||
return
|
||||
"""Set up BCS update entities."""
|
||||
core: BCSCore | None = hass.data.get(DOMAIN)
|
||||
if not core:
|
||||
_LOGGER.debug("BCS core not available, skipping update platform setup")
|
||||
return
|
||||
|
||||
entities: dict[str, BCSRepoUpdateEntity] = {}
|
||||
|
||||
_sync_entities(core, entities, async_add_entities)
|
||||
|
||||
@callback
|
||||
def _handle_update() -> None:
|
||||
_sync_entities(core, entities, async_add_entities)
|
||||
|
||||
async_dispatcher_connect(hass, SIGNAL_UPDATED, _handle_update)
|
||||
@@ -334,6 +334,74 @@ class BCSUpdateView(HomeAssistantView):
|
||||
return web.json_response({"ok": False, "message": str(e) or "Update failed"}, status=500)
|
||||
|
||||
|
||||
class BCSUninstallView(HomeAssistantView):
|
||||
url = "/api/bcs/uninstall"
|
||||
name = "api:bcs_uninstall"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
result = await self.core.uninstall_repo(repo_id)
|
||||
return web.json_response(result, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS uninstall failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "Uninstall failed"}, status=500)
|
||||
|
||||
|
||||
|
||||
|
||||
class BCSBackupsView(HomeAssistantView):
|
||||
url = "/api/bcs/backups"
|
||||
name = "api:bcs_backups"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def get(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
|
||||
try:
|
||||
backups = await self.core.list_repo_backups(repo_id)
|
||||
return web.json_response({"ok": True, "repo_id": repo_id, "backups": backups}, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS list backups failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "List backups failed"}, status=500)
|
||||
|
||||
|
||||
class BCSRestoreView(HomeAssistantView):
|
||||
url = "/api/bcs/restore"
|
||||
name = "api:bcs_restore"
|
||||
requires_auth = True
|
||||
|
||||
def __init__(self, core: Any) -> None:
|
||||
self.core: BCSCore = core
|
||||
|
||||
async def post(self, request: web.Request) -> web.Response:
|
||||
repo_id = request.query.get("repo_id")
|
||||
backup_id = request.query.get("backup_id")
|
||||
if not repo_id:
|
||||
return web.json_response({"ok": False, "message": "Missing repo_id"}, status=400)
|
||||
if not backup_id:
|
||||
return web.json_response({"ok": False, "message": "Missing backup_id"}, status=400)
|
||||
|
||||
try:
|
||||
result = await self.core.restore_repo_backup(repo_id, backup_id)
|
||||
return web.json_response(result, status=200)
|
||||
except Exception as e:
|
||||
_LOGGER.exception("BCS restore failed: %s", e)
|
||||
return web.json_response({"ok": False, "message": str(e) or "Restore failed"}, status=500)
|
||||
|
||||
|
||||
class BCSRestartView(HomeAssistantView):
|
||||
url = "/api/bcs/restart"
|
||||
name = "api:bcs_restart"
|
||||
|
||||
Reference in New Issue
Block a user