folly/Shell.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   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
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * `Shell` provides a collection of functions to use with `Subprocess` that make
  19  * it easier to safely run processes in a unix shell.
  20  *
  21  * Note: use this rarely and carefully. By default you should use `Subprocess`
  22  * with a vector of arguments.
  23  */
  24
  25 #pragma once
  26
  27 #include <string>
  28 #include <vector>
  29
  30 #include <folly/Conv.h>
  31 #include <folly/Format.h>
  32 #include <folly/Range.h>
  33
  34 namespace folly {
  35
  36 /**
  37  * Quotes an argument to make it suitable for use as shell command arguments.
  38  */
  39 std::string shellQuote(StringPiece argument);
  40
  41 /**
  42   * Create argument array for `Subprocess()` for a process running in a
  43   * shell.
  44   *
  45   * The shell to use is always going to be `/bin/sh`.
  46   *
  47   * The format string should always be a string literal to protect against
  48   * shell injections. Arguments will automatically be escaped with `'`.
  49   *
  50   * TODO(dominik): find a way to ensure statically determined format strings.
  51   */
  52 template <typename... Arguments>
  53 std::vector<std::string> shellify(
  54     const StringPiece format,
  55     Arguments&&... arguments) {
  56   auto command = sformat(
  57       format,
  58       shellQuote(to<std::string>(std::forward<Arguments>(arguments)))...);
  59   return {"/bin/sh", "-c", command};
  60 }
  61
  62 } // folly