sbuild::chroot_source Class Reference

A chroot may offer a "source" chroot in addition to its normal "session" copy, to allow for maintenence of the source data. More...

#include <sbuild-chroot-source.h>

Inheritance diagram for sbuild::chroot_source:

Inheritance graph
[legend]
Collaboration diagram for sbuild::chroot_source:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~chroot_source ()
 The destructor.
virtual chroot::ptr clone_source () const =0
 Create a source chroot.
virtual string_list const & get_source_users () const
 Get the users allowed to access the source chroot.
virtual void set_source_users (string_list const &users)
 Set the users allowed to access the source chroot.
virtual string_list const & get_source_groups () const
 Get the groups allowed to access the source chroot.
virtual void set_source_groups (string_list const &groups)
 Set the groups allowed to access the source chroot.
virtual string_list const & get_source_root_users () const
 Get the users allowed to access the source chroot as root.
virtual void set_source_root_users (string_list const &users)
 Set the users allowed to access the source chroot as root.
virtual string_list const & get_source_root_groups () const
 Get the groups allowed to access the source chroot as root.
virtual void set_source_root_groups (string_list const &groups)
 Set the groups allowed to access the source chroot as root.
void setup_env (environment &env)
 Set environment.

Protected Member Functions

 chroot_source ()
 The constructor.
void clone_source_setup (chroot::ptr &clone) const
 Set the defaults in the cloned source chroot.
virtual session_flags get_session_flags () const
 Get the session flags of the chroot.
virtual void get_details (format_detail &detail) const
 Get detailed information about the chroot for output.
void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile.
void set_keyfile (keyfile const &keyfile, string_list &used_keys)
 Set the chroot properties from a keyfile.

Private Attributes

bool is_source
 Is the chroot source or clone?
string_list source_users
 Users allowed to access the source chroot.
string_list source_groups
 Groups allowed to access the source chroot.
string_list source_root_users
 Users allowed to access the source chroot as root.
string_list source_root_groups
 Groups allowed to access the source chroot as root.

Friends

class chroot


Detailed Description

A chroot may offer a "source" chroot in addition to its normal "session" copy, to allow for maintenence of the source data.

This interface may be implemented by any chroot wishing to provide such functionality.

While this is effectively an interface, in practice this derives from sbuild::chroot, to allow setting and getting of data from a keyfile, including storing the keyfile options.

Chroot types implementing chroot_source should, at a minimum, implement clone_source(). This should create and return a source chroot, and must call clone_source_setup() to set up the source chroot.


Constructor & Destructor Documentation

chroot_source::chroot_source (  )  [protected]

The constructor.

chroot_source::~chroot_source (  )  [virtual]

The destructor.


Member Function Documentation

virtual chroot::ptr sbuild::chroot_source::clone_source (  )  const [pure virtual]

Create a source chroot.

Returns:
a source chroot.

Implemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

Referenced by sbuild::chroot_config::load_keyfile().

void chroot_source::clone_source_setup ( chroot::ptr clone  )  const [protected]

string_list const & chroot_source::get_source_users (  )  const [virtual]

Get the users allowed to access the source chroot.

Returns:
a list of users.

References source_users.

Referenced by clone_source_setup(), get_details(), and get_keyfile().

void chroot_source::set_source_users ( string_list const &  users  )  [virtual]

Set the users allowed to access the source chroot.

Parameters:
users a list of users.

Referenced by set_keyfile().

string_list const & chroot_source::get_source_groups (  )  const [virtual]

Get the groups allowed to access the source chroot.

Returns:
a list of groups.

References source_groups.

Referenced by clone_source_setup(), get_details(), and get_keyfile().

void chroot_source::set_source_groups ( string_list const &  groups  )  [virtual]

Set the groups allowed to access the source chroot.

Parameters:
groups a list of groups.

Referenced by set_keyfile().

string_list const & chroot_source::get_source_root_users (  )  const [virtual]

Get the users allowed to access the source chroot as root.

Members of these users can switch to root without authenticating themselves.

Returns:
a list of users.

References source_root_users.

Referenced by clone_source_setup(), get_details(), and get_keyfile().

void chroot_source::set_source_root_users ( string_list const &  users  )  [virtual]

Set the users allowed to access the source chroot as root.

Members of these users can switch to root without authenticating themselves.

Parameters:
users a list of users.

References source_root_users.

Referenced by set_keyfile().

string_list const & chroot_source::get_source_root_groups (  )  const [virtual]

Get the groups allowed to access the source chroot as root.

Members of these groups can switch to root without authenticating themselves.

Returns:
a list of groups.

References source_root_groups.

Referenced by clone_source_setup(), get_details(), and get_keyfile().

void chroot_source::set_source_root_groups ( string_list const &  groups  )  [virtual]

Set the groups allowed to access the source chroot as root.

Members of these groups can switch to root without authenticating themselves.

Parameters:
groups a list of groups.

References source_root_groups.

Referenced by set_keyfile().

void chroot_source::setup_env ( environment env  )  [virtual]

Set environment.

Set the environment that the setup scripts will see during execution.

Parameters:
env the environment to set.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

Referenced by sbuild::chroot_lvm_snapshot::setup_env(), and sbuild::chroot_file::setup_env().

sbuild::chroot::session_flags chroot_source::get_session_flags (  )  const [protected, virtual]

void chroot_source::get_details ( format_detail detail  )  const [protected, virtual]

Get detailed information about the chroot for output.

Parameters:
detail the details to output to.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

References sbuild::format_detail::add(), get_source_groups(), get_source_root_groups(), get_source_root_users(), get_source_users(), and is_source.

Referenced by sbuild::chroot_lvm_snapshot::get_details(), and sbuild::chroot_file::get_details().

void chroot_source::get_keyfile ( 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:
keyfile the keyfile to use.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

References sbuild::chroot::get_name(), get_source_groups(), get_source_root_groups(), get_source_root_users(), get_source_users(), is_source, and sbuild::basic_keyfile< K, P >::set_object_list_value().

Referenced by sbuild::chroot_lvm_snapshot::get_keyfile(), and sbuild::chroot_file::get_keyfile().

void chroot_source::set_keyfile ( 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:
keyfile the keyfile to get the properties from.
used_keys a list of the keys used will be set.

Reimplemented from sbuild::chroot.

Reimplemented in sbuild::chroot_file, and sbuild::chroot_lvm_snapshot.

References sbuild::chroot::get_name(), sbuild::basic_keyfile< K, P >::get_object_list_value(), is_source, sbuild::keyfile_base::PRIORITY_OPTIONAL, set_source_groups(), set_source_root_groups(), set_source_root_users(), and set_source_users().

Referenced by sbuild::chroot_lvm_snapshot::set_keyfile(), and sbuild::chroot_file::set_keyfile().


Friends And Related Function Documentation

friend class chroot [friend]


Member Data Documentation

Is the chroot source or clone?

Referenced by get_details(), get_keyfile(), get_session_flags(), and set_keyfile().

Users allowed to access the source chroot.

Referenced by get_source_users().

Groups allowed to access the source chroot.

Referenced by get_source_groups().

Users allowed to access the source chroot as root.

Referenced by get_source_root_users(), and set_source_root_users().

Groups allowed to access the source chroot as root.

Referenced by get_source_root_groups(), and set_source_root_groups().


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

Generated on Mon May 5 09:26:39 2008 for sbuild by  doxygen 1.5.5