src/secure-save.h

   1 /*
   2  * Copyright (C) 2008 - 2016 The Geeqie Team
   3  *
   4  * Author: Laurent Monin
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #ifndef SECURE_SAVE_H
  22 #define SECURE_SAVE_H
  23
  24 /**
  25  * @enum SecureSaveErrno
  26  * see err field in #SecureSaveInfo
  27  */
  28 enum SecureSaveErrno {
  29         SS_ERR_NONE = 0,
  30         SS_ERR_DISABLED, /**< secsave is disabled. */
  31         SS_ERR_OUT_OF_MEM, /**< memory allocation failure */
  32
  33         SS_ERR_OPEN_READ,
  34         SS_ERR_OPEN_WRITE,
  35         SS_ERR_STAT,
  36         SS_ERR_ACCESS,
  37         SS_ERR_MKSTEMP,
  38         SS_ERR_RENAME,
  39         SS_ERR_OTHER,
  40 };
  41
  42 extern SecureSaveErrno secsave_errno; /**< internal secsave error number */
  43
  44 struct SecureSaveInfo {
  45         FILE *fp; /**< file stream pointer */
  46         gchar *file_name; /**< final file name */
  47         gchar *tmp_file_name; /**< temporary file name */
  48         gint err; /**< set to non-zero value in case of error */
  49         gboolean secure_save; /**< use secure save for this file, internal use only */
  50         gboolean preserve_perms; /**< whether to preserve perms, TRUE by default */
  51         gboolean preserve_mtime; /**< whether to preserve mtime, FALSE by default */
  52         gboolean unlink_on_error; /**< whether to remove temporary file on save failure, TRUE by default */
  53 };
  54
  55 SecureSaveInfo *secure_open(const gchar *);
  56
  57 gint secure_close(SecureSaveInfo *);
  58
  59 gint secure_fputs(SecureSaveInfo *, const gchar *);
  60 gint secure_fputc(SecureSaveInfo *, gint);
  61
  62 gint secure_fprintf(SecureSaveInfo *, const gchar *, ...);
  63 size_t secure_fwrite(gconstpointer ptr, size_t size, size_t nmemb, SecureSaveInfo *ssi);
  64
  65 gchar *secsave_strerror(SecureSaveErrno);
  66
  67 #endif /* SECURE_SAVE_H */
  68 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */