expose our hello to plugins
[oweals/gnunet.git] / src / fs / fs_publish.c
index 7a70b0558403c1c58f83e8471dd2ac40e5950e7a..2c9d41b05603b5db274d32a7c925ed5d470b2d3b 100644 (file)
@@ -4,7 +4,7 @@
 
      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 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
  * @see http://gnunet.org/encoding
  * @author Krista Bennett
  * @author Christian Grothoff
- *
- * TODO:
- * - indexing cleanup: unindex on failure (can wait)
- * - datastore reservation support (optimization)
- * - location URIs (publish with anonymity-level zero)
  */
 
 #include "platform.h"
@@ -85,7 +80,7 @@ GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
                                const struct GNUNET_FS_FileInformation *p,
                                uint64_t offset)
 {
-  pi->value.publish.sc = sc;
+  pi->value.publish.pc = sc;
   pi->value.publish.fi = p;
   pi->value.publish.cctx
     = p->client_info;
@@ -118,6 +113,11 @@ publish_cleanup (void *cls,
 {
   struct GNUNET_FS_PublishContext *pc = cls;
 
+  if (pc->fhc != NULL)
+    {
+      GNUNET_CRYPTO_hash_file_cancel (pc->fhc);
+      pc->fhc = NULL;
+    }
   GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
   if (pc->namespace != NULL)
     GNUNET_FS_namespace_delete (pc->namespace, GNUNET_NO);
@@ -166,12 +166,21 @@ ds_put_cont (void *cls,
   if (GNUNET_OK != success)
     {
       GNUNET_asprintf (&pcc->p->emsg, 
-                      _("Upload failed: %s"),
+                      _("Publishing failed: %s"),
                       msg);
       pi.status = GNUNET_FS_STATUS_PUBLISH_ERROR;
       pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
       pi.value.publish.specifics.error.message = pcc->p->emsg;
       pcc->p->client_info = GNUNET_FS_publish_make_status_ (&pi, pcc->sc, pcc->p, 0);
+      if ( (pcc->p->is_directory == GNUNET_NO) &&
+          (pcc->p->filename != NULL) &&
+          (pcc->p->data.file.do_index == GNUNET_YES) )
+       {
+         /* run unindex to clean up */
+         GNUNET_FS_unindex_start (pcc->sc->h,
+                                  pcc->p->filename,
+                                  NULL);
+       }          
     }
   if (NULL != pcc->cont)
     pcc->sc->upload_task 
@@ -226,6 +235,37 @@ signal_publish_error (struct GNUNET_FS_FileInformation *p,
   pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
   pi.value.publish.specifics.error.message =emsg;
   p->client_info = GNUNET_FS_publish_make_status_ (&pi, sc, p, 0);
+  if ( (p->is_directory == GNUNET_NO) &&
+       (p->filename != NULL) &&
+       (p->data.file.do_index == GNUNET_YES) )
+    {
+      /* run unindex to clean up */
+      GNUNET_FS_unindex_start (sc->h,
+                              p->filename,
+                              NULL);
+    }     
+  
+}
+
+
+/**
+ * Datastore returns from reservation cancel request.
+ * 
+ * @param cls the 'struct GNUNET_FS_PublishContext'
+ * @param success success code (not used)
+ * @param msg error message (typically NULL, not used)
+ */
+static void
+finish_release_reserve (void *cls,
+                       int success,
+                       const char *msg)
+{
+  struct GNUNET_FS_PublishContext *pc = cls;
+
+  pc->qre = NULL;
+  signal_publish_completion (pc->fi, pc);
+  pc->all_done = GNUNET_YES;
+  GNUNET_FS_publish_sync_ (pc);
 }
 
 
@@ -251,10 +291,22 @@ publish_sblocks_cont (void *cls,
       GNUNET_FS_publish_sync_ (pc);
       return;
     }  
-  // FIXME: release the datastore reserve here!
-  signal_publish_completion (pc->fi, pc);
-  pc->all_done = GNUNET_YES;
-  GNUNET_FS_publish_sync_ (pc);
+  GNUNET_assert (pc->qre == NULL);
+  if ( (pc->dsh != NULL) &&
+       (pc->rid != 0) )
+    {
+      pc->qre = GNUNET_DATASTORE_release_reserve (pc->dsh,
+                                                 pc->rid,
+                                                 UINT_MAX,
+                                                 UINT_MAX,
+                                                 GNUNET_TIME_UNIT_FOREVER_REL,
+                                                 &finish_release_reserve,
+                                                 pc);
+    }
+  else
+    {
+      finish_release_reserve (pc, GNUNET_OK, NULL);
+    }
 }
 
 
@@ -423,7 +475,7 @@ encode_cont (void *cls,
                  emsg);
 #endif
       GNUNET_asprintf (&p->emsg, 
-                      _("Upload failed: %s"),
+                      _("Publishing failed: %s"),
                       emsg);
       GNUNET_free (emsg);
       pi.status = GNUNET_FS_STATUS_PUBLISH_ERROR;
@@ -435,6 +487,15 @@ encode_cont (void *cls,
   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Finished with tree encoder\n");
 #endif  
+  /* final progress event */
+  pi.status = GNUNET_FS_STATUS_PUBLISH_PROGRESS;
+  pi.value.publish.specifics.progress.data = NULL;
+  pi.value.publish.specifics.progress.offset = GNUNET_FS_uri_chk_get_file_size (p->chk_uri);
+  pi.value.publish.specifics.progress.data_len = 0;
+  pi.value.publish.specifics.progress.depth = 0;
+  p->client_info = GNUNET_FS_publish_make_status_ (&pi, sc, p, 
+                                                  GNUNET_FS_uri_chk_get_file_size (p->chk_uri));
+
   /* continue with main */
   sc->upload_task 
     = GNUNET_SCHEDULER_add_with_priority (sc->h->sched,
@@ -506,7 +567,7 @@ block_proc (void *cls,
       odb.offset = GNUNET_htonll (offset);
       odb.file_id = p->data.file.file_id;
       GNUNET_DATASTORE_put (sc->dsh,
-                           sc->rid,
+                           (p->is_directory) ? 0 : sc->rid,
                            query,
                            sizeof(struct OnDemandBlock),
                            &odb,
@@ -528,7 +589,7 @@ block_proc (void *cls,
              (unsigned int) block_size);
 #endif
   GNUNET_DATASTORE_put (sc->dsh,
-                       sc->rid,
+                       (p->is_directory) ? 0 : sc->rid,
                        query,
                        block_size,
                        block,
@@ -737,10 +798,11 @@ hash_for_index_cb (void *cls,
   struct IndexStartMessage *ism;
   size_t slen;
   struct GNUNET_CLIENT_Connection *client;
-  uint32_t dev;
+  uint64_t dev;
   uint64_t ino;
   char *fn;
 
+  sc->fhc = NULL;
   p = sc->fi_pos;
   if (NULL == res) 
     {
@@ -761,7 +823,7 @@ hash_for_index_cb (void *cls,
   fn = GNUNET_STRINGS_filename_expand (p->filename);
   GNUNET_assert (fn != NULL);
   slen = strlen (fn) + 1;
-  if (slen > GNUNET_SERVER_MAX_MESSAGE_SIZE - sizeof(struct IndexStartMessage))
+  if (slen >= GNUNET_SERVER_MAX_MESSAGE_SIZE - sizeof(struct IndexStartMessage))
     {
       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                  _("Can not index file `%s': %s.  Will try to insert instead.\n"),
@@ -809,15 +871,17 @@ hash_for_index_cb (void *cls,
                                        &dev,
                                        &ino))
     {
-      ism->device = htonl (dev);
+      ism->device = GNUNET_htonll (dev);
       ism->inode = GNUNET_htonll(ino);
     }
+#if DEBUG_PUBLISH
   else
     {
-      GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  _("Failed to get file identifiers for `%s'\n"),
                  p->filename);
     }
+#endif
   ism->file_id = *res;
   memcpy (&ism[1],
          fn,
@@ -848,6 +912,7 @@ GNUNET_FS_publish_main_ (void *cls,
   struct GNUNET_FS_PublishContext *pc = cls;
   struct GNUNET_FS_ProgressInfo pi;
   struct GNUNET_FS_FileInformation *p;
+  struct GNUNET_FS_Uri *loc;
   char *fn;
 
   pc->upload_task = GNUNET_SCHEDULER_NO_TASK;  
@@ -856,7 +921,7 @@ GNUNET_FS_publish_main_ (void *cls,
     {
 #if DEBUG_PUBLISH
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                 "Upload complete, now publishing SKS and KSK blocks.\n");
+                 "Publishing complete, now publishing SKS and KSK blocks.\n");
 #endif
       /* upload of entire hierarchy complete,
         publish namespace entries */
@@ -919,6 +984,15 @@ GNUNET_FS_publish_main_ (void *cls,
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                  "File upload complete, now publishing KSK blocks.\n");
 #endif
+      if (0 == p->anonymity)
+       {
+         /* zero anonymity, box CHK URI in LOC URI */
+         loc = GNUNET_FS_uri_loc_create (p->chk_uri,
+                                         pc->h->cfg,
+                                         p->expirationTime);
+         GNUNET_FS_uri_destroy (p->chk_uri);
+         p->chk_uri = loc;
+       }
       GNUNET_FS_publish_sync_ (pc);
       /* upload of "p" complete, publish KBlocks! */
       if (p->keywords != NULL)
@@ -964,12 +1038,12 @@ GNUNET_FS_publish_main_ (void *cls,
       else
        {
          p->start_time = GNUNET_TIME_absolute_get ();
-         GNUNET_CRYPTO_hash_file (pc->h->sched,
-                                  GNUNET_SCHEDULER_PRIORITY_IDLE,
-                                  p->filename,
-                                  HASHING_BLOCKSIZE,
-                                  &hash_for_index_cb,
-                                  pc);
+         pc->fhc = GNUNET_CRYPTO_hash_file (pc->h->sched,
+                                            GNUNET_SCHEDULER_PRIORITY_IDLE,
+                                            p->filename,
+                                            HASHING_BLOCKSIZE,
+                                            &hash_for_index_cb,
+                                            pc);
        }
       return;
     }
@@ -1007,7 +1081,38 @@ fip_signal_start(void *cls,
 {
   struct GNUNET_FS_PublishContext *sc = cls;
   struct GNUNET_FS_ProgressInfo pi;
+  unsigned int kc;
+  uint64_t left;
 
+  if (*do_index)
+    {
+      /* space for on-demand blocks */
+      sc->reserve_space += ((length + DBLOCK_SIZE - 1) / DBLOCK_SIZE) * sizeof (struct OnDemandBlock);
+    }
+  else
+    {
+      /* space for DBlocks */
+      sc->reserve_space += length;
+    }
+  /* entries for IBlocks and DBlocks, space for IBlocks */
+  left = length;
+  while (1)
+    {
+      left = (left + DBLOCK_SIZE - 1) / DBLOCK_SIZE;
+      sc->reserve_entries += left;
+      if (left <= 1)
+       break;
+      left = left * sizeof (struct ContentHashKey);
+      sc->reserve_space += left;
+    }
+  sc->reserve_entries++;
+  /* entries and space for keywords */
+  if (NULL != *uri)
+    {
+      kc = GNUNET_FS_uri_ksk_get_keyword_count (*uri);
+      sc->reserve_entries += kc;
+      sc->reserve_space += GNUNET_SERVER_MAX_MESSAGE_SIZE * kc;
+    }  
   pi.status = GNUNET_FS_STATUS_PUBLISH_START;
   *client_info = GNUNET_FS_publish_make_status_ (&pi, sc, fi, 0);
   GNUNET_FS_file_information_sync_ (fi);
@@ -1086,6 +1191,42 @@ GNUNET_FS_publish_signal_suspend_ (void *cls)
 }
 
 
+/**
+ * We have gotten a reply for our space reservation request.
+ * Either fail (insufficient space) or start publishing for good.
+ * 
+ * @param cls the 'struct GNUNET_FS_PublishContext*'
+ * @param success positive reservation ID on success
+ * @param msg error message on error, otherwise NULL
+ */
+static void
+finish_reserve (void *cls,
+               int success,
+               const char *msg)
+{
+  struct GNUNET_FS_PublishContext *pc = cls;
+
+  pc->qre = NULL;
+  if ( (msg != NULL) ||
+       (success <= 0) )
+    {
+      GNUNET_asprintf (&pc->fi->emsg, 
+                      _("Insufficient space for publishing: %s"),
+                      msg);
+      signal_publish_error (pc->fi,
+                           pc,
+                           pc->fi->emsg);
+      return;
+    }
+  pc->rid = success;
+  pc->upload_task 
+    = GNUNET_SCHEDULER_add_with_priority (pc->h->sched,
+                                         GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
+                                         &GNUNET_FS_publish_main_,
+                                         pc);
+}
+
+
 /**
  * Publish a file or directory.
  *
@@ -1110,6 +1251,7 @@ GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
   struct GNUNET_FS_PublishContext *ret;
   struct GNUNET_DATASTORE_Handle *dsh;
 
+  GNUNET_assert (NULL != h);
   if (0 == (options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY))
     {
       dsh = GNUNET_DATASTORE_connect (h->cfg,
@@ -1141,14 +1283,29 @@ GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
   ret->fi_pos = ret->fi;
   ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, ret);
   GNUNET_FS_publish_sync_ (ret);
-  // FIXME: calculate space needed for "fi"
-  // and reserve as first task (then trigger
-  // "publish_main" from that continuation)!
-  ret->upload_task 
-    = GNUNET_SCHEDULER_add_with_priority (h->sched,
-                                         GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
-                                         &GNUNET_FS_publish_main_,
-                                         ret);
+  if (NULL != ret->dsh)
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+                 _("Reserving space for %u entries and %llu bytes for publication\n"),
+                 (unsigned int) ret->reserve_entries,
+                 (unsigned long long) ret->reserve_space);
+      ret->qre = GNUNET_DATASTORE_reserve (ret->dsh,
+                                          ret->reserve_space,
+                                          ret->reserve_entries,
+                                          UINT_MAX,
+                                          UINT_MAX,
+                                          GNUNET_TIME_UNIT_FOREVER_REL,
+                                          &finish_reserve,
+                                          ret);
+    }
+  else
+    {
+      ret->upload_task 
+       = GNUNET_SCHEDULER_add_with_priority (h->sched,
+                                             GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
+                                             &GNUNET_FS_publish_main_,
+                                             ret);
+    }
   return ret;
 }
 
@@ -1213,6 +1370,11 @@ void
 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc)
 {
   GNUNET_FS_end_top (pc->h, pc->top);
+  if (NULL != pc->qre)
+    {
+      GNUNET_DATASTORE_cancel (pc->qre);
+      pc->qre = NULL;
+    }
   if (NULL != pc->dsh)
     {
       GNUNET_DATASTORE_disconnect (pc->dsh, GNUNET_NO);
@@ -1547,223 +1709,4 @@ GNUNET_FS_publish_ksk (struct GNUNET_FS_Handle *h,
 }
 
 
-/**
- * Context for the SKS publication.
- */
-struct PublishSksContext
-{
-
-  /**
-   * Global FS context.
-   */
-  struct GNUNET_FS_Uri *uri;
-
-  /**
-   * Handle to the datastore.
-   */
-  struct GNUNET_DATASTORE_Handle *dsh;
-
-  /**
-   * Function to call once we're done.
-   */
-  GNUNET_FS_PublishContinuation cont;
-
-  /**
-   * Closure for cont.
-   */ 
-  void *cont_cls;
-
-};
-
-
-/**
- * Function called by the datastore API with
- * the result from the PUT (SBlock) request.
- *
- * @param cls closure of type "struct PublishSksContext*"
- * @param success GNUNET_OK on success
- * @param msg error message (or NULL)
- */
-static void
-sb_put_cont (void *cls,
-            int success,
-            const char *msg)
-{
-  struct PublishSksContext *psc = cls;
-
-  if (NULL != psc->dsh)
-    {
-      GNUNET_DATASTORE_disconnect (psc->dsh, GNUNET_NO);
-      psc->dsh = NULL;
-    }
-  if (GNUNET_OK != success)
-    psc->cont (psc->cont_cls,
-              NULL,
-              msg);
-  else
-    psc->cont (psc->cont_cls,
-              psc->uri,
-              NULL);
-  GNUNET_FS_uri_destroy (psc->uri);
-  GNUNET_free (psc);
-}
-
-
-/**
- * Publish an SBlock on GNUnet.
- *
- * @param h handle to the file sharing subsystem
- * @param namespace namespace to publish in
- * @param identifier identifier to use
- * @param update update identifier to use
- * @param meta metadata to use
- * @param uri URI to refer to in the SBlock
- * @param expirationTime when the SBlock expires
- * @param anonymity anonymity level for the SBlock
- * @param priority priority for the SBlock
- * @param options publication options
- * @param cont continuation
- * @param cont_cls closure for cont
- */
-void
-GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
-                      struct GNUNET_FS_Namespace *namespace,
-                      const char *identifier,
-                      const char *update,
-                      const struct GNUNET_CONTAINER_MetaData *meta,
-                      const struct GNUNET_FS_Uri *uri,
-                      struct GNUNET_TIME_Absolute expirationTime,
-                      uint32_t anonymity,
-                      uint32_t priority,
-                      enum GNUNET_FS_PublishOptions options,
-                      GNUNET_FS_PublishContinuation cont,
-                      void *cont_cls)
-{
-  struct PublishSksContext *psc;
-  struct GNUNET_CRYPTO_AesSessionKey sk;
-  struct GNUNET_CRYPTO_AesInitializationVector iv;
-  struct GNUNET_FS_Uri *sks_uri;
-  char *uris;
-  size_t size;
-  size_t slen;
-  size_t nidlen;
-  size_t idlen;
-  ssize_t mdsize;
-  struct SBlock *sb;
-  struct SBlock *sb_enc;
-  char *dest;
-  struct GNUNET_CONTAINER_MetaData *mmeta;
-  GNUNET_HashCode key;         /* hash of thisId = key */
-  GNUNET_HashCode id;          /* hash of hc = identifier */
-  GNUNET_HashCode query;       /* id ^ nsid = DB query */
-
-  if (NULL == meta)
-    mmeta = GNUNET_CONTAINER_meta_data_create ();
-  else
-    mmeta = GNUNET_CONTAINER_meta_data_duplicate (meta);
-  uris = GNUNET_FS_uri_to_string (uri);
-  slen = strlen (uris) + 1;
-  idlen = strlen (identifier);
-  if (update == NULL)
-    update = "";
-  nidlen = strlen (update) + 1;
-  mdsize = GNUNET_CONTAINER_meta_data_get_serialized_size (mmeta);
-  size = sizeof (struct SBlock) + slen + nidlen + mdsize;
-  if (size > MAX_SBLOCK_SIZE)
-    {
-      size = MAX_SBLOCK_SIZE;
-      mdsize = size - (sizeof (struct SBlock) + slen + nidlen);
-    }
-  sb = GNUNET_malloc (sizeof (struct SBlock) + size);
-  dest = (char *) &sb[1];
-  memcpy (dest, update, nidlen);
-  dest += nidlen;
-  memcpy (dest, uris, slen);
-  GNUNET_free (uris);
-  dest += slen;
-  mdsize = GNUNET_CONTAINER_meta_data_serialize (mmeta,
-                                                &dest,
-                                                mdsize, 
-                                                GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
-  GNUNET_CONTAINER_meta_data_destroy (mmeta);
-  if (mdsize == -1)
-    {
-      GNUNET_break (0);
-      GNUNET_free (sb);
-      cont (cont_cls,
-           NULL,
-           _("Internal error."));
-      return;
-    }
-  size = sizeof (struct SBlock) + mdsize + slen + nidlen;
-  sb_enc = GNUNET_malloc (size);
-  GNUNET_CRYPTO_hash (identifier, idlen, &key);
-  GNUNET_CRYPTO_hash (&key, sizeof (GNUNET_HashCode), &id);
-  sks_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
-  sks_uri->type = sks;
-  GNUNET_CRYPTO_rsa_key_get_public (namespace->key, &sb_enc->subspace);
-  GNUNET_CRYPTO_hash (&sb_enc->subspace,
-                     sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
-                     &sks_uri->data.sks.namespace);
-  sks_uri->data.sks.identifier = GNUNET_strdup (identifier);
-  GNUNET_CRYPTO_hash_xor (&id, 
-                         &sks_uri->data.sks.namespace, 
-                         &sb_enc->identifier);
-  GNUNET_CRYPTO_hash_to_aes_key (&key, &sk, &iv);
-  GNUNET_CRYPTO_aes_encrypt (&sb[1],
-                            size - sizeof (struct SBlock),
-                            &sk,
-                            &iv,
-                            &sb_enc[1]);
-  sb_enc->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK);
-  sb_enc->purpose.size = htonl(slen + mdsize + nidlen
-                              + sizeof(struct SBlock)
-                              - sizeof(struct GNUNET_CRYPTO_RsaSignature));
-  GNUNET_assert (GNUNET_OK == 
-                GNUNET_CRYPTO_rsa_sign (namespace->key,
-                                        &sb_enc->purpose,
-                                        &sb_enc->signature));
-  psc = GNUNET_malloc (sizeof(struct PublishSksContext));
-  psc->uri = sks_uri;
-  psc->cont = cont;
-  psc->cont_cls = cont_cls;
-  if (0 != (options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY))
-    {
-      GNUNET_free (sb_enc);
-      GNUNET_free (sb);
-      sb_put_cont (psc,
-                  GNUNET_OK,
-                  NULL);
-      return;
-    }
-  psc->dsh = GNUNET_DATASTORE_connect (h->cfg, h->sched);
-  if (NULL == psc->dsh)
-    {
-      GNUNET_free (sb_enc);
-      GNUNET_free (sb);
-      sb_put_cont (psc,
-                  GNUNET_NO,
-                  _("Failed to connect to datastore."));
-      return;
-    }
-  GNUNET_CRYPTO_hash_xor (&sks_uri->data.sks.namespace,
-                         &id,
-                         &query);  
-  GNUNET_DATASTORE_put (psc->dsh,
-                       0,
-                       &sb_enc->identifier,
-                       size,
-                       sb_enc,
-                       GNUNET_BLOCK_TYPE_SBLOCK, 
-                       priority,
-                       anonymity,
-                       expirationTime,
-                       -2, 1,
-                       GNUNET_CONSTANTS_SERVICE_TIMEOUT,
-                       &sb_put_cont,
-                       psc);
-  GNUNET_free (sb);
-  GNUNET_free (sb_enc);
-}
-
 /* end of fs_publish.c */