2 This file is part of GNUnet.
3 (C) 2003, 2004, 2006, 2009 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_unindex.c
23 * @author Krista Grothoff
24 * @author Christian Grothoff
25 * @brief Unindex file.
28 #include "gnunet_constants.h"
29 #include "gnunet_fs_service.h"
30 #include "gnunet_protocols.h"
34 #define DEBUG_UNINDEX GNUNET_EXTRA_LOGGING
37 * Function called by the tree encoder to obtain
38 * a block of plaintext data (for the lowest level
41 * @param cls our publishing context
42 * @param offset identifies which block to get
43 * @param max (maximum) number of bytes to get; returning
44 * fewer will also cause errors
45 * @param buf where to copy the plaintext buffer
46 * @param emsg location to store an error message (on error)
47 * @return number of bytes copied to buf, 0 on error
50 unindex_reader (void *cls, uint64_t offset, size_t max, void *buf, char **emsg)
52 struct GNUNET_FS_UnindexContext *uc = cls;
55 pt_size = GNUNET_MIN (max, uc->file_size - offset);
56 if (offset != GNUNET_DISK_file_seek (uc->fh, offset, GNUNET_DISK_SEEK_SET))
58 *emsg = GNUNET_strdup (_("Failed to find given position in file"));
61 if (pt_size != GNUNET_DISK_file_read (uc->fh, buf, pt_size))
63 *emsg = GNUNET_strdup (_("Failed to read file"));
71 * Fill in all of the generic fields for
72 * an unindex event and call the callback.
74 * @param pi structure to fill in
75 * @param uc overall unindex context
76 * @param offset where we are in the file (for progress)
79 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
80 struct GNUNET_FS_UnindexContext *uc,
83 pi->value.unindex.uc = uc;
84 pi->value.unindex.cctx = uc->client_info;
85 pi->value.unindex.filename = uc->filename;
86 pi->value.unindex.size = uc->file_size;
87 pi->value.unindex.eta =
88 GNUNET_TIME_calculate_eta (uc->start_time, offset, uc->file_size);
89 pi->value.unindex.duration =
90 GNUNET_TIME_absolute_get_duration (uc->start_time);
91 pi->value.unindex.completed = offset;
92 uc->client_info = uc->h->upcb (uc->h->upcb_cls, pi);
98 * Function called with information about our
99 * progress in computing the tree encoding.
102 * @param offset where are we in the file
103 * @param pt_block plaintext of the currently processed block
104 * @param pt_size size of pt_block
105 * @param depth depth of the block in the tree, 0 for DBLOCK
108 unindex_progress (void *cls, uint64_t offset, const void *pt_block,
109 size_t pt_size, unsigned int depth)
111 struct GNUNET_FS_UnindexContext *uc = cls;
112 struct GNUNET_FS_ProgressInfo pi;
114 pi.status = GNUNET_FS_STATUS_UNINDEX_PROGRESS;
115 pi.value.unindex.specifics.progress.data = pt_block;
116 pi.value.unindex.specifics.progress.offset = offset;
117 pi.value.unindex.specifics.progress.data_len = pt_size;
118 pi.value.unindex.specifics.progress.depth = depth;
119 GNUNET_FS_unindex_make_status_ (&pi, uc, offset);
124 * We've encountered an error during
125 * unindexing. Signal the client.
127 * @param uc context for the failed unindexing operation
130 signal_unindex_error (struct GNUNET_FS_UnindexContext *uc)
132 struct GNUNET_FS_ProgressInfo pi;
134 pi.status = GNUNET_FS_STATUS_UNINDEX_ERROR;
135 pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
136 pi.value.unindex.specifics.error.message = uc->emsg;
137 GNUNET_FS_unindex_make_status_ (&pi, uc, 0);
142 * Continuation called to notify client about result of the
143 * datastore removal operation.
146 * @param success GNUNET_SYSERR on failure
147 * @param msg NULL on success, otherwise an error message
150 process_cont (void *cls, int success, const char *msg)
152 struct GNUNET_FS_UnindexContext *uc = cls;
154 if (success == GNUNET_SYSERR)
156 uc->emsg = GNUNET_strdup (msg);
157 signal_unindex_error (uc);
161 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
162 "Datastore REMOVE operation succeeded\n");
164 GNUNET_FS_tree_encoder_next (uc->tc);
169 * Function called asking for the current (encoded)
170 * block to be processed. After processing the
171 * client should either call "GNUNET_FS_tree_encode_next"
172 * or (on error) "GNUNET_FS_tree_encode_finish".
175 * @param chk content hash key for the block (key for lookup in the datastore)
176 * @param offset offset of the block
177 * @param depth depth of the block, 0 for DBLOCK
178 * @param type type of the block (IBLOCK or DBLOCK)
179 * @param block the (encrypted) block
180 * @param block_size size of block (in bytes)
183 unindex_process (void *cls, const struct ContentHashKey *chk, uint64_t offset,
184 unsigned int depth, enum GNUNET_BLOCK_Type type,
185 const void *block, uint16_t block_size)
187 struct GNUNET_FS_UnindexContext *uc = cls;
190 struct OnDemandBlock odb;
192 if (type != GNUNET_BLOCK_TYPE_FS_DBLOCK)
197 else /* on-demand encoded DBLOCK */
199 size = sizeof (struct OnDemandBlock);
200 odb.offset = GNUNET_htonll (offset);
201 odb.file_id = uc->file_id;
205 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
206 "Sending REMOVE request to DATASTORE service\n");
208 GNUNET_DATASTORE_remove (uc->dsh, &chk->query, size, data, -2, 1,
209 GNUNET_CONSTANTS_SERVICE_TIMEOUT, &process_cont, uc);
214 * Function called with the response from the
215 * FS service to our unindexing request.
217 * @param cls closure, unindex context
218 * @param msg NULL on timeout, otherwise the response
221 process_fs_response (void *cls, const struct GNUNET_MessageHeader *msg)
223 struct GNUNET_FS_UnindexContext *uc = cls;
224 struct GNUNET_FS_ProgressInfo pi;
226 if (uc->client != NULL)
228 GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
231 if (uc->state != UNINDEX_STATE_FS_NOTIFY)
233 uc->state = UNINDEX_STATE_ERROR;
235 GNUNET_strdup (_("Unexpected time for a response from `fs' service."));
236 GNUNET_FS_unindex_sync_ (uc);
237 signal_unindex_error (uc);
242 uc->state = UNINDEX_STATE_ERROR;
243 uc->emsg = GNUNET_strdup (_("Timeout waiting for `fs' service."));
244 GNUNET_FS_unindex_sync_ (uc);
245 signal_unindex_error (uc);
248 if (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK)
250 uc->state = UNINDEX_STATE_ERROR;
251 uc->emsg = GNUNET_strdup (_("Invalid response from `fs' service."));
252 GNUNET_FS_unindex_sync_ (uc);
253 signal_unindex_error (uc);
256 uc->state = UNINDEX_STATE_COMPLETE;
257 pi.status = GNUNET_FS_STATUS_UNINDEX_COMPLETED;
258 pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
259 GNUNET_FS_unindex_sync_ (uc);
260 GNUNET_FS_unindex_make_status_ (&pi, uc, uc->file_size);
265 * Function called when the tree encoder has
266 * processed all blocks. Clean up.
268 * @param cls our unindexing context
272 unindex_finish (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
274 struct GNUNET_FS_UnindexContext *uc = cls;
276 struct GNUNET_FS_Uri *uri;
277 struct UnindexMessage req;
279 /* generate final progress message */
280 unindex_progress (uc, uc->file_size, NULL, 0, 0);
281 GNUNET_FS_tree_encoder_finish (uc->tc, &uri, &emsg);
284 GNUNET_FS_uri_destroy (uri);
285 GNUNET_DISK_file_close (uc->fh);
287 GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
289 uc->state = UNINDEX_STATE_FS_NOTIFY;
290 GNUNET_FS_unindex_sync_ (uc);
291 uc->client = GNUNET_CLIENT_connect ("fs", uc->h->cfg);
292 if (uc->client == NULL)
294 uc->state = UNINDEX_STATE_ERROR;
296 GNUNET_strdup (_("Failed to connect to FS service for unindexing."));
297 GNUNET_FS_unindex_sync_ (uc);
298 signal_unindex_error (uc);
302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
303 "Sending UNINDEX message to FS service\n");
305 req.header.size = htons (sizeof (struct UnindexMessage));
306 req.header.type = htons (GNUNET_MESSAGE_TYPE_FS_UNINDEX);
308 req.file_id = uc->file_id;
309 GNUNET_break (GNUNET_OK ==
310 GNUNET_CLIENT_transmit_and_get_response (uc->client,
312 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
314 &process_fs_response,
320 * Connect to the datastore and remove the blocks.
322 * @param uc context for the unindex operation.
325 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc)
327 uc->dsh = GNUNET_DATASTORE_connect (uc->h->cfg);
330 uc->state = UNINDEX_STATE_ERROR;
331 uc->emsg = GNUNET_strdup (_("Failed to connect to `datastore' service."));
332 GNUNET_FS_unindex_sync_ (uc);
333 signal_unindex_error (uc);
337 GNUNET_DISK_file_open (uc->filename, GNUNET_DISK_OPEN_READ,
338 GNUNET_DISK_PERM_NONE);
341 GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
343 uc->state = UNINDEX_STATE_ERROR;
344 uc->emsg = GNUNET_strdup (_("Failed to open file for unindexing."));
345 GNUNET_FS_unindex_sync_ (uc);
346 signal_unindex_error (uc);
350 GNUNET_FS_tree_encoder_create (uc->h, uc->file_size, uc, &unindex_reader,
351 &unindex_process, &unindex_progress,
353 GNUNET_FS_tree_encoder_next (uc->tc);
358 * Function called once the hash of the file
359 * that is being unindexed has been computed.
361 * @param cls closure, unindex context
362 * @param file_id computed hash, NULL on error
365 GNUNET_FS_unindex_process_hash_ (void *cls, const GNUNET_HashCode * file_id)
367 struct GNUNET_FS_UnindexContext *uc = cls;
370 if (uc->state != UNINDEX_STATE_HASHING)
372 GNUNET_FS_unindex_stop (uc);
377 uc->state = UNINDEX_STATE_ERROR;
378 uc->emsg = GNUNET_strdup (_("Failed to compute hash of file."));
379 GNUNET_FS_unindex_sync_ (uc);
380 signal_unindex_error (uc);
383 uc->file_id = *file_id;
384 uc->state = UNINDEX_STATE_DS_REMOVE;
385 GNUNET_FS_unindex_sync_ (uc);
386 GNUNET_FS_unindex_do_remove_ (uc);
391 * Create SUSPEND event for the given unindex operation
392 * and then clean up our state (without stop signal).
394 * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
397 GNUNET_FS_unindex_signal_suspend_ (void *cls)
399 struct GNUNET_FS_UnindexContext *uc = cls;
400 struct GNUNET_FS_ProgressInfo pi;
404 GNUNET_CRYPTO_hash_file_cancel (uc->fhc);
407 if (uc->client != NULL)
409 GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
414 GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
419 GNUNET_FS_tree_encoder_finish (uc->tc, NULL, NULL);
424 GNUNET_DISK_file_close (uc->fh);
427 GNUNET_FS_end_top (uc->h, uc->top);
428 pi.status = GNUNET_FS_STATUS_UNINDEX_SUSPEND;
429 GNUNET_FS_unindex_make_status_ (&pi, uc,
431 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
432 GNUNET_break (NULL == uc->client_info);
433 GNUNET_free (uc->filename);
434 GNUNET_free_non_null (uc->serialization);
435 GNUNET_free_non_null (uc->emsg);
443 * @param h handle to the file sharing subsystem
444 * @param filename file to unindex
445 * @param cctx initial value for the client context
446 * @return NULL on error, otherwise handle
448 struct GNUNET_FS_UnindexContext *
449 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h, const char *filename,
452 struct GNUNET_FS_UnindexContext *ret;
453 struct GNUNET_FS_ProgressInfo pi;
456 if (GNUNET_OK != GNUNET_DISK_file_size (filename, &size, GNUNET_YES))
458 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
460 ret->filename = GNUNET_strdup (filename);
461 ret->start_time = GNUNET_TIME_absolute_get ();
462 ret->file_size = size;
463 ret->client_info = cctx;
464 GNUNET_FS_unindex_sync_ (ret);
465 pi.status = GNUNET_FS_STATUS_UNINDEX_START;
466 pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
467 GNUNET_FS_unindex_make_status_ (&pi, ret, 0);
469 GNUNET_CRYPTO_hash_file (GNUNET_SCHEDULER_PRIORITY_IDLE, filename,
471 &GNUNET_FS_unindex_process_hash_, ret);
472 ret->top = GNUNET_FS_make_top (h, &GNUNET_FS_unindex_signal_suspend_, ret);
478 * Clean up after completion of an unindex operation.
483 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc)
485 struct GNUNET_FS_ProgressInfo pi;
489 GNUNET_CRYPTO_hash_file_cancel (uc->fhc);
492 if (uc->client != NULL)
494 GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
499 GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
504 GNUNET_FS_tree_encoder_finish (uc->tc, NULL, NULL);
509 GNUNET_DISK_file_close (uc->fh);
512 GNUNET_FS_end_top (uc->h, uc->top);
513 if (uc->serialization != NULL)
515 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX,
517 GNUNET_free (uc->serialization);
518 uc->serialization = NULL;
520 pi.status = GNUNET_FS_STATUS_UNINDEX_STOPPED;
521 pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
522 GNUNET_FS_unindex_make_status_ (&pi, uc,
524 UNINDEX_STATE_COMPLETE) ? uc->file_size : 0);
525 GNUNET_break (NULL == uc->client_info);
526 GNUNET_free (uc->filename);
530 /* end of fs_unindex.c */