1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
/* Copyright © 2005-2006 Roger Leigh <rleigh@debian.org>
*
* schroot is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* schroot is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*********************************************************************/
#ifndef SBUILD_CHROOT_CONFIG_H
#define SBUILD_CHROOT_CONFIG_H
#include "sbuild-chroot.h"
#include "sbuild-custom-error.h"
#include <map>
#include <ostream>
#include <vector>
#include <string>
namespace sbuild
{
/**
* Chroot configuration.
*
* This class holds the configuration details from the configuration
* file. Conceptually, it's an opaque container of chroot objects.
*
* Methods are provided to query the available chroots and find
* specific chroots.
*/
class chroot_config
{
public:
/// A list of chroots.
typedef std::vector<chroot::ptr> chroot_list;
/// A map between key-value string pairs.
typedef std::map<std::string, std::string> string_map;
/// A map between a chroot name and a chroot object.
typedef std::map<std::string, chroot::ptr> chroot_map;
/// Error codes.
enum error_code
{
DIR_OPEN, ///< Failed to open directory.
FILE_STAT, ///< Failed to stat file.
FILE_OPEN, ///< Failed to open file.
FILE_OWNER, ///< File is not owned by user root.
FILE_PERMS, ///< File has write permissions for others.
FILE_NOTREG ///< File is not a regular file.
};
/// Exception type.
typedef custom_error<error_code> error;
/// A shared_ptr to a chroot_config object.
typedef std::tr1::shared_ptr<chroot_config> ptr;
/// The constructor.
chroot_config ();
/**
* The constructor.
*
* @param file initialise using a configuration file or a whole
* directory containing configuration files.
* @param active true if the chroots in the configuration file are
* active sessions, otherwise false.
*/
chroot_config (std::string const& file,
bool active);
/// The destructor.
virtual ~chroot_config ();
/**
* Add a configuration file or directory. The configuration file
* or directory specified will be loaded.
*
* @param location initialise using a configuration file or a
* whole directory containing configuration files.
* @param active true if the chroots in the configuration file are
* active sessions, otherwise false.
*/
void
add (std::string const& location,
bool active);
private:
/**
* Add a configuration file. The configuration file specified
* will be loaded.
*
* @param file the file to load.
* @param active true if the chroots in the configuration file are
* active sessions, otherwise false.
*/
void
add_config_file (std::string const& file,
bool active);
/**
* Add a configuration directory. The configuration files in the
* directory specified will all be loaded.
*
* @param dir the directory containing the files to load.
* @param active true if the chroots in the configuration file are
* active sessions, otherwise false.
*/
void
add_config_directory (std::string const& dir,
bool active);
protected:
/**
* Add a chroot. The lists of chroots and aliases will be
* updated. If a chroot or alias by the same name exists, the
* chroot will not be added, and a warning will be logged. Af any
* of the aliases already exist, a warning will be logged, and the
* alias will not be added.
*
* @param chroot the chroot to add.
*/
void
add (chroot::ptr& chroot);
public:
/**
* Get a list of available chroots.
*
* @returns a list of available chroots. The list will be empty
* if no chroots are available.
*/
chroot_list
get_chroots () const;
/**
* Find a chroot by its name.
*
* @param name the chroot name
* @returns the chroot if found, otherwise 0.
*/
const chroot::ptr
find_chroot (std::string const& name) const;
/**
* Find a chroot by its name or an alias.
*
* @param name the chroot name or alias.
* @returns the chroot if found, otherwise 0.
*/
const chroot::ptr
find_alias (std::string const& name) const;
/**
* Get the names (including aliases) of all the available chroots,
* sorted in alphabetical order.
*
* @returns the list. The list will be empty if no chroots are
* available.
*/
string_list
get_chroot_list () const;
/**
* Print all the available chroots to the specified stream.
*
* @param stream the stream to output to.
*/
void
print_chroot_list (std::ostream& stream) const;
/**
* Print a single line of all the available chroots to the
* specified stream.
*
* @param stream the stream to output to.
*/
void
print_chroot_list_simple (std::ostream& stream) const;
/**
* Print information about the specified chroots to the specified
* stream.
*
* @param chroots a list of chroots to print.
* @param stream the stream to output to.
*/
void
print_chroot_info (string_list const& chroots,
std::ostream& stream) const;
/**
* Print location information about the specified chroots to the
* specified stream.
*
* @param chroots a list of chroots to print.
* @param stream the stream to output to.
*/
void
print_chroot_location (string_list const& chroots,
std::ostream& stream) const;
/**
* Print configuration of the specified chroots to the specified
* stream.
*
* @param chroots a list of chroots to print.
* @param stream the stream to output to.
*/
void
print_chroot_config (string_list const& chroots,
std::ostream& stream) const;
/**
* Check that all the chroots specified exist.
*
* @param chroots a list of chroots to validate.
* @returns a list of invalid chroots. The list will be empty if
* all chroots are valid.
*/
string_list
validate_chroots (string_list const& chroots) const;
private:
/**
* Load a configuration file. If there are problems with the
* configuration file, an error will be thrown. The file must be
* owned by root, not writable by other, and be a regular file.
*
* @param file the file to load.
* @param active true if the chroots in the configuration file are
* active sessions, otherwise false.
*/
void
load_data (std::string const& file,
bool active);
/**
* Parse a loaded configuration file. If there are problems with
* the configuration file, an error will be thrown.
*
* @param stream the data stream to parse.
* @param active true if the chroots in the configuration file are
* active sessions, otherwise false.
*/
virtual void
parse_data (std::istream& stream,
bool active);
/// A list of chroots (name->chroot mapping).
chroot_map chroots;
/// A list of aliases (alias->name mapping).
string_map aliases;
};
}
#endif /* SBUILD_CHROOT_CONFIG_H */
/*
* Local Variables:
* mode:C++
* End:
*/
|
