flush peer respect value on disconnect
[oweals/gnunet.git] / src / fs / gnunet-auto-share.c
index 8436e8442d2b28f824c5f6323a0690a0f155615b..32725f66f00d73e925f066cf01029b37b4c150c4 100644 (file)
  * @file fs/gnunet-auto-share.c
  * @brief automatically publish files on GNUnet
  * @author Christian Grothoff
+ *
+ * TODO:
+ * - support loading meta data / keywords from resource file
+ * - add stability timer (a la buildbot)
  */
 #include "platform.h"
 #include "gnunet_util_lib.h"
 
+#define MIN_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 4)
+
+#define MAX_FREQUENCY GNUNET_TIME_UNIT_MINUTES
+
 
 /**
  * Item in our work queue (or in the set of files/directories
@@ -46,7 +54,7 @@ struct WorkItem
   /**
    * Filename of the work item.
    */
-  const char *filename;
+  char *filename;
 
   /**
    * Unique identity for this work item (used to detect
@@ -71,6 +79,11 @@ static int verbose;
  */
 static const struct GNUNET_CONFIGURATION_Handle *cfg;
 
+/**
+ * Name of the configuration file.
+ */
+static char *cfg_filename;
+
 /**
  * Disable extractor option to use for publishing.
  */
@@ -139,6 +152,32 @@ static int do_shutdown;
  */
 static struct GNUNET_TIME_Absolute start_time;
 
+/**
+ * Pipe used to communicate 'gnunet-publish' completion (SIGCHLD) via signal.
+ */
+static struct GNUNET_DISK_PipeHandle *sigpipe;
+
+/**
+ * Handle to the 'gnunet-publish' process that we executed.
+ */
+static struct GNUNET_OS_Process *publish_proc;
+
+
+/**
+ * Compute the name of the state database file we will use.
+ */
+static char *
+get_state_file ()
+{
+  char *ret;
+
+  GNUNET_asprintf (&ret,
+                  "%s%s.auto-share",
+                  dir_name,
+                  (DIR_SEPARATOR == dir_name[strlen(dir_name)-1]) ? "" : DIR_SEPARATOR_STR);
+  return ret;
+}
+
 
 /**
  * Load the set of 'work_finished' items from disk.
@@ -146,8 +185,89 @@ static struct GNUNET_TIME_Absolute start_time;
 static void
 load_state ()
 {
-  GNUNET_break (0);
-  // FIXME: implement!
+  char *fn;
+  struct GNUNET_BIO_ReadHandle *rh;
+  uint32_t n;
+  struct GNUNET_HashCode id;
+  struct WorkItem *wi;
+  char *emsg;
+
+  emsg = NULL;
+  fn = get_state_file ();
+  rh = GNUNET_BIO_read_open (fn);
+  GNUNET_free (fn);
+  if (NULL == rh)
+    return;
+  fn = NULL;
+  if (GNUNET_OK != GNUNET_BIO_read_int32 (rh, &n))
+    goto error;
+  while (n-- > 0)
+  {
+    if ( (GNUNET_OK !=
+         GNUNET_BIO_read_string (rh, "filename", &fn, 1024)) ||
+        (GNUNET_OK !=
+         GNUNET_BIO_read (rh, "id", &id, sizeof (struct GNUNET_HashCode))) )
+      goto error;
+    wi = GNUNET_new (struct WorkItem);
+    wi->id = id;
+    wi->filename = fn;
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+               "Loaded serialization ID for `%s' is `%s'\n",
+               wi->filename,
+               GNUNET_h2s (&id));
+    fn = NULL;
+    GNUNET_CRYPTO_hash (wi->filename,
+                       strlen (wi->filename),
+                       &id);
+    GNUNET_break (GNUNET_OK ==
+                  GNUNET_CONTAINER_multihashmap_put (work_finished,
+                                                     &id,
+                                                     wi,
+                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
+  }
+  if (GNUNET_OK ==
+      GNUNET_BIO_read_close (rh, &emsg))
+    return;
+  rh = NULL;
+ error:
+  GNUNET_free_non_null (fn);
+  if (NULL != rh)
+    (void) GNUNET_BIO_read_close (rh, &emsg);
+  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+             _("Failed to load state: %s\n"),
+             emsg);
+  GNUNET_free_non_null (emsg);
+}
+
+
+/**
+ * Write work item from the work_finished map to the given write handle.
+ *
+ * @param cls the 'struct GNUNET_BIO_WriteHandle*'
+ * @param key key of the item in the map (unused)
+ * @param value the 'struct WorkItem' to write
+ * @return GNUNET_OK to continue to iterate (if write worked)
+ */
+static int
+write_item (void *cls,
+           const struct GNUNET_HashCode *key,
+           void *value)
+{
+  struct GNUNET_BIO_WriteHandle *wh = cls;
+  struct WorkItem *wi = value;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+             "Saving serialization ID of file `%s' with value `%s'\n",
+             wi->filename,
+             GNUNET_h2s (&wi->id));
+  if ( (GNUNET_OK !=
+       GNUNET_BIO_write_string (wh, wi->filename)) ||
+       (GNUNET_OK !=
+       GNUNET_BIO_write (wh,
+                         &wi->id,
+                         sizeof (struct GNUNET_HashCode))) )
+    return GNUNET_SYSERR; /* write error, abort iteration */
+  return GNUNET_OK;
 }
 
 
@@ -157,8 +277,39 @@ load_state ()
 static void
 save_state ()
 {
-  GNUNET_break (0);
-  // FIXME: implement!
+  uint32_t n;
+  struct GNUNET_BIO_WriteHandle *wh;
+  char *fn;
+
+  n = GNUNET_CONTAINER_multihashmap_size (work_finished);
+  fn = get_state_file ();
+  wh = GNUNET_BIO_write_open (fn);
+  if (NULL == wh)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+               _("Failed to save state to file %s\n"),
+               fn);
+    GNUNET_free (fn);
+    return;
+  }
+  if (GNUNET_OK !=
+      GNUNET_BIO_write_int32 (wh, n))
+  {
+    (void) GNUNET_BIO_write_close (wh);
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+               _("Failed to save state to file %s\n"),
+               fn);
+    GNUNET_free (fn);
+    return;
+  }
+  (void) GNUNET_CONTAINER_multihashmap_iterate (work_finished,
+                                               &write_item,
+                                               wh);
+  if (GNUNET_OK != GNUNET_BIO_write_close (wh))
+    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+               _("Failed to save state to file %s\n"),
+               fn);
+  GNUNET_free (fn);
 }
 
 
@@ -173,6 +324,11 @@ do_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   kill_task = GNUNET_SCHEDULER_NO_TASK;
   do_shutdown = GNUNET_YES;
+  if (NULL != publish_proc)
+  {
+    GNUNET_OS_process_kill (publish_proc, SIGKILL);
+    return;
+  }
   if (GNUNET_SCHEDULER_NO_TASK != run_task)
   {
     GNUNET_SCHEDULER_cancel (run_task);
@@ -188,6 +344,101 @@ static void
 schedule_next_task (void);
 
 
+/**
+ * Task triggered whenever we receive a SIGCHLD (child
+ * process died).
+ *
+ * @param cls the 'struct WorkItem' we were working on
+ * @param tc context
+ */
+static void
+maint_child_death (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+{
+  struct WorkItem *wi = cls;
+  struct GNUNET_HashCode key;
+  enum GNUNET_OS_ProcessStatusType type;
+  unsigned long code;
+  int ret;
+  char c;
+  const struct GNUNET_DISK_FileHandle *pr;
+
+
+  run_task = GNUNET_SCHEDULER_NO_TASK;
+  pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
+  if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY))
+  {
+    /* shutdown scheduled us, ignore! */
+    run_task =
+      GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+                                     pr, &maint_child_death, wi);
+    return;
+  }
+
+  ret = GNUNET_OS_process_status (publish_proc,
+                                 &type,
+                                 &code);
+  GNUNET_assert (GNUNET_SYSERR != ret);
+  if (GNUNET_NO == ret)
+  {
+    GNUNET_break (0);
+    GNUNET_OS_process_kill (publish_proc, SIGKILL);
+    type = GNUNET_OS_PROCESS_SIGNALED;
+  }
+  GNUNET_OS_process_destroy (publish_proc);
+  publish_proc = NULL;
+  /* consume the signal */
+  GNUNET_break (0 < GNUNET_DISK_file_read (pr, &c, sizeof (c)));
+
+  if (GNUNET_YES == do_shutdown)
+  {
+    GNUNET_free (wi->filename);
+    GNUNET_free (wi);
+    return;
+  }
+  if ( (GNUNET_OS_PROCESS_EXITED == type) &&
+       (0 == code) )
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+               _("Publication of `%s' done\n"),
+               wi->filename);
+    GNUNET_CRYPTO_hash (wi->filename,
+                       strlen (wi->filename),
+                       &key);
+    GNUNET_break (GNUNET_OK ==
+                  GNUNET_CONTAINER_multihashmap_put (work_finished,
+                                                     &key,
+                                                     wi,
+                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
+  }
+  else
+  {
+    GNUNET_CONTAINER_DLL_insert_tail (work_head,
+                                     work_tail,
+                                     wi);
+  }
+  save_state ();
+  schedule_next_task ();
+}
+
+
+/**
+ * Signal handler called for SIGCHLD.  Triggers the
+ * respective handler by writing to the trigger pipe.
+ */
+static void
+sighandler_child_death ()
+{
+  static char c;
+  int old_errno = errno;       /* back-up errno */
+
+  GNUNET_break (1 ==
+               GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
+                                       (sigpipe, GNUNET_DISK_PIPE_END_WRITE),
+                                       &c, sizeof (c)));
+  errno = old_errno;           /* restore errno */
+}
+
+
 /**
  * Function called to process work items.
  *
@@ -198,25 +449,67 @@ static void
 work (void *cls,
       const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
+  static char *argv[14];
+  static char anon_level[20];
+  static char content_prio[20];
+  static char repl_level[20];
   struct WorkItem *wi;
-  struct GNUNET_HashCode key;
+  const struct GNUNET_DISK_FileHandle *pr;
+  int argc;
 
   run_task = GNUNET_SCHEDULER_NO_TASK;
   wi = work_head;
   GNUNET_CONTAINER_DLL_remove (work_head,
                               work_tail,
                               wi);
-  // FIXME: actually run 'publish' here!
-
-  GNUNET_CRYPTO_hash (wi->filename,
-                     strlen (wi->filename),
-                     &key);
-  GNUNET_CONTAINER_multihashmap_put (work_finished,
-                                    &key,
-                                    wi,
-                                    GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
-  save_state ();
-  schedule_next_task ();    
+  argc = 0;
+  argv[argc++] = "gnunet-publish";
+  if (verbose)
+    argv[argc++] = "-V";
+  if (disable_extractor)
+    argv[argc++] = "-D";
+  if (do_disable_creation_time)
+    argv[argc++] = "-d";
+  argv[argc++] = "-c";
+  argv[argc++] = cfg_filename;
+  GNUNET_snprintf (anon_level, sizeof (anon_level),
+                  "%u", anonymity_level);
+  argv[argc++] = "-a";
+  argv[argc++] = anon_level;
+  GNUNET_snprintf (content_prio, sizeof (content_prio),
+                  "%u", content_priority);
+  argv[argc++] = "-p";
+  argv[argc++] = content_prio;
+  GNUNET_snprintf (repl_level, sizeof (repl_level),
+                  "%u", replication_level);
+  argv[argc++] = "-r";
+  argv[argc++] = repl_level;
+  argv[argc++] = wi->filename;
+  argv[argc] = NULL;
+  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+             _("Publishing `%s'\n"),
+             wi->filename);
+  publish_proc = GNUNET_OS_start_process_vap (GNUNET_YES,
+                                              0, NULL, NULL, NULL,
+                                             "gnunet-publish",
+                                             argv);
+  if (NULL == publish_proc)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+               _("Failed to run `%s'\n"),
+               "gnunet-publish");
+    GNUNET_CONTAINER_DLL_insert (work_head,
+                                work_tail,
+                                wi);
+    run_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
+                                            &work,
+                                            NULL);
+    return;
+  }
+  pr = GNUNET_DISK_pipe_handle (sigpipe, GNUNET_DISK_PIPE_END_READ);
+  run_task =
+    GNUNET_SCHEDULER_add_read_file (GNUNET_TIME_UNIT_FOREVER_REL,
+                                   pr, &maint_child_death, wi);
 }
 
 
@@ -245,9 +538,12 @@ determine_id (void *cls,
   GNUNET_CRYPTO_hash (filename, strlen (filename), &fx[0]);
   if (!S_ISDIR (sbuf.st_mode))
   {
-    uint64_t fsize = GNUNET_htonll (sbuf.st_size);
+    uint64_t fattr[2];
 
-    GNUNET_CRYPTO_hash (&fsize, sizeof (uint64_t), &fx[1]);
+    fattr[0] = GNUNET_htonll (sbuf.st_size);
+    fattr[0] = GNUNET_htonll (sbuf.st_mtime);
+
+    GNUNET_CRYPTO_hash (fattr, sizeof (fattr), &fx[1]);
   }
   else
   {
@@ -259,7 +555,7 @@ determine_id (void *cls,
   /* use hash here to make hierarchical structure distinct from
      all files on the same level */
   GNUNET_CRYPTO_hash (fx, sizeof (fx), &ft);
-  /* use XOR here so that order of the files in the directory 
+  /* use XOR here so that order of the files in the directory
      does not matter! */
   GNUNET_CRYPTO_hash_xor (&ft, id, id);
   return GNUNET_OK;
@@ -285,6 +581,11 @@ add_file (void *cls,
 
   if (GNUNET_YES == do_shutdown)
     return GNUNET_SYSERR;
+  if ( (NULL != strstr (filename,
+                     "/.auto-share")) ||
+       (NULL != strstr (filename,
+                       "\\.auto-share")) )
+    return GNUNET_OK; /* skip internal file */
   GNUNET_CRYPTO_hash (filename,
                      strlen (filename),
                      &key);
@@ -299,21 +600,22 @@ add_file (void *cls,
                     sizeof (struct GNUNET_HashCode)))
       return GNUNET_OK; /* skip: we did this one already */
     /* contents changed, need to re-do the directory... */
-    GNUNET_CONTAINER_multihashmap_remove (work_finished,
-                                         &key,
-                                         wi);
-    wi->id = id; 
+    GNUNET_assert (GNUNET_YES ==
+                  GNUNET_CONTAINER_multihashmap_remove (work_finished,
+                                                        &key,
+                                                        wi));
   }
   else
   {
-    wi = GNUNET_malloc (sizeof (struct WorkItem));
+    wi = GNUNET_new (struct WorkItem);
     wi->filename = GNUNET_strdup (filename);
   }
+  wi->id = id;
   GNUNET_CONTAINER_DLL_insert (work_head,
                               work_tail,
                               wi);
   if (GNUNET_YES == do_shutdown)
-    return GNUNET_SYSERR; 
+    return GNUNET_SYSERR;
   return GNUNET_OK;
 }
 
@@ -345,18 +647,17 @@ schedule_next_task ()
   struct GNUNET_TIME_Relative delay;
 
   if (GNUNET_YES == do_shutdown)
-    return;  
+    return;
   if (NULL == work_head)
   {
     /* delay by at most 4h, at least 1s, and otherwise in between depending
        on how long it took to scan */
     delay = GNUNET_TIME_absolute_get_duration (start_time);
-    delay = GNUNET_TIME_relative_min (GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS,
-                                                                    4),
+    delay = GNUNET_TIME_relative_min (MIN_FREQUENCY,
                                      GNUNET_TIME_relative_multiply (delay,
                                                                     100));
     delay = GNUNET_TIME_relative_max (delay,
-                                     GNUNET_TIME_UNIT_MINUTES);
+                                     MAX_FREQUENCY);
     run_task = GNUNET_SCHEDULER_add_delayed (delay,
                                             &scan,
                                             NULL);
@@ -382,25 +683,47 @@ run (void *cls, char *const *args, const char *cfgfile,
 {
   /* check arguments */
   if ((args[0] == NULL) || (args[1] != NULL) ||
-      (GNUNET_YES != GNUNET_DISK_directory_test (args[0])))
+      (GNUNET_YES != GNUNET_DISK_directory_test (args[0], GNUNET_YES)))
   {
     printf (_("You must specify one and only one directory name for automatic publication.\n"));
     ret = -1;
     return;
   }
+  cfg_filename = GNUNET_strdup (cfgfile);
   cfg = c;
   dir_name = args[0];
-  work_finished = GNUNET_CONTAINER_multihashmap_create (1024);
+  work_finished = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_NO);
   load_state ();
   run_task = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
                                                 &scan, NULL);
-  
+
   kill_task =
       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_stop_task,
                                     NULL);
 }
 
 
+/**
+ * Free memory associated with the work item from the work_finished map.
+ *
+ * @param cls NULL (unused)
+ * @param key key of the item in the map (unused)
+ * @param value the 'struct WorkItem' to free
+ * @return GNUNET_OK to continue to iterate
+ */
+static int
+free_item (void *cls,
+          const struct GNUNET_HashCode *key,
+          void *value)
+{
+  struct WorkItem *wi = value;
+
+  GNUNET_free (wi->filename);
+  GNUNET_free (wi);
+  return GNUNET_OK;
+}
+
+
 /**
  * The main function to automatically publish content to GNUnet.
  *
@@ -410,7 +733,7 @@ run (void *cls, char *const *args, const char *cfgfile,
  */
 int
 main (int argc, char *const *argv)
-{  
+{
   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
     {'a', "anonymity", "LEVEL",
      gettext_noop ("set the desired LEVEL of sender-anonymity"),
@@ -433,16 +756,41 @@ main (int argc, char *const *argv)
      0, &GNUNET_GETOPT_set_one, &verbose},
     GNUNET_GETOPT_OPTION_END
   };
+  struct WorkItem *wi;
   int ok;
+  struct GNUNET_SIGNAL_Context *shc_chld;
 
   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
     return 2;
+  sigpipe = GNUNET_DISK_pipe (GNUNET_NO, GNUNET_NO, GNUNET_NO, GNUNET_NO);
+  GNUNET_assert (sigpipe != NULL);
+  shc_chld =
+    GNUNET_SIGNAL_handler_install (GNUNET_SIGCHLD, &sighandler_child_death);
   ok = (GNUNET_OK ==
        GNUNET_PROGRAM_run (argc, argv, "gnunet-auto-share [OPTIONS] FILENAME",
                            gettext_noop
                            ("Automatically publish files from a directory on GNUnet"),
                            options, &run, NULL)) ? ret : 1;
-  // FIXME: free memory in work lists and hash map...
+  if (NULL != work_finished)
+  {
+    (void) GNUNET_CONTAINER_multihashmap_iterate (work_finished,
+                                                 &free_item,
+                                                 NULL);
+    GNUNET_CONTAINER_multihashmap_destroy (work_finished);
+  }
+  while (NULL != (wi = work_head))
+  {
+    GNUNET_CONTAINER_DLL_remove (work_head, work_tail, wi);
+    GNUNET_free (wi->filename);
+    GNUNET_free (wi);
+  }
+  GNUNET_SIGNAL_handler_uninstall (shc_chld);
+  shc_chld = NULL;
+  GNUNET_DISK_pipe_close (sigpipe);
+  sigpipe = NULL;
+  GNUNET_free (cfg_filename);
+  cfg_filename = NULL;
+  GNUNET_free ((void*) argv);
   return ok;
 }