initial commit

custom_components/hacs/repositories/__init__.py

@@ -0,0 +1,20 @@
+"""Initialize repositories."""
+from __future__ import annotations
+
+from ..enums import HacsCategory
+from .appdaemon import HacsAppdaemonRepository
+from .base import HacsRepository
+from .integration import HacsIntegrationRepository
+from .netdaemon import HacsNetdaemonRepository
+from .plugin import HacsPluginRepository
+from .python_script import HacsPythonScriptRepository
+from .theme import HacsThemeRepository
+
+RERPOSITORY_CLASSES: dict[HacsCategory, HacsRepository] = {
+    HacsCategory.THEME: HacsThemeRepository,
+    HacsCategory.INTEGRATION: HacsIntegrationRepository,
+    HacsCategory.PYTHON_SCRIPT: HacsPythonScriptRepository,
+    HacsCategory.APPDAEMON: HacsAppdaemonRepository,
+    HacsCategory.NETDAEMON: HacsNetdaemonRepository,
+    HacsCategory.PLUGIN: HacsPluginRepository,
+}

custom_components/hacs/repositories/appdaemon.py

@@ -0,0 +1,92 @@
+"""Class for appdaemon apps in HACS."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from aiogithubapi import AIOGitHubAPIException
+
+from ..enums import HacsCategory, HacsDispatchEvent
+from ..exceptions import HacsException
+from ..utils.decorator import concurrent
+from .base import HacsRepository
+
+if TYPE_CHECKING:
+    from ..base import HacsBase
+
+
+class HacsAppdaemonRepository(HacsRepository):
+    """Appdaemon apps in HACS."""
+
+    def __init__(self, hacs: HacsBase, full_name: str):
+        """Initialize."""
+        super().__init__(hacs=hacs)
+        self.data.full_name = full_name
+        self.data.full_name_lower = full_name.lower()
+        self.data.category = HacsCategory.APPDAEMON
+        self.content.path.local = self.localpath
+        self.content.path.remote = "apps"
+
+    @property
+    def localpath(self):
+        """Return localpath."""
+        return f"{self.hacs.core.config_path}/appdaemon/apps/{self.data.name}"
+
+    async def validate_repository(self):
+        """Validate."""
+        await self.common_validate()
+
+        # Custom step 1: Validate content.
+        try:
+            addir = await self.repository_object.get_contents("apps", self.ref)
+        except AIOGitHubAPIException:
+            raise HacsException(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            ) from None
+
+        if not isinstance(addir, list):
+            self.validate.errors.append(f"{self.string} Repository structure not compliant")
+
+        self.content.path.remote = addir[0].path
+        self.content.objects = await self.repository_object.get_contents(
+            self.content.path.remote, self.ref
+        )
+
+        # Handle potential errors
+        if self.validate.errors:
+            for error in self.validate.errors:
+                if not self.hacs.status.startup:
+                    self.logger.error("%s %s", self.string, error)
+        return self.validate.success
+
+    @concurrent(concurrenttasks=10, backoff_time=5)
+    async def update_repository(self, ignore_issues=False, force=False):
+        """Update."""
+        if not await self.common_update(ignore_issues, force) and not force:
+            return
+
+        # Get appdaemon objects.
+        if self.repository_manifest:
+            if self.repository_manifest.content_in_root:
+                self.content.path.remote = ""
+
+        if self.content.path.remote == "apps":
+            addir = await self.repository_object.get_contents(self.content.path.remote, self.ref)
+            self.content.path.remote = addir[0].path
+        self.content.objects = await self.repository_object.get_contents(
+            self.content.path.remote, self.ref
+        )
+
+        # Set local path
+        self.content.path.local = self.localpath
+
+        # Signal entities to refresh
+        if self.data.installed:
+            self.hacs.async_dispatch(
+                HacsDispatchEvent.REPOSITORY,
+                {
+                    "id": 1337,
+                    "action": "update",
+                    "repository": self.data.full_name,
+                    "repository_id": self.data.id,
+                },
+            )

custom_components/hacs/repositories/integration.py

@@ -0,0 +1,182 @@
+"""Class for integrations in HACS."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from homeassistant.helpers.issue_registry import async_create_issue, IssueSeverity
+from homeassistant.loader import async_get_custom_components
+
+from ..const import DOMAIN
+from ..enums import HacsCategory, HacsDispatchEvent, HacsGitHubRepo, RepositoryFile
+from ..exceptions import AddonRepositoryException, HacsException
+from ..utils.decode import decode_content
+from ..utils.decorator import concurrent
+from ..utils.filters import get_first_directory_in_directory
+from ..utils.json import json_loads
+from .base import HacsRepository
+
+if TYPE_CHECKING:
+    from ..base import HacsBase
+
+
+class HacsIntegrationRepository(HacsRepository):
+    """Integrations in HACS."""
+
+    def __init__(self, hacs: HacsBase, full_name: str):
+        """Initialize."""
+        super().__init__(hacs=hacs)
+        self.data.full_name = full_name
+        self.data.full_name_lower = full_name.lower()
+        self.data.category = HacsCategory.INTEGRATION
+        self.content.path.remote = "custom_components"
+        self.content.path.local = self.localpath
+
+    @property
+    def localpath(self):
+        """Return localpath."""
+        return f"{self.hacs.core.config_path}/custom_components/{self.data.domain}"
+
+    async def async_post_installation(self):
+        """Run post installation steps."""
+        self.pending_restart = True
+        if self.data.config_flow:
+            if self.data.full_name != HacsGitHubRepo.INTEGRATION:
+                await self.reload_custom_components()
+            if self.data.first_install:
+                self.pending_restart = False
+
+        if self.pending_restart and self.hacs.configuration.experimental:
+            self.logger.debug("%s Creating restart_required issue", self.string)
+            async_create_issue(
+                hass=self.hacs.hass,
+                domain=DOMAIN,
+                issue_id=f"restart_required_{self.data.id}_{self.ref}",
+                is_fixable=True,
+                issue_domain=self.data.domain or DOMAIN,
+                severity=IssueSeverity.WARNING,
+                translation_key="restart_required",
+                translation_placeholders={
+                    "name": self.display_name,
+                },
+            )
+
+    async def validate_repository(self):
+        """Validate."""
+        await self.common_validate()
+
+        # Custom step 1: Validate content.
+        if self.repository_manifest.content_in_root:
+            self.content.path.remote = ""
+
+        if self.content.path.remote == "custom_components":
+            name = get_first_directory_in_directory(self.tree, "custom_components")
+            if name is None:
+                if (
+                    "repository.json" in self.treefiles
+                    or "repository.yaml" in self.treefiles
+                    or "repository.yml" in self.treefiles
+                ):
+                    raise AddonRepositoryException()
+                raise HacsException(
+                    f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+                )
+            self.content.path.remote = f"custom_components/{name}"
+
+        # Get the content of manifest.json
+        if manifest := await self.async_get_integration_manifest():
+            try:
+                self.integration_manifest = manifest
+                self.data.authors = manifest.get("codeowners", [])
+                self.data.domain = manifest["domain"]
+                self.data.manifest_name = manifest.get("name")
+                self.data.config_flow = manifest.get("config_flow", False)
+
+            except KeyError as exception:
+                self.validate.errors.append(
+                    f"Missing expected key '{exception}' in { RepositoryFile.MAINIFEST_JSON}"
+                )
+                self.hacs.log.error(
+                    "Missing expected key '%s' in '%s'", exception, RepositoryFile.MAINIFEST_JSON
+                )
+
+        # Set local path
+        self.content.path.local = self.localpath
+
+        # Handle potential errors
+        if self.validate.errors:
+            for error in self.validate.errors:
+                if not self.hacs.status.startup:
+                    self.logger.error("%s %s", self.string, error)
+        return self.validate.success
+
+    @concurrent(concurrenttasks=10, backoff_time=5)
+    async def update_repository(self, ignore_issues=False, force=False):
+        """Update."""
+        if not await self.common_update(ignore_issues, force) and not force:
+            return
+
+        if self.repository_manifest.content_in_root:
+            self.content.path.remote = ""
+
+        if self.content.path.remote == "custom_components":
+            name = get_first_directory_in_directory(self.tree, "custom_components")
+            self.content.path.remote = f"custom_components/{name}"
+
+        # Get the content of manifest.json
+        if manifest := await self.async_get_integration_manifest():
+            try:
+                self.integration_manifest = manifest
+                self.data.authors = manifest.get("codeowners", [])
+                self.data.domain = manifest["domain"]
+                self.data.manifest_name = manifest.get("name")
+                self.data.config_flow = manifest.get("config_flow", False)
+
+            except KeyError as exception:
+                self.validate.errors.append(
+                    f"Missing expected key '{exception}' in { RepositoryFile.MAINIFEST_JSON}"
+                )
+                self.hacs.log.error(
+                    "Missing expected key '%s' in '%s'", exception, RepositoryFile.MAINIFEST_JSON
+                )
+
+        # Set local path
+        self.content.path.local = self.localpath
+
+        # Signal entities to refresh
+        if self.data.installed:
+            self.hacs.async_dispatch(
+                HacsDispatchEvent.REPOSITORY,
+                {
+                    "id": 1337,
+                    "action": "update",
+                    "repository": self.data.full_name,
+                    "repository_id": self.data.id,
+                },
+            )
+
+    async def reload_custom_components(self):
+        """Reload custom_components (and config flows)in HA."""
+        self.logger.info("Reloading custom_component cache")
+        del self.hacs.hass.data["custom_components"]
+        await async_get_custom_components(self.hacs.hass)
+        self.logger.info("Custom_component cache reloaded")
+
+    async def async_get_integration_manifest(self, ref: str = None) -> dict[str, Any] | None:
+        """Get the content of the manifest.json file."""
+        manifest_path = (
+            "manifest.json"
+            if self.repository_manifest.content_in_root
+            else f"{self.content.path.remote}/{RepositoryFile.MAINIFEST_JSON}"
+        )
+
+        if not manifest_path in (x.full_path for x in self.tree):
+            raise HacsException(f"No {RepositoryFile.MAINIFEST_JSON} file found '{manifest_path}'")
+
+        response = await self.hacs.async_github_api_method(
+            method=self.hacs.githubapi.repos.contents.get,
+            repository=self.data.full_name,
+            path=manifest_path,
+            **{"params": {"ref": ref or self.version_to_download()}},
+        )
+        if response:
+            return json_loads(decode_content(response.data.content))

custom_components/hacs/repositories/netdaemon.py

@@ -0,0 +1,104 @@
+"""Class for netdaemon apps in HACS."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ..enums import HacsCategory, HacsDispatchEvent
+from ..exceptions import HacsException
+from ..utils import filters
+from ..utils.decorator import concurrent
+from .base import HacsRepository
+
+if TYPE_CHECKING:
+    from ..base import HacsBase
+
+
+class HacsNetdaemonRepository(HacsRepository):
+    """Netdaemon apps in HACS."""
+
+    def __init__(self, hacs: HacsBase, full_name: str):
+        """Initialize."""
+        super().__init__(hacs=hacs)
+        self.data.full_name = full_name
+        self.data.full_name_lower = full_name.lower()
+        self.data.category = HacsCategory.NETDAEMON
+        self.content.path.local = self.localpath
+        self.content.path.remote = "apps"
+
+    @property
+    def localpath(self):
+        """Return localpath."""
+        return f"{self.hacs.core.config_path}/netdaemon/apps/{self.data.name}"
+
+    async def validate_repository(self):
+        """Validate."""
+        await self.common_validate()
+
+        # Custom step 1: Validate content.
+        if self.repository_manifest:
+            if self.repository_manifest.content_in_root:
+                self.content.path.remote = ""
+
+        if self.content.path.remote == "apps":
+            self.data.domain = filters.get_first_directory_in_directory(
+                self.tree, self.content.path.remote
+            )
+            self.content.path.remote = f"apps/{self.data.name}"
+
+        compliant = False
+        for treefile in self.treefiles:
+            if treefile.startswith(f"{self.content.path.remote}") and treefile.endswith(".cs"):
+                compliant = True
+                break
+        if not compliant:
+            raise HacsException(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            )
+
+        # Handle potential errors
+        if self.validate.errors:
+            for error in self.validate.errors:
+                if not self.hacs.status.startup:
+                    self.logger.error("%s %s", self.string, error)
+        return self.validate.success
+
+    @concurrent(concurrenttasks=10, backoff_time=5)
+    async def update_repository(self, ignore_issues=False, force=False):
+        """Update."""
+        if not await self.common_update(ignore_issues, force) and not force:
+            return
+
+        # Get appdaemon objects.
+        if self.repository_manifest:
+            if self.repository_manifest.content_in_root:
+                self.content.path.remote = ""
+
+        if self.content.path.remote == "apps":
+            self.data.domain = filters.get_first_directory_in_directory(
+                self.tree, self.content.path.remote
+            )
+            self.content.path.remote = f"apps/{self.data.name}"
+
+        # Set local path
+        self.content.path.local = self.localpath
+
+        # Signal entities to refresh
+        if self.data.installed:
+            self.hacs.async_dispatch(
+                HacsDispatchEvent.REPOSITORY,
+                {
+                    "id": 1337,
+                    "action": "update",
+                    "repository": self.data.full_name,
+                    "repository_id": self.data.id,
+                },
+            )
+
+    async def async_post_installation(self):
+        """Run post installation steps."""
+        try:
+            await self.hacs.hass.services.async_call(
+                "hassio", "addon_restart", {"addon": "c6a2317c_netdaemon"}
+            )
+        except BaseException:  # lgtm [py/catch-base-exception] pylint: disable=broad-except
+            pass

custom_components/hacs/repositories/plugin.py

@@ -0,0 +1,130 @@
+"""Class for plugins in HACS."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ..enums import HacsCategory, HacsDispatchEvent
+from ..exceptions import HacsException
+from ..utils.decorator import concurrent
+from ..utils.json import json_loads
+from .base import HacsRepository
+
+if TYPE_CHECKING:
+    from ..base import HacsBase
+
+
+class HacsPluginRepository(HacsRepository):
+    """Plugins in HACS."""
+
+    def __init__(self, hacs: HacsBase, full_name: str):
+        """Initialize."""
+        super().__init__(hacs=hacs)
+        self.data.full_name = full_name
+        self.data.full_name_lower = full_name.lower()
+        self.data.file_name = None
+        self.data.category = HacsCategory.PLUGIN
+        self.content.path.local = self.localpath
+
+    @property
+    def localpath(self):
+        """Return localpath."""
+        return f"{self.hacs.core.config_path}/www/community/{self.data.full_name.split('/')[-1]}"
+
+    async def validate_repository(self):
+        """Validate."""
+        # Run common validation steps.
+        await self.common_validate()
+
+        # Custom step 1: Validate content.
+        self.update_filenames()
+
+        if self.content.path.remote is None:
+            raise HacsException(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            )
+
+        if self.content.path.remote == "release":
+            self.content.single = True
+
+        # Handle potential errors
+        if self.validate.errors:
+            for error in self.validate.errors:
+                if not self.hacs.status.startup:
+                    self.logger.error("%s %s", self.string, error)
+        return self.validate.success
+
+    @concurrent(concurrenttasks=10, backoff_time=5)
+    async def update_repository(self, ignore_issues=False, force=False):
+        """Update."""
+        if not await self.common_update(ignore_issues, force) and not force:
+            return
+
+        # Get plugin objects.
+        self.update_filenames()
+
+        if self.content.path.remote is None:
+            self.validate.errors.append(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            )
+
+        if self.content.path.remote == "release":
+            self.content.single = True
+
+        # Signal entities to refresh
+        if self.data.installed:
+            self.hacs.async_dispatch(
+                HacsDispatchEvent.REPOSITORY,
+                {
+                    "id": 1337,
+                    "action": "update",
+                    "repository": self.data.full_name,
+                    "repository_id": self.data.id,
+                },
+            )
+
+    async def get_package_content(self):
+        """Get package content."""
+        try:
+            package = await self.repository_object.get_contents("package.json", self.ref)
+            package = json_loads(package.content)
+
+            if package:
+                self.data.authors = package["author"]
+        except BaseException:  # lgtm [py/catch-base-exception] pylint: disable=broad-except
+            pass
+
+    def update_filenames(self) -> None:
+        """Get the filename to target."""
+        # Handler for plug requirement 3
+        if self.repository_manifest.filename:
+            valid_filenames = (self.repository_manifest.filename,)
+        else:
+            valid_filenames = (
+                f"{self.data.name.replace('lovelace-', '')}.js",
+                f"{self.data.name}.js",
+                f"{self.data.name}.umd.js",
+                f"{self.data.name}-bundle.js",
+            )
+
+        if not self.repository_manifest.content_in_root:
+            if self.releases.objects:
+                release = self.releases.objects[0]
+                if release.assets:
+                    if assetnames := [
+                        filename
+                        for filename in valid_filenames
+                        for asset in release.assets
+                        if filename == asset.name
+                    ]:
+                        self.data.file_name = assetnames[0]
+                        self.content.path.remote = "release"
+                        return
+
+        for location in ("",) if self.repository_manifest.content_in_root else ("dist", ""):
+            for filename in valid_filenames:
+                if f"{location+'/' if location else ''}{filename}" in [
+                    x.full_path for x in self.tree
+                ]:
+                    self.data.file_name = filename.split("/")[-1]
+                    self.content.path.remote = location
+                    break

custom_components/hacs/repositories/python_script.py

@@ -0,0 +1,110 @@
+"""Class for python_scripts in HACS."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ..enums import HacsCategory, HacsDispatchEvent
+from ..exceptions import HacsException
+from ..utils.decorator import concurrent
+from .base import HacsRepository
+
+if TYPE_CHECKING:
+    from ..base import HacsBase
+
+
+class HacsPythonScriptRepository(HacsRepository):
+    """python_scripts in HACS."""
+
+    category = "python_script"
+
+    def __init__(self, hacs: HacsBase, full_name: str):
+        """Initialize."""
+        super().__init__(hacs=hacs)
+        self.data.full_name = full_name
+        self.data.full_name_lower = full_name.lower()
+        self.data.category = HacsCategory.PYTHON_SCRIPT
+        self.content.path.remote = "python_scripts"
+        self.content.path.local = self.localpath
+        self.content.single = True
+
+    @property
+    def localpath(self):
+        """Return localpath."""
+        return f"{self.hacs.core.config_path}/python_scripts"
+
+    async def validate_repository(self):
+        """Validate."""
+        # Run common validation steps.
+        await self.common_validate()
+
+        # Custom step 1: Validate content.
+        if self.repository_manifest.content_in_root:
+            self.content.path.remote = ""
+
+        compliant = False
+        for treefile in self.treefiles:
+            if treefile.startswith(f"{self.content.path.remote}") and treefile.endswith(".py"):
+                compliant = True
+                break
+        if not compliant:
+            raise HacsException(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            )
+
+        # Handle potential errors
+        if self.validate.errors:
+            for error in self.validate.errors:
+                if not self.hacs.status.startup:
+                    self.logger.error("%s %s", self.string, error)
+        return self.validate.success
+
+    async def async_post_registration(self):
+        """Registration."""
+        # Set name
+        self.update_filenames()
+
+        if self.hacs.system.action:
+            await self.hacs.validation.async_run_repository_checks(self)
+
+    @concurrent(concurrenttasks=10, backoff_time=5)
+    async def update_repository(self, ignore_issues=False, force=False):
+        """Update."""
+        if not await self.common_update(ignore_issues, force) and not force:
+            return
+
+        # Get python_script objects.
+        if self.repository_manifest.content_in_root:
+            self.content.path.remote = ""
+
+        compliant = False
+        for treefile in self.treefiles:
+            if treefile.startswith(f"{self.content.path.remote}") and treefile.endswith(".py"):
+                compliant = True
+                break
+        if not compliant:
+            raise HacsException(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            )
+
+        # Update name
+        self.update_filenames()
+
+        # Signal entities to refresh
+        if self.data.installed:
+            self.hacs.async_dispatch(
+                HacsDispatchEvent.REPOSITORY,
+                {
+                    "id": 1337,
+                    "action": "update",
+                    "repository": self.data.full_name,
+                    "repository_id": self.data.id,
+                },
+            )
+
+    def update_filenames(self) -> None:
+        """Get the filename to target."""
+        for treefile in self.tree:
+            if treefile.full_path.startswith(
+                self.content.path.remote
+            ) and treefile.full_path.endswith(".py"):
+                self.data.file_name = treefile.filename

custom_components/hacs/repositories/theme.py

@@ -0,0 +1,107 @@
+"""Class for themes in HACS."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from ..enums import HacsCategory, HacsDispatchEvent
+from ..exceptions import HacsException
+from ..utils.decorator import concurrent
+from .base import HacsRepository
+
+if TYPE_CHECKING:
+    from ..base import HacsBase
+
+
+class HacsThemeRepository(HacsRepository):
+    """Themes in HACS."""
+
+    def __init__(self, hacs: HacsBase, full_name: str):
+        """Initialize."""
+        super().__init__(hacs=hacs)
+        self.data.full_name = full_name
+        self.data.full_name_lower = full_name.lower()
+        self.data.category = HacsCategory.THEME
+        self.content.path.remote = "themes"
+        self.content.path.local = self.localpath
+        self.content.single = False
+
+    @property
+    def localpath(self):
+        """Return localpath."""
+        return f"{self.hacs.core.config_path}/themes/{self.data.file_name.replace('.yaml', '')}"
+
+    async def async_post_installation(self):
+        """Run post installation steps."""
+        try:
+            await self.hacs.hass.services.async_call("frontend", "reload_themes", {})
+        except BaseException:  # lgtm [py/catch-base-exception] pylint: disable=broad-except
+            pass
+
+    async def validate_repository(self):
+        """Validate."""
+        # Run common validation steps.
+        await self.common_validate()
+
+        # Custom step 1: Validate content.
+        compliant = False
+        for treefile in self.treefiles:
+            if treefile.startswith("themes/") and treefile.endswith(".yaml"):
+                compliant = True
+                break
+        if not compliant:
+            raise HacsException(
+                f"{self.string} Repository structure for {self.ref.replace('tags/','')} is not compliant"
+            )
+
+        if self.repository_manifest.content_in_root:
+            self.content.path.remote = ""
+
+        # Handle potential errors
+        if self.validate.errors:
+            for error in self.validate.errors:
+                if not self.hacs.status.startup:
+                    self.logger.error("%s %s", self.string, error)
+        return self.validate.success
+
+    async def async_post_registration(self):
+        """Registration."""
+        # Set name
+        self.update_filenames()
+        self.content.path.local = self.localpath
+
+        if self.hacs.system.action:
+            await self.hacs.validation.async_run_repository_checks(self)
+
+    @concurrent(concurrenttasks=10, backoff_time=5)
+    async def update_repository(self, ignore_issues=False, force=False):
+        """Update."""
+        if not await self.common_update(ignore_issues, force) and not force:
+            return
+
+        # Get theme objects.
+        if self.repository_manifest.content_in_root:
+            self.content.path.remote = ""
+
+        # Update name
+        self.update_filenames()
+        self.content.path.local = self.localpath
+
+        # Signal entities to refresh
+        if self.data.installed:
+            self.hacs.async_dispatch(
+                HacsDispatchEvent.REPOSITORY,
+                {
+                    "id": 1337,
+                    "action": "update",
+                    "repository": self.data.full_name,
+                    "repository_id": self.data.id,
+                },
+            )
+
+    def update_filenames(self) -> None:
+        """Get the filename to target."""
+        for treefile in self.tree:
+            if treefile.full_path.startswith(
+                self.content.path.remote
+            ) and treefile.full_path.endswith(".yaml"):
+                self.data.file_name = treefile.filename