adding number of preferences to allow iterating over preferences
[oweals/gnunet.git] / src / include / gnunet_disk_lib.h
index 0a3abce4908067a607cac862139f64722b8004b5..6b832b4ecd2e1b5dd164c685bf0873b91805f2b7 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001-2012 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001-2012 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
 #ifndef GNUNET_DISK_LIB_H
 #define GNUNET_DISK_LIB_H
 
-#if WINDOWS
-#define OFF_T uint64_t
-#else
-#define OFF_T off_t
-#endif
-
 /**
  * Handle used to manage a pipe.
  */
@@ -41,10 +35,15 @@ struct GNUNET_DISK_PipeHandle;
  */
 enum GNUNET_FILE_Type
 {
+  /**
+   * Handle represents an event.
+   */
+  GNUNET_DISK_HANLDE_TYPE_EVENT,
+
   /**
    * Handle represents a file.
-   */ 
-  GNUNET_DISK_HANLDE_TYPE_FILE, 
+   */
+  GNUNET_DISK_HANLDE_TYPE_FILE,
 
   /**
    * Handle represents a pipe.
@@ -157,7 +156,7 @@ enum GNUNET_DISK_MapType
    * Read-only memory map.
    */
   GNUNET_DISK_MAP_TYPE_READ = 1,
-  
+
   /**
    * Write-able memory map.
    */
@@ -271,7 +270,7 @@ enum GNUNET_DISK_PipeEnd
  * Checks whether a handle is invalid
  *
  * @param h handle to check
- * @return GNUNET_YES if invalid, GNUNET_NO if valid
+ * @return #GNUNET_YES if invalid, #GNUNET_NO if valid
  */
 int
 GNUNET_DISK_handle_invalid (const struct GNUNET_DISK_FileHandle *h);
@@ -307,8 +306,8 @@ GNUNET_DISK_file_backup (const char *fil);
  * @param whence specification to which position the offset parameter relates to
  * @return the new position on success, GNUNET_SYSERR otherwise
  */
-OFF_T
-GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, OFF_T offset,
+off_t
+GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, off_t offset,
                        enum GNUNET_DISK_Seek whence);
 
 
@@ -328,7 +327,7 @@ GNUNET_DISK_file_seek (const struct GNUNET_DISK_FileHandle *h, OFF_T offset,
  */
 int
 GNUNET_DISK_file_size (const char *filename, uint64_t *size,
-                       int include_symbolic_links, 
+                       int include_symbolic_links,
                        int single_file_mode);
 
 
@@ -348,7 +347,7 @@ GNUNET_DISK_file_size (const char *filename, uint64_t *size,
  * @return GNUNET_OK on success
  */
 int
-GNUNET_DISK_file_get_identifiers (const char *filename, 
+GNUNET_DISK_file_get_identifiers (const char *filename,
                                   uint64_t *dev,
                                   uint64_t *ino);
 
@@ -394,7 +393,7 @@ GNUNET_DISK_mkdtemp (const char *t);
  * @return IO handle on success, NULL on error
  */
 struct GNUNET_DISK_FileHandle *
-GNUNET_DISK_file_open (const char *fn, 
+GNUNET_DISK_file_open (const char *fn,
                        enum GNUNET_DISK_OpenFlags flags,
                        enum GNUNET_DISK_AccessPermissions perm);
 
@@ -408,7 +407,7 @@ GNUNET_DISK_file_open (const char *fn,
  */
 int
 GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh,
-                             OFF_T *size);
+                             off_t *size);
 
 
 /**
@@ -421,9 +420,9 @@ GNUNET_DISK_file_handle_size (struct GNUNET_DISK_FileHandle *fh,
  * @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, 
+GNUNET_DISK_pipe (int blocking_read,
+                  int blocking_write,
+                  int inherit_read,
                   int inherit_write);
 
 
@@ -438,8 +437,8 @@ GNUNET_DISK_pipe (int blocking_read,
  * @return handle to the new pipe, NULL on error
  */
 struct GNUNET_DISK_PipeHandle *
-GNUNET_DISK_pipe_from_fd (int blocking_read, 
-                          int blocking_write, 
+GNUNET_DISK_pipe_from_fd (int blocking_read,
+                          int blocking_write,
                           int fd[2]);
 
 
@@ -514,6 +513,21 @@ struct GNUNET_DISK_FileHandle *
 GNUNET_DISK_get_handle_from_w32_handle (HANDLE osfh);
 #endif
 
+/**
+ * Update POSIX permissions mask of a file on disk.  If both argumets
+ * are #GNUNET_NO, the file is made world-read-write-executable (777).
+ * Does nothing on W32.
+ *
+ * @param fn name of the file to update
+ * @param require_uid_match #GNUNET_YES means 700
+ * @param require_gid_match #GNUNET_YES means 770 unless @a require_uid_match is set
+ */
+void
+GNUNET_DISK_fix_permissions (const char *fn,
+                             int require_uid_match,
+                             int require_gid_match);
+
+
 
 /**
  * Get a handle from a native integer FD.
@@ -544,7 +558,7 @@ GNUNET_DISK_get_handle_from_native (FILE *fd);
  * @return the number of bytes read on success, #GNUNET_SYSERR on failure
  */
 ssize_t
-GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h, 
+GNUNET_DISK_file_read (const struct GNUNET_DISK_FileHandle *h,
                        void *result,
                        size_t len);
 
@@ -575,7 +589,7 @@ GNUNET_DISK_file_read_non_blocking (const struct GNUNET_DISK_FileHandle * h,
  */
 ssize_t
 GNUNET_DISK_fn_read (const char *fn,
-                     void *result, 
+                     void *result,
                      size_t len);
 
 
@@ -589,7 +603,7 @@ GNUNET_DISK_fn_read (const char *fn,
  */
 ssize_t
 GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h,
-                        const void *buffer, 
+                        const void *buffer,
                         size_t n);
 
 
@@ -603,7 +617,7 @@ GNUNET_DISK_file_write (const struct GNUNET_DISK_FileHandle *h,
  */
 ssize_t
 GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle *h,
-                                const void *buffer, 
+                                const void *buffer,
                                 size_t n);
 
 
@@ -619,7 +633,7 @@ GNUNET_DISK_file_write_blocking (const struct GNUNET_DISK_FileHandle *h,
  */
 ssize_t
 GNUNET_DISK_fn_write (const char *fn,
-                      const void *buffer, 
+                      const void *buffer,
                       size_t n,
                       enum GNUNET_DISK_AccessPermissions mode);
 
@@ -766,9 +780,9 @@ GNUNET_DISK_directory_create (const char *dir);
  * @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);
 
 
 /**
@@ -780,9 +794,9 @@ GNUNET_DISK_file_lock (struct GNUNET_DISK_FileHandle *fh,
  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
  */
 int
-GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh, 
-                         OFF_T unlock_start,
-                         OFF_T unlock_end);
+GNUNET_DISK_file_unlock (struct GNUNET_DISK_FileHandle *fh,
+                         off_t unlock_start,
+                         off_t unlock_end);
 
 
 /**
@@ -803,25 +817,6 @@ int
 GNUNET_DISK_file_change_owner (const char *filename, const char *user);
 
 
-/**
- * Construct full path to a file inside of the private
- * directory used by GNUnet.  Also creates the corresponding
- * directory.  If the resulting name is supposed to be
- * a directory, end the last argument in '/' (or pass
- * DIR_SEPARATOR_STR as the last argument before NULL).
- *
- * @param cfg configuration to use
- * @param service_name name of the service asking
- * @param ... is NULL-terminated list of
- *                path components to append to the
- *                private directory name.
- * @return the constructed filename
- */
-char *
-GNUNET_DISK_get_home_filename (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                               const char *service_name, ...);
-
-
 /**
  * Opaque handle for a memory-mapping operation.
  */