mirror of
https://git.savannah.gnu.org/git/coreutils.git
synced 2026-11-19 03:33:43 +03:00
* src/mktemp.c (main): Use an exit() strategy consistent with the previous clauses dealing with optional error messages to ensure we exit with the correct status in all cases. Prompted by the continuous integration build failure at: http://hydra.nixos.org/build/6412979
350 lines
9.8 KiB
C
350 lines
9.8 KiB
C
/* Create a temporary file or directory, safely.
|
|
Copyright (C) 2007-2013 Free Software Foundation, Inc.
|
|
|
|
This program 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.
|
|
|
|
This program 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/>. */
|
|
|
|
/* Written by Jim Meyering and Eric Blake. */
|
|
|
|
#include <config.h>
|
|
#include <sys/types.h>
|
|
#include <getopt.h>
|
|
|
|
#include "system.h"
|
|
|
|
#include "close-stream.h"
|
|
#include "error.h"
|
|
#include "filenamecat.h"
|
|
#include "quote.h"
|
|
#include "tempname.h"
|
|
|
|
/* The official name of this program (e.g., no 'g' prefix). */
|
|
#define PROGRAM_NAME "mktemp"
|
|
|
|
#define AUTHORS \
|
|
proper_name ("Jim Meyering"), \
|
|
proper_name ("Eric Blake")
|
|
|
|
static const char *default_template = "tmp.XXXXXXXXXX";
|
|
|
|
/* For long options that have no equivalent short option, use a
|
|
non-character as a pseudo short option, starting with CHAR_MAX + 1. */
|
|
enum
|
|
{
|
|
SUFFIX_OPTION = CHAR_MAX + 1,
|
|
};
|
|
|
|
static struct option const longopts[] =
|
|
{
|
|
{"directory", no_argument, NULL, 'd'},
|
|
{"quiet", no_argument, NULL, 'q'},
|
|
{"dry-run", no_argument, NULL, 'u'},
|
|
{"suffix", required_argument, NULL, SUFFIX_OPTION},
|
|
{"tmpdir", optional_argument, NULL, 'p'},
|
|
{GETOPT_HELP_OPTION_DECL},
|
|
{GETOPT_VERSION_OPTION_DECL},
|
|
{NULL, 0, NULL, 0}
|
|
};
|
|
|
|
void
|
|
usage (int status)
|
|
{
|
|
if (status != EXIT_SUCCESS)
|
|
emit_try_help ();
|
|
else
|
|
{
|
|
printf (_("Usage: %s [OPTION]... [TEMPLATE]\n"), program_name);
|
|
fputs (_("\
|
|
Create a temporary file or directory, safely, and print its name.\n\
|
|
TEMPLATE must contain at least 3 consecutive 'X's in last component.\n\
|
|
If TEMPLATE is not specified, use tmp.XXXXXXXXXX, and --tmpdir is implied.\n\
|
|
"), stdout);
|
|
fputs (_("\
|
|
Files are created u+rw, and directories u+rwx, minus umask restrictions.\n\
|
|
"), stdout);
|
|
fputs ("\n", stdout);
|
|
fputs (_("\
|
|
-d, --directory create a directory, not a file\n\
|
|
-u, --dry-run do not create anything; merely print a name (unsafe)\n\
|
|
-q, --quiet suppress diagnostics about file/dir-creation failure\n\
|
|
"), stdout);
|
|
fputs (_("\
|
|
--suffix=SUFF append SUFF to TEMPLATE; SUFF must not contain a slash.\n\
|
|
This option is implied if TEMPLATE does not end in X\n\
|
|
"), stdout);
|
|
fputs (_("\
|
|
-p DIR, --tmpdir[=DIR] interpret TEMPLATE relative to DIR; if DIR is not\n\
|
|
specified, use $TMPDIR if set, else /tmp. With\n\
|
|
this option, TEMPLATE must not be an absolute name;\n\
|
|
unlike with -t, TEMPLATE may contain slashes, but\n\
|
|
mktemp creates only the final component\n\
|
|
"), stdout);
|
|
fputs (_("\
|
|
-t interpret TEMPLATE as a single file name component,\n\
|
|
relative to a directory: $TMPDIR, if set; else the\n\
|
|
directory specified via -p; else /tmp [deprecated]\n\
|
|
"), stdout);
|
|
fputs (HELP_OPTION_DESCRIPTION, stdout);
|
|
fputs (VERSION_OPTION_DESCRIPTION, stdout);
|
|
emit_ancillary_info ();
|
|
}
|
|
|
|
exit (status);
|
|
}
|
|
|
|
static size_t
|
|
count_consecutive_X_s (const char *s, size_t len)
|
|
{
|
|
size_t n = 0;
|
|
for ( ; len && s[len-1] == 'X'; len--)
|
|
++n;
|
|
return n;
|
|
}
|
|
|
|
static int
|
|
mkstemp_len (char *tmpl, size_t suff_len, size_t x_len, bool dry_run)
|
|
{
|
|
return gen_tempname_len (tmpl, suff_len, 0, dry_run ? GT_NOCREATE : GT_FILE,
|
|
x_len);
|
|
}
|
|
|
|
static int
|
|
mkdtemp_len (char *tmpl, size_t suff_len, size_t x_len, bool dry_run)
|
|
{
|
|
return gen_tempname_len (tmpl, suff_len, 0, dry_run ? GT_NOCREATE : GT_DIR,
|
|
x_len);
|
|
}
|
|
|
|
/* True if we have already closed standard output. */
|
|
static bool stdout_closed;
|
|
|
|
/* Avoid closing stdout twice. Since we conditionally call
|
|
close_stream (stdout) in order to decide whether to clean up a
|
|
temporary file, the exit hook needs to know whether to do all of
|
|
close_stdout or just the stderr half. */
|
|
static void
|
|
maybe_close_stdout (void)
|
|
{
|
|
if (!stdout_closed)
|
|
close_stdout ();
|
|
else if (close_stream (stderr) != 0)
|
|
_exit (EXIT_FAILURE);
|
|
}
|
|
|
|
int
|
|
main (int argc, char **argv)
|
|
{
|
|
char const *dest_dir;
|
|
char const *dest_dir_arg = NULL;
|
|
bool suppress_file_err = false;
|
|
int c;
|
|
unsigned int n_args;
|
|
char *template;
|
|
char *suffix = NULL;
|
|
bool use_dest_dir = false;
|
|
bool deprecated_t_option = false;
|
|
bool create_directory = false;
|
|
bool dry_run = false;
|
|
int status = EXIT_SUCCESS;
|
|
size_t x_count;
|
|
size_t suffix_len;
|
|
char *dest_name;
|
|
|
|
initialize_main (&argc, &argv);
|
|
set_program_name (argv[0]);
|
|
setlocale (LC_ALL, "");
|
|
bindtextdomain (PACKAGE, LOCALEDIR);
|
|
textdomain (PACKAGE);
|
|
|
|
atexit (maybe_close_stdout);
|
|
|
|
while ((c = getopt_long (argc, argv, "dp:qtuV", longopts, NULL)) != -1)
|
|
{
|
|
switch (c)
|
|
{
|
|
case 'd':
|
|
create_directory = true;
|
|
break;
|
|
case 'p':
|
|
dest_dir_arg = optarg;
|
|
use_dest_dir = true;
|
|
break;
|
|
case 'q':
|
|
suppress_file_err = true;
|
|
break;
|
|
case 't':
|
|
use_dest_dir = true;
|
|
deprecated_t_option = true;
|
|
break;
|
|
case 'u':
|
|
dry_run = true;
|
|
break;
|
|
|
|
case SUFFIX_OPTION:
|
|
suffix = optarg;
|
|
break;
|
|
|
|
case_GETOPT_HELP_CHAR;
|
|
|
|
case 'V': /* Undocumented alias, for compatibility with the original
|
|
mktemp program. */
|
|
case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
|
|
default:
|
|
usage (EXIT_FAILURE);
|
|
}
|
|
}
|
|
|
|
n_args = argc - optind;
|
|
if (2 <= n_args)
|
|
{
|
|
error (0, 0, _("too many templates"));
|
|
usage (EXIT_FAILURE);
|
|
}
|
|
|
|
if (n_args == 0)
|
|
{
|
|
use_dest_dir = true;
|
|
template = (char *) default_template;
|
|
}
|
|
else
|
|
{
|
|
template = argv[optind];
|
|
}
|
|
|
|
if (suffix)
|
|
{
|
|
size_t len = strlen (template);
|
|
if (!len || template[len - 1] != 'X')
|
|
{
|
|
error (EXIT_FAILURE, 0,
|
|
_("with --suffix, template %s must end in X"),
|
|
quote (template));
|
|
}
|
|
suffix_len = strlen (suffix);
|
|
dest_name = xcharalloc (len + suffix_len + 1);
|
|
memcpy (dest_name, template, len);
|
|
memcpy (dest_name + len, suffix, suffix_len + 1);
|
|
template = dest_name;
|
|
suffix = dest_name + len;
|
|
}
|
|
else
|
|
{
|
|
template = xstrdup (template);
|
|
suffix = strrchr (template, 'X');
|
|
if (!suffix)
|
|
suffix = strchr (template, '\0');
|
|
else
|
|
suffix++;
|
|
suffix_len = strlen (suffix);
|
|
}
|
|
|
|
/* At this point, template is malloc'd, and suffix points into template. */
|
|
if (suffix_len && last_component (suffix) != suffix)
|
|
{
|
|
error (EXIT_FAILURE, 0,
|
|
_("invalid suffix %s, contains directory separator"),
|
|
quote (suffix));
|
|
}
|
|
x_count = count_consecutive_X_s (template, suffix - template);
|
|
if (x_count < 3)
|
|
error (EXIT_FAILURE, 0, _("too few X's in template %s"), quote (template));
|
|
|
|
if (use_dest_dir)
|
|
{
|
|
if (deprecated_t_option)
|
|
{
|
|
char *env = getenv ("TMPDIR");
|
|
if (env && *env)
|
|
dest_dir = env;
|
|
else if (dest_dir_arg && *dest_dir_arg)
|
|
dest_dir = dest_dir_arg;
|
|
else
|
|
dest_dir = "/tmp";
|
|
|
|
if (last_component (template) != template)
|
|
error (EXIT_FAILURE, 0,
|
|
_("invalid template, %s, contains directory separator"),
|
|
quote (template));
|
|
}
|
|
else
|
|
{
|
|
if (dest_dir_arg && *dest_dir_arg)
|
|
dest_dir = dest_dir_arg;
|
|
else
|
|
{
|
|
char *env = getenv ("TMPDIR");
|
|
dest_dir = (env && *env ? env : "/tmp");
|
|
}
|
|
if (IS_ABSOLUTE_FILE_NAME (template))
|
|
error (EXIT_FAILURE, 0,
|
|
_("invalid template, %s; with --tmpdir,"
|
|
" it may not be absolute"),
|
|
quote (template));
|
|
}
|
|
|
|
dest_name = file_name_concat (dest_dir, template, NULL);
|
|
free (template);
|
|
template = dest_name;
|
|
/* Note that suffix is now invalid. */
|
|
}
|
|
|
|
/* Make a copy to be used in case of diagnostic, since failing
|
|
mkstemp may leave the buffer in an undefined state. */
|
|
dest_name = xstrdup (template);
|
|
|
|
if (create_directory)
|
|
{
|
|
int err = mkdtemp_len (dest_name, suffix_len, x_count, dry_run);
|
|
if (err != 0)
|
|
{
|
|
if (!suppress_file_err)
|
|
error (0, errno, _("failed to create directory via template %s"),
|
|
quote (template));
|
|
status = EXIT_FAILURE;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
int fd = mkstemp_len (dest_name, suffix_len, x_count, dry_run);
|
|
if (fd < 0 || (!dry_run && close (fd) != 0))
|
|
{
|
|
if (!suppress_file_err)
|
|
error (0, errno, _("failed to create file via template %s"),
|
|
quote (template));
|
|
status = EXIT_FAILURE;
|
|
}
|
|
}
|
|
|
|
if (status == EXIT_SUCCESS)
|
|
{
|
|
puts (dest_name);
|
|
/* If we created a file, but then failed to output the file
|
|
name, we should clean up the mess before failing. */
|
|
if (!dry_run && ((stdout_closed = true), close_stream (stdout) != 0))
|
|
{
|
|
int saved_errno = errno;
|
|
remove (dest_name);
|
|
if (!suppress_file_err)
|
|
error (0, saved_errno, _("write error"));
|
|
status = EXIT_FAILURE;
|
|
}
|
|
}
|
|
|
|
#ifdef lint
|
|
free (dest_name);
|
|
free (template);
|
|
#endif
|
|
|
|
exit (status);
|
|
}
|