2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * `Shell` provides a collection of functions to use with `Subprocess` that make
19 * it easier to safely run processes in a unix shell.
21 * Note: use this rarely and carefully. By default you should use `Subprocess`
22 * with a vector of arguments.
30 #include <folly/Conv.h>
31 #include <folly/Format.h>
32 #include <folly/Range.h>
37 * Quotes an argument to make it suitable for use as shell command arguments.
39 std::string shellQuote(StringPiece argument);
42 template <typename... Arguments>
43 std::vector<std::string> shellify(
45 Arguments&&... arguments) {
46 auto command = sformat(
48 shellQuote(to<std::string>(std::forward<Arguments>(arguments)))...);
49 return {"/bin/sh", "-c", command};
52 struct ShellCmdFormat {
54 template <typename... Arguments>
55 std::vector<std::string> operator()(Arguments&&... arguments) const {
56 return ::folly::detail::shellify(
57 format, std::forward<Arguments>(arguments)...);
63 inline namespace literals {
64 inline namespace shell_literals {
65 constexpr detail::ShellCmdFormat operator"" _shellify(
68 return {folly::StringPiece(name, length)};
70 } // namespace shell_literals
71 } // namespace literals
74 * Create argument array for `Subprocess()` for a process running in a
77 * The shell to use is always going to be `/bin/sh`.
79 * This is deprecated in favour of the user-defined-literal `_shellify`
80 * from namespace `folly::shell_literals` because that requires that the format
81 * string is a compile-time constant which can be inspected during code reviews
83 template <typename... Arguments>
85 "Use `\"command {} {} ...\"_shellify(argument1, argument2 ...)` from "
86 "namespace `folly::literals::shell_literals`")
87 std::vector<std::string> shellify(
89 Arguments&&... arguments) {
90 return detail::shellify(format, std::forward<Arguments>(arguments)...);