i_database.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 I_DATABASE_HPP
#define I_DATABASE_HPP
 
#include "../my_config.h"
 
#include <list>
 
#include "archive.hpp"
#include "generic_file.hpp"
#include "data_dir.hpp"
#include "storage.hpp"
#include "mem_ui.hpp"
#include "database_options.hpp"
#include "database_archives.hpp"
#include "database.hpp"
#include "tools.hpp"
#include "datetime.hpp"
#include "archive_options.hpp"
 
namespace libdar
{
 
 
 
    class database::i_database: public mem_ui
    {
    public:
        i_database(const std::shared_ptr<user_interaction> & dialog);
 
        i_database(const std::shared_ptr<user_interaction> & dialog,
                 const std::string & base,
                 const database_open_options & opt);
 
        i_database(const i_database & ref) = delete;
 
        i_database(i_database && ref) noexcept = delete;
 
        i_database & operator = (const i_database & ref) = delete;
 
        i_database & operator = (i_database && ref) noexcept = delete;
 
        ~i_database();
 
        void dump(const std::string & filename, const database_dump_options & opt) const;
 
            // SETTINGS
 
        void add_archive(const archive & arch, const std::string & chemin, const std::string & basename, const database_add_options & opt);
 
        void remove_archive(archive_num min, archive_num max, const database_remove_options & opt);
 
        void set_permutation(archive_num src, archive_num dst);
 
        void change_name(archive_num num, const std::string & basename, const database_change_basename_options &opt);
 
        void set_path(archive_num num, const std::string & chemin, const database_change_path_options & opt);
 
        void set_options(const std::vector<std::string> &opt) { options_to_dar = opt; };
 
        void set_dar_path(const std::string & chemin) { dar_path = chemin; };
 
        void set_compression(compression algozip) const { algo = algozip; };
 
    void set_compression_level(U_I level) const { compr_level = level; };
 
        //
            // "GETTINGS"
        //
 
        database_archives_list get_contents() const;
 
        std::vector<std::string> get_options() const { return options_to_dar; }; // show option passed to dar
 
        std::string get_dar_path() const { return dar_path; }; // show path to dar command
 
        compression get_compression() const { return algo; };
 
    U_I get_compression_level() const { return compr_level; };
 
        std::string get_database_version() const { return tools_uint2str(cur_db_version); };
 
        void get_files(database_listing_show_files_callback callback,
                       void *context,
                       archive_num num,
                       const database_used_options & opt) const;
 
        void get_version(database_listing_get_version_callback callback,
                         void *context,
                         path chemin) const;
 
        void show_most_recent_stats(database_listing_statistics_callback callback,
                                    void *context) const;
 
            // "ACTIONS" (not available with partially extracted databases)
 
        void restore(const std::vector<std::string> & filename,
                     const database_restore_options & opt);
 
 
    void restore(const archive_options_read & read_options,
             const path & fs_root,
             archive_options_extract extract_options,
             const database_restore_options & opt,
             statistics* progressive_report);
 
        bool check_order() const
        {
            bool initial_warn = true;
 
            if(files == nullptr)
                throw SRC_BUG;
            if(check_order_asked)
                return files->check_order(get_ui(), path("."), initial_warn) && initial_warn;
            else
                return true;
        }
 
 
    private:
 
        struct archive_data
        {
            std::string chemin;      
            std::string basename;    
            datetime root_last_mod;  
        };
 
        std::deque<struct archive_data> coordinate;  
        std::vector<std::string> options_to_dar;     
    std::string dar_path;                        
    data_dir *files;                             
    storage *data_files;                         
    bool check_order_asked;                      
    unsigned char cur_db_version;                
    mutable compression algo;                    
    mutable U_I compr_level;                     
 
    void build(generic_file & f, bool partial, bool read_only, unsigned char db_version);  
    archive_num get_real_archive_num(archive_num num, bool revert) const;
 
    const datetime & get_root_last_mod(const archive_num & num) const;
    };
 
 
} // end of namespace
 
#endif