data_dir.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 DATA_DIR_HPP
#define DATA_DIR_HPP

#include "../my_config.h"

#include <string>
#include <deque>
#include <vector>
#include "infinint.hpp"
#include "generic_file.hpp"
#include "user_interaction.hpp"
#include "path.hpp"
#include "cat_directory.hpp"
#include "cat_inode.hpp"
#include "cat_detruit.hpp"
#include "data_tree.hpp"

namespace libdar
{



    class data_dir : public data_tree
    {
    public:
    data_dir(const std::string &name);
    data_dir(generic_file &f, unsigned char db_version); //< does not read signature
    data_dir(const data_tree & ref);
    data_dir(const data_dir & ref);
    data_dir(data_dir && ref) = default;
    data_dir & operator = (const data_dir & ref) { rejetons.clear(); return *this; };
    data_dir & operator = (data_dir && ref) noexcept = default;
    ~data_dir();

    virtual void dump(generic_file & f) const override; //< write signature followed by data constructor will read

    void add(const cat_inode *entry, const archive_num & archive);
    void add(const cat_detruit *entry, const archive_num & archive);
    const data_tree *read_child(const std::string & name) const;
    void read_all_children(std::vector<std::string> & fils) const;
    void finalize_except_self(const archive_num & archive,
                  const datetime & deleted_date,
                  const archive_num & ignore_archives_greater_or_equal);

        // inherited methods
    virtual bool check_order(user_interaction & dialog, const path & current_path, bool & initial_warn) const override;
    virtual void finalize(const archive_num & archive, const datetime & deleted_date, const archive_num & ignore_archives_greater_or_equal) override;
    virtual bool remove_all_from(const archive_num & archive_to_remove, const archive_num & last_archive) override;

    void show(database_listing_show_files_callback callback,
          void *tag,
          archive_num num,
          std::string marge = "") const;
    virtual void apply_permutation(archive_num src, archive_num dst) override;
    virtual void skip_out(archive_num num) override;
    virtual void compute_most_recent_stats(std::deque<infinint> & data,
                           std::deque<infinint> & ea,
                           std::deque<infinint> & total_data,
                           std::deque<infinint> & total_ea) const override;

    virtual char obj_signature() const override { return signature(); };
    static char signature() { return 'd'; };

    virtual bool fix_corruption() override; // inherited from data_tree


    bool data_tree_find(path chemin, const data_tree *& ptr) const;

    void data_tree_update_with(const cat_directory *dir, archive_num archive);



    static data_dir *data_tree_read(generic_file & f, unsigned char db_version);

    private:
    std::deque<data_tree *> rejetons;          //< subdir and subfiles of the current dir

    void add_child(data_tree *fils);          //< "this" is now responsible of "fils" disalocation
    void remove_child(const std::string & name);
    data_tree *find_or_addition(const std::string & name, bool is_dir, const archive_num & archive);

    static data_tree *read_next_in_list_from_file(generic_file & f, unsigned char db_version);
    };





} // end of namespace

#endif