Include a Other Software section in Help file
[geeqie.git] / src / secure_save.c
index 5815c28..2fefe7a 100644 (file)
@@ -1,31 +1,41 @@
 /*
- * Geeqie
- * Copyright (C) 2008 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;
 
@@ -94,9 +105,9 @@ secure_open_umask(const gchar *file_name)
 
        /* Check properties of final file. */
 #ifndef NO_UNIX_SOFTLINKS
-       if (g_lstat(ssi->file_name, &st)) {
+       if (lstat(ssi->file_name, &st)) {
 #else
-       if (g_stat(ssi->file_name, &st)) {
+       if (stat(ssi->file_name, &st)) {
 #endif
                /* We ignore error caused by file inexistence. */
                if (errno != ENOENT) {
@@ -123,7 +134,7 @@ secure_open_umask(const gchar *file_name)
                        /* We still have a race condition here between
                         * [l]stat() and fopen() */
 
-                       f1 = g_fopen(ssi->file_name, "rb+");
+                       f1 = fopen(ssi->file_name, "rb+");
                        if (f1) {
                                fclose(f1);
                        } else {
@@ -167,7 +178,7 @@ secure_open_umask(const gchar *file_name)
                ssi->tmp_file_name = randname;
        } else {
                /* No need to create a temporary file here. */
-               ssi->fp = g_fopen(ssi->file_name, "wb");
+               ssi->fp = fopen(ssi->file_name, "wb");
                if (!ssi->fp) {
                        secsave_errno = SS_ERR_OPEN_WRITE;
                        ssi->err = errno;
@@ -232,7 +243,7 @@ secure_close(SecureSaveInfo *ssi)
         * while closing file releases file descriptor we need to call fsync(). */
 #if defined(HAVE_FFLUSH) || defined(HAVE_FSYNC)
        if (ssi->secure_save) {
-               int fail = 0;
+               gboolean fail = FALSE;
 
 #ifdef HAVE_FFLUSH
                fail = (fflush(ssi->fp) == EOF);
@@ -262,21 +273,22 @@ secure_close(SecureSaveInfo *ssi)
        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..).  */
 #ifndef NO_UNIX_SOFTLINKS
-               if (g_lstat(ssi->file_name, &st) == 0)
+               if (lstat(ssi->file_name, &st) == 0)
 #else
-               if (g_stat(ssi->file_name, &st) == 0)
+               if (stat(ssi->file_name, &st) == 0)
 #endif
                        {
                        /* set the dest file attributes to that of source (ignoring errors) */
                        if (ssi->preserve_perms)
                                {
-                               chown(ssi->tmp_file_name, st.st_uid, st.st_gid);
-                               chmod(ssi->tmp_file_name, st.st_mode);
+                               if (chown(ssi->tmp_file_name, st.st_uid, st.st_gid) != 0) log_printf("chown('%s', %d, %d) failed", ssi->tmp_file_name, st.st_uid, st.st_gid);
+                               if (chmod(ssi->tmp_file_name, st.st_mode) != 0) log_printf("chmod('%s', %o) failed", ssi->tmp_file_name, st.st_mode);
                                }
 
                        if (ssi->preserve_mtime)
@@ -288,8 +300,7 @@ secure_close(SecureSaveInfo *ssi)
                                utime(ssi->tmp_file_name, &tb);
                                }
                        }
-               DEBUG_3("rename %s -> %s", ssi->tmp_file_name, ssi->file_name);
-               if (g_rename(ssi->tmp_file_name, ssi->file_name) == -1) {
+               if (rename(ssi->tmp_file_name, ssi->file_name) == -1) {
                        ret = errno;
                        secsave_errno = SS_ERR_RENAME;
                        goto free;
@@ -312,7 +323,7 @@ free:
 
 
 /** 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)
@@ -332,7 +343,7 @@ 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)
@@ -351,7 +362,7 @@ 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, ...)
@@ -362,18 +373,17 @@ secure_fprintf(SecureSaveInfo *ssi, const gchar *format, ...)
        if (!ssi || !ssi->fp || ssi->err) return -1;
 
        va_start(ap, format);
-       ret = vfprintf(ssi->fp, format, ap);
-       if (ret < 0) ssi->err = errno;
+       ret = g_vfprintf(ssi->fp, format, ap);
        va_end(ap);
 
        return ret;
 }
 
 /** 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(const void *ptr, size_t size, size_t nmemb, SecureSaveInfo *ssi)
+secure_fwrite(gconstpointer ptr, size_t size, size_t nmemb, SecureSaveInfo *ssi)
 {
        size_t ret;
 
@@ -415,3 +425,4 @@ secsave_strerror(SecureSaveErrno secsave_error)
                return _("Secure file saving error");
        }
 }
+/* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */