File: sbuild-chroot-facet-mountable.h

package info (click to toggle)
schroot 1.6.4-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,684 kB
  • sloc: cpp: 21,427; sh: 12,516; makefile: 829; ansic: 231; sed: 16
file content (156 lines) | stat: -rw-r--r-- 4,070 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/* Copyright © 2005-2009  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_MOUNTABLE_H
#define SBUILD_CHROOT_FACET_MOUNTABLE_H

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

namespace sbuild
{

  /**
   * Chroot support for mountable devices and filesystems.
   *
   * This facet should be selected for sessions using the mount
   * command to create the chroot.  The specified device will be
   * mounted on demand.
   *
   * This facet is not restricted to block devices and can also be
   * used for network filesystems, loopback files and other
   * mountable objects.
   */
  class chroot_facet_mountable : public chroot_facet
  {
  public:
    /// A shared_ptr to a chroot facet object.
    typedef std::shared_ptr<chroot_facet_mountable> ptr;

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

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

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

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

    virtual chroot_facet::ptr
    clone () const;

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

    /**
     * Get the device path of the chroot block device to mount.
     *
     * @returns the mount device.
     */
    virtual std::string const&
    get_mount_device () const;

    /**
     * Set the device path of the chroot block device to mount.
     *
     * @param mount_device the mount device.
     */
    virtual void
    set_mount_device (std::string const& mount_device);

    /**
     * Get the filesystem mount options of the chroot block device.
     *
     * @returns the mount options.
     */
    virtual std::string const&
    get_mount_options () const;

    /**
     * Set the filesystem mount options of the chroot block device.
     *
     * @param mount_options the mount options.
     */
    virtual void
    set_mount_options (std::string const& mount_options);

    /**
     * Get the location.  This is a path to the chroot directory
     * inside the device (absolute path from the device root).
     *
     * @returns the location.
     */
    virtual std::string const&
    get_location () const;

    /**
     * Set the location.  This is a path to the chroot directory
     * inside the device (absolute path from the device root).
     *
     * @param location the location.
     */
    virtual void
    set_location (std::string const& location);

    virtual void
    setup_env (chroot const& chroot,
	       environment&  env) const;

    virtual chroot::session_flags
    get_session_flags (chroot const& chroot) const;

    virtual void
    get_details (chroot const&  chroot,
		 format_detail& detail) const;

    virtual void
    get_keyfile (chroot const& chroot,
		 keyfile&      keyfile) const;

    virtual void
    set_keyfile (chroot&        chroot,
		 keyfile const& keyfile,
		 string_list&   used_keys);

  private:
    /// The device to mount.
    std::string mount_device;
    /// The options to mount the device with.
    std::string mount_options;
    /// Location inside the mount location root.
    std::string location;
  };

}

#endif /* SBUILD_CHROOT_FACET_MOUNTABLE_H */

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