sbuild  1.5.3
Public Member Functions | Protected Member Functions | Private Attributes | Friends
sbuild::chroot_custom Class Reference

A chroot stored with custom parameters. More...

#include <sbuild-chroot-custom.h>

+ Inheritance diagram for sbuild::chroot_custom:
+ Collaboration diagram for sbuild::chroot_custom:

List of all members.

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

Detailed Description

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.


Member Function Documentation

Copy the chroot.

This is a virtual copy constructor.

Returns:
a shared_ptr to the new copy of the chroot.

Implements sbuild::chroot.

References chroot_custom().

Referenced by clone_source().

+ Here is the caller graph for this function:

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.

Parameters:
session_idthe identifier (session_id) for the new session.
aliasused to initially identify the chroot.
userthe user creating the session.
roottrue if the user has root access, otherwise false.
Returns:
a session chroot.

Implements sbuild::chroot.

References chroot_custom().

Create a source chroot.

Returns:
a source chroot.

Implements sbuild::chroot.

References chroot_custom(), and clone().

std::string const & chroot_custom::get_chroot_type ( ) const [virtual]

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

void chroot_custom::get_details ( chroot const &  chroot,
format_detail detail 
) const [protected, virtual]

Get detailed information about the chroot for output.

Parameters:
chrootthe chroot to use.
detailthe 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.

Parameters:
chrootthe chroot to use.
keyfilethe 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.

Returns:
the path.

Implements sbuild::chroot.

References sbuild::chroot::get_mount_location().

Get the session flags of the chroot.

These determine how the Session controlling the chroot will operate.

Parameters:
chrootthe chroot to use.
Returns:
the session flags.

Implements sbuild::chroot.

References sbuild::chroot::get_facet(), get_session_purgeable(), sbuild::chroot::SESSION_NOFLAGS, and sbuild::chroot::SESSION_PURGE.

Get status of chroot session purging.

Returns:
true if purgeable, false if not.

Referenced by get_keyfile(), and get_session_flags().

+ Here is the caller graph for this function:

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.

Parameters:
chrootthe chroot to use.
keyfilethe keyfile to get the properties from.
used_keysa 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.

Parameters:
cloneabletrue if cloneable, false if not.

References sbuild::chroot::add_facet(), and sbuild::chroot_facet_session_clonable::create().

Referenced by set_keyfile().

+ Here is the caller graph for this function:

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.

Parameters:
purgeabletrue if purgeable, false if not.

Referenced by set_keyfile().

+ Here is the caller graph for this function:

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.

Parameters:
cloneabletrue if source cloneable, false if not.

References sbuild::chroot::add_facet(), and sbuild::chroot_facet_source_clonable::create().

Referenced by set_keyfile().

+ Here is the caller graph for this function:

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.

Parameters:
chrootthe chroot to use.
envthe 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.

Parameters:
typethe type of setup being performed
locktrue to lock, false to unlock
statusthe 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.


The documentation for this class was generated from the following files: