2 This file is part of GNUnet.
3 (C) 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 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 src/fs/gnunet-helper-fs-publish.c
23 * @brief Tool to help extract meta data asynchronously
24 * @author Christian Grothoff
26 * This program will scan a directory for files with meta data
27 * and report the results to stdout.
30 #include "gnunet_fs_service.h"
34 * A node of a directory tree.
40 * This is a doubly-linked list
42 struct ScanTreeNode *next;
45 * This is a doubly-linked list
47 struct ScanTreeNode *prev;
50 * Parent of this node, NULL for top-level entries.
52 struct ScanTreeNode *parent;
55 * This is a doubly-linked tree
56 * NULL for files and empty directories
58 struct ScanTreeNode *children_head;
61 * This is a doubly-linked tree
62 * NULL for files and empty directories
64 struct ScanTreeNode *children_tail;
67 * Name of the file/directory
72 * Size of the file (if it is a file), in bytes.
73 * At the moment it is set to 0 for directories.
78 * GNUNET_YES if this is a directory
86 * List of libextractor plugins to use for extracting.
88 static struct EXTRACTOR_PluginList *plugins;
92 * Add meta data that libextractor finds to our meta data
95 * @param cls closure, our meta data container
96 * @param plugin_name name of the plugin that produced this value;
97 * special values can be used (i.e. '<zlib>' for zlib being
98 * used in the main libextractor library and yielding
100 * @param type libextractor-type describing the meta data
101 * @param format basic format information about data
102 * @param data_mime_type mime-type of data (not of the original file);
103 * can be NULL (if mime-type is not known)
104 * @param data actual meta-data found
105 * @param data_len number of bytes in data
106 * @return always 0 to continue extracting
109 add_to_md (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
110 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
111 const char *data, size_t data_len)
113 struct GNUNET_CONTAINER_MetaData *md = cls;
115 (void) GNUNET_CONTAINER_meta_data_insert (md, plugin_name, type, format,
116 data_mime_type, data, data_len);
122 * Free memory of the 'tree' structure
124 * @param tree tree to free
127 free_tree (struct ScanTreeNode *tree)
129 struct ScanTreeNode *pos;
131 while (NULL != (pos = tree->children_head))
133 if (NULL != tree->parent)
134 GNUNET_CONTAINER_DLL_remove (tree->parent->children_head,
135 tree->parent->children_tail,
137 GNUNET_free (tree->filename);
143 * Write 'size' bytes from 'buf' into 'out'.
145 * @param buf buffer with data to write
146 * @param size number of bytes to write
147 * @return GNUNET_OK on success, GNUNET_SYSERR on error
150 write_all (const void *buf,
153 const char *cbuf = buf;
165 } while ( (wr > 0) && (total < size) );
167 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
168 "Failed to write to stdout: %s\n",
170 return (total == size) ? GNUNET_OK : GNUNET_SYSERR;
175 * Write message to the master process.
177 * @param message_type message type to use
178 * @param data data to append, NULL for none
179 * @param data_length number of bytes in data
180 * @return GNUNET_SYSERR to stop scanning (the pipe was broken somehow)
183 write_message (uint16_t message_type,
187 struct GNUNET_MessageHeader hdr;
190 fprintf (stderr, "Helper sends %u-byte message of type %u\n",
191 (unsigned int) (sizeof (struct GNUNET_MessageHeader) + data_length),
192 (unsigned int) message_type);
194 hdr.type = htons (message_type);
195 hdr.size = htons (sizeof (struct GNUNET_MessageHeader) + data_length);
202 return GNUNET_SYSERR;
208 * Function called to (recursively) add all of the files in the
209 * directory to the tree. Called by the directory scanner to initiate
210 * the scan. Does NOT yet add any metadata.
212 * @param filename file or directory to scan
213 * @param dst where to store the resulting share tree item;
214 * NULL is stored in 'dst' upon recoverable errors (GNUNET_OK is returned)
215 * @return GNUNET_OK on success, GNUNET_SYSERR on error
218 preprocess_file (const char *filename,
219 struct ScanTreeNode **dst);
223 * Closure for the 'scan_callback'
225 struct RecursionContext
228 * Parent to add the files to.
230 struct ScanTreeNode *parent;
233 * Flag to set to GNUNET_YES on serious errors.
240 * Function called by the directory iterator to (recursively) add all
241 * of the files in the directory to the tree. Called by the directory
242 * scanner to initiate the scan. Does NOT yet add any metadata.
244 * @param cls the 'struct RecursionContext'
245 * @param filename file or directory to scan
246 * @return GNUNET_OK on success, GNUNET_SYSERR on error
249 scan_callback (void *cls,
250 const char *filename)
252 struct RecursionContext *rc = cls;
253 struct ScanTreeNode *chld;
256 preprocess_file (filename,
259 rc->stop = GNUNET_YES;
260 return GNUNET_SYSERR;
264 chld->parent = rc->parent;
265 GNUNET_CONTAINER_DLL_insert (rc->parent->children_head,
266 rc->parent->children_tail,
273 * Function called to (recursively) add all of the files in the
274 * directory to the tree. Called by the directory scanner to initiate
275 * the scan. Does NOT yet add any metadata.
277 * @param filename file or directory to scan
278 * @param dst where to store the resulting share tree item;
279 * NULL is stored in 'dst' upon recoverable errors (GNUNET_OK is returned)
280 * @return GNUNET_OK on success, GNUNET_SYSERR on error
283 preprocess_file (const char *filename,
284 struct ScanTreeNode **dst)
286 struct ScanTreeNode *item;
290 if ((0 != STAT (filename, &sbuf)) ||
291 ((!S_ISDIR (sbuf.st_mode)) && (GNUNET_OK != GNUNET_DISK_file_size (
292 filename, &fsize, GNUNET_NO, GNUNET_YES))))
294 /* If the file doesn't exist (or is not stat-able for any other reason)
295 skip it (but report it), but do continue. */
297 write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_SKIP_FILE,
298 filename, strlen (filename) + 1))
299 return GNUNET_SYSERR;
300 /* recoverable error, store 'NULL' in *dst */
305 /* Report the progress */
307 write_message (S_ISDIR (sbuf.st_mode)
308 ? GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_DIRECTORY
309 : GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_FILE,
310 filename, strlen (filename) + 1))
311 return GNUNET_SYSERR;
312 item = GNUNET_malloc (sizeof (struct ScanTreeNode));
313 item->filename = GNUNET_strdup (filename);
314 item->is_directory = (S_ISDIR (sbuf.st_mode)) ? GNUNET_YES : GNUNET_NO;
315 item->file_size = fsize;
316 if (GNUNET_YES == item->is_directory)
318 struct RecursionContext rc;
322 GNUNET_DISK_directory_scan (filename,
325 if ( (GNUNET_YES == rc.stop) ||
327 write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_PROGRESS_DIRECTORY,
331 return GNUNET_SYSERR;
340 * Extract metadata from files.
342 * @param item entry we are processing
343 * @return GNUNET_OK on success, GNUNET_SYSERR on fatal errors
346 extract_files (struct ScanTreeNode *item)
348 struct GNUNET_CONTAINER_MetaData *meta;
352 if (GNUNET_YES == item->is_directory)
354 /* for directories, we simply only descent, no extraction, no
355 progress reporting */
356 struct ScanTreeNode *pos;
358 for (pos = item->children_head; NULL != pos; pos = pos->next)
361 return GNUNET_SYSERR;
365 /* this is the expensive operation, *afterwards* we'll check for aborts */
366 meta = GNUNET_CONTAINER_meta_data_create ();
367 EXTRACTOR_extract (plugins, item->filename, NULL, 0, &add_to_md, meta);
368 slen = strlen (item->filename) + 1;
369 size = GNUNET_CONTAINER_meta_data_get_serialized_size (meta);
373 GNUNET_CONTAINER_meta_data_destroy (meta);
375 write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_META_DATA,
376 item->filename, slen))
377 return GNUNET_SYSERR;
380 else if (size > (UINT16_MAX - sizeof (struct GNUNET_MessageHeader) - slen))
382 /* We can't transfer more than 64k bytes in one message. */
383 size = UINT16_MAX - sizeof (struct GNUNET_MessageHeader) - slen;
386 char buf[size + slen];
387 char *dst = &buf[slen];
389 memcpy (buf, item->filename, slen);
390 size = GNUNET_CONTAINER_meta_data_serialize (meta,
392 GNUNET_CONTAINER_META_DATA_SERIALIZE_PART);
398 GNUNET_CONTAINER_meta_data_destroy (meta);
400 write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_META_DATA,
403 return GNUNET_SYSERR;
411 * Install a signal handler to ignore SIGPIPE.
416 struct sigaction oldsig;
417 struct sigaction sig;
419 memset (&sig, 0, sizeof (struct sigaction));
420 sig.sa_handler = SIG_IGN;
421 sigemptyset (&sig.sa_mask);
423 sig.sa_flags = SA_INTERRUPT; /* SunOS */
425 sig.sa_flags = SA_RESTART;
427 if (0 != sigaction (SIGPIPE, &sig, &oldsig))
429 "Failed to install SIGPIPE handler: %s\n", strerror (errno));
435 * Main function of the helper process to extract meta data.
437 * @param argc should be 3
438 * @param argv [0] our binary name
439 * [1] name of the file or directory to process
440 * [2] "-" to disable extraction, NULL for defaults,
441 * otherwise custom plugins to load from LE
442 * @return 0 on success
447 const char *filename_expanded;
449 struct ScanTreeNode *root;
452 /* We're using stdout to communicate binary data back to the parent; use
455 _setmode (1, _O_BINARY);
456 /* Get utf-8-encoded arguments */
457 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
463 /* parse command line */
464 if ( (3 != argc) && (2 != argc) )
468 "gnunet-helper-fs-publish needs exactly one or two arguments\n");
470 GNUNET_free ((void*) argv);
474 filename_expanded = argv[1];
477 (0 != strcmp (ex, "-")) )
479 plugins = EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
481 plugins = EXTRACTOR_plugin_add_config (plugins, ex,
482 EXTRACTOR_OPTION_DEFAULT_POLICY);
485 /* scan tree to find out how much work there is to be done */
486 if (GNUNET_OK != preprocess_file (filename_expanded,
489 (void) write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_ERROR, NULL, 0);
490 EXTRACTOR_plugin_remove_all (plugins);
492 GNUNET_free ((void*) argv);
496 /* signal that we're done counting files, so that a percentage of
497 progress can now be calculated */
499 write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_COUNTING_DONE, NULL, 0))
501 EXTRACTOR_plugin_remove_all (plugins);
503 GNUNET_free ((void*) argv);
510 extract_files (root))
512 (void) write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_ERROR, NULL, 0);
514 EXTRACTOR_plugin_remove_all (plugins);
516 GNUNET_free ((void*) argv);
522 /* enable "clean" shutdown by telling parent that we are done */
523 (void) write_message (GNUNET_MESSAGE_TYPE_FS_PUBLISH_HELPER_FINISHED, NULL, 0);
524 EXTRACTOR_plugin_remove_all (plugins);
526 GNUNET_free ((void*) argv);
531 /* end of gnunet-helper-fs-publish.c */