/*
- * Geeqie
- * Copyright (C) 2008 - 2009 The Geeqie Team
+ * Copyright (C) 2008 - 2016 The Geeqie Team
*
- * based on the code developped for ELinks by Laurent Monin
+ * Author: Laurent Monin
*
- * This software is released under the GNU General Public License (GNU GPL).
- * Please read the included file COPYING for more information.
- * This software comes with no warranty of any kind, use at your own risk!
+ * 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
+#include "main.h"
#include <glib/gprintf.h>
#include <glib/gstdio.h>
#include <errno.h>
#include <utime.h>
-#include "main.h"
#include "secure_save.h"
-
-/* ABOUT SECURE SAVE */
-/* This code was borrowed from the ELinks project (http://elinks.cz)
+/**
+ * @file secure_save.c
+ *
+ * ABOUT SECURE SAVE \n
+ * This code was borrowed from the ELinks project (http://elinks.cz)
* It was originally written by me (Laurent Monin aka Zas) and heavily
* modified and improved by all ELinks contributors.
* This code was released under the GPLv2 licence.
- * It was modified to be included in geeqie on 2008/04/05 */
-
-/* If ssi->secure_save is TRUE:
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * It was modified to be included in geeqie on 2008/04/05
+ * If ssi->secure_save is TRUE:
*
* A call to secure_open("/home/me/.confdir/filename", mask) will open a file
* named "filename.tmp_XXXXXX" in /home/me/.confdir/ and return a pointer to a
* then secsave is disabled for that file.
*
* If ssi->secure_save is FALSE:
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* No temporary file is created, "filename" is truncated, all operations are
* done on it, no rename nor flush occur, symlinks are preserved.
*
* In both cases:
- * ~~~~~~~~~~~~~
*
* Access rights are affected by secure_open() mask parameter.
*/
-/* FIXME: locking system on files about to be rewritten ? */
-/* FIXME: Low risk race conditions about ssi->file_name. */
+/**
+ * @file
+ * @FIXME locking system on files about to be rewritten ?
+ * @FIXME Low risk race conditions about ssi->file_name.
+ */
SecureSaveErrno secsave_errno = SS_ERR_NONE;
* while closing file releases file descriptor we need to call fsync(). */
#if defined(HAVE_FFLUSH) || defined(HAVE_FSYNC)
if (ssi->secure_save) {
- gint fail = 0;
+ gboolean fail = FALSE;
#ifdef HAVE_FFLUSH
fail = (fflush(ssi->fp) == EOF);
if (ssi->secure_save && ssi->file_name && ssi->tmp_file_name) {
struct stat st;
- /* FIXME: Race condition on ssi->file_name. The file
+ /**
+ * @FIXME Race condition on ssi->file_name. The file
* named ssi->file_name may have changed since
* secure_open() call (where we stat() file and
* more..). */
utime(ssi->tmp_file_name, &tb);
}
}
- DEBUG_3("rename %s -> %s", ssi->tmp_file_name, ssi->file_name);
if (rename(ssi->tmp_file_name, ssi->file_name) == -1) {
ret = errno;
secsave_errno = SS_ERR_RENAME;
/** fputs() wrapper, set ssi->err to errno on error. If ssi->err is set when
- * called, it immediatly returns EOF.
+ * called, it immediately returns EOF.
*/
gint
secure_fputs(SecureSaveInfo *ssi, const gchar *s)
/** fputc() wrapper, set ssi->err to errno on error. If ssi->err is set when
- * called, it immediatly returns EOF.
+ * called, it immediately returns EOF.
*/
gint
secure_fputc(SecureSaveInfo *ssi, gint c)
}
/** fprintf() wrapper, set ssi->err to errno on error and return a negative
- * value. If ssi->err is set when called, it immediatly returns -1.
+ * value. If ssi->err is set when called, it immediately returns -1.
*/
gint
secure_fprintf(SecureSaveInfo *ssi, const gchar *format, ...)
}
/** fwrite() wrapper, set ssi->err to errno on error and return a value less than
- * the number of elements to write. If ssi->err is set when called, it immediatly returns 0.
+ * the number of elements to write. If ssi->err is set when called, it immediately returns 0.
*/
size_t
secure_fwrite(gconstpointer ptr, size_t size, size_t nmemb, SecureSaveInfo *ssi)
projects / geeqie.git / blobdiff