/* Copyright © 2005-2013  Roger Leigh <rleigh@debian.org>
 *
 * schroot 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 3 of the License, or
 * (at your option) any later version.
 *
 * schroot 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, see
 * <http://www.gnu.org/licenses/>.
 *
 *********************************************************************/

#ifndef SBUILD_CHROOT_FACET_UNSHARE_H
#define SBUILD_CHROOT_FACET_UNSHARE_H

#include <sbuild/chroot/facet/facet.h>

namespace sbuild
{
  namespace chroot
  {
    namespace facet
    {

      /**
       * Chroot support for unsharing process execution context
       */
      class unshare : public facet
      {
      public:
        /// A shared_ptr to a chroot facet object.
        typedef std::shared_ptr<unshare> ptr;

        /// A shared_ptr to a const chroot facet object.
        typedef std::shared_ptr<const unshare> const_ptr;

        /// Error codes.
        enum error_code
          {
            UNSHARE ///< Could not unshare process execution context
          };

        /// Exception type.
        typedef custom_error<error_code> error;

      private:
        /// The constructor.
        unshare ();

      public:
        /// The destructor.
        virtual ~unshare ();

        /**
         * Create a chroot facet.
         *
         * @returns a shared_ptr to the new chroot facet.
         */
        static ptr
        create ();

        virtual facet::ptr
        clone () const;

        virtual std::string const&
        get_name () const;

        /**
         * Is networking unshared?
         *
         * @returns true if unshared, otherwise false.
         */
        bool
        get_unshare_net () const;

        /**
         * Set network unsharing.
         *
         * @param unshare unshare?
         */
        void
        set_unshare_net (bool unshare);

        /**
         * Is System V IPC unshared?
         *
         * @returns true if unshared, otherwise false.
         */
        bool
        get_unshare_sysvipc () const;

        /**
         * Set System V IPC unsharing.
         *
         * @param unshare unshare?
         */
        void
        set_unshare_sysvipc (bool unshare);

        /**
         * Is System V SEM unshared?
         *
         * @returns true if unshared, otherwise false.
         */
        bool
        get_unshare_sysvsem () const;

        /**
         * Set System V SEM unsharing.
         *
         * @param unshare unshare?
         */
        void
        set_unshare_sysvsem (bool unshare);

        /**
         * Is UTS namespace unshared?
         *
         * @returns true if unshared, otherwise false.
         */
        bool
        get_unshare_uts () const;

        /**
         * Set System UTS namespace unsharing.
         *
         * @param unshare unshare?
         */
        void
        set_unshare_uts (bool unshare);

        /**
         * Unshare process execution context.
         */
        void
        do_unshare () const;

        virtual void
        setup_env (environment& env) const;

        virtual void
        get_details (format_detail& detail) const;

        virtual void
        get_used_keys (string_list& used_keys) const;

        virtual void
        get_keyfile (keyfile& keyfile) const;

        virtual void
        set_keyfile (const keyfile& keyfile);

      private:
        /// Unshare networking.
        bool unshare_net;
        /// Unshare System V IPC.
        bool unshare_sysvipc;
        /// Unshare System V SEM.
        bool unshare_sysvsem;
        /// Unshare System V SEM.
        bool unshare_uts;
      };

    }
  }
}

#endif /* SBUILD_CHROOT_FACET_UNSHARE_H */

/*
 * Local Variables:
 * mode:C++
 * End:
 */