sbuild  1.7.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
sbuild::chroot::facet::file Class Reference

A chroot stored in a file archive (tar with optional compression). More...

#include <file.h>

+ Inheritance diagram for sbuild::chroot::facet::file:
+ Collaboration diagram for sbuild::chroot::facet::file:

Public Types

typedef chroot::error error
 Exception type.
 
typedef std::shared_ptr< fileptr
 A shared_ptr to a chroot facet object.
 
typedef std::shared_ptr< const
file
const_ptr
 A shared_ptr to a const chroot facet object.
 
- Public Types inherited from sbuild::chroot::facet::facet
enum  session_flags { SESSION_NOFLAGS = 0, SESSION_CREATE = 1 << 0, SESSION_CLONE = 1 << 1, SESSION_PURGE = 1 << 2 }
 Chroot session properties. More...
 
typedef std::shared_ptr< facetptr
 A shared_ptr to a chroot facet object.
 
typedef std::shared_ptr< const
facet
const_ptr
 A shared_ptr to a const chroot facet object.
 
- Public Types inherited from sbuild::chroot::facet::storage
typedef std::shared_ptr< storageptr
 A shared_ptr to a chroot storage object.
 
typedef std::shared_ptr< const
storage
const_ptr
 A shared_ptr to a const chroot storage object.
 
- Public Types inherited from sbuild::chroot::facet::source_setup
typedef std::shared_ptr
< source_setup
ptr
 A shared_ptr to a chroot source_setup object.
 
typedef std::shared_ptr< const
source_setup
const_ptr
 A shared_ptr to a const chroot source_setup object.
 

Public Member Functions

virtual ~file ()
 The destructor.
 
virtual std::string const & get_name () const
 Get the name of the chroot facet. More...
 
facet::ptr clone () const
 Copy the chroot facet. More...
 
std::string const & get_filename () const
 Get the filename used by the chroot. More...
 
void set_filename (const std::string &filename)
 Set the filename used by the chroot. More...
 
virtual std::string const & get_location () const
 Get the location. More...
 
virtual void set_location (const std::string &location)
 Set the location. More...
 
bool get_file_repack () const
 Get the repack status. More...
 
void set_file_repack (bool repack)
 Set the file repack status. More...
 
virtual void setup_env (environment &env) const
 Set environment. More...
 
std::string get_path () const
 Get the path to the chroot. More...
 
virtual session_flags get_session_flags () const
 Get the session flags of the chroot. More...
 
- Public Member Functions inherited from sbuild::chroot::facet::facet
virtual ~facet ()
 The destructor.
 
- Public Member Functions inherited from sbuild::chroot::facet::storage
virtual ~storage ()
 The destructor.
 
- Public Member Functions inherited from sbuild::chroot::facet::source_setup
virtual ~source_setup ()
 The destructor.
 

Static Public Member Functions

static ptr create ()
 Create a chroot facet. More...
 

Protected Member Functions

 file ()
 The constructor.
 
 file (const file &rhs)
 The copy constructor.
 
void set_chroot (chroot &chroot, bool copy)
 Set containing chroot. More...
 
virtual void setup_lock (chroot::setup_type type, bool lock, int status)
 
virtual void get_details (format_detail &detail) const
 Get detailed information about the chroot for output. More...
 
virtual void get_used_keys (string_list &used_keys) const
 Get a list of the keys used during keyfile parsing. More...
 
virtual void get_keyfile (keyfile &keyfile) const
 Copy the chroot properties into a keyfile. More...
 
virtual void set_keyfile (const keyfile &keyfile)
 Set the chroot properties from a keyfile. More...
 
virtual void chroot_source_setup (const chroot &parent)
 Set up a newly-cloned source chroot. More...
 
- Protected Member Functions inherited from sbuild::chroot::facet::facet
 facet ()
 The constructor.
 
- Protected Member Functions inherited from sbuild::chroot::facet::storage
 storage ()
 The constructor.
 
- Protected Member Functions inherited from sbuild::chroot::facet::source_setup
 source_setup ()
 The constructor.
 

Private Attributes

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

Friends

class chroot
 

Additional Inherited Members

- Protected Attributes inherited from sbuild::chroot::facet::facet
chrootowner
 Chroot owning this facet.
 

Detailed Description

A chroot stored in a file archive (tar with optional compression).

The archive will be unpacked and repacked on demand.

Member Function Documentation

void sbuild::chroot::facet::file::chroot_source_setup ( const chroot parent)
protectedvirtual

Set up a newly-cloned source chroot.

Parameters
parentthe parent of the cloned chroot.

Implements sbuild::chroot::facet::source_setup.

References set_file_repack().

facet::ptr sbuild::chroot::facet::file::clone ( ) const
virtual

Copy the chroot facet.

This is a virtual copy constructor.

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

Implements sbuild::chroot::facet::facet.

References file().

file::ptr sbuild::chroot::facet::file::create ( )
static

Create a chroot facet.

Returns
a shared_ptr to the new chroot facet.

References file().

void sbuild::chroot::facet::file::get_details ( format_detail detail) const
protectedvirtual

Get detailed information about the chroot for output.

Parameters
detailthe details to output to.

Reimplemented from sbuild::chroot::facet::facet.

References sbuild::_(), sbuild::format_detail::add(), filename, get_filename(), get_location(), and repack.

bool sbuild::chroot::facet::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:

std::string const & sbuild::chroot::facet::file::get_filename ( ) const

Get the filename used by the chroot.

Returns
the filename.

References filename.

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

+ Here is the caller graph for this function:

void sbuild::chroot::facet::file::get_keyfile ( keyfile keyfile) const
protectedvirtual

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
keyfilethe keyfile to use.

Reimplemented from sbuild::chroot::facet::facet.

References sbuild::chroot::chroot::get_facet(), get_file_repack(), get_filename(), get_location(), sbuild::chroot::chroot::get_name(), sbuild::chroot::facet::facet::owner, and sbuild::keyfile::set_object_value().

std::string const & sbuild::chroot::facet::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:

std::string const & sbuild::chroot::facet::file::get_name ( ) const
virtual

Get the name of the chroot facet.

Returns
the chroot facet name.

Implements sbuild::chroot::facet::facet.

std::string sbuild::chroot::facet::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::facet::storage.

References get_location(), sbuild::chroot::chroot::get_mount_location(), and sbuild::chroot::facet::facet::owner.

facet::session_flags sbuild::chroot::facet::file::get_session_flags ( ) const
virtual

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.

Reimplemented from sbuild::chroot::facet::facet.

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

void sbuild::chroot::facet::file::get_used_keys ( string_list used_keys) const
protectedvirtual

Get a list of the keys used during keyfile parsing.

Returns
a list of key names.

Reimplemented from sbuild::chroot::facet::facet.

void sbuild::chroot::facet::file::set_chroot ( chroot chroot,
bool  copy 
)
protectedvirtual

Set containing chroot.

The copy parameter is used to inform the facet if it is new or a copy; this is intended to allow additional facets to only be added if the facet is new, for example, to avoid re-adding removed facets when copying a chroot.

Parameters
chrootthe chroot containing this facet.
copytrue if the facet has been copied, or false if this is a new instance.

Reimplemented from sbuild::chroot::facet::facet.

References sbuild::chroot::chroot::add_facet(), sbuild::chroot::facet::session_clonable::create(), sbuild::chroot::facet::source_clonable::create(), sbuild::chroot::chroot::get_facet(), sbuild::chroot::facet::facet::owner, and sbuild::chroot::facet::facet::set_chroot().

void sbuild::chroot::facet::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
repackthe repack status.

References repack.

Referenced by chroot_source_setup(), and set_keyfile().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::file::set_filename ( const std::string &  filename)

Set the filename used by the chroot.

Parameters
filenamethe filename.

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

Referenced by set_keyfile().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::file::set_keyfile ( const keyfile keyfile)
protectedvirtual

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
keyfilethe keyfile to get the properties from.

Reimplemented from sbuild::chroot::facet::facet.

References sbuild::chroot::chroot::get_facet(), sbuild::chroot::chroot::get_name(), sbuild::keyfile::get_object_value(), sbuild::chroot::facet::facet::owner, sbuild::keyfile::PRIORITY_DISALLOWED, sbuild::keyfile::PRIORITY_OPTIONAL, sbuild::keyfile::PRIORITY_REQUIRED, set_file_repack(), set_filename(), and set_location().

void sbuild::chroot::facet::file::set_location ( const std::string &  location)
virtual

Set the location.

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

Parameters
locationthe location.

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

Referenced by set_keyfile().

+ Here is the caller graph for this function:

void sbuild::chroot::facet::file::setup_env ( environment env) const
virtual

Set environment.

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

Parameters
envthe environment to set.

Reimplemented from sbuild::chroot::facet::facet.

References sbuild::environment::add(), get_filename(), get_location(), and repack.


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