2 This file is part of GNUnet.
3 (C) 2009, 2010 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file fs/fs_publish.c
23 * @brief publish a file or directory in GNUnet
24 * @see https://gnunet.org/encoding
25 * @author Krista Bennett
26 * @author Christian Grothoff
30 #include "gnunet_constants.h"
31 #include "gnunet_signatures.h"
32 #include "gnunet_util_lib.h"
33 #include "gnunet_fs_service.h"
39 * Fill in all of the generic fields for
40 * a publish event and call the callback.
42 * @param pi structure to fill in
43 * @param pc overall publishing context
44 * @param p file information for the file being published
45 * @param offset where in the file are we so far
46 * @return value returned from callback
49 GNUNET_FS_publish_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
50 struct GNUNET_FS_PublishContext *pc,
51 const struct GNUNET_FS_FileInformation *p,
54 pi->value.publish.pc = pc;
55 pi->value.publish.fi = p;
56 pi->value.publish.cctx = p->client_info;
57 pi->value.publish.pctx = (NULL == p->dir) ? NULL : p->dir->client_info;
58 pi->value.publish.filename = p->filename;
59 pi->value.publish.size =
60 (p->is_directory == GNUNET_YES) ? p->data.dir.dir_size : p->data.file.file_size;
61 pi->value.publish.eta =
62 GNUNET_TIME_calculate_eta (p->start_time, offset, pi->value.publish.size);
63 pi->value.publish.completed = offset;
64 pi->value.publish.duration =
65 GNUNET_TIME_absolute_get_duration (p->start_time);
66 pi->value.publish.anonymity = p->bo.anonymity_level;
67 return pc->h->upcb (pc->h->upcb_cls, pi);
72 * Cleanup the publish context, we're done with it.
74 * @param pc struct to clean up
77 publish_cleanup (struct GNUNET_FS_PublishContext *pc)
79 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Cleaning up publish context (done!)\n");
82 GNUNET_CRYPTO_hash_file_cancel (pc->fhc);
85 GNUNET_FS_file_information_destroy (pc->fi, NULL, NULL);
86 if (pc->namespace != NULL)
88 GNUNET_FS_namespace_delete (pc->namespace, GNUNET_NO);
91 GNUNET_free_non_null (pc->nid);
92 GNUNET_free_non_null (pc->nuid);
93 GNUNET_free_non_null (pc->serialization);
96 GNUNET_DATASTORE_disconnect (pc->dsh, GNUNET_NO);
99 if (pc->client != NULL)
101 GNUNET_CLIENT_disconnect (pc->client, GNUNET_NO);
104 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
110 * Function called by the datastore API with
111 * the result from the PUT request.
113 * @param cls the 'struct GNUNET_FS_PublishContext'
114 * @param success GNUNET_OK on success
115 * @param min_expiration minimum expiration time required for content to be stored
116 * @param msg error message (or NULL)
119 ds_put_cont (void *cls, int success,
120 struct GNUNET_TIME_Absolute min_expiration,
123 struct GNUNET_FS_PublishContext *pc = cls;
124 struct GNUNET_FS_ProgressInfo pi;
127 if (GNUNET_SYSERR == success)
129 GNUNET_asprintf (&pc->fi_pos->emsg, _("Publishing failed: %s"), msg);
130 pi.status = GNUNET_FS_STATUS_PUBLISH_ERROR;
131 pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
132 pi.value.publish.specifics.error.message = pc->fi_pos->emsg;
133 pc->fi_pos->client_info =
134 GNUNET_FS_publish_make_status_ (&pi, pc, pc->fi_pos, 0);
135 if ((pc->fi_pos->is_directory != GNUNET_YES) &&
136 (pc->fi_pos->filename != NULL) &&
137 (pc->fi_pos->data.file.do_index == GNUNET_YES))
139 /* run unindex to clean up */
140 GNUNET_FS_unindex_start (pc->h, pc->fi_pos->filename, NULL);
143 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
145 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
146 &GNUNET_FS_publish_main_, pc);
151 * Generate the callback that signals clients
152 * that a file (or directory) has been completely
155 * @param p the completed upload
156 * @param pc context of the publication
159 signal_publish_completion (struct GNUNET_FS_FileInformation *p,
160 struct GNUNET_FS_PublishContext *pc)
162 struct GNUNET_FS_ProgressInfo pi;
164 pi.status = GNUNET_FS_STATUS_PUBLISH_COMPLETED;
165 pi.value.publish.eta = GNUNET_TIME_UNIT_ZERO;
166 pi.value.publish.specifics.completed.chk_uri = p->chk_uri;
168 GNUNET_FS_publish_make_status_ (&pi, pc, p,
169 GNUNET_ntohll (p->chk_uri->data.
175 * Generate the callback that signals clients
176 * that a file (or directory) has encountered
177 * a problem during publication.
179 * @param p the upload that had trouble
180 * @param pc context of the publication
181 * @param emsg error message
184 signal_publish_error (struct GNUNET_FS_FileInformation *p,
185 struct GNUNET_FS_PublishContext *pc, const char *emsg)
187 struct GNUNET_FS_ProgressInfo pi;
189 p->emsg = GNUNET_strdup (emsg);
190 pi.status = GNUNET_FS_STATUS_PUBLISH_ERROR;
191 pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
192 pi.value.publish.specifics.error.message = emsg;
193 p->client_info = GNUNET_FS_publish_make_status_ (&pi, pc, p, 0);
194 if ((p->is_directory != GNUNET_YES) && (p->filename != NULL) &&
195 (p->data.file.do_index == GNUNET_YES))
197 /* run unindex to clean up */
198 GNUNET_FS_unindex_start (pc->h, p->filename, NULL);
205 * Datastore returns from reservation cancel request.
207 * @param cls the 'struct GNUNET_FS_PublishContext'
208 * @param success success code (not used)
209 * @param min_expiration minimum expiration time required for content to be stored
210 * @param msg error message (typically NULL, not used)
213 finish_release_reserve (void *cls, int success,
214 struct GNUNET_TIME_Absolute min_expiration,
217 struct GNUNET_FS_PublishContext *pc = cls;
220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Releasing reserve done!\n");
221 signal_publish_completion (pc->fi, pc);
222 pc->all_done = GNUNET_YES;
223 GNUNET_FS_publish_sync_ (pc);
228 * We've finished publishing the SBlock as part of a larger upload.
229 * Check the result and complete the larger upload.
231 * @param cls the "struct GNUNET_FS_PublishContext*" of the larger upload
232 * @param uri URI of the published SBlock
233 * @param emsg NULL on success, otherwise error message
236 publish_sblocks_cont (void *cls, const struct GNUNET_FS_Uri *uri,
239 struct GNUNET_FS_PublishContext *pc = cls;
244 signal_publish_error (pc->fi, pc, emsg);
245 GNUNET_FS_publish_sync_ (pc);
248 GNUNET_assert (pc->qre == NULL);
249 if ((pc->dsh != NULL) && (pc->rid != 0))
252 GNUNET_DATASTORE_release_reserve (pc->dsh, pc->rid, UINT_MAX, UINT_MAX,
253 GNUNET_TIME_UNIT_FOREVER_REL,
254 &finish_release_reserve, pc);
258 finish_release_reserve (pc, GNUNET_OK, GNUNET_TIME_UNIT_ZERO_ABS, NULL);
264 * We are almost done publishing the structure,
265 * add SBlocks (if needed).
267 * @param pc overall upload data
270 publish_sblock (struct GNUNET_FS_PublishContext *pc)
272 if (NULL != pc->namespace)
273 pc->sks_pc = GNUNET_FS_publish_sks (pc->h, pc->namespace, pc->nid, pc->nuid,
274 pc->fi->meta, pc->fi->chk_uri, &pc->fi->bo,
275 pc->options, &publish_sblocks_cont, pc);
277 publish_sblocks_cont (pc, NULL, NULL);
282 * We've finished publishing a KBlock as part of a larger upload.
283 * Check the result and continue the larger upload.
285 * @param cls the "struct GNUNET_FS_PublishContext*"
286 * of the larger upload
287 * @param uri URI of the published blocks
288 * @param emsg NULL on success, otherwise error message
291 publish_kblocks_cont (void *cls, const struct GNUNET_FS_Uri *uri,
294 struct GNUNET_FS_PublishContext *pc = cls;
295 struct GNUNET_FS_FileInformation *p = pc->fi_pos;
300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error uploading KSK blocks: %s\n",
302 signal_publish_error (p, pc, emsg);
303 GNUNET_FS_file_information_sync_ (p);
304 GNUNET_FS_publish_sync_ (pc);
305 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
307 GNUNET_SCHEDULER_add_with_priority
308 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND, &GNUNET_FS_publish_main_, pc);
311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
312 "KSK blocks published, moving on to next file\n");
314 signal_publish_completion (p, pc);
315 /* move on to next file */
317 pc->fi_pos = p->next;
320 GNUNET_FS_publish_sync_ (pc);
321 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
323 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
324 &GNUNET_FS_publish_main_, pc);
329 * Function called by the tree encoder to obtain
330 * a block of plaintext data (for the lowest level
333 * @param cls our publishing context
334 * @param offset identifies which block to get
335 * @param max (maximum) number of bytes to get; returning
336 * fewer will also cause errors
337 * @param buf where to copy the plaintext buffer
338 * @param emsg location to store an error message (on error)
339 * @return number of bytes copied to buf, 0 on error
342 block_reader (void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
344 struct GNUNET_FS_PublishContext *pc = cls;
345 struct GNUNET_FS_FileInformation *p;
350 if (p->is_directory == GNUNET_YES)
352 pt_size = GNUNET_MIN (max, p->data.dir.dir_size - offset);
353 dd = p->data.dir.dir_data;
354 memcpy (buf, &dd[offset], pt_size);
358 pt_size = GNUNET_MIN (max, p->data.file.file_size - offset);
360 return 0; /* calling reader with pt_size==0
361 * might free buf, so don't! */
363 p->data.file.reader (p->data.file.reader_cls, offset, pt_size, buf,
372 * The tree encoder has finished processing a
373 * file. Call it's finish method and deal with
376 * @param cls our publishing context
377 * @param tc scheduler's task context (not used)
380 encode_cont (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
382 struct GNUNET_FS_PublishContext *pc = cls;
383 struct GNUNET_FS_FileInformation *p;
384 struct GNUNET_FS_ProgressInfo pi;
389 GNUNET_FS_tree_encoder_finish (p->te, &p->chk_uri, &emsg);
391 GNUNET_FS_file_information_sync_ (p);
394 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error during tree walk: %s\n", emsg);
395 GNUNET_asprintf (&p->emsg, _("Publishing failed: %s"), emsg);
397 pi.status = GNUNET_FS_STATUS_PUBLISH_ERROR;
398 pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
399 pi.value.publish.specifics.error.message = p->emsg;
400 p->client_info = GNUNET_FS_publish_make_status_ (&pi, pc, p, 0);
402 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Finished with tree encoder\n");
403 /* final progress event */
404 flen = GNUNET_FS_uri_chk_get_file_size (p->chk_uri);
405 pi.status = GNUNET_FS_STATUS_PUBLISH_PROGRESS;
406 pi.value.publish.specifics.progress.data = NULL;
407 pi.value.publish.specifics.progress.offset = flen;
408 pi.value.publish.specifics.progress.data_len = 0;
409 pi.value.publish.specifics.progress.depth = GNUNET_FS_compute_depth (flen);
410 p->client_info = GNUNET_FS_publish_make_status_ (&pi, pc, p, flen);
412 /* continue with main */
413 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
415 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
416 &GNUNET_FS_publish_main_, pc);
421 * Function called asking for the current (encoded)
422 * block to be processed. After processing the
423 * client should either call "GNUNET_FS_tree_encode_next"
424 * or (on error) "GNUNET_FS_tree_encode_finish".
427 * @param chk content hash key for the block
428 * @param offset offset of the block in the file
429 * @param depth depth of the block in the file, 0 for DBLOCK
430 * @param type type of the block (IBLOCK or DBLOCK)
431 * @param block the (encrypted) block
432 * @param block_size size of block (in bytes)
435 block_proc (void *cls, const struct ContentHashKey *chk, uint64_t offset,
436 unsigned int depth, enum GNUNET_BLOCK_Type type, const void *block,
439 struct GNUNET_FS_PublishContext *pc = cls;
440 struct GNUNET_FS_FileInformation *p;
441 struct OnDemandBlock odb;
446 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Waiting for datastore connection\n");
447 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
449 GNUNET_SCHEDULER_add_with_priority
450 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND, &GNUNET_FS_publish_main_, pc);
454 if ((p->is_directory != GNUNET_YES) && (GNUNET_YES == p->data.file.do_index) &&
455 (type == GNUNET_BLOCK_TYPE_FS_DBLOCK))
457 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
458 "Indexing block `%s' for offset %llu with index size %u\n",
459 GNUNET_h2s (&chk->query), (unsigned long long) offset,
460 sizeof (struct OnDemandBlock));
461 odb.offset = GNUNET_htonll (offset);
462 odb.file_id = p->data.file.file_id;
463 GNUNET_assert (pc->qre == NULL);
465 GNUNET_DATASTORE_put (pc->dsh, (p->is_directory == GNUNET_YES) ? 0 : pc->rid,
466 &chk->query, sizeof (struct OnDemandBlock), &odb,
467 GNUNET_BLOCK_TYPE_FS_ONDEMAND,
468 p->bo.content_priority, p->bo.anonymity_level,
469 p->bo.replication_level, p->bo.expiration_time,
470 -2, 1, GNUNET_CONSTANTS_SERVICE_TIMEOUT,
474 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
475 "Publishing block `%s' for offset %llu with size %u\n",
476 GNUNET_h2s (&chk->query), (unsigned long long) offset,
477 (unsigned int) block_size);
478 GNUNET_assert (pc->qre == NULL);
480 GNUNET_DATASTORE_put (pc->dsh, (p->is_directory == GNUNET_YES) ? 0 : pc->rid,
481 &chk->query, block_size, block, type,
482 p->bo.content_priority, p->bo.anonymity_level,
483 p->bo.replication_level, p->bo.expiration_time, -2,
484 1, GNUNET_CONSTANTS_SERVICE_TIMEOUT, &ds_put_cont,
490 * Function called with information about our
491 * progress in computing the tree encoding.
494 * @param offset where are we in the file
495 * @param pt_block plaintext of the currently processed block
496 * @param pt_size size of pt_block
497 * @param depth depth of the block in the tree, 0 for DBLOCK
500 progress_proc (void *cls, uint64_t offset, const void *pt_block, size_t pt_size,
503 struct GNUNET_FS_PublishContext *pc = cls;
504 struct GNUNET_FS_FileInformation *p;
505 struct GNUNET_FS_ProgressInfo pi;
508 pi.status = GNUNET_FS_STATUS_PUBLISH_PROGRESS;
509 pi.value.publish.specifics.progress.data = pt_block;
510 pi.value.publish.specifics.progress.offset = offset;
511 pi.value.publish.specifics.progress.data_len = pt_size;
512 pi.value.publish.specifics.progress.depth = depth;
513 p->client_info = GNUNET_FS_publish_make_status_ (&pi, pc, p, offset);
518 * We are uploading a file or directory; load (if necessary) the next
519 * block into memory, encrypt it and send it to the FS service. Then
520 * continue with the main task.
522 * @param pc overall upload data
525 publish_content (struct GNUNET_FS_PublishContext *pc)
527 struct GNUNET_FS_FileInformation *p;
529 struct GNUNET_FS_DirectoryBuilder *db;
530 struct GNUNET_FS_FileInformation *dirpos;
535 GNUNET_assert (p != NULL);
538 if (p->is_directory == GNUNET_YES)
540 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating directory\n");
541 db = GNUNET_FS_directory_builder_create (p->meta);
542 dirpos = p->data.dir.entries;
543 while (NULL != dirpos)
545 if (dirpos->is_directory == GNUNET_YES)
547 raw_data = dirpos->data.dir.dir_data;
548 dirpos->data.dir.dir_data = NULL;
553 if ((dirpos->data.file.file_size < MAX_INLINE_SIZE) &&
554 (dirpos->data.file.file_size > 0))
556 raw_data = GNUNET_malloc (dirpos->data.file.file_size);
558 if (dirpos->data.file.file_size !=
559 dirpos->data.file.reader (dirpos->data.file.reader_cls, 0,
560 dirpos->data.file.file_size, raw_data,
563 GNUNET_free_non_null (emsg);
564 GNUNET_free (raw_data);
569 GNUNET_FS_directory_builder_add (db, dirpos->chk_uri, dirpos->meta,
571 GNUNET_free_non_null (raw_data);
572 dirpos = dirpos->next;
574 GNUNET_free_non_null (p->data.dir.dir_data);
575 p->data.dir.dir_data = NULL;
576 p->data.dir.dir_size = 0;
577 GNUNET_FS_directory_builder_finish (db, &p->data.dir.dir_size,
578 &p->data.dir.dir_data);
579 GNUNET_FS_file_information_sync_ (p);
581 size = (p->is_directory == GNUNET_YES) ? p->data.dir.dir_size : p->data.file.file_size;
582 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating tree encoder\n");
584 GNUNET_FS_tree_encoder_create (pc->h, size, pc, &block_reader,
585 &block_proc, &progress_proc,
589 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Processing next block from tree\n");
590 GNUNET_FS_tree_encoder_next (p->te);
595 * Process the response (or lack thereof) from
596 * the "fs" service to our 'start index' request.
598 * @param cls closure (of type "struct GNUNET_FS_PublishContext*"_)
599 * @param msg the response we got
602 process_index_start_response (void *cls, const struct GNUNET_MessageHeader *msg)
604 struct GNUNET_FS_PublishContext *pc = cls;
605 struct GNUNET_FS_FileInformation *p;
609 GNUNET_CLIENT_disconnect (pc->client, GNUNET_NO);
614 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
616 ("Can not index file `%s': %s. Will try to insert instead.\n"),
618 _("timeout on index-start request to `fs' service"));
619 p->data.file.do_index = GNUNET_NO;
620 GNUNET_FS_file_information_sync_ (p);
621 publish_content (pc);
624 if (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK)
626 msize = ntohs (msg->size);
627 emsg = (const char *) &msg[1];
628 if ((msize <= sizeof (struct GNUNET_MessageHeader)) ||
629 (emsg[msize - sizeof (struct GNUNET_MessageHeader) - 1] != '\0'))
630 emsg = gettext_noop ("unknown error");
631 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
633 ("Can not index file `%s': %s. Will try to insert instead.\n"),
634 p->filename, gettext (emsg));
635 p->data.file.do_index = GNUNET_NO;
636 GNUNET_FS_file_information_sync_ (p);
637 publish_content (pc);
640 p->data.file.index_start_confirmed = GNUNET_YES;
641 /* success! continue with indexing */
642 GNUNET_FS_file_information_sync_ (p);
643 publish_content (pc);
648 * Function called once the hash computation over an
649 * indexed file has completed.
651 * @param cls closure, our publishing context
652 * @param res resulting hash, NULL on error
655 hash_for_index_cb (void *cls, const GNUNET_HashCode * res)
657 struct GNUNET_FS_PublishContext *pc = cls;
658 struct GNUNET_FS_FileInformation *p;
659 struct IndexStartMessage *ism;
661 struct GNUNET_CLIENT_Connection *client;
670 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
672 ("Can not index file `%s': %s. Will try to insert instead.\n"),
673 p->filename, _("failed to compute hash"));
674 p->data.file.do_index = GNUNET_NO;
675 GNUNET_FS_file_information_sync_ (p);
676 publish_content (pc);
679 if (GNUNET_YES == p->data.file.index_start_confirmed)
681 publish_content (pc);
684 fn = GNUNET_STRINGS_filename_expand (p->filename);
685 GNUNET_assert (fn != NULL);
686 slen = strlen (fn) + 1;
688 GNUNET_SERVER_MAX_MESSAGE_SIZE - sizeof (struct IndexStartMessage))
690 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
692 ("Can not index file `%s': %s. Will try to insert instead.\n"),
693 fn, _("filename too long"));
695 p->data.file.do_index = GNUNET_NO;
696 GNUNET_FS_file_information_sync_ (p);
697 publish_content (pc);
700 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hash of indexed file `%s' is `%s'\n",
701 p->filename, GNUNET_h2s (res));
702 if (0 != (pc->options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY))
704 p->data.file.file_id = *res;
705 p->data.file.have_hash = GNUNET_YES;
706 p->data.file.index_start_confirmed = GNUNET_YES;
707 GNUNET_FS_file_information_sync_ (p);
708 publish_content (pc);
712 client = GNUNET_CLIENT_connect ("fs", pc->h->cfg);
715 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
717 ("Can not index file `%s': %s. Will try to insert instead.\n"),
718 p->filename, _("could not connect to `fs' service"));
719 p->data.file.do_index = GNUNET_NO;
720 publish_content (pc);
724 if (p->data.file.have_hash != GNUNET_YES)
726 p->data.file.file_id = *res;
727 p->data.file.have_hash = GNUNET_YES;
728 GNUNET_FS_file_information_sync_ (p);
730 ism = GNUNET_malloc (sizeof (struct IndexStartMessage) + slen);
731 ism->header.size = htons (sizeof (struct IndexStartMessage) + slen);
732 ism->header.type = htons (GNUNET_MESSAGE_TYPE_FS_INDEX_START);
733 if (GNUNET_OK == GNUNET_DISK_file_get_identifiers (p->filename, &dev, &ino))
735 ism->device = GNUNET_htonll (dev);
736 ism->inode = GNUNET_htonll (ino);
740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
741 _("Failed to get file identifiers for `%s'\n"), p->filename);
744 memcpy (&ism[1], fn, slen);
747 GNUNET_break (GNUNET_YES ==
748 GNUNET_CLIENT_transmit_and_get_response (client, &ism->header,
749 GNUNET_TIME_UNIT_FOREVER_REL,
751 &process_index_start_response,
758 * Main function that performs the upload.
760 * @param cls "struct GNUNET_FS_PublishContext" identifies the upload
761 * @param tc task context
764 GNUNET_FS_publish_main_ (void *cls,
765 const struct GNUNET_SCHEDULER_TaskContext *tc)
767 struct GNUNET_FS_PublishContext *pc = cls;
768 struct GNUNET_FS_ProgressInfo pi;
769 struct GNUNET_FS_FileInformation *p;
770 struct GNUNET_FS_Uri *loc;
773 pc->upload_task = GNUNET_SCHEDULER_NO_TASK;
777 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
778 "Publishing complete, now publishing SKS and KSK blocks.\n");
779 /* upload of entire hierarchy complete,
780 * publish namespace entries */
781 GNUNET_FS_publish_sync_ (pc);
785 /* find starting position */
786 while ((p->is_directory == GNUNET_YES) && (NULL != p->data.dir.entries) && (NULL == p->emsg)
787 && (NULL == p->data.dir.entries->chk_uri))
789 p = p->data.dir.entries;
791 GNUNET_FS_publish_sync_ (pc);
796 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Error uploading: %s\n", p->emsg);
797 /* error with current file, abort all
798 * related files as well! */
799 while (NULL != p->dir)
801 fn = GNUNET_CONTAINER_meta_data_get_by_type (p->meta,
802 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
806 GNUNET_asprintf (&p->emsg, _("Recursive upload failed at `%s': %s"), fn,
812 GNUNET_asprintf (&p->emsg, _("Recursive upload failed: %s"), p->emsg);
814 pi.status = GNUNET_FS_STATUS_PUBLISH_ERROR;
815 pi.value.publish.eta = GNUNET_TIME_UNIT_FOREVER_REL;
816 pi.value.publish.specifics.error.message = p->emsg;
817 p->client_info = GNUNET_FS_publish_make_status_ (&pi, pc, p, 0);
819 pc->all_done = GNUNET_YES;
820 GNUNET_FS_publish_sync_ (pc);
823 /* handle completion */
824 if (NULL != p->chk_uri)
826 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
827 "File upload complete, now publishing KSK blocks.\n");
828 if (0 == p->bo.anonymity_level)
830 /* zero anonymity, box CHK URI in LOC URI */
832 GNUNET_FS_uri_loc_create (p->chk_uri, pc->h->cfg,
833 p->bo.expiration_time);
834 GNUNET_FS_uri_destroy (p->chk_uri);
837 GNUNET_FS_publish_sync_ (pc);
838 /* upload of "p" complete, publish KBlocks! */
839 if (p->keywords != NULL)
841 pc->ksk_pc = GNUNET_FS_publish_ksk (pc->h, p->keywords, p->meta, p->chk_uri, &p->bo,
842 pc->options, &publish_kblocks_cont, pc);
846 publish_kblocks_cont (pc, p->chk_uri, NULL);
850 if ((p->is_directory != GNUNET_YES) && (p->data.file.do_index))
852 if (NULL == p->filename)
854 p->data.file.do_index = GNUNET_NO;
855 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
857 ("Can not index file `%s': %s. Will try to insert instead.\n"),
858 "<no-name>", _("needs to be an actual file"));
859 GNUNET_FS_file_information_sync_ (p);
860 publish_content (pc);
863 if (p->data.file.have_hash)
865 hash_for_index_cb (pc, &p->data.file.file_id);
869 p->start_time = GNUNET_TIME_absolute_get ();
871 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, p->filename,
872 HASHING_BLOCKSIZE, &hash_for_index_cb, pc);
876 publish_content (pc);
881 * Signal the FS's progress function that we are starting
884 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
885 * @param fi the entry in the publish-structure
886 * @param length length of the file or directory
887 * @param meta metadata for the file or directory (can be modified)
888 * @param uri pointer to the keywords that will be used for this entry (can be modified)
889 * @param bo block options
890 * @param do_index should we index?
891 * @param client_info pointer to client context set upon creation (can be modified)
892 * @return GNUNET_OK to continue (always)
895 fip_signal_start (void *cls, struct GNUNET_FS_FileInformation *fi,
896 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
897 struct GNUNET_FS_Uri **uri, struct GNUNET_FS_BlockOptions *bo,
898 int *do_index, void **client_info)
900 struct GNUNET_FS_PublishContext *pc = cls;
901 struct GNUNET_FS_ProgressInfo pi;
905 if (GNUNET_YES == pc->skip_next_fi_callback)
907 pc->skip_next_fi_callback = GNUNET_NO;
910 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Starting publish operation\n");
913 /* space for on-demand blocks */
915 ((length + DBLOCK_SIZE -
916 1) / DBLOCK_SIZE) * sizeof (struct OnDemandBlock);
920 /* space for DBlocks */
921 pc->reserve_space += length;
923 /* entries for IBlocks and DBlocks, space for IBlocks */
927 left = (left + DBLOCK_SIZE - 1) / DBLOCK_SIZE;
928 pc->reserve_entries += left;
931 left = left * sizeof (struct ContentHashKey);
932 pc->reserve_space += left;
934 pc->reserve_entries++;
935 /* entries and space for keywords */
938 kc = GNUNET_FS_uri_ksk_get_keyword_count (*uri);
939 pc->reserve_entries += kc;
940 pc->reserve_space += GNUNET_SERVER_MAX_MESSAGE_SIZE * kc;
942 pi.status = GNUNET_FS_STATUS_PUBLISH_START;
943 *client_info = GNUNET_FS_publish_make_status_ (&pi, pc, fi, 0);
944 GNUNET_FS_file_information_sync_ (fi);
945 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta)
946 && (fi->dir != NULL))
948 /* process entries in directory */
949 pc->skip_next_fi_callback = GNUNET_YES;
950 GNUNET_FS_file_information_inspect (fi, &fip_signal_start, pc);
957 * Signal the FS's progress function that we are suspending
960 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
961 * @param fi the entry in the publish-structure
962 * @param length length of the file or directory
963 * @param meta metadata for the file or directory (can be modified)
964 * @param uri pointer to the keywords that will be used for this entry (can be modified)
965 * @param bo block options
966 * @param do_index should we index?
967 * @param client_info pointer to client context set upon creation (can be modified)
968 * @return GNUNET_OK to continue (always)
971 fip_signal_suspend (void *cls, struct GNUNET_FS_FileInformation *fi,
972 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
973 struct GNUNET_FS_Uri **uri,
974 struct GNUNET_FS_BlockOptions *bo, int *do_index,
977 struct GNUNET_FS_PublishContext *pc = cls;
978 struct GNUNET_FS_ProgressInfo pi;
981 if (GNUNET_YES == pc->skip_next_fi_callback)
983 pc->skip_next_fi_callback = GNUNET_NO;
986 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
988 /* process entries in directory */
989 pc->skip_next_fi_callback = GNUNET_YES;
990 GNUNET_FS_file_information_inspect (fi, &fip_signal_suspend, pc);
992 if (NULL != pc->ksk_pc)
994 GNUNET_FS_publish_ksk_cancel (pc->ksk_pc);
997 if (NULL != pc->sks_pc)
999 GNUNET_FS_publish_sks_cancel (pc->sks_pc);
1002 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Suspending publish operation\n");
1003 GNUNET_free_non_null (fi->serialization);
1004 fi->serialization = NULL;
1005 off = (fi->chk_uri == NULL) ? 0 : length;
1006 pi.status = GNUNET_FS_STATUS_PUBLISH_SUSPEND;
1007 GNUNET_break (NULL == GNUNET_FS_publish_make_status_ (&pi, pc, fi, off));
1008 *client_info = NULL;
1009 if (NULL != pc->qre)
1011 GNUNET_DATASTORE_cancel (pc->qre);
1014 if (NULL != pc->dsh)
1016 GNUNET_DATASTORE_disconnect (pc->dsh, GNUNET_NO);
1025 * Create SUSPEND event for the given publish operation
1026 * and then clean up our state (without stop signal).
1028 * @param cls the 'struct GNUNET_FS_PublishContext' to signal for
1031 GNUNET_FS_publish_signal_suspend_ (void *cls)
1033 struct GNUNET_FS_PublishContext *pc = cls;
1035 if (GNUNET_SCHEDULER_NO_TASK != pc->upload_task)
1037 GNUNET_SCHEDULER_cancel (pc->upload_task);
1038 pc->upload_task = GNUNET_SCHEDULER_NO_TASK;
1040 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_suspend, pc);
1041 GNUNET_FS_end_top (pc->h, pc->top);
1043 publish_cleanup (pc);
1048 * We have gotten a reply for our space reservation request.
1049 * Either fail (insufficient space) or start publishing for good.
1051 * @param cls the 'struct GNUNET_FS_PublishContext*'
1052 * @param success positive reservation ID on success
1053 * @param min_expiration minimum expiration time required for content to be stored
1054 * @param msg error message on error, otherwise NULL
1057 finish_reserve (void *cls, int success,
1058 struct GNUNET_TIME_Absolute min_expiration,
1061 struct GNUNET_FS_PublishContext *pc = cls;
1064 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Reservation complete (%d)!\n", success);
1065 if ((msg != NULL) || (success <= 0))
1067 GNUNET_asprintf (&pc->fi->emsg, _("Insufficient space for publishing: %s"),
1069 signal_publish_error (pc->fi, pc, pc->fi->emsg);
1073 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pc->upload_task);
1075 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_BACKGROUND,
1076 &GNUNET_FS_publish_main_, pc);
1081 * Publish a file or directory.
1083 * @param h handle to the file sharing subsystem
1084 * @param fi information about the file or directory structure to publish
1085 * @param namespace namespace to publish the file in, NULL for no namespace
1086 * @param nid identifier to use for the publishd content in the namespace
1087 * (can be NULL, must be NULL if namespace is NULL)
1088 * @param nuid update-identifier that will be used for future updates
1089 * (can be NULL, must be NULL if namespace or nid is NULL)
1090 * @param options options for the publication
1091 * @return context that can be used to control the publish operation
1093 struct GNUNET_FS_PublishContext *
1094 GNUNET_FS_publish_start (struct GNUNET_FS_Handle *h,
1095 struct GNUNET_FS_FileInformation *fi,
1096 struct GNUNET_FS_Namespace *namespace, const char *nid,
1098 enum GNUNET_FS_PublishOptions options)
1100 struct GNUNET_FS_PublishContext *ret;
1101 struct GNUNET_DATASTORE_Handle *dsh;
1103 GNUNET_assert (NULL != h);
1104 if (0 == (options & GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY))
1106 dsh = GNUNET_DATASTORE_connect (h->cfg);
1114 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_PublishContext));
1118 ret->namespace = namespace;
1119 ret->options = options;
1120 if (namespace != NULL)
1123 GNUNET_assert (NULL != nid);
1124 ret->nid = GNUNET_strdup (nid);
1126 ret->nuid = GNUNET_strdup (nuid);
1129 GNUNET_FS_file_information_inspect (ret->fi, &fip_signal_start, ret);
1130 ret->fi_pos = ret->fi;
1131 ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_publish_signal_suspend_, ret);
1132 GNUNET_FS_publish_sync_ (ret);
1133 if (NULL != ret->dsh)
1135 GNUNET_assert (NULL == ret->qre);
1136 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1138 ("Reserving space for %u entries and %llu bytes for publication\n"),
1139 (unsigned int) ret->reserve_entries,
1140 (unsigned long long) ret->reserve_space);
1142 GNUNET_DATASTORE_reserve (ret->dsh, ret->reserve_space,
1143 ret->reserve_entries, UINT_MAX, UINT_MAX,
1144 GNUNET_TIME_UNIT_FOREVER_REL, &finish_reserve,
1149 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == ret->upload_task);
1151 GNUNET_SCHEDULER_add_with_priority
1152 (GNUNET_SCHEDULER_PRIORITY_BACKGROUND, &GNUNET_FS_publish_main_, ret);
1159 * Signal the FS's progress function that we are stopping
1162 * @param cls closure (of type "struct GNUNET_FS_PublishContext*")
1163 * @param fi the entry in the publish-structure
1164 * @param length length of the file or directory
1165 * @param meta metadata for the file or directory (can be modified)
1166 * @param uri pointer to the keywords that will be used for this entry (can be modified)
1167 * @param bo block options (can be modified)
1168 * @param do_index should we index?
1169 * @param client_info pointer to client context set upon creation (can be modified)
1170 * @return GNUNET_OK to continue (always)
1173 fip_signal_stop (void *cls, struct GNUNET_FS_FileInformation *fi,
1174 uint64_t length, struct GNUNET_CONTAINER_MetaData *meta,
1175 struct GNUNET_FS_Uri **uri, struct GNUNET_FS_BlockOptions *bo,
1176 int *do_index, void **client_info)
1178 struct GNUNET_FS_PublishContext *pc = cls;
1179 struct GNUNET_FS_ProgressInfo pi;
1182 if (GNUNET_YES == pc->skip_next_fi_callback)
1184 pc->skip_next_fi_callback = GNUNET_NO;
1187 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (meta))
1189 /* process entries in directory first */
1190 pc->skip_next_fi_callback = GNUNET_YES;
1191 GNUNET_FS_file_information_inspect (fi, &fip_signal_stop, pc);
1193 if (fi->serialization != NULL)
1195 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1197 GNUNET_free (fi->serialization);
1198 fi->serialization = NULL;
1200 off = (fi->chk_uri == NULL) ? 0 : length;
1201 pi.status = GNUNET_FS_STATUS_PUBLISH_STOPPED;
1202 GNUNET_break (NULL == GNUNET_FS_publish_make_status_ (&pi, pc, fi, off));
1203 *client_info = NULL;
1209 * Stop an upload. Will abort incomplete uploads (but
1210 * not remove blocks that have already been publishd) or
1211 * simply clean up the state for completed uploads.
1212 * Must NOT be called from within the event callback!
1214 * @param pc context for the upload to stop
1217 GNUNET_FS_publish_stop (struct GNUNET_FS_PublishContext *pc)
1219 struct GNUNET_FS_ProgressInfo pi;
1222 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Publish stop called\n");
1223 GNUNET_FS_end_top (pc->h, pc->top);
1224 if (NULL != pc->ksk_pc)
1226 GNUNET_FS_publish_ksk_cancel (pc->ksk_pc);
1229 if (NULL != pc->sks_pc)
1231 GNUNET_FS_publish_sks_cancel (pc->sks_pc);
1234 if (GNUNET_SCHEDULER_NO_TASK != pc->upload_task)
1236 GNUNET_SCHEDULER_cancel (pc->upload_task);
1237 pc->upload_task = GNUNET_SCHEDULER_NO_TASK;
1239 pc->skip_next_fi_callback = GNUNET_YES;
1240 GNUNET_FS_file_information_inspect (pc->fi, &fip_signal_stop, pc);
1242 if (pc->fi->serialization != NULL)
1244 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_FILE_INFO,
1245 pc->fi->serialization);
1246 GNUNET_free (pc->fi->serialization);
1247 pc->fi->serialization = NULL;
1249 off = (pc->fi->chk_uri == NULL) ? 0 : GNUNET_ntohll (pc->fi->chk_uri->data.chk.file_length);
1251 if (pc->serialization != NULL)
1253 GNUNET_FS_remove_sync_file_ (pc->h, GNUNET_FS_SYNC_PATH_MASTER_PUBLISH,
1255 GNUNET_free (pc->serialization);
1256 pc->serialization = NULL;
1258 if (NULL != pc->qre)
1260 GNUNET_DATASTORE_cancel (pc->qre);
1263 pi.status = GNUNET_FS_STATUS_PUBLISH_STOPPED;
1264 GNUNET_break (NULL == GNUNET_FS_publish_make_status_ (&pi, pc, pc->fi, off));
1265 publish_cleanup (pc);
1270 /* end of fs_publish.c */