108 lines
3.4 KiB
Python
108 lines
3.4 KiB
Python
|
"""Class for plugins in HACS."""
|
||
|
|
import json
|
||
|
|
from integrationhelper import Logger
|
||
|
|
|
||
|
|
from .repository import HacsRepository
|
||
|
|
from ..hacsbase.exceptions import HacsException
|
||
|
|
|
||
|
|
from custom_components.hacs.helpers.information import find_file_name
|
||
|
|
|
||
|
|
|
||
|
|
class HacsPlugin(HacsRepository):
|
||
|
|
"""Plugins in HACS."""
|
||
|
|
|
||
|
|
def __init__(self, full_name):
|
||
|
|
"""Initialize."""
|
||
|
|
super().__init__()
|
||
|
|
self.data.full_name = full_name
|
||
|
|
self.data.file_name = None
|
||
|
|
self.data.category = "plugin"
|
||
|
|
self.information.javascript_type = None
|
||
|
|
self.content.path.local = (
|
||
|
|
f"{self.hacs.system.config_path}/www/community/{full_name.split('/')[-1]}"
|
||
|
|
)
|
||
|
|
self.logger = Logger(f"hacs.repository.{self.data.category}.{full_name}")
|
||
|
|
|
||
|
|
async def validate_repository(self):
|
||
|
|
"""Validate."""
|
||
|
|
# Run common validation steps.
|
||
|
|
await self.common_validate()
|
||
|
|
|
||
|
|
# Custom step 1: Validate content.
|
||
|
|
find_file_name(self)
|
||
|
|
|
||
|
|
if self.content.path.remote is None:
|
||
|
|
raise HacsException(
|
||
|
|
f"Repostitory 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.system.status.startup:
|
||
|
|
self.logger.error(error)
|
||
|
|
return self.validate.success
|
||
|
|
|
||
|
|
async def registration(self):
|
||
|
|
"""Registration."""
|
||
|
|
if not await self.validate_repository():
|
||
|
|
return False
|
||
|
|
|
||
|
|
# Run common registration steps.
|
||
|
|
await self.common_registration()
|
||
|
|
|
||
|
|
async def update_repository(self):
|
||
|
|
"""Update."""
|
||
|
|
if self.hacs.github.ratelimits.remaining == 0:
|
||
|
|
return
|
||
|
|
# Run common update steps.
|
||
|
|
await self.common_update()
|
||
|
|
|
||
|
|
# Get plugin objects.
|
||
|
|
find_file_name(self)
|
||
|
|
|
||
|
|
# Get JS type
|
||
|
|
await self.parse_readme_for_jstype()
|
||
|
|
|
||
|
|
if self.content.path.remote is None:
|
||
|
|
self.validate.errors.append("Repostitory structure not compliant")
|
||
|
|
|
||
|
|
if self.content.path.remote == "release":
|
||
|
|
self.content.single = True
|
||
|
|
|
||
|
|
async def get_package_content(self):
|
||
|
|
"""Get package content."""
|
||
|
|
try:
|
||
|
|
package = await self.repository_object.get_contents("package.json")
|
||
|
|
package = json.loads(package.content)
|
||
|
|
|
||
|
|
if package:
|
||
|
|
self.data.authors = package["author"]
|
||
|
|
except Exception: # pylint: disable=broad-except
|
||
|
|
pass
|
||
|
|
|
||
|
|
async def parse_readme_for_jstype(self):
|
||
|
|
"""Parse the readme looking for js type."""
|
||
|
|
readme = None
|
||
|
|
readme_files = ["readme", "readme.md"]
|
||
|
|
root = await self.repository_object.get_contents("")
|
||
|
|
for file in root:
|
||
|
|
if file.name.lower() in readme_files:
|
||
|
|
readme = await self.repository_object.get_contents(file.name)
|
||
|
|
break
|
||
|
|
|
||
|
|
if readme is None:
|
||
|
|
return
|
||
|
|
|
||
|
|
readme = readme.content
|
||
|
|
for line in readme.splitlines():
|
||
|
|
if "type: module" in line:
|
||
|
|
self.information.javascript_type = "module"
|
||
|
|
break
|
||
|
|
elif "type: js" in line:
|
||
|
|
self.information.javascript_type = "js"
|
||
|
|
break
|