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 DATABASE_HPP
#define DATABASE_HPP
 
#include "../my_config.h"
 
#include <list>
 
#include "archive.hpp"
#include "database_options.hpp"
#include "database_archives.hpp"
#include "archive_num.hpp"
#include "database_listing_callback.hpp"
 
namespace libdar
{
 
 
 
    class database
    {
    public:
    database(const std::shared_ptr<user_interaction> & dialog);
 
 
    database(const std::shared_ptr<user_interaction> & dialog,
         const std::string & base,
         const database_open_options & opt);
 
    database(const database & ref) = delete;
 
    database(database && ref) noexcept = delete;
 
    database & operator = (const database & ref) = delete;
 
    database & operator = (database && ref) noexcept = delete;
 
    ~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);
 
 
    void set_dar_path(const std::string & chemin);
 
    void set_compression(compression algozip) const;
 
    void set_compression_level(U_I compr_level) const;
 
        // "GETTINGS"
 
    database_archives_list get_contents() const;
 
    std::vector<std::string> get_options() const;
 
 
    std::string get_dar_path() const;
 
    compression get_compression() const;
 
    U_I get_compression_level() const;
 
    std::string get_database_version() const;
 
 
    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,
             const archive_options_extract & extract_options,
             const database_restore_options & opt,
             statistics* progressive_report);
 
 
 
    bool check_order() const;
 
    private:
    class i_database;
    std::unique_ptr<i_database> pimpl;
 
    };
 
 
} // end of namespace
 
#endif