8 typedef std::string string;
9 typedef std::string::iterator string_iterator;
11 // Utility function to skip white space. Returns an iterator at the
12 // first non-white-space position (or at end).
13 static string_iterator skipws(string_iterator i, string_iterator end)
19 if (! isspace(*i, locale::classic())) {
27 // Read a setting name.
28 static string read_setting_name(string_iterator & i, string_iterator end)
34 const ctype<char> & facet = use_facet<ctype<char> >(locale::classic());
37 // Allow alphabetical characters, and dash (-) in setting name
38 while (i != end && (*i == '-' || facet.is(ctype<char>::alpha, *i))) {
45 // Read a setting value
47 // In general a setting value is a single-line string. It may contain multiple parts
48 // separated by white space (which is normally collapsed). A hash mark - # - denotes
49 // the end of the value and the beginning of a comment (it should be preceded by
52 // Part of a value may be quoted using double quote marks, which prevents collapse
53 // of whitespace and interpretation of most special characters (the quote marks will
54 // not be considered part of the value). A backslash can precede a character (such
55 // as '#' or '"' or another backslash) to remove its special meaning. Newline
56 // characters are not allowed in values and cannot be quoted.
58 // This function expects the string to be in an ASCII-compatible, single byte
59 // encoding (the "classic" locale).
62 // i - reference to string iterator through the line
63 // end - iterator at end of line
64 // part_positions - list of <int,int> to which the position of each setting value
65 // part will be added as [start,end). May be null.
66 static string read_setting_value(string_iterator & i, string_iterator end,
67 std::list<std::pair<unsigned,unsigned>> * part_positions = nullptr)
82 part_start = rval.length();
94 // A backslash escapes the following character.
110 // String wasn't terminated
115 else if (c == '\\') {
117 part_start = rval.length();
120 // A backslash escapes the next character
129 else if (isspace(c, locale::classic())) {
130 if (! new_part && part_positions != nullptr) {
131 part_positions->emplace_back(part_start, rval.length());
136 if (*i == '#') break; // comment
137 rval += ' '; // collapse ws to a single space
141 // hmm... comment? Probably, though they should have put a space
142 // before it really. TODO throw an exception, and document
143 // that '#' for comments must be preceded by space, and in values
149 part_start = rval.length();
158 if (part_positions != nullptr) {
159 part_positions->emplace_back(part_start, rval.length());
165 static int signalNameToNumber(std::string &signame)
167 if (signame == "HUP") return SIGHUP;
168 if (signame == "INT") return SIGINT;
169 if (signame == "QUIT") return SIGQUIT;
170 if (signame == "USR1") return SIGUSR1;
171 if (signame == "USR2") return SIGUSR2;
175 // Find a service record, or load it from file. If the service has
176 // dependencies, load those also.
178 // Might throw a ServiceLoadExc exception if a dependency cycle is found or if another
179 // problem occurs (I/O error, service description not found etc). Throws std::bad_alloc
180 // if a memory allocation failure occurs.
181 ServiceRecord * ServiceSet::loadServiceRecord(const char * name)
190 // First try and find an existing record...
191 ServiceRecord * rval = findService(string(name));
193 if (rval->isDummy()) {
194 throw ServiceCyclicDependency(name);
199 // Couldn't find one. Have to load it.
200 string service_filename = service_dir;
201 if (*(service_filename.rbegin()) != '/') {
202 service_filename += '/';
204 service_filename += name;
207 std::list<std::pair<unsigned,unsigned>> command_offsets;
209 ServiceType service_type = ServiceType::PROCESS;
210 std::list<ServiceRecord *> depends_on;
211 std::list<ServiceRecord *> depends_soft;
213 OnstartFlags onstart_flags;
214 int term_signal = -1; // additional termination signal
217 bool auto_restart = false;
218 ifstream service_file;
219 service_file.exceptions(ios::badbit | ios::failbit);
222 service_file.open(service_filename.c_str(), ios::in);
224 catch (std::ios_base::failure &exc) {
225 throw ServiceNotFound(name);
228 // Add a dummy service record now to prevent infinite recursion in case of cyclic dependency
229 rval = new ServiceRecord(this, string(name));
230 records.push_back(rval);
233 // getline can set failbit if it reaches end-of-file, we don't want an exception in that case:
234 service_file.exceptions(ios::badbit);
236 while (! (service_file.rdstate() & ios::eofbit)) {
237 getline(service_file, line);
238 string::iterator i = line.begin();
239 string::iterator end = line.end();
244 continue; // comment line
246 string setting = read_setting_name(i, end);
248 if (i == end || (*i != '=' && *i != ':')) {
249 throw ServiceDescriptionExc(name, "Badly formed line.");
251 i = skipws(++i, end);
253 if (setting == "command") {
254 command = read_setting_value(i, end, &command_offsets);
256 else if (setting == "depends-on") {
257 string dependency_name = read_setting_value(i, end);
258 depends_on.push_back(loadServiceRecord(dependency_name.c_str()));
260 else if (setting == "waits-for") {
261 string dependency_name = read_setting_value(i, end);
262 depends_soft.push_back(loadServiceRecord(dependency_name.c_str()));
264 else if (setting == "logfile") {
265 logfile = read_setting_value(i, end);
267 else if (setting == "restart") {
268 string restart = read_setting_value(i, end);
269 auto_restart = (restart == "yes" || restart == "true");
271 else if (setting == "type") {
272 string type_str = read_setting_value(i, end);
273 if (type_str == "scripted") {
274 service_type = ServiceType::SCRIPTED;
276 else if (type_str == "process") {
277 service_type = ServiceType::PROCESS;
279 else if (type_str == "internal") {
280 service_type = ServiceType::INTERNAL;
283 throw ServiceDescriptionExc(name, "Service type must be \"scripted\""
284 " or \"process\" or \"internal\"");
287 else if (setting == "onstart") {
288 std::list<std::pair<unsigned,unsigned>> indices;
289 string onstart_cmds = read_setting_value(i, end, &indices);
290 for (auto indexpair : indices) {
291 string onstart_cmd = onstart_cmds.substr(indexpair.first, indexpair.second - indexpair.first);
292 if (onstart_cmd == "release_console") {
293 onstart_flags.release_console = true;
295 else if (onstart_cmd == "rw_ready") {
296 onstart_flags.rw_ready = true;
299 throw new ServiceDescriptionExc(name, "Unknown onstart command: " + onstart_cmd);
303 else if (setting == "termsignal") {
304 string signame = read_setting_value(i, end, nullptr);
305 int signo = signalNameToNumber(signame);
307 throw new ServiceDescriptionExc(name, "Unknown/unsupported termination signal: " + signame);
313 else if (setting == "nosigterm") {
314 string sigtermsetting = read_setting_value(i, end);
315 onstart_flags.no_sigterm = (sigtermsetting == "yes" || sigtermsetting == "true");
318 throw ServiceDescriptionExc(name, "Unknown setting: " + setting);
323 service_file.close();
324 // TODO check we actually have all the settings - type, command
326 // Now replace the dummy service record with a real record:
327 for (auto iter = records.begin(); iter != records.end(); iter++) {
329 // We've found the dummy record
331 rval = new ServiceRecord(this, string(name), service_type, std::move(command), command_offsets,
332 & depends_on, & depends_soft);
333 rval->setLogfile(logfile);
334 rval->setAutoRestart(auto_restart);
335 rval->setOnstartFlags(onstart_flags);
336 rval->setExtraTerminationSignal(term_signal);
345 // Must remove the dummy service record.
346 std::remove(records.begin(), records.end(), rval);