2 This file is part of GNUnet.
3 (C) 2009, 2011 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_file_information.c
23 * @brief Manage information for publishing directory hierarchies
24 * @author Christian Grothoff
27 * - metadata filename clean up code
28 * - metadata/ksk generation for directories from contained files
31 #include <extractor.h>
32 #include "gnunet_fs_service.h"
38 * Add meta data that libextractor finds to our meta data
41 * @param cls closure, our meta data container
42 * @param plugin_name name of the plugin that produced this value;
43 * special values can be used (i.e. '<zlib>' for zlib being
44 * used in the main libextractor library and yielding
46 * @param type libextractor-type describing the meta data
47 * @param format basic format information about data
48 * @param data_mime_type mime-type of data (not of the original file);
49 * can be NULL (if mime-type is not known)
50 * @param data actual meta-data found
51 * @param data_len number of bytes in data
52 * @return always 0 to continue extracting
55 add_to_md (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
56 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
57 const char *data, size_t data_len)
59 struct GNUNET_CONTAINER_MetaData *md = cls;
61 (void) GNUNET_CONTAINER_meta_data_insert (md, plugin_name, type, format,
62 data_mime_type, data, data_len);
68 * Extract meta-data from a file.
70 * @return GNUNET_SYSERR on error, otherwise the number
71 * of meta-data items obtained
74 GNUNET_FS_meta_data_extract_from_file (struct GNUNET_CONTAINER_MetaData *md,
76 struct EXTRACTOR_PluginList *extractors)
82 if (extractors == NULL)
84 old = GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL);
85 GNUNET_assert (old >= 0);
86 EXTRACTOR_extract (extractors, filename, NULL, 0, &add_to_md, md);
87 return (GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL) - old);
93 * Obtain the name under which this file information
94 * structure is stored on disk. Only works for top-level
95 * file information structures.
97 * @param s structure to get the filename for
98 * @return NULL on error, otherwise filename that
99 * can be passed to "GNUNET_FS_file_information_recover"
100 * to read this fi-struct from disk.
103 GNUNET_FS_file_information_get_id (struct GNUNET_FS_FileInformation *s)
107 return s->serialization;
111 * Obtain the filename from the file information structure.
113 * @param s structure to get the filename for
114 * @return "filename" field of the structure (can be NULL)
117 GNUNET_FS_file_information_get_filename (struct GNUNET_FS_FileInformation *s)
124 * Set the filename in the file information structure.
125 * If filename was already set, frees it before setting the new one.
126 * Makes a copy of the argument.
128 * @param s structure to get the filename for
129 * @param filename filename to set
132 GNUNET_FS_file_information_set_filename (struct GNUNET_FS_FileInformation *s,
133 const char *filename)
135 GNUNET_free_non_null (s->filename);
137 s->filename = GNUNET_strdup (filename);
143 * Create an entry for a file in a publish-structure.
145 * @param h handle to the file sharing subsystem
146 * @param client_info initial value for the client-info value for this entry
147 * @param filename name of the file or directory to publish
148 * @param keywords under which keywords should this file be available
149 * directly; can be NULL
150 * @param meta metadata for the file
151 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
152 * GNUNET_SYSERR for simulation
153 * @param bo block options
154 * @return publish structure entry for the file
156 struct GNUNET_FS_FileInformation *
157 GNUNET_FS_file_information_create_from_file (struct GNUNET_FS_Handle *h,
159 const char *filename,
160 const struct GNUNET_FS_Uri
163 GNUNET_CONTAINER_MetaData *meta,
165 const struct GNUNET_FS_BlockOptions
170 struct GNUNET_FS_FileInformation *ret;
175 char fn_conv[MAX_PATH];
178 if (0 != STAT (filename, &sbuf))
180 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "stat", filename);
183 fi = GNUNET_FS_make_file_reader_context_ (filename);
190 GNUNET_FS_file_information_create_from_reader (h, client_info,
192 &GNUNET_FS_data_reader_file_,
198 ret->filename = GNUNET_strdup (filename);
202 plibc_conv_to_win_path (filename, fn_conv);
205 while (NULL != (ss = strstr (fn, DIR_SEPARATOR_STR)))
208 GNUNET_CONTAINER_meta_data_insert (ret->meta, "<gnunet>",
209 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
210 EXTRACTOR_METAFORMAT_C_STRING,
211 "text/plain", fn, strlen (fn) + 1);
213 GNUNET_CONTAINER_meta_data_insert (ret->meta, "<gnunet>",
214 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
215 EXTRACTOR_METAFORMAT_UTF8,
216 "text/plain", fn, strlen (fn) + 1);
223 * Create an entry for a file in a publish-structure.
225 * @param h handle to the file sharing subsystem
226 * @param client_info initial value for the client-info value for this entry
227 * @param length length of the file
228 * @param data data for the file (should not be used afterwards by
229 * the caller; callee will "free")
230 * @param keywords under which keywords should this file be available
231 * directly; can be NULL
232 * @param meta metadata for the file
233 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
234 * GNUNET_SYSERR for simulation
235 * @param bo block options
236 * @return publish structure entry for the file
238 struct GNUNET_FS_FileInformation *
239 GNUNET_FS_file_information_create_from_data (struct GNUNET_FS_Handle *h,
240 void *client_info, uint64_t length,
242 const struct GNUNET_FS_Uri
245 GNUNET_CONTAINER_MetaData *meta,
247 const struct GNUNET_FS_BlockOptions
250 if (GNUNET_YES == do_index)
255 return GNUNET_FS_file_information_create_from_reader (h, client_info, length,
256 &GNUNET_FS_data_reader_copy_,
257 data, keywords, meta,
263 * Create an entry for a file in a publish-structure.
265 * @param h handle to the file sharing subsystem
266 * @param client_info initial value for the client-info value for this entry
267 * @param length length of the file
268 * @param reader function that can be used to obtain the data for the file
269 * @param reader_cls closure for "reader"
270 * @param keywords under which keywords should this file be available
271 * directly; can be NULL
272 * @param meta metadata for the file
273 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
274 * GNUNET_SYSERR for simulation
275 * @param bo block options
276 * @return publish structure entry for the file
278 struct GNUNET_FS_FileInformation *
279 GNUNET_FS_file_information_create_from_reader (struct GNUNET_FS_Handle *h,
282 GNUNET_FS_DataReader reader,
284 const struct GNUNET_FS_Uri
287 GNUNET_CONTAINER_MetaData *meta,
290 GNUNET_FS_BlockOptions *bo)
292 struct GNUNET_FS_FileInformation *ret;
294 if ((GNUNET_YES == do_index) && (reader != &GNUNET_FS_data_reader_file_))
299 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
301 ret->client_info = client_info;
302 ret->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
303 if (ret->meta == NULL)
304 ret->meta = GNUNET_CONTAINER_meta_data_create ();
305 ret->keywords = (keywords == NULL) ? NULL : GNUNET_FS_uri_dup (keywords);
306 ret->data.file.reader = reader;
307 ret->data.file.reader_cls = reader_cls;
308 ret->data.file.do_index = do_index;
309 ret->data.file.file_size = length;
316 * Closure for "dir_scan_cb".
321 * Metadata extractors to use.
323 struct EXTRACTOR_PluginList *extractors;
328 struct GNUNET_FS_Handle *h;
331 * Function to call on each directory entry.
333 GNUNET_FS_FileProcessor proc;
341 * Scanner to use for subdirectories.
343 GNUNET_FS_DirectoryScanner scanner;
346 * Closure for scanner.
351 * Set to an error message (if any).
358 const struct GNUNET_FS_BlockOptions *bo;
361 * Should files be indexed?
369 * Function called on each entry in a file to cause
370 * default-publishing.
372 * @param cls closure (struct DirScanCls)
373 * @param filename name of the file to be published
374 * @return GNUNET_OK on success, GNUNET_SYSERR to abort
377 dir_scan_cb (void *cls, const char *filename)
379 struct DirScanCls *dsc = cls;
381 struct GNUNET_FS_FileInformation *fi;
382 struct GNUNET_FS_Uri *keywords;
383 struct GNUNET_CONTAINER_MetaData *meta;
385 if (0 != STAT (filename, &sbuf))
387 GNUNET_asprintf (&dsc->emsg, _("`%s' failed on file `%s': %s"), "stat",
388 filename, STRERROR (errno));
389 return GNUNET_SYSERR;
391 if (S_ISDIR (sbuf.st_mode))
393 fi = GNUNET_FS_file_information_create_from_directory (dsc->h, NULL,
398 dsc->bo, &dsc->emsg);
401 GNUNET_assert (NULL != dsc->emsg);
402 return GNUNET_SYSERR;
407 meta = GNUNET_CONTAINER_meta_data_create ();
408 GNUNET_FS_meta_data_extract_from_file (meta, filename, dsc->extractors);
409 keywords = GNUNET_FS_uri_ksk_create_from_meta_data (meta);
410 fi = GNUNET_FS_file_information_create_from_file (dsc->h, NULL, filename,
412 dsc->do_index, dsc->bo);
413 GNUNET_CONTAINER_meta_data_destroy (meta);
414 GNUNET_FS_uri_destroy (keywords);
416 dsc->proc (dsc->proc_cls, filename, fi);
422 * Simple, useful default implementation of a directory scanner
423 * (GNUNET_FS_DirectoryScanner). This implementation expects to get a
424 * UNIX filename, will publish all files in the directory except hidden
425 * files (those starting with a "."). Metadata will be extracted
426 * using GNU libextractor; the specific list of plugins should be
427 * specified in "cls", passing NULL will disable (!) metadata
428 * extraction. Keywords will be derived from the metadata and be
429 * subject to default canonicalization. This is strictly a
430 * convenience function.
432 * @param cls must be of type "struct EXTRACTOR_Extractor*"
433 * @param h handle to the file sharing subsystem
434 * @param dirname name of the directory to scan
435 * @param do_index should files be indexed or inserted
436 * @param bo block options
437 * @param proc function called on each entry
438 * @param proc_cls closure for proc
439 * @param emsg where to store an error message (on errors)
440 * @return GNUNET_OK on success
443 GNUNET_FS_directory_scanner_default (void *cls, struct GNUNET_FS_Handle *h,
444 const char *dirname, int do_index,
445 const struct GNUNET_FS_BlockOptions *bo,
446 GNUNET_FS_FileProcessor proc,
447 void *proc_cls, char **emsg)
449 struct EXTRACTOR_PluginList *ex = cls;
450 struct DirScanCls dsc;
455 dsc.proc_cls = proc_cls;
456 dsc.scanner = &GNUNET_FS_directory_scanner_default;
457 dsc.scanner_cls = cls;
458 dsc.do_index = do_index;
460 if (-1 == GNUNET_DISK_directory_scan (dirname, &dir_scan_cb, &dsc))
462 GNUNET_assert (NULL != dsc.emsg);
464 return GNUNET_SYSERR;
471 * Aggregate information we keep for meta data in each directory.
473 struct MetaValueInformation
479 const char *mime_type;
482 * The actual meta data.
487 * Number of bytes in 'data'.
492 * Type of the meta data.
494 enum EXTRACTOR_MetaType type;
497 * Format of the meta data.
499 enum EXTRACTOR_MetaFormat format;
502 * How often does this meta value occur in this directory?
504 unsigned int frequency;
510 * Type of a function that libextractor calls for each
511 * meta data item found.
513 * @param cls the container multihashmap to update
514 * @param plugin_name name of the plugin that produced this value;
515 * special values can be used (i.e. '<zlib>' for zlib being
516 * used in the main libextractor library and yielding
518 * @param type libextractor-type describing the meta data
519 * @param format basic format information about data
520 * @param data_mime_type mime-type of data (not of the original file);
521 * can be NULL (if mime-type is not known)
522 * @param data actual meta-data found
523 * @param data_len number of bytes in data
524 * @return 0 to continue extracting / iterating
527 update_metamap (void *cls, const char *plugin_name,
528 enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format,
529 const char *data_mime_type, const char *data, size_t data_len)
531 struct GNUNET_CONTAINER_MultiHashMap *map = cls;
533 struct MetaValueInformation *mvi;
535 GNUNET_CRYPTO_hash (data, data_len, &key);
536 mvi = GNUNET_CONTAINER_multihashmap_get (map, &key);
539 mvi = GNUNET_malloc (sizeof (struct MetaValueInformation));
540 mvi->mime_type = data_mime_type;
542 mvi->data_size = data_len;
544 mvi->format = format;
545 GNUNET_CONTAINER_multihashmap_put (map, &key, mvi,
546 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
554 * Aggregate information we keep for keywords in each directory.
556 struct KeywordInformation
560 * Mime-type of keyword.
565 * How often does this meta value occur in this directory?
567 unsigned int frequency;
573 * Closure for dirproc function.
578 * Linked list of directory entries that is being
581 struct GNUNET_FS_FileInformation *entries;
584 * Map describing the meta data for all entries in the
585 * directory. Keys are the hash of the meta-value,
586 * values are of type 'struct MetaValueInformation'.
588 struct GNUNET_CONTAINER_MultiHashMap *metamap;
591 * Map describing the keywords for all entries in the
592 * directory. Keys are the hash of the keyword,
593 * values are of type 'struct KeywordInformation'.
595 struct GNUNET_CONTAINER_MultiHashMap *keywordmap;
598 * Number of entries in 'entries'.
606 * Function that processes a directory entry that
607 * was obtained from the scanner. Adds each entry to
608 * the directory and computes directroy meta map.
610 * @param cls our closure
611 * @param filename name of the file (unused, why there???)
612 * @param fi information for publishing the file
615 dirproc_add (void *cls, const char *filename,
616 struct GNUNET_FS_FileInformation *fi)
618 struct EntryProcCls *dc = cls;
621 struct KeywordInformation *ki;
624 GNUNET_assert (fi->next == NULL);
625 GNUNET_assert (fi->dir == NULL);
626 fi->next = dc->entries;
629 if (NULL != fi->meta)
630 GNUNET_CONTAINER_meta_data_iterate (fi->meta, &update_metamap, dc->metamap);
631 for (i = 0; i < fi->keywords->data.ksk.keywordCount; i++)
633 kw = fi->keywords->data.ksk.keywords[i];
634 GNUNET_CRYPTO_hash (kw, strlen (kw), &key);
635 ki = GNUNET_CONTAINER_multihashmap_get (dc->keywordmap, &key);
638 ki = GNUNET_malloc (sizeof (struct KeywordInformation));
639 ki->keyword = &kw[1];
640 GNUNET_CONTAINER_multihashmap_put (dc->keywordmap, &key, ki,
641 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
649 * Closure for 'compute_directory_metadata'.
651 struct ComputeDirectoryMetadataContext
654 * Where to store the extracted keywords.
656 struct GNUNET_FS_Uri *ksk;
659 * Where to store the extracted meta data.
661 struct GNUNET_CONTAINER_MetaData *meta;
664 * Threshold to apply for adding meta data.
666 unsigned int threshold;
671 * Add metadata that occurs in more than the threshold entries of the
672 * directory to the directory itself. For example, if most files in a
673 * directory are of the same mime-type, the directory should have that
674 * mime-type as a keyword.
676 * @param cls the 'struct ComputeDirectoryMetadataContext'
678 * @param value the 'struct MetaValueInformation' (to be freed as well)
682 compute_directory_metadata (void *cls, const GNUNET_HashCode * key, void *value)
684 struct ComputeDirectoryMetadataContext *cdmc = cls;
685 struct MetaValueInformation *mvi = value;
687 if (mvi->frequency > cdmc->threshold)
689 if (mvi->type != EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
690 (void) GNUNET_CONTAINER_meta_data_insert (cdmc->meta, "<children>",
691 mvi->type, mvi->format,
692 mvi->mime_type, mvi->data,
694 if ((mvi->format == EXTRACTOR_METAFORMAT_UTF8) ||
695 (mvi->format == EXTRACTOR_METAFORMAT_C_STRING))
696 GNUNET_FS_uri_ksk_add_keyword (cdmc->ksk, mvi->data, GNUNET_NO);
704 * Add keywords that occur in more than the threshold entries of the
705 * directory to the directory itself.
707 * @param cls the 'struct ComputeDirectoryMetadataContext'
709 * @param value the 'struct Keywordnformation' (to be freed as well)
713 compute_directory_keywords (void *cls, const GNUNET_HashCode * key, void *value)
715 struct ComputeDirectoryMetadataContext *cdmc = cls;
716 struct KeywordInformation *ki = value;
718 if (ki->frequency > cdmc->threshold)
719 (void) GNUNET_FS_uri_ksk_add_keyword (cdmc->ksk, ki->keyword, GNUNET_NO);
726 * Create a publish-structure from an existing file hierarchy, inferring
727 * and organizing keywords and metadata as much as possible. This
728 * function primarily performs the recursive build and re-organizes
729 * keywords and metadata; for automatically getting metadata
730 * extraction, scanning of directories and creation of the respective
731 * GNUNET_FS_FileInformation entries the default scanner should be
732 * passed (GNUNET_FS_directory_scanner_default). This is strictly a
733 * convenience function.
735 * @param h handle to the file sharing subsystem
736 * @param client_info initial value for the client-info value for this entry
737 * @param filename name of the top-level file or directory
738 * @param scanner function used to get a list of files in a directory
739 * @param scanner_cls closure for scanner
740 * @param do_index should files in the hierarchy be indexed?
741 * @param bo block options
742 * @param emsg where to store an error message
743 * @return publish structure entry for the directory, NULL on error
745 struct GNUNET_FS_FileInformation *
746 GNUNET_FS_file_information_create_from_directory (struct GNUNET_FS_Handle *h,
748 const char *filename,
749 GNUNET_FS_DirectoryScanner
750 scanner, void *scanner_cls,
753 GNUNET_FS_BlockOptions *bo,
756 struct GNUNET_FS_FileInformation *ret;
757 struct ComputeDirectoryMetadataContext cdmc;
758 struct EntryProcCls dc;
762 struct GNUNET_FS_FileInformation *epos;
768 dc.metamap = GNUNET_CONTAINER_multihashmap_create (64);
769 dc.keywordmap = GNUNET_CONTAINER_multihashmap_create (64);
770 /* update children to point to directory and generate statistics
771 * on all meta data in children */
772 scanner (scanner_cls, h, filename, do_index, bo, &dirproc_add, &dc, emsg);
773 cdmc.meta = GNUNET_CONTAINER_meta_data_create ();
774 cdmc.ksk = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
775 cdmc.ksk->type = ksk;
776 cdmc.threshold = 1 + dc.count / 2; /* 50% threshold for now */
777 GNUNET_FS_meta_data_make_directory (cdmc.meta);
778 GNUNET_CONTAINER_multihashmap_iterate (dc.metamap,
779 &compute_directory_metadata, &cdmc);
780 GNUNET_CONTAINER_multihashmap_iterate (dc.keywordmap,
781 &compute_directory_keywords, &cdmc);
782 GNUNET_CONTAINER_multihashmap_destroy (dc.metamap);
783 GNUNET_CONTAINER_multihashmap_destroy (dc.keywordmap);
785 /* remove keywords in children that are already in the
787 for (epos = dc.entries; NULL != epos; epos = epos->next)
789 for (i = 0; i < cdmc.ksk->data.ksk.keywordCount; i++)
791 kw = cdmc.ksk->data.ksk.keywords[i];
792 GNUNET_FS_uri_ksk_remove_keyword (epos->keywords, &kw[1]);
795 GNUNET_FS_uri_ksk_add_keyword (cdmc.ksk, GNUNET_FS_DIRECTORY_MIME, GNUNET_NO);
797 GNUNET_FS_file_information_create_empty_directory (h, client_info, cdmc.ksk,
798 cdmc.meta, bo, filename);
799 GNUNET_CONTAINER_meta_data_destroy (cdmc.meta);
800 GNUNET_FS_uri_destroy (cdmc.ksk);
801 ret->data.dir.entries = dc.entries;
802 while (dc.entries != NULL)
804 dc.entries->dir = ret;
805 dc.entries = dc.entries->next;
808 while ((NULL != (ss = strstr (fn, DIR_SEPARATOR_STR))) && (strlen (ss) > 1))
810 GNUNET_asprintf (&dn, "%s/", fn);
812 GNUNET_CONTAINER_meta_data_insert (ret->meta, "<gnunet>",
813 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
814 EXTRACTOR_METAFORMAT_C_STRING,
815 "text/plain", dn, strlen (dn) + 1);
817 GNUNET_CONTAINER_meta_data_insert (ret->meta, "<gnunet>",
818 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME,
819 EXTRACTOR_METAFORMAT_UTF8,
820 "text/plain", dn, strlen (dn) + 1);
828 * Test if a given entry represents a directory.
830 * @param ent check if this FI represents a directory
831 * @return GNUNET_YES if so, GNUNET_NO if not
834 GNUNET_FS_file_information_is_directory (const struct GNUNET_FS_FileInformation
837 return ent->is_directory;
842 * Create an entry for an empty directory in a publish-structure.
843 * This function should be used by applications for which the
844 * use of "GNUNET_FS_file_information_create_from_directory"
845 * is not appropriate.
847 * @param h handle to the file sharing subsystem
848 * @param client_info initial value for the client-info value for this entry
849 * @param meta metadata for the directory
850 * @param keywords under which keywords should this directory be available
851 * directly; can be NULL
852 * @param bo block options
853 * @param filename name of the directory; can be NULL
854 * @return publish structure entry for the directory , NULL on error
856 struct GNUNET_FS_FileInformation *
857 GNUNET_FS_file_information_create_empty_directory (struct GNUNET_FS_Handle *h,
859 const struct GNUNET_FS_Uri
862 GNUNET_CONTAINER_MetaData
865 GNUNET_FS_BlockOptions *bo,
866 const char *filename)
868 struct GNUNET_FS_FileInformation *ret;
870 ret = GNUNET_malloc (sizeof (struct GNUNET_FS_FileInformation));
872 ret->client_info = client_info;
873 ret->meta = GNUNET_CONTAINER_meta_data_duplicate (meta);
874 ret->keywords = GNUNET_FS_uri_dup (keywords);
876 ret->is_directory = GNUNET_YES;
877 if (filename != NULL)
878 ret->filename = GNUNET_strdup (filename);
884 * Add an entry to a directory in a publish-structure. Clients
885 * should never modify publish structures that were passed to
886 * "GNUNET_FS_publish_start" already.
888 * @param dir the directory
889 * @param ent the entry to add; the entry must not have been
890 * added to any other directory at this point and
891 * must not include "dir" in its structure
892 * @return GNUNET_OK on success, GNUNET_SYSERR on error
895 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
896 struct GNUNET_FS_FileInformation *ent)
898 if ((ent->dir != NULL) || (ent->next != NULL) || (!dir->is_directory))
901 return GNUNET_SYSERR;
904 ent->next = dir->data.dir.entries;
905 dir->data.dir.entries = ent;
906 dir->data.dir.dir_size = 0;
912 * Inspect a file or directory in a publish-structure. Clients
913 * should never modify publish structures that were passed to
914 * "GNUNET_FS_publish_start" already. When called on a directory,
915 * this function will FIRST call "proc" with information about
916 * the directory itself and then for each of the files in the
917 * directory (but not for files in subdirectories). When called
918 * on a file, "proc" will be called exactly once (with information
919 * about the specific file).
921 * @param dir the directory
922 * @param proc function to call on each entry
923 * @param proc_cls closure for proc
926 GNUNET_FS_file_information_inspect (struct GNUNET_FS_FileInformation *dir,
927 GNUNET_FS_FileInformationProcessor proc,
930 struct GNUNET_FS_FileInformation *pos;
936 (dir->is_directory) ? dir->data.dir.dir_size : dir->data.
937 file.file_size, dir->meta, &dir->keywords, &dir->bo,
938 (dir->is_directory) ? &no : &dir->data.file.do_index,
941 if (!dir->is_directory)
943 pos = dir->data.dir.entries;
949 (pos->is_directory) ? pos->data.dir.dir_size : pos->data.
950 file.file_size, pos->meta, &pos->keywords, &pos->bo,
951 (pos->is_directory) ? &no : &pos->data.file.do_index,
960 * Destroy publish-structure. Clients should never destroy publish
961 * structures that were passed to "GNUNET_FS_publish_start" already.
963 * @param fi structure to destroy
964 * @param cleaner function to call on each entry in the structure
965 * (useful to clean up client_info); can be NULL; return
967 * @param cleaner_cls closure for cleaner
970 GNUNET_FS_file_information_destroy (struct GNUNET_FS_FileInformation *fi,
971 GNUNET_FS_FileInformationProcessor cleaner,
974 struct GNUNET_FS_FileInformation *pos;
978 if (fi->is_directory)
980 /* clean up directory */
981 while (NULL != (pos = fi->data.dir.entries))
983 fi->data.dir.entries = pos->next;
984 GNUNET_FS_file_information_destroy (pos, cleaner, cleaner_cls);
986 /* clean up client-info */
988 cleaner (cleaner_cls, fi, fi->data.dir.dir_size, fi->meta, &fi->keywords,
989 &fi->bo, &no, &fi->client_info);
990 GNUNET_free_non_null (fi->data.dir.dir_data);
994 /* call clean-up function of the reader */
995 if (fi->data.file.reader != NULL)
996 fi->data.file.reader (fi->data.file.reader_cls, 0, 0, NULL, NULL);
997 /* clean up client-info */
999 cleaner (cleaner_cls, fi, fi->data.file.file_size, fi->meta,
1000 &fi->keywords, &fi->bo, &fi->data.file.do_index,
1003 GNUNET_free_non_null (fi->filename);
1004 GNUNET_free_non_null (fi->emsg);
1005 GNUNET_free_non_null (fi->chk_uri);
1006 /* clean up serialization */
1007 if ((NULL != fi->serialization) && (0 != UNLINK (fi->serialization)))
1008 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink",
1010 if (NULL != fi->keywords)
1011 GNUNET_FS_uri_destroy (fi->keywords);
1012 if (NULL != fi->meta)
1013 GNUNET_CONTAINER_meta_data_destroy (fi->meta);
1014 GNUNET_free_non_null (fi->serialization);
1017 GNUNET_FS_tree_encoder_finish (fi->te, NULL, NULL);
1024 /* end of fs_file_information.c */