Storage.h

/*
 * Copyright (c) [2014-2015] Novell, Inc.
 * Copyright (c) 2016 SUSE LLC
 *
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as published
 * by the Free Software Foundation.
 *
 * 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, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may
 * find current contact information at www.novell.com.
 */


#ifndef STORAGE_STORAGE_H
#define STORAGE_STORAGE_H


#include <string>
#include <vector>
#include <memory>
#include <boost/noncopyable.hpp>


namespace storage
{
    class Environment;
    class Arch;
    class Devicegraph;
    class Actiongraph;


    namespace Action
    {
        class Base;
    }


    class CommitCallbacks
    {
    public:

        virtual ~CommitCallbacks() {}

        virtual void message(const std::string& message) const = 0;
        virtual bool error(const std::string& message, const std::string& what) const = 0;

        // TODO to make pre and post generally usable the Action classes must
        // be included in the public libstorage interface
        virtual void pre(const Action::Base* action) const {}
        virtual void post(const Action::Base* action) const {}

    };


    class Storage : private boost::noncopyable
    {
    public:

        Storage(const Environment& environment);
        ~Storage();

    public:

        const Environment& get_environment() const;
        const Arch& get_arch() const;

        Devicegraph* create_devicegraph(const std::string& name);
        Devicegraph* copy_devicegraph(const std::string& source_name, const std::string& dest_name);
        void remove_devicegraph(const std::string& name);
        void restore_devicegraph(const std::string& name);

        bool equal_devicegraph(const std::string& lhs, const std::string& rhs) const;

        bool exist_devicegraph(const std::string& name) const;
        std::vector<std::string> get_devicegraph_names() const;

        Devicegraph* get_devicegraph(const std::string& name);

        const Devicegraph* get_devicegraph(const std::string& name) const;

        Devicegraph* get_staging();

        const Devicegraph* get_staging() const;

        const Devicegraph* get_probed() const;

        void check() const;

        const std::string& get_rootprefix() const;
        void set_rootprefix(const std::string& rootprefix);

        std::string prepend_rootprefix(const std::string& mountpoint) const;

        const Actiongraph* calculate_actiongraph();

        void commit(const CommitCallbacks* commit_callbacks = nullptr);

    public:

        class Impl;

        Impl& get_impl() { return *impl; }
        const Impl& get_impl() const { return *impl; }

    private:

        const std::unique_ptr<Impl> impl;

    };

}

#endif