Constructors

new

App::BorgRestore->new(\%deps);

Returns a new instance. The following dependencies can be injected:

• borg (optional)

  This object is used to interact with the borg repository of the system. Defaults to App::BorgRestore::Borg

• db (optional)

  This object is used to store the extracted data (the cache). Defaults to App::BorgRestore::DB

new_no_defaults

Same as "new" except that this does not initialize unset dependencies with their default values. This is probably only useful for tests.

Public Methods

resolve_relative_path

my $abs_path = $app->resolve_relative_path($path);

Returns an absolute path for a given path.

map_path_to_backup_path

my $path_in_backup = $app->map_path_to_backup_path($abs_path);

Maps an absolute path from the system to the path that needs to be looked up in / extracted from the backup using @backup_prefixes from App::BorgRestore::Settings.

Returns the mapped path (string).

find_archives

my $archives = $app->find_archives($path);

Returns an arrayref of archives (hash with "modification_time" and "archive") from the database that contain a path. Duplicates are filtered based on the modification time of the path in the archives.

get_all_archives

my $archives = $app->get_all_archives();

Returns an arrayref of archives (hash with "modification_time" and "archive") from borg directly. This does not require the database to be populated. Instead it just fetches a list of archives from borg at runtime and returns it.

The returned data structure is the same as that returned by "find_archives".

cache_contains_data

if ($app->cache_contains_data()) { ... }

Returns 1 if the cache contains any archive data, 0 otherwise.

select_archive_timespec

my $archive = $app->select_archive_timespec($archives, $timespec);

Returns one archive from $archives that is older than the value of $timespec.

timespec is a string of the form "<number><unit>" with unit being one of the following: s (seconds), min (minutes), h (hours), d (days), m (months = 31 days), y (year). Example: "5.5d"

restore

$app->restore($backup_path, $archive, $destination);

Restore a backup path (returned by "map_path_to_backup_path") from an archive (returned by "find_archives" or "get_all_archives") to a destination directory.

If the destination path ("$destination/$last_elem_of_backup_path") exists, it is removed before beginning extraction from the backup.

Warning: This method temporarily modifies the current working directory of the process during method execution since this is required by `borg extract`.

restore_simple

$app->restore_simple($path, $timespec, $destination);

Restores a $path based on a $timespec to an optional $destination. If $destination is not specified, it is set to the parent directory of $path so that $path is restored to its original place.

Refer to "select_archive_timespec" for an explanation of the $timespec variable.

search_path

my $paths = $app->search_path($pattern)

Returns a arrayref of paths that match the pattern. The pattern is matched as an sqlite LIKE pattern. If no % occurs in the pattern, the patterns is automatically wrapped between two % so it may match anywhere in the path.

get_missing_items

my $items = $app->get_missing_items($have, $want);

Returns an arrayref of items that are part of $want, but not of $have.

update_cache

$app->update_cache();

Updates the database used by e.g. "find_archives".