selfprivacy-rest-api/selfprivacy_api/services/roundcube/__init__.py

114 lines
2.9 KiB
Python
Raw Normal View History

2024-06-06 19:14:07 +00:00
"""Class representing Roundcube service"""
import base64
import subprocess
2024-06-26 12:00:51 +00:00
from typing import List, Optional
2024-06-06 19:14:07 +00:00
from selfprivacy_api.jobs import Job
from selfprivacy_api.utils.systemd import (
get_service_status_from_several_units,
)
from selfprivacy_api.services.service import Service, ServiceStatus
2024-06-26 12:00:51 +00:00
from selfprivacy_api.utils import ReadUserData, get_domain
2024-06-06 19:14:07 +00:00
from selfprivacy_api.utils.block_devices import BlockDevice
from selfprivacy_api.services.roundcube.icon import ROUNDCUBE_ICON
class Roundcube(Service):
"""Class representing roundcube service"""
@staticmethod
def get_id() -> str:
"""Return service id."""
return "roundcube"
@staticmethod
def get_display_name() -> str:
"""Return service display name."""
2024-06-12 13:56:43 +00:00
return "Roundcube"
2024-06-06 19:14:07 +00:00
@staticmethod
def get_description() -> str:
"""Return service description."""
2024-06-12 13:56:43 +00:00
return "Roundcube is an open source webmail software."
2024-06-06 19:14:07 +00:00
@staticmethod
def get_svg_icon() -> str:
"""Read SVG icon from file and return it as base64 encoded string."""
return base64.b64encode(ROUNDCUBE_ICON.encode("utf-8")).decode("utf-8")
2024-06-26 12:00:51 +00:00
@classmethod
def get_url(cls) -> Optional[str]:
"""Return service url."""
domain = get_domain()
2024-06-26 12:00:51 +00:00
subdomain = cls.get_subdomain()
return f"https://{subdomain}.{domain}"
2024-06-26 12:00:51 +00:00
@classmethod
def get_subdomain(cls) -> Optional[str]:
with ReadUserData() as data:
if "roundcube" in data["modules"]:
return data["modules"]["roundcube"]["subdomain"]
2024-06-26 12:00:51 +00:00
return "roundcube"
2024-06-06 19:14:07 +00:00
@staticmethod
def is_movable() -> bool:
return False
@staticmethod
def is_required() -> bool:
return False
2024-06-19 11:20:31 +00:00
@staticmethod
def can_be_backed_up() -> bool:
return False
2024-06-06 19:14:07 +00:00
@staticmethod
def get_backup_description() -> str:
2024-06-19 11:20:31 +00:00
return "Nothing to backup."
2024-06-06 19:14:07 +00:00
@staticmethod
def get_status() -> ServiceStatus:
return get_service_status_from_several_units(["phpfpm-roundcube.service"])
@staticmethod
def stop():
subprocess.run(
["systemctl", "stop", "phpfpm-roundcube.service"],
check=False,
)
@staticmethod
def start():
subprocess.run(
["systemctl", "start", "phpfpm-roundcube.service"],
check=False,
)
@staticmethod
def restart():
subprocess.run(
["systemctl", "restart", "phpfpm-roundcube.service"],
check=False,
)
@staticmethod
def get_configuration():
return {}
@staticmethod
def set_configuration(config_items):
return super().set_configuration(config_items)
@staticmethod
def get_logs():
return ""
@staticmethod
def get_folders() -> List[str]:
2024-06-12 14:48:56 +00:00
return []
2024-06-06 19:14:07 +00:00
def move_to_volume(self, volume: BlockDevice) -> Job:
raise NotImplementedError("roundcube service is not movable")