/usr/include/dar/archive_options.hpp is in libdar-dev 2.5.14+bis-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 | /*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2052 Denis Corbin
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// to contact the author : http://dar.linux.free.fr/email.html
/*********************************************************************/
/// \file archive_options.hpp
/// \brief this file contains a set of classes used to transmit options to archive operation
/// \ingroup API
#ifndef ARCHIVE_OPTIONS_HPP
#define ARCHIVE_OPTIONS_HPP
#include "/usr/include/dar/libdar_my_config.h"
#include "/usr/include/dar/crypto.hpp"
#include "/usr/include/dar/integers.hpp"
#include "/usr/include/dar/mask.hpp"
#include "/usr/include/dar/compressor.hpp"
#include "/usr/include/dar/catalogue.hpp"
#include "/usr/include/dar/criterium.hpp"
#include "/usr/include/dar/hash_fichier.hpp"
#include "/usr/include/dar/secu_string.hpp"
#include "/usr/include/dar/nls_swap.hpp"
#include "/usr/include/dar/entrepot.hpp"
#include "/usr/include/dar/fsa_family.hpp"
#include "/usr/include/dar/on_pool.hpp"
#include <string>
namespace libdar
{
class archive; // needed to be able to use pointer on archive object.
/////////////////////////////////////////////////////////
////////////// OPTIONS FOR OPENNING AN ARCHIVE //////////
/////////////////////////////////////////////////////////
/// \addtogroup API
/// @{
/// class holding optional parameters used to read an existing archive
class archive_options_read : public on_pool
{
public:
/// build an object and set options to their default values
archive_options_read();
/// the copy constructor, assignment operator and destructor
archive_options_read(const archive_options_read & ref) : x_ref_chem(ref.x_ref_chem) { copy_from(ref); };
const archive_options_read & operator = (const archive_options_read & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_read() { destroy(); };
/////////////////////////////////////////////////////////////////////
// set back to default (this is the state just after the object is constructed
// this method is to be used to reuse a given object
/// reset all the options to their default values
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
/// defines the the crypto cypher to use to read the archive (default is crypto_none)
/// \note since release 2.5.0 you may and should provide crypto_none in any case (the default value)
/// for libdar uses the algorithm stored in the archive. However you way override this
/// (in case of corruption for example) by explicitely specifying a crypto algorithm
/// in that case the value of the crypto algorithm stored in the archive is ignored
/// and the algorithm used to decipher is the one specified here.
void set_crypto_algo(crypto_algo val) { x_crypto = val; };
/// defines the password or passphrase to decrypt (unused if encryption is not set)
void set_crypto_pass(const secu_string & pass) { x_pass = pass; };
/// the encryption block size to use to decrypt
void set_crypto_size(U_32 crypto_size) { x_crypto_size = crypto_size; };
/// set the encryption block size to the default value
void set_default_crypto_size();
/// set the name of the input pipe to read data from (when basename is set to "-")
/// if input_pipe is set to "" (empty string) the information from dar_slave are expected
/// in standard input else the given string
void set_input_pipe(const std::string & input_pipe) { x_input_pipe = input_pipe; };
/// set the name of the output pipe to send orders to (when basenale is set to "-")
/// if output_pipe is set to "" the orders sent to dar_slave will exit by the standard output else the given string
/// must be the path to a named pipe which will relay the orders to dar_slave
void set_output_pipe(const std::string & output_pipe) { x_output_pipe = output_pipe; };
/// set the command to execute before reading each slice (empty string for no script)
/// several macros are available:
/// - %%n : the slice number to be read
/// - %%b : the archive basename
/// - %%p : the slices path
/// - %%e : the archive extension (usually "dar")
/// - %%% : substitued by %%
/// .
void set_execute(const std::string & execute) { x_execute = execute; };
/// defines whether the user needs detailed output of the operation
void set_info_details(bool info_details) { x_info_details = info_details; };
/// defines whether any archive coherence error, system error or media error lead to the abortion of the operation
/// lax mode is false by default.
/// setting it to true, may allow more data to be restored, but may lead the user to get corrupted data
/// the user will be warned and asked upon what to do if such case arrives.
void set_lax(bool val) { x_lax = val; };
/// defines whether to try reading the archive sequentially (ala tar) or using the final catalogue
/// the sequential reading must not has been disabled at creation time and the archive must be of minimum format "08" for the operation not to fail
void set_sequential_read(bool val) { x_sequential_read = val; };
/// defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
void set_slice_min_digits(infinint val) { x_slice_min_digits = val; };
/// defines the protocol to use to retrieve slices
void set_entrepot(const entrepot & entr) { if(x_entrepot != nullptr) delete x_entrepot; x_entrepot = entr.clone(); if(x_entrepot == nullptr) throw Ememory("archive_options_read::set_entrepot"); };
/// whether to warn (true) or ignore (false) signature failure (default is true)
void set_ignore_signature_check_failure(bool val) { x_ignore_signature_check_failure = val; };
/// whether libdar is allowed to create several thread to work possilbiy faster on multicore CPU (need libthreadar to be effective)
void set_multi_threaded(bool val) { x_multi_threaded = val; };
//////// what follows concerne the use of an external catalogue instead of the archive's internal one
/// defines whether or not to use the catalogue from an extracted catalogue (instead of the one embedded in the archive) and which one to use
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; };
/// clear any reference to an external catalogue
void unset_external_catalogue();
/// defines the crypto algo for the reference catalogue
void set_ref_crypto_algo(crypto_algo ref_crypto) { x_ref_crypto = ref_crypto; };
/// defines the pass for the reference catalogue
void set_ref_crypto_pass(const secu_string & ref_pass) { x_ref_pass = ref_pass; };
/// defines the crypto size for the reference catalogue
void set_ref_crypto_size(U_32 ref_crypto_size) { x_ref_crypto_size = ref_crypto_size; };
/// set the command to execute before reading each slice of the reference catalogue
/// several macros are available:
/// - %%n : the slice number to be read
/// - %%b : the archive basename
/// - %%p : the slices path
/// - %%e : the archive extension (usually "dar")
/// - %%% : substitued by %%
/// .
void set_ref_execute(const std::string & ref_execute) { x_ref_execute = ref_execute; };
/// defines the minim digit for slice number of the archive of reference (where the external catalogue is read from)
void set_ref_slice_min_digits(infinint val) { x_ref_slice_min_digits = val; };
/// defines the protocol to use to retrieve slices of the reference archive (where the external catalogue resides)
void set_ref_entrepot(const entrepot & entr) { if(x_ref_entrepot != nullptr) delete x_ref_entrepot; x_ref_entrepot = entr.clone(); if(x_ref_entrepot == nullptr) throw Ememory("archive_options_read::set_entrepot"); };
/// whether we only read the archive header and exit
void set_header_only(bool val) { x_header_only = val; };
/////////////////////////////////////////////////////////////////////
// getting methods (mainly used inside libdar, but kept public and part of the API in the case it is needed)
crypto_algo get_crypto_algo() const { return x_crypto; };
const secu_string & get_crypto_pass() const { return x_pass; };
U_32 get_crypto_size() const { return x_crypto_size; };
const std::string & get_input_pipe() const { return x_input_pipe; };
const std::string & get_output_pipe() const { return x_output_pipe; };
const std::string & get_execute() const { return x_execute; };
bool get_info_details() const { return x_info_details; };
bool get_lax() const { return x_lax; };
bool get_sequential_read() const { return x_sequential_read; };
infinint get_slice_min_digits() const { return x_slice_min_digits; };
const entrepot & get_entrepot() const { if(x_entrepot == nullptr) throw SRC_BUG; return *x_entrepot; };
bool get_ignore_signature_check_failure() const { return x_ignore_signature_check_failure; };
bool get_multi_threaded() const { return x_multi_threaded; };
// All methods that follow concern the archive where to fetch the (isolated) catalogue from
bool is_external_catalogue_set() const { return external_cat; };
const path & get_ref_path() const;
const std::string & get_ref_basename() const;
crypto_algo get_ref_crypto_algo() const { return x_ref_crypto; };
const secu_string & get_ref_crypto_pass() const { return x_ref_pass; };
U_32 get_ref_crypto_size() const { return x_ref_crypto_size; };
const std::string & get_ref_execute() const { return x_ref_execute; };
infinint get_ref_slice_min_digits() const { return x_ref_slice_min_digits; };
const entrepot & get_ref_entrepot() const { if(x_ref_entrepot == nullptr) throw SRC_BUG; return *x_ref_entrepot; };
bool get_header_only() const { return x_header_only; };
private:
crypto_algo x_crypto;
secu_string x_pass;
U_32 x_crypto_size;
std::string x_input_pipe;
std::string x_output_pipe;
std::string x_execute;
bool x_info_details;
bool x_lax;
bool x_sequential_read;
infinint x_slice_min_digits;
entrepot *x_entrepot;
bool x_ignore_signature_check_failure;
bool x_multi_threaded;
// external catalogue relative fields
bool external_cat;
path x_ref_chem;
std::string x_ref_basename;
crypto_algo x_ref_crypto;
secu_string x_ref_pass;
U_32 x_ref_crypto_size;
std::string x_ref_execute;
infinint x_ref_slice_min_digits;
entrepot *x_ref_entrepot;
bool x_header_only;
void copy_from(const archive_options_read & ref);
void destroy();
};
/////////////////////////////////////////////////////////
///////// OPTIONS FOR CREATING AN ARCHIVE ///////////////
/////////////////////////////////////////////////////////
/// class holding optional parameters used to create an archive
class archive_options_create : public on_pool
{
public:
// default constructors and destructor.
archive_options_create();
archive_options_create(const archive_options_create & ref);
const archive_options_create & operator = (const archive_options_create & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_create() { destroy(); };
/////////////////////////////////////////////////////////////////////
// set back to default (this is the state just after the object is constructed
// this method is to be used to reuse a given object
/// reset all the options to their default values
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
/// set the archive to take as reference (nullptr for a full backup)
void set_reference(archive *ref_arch) { x_ref_arch = ref_arch; };
/// defines the filenames to only save (except directory) as those that match the given mask
void set_selection(const mask & selection);
/// defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
void set_subtree(const mask & subtree);
/// defines whether overwritting is allowed or not
void set_allow_over(bool allow_over) { x_allow_over = allow_over; };
/// defines whether a warning shall be issued before overwriting
void set_warn_over(bool warn_over) { x_warn_over = warn_over; };
/// defines whether the user needs detailed output of the operation
///
/// \note in API 5.5.x and before this switch drove the displaying
/// of processing messages and treated files. now it only drives the
/// display of processing messages, use set_display_treated to define
/// whether files under treatement should be display or not
void set_info_details(bool info_details) { x_info_details = info_details; };
/// defines whether to show treated files
///
/// \param[in] display_treated true to display processed inodes
/// \param[in] only_dir only display the current directory under process, not its individual files
void set_display_treated(bool display_treated, bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
/// whether to display files that have been excluded by filters
void set_display_skipped(bool display_skipped) { x_display_skipped = display_skipped; };
/// whether to display a summary for each completed directory with total saved data and compression ratio
void set_display_finished(bool display_finished) { x_display_finished = display_finished; };
/// set a pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each slice, set to 2 makes libdar pause each 2 slices and so on.
void set_pause(const infinint & pause) { x_pause = pause; };
/// defines whether we need to store ignored directories as empty
void set_empty_dir(bool empty_dir) { x_empty_dir = empty_dir; };
/// set the compression algorithm to be used
void set_compression(compression compr_algo) { x_compr_algo = compr_algo; };
/// set the compression level (from 1 to 9)
void set_compression_level(U_I compression_level) { x_compression_level = compression_level; };
/// define the archive slicing
/// \param[in] file_size set the slice size in byte (0 for a single slice whatever its size is)
/// \param[in] first_file_size set the first file size
/// \note if not specified or set to zero, first_file_size is considered equal to file_size
void set_slicing(const infinint & file_size, const infinint & first_file_size = 0)
{
x_file_size = file_size;
if(first_file_size.is_zero())
x_first_file_size = file_size;
else
x_first_file_size = first_file_size;
};
/// defines which Extended Attributes to save
void set_ea_mask(const mask & ea_mask);
/// set the command to execute after each slice creation
void set_execute(const std::string & execute) { x_execute = execute; };
/// set the cypher to use
void set_crypto_algo(crypto_algo crypto) { x_crypto = crypto; };
/// set the pass the password / passphrase to use. Giving an empty string makes the password asked
/// interactively through the dialog argument if encryption has been set.
void set_crypto_pass(const secu_string & pass) { x_pass = pass; };
/// set the size of the encryption by block to use
void set_crypto_size(U_32 crypto_size) { x_crypto_size = crypto_size; };
/// set the list of recipients that will be able to read the archive
/// \note this is based on GnuPG keyring and assumes the user running libdar has its keyring
/// containing for each recipient a valid public key. If a list of recipient is given the crypto_pass
/// (see above) is not used, but the crypto_algo stays used to encrypt the archive using a randomly generated key
/// which is encrypted using the public keys of the recipients and dropped that way encrypted inside the archive.
/// \note if crypto_algo is not set while a list of recipient is given, the crypto algo will default to blowfish
void set_gnupg_recipients(const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
/// the private keys matching the email of the provided list are used to sign the archive random key
void set_gnupg_signatories(const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
/// defines files to compress
void set_compr_mask(const mask & compr_mask);
/// defines file size under which to never compress
void set_min_compr_size(const infinint & min_compr_size) { x_min_compr_size = min_compr_size; };
/// defines whether to ignore files with the nodump flag set
void set_nodump(bool nodump) { x_nodump = nodump; };
/// defines whether to ignore files having a given EA
/// \note if ea_name is set to "" the default ea_name "user.libdar_no_backup" is used.
void set_exclude_by_ea(const std::string & ea_name)
{ exclude_by_ea = (ea_name == "" ? "user.libdar_no_backup" : ea_name); };
/// set the fields to consider when comparing inodes with reference archive (see cat_inode::comparison_fields enumeration in catalogue.hpp)
void set_what_to_check(cat_inode::comparison_fields what_to_check) { x_what_to_check = what_to_check; };
/// ignore differences of at most this integer number of hours while looking for changes in dates
void set_hourshift(const infinint & hourshift) { x_hourshift = hourshift; };
/// whether to make a dry-run operation
void set_empty(bool empty) { x_empty = empty; };
/// whether to alter atime or ctime in the filesystem when reading files to save
/// \param[in] alter_atime whether to change atime (true) or ctime (false)
/// \note this parameter is used only when furtive_read_mode() is not activated
void set_alter_atime(bool alter_atime)
{
if(x_furtive_read)
x_old_alter_atime = alter_atime;
else
x_alter_atime = alter_atime;
};
/// whether to use furtive read mode (if activated, alter_atime() has no meaning/use)
void set_furtive_read_mode(bool furtive_read)
{
NLS_SWAP_IN;
try
{
#if FURTIVE_READ_MODE_AVAILABLE_FOR_LIBDAR
x_furtive_read = furtive_read;
if(furtive_read)
{
x_old_alter_atime = x_alter_atime;
x_alter_atime = true;
// this is required to avoid libdar manipulating ctime of inodes
}
else
x_alter_atime = x_old_alter_atime;
#else
if(furtive_read)
throw Ecompilation(gettext("Furtive read mode"));
x_furtive_read = false;
#endif
}
catch(...)
{
NLS_SWAP_OUT;
throw;
}
NLS_SWAP_OUT;
};
/// whether to limit the backup to files located on the same filesystem as the directory taken as root of the backup
void set_same_fs(bool same_fs) { x_same_fs = same_fs; };
/// whether to make an emtpy archive only referencing the current state of files in the filesystem
void set_snapshot(bool snapshot) { x_snapshot = snapshot; };
/// whether to consider the Cache Directory Tagging Standard
void set_cache_directory_tagging(bool cache_directory_tagging) { x_cache_directory_tagging = cache_directory_tagging; };
/// whether to ignore any archive of reference and only save file which modification is more recent that the given "fixed_date". To not use this feature set fixed_date value of zero (which is the value by default)
void set_fixed_date(const infinint & fixed_date) { x_fixed_date = fixed_date; };
/// if not an empty string set the slice permission according to the octal value given.
void set_slice_permission(const std::string & slice_permission) { x_slice_permission = slice_permission; };
/// if not an empty string set the user ownership of slices accordingly
void set_slice_user_ownership(const std::string & slice_user_ownership) { x_slice_user_ownership = slice_user_ownership; };
/// if not an empty string set the group ownership of slices accordingly
void set_slice_group_ownership(const std::string & slice_group_ownership) { x_slice_group_ownership = slice_group_ownership; };
/// how much time to retry saving a file if it changed while being read
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; };
/// whether to add escape sequence aka tape marks to allow sequential reading of the archive
void set_sequential_marks(bool sequential) { x_sequential_marks = sequential; };
/// whether to try to detect sparse files
void set_sparse_file_min_size(const infinint & size) { x_sparse_file_min_size = size; };
/// whether to check for ctime changes since with the archive of reference
void set_security_check(bool check) { x_security_check = check; };
/// specify a user comment in the archive (always in clear text!)
void set_user_comment(const std::string & comment) { x_user_comment = comment; };
/// specify whether to produce a hash file of the slice and which hash algo to use
/// \note the libdar::hash_algo data type is defined in hash_fichier.hpp, valid values
/// are for examle libdar::hash_none, libdar::hash_md5, libdar::hash_sha1, libdar::hash_sha512...
void set_hash_algo(hash_algo hash) { x_hash = hash; };
/// defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
void set_slice_min_digits(infinint val) { x_slice_min_digits = val; };
/// defines the backup hook for files
void set_backup_hook(const std::string & execute, const mask & which_files);
/// whether to ignore unknown inode types instead of issuing a warning
void set_ignore_unknown_inode_type(bool val) { x_ignore_unknown = val; };
/// defines the protocol to use for slices
void set_entrepot(const entrepot & entr);
/// defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA activated at compilation time are considered)
void set_fsa_scope(const fsa_scope & scope) { x_scope = scope; };
/// whether libdar is allowed to spawn several threads to possibily work faster on multicore CPU (requires libthreadar)
void set_multi_threaded(bool val) { x_multi_threaded = val; };
/// whether to automatically zeroing negative dates read from the filesystem (just warn, don't ask whether to pursue)
void set_auto_zeroing_neg_dates(bool val) { x_auto_zeroing_neg_dates = val; };
/////////////////////////////////////////////////////////////////////
// getting methods
archive *get_reference() const { return x_ref_arch; };
const mask & get_selection() const { if(x_selection == nullptr) throw SRC_BUG; return *x_selection; };
const mask & get_subtree() const { if(x_subtree == nullptr) throw SRC_BUG; return *x_subtree; };
bool get_allow_over() const { return x_allow_over; };
bool get_warn_over() const { return x_warn_over; };
bool get_info_details() const { return x_info_details; };
bool get_display_treated() const { return x_display_treated; };
bool get_display_treated_only_dir() const { return x_display_treated_only_dir; };
bool get_display_skipped() const { return x_display_skipped; };
bool get_display_finished() const { return x_display_finished; };
const infinint & get_pause() const { return x_pause; };
bool get_empty_dir() const { return x_empty_dir; };
compression get_compression() const { return x_compr_algo; };
U_I get_compression_level() const { return x_compression_level; };
const infinint & get_slice_size() const { return x_file_size; };
const infinint & get_first_slice_size() const { return x_first_file_size; };
const mask & get_ea_mask() const { if(x_ea_mask == nullptr) throw SRC_BUG; return *x_ea_mask; };
const std::string & get_execute() const { return x_execute; };
crypto_algo get_crypto_algo() const { return x_crypto; };
const secu_string & get_crypto_pass() const { return x_pass; };
U_32 get_crypto_size() const { return x_crypto_size; };
const std::vector<std::string> & get_gnupg_recipients() const { return x_gnupg_recipients; };
const std::vector<std::string> & get_gnupg_signatories() const { return x_gnupg_signatories; };
const mask & get_compr_mask() const { if(x_compr_mask == nullptr) throw SRC_BUG; return *x_compr_mask; };
const infinint & get_min_compr_size() const { return x_min_compr_size; };
bool get_nodump() const { return x_nodump; };
const std::string & get_exclude_by_ea() const { return exclude_by_ea; };
cat_inode::comparison_fields get_comparison_fields() const { return x_what_to_check; };
const infinint & get_hourshift() const { return x_hourshift; };
bool get_empty() const { return x_empty; };
bool get_alter_atime() const { return x_alter_atime; };
bool get_furtive_read_mode() const { return x_furtive_read; };
bool get_same_fs() const { return x_same_fs; };
bool get_snapshot() const { return x_snapshot; };
bool get_cache_directory_tagging() const { return x_cache_directory_tagging; };
const infinint & get_fixed_date() const { return x_fixed_date; };
const std::string & get_slice_permission() const { return x_slice_permission; };
const std::string & get_slice_user_ownership() const { return x_slice_user_ownership; };
const std::string & get_slice_group_ownership() const { return x_slice_group_ownership; };
const infinint & get_repeat_count() const { return x_repeat_count; };
const infinint & get_repeat_byte() const { return x_repeat_byte; };
bool get_sequential_marks() const { return x_sequential_marks; };
infinint get_sparse_file_min_size() const { return x_sparse_file_min_size; };
bool get_security_check() const { return x_security_check; };
const std::string & get_user_comment() const { return x_user_comment; };
hash_algo get_hash_algo() const { return x_hash; };
infinint get_slice_min_digits() const { return x_slice_min_digits; };
const std::string & get_backup_hook_file_execute() const { return x_backup_hook_file_execute; };
const mask & get_backup_hook_file_mask() const { return *x_backup_hook_file_mask; };
bool get_ignore_unknown_inode_type() const { return x_ignore_unknown; };
const entrepot & get_entrepot() const { if(x_entrepot == nullptr) throw SRC_BUG; return *x_entrepot; };
const fsa_scope & get_fsa_scope() const { return x_scope; };
bool get_multi_threaded() const { return x_multi_threaded; };
bool get_auto_zeroing_neg_dates() const { return x_auto_zeroing_neg_dates; };
private:
archive *x_ref_arch; //< just contains the address of an existing object, no local copy of object is done here
mask * x_selection; //< points to a local copy of mask (must be allocated / releases by the archive_option_create object)
mask * x_subtree; //< points to a local copy of mask (must be allocated / releases by the archive_option_create objects)
bool x_allow_over;
bool x_warn_over;
bool x_info_details;
bool x_display_treated;
bool x_display_treated_only_dir;
bool x_display_skipped;
bool x_display_finished;
infinint x_pause;
bool x_empty_dir;
compression x_compr_algo;
U_I x_compression_level;
infinint x_file_size;
infinint x_first_file_size;
mask * x_ea_mask; //< points to a local copy of mask (must be allocated / releases by the archive_option_create objects)
std::string x_execute;
crypto_algo x_crypto;
secu_string x_pass;
U_32 x_crypto_size;
std::vector<std::string> x_gnupg_recipients;
std::vector<std::string> x_gnupg_signatories;
mask * x_compr_mask; //< points to a local copy of mask (must be allocated / releases by the archive_option_create objects)
infinint x_min_compr_size;
bool x_nodump;
std::string exclude_by_ea;
cat_inode::comparison_fields x_what_to_check;
infinint x_hourshift;
bool x_empty;
bool x_alter_atime;
bool x_old_alter_atime; //< used to backup origina alter_atime value when activating furtive read mode
bool x_furtive_read;
bool x_same_fs;
bool x_snapshot;
bool x_cache_directory_tagging;
infinint x_fixed_date;
std::string x_slice_permission;
std::string x_slice_user_ownership;
std::string x_slice_group_ownership;
infinint x_repeat_count;
infinint x_repeat_byte;
bool x_sequential_marks;
infinint x_sparse_file_min_size;
bool x_security_check;
std::string x_user_comment;
hash_algo x_hash;
infinint x_slice_min_digits;
mask * x_backup_hook_file_mask;
std::string x_backup_hook_file_execute;
bool x_ignore_unknown;
entrepot *x_entrepot;
fsa_scope x_scope;
bool x_multi_threaded;
bool x_auto_zeroing_neg_dates;
void destroy();
void copy_from(const archive_options_create & ref);
void destroy_mask(mask * & ptr);
void clean_mask(mask * & ptr);
void check_mask(const mask & m);
};
/////////////////////////////////////////////////////////
//////////// OPTIONS FOR ISOLATING A CATALOGUE //////////
/////////////////////////////////////////////////////////
/// class holding optional parameters used to isolate an existing archive
class archive_options_isolate : public on_pool
{
public:
archive_options_isolate() { x_entrepot = nullptr; clear(); };
archive_options_isolate(const archive_options_isolate & ref) { x_entrepot = nullptr; copy_from(ref); };
const archive_options_isolate & operator = (const archive_options_isolate & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_isolate() { destroy(); };
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
/// whether overwritting is allowed
void set_allow_over(bool allow_over) { x_allow_over = allow_over; };
/// whether a warning shall be issued before overwriting
void set_warn_over(bool warn_over) { x_warn_over = warn_over; };
/// whether the user needs detailed output of the operation
void set_info_details(bool info_details) { x_info_details = info_details; };
/// Pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each slice, set to 2 makes libdar pause each 2 slices and so on.
void set_pause(const infinint & pause) { x_pause = pause; };
/// the compression algorithm used
void set_compression(compression algo) { x_algo = algo; };
/// the compression level (from 1 to 9)
void set_compression_level(U_I compression_level) { x_compression_level = compression_level; };
/// define the archive slicing
/// \param[in] file_size set the slice size in byte (0 for a single slice whatever its size is)
/// \param[in] first_file_size set the first file size
/// \note if not specified or set to zero, first_file_size is considered equal to file_size
void set_slicing(const infinint & file_size, const infinint & first_file_size = 0)
{
x_file_size = file_size;
if(first_file_size.is_zero())
x_first_file_size = file_size;
else
x_first_file_size = first_file_size;
};
/// command to execute after each slice creation
void set_execute(const std::string & execute) { x_execute = execute; };
/// cypher to use
void set_crypto_algo(crypto_algo crypto) { x_crypto = crypto; };
/// password / passphrase to encrypt the data with (empty string for interactive question)
void set_crypto_pass(const secu_string & pass) { x_pass = pass; };
/// size of the encryption by block to use
void set_crypto_size(U_32 crypto_size) { x_crypto_size = crypto_size; };
/// set the list of recipients that will be able to read the archive
/// \note more details for the same option of archive_options_create
void set_gnupg_recipients(const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
/// the private keys matching the email of the provided list are used to sign the archive random key
void set_gnupg_signatories(const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
/// whether to make a dry-run operation
void set_empty(bool empty) { x_empty = empty; };
/// if not an empty string set the slice permission according to the octal value given.
void set_slice_permission(const std::string & slice_permission) { x_slice_permission = slice_permission; };
/// if not an empty string set the user ownership of slices accordingly
void set_slice_user_ownership(const std::string & slice_user_ownership) { x_slice_user_ownership = slice_user_ownership; };
/// if not an empty string set the group ownership of slices accordingly
void set_slice_group_ownership(const std::string & slice_group_ownership) { x_slice_group_ownership = slice_group_ownership; };
/// specify a user comment in the archive (always in clear text!)
void set_user_comment(const std::string & comment) { x_user_comment = comment; };
/// specify whether to produce a hash file of the slice and which hash algo to use
void set_hash_algo(hash_algo hash) { x_hash = hash; };
/// defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
void set_slice_min_digits(infinint val) { x_slice_min_digits = val; };
/// whether to add escape sequence aka tape marks to allow sequential reading of the archive
void set_sequential_marks(bool sequential) { x_sequential_marks = sequential; };
/// defines the protocol to use for slices
void set_entrepot(const entrepot & entr);
/// whether libdar is allowed to created several thread to work possibily faster on multicore CPU (require libthreadar)
void set_multi_threaded(bool val) { x_multi_threaded = val; };
/////////////////////////////////////////////////////////////////////
// getting methods
bool get_allow_over() const { return x_allow_over; };
bool get_warn_over() const { return x_warn_over; };
bool get_info_details() const { return x_info_details; };
const infinint & get_pause() const { return x_pause; };
compression get_compression() const { return x_algo; };
U_I get_compression_level() const { return x_compression_level; };
const infinint & get_slice_size() const { return x_file_size; };
const infinint & get_first_slice_size() const { return x_first_file_size; };
const std::string & get_execute() const { return x_execute; };
crypto_algo get_crypto_algo() const { return x_crypto; };
const secu_string & get_crypto_pass() const { return x_pass; };
U_32 get_crypto_size() const { return x_crypto_size; };
const std::vector<std::string> & get_gnupg_recipients() const { return x_gnupg_recipients; };
const std::vector<std::string> & get_gnupg_signatories() const { return x_gnupg_signatories; };
bool get_empty() const { return x_empty; };
const std::string & get_slice_permission() const { return x_slice_permission; };
const std::string & get_slice_user_ownership() const { return x_slice_user_ownership; };
const std::string & get_slice_group_ownership() const { return x_slice_group_ownership; };
const std::string & get_user_comment() const { return x_user_comment; };
hash_algo get_hash_algo() const { return x_hash; };
infinint get_slice_min_digits() const { return x_slice_min_digits; };
bool get_sequential_marks() const { return x_sequential_marks; };
const entrepot & get_entrepot() const { if(x_entrepot == nullptr) throw SRC_BUG; return *x_entrepot; };
bool get_multi_threaded() const { return x_multi_threaded; };
private:
bool x_allow_over;
bool x_warn_over;
bool x_info_details;
infinint x_pause;
compression x_algo;
U_I x_compression_level;
infinint x_file_size;
infinint x_first_file_size;
std::string x_execute;
crypto_algo x_crypto;
secu_string x_pass;
U_32 x_crypto_size;
std::vector<std::string> x_gnupg_recipients;
std::vector<std::string> x_gnupg_signatories;
bool x_empty;
std::string x_slice_permission;
std::string x_slice_user_ownership;
std::string x_slice_group_ownership;
std::string x_user_comment;
hash_algo x_hash;
infinint x_slice_min_digits;
bool x_sequential_marks;
entrepot *x_entrepot;
bool x_multi_threaded;
void copy_from(const archive_options_isolate & ref);
void destroy();
};
/////////////////////////////////////////////////////////
////////// OPTONS FOR MERGING ARCHIVES //////////////////
/////////////////////////////////////////////////////////
/// class holding optional parameters used to proceed to the merge operation
class archive_options_merge : public on_pool
{
public:
archive_options_merge() { x_selection = x_subtree = x_ea_mask = x_compr_mask = nullptr; x_overwrite = nullptr; x_entrepot = nullptr; clear(); };
archive_options_merge(const archive_options_merge & ref) { copy_from(ref); };
const archive_options_merge & operator = (const archive_options_merge & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_merge() { destroy(); };
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
void set_auxilliary_ref(archive *ref) { x_ref = ref; };
/// defines the filenames to only save (except directory) as those that match the given mask
void set_selection(const mask & selection);
/// defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
void set_subtree(const mask & subtree);
/// defines whether overwritting is allowed or not
void set_allow_over(bool allow_over) { x_allow_over = allow_over; };
/// defines whether a warning shall be issued before overwriting
void set_warn_over(bool warn_over) { x_warn_over = warn_over; };
/// policy to solve merging conflict
void set_overwriting_rules(const crit_action & overwrite);
/// defines whether the user needs detailed output of the operation
///
/// \note in API 5.5.x and before this switch drove the displaying
/// of processing messages and treated files. now it only drives the
/// display of processing messages, use set_display_treated to define
/// whether files under treatement should be display or not
void set_info_details(bool info_details) { x_info_details = info_details; };
/// defines whether to show treated files
///
/// \param[in] display_treated true to display processed inodes
/// \param[in] only_dir only display the current directory under processing, not its individual files
void set_display_treated(bool display_treated, bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
/// whether to display files that have been excluded by filters
void set_display_skipped(bool display_skipped) { x_display_skipped = display_skipped; };
/// set a pause beteween slices. Set to zero does not pause at all, set to 1 makes libdar pauses each slice, set to 2 makes libdar pause each 2 slices and so on.
void set_pause(const infinint & pause) { x_pause = pause; };
/// defines whether we need to store ignored directories as empty
void set_empty_dir(bool empty_dir) { x_empty_dir = empty_dir; };
/// set the compression algorithm to be used
void set_compression(compression compr_algo) { x_compr_algo = compr_algo; };
/// set the compression level (from 1 to 9)
void set_compression_level(U_I compression_level) { x_compression_level = compression_level; };
/// define the archive slicing
/// \param[in] file_size set the slice size in byte (0 for a single slice whatever its size is)
/// \param[in] first_file_size set the first file size
/// \note if not specified or set to zero, first_file_size is considered equal to file_size
void set_slicing(const infinint & file_size, const infinint & first_file_size = 0)
{
x_file_size = file_size;
if(first_file_size.is_zero())
x_first_file_size = file_size;
else
x_first_file_size = first_file_size;
};
/// defines which Extended Attributes to save
void set_ea_mask(const mask & ea_mask);
/// set the command to execute after each slice creation
void set_execute(const std::string & execute) { x_execute = execute; };
/// set the cypher to use
void set_crypto_algo(crypto_algo crypto) { x_crypto = crypto; };
/// set the pass the password / passphrase to use. Giving an empty string makes the password asked
/// interactively through the dialog argument if encryption has been set.
void set_crypto_pass(const secu_string & pass) { x_pass = pass; };
/// set the size of the encryption by block to use
void set_crypto_size(U_32 crypto_size) { x_crypto_size = crypto_size; };
/// set the list of recipients that will be able to read the archive
/// \note more details for the same option of archive_options_create
void set_gnupg_recipients(const std::vector<std::string> & gnupg_recipients) { x_gnupg_recipients = gnupg_recipients; };
/// the private keys matching the email of the provided list are used to sign the archive random key
void set_gnupg_signatories(const std::vector<std::string> & gnupg_signatories) { x_gnupg_signatories = gnupg_signatories; };
/// defines files to compress
void set_compr_mask(const mask & compr_mask);
/// defines file size under which to never compress
void set_min_compr_size(const infinint & min_compr_size) { x_min_compr_size = min_compr_size; };
/// defines whether we do a dry-run execution
void set_empty(bool empty) { x_empty = empty; };
/// make dar ignore the 'algo' argument and do not uncompress / compress files that are selected for merging
void set_keep_compressed(bool keep_compressed) { x_keep_compressed = keep_compressed; };
/// if not an empty string set the slice permission according to the octal value given.
void set_slice_permission(const std::string & slice_permission) { x_slice_permission = slice_permission; };
/// if not an empty string set the user ownership of slices accordingly
void set_slice_user_ownership(const std::string & slice_user_ownership) { x_slice_user_ownership = slice_user_ownership; };
/// if not an empty string set the group ownership of slices accordingly
void set_slice_group_ownership(const std::string & slice_group_ownership) { x_slice_group_ownership = slice_group_ownership; };
/// if set to true use a merging mode suitable to build a decremental backup from two full backups (see Notes)
void set_decremental_mode(bool mode) { x_decremental = mode; };
/// whether to activate escape sequence aka tape marks to allow sequential reading of the archive
void set_sequential_marks(bool sequential) { x_sequential_marks = sequential; };
/// whether to try to detect sparse files
void set_sparse_file_min_size(const infinint & size) { x_sparse_file_min_size = size; };
/// specify a user comment in the archive (always in clear text!)
void set_user_comment(const std::string & comment) { x_user_comment = comment; };
/// specify whether to produce a hash file of the slice and which hash algo to use
void set_hash_algo(hash_algo hash) { x_hash = hash; };
/// defines the minimum digit a slice must have concerning its number, zeros will be prepended as much as necessary to respect this
void set_slice_min_digits(infinint val) { x_slice_min_digits = val; };
/// defines the protocol to use for slices
void set_entrepot(const entrepot & entr);
/// defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA are considered)
void set_fsa_scope(const fsa_scope & scope) { x_scope = scope; };
/// whether libdar is allowed to spawn several threads to possibily work faster on multicore CPU (requires libthreadar)
void set_multi_threaded(bool val) { x_multi_threaded = val; };
/////////////////////////////////////////////////////////////////////
// getting methods
archive * get_auxilliary_ref() const { return x_ref; };
const mask & get_selection() const { if(x_selection == nullptr) throw SRC_BUG; return *x_selection; };
const mask & get_subtree() const { if(x_subtree == nullptr) throw SRC_BUG; return *x_subtree; };
bool get_allow_over() const { return x_allow_over; };
bool get_warn_over() const { return x_warn_over; };
const crit_action & get_overwriting_rules() const { if(x_overwrite == nullptr) throw SRC_BUG; return *x_overwrite; };
bool get_info_details() const { return x_info_details; };
bool get_display_treated() const { return x_display_treated; };
bool get_display_treated_only_dir() const { return x_display_treated_only_dir; };
bool get_display_skipped() const { return x_display_skipped; };
const infinint & get_pause() const { return x_pause; };
bool get_empty_dir() const { return x_empty_dir; };
compression get_compression() const { return x_compr_algo; };
U_I get_compression_level() const { return x_compression_level; };
const infinint & get_slice_size() const { return x_file_size; };
const infinint & get_first_slice_size() const { return x_first_file_size; };
const mask & get_ea_mask() const { if(x_ea_mask == nullptr) throw SRC_BUG; return *x_ea_mask; };
const std::string & get_execute() const { return x_execute; };
crypto_algo get_crypto_algo() const { return x_crypto; };
const secu_string & get_crypto_pass() const { return x_pass; };
U_32 get_crypto_size() const { return x_crypto_size; };
const std::vector<std::string> & get_gnupg_recipients() const { return x_gnupg_recipients; };
const std::vector<std::string> & get_gnupg_signatories() const { return x_gnupg_signatories; };
const mask & get_compr_mask() const { if(x_compr_mask == nullptr) throw SRC_BUG; return *x_compr_mask; };
const infinint & get_min_compr_size() const { return x_min_compr_size; };
bool get_empty() const { return x_empty; };
bool get_keep_compressed() const { return x_keep_compressed; };
const std::string & get_slice_permission() const { return x_slice_permission; };
const std::string & get_slice_user_ownership() const { return x_slice_user_ownership; };
const std::string & get_slice_group_ownership() const { return x_slice_group_ownership; };
bool get_decremental_mode() const { return x_decremental; };
bool get_sequential_marks() const { return x_sequential_marks; };
infinint get_sparse_file_min_size() const { return x_sparse_file_min_size; };
const std::string & get_user_comment() const { return x_user_comment; };
hash_algo get_hash_algo() const { return x_hash; };
infinint get_slice_min_digits() const { return x_slice_min_digits; };
const entrepot & get_entrepot() const { if(x_entrepot == nullptr) throw SRC_BUG; return *x_entrepot; };
const fsa_scope & get_fsa_scope() const { return x_scope; };
bool get_multi_threaded() const { return x_multi_threaded; };
private:
archive * x_ref; //< points to an external existing object, must never be deleted by "this"
mask * x_selection;
mask * x_subtree;
bool x_allow_over;
bool x_warn_over;
crit_action * x_overwrite;
bool x_info_details;
bool x_display_treated;
bool x_display_treated_only_dir;
bool x_display_skipped;
infinint x_pause;
bool x_empty_dir;
compression x_compr_algo;
U_I x_compression_level;
infinint x_file_size;
infinint x_first_file_size;
mask * x_ea_mask;
std::string x_execute;
crypto_algo x_crypto;
secu_string x_pass;
U_32 x_crypto_size;
std::vector<std::string> x_gnupg_recipients;
std::vector<std::string> x_gnupg_signatories;
mask * x_compr_mask;
infinint x_min_compr_size;
bool x_empty;
bool x_keep_compressed;
std::string x_slice_permission;
std::string x_slice_user_ownership;
std::string x_slice_group_ownership;
bool x_decremental;
bool x_sequential_marks;
infinint x_sparse_file_min_size;
std::string x_user_comment;
hash_algo x_hash;
infinint x_slice_min_digits;
entrepot *x_entrepot;
fsa_scope x_scope;
bool x_multi_threaded;
void destroy();
void copy_from(const archive_options_merge & ref);
};
/////////////////////////////////////////////////////////
////////// OPTONS FOR EXTRACTING FILES FROM ARCHIVE /////
/////////////////////////////////////////////////////////
/// class holding optional parameters used to extract files from an existing archive
class archive_options_extract : public on_pool
{
public:
enum t_dirty { dirty_ignore, dirty_warn, dirty_ok };
archive_options_extract() { x_selection = x_subtree = x_ea_mask = nullptr; x_overwrite = nullptr; clear(); };
archive_options_extract(const archive_options_extract & ref) { copy_from(ref); };
const archive_options_extract & operator = (const archive_options_extract & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_extract() { destroy(); };
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
/// defines the filenames to only save (except directory) as those that match the given mask
void set_selection(const mask & selection);
/// defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
void set_subtree(const mask & subtree);
/// defines whether a warning shall be issued before overwriting
void set_warn_over(bool warn_over) { x_warn_over = warn_over; };
/// defines whether the user needs detailed output of the operation
///
/// \note in API 5.5.x and before this switch drove the displaying
/// of processing messages and treated files. now it only drives the
/// display of processing messages, use set_display_treated to define
/// whether files under treatement should be display or not
void set_info_details(bool info_details) { x_info_details = info_details; };
/// defines whether to show treated files
/// \param[in] display_treated true to display processed inodes
/// \param[in] only_dir only display the current directory under processing, not its individual files
void set_display_treated(bool display_treated, bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
/// whether to display files that have been excluded by filters
void set_display_skipped(bool display_skipped) { x_display_skipped = display_skipped; };
/// defines which Extended Attributes to save
void set_ea_mask(const mask & ea_mask);
/// whether to ignore directory structure and restore all files in the same directory
void set_flat(bool flat) { x_flat = flat; };
/// fields to consider when comparing inodes with those on filesystem to determine if it is more recent (see cat_inode::comparison_fields enumeration), also defines whether mtime has to be restored (cf_mtime) whether permission have to be too (cf_ignore_owner) whether ownership has to be restored too (cf_all)
void set_what_to_check(cat_inode::comparison_fields what_to_check) { x_what_to_check = what_to_check; };
/// whether a warning must be issue if a file to remove does not match the expected type of file
void set_warn_remove_no_match(bool warn_remove_no_match) { x_warn_remove_no_match = warn_remove_no_match; };
/// defines whether we need to store ignored directories as empty
void set_empty(bool empty) { x_empty = empty; };
/// whether to restore directories where no file has been triggered for backup (no file/inode change, excluded files,...)
void set_empty_dir(bool empty_dir) { x_empty_dir = empty_dir; };
/// whether to restore dirty files (those that changed during backup), warn before restoring or ignoring them
///\param[in] ignore if set to true, dirty files are not restored at all
///\param[in] warn useless if ignored is false. If warn is true, a warning is issued before restoring each dirty file (default behavior)
void set_dirty_behavior(bool ignore, bool warn) { x_dirty = ignore ? dirty_ignore : (warn ? dirty_warn : dirty_ok); };
/// alternative method to modify dirty behavior
void set_dirty_behavior(t_dirty val) { x_dirty = val; };
/// overwriting policy
void set_overwriting_rules(const crit_action & over);
/// only consider deleted files (if set, no data get restored)
/// \note setting both set_only_deleted() and set_ignore_deleted() will not restore anything, almost equivalent to a dry-run execution
void set_only_deleted(bool val) { x_only_deleted = val; };
/// do not consider deleted files (if set, no inode will be removed)
/// \note setting both set_only_deleted() and set_ignore_deleted() will not restore anything, almost equivalent to a dry-run execution
void set_ignore_deleted(bool val) { x_ignore_deleted = val; };
/// defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA activated at compilation time are considered)
void set_fsa_scope(const fsa_scope & scope) { x_scope = scope; };
/////////////////////////////////////////////////////////////////////
// getting methods
const mask & get_selection() const { if(x_selection == nullptr) throw SRC_BUG; return *x_selection; };
const mask & get_subtree() const { if(x_subtree == nullptr) throw SRC_BUG; return *x_subtree; };
bool get_warn_over() const { return x_warn_over; };
bool get_info_details() const { return x_info_details; };
bool get_display_treated() const { return x_display_treated; };
bool get_display_treated_only_dir() const { return x_display_treated_only_dir; };
bool get_display_skipped() const { return x_display_skipped; };
const mask & get_ea_mask() const { if(x_ea_mask == nullptr) throw SRC_BUG; return *x_ea_mask; };
bool get_flat() const { return x_flat; };
cat_inode::comparison_fields get_what_to_check() const { return x_what_to_check; };
bool get_warn_remove_no_match() const { return x_warn_remove_no_match; };
bool get_empty() const { return x_empty; };
bool get_empty_dir() const { return x_empty_dir; };
t_dirty get_dirty_behavior() const { return x_dirty; }
const crit_action & get_overwriting_rules() const { if(x_overwrite == nullptr) throw SRC_BUG; return *x_overwrite; };
bool get_only_deleted() const { return x_only_deleted; };
bool get_ignore_deleted() const { return x_ignore_deleted; };
const fsa_scope & get_fsa_scope() const { return x_scope; };
private:
mask * x_selection;
mask * x_subtree;
bool x_warn_over;
bool x_info_details;
bool x_display_treated;
bool x_display_treated_only_dir;
bool x_display_skipped;
mask * x_ea_mask;
bool x_flat;
cat_inode::comparison_fields x_what_to_check;
bool x_warn_remove_no_match;
bool x_empty;
bool x_empty_dir;
t_dirty x_dirty;
crit_action *x_overwrite;
bool x_only_deleted;
bool x_ignore_deleted;
fsa_scope x_scope;
void destroy();
void copy_from(const archive_options_extract & ref);
};
/////////////////////////////////////////////////////////
////////// OPTIONS FOR LISTING AN ARCHIVE ///////////////
/////////////////////////////////////////////////////////
/// class holding optional parameters used to list the contents of an existing archive
class archive_options_listing : public on_pool
{
public:
archive_options_listing() { x_selection = x_subtree = nullptr; x_slicing_first = x_slicing_others = nullptr; clear(); };
archive_options_listing(const archive_options_listing & ref) { copy_from(ref); };
const archive_options_listing & operator = (const archive_options_listing & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_listing() { destroy(); };
void clear();
/// defines the way archive listing is done:
enum listformat
{
normal, //< the tar-like listing (this is the default)
tree, //< the original dar's tree listing (for those that like forest)
xml, //< the xml catalogue output
slicing //< the slicing output (give info about where files are located)
};
/////////////////////////////////////////////////////////////////////
// setting methods
void set_info_details(bool info_details) { x_info_details = info_details; };
void set_list_mode(listformat list_mode) { x_list_mode = list_mode; };
void set_selection(const mask & selection);
void set_subtree(const mask & subtree);
void set_filter_unsaved(bool filter_unsaved) { x_filter_unsaved = filter_unsaved; };
void set_display_ea(bool display_ea) { x_display_ea = display_ea; };
void set_user_slicing(const infinint & slicing_first, const infinint & slicing_others);
void set_sizes_in_bytes(bool arg) { x_sizes_in_bytes = arg; };
/////////////////////////////////////////////////////////////////////
// getting methods
bool get_info_details() const { return x_info_details; };
listformat get_list_mode() const { return x_list_mode; };
const mask & get_selection() const;
const mask & get_subtree() const;
bool get_filter_unsaved() const { return x_filter_unsaved; };
bool get_display_ea() const { return x_display_ea; };
bool get_user_slicing(infinint & slicing_first, infinint & slicing_others) const;
bool get_sizes_in_bytes() const { return x_sizes_in_bytes; };
private:
bool x_info_details;
listformat x_list_mode;
mask * x_selection;
mask * x_subtree;
bool x_filter_unsaved;
bool x_display_ea;
infinint *x_slicing_first;
infinint *x_slicing_others;
bool x_sizes_in_bytes;
void destroy();
void copy_from(const archive_options_listing & ref);
};
/////////////////////////////////////////////////////////
////////// OPTONS FOR DIFFING AN ARCHIVE ////////////////
/////////////////////////////////////////////////////////
class archive_options_diff : public on_pool
{
public:
archive_options_diff() { x_selection = x_subtree = x_ea_mask = nullptr; clear(); };
archive_options_diff(const archive_options_diff & ref) { copy_from(ref); };
const archive_options_diff & operator = (const archive_options_diff & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_diff() { destroy(); };
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
/// list of filenames to consider (directory not concerned by this fiter)
void set_selection(const mask & selection);
/// defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
void set_subtree(const mask & subtree);
/// whether the user needs detailed output of the operation
///
/// \note in API 5.5.x and before this switch drove the displaying
/// of processing messages and treated files. now it only drives the
/// display of processing messages, use set_display_treated to define
/// whether files under treatement should be display or not
void set_info_details(bool info_details) { x_info_details = info_details; };
/// defines whether to show treated files
/// \param[in] display_treated true to display processed inodes
/// \param[in] only_dir only display the current directory under processing, not its individual files
void set_display_treated(bool display_treated, bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
/// whether to display files that have been excluded by filters
void set_display_skipped(bool display_skipped) { x_display_skipped = display_skipped; };
/// defines the Extended Attributes to compare
void set_ea_mask(const mask & ea_mask);
/// fields to consider wien comparing inodes with those on filesystem (see cat_inode::comparison_fields enumeration in catalogue.hpp)
void set_what_to_check(cat_inode::comparison_fields what_to_check) { x_what_to_check = what_to_check; };
/// whether to alter atime or ctime in the filesystem when reading files to compare
/// \param[in] alter_atime whether to change atime (true) or ctime (false)
/// \note this parameter is used only when furtive_read_mode() is not activated
void set_alter_atime(bool alter_atime)
{
if(x_furtive_read)
x_old_alter_atime = alter_atime;
else
x_alter_atime = alter_atime;
};
/// whether to use furtive read mode (if activated, alter_atime() has no meaning/use)
void set_furtive_read_mode(bool furtive_read);
/// ignore differences of at most this integer number of hours while looking for changes in dates
void set_hourshift(const infinint & hourshift) { x_hourshift = hourshift; };
/// whether to compare symlink mtime (symlink mtime)
void set_compare_symlink_date(bool compare_symlink_date) { x_compare_symlink_date = compare_symlink_date; };
/// defines the FSA (Filesystem Specific Attribute) to only consider (by default all FSA activated at compilation time are considered)
void set_fsa_scope(const fsa_scope & scope) { x_scope = scope; };
/////////////////////////////////////////////////////////////////////
// getting methods
const mask & get_selection() const { if(x_selection == nullptr) throw SRC_BUG; return *x_selection; };
const mask & get_subtree() const { if(x_subtree == nullptr) throw SRC_BUG; return *x_subtree; };
bool get_info_details() const { return x_info_details; };
bool get_display_treated() const { return x_display_treated; };
bool get_display_treated_only_dir() const { return x_display_treated_only_dir; };
bool get_display_skipped() const { return x_display_skipped; };
const mask & get_ea_mask() const { if(x_ea_mask == nullptr) throw SRC_BUG; return *x_ea_mask; };
cat_inode::comparison_fields get_what_to_check() const { return x_what_to_check; };
bool get_alter_atime() const { return x_alter_atime; };
bool get_furtive_read_mode() const { return x_furtive_read; };
const infinint & get_hourshift() const { return x_hourshift; };
bool get_compare_symlink_date() const { return x_compare_symlink_date; };
const fsa_scope & get_fsa_scope() const { return x_scope; };
private:
mask * x_selection;
mask * x_subtree;
bool x_info_details;
bool x_display_treated;
bool x_display_treated_only_dir;
bool x_display_skipped;
mask * x_ea_mask;
cat_inode::comparison_fields x_what_to_check;
bool x_alter_atime;
bool x_old_alter_atime;
bool x_furtive_read;
infinint x_hourshift;
bool x_compare_symlink_date;
fsa_scope x_scope;
void destroy();
void copy_from(const archive_options_diff & ref);
};
/////////////////////////////////////////////////////////
////////// OPTONS FOR TESTING AN ARCHIVE ////////////////
/////////////////////////////////////////////////////////
/// class holding optional parameters used to test the structure coherence of an existing archive
class archive_options_test : public on_pool
{
public:
archive_options_test() { x_selection = x_subtree = nullptr; clear(); };
archive_options_test(const archive_options_test & ref) { copy_from(ref); };
const archive_options_test & operator = (const archive_options_test & ref) { destroy(); copy_from(ref); return *this; };
~archive_options_test() { destroy(); };
void clear();
/////////////////////////////////////////////////////////////////////
// setting methods
/// list of filenames to consider (directory not concerned by this fiter)
void set_selection(const mask & selection);
/// defines the directory and files to consider (this mask will be applied to the absolute path of files being proceeded)
void set_subtree(const mask & subtree);
/// whether the user needs detailed output of the operation
///
/// \note in API 5.5.x and before this switch drove the displaying
/// of processing messages and treated files. now it only drives the
/// display of processing messages, use set_display_treated to define
/// whether files under treatement should be display or not
void set_info_details(bool info_details) { x_info_details = info_details; };
/// whether to display files that have been excluded by filters
void set_display_skipped(bool display_skipped) { x_display_skipped = display_skipped; };
/// defines whether to show treated files
/// \param[in] display_treated true to display processed inodes
/// \param[in] only_dir only display the current directory under processing, not its individual files
void set_display_treated(bool display_treated, bool only_dir) { x_display_treated = display_treated; x_display_treated_only_dir = only_dir; };
/// dry-run exectution if set to true
void set_empty(bool empty) { x_empty = empty; };
/////////////////////////////////////////////////////////////////////
// getting methods
const mask & get_selection() const { if(x_selection == nullptr) throw SRC_BUG; return *x_selection; };
const mask & get_subtree() const { if(x_subtree == nullptr) throw SRC_BUG; return *x_subtree; };
bool get_info_details() const { return x_info_details; };
bool get_display_treated() const { return x_display_treated; };
bool get_display_treated_only_dir() const { return x_display_treated_only_dir; };
bool get_display_skipped() const { return x_display_skipped; };
bool get_empty() const { return x_empty; };
private:
mask * x_selection;
mask * x_subtree;
bool x_info_details;
bool x_display_treated;
bool x_display_treated_only_dir;
bool x_display_skipped;
bool x_empty;
void destroy();
void copy_from(const archive_options_test & ref);
};
/// @}
} // end of namespace
#endif
|