docs/administration-guide.rst: minor cleanups

docs/Makefile: remove paper settings (we set that in conf.py)

docs/administration-guide.rst: explain restore

docs/administration-guide.rst: add encryption section

test another api macro use

The api macro now supports hyphens in parameter names and
referencing externally defined `Schema`s, so here's an
example.

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

pxar: decoder: fix incorrect read for hardlinks.

Decoders read must check if the file is a hardlink and read data from the
corresponding offset if so.

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

pxar: decoder: return original name in attributes()

The returned filename should be the one of the file given at the offset, not of
the one the hardlink points to.

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

docs/administration-guide.rst: improve section "Creating Backups"

correctly install bash completion helpers

docs/administration-guide.rst: improve section "Backup Content"

docs/installation.rst: replace FIXME with todo items

docs/introduction.rst: improve "Why Backup" section.

use cli from proxmox::api

src/cli/completion.rs - get_help_completion: fix for "help -" expansion

src/bin/completion.rs: add echo command

src/bin/completion.rs: use api macros

src/cli/command.rs: use insert_help()

src/cli/command.rs: cleanup, remove unused top_def parameter

src/cli/completion.rs - get_simple_completion: remove all_arg_param parameters

Seems useless.

src/cli: improve docs

src/cli/command.rs: make set_help_context private - no need to expose

src/cli/command.rs: improve help command description

src/cli/completion.rs: moved all completion related code here

src/cli/readline.rs: moved readline related code here

src/cli/shellword.rs: moved shellword related code into this file

src/cli/command.rs - get_nested_completion: allow fuzzy match

src/cli/command.rs - get_nested_completion: return nothing if first argument does not match

src/cli/command.rs: improve get_help_completion

tests/verify-api.rs: remove unused use clause

src/cli/command.rs: handle multilevel sub commands in help

src/cli/command.rs: fix help completions

src/bin/completion.rs: add history support

src/cli/command.rs - handle_command: return Result instead of exit()

src/cli.rs: add insert_help() method

src/cli/command.rs: implement help

cli/completion: use match statements and .contains()

`match` is a bit more readable than the if-else chains,
also replace
    space_chars.iter().any(|s| c == *s)
with
    space_chars.contains(&c)
which is also more readable.

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

remove shellwords crate

use rustyline to replace readline

whitespace fixup

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

update api macro example usage

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

src/cli/command.rs: cleanup, make handlers more generic

update api macro invocation to new style

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

catalog_shell: fix several clippy warnings

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

first api macro usage test/example

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

catalog_shell: major refactoring of cli command definition and parsing

By changing the way shell commands are defined and parsed, this makes it more
straight forward to extend the current functionality.
The readline input is parsed based on the provided command definition and the
given parameters and options are passed to a command specific callback function.
In addition, the provided command definition including its description is used
to generate a help string to display.
The help command shows a list of all supported commands or the help string for
the provided command.

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

catalog_shell: check and return on empty list in order to avoid division by zero

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

catalog_shell: do not restore full archive if no entries are selected for restore-selected

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

src/cli/format.rs: move doc generation code into extra file

src/pxar/fuse.rs: add impl Context

src/pxar/fuse.rs: move init and destroy into Session

src/pxar/fuse.rs: cleanup - remove setup_session (moved into new)

src/pxar/fuse.rs: rename from_decoder into new, new into from_path

src/pxar/decoder.rs: use trait object as reader

So that the Decoder is no longer genertic.

src/pxar/sequential_decoder.rs: remove callback from new()

And use an extra functzion  set_callback() to configure that.

Also rewrite pxar/fuse.rs and implement a generic Session (will get
further cleanups with next patches).

src/cli/command.rs: use static array for arg_param

rename ApiHandler::Async into ApiHandler::AsyncHttp

src/server/rest.rs: simplify code

src/server/rest.rs: rename get_request_parameters_async to get_request_parameters

src/server/rest.rs - only pass ObjectSchema to get_request_parameters_async()

src/server/rest.rs: cleanup async code

remove api_schema submodule

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

move src/api_schema/config.rs -> src/server/config.rs

src/api_schema/registry.rs: remove dead code

add build depend for libreadline-dev

src/bin/proxmox-backup-client.rs: impl shell subcommand for client

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

src/backup/catalog_shell.rs: impl shell to inspect and restore a snapshot via the catalog

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

src/backup/readline.rs: impl wrapper for GNU readline

In order to provide the context needed for tab completion via the readline
callback, the needed mut ref is passed via a thread local storage key.

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

src/backup/catalog.rs: derive Clone for DirEntry and DirEntryAttribute

This is needed in order to explicitly clone the values when needed in the
catalog shell implementation.

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

src/backup/catalog.rs: impl DirEntry::is_directory()

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

src/pxar/sequential_decoder.rs: create all directories in target path

Create the full target path and not fail if an intermediate directory does not
exist.
This is needed in order to restore multiple archives via the catalog, where the
target should further contain each archive name as subdir.

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

src/pxar/decoder.rs: return also payload size in lookup

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

docs: add backup reader protocol

tests/verify-api.rs: test lookup table sort order

api/compat: remove remaining api_schema references

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

api/compat: drop more compat imports from api_schema.rs

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

api/compat: drop api_handler submodule

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

api/comapt: drop schema submodule

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

api: BoxFut -> ApiFuture

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

move api schema into proxmox::api crate

And leave some compat imports in api_schema.rs to get it to
build with minimal changes.

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

sort all property lookup tables

Required, because we use binary sreach to find items.

use const api definitions

add pxar.1 manual page

docs/administration-guide.rs: add 'Backup Content' section.

docs/administration-guide.rst: add section termonology

docs/administration-guide.rs: move sysadmin.rst to the end

docs/introduction.rst: improve section Architecture

docs/introduction.rst: add todo items

docs: improve introduction.rst

docs: enable sphinx todo items

docs: add sysadmin.rst, cleanups

docs: rename deployment-guide.rst -> administration-guide.rst

and join with admin-guide.rst

docs/conf.py: add exclude_pattern package-repositories.rst

The file is inlcuded with 'include' directive. Exclude it to avoid
avoid warning about duplicate label definition.

drop unused mio crate

we still depend on it through other crates, but we don't use
it directly

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

drop md5 crate dependency

we already depend on openssl which also provides md5

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

drop uuid crate dependency

proxmox::tools now has a Uuid module using the native
libuuid.

Adds build dependency: libuuid1 (which is a Pre-Depends of
util-linux, so always installed anyway).

Drops uuid + 16 more crate dependencies.

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

docs: add more ...

catalog: fix issue with DirEntry start

start has to be the parent start - offset

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

src/backup/catalog.rs: add some docs

src/backup/catalog.rs - CatalogReader: verify magic number

src/backup/catalog.rs -  CatalogReader::dump(): use root()