mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
d09fe5240b
Fixes #2158. When 'systemctl show' is used see the ConditionResult property, the value is correct only when the unit has been started. When the unit is not running but can run, ConditionResult has a value of 'no' leading to an incorrect result. This in turn leads to _is_time_managed() returning incorrect value once the service has been stopped. FreedomBox would have noted that daemon can be enabled/disabled during startup while during attempts to enable it the action script will think that service can't be enabled/disabled. Fix this by using a better approach to detect when the service can run. Newer versions of systemd (likely >=250) have the ability to run 'systemd-analzye condition --unit=systemd-timesyncd.service' which have been ideal to detect this. However, --unit option is not available in older versions. Use systemd-virt-detect (part of systemd package) to detect for containers instead. Tests: - Boot the machine and run datetime functional tests - User interface should not show enable/disable button for the app in container but show in VM. - Running first setup (after removing /var/lib/plinth/plinth.sqlite3) should work on container and VM. - Run above tests on a container and on a VM Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
114 lines
3.6 KiB
Python
114 lines
3.6 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
|
|
from plinth.modules.backups.components import BackupRestore
|
|
|
|
from . import manifest
|
|
|
|
_description = [
|
|
_('Network time server is a program that maintains the system time '
|
|
'in synchronization with servers on the Internet.')
|
|
]
|
|
|
|
app = None
|
|
|
|
|
|
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)
|
|
|
|
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(helper, old_version=None):
|
|
"""Install and configure the module."""
|
|
helper.call('post', app.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]
|