command_line.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2025 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// to contact the author, see the AUTHOR file
/*********************************************************************/
 
 
#ifndef COMMAND_LINE_HPP
#define COMMAND_LINE_HPP
 
#include "../my_config.h"
#include <string>
#include <deque>
#include <vector>
#include "libdar.hpp"
 
using namespace std;
using namespace libdar;
 
 
enum operation { noop, extract, create, diff, test, listing, isolate, merging, version_or_help, repairing };
    // noop stands for no-operation. get_args() never returns such value,
    // it is just necessary within the command_line module
 
enum dirty_behavior { dirtyb_ignore, dirtyb_warn, dirtyb_ok };
 
struct ent_params
{
    string ent_proto;             
    string ent_login;             
    secu_string ent_pass;         
    string ent_host;              
    string ent_port;              
    U_I network_retry;            
    bool auth_from_file;          
 
    void clear()
    {   ent_proto.clear(); ent_login.clear(); ent_pass.clear();
    ent_host.clear(); ent_port.clear(); network_retry = 3;
    auth_from_file = false; };
};
 
struct line_param
{
    operation op;                 
    path * fs_root;               
    path * sauv_root;             
    string filename;              
    path * ref_root;              
    string * ref_filename;        
    infinint file_size;           
    infinint first_file_size;     
    mask * selection;             
    mask * subtree;               
    bool allow_over;              
    bool warn_over;               
    bool info_details;            
    bool display_treated;         
    bool display_treated_only_dir;
    bool display_skipped;         
    bool display_finished;        
    bool display_masks;           
    compression algo;             
    U_I compression_level;        
    U_I compression_block_size;   
    infinint pause;               
    bool beep;                    
    bool empty_dir;               
    mask * ea_mask;               
    string input_pipe;            
    string output_pipe;           
    comparison_fields what_to_check; 
    string execute;               
    string execute_ref;           
    secu_string pass;             
    vector<string> signatories;   
    bool blind_signatures;        
    secu_string pass_ref;         
    mask * compress_mask;         
    bool flat;                    
    infinint min_compr_size;      
    bool nodump;                  
    bool exclude_by_ea;           
    string ea_name_for_exclusion; 
    infinint hourshift;           
    bool warn_remove_no_match;    
    bool filter_unsaved;          
    bool empty;                   
    bool alter_atime;             
    bool same_fs;                 
    deque<string> same_fs_incl;   
    deque<string> same_fs_excl;   
    bool snapshot;                
    bool cache_directory_tagging; 
    U_32 crypto_size;             
    U_32 crypto_size_ref;         
    archive_options_listing_shell::listformat list_mode; 
    path * aux_root;              
    string * aux_filename;        
    secu_string aux_pass;         
    string aux_execute;           
    U_32 aux_crypto_size;         
    bool keep_compressed;         
    infinint fixed_date;          
    bool quiet;                   
    bool quiet_crypto;            
    const crit_action * overwrite;
    string slice_perm;            
    string slice_user;            
    string slice_group;           
    infinint repeat_count;        
    infinint repeat_byte;         
    bool decremental;             
    bool furtive_read_mode;       
    bool lax;                     
    bool use_sequential_marks;    
    bool sequential_read;         
    infinint sparse_file_min_size;
    dirty_behavior dirty;         
    bool  security_check;         
    string user_comment;          
    hash_algo hash;               
    infinint num_digits;          
    infinint ref_num_digits;      
    infinint aux_num_digits;      
    bool only_deleted;            
    bool not_deleted;             
    mask * backup_hook_mask;      
    string backup_hook_execute;   
    bool list_ea;                 
    bool ignore_unknown_inode;    
    bool no_compare_symlink_date; 
    fsa_scope scope;              
    U_I multi_threaded_crypto;    
    U_I multi_threaded_compress;  
    bool delta_sig;               
    mask *delta_mask;             
    bool delta_diff;              
    infinint delta_sig_min_size;  
    ent_params remote;            
    ent_params ref_remote;        
    ent_params aux_remote;        
    bool remote_verbose;          
    bool sizes_in_bytes;          
    bool header_only;             
    bool zeroing_neg_dates;       
    string ignored_as_symlink;    
    modified_data_detection modet;
    infinint iteration_count;     
    hash_algo kdf_hash;           
    delta_sig_block_size delta_sig_len; 
    bool unix_sockets;            
    bool in_place;                
    bool never_resave_uncompr;    
    bool force_first_slice;       
    bool fully_detailed_dates;    
    bool isolation_repair;        
    bool extract_from_database;   
 
    // constructor for line_param
    line_param()
    {
    fs_root = nullptr;
    sauv_root = nullptr;
    ref_root = nullptr;
    selection = nullptr;
    subtree = nullptr;
    ref_filename = nullptr;
    ea_mask = nullptr;
    compress_mask = nullptr;
    aux_root = nullptr;
    aux_filename = nullptr;
    overwrite = nullptr;
    backup_hook_mask = nullptr;
    };
 
    // destructor for line_param
    ~line_param()
    {
    if(fs_root != nullptr)
        delete fs_root;
    if(sauv_root != nullptr)
        delete sauv_root;
    if(ref_root != nullptr)
        delete ref_root;
    if(selection != nullptr)
        delete selection;
    if(subtree != nullptr)
        delete subtree;
    if(ref_filename != nullptr)
        delete ref_filename;
    if(ea_mask != nullptr)
        delete ea_mask;
    if(compress_mask != nullptr)
        delete compress_mask;
    if(aux_root != nullptr)
        delete aux_root;
    if(aux_filename != nullptr)
        delete aux_filename;
    if(overwrite != nullptr)
        delete overwrite;
    if(backup_hook_mask != nullptr)
        delete backup_hook_mask;
    };
};
 
 
extern bool get_args(shared_ptr<user_interaction> & dialog,
             const char *home,
             const deque<string> & dar_dcf_path,
             const deque<string> & dar_duc_path,
                     S_I argc,
             char * const argv[],
             line_param & param);
 
 
#if HAVE_GETOPT_LONG
const struct option *get_long_opt();
#endif
 
const char *get_short_opt();
 
 
#endif