catalog: add missing function documentation.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

catalog: introduce is_symlink() to check if DirEntry is a symlink.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

catalog: derive PartEq for equality checks of two DirEntry's.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

src/backup/dynamic_index.rs: Add LruCache for chunks.

In order to improve non-sequential reads of chunks as e.g. in FUSE.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

catalog: shell: Introduce clear-selected command.

'clear-selected' allows to clear all the match patterns from the list of
patterns for a subsequent restore.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

catalog: shell: Improve list-selected command.

'list-selected' now shows the filenames matching the patterns for a restore
instead of the patterns themselfs.
The patterns can be displayed by passing the '--pattern' flag.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

pxar::decoder: Return the correct symlink target size.

This eliminates also repeated calls to readlink in fuse, which occur when the
preallocated buffer to store the symlink target path is to small.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

proxmox-backup-client: expose exclude match patterns to cli.

Allows to pass exclude match patterns to the 'backup' command.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

src/bin/proxmox-backup-manager.rs: cleanup output handling

src/tools/format.rs: move output rendering code to this new file

src/bin/proxmox-backup-client.rs - list_groups: use format_and_print_result_full()

Depend on proxmox 0.1.16-1

src/bin/proxmox-backup-client.rs: use new output formath helpers from proxmox 0.15.1-1

src/bin/proxmox-backup-client.rs - status: improve alignment

src/bin/proxmox-backup-client.rs - status: do not print header

src/bin/proxmox-backup-client.rs - list_snapshots: use format_and_print_result_full()

Depend on proxmox v0.1.14.

tools::lru_cache: Improve access() and insert() by using HashMap::entry().

entry() allows to lookup the position where and entry belongs and update/insert
it in the HashMap more efficiently than get_mut() and insert().
Details: https://gankra.github.io/blah/hashbrown-insert/

In addition, use the struct LinkedList and remove the outdated code.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

tools::lru_cache: Separate LinkedList part of LruCache into own struct.

In order to keep the separation more aparent and avoid mut borrow conflics.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

tools::lru_cache: Make key generic.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

catalog: shell: Improve output of stat command.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

Add zsh completion scripts

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

src/bin/proxmox-backup-client.rs - list_snapshot_files: use format_and_print_result_full()

src/bin/proxmox-backup-client.rs - status: use format_and_print_result_full

src/bin/proxmox-backup-manager.rs: use crate::tools::runtime::block_on()

src/tools/runtime.rs: call OPENSSL_thread_stop to avoid race with openssl cleanup handlers

src/client/backup_writer.rs: also print archive size

cleanup unused module

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

docs: add documentation for pxar

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

pxar: Change text of warning for files matched by exclude patterns.

In addition to the .pxarexclude files, glob match patterns can be passed to pxar
also via cli parameters.
Therefore the warning is rephrased to be more ambiguous.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

src/client/backup_writer.rs: prefix upload stats with archive name

src/client/backup_writer.rs: implement verbose options

src/client/backup_writer.rs: reduce verbosity

docs: fix typo

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

docs: Add documentation for .pxarexclude files

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

src/backup/backup_info.rs: fix SNAPSHOT_PATH_REGEX and GROUP_PATH_REGEX

runtime: fix blocking strategy:

- do not "double"-block_in_place() (it may not be nested)
- do not call block_in_place() in non-worker threads

is_in_tokio() isn't sufficient, we need to actually know
that we're in a worker-thread, so we do this by remembering
that we're blocking.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

runtime: remove IN_TOKIO thread local variable

tokio now has Handle::try_current() allowing us to
generally check for a tokio runtime even if spawned by
someone else

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

administration-guide.rst: documnet new PBS_FINGERPRINT env var

src/client/http_client.rs: do not store fingerprints passed via options in cache

src/client/http_client.rs: always convert fingerprint to lowercase

src/client/http_client.rs: remove useless password_env

src/bin/proxmox-backup-client.rs: allows to pass fingerprint via env vars

s/pbsbanner/proxmox-backup-banner/ + move to /usr/lib

We want to avoid pbs if possible and also avoid placing internal
binaries, not intended for human direct use, in /bin or /sbin paths.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

pbsbanner: use match and also return error

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

add login banner service

Modeled after the one from PVE, but using rust instead of perl for
resolving the nodename and writing to /etc/issue

Behavior differs a bit. We write all non-loopback addresses to this
file, as the gui accepts connections from them all, so limiting it to
the first one is not really sensible.
Further an error to resolve, or only getting loopback addresses won't
write out an empty /etc/issue file, but a note about the error at the
place where the address would be displayed.

Named it "pbsbanner", not "proxmox-backup-banner" as it's rather an
internal tool anyway and mirrors pvebanner, pmgbanner

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

catalog: shell: Allow two or more successive slashes in path.

Two or more successive slashes should be allowed and treated as a single slash.
We also do not treat two successive slashes at the beginning of a path any
different.

Details are found here:
https://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap04.html#tag_04_11

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar::fuse: cleanup: Remove unused code.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar::fuse: Refactor lookup in order to cache accessed entries.

Context::find_goodbye_entry() is removed and incorporated into the lookup
callback in order to take advantage of the entry_cache and since it is only used
inside this callback.
All entries read on lookup are cached.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar: Improve read performance for fuse.

By storing the payload start offset in the `DirectoryEntry` and passing this
information to `Decoder::read()`, the payload can be read directly and a repeated
re-reading of the entry information is avoided.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

src/bin/proxmox-backup-client.rs: do not use api macro for prune

So that we can use add_common_prune_prameters!() macro again.

src/config/remote.rs: do not serialize empty option

src/section_config.rs - write: improve error message

depend on proxmox 0.1.13, use new tty helpers from there

docs: fix typos

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

docs: Add documentation for mounting pxar archives via FUSE.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

proxmox-backup-client: add missing prune options to api definition.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

update proxmox dependency to 0.1.12

src/bin/proxmox-backup-manager.rs: remove stale debug comment

src/bin/proxmox-backup-manager.rs - list remotes: do not use client, call directly

src/bin/proxmox-backup-manager.rs: use new texdt table formatter

src/api2/node/tasks.rs; make list_tasks public

fixup

src/section_config.rs - convert_to_array: add option to skip properties

docs: Extend documentation on interactive restore with catalog shell.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

docs: s/RUST/Rust/

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>

pxar::fuse: Do not return fcaps value on listxattr.

listxattr must only return the name list, no extended attribute values.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar::fuse: return ACL names in listxattr if present

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar::fuse: add support to read ACLs.

ACLs are stored separately in the pxar archive. This implements the functionality
needed to read the ACLs and return them as extended attributes in the getxattr
callback.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

tools::acl: Add helpers to create extended attribute buffer.

This helpers are used to construct the extended attributes values from
the ACLs stored in the pxar archive.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar: move acl helper functions to src/tools/acl.rs

They are not only needed by the pxar::sequential_decoder but also for the fuse
xattr impl, so it makes more sense to have them there.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

tools: LruCache: add dropcheck marker

See https://doc.rust-lang.org/nomicon/phantom-data.html

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

src/api2/types.rs: define and use struct TaskListItem

src/api2/node/tasks.rs: use api macro for list_tasks

pxar::fuse: Introduce LRU caching for goodbye table and directory entries.

The goodbye table of directory entries is cached in a LRU cache to speed up
subsequent accesses.
This is especially important for directories with many entries, as then the
readdirplus callback is called repeatedly because of the limited reply buffer
size.

`DirectoryEntry`s are cached for subsequent access in their own LRU cache,
independent of the goodbye tables.

In order to avoid borrow conflicts, the `Context` provides a fn as_mut_refs
as well as a fn run_with_context_refs.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

pxar::fuse: refactor fn stat

By passing `&DirectoryEntry` to stat, the function interface is simplified.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

use proxmox 0.1.9 with new cli command helpers

src/client/http_client.rs: new password_env option

src/client/http_client.rs: new prefix options

src/client/http_client.rs: implement fingerprint cache

src/client/http_client.rs: new struct HttpClientOptions

src/config/remote.rs: add fingerprint

src/api2/types.rs: add CERT_FINGERPRINT_SHA256_SCHEMA

src/bin/proxmox-backup-client.rs: fix another typo in property description

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

src/bin/proxmox-backup-client.rs: fix typo in property description

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

bump proxmox crate version requirement

it contained an important api macro bugfix

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

tools: add access method to LruCache

This will return a mutable reference just like get_mut, but on a cache miss
it will get and insert the missing value via the fetch method provided via the
Cacher trait.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>

src/api2/admin/datastore.rs - download_file: use BACKUP_ARCHIVE_NAME_SCHEMA for file-name

src/api2/types.rs: define and use api type GarbageCollectionStatus

src/api2/admin/datastore.rs: use api macro for start_garbage_collection

src/api2/types.rs: define and use struct StorageStatus

src/api2/types.rs: define struct BackupContent, and use it with list_snapshot_files

src/backup/manifest.rs: check if manifest contains files

src/api2/admin/datastore.rs: use api macro for delete_snapshot

src/backup/datastore.rs: remove_backup_(group/dir) - return Error instead of io::Error

src/api2/pull.rs: delete fanished snapshots

src/backup/datastore.rs: improve error messages

src/api2/pull.rs: use new Datastore::last_successful_backup helper

Do not fail if local group does not exists.

src/backup/datastore.rs: new helpers

last_successful_backup: Returns the time of the last successful backup
group_path: Returns the absolute path for a backup_group
snapshot_path: Returns the absolute path for a backup_dir

followup: commit all changes

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

api/datastore: do not allow updating path for now

It's a bit dangerous as it points to all the saved backups, so they
would be seemingly lost after updating the path.
Follow our logic from other products, e.g. in PVE we do not allow to
update the backing path/location of a storage either for similar
reasons.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

tools: LRU cache to use for pxar FUSE implementation.

Implements a cache with least recently used cache replacement policy.
Internally the state is tracked by a HashMap (for fast access) and a doubly
linked list (for the access order).

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>