sbuild::chroot_file Class Reference

A chroot stored in a file archive (tar or zip). More...

#include <sbuild-chroot-file.h>

Inheritance diagram for sbuild::chroot_file:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~chroot_file ()
 The destructor.
virtual chroot::ptr clone () const
 Copy the chroot.
virtual chroot::ptr clone_session (std::string const &session_id, std::string const &user, bool root) const
 Create a session chroot.
virtual chroot::ptr clone_source () const
 Create a source chroot.
std::string const & get_file () const
 Get the file used by the chroot.
void set_file (std::string const &file)
 Set the file used by the chroot.
virtual std::string const & get_location () const
 Get the location.
virtual void set_location (std::string const &location)
 Set the location.
bool get_file_repack () const
 Get the repack status.
void set_file_repack (bool repack)
 Set the file repack status.
virtual std::string const & get_chroot_type () const
 Get the type of the chroot.
virtual void setup_env (chroot const &chroot, environment &env) const
 Set environment.
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_file ()
 The constructor.
 chroot_file (const chroot_file &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

std::string file
 The file to use.
std::string location
 Location inside the mount location root.
bool repack
 Should the chroot be repacked?

Friends

class chroot


Detailed Description

A chroot stored in a file archive (tar or zip).

The archive will be unpacked and repacked on demand.


Member Function Documentation

sbuild::chroot::ptr chroot_file::clone (  )  const [virtual]

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_file().

Referenced by clone_source().

Here is the caller graph for this function:

sbuild::chroot::ptr chroot_file::clone_session ( std::string const &  name,
std::string const &  user,
bool  root 
) const [virtual]

Create a session chroot.

Parameters:
name the identifier (session_id) for the new session.
user the user creating the session.
root true if the user has root access, otherwise false.
Returns:
a session chroot.

Implements sbuild::chroot.

References chroot_file().

sbuild::chroot::ptr chroot_file::clone_source (  )  const [virtual]

Create a source chroot.

Returns:
a source chroot.

Implements sbuild::chroot.

References chroot_file(), clone(), and repack.

std::string const & chroot_file::get_file (  )  const

Get the file used by the chroot.

Returns:
the file.

References file.

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

Here is the caller graph for this function:

void chroot_file::set_file ( std::string const &  file  ) 

Set the file used by the chroot.

Parameters:
file the file.

References sbuild::chroot::FILE_ABS, and sbuild::is_absname().

Referenced by set_keyfile().

Here is the caller graph for this function:

std::string const & chroot_file::get_location (  )  const [virtual]

Get the location.

This is a path to the chroot directory inside the archive (absolute path from the archive root).

Returns:
the location.

References location.

Referenced by get_details(), get_keyfile(), get_path(), and setup_env().

Here is the caller graph for this function:

void chroot_file::set_location ( std::string const &  location  )  [virtual]

Set the location.

This is a path to the chroot directory inside the archive (absolute path from the archive root).

Parameters:
location the location.

References sbuild::is_absname(), and sbuild::chroot::LOCATION_ABS.

Referenced by set_keyfile().

Here is the caller graph for this function:

bool chroot_file::get_file_repack (  )  const

Get the repack status.

This is true if the unpacked archive file will be repacked.

Returns:
the repack status.

References repack.

Referenced by get_keyfile().

Here is the caller graph for this function:

void chroot_file::set_file_repack ( bool  repack  ) 

Set the file repack status.

Set to true if the unpacked archive file will be repacked on session cleanup, or false to discard.

Parameters:
repack the repack status.

Referenced by set_keyfile().

Here is the caller graph for this function:

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

Get the type of the chroot.

Returns:
the chroot type.

Implements sbuild::chroot.

void chroot_file::setup_env ( chroot const &  chroot,
environment env 
) const [virtual]

Set environment.

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

Parameters:
chroot the chroot to use.
env the environment to set.

Implements sbuild::chroot.

References sbuild::environment::add(), get_file(), get_location(), repack, and sbuild::chroot::setup_env().

std::string chroot_file::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 get_location(), and sbuild::chroot::get_mount_location().

sbuild::chroot::session_flags chroot_file::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.

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

Implements sbuild::chroot.

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

void chroot_file::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:
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::stat::check_mode(), file, sbuild::chroot::FILE_NOTREG, sbuild::chroot::FILE_OWNER, sbuild::chroot::FILE_PERMS, sbuild::stat::is_regular(), sbuild::stat::PERM_OTHER_WRITE, sbuild::chroot::setup_session_info(), sbuild::chroot::SETUP_START, sbuild::chroot::SETUP_STOP, and sbuild::stat::uid().

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

Get detailed information about the chroot for output.

Parameters:
chroot the chroot to use.
detail the details to output to.

Implements sbuild::chroot.

References sbuild::format_detail::add(), file, sbuild::chroot::get_details(), get_file(), get_location(), and repack.

void chroot_file::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:
chroot the chroot to use.
keyfile the keyfile to use.

Implements sbuild::chroot.

References get_file(), get_file_repack(), sbuild::chroot::get_keyfile(), get_location(), sbuild::chroot::get_name(), and sbuild::basic_keyfile< K, P >::set_object_value().

void chroot_file::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:
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, sbuild::keyfile_base::PRIORITY_REQUIRED, set_file(), set_file_repack(), sbuild::chroot::set_keyfile(), and set_location().


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

Generated on Wed Jun 1 08:00:15 2011 for sbuild by  doxygen 1.5.6