tmp.h File Reference

Create Temporary Files. More...

#include <stdio.h>

Include dependency graph for tmp.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	mutt_mktemp(buf, buflen)   mutt_mktemp_pfx_sfx(buf, buflen, "neomutt", NULL)
#define	mutt_mktemp_pfx_sfx(buf, buflen, prefix, suffix)   mutt_mktemp_full(buf, buflen, prefix, suffix, __FILE__, __LINE__)
#define	buf_mktemp(buf)   buf_mktemp_pfx_sfx(buf, "neomutt", NULL)
#define	buf_mktemp_pfx_sfx(buf, prefix, suffix)   buf_mktemp_full(buf, prefix, suffix, __FILE__, __LINE__)
#define	mutt_file_mkstemp()   mutt_file_mkstemp_full(__FILE__, __LINE__, __func__)

Functions
void	buf_mktemp_full (struct Buffer *buf, const char *prefix, const char *suffix, const char *src, int line)
	Create a temporary file. More...
FILE *	mutt_file_mkstemp_full (const char *file, int line, const char *func)
	Create temporary file safely. More...
void	mutt_mktemp_full (char *s, size_t slen, const char *prefix, const char *suffix, const char *src, int line)
	Create a temporary filename. More...

Detailed Description

Create Temporary Files.

Authors

• Richard Russon

Copyright

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 2 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/.

Definition in file tmp.h.

Macro Definition Documentation

mutt_mktemp

#define mutt_mktemp	(		buf,
			buflen
	)		mutt_mktemp_pfx_sfx(buf, buflen, "neomutt", NULL)

Definition at line 34 of file tmp.h.

mutt_mktemp_pfx_sfx

#define mutt_mktemp_pfx_sfx	(		buf,
			buflen,
			prefix,
			suffix
	)		mutt_mktemp_full(buf, buflen, prefix, suffix, __FILE__, __LINE__)

Definition at line 35 of file tmp.h.

buf_mktemp

#define buf_mktemp

(

buf

)

buf_mktemp_pfx_sfx(buf, "neomutt", NULL)

Definition at line 37 of file tmp.h.

buf_mktemp_pfx_sfx

#define buf_mktemp_pfx_sfx	(		buf,
			prefix,
			suffix
	)		buf_mktemp_full(buf, prefix, suffix, __FILE__, __LINE__)

Definition at line 38 of file tmp.h.

mutt_file_mkstemp

#define mutt_file_mkstemp

(

)

mutt_file_mkstemp_full(__FILE__, __LINE__, __func__)

Definition at line 40 of file tmp.h.

Function Documentation

buf_mktemp_full()

void buf_mktemp_full	(	struct Buffer *	buf,
		const char *	prefix,
		const char *	suffix,
		const char *	src,
		int	line
	)

Create a temporary file.

Parameters

buf	Buffer for result
prefix	Prefix for filename
suffix	Suffix for filename
src	Source file of caller
line	Source line number of caller

Definition at line 50 of file tmp.c.

{
  const char *const c_tmp_dir = cs_subset_path(NeoMutt->sub, "tmp_dir");
  buf_printf(buf, "%s/%s-%s-%d-%d-%" PRIu64 "%s%s", NONULL(c_tmp_dir),
             NONULL(prefix), NONULL(ShortHostname), (int) getuid(),
             (int) getpid(), mutt_rand64(), suffix ? "." : "", NONULL(suffix));
 
  mutt_debug(LL_DEBUG3, "%s:%d: mutt_mktemp returns \"%s\"\n", src, line, buf_string(buf));
  if (unlink(buf_string(buf)) && (errno != ENOENT))
  {
    mutt_debug(LL_DEBUG1, "%s:%d: ERROR: unlink(\"%s\"): %s (errno %d)\n", src,
               line, buf_string(buf), strerror(errno), errno);
  }
}

Here is the call graph for this function:

mutt_file_mkstemp_full()

FILE * mutt_file_mkstemp_full	(	const char *	file,
		int	line,
		const char *	func
	)

Create temporary file safely.

Parameters

file	Source file of caller
line	Source line number of caller
func	Function name of caller

Return values

ptr	FILE handle
NULL	Error, see errno

Create and immediately unlink a temp file using mkstemp().

Definition at line 76 of file tmp.c.

{
  char name[PATH_MAX] = { 0 };
 
  const char *const c_tmp_dir = cs_subset_path(NeoMutt->sub, "tmp_dir");
  int n = snprintf(name, sizeof(name), "%s/neomutt-XXXXXX", NONULL(c_tmp_dir));
  if (n < 0)
    return NULL;
 
  int fd = mkstemp(name);
  if (fd == -1)
    return NULL;
 
  FILE *fp = fdopen(fd, "w+");
 
  if ((unlink(name) != 0) && (errno != ENOENT))
  {
    mutt_file_fclose(&fp);
    return NULL;
  }
 
  MuttLogger(0, file, line, func, 1, "created temp file '%s'\n", name);
  return fp;
}

Here is the call graph for this function:

mutt_mktemp_full()

void mutt_mktemp_full	(	char *	buf,
		size_t	buflen,
		const char *	prefix,
		const char *	suffix,
		const char *	src,
		int	line
	)

Create a temporary filename.

Parameters

buf	Buffer for result
buflen	Length of buffer
prefix	Prefix for filename
suffix	Suffix for filename
src	Source file of caller
line	Source line number of caller

Note

This doesn't create the file, only the name

Definition at line 112 of file tmp.c.

{
  const char *const c_tmp_dir = cs_subset_path(NeoMutt->sub, "tmp_dir");
  size_t n = snprintf(buf, buflen, "%s/%s-%s-%d-%d-%" PRIu64 "%s%s",
                      NONULL(c_tmp_dir), NONULL(prefix), NONULL(ShortHostname),
                      (int) getuid(), (int) getpid(), mutt_rand64(),
                      suffix ? "." : "", NONULL(suffix));
  if (n >= buflen)
  {
    mutt_debug(LL_DEBUG1, "%s:%d: ERROR: insufficient buffer space to hold temporary filename! buflen=%zu but need %zu\n",
               src, line, buflen, n);
  }
  mutt_debug(LL_DEBUG3, "%s:%d: mutt_mktemp returns \"%s\"\n", src, line, buf);
  if ((unlink(buf) != 0) && (errno != ENOENT))
  {
    mutt_debug(LL_DEBUG1, "%s:%d: ERROR: unlink(\"%s\"): %s (errno %d)\n", src,
               line, buf, strerror(errno), errno);
  }
}

Here is the call graph for this function: