File: sbuild-run-parts.h

package info (click to toggle)
schroot 1.6.4-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,684 kB
  • sloc: cpp: 21,427; sh: 12,516; makefile: 829; ansic: 231; sed: 16
file content (207 lines) | stat: -rw-r--r-- 5,757 bytes parent folder | download | duplicates (2)
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
/* Copyright © 2005-2009  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 3 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, see
 * <http://www.gnu.org/licenses/>.
 *
 *********************************************************************/

#ifndef SBUILD_RUN_PARTS_H
#define SBUILD_RUN_PARTS_H

#include <sbuild/sbuild-custom-error.h>
#include <sbuild/sbuild-environment.h>
#include <sbuild/sbuild-types.h>

#include <set>
#include <string>

#include <sys/types.h>
#include <sys/stat.h>

namespace sbuild
{

  /**
   * Run all scripts or programs within a directory.
   */
  class run_parts
  {
  public:
    /// Error codes.
    enum error_code
      {
	CHILD_FORK, ///< Failed to fork child.
	CHILD_WAIT, ///< Wait for child failed.
	EXEC,       ///< Failed to execute.
	PIPE,       ///< Failed to create pipe.
	DUP,        ///< Failed to duplicate file descriptor.
	POLL,       ///< Failed to poll file descriptor.
	READ        ///< Failed to read file descriptor.
      };

    /// Exception type.
    typedef custom_error<error_code> error;

    /**
     *  The constructor.
     *
     * @param directory the directory to run scripts from.
     * @param lsb_mode use Linux Standard Base filename requirements.
     * If true, the following patterns are permitted: LANANA
     * ("^[a-z0-9]+$"), LSB ("^_?([a-z0-9_.]+-)+[a-z0-9]+$"), and
     * Debian cron ("^[a-z0-9][a-z0-9-]*$").  Debian dpkg conffile
     * backups are not permitted ("dpkg-(old|dist|new|tmp)$").  If
     * false, the traditional run-parts pattern is used
     * ("^[a-zA-Z0-9_-]$").
     * @param abort_on_error stop executing scripts if one returns an error.
     * @param umask the umask to set when running scripts.
     */
    run_parts (std::string const& directory,
	       bool               lsb_mode = true,
	       bool               abort_on_error = true,
	       mode_t             umask = 022);

    /// The destructor.
    ~run_parts ();

    /**
     * Get the verbosity level.
     *
     * @returns true if verbose, otherwise false.
     */
    bool
    get_verbose () const;

    /**
     * Set the verbosity level.
     *
     * @param verbose true to be verbose, otherwise false.
     */
    void
    set_verbose (bool verbose);

    /**
     * Get the script execution order.
     *
     * @returns true if executing in reverse, otherwise false.
     */
    bool
    get_reverse () const;

    /**
     * Set the script execution order.
     *
     * @param reverse true to execute in reverse, otherwise false.
     */
    void
    set_reverse (bool reverse);

    /**
     * Run all scripts in the specified directory.  If abort_on_error
     * is true, execution will stop at the first script to fail.
     *
     * @param command the command to run.
     * @param env the environment to use.
     * @returns the exit status of the scripts.  This will be 0 on
     * success, or the exit status of the last failing script.
     */
    int
    run(string_list const& command,
	environment const& env);

    /**
     * Output the environment to an ostream.
     *
     * @param stream the stream to output to.
     * @param rhs the environment to output.
     * @returns the stream.
     */
    template <class charT, class traits>
    friend
    std::basic_ostream<charT,traits>&
    operator << (std::basic_ostream<charT,traits>& stream,
		 run_parts const&                  rhs)
    {
      if (!rhs.reverse)
	{
	  for (program_set::const_iterator pos = rhs.programs.begin();
	       pos != rhs.programs.end();
	       ++pos)
	    stream << *pos << '\n';
	}
      else
	{
	  for (program_set::const_reverse_iterator pos = rhs.programs.rbegin();
	       pos != rhs.programs.rend();
	       ++pos)
	    stream << *pos << '\n';
	}
      return stream;
    }

  private:
    /**
     * Run the command specified by file (an absolute pathname), using
     * command and env as the argv and environment, respectively.
     *
     * @param file the program to execute.
     * @param command the arguments to pass to the executable.
     * @param env the environment.
     * @returns the return value of the execve system call on failure.
     */
    int
    run_child(std::string const& file,
	      string_list const& command,
	      environment const& env);

    /**
     * Wait for a child process to complete, and check its exit status.
     *
     * An error will be thrown on failure.
     *
     * @param pid the pid to wait for.
     * @param child_status the place to store the child exit status.
     */
    void
    wait_for_child (pid_t pid,
		    int&  child_status);

    /// A sorted set of filenames to use.
    typedef std::set<std::string> program_set;

    /// The LSB mode for allowed filenames.
    bool        lsb_mode;
    /// Whether to abort on script execution error.
    bool        abort_on_error;
    /// The umask to run scripts with.
    mode_t      umask;
    /// Verbose logging.
    bool        verbose;
    /// Execute scripts in reverse order.
    bool        reverse;
    /// The directory to run scripts from.
    std::string directory;
    /// The list of scripts to run.
    program_set programs;
  };

}

#endif /* SBUILD_RUN_PARTS_H */

/*
 * Local Variables:
 * mode:C++
 * End:
 */