Sunil Mohan Adapa 8c1f73f54c
datetime: Re-implment backup/restore for timezone
Closes: #2326.

Earlier /etc/timezone was used to store timezone. Now, we use /etc/localtime
symlink instead. Since the change, backup/restore for timezone has not been
working. Implement this by backing up and restoring the new symlink. Borg
understands symlinks so it properly backs them up and restore them.

When the symlink is restored, timedatectl does not immediately show the new
timezone. This is because a DBus activated daemon 'systemd-timedated' which
supplies the information for timedatectl needs to be reloaded. Add this service
to list of services that backup framework needs to restart.

Tests:

- Set a new timezone. Backup datetime app. Set another timezone. Restore the
datetime app. Visiting the datetime app shows the restored timezone as expected
and timedatectl on command line also immediately shows the expected timezone.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2023-04-07 09:53:00 -04:00

119 lines
3.8 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
FreedomBox app to configure system date and time.
"""
import subprocess
from django.utils.translation import gettext_lazy as _
from plinth import app as app_module
from plinth import menu
from plinth.daemon import Daemon, RelatedDaemon
from plinth.modules.backups.components import BackupRestore
from plinth.package import Packages
from . import manifest
_description = [
_('Network time server is a program that maintains the system time '
'in synchronization with servers on the Internet.')
]
class DateTimeApp(app_module.App):
"""FreedomBox app for date and time if time syncronization is unmanaged."""
app_id = 'datetime'
_version = 2
_time_managed = None
@property
def can_be_disabled(self):
"""Return whether the app can be disabled."""
return self._is_time_managed()
def _is_time_managed(self):
"""Check whether time should be syncronized by the systemd-timesyncd.
systemd-timesyncd does not run if we have another NTP daemon installed
or FreedomBox runs inside a container where the host manages the time.
"""
if self._time_managed is None:
try:
# Replace with the command 'systemd-analyze condition
# --unit=systemd-timesyncd.service' when --unit argument
# becomes available in a newer systemd.
process = subprocess.run(
['systemd-detect-virt', '--container'], check=False,
stdout=subprocess.PIPE)
self._time_managed = (
process.stdout.decode().strip() == 'none')
except (FileNotFoundError, subprocess.CalledProcessError):
# When systemd-timesyncd will not run.
self._time_managed = False
return self._time_managed
def __init__(self):
"""Create components for the app."""
super().__init__()
info = app_module.Info(app_id=self.app_id, version=self._version,
is_essential=True, name=_('Date & Time'),
icon='fa-clock-o', description=_description,
manual_page='DateTime')
self.add(info)
menu_item = menu.Menu('menu-datetime', info.name, None, info.icon,
'datetime:index', parent_url_name='system')
self.add(menu_item)
packages = Packages('packages-datetime', ['systemd-timesyncd'])
self.add(packages)
daemon = RelatedDaemon('daemon-datetime', 'systemd-timedated')
self.add(daemon)
if self._is_time_managed():
daemon = Daemon('daemon-datetime', 'systemd-timesyncd')
self.add(daemon)
backup_restore = BackupRestore('backup-restore-datetime',
**manifest.backup)
self.add(backup_restore)
def diagnose(self):
"""Run diagnostics and return the results."""
results = super().diagnose()
if self._is_time_managed():
results.append(_diagnose_time_synchronized())
return results
def has_diagnostics(self):
"""Return that app has diagnostics only when time is managed."""
return self._is_time_managed()
def setup(self, old_version):
"""Install and configure the app."""
super().setup(old_version)
self.enable()
def _diagnose_time_synchronized():
"""Check whether time is synchronized to NTP server."""
result = 'failed'
try:
output = subprocess.check_output(
['timedatectl', 'show', '--property=NTPSynchronized', '--value'])
if 'yes' in output.decode():
result = 'passed'
except subprocess.CalledProcessError:
pass
return [_('Time synchronized to NTP server'), result]