tempfile.c

   1 /* tempfile.c
   2  * Routines to create temporary files
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #include "config.h"
  26
  27 #include <glib.h>
  28
  29 #include <time.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <stdio.h>
  33 #include <errno.h>
  34
  35 #ifdef HAVE_FCNTL_H
  36 #include <fcntl.h>
  37 #endif
  38
  39 #ifdef HAVE_UNISTD_H
  40 #include <unistd.h>
  41 #endif
  42
  43 #ifdef HAVE_WINDOWS_H
  44 #include <windows.h>
  45 #endif
  46
  47 #ifdef _WIN32
  48 #include <process.h>    /* For getpid() */
  49 #endif
  50
  51 #include "tempfile.h"
  52 #include <wsutil/file_util.h>
  53
  54 #ifndef __set_errno
  55 #define __set_errno(x) errno=(x)
  56 #endif
  57
  58 #define INITIAL_PATH_SIZE   128
  59 #define TMP_FILE_SUFFIX     "XXXXXX"
  60
  61 #ifndef HAVE_MKSTEMP
  62 /* Generate a unique temporary file name from TEMPLATE.
  63    The last six characters of TEMPLATE must be TMP_FILE_SUFFIX;
  64    they are replaced with a string that makes the filename unique.
  65    Returns a file descriptor open on the file for reading and writing.  */
  66 static int
  67 mkstemp (char *template)
  68 {
  69   static const char letters[]
  70     = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
  71   size_t len;
  72   size_t i;
  73
  74   len = strlen (template);
  75   if (len < 6 || strcmp (&template[len - 6], TMP_FILE_SUFFIX))
  76     {
  77       __set_errno (EINVAL);
  78       return -1;
  79     }
  80
  81   if (g_snprintf (&template[len - 5], 6, "%.5u",
  82                (unsigned int) getpid () % 100000) != 5)
  83     /* Inconceivable lossage.  */
  84     return -1;
  85
  86   for (i = 0; i < sizeof (letters); ++i)
  87     {
  88       int fd;
  89
  90       template[len - 6] = letters[i];
  91
  92       fd = ws_open (template, O_RDWR|O_BINARY|O_CREAT|O_EXCL, 0600);
  93       if (fd >= 0)
  94         return fd;
  95     }
  96
  97   /* We return the null string if we can't find a unique file name.  */
  98
  99   template[0] = '\0';
 100   return -1;
 101 }
 102
 103 #endif /* HAVE_MKSTEMP */
 104
 105 #ifndef HAVE_MKDTEMP
 106 /* Generate a unique temporary directory name from TEMPLATE.
 107    The last six characters of TEMPLATE must be TMP_FILE_SUFFIX;
 108    they are replaced with a string that makes the filename unique.
 109    Returns 0 on success or -1 on error (from mkdir(2)).  */
 110 char *
 111 mkdtemp (char *template)
 112 {
 113   static const char letters[]
 114     = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
 115   size_t len;
 116   size_t i;
 117
 118   len = strlen (template);
 119   if (len < 6 || strcmp (&template[len - 6], TMP_FILE_SUFFIX))
 120     {
 121       __set_errno (EINVAL);
 122       return NULL;
 123     }
 124
 125   if (g_snprintf (&template[len - 5], 6, "%.5u",
 126                (unsigned int) getpid () % 100000) != 5)
 127     /* Inconceivable lossage.  */
 128     return NULL;
 129
 130   for (i = 0; i < sizeof (letters); ++i)
 131     {
 132       int ret;
 133
 134       template[len - 6] = letters[i];
 135
 136       ret = ws_mkdir(template, 0700);
 137       if (ret >= 0)
 138         return template;
 139     }
 140
 141   /* We return the null string if we can't find a unique file name.  */
 142
 143   template[0] = '\0';
 144   return NULL;
 145 }
 146
 147 #endif /* HAVE_MKDTEMP */
 148
 149 #define MAX_TEMPFILES   3
 150
 151 /**
 152  * Create a tempfile with the given prefix (e.g. "wireshark").
 153  *
 154  * @param namebuf If not NULL, receives the full path of the temp file.
 155  *                Should NOT be freed.
 156  * @param pfx A prefix for the temporary file.
 157  * @return The file descriptor of the new tempfile, from mkstemp().
 158  */
 159 int
 160 create_tempfile(char **namebuf, const char *pfx)
 161 {
 162         static struct _tf {
 163                 char *path;
 164                 unsigned long len;
 165         } tf[MAX_TEMPFILES];
 166         static int idx;
 167
 168         const char *tmp_dir;
 169         int old_umask;
 170         int fd;
 171         time_t current_time;
 172         char timestr[14 + 1];
 173         gchar *tmp_file;
 174         gchar sep[2] = {0, 0};
 175
 176         idx = (idx + 1) % MAX_TEMPFILES;
 177
 178         /*
 179          * Allocate the buffer if it's not already allocated.
 180          */
 181         if (tf[idx].path == NULL) {
 182                 tf[idx].len = INITIAL_PATH_SIZE;
 183                 tf[idx].path = (char *)g_malloc(tf[idx].len);
 184         }
 185
 186         /*
 187          * We can't use get_tempfile_path here because we're called from dumpcap.c.
 188          */
 189         tmp_dir = g_get_tmp_dir();
 190
 191 #ifdef _WIN32
 192         _tzset();
 193 #endif
 194         current_time = time(NULL);
 195         strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(&current_time));
 196         sep[0] = G_DIR_SEPARATOR;
 197         tmp_file = g_strconcat(tmp_dir, sep, pfx, "_", timestr, "_", TMP_FILE_SUFFIX, NULL);
 198         if (strlen(tmp_file) > tf[idx].len) {
 199                 tf[idx].len = (int)strlen(tmp_file) + 1;
 200                 tf[idx].path = (char *)g_realloc(tf[idx].path, tf[idx].len);
 201         }
 202         g_strlcpy(tf[idx].path, tmp_file, tf[idx].len);
 203         g_free(tmp_file);
 204
 205         if (namebuf) {
 206                 *namebuf = tf[idx].path;
 207         }
 208         /* The Single UNIX Specification doesn't say that "mkstemp()"
 209            creates the temporary file with mode rw-------, so we
 210            won't assume that all UNIXes will do so; instead, we set
 211            the umask to 0077 to take away all group and other
 212            permissions, attempt to create the file, and then put
 213            the umask back. */
 214         old_umask = umask(0077);
 215         fd = mkstemp(tf[idx].path);
 216         umask(old_umask);
 217         return fd;
 218 }
 219
 220 /**
 221  * Create a directory with the given prefix (e.g. "wireshark"). The path
 222  * is created using g_get_tmp_dir and mkdtemp.
 223  *
 224  * @param namebuf
 225  * @param pfx A prefix for the temporary directory.
 226  * @return The temporary directory path on success, or NULL on failure.
 227  *         Must NOT be freed.
 228  */
 229 const char *
 230 create_tempdir(char **namebuf, const char *pfx)
 231 {
 232         static char *td_path[3];
 233         static int td_path_len[3];
 234         static int idx;
 235         const char *tmp_dir;
 236
 237         idx = (idx + 1) % 3;
 238
 239         /*
 240          * Allocate the buffer if it's not already allocated.
 241          */
 242         if (td_path[idx] == NULL) {
 243                 td_path_len[idx] = INITIAL_PATH_SIZE;
 244                 td_path[idx] = (char *)g_malloc(td_path_len[idx]);
 245         }
 246
 247         /*
 248          * We can't use get_tempfile_path here because we're called from dumpcap.c.
 249          */
 250         tmp_dir = g_get_tmp_dir();
 251
 252         while (g_snprintf(td_path[idx], td_path_len[idx], "%s%c%s" TMP_FILE_SUFFIX, tmp_dir, G_DIR_SEPARATOR, pfx) > td_path_len[idx]) {
 253                 td_path_len[idx] *= 2;
 254                 td_path[idx] = (char *)g_realloc(td_path[idx], td_path_len[idx]);
 255         }
 256
 257         if (namebuf) {
 258                 *namebuf = td_path[idx];
 259         }
 260         return mkdtemp(td_path[idx]);
 261 }