mirror of
https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git
synced 2024-11-26 14:01:30 +00:00
156 lines
4.6 KiB
Python
156 lines
4.6 KiB
Python
"""Class representing Bitwarden service"""
|
|
import base64
|
|
import subprocess
|
|
from typing import Optional, List
|
|
|
|
from selfprivacy_api.utils import get_domain, ReadUserData, WriteUserData
|
|
|
|
from selfprivacy_api.utils.systemd import get_service_status
|
|
from selfprivacy_api.services.service import Service, ServiceStatus
|
|
from selfprivacy_api.services.forgejo.icon import FORGEJO_ICON
|
|
from selfprivacy_api.services.config_item import (
|
|
StringConfigItem,
|
|
BoolConfigItem,
|
|
ConfigItem,
|
|
)
|
|
|
|
|
|
class Forgejo(Service):
|
|
"""Class representing Forgejo service.
|
|
|
|
Previously was Gitea, so some IDs are still called gitea for compatibility.
|
|
"""
|
|
|
|
config_items: dict[str, ConfigItem] = {
|
|
"subdomain": StringConfigItem(
|
|
id="subdomain",
|
|
default_value="git",
|
|
description="Subdomain",
|
|
regex=r"[A-Za-z0-9][A-Za-z0-9\-]{0,61}[A-Za-z0-9]",
|
|
widget="subdomain",
|
|
),
|
|
"appName": StringConfigItem(
|
|
id="appName",
|
|
default_value="SelfPrivacy git Service",
|
|
description="The name displayed in the web interface",
|
|
),
|
|
"enableLfs": BoolConfigItem(
|
|
id="enableLfs",
|
|
default_value=True,
|
|
description="Enable Git LFS",
|
|
),
|
|
"forcePrivate": BoolConfigItem(
|
|
id="forcePrivate",
|
|
default_value=False,
|
|
description="Force all new repositories to be private",
|
|
),
|
|
"disableRegistration": BoolConfigItem(
|
|
id="disableRegistration",
|
|
default_value=False,
|
|
description="Disable registration of new users",
|
|
),
|
|
"requireSigninView": BoolConfigItem(
|
|
id="requireSigninView",
|
|
default_value=False,
|
|
description="Require signin to view any page",
|
|
),
|
|
}
|
|
|
|
@staticmethod
|
|
def get_id() -> str:
|
|
"""Return service id. For compatibility keep in gitea."""
|
|
return "gitea"
|
|
|
|
@staticmethod
|
|
def get_display_name() -> str:
|
|
"""Return service display name."""
|
|
return "Forgejo"
|
|
|
|
@staticmethod
|
|
def get_description() -> str:
|
|
"""Return service description."""
|
|
return "Forgejo is a Git forge."
|
|
|
|
@staticmethod
|
|
def get_svg_icon() -> str:
|
|
"""Read SVG icon from file and return it as base64 encoded string."""
|
|
return base64.b64encode(FORGEJO_ICON.encode("utf-8")).decode("utf-8")
|
|
|
|
@staticmethod
|
|
def get_url() -> Optional[str]:
|
|
"""Return service url."""
|
|
domain = get_domain()
|
|
return f"https://git.{domain}"
|
|
|
|
@staticmethod
|
|
def get_subdomain() -> Optional[str]:
|
|
return "git"
|
|
|
|
@staticmethod
|
|
def is_movable() -> bool:
|
|
return True
|
|
|
|
@staticmethod
|
|
def is_required() -> bool:
|
|
return False
|
|
|
|
@staticmethod
|
|
def get_backup_description() -> str:
|
|
return "Git repositories, database and user data."
|
|
|
|
@staticmethod
|
|
def get_status() -> ServiceStatus:
|
|
"""
|
|
Return Gitea 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("forgejo.service")
|
|
|
|
@staticmethod
|
|
def stop():
|
|
subprocess.run(["systemctl", "stop", "forgejo.service"])
|
|
|
|
@staticmethod
|
|
def start():
|
|
subprocess.run(["systemctl", "start", "forgejo.service"])
|
|
|
|
@staticmethod
|
|
def restart():
|
|
subprocess.run(["systemctl", "restart", "forgejo.service"])
|
|
|
|
@classmethod
|
|
def get_configuration(cls):
|
|
with ReadUserData() as user_data:
|
|
return {
|
|
key: cls.config_items[key].as_dict(
|
|
user_data.get("modules", {}).get(cls.get_id(), {})
|
|
)
|
|
for key in cls.config_items
|
|
}
|
|
|
|
@classmethod
|
|
def set_configuration(cls, config_items):
|
|
with WriteUserData() as user_data:
|
|
if "modules" not in user_data:
|
|
user_data["modules"] = {}
|
|
if cls.get_id() not in user_data["modules"]:
|
|
user_data["modules"][cls.get_id()] = {}
|
|
for key, value in config_items.items():
|
|
cls.config_items[key].set_value(
|
|
value,
|
|
user_data["modules"][cls.get_id()],
|
|
)
|
|
|
|
@staticmethod
|
|
def get_logs():
|
|
return ""
|
|
|
|
@staticmethod
|
|
def get_folders() -> List[str]:
|
|
"""The data folder is still called gitea for compatibility."""
|
|
return ["/var/lib/gitea"]
|