fix #3869: outdated FSF address
[oweals/gnunet.git] / src / fs / gnunet-directory.c
1 /*
2      This file is part of GNUnet.
3      Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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., 51 Franklin Street, Fifth Floor,
18      Boston, MA 02110-1301, USA.
19 */
20 /**
21  * @file fs/gnunet-directory.c
22  * @brief display content of GNUnet directories
23  * @author Christian Grothoff
24  */
25 #include "platform.h"
26 #include "gnunet_fs_service.h"
27
28 static int ret;
29
30 /**
31  * Print a meta data entry.
32  *
33  * @param cls closure (unused)
34  * @param plugin_name name of the plugin that generated the meta data
35  * @param type type of the keyword
36  * @param format format of data
37  * @param data_mime_type mime type of data
38  * @param data value of the meta data
39  * @param data_size number of bytes in @a data
40  * @return always 0 (to continue iterating)
41  */
42 static int
43 item_printer (void *cls,
44               const char *plugin_name,
45               enum EXTRACTOR_MetaType type,
46               enum EXTRACTOR_MetaFormat format,
47               const char *data_mime_type,
48               const char *data,
49               size_t data_size)
50 {
51   if (type == EXTRACTOR_METATYPE_GNUNET_FULL_DATA)
52   {
53     printf (_("\t<original file embedded in %u bytes of meta data>\n"),
54             (unsigned int) data_size);
55     return 0;
56   }
57   if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
58       (format != EXTRACTOR_METAFORMAT_C_STRING))
59     return 0;
60   if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
61     return 0;
62 #if HAVE_LIBEXTRACTOR
63   printf ("\t%20s: %s\n",
64           dgettext (LIBEXTRACTOR_GETTEXT_DOMAIN,
65                     EXTRACTOR_metatype_to_string (type)),
66     data);
67 #else
68   printf ("\t%20d: %s\n",
69           type,
70           data);
71 #endif
72   return 0;
73 }
74
75
76
77 /**
78  * Print an entry in a directory.
79  *
80  * @param cls closure (not used)
81  * @param filename name of the file in the directory
82  * @param uri URI of the file
83  * @param meta metadata for the file; metadata for
84  *        the directory if everything else is NULL/zero
85  * @param length length of the available data for the file
86  *           (of type size_t since data must certainly fit
87  *            into memory; if files are larger than size_t
88  *            permits, then they will certainly not be
89  *            embedded with the directory itself).
90  * @param data data available for the file (length bytes)
91  */
92 static void
93 print_entry (void *cls, const char *filename, const struct GNUNET_FS_Uri *uri,
94              const struct GNUNET_CONTAINER_MetaData *meta, size_t length,
95              const void *data)
96 {
97   char *string;
98   char *name;
99
100   name =
101       GNUNET_CONTAINER_meta_data_get_by_type (meta,
102                                               EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
103   if (uri == NULL)
104   {
105     printf (_("Directory `%s' meta data:\n"), name ? name : "");
106     GNUNET_CONTAINER_meta_data_iterate (meta, &item_printer, NULL);
107     printf ("\n");
108     printf (_("Directory `%s' contents:\n"), name ? name : "");
109     GNUNET_free_non_null (name);
110     return;
111   }
112   string = GNUNET_FS_uri_to_string (uri);
113   printf ("%s (%s):\n", name ? name : "", string);
114   GNUNET_free (string);
115   GNUNET_CONTAINER_meta_data_iterate (meta, &item_printer, NULL);
116   printf ("\n");
117   GNUNET_free_non_null (name);
118 }
119
120
121 /**
122  * Main function that will be run by the scheduler.
123  *
124  * @param cls closure
125  * @param args remaining command-line arguments
126  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
127  * @param cfg configuration
128  */
129 static void
130 run (void *cls, char *const *args, const char *cfgfile,
131      const struct GNUNET_CONFIGURATION_Handle *cfg)
132 {
133   struct GNUNET_DISK_MapHandle *map;
134   struct GNUNET_DISK_FileHandle *h;
135   void *data;
136   size_t len;
137   uint64_t size;
138   const char *filename;
139   int i;
140
141   if (NULL == args[0])
142   {
143     FPRINTF (stderr, "%s",  _("You must specify a filename to inspect.\n"));
144     ret = 1;
145     return;
146   }
147   i = 0;
148   while (NULL != (filename = args[i++]))
149   {
150     if ((GNUNET_OK != GNUNET_DISK_file_size (filename, &size, GNUNET_YES, GNUNET_YES)) ||
151         (NULL ==
152          (h =
153           GNUNET_DISK_file_open (filename, GNUNET_DISK_OPEN_READ,
154                                  GNUNET_DISK_PERM_NONE))))
155     {
156       GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("Failed to read directory `%s'\n"),
157                   filename);
158       ret = 1;
159       continue;
160     }
161     len = (size_t) size;
162     data = GNUNET_DISK_file_map (h, &map, GNUNET_DISK_MAP_TYPE_READ, len);
163     GNUNET_assert (NULL != data);
164     if (GNUNET_OK != GNUNET_FS_directory_list_contents (len, data, 0, &print_entry, NULL))
165       fprintf (stdout, _("`%s' is not a GNUnet directory\n"),
166                filename);
167     else
168       printf ("\n");
169     GNUNET_DISK_file_unmap (map);
170     GNUNET_DISK_file_close (h);
171   }
172 }
173
174 /**
175  * The main function to inspect GNUnet directories.
176  *
177  * @param argc number of arguments from the command line
178  * @param argv command line arguments
179  * @return 0 ok, 1 on error
180  */
181 int
182 main (int argc, char *const *argv)
183 {
184   static struct GNUNET_GETOPT_CommandLineOption options[] = {
185     GNUNET_GETOPT_OPTION_END
186   };
187
188   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
189     return 2;
190
191   ret = (GNUNET_OK ==
192          GNUNET_PROGRAM_run (argc, argv, "gnunet-directory [OPTIONS] FILENAME",
193                              gettext_noop
194                              ("Display contents of a GNUnet directory"),
195                              options, &run, NULL)) ? ret : 1;
196   GNUNET_free ((void*) argv);
197   return ret;
198 }
199
200 /* end of gnunet-directory.c */