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 2, 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"
36 * Function called by the tree encoder to obtain
37 * a block of plaintext data (for the lowest level
40 * @param cls our publishing context
41 * @param offset identifies which block to get
42 * @param max (maximum) number of bytes to get; returning
43 * fewer will also cause errors
44 * @param buf where to copy the plaintext buffer
45 * @param emsg location to store an error message (on error)
46 * @return number of bytes copied to buf, 0 on error
49 unindex_reader (void *cls,
55 struct GNUNET_FS_UnindexContext *uc = cls;
58 pt_size = GNUNET_MIN(max,
59 uc->file_size - offset);
61 GNUNET_DISK_file_seek (uc->fh, offset, GNUNET_DISK_SEEK_SET))
63 *emsg = GNUNET_strdup (_("Failed to find given position in file"));
67 GNUNET_DISK_file_read (uc->fh,
71 *emsg = GNUNET_strdup (_("Failed to read file"));
79 * Fill in all of the generic fields for
80 * an unindex event and call the callback.
82 * @param pi structure to fill in
83 * @param uc overall unindex context
84 * @param offset where we are in the file (for progress)
87 GNUNET_FS_unindex_make_status_ (struct GNUNET_FS_ProgressInfo *pi,
88 struct GNUNET_FS_UnindexContext *uc,
91 pi->value.unindex.uc = uc;
92 pi->value.unindex.cctx = uc->client_info;
93 pi->value.unindex.filename = uc->filename;
94 pi->value.unindex.size = uc->file_size;
96 = GNUNET_TIME_calculate_eta (uc->start_time,
99 pi->value.unindex.duration = GNUNET_TIME_absolute_get_duration (uc->start_time);
100 pi->value.unindex.completed = offset;
102 = uc->h->upcb (uc->h->upcb_cls,
109 * Function called with information about our
110 * progress in computing the tree encoding.
113 * @param offset where are we in the file
114 * @param pt_block plaintext of the currently processed block
115 * @param pt_size size of pt_block
116 * @param depth depth of the block in the tree
119 unindex_progress (void *cls,
121 const void *pt_block,
125 struct GNUNET_FS_UnindexContext *uc = cls;
126 struct GNUNET_FS_ProgressInfo pi;
128 pi.status = GNUNET_FS_STATUS_UNINDEX_PROGRESS;
129 pi.value.unindex.specifics.progress.data = pt_block;
130 pi.value.unindex.specifics.progress.offset = offset;
131 pi.value.unindex.specifics.progress.data_len = pt_size;
132 pi.value.unindex.specifics.progress.depth = depth;
133 GNUNET_FS_unindex_make_status_ (&pi, uc, offset);
138 * We've encountered an error during
139 * unindexing. Signal the client.
141 * @param uc context for the failed unindexing operation
144 signal_unindex_error (struct GNUNET_FS_UnindexContext *uc)
146 struct GNUNET_FS_ProgressInfo pi;
148 pi.status = GNUNET_FS_STATUS_UNINDEX_ERROR;
149 pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
150 pi.value.unindex.specifics.error.message = uc->emsg;
151 GNUNET_FS_unindex_make_status_ (&pi, uc, 0);
156 * Continuation called to notify client about result of the
157 * datastore removal operation.
160 * @param success GNUNET_SYSERR on failure
161 * @param msg NULL on success, otherwise an error message
164 process_cont (void *cls,
168 struct GNUNET_FS_UnindexContext *uc = cls;
169 if (success == GNUNET_SYSERR)
171 uc->emsg = GNUNET_strdup (msg);
172 signal_unindex_error (uc);
175 GNUNET_FS_tree_encoder_next (uc->tc);
180 * Function called asking for the current (encoded)
181 * block to be processed. After processing the
182 * client should either call "GNUNET_FS_tree_encode_next"
183 * or (on error) "GNUNET_FS_tree_encode_finish".
186 * @param query the query for the block (key for lookup in the datastore)
187 * @param offset offset of the block
188 * @param type type of the block (IBLOCK or DBLOCK)
189 * @param block the (encrypted) block
190 * @param block_size size of block (in bytes)
193 unindex_process (void *cls,
194 const GNUNET_HashCode *query,
196 enum GNUNET_BLOCK_Type type,
200 struct GNUNET_FS_UnindexContext *uc = cls;
203 struct OnDemandBlock odb;
205 if (type != GNUNET_BLOCK_TYPE_DBLOCK)
210 else /* on-demand encoded DBLOCK */
212 size = sizeof(struct OnDemandBlock);
213 odb.offset = GNUNET_htonll (offset);
214 odb.file_id = uc->file_id;
217 GNUNET_DATASTORE_remove (uc->dsh,
223 GNUNET_CONSTANTS_SERVICE_TIMEOUT);
228 * Function called when the tree encoder has
229 * processed all blocks. Clean up.
231 * @param cls our unindexing context
235 unindex_finish (void *cls,
236 const struct GNUNET_SCHEDULER_TaskContext *tc)
238 struct GNUNET_FS_UnindexContext *uc = cls;
240 struct GNUNET_FS_Uri *uri;
241 struct GNUNET_FS_ProgressInfo pi;
243 GNUNET_FS_tree_encoder_finish (uc->tc,
247 GNUNET_FS_uri_destroy (uri);
248 GNUNET_DISK_file_close (uc->fh);
250 GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
255 signal_unindex_error (uc);
259 pi.status = GNUNET_FS_STATUS_UNINDEX_COMPLETED;
260 pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
261 GNUNET_FS_unindex_make_status_ (&pi, uc, uc->file_size);
263 GNUNET_FS_unindex_sync_ (uc);
268 * Function called with the response from the
269 * FS service to our unindexing request.
271 * @param cls closure, unindex context
272 * @param msg NULL on timeout, otherwise the response
275 process_fs_response (void *cls,
276 const struct GNUNET_MessageHeader *msg)
278 struct GNUNET_FS_UnindexContext *uc = cls;
280 if (uc->client != NULL)
282 GNUNET_CLIENT_disconnect (uc->client, GNUNET_NO);
285 if (uc->state != UNINDEX_STATE_FS_NOTIFY)
287 GNUNET_FS_unindex_stop (uc);
292 uc->state = UNINDEX_STATE_ERROR;
293 uc->emsg = GNUNET_strdup (_("Timeout waiting for `fs' service."));
294 GNUNET_FS_unindex_sync_ (uc);
295 signal_unindex_error (uc);
298 if (ntohs(msg->type) != GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK)
300 uc->state = UNINDEX_STATE_ERROR;
301 uc->emsg = GNUNET_strdup (_("Invalid response from `fs' service."));
302 GNUNET_FS_unindex_sync_ (uc);
303 signal_unindex_error (uc);
306 uc->state = UNINDEX_STATE_DS_REMOVE;
307 GNUNET_FS_unindex_sync_ (uc);
308 GNUNET_FS_unindex_do_remove_ (uc);
313 * Connect to the datastore and remove the blocks.
315 * @param uc context for the unindex operation.
318 GNUNET_FS_unindex_do_remove_ (struct GNUNET_FS_UnindexContext *uc)
320 uc->dsh = GNUNET_DATASTORE_connect (uc->h->cfg,
324 uc->state = UNINDEX_STATE_ERROR;
325 uc->emsg = GNUNET_strdup (_("Failed to connect to `datastore' service."));
326 GNUNET_FS_unindex_sync_ (uc);
327 signal_unindex_error (uc);
330 uc->fh = GNUNET_DISK_file_open (uc->filename,
331 GNUNET_DISK_OPEN_READ,
332 GNUNET_DISK_PERM_NONE);
335 GNUNET_DATASTORE_disconnect (uc->dsh, GNUNET_NO);
337 uc->state = UNINDEX_STATE_ERROR;
338 uc->emsg = GNUNET_strdup (_("Failed to open file for unindexing."));
339 GNUNET_FS_unindex_sync_ (uc);
340 signal_unindex_error (uc);
343 uc->tc = GNUNET_FS_tree_encoder_create (uc->h,
350 GNUNET_FS_tree_encoder_next (uc->tc);
355 * Function called once the hash of the file
356 * that is being unindexed has been computed.
358 * @param cls closure, unindex context
359 * @param file_id computed hash, NULL on error
362 GNUNET_FS_unindex_process_hash_ (void *cls,
363 const GNUNET_HashCode *file_id)
365 struct GNUNET_FS_UnindexContext *uc = cls;
366 struct UnindexMessage req;
368 if (uc->state != UNINDEX_STATE_HASHING)
370 GNUNET_FS_unindex_stop (uc);
375 uc->state = UNINDEX_STATE_ERROR;
376 uc->emsg = GNUNET_strdup (_("Failed to compute hash of file."));
377 GNUNET_FS_unindex_sync_ (uc);
378 signal_unindex_error (uc);
381 uc->file_id = *file_id;
382 uc->state = UNINDEX_STATE_FS_NOTIFY;
383 GNUNET_FS_unindex_sync_ (uc);
384 uc->client = GNUNET_CLIENT_connect (uc->h->sched,
387 req.header.size = htons (sizeof (struct UnindexMessage));
388 req.header.type = htons (GNUNET_MESSAGE_TYPE_FS_UNINDEX);
390 req.file_id = *file_id;
391 GNUNET_break (GNUNET_OK ==
392 GNUNET_CLIENT_transmit_and_get_response (uc->client,
394 GNUNET_CONSTANTS_SERVICE_TIMEOUT,
396 &process_fs_response,
402 * Create SUSPEND event for the given unindex operation
403 * and then clean up our state (without stop signal).
405 * @param cls the 'struct GNUNET_FS_UnindexContext' to signal for
408 unindex_signal_suspend (void *cls)
410 struct GNUNET_FS_UnindexContext *uc = cls;
411 struct GNUNET_FS_ProgressInfo pi;
413 GNUNET_FS_end_top (uc->h, uc->top);
414 pi.status = GNUNET_FS_STATUS_UNINDEX_SUSPEND;
415 GNUNET_FS_unindex_make_status_ (&pi, uc,
416 (uc->state == UNINDEX_STATE_COMPLETE)
417 ? uc->file_size : 0);
418 GNUNET_break (NULL == uc->client_info);
419 GNUNET_free (uc->filename);
420 GNUNET_free_non_null (uc->serialization);
428 * @param h handle to the file sharing subsystem
429 * @param filename file to unindex
430 * @param cctx initial value for the client context
431 * @return NULL on error, otherwise handle
433 struct GNUNET_FS_UnindexContext *
434 GNUNET_FS_unindex_start (struct GNUNET_FS_Handle *h,
435 const char *filename,
438 struct GNUNET_FS_UnindexContext *ret;
439 struct GNUNET_FS_ProgressInfo pi;
443 GNUNET_DISK_file_size (filename,
447 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_UnindexContext));
449 ret->filename = GNUNET_strdup (filename);
450 ret->start_time = GNUNET_TIME_absolute_get ();
451 ret->file_size = size;
452 ret->client_info = cctx;
453 GNUNET_FS_unindex_sync_ (ret);
454 pi.status = GNUNET_FS_STATUS_UNINDEX_START;
455 pi.value.unindex.eta = GNUNET_TIME_UNIT_FOREVER_REL;
456 GNUNET_FS_unindex_make_status_ (&pi, ret, 0);
457 /* FIXME: must be able to abort hashing here! */
458 GNUNET_CRYPTO_hash_file (h->sched,
459 GNUNET_SCHEDULER_PRIORITY_IDLE,
462 &GNUNET_FS_unindex_process_hash_,
464 ret->top = GNUNET_FS_make_top (h,
465 &unindex_signal_suspend,
472 * Clean up after completion of an unindex operation.
477 GNUNET_FS_unindex_stop (struct GNUNET_FS_UnindexContext *uc)
479 struct GNUNET_FS_ProgressInfo pi;
481 /* FIXME: stop hashing (if still ongoing) */
482 /* FIXME: disconnect uc->client (if still connected) */
483 /* FIXME: disconnect from datastore (if still connected) */
484 /* FIXME: other termination operations? */
485 /* FIXME: must do same cleanup in 'unindex_signal_suspend'! */
486 GNUNET_FS_end_top (uc->h, uc->top);
487 if ( (uc->state != UNINDEX_STATE_COMPLETE) &&
488 (uc->state != UNINDEX_STATE_ERROR) )
490 uc->state = UNINDEX_STATE_ABORTED;
493 if (uc->serialization != NULL)
495 GNUNET_FS_remove_sync_file_ (uc->h, GNUNET_FS_SYNC_PATH_MASTER_UNINDEX, uc->serialization);
496 GNUNET_free (uc->serialization);
497 uc->serialization = NULL;
499 pi.status = GNUNET_FS_STATUS_UNINDEX_STOPPED;
500 pi.value.unindex.eta = GNUNET_TIME_UNIT_ZERO;
501 GNUNET_FS_unindex_make_status_ (&pi, uc,
502 (uc->state == UNINDEX_STATE_COMPLETE)
503 ? uc->file_size : 0);
504 GNUNET_break (NULL == uc->client_info);
505 GNUNET_free (uc->filename);
509 /* end of fs_unindex.c */