Files
profilarr/backend/app/task/backup/backup.py
santiagosayshey d8f944af11 improvements: whole lotta stuff (#18)
* feat: initialise task scheduler

* feat: add "next run" field to task status

* fix: adjust status route path

* feat: task dashboard + api functions

* fix: return sucess object for alert

* refactor: turn task cards into seperate objects

* fix: change task names

* feat: implement compile and import module
- only working for custom formats for now

* refactor/feature: refactor compilation module
- seperate file for mappings
- seperate format compiler into new file
- add compiler for profiles

* feat: add import logic for quality profiles

* fix: properly resolve cutoff IDs for singular qualities

* fix: remux mappings for sonarr

* fix: retain quality group order
- stop groups first, then singular

* fix: dynamically find next group ID to stop duplicate IDs from occuring

* fix: normalise quality letter case

* feat: add api functions for import functionality

* fix: adjust validation for import.js

* feat: add mass selection tool componnet
- keyboard shortcuts to enter state
- mass delete / import

* feat: add loading indicator on import

* style: improve selected card styling

* fix: append extra custom formats with 0 score

* perf: add git status caching to improve load times

* fix: adjust mass import handling and selection logic
- use content.name rather than content.id

* fix: enhance quality name mapping with alternate names and case-insensitive lookups

* feat: add description truncation to ProfileCard for improved readability
- also remove qualitites

* fix: update upgrade quality selection logic to handle disabling scenarios

* feat: expand language mappings with additional languages and identifiers

* feat: enhance profile conversion logging with language handling

* fix: clarify language setting impact in ProfileLanguagesTab component

* feat: add Sonarr language mappings and update language selection logic

* feat: implement language normalization and enhance logging in format conversion

* feat: enhance logging in format conversion and add language specification handling

* feat: add Afrikaans and Albanian languages to the language constants

* refactor: remove language strictness feature and update language handling in ProfileModal

* feat: add logging setup for improved debugging in mappings module

* feat: enhance language compilation to work with new system

* feat: update language handling in ProfileLanguagesTab to support 'any' behavior

* fix: remove redundant import statement in profile.py

* feat: implement in-memory format import functionality and update profile compiler to utilize it for non english language compilation

* feat: add comparison for tweaks in quality profile changes

* feat: add functions to convert display names to filenames and vice versa

* fix: remove unnecessary filename modification in formats data

* feat: add process_tweaks function to handle profile tweaks and import formats before compilation

* feat: refactor process_tweaks to modularize format import and scoring
- include lossless audio tweak handling

* feat: add support for Dolby Vision no fallback and bleeding edge codecs in process_tweaks

* feat: add support for disabling prereleases based on profile tweaks

* fix: reduce cache TTL from 30 seconds to 1 second for quicker updates

* feat: add resetState function to initialize profile modal state

* feat: enhance save_yaml_file function to optionally use data name for filename

* feat: enhance handle_rename function to account for staged renames

* feat: enhance revert functionality to handle untracked files and staged deletions

* chore: update timezone setting in docker-compose.yml

* feat: increase maximum description length in ProfileCard component

* refactor: generic YAML comparison and change summary functionality

* refactor: incoming changes now uses generic comparison logic

* refactor: add YAML conflict comparison functionality with detailed summary generation for merge conflicts

* refactor: heavily simplified resolve conflict modal to work with new generic conflict parsing

* refactor: implement GitStatusManager for improved repository status handling and sync task updates

* refactor: integrate GitStatusManager to update remote status after pull operations

* refactor: remove isDevMode prop from ChangeRow, ConflictRow, ConflictTable, ChangeTable, RepoContainer, and ActionButtons components

* refactor: migrate settings handling from settings_utils to db module and enhance settings management

* refactor: remove deprecated authentication methods and streamline push operations with SSH access

* refactor: enhance error handling and authentication for Git operations, including PAT support

* refactor: remove old settings_utils

* refactor: add settings prop to StatusContainer and update database initialization for profilarr_pat

* refactor: simplify format name handling in ViewChanges component by removing old API call

* fix: update fetchSettings to handle cases with no git repository and ensure settings is null

* fix: enhance get_git_status to return a valid status object when no git repository is found

* style: various improvements to repo container
- add database stats
- add organisation / profile avatar
- parse organisation / repo name
- improvements to branch button

* feat: implement authentication setup and middleware for secure session management

* fix: auto login after setting up authentication

* feat: enhance authentication setup with GET method and track failed attempts

* feat: add authentication setup and login components with API integration

* feat: redesign SetupPage component with improved layout and user guidance

* feat: enhance LoginPage layout with improved design and user guidance

* refactor: remove unused API functions for regex and format management

* improvements: whole lot more stuff (#17)

* feat: implement configuration management for directory paths and session settings

* feat: implement backup management with API endpoints for backup operations

* feat: add backup import functionality with zip file validation and restoration

* feat: implement backup API with endpoints for listing, creating, downloading, restoring, deleting, and importing backups

* feat: enhance backup listing with file size and last modified time

* feat: add backup management interface with listing, creation, restoration, and deletion functionalities

* fix: refresh backups list after successful deletion

* feat: create BackupCard component for displaying backup details and actions

* fix: status parsing improvements
- now properly shows outgoing changes with / without developer mode

* fix: remove authentication bypass for backup routes during testing

* feat: add logging configuration and ensure log directory creation

* feat: implement application-wide logging configuration and ensure log directory creation

* feat: add logging blueprint with endpoints for retrieving and searching log files

* feat: add git logging configuration to enhance logging capabilities

* refactor: enhance logging details and improve error handling in repository cloning and file processing

* refactor: update tab labels for clarity in settings page

* refactor: remove unused tasks and streamline task scheduler

* refactor: improve repository settings handling and UI updates in RepoContainer

* style: add slight gradient to modal

* feat: enhance footer with GitHub repository info and organization avatar

* refactor: update imports and enhance modal layout for linking Git repository

* refactor: remove documentation and issue links from footer component

* refactor: git settings refactor.
- new git container to contain repo / status
- split repo container into active / empty components
- split status into seperate sections for incoming, outgoing, conflict

* chore: simplify environment configuration by using .env file in docker-compose

* fix: update remote status after commit and push operations

* refactor: restructure application initialization and configure Git user settings on startup

* refactor: improve default Git user configuration handling in initialization

* style: enhance UI styling and structure for Git status display

* style: enhance UI layout and styling for ChangeRow and ChangeTable components

* style: enhance UI layout and styling for CommitMessage component

* style: improve selected row styling

* style: enhance UI styling for ConflictRow and ConflictTable components

* style: update merge process to include remote status update after finalization

* style: update noChangesMessages for improved clarity and engagement

* feat: add animated Logo component and integrate it into Navbar

* feat: enhance selection handling
- add shift selection
- add will be selected state and styling

* feat: enhance mouse tracking for shift selection

* refactor: remove deprecated ActionButtons

* style: unify button colors and update tooltips in IncomingChanges and OutgoingChanges components

* feat: add auto-pull feature with toggle in settings and backend support

* fix: update auto-pull implementation to use integer values

* feat: implement auto-pull functionality in remote status update

* file: improve value formatting for new files

* fix: change logger level to DEBUG and add debug message for profile import attempts

* refactor: remove logging statements and streamline exception handling in format compiler

* feat: enhance format import process with detailed logging and error handling

* feat: enhance profile import process with detailed logging and error handling

* refactor: remove non error logging statements for profile compilation

* feat: enhance logging for memory-based format import with detailed success and error messages

* feat: add logging for language settings and compiled profile data in profile import

* feat: add dedicated logging for importarr with separate log file and configuration

* feat: add logging API with functions to fetch logs, search, and filter by level

* feat: add logs tab to settings page with LogContainer component

* feat: add LogContainer and LogViewer components for enhanced log management

* fix: dynamic vertical height for log viewer

* fix: reduce log file size and increase backup count for improved log management

* fix: enhance error logging with exception type and full traceback for better debugging

* fix: use mapped cutoff name for profile conversion to ensure correct quality mapping

* fix: add validation for git repository existence before syncing

* fix: implement delete constraints check before item deletion to prevent breaking references

* fix: enhance delete constraints check with improved logging and name normalization

* fix: add protection against deletion of required custom formats in delete constraints check

* feat: implement ANSI color parsing in LogViewer for improved log readability

* feat: enhance ViewChanges component with improved key parsing and rendering of changes

* refactor: improve styling and structure of ResolveConflicts component for better readability and usability

* fix: improve error handling and response for arr config saving

* feat: extend arr configuration with additional fields and sync methods

* feat: add DataSelectorModal component for selecting data to sync

* feat: enhance ArrModal and DataSelectorModal with improved layout and data display

* feat: update ArrContainer to use new API import and include additional arrConfig fields

* feat: enhance ArrCard component with sync details and improved layout

* feat: add AddButton component with custom positioning and animations

* feat: replace Add New Card section with AddButton component for improved UX

* feat: reposition AddButton in ArrContainer for better visibility

* feat: replace AddNewCard with AddButton in RegexPage for improved UX

* feat: replace AddNewCard with AddButton in FormatPage for improved UX

* feat: replace AddNewCard with AddButton in ProfilePage for improved UX
2025-02-05 16:09:59 +10:30

187 lines
6.8 KiB
Python

# app/task/backup/backup.py
import os
import shutil
from datetime import datetime, timedelta
import logging
from pathlib import Path
import zipfile
import tempfile
from ...config.config import config
from ...db import get_db
logger = logging.getLogger(__name__)
class BackupManager:
def __init__(self):
self.backup_dir = os.path.join(config.CONFIG_DIR, 'backups')
self.retention_days = 30
self._ensure_backup_directory()
def _ensure_backup_directory(self):
"""Ensure backup directory exists"""
os.makedirs(self.backup_dir, exist_ok=True)
def create_backup(self):
"""Create a new backup of the config directory"""
try:
# Generate backup filename with timestamp
timestamp = datetime.now().strftime('%Y_%m_%d_%H%M%S')
backup_filename = f'backup_{timestamp}.zip'
backup_path = os.path.join(self.backup_dir, backup_filename)
# Create zip file
with zipfile.ZipFile(backup_path, 'w',
zipfile.ZIP_DEFLATED) as zipf:
# Walk through all files in config directory
for root, dirs, files in os.walk(config.CONFIG_DIR):
# Skip the backups directory itself
if 'backups' in root:
continue
for file in files:
file_path = os.path.join(root, file)
# Calculate path relative to config directory
arc_path = os.path.relpath(file_path,
config.CONFIG_DIR)
zipf.write(file_path, arc_path)
# Record backup in database
with get_db() as conn:
conn.execute(
'''
INSERT INTO backups (filename, created_at, status)
VALUES (?, CURRENT_TIMESTAMP, 'completed')
''', (backup_filename, ))
conn.commit()
logger.info(f'Backup created successfully: {backup_filename}')
return True, backup_filename
except Exception as e:
logger.error(f'Error creating backup: {str(e)}')
return False, str(e)
def restore_backup(self, backup_filename):
"""Restore from a backup file"""
backup_path = os.path.join(self.backup_dir, backup_filename)
if not os.path.exists(backup_path):
return False, "Backup file not found"
try:
# Create a temporary directory for extraction
temp_dir = os.path.join(self.backup_dir, 'temp_restore')
os.makedirs(temp_dir, exist_ok=True)
# Extract backup to temporary directory
with zipfile.ZipFile(backup_path, 'r') as zipf:
zipf.extractall(temp_dir)
# Move files to config directory
for item in os.listdir(temp_dir):
s = os.path.join(temp_dir, item)
d = os.path.join(config.CONFIG_DIR, item)
if os.path.isdir(s):
# Skip backups directory if it exists in the backup
if item == 'backups':
continue
shutil.rmtree(d, ignore_errors=True)
shutil.copytree(s, d, dirs_exist_ok=True)
else:
shutil.copy2(s, d)
# Clean up temporary directory
shutil.rmtree(temp_dir)
logger.info(f'Backup restored successfully: {backup_filename}')
return True, "Backup restored successfully"
except Exception as e:
logger.error(f'Error restoring backup: {str(e)}')
return False, str(e)
def cleanup_old_backups(self):
"""Remove backups older than retention period"""
try:
cutoff_date = datetime.now() - timedelta(days=self.retention_days)
with get_db() as conn:
# Get list of old backups
old_backups = conn.execute(
'''
SELECT filename FROM backups
WHERE created_at < ?
''', (cutoff_date.isoformat(), )).fetchall()
# Remove old backup files and database entries
for backup in old_backups:
backup_path = os.path.join(self.backup_dir,
backup['filename'])
if os.path.exists(backup_path):
os.remove(backup_path)
conn.execute('DELETE FROM backups WHERE filename = ?',
(backup['filename'], ))
conn.commit()
logger.info('Old backups cleaned up successfully')
return True, "Cleanup completed successfully"
except Exception as e:
logger.error(f'Error cleaning up old backups: {str(e)}')
return False, str(e)
def list_backups(self):
"""List all available backups"""
try:
with get_db() as conn:
backups = conn.execute('''
SELECT filename, created_at, status
FROM backups
ORDER BY created_at DESC
''').fetchall()
return [{
'filename': backup['filename'],
'created_at': backup['created_at'],
'status': backup['status']
} for backup in backups]
except Exception as e:
logger.error(f'Error listing backups: {str(e)}')
return []
def restore_backup_from_file(self, file_path):
"""Restore from a backup file path"""
try:
# Create a temporary directory for extraction
with tempfile.TemporaryDirectory() as temp_dir:
# Extract backup to temporary directory
with zipfile.ZipFile(file_path, 'r') as zipf:
zipf.extractall(temp_dir)
# Move files to config directory
for item in os.listdir(temp_dir):
s = os.path.join(temp_dir, item)
d = os.path.join(config.CONFIG_DIR, item)
if os.path.isdir(s):
# Skip backups directory if it exists in the backup
if item == 'backups':
continue
shutil.rmtree(d, ignore_errors=True)
shutil.copytree(s, d, dirs_exist_ok=True)
else:
shutil.copy2(s, d)
logger.info(f'Backup imported and restored successfully')
return True, "Backup imported and restored successfully"
except Exception as e:
logger.error(f'Error importing and restoring backup: {str(e)}')
return False, str(e)