mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
89bce7a344
- Add typing information for init methods Info, Shortcut, and Menu to easily identify problems. - Update docstrings for these components. - Updates test cases to deal with tags instead of short description. - Update custom shortcuts code to read tags and ignore short description. - Update API to send tags instead of custom shortcuts. - OpenVPN special treatment of info.description in Shortcut Tests: - All unit tests pass and type checking succeeds. - All apps show icons with tags in apps and system section. - In help section cards don't show tags. - In front page, enabled apps show shortcuts with tags. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Joseph Nuthalapati <njoseph@riseup.net>
140 lines
4.6 KiB
Python
140 lines
4.6 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to manage filesystem snapshots."""
|
|
|
|
import pathlib
|
|
|
|
import augeas
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import app as app_module
|
|
from plinth import menu
|
|
from plinth.modules import storage
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.package import Packages
|
|
|
|
from . import manifest, privileged
|
|
|
|
_description = [
|
|
_('Snapshots allows creating and managing btrfs file system snapshots. '
|
|
'These can be used to roll back the system to a previously known '
|
|
'good state in case of unwanted changes to the system.'),
|
|
# Translators: xgettext:no-python-format
|
|
_('Snapshots are taken periodically (called timeline snapshots) and also '
|
|
'before and after a software installation. Older snapshots will be '
|
|
'automatically cleaned up according to the settings below.'),
|
|
_('Snapshots currently work on btrfs file systems only and on the root '
|
|
'partition only. Snapshots are not a replacement for '
|
|
'<a href="/plinth/sys/backups">backups</a> since '
|
|
'they can only be stored on the same partition. ')
|
|
]
|
|
|
|
DEFAULT_FILE = '/etc/default/snapper'
|
|
|
|
fs_types_supported = ['btrfs']
|
|
|
|
|
|
class SnapshotApp(app_module.App):
|
|
"""FreedomBox app for snapshots."""
|
|
|
|
app_id = 'snapshot'
|
|
|
|
_version = 5
|
|
|
|
can_be_disabled = False
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
is_essential=True, name=_('Storage Snapshots'),
|
|
icon='fa-film', description=_description,
|
|
manual_page='Snapshots', tags=manifest.tags)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-snapshot', info.name, info.icon, info.tags,
|
|
'snapshot:index', parent_url_name='system:data',
|
|
order=40)
|
|
self.add(menu_item)
|
|
|
|
packages = Packages('packages-snapshot', ['snapper'])
|
|
self.add(packages)
|
|
|
|
backup_restore = SnapshotBackupRestore('backup-restore-snapshot',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
if is_supported():
|
|
privileged.setup(old_version)
|
|
self.enable()
|
|
|
|
|
|
class SnapshotBackupRestore(BackupRestore):
|
|
"""Component to backup/restore snapshot module."""
|
|
|
|
def restore_post(self, packet):
|
|
"""Run after restore."""
|
|
privileged.kill_daemon()
|
|
|
|
|
|
def is_supported():
|
|
"""Return whether snapshots are support on current setup."""
|
|
fs_type = storage.get_filesystem_type()
|
|
# Check that / is not a bind mounted btrfs filesystem similar to how
|
|
# snapper does the check: https://github.com/openSUSE/snapper/blob/
|
|
# 77eb6565d3d8df95a06cd52ce31174d98994939c/snapper/BtrfsUtils.cc#L61
|
|
root_inode_number = pathlib.Path('/').stat().st_ino
|
|
return fs_type in fs_types_supported and root_inode_number == 256
|
|
|
|
|
|
def load_augeas():
|
|
"""Initialize Augeas."""
|
|
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
|
|
augeas.Augeas.NO_MODL_AUTOLOAD)
|
|
|
|
# shell-script config file lens
|
|
aug.set('/augeas/load/Shellvars/lens', 'Shellvars.lns')
|
|
aug.set('/augeas/load/Shellvars/incl[last() + 1]', DEFAULT_FILE)
|
|
aug.load()
|
|
return aug
|
|
|
|
|
|
def is_apt_snapshots_enabled(aug):
|
|
"""Return whether APT snapshots is enabled."""
|
|
value = aug.get('/files' + DEFAULT_FILE + '/DISABLE_APT_SNAPSHOT')
|
|
return value != 'yes'
|
|
|
|
|
|
def get_configuration():
|
|
"""Return snapper configuration."""
|
|
aug = load_augeas()
|
|
output = privileged.get_config()
|
|
|
|
def get_boolean_choice(status):
|
|
return ('yes', 'Enabled') if status else ('no', 'Disabled')
|
|
|
|
def get_max_from_range(key):
|
|
return output[key].split('-')[-1]
|
|
|
|
return {
|
|
'enable_timeline_snapshots':
|
|
get_boolean_choice(output['TIMELINE_CREATE'] == 'yes'),
|
|
'enable_software_snapshots':
|
|
get_boolean_choice(is_apt_snapshots_enabled(aug)),
|
|
'hourly_limit':
|
|
get_max_from_range('TIMELINE_LIMIT_HOURLY'),
|
|
'daily_limit':
|
|
get_max_from_range('TIMELINE_LIMIT_DAILY'),
|
|
'weekly_limit':
|
|
get_max_from_range('TIMELINE_LIMIT_WEEKLY'),
|
|
'monthly_limit':
|
|
get_max_from_range('TIMELINE_LIMIT_MONTHLY'),
|
|
'yearly_limit':
|
|
get_max_from_range('TIMELINE_LIMIT_YEARLY'),
|
|
'free_space':
|
|
output['FREE_LIMIT'],
|
|
}
|