26#ifndef ARCHIVE_OPTIONS_HPP
27#define ARCHIVE_OPTIONS_HPP
75 ~archive_options_read() =
default;
112 void set_input_pipe(
const std::string & input_pipe) { x_input_pipe = input_pipe; };
118 void set_output_pipe(
const std::string & output_pipe) { x_output_pipe = output_pipe; };
131 void set_execute(
const std::string & execute) { x_execute = execute; };
155 void set_entrepot(
const std::shared_ptr<entrepot> & entr) {
if(!entr)
throw Erange(
"archive_options_read::set_entrepot",
"null entrepot pointer given in argument"); x_entrepot = entr; };
176 void set_external_catalogue(
const path & ref_chem,
const std::string & ref_basename) { x_ref_chem = ref_chem, x_ref_basename = ref_basename; external_cat =
true; };
200 void set_ref_execute(
const std::string & ref_execute) { x_ref_execute = ref_execute; };
208 void set_ref_entrepot(
const std::shared_ptr<entrepot> & entr) {
if(!entr)
throw Erange(
"archive_options_read::set_ref_entrepot",
"null entrepot pointer given in argument"); x_ref_entrepot = entr; };
219 crypto_algo get_crypto_algo()
const {
return x_crypto; };
220 const secu_string & get_crypto_pass()
const {
return x_pass; };
221 U_32 get_crypto_size()
const {
return x_crypto_size; };
222 const std::string & get_input_pipe()
const {
return x_input_pipe; };
223 const std::string & get_output_pipe()
const {
return x_output_pipe; };
224 const std::string & get_execute()
const {
return x_execute; };
225 bool get_info_details()
const {
return x_info_details; };
226 bool get_lax()
const {
return x_lax; };
227 bool get_sequential_read()
const {
return x_sequential_read; };
228 infinint get_slice_min_digits()
const {
return x_slice_min_digits; };
229 const std::shared_ptr<entrepot> & get_entrepot()
const {
return x_entrepot; };
230 bool get_ignore_signature_check_failure()
const {
return x_ignore_signature_check_failure; };
231 U_I get_multi_threaded_crypto()
const {
return x_multi_threaded_crypto; };
232 U_I get_multi_threaded_compress()
const {
return x_multi_threaded_compress; };
235 bool is_external_catalogue_set()
const {
return external_cat; };
236 const path & get_ref_path()
const;
237 const std::string & get_ref_basename()
const;
238 crypto_algo get_ref_crypto_algo()
const {
return x_ref_crypto; };
239 const secu_string & get_ref_crypto_pass()
const {
return x_ref_pass; };
240 U_32 get_ref_crypto_size()
const {
return x_ref_crypto_size; };
241 const std::string & get_ref_execute()
const {
return x_ref_execute; };
242 infinint get_ref_slice_min_digits()
const {
return x_ref_slice_min_digits; };
243 const std::shared_ptr<entrepot> & get_ref_entrepot()
const {
return x_ref_entrepot; };
244 bool get_header_only()
const {
return x_header_only; };
248 crypto_algo x_crypto;
251 std::string x_input_pipe;
252 std::string x_output_pipe;
253 std::string x_execute;
256 bool x_sequential_read;
257 infinint x_slice_min_digits;
258 std::shared_ptr<entrepot> x_entrepot;
259 bool x_ignore_signature_check_failure;
260 U_I x_multi_threaded_crypto;
261 U_I x_multi_threaded_compress;
267 std::string x_ref_basename;
268 crypto_algo x_ref_crypto;
269 secu_string x_ref_pass;
270 U_32 x_ref_crypto_size;
271 std::string x_ref_execute;
272 infinint x_ref_slice_min_digits;
273 std::shared_ptr<entrepot> x_ref_entrepot;
337 void set_display_treated(
bool display_treated,
bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
376 x_file_size = file_size;
377 if(first_file_size.is_zero())
378 x_first_file_size = file_size;
380 x_first_file_size = first_file_size;
398 void set_execute(
const std::string & execute) { x_execute = execute; };
419 void set_gnupg_recipients(
const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
425 void set_gnupg_signatories(
const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
439 { exclude_by_ea = (ea_name ==
"" ?
"user.libdar_no_backup" : ea_name); };
459 x_alter_atime = alter_atime;
469 void set_same_fs(
bool same_fs) { x_same_fs = same_fs; x_same_fs_include.clear(); x_same_fs_exclude.clear(); };
474 void set_same_fs_include(
const std::string & included_path_to_fs) { x_same_fs_include.push_back(included_path_to_fs); };
479 void set_same_fs_exclude(
const std::string & excluded_path_to_fs) { x_same_fs_exclude.push_back(excluded_path_to_fs); };
500 void set_retry_on_change(
const infinint & count_max_per_file,
const infinint & global_max_byte_overhead = 0) { x_repeat_count = count_max_per_file; x_repeat_byte = global_max_byte_overhead; };
530 void set_entrepot(
const std::shared_ptr<entrepot> & entr) {
if(!entr)
throw Erange(
"archive_options_create::set_entrepot",
"null entrepot pointer given in argument"); x_entrepot = entr; };
589 std::shared_ptr<archive> get_reference()
const {
return x_ref_arch; };
591 const mask & get_subtree()
const {
if(
x_subtree ==
nullptr)
throw SRC_BUG;
return *
x_subtree; };
592 bool get_allow_over()
const {
return x_allow_over; };
593 bool get_warn_over()
const {
return x_warn_over; };
594 bool get_info_details()
const {
return x_info_details; };
595 bool get_display_treated()
const {
return x_display_treated; };
596 bool get_display_treated_only_dir()
const {
return x_display_treated_only_dir; };
597 bool get_display_skipped()
const {
return x_display_skipped; };
598 bool get_display_finished()
const {
return x_display_finished; };
599 const infinint & get_pause()
const {
return x_pause; };
600 bool get_empty_dir()
const {
return x_empty_dir; };
601 compression get_compression()
const {
return x_compr_algo; };
602 U_I get_compression_level()
const {
return x_compression_level; };
603 U_I get_compression_block_size()
const {
return x_compression_block_size; };
604 const infinint & get_slice_size()
const {
return x_file_size; };
605 const infinint & get_first_slice_size()
const {
return x_first_file_size; };
606 const mask & get_ea_mask()
const {
if(
x_ea_mask ==
nullptr)
throw SRC_BUG;
return *
x_ea_mask; };
607 const std::string & get_execute()
const {
return x_execute; };
608 crypto_algo get_crypto_algo()
const {
return x_crypto; };
609 const secu_string & get_crypto_pass()
const {
return x_pass; };
610 U_32 get_crypto_size()
const {
return x_crypto_size; };
611 const std::vector<std::string> & get_gnupg_recipients()
const {
return x_gnupg_recipients; };
612 const std::vector<std::string> & get_gnupg_signatories()
const {
return x_gnupg_signatories; };
614 const infinint & get_min_compr_size()
const {
return x_min_compr_size; };
615 bool get_nodump()
const {
return x_nodump; };
616 const std::string & get_exclude_by_ea()
const {
return exclude_by_ea; };
617 comparison_fields get_comparison_fields()
const {
return x_what_to_check; };
618 const infinint & get_hourshift()
const {
return x_hourshift; };
619 bool get_empty()
const {
return x_empty; };
620 bool get_alter_atime()
const {
return x_alter_atime; };
621 bool get_furtive_read_mode()
const {
return x_furtive_read; };
622 bool get_same_fs()
const {
return x_same_fs; };
623 std::deque<std::string> get_same_fs_include()
const {
return x_same_fs_include; };
624 std::deque<std::string> get_same_fs_exclude()
const {
return x_same_fs_exclude; };
625 bool get_snapshot()
const {
return x_snapshot; };
626 bool get_cache_directory_tagging()
const {
return x_cache_directory_tagging; };
627 const infinint & get_fixed_date()
const {
return x_fixed_date; };
628 const std::string & get_slice_permission()
const {
return x_slice_permission; };
629 const std::string & get_slice_user_ownership()
const {
return x_slice_user_ownership; };
630 const std::string & get_slice_group_ownership()
const {
return x_slice_group_ownership; };
631 const infinint & get_repeat_count()
const {
return x_repeat_count; };
632 const infinint & get_repeat_byte()
const {
return x_repeat_byte; };
633 bool get_sequential_marks()
const {
return x_sequential_marks; };
634 infinint get_sparse_file_min_size()
const {
return x_sparse_file_min_size; };
635 bool get_security_check()
const {
return x_security_check; };
636 const std::string & get_user_comment()
const {
return x_user_comment; };
637 hash_algo get_hash_algo()
const {
return x_hash; };
638 infinint get_slice_min_digits()
const {
return x_slice_min_digits; };
639 const std::string & get_backup_hook_file_execute()
const {
return x_backup_hook_file_execute; };
640 const mask & get_backup_hook_file_mask()
const {
return *x_backup_hook_file_mask; };
641 bool get_ignore_unknown_inode_type()
const {
return x_ignore_unknown; };
642 const std::shared_ptr<entrepot> & get_entrepot()
const {
return x_entrepot; };
643 const fsa_scope & get_fsa_scope()
const {
return x_scope; };
644 U_I get_multi_threaded_crypto()
const {
return x_multi_threaded_crypto; };
645 U_I get_multi_threaded_compress()
const {
return x_multi_threaded_compress; };
646 bool get_delta_diff()
const {
return x_delta_diff; };
647 bool get_delta_signature()
const {
return x_delta_signature; };
648 const mask & get_delta_mask()
const {
return *x_delta_mask; }
649 bool get_has_delta_mask_been_set()
const {
return has_delta_mask_been_set; };
650 const infinint & get_delta_sig_min_size()
const {
return x_delta_sig_min_size; };
651 bool get_auto_zeroing_neg_dates()
const {
return x_auto_zeroing_neg_dates; };
652 const std::set<std::string> & get_ignored_as_symlink()
const {
return x_ignored_as_symlink; };
653 modified_data_detection get_modified_data_detection()
const {
return x_modified_data_detection; };
654 const infinint & get_iteration_count()
const {
return x_iteration_count; };
655 hash_algo get_kdf_hash()
const {
return x_kdf_hash; };
656 delta_sig_block_size get_sig_block_len()
const {
return x_sig_block_len; };
665 bool x_display_treated;
666 bool x_display_treated_only_dir;
667 bool x_display_skipped;
668 bool x_display_finished;
672 U_I x_compression_level;
673 U_I x_compression_block_size;
677 std::string x_execute;
681 std::vector<std::string> x_gnupg_recipients;
682 std::vector<std::string> x_gnupg_signatories;
686 std::string exclude_by_ea;
694 std::deque<std::string> x_same_fs_include;
695 std::deque<std::string> x_same_fs_exclude;
697 bool x_cache_directory_tagging;
699 std::string x_slice_permission;
700 std::string x_slice_user_ownership;
701 std::string x_slice_group_ownership;
704 bool x_sequential_marks;
706 bool x_security_check;
707 std::string x_user_comment;
710 mask * x_backup_hook_file_mask;
711 std::string x_backup_hook_file_execute;
712 bool x_ignore_unknown;
713 std::shared_ptr<entrepot> x_entrepot;
715 U_I x_multi_threaded_crypto;
716 U_I x_multi_threaded_compress;
718 bool x_delta_signature;
720 bool has_delta_mask_been_set;
722 bool x_auto_zeroing_neg_dates;
723 std::set<std::string> x_ignored_as_symlink;
729 void nullifyptr() noexcept;
730 void destroy() noexcept;
733 void destroy_mask(
mask * & ptr);
734 void clean_mask(
mask * & ptr);
735 void check_mask(const
mask & m);
794 x_file_size = file_size;
795 if(first_file_size.is_zero())
796 x_first_file_size = file_size;
798 x_first_file_size = first_file_size;
812 void set_execute(
const std::string & execute) { x_execute = execute; };
827 void set_gnupg_recipients(
const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
832 void set_gnupg_signatories(
const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
859 void set_entrepot(
const std::shared_ptr<entrepot> & entr) {
if(!entr)
throw Erange(
"archive_options_isolated::set_entrepot",
"null entrepot pointer given in argument"); x_entrepot = entr; };
897 bool get_allow_over()
const {
return x_allow_over; };
898 bool get_warn_over()
const {
return x_warn_over; };
899 bool get_info_details()
const {
return x_info_details; };
900 const infinint & get_pause()
const {
return x_pause; };
901 compression get_compression()
const {
return x_algo; };
902 U_I get_compression_level()
const {
return x_compression_level; };
903 U_I get_compression_block_size()
const {
return x_compression_block_size; };
904 const infinint & get_slice_size()
const {
return x_file_size; };
905 const infinint & get_first_slice_size()
const {
return x_first_file_size; };
906 const std::string & get_execute()
const {
return x_execute; };
907 crypto_algo get_crypto_algo()
const {
return x_crypto; };
908 const secu_string & get_crypto_pass()
const {
return x_pass; };
909 U_32 get_crypto_size()
const {
return x_crypto_size; };
910 const std::vector<std::string> & get_gnupg_recipients()
const {
return x_gnupg_recipients; };
911 const std::vector<std::string> & get_gnupg_signatories()
const {
return x_gnupg_signatories; };
912 bool get_empty()
const {
return x_empty; };
913 const std::string & get_slice_permission()
const {
return x_slice_permission; };
914 const std::string & get_slice_user_ownership()
const {
return x_slice_user_ownership; };
915 const std::string & get_slice_group_ownership()
const {
return x_slice_group_ownership; };
916 const std::string & get_user_comment()
const {
return x_user_comment; };
917 hash_algo get_hash_algo()
const {
return x_hash; };
918 infinint get_slice_min_digits()
const {
return x_slice_min_digits; };
919 bool get_sequential_marks()
const {
return x_sequential_marks; };
920 const std::shared_ptr<entrepot> & get_entrepot()
const {
return x_entrepot; };
921 U_I get_multi_threaded_crypto()
const {
return x_multi_threaded_crypto; };
922 U_I get_multi_threaded_compress()
const {
return x_multi_threaded_compress; };
923 bool get_delta_signature()
const {
return x_delta_signature; };
924 const mask & get_delta_mask()
const {
return *x_delta_mask; }
925 bool get_has_delta_mask_been_set()
const {
return has_delta_mask_been_set; };
926 const infinint & get_delta_sig_min_size()
const {
return x_delta_sig_min_size; };
927 const infinint & get_iteration_count()
const {
return x_iteration_count; };
928 hash_algo get_kdf_hash()
const {
return x_kdf_hash; };
929 delta_sig_block_size get_sig_block_len()
const {
return x_sig_block_len; };
938 U_I x_compression_level;
939 U_I x_compression_block_size;
940 infinint x_file_size;
941 infinint x_first_file_size;
942 std::string x_execute;
943 crypto_algo x_crypto;
946 std::vector<std::string> x_gnupg_recipients;
947 std::vector<std::string> x_gnupg_signatories;
949 std::string x_slice_permission;
950 std::string x_slice_user_ownership;
951 std::string x_slice_group_ownership;
952 std::string x_user_comment;
954 infinint x_slice_min_digits;
955 bool x_sequential_marks;
956 std::shared_ptr<entrepot> x_entrepot;
957 U_I x_multi_threaded_crypto;
958 U_I x_multi_threaded_compress;
959 bool x_delta_signature;
961 bool has_delta_mask_been_set;
962 infinint x_delta_sig_min_size;
963 infinint x_iteration_count;
964 hash_algo x_kdf_hash;
965 delta_sig_block_size x_sig_block_len;
967 void copy_from(
const archive_options_isolate & ref);
968 void move_from(archive_options_isolate && ref)
noexcept;
969 void destroy() noexcept;
970 void nullifyptr() noexcept;
996 void set_auxiliary_ref(std::shared_ptr<archive> ref) { x_ref = ref; };
1025 void set_display_treated(
bool display_treated,
bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
1052 x_file_size = file_size;
1053 if(first_file_size.is_zero())
1054 x_first_file_size = file_size;
1056 x_first_file_size = first_file_size;
1073 void set_execute(
const std::string & execute) { x_execute = execute; };
1089 void set_gnupg_recipients(
const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
1094 void set_gnupg_signatories(
const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
1136 void set_entrepot(
const std::shared_ptr<entrepot> & entr) {
if(!entr)
throw Erange(
"archive_options_merge::set_entrepot",
"null entrepot pointer given in argument"); x_entrepot = entr; };
1181 std::shared_ptr<archive> get_auxiliary_ref()
const {
return x_ref; };
1183 const mask & get_subtree()
const {
if(
x_subtree ==
nullptr)
throw SRC_BUG;
return *
x_subtree; };
1184 bool get_allow_over()
const {
return x_allow_over; };
1185 bool get_warn_over()
const {
return x_warn_over; };
1186 const crit_action & get_overwriting_rules()
const {
if(x_overwrite ==
nullptr)
throw SRC_BUG;
return *x_overwrite; };
1187 bool get_info_details()
const {
return x_info_details; };
1188 bool get_display_treated()
const {
return x_display_treated; };
1189 bool get_display_treated_only_dir()
const {
return x_display_treated_only_dir; };
1190 bool get_display_skipped()
const {
return x_display_skipped; };
1191 const infinint & get_pause()
const {
return x_pause; };
1192 bool get_empty_dir()
const {
return x_empty_dir; };
1193 compression get_compression()
const {
return x_compr_algo; };
1194 U_I get_compression_level()
const {
return x_compression_level; };
1195 U_I get_compression_block_size()
const {
return x_compression_block_size; };
1196 const infinint & get_slice_size()
const {
return x_file_size; };
1197 const infinint & get_first_slice_size()
const {
return x_first_file_size; };
1198 const mask & get_ea_mask()
const {
if(
x_ea_mask ==
nullptr)
throw SRC_BUG;
return *
x_ea_mask; };
1199 const std::string & get_execute()
const {
return x_execute; };
1200 crypto_algo get_crypto_algo()
const {
return x_crypto; };
1201 const secu_string & get_crypto_pass()
const {
return x_pass; };
1202 U_32 get_crypto_size()
const {
return x_crypto_size; };
1203 const std::vector<std::string> & get_gnupg_recipients()
const {
return x_gnupg_recipients; };
1204 const std::vector<std::string> & get_gnupg_signatories()
const {
return x_gnupg_signatories; };
1206 const infinint & get_min_compr_size()
const {
return x_min_compr_size; };
1207 bool get_empty()
const {
return x_empty; };
1208 bool get_keep_compressed()
const {
return x_keep_compressed; };
1209 const std::string & get_slice_permission()
const {
return x_slice_permission; };
1210 const std::string & get_slice_user_ownership()
const {
return x_slice_user_ownership; };
1211 const std::string & get_slice_group_ownership()
const {
return x_slice_group_ownership; };
1212 bool get_decremental_mode()
const {
return x_decremental; };
1213 bool get_sequential_marks()
const {
return x_sequential_marks; };
1214 infinint get_sparse_file_min_size()
const {
return x_sparse_file_min_size; };
1215 const std::string & get_user_comment()
const {
return x_user_comment; };
1216 hash_algo get_hash_algo()
const {
return x_hash; };
1217 infinint get_slice_min_digits()
const {
return x_slice_min_digits; };
1218 const std::shared_ptr<entrepot> & get_entrepot()
const {
return x_entrepot; };
1219 const fsa_scope & get_fsa_scope()
const {
return x_scope; };
1220 U_I get_multi_threaded_crypto()
const {
return x_multi_threaded_crypto; };
1221 U_I get_multi_threaded_compress()
const {
return x_multi_threaded_compress; };
1222 bool get_delta_signature()
const {
return x_delta_signature; };
1223 const mask & get_delta_mask()
const {
return *x_delta_mask; }
1224 bool get_has_delta_mask_been_set()
const {
return has_delta_mask_been_set; };
1225 const infinint & get_delta_sig_min_size()
const {
return x_delta_sig_min_size; };
1226 const infinint & get_iteration_count()
const {
return x_iteration_count; };
1227 hash_algo get_kdf_hash()
const {
return x_kdf_hash; };
1228 delta_sig_block_size get_sig_block_len()
const {
return x_sig_block_len; };
1232 std::shared_ptr<archive> x_ref;
1237 crit_action * x_overwrite;
1238 bool x_info_details;
1239 bool x_display_treated;
1240 bool x_display_treated_only_dir;
1241 bool x_display_skipped;
1244 compression x_compr_algo;
1245 U_I x_compression_level;
1246 U_I x_compression_block_size;
1247 infinint x_file_size;
1248 infinint x_first_file_size;
1250 std::string x_execute;
1251 crypto_algo x_crypto;
1254 std::vector<std::string> x_gnupg_recipients;
1255 std::vector<std::string> x_gnupg_signatories;
1257 infinint x_min_compr_size;
1259 bool x_keep_compressed;
1260 std::string x_slice_permission;
1261 std::string x_slice_user_ownership;
1262 std::string x_slice_group_ownership;
1264 bool x_sequential_marks;
1265 infinint x_sparse_file_min_size;
1266 std::string x_user_comment;
1268 infinint x_slice_min_digits;
1269 std::shared_ptr<entrepot> x_entrepot;
1271 U_I x_multi_threaded_crypto;
1272 U_I x_multi_threaded_compress;
1273 bool x_delta_signature;
1275 bool has_delta_mask_been_set;
1276 infinint x_delta_sig_min_size;
1277 infinint x_iteration_count;
1278 hash_algo x_kdf_hash;
1279 delta_sig_block_size x_sig_block_len;
1281 void destroy() noexcept;
1282 void copy_from(const archive_options_merge & ref);
1283 void move_from(archive_options_merge && ref) noexcept;
1284 void nullifyptr() noexcept;
1296 enum t_dirty { dirty_ignore, dirty_warn, dirty_ok };
1330 void set_display_treated(
bool display_treated,
bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
1357 void set_dirty_behavior(
bool ignore,
bool warn) { x_dirty = ignore ? dirty_ignore : (warn ? dirty_warn : dirty_ok); };
1390 const mask & get_subtree()
const {
if(
x_subtree ==
nullptr)
throw SRC_BUG;
return *
x_subtree; };
1391 bool get_warn_over()
const {
return x_warn_over; };
1392 bool get_info_details()
const {
return x_info_details; };
1393 bool get_display_treated()
const {
return x_display_treated; };
1394 bool get_display_treated_only_dir()
const {
return x_display_treated_only_dir; };
1395 bool get_display_skipped()
const {
return x_display_skipped; };
1396 const mask & get_ea_mask()
const {
if(
x_ea_mask ==
nullptr)
throw SRC_BUG;
return *
x_ea_mask; };
1397 bool get_flat()
const {
return x_flat; };
1398 comparison_fields get_what_to_check()
const {
return x_what_to_check; };
1399 bool get_warn_remove_no_match()
const {
return x_warn_remove_no_match; };
1400 bool get_empty()
const {
return x_empty; };
1401 bool get_empty_dir()
const {
return x_empty_dir; };
1402 t_dirty get_dirty_behavior()
const {
return x_dirty; }
1403 const crit_action & get_overwriting_rules()
const {
if(x_overwrite ==
nullptr)
throw SRC_BUG;
return *x_overwrite; };
1404 bool get_only_deleted()
const {
return x_only_deleted; };
1405 bool get_ignore_deleted()
const {
return x_ignore_deleted; };
1406 const fsa_scope & get_fsa_scope()
const {
return x_scope; };
1407 bool get_ignore_unix_sockets()
const {
return x_ignore_unix_sockets; };
1408 bool get_in_place()
const {
return x_in_place; };
1414 bool x_info_details;
1415 bool x_display_treated;
1416 bool x_display_treated_only_dir;
1417 bool x_display_skipped;
1420 comparison_fields x_what_to_check;
1421 bool x_warn_remove_no_match;
1425 crit_action *x_overwrite;
1426 bool x_only_deleted;
1427 bool x_ignore_deleted;
1429 bool x_ignore_unix_sockets;
1432 void destroy() noexcept;
1433 void nullifyptr() noexcept;
1434 void copy_from(const archive_options_extract & ref);
1435 void move_from(archive_options_extract && ref) noexcept;
1456 virtual void clear();
1497 bool get_info_details()
const {
return x_info_details; };
1498 const mask & get_selection()
const;
1499 const mask & get_subtree()
const;
1500 bool get_filter_unsaved()
const {
return x_filter_unsaved; };
1501 bool get_user_slicing(infinint & slicing_first, infinint & slicing_others)
const;
1502 bool get_slicing_location()
const {
return x_slicing_location; };
1503 bool get_display_ea()
const {
return x_display_ea; };
1506 bool x_info_details;
1509 bool x_filter_unsaved;
1510 infinint *x_slicing_first;
1511 infinint *x_slicing_others;
1512 bool x_slicing_location;
1515 void destroy() noexcept;
1516 void nullifyptr() noexcept;
1517 void copy_from(const archive_options_listing & ref);
1518 void move_from(archive_options_listing && ref) noexcept;
1526 class archive_options_diff
1529 archive_options_diff() { nullifyptr();
clear(); };
1530 archive_options_diff(
const archive_options_diff & ref) { copy_from(ref); };
1531 archive_options_diff(archive_options_diff && ref)
noexcept { nullifyptr(); move_from(std::move(ref)); };
1532 archive_options_diff & operator = (
const archive_options_diff & ref) { destroy(); copy_from(ref);
return *
this; };
1533 archive_options_diff & operator = (archive_options_diff && ref)
noexcept { move_from(std::move(ref));
return *
this; };
1534 ~archive_options_diff() { destroy(); };
1553 void set_info_details(
bool info_details) { x_info_details = info_details; };
1558 void set_display_treated(
bool display_treated,
bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
1567 void set_what_to_check(comparison_fields what_to_check) { x_what_to_check = what_to_check; };
1578 x_alter_atime = alter_atime;
1585 void set_hourshift(
const infinint & hourshift) { x_hourshift = hourshift; };
1588 void set_compare_symlink_date(
bool compare_symlink_date) { x_compare_symlink_date = compare_symlink_date; };
1591 void set_fsa_scope(
const fsa_scope & scope) { x_scope = scope; };
1594 void set_in_place(
bool arg) { x_in_place = arg; };
1601 const mask & get_subtree()
const {
if(
x_subtree ==
nullptr)
throw SRC_BUG;
return *
x_subtree; };
1602 bool get_info_details()
const {
return x_info_details; };
1603 bool get_display_treated()
const {
return x_display_treated; };
1604 bool get_display_treated_only_dir()
const {
return x_display_treated_only_dir; };
1605 bool get_display_skipped()
const {
return x_display_skipped; };
1606 const mask & get_ea_mask()
const {
if(
x_ea_mask ==
nullptr)
throw SRC_BUG;
return *
x_ea_mask; };
1607 comparison_fields get_what_to_check()
const {
return x_what_to_check; };
1608 bool get_alter_atime()
const {
return x_alter_atime; };
1609 bool get_furtive_read_mode()
const {
return x_furtive_read; };
1610 const infinint & get_hourshift()
const {
return x_hourshift; };
1611 bool get_compare_symlink_date()
const {
return x_compare_symlink_date; };
1612 const fsa_scope & get_fsa_scope()
const {
return x_scope; };
1613 bool get_in_place()
const {
return x_in_place; };
1618 bool x_info_details;
1619 bool x_display_treated;
1620 bool x_display_treated_only_dir;
1621 bool x_display_skipped;
1623 comparison_fields x_what_to_check;
1626 bool x_furtive_read;
1627 infinint x_hourshift;
1628 bool x_compare_symlink_date;
1632 void destroy() noexcept;
1633 void nullifyptr() noexcept;
1634 void copy_from(const archive_options_diff & ref);
1635 void move_from(archive_options_diff && ref) noexcept;
1681 void set_display_treated(
bool display_treated,
bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
1691 const mask & get_subtree()
const {
if(
x_subtree ==
nullptr)
throw SRC_BUG;
return *
x_subtree; };
1692 bool get_info_details()
const {
return x_info_details; };
1693 bool get_display_treated()
const {
return x_display_treated; };
1694 bool get_display_treated_only_dir()
const {
return x_display_treated_only_dir; };
1695 bool get_display_skipped()
const {
return x_display_skipped; };
1696 bool get_empty()
const {
return x_empty; };
1701 bool x_info_details;
1702 bool x_display_treated;
1703 bool x_display_treated_only_dir;
1704 bool x_display_skipped;
1707 void destroy() noexcept;
1708 void nullifyptr() noexcept;
1709 void copy_from(const archive_options_test & ref);
1710 void move_from(archive_options_test && ref) noexcept;
1760 void set_display_treated(
bool display_treated,
bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
1778 x_file_size = file_size;
1779 if(first_file_size.is_zero())
1780 x_first_file_size = file_size;
1782 x_first_file_size = first_file_size;
1796 void set_execute(
const std::string & execute) { x_execute = execute; };
1816 void set_gnupg_recipients(
const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
1821 void set_gnupg_signatories(
const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
1847 void set_entrepot(
const std::shared_ptr<entrepot> & entr) {
if(!entr)
throw Erange(
"archive_options_repair::set_entrepot",
"null entrepot pointer given in argument"); x_entrepot = entr; };
1865 bool get_allow_over()
const {
return x_allow_over; };
1866 bool get_warn_over()
const {
return x_warn_over; };
1867 bool get_info_details()
const {
return x_info_details; };
1868 bool get_display_treated()
const {
return x_display_treated; };
1869 bool get_display_treated_only_dir()
const {
return x_display_treated_only_dir; };
1870 bool get_display_skipped()
const {
return x_display_skipped; };
1871 bool get_display_finished()
const {
return x_display_finished; };
1872 const infinint & get_pause()
const {
return x_pause; };
1873 const infinint & get_slice_size()
const {
return x_file_size; };
1874 const infinint & get_first_slice_size()
const {
return x_first_file_size; };
1875 const std::string & get_execute()
const {
return x_execute; };
1876 crypto_algo get_crypto_algo()
const {
return x_crypto; };
1877 const secu_string & get_crypto_pass()
const {
return x_pass; };
1878 U_32 get_crypto_size()
const {
return x_crypto_size; };
1879 const std::vector<std::string> & get_gnupg_recipients()
const {
return x_gnupg_recipients; };
1880 const std::vector<std::string> & get_gnupg_signatories()
const {
return x_gnupg_signatories; };
1881 bool get_empty()
const {
return x_empty; };
1882 const std::string & get_slice_permission()
const {
return x_slice_permission; };
1883 const std::string & get_slice_user_ownership()
const {
return x_slice_user_ownership; };
1884 const std::string & get_slice_group_ownership()
const {
return x_slice_group_ownership; };
1885 const std::string & get_user_comment()
const {
return x_user_comment; };
1886 hash_algo get_hash_algo()
const {
return x_hash; };
1887 infinint get_slice_min_digits()
const {
return x_slice_min_digits; };
1888 const std::shared_ptr<entrepot> & get_entrepot()
const {
return x_entrepot; };
1889 U_I get_multi_threaded_crypto()
const {
return x_multi_threaded_crypto; };
1890 U_I get_multi_threaded_compress()
const {
return x_multi_threaded_compress; };
1895 bool x_info_details;
1896 bool x_display_treated;
1897 bool x_display_treated_only_dir;
1898 bool x_display_skipped;
1899 bool x_display_finished;
1901 infinint x_file_size;
1902 infinint x_first_file_size;
1903 std::string x_execute;
1904 crypto_algo x_crypto;
1907 std::vector<std::string> x_gnupg_recipients;
1908 std::vector<std::string> x_gnupg_signatories;
1910 std::string x_slice_permission;
1911 std::string x_slice_user_ownership;
1912 std::string x_slice_group_ownership;
1913 std::string x_user_comment;
1915 infinint x_slice_min_digits;
1916 std::shared_ptr<entrepot> x_entrepot;
1917 U_I x_multi_threaded_crypto;
1918 U_I x_multi_threaded_compress;
1920 void nullifyptr() noexcept {};
1921 void copy_from(
const archive_options_repair & ref);
1922 void move_from(archive_options_repair && ref)
noexcept;
set of datastructures used to interact with a catalogue object
exception used when a requested fearture has not beed activated at compilation time
exception used to signal range error
class holding optional parameters used to create an archive
void clear()
reset all the options to their default values
void set_slicing(const infinint &file_size, const infinint &first_file_size=0)
define the archive slicing
void set_delta_sig_min_size(const infinint &val)
whether to never calculate delta signature for files which size is smaller or equal to the given argu...
void set_crypto_pass(const secu_string &pass)
void set_compression_block_size(U_I compression_block_size)
set the compression block size
void set_auto_zeroing_neg_dates(bool val)
whether to automatically zeroing negative dates read from the filesystem (just warn,...
void set_same_fs_include(const std::string &included_path_to_fs)
files on the filesystem pointed to by the given path will be considered for the backup operation if n...
void set_display_finished(bool display_finished)
whether to display a summary for each completed directory with total saved data and compression ratio
void set_allow_over(bool allow_over)
defines whether overwritting is allowed or not
void set_crypto_algo(crypto_algo crypto)
set the cypher to use
void set_backup_hook(const std::string &execute, const mask &which_files)
defines the backup hook for files
void set_compression_level(U_I compression_level)
set the compression level (from 1 to 9)
void set_retry_on_change(const infinint &count_max_per_file, const infinint &global_max_byte_overhead=0)
how much time to retry saving a file if it changed while being read
void set_info_details(bool info_details)
defines whether the user needs detailed output of the operation
void set_warn_over(bool warn_over)
defines whether a warning shall be issued before overwriting
void set_execute(const std::string &execute)
set the command to execute after each slice creation
void set_security_check(bool check)
whether to check for ctime changes since with the archive of reference
void set_min_compr_size(const infinint &min_compr_size)
defines file size under which to never compress
void set_fixed_date(const infinint &fixed_date)
whether to ignore any archive of reference and only save file which modification is more recent that ...
void set_delta_signature(bool val)
whether signature to base binary delta on the future has to be calculated and stored beside saved fil...
void set_slice_permission(const std::string &slice_permission)
if not an empty string set the slice permission according to the octal value given.
void set_gnupg_signatories(const std::vector< std::string > &gnupg_signatories)
void set_subtree(const mask &subtree)
defines the directory and files to consider (this mask will be applied to the absolute path of files ...
void set_modified_data_detection(modified_data_detection val)
defines when to resave a file's data which inode metadata changed
void set_furtive_read_mode(bool furtive_read)
whether to use furtive read mode (if activated, alter_atime() has no meaning/use)
void set_sequential_marks(bool sequential)
whether to add escape sequence aka tape marks to allow sequential reading of the archive
std::shared_ptr< archive > x_ref_arch
just contains the address of an existing object, no local copy of object is done here
void set_multi_threaded_compress(U_I num)
how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
void set_cache_directory_tagging(bool cache_directory_tagging)
whether to consider the Cache Directory Tagging Standard
void set_compr_mask(const mask &compr_mask)
defines files to compress
void set_pause(const infinint &pause)
set a pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each sli...
mask * x_ea_mask
points to a local copy of mask (must be allocated / releases by the archive_option_create objects)
void set_slice_min_digits(infinint val)
defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as...
void set_multi_threaded(bool val)
whether libdar is allowed to spawn several threads to possibily work faster on multicore CPU (require...
void set_same_fs(bool same_fs)
whether to limit the backup to files located on the same filesystem as the directory taken as root of...
void set_iteration_count(const infinint &val)
key derivation
void set_empty_dir(bool empty_dir)
defines whether we need to store ignored directories as empty
void set_delta_mask(const mask &delta_mask)
whether to derogate to defaut delta file consideration while calculation delta signatures
void set_sparse_file_min_size(const infinint &size)
whether to try to detect sparse files
mask * x_subtree
points to a local copy of mask (must be allocated / releases by the archive_option_create objects)
void set_delta_diff(bool val)
whether binary delta has to be computed for differential/incremental backup
void set_display_skipped(bool display_skipped)
whether to display files that have been excluded by filters
void set_hourshift(const infinint &hourshift)
ignore differences of at most this integer number of hours while looking for changes in dates
mask * x_selection
points to a local copy of mask (must be allocated / releases by the archive_option_create object)
void set_crypto_size(U_32 crypto_size)
set the size of the encryption by block to use
void set_ea_mask(const mask &ea_mask)
defines which Extended Attributes to save
void set_fsa_scope(const fsa_scope &scope)
defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA activated at com...
void set_nodump(bool nodump)
defines whether to ignore files with the nodump flag set
void set_same_fs_exclude(const std::string &excluded_path_to_fs)
files on the filesystem pointed to by the given path will not be considered for backup operation
void set_ignored_as_symlink(const std::set< std::string > &list)
provide a list of full path which if are symlinks will be considered as the inode they point to
void set_exclude_by_ea(const std::string &ea_name)
void set_entrepot(const std::shared_ptr< entrepot > &entr)
defines the protocol to use for slices
void set_slice_user_ownership(const std::string &slice_user_ownership)
if not an empty string set the user ownership of slices accordingly
void set_compression(compression compr_algo)
set the compression algorithm to be used
mask * x_compr_mask
points to a local copy of mask (must be allocated / releases by the archive_option_create objects)
void set_ignore_unknown_inode_type(bool val)
whether to ignore unknown inode types instead of issuing a warning
void set_snapshot(bool snapshot)
whether to make an emtpy archive only referencing the current state of files in the filesystem
void set_slice_group_ownership(const std::string &slice_group_ownership)
if not an empty string set the group ownership of slices accordingly
void set_reference(std::shared_ptr< archive > ref_arch)
set the archive to take as reference (nullptr for a full backup)
void set_alter_atime(bool alter_atime)
whether to alter atime or ctime in the filesystem when reading files to save
bool x_old_alter_atime
used to backup origina alter_atime value when activating furtive read mode
void set_kdf_hash(hash_algo algo)
hash algo used for key derivation
void set_user_comment(const std::string &comment)
specify a user comment in the archive (always in clear text!)
void set_display_treated(bool display_treated, bool only_dir)
defines whether to show treated files
void set_hash_algo(hash_algo hash)
specify whether to produce a hash file of the slice and which hash algo to use
void set_what_to_check(comparison_fields what_to_check)
set the fields to consider when comparing inodes with reference archive (see comparison_fields enumer...
void set_sig_block_len(delta_sig_block_size val)
block size to use to build delta signatures
void set_selection(const mask &selection)
defines the filenames to only save (except directory) as those that match the given mask
void set_gnupg_recipients(const std::vector< std::string > &gnupg_recipients)
set the list of recipients that will be able to read the archive
void set_multi_threaded_crypto(U_I num)
how much thread libdar will use for cryptography (need libthreadar to be effective)
void set_empty(bool empty)
whether to make a dry-run operation
class holding optional parameters used to isolate an existing archive
void set_crypto_size(U_32 crypto_size)
size of the encryption by block to use
void set_multi_threaded_crypto(U_I num)
how much thread libdar will use for cryptography (need libthreadar to be effective)
void set_warn_over(bool warn_over)
whether a warning shall be issued before overwriting
void set_gnupg_recipients(const std::vector< std::string > &gnupg_recipients)
void set_delta_mask(const mask &delta_mask)
whether to derogate to defaut delta file consideration while calculation delta signatures
void set_delta_signature(bool val)
whether signature to base binary delta on the future has to be calculated and stored beside saved fil...
void set_slice_permission(const std::string &slice_permission)
if not an empty string set the slice permission according to the octal value given.
void set_slicing(const infinint &file_size, const infinint &first_file_size=0)
define the archive slicing
void set_pause(const infinint &pause)
Pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each slice,...
void set_crypto_algo(crypto_algo crypto)
cypher to use
void set_allow_over(bool allow_over)
whether overwritting is allowed
void set_sequential_marks(bool sequential)
whether to add escape sequence aka tape marks to allow sequential reading of the archive
void set_entrepot(const std::shared_ptr< entrepot > &entr)
defines the protocol to use for slices
void set_sig_block_len(delta_sig_block_size val)
block size to use to build delta signatures
void set_user_comment(const std::string &comment)
specify a user comment in the archive (always in clear text!)
void set_compression_level(U_I compression_level)
the compression level (from 1 to 9)
void set_delta_sig_min_size(const infinint &val)
void set_multi_threaded(bool val)
whether libdar is allowed to created several thread to work possibily faster on multicore CPU (requir...
void set_slice_user_ownership(const std::string &slice_user_ownership)
if not an empty string set the user ownership of slices accordingly
void set_execute(const std::string &execute)
command to execute after each slice creation
void set_hash_algo(hash_algo hash)
specify whether to produce a hash file of the slice and which hash algo to use
void set_compression(compression algo)
the compression algorithm used
void set_compression_block_size(U_I compression_block_size)
set the compression block size
void set_slice_group_ownership(const std::string &slice_group_ownership)
if not an empty string set the group ownership of slices accordingly
void set_multi_threaded_compress(U_I num)
how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
void set_gnupg_signatories(const std::vector< std::string > &gnupg_signatories)
void set_slice_min_digits(infinint val)
defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as...
void set_info_details(bool info_details)
whether the user needs detailed output of the operation
void set_kdf_hash(hash_algo algo)
hash algo used for key derivation
void set_iteration_count(const infinint &val)
key derivation
void set_crypto_pass(const secu_string &pass)
password / passphrase to encrypt the data with (empty string for interactive question)
void set_empty(bool empty)
whether to make a dry-run operation
class holding optional parameters used to list the contents of an existing archive
void set_subtree(const mask &subtree)
mask applied to the full path, only those matching it will be listed
void set_display_ea(bool display_ea)
whether to fetch EA for listing
void set_user_slicing(const infinint &slicing_first, const infinint &slicing_others)
when slice location is performed, user may modify the slice layout of the archive
void set_filter_unsaved(bool filter_unsaved)
whether to only show entries that have their data fully saved
void set_selection(const mask &selection)
mask applied to filename, only those marching it will be listed
void set_info_details(bool info_details)
whether output should be verbosed --> to be moved to shell output
void set_slicing_location(bool val)
whether to calculate the slice location of each file
class holding optional parameters used to proceed to the merge operation
void set_delta_signature(bool val)
void set_sequential_marks(bool sequential)
whether to activate escape sequence aka tape marks to allow sequential reading of the archive
void set_display_skipped(bool display_skipped)
whether to display files that have been excluded by filters
void set_compr_mask(const mask &compr_mask)
defines files to compress
void set_sig_block_len(delta_sig_block_size val)
block size to use to build delta signatures
void set_empty(bool empty)
defines whether we do a dry-run execution
void set_ea_mask(const mask &ea_mask)
defines which Extended Attributes to save
void set_crypto_pass(const secu_string &pass)
void set_display_treated(bool display_treated, bool only_dir)
defines whether to show treated files
void set_multi_threaded_compress(U_I num)
how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
void set_slice_min_digits(infinint val)
defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as...
void set_overwriting_rules(const crit_action &overwrite)
policy to solve merging conflict
void set_delta_mask(const mask &delta_mask)
whether to derogate to defaut delta file consideration while calculation delta signatures
void set_min_compr_size(const infinint &min_compr_size)
defines file size under which to never compress
void set_iteration_count(const infinint &val)
key derivation
void set_compression(compression compr_algo)
set the compression algorithm to be used
void set_sparse_file_min_size(const infinint &size)
whether to try to detect sparse files
void set_multi_threaded(bool val)
whether libdar is allowed to spawn several threads to possibily work faster on multicore CPU (require...
void set_crypto_algo(crypto_algo crypto)
set the cypher to use
void set_crypto_size(U_32 crypto_size)
set the size of the encryption by block to use
void set_keep_compressed(bool keep_compressed)
make dar ignore the 'algo' argument and do not uncompress / compress files that are selected for merg...
void set_gnupg_recipients(const std::vector< std::string > &gnupg_recipients)
void set_entrepot(const std::shared_ptr< entrepot > &entr)
defines the protocol to use for slices
void set_kdf_hash(hash_algo algo)
hash algo used for key derivation
void set_info_details(bool info_details)
defines whether the user needs detailed output of the operation
void set_multi_threaded_crypto(U_I num)
how much thread libdar will use for cryptography (need libthreadar to be effective)
void set_decremental_mode(bool mode)
if set to true use a merging mode suitable to build a decremental backup from two full backups (see N...
void set_execute(const std::string &execute)
set the command to execute after each slice creation
void set_slicing(const infinint &file_size, const infinint &first_file_size=0)
define the archive slicing
void set_pause(const infinint &pause)
set a pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each sli...
void set_empty_dir(bool empty_dir)
defines whether we need to store ignored directories as empty
void set_compression_block_size(U_I compression_block_size)
set the compression block size (0 for streamed compression)
void set_allow_over(bool allow_over)
defines whether overwritting is allowed or not
void set_delta_sig_min_size(const infinint &val)
whether to never calculate delta signature for files which size is smaller or equal to the given argu...
void set_subtree(const mask &subtree)
defines the directory and files to consider (this mask will be applied to the absolute path of files ...
void set_fsa_scope(const fsa_scope &scope)
defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA are considered)
void set_gnupg_signatories(const std::vector< std::string > &gnupg_signatories)
void set_slice_group_ownership(const std::string &slice_group_ownership)
if not an empty string set the group ownership of slices accordingly
void set_hash_algo(hash_algo hash)
specify whether to produce a hash file of the slice and which hash algo to use
void set_compression_level(U_I compression_level)
set the compression level (from 1 to 9)
void set_user_comment(const std::string &comment)
specify a user comment in the archive (always in clear text!)
void set_slice_permission(const std::string &slice_permission)
if not an empty string set the slice permission according to the octal value given.
void set_warn_over(bool warn_over)
defines whether a warning shall be issued before overwriting
void set_slice_user_ownership(const std::string &slice_user_ownership)
if not an empty string set the user ownership of slices accordingly
void set_selection(const mask &selection)
defines the filenames to only save (except directory) as those that match the given mask
class holding optional parameters used to read an existing archive
void set_input_pipe(const std::string &input_pipe)
set the name of the input pipe to read data from (when basename is set to "-")
void set_entrepot(const std::shared_ptr< entrepot > &entr)
defines the protocol to use to retrieve slices
void set_crypto_algo(crypto_algo val)
defines the the crypto cypher to use to read the archive (default is crypto_none)
void set_ref_crypto_size(U_32 ref_crypto_size)
defines the crypto size for the reference catalogue
void set_multi_threaded_compress(U_I num)
how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
void set_slice_min_digits(infinint val)
defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as...
void set_crypto_pass(const secu_string &pass)
defines the password or passphrase to decrypt (unused if encryption is not set)
archive_options_read()
build an object and set options to their default values
void set_multi_threaded(bool val)
whether libdar is allowed to create several thread to work possibly faster on multicore CPU (need lib...
void set_ref_crypto_pass(const secu_string &ref_pass)
defines the pass for the reference catalogue
void set_ref_entrepot(const std::shared_ptr< entrepot > &entr)
defines the protocol to use to retrieve slices of the reference archive (where the external catalogue...
void clear()
reset all the options to their default values
void set_ignore_signature_check_failure(bool val)
whether to warn (true) or ignore (false) signature failure (default is true)
void unset_external_catalogue()
clear any reference to an external catalogue
void set_ref_crypto_algo(crypto_algo ref_crypto)
defines the crypto algo for the reference catalogue
void set_lax(bool val)
defines whether any archive coherence error, system error or media error lead to the abortion of the ...
void set_info_details(bool info_details)
defines whether the user needs detailed output of the operation
void set_header_only(bool val)
whether we only read the archive header and exit
void set_ref_slice_min_digits(infinint val)
defines the minim digit for slice number of the archive of reference (where the external catalogue is...
void set_ref_execute(const std::string &ref_execute)
set the command to execute before reading each slice of the reference catalogue
void set_output_pipe(const std::string &output_pipe)
set the name of the output pipe to send orders to (when basenale is set to "-")
void set_execute(const std::string &execute)
set the command to execute before reading each slice (empty string for no script)
void set_default_crypto_size()
set the encryption block size to the default value
void set_sequential_read(bool val)
defines whether to try reading the archive sequentially (ala tar) or using the final catalogue
void set_crypto_size(U_32 crypto_size)
the encryption block size to use to decrypt
void set_multi_threaded_crypto(U_I num)
how much thread libdar will use for cryptography (need libthreadar to be effective)
archive_options_read(const archive_options_read &ref)
the copy constructor, assignment operator and destructor
void set_external_catalogue(const path &ref_chem, const std::string &ref_basename)
defines whether or not to use the catalogue from an extracted catalogue (instead of the one embedded ...
class holding optional parameters used to create an archive
void set_display_finished(bool display_finished)
whether to display a summary for each completed directory with total saved data and compression ratio
void set_allow_over(bool allow_over)
defines whether overwritting is allowed or not
void set_multi_threaded_compress(U_I num)
how much thread libdar will use for compression (need libthreadar too and compression_block_size > 0)
void set_gnupg_signatories(const std::vector< std::string > &gnupg_signatories)
void set_crypto_algo(crypto_algo crypto)
set the cypher to use
void set_slice_min_digits(infinint val)
defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as...
void set_slice_user_ownership(const std::string &slice_user_ownership)
if not an empty string set the user ownership of slices accordingly
void set_execute(const std::string &execute)
set the command to execute after each slice creation
void set_slice_permission(const std::string &slice_permission)
if not an empty string set the slice permission according to the octal value given.
void set_crypto_size(U_32 crypto_size)
set the size of the encryption by block to use
void set_gnupg_recipients(const std::vector< std::string > &gnupg_recipients)
void clear()
reset all the options to their default values
void set_info_details(bool info_details)
void set_slice_group_ownership(const std::string &slice_group_ownership)
if not an empty string set the group ownership of slices accordingly
void set_pause(const infinint &pause)
set a pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each sli...
void set_empty(bool empty)
whether to make a dry-run operation
void set_multi_threaded_crypto(U_I num)
how much thread libdar will use for cryptography (need libthreadar to be effective)
void set_display_treated(bool display_treated, bool only_dir)
void set_slicing(const infinint &file_size, const infinint &first_file_size=0)
define the archive slicing
void set_display_skipped(bool display_skipped)
whether to display files that have been excluded by filters
void set_user_comment(const std::string &comment)
specify a user comment in the archive (always in clear text!)
void set_multi_threaded(bool val)
whether libdar is allowed to spawn several threads to possibily work faster on multicore CPU (require...
void set_crypto_pass(const secu_string &pass)
void set_hash_algo(hash_algo hash)
void set_warn_over(bool warn_over)
defines whether a warning shall be issued before overwriting
void set_entrepot(const std::shared_ptr< entrepot > &entr)
defines the protocol to use for slices
class holding optional parameters used to test the structure coherence of an existing archive
void set_selection(const mask &selection)
list of filenames to consider (directory not concerned by this fiter)
void set_display_skipped(bool display_skipped)
whether to display files that have been excluded by filters
void set_subtree(const mask &subtree)
defines the directory and files to consider (this mask will be applied to the absolute path of files ...
void set_empty(bool empty)
dry-run exectution if set to true
void set_display_treated(bool display_treated, bool only_dir)
void set_info_details(bool info_details)
the global action for overwriting
the arbitrary large positive integer class
the generic class, parent of all masks
the class path is here to manipulate paths in the Unix notation: using'/'
nested namespace containing routines that give features activated at compile time
compression parameters for API
contains classes that let the user define the policy for overwriting files
the crypto algoritm definition
structure used to define how to select block size for delta signature
defines the entrepot interface.
gather the ids of different filesystem to provide a filter based on filesystem
filesystem specific attributes available families and fsa_scope definition
modified_data_detection
how to detect data has changed when some fields
comparison_fields
how to consider file change during comparison and incremental backup
hash_algo
hashing algorithm available
std::set< fsa_family > fsa_scope
set of fsa families
compression
the different compression algorithm available
crypto_algo
the different cypher available for encryption (strong or weak)
are defined here basic integer types that tend to be portable
here lies a collection of mask classes
here lies a mask that selects files present in a given list
include macro defined by the configure script and some specific additional ones
bool librsync() noexcept
returns whether delta compression is available and delta diff stuff with it
libdar namespace encapsulate all libdar symbols
this file contains the definition of secu_string class, a std::string like class but allocated in sec...
defines how to calculate delta signature block size based of file size to delta sign
void check() const
check the sanity of the provided values