2 This file is part of GNUnet
3 (C) 2005-2012 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_dirmetascan.c
23 * @brief code to asynchronously build a 'struct GNUNET_FS_ShareTreeItem'
24 * from an on-disk directory for publishing; use the 'gnunet-helper-fs-publish'.
26 * @author Christian Grothoff
29 #include "gnunet_fs_service.h"
30 #include "gnunet_scheduler_lib.h"
35 * An opaque structure a pointer to which is returned to the
36 * caller to be used to control the scanner.
38 struct GNUNET_FS_DirScanner
44 struct GNUNET_HELPER_Handle *helper;
47 * Expanded filename (as given by the scan initiator).
48 * The scanner thread stores a copy here, and frees it when it finishes.
50 char *filename_expanded;
53 * Second argument to helper process.
58 * The function that will be called every time there's a progress
61 GNUNET_FS_DirScannerProgressCallback progress_callback;
64 * A closure for progress_callback.
66 void *progress_callback_cls;
69 * After the scan is finished, it will contain a pointer to the
70 * top-level directory entry in the directory tree built by the
73 struct GNUNET_FS_ShareTreeItem *toplevel;
76 * Current position during processing.
78 struct GNUNET_FS_ShareTreeItem *pos;
81 * Task scheduled when we are done.
83 GNUNET_SCHEDULER_TaskIdentifier stop_task;
86 * Arguments for helper.
97 * @param ds directory scanner structure
100 GNUNET_FS_directory_scan_abort (struct GNUNET_FS_DirScanner *ds)
102 /* terminate helper */
103 if (NULL != ds->helper)
104 GNUNET_HELPER_stop (ds->helper);
107 if (NULL != ds->toplevel)
108 GNUNET_FS_share_tree_free (ds->toplevel);
109 if (GNUNET_SCHEDULER_NO_TASK != ds->stop_task)
110 GNUNET_SCHEDULER_cancel (ds->stop_task);
111 GNUNET_free_non_null (ds->ex_arg);
112 GNUNET_free (ds->filename_expanded);
118 * Obtain the result of the scan after the scan has signalled
119 * completion. Must not be called prior to completion. The 'ds' is
120 * freed as part of this call.
122 * @param ds directory scanner structure
123 * @return the results of the scan (a directory tree)
125 struct GNUNET_FS_ShareTreeItem *
126 GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds)
128 struct GNUNET_FS_ShareTreeItem *result;
130 /* check that we're actually done */
131 GNUNET_assert (NULL == ds->helper);
132 /* preserve result */
133 result = ds->toplevel;
135 GNUNET_FS_directory_scan_abort (ds);
141 * Move in the directory from the given position to the next file
144 * @param pos current position
145 * @return next file, NULL for none
147 static struct GNUNET_FS_ShareTreeItem *
148 advance (struct GNUNET_FS_ShareTreeItem *pos)
152 GNUNET_assert (NULL != pos);
153 moved = 0; /* must not terminate, even on file, otherwise "normal" */
154 while ( (pos->is_directory) ||
157 if ( (moved != -1) &&
158 (NULL != pos->children_head) )
160 pos = pos->children_head;
161 moved = 1; /* can terminate if file */
164 if (NULL != pos->next)
167 moved = 1; /* can terminate if file */
170 if (NULL != pos->parent)
173 moved = -1; /* force move to 'next' or 'parent' */
176 /* no more options, end of traversal */
184 * Add another child node to the tree.
186 * @param parent parent of the child, NULL for top level
187 * @param filename name of the file or directory
188 * @param is_directory GNUNET_YES for directories
189 * @return new entry that was just created
191 static struct GNUNET_FS_ShareTreeItem *
192 expand_tree (struct GNUNET_FS_ShareTreeItem *parent,
193 const char *filename,
196 struct GNUNET_FS_ShareTreeItem *chld;
199 chld = GNUNET_malloc (sizeof (struct GNUNET_FS_ShareTreeItem));
200 chld->parent = parent;
201 chld->filename = GNUNET_strdup (filename);
202 GNUNET_asprintf (&chld->short_filename,
204 GNUNET_STRINGS_get_short_name (filename),
205 is_directory ? "/" : "");
206 /* make sure we do not end with '//' */
207 slen = strlen (chld->short_filename);
209 (chld->short_filename[slen-1] == '/') &&
210 (chld->short_filename[slen-2] == '/') )
211 chld->short_filename[slen-1] = '\0';
212 chld->is_directory = is_directory;
214 GNUNET_CONTAINER_DLL_insert (parent->children_head,
215 parent->children_tail,
222 * Task run last to shut everything down.
224 * @param cls the 'struct GNUNET_FS_DirScanner'
228 finish_scan (void *cls,
229 const struct GNUNET_SCHEDULER_TaskContext *tc)
231 struct GNUNET_FS_DirScanner *ds = cls;
233 ds->stop_task = GNUNET_SCHEDULER_NO_TASK;
234 GNUNET_HELPER_stop (ds->helper);
236 ds->progress_callback (ds->progress_callback_cls,
238 GNUNET_FS_DIRSCANNER_FINISHED);
243 * Called every time there is data to read from the scanner.
244 * Calls the scanner progress handler.
246 * @param cls the closure (directory scanner object)
247 * @param client always NULL
248 * @param msg message from the helper process
251 process_helper_msgs (void *cls,
253 const struct GNUNET_MessageHeader *msg)
255 struct GNUNET_FS_DirScanner *ds = cls;
256 const char *filename;
259 left = ntohs (msg->size) - sizeof (struct GNUNET_MessageHeader);
260 filename = (const char*) &msg[1];
261 switch (ntohs (msg->type))
263 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_FILE:
264 if (filename[left-1] != '\0')
269 ds->progress_callback (ds->progress_callback_cls,
271 GNUNET_FS_DIRSCANNER_FILE_START);
272 if (NULL == ds->toplevel)
273 ds->toplevel = expand_tree (ds->pos,
274 filename, GNUNET_NO);
276 (void) expand_tree (ds->pos,
277 filename, GNUNET_NO);
279 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_DIRECTORY:
280 if (filename[left-1] != '\0')
285 if (0 == strcmp ("..", filename))
292 ds->pos = ds->pos->parent;
295 ds->progress_callback (ds->progress_callback_cls,
296 filename, GNUNET_YES,
297 GNUNET_FS_DIRSCANNER_FILE_START);
298 ds->pos = expand_tree (ds->pos,
299 filename, GNUNET_YES);
300 if (NULL == ds->toplevel)
301 ds->toplevel = ds->pos;
303 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_ERROR:
305 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_SKIP_FILE:
306 if (filename[left-1] != '\0')
308 ds->progress_callback (ds->progress_callback_cls,
309 filename, GNUNET_SYSERR,
310 GNUNET_FS_DIRSCANNER_FILE_IGNORED);
312 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_COUNTING_DONE:
318 if (NULL == ds->toplevel)
323 ds->progress_callback (ds->progress_callback_cls,
325 GNUNET_FS_DIRSCANNER_ALL_COUNTED);
326 ds->pos = ds->toplevel;
327 if (ds->pos->is_directory)
328 ds->pos = advance (ds->pos);
330 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_META_DATA:
340 end = memchr (filename, 0, left);
347 nlen = end - filename;
349 if (0 != strcmp (filename,
355 ds->progress_callback (ds->progress_callback_cls,
356 filename, GNUNET_YES,
357 GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED);
360 ds->pos->meta = GNUNET_CONTAINER_meta_data_deserialize (end, left);
361 if (NULL == ds->pos->meta)
366 /* having full filenames is too dangerous; always make sure we clean them up */
367 GNUNET_CONTAINER_meta_data_delete (ds->pos->meta,
368 EXTRACTOR_METATYPE_FILENAME,
370 /* instead, put in our 'safer' original filename */
371 GNUNET_CONTAINER_meta_data_insert (ds->pos->meta, "<libgnunetfs>",
372 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
373 EXTRACTOR_METAFORMAT_UTF8, "text/plain",
374 ds->pos->short_filename,
375 strlen (ds->pos->short_filename) + 1);
377 ds->pos = advance (ds->pos);
380 case GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_FINISHED:
391 if (NULL == ds->toplevel)
396 ds->stop_task = GNUNET_SCHEDULER_add_now (&finish_scan,
403 ds->progress_callback (ds->progress_callback_cls,
405 GNUNET_FS_DIRSCANNER_INTERNAL_ERROR);
410 * Start a directory scanner thread.
412 * @param filename name of the directory to scan
413 * @param GNUNET_YES to not to run libextractor on files (only build a tree)
414 * @param ex if not NULL, must be a list of extra plugins for extractor
415 * @param cb the callback to call when there are scanning progress messages
416 * @param cb_cls closure for 'cb'
417 * @return directory scanner object to be used for controlling the scanner
419 struct GNUNET_FS_DirScanner *
420 GNUNET_FS_directory_scan_start (const char *filename,
421 int disable_extractor, const char *ex,
422 GNUNET_FS_DirScannerProgressCallback cb,
426 char *filename_expanded;
427 struct GNUNET_FS_DirScanner *ds;
429 if (0 != STAT (filename, &sbuf))
431 filename_expanded = GNUNET_STRINGS_filename_expand (filename);
432 if (NULL == filename_expanded)
434 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
435 "Starting to scan directory `%s'\n",
437 ds = GNUNET_malloc (sizeof (struct GNUNET_FS_DirScanner));
438 ds->progress_callback = cb;
439 ds->progress_callback_cls = cb_cls;
440 ds->filename_expanded = filename_expanded;
441 if (disable_extractor)
442 ds->ex_arg = GNUNET_strdup ("-");
444 ds->ex_arg = (NULL != ex) ? GNUNET_strdup (ex) : NULL;
445 ds->args[0] = "gnunet-helper-fs-publish";
446 ds->args[1] = ds->filename_expanded;
447 ds->args[2] = ds->ex_arg;
449 ds->helper = GNUNET_HELPER_start ("gnunet-helper-fs-publish",
451 &process_helper_msgs,
453 if (NULL == ds->helper)
455 GNUNET_free (filename_expanded);
463 /* end of fs_dirmetascan.c */