filesystem_restore.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2024 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 FILESYSTEM_RESTORE_HPP
#define FILESYSTEM_RESTORE_HPP
 
#include "../my_config.h"
 
extern "C"
{
#if HAVE_UNISTD_H
#include <unistd.h>
#endif
 
#if HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif
} // end extern "C"
 
#include <deque>
#include "crit_action.hpp"
#include "fsa_family.hpp"
#include "cat_all_entrees.hpp"
#include "filesystem_hard_link_read.hpp"
#include "filesystem_hard_link_write.hpp"
 
#include <set>
 
namespace libdar
{
 
 
    class filesystem_restore : public filesystem_hard_link_write, public filesystem_hard_link_read
    {
    public:
        filesystem_restore(const std::shared_ptr<user_interaction> & dialog,
               const path & root,
               bool x_warn_overwrite,
               bool x_info_details,
                           const mask & x_ea_mask,
               comparison_fields what_to_check,
               bool x_warn_remove_no_match,
               bool empty,
               const crit_action *x_overwrite,
               bool x_only_overwrite,
               const fsa_scope & scope);
 
        filesystem_restore(const filesystem_restore & ref) = delete;
 
    filesystem_restore(filesystem_restore && ref) = delete;
 
        filesystem_restore & operator = (const filesystem_restore  & ref) = delete;
 
    filesystem_restore & operator = (filesystem_restore && ref) = delete;
 
        ~filesystem_restore() { restore_stack_dir_ownership(); detruire(); };
 
        void reset_write();
 
    using action_done_for_data = enum
    {
        done_data_restored,     //< data has been restored to filesystem
        done_no_change_no_data, //< no change in filesystem because no data present in archive
        done_no_change_policy,  //< no change in filesystem because of overwiting policy decision
        done_data_removed       //< data (= whole inode) removed from filesystem
    };
 
 
    void write(const cat_entree *x,
           action_done_for_data & data_restored,
           bool & ea_restored,
           bool & data_created,
           bool & hard_link,
           bool & fsa_restored);
 
 
 
    void ignore_overwrite_restrictions_for_next_write() { ignore_over_restricts = true; };
 
 
    private:
    class stack_dir_t : public cat_directory
    {
    public:
        stack_dir_t(const cat_directory & ref, bool restore) : cat_directory(ref) { restore_date = restore; };
 
        bool get_restore_date() const { return restore_date; };
        void set_restore_date(bool val) { restore_date = val; };
 
    private:
        bool restore_date;
    };
 
        path *fs_root;
        bool info_details;
    mask *ea_mask;
        bool warn_overwrite;
    comparison_fields what_to_check;
    bool warn_remove_no_match;
        std::deque<stack_dir_t> stack_dir;
        path *current_dir;
    bool empty;
    bool ignore_over_restricts;
    const crit_action *overwrite;
    bool only_overwrite;
 
        void detruire();
    void restore_stack_dir_ownership();
    user_interaction & get_ui() const { return filesystem_hard_link_read::get_ui(); };
    std::shared_ptr<user_interaction> get_pointer() const { return filesystem_hard_link_read::get_pointer(); };
 
        // subroutines of write()
 
    void action_over_remove(const cat_inode *in_place,
                const cat_detruit *to_be_added,
                const std::string & spot,
                over_action_data action);
    void action_over_data(const cat_inode *in_place,
                  const cat_nomme *to_be_added,
                  const std::string & spot,
                  over_action_data action,
                  action_done_for_data & data_done);
    bool action_over_ea(const cat_inode *in_place,
                const cat_nomme *to_be_added,
                const std::string & spot,
                over_action_ea action);
    bool action_over_fsa(const cat_inode *in_place,
                 const cat_nomme *to_be_added,
                 const std::string & spot,
                 over_action_ea action);
 
    };
 
 
} // end of namespace
 
#endif