initial commit

custom_components/hacs/update.py

@@ -0,0 +1,134 @@
+"""Update entities for HACS."""
+from __future__ import annotations
+
+from typing import Any
+
+from homeassistant.components.update import UpdateEntity
+from homeassistant.core import callback
+from homeassistant.helpers.dispatcher import async_dispatcher_connect
+
+from .base import HacsBase
+from .const import DOMAIN
+from .entity import HacsRepositoryEntity
+from .enums import HacsCategory, HacsDispatchEvent
+
+
+async def async_setup_entry(hass, _config_entry, async_add_devices):
+    """Setup update platform."""
+    hacs: HacsBase = hass.data.get(DOMAIN)
+    async_add_devices(
+        HacsRepositoryUpdateEntity(hacs=hacs, repository=repository)
+        for repository in hacs.repositories.list_downloaded
+    )
+
+
+class HacsRepositoryUpdateEntity(HacsRepositoryEntity, UpdateEntity):
+    """Update entities for repositories downloaded with HACS."""
+
+    @property
+    def supported_features(self) -> int | None:
+        """Return the supported features of the entity."""
+        features = 4 | 16
+        if self.repository.can_download:
+            features = features | 1
+        return features
+
+    @property
+    def name(self) -> str | None:
+        """Return the name."""
+        return f"{self.repository.display_name} update"
+
+    @property
+    def latest_version(self) -> str:
+        """Return latest version of the entity."""
+        return self.repository.display_available_version
+
+    @property
+    def release_url(self) -> str:
+        """Return the URL of the release page."""
+        if self.repository.display_version_or_commit == "commit":
+            return f"https://github.com/{self.repository.data.full_name}"
+        return f"https://github.com/{self.repository.data.full_name}/releases/{self.latest_version}"
+
+    @property
+    def installed_version(self) -> str:
+        """Return downloaded version of the entity."""
+        return self.repository.display_installed_version
+
+    @property
+    def release_summary(self) -> str | None:
+        """Return the release summary."""
+        if not self.repository.can_download:
+            return f"<ha-alert alert-type='warning'>Requires Home Assistant {self.repository.repository_manifest.homeassistant}</ha-alert>"
+        if self.repository.pending_restart:
+            return "<ha-alert alert-type='error'>Restart of Home Assistant required</ha-alert>"
+        return None
+
+    @property
+    def entity_picture(self) -> str | None:
+        """Return the entity picture to use in the frontend."""
+        if (
+            self.repository.data.category != HacsCategory.INTEGRATION
+            or self.repository.data.domain is None
+        ):
+            return None
+
+        return f"https://brands.home-assistant.io/_/{self.repository.data.domain}/icon.png"
+
+    async def async_install(self, version: str | None, backup: bool, **kwargs: Any) -> None:
+        """Install an update."""
+        if self.repository.display_version_or_commit == "version":
+            self._update_in_progress(progress=10)
+            self.repository.data.selected_tag = self.latest_version
+            await self.repository.update_repository(force=True)
+            self._update_in_progress(progress=20)
+        await self.repository.async_install()
+        self._update_in_progress(progress=False)
+
+    async def async_release_notes(self) -> str | None:
+        """Return the release notes."""
+        if self.repository.pending_restart or not self.repository.can_download:
+            return None
+
+        release_notes = ""
+        if len(self.repository.releases.objects) > 0:
+            release = self.repository.releases.objects[0]
+            release_notes += release.body
+
+        if self.repository.pending_update:
+            if self.repository.data.category == HacsCategory.INTEGRATION:
+                release_notes += (
+                    "\n\n<ha-alert alert-type='warning'>You need to restart"
+                    " Home Assistant manually after updating.</ha-alert>\n\n"
+                )
+            if self.repository.data.category == HacsCategory.PLUGIN:
+                release_notes += (
+                    "\n\n<ha-alert alert-type='warning'>You need to manually"
+                    " clear the frontend cache after updating.</ha-alert>\n\n"
+                )
+
+        return release_notes.replace("\n#", "\n\n#")
+
+    async def async_added_to_hass(self) -> None:
+        """Register for status events."""
+        await super().async_added_to_hass()
+        self.async_on_remove(
+            async_dispatcher_connect(
+                self.hass,
+                HacsDispatchEvent.REPOSITORY_DOWNLOAD_PROGRESS,
+                self._update_download_progress,
+            )
+        )
+
+    @callback
+    def _update_download_progress(self, data: dict) -> None:
+        """Update the download progress."""
+        if data["repository"] != self.repository.data.full_name:
+            return
+        self._update_in_progress(progress=data["progress"])
+
+    @callback
+    def _update_in_progress(self, progress: int | bool) -> None:
+        """Update the download progress."""
+        self._attr_in_progress = progress
+        self.async_write_ha_state()