mirror of
https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git
synced 2024-11-13 22:23:16 +00:00
114 lines
2.9 KiB
Python
114 lines
2.9 KiB
Python
"""Class representing Roundcube service"""
|
|
|
|
import base64
|
|
import subprocess
|
|
from typing import List, Optional
|
|
|
|
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
|
|
from selfprivacy_api.utils import ReadUserData, get_domain
|
|
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."""
|
|
return "Roundcube"
|
|
|
|
@staticmethod
|
|
def get_description() -> str:
|
|
"""Return service description."""
|
|
return "Roundcube is an open source webmail software."
|
|
|
|
@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")
|
|
|
|
@classmethod
|
|
def get_url(cls) -> Optional[str]:
|
|
"""Return service url."""
|
|
domain = get_domain()
|
|
subdomain = cls.get_subdomain()
|
|
return f"https://{subdomain}.{domain}"
|
|
|
|
@classmethod
|
|
def get_subdomain(cls) -> Optional[str]:
|
|
with ReadUserData() as data:
|
|
if "roundcube" in data["modules"]:
|
|
return data["modules"]["roundcube"]["subdomain"]
|
|
|
|
return "roundcube"
|
|
|
|
@staticmethod
|
|
def is_movable() -> bool:
|
|
return False
|
|
|
|
@staticmethod
|
|
def is_required() -> bool:
|
|
return False
|
|
|
|
@staticmethod
|
|
def can_be_backed_up() -> bool:
|
|
return False
|
|
|
|
@staticmethod
|
|
def get_backup_description() -> str:
|
|
return "Nothing to backup."
|
|
|
|
@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]:
|
|
return []
|
|
|
|
def move_to_volume(self, volume: BlockDevice) -> Job:
|
|
raise NotImplementedError("roundcube service is not movable")
|