A chroot stored with custom parameters. More...
#include <sbuild-chroot-custom.h>
Public Member Functions | |
virtual | ~chroot_custom () |
The destructor. | |
virtual chroot::ptr | clone () const |
Copy the chroot. | |
virtual chroot::ptr | clone_session (std::string const &session_id, std::string const &alias, std::string const &user, bool root) const |
Create a session chroot. | |
virtual chroot::ptr | clone_source () const |
Create a source chroot. | |
void | set_session_cloneable (bool cloneable) |
Enable or disable cloning of the chroot session. | |
void | set_session_purgeable (bool purgeable) |
Enable or disable purging of the chroot session. | |
bool | get_session_purgeable () const |
Get status of chroot session purging. | |
void | set_source_cloneable (bool cloneable) |
Enable or disable cloning of the source chroot. | |
virtual void | setup_env (chroot const &chroot, environment &env) const |
Set environment. | |
virtual std::string const & | get_chroot_type () const |
Get the type of the chroot. | |
std::string | get_path () const |
Get the path to the chroot. | |
virtual session_flags | get_session_flags (chroot const &chroot) const |
Get the session flags of the chroot. | |
Protected Member Functions | |
chroot_custom () | |
The constructor. | |
chroot_custom (const chroot_custom &rhs) | |
The copy constructor. | |
virtual void | setup_lock (chroot::setup_type type, bool lock, int status) |
Unlock a chroot during setup. | |
virtual void | get_details (chroot const &chroot, format_detail &detail) const |
Get detailed information about the chroot for output. | |
virtual void | get_keyfile (chroot const &chroot, keyfile &keyfile) const |
Copy the chroot properties into a keyfile. | |
virtual void | set_keyfile (chroot &chroot, keyfile const &keyfile, string_list &used_keys) |
Set the chroot properties from a keyfile. | |
Private Attributes | |
bool | purgeable |
Friends | |
class | chroot |
A chroot stored with custom parameters.
This chroot specifies no behaviour or policy. It is entirely configured using user options and setup scripts. The intent is to permit the prototyping of and experimentation with new chroot types without requiring a "full" class definition and associated infrastructural work. It also makes schroot extensible without requiring any C++ coding.
sbuild::chroot::ptr chroot_custom::clone | ( | ) | const [virtual] |
Copy the chroot.
This is a virtual copy constructor.
Implements sbuild::chroot.
References chroot_custom().
Referenced by clone_source().
sbuild::chroot::ptr chroot_custom::clone_session | ( | std::string const & | session_id, | |
std::string const & | alias, | |||
std::string const & | user, | |||
bool | root | |||
) | const [virtual] |
Create a session chroot.
session_id | the identifier (session_id) for the new session. | |
alias | used to initially identify the chroot. | |
user | the user creating the session. | |
root | true if the user has root access, otherwise false. |
Implements sbuild::chroot.
References chroot_custom().
sbuild::chroot::ptr chroot_custom::clone_source | ( | ) | const [virtual] |
Create a source chroot.
Implements sbuild::chroot.
References chroot_custom(), and clone().
std::string const & chroot_custom::get_chroot_type | ( | ) | const [virtual] |
void chroot_custom::get_details | ( | chroot const & | chroot, | |
format_detail & | detail | |||
) | const [protected, virtual] |
Get detailed information about the chroot for output.
chroot | the chroot to use. | |
detail | the details to output to. |
Implements sbuild::chroot.
void chroot_custom::get_keyfile | ( | chroot const & | chroot, | |
keyfile & | keyfile | |||
) | const [protected, virtual] |
Copy the chroot properties into a keyfile.
The keyfile group with the name of the chroot will be set; if it already exists, it will be removed before setting it.
chroot | the chroot to use. | |
keyfile | the keyfile to use. |
Implements sbuild::chroot.
References sbuild::chroot::get_name(), get_session_purgeable(), and sbuild::basic_keyfile< K, P >::set_object_value().
std::string chroot_custom::get_path | ( | ) | const [virtual] |
Get the path to the chroot.
This is the absolute path to the root of the chroot, and is typically the same as the mount location and location concatenated together, but is overridden by the chroot type if required.
Implements sbuild::chroot.
References sbuild::chroot::get_mount_location().
sbuild::chroot::session_flags chroot_custom::get_session_flags | ( | chroot const & | chroot | ) | const [virtual] |
Get the session flags of the chroot.
These determine how the Session controlling the chroot will operate.
chroot | the chroot to use. |
Implements sbuild::chroot.
References sbuild::chroot::get_facet(), and get_session_purgeable().
bool chroot_custom::get_session_purgeable | ( | ) | const |
Get status of chroot session purging.
Referenced by get_keyfile(), and get_session_flags().
void chroot_custom::set_keyfile | ( | chroot & | chroot, | |
keyfile const & | keyfile, | |||
string_list & | used_keys | |||
) | [protected, virtual] |
Set the chroot properties from a keyfile.
The chroot name must have previously been set, so that the correct keyfile group may be determined.
chroot | the chroot to use. | |
keyfile | the keyfile to get the properties from. | |
used_keys | a list of the keys used will be set. |
Implements sbuild::chroot.
References sbuild::chroot::get_name(), sbuild::basic_keyfile< K, P >::get_object_value(), sbuild::keyfile_base::PRIORITY_DISALLOWED, sbuild::keyfile_base::PRIORITY_OPTIONAL, set_session_cloneable(), set_session_purgeable(), and set_source_cloneable().
void chroot_custom::set_session_cloneable | ( | bool | cloneable | ) |
Enable or disable cloning of the chroot session.
This simply creates or removes the chroot_facet_session_cloneable facet, hence there is no companion get method.
cloneable | true if cloneable, false if not. |
References sbuild::chroot::add_facet(), and sbuild::chroot_facet_session_clonable::create().
Referenced by set_keyfile().
void chroot_custom::set_session_purgeable | ( | bool | purgeable | ) |
Enable or disable purging of the chroot session.
Note that this is only usable if the chroot supports session cloning, otherwise this does nothing.
purgeable | true if purgeable, false if not. |
Referenced by set_keyfile().
void chroot_custom::set_source_cloneable | ( | bool | cloneable | ) |
Enable or disable cloning of the source chroot.
This simply creates or removes the chroot_facet_source_cloneable facet, hence there is no companion get method.
cloneable | true if source cloneable, false if not. |
References sbuild::chroot::add_facet(), and sbuild::chroot_facet_source_clonable::create().
Referenced by set_keyfile().
void chroot_custom::setup_env | ( | chroot const & | chroot, | |
environment & | env | |||
) | const [virtual] |
Set environment.
Set the environment that the setup scripts will see during execution.
chroot | the chroot to use. | |
env | the environment to set. |
Implements sbuild::chroot.
void chroot_custom::setup_lock | ( | chroot::setup_type | type, | |
bool | lock, | |||
int | status | |||
) | [protected, virtual] |
Unlock a chroot during setup.
The locking technique (if any) may vary depending upon the chroot type and setup stage. For example, during creation of an LVM snapshot a block device might require locking, but afterwards this will change to the new block device.
An error will be thrown on failure.
type | the type of setup being performed | |
lock | true to lock, false to unlock | |
status | the exit status of the setup commands (0 for success, nonzero for failure). |
Implements sbuild::chroot.
References sbuild::chroot::setup_session_info(), sbuild::chroot::SETUP_START, and sbuild::chroot::SETUP_STOP.