Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a8ff892993 | |||
| 90223e3fc4 | |||
| 0f5504b67d | |||
| 5fff1b2692 | |||
| c8356c7603 | |||
| 0c49a50fc9 | |||
| fa48841645 | |||
| 1445fff739 | |||
| 5cf365f354 | |||
| f73ce4095c | |||
| 1484d53f8c | |||
| 0e99c9c59e | |||
| 644e61aab0 | |||
| 4c2a104af7 | |||
| 95dd8b9dc2 | |||
| 8b01c04a4c | |||
| 981f56a693 | |||
| f6bd04f354 | |||
| 8da8a26a90 | |||
| 42fe5afe52 | |||
| 437c020566 | |||
| b863ed4d51 | |||
| 368642345d | |||
| 43bc31c8b4 |
43
CHANGELOG.md
43
CHANGELOG.md
@@ -11,6 +11,49 @@ Sections:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## 0.7.2 – 2026-01-20
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- When Bahmcloud Store is installed via an external installer (files copied into /config/custom_components), it now reconciles itself as "installed" in BCS storage so update checks work immediately.
|
||||||
|
|
||||||
|
## 0.7.1 – 2026-01-20
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- GitHub version provider now reliably fetches the latest 20 releases/tags using authenticated API requests.
|
||||||
|
- Repositories that were previously fetched in a degraded state (only `latest` and `branch`) are now automatically refreshed on repository view.
|
||||||
|
- Cached version lists with incomplete data are no longer reused and are re-fetched from the provider.
|
||||||
|
|
||||||
|
## [0.7.0] - 2026-01-20
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Options dialog (gear icon) for the Bahmcloud Store integration.
|
||||||
|
- Optional GitHub token can now be set, changed or removed via the Home Assistant UI.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixed missing options flow when clicking the integration settings button.
|
||||||
|
|
||||||
|
## [0.6.9] – 2026-01-19
|
||||||
|
### Added
|
||||||
|
- New Home Assistant **GUI setup** (Config Flow) – no YAML configuration required.
|
||||||
|
- Optional **GitHub Token** support to increase API limits (up to 5000 req/h).
|
||||||
|
Configurable via *Integration → Options*.
|
||||||
|
- Clear setup guidance and warning about GitHub rate limits.
|
||||||
|
- Automatic detection and warning if YAML setup is still present (ignored safely).
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- **store.yaml** URL is now fixed to the official Bahmcloud Store index:
|
||||||
|
https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml
|
||||||
|
- Installation workflow fully aligned with standard HA integrations.
|
||||||
|
- Update platform migrated to `async_setup_entry`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Minor stability and persistence improvements in startup sequence.
|
||||||
|
- Prevented duplicate background initialization when HA reloads the integration.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
- To enable extended GitHub access, create a fine-grained personal access token
|
||||||
|
(read-only) at https://github.com/settings/tokens and add it via the integration options.
|
||||||
|
|
||||||
## 0.6.8 – Performance & Cache Stabilization (2026-01-19)
|
## 0.6.8 – Performance & Cache Stabilization (2026-01-19)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|||||||
@@ -3,35 +3,56 @@ from __future__ import annotations
|
|||||||
import logging
|
import logging
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.components.panel_custom import async_register_panel
|
from homeassistant.components.panel_custom import async_register_panel
|
||||||
from homeassistant.helpers.event import async_track_time_interval, async_call_later
|
|
||||||
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
|
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
|
||||||
from homeassistant.helpers.discovery import async_load_platform
|
from homeassistant.helpers.event import async_call_later, async_track_time_interval
|
||||||
|
|
||||||
from .core import BCSCore, BCSConfig, BCSError
|
from .const import CONF_GITHUB_TOKEN, DEFAULT_STORE_URL, DOMAIN
|
||||||
|
from .core import BCSError, BCSConfig, BCSCore
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
DOMAIN = "bahmcloud_store"
|
PLATFORMS: list[str] = ["update"]
|
||||||
|
|
||||||
DEFAULT_STORE_URL = "https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml"
|
|
||||||
CONF_STORE_URL = "store_url"
|
|
||||||
|
|
||||||
|
|
||||||
async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
||||||
cfg = config.get(DOMAIN, {}) or {}
|
"""Set up Bahmcloud Store.
|
||||||
store_url = cfg.get(CONF_STORE_URL, DEFAULT_STORE_URL)
|
|
||||||
|
|
||||||
core = BCSCore(hass, BCSConfig(store_url=store_url))
|
We intentionally do NOT support YAML configuration.
|
||||||
hass.data[DOMAIN] = core
|
This method is kept so we can log a helpful message if someone tries.
|
||||||
|
"""
|
||||||
|
if DOMAIN in (config or {}):
|
||||||
|
_LOGGER.warning(
|
||||||
|
"BCS YAML configuration is no longer supported. "
|
||||||
|
"Please remove 'bahmcloud_store:' from configuration.yaml and set up the integration via the UI."
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
|
"""Set up Bahmcloud Store from a config entry (UI setup)."""
|
||||||
|
# Only one instance.
|
||||||
|
hass.data.setdefault(DOMAIN, {})
|
||||||
|
|
||||||
|
github_token = (entry.options.get(CONF_GITHUB_TOKEN) or "").strip() or None
|
||||||
|
|
||||||
|
core = BCSCore(
|
||||||
|
hass,
|
||||||
|
BCSConfig(
|
||||||
|
store_url=DEFAULT_STORE_URL,
|
||||||
|
github_token=github_token,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
hass.data[DOMAIN][entry.entry_id] = core
|
||||||
|
# Keep a convenient shortcut for platforms that previously used hass.data[DOMAIN] directly.
|
||||||
|
hass.data[DOMAIN]["_core"] = core
|
||||||
|
|
||||||
await core.async_initialize()
|
await core.async_initialize()
|
||||||
|
|
||||||
# Provide native Update entities in Settings -> System -> Updates.
|
# HTTP views + panel (registered once per entry; we only allow one entry).
|
||||||
# This integration is YAML-based (async_setup), therefore we load the platform manually.
|
|
||||||
await async_load_platform(hass, "update", DOMAIN, {}, config)
|
|
||||||
|
|
||||||
from .views import (
|
from .views import (
|
||||||
StaticAssetsView,
|
StaticAssetsView,
|
||||||
BCSApiView,
|
BCSApiView,
|
||||||
@@ -67,7 +88,7 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
|||||||
frontend_url_path="bahmcloud-store",
|
frontend_url_path="bahmcloud-store",
|
||||||
webcomponent_name="bahmcloud-store-panel",
|
webcomponent_name="bahmcloud-store-panel",
|
||||||
# IMPORTANT: bump v to avoid caching old JS
|
# IMPORTANT: bump v to avoid caching old JS
|
||||||
module_url="/api/bahmcloud_store_static/panel.js?v=108",
|
module_url="/api/bahmcloud_store_static/panel.js?v=109",
|
||||||
sidebar_title="Bahmcloud Store",
|
sidebar_title="Bahmcloud Store",
|
||||||
sidebar_icon="mdi:store",
|
sidebar_icon="mdi:store",
|
||||||
require_admin=True,
|
require_admin=True,
|
||||||
@@ -80,7 +101,7 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
|||||||
except BCSError as e:
|
except BCSError as e:
|
||||||
_LOGGER.error("Initial refresh failed: %s", e)
|
_LOGGER.error("Initial refresh failed: %s", e)
|
||||||
|
|
||||||
# Do not block Home Assistant startup. Schedule the initial refresh after HA started.
|
# Do not block startup; refresh after HA is up.
|
||||||
def _on_ha_started(_event) -> None:
|
def _on_ha_started(_event) -> None:
|
||||||
async_call_later(hass, 30, _do_startup_refresh)
|
async_call_later(hass, 30, _do_startup_refresh)
|
||||||
|
|
||||||
@@ -97,4 +118,16 @@ async def async_setup(hass: HomeAssistant, config: dict) -> bool:
|
|||||||
interval_seconds = int(getattr(core, "refresh_seconds", 300) or 300)
|
interval_seconds = int(getattr(core, "refresh_seconds", 300) or 300)
|
||||||
async_track_time_interval(hass, periodic, timedelta(seconds=interval_seconds))
|
async_track_time_interval(hass, periodic, timedelta(seconds=interval_seconds))
|
||||||
|
|
||||||
return True
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
||||||
|
"""Unload a config entry."""
|
||||||
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
||||||
|
if unload_ok:
|
||||||
|
try:
|
||||||
|
hass.data.get(DOMAIN, {}).pop(entry.entry_id, None)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return unload_ok
|
||||||
|
|||||||
71
custom_components/bahmcloud_store/config_flow.py
Normal file
71
custom_components/bahmcloud_store/config_flow.py
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import voluptuous as vol
|
||||||
|
|
||||||
|
from homeassistant import config_entries
|
||||||
|
from homeassistant.core import callback
|
||||||
|
|
||||||
|
from .const import CONF_GITHUB_TOKEN, DOMAIN
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def _schema(default_token: str | None = None) -> vol.Schema:
|
||||||
|
default_token = (default_token or "").strip()
|
||||||
|
return vol.Schema({vol.Optional(CONF_GITHUB_TOKEN, default=default_token): str})
|
||||||
|
|
||||||
|
|
||||||
|
class BahmcloudStoreConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
|
||||||
|
"""Config flow for Bahmcloud Store.
|
||||||
|
|
||||||
|
The store index URL is fixed and not user-configurable.
|
||||||
|
The only optional setting is a GitHub token to increase API rate limits.
|
||||||
|
"""
|
||||||
|
|
||||||
|
VERSION = 1
|
||||||
|
|
||||||
|
async def async_step_user(self, user_input: dict | None = None):
|
||||||
|
# Allow only one instance.
|
||||||
|
await self.async_set_unique_id(DOMAIN)
|
||||||
|
self._abort_if_unique_id_configured()
|
||||||
|
|
||||||
|
if user_input is None:
|
||||||
|
return self.async_show_form(step_id="user", data_schema=_schema(None))
|
||||||
|
|
||||||
|
token = str(user_input.get(CONF_GITHUB_TOKEN, "")).strip() or None
|
||||||
|
|
||||||
|
return self.async_create_entry(
|
||||||
|
title="Bahmcloud Store",
|
||||||
|
data={},
|
||||||
|
options={CONF_GITHUB_TOKEN: token} if token else {},
|
||||||
|
)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
@callback
|
||||||
|
def async_get_options_flow(config_entry: config_entries.ConfigEntry):
|
||||||
|
return BahmcloudStoreOptionsFlowHandler(config_entry)
|
||||||
|
|
||||||
|
|
||||||
|
class BahmcloudStoreOptionsFlowHandler(config_entries.OptionsFlow):
|
||||||
|
"""Options flow to manage optional GitHub token."""
|
||||||
|
|
||||||
|
def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
|
||||||
|
self._config_entry = config_entry
|
||||||
|
|
||||||
|
async def async_step_init(self, user_input: dict | None = None):
|
||||||
|
if user_input is None:
|
||||||
|
current = self._config_entry.options.get(CONF_GITHUB_TOKEN) or ""
|
||||||
|
return self.async_show_form(step_id="init", data_schema=_schema(str(current)))
|
||||||
|
|
||||||
|
token = str(user_input.get(CONF_GITHUB_TOKEN, "")).strip() or None
|
||||||
|
options = dict(self._config_entry.options)
|
||||||
|
|
||||||
|
# Allow clearing the token.
|
||||||
|
if token:
|
||||||
|
options[CONF_GITHUB_TOKEN] = token
|
||||||
|
else:
|
||||||
|
options.pop(CONF_GITHUB_TOKEN, None)
|
||||||
|
|
||||||
|
return self.async_create_entry(title="", data=options)
|
||||||
11
custom_components/bahmcloud_store/const.py
Normal file
11
custom_components/bahmcloud_store/const.py
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
"""Constants for Bahmcloud Store."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
DOMAIN = "bahmcloud_store"
|
||||||
|
|
||||||
|
# Fixed store index URL (not user-configurable).
|
||||||
|
DEFAULT_STORE_URL = "https://git.bahmcloud.de/bahmcloud/ha_store/raw/branch/main/store.yaml"
|
||||||
|
|
||||||
|
# Config entry option keys
|
||||||
|
CONF_GITHUB_TOKEN = "github_token"
|
||||||
@@ -58,6 +58,7 @@ class BCSInstallError(BCSError):
|
|||||||
@dataclass
|
@dataclass
|
||||||
class BCSConfig:
|
class BCSConfig:
|
||||||
store_url: str
|
store_url: str
|
||||||
|
github_token: str | None = None
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
@dataclass
|
||||||
@@ -180,6 +181,108 @@ class BCSCore:
|
|||||||
|
|
||||||
return await self.hass.async_add_executor_job(_read)
|
return await self.hass.async_add_executor_job(_read)
|
||||||
|
|
||||||
|
async def _read_manifest_info_async(self) -> dict[str, str]:
|
||||||
|
"""Read manifest.json fields that help identify this integration."""
|
||||||
|
|
||||||
|
def _read() -> dict[str, str]:
|
||||||
|
try:
|
||||||
|
manifest_path = Path(__file__).resolve().parent / "manifest.json"
|
||||||
|
data = json.loads(manifest_path.read_text(encoding="utf-8"))
|
||||||
|
out: dict[str, str] = {}
|
||||||
|
for k in ("version", "documentation", "name", "domain"):
|
||||||
|
v = data.get(k)
|
||||||
|
if v:
|
||||||
|
out[str(k)] = str(v)
|
||||||
|
return out
|
||||||
|
except Exception:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
return await self.hass.async_add_executor_job(_read)
|
||||||
|
|
||||||
|
def _normalize_repo_base(self, url: str) -> str:
|
||||||
|
"""Normalize repository URLs to a stable base for matching.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
https://git.example.tld/org/repo/raw/branch/main/store.yaml
|
||||||
|
becomes:
|
||||||
|
https://git.example.tld/org/repo
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
p = urlsplit(str(url or "").strip())
|
||||||
|
parts = [x for x in (p.path or "").split("/") if x]
|
||||||
|
base_path = "/" + "/".join(parts[:2]) if len(parts) >= 2 else (p.path or "")
|
||||||
|
return urlunsplit((p.scheme, p.netloc, base_path.rstrip("/"), "", "")).lower()
|
||||||
|
except Exception:
|
||||||
|
return str(url or "").strip().lower()
|
||||||
|
|
||||||
|
async def _ensure_self_marked_installed(self, repos: dict[str, RepoItem]) -> None:
|
||||||
|
"""Ensure BCS is treated as installed when deployed via external installer.
|
||||||
|
|
||||||
|
When users install BCS via an installer that places files into
|
||||||
|
/config/custom_components, our internal storage has no installed entry.
|
||||||
|
This breaks update detection for the BCS repo entry in the Store.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
# Already tracked as installed?
|
||||||
|
items = await self.storage.list_installed_repos()
|
||||||
|
for it in items:
|
||||||
|
if DOMAIN in [str(d) for d in (it.domains or [])]:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Files must exist on disk.
|
||||||
|
cc_root = Path(self.hass.config.path("custom_components"))
|
||||||
|
manifest_path = cc_root / DOMAIN / "manifest.json"
|
||||||
|
if not manifest_path.exists():
|
||||||
|
return
|
||||||
|
|
||||||
|
info = await self._read_manifest_info_async()
|
||||||
|
doc = (info.get("documentation") or "").strip()
|
||||||
|
name = (info.get("name") or "").strip()
|
||||||
|
ver = (info.get("version") or self.version or "unknown").strip()
|
||||||
|
|
||||||
|
doc_base = self._normalize_repo_base(doc) if doc else ""
|
||||||
|
|
||||||
|
# Identify the matching repo entry in our current repo list.
|
||||||
|
chosen: RepoItem | None = None
|
||||||
|
if doc_base:
|
||||||
|
for r in repos.values():
|
||||||
|
if self._normalize_repo_base(r.url) == doc_base:
|
||||||
|
chosen = r
|
||||||
|
break
|
||||||
|
|
||||||
|
if not chosen and name:
|
||||||
|
for r in repos.values():
|
||||||
|
if (r.name or "").strip().lower() == name.lower():
|
||||||
|
chosen = r
|
||||||
|
break
|
||||||
|
|
||||||
|
if not chosen:
|
||||||
|
for r in repos.values():
|
||||||
|
if "bahmcloud_store" in (r.url or "").lower():
|
||||||
|
chosen = r
|
||||||
|
break
|
||||||
|
|
||||||
|
if not chosen:
|
||||||
|
_LOGGER.debug("BCS self-install reconcile: could not match repo entry")
|
||||||
|
return
|
||||||
|
|
||||||
|
await self.storage.set_installed_repo(
|
||||||
|
repo_id=chosen.id,
|
||||||
|
url=chosen.url,
|
||||||
|
domains=[DOMAIN],
|
||||||
|
installed_version=ver if ver != "unknown" else None,
|
||||||
|
installed_manifest_version=ver if ver != "unknown" else None,
|
||||||
|
ref=ver if ver != "unknown" else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
_LOGGER.info(
|
||||||
|
"BCS self-install reconcile: marked as installed (repo_id=%s version=%s)",
|
||||||
|
chosen.id,
|
||||||
|
ver,
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
_LOGGER.debug("BCS self-install reconcile failed", exc_info=True)
|
||||||
|
|
||||||
def add_listener(self, cb) -> None:
|
def add_listener(self, cb) -> None:
|
||||||
self._listeners.append(cb)
|
self._listeners.append(cb)
|
||||||
|
|
||||||
@@ -323,6 +426,12 @@ class BCSCore:
|
|||||||
# Apply persisted per-repo enrichment cache (instant UI after restart).
|
# Apply persisted per-repo enrichment cache (instant UI after restart).
|
||||||
self._apply_repo_cache(merged)
|
self._apply_repo_cache(merged)
|
||||||
|
|
||||||
|
# If BCS itself was installed via an external installer (i.e. files exist on disk
|
||||||
|
# but our storage has no installed entry yet), we still want update checks to work.
|
||||||
|
# Reconcile this once we have the current repo list.
|
||||||
|
await self._ensure_self_marked_installed(merged)
|
||||||
|
await self._refresh_installed_cache()
|
||||||
|
|
||||||
await self._enrich_installed_only(merged)
|
await self._enrich_installed_only(merged)
|
||||||
self.repos = merged
|
self.repos = merged
|
||||||
|
|
||||||
@@ -696,7 +805,7 @@ class BCSCore:
|
|||||||
|
|
||||||
async def process_one(r: RepoItem) -> None:
|
async def process_one(r: RepoItem) -> None:
|
||||||
async with sem:
|
async with sem:
|
||||||
info: RepoInfo = await fetch_repo_info(self.hass, r.url)
|
info: RepoInfo = await fetch_repo_info(self.hass, r.url, github_token=self.config.github_token)
|
||||||
|
|
||||||
r.provider = info.provider or r.provider
|
r.provider = info.provider or r.provider
|
||||||
r.owner = info.owner or r.owner
|
r.owner = info.owner or r.owner
|
||||||
@@ -755,7 +864,7 @@ class BCSCore:
|
|||||||
|
|
||||||
async def _enrich_one_repo(self, r: RepoItem) -> None:
|
async def _enrich_one_repo(self, r: RepoItem) -> None:
|
||||||
"""Fetch provider info + metadata for a single repo item."""
|
"""Fetch provider info + metadata for a single repo item."""
|
||||||
info: RepoInfo = await fetch_repo_info(self.hass, r.url)
|
info: RepoInfo = await fetch_repo_info(self.hass, r.url, github_token=self.config.github_token)
|
||||||
|
|
||||||
r.provider = info.provider or r.provider
|
r.provider = info.provider or r.provider
|
||||||
r.owner = info.owner or r.owner
|
r.owner = info.owner or r.owner
|
||||||
@@ -807,13 +916,21 @@ class BCSCore:
|
|||||||
_LOGGER.debug("BCS ensure_repo_details failed for %s", repo_id, exc_info=True)
|
_LOGGER.debug("BCS ensure_repo_details failed for %s", repo_id, exc_info=True)
|
||||||
return r
|
return r
|
||||||
|
|
||||||
async def list_repo_versions(self, repo_id: str) -> list[dict[str, Any]]:
|
async def list_repo_versions(
|
||||||
|
self,
|
||||||
|
repo_id: str,
|
||||||
|
*,
|
||||||
|
limit: int = 20,
|
||||||
|
force_refresh: bool = False,
|
||||||
|
) -> list[dict[str, Any]]:
|
||||||
repo = self.get_repo(repo_id)
|
repo = self.get_repo(repo_id)
|
||||||
if not repo:
|
if not repo:
|
||||||
return []
|
return []
|
||||||
|
|
||||||
# Prefer cached version lists to avoid hammering provider APIs (notably GitHub unauthenticated
|
# Prefer cached version lists to avoid hammering provider APIs (notably GitHub unauthenticated
|
||||||
# rate limits). We refresh on-demand when the user opens the selector.
|
# rate limits). However, if the cached list is clearly a degraded fallback (e.g. only
|
||||||
|
# "Latest" + "Branch"), we treat it as stale and retry immediately when the user requests
|
||||||
|
# versions again.
|
||||||
cached = None
|
cached = None
|
||||||
cached_ts = 0
|
cached_ts = 0
|
||||||
async with self._repo_cache_lock:
|
async with self._repo_cache_lock:
|
||||||
@@ -822,11 +939,27 @@ class BCSCore:
|
|||||||
cached_ts = int(cached.get("versions_ts", 0) or 0)
|
cached_ts = int(cached.get("versions_ts", 0) or 0)
|
||||||
|
|
||||||
now = int(time.time())
|
now = int(time.time())
|
||||||
if isinstance(cached, dict) and cached.get("versions") and (now - cached_ts) < VERSIONS_CACHE_TTL_SECONDS:
|
cached_versions = list(cached.get("versions") or []) if isinstance(cached, dict) else []
|
||||||
return list(cached.get("versions") or [])
|
cache_fresh = (now - cached_ts) < VERSIONS_CACHE_TTL_SECONDS
|
||||||
|
|
||||||
|
# Cache hit if it's fresh and not degraded, unless the caller explicitly wants a refresh.
|
||||||
|
if (
|
||||||
|
not force_refresh
|
||||||
|
and cached_versions
|
||||||
|
and cache_fresh
|
||||||
|
and len(cached_versions) > 2
|
||||||
|
):
|
||||||
|
return cached_versions
|
||||||
|
|
||||||
try:
|
try:
|
||||||
versions = await fetch_repo_versions(self.hass, repo.url)
|
versions = await fetch_repo_versions(
|
||||||
|
self.hass,
|
||||||
|
repo.url,
|
||||||
|
provider=repo.provider,
|
||||||
|
default_branch=repo.default_branch,
|
||||||
|
limit=limit,
|
||||||
|
github_token=self.config.github_token,
|
||||||
|
)
|
||||||
except Exception:
|
except Exception:
|
||||||
versions = []
|
versions = []
|
||||||
|
|
||||||
@@ -1027,23 +1160,6 @@ class BCSCore:
|
|||||||
default_branch=repo.default_branch,
|
default_branch=repo.default_branch,
|
||||||
)
|
)
|
||||||
|
|
||||||
async def list_repo_versions(self, repo_id: str, *, limit: int = 20) -> list[dict[str, str]]:
|
|
||||||
"""List installable versions/refs for a repo.
|
|
||||||
|
|
||||||
This is used by the UI to allow selecting an older tag/release.
|
|
||||||
"""
|
|
||||||
repo = self.get_repo(repo_id)
|
|
||||||
if not repo:
|
|
||||||
raise BCSInstallError(f"repo_id not found: {repo_id}")
|
|
||||||
|
|
||||||
return await fetch_repo_versions(
|
|
||||||
self.hass,
|
|
||||||
repo.url,
|
|
||||||
provider=repo.provider,
|
|
||||||
default_branch=repo.default_branch,
|
|
||||||
limit=limit,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _pick_ref_for_install(self, repo: RepoItem) -> str:
|
def _pick_ref_for_install(self, repo: RepoItem) -> str:
|
||||||
if repo.latest_version and str(repo.latest_version).strip():
|
if repo.latest_version and str(repo.latest_version).strip():
|
||||||
return str(repo.latest_version).strip()
|
return str(repo.latest_version).strip()
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"domain": "bahmcloud_store",
|
"domain": "bahmcloud_store",
|
||||||
"name": "Bahmcloud Store",
|
"name": "Bahmcloud Store",
|
||||||
"version": "0.6.8",
|
"version": "0.7.2",
|
||||||
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
"documentation": "https://git.bahmcloud.de/bahmcloud/bahmcloud_store",
|
||||||
|
"config_flow": true,
|
||||||
"platforms": ["update"],
|
"platforms": ["update"],
|
||||||
"requirements": [],
|
"requirements": [],
|
||||||
"codeowners": ["@bahmcloud"],
|
"codeowners": ["@bahmcloud"],
|
||||||
|
|||||||
@@ -189,9 +189,11 @@ async def _github_latest_version_redirect(hass: HomeAssistant, owner: str, repo:
|
|||||||
return None, None
|
return None, None
|
||||||
|
|
||||||
|
|
||||||
async def _github_latest_version_api(hass: HomeAssistant, owner: str, repo: str) -> tuple[str | None, str | None]:
|
async def _github_latest_version_api(
|
||||||
|
hass: HomeAssistant, owner: str, repo: str, *, github_token: str | None = None
|
||||||
|
) -> tuple[str | None, str | None]:
|
||||||
session = async_get_clientsession(hass)
|
session = async_get_clientsession(hass)
|
||||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
headers = _github_headers(github_token)
|
||||||
|
|
||||||
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}/releases/latest", headers=headers)
|
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}/releases/latest", headers=headers)
|
||||||
if isinstance(data, dict) and data.get("tag_name"):
|
if isinstance(data, dict) and data.get("tag_name"):
|
||||||
@@ -217,12 +219,14 @@ async def _github_latest_version_api(hass: HomeAssistant, owner: str, repo: str)
|
|||||||
return None, None
|
return None, None
|
||||||
|
|
||||||
|
|
||||||
async def _github_latest_version(hass: HomeAssistant, owner: str, repo: str) -> tuple[str | None, str | None]:
|
async def _github_latest_version(
|
||||||
|
hass: HomeAssistant, owner: str, repo: str, *, github_token: str | None = None
|
||||||
|
) -> tuple[str | None, str | None]:
|
||||||
tag, src = await _github_latest_version_redirect(hass, owner, repo)
|
tag, src = await _github_latest_version_redirect(hass, owner, repo)
|
||||||
if tag:
|
if tag:
|
||||||
return tag, src
|
return tag, src
|
||||||
|
|
||||||
tag, src = await _github_latest_version_api(hass, owner, repo)
|
tag, src = await _github_latest_version_api(hass, owner, repo, github_token=github_token)
|
||||||
if tag:
|
if tag:
|
||||||
return tag, src
|
return tag, src
|
||||||
|
|
||||||
@@ -316,7 +320,16 @@ async def _gitlab_latest_version(
|
|||||||
return None, None
|
return None, None
|
||||||
|
|
||||||
|
|
||||||
async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
def _github_headers(github_token: str | None = None) -> dict:
|
||||||
|
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
||||||
|
token = (github_token or "").strip()
|
||||||
|
if token:
|
||||||
|
# PAT or fine-grained token
|
||||||
|
headers["Authorization"] = f"Bearer {token}"
|
||||||
|
return headers
|
||||||
|
|
||||||
|
|
||||||
|
async def fetch_repo_info(hass: HomeAssistant, repo_url: str, *, github_token: str | None = None) -> RepoInfo:
|
||||||
provider = detect_provider(repo_url)
|
provider = detect_provider(repo_url)
|
||||||
owner, repo = _split_owner_repo(repo_url)
|
owner, repo = _split_owner_repo(repo_url)
|
||||||
|
|
||||||
@@ -337,7 +350,7 @@ async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
if provider == "github":
|
if provider == "github":
|
||||||
headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
headers = _github_headers(github_token)
|
||||||
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}", headers=headers)
|
data, status = await _safe_json(session, f"https://api.github.com/repos/{owner}/{repo}", headers=headers)
|
||||||
|
|
||||||
if isinstance(data, dict):
|
if isinstance(data, dict):
|
||||||
@@ -356,7 +369,7 @@ async def fetch_repo_info(hass: HomeAssistant, repo_url: str) -> RepoInfo:
|
|||||||
if desc:
|
if desc:
|
||||||
info.description = desc
|
info.description = desc
|
||||||
|
|
||||||
ver, src = await _github_latest_version(hass, owner, repo)
|
ver, src = await _github_latest_version(hass, owner, repo, github_token=github_token)
|
||||||
info.latest_version = ver
|
info.latest_version = ver
|
||||||
info.latest_version_source = src
|
info.latest_version_source = src
|
||||||
return info
|
return info
|
||||||
@@ -514,6 +527,7 @@ async def fetch_repo_versions(
|
|||||||
provider: str | None = None,
|
provider: str | None = None,
|
||||||
default_branch: str | None = None,
|
default_branch: str | None = None,
|
||||||
limit: int = 20,
|
limit: int = 20,
|
||||||
|
github_token: str | None = None,
|
||||||
) -> list[dict[str, str]]:
|
) -> list[dict[str, str]]:
|
||||||
"""List available versions/refs for a repository.
|
"""List available versions/refs for a repository.
|
||||||
|
|
||||||
@@ -523,7 +537,7 @@ async def fetch_repo_versions(
|
|||||||
- source: release|tag|branch
|
- source: release|tag|branch
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
- Uses public endpoints (no tokens) for public repositories.
|
- Uses provider APIs; for GitHub we include the configured token (if any) to avoid unauthenticated rate limits.
|
||||||
- We prefer releases first (if available), then tags.
|
- We prefer releases first (if available), then tags.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -541,6 +555,8 @@ async def fetch_repo_versions(
|
|||||||
|
|
||||||
session = async_get_clientsession(hass)
|
session = async_get_clientsession(hass)
|
||||||
headers = {"User-Agent": UA}
|
headers = {"User-Agent": UA}
|
||||||
|
if prov == "github":
|
||||||
|
headers = _github_headers(github_token)
|
||||||
|
|
||||||
out: list[dict[str, str]] = []
|
out: list[dict[str, str]] = []
|
||||||
seen: set[str] = set()
|
seen: set[str] = set()
|
||||||
@@ -559,11 +575,13 @@ async def fetch_repo_versions(
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
if prov == "github":
|
if prov == "github":
|
||||||
# Releases
|
# Releases (prefer these over tags)
|
||||||
gh_headers = {"Accept": "application/vnd.github+json", "User-Agent": UA}
|
# Use the configured GitHub token (if any) to avoid unauthenticated rate limits.
|
||||||
|
gh_headers = _github_headers(github_token)
|
||||||
|
per_page = max(1, min(int(limit), 100))
|
||||||
data, _ = await _safe_json(
|
data, _ = await _safe_json(
|
||||||
session,
|
session,
|
||||||
f"https://api.github.com/repos/{owner}/{repo}/releases?per_page={int(limit)}",
|
f"https://api.github.com/repos/{owner}/{repo}/releases?per_page={per_page}",
|
||||||
headers=gh_headers,
|
headers=gh_headers,
|
||||||
)
|
)
|
||||||
if isinstance(data, list):
|
if isinstance(data, list):
|
||||||
@@ -581,7 +599,7 @@ async def fetch_repo_versions(
|
|||||||
# Tags
|
# Tags
|
||||||
data, _ = await _safe_json(
|
data, _ = await _safe_json(
|
||||||
session,
|
session,
|
||||||
f"https://api.github.com/repos/{owner}/{repo}/tags?per_page={int(limit)}",
|
f"https://api.github.com/repos/{owner}/{repo}/tags?per_page={per_page}",
|
||||||
headers=gh_headers,
|
headers=gh_headers,
|
||||||
)
|
)
|
||||||
if isinstance(data, list):
|
if isinstance(data, list):
|
||||||
|
|||||||
@@ -1,4 +1,29 @@
|
|||||||
{
|
{
|
||||||
|
"config": {
|
||||||
|
"abort": {
|
||||||
|
"single_instance_allowed": "Only one Bahmcloud Store instance can be configured."
|
||||||
|
},
|
||||||
|
"step": {
|
||||||
|
"user": {
|
||||||
|
"title": "Bahmcloud Store",
|
||||||
|
"description": "Bahmcloud Store uses a fixed official store index. You can optionally add a GitHub token to increase API rate limits.",
|
||||||
|
"data": {
|
||||||
|
"github_token": "GitHub token (optional)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"options": {
|
||||||
|
"step": {
|
||||||
|
"init": {
|
||||||
|
"title": "Bahmcloud Store Options",
|
||||||
|
"description": "Optionally set or clear your GitHub token to reduce rate limiting.",
|
||||||
|
"data": {
|
||||||
|
"github_token": "GitHub token (optional)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"issues": {
|
"issues": {
|
||||||
"restart_required": {
|
"restart_required": {
|
||||||
"title": "Restart required",
|
"title": "Restart required",
|
||||||
@@ -15,4 +40,4 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,11 +10,21 @@ from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
|||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
from homeassistant.helpers.entity import EntityCategory
|
from homeassistant.helpers.entity import EntityCategory
|
||||||
|
|
||||||
from .core import DOMAIN, SIGNAL_UPDATED, BCSCore
|
from .const import DOMAIN
|
||||||
|
from .core import SIGNAL_UPDATED, BCSCore
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_core(hass: HomeAssistant) -> BCSCore | None:
|
||||||
|
data = hass.data.get(DOMAIN)
|
||||||
|
if isinstance(data, dict):
|
||||||
|
c = data.get("_core")
|
||||||
|
return c if isinstance(c, BCSCore) else None
|
||||||
|
# Backwards compatibility (older versions used hass.data[DOMAIN] = core)
|
||||||
|
return data if isinstance(data, BCSCore) else None
|
||||||
|
|
||||||
|
|
||||||
def _pretty_repo_name(core: BCSCore, repo_id: str) -> str:
|
def _pretty_repo_name(core: BCSCore, repo_id: str) -> str:
|
||||||
"""Return a human-friendly name for a repo update entity."""
|
"""Return a human-friendly name for a repo update entity."""
|
||||||
try:
|
try:
|
||||||
@@ -146,7 +156,7 @@ async def async_setup_platform(
|
|||||||
discovery_info=None,
|
discovery_info=None,
|
||||||
):
|
):
|
||||||
"""Set up BCS update entities."""
|
"""Set up BCS update entities."""
|
||||||
core: BCSCore | None = hass.data.get(DOMAIN)
|
core: BCSCore | None = _get_core(hass)
|
||||||
if not core:
|
if not core:
|
||||||
_LOGGER.debug("BCS core not available, skipping update platform setup")
|
_LOGGER.debug("BCS core not available, skipping update platform setup")
|
||||||
return
|
return
|
||||||
@@ -159,4 +169,13 @@ async def async_setup_platform(
|
|||||||
def _handle_update() -> None:
|
def _handle_update() -> None:
|
||||||
_sync_entities(core, entities, async_add_entities)
|
_sync_entities(core, entities, async_add_entities)
|
||||||
|
|
||||||
async_dispatcher_connect(hass, SIGNAL_UPDATED, _handle_update)
|
async_dispatcher_connect(hass, SIGNAL_UPDATED, _handle_update)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
entry,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
) -> None:
|
||||||
|
"""Set up BCS update entities from a config entry."""
|
||||||
|
await async_setup_platform(hass, {}, async_add_entities, None)
|
||||||
Reference in New Issue
Block a user