sh-quote.c

   1 /* Shell quoting.
   2    Copyright (C) 2001-2004, 2006, 2009-2022 Free Software Foundation, Inc.
   3    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation, either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 /* Specification.  */
  19 #include "sh-quote.h"
  20
  21 #include <stdint.h>
  22 #include <string.h>
  23
  24 #include "quotearg.h"
  25
  26 /* Describes quoting for sh compatible shells.  */
  27 static const struct quoting_options sh_quoting_options =
  28   {
  29     quoting_style_shell,
  30     0,
  31     { 0 },
  32     NULL,
  33     NULL
  34   };
  35
  36 /* Returns the number of bytes needed for the quoted string.  */
  37 size_t
  38 shell_quote_length (const char *string)
  39 {
  40   return quotearg_buffer (NULL, 0, string, strlen (string),
  41                           &sh_quoting_options);
  42 }
  43
  44 /* Copies the quoted string to p and returns the incremented p.
  45    There must be room for shell_quote_length (string) + 1 bytes at p.  */
  46 char *
  47 shell_quote_copy (char *p, const char *string)
  48 {
  49   return p + quotearg_buffer (p, SIZE_MAX, string, strlen (string), &sh_quoting_options);
  50 }
  51
  52 /* Returns the freshly allocated quoted string.  */
  53 char *
  54 shell_quote (const char *string)
  55 {
  56   return quotearg_allocate (string, strlen (string), &sh_quoting_options);
  57 }
  58
  59 /* Returns a freshly allocated string containing all argument strings, quoted,
  60    separated through spaces.  */
  61 char *
  62 shell_quote_argv (const char *const *argv)
  63 {
  64   if (*argv != NULL)
  65     {
  66       const char * const *argp;
  67       size_t length;
  68       char *command;
  69       char *p;
  70
  71       length = 0;
  72
  73       for (argp = argv;;)
  74         {
  75           length += shell_quote_length (*argp) + 1;
  76           argp++;
  77
  78           if (*argp == NULL)
  79             break;
  80         }
  81
  82       command = malloc (length);
  83
  84       if (command == NULL)
  85         return NULL;
  86
  87       p = command;
  88
  89       for (argp = argv;;)
  90         {
  91           p = shell_quote_copy (p, *argp);
  92           argp++;
  93
  94           if (*argp == NULL)
  95             break;
  96
  97           *p++ = ' ';
  98         }
  99
 100       *p = '\0';
 101       return command;
 102     }
 103   else
 104     return strdup ("");
 105 }