sbuild
1.7.1
|
A chroot stored in a file archive (tar with optional compression). More...
#include <file.h>
Public Types | |
typedef chroot::error | error |
Exception type. | |
typedef std::shared_ptr< file > | ptr |
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. | |
![]() | |
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< facet > | ptr |
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. | |
![]() | |
typedef std::shared_ptr< storage > | ptr |
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. | |
![]() | |
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... | |
![]() | |
virtual | ~facet () |
The destructor. | |
![]() | |
virtual | ~storage () |
The destructor. | |
![]() | |
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... | |
![]() | |
facet () | |
The constructor. | |
![]() | |
storage () | |
The constructor. | |
![]() | |
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 | |
![]() | |
chroot * | owner |
Chroot owning this facet. | |
A chroot stored in a file archive (tar with optional compression).
The archive will be unpacked and repacked on demand.
|
protectedvirtual |
Set up a newly-cloned source chroot.
parent | the parent of the cloned chroot. |
Implements sbuild::chroot::facet::source_setup.
References set_file_repack().
|
virtual |
Copy the chroot facet.
This is a virtual copy constructor.
Implements sbuild::chroot::facet::facet.
References file().
|
static |
|
protectedvirtual |
Get detailed information about the chroot for output.
detail | the 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.
References repack.
Referenced by get_keyfile().
std::string const & sbuild::chroot::facet::file::get_filename | ( | ) | const |
Get the filename used by the chroot.
References filename.
Referenced by get_details(), get_keyfile(), and setup_env().
|
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.
keyfile | the 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().
|
virtual |
Get the location.
This is a path to the chroot directory inside the archive (absolute path from the archive root).
References location.
Referenced by get_details(), get_keyfile(), get_path(), and setup_env().
|
virtual |
Get the name of the chroot facet.
Implements sbuild::chroot::facet::facet.
|
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::facet::storage.
References get_location(), sbuild::chroot::chroot::get_mount_location(), and sbuild::chroot::facet::facet::owner.
|
virtual |
Get the session flags of the chroot.
These determine how the Session controlling the chroot will operate.
chroot | the chroot to use. |
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.
|
protectedvirtual |
Get a list of the keys used during keyfile parsing.
Reimplemented from sbuild::chroot::facet::facet.
|
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.
chroot | the chroot containing this facet. |
copy | true 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.
repack | the repack status. |
References repack.
Referenced by chroot_source_setup(), and set_keyfile().
void sbuild::chroot::facet::file::set_filename | ( | const std::string & | filename) |
Set the filename used by the chroot.
filename | the filename. |
References sbuild::chroot::chroot::FILE_ABS, filename, and sbuild::is_absname().
Referenced by set_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.
keyfile | the 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().
|
virtual |
Set the location.
This is a path to the chroot directory inside the archive (absolute path from the archive root).
location | the location. |
References sbuild::is_absname(), location, and sbuild::chroot::chroot::LOCATION_ABS.
Referenced by set_keyfile().
|
virtual |
Set environment.
Set the environment that the setup scripts will see during execution.
env | the environment to set. |
Reimplemented from sbuild::chroot::facet::facet.
References sbuild::environment::add(), get_filename(), get_location(), and repack.