/*
This file is part of GNUnet.
- Copyright (C) 2001--2013 GNUnet e.V.
+ Copyright (C) 2001--2013, 2016, 2018 GNUnet e.V.
- GNUnet 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 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet 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.
+ Affero General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @file util/disk.c
#include "gnunet_strings_lib.h"
#include "gnunet_disk_lib.h"
-#define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
+#define LOG(kind,...) GNUNET_log_from (kind, "util-disk", __VA_ARGS__)
-#define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
+#define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util-disk", syscall)
-#define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
+#define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util-disk", syscall, filename)
/**
* Block size for IO for copying files.
* @return the new position on success, #GNUNET_SYSERR otherwise
*/
off_t
-GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle * h, off_t offset,
+GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h,
+ off_t offset,
enum GNUNET_DISK_Seek whence)
{
if (h == NULL)
BY_HANDLE_FILE_INFORMATION info;
int succ;
- fh = GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ, 0);
- if (fh == NULL)
+ fh = GNUNET_DISK_file_open (filename,
+ GNUNET_DISK_OPEN_READ,
+ GNUNET_DISK_PERM_NONE);
+ if (NULL == fh)
return GNUNET_SYSERR;
succ = GetFileInformationByHandle (fh->h, &info);
GNUNET_DISK_file_close (fh);
GNUNET_DISK_mkdtemp (const char *t)
{
char *fn;
+ mode_t omask;
+ omask = umask (S_IWGRP | S_IWOTH | S_IRGRP | S_IROTH);
fn = mktemp_name (t);
if (fn != mkdtemp (fn))
{
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkstemp", fn);
+ LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkdtemp", fn);
GNUNET_free (fn);
+ umask (omask);
return NULL;
}
+ umask (omask);
return fn;
}
{
int fd;
char *fn;
+ mode_t omask;
+ omask = umask (S_IWGRP | S_IWOTH | S_IRGRP | S_IROTH);
fn = mktemp_name (t);
if (-1 == (fd = mkstemp (fn)))
{
LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_ERROR, "mkstemp", fn);
GNUNET_free (fn);
+ umask (omask);
return NULL;
}
+ umask (omask);
if (0 != CLOSE (fd))
LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "close", fn);
return fn;
* does not exist or stat'ed
*/
int
-GNUNET_DISK_directory_test (const char *fil, int is_readable)
+GNUNET_DISK_directory_test (const char *fil,
+ int is_readable)
{
struct stat filestat;
int ret;
}
if (!S_ISDIR (filestat.st_mode))
{
- LOG (GNUNET_ERROR_TYPE_DEBUG,
+ LOG (GNUNET_ERROR_TYPE_INFO,
"A file already exits with the same name %s\n", fil);
return GNUNET_NO;
}
rdir = GNUNET_STRINGS_filename_expand (dir);
if (rdir == NULL)
+ {
+ GNUNET_break (0);
return GNUNET_SYSERR;
+ }
len = strlen (rdir);
#ifndef MINGW
ret = GNUNET_DISK_directory_test (rdir, GNUNET_NO);
if (GNUNET_NO == ret)
{
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ "Creating directory `%s' failed",
+ rdir);
GNUNET_free (rdir);
return GNUNET_SYSERR;
}
ret = GNUNET_DISK_directory_test (rdir, GNUNET_NO);
if (GNUNET_NO == ret)
{
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ "Creating directory `%s' failed",
+ rdir);
GNUNET_free (rdir);
return GNUNET_SYSERR;
}
char *rdir;
size_t len;
int ret;
+ int eno;
rdir = GNUNET_STRINGS_filename_expand (filename);
- if (rdir == NULL)
+ if (NULL == rdir)
+ {
+ errno = EINVAL;
return GNUNET_SYSERR;
+ }
+ if (0 == ACCESS (rdir, W_OK))
+ {
+ GNUNET_free (rdir);
+ return GNUNET_OK;
+ }
+
len = strlen (rdir);
while ((len > 0) && (rdir[len] != DIR_SEPARATOR))
len--;
rdir[len] = '\0';
/* The empty path is invalid and in this case refers to / */
- if (0 == len) {
+ if (0 == len)
+ {
GNUNET_free (rdir);
rdir = GNUNET_strdup ("/");
}
ret = GNUNET_DISK_directory_create (rdir);
- if ((ret == GNUNET_OK) && (0 != ACCESS (rdir, W_OK)))
+ if ((GNUNET_OK == ret) && (0 != ACCESS (rdir, W_OK)))
ret = GNUNET_NO;
+ eno = errno;
GNUNET_free (rdir);
+ errno = eno;
return ret;
}
*/
ssize_t
GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle * h,
- const void *buffer, size_t n)
+ const void *buffer,
+ size_t n)
{
if (NULL == h)
{
fh = GNUNET_DISK_file_open (fn,
GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_TRUNCATE
| GNUNET_DISK_OPEN_CREATE, mode);
- if (!fh)
+ if (! fh)
return GNUNET_SYSERR;
ret = GNUNET_DISK_file_write (fh, buffer, n);
GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
GNUNET_assert (NULL != dir_name);
dname = GNUNET_STRINGS_filename_expand (dir_name);
- if (dname == NULL)
+ if (NULL == dname)
return GNUNET_SYSERR;
- while ((strlen (dname) > 0) && (dname[strlen (dname) - 1] == DIR_SEPARATOR))
+ while ( (strlen (dname) > 0) &&
+ (dname[strlen (dname) - 1] == DIR_SEPARATOR) )
dname[strlen (dname) - 1] = '\0';
if (0 != STAT (dname, &istat))
{
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "stat", dname);
+ LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
+ "stat",
+ dname);
GNUNET_free (dname);
return GNUNET_SYSERR;
}
}
errno = 0;
dinfo = OPENDIR (dname);
- if ((errno == EACCES) || (NULL == dinfo))
+ if ( (EACCES == errno) ||
+ (NULL == dinfo) )
{
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "opendir", dname);
- if (dinfo != NULL)
+ LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
+ "opendir",
+ dname);
+ if (NULL != dinfo)
CLOSEDIR (dinfo);
GNUNET_free (dname);
return GNUNET_SYSERR;
}
name_len = 256;
- n_size = strlen (dname) + name_len + 2;
+ n_size = strlen (dname) + name_len + strlen (DIR_SEPARATOR_STR) + 1;
name = GNUNET_malloc (n_size);
while (NULL != (finfo = READDIR (dinfo)))
{
- if ((0 == strcmp (finfo->d_name, ".")) ||
- (0 == strcmp (finfo->d_name, "..")))
+ if ( (0 == strcmp (finfo->d_name, ".")) ||
+ (0 == strcmp (finfo->d_name, "..")) )
continue;
if (NULL != callback)
{
{
GNUNET_free (name);
name_len = strlen (finfo->d_name);
- n_size = strlen (dname) + name_len + 2;
+ n_size = strlen (dname) + name_len + strlen (DIR_SEPARATOR_STR) + 1;
name = GNUNET_malloc (n_size);
}
/* dname can end in "/" only if dname == "/";
* if dname does not end in "/", we need to add
* a "/" (otherwise, we must not!) */
- GNUNET_snprintf (name, n_size, "%s%s%s", dname,
- (strcmp (dname, DIR_SEPARATOR_STR) ==
- 0) ? "" : DIR_SEPARATOR_STR, finfo->d_name);
- ret = callback (callback_cls, name);
+ GNUNET_snprintf (name,
+ n_size,
+ "%s%s%s",
+ dname,
+ (0 == strcmp (dname,
+ DIR_SEPARATOR_STR))
+ ? ""
+ : DIR_SEPARATOR_STR,
+ finfo->d_name);
+ ret = callback (callback_cls,
+ name);
if (GNUNET_OK != ret)
{
CLOSEDIR (dinfo);
/**
* Function that removes the given directory by calling
- * "GNUNET_DISK_directory_remove".
+ * #GNUNET_DISK_directory_remove().
*
* @param unused not used
* @param fn directory to remove
* @return #GNUNET_OK
*/
static int
-remove_helper (void *unused, const char *fn)
+remove_helper (void *unused,
+ const char *fn)
{
+ (void) unused;
(void) GNUNET_DISK_directory_remove (fn);
return GNUNET_OK;
}
/**
- * Remove all files in a directory (rm -rf). Call with
+ * Remove all files in a directory (rm -r). Call with
* caution.
*
* @param filename the file to remove
}
if (0 != LSTAT (filename, &istat))
return GNUNET_NO; /* file may not exist... */
- (void) CHMOD (filename, S_IWUSR | S_IRUSR | S_IXUSR);
- if (UNLINK (filename) == 0)
+ (void) CHMOD (filename,
+ S_IWUSR | S_IRUSR | S_IXUSR);
+ if (0 == UNLINK (filename))
return GNUNET_OK;
- if ((errno != EISDIR) &&
- /* EISDIR is not sufficient in all cases, e.g.
- * sticky /tmp directory may result in EPERM on BSD.
- * So we also explicitly check "isDirectory" */
- (GNUNET_YES != GNUNET_DISK_directory_test (filename, GNUNET_YES)))
- {
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "rmdir", filename);
+ if ( (errno != EISDIR) &&
+ /* EISDIR is not sufficient in all cases, e.g.
+ * sticky /tmp directory may result in EPERM on BSD.
+ * So we also explicitly check "isDirectory" */
+ (GNUNET_YES !=
+ GNUNET_DISK_directory_test (filename,
+ GNUNET_YES)) )
+ {
+ LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
+ "rmdir",
+ filename);
return GNUNET_SYSERR;
}
if (GNUNET_SYSERR ==
- GNUNET_DISK_directory_scan (filename, &remove_helper, NULL))
+ GNUNET_DISK_directory_scan (filename,
+ &remove_helper,
+ NULL))
return GNUNET_SYSERR;
if (0 != RMDIR (filename))
{
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "rmdir", filename);
+ LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
+ "rmdir",
+ filename);
return GNUNET_SYSERR;
}
return GNUNET_OK;
uint64_t pos;
uint64_t size;
size_t len;
+ ssize_t sret;
struct GNUNET_DISK_FileHandle *in;
struct GNUNET_DISK_FileHandle *out;
- if (GNUNET_OK != GNUNET_DISK_file_size (src, &size, GNUNET_YES, GNUNET_YES))
+ if (GNUNET_OK !=
+ GNUNET_DISK_file_size (src,
+ &size,
+ GNUNET_YES,
+ GNUNET_YES))
+ {
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
+ "stat",
+ src);
return GNUNET_SYSERR;
+ }
pos = 0;
- in = GNUNET_DISK_file_open (src, GNUNET_DISK_OPEN_READ,
+ in = GNUNET_DISK_file_open (src,
+ GNUNET_DISK_OPEN_READ,
GNUNET_DISK_PERM_NONE);
- if (!in)
+ if (! in)
+ {
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
+ "open",
+ src);
return GNUNET_SYSERR;
+ }
out =
GNUNET_DISK_file_open (dst,
GNUNET_DISK_OPEN_WRITE | GNUNET_DISK_OPEN_CREATE |
GNUNET_DISK_PERM_GROUP_WRITE);
if (!out)
{
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
+ "open",
+ dst);
GNUNET_DISK_file_close (in);
return GNUNET_SYSERR;
}
len = COPY_BLK_SIZE;
if (len > size - pos)
len = size - pos;
- if (len != GNUNET_DISK_file_read (in, buf, len))
+ sret = GNUNET_DISK_file_read (in,
+ buf,
+ len);
+ if ( (sret < 0) ||
+ (len != (size_t) sret) )
goto FAIL;
- if (len != GNUNET_DISK_file_write (out, buf, len))
+ sret = GNUNET_DISK_file_write (out,
+ buf,
+ len);
+ if ( (sret < 0) ||
+ (len != (size_t) sret) )
goto FAIL;
pos += len;
}
char *idx;
char c;
- idx = fn;
- while (*idx)
+ for (idx = fn; *idx; idx++)
{
c = *idx;
- if (c == '/' || c == '\\' || c == ':' || c == '*' || c == '?' || c == '"' ||
+ if (c == '/' || c == '\\' || c == ':' ||
+ c == '*' || c == '?' || c == '"' ||
c == '<' || c == '>' || c == '|')
{
*idx = '_';
}
-
- idx++;
}
}
*
* @param filename name of file to change the owner of
* @param user name of the new owner
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
-GNUNET_DISK_file_change_owner (const char *filename, const char *user)
+GNUNET_DISK_file_change_owner (const char *filename,
+ const char *user)
{
#ifndef MINGW
struct passwd *pws;
pws = getpwnam (user);
- if (pws == NULL)
+ if (NULL == pws)
{
LOG (GNUNET_ERROR_TYPE_ERROR,
- _("Cannot obtain information about user `%s': %s\n"), user,
+ _("Cannot obtain information about user `%s': %s\n"),
+ user,
STRERROR (errno));
return GNUNET_SYSERR;
}
- if (0 != chown (filename, pws->pw_uid, pws->pw_gid))
- LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING, "chown", filename);
+ if (0 != chown (filename,
+ pws->pw_uid,
+ pws->pw_gid))
+ {
+ LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
+ "chown",
+ filename);
+ return GNUNET_SYSERR;
+ }
#endif
return GNUNET_OK;
}
/**
* Lock a part of a file
+ *
* @param fh file handle
* @param lock_start absolute position from where to lock
* @param lock_end absolute position until where to lock
- * @param excl GNUNET_YES for an exclusive lock
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @param excl #GNUNET_YES for an exclusive lock
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
-GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh, off_t lock_start,
- off_t lock_end, int excl)
+GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh,
+ off_t lock_start,
+ off_t lock_end,
+ int excl)
{
if (fh == NULL)
{
/**
* Unlock a part of a file
+ *
* @param fh file handle
* @param unlock_start absolute position from where to unlock
* @param unlock_end absolute position until where to unlock
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
-GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, off_t unlock_start,
+GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh,
+ off_t unlock_start,
off_t unlock_end)
{
if (fh == NULL)
return NULL;
}
if (flags & GNUNET_DISK_OPEN_FAILIFEXISTS)
- oflags |= (O_CREAT | O_EXCL);
+ oflags |= (O_CREAT | O_EXCL);
if (flags & GNUNET_DISK_OPEN_TRUNCATE)
oflags |= O_TRUNC;
if (flags & GNUNET_DISK_OPEN_APPEND)
oflags |= O_APPEND;
- if (flags & GNUNET_DISK_OPEN_CREATE)
- {
- (void) GNUNET_DISK_directory_create_for_file (expfn);
- oflags |= O_CREAT;
- mode = translate_unix_perms (perm);
+ if(GNUNET_NO == GNUNET_DISK_file_test(fn))
+ {
+ if (flags & GNUNET_DISK_OPEN_CREATE )
+ {
+ (void) GNUNET_DISK_directory_create_for_file (expfn);
+ oflags |= O_CREAT;
+ mode = translate_unix_perms (perm);
+ }
}
fd = open (expfn, oflags
/**
- * Close an open file
+ * Close an open file.
+ *
* @param h file handle
- * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
*/
int
GNUNET_DISK_file_close (struct GNUNET_DISK_FileHandle *h)
ret = GNUNET_OK;
#if MINGW
- if (!CloseHandle (h->h))
+ if (! CloseHandle (h->h))
{
SetErrnoFromWinError (GetLastError ());
LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
}
if (h->oOverlapRead)
{
- if (!CloseHandle (h->oOverlapRead->hEvent))
+ if (! CloseHandle (h->oOverlapRead->hEvent))
{
SetErrnoFromWinError (GetLastError ());
LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "close");
return ret;
}
+
#ifdef WINDOWS
/**
* Get a GNUnet file handle from a W32 handle.
GNUNET_DISK_get_handle_from_w32_handle (HANDLE osfh)
{
struct GNUNET_DISK_FileHandle *fh;
-
DWORD dwret;
enum GNUNET_FILE_Type ftype;
ftype = GNUNET_DISK_HANLDE_TYPE_PIPE;
break;
case FILE_TYPE_UNKNOWN:
- if (GetLastError () == NO_ERROR || GetLastError () == ERROR_INVALID_HANDLE)
+ if ( (GetLastError () == NO_ERROR) ||
+ (GetLastError () == ERROR_INVALID_HANDLE) )
{
if (0 != ResetEvent (osfh))
ftype = GNUNET_DISK_HANLDE_TYPE_EVENT;
+ else
+ return NULL;
}
else
return NULL;
* @return handle to the new pipe, NULL on error
*/
struct GNUNET_DISK_PipeHandle *
-GNUNET_DISK_pipe (int blocking_read, int blocking_write, int inherit_read, int inherit_write)
+GNUNET_DISK_pipe (int blocking_read,
+ int blocking_write,
+ int inherit_read,
+ int inherit_write)
{
#ifndef MINGW
int fd[2];
int ret;
int eno;
+ (void) inherit_read;
+ (void) inherit_write;
ret = pipe (fd);
if (ret == -1)
{
eno = errno;
- LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR, "pipe");
+ LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR,
+ "pipe");
errno = eno;
return NULL;
}
return GNUNET_OK;
}
+
+/**
+ * Helper function for #GNUNET_DISK_purge_cfg_dir.
+ *
+ * @param cls a `const char *` with the option to purge
+ * @param cfg our configuration
+ * @return #GNUNET_OK on success
+ */
+static int
+purge_cfg_dir (void *cls,
+ const struct GNUNET_CONFIGURATION_Handle *cfg)
+{
+ const char *option = cls;
+ char *tmpname;
+
+ if (GNUNET_OK !=
+ GNUNET_CONFIGURATION_get_value_filename (cfg,
+ "PATHS",
+ option,
+ &tmpname))
+ {
+ GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+ "PATHS",
+ option);
+ return GNUNET_NO;
+ }
+ if (GNUNET_SYSERR ==
+ GNUNET_DISK_directory_remove (tmpname))
+ {
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
+ "remove",
+ tmpname);
+ GNUNET_free (tmpname);
+ return GNUNET_OK;
+ }
+ GNUNET_free (tmpname);
+ return GNUNET_OK;
+}
+
+
+/**
+ * Remove the directory given under @a option in
+ * section [PATHS] in configuration under @a cfg_filename
+ *
+ * @param cfg_filename configuration file to parse
+ * @param option option with the dir name to purge
+ */
+void
+GNUNET_DISK_purge_cfg_dir (const char *cfg_filename,
+ const char *option)
+{
+ GNUNET_break (GNUNET_OK ==
+ GNUNET_CONFIGURATION_parse_and_run (cfg_filename,
+ &purge_cfg_dir,
+ (void *) option));
+}
+
+
/* end of disk.c */
projects / oweals / gnunet.git / blobdiff