archive.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 ARCHIVE_HPP
#define ARCHIVE_HPP
 
#include "../my_config.h"
#include <vector>
#include <string>
#include <memory>
 
#include "erreurs.hpp"
#include "path.hpp"
#include "statistics.hpp"
#include "archive_options.hpp"
#include "list_entry.hpp"
#include "crypto.hpp"
#include "archive_summary.hpp"
#include "archive_listing_callback.hpp"
#include "user_interaction.hpp"
 
 
namespace libdar
{
    // need to declare class database friend of class archive.
    // class database need to access the archive table of content
    // though exposing it by mean of a public method of class
    // archive would let it visibile to the API, thing we do not
    // want
    class database;
 
 
    constexpr const char* dar_extension = "dar";
 
 
 
    class archive
    {
    public:
 
 
    archive(const std::shared_ptr<user_interaction> & dialog,
        const path & chem,
        const std::string & basename,
        const std::string & extension,
        const archive_options_read & options);
 
 
 
 
    archive(const std::shared_ptr<user_interaction> & dialog,
        const path & fs_root,
        const path & sauv_path,
        const std::string & filename,
        const std::string & extension,
        const archive_options_create & options,
        statistics * progressive_report);
 
 
 
    archive(const std::shared_ptr<user_interaction> & dialog,
        const path & sauv_path,
        std::shared_ptr<archive> ref_arch1,
        const std::string & filename,
        const std::string & extension,
        const archive_options_merge & options,
        statistics* progressive_report);
 
 
 
    archive(const std::shared_ptr<user_interaction> & dialog,
        const path & chem_src,
        const std::string & basename_src,
        const std::string & extension_src,
        const archive_options_read & options_read,
        const path & chem_dst,
        const std::string & basename_dst,
        const std::string & extension_dst,
        const archive_options_repair & options_repair,
        statistics* progressive_report = nullptr); 
 
 
 
 
    archive(const archive & ref) = delete;
    archive(archive && ref) = delete;
    archive & operator = (const archive & ref) = delete;
    archive & operator = (archive && ref) = delete;
 
    ~archive();
 
 
 
 
    statistics op_extract(const path &fs_root,
                  const archive_options_extract & options,
                  statistics *progressive_report);
 
 
    void summary();
 
    archive_summary summary_data();
 
 
 
    void op_listing(archive_listing_callback callback,
            void *context,
            const archive_options_listing & options) const;
 
 
    statistics op_diff(const path & fs_root,
               const archive_options_diff & options,
               statistics * progressive_report);
 
 
 
    statistics op_test(const archive_options_test & options,
               statistics * progressive_report);
 
 
 
    void op_isolate(const path &sauv_path,
            const std::string & filename,
            const std::string & extension,
            const archive_options_isolate & options);
 
 
 
    bool get_children_of(archive_listing_callback callback,
                 void *context,
                 const std::string & dir,
                 bool fetch_ea = false);
 
 
    const std::vector<list_entry> get_children_in_table(const std::string & dir, bool fetch_ea = false) const;
 
    bool has_subdirectory(const std::string & dir) const;
 
    const entree_stats get_stats() const;
 
    const std::list<signator> & get_signatories() const;
 
    void init_catalogue() const;
 
 
    void drop_all_filedescriptors(bool repairing = false);
 
    void set_to_unsaved_data_and_FSA();
 
 
    U_64 get_first_slice_header_size() const;
 
 
    U_64 get_non_first_slice_header_size() const;
 
 
    private:
    class i_archive;
    std::shared_ptr<i_archive> pimpl;
 
        // see the comment near the forward declaration
        // of class database above for explanations
    friend class database;
    };
 
} // end of namespace
 
#endif