mirror of
https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git
synced 2024-11-19 00:39:15 +00:00
135 lines
4 KiB
Python
135 lines
4 KiB
Python
"""Class representing Nextcloud service."""
|
|
import base64
|
|
import subprocess
|
|
import typing
|
|
from selfprivacy_api.jobs import Job, Jobs
|
|
from selfprivacy_api.services.generic_service_mover import FolderMoveNames, move_service
|
|
from selfprivacy_api.utils.systemd import get_service_status
|
|
from selfprivacy_api.services.service import Service, ServiceDnsRecord, ServiceStatus
|
|
from selfprivacy_api.utils import get_domain
|
|
from selfprivacy_api.utils.block_devices import BlockDevice
|
|
import selfprivacy_api.utils.network as network_utils
|
|
from selfprivacy_api.services.nextcloud.icon import NEXTCLOUD_ICON
|
|
|
|
|
|
class Nextcloud(Service):
|
|
"""Class representing Nextcloud service."""
|
|
|
|
@staticmethod
|
|
def get_id() -> str:
|
|
"""Return service id."""
|
|
return "nextcloud"
|
|
|
|
@staticmethod
|
|
def get_display_name() -> str:
|
|
"""Return service display name."""
|
|
return "Nextcloud"
|
|
|
|
@staticmethod
|
|
def get_description() -> str:
|
|
"""Return service description."""
|
|
return "Nextcloud is a cloud storage service that offers a web interface and a desktop client."
|
|
|
|
@staticmethod
|
|
def get_svg_icon() -> str:
|
|
"""Read SVG icon from file and return it as base64 encoded string."""
|
|
return base64.b64encode(NEXTCLOUD_ICON.encode("utf-8")).decode("utf-8")
|
|
|
|
@staticmethod
|
|
def get_url() -> typing.Optional[str]:
|
|
"""Return service url."""
|
|
domain = get_domain()
|
|
return f"https://cloud.{domain}"
|
|
|
|
@staticmethod
|
|
def is_movable() -> bool:
|
|
return True
|
|
|
|
@staticmethod
|
|
def is_required() -> bool:
|
|
return False
|
|
|
|
@staticmethod
|
|
def get_backup_description() -> str:
|
|
return "All the files and other data stored in Nextcloud."
|
|
|
|
@staticmethod
|
|
def get_status() -> ServiceStatus:
|
|
"""
|
|
Return Nextcloud status from systemd.
|
|
Use command return code to determine status.
|
|
|
|
Return code 0 means service is running.
|
|
Return code 1 or 2 means service is in error stat.
|
|
Return code 3 means service is stopped.
|
|
Return code 4 means service is off.
|
|
"""
|
|
return get_service_status("phpfpm-nextcloud.service")
|
|
|
|
@staticmethod
|
|
def stop():
|
|
"""Stop Nextcloud service."""
|
|
subprocess.Popen(["systemctl", "stop", "phpfpm-nextcloud.service"])
|
|
|
|
@staticmethod
|
|
def start():
|
|
"""Start Nextcloud service."""
|
|
subprocess.Popen(["systemctl", "start", "phpfpm-nextcloud.service"])
|
|
|
|
@staticmethod
|
|
def restart():
|
|
"""Restart Nextcloud service."""
|
|
subprocess.Popen(["systemctl", "restart", "phpfpm-nextcloud.service"])
|
|
|
|
@staticmethod
|
|
def get_configuration() -> dict:
|
|
"""Return Nextcloud configuration."""
|
|
return {}
|
|
|
|
@staticmethod
|
|
def set_configuration(config_items):
|
|
return super().set_configuration(config_items)
|
|
|
|
@staticmethod
|
|
def get_logs():
|
|
"""Return Nextcloud logs."""
|
|
return ""
|
|
|
|
@staticmethod
|
|
def get_folders() -> typing.List[str]:
|
|
return ["/var/lib/nextcloud"]
|
|
|
|
@staticmethod
|
|
def get_dns_records() -> typing.List[ServiceDnsRecord]:
|
|
return [
|
|
ServiceDnsRecord(
|
|
type="A",
|
|
name="cloud",
|
|
content=network_utils.get_ip4(),
|
|
ttl=3600,
|
|
display_name="Nextcloud",
|
|
),
|
|
ServiceDnsRecord(
|
|
type="AAAA",
|
|
name="cloud",
|
|
content=network_utils.get_ip6(),
|
|
ttl=3600,
|
|
display_name="Nextcloud (IPv6)",
|
|
),
|
|
]
|
|
|
|
def move_to_volume(self, volume: BlockDevice) -> Job:
|
|
job = Jobs.add(
|
|
type_id="services.nextcloud.move",
|
|
name="Move Nextcloud",
|
|
description=f"Moving Nextcloud to volume {volume.name}",
|
|
)
|
|
move_service(
|
|
self,
|
|
volume,
|
|
job,
|
|
FolderMoveNames.default_foldermoves(self),
|
|
"nextcloud",
|
|
)
|
|
return job
|