database.hpp

Go to the documentation of this file.

/*********************************************************************/
// dar - disk archive - a backup/restoration program
// Copyright (C) 2002-2052 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//
// to contact the author : http://dar.linux.free.fr/email.html
/*********************************************************************/



#ifndef DATABASE_HPP
#define DATABASE_HPP

#include "../my_config.h"

#include <list>

#include "archive.hpp"
#include "generic_file.hpp"
#include "data_tree.hpp"
#include "storage.hpp"
#include "database_options.hpp"

namespace libdar
{

    class database
    {
    public:
        database();


        database(user_interaction & dialog, const std::string & base, const database_open_options & opt);

        ~database();


        void dump(user_interaction & dialog, 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; };


            // "GETTINGS"


        void show_contents(user_interaction & dialog) const; // displays all archive information

        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


        void show_files(user_interaction & dialog, archive_num num, const database_used_options & opt) const;


        void show_version(user_interaction & dialog, path chemin) const;


        void show_most_recent_stats(user_interaction & dialog) const;

            // "ACTIONS" (not available with partially extracted databases)


        void restore(user_interaction & dialog,
                     const std::vector<std::string> & filename,
                     const database_restore_options & opt);



        bool check_order(user_interaction & dialog) const
        {
            bool initial_warn = true;

            if(files == NULL)
                throw SRC_BUG;
            if(check_order_asked)
                return files->check_order(dialog, ".", initial_warn) && initial_warn;
            else
                return true;
        }


    private:

        struct archive_data
        {
            std::string chemin;      //< path to the archive
            std::string basename;    //< basename of the archive
            infinint root_last_mod;  //< last modification date of the root directory
        };

        std::vector<struct archive_data> coordinate; //< list of archive used to build the database
        std::vector<std::string> options_to_dar;     //< options to use when calling dar for restoration
        std::string dar_path;                        //< path to dar
        data_dir *files;                             //< structure containing files and their status in the set of archive used for that database (is set to NULL in partial mode)
        storage *data_files;                         //< when reading archive in partial mode, this is where is located the "not readed" part of the archive (is set to NULL in partial-read-only mode)
        bool check_order_asked;                      //< whether order check has been asked

        void build(user_interaction & dialog, generic_file & f, bool partial, bool read_only, unsigned char db_version);  //< used by constructors
        archive_num get_real_archive_num(archive_num num, bool revert) const;

        const infinint & get_root_last_mod(const archive_num & num) const;
    };

} // end of namespace

#endif