mirror of https://github.com/borgbackup/borg.git
move extract command to archiver.extract
This commit is contained in:
Thomas Waldmann
parent
e05f7971da
commit
ae6ef77495
|
|
@ -24,8 +24,8 @@ try:
|
|||
|
||||
logger = create_logger()
|
||||
|
||||
from .common import with_repository, with_archive, Highlander
|
||||
from .common import build_filter, build_matcher
|
||||
from .common import with_repository, Highlander
|
||||
from .common import build_matcher
|
||||
from .. import __version__
|
||||
from .. import helpers
|
||||
from ..archive import Archive, ArchiveRecreater, is_special
|
||||
|
|
@ -43,13 +43,11 @@ try:
|
|||
from ..helpers import timestamp
|
||||
from ..helpers import get_cache_dir, os_stat
|
||||
from ..helpers import Manifest
|
||||
from ..helpers import HardLinkManager
|
||||
from ..helpers import check_python, check_extension_modules
|
||||
from ..helpers import dir_is_tagged, is_slow_msgpack, is_supported_msgpack, sysinfo
|
||||
from ..helpers import log_multi
|
||||
from ..helpers import signal_handler, raising_signal_handler, SigHup, SigTerm
|
||||
from ..helpers import ErrorIgnoringTextIOWrapper
|
||||
from ..helpers import ProgressIndicatorPercent
|
||||
from ..helpers import basic_json_data, json_print
|
||||
from ..helpers import flags_root, flags_dir, flags_special_follow, flags_special
|
||||
from ..helpers import msgpack
|
||||
|
|
@ -94,6 +92,7 @@ from .config import ConfigMixIn
|
|||
from .debug import DebugMixIn
|
||||
from .delete import DeleteMixIn
|
||||
from .diff import DiffMixIn
|
||||
from .extract import ExtractMixIn
|
||||
from .help import HelpMixIn
|
||||
from .info import InfoMixIn
|
||||
from .keys import KeysMixIn
|
||||
|
|
@ -118,6 +117,7 @@ class Archiver(
|
|||
DebugMixIn,
|
||||
DeleteMixIn,
|
||||
DiffMixIn,
|
||||
ExtractMixIn,
|
||||
TarMixIn,
|
||||
BenchmarkMixIn,
|
||||
KeysMixIn,
|
||||
|
|
@ -595,94 +595,6 @@ class Archiver(
|
|||
if not recurse_excluded_dir:
|
||||
self.print_file_status(status, path)
|
||||
|
||||
@with_repository(compatibility=(Manifest.Operation.READ,))
|
||||
@with_archive
|
||||
def do_extract(self, args, repository, manifest, key, archive):
|
||||
"""Extract archive contents"""
|
||||
# be restrictive when restoring files, restore permissions later
|
||||
if sys.getfilesystemencoding() == "ascii":
|
||||
logger.warning(
|
||||
'Warning: File system encoding is "ascii", extracting non-ascii filenames will not be supported.'
|
||||
)
|
||||
if sys.platform.startswith(("linux", "freebsd", "netbsd", "openbsd", "darwin")):
|
||||
logger.warning(
|
||||
"Hint: You likely need to fix your locale setup. E.g. install locales and use: LANG=en_US.UTF-8"
|
||||
)
|
||||
|
||||
matcher = build_matcher(args.patterns, args.paths)
|
||||
|
||||
progress = args.progress
|
||||
output_list = args.output_list
|
||||
dry_run = args.dry_run
|
||||
stdout = args.stdout
|
||||
sparse = args.sparse
|
||||
strip_components = args.strip_components
|
||||
dirs = []
|
||||
hlm = HardLinkManager(id_type=bytes, info_type=str) # hlid -> path
|
||||
|
||||
filter = build_filter(matcher, strip_components)
|
||||
if progress:
|
||||
pi = ProgressIndicatorPercent(msg="%5.1f%% Extracting: %s", step=0.1, msgid="extract")
|
||||
pi.output("Calculating total archive size for the progress indicator (might take long for large archives)")
|
||||
extracted_size = sum(item.get_size() for item in archive.iter_items(filter))
|
||||
pi.total = extracted_size
|
||||
else:
|
||||
pi = None
|
||||
|
||||
for item in archive.iter_items(filter, preload=True):
|
||||
orig_path = item.path
|
||||
if strip_components:
|
||||
item.path = os.sep.join(orig_path.split(os.sep)[strip_components:])
|
||||
if not args.dry_run:
|
||||
while dirs and not item.path.startswith(dirs[-1].path):
|
||||
dir_item = dirs.pop(-1)
|
||||
try:
|
||||
archive.extract_item(dir_item, stdout=stdout)
|
||||
except BackupOSError as e:
|
||||
self.print_warning("%s: %s", remove_surrogates(dir_item.path), e)
|
||||
if output_list:
|
||||
logging.getLogger("borg.output.list").info(remove_surrogates(item.path))
|
||||
try:
|
||||
if dry_run:
|
||||
archive.extract_item(item, dry_run=True, hlm=hlm, pi=pi)
|
||||
else:
|
||||
if stat.S_ISDIR(item.mode):
|
||||
dirs.append(item)
|
||||
archive.extract_item(item, stdout=stdout, restore_attrs=False)
|
||||
else:
|
||||
archive.extract_item(
|
||||
item,
|
||||
stdout=stdout,
|
||||
sparse=sparse,
|
||||
hlm=hlm,
|
||||
stripped_components=strip_components,
|
||||
original_path=orig_path,
|
||||
pi=pi,
|
||||
)
|
||||
except (BackupOSError, BackupError) as e:
|
||||
self.print_warning("%s: %s", remove_surrogates(orig_path), e)
|
||||
|
||||
if pi:
|
||||
pi.finish()
|
||||
|
||||
if not args.dry_run:
|
||||
pi = ProgressIndicatorPercent(
|
||||
total=len(dirs), msg="Setting directory permissions %3.0f%%", msgid="extract.permissions"
|
||||
)
|
||||
while dirs:
|
||||
pi.show()
|
||||
dir_item = dirs.pop(-1)
|
||||
try:
|
||||
archive.extract_item(dir_item, stdout=stdout)
|
||||
except BackupOSError as e:
|
||||
self.print_warning("%s: %s", remove_surrogates(dir_item.path), e)
|
||||
for pattern in matcher.get_unmatched_include_patterns():
|
||||
self.print_warning("Include pattern '%s' never matched.", pattern)
|
||||
if pi:
|
||||
# clear progress output
|
||||
pi.finish()
|
||||
return self.exit_code
|
||||
|
||||
@with_repository(cache=True, exclusive=True, compatibility=(Manifest.Operation.CHECK,))
|
||||
def do_recreate(self, args, repository, manifest, key, cache):
|
||||
"""Re-create archives"""
|
||||
|
|
@ -1431,80 +1343,11 @@ class Archiver(
|
|||
self.build_parser_config(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_debug(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_delete(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_extract(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_help(subparsers, common_parser, mid_common_parser, parser)
|
||||
self.build_parser_rdelete(subparsers, common_parser, mid_common_parser, parser)
|
||||
self.build_parser_rinfo(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_rlist(subparsers, common_parser, mid_common_parser)
|
||||
|
||||
# borg extract
|
||||
extract_epilog = process_epilog(
|
||||
"""
|
||||
This command extracts the contents of an archive. By default the entire
|
||||
archive is extracted but a subset of files and directories can be selected
|
||||
by passing a list of ``PATHs`` as arguments. The file selection can further
|
||||
be restricted by using the ``--exclude`` option.
|
||||
|
||||
For more help on include/exclude patterns, see the :ref:`borg_patterns` command output.
|
||||
|
||||
By using ``--dry-run``, you can do all extraction steps except actually writing the
|
||||
output data: reading metadata and data chunks from the repo, checking the hash/hmac,
|
||||
decrypting, decompressing.
|
||||
|
||||
``--progress`` can be slower than no progress display, since it makes one additional
|
||||
pass over the archive metadata.
|
||||
|
||||
.. note::
|
||||
|
||||
Currently, extract always writes into the current working directory ("."),
|
||||
so make sure you ``cd`` to the right place before calling ``borg extract``.
|
||||
|
||||
When parent directories are not extracted (because of using file/directory selection
|
||||
or any other reason), borg can not restore parent directories' metadata, e.g. owner,
|
||||
group, permission, etc.
|
||||
"""
|
||||
)
|
||||
subparser = subparsers.add_parser(
|
||||
"extract",
|
||||
parents=[common_parser],
|
||||
add_help=False,
|
||||
description=self.do_extract.__doc__,
|
||||
epilog=extract_epilog,
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
help="extract archive contents",
|
||||
)
|
||||
subparser.set_defaults(func=self.do_extract)
|
||||
subparser.add_argument(
|
||||
"--list", dest="output_list", action="store_true", help="output verbose list of items (files, dirs, ...)"
|
||||
)
|
||||
subparser.add_argument(
|
||||
"-n", "--dry-run", dest="dry_run", action="store_true", help="do not actually change any files"
|
||||
)
|
||||
subparser.add_argument(
|
||||
"--numeric-ids",
|
||||
dest="numeric_ids",
|
||||
action="store_true",
|
||||
help="only obey numeric user and group identifiers",
|
||||
)
|
||||
subparser.add_argument(
|
||||
"--noflags", dest="noflags", action="store_true", help="do not extract/set flags (e.g. NODUMP, IMMUTABLE)"
|
||||
)
|
||||
subparser.add_argument("--noacls", dest="noacls", action="store_true", help="do not extract/set ACLs")
|
||||
subparser.add_argument("--noxattrs", dest="noxattrs", action="store_true", help="do not extract/set xattrs")
|
||||
subparser.add_argument(
|
||||
"--stdout", dest="stdout", action="store_true", help="write all extracted data to stdout"
|
||||
)
|
||||
subparser.add_argument(
|
||||
"--sparse",
|
||||
dest="sparse",
|
||||
action="store_true",
|
||||
help="create holes in output sparse file from all-zero chunks",
|
||||
)
|
||||
subparser.add_argument("name", metavar="NAME", type=NameSpec, help="specify the archive name")
|
||||
subparser.add_argument(
|
||||
"paths", metavar="PATH", nargs="*", type=str, help="paths to extract; patterns are supported"
|
||||
)
|
||||
define_exclusion_group(subparser, strip_components=True)
|
||||
|
||||
self.build_parser_info(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_keys(subparsers, common_parser, mid_common_parser)
|
||||
self.build_parser_rcreate(subparsers, common_parser, mid_common_parser)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,182 @@
|
|||
import sys
|
||||
import argparse
|
||||
import logging
|
||||
import os
|
||||
import stat
|
||||
|
||||
from .common import with_repository, with_archive
|
||||
from .common import build_filter, build_matcher
|
||||
from ..archive import BackupError, BackupOSError
|
||||
from ..constants import * # NOQA
|
||||
from ..helpers import NameSpec
|
||||
from ..helpers import remove_surrogates
|
||||
from ..helpers import Manifest
|
||||
from ..helpers import HardLinkManager
|
||||
from ..helpers import ProgressIndicatorPercent
|
||||
|
||||
from ..logger import create_logger
|
||||
|
||||
logger = create_logger()
|
||||
|
||||
|
||||
class ExtractMixIn:
|
||||
@with_repository(compatibility=(Manifest.Operation.READ,))
|
||||
@with_archive
|
||||
def do_extract(self, args, repository, manifest, key, archive):
|
||||
"""Extract archive contents"""
|
||||
# be restrictive when restoring files, restore permissions later
|
||||
if sys.getfilesystemencoding() == "ascii":
|
||||
logger.warning(
|
||||
'Warning: File system encoding is "ascii", extracting non-ascii filenames will not be supported.'
|
||||
)
|
||||
if sys.platform.startswith(("linux", "freebsd", "netbsd", "openbsd", "darwin")):
|
||||
logger.warning(
|
||||
"Hint: You likely need to fix your locale setup. E.g. install locales and use: LANG=en_US.UTF-8"
|
||||
)
|
||||
|
||||
matcher = build_matcher(args.patterns, args.paths)
|
||||
|
||||
progress = args.progress
|
||||
output_list = args.output_list
|
||||
dry_run = args.dry_run
|
||||
stdout = args.stdout
|
||||
sparse = args.sparse
|
||||
strip_components = args.strip_components
|
||||
dirs = []
|
||||
hlm = HardLinkManager(id_type=bytes, info_type=str) # hlid -> path
|
||||
|
||||
filter = build_filter(matcher, strip_components)
|
||||
if progress:
|
||||
pi = ProgressIndicatorPercent(msg="%5.1f%% Extracting: %s", step=0.1, msgid="extract")
|
||||
pi.output("Calculating total archive size for the progress indicator (might take long for large archives)")
|
||||
extracted_size = sum(item.get_size() for item in archive.iter_items(filter))
|
||||
pi.total = extracted_size
|
||||
else:
|
||||
pi = None
|
||||
|
||||
for item in archive.iter_items(filter, preload=True):
|
||||
orig_path = item.path
|
||||
if strip_components:
|
||||
item.path = os.sep.join(orig_path.split(os.sep)[strip_components:])
|
||||
if not args.dry_run:
|
||||
while dirs and not item.path.startswith(dirs[-1].path):
|
||||
dir_item = dirs.pop(-1)
|
||||
try:
|
||||
archive.extract_item(dir_item, stdout=stdout)
|
||||
except BackupOSError as e:
|
||||
self.print_warning("%s: %s", remove_surrogates(dir_item.path), e)
|
||||
if output_list:
|
||||
logging.getLogger("borg.output.list").info(remove_surrogates(item.path))
|
||||
try:
|
||||
if dry_run:
|
||||
archive.extract_item(item, dry_run=True, hlm=hlm, pi=pi)
|
||||
else:
|
||||
if stat.S_ISDIR(item.mode):
|
||||
dirs.append(item)
|
||||
archive.extract_item(item, stdout=stdout, restore_attrs=False)
|
||||
else:
|
||||
archive.extract_item(
|
||||
item,
|
||||
stdout=stdout,
|
||||
sparse=sparse,
|
||||
hlm=hlm,
|
||||
stripped_components=strip_components,
|
||||
original_path=orig_path,
|
||||
pi=pi,
|
||||
)
|
||||
except (BackupOSError, BackupError) as e:
|
||||
self.print_warning("%s: %s", remove_surrogates(orig_path), e)
|
||||
|
||||
if pi:
|
||||
pi.finish()
|
||||
|
||||
if not args.dry_run:
|
||||
pi = ProgressIndicatorPercent(
|
||||
total=len(dirs), msg="Setting directory permissions %3.0f%%", msgid="extract.permissions"
|
||||
)
|
||||
while dirs:
|
||||
pi.show()
|
||||
dir_item = dirs.pop(-1)
|
||||
try:
|
||||
archive.extract_item(dir_item, stdout=stdout)
|
||||
except BackupOSError as e:
|
||||
self.print_warning("%s: %s", remove_surrogates(dir_item.path), e)
|
||||
for pattern in matcher.get_unmatched_include_patterns():
|
||||
self.print_warning("Include pattern '%s' never matched.", pattern)
|
||||
if pi:
|
||||
# clear progress output
|
||||
pi.finish()
|
||||
return self.exit_code
|
||||
|
||||
def build_parser_extract(self, subparsers, common_parser, mid_common_parser):
|
||||
|
||||
from .common import process_epilog
|
||||
from .common import define_exclusion_group
|
||||
|
||||
extract_epilog = process_epilog(
|
||||
"""
|
||||
This command extracts the contents of an archive. By default the entire
|
||||
archive is extracted but a subset of files and directories can be selected
|
||||
by passing a list of ``PATHs`` as arguments. The file selection can further
|
||||
be restricted by using the ``--exclude`` option.
|
||||
|
||||
For more help on include/exclude patterns, see the :ref:`borg_patterns` command output.
|
||||
|
||||
By using ``--dry-run``, you can do all extraction steps except actually writing the
|
||||
output data: reading metadata and data chunks from the repo, checking the hash/hmac,
|
||||
decrypting, decompressing.
|
||||
|
||||
``--progress`` can be slower than no progress display, since it makes one additional
|
||||
pass over the archive metadata.
|
||||
|
||||
.. note::
|
||||
|
||||
Currently, extract always writes into the current working directory ("."),
|
||||
so make sure you ``cd`` to the right place before calling ``borg extract``.
|
||||
|
||||
When parent directories are not extracted (because of using file/directory selection
|
||||
or any other reason), borg can not restore parent directories' metadata, e.g. owner,
|
||||
group, permission, etc.
|
||||
"""
|
||||
)
|
||||
subparser = subparsers.add_parser(
|
||||
"extract",
|
||||
parents=[common_parser],
|
||||
add_help=False,
|
||||
description=self.do_extract.__doc__,
|
||||
epilog=extract_epilog,
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter,
|
||||
help="extract archive contents",
|
||||
)
|
||||
subparser.set_defaults(func=self.do_extract)
|
||||
subparser.add_argument(
|
||||
"--list", dest="output_list", action="store_true", help="output verbose list of items (files, dirs, ...)"
|
||||
)
|
||||
subparser.add_argument(
|
||||
"-n", "--dry-run", dest="dry_run", action="store_true", help="do not actually change any files"
|
||||
)
|
||||
subparser.add_argument(
|
||||
"--numeric-ids",
|
||||
dest="numeric_ids",
|
||||
action="store_true",
|
||||
help="only obey numeric user and group identifiers",
|
||||
)
|
||||
subparser.add_argument(
|
||||
"--noflags", dest="noflags", action="store_true", help="do not extract/set flags (e.g. NODUMP, IMMUTABLE)"
|
||||
)
|
||||
subparser.add_argument("--noacls", dest="noacls", action="store_true", help="do not extract/set ACLs")
|
||||
subparser.add_argument("--noxattrs", dest="noxattrs", action="store_true", help="do not extract/set xattrs")
|
||||
subparser.add_argument(
|
||||
"--stdout", dest="stdout", action="store_true", help="write all extracted data to stdout"
|
||||
)
|
||||
subparser.add_argument(
|
||||
"--sparse",
|
||||
dest="sparse",
|
||||
action="store_true",
|
||||
help="create holes in output sparse file from all-zero chunks",
|
||||
)
|
||||
subparser.add_argument("name", metavar="NAME", type=NameSpec, help="specify the archive name")
|
||||
subparser.add_argument(
|
||||
"paths", metavar="PATH", nargs="*", type=str, help="paths to extract; patterns are supported"
|
||||
)
|
||||
define_exclusion_group(subparser, strip_components=True)
|
||||
Loading…
Reference in New Issue