Refactoring gnunet time
[oweals/gnunet.git] / src / fs / fs_uri.c
1 /*
2      This file is part of GNUnet.
3      (C) 2003, 2004, 2005, 2006, 2007, 2008, 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., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file fs/fs_uri.c
23  * @brief Parses and produces uri strings.
24  * @author Igor Wronsky, Christian Grothoff
25  *
26  * GNUnet URIs are of the general form "gnunet://MODULE/IDENTIFIER".
27  * The specific structure of "IDENTIFIER" depends on the module and
28  * maybe differenciated into additional subcategories if applicable.
29  * This module only deals with fs identifiers (MODULE = "fs").
30  * <p>
31  *
32  * This module only parses URIs for the AFS module.  The FS URIs fall
33  * into four categories, "chk", "sks", "ksk" and "loc".  The first three
34  * categories were named in analogy (!) to Freenet, but they do NOT
35  * work in exactly the same way.  They are very similar from the user's
36  * point of view (unique file identifier, subspace, keyword), but the
37  * implementation is rather different in pretty much every detail.
38  * The concrete URI formats are:
39  *
40  * <ul><li>
41  *
42  * First, there are URIs that identify a file.  They have the format
43  * "gnunet://fs/chk/HEX1.HEX2.SIZE".  These URIs can be used to
44  * download the file.  The description, filename, mime-type and other
45  * meta-data is NOT part of the file-URI since a URI uniquely
46  * identifies a resource (and the contents of the file would be the
47  * same even if it had a different description).
48  *
49  * </li><li>
50  *
51  * The second category identifies entries in a namespace.  The format
52  * is "gnunet://fs/sks/NAMESPACE/IDENTIFIER" where the namespace
53  * should be given in HEX.  Applications may allow using a nickname
54  * for the namespace if the nickname is not ambiguous.  The identifier
55  * can be either an ASCII sequence or a HEX-encoding.  If the
56  * identifier is in ASCII but the format is ambiguous and could denote
57  * a HEX-string a "/" is appended to indicate ASCII encoding.
58  *
59  * </li> <li>
60  *
61  * The third category identifies ordinary searches.  The format is
62  * "gnunet://fs/ksk/KEYWORD[+KEYWORD]*".  Using the "+" syntax
63  * it is possible to encode searches with the boolean "AND" operator.
64  * "+" is used since it indicates a commutative 'and' operation and
65  * is unlikely to be used in a keyword by itself.
66  *
67  * </li><li>
68  *
69  * The last category identifies a datum on a specific machine.  The
70  * format is "gnunet://fs/loc/HEX1.HEX2.SIZE.PEER.SIG.EXPTIME".  PEER is
71  * the BinName of the public key of the peer storing the datum.  The
72  * signature (SIG) certifies that this peer has this content.
73  * HEX1, HEX2 and SIZE correspond to a 'chk' URI.
74  *
75  * </li></ul>
76  *
77  * The encoding for hexadecimal values is defined in the hashing.c
78  * module in the gnunetutil library and discussed there.
79  * <p>
80  */
81 #include "platform.h"
82 #include "gnunet_fs_service.h"
83 #include "gnunet_signatures.h"
84 #include "fs.h"
85
86
87 /**
88  * Get a unique key from a URI.  This is for putting URIs
89  * into HashMaps.  The key may change between FS implementations.
90  *
91  * @param uri uri to convert to a unique key
92  * @param key wherer to store the unique key
93  */
94 void 
95 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
96                       GNUNET_HashCode * key)
97 {
98   switch (uri->type)
99     {
100     case chk:
101       *key = uri->data.chk.chk.query;
102       return;
103     case sks:
104       GNUNET_CRYPTO_hash (uri->data.sks.identifier,
105                           strlen (uri->data.sks.identifier), key);
106       break;
107     case ksk:
108       if (uri->data.ksk.keywordCount > 0)
109         GNUNET_CRYPTO_hash (uri->data.ksk.keywords[0],
110                             strlen (uri->data.ksk.keywords[0]), key);
111       break;
112     case loc:
113       GNUNET_CRYPTO_hash (&uri->data.loc.fi,
114                           sizeof (struct FileIdentifier) +
115                           sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded), key);
116       break;
117     default:
118       memset (key, 0, sizeof (GNUNET_HashCode));
119       break;
120     }
121 }
122
123
124 /**
125  * Convert keyword URI to a human readable format
126  * (i.e. the search query that was used in the first place)
127  *
128  * @param uri ksk uri to convert to a string 
129  * @return string with the keywords
130  */
131 char *
132 GNUNET_FS_uri_ksk_to_string_fancy (const struct GNUNET_FS_Uri *uri)
133 {
134   size_t n;
135   char *ret;
136   unsigned int i;
137   const char *keyword;
138   char **keywords;
139   unsigned int keywordCount;
140
141   if ((uri == NULL) || (uri->type != ksk))
142     {
143       GNUNET_break (0);
144       return NULL;
145     }
146   keywords = uri->data.ksk.keywords;
147   keywordCount = uri->data.ksk.keywordCount;
148   n = keywordCount + 1;
149   for (i = 0; i < keywordCount; i++)
150     {
151       keyword = keywords[i];
152       n += strlen (keyword) - 1;
153       if (NULL != strstr (&keyword[1], " "))
154         n += 2;
155       if (keyword[0] == '+')
156         n++;
157     }
158   ret = GNUNET_malloc (n);
159   strcpy (ret, "");
160   for (i = 0; i < keywordCount; i++)
161     {
162       keyword = keywords[i];
163       if (NULL != strstr (&keyword[1], " "))
164         {
165           strcat (ret, "\"");
166           if (keyword[0] == '+')
167             strcat (ret, keyword);
168           else
169             strcat (ret, &keyword[1]);
170           strcat (ret, "\"");
171         }
172       else
173         {
174           if (keyword[0] == '+')
175             strcat (ret, keyword);
176           else
177             strcat (ret, &keyword[1]);
178         }
179       strcat (ret, " ");
180     }
181   return ret;
182 }
183
184
185 /**
186  * Given a keyword with %-encoding (and possibly quotes to protect
187  * spaces), return a copy of the keyword without %-encoding and
188  * without double-quotes (%22).  Also, add a space at the beginning
189  * if there is not a '+'.
190  * 
191  * @param in string with %-encoding
192  * @param emsg where to store the parser error message (if any)
193  * @return decodded string with leading space (or preserved plus)
194  */
195 static char *
196 percent_decode_keyword (const char *in, char **emsg)
197 {
198   char *out;
199   char *ret;
200   unsigned int rpos;
201   unsigned int wpos;
202   unsigned int hx;
203
204   out = GNUNET_strdup (in);
205   rpos = 0;
206   wpos = 0;
207   while (out[rpos] != '\0')
208     {
209       if (out[rpos] == '%')
210         {
211           if (1 != sscanf (&out[rpos + 1], "%2X", &hx))
212             {
213               GNUNET_free (out);
214               *emsg = GNUNET_strdup (_("`%' must be followed by HEX number"));
215               return NULL;
216             }
217           rpos += 3;
218           if (hx == '"')
219             continue;           /* skip double quote */
220           out[wpos++] = (char) hx;
221         }
222       else
223         {
224           out[wpos++] = out[rpos++];
225         }
226     }
227   out[wpos] = '\0';
228   if (out[0] == '+')
229     {
230       ret = GNUNET_strdup (out);
231     }
232   else
233     {
234       /* need to prefix with space */
235       ret = GNUNET_malloc (strlen (out) + 2);
236       strcpy (ret, " ");
237       strcat (ret, out);
238     }
239   GNUNET_free (out);
240   return ret;
241 }
242
243
244 /**
245  * Parse a KSK URI.
246  *
247  * @param s an uri string
248  * @param emsg where to store the parser error message (if any)
249  * @return NULL on error, otherwise the KSK URI
250  */
251 static struct GNUNET_FS_Uri *
252 uri_ksk_parse (const char *s, char **emsg)
253 {
254   struct GNUNET_FS_Uri *ret;
255   char **keywords;
256   unsigned int pos;
257   int max;
258   int iret;
259   int i;
260   size_t slen;
261   char *dup;
262   int saw_quote;
263
264   GNUNET_assert (s != NULL);
265   slen = strlen (s);
266   pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_KSK_INFIX);
267   if ( (slen <= pos) ||
268        (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_KSK_INFIX, 
269                       pos) ) )
270     return NULL;       /* not KSK URI */
271   if ( (s[slen - 1] == '+') ||
272        (s[pos] == '+') )
273     {
274       *emsg = GNUNET_strdup (_("Malformed KSK URI (must not begin or end with `+')"));
275       return NULL;
276     }
277   max = 1;
278   saw_quote = 0;
279   for (i = pos; i < slen; i++)
280     {
281       if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
282         {
283           saw_quote = (saw_quote + 1) % 2;
284           i += 3;
285           continue;
286         }
287       if ((s[i] == '+') && (saw_quote == 0))
288         {
289           max++;
290           if (s[i - 1] == '+')
291             {
292               *emsg = GNUNET_strdup (_("`++' not allowed in KSK URI")); 
293               return NULL;
294             }
295         }
296     }
297   if (saw_quote == 1)
298     {
299       *emsg = GNUNET_strdup (_("Quotes not balanced in KSK URI")); 
300       return NULL;
301     }
302   iret = max;
303   dup = GNUNET_strdup (s);
304   keywords = GNUNET_malloc (max * sizeof (char *));
305   for (i = slen - 1; i >= pos; i--)
306     {
307       if ((s[i] == '%') && (&s[i] == strstr (&s[i], "%22")))
308         {
309           saw_quote = (saw_quote + 1) % 2;
310           i += 3;
311           continue;
312         }
313       if ((dup[i] == '+') && (saw_quote == 0))
314         {
315           keywords[--max] = percent_decode_keyword (&dup[i + 1], emsg);
316           if (NULL == keywords[max])
317             goto CLEANUP;          
318           dup[i] = '\0';
319         }
320     }
321   keywords[--max] = percent_decode_keyword (&dup[pos], emsg);
322   if (NULL == keywords[max])
323     goto CLEANUP;
324   GNUNET_assert (max == 0);
325   GNUNET_free (dup);
326   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
327   ret->type = ksk;
328   ret->data.ksk.keywordCount = iret;
329   ret->data.ksk.keywords = keywords;
330   return ret;
331 CLEANUP:
332   for (i = 0; i < max; i++)
333     GNUNET_free_non_null (keywords[i]);
334   GNUNET_free (keywords);
335   GNUNET_free (dup);
336   return NULL;
337 }
338
339
340 /**
341  * Parse an SKS URI.
342  *
343  * @param s an uri string
344  * @param emsg where to store the parser error message (if any)
345  * @return NULL on error, SKS URI otherwise
346  */
347 static struct GNUNET_FS_Uri *
348 uri_sks_parse (const char *s, char **emsg)
349 {
350   struct GNUNET_FS_Uri *ret;
351   GNUNET_HashCode namespace;
352   char *identifier;
353   unsigned int pos;
354   size_t slen;
355   char enc[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
356
357   GNUNET_assert (s != NULL);
358   slen = strlen (s);
359   pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_SKS_INFIX);
360   if ( (slen <= pos) ||
361        (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_SKS_INFIX, 
362                       pos) ) )
363     return NULL; /* not an SKS URI */
364   if ( (slen < pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)) ||
365        (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '/') )
366     {
367       *emsg = GNUNET_strdup (_("Malformed SKS URI"));
368       return NULL;
369     }
370   memcpy (enc, &s[pos], sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
371   enc[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
372   if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (enc, &namespace))
373     {
374       *emsg = GNUNET_strdup (_("Malformed SKS URI"));
375       return NULL;
376     }
377   identifier = GNUNET_strdup (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded)]);
378   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
379   ret->type = sks;
380   ret->data.sks.namespace = namespace;
381   ret->data.sks.identifier = identifier;
382   return ret;
383 }
384
385
386 /**
387  * Parse a CHK URI.
388  *
389  * @param s an uri string
390  * @param emsg where to store the parser error message (if any)
391  * @return NULL on error, CHK URI otherwise
392  */
393 static struct GNUNET_FS_Uri *
394 uri_chk_parse (const char *s, char **emsg)
395 {
396   struct GNUNET_FS_Uri *ret;
397   struct FileIdentifier fi;
398   unsigned int pos;
399   unsigned long long flen;
400   size_t slen;
401   char h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
402   char h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
403
404   GNUNET_assert (s != NULL);
405
406   slen = strlen (s);
407   pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX);
408   if ( (slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
409        (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_CHK_INFIX, 
410                       pos) ) )
411     return NULL; /* not a CHK URI */
412   if ( (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
413        (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.') )
414     {
415       *emsg = GNUNET_strdup (_("Malformed CHK URI"));
416       return NULL;
417     }
418   memcpy (h1,
419           &s[pos], 
420           sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
421   h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
422   memcpy (h2,
423           &s[pos + sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)],
424           sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
425   h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
426   
427   if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1,
428                                                &fi.chk.key)) ||
429       (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2,
430                                                &fi.chk.query)) ||
431       (1 != SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
432                     "%llu", 
433                     &flen)) )
434     {
435       *emsg = GNUNET_strdup (_("Malformed CHK URI"));
436       return NULL;
437     }
438   fi.file_length = GNUNET_htonll (flen);
439   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
440   ret->type = chk;
441   ret->data.chk = fi;
442   return ret;
443 }
444
445
446 /**
447  * Convert a character back to the binary value
448  * that it represents (given base64-encoding).
449  *
450  * @param a character to convert
451  * @return offset in the "tbl" array
452  */
453 static unsigned int
454 c2v (unsigned char a)
455 {
456   if ((a >= '0') && (a <= '9'))
457     return a - '0';
458   if ((a >= 'A') && (a <= 'Z'))
459     return (a - 'A' + 10);
460   if ((a >= 'a') && (a <= 'z'))
461     return (a - 'a' + 36);
462   if (a == '_')
463     return 62;
464   if (a == '=')
465     return 63;
466   return -1;
467 }
468
469
470 /**
471  * Convert string back to binary data.
472  *
473  * @param input '\\0'-terminated string
474  * @param data where to write binary data
475  * @param size how much data should be converted
476  * @return number of characters processed from input,
477  *        -1 on error
478  */
479 static int
480 enc2bin (const char *input, void *data, size_t size)
481 {
482   size_t len;
483   size_t pos;
484   unsigned int bits;
485   unsigned int hbits;
486
487   len = size * 8 / 6;
488   if (((size * 8) % 6) != 0)
489     len++;
490   if (strlen (input) < len)
491     return -1;                  /* error! */
492   bits = 0;
493   hbits = 0;
494   len = 0;
495   for (pos = 0; pos < size; pos++)
496     {
497       while (hbits < 8)
498         {
499           bits |= (c2v (input[len++]) << hbits);
500           hbits += 6;
501         }
502       (((unsigned char *) data)[pos]) = (unsigned char) bits;
503       bits >>= 8;
504       hbits -= 8;
505     }
506   return len;
507 }
508
509
510 /**
511  * Structure that defines how the
512  * contents of a location URI must be
513  * assembled in memory to create or
514  * verify the signature of a location
515  * URI.
516  */
517 struct LocUriAssembly 
518 {
519   struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
520
521   struct GNUNET_TIME_AbsoluteNBO exptime;
522
523   struct FileIdentifier fi;
524   
525   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded peer;
526
527 };
528
529
530 /**
531  * Parse a LOC URI.
532  * Also verifies validity of the location URI.
533  *
534  * @param s an uri string
535  * @param emsg where to store the parser error message (if any)
536  * @return NULL on error, valid LOC URI otherwise
537  */
538 static struct GNUNET_FS_Uri *
539 uri_loc_parse (const char *s, char **emsg)
540 {
541   struct GNUNET_FS_Uri *uri;
542   char h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
543   char h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)];
544   unsigned int pos;
545   unsigned int npos;
546   unsigned long long exptime;
547   unsigned long long flen;
548   struct GNUNET_TIME_Absolute et;
549   struct GNUNET_CRYPTO_RsaSignature sig;
550   struct LocUriAssembly ass;
551   int ret;
552   size_t slen;
553
554   GNUNET_assert (s != NULL);
555   slen = strlen (s);
556   pos = strlen (GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX);
557   if ( (slen < pos + 2 * sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1) ||
558        (0 != strncmp (s, GNUNET_FS_URI_PREFIX GNUNET_FS_URI_LOC_INFIX, 
559                       pos) ) )
560     return NULL; /* not an SKS URI */
561   if ( (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) - 1] != '.') ||
562        (s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2 - 1] != '.') )
563     {
564       *emsg = GNUNET_strdup (_("SKS URI malformed"));
565       return NULL;
566     }
567   memcpy (h1,
568           &s[pos], 
569           sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
570   h1[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
571   memcpy (h2,
572           &s[pos + sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)],
573           sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded));
574   h2[sizeof(struct GNUNET_CRYPTO_HashAsciiEncoded)-1] = '\0';
575   
576   if ((GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h1,
577                                                     &ass.fi.chk.key)) ||
578       (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (h2,
579                                                     &ass.fi.chk.query)) ||
580       (1 != SSCANF (&s[pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2],
581                     "%llu", 
582                     &flen)) )
583     {
584       *emsg = GNUNET_strdup (_("SKS URI malformed"));
585       return NULL;
586     }
587   ass.fi.file_length = GNUNET_htonll (flen);
588
589   npos = pos + sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) * 2;
590   while ((s[npos] != '\0') && (s[npos] != '.'))
591     npos++;
592   if (s[npos] == '\0')
593     {
594       *emsg = GNUNET_strdup (_("SKS URI malformed"));
595       goto ERR;
596     }
597   npos++;
598   ret = enc2bin (&s[npos], 
599                  &ass.peer,
600                  sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
601   if (ret == -1)
602     {
603       *emsg = GNUNET_strdup (_("SKS URI malformed (could not decode public key)"));
604       goto ERR;
605     }
606   npos += ret;
607   if (s[npos++] != '.')
608     {
609       *emsg = GNUNET_strdup (_("SKS URI malformed (could not find signature)"));
610       goto ERR;
611     }
612   ret = enc2bin (&s[npos],
613                  &sig,
614                  sizeof (struct GNUNET_CRYPTO_RsaSignature));
615   if (ret == -1)
616     {
617       *emsg = GNUNET_strdup (_("SKS URI malformed (could not decode signature)"));
618       goto ERR;
619     }
620     npos += ret;
621   if (s[npos++] != '.')
622     {
623       *emsg = GNUNET_strdup (_("SKS URI malformed"));
624       goto ERR;
625     }
626   if (1 != SSCANF (&s[npos], "%llu", &exptime))
627     {
628       *emsg = GNUNET_strdup (_("SKS URI malformed (could not parse expiration time)"));
629       goto ERR;
630     }
631   ass.purpose.size = htonl(sizeof(struct LocUriAssembly));
632   ass.purpose.purpose = htonl(GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
633   et.abs_value = exptime;
634   ass.exptime = GNUNET_TIME_absolute_hton (et);
635   if (GNUNET_OK != 
636       GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT,
637                                 &ass.purpose,
638                                 &sig,
639                                 &ass.peer))
640     {
641       *emsg = GNUNET_strdup (_("SKS URI malformed (signature failed validation)"));
642       goto ERR;
643     }
644   uri = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
645   uri->type = loc;
646   uri->data.loc.fi = ass.fi;
647   uri->data.loc.peer = ass.peer;
648   uri->data.loc.expirationTime = et;
649   uri->data.loc.contentSignature = sig;
650
651   return uri;
652 ERR:
653   return NULL;
654 }
655
656
657 /**
658  * Convert a UTF-8 String to a URI.
659  *
660  * @param uri string to parse
661  * @param emsg where to store the parser error message (if any)
662  * @return NULL on error
663  */
664 struct GNUNET_FS_Uri *
665 GNUNET_FS_uri_parse (const char *uri,
666                      char **emsg)
667 {
668   struct GNUNET_FS_Uri *ret;
669   char *msg;
670
671   if (NULL == emsg)
672     emsg = &msg;
673   *emsg = NULL;
674   if ( (NULL != (ret = uri_chk_parse (uri, emsg))) ||
675        (NULL != (ret = uri_ksk_parse (uri, emsg))) ||
676        (NULL != (ret = uri_sks_parse (uri, emsg))) ||
677        (NULL != (ret = uri_loc_parse (uri, emsg))) )
678     return ret;
679   if (NULL == *emsg)
680     *emsg = GNUNET_strdup (_("Unrecognized URI type"));
681   if (emsg == &msg)
682     GNUNET_free (msg);
683   return NULL;
684 }
685
686
687 /**
688  * Free URI.
689  *
690  * @param uri uri to free
691  */
692 void 
693 GNUNET_FS_uri_destroy (struct GNUNET_FS_Uri *uri)
694 {
695   unsigned int i;
696
697   GNUNET_assert (uri != NULL);
698   switch (uri->type)
699     {
700     case ksk:
701       for (i = 0; i < uri->data.ksk.keywordCount; i++)
702         GNUNET_free (uri->data.ksk.keywords[i]);
703       GNUNET_array_grow (uri->data.ksk.keywords, uri->data.ksk.keywordCount,
704                          0);
705       break;
706     case sks:
707       GNUNET_free (uri->data.sks.identifier);
708       break;
709     case loc:
710       break;
711     default:
712       /* do nothing */
713       break;
714     }
715   GNUNET_free (uri);
716 }
717
718 /**
719  * How many keywords are ANDed in this keyword URI?
720  *
721  * @param uri ksk uri to get the number of keywords from
722  * @return 0 if this is not a keyword URI
723  */
724 unsigned int 
725 GNUNET_FS_uri_ksk_get_keyword_count (const struct GNUNET_FS_Uri *uri)
726 {
727   if (uri->type != ksk)
728     return 0;
729   return uri->data.ksk.keywordCount;
730 }
731
732
733 /**
734  * Iterate over all keywords in this keyword URI.
735  *
736  * @param uri ksk uri to get the keywords from
737  * @param iterator function to call on each keyword
738  * @param iterator_cls closure for iterator
739  * @return -1 if this is not a keyword URI, otherwise number of
740  *   keywords iterated over until iterator aborted
741  */
742 int 
743 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
744                                 GNUNET_FS_KeywordIterator iterator, 
745                                 void *iterator_cls)
746 {
747   unsigned int i;
748   char *keyword;
749
750   if (uri->type != ksk)
751     return -1;
752   if (iterator == NULL)
753     return uri->data.ksk.keywordCount;
754   for (i = 0; i < uri->data.ksk.keywordCount; i++)
755     {
756       keyword = uri->data.ksk.keywords[i];
757       /* first character of keyword indicates
758          if it is mandatory or not */
759       if (GNUNET_OK != iterator (iterator_cls,
760                                  &keyword[1],
761                                  keyword[0] == '+'))
762         return i;
763     }
764   return i;
765 }
766
767
768 /**
769  * Add the given keyword to the set of keywords represented by the URI.
770  * Does nothing if the keyword is already present.
771  *
772  * @param uri ksk uri to modify
773  * @param keyword keyword to add
774  * @param is_mandatory is this keyword mandatory?
775  */
776 void
777 GNUNET_FS_uri_ksk_add_keyword (struct GNUNET_FS_Uri *uri,
778                                const char *keyword,
779                                int is_mandatory)
780 {
781   unsigned int i;
782   const char *old;
783   char *n;
784
785   GNUNET_assert (uri->type == ksk);
786   for (i = 0; i < uri->data.ksk.keywordCount; i++)
787     {
788       old = uri->data.ksk.keywords[i];
789       if (0 == strcmp (&old[1], keyword))
790         return;
791     }
792   GNUNET_asprintf (&n,
793                    is_mandatory ? "+%s" : " %s",
794                    keyword);
795   GNUNET_array_append (uri->data.ksk.keywords,
796                        uri->data.ksk.keywordCount,
797                        n);
798 }
799
800
801 /**
802  * Remove the given keyword from the set of keywords represented by the URI.
803  * Does nothing if the keyword is not present.
804  *
805  * @param uri ksk uri to modify
806  * @param keyword keyword to add
807  */
808 void
809 GNUNET_FS_uri_ksk_remove_keyword (struct GNUNET_FS_Uri *uri,
810                                   const char *keyword)
811 {
812   unsigned int i;
813   char *old;
814
815   GNUNET_assert (uri->type == ksk);
816   for (i = 0; i < uri->data.ksk.keywordCount; i++)
817     {
818       old = uri->data.ksk.keywords[i];
819       if (0 == strcmp (&old[1], keyword))
820         {
821           uri->data.ksk.keywords[i] = uri->data.ksk.keywords[uri->data.ksk.keywordCount-1];
822           GNUNET_array_grow (uri->data.ksk.keywords,
823                              uri->data.ksk.keywordCount,
824                              uri->data.ksk.keywordCount - 1);
825           GNUNET_free (old);
826           return;
827         }
828     }
829 }
830
831
832 /**
833  * Obtain the identity of the peer offering the data
834  *
835  * @param uri the location URI to inspect
836  * @param peer where to store the identify of the peer (presumably) offering the content
837  * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
838  */
839 int
840 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
841                                      struct GNUNET_PeerIdentity * peer)
842 {
843   if (uri->type != loc)
844     return GNUNET_SYSERR;
845   GNUNET_CRYPTO_hash (&uri->data.loc.peer,
846                       sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
847                       &peer->hashPubKey);
848   return GNUNET_OK;
849 }
850
851
852 /**
853  * Obtain the expiration of the LOC URI.
854  *
855  * @param uri location URI to get the expiration from
856  * @return expiration time of the URI
857  */
858 struct GNUNET_TIME_Absolute
859 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri)
860 {
861   GNUNET_assert (uri->type == loc);
862   return uri->data.loc.expirationTime; 
863 }
864
865
866
867 /**
868  * Obtain the URI of the content itself.
869  *
870  * @param uri location URI to get the content URI from
871  * @return NULL if argument is not a location URI
872  */
873 struct GNUNET_FS_Uri *
874 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri)
875 {
876   struct GNUNET_FS_Uri *ret;
877
878   if (uri->type != loc)
879     return NULL;
880   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
881   ret->type = chk;
882   ret->data.chk = uri->data.loc.fi;
883   return ret;
884 }
885
886
887 /**
888  * Construct a location URI (this peer will be used for the location).
889  *
890  * @param baseUri content offered by the sender
891  * @param cfg configuration information (used to find our hostkey)
892  * @param expiration_time how long will the content be offered?
893  * @return the location URI, NULL on error
894  */
895 struct GNUNET_FS_Uri *
896 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
897                           const struct GNUNET_CONFIGURATION_Handle *cfg,
898                           struct GNUNET_TIME_Absolute expiration_time)
899 {
900   struct GNUNET_FS_Uri *uri;
901   struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;  
902   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
903   char *keyfile;
904   struct LocUriAssembly ass;
905
906   if (baseUri->type != chk)
907     return NULL;
908   if (GNUNET_OK !=
909       GNUNET_CONFIGURATION_get_value_filename (cfg,
910                                                "GNUNETD",
911                                                "HOSTKEY", &keyfile))
912     {
913       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
914                   _
915                   ("Lacking key configuration settings.\n"));
916       return NULL;
917     }
918   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
919   if (my_private_key == NULL)
920     {
921       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
922                   _("Could not access hostkey file `%s'.\n"),
923                   keyfile);
924       GNUNET_free (keyfile);
925       return NULL;
926     }
927   GNUNET_free (keyfile);
928   GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
929   ass.purpose.size = htonl(sizeof(struct LocUriAssembly));
930   ass.purpose.purpose = htonl(GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
931   ass.exptime = GNUNET_TIME_absolute_hton (expiration_time);
932   ass.fi = baseUri->data.chk;
933   ass.peer = my_public_key;
934   uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
935   uri->type = loc;
936   uri->data.loc.fi = baseUri->data.chk;
937   uri->data.loc.expirationTime = expiration_time;
938   uri->data.loc.peer = my_public_key;
939   GNUNET_assert (GNUNET_OK ==
940                  GNUNET_CRYPTO_rsa_sign (my_private_key,
941                                          &ass.purpose,
942                                          &uri->data.loc.contentSignature));
943   GNUNET_CRYPTO_rsa_key_free (my_private_key);
944   return uri;
945 }
946
947
948 /**
949  * Create an SKS URI from a namespace and an identifier.
950  *
951  * @param ns namespace
952  * @param id identifier
953  * @param emsg where to store an error message
954  * @return an FS URI for the given namespace and identifier
955  */
956 struct GNUNET_FS_Uri *
957 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns,
958                           const char *id,
959                           char **emsg)
960 {
961   struct GNUNET_FS_Uri *ns_uri;
962   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
963               
964   ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
965   ns_uri->type = sks;
966   GNUNET_CRYPTO_rsa_key_get_public (ns->key,
967                                     &pk);
968   GNUNET_CRYPTO_hash (&pk,
969                       sizeof (pk),
970                       &ns_uri->data.sks.namespace);
971   ns_uri->data.sks.identifier = GNUNET_strdup (id);
972   return ns_uri;
973 }
974
975
976 /**
977  * Create an SKS URI from a namespace ID and an identifier.
978  *
979  * @param nsid namespace ID
980  * @param id identifier
981  * @return an FS URI for the given namespace and identifier
982  */
983 struct GNUNET_FS_Uri *
984 GNUNET_FS_uri_sks_create_from_nsid (GNUNET_HashCode *nsid,
985                                     const char *id)
986 {
987   struct GNUNET_FS_Uri *ns_uri;
988               
989   ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
990   ns_uri->type = sks;
991   ns_uri->data.sks.namespace = *nsid;
992   ns_uri->data.sks.identifier = GNUNET_strdup (id);
993   return ns_uri;
994 }
995
996
997 /**
998  * Canonicalize a keyword.
999  * 
1000  * @param in input string (the keyword)
1001  * @return canonicalized keyword
1002  */
1003 static char *
1004 canonicalize_keyword (const char *in)
1005 {
1006   char *ret;
1007   char *wpos;
1008   const char *rpos;
1009
1010   ret = GNUNET_strdup (in);
1011   wpos = ret;
1012   rpos = in;
1013   while ('\0' != *rpos)
1014     {
1015       switch (tolower( (unsigned char) *rpos))
1016         {
1017         case 'a':
1018         case 'e':
1019         case 'i':
1020         case 'o':
1021         case 'u':
1022         case ' ':
1023         case '\t':
1024         case '\n':
1025         case '\r':
1026           /* skip characters listed above */
1027           break;
1028         case 'b':
1029         case 'c':
1030         case 'd':
1031         case 'f':
1032         case 'g':
1033         case 'h':
1034         case 'j':
1035         case 'k':
1036         case 'l':
1037         case 'm':
1038         case 'n':
1039         case 'p':
1040         case 'r':
1041         case 's':
1042         case 't':
1043         case 'v':
1044         case 'w':
1045         case 'x':
1046         case 'y':
1047         case 'z':
1048           /* convert characters listed above to lower case */
1049           *wpos = tolower( (unsigned char)*rpos);
1050           wpos++;
1051           break;
1052         case '!':
1053         case '.':
1054         case '?':
1055         case '-':
1056           /* keep characters listed above without changes */
1057           *wpos = *rpos;
1058           wpos++;
1059           break;
1060         default:
1061           /* replace characters listed above with '_' */
1062           *wpos = '_';
1063           wpos++;
1064           break;
1065         }
1066       rpos++;
1067     }
1068   return ret;
1069 }
1070
1071
1072 /**
1073  * Canonicalize keyword URI.  Performs operations such
1074  * as decapitalization and removal of certain characters.
1075  * (useful for search).
1076  *
1077  * @param uri the URI to canonicalize 
1078  * @return canonicalized version of the URI, NULL on error
1079  */
1080 struct GNUNET_FS_Uri *
1081 GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri)
1082 {
1083   struct GNUNET_FS_Uri *ret;
1084   unsigned int kc;
1085   unsigned int i;
1086   char **kl;
1087
1088   kc = uri->data.ksk.keywordCount;
1089   kl = GNUNET_malloc (kc*sizeof(char*));
1090   for (i=0;i<kc;i++)
1091     kl[i] = canonicalize_keyword (uri->data.ksk.keywords[i]);
1092   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
1093   ret->type = ksk;
1094   ret->data.ksk.keywordCount = kc;
1095   ret->data.ksk.keywords = kl;
1096   return ret;
1097 }
1098
1099
1100 /**
1101  * Merge the sets of keywords from two KSK URIs.
1102  * (useful for merging the canonicalized keywords with
1103  * the original keywords for sharing).
1104  *
1105  * @param u1 first uri
1106  * @param u2 second uri
1107  * @return merged URI, NULL on error
1108  */
1109 struct GNUNET_FS_Uri *
1110 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
1111                          const struct GNUNET_FS_Uri *u2)
1112 {
1113   struct GNUNET_FS_Uri *ret;
1114   unsigned int kc;
1115   unsigned int i;
1116   unsigned int j;
1117   int found;
1118   const char *kp;
1119   char **kl;
1120
1121   if ( (u1 == NULL) && (u2 == NULL) )
1122     return NULL;
1123   if (u1 == NULL)
1124     return GNUNET_FS_uri_dup (u2);
1125   if (u2 == NULL)
1126     return GNUNET_FS_uri_dup (u1);
1127   if ( (u1->type != ksk) ||
1128        (u2->type != ksk) )
1129     {
1130       GNUNET_break (0);
1131       return NULL;
1132     } 
1133   kc = u1->data.ksk.keywordCount;
1134   kl = GNUNET_malloc ((kc+u2->data.ksk.keywordCount)*sizeof(char*));
1135   for (i=0;i<u1->data.ksk.keywordCount;i++)
1136     kl[i] = GNUNET_strdup (u1->data.ksk.keywords[i]);
1137   for (i=0;i<u2->data.ksk.keywordCount;i++)
1138     {
1139       kp = u2->data.ksk.keywords[i];
1140       found = 0;
1141       for (j=0;j<u1->data.ksk.keywordCount;j++)
1142         if (0 == strcmp(kp + 1,
1143                         kl[j]+1))
1144           {
1145             found = 1;
1146             if (kp[0] == '+')
1147               kl[j][0] = '+';
1148             break;
1149           }
1150       if (0 == found)
1151         kl[kc++] = GNUNET_strdup (kp - 1);
1152     }
1153   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
1154   ret->type = ksk;
1155   ret->data.ksk.keywordCount = kc;
1156   ret->data.ksk.keywords = kl;
1157   return ret;
1158 }
1159
1160
1161 /**
1162  * Duplicate URI.
1163  *
1164  * @param uri the URI to duplicate
1165  * @return copy of the URI
1166  */
1167 struct GNUNET_FS_Uri *
1168 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri)
1169 {
1170   struct GNUNET_FS_Uri *ret;
1171   unsigned int i;
1172
1173   if (uri == NULL)
1174     return NULL;
1175   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1176   memcpy (ret, uri, sizeof (struct GNUNET_FS_Uri));
1177   switch (ret->type)
1178     {
1179     case ksk:
1180       if (ret->data.ksk.keywordCount >= GNUNET_MAX_MALLOC_CHECKED / sizeof (char*))
1181         {
1182           GNUNET_break (0);
1183           GNUNET_free (ret);
1184           return NULL;
1185         }
1186       if (ret->data.ksk.keywordCount > 0)
1187         {         
1188           ret->data.ksk.keywords
1189             = GNUNET_malloc (ret->data.ksk.keywordCount * sizeof (char *));
1190           for (i = 0; i < ret->data.ksk.keywordCount; i++)
1191             ret->data.ksk.keywords[i] =
1192               GNUNET_strdup (uri->data.ksk.keywords[i]);
1193         }
1194       else
1195         ret->data.ksk.keywords = NULL;  /* just to be sure */
1196       break;
1197     case sks:
1198       ret->data.sks.identifier = GNUNET_strdup (uri->data.sks.identifier);
1199       break;
1200     case loc:
1201       break;
1202     default:
1203       break;
1204     }
1205   return ret;
1206 }
1207
1208
1209 /**
1210  * Create an FS URI from a single user-supplied string of keywords.
1211  * The string is broken up at spaces into individual keywords.
1212  * Keywords that start with "+" are mandatory.  Double-quotes can
1213  * be used to prevent breaking up strings at spaces (and also
1214  * to specify non-mandatory keywords starting with "+").
1215  *
1216  * Keywords must contain a balanced number of double quotes and
1217  * double quotes can not be used in the actual keywords (for
1218  * example, the string '""foo bar""' will be turned into two
1219  * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
1220  *
1221  * @param keywords the keyword string
1222  * @param emsg where to store an error message
1223  * @return an FS URI for the given keywords, NULL
1224  *  if keywords is not legal (i.e. empty).
1225  */
1226 struct GNUNET_FS_Uri *
1227 GNUNET_FS_uri_ksk_create (const char *keywords,
1228                           char **emsg)
1229 {
1230   char **keywordarr;
1231   unsigned int num_Words;
1232   int inWord;
1233   char *pos;
1234   struct GNUNET_FS_Uri *uri;
1235   char *searchString;
1236   int saw_quote;
1237
1238   if (keywords == NULL)
1239     {
1240       *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1241       GNUNET_break (0);
1242       return NULL;
1243     }
1244   searchString = GNUNET_strdup (keywords);
1245   num_Words = 0;
1246   inWord = 0;
1247   saw_quote = 0;
1248   pos = searchString;
1249   while ('\0' != *pos)
1250     {
1251       if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1252         {
1253           inWord = 0;
1254         }
1255       else if (0 == inWord)
1256         {
1257           inWord = 1;
1258           ++num_Words;
1259         }
1260       if ('"' == *pos)
1261         saw_quote = (saw_quote + 1) % 2;
1262       pos++;
1263     }
1264   if (num_Words == 0)
1265     {
1266       GNUNET_free (searchString);
1267       *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1268       return NULL;
1269     }
1270   if (saw_quote != 0)
1271     {
1272       GNUNET_free (searchString);
1273       *emsg = GNUNET_strdup (_("Number of double-quotes not balanced!\n"));
1274       return NULL;
1275     }
1276   keywordarr = GNUNET_malloc (num_Words * sizeof (char *));
1277   num_Words = 0;
1278   inWord = 0;
1279   pos = searchString;
1280   while ('\0' != *pos)
1281     {
1282       if ((saw_quote == 0) && (isspace ( (unsigned char) *pos)))
1283         {
1284           inWord = 0;
1285           *pos = '\0';
1286         }
1287       else if (0 == inWord)
1288         {
1289           keywordarr[num_Words] = pos;
1290           inWord = 1;
1291           ++num_Words;
1292         }
1293       if ('"' == *pos)
1294         saw_quote = (saw_quote + 1) % 2;
1295       pos++;
1296     }
1297   uri =
1298     GNUNET_FS_uri_ksk_create_from_args (num_Words,
1299                                         (const char **) keywordarr);
1300   GNUNET_free (keywordarr);
1301   GNUNET_free (searchString);
1302   return uri;
1303 }
1304
1305
1306 /**
1307  * Create an FS URI from a user-supplied command line of keywords.
1308  * Arguments should start with "+" to indicate mandatory
1309  * keywords.
1310  *
1311  * @param argc number of keywords
1312  * @param argv keywords (double quotes are not required for
1313  *             keywords containing spaces; however, double
1314  *             quotes are required for keywords starting with
1315  *             "+"); there is no mechanism for having double
1316  *             quotes in the actual keywords (if the user
1317  *             did specifically specify double quotes, the
1318  *             caller should convert each double quote
1319  *             into two single quotes).
1320  * @return an FS URI for the given keywords, NULL
1321  *  if keywords is not legal (i.e. empty).
1322  */
1323 struct GNUNET_FS_Uri *
1324 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
1325                                     const char **argv)
1326 {
1327   unsigned int i;
1328   struct GNUNET_FS_Uri *uri;
1329   const char *keyword;
1330   char *val;
1331   const char *r;
1332   char *w;
1333   char *emsg;
1334
1335   if (argc == 0)
1336     return NULL;
1337   /* allow URI to be given as one and only keyword and
1338      handle accordingly */
1339   emsg = NULL;
1340   if ( (argc == 1) &&
1341        (strlen(argv[0]) > strlen(GNUNET_FS_URI_PREFIX)) &&
1342        (0 == strncmp(argv[0], GNUNET_FS_URI_PREFIX, strlen(GNUNET_FS_URI_PREFIX)) ) &&
1343        (NULL != (uri = GNUNET_FS_uri_parse(argv[0], &emsg)) ) )
1344     return uri;
1345   GNUNET_free_non_null (emsg);
1346   uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1347   uri->type = ksk;
1348   uri->data.ksk.keywordCount = argc;
1349   uri->data.ksk.keywords = GNUNET_malloc (argc * sizeof (char *));
1350   for (i = 0; i < argc; i++)
1351     {
1352       keyword = argv[i];
1353       if (keyword[0] == '+')
1354         val = GNUNET_strdup (keyword);
1355       else
1356         GNUNET_asprintf (&val, " %s", keyword);
1357       r = val;
1358       w = val;
1359       while ('\0' != *r)
1360         {
1361           if ('"' == *r)
1362             r++;
1363           else
1364             *(w++) = *(r++);
1365         }
1366       *w = '\0';
1367       uri->data.ksk.keywords[i] = val;
1368     }
1369   return uri;
1370 }
1371
1372
1373 /**
1374  * Test if two URIs are equal.
1375  *
1376  * @param u1 one of the URIs
1377  * @param u2 the other URI
1378  * @return GNUNET_YES if the URIs are equal
1379  */
1380 int 
1381 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
1382                           const struct GNUNET_FS_Uri *u2)
1383 {
1384   int ret;
1385   unsigned int i;
1386   unsigned int j;
1387
1388   GNUNET_assert (u1 != NULL);
1389   GNUNET_assert (u2 != NULL);
1390   if (u1->type != u2->type)
1391     return GNUNET_NO;
1392   switch (u1->type)
1393     {
1394     case chk:
1395       if (0 == memcmp (&u1->data.chk,
1396                        &u2->data.chk,
1397                        sizeof (struct FileIdentifier)))
1398         return GNUNET_YES;
1399       return GNUNET_NO;
1400     case sks:
1401       if ((0 == memcmp (&u1->data.sks.namespace,
1402                         &u2->data.sks.namespace,
1403                         sizeof (GNUNET_HashCode))) &&
1404           (0 == strcmp (u1->data.sks.identifier,
1405                         u2->data.sks.identifier)))
1406
1407         return GNUNET_YES;
1408       return GNUNET_NO;
1409     case ksk:
1410       if (u1->data.ksk.keywordCount != u2->data.ksk.keywordCount)
1411         return GNUNET_NO;
1412       for (i = 0; i < u1->data.ksk.keywordCount; i++)
1413         {
1414           ret = GNUNET_NO;
1415           for (j = 0; j < u2->data.ksk.keywordCount; j++)
1416             {
1417               if (0 == strcmp (u1->data.ksk.keywords[i],
1418                                u2->data.ksk.keywords[j]))
1419                 {
1420                   ret = GNUNET_YES;
1421                   break;
1422                 }
1423             }
1424           if (ret == GNUNET_NO)
1425             return GNUNET_NO;
1426         }
1427       return GNUNET_YES;
1428     case loc:
1429       if (memcmp (&u1->data.loc,
1430                   &u2->data.loc,
1431                   sizeof (struct FileIdentifier) +
1432                   sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
1433                   sizeof (struct GNUNET_TIME_Absolute) +
1434                   sizeof (unsigned short) + sizeof (unsigned short)) != 0)
1435         return GNUNET_NO;
1436       return GNUNET_YES;
1437     default:
1438       return GNUNET_NO;
1439     }
1440 }
1441
1442
1443 /**
1444  * Is this a namespace URI?
1445  *
1446  * @param uri the uri to check
1447  * @return GNUNET_YES if this is an SKS uri
1448  */
1449 int
1450 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri)
1451 {
1452   return uri->type == sks;
1453 }
1454
1455
1456 /**
1457  * Get the ID of a namespace from the given
1458  * namespace URI.
1459  *
1460  * @param uri the uri to get the namespace ID from
1461  * @param nsid where to store the ID of the namespace
1462  * @return GNUNET_OK on success
1463  */
1464 int 
1465 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
1466                                  GNUNET_HashCode * nsid)
1467 {
1468   if (! GNUNET_FS_uri_test_sks (uri))
1469     {
1470       GNUNET_break (0);
1471       return GNUNET_SYSERR;
1472     }
1473   *nsid = uri->data.sks.namespace;
1474   return GNUNET_OK;
1475 }
1476
1477
1478 /**
1479  * Get the content identifier of an SKS URI.
1480  *
1481  * @param uri the sks uri
1482  * @return NULL on error (not a valid SKS URI)
1483  */
1484 char *
1485 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
1486 {
1487   if (!GNUNET_FS_uri_test_sks (uri))
1488     {
1489       GNUNET_break (0);
1490       return NULL;
1491     }
1492   return GNUNET_strdup (uri->data.sks.identifier);
1493 }
1494
1495
1496 /**
1497  * Convert namespace URI to a human readable format
1498  * (using the namespace description, if available).
1499  *
1500  * @param cfg configuration to use
1501  * @param uri SKS uri to convert
1502  * @return NULL on error (not an SKS URI)
1503  */
1504 char *
1505 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
1506                                    const struct GNUNET_FS_Uri *uri)
1507 {
1508   char *ret;
1509   char *name;
1510
1511   if (uri->type != sks)
1512     return NULL;
1513   name = GNUNET_PSEUDONYM_id_to_name (cfg, &uri->data.sks.namespace);
1514   if (name == NULL)
1515     return GNUNET_FS_uri_to_string (uri);
1516   GNUNET_asprintf (&ret,
1517                    "%s: %s",
1518                    name,
1519                    uri->data.sks.identifier);
1520   GNUNET_free (name);
1521   return ret;
1522 }
1523
1524
1525 /**
1526  * Is this a keyword URI?
1527  *
1528  * @param uri the uri
1529  * @return GNUNET_YES if this is a KSK uri
1530  */
1531 int 
1532 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
1533 {
1534 #if EXTRA_CHECKS
1535   unsigned int i;
1536
1537   if (uri->type == ksk)
1538     {
1539       for (i = uri->data.ksk.keywordCount - 1; i >= 0; i--)
1540         GNUNET_assert (uri->data.ksk.keywords[i] != NULL);
1541     }
1542 #endif
1543   return uri->type == ksk;
1544 }
1545
1546
1547 /**
1548  * Is this a file (or directory) URI?
1549  *
1550  * @param uri the uri to check
1551  * @return GNUNET_YES if this is a CHK uri
1552  */
1553 int 
1554 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri)
1555 {
1556   return uri->type == chk;
1557 }
1558
1559
1560 /**
1561  * What is the size of the file that this URI
1562  * refers to?
1563  *
1564  * @param uri the CHK URI to inspect
1565  * @return size of the file as specified in the CHK URI
1566  */
1567 uint64_t 
1568 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri)
1569 {
1570   switch (uri->type)
1571     {
1572     case chk:
1573       return GNUNET_ntohll (uri->data.chk.file_length);
1574     case loc:
1575       return GNUNET_ntohll (uri->data.loc.fi.file_length);
1576     default:
1577       GNUNET_assert (0);
1578     }
1579   return 0;                     /* unreachable */
1580 }
1581
1582
1583 /**
1584  * Is this a location URI?
1585  *
1586  * @param uri the uri to check
1587  * @return GNUNET_YES if this is a LOC uri
1588  */
1589 int 
1590 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri)
1591 {
1592   return uri->type == loc;
1593 }
1594
1595
1596 /**
1597  * Function called on each value in the meta data.
1598  * Adds it to the URI.
1599  *
1600  * @param cls URI to update
1601  * @param plugin_name name of the plugin that produced this value;
1602  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
1603  *        used in the main libextractor library and yielding
1604  *        meta data).
1605  * @param type libextractor-type describing the meta data
1606  * @param format basic format information about data 
1607  * @param data_mime_type mime-type of data (not of the original file);
1608  *        can be NULL (if mime-type is not known)
1609  * @param data actual meta-data found
1610  * @param data_len number of bytes in data
1611  * @return 0 (always)
1612  */
1613 static int
1614 gather_uri_data (void *cls,
1615                  const char *plugin_name,
1616                  enum EXTRACTOR_MetaType type, 
1617                  enum EXTRACTOR_MetaFormat format,
1618                  const char *data_mime_type,
1619                  const char *data,
1620                  size_t data_len)
1621 {
1622   struct GNUNET_FS_Uri *uri = cls;
1623   char *nkword;
1624   int j;
1625   
1626   if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
1627        (format != EXTRACTOR_METAFORMAT_C_STRING) )
1628     return 0;
1629   for (j = uri->data.ksk.keywordCount - 1; j >= 0; j--)
1630     if (0 == strcmp (&uri->data.ksk.keywords[j][1], data))
1631       return GNUNET_OK;
1632   GNUNET_asprintf (&nkword,
1633                    " %s", /* space to mark as 'non mandatory' */
1634                    data);
1635   uri->data.ksk.keywords[uri->data.ksk.keywordCount++] = nkword;
1636   return 0;
1637 }
1638
1639
1640 /**
1641  * Construct a keyword-URI from meta-data (take all entries
1642  * in the meta-data and construct one large keyword URI
1643  * that lists all keywords that can be found in the meta-data).
1644  *
1645  * @param md metadata to use
1646  * @return NULL on error, otherwise a KSK URI
1647  */
1648 struct GNUNET_FS_Uri *
1649 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md)
1650 {
1651   struct GNUNET_FS_Uri *ret;
1652   int ent;
1653
1654   if (md == NULL)
1655     return NULL;
1656   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1657   ret->type = ksk;
1658   ent = GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL);
1659   if (ent > 0)
1660     {
1661       ret->data.ksk.keywords
1662         = GNUNET_malloc (sizeof (char *) * ent);                     
1663       GNUNET_CONTAINER_meta_data_iterate (md, &gather_uri_data, ret);
1664     }
1665   return ret;
1666 }
1667
1668
1669 /**
1670  * In URI-encoding, does the given character
1671  * need to be encoded using %-encoding?
1672  */
1673 static int
1674 needs_percent (char c)
1675 {
1676   return (!((isalnum ( (unsigned char) c)) ||
1677             (c == '-') || (c == '_') || (c == '.') || (c == '~')));
1678 }
1679
1680
1681 /**
1682  * Convert a KSK URI to a string.
1683  *
1684  * @param uri the URI to convert
1685  * @return NULL on error (i.e. keywordCount == 0)
1686  */
1687 static char *
1688 uri_ksk_to_string (const struct GNUNET_FS_Uri *uri)
1689 {
1690   char ** keywords; 
1691   unsigned int keywordCount;
1692   size_t n;
1693   char *ret;
1694   unsigned int i;
1695   unsigned int j;
1696   unsigned int wpos;
1697   size_t slen;
1698   const char *keyword;
1699
1700   if (uri->type != ksk)
1701     return NULL;
1702   keywords = uri->data.ksk.keywords;
1703   keywordCount = uri->data.ksk.keywordCount;
1704   n =
1705     keywordCount + strlen (GNUNET_FS_URI_PREFIX) +
1706     strlen (GNUNET_FS_URI_KSK_INFIX) + 1;
1707   for (i = 0; i < keywordCount; i++)
1708     {
1709       keyword = keywords[i];
1710       slen = strlen (keyword);
1711       n += slen;
1712       for (j = 0; j < slen; j++)
1713         {
1714           if ((j == 0) && (keyword[j] == ' '))
1715             {
1716               n--;
1717               continue;         /* skip leading space */
1718             }
1719           if (needs_percent (keyword[j]))
1720             n += 2;             /* will use %-encoding */
1721         }
1722     }
1723   ret = GNUNET_malloc (n);
1724   strcpy (ret, GNUNET_FS_URI_PREFIX);
1725   strcat (ret, GNUNET_FS_URI_KSK_INFIX);
1726   wpos = strlen (ret);
1727   for (i = 0; i < keywordCount; i++)
1728     {
1729       keyword = keywords[i];
1730       slen = strlen (keyword);
1731       for (j = 0; j < slen; j++)
1732         {
1733           if ((j == 0) && (keyword[j] == ' '))
1734             continue;           /* skip leading space */
1735           if (needs_percent (keyword[j]))
1736             {
1737               sprintf (&ret[wpos], "%%%02X", keyword[j]);
1738               wpos += 3;
1739             }
1740           else
1741             {
1742               ret[wpos++] = keyword[j];
1743             }
1744         }
1745       if (i != keywordCount - 1)
1746         ret[wpos++] = '+';
1747     }
1748   return ret;
1749 }
1750
1751
1752 /**
1753  * Convert SKS URI to a string.
1754  *
1755  * @param uri sks uri to convert
1756  * @return NULL on error
1757  */
1758 static char *
1759 uri_sks_to_string (const struct GNUNET_FS_Uri *uri)
1760 {
1761   const GNUNET_HashCode * namespace;
1762   const char *identifier;
1763   char *ret;
1764   struct GNUNET_CRYPTO_HashAsciiEncoded ns;
1765   
1766   if (uri->type != sks)
1767     return NULL;
1768   namespace = &uri->data.sks.namespace;
1769   identifier = uri->data.sks.identifier;
1770   GNUNET_CRYPTO_hash_to_enc (namespace, &ns);
1771   GNUNET_asprintf (&ret,
1772                    "%s%s%s/%s",
1773                    GNUNET_FS_URI_PREFIX, 
1774                    GNUNET_FS_URI_SKS_INFIX,
1775                    (const char *) &ns, identifier);
1776   return ret;
1777 }
1778
1779
1780 /**
1781  * Convert a CHK URI to a string.
1782  *
1783  * @param uri chk uri to convert
1784  * @return NULL on error
1785  */
1786 static char *
1787 uri_chk_to_string (const struct GNUNET_FS_Uri *uri)
1788 {
1789   const struct FileIdentifier * fi;
1790   char *ret;
1791   struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1792   struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1793
1794   if (uri->type != chk)
1795     return NULL;
1796   fi = &uri->data.chk;
1797   GNUNET_CRYPTO_hash_to_enc (&fi->chk.key, &keyhash);
1798   GNUNET_CRYPTO_hash_to_enc (&fi->chk.query, &queryhash);
1799
1800   GNUNET_asprintf (&ret,
1801                    "%s%s%s.%s.%llu",
1802                    GNUNET_FS_URI_PREFIX,
1803                    GNUNET_FS_URI_CHK_INFIX,
1804                    (const char *) &keyhash, 
1805                    (const char *) &queryhash,
1806                    GNUNET_ntohll (fi->file_length));
1807   return ret;
1808 }
1809
1810 /**
1811  * Convert binary data to a string.
1812  *
1813  * @param data binary data to convert
1814  * @param size number of bytes in data
1815  * @return converted data
1816  */
1817 static char *
1818 bin2enc (const void *data, size_t size)
1819 {
1820   /**
1821    * 64 characters for encoding, 6 bits per character
1822    */
1823   static char *tbl =
1824     "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_=";
1825   
1826   size_t len;
1827   size_t pos;
1828   unsigned int bits;
1829   unsigned int hbits;
1830   char *ret;
1831
1832   GNUNET_assert (strlen (tbl) == 64);
1833   len = size * 8 / 6;
1834   if (((size * 8) % 6) != 0)
1835     len++;
1836   ret = GNUNET_malloc (len + 1);
1837   ret[len] = '\0';
1838   len = 0;
1839   bits = 0;
1840   hbits = 0;
1841   for (pos = 0; pos < size; pos++)
1842     {
1843       bits |= ((((const unsigned char *) data)[pos]) << hbits);
1844       hbits += 8;
1845       while (hbits >= 6)
1846         {
1847           ret[len++] = tbl[bits & 63];
1848           bits >>= 6;
1849           hbits -= 6;
1850         }
1851     }
1852   if (hbits > 0)
1853     ret[len] = tbl[bits & 63];
1854   return ret;
1855 }
1856
1857
1858 /**
1859  * Convert a LOC URI to a string.
1860  *
1861  * @param uri loc uri to convert
1862  * @return NULL on error
1863  */
1864 static char *
1865 uri_loc_to_string (const struct GNUNET_FS_Uri *uri)
1866 {
1867   char *ret;
1868   struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1869   struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1870   char *peerId;
1871   char *peerSig;
1872
1873   GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.key, &keyhash);
1874   GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.query, &queryhash);
1875   peerId = bin2enc (&uri->data.loc.peer,
1876                     sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
1877   peerSig = bin2enc (&uri->data.loc.contentSignature, 
1878                      sizeof (struct GNUNET_CRYPTO_RsaSignature));
1879   GNUNET_asprintf (&ret,
1880                    "%s%s%s.%s.%llu.%s.%s.%llu",
1881                    GNUNET_FS_URI_PREFIX,
1882                    GNUNET_FS_URI_LOC_INFIX,
1883                    (const char *) &keyhash,
1884                    (const char *) &queryhash,
1885                    (unsigned long long) GNUNET_ntohll (uri->data.loc.fi.file_length),
1886                    peerId,
1887                    peerSig,
1888                    (unsigned long long) uri->data.loc.expirationTime.abs_value);
1889   GNUNET_free (peerSig);
1890   GNUNET_free (peerId);
1891   return ret;
1892 }
1893
1894
1895 /**
1896  * Convert a URI to a UTF-8 String.
1897  *
1898  * @param uri uri to convert to a string
1899  * @return the UTF-8 string
1900  */
1901 char *
1902 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri)
1903 {
1904   if (uri == NULL)
1905     {
1906       GNUNET_break (0);
1907       return NULL;
1908     }
1909   switch (uri->type)
1910     {
1911     case ksk:
1912       return uri_ksk_to_string (uri);
1913     case sks:
1914       return uri_sks_to_string (uri);
1915     case chk:
1916       return uri_chk_to_string (uri);
1917     case loc:
1918       return uri_loc_to_string (uri);
1919     default:
1920       GNUNET_break (0);
1921       return NULL;
1922     }
1923 }
1924
1925 /* end of fs_uri.c */