2e1ec92c84368fb284a73da8ab7a70d42525885e
[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 2, 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.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  * Obtain the identity of the peer offering the data
770  *
771  * @param uri the location URI to inspect
772  * @param peer where to store the identify of the peer (presumably) offering the content
773  * @return GNUNET_SYSERR if this is not a location URI, otherwise GNUNET_OK
774  */
775 int
776 GNUNET_FS_uri_loc_get_peer_identity (const struct GNUNET_FS_Uri *uri,
777                                      struct GNUNET_PeerIdentity * peer)
778 {
779   if (uri->type != loc)
780     return GNUNET_SYSERR;
781   GNUNET_CRYPTO_hash (&uri->data.loc.peer,
782                       sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
783                       &peer->hashPubKey);
784   return GNUNET_OK;
785 }
786
787
788 /**
789  * Obtain the expiration of the LOC URI.
790  *
791  * @param uri location URI to get the expiration from
792  * @return expiration time of the URI
793  */
794 struct GNUNET_TIME_Absolute
795 GNUNET_FS_uri_loc_get_expiration (const struct GNUNET_FS_Uri *uri)
796 {
797   GNUNET_assert (uri->type == loc);
798   return uri->data.loc.expirationTime; 
799 }
800
801
802
803 /**
804  * Obtain the URI of the content itself.
805  *
806  * @param uri location URI to get the content URI from
807  * @return NULL if argument is not a location URI
808  */
809 struct GNUNET_FS_Uri *
810 GNUNET_FS_uri_loc_get_uri (const struct GNUNET_FS_Uri *uri)
811 {
812   struct GNUNET_FS_Uri *ret;
813
814   if (uri->type != loc)
815     return NULL;
816   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
817   ret->type = chk;
818   ret->data.chk = uri->data.loc.fi;
819   return ret;
820 }
821
822
823 /**
824  * Construct a location URI (this peer will be used for the location).
825  *
826  * @param baseUri content offered by the sender
827  * @param cfg configuration information (used to find our hostkey)
828  * @param expiration_time how long will the content be offered?
829  * @return the location URI, NULL on error
830  */
831 struct GNUNET_FS_Uri *
832 GNUNET_FS_uri_loc_create (const struct GNUNET_FS_Uri *baseUri,
833                           struct GNUNET_CONFIGURATION_Handle *cfg,
834                           struct GNUNET_TIME_Absolute expiration_time)
835 {
836   struct GNUNET_FS_Uri *uri;
837   struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;  
838   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
839   char *keyfile;
840   struct LocUriAssembly ass;
841
842   if (baseUri->type != chk)
843     return NULL;
844   if (GNUNET_OK !=
845       GNUNET_CONFIGURATION_get_value_filename (cfg,
846                                                "GNUNETD",
847                                                "HOSTKEY", &keyfile))
848     {
849       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
850                   _
851                   ("Lacking key configuration settings.\n"));
852       return NULL;
853     }
854   my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
855   if (my_private_key == NULL)
856     {
857       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
858                   _("Could not access hostkey file `%s'.\n"),
859                   keyfile);
860       GNUNET_free (keyfile);
861       return NULL;
862     }
863   GNUNET_free (keyfile);
864   GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
865   ass.purpose.size = htonl(sizeof(struct LocUriAssembly));
866   ass.purpose.purpose = htonl(GNUNET_SIGNATURE_PURPOSE_PEER_PLACEMENT);
867   ass.exptime = GNUNET_TIME_absolute_hton (expiration_time);
868   ass.fi = baseUri->data.chk;
869   ass.peer = my_public_key;
870   uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
871   uri->type = loc;
872   uri->data.loc.fi = baseUri->data.chk;
873   uri->data.loc.expirationTime = expiration_time;
874   uri->data.loc.peer = my_public_key;
875   GNUNET_assert (GNUNET_OK ==
876                  GNUNET_CRYPTO_rsa_sign (my_private_key,
877                                          &ass.purpose,
878                                          &uri->data.loc.contentSignature));
879   GNUNET_CRYPTO_rsa_key_free (my_private_key);
880   return uri;
881 }
882
883
884 /**
885  * Create an SKS URI from a namespace and an identifier.
886  *
887  * @param ns namespace
888  * @param id identifier
889  * @param emsg where to store an error message
890  * @return an FS URI for the given namespace and identifier
891  */
892 struct GNUNET_FS_Uri *
893 GNUNET_FS_uri_sks_create (struct GNUNET_FS_Namespace *ns,
894                           const char *id,
895                           char **emsg)
896 {
897   struct GNUNET_FS_Uri *ns_uri;
898   struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pk;
899               
900   ns_uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
901   ns_uri->type = sks;
902   GNUNET_CRYPTO_rsa_key_get_public (ns->key,
903                                     &pk);
904   GNUNET_CRYPTO_hash (&pk,
905                       sizeof (pk),
906                       &ns_uri->data.sks.namespace);
907   ns_uri->data.sks.identifier = GNUNET_strdup (id);
908   return ns_uri;
909 }
910
911
912 /**
913  * Canonicalize a keyword.
914  * 
915  * @param in input string (the keyword)
916  * @return canonicalized keyword
917  */
918 static char *
919 canonicalize_keyword (const char *in)
920 {
921   char *ret;
922   char *wpos;
923   const char *rpos;
924
925   ret = GNUNET_strdup (in);
926   wpos = ret;
927   rpos = in;
928   while ('\0' != *rpos)
929     {
930       switch (tolower( (unsigned char) *rpos))
931         {
932         case 'a':
933         case 'e':
934         case 'i':
935         case 'o':
936         case 'u':
937         case ' ':
938         case '\t':
939         case '\n':
940         case '\r':
941           /* skip characters listed above */
942           rpos++;
943           break;
944         case 'b':
945         case 'c':
946         case 'd':
947         case 'f':
948         case 'g':
949         case 'h':
950         case 'j':
951         case 'k':
952         case 'l':
953         case 'm':
954         case 'n':
955         case 'p':
956         case 'r':
957         case 's':
958         case 't':
959         case 'v':
960         case 'w':
961         case 'x':
962         case 'y':
963         case 'z':
964           /* convert characters listed above to lower case */
965           *wpos = tolower( (unsigned char)*rpos);
966           wpos++;
967         case '!':
968         case '.':
969         case '?':
970         case '-':
971           /* keep characters listed above without changes */
972           *wpos = *rpos;
973           wpos++;
974           break;
975         default:
976           /* replace characters listed above with '_' */
977           *wpos = '_';
978           wpos++;
979         }
980       rpos++;
981     }
982   return ret;
983 }
984
985
986 /**
987  * Canonicalize keyword URI.  Performs operations such
988  * as decapitalization and removal of certain characters.
989  * (useful for search).
990  *
991  * @param uri the URI to canonicalize 
992  * @return canonicalized version of the URI, NULL on error
993  */
994 struct GNUNET_FS_Uri *
995 GNUNET_FS_uri_ksk_canonicalize (const struct GNUNET_FS_Uri *uri)
996 {
997   struct GNUNET_FS_Uri *ret;
998   unsigned int kc;
999   unsigned int i;
1000   char **kl;
1001
1002   kc = uri->data.ksk.keywordCount;
1003   kl = GNUNET_malloc (kc*sizeof(char*));
1004   for (i=0;i<kc;i++)
1005     kl[i] = canonicalize_keyword (uri->data.ksk.keywords[i]);
1006   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
1007   ret->type = ksk;
1008   ret->data.ksk.keywordCount = kc;
1009   ret->data.ksk.keywords = kl;
1010   return ret;
1011 }
1012
1013
1014 /**
1015  * Merge the sets of keywords from two KSK URIs.
1016  * (useful for merging the canonicalized keywords with
1017  * the original keywords for sharing).
1018  *
1019  * @param u1 first uri
1020  * @param u2 second uri
1021  * @return merged URI, NULL on error
1022  */
1023 struct GNUNET_FS_Uri *
1024 GNUNET_FS_uri_ksk_merge (const struct GNUNET_FS_Uri *u1,
1025                          const struct GNUNET_FS_Uri *u2)
1026 {
1027   struct GNUNET_FS_Uri *ret;
1028   unsigned int kc;
1029   unsigned int i;
1030   unsigned int j;
1031   int found;
1032   const char *kp;
1033   char **kl;
1034
1035   if ( (u1 == NULL) && (u2 == NULL) )
1036     return NULL;
1037   if (u1 == NULL)
1038     return GNUNET_FS_uri_dup (u2);
1039   if (u2 == NULL)
1040     return GNUNET_FS_uri_dup (u1);
1041   if ( (u1->type != ksk) ||
1042        (u2->type != ksk) )
1043     {
1044       GNUNET_break (0);
1045       return NULL;
1046     } 
1047   kc = u1->data.ksk.keywordCount;
1048   kl = GNUNET_malloc ((kc+u2->data.ksk.keywordCount)*sizeof(char*));
1049   for (i=0;i<u1->data.ksk.keywordCount;i++)
1050     kl[i] = GNUNET_strdup (u1->data.ksk.keywords[i]);
1051   for (i=0;i<u2->data.ksk.keywordCount;i++)
1052     {
1053       kp = u2->data.ksk.keywords[i];
1054       found = 0;
1055       for (j=0;j<u1->data.ksk.keywordCount;j++)
1056         if (0 == strcmp(kp + 1,
1057                         kl[j]+1))
1058           {
1059             found = 1;
1060             if (kp[0] == '+')
1061               kl[j][0] = '+';
1062             break;
1063           }
1064       if (0 == found)
1065         kl[kc++] = GNUNET_strdup (kp - 1);
1066     }
1067   ret = GNUNET_malloc (sizeof(struct GNUNET_FS_Uri));
1068   ret->type = ksk;
1069   ret->data.ksk.keywordCount = kc;
1070   ret->data.ksk.keywords = kl;
1071   return ret;
1072 }
1073
1074
1075 /**
1076  * Duplicate URI.
1077  *
1078  * @param uri the URI to duplicate
1079  * @return copy of the URI
1080  */
1081 struct GNUNET_FS_Uri *
1082 GNUNET_FS_uri_dup (const struct GNUNET_FS_Uri *uri)
1083 {
1084   struct GNUNET_FS_Uri *ret;
1085   unsigned int i;
1086
1087   if (uri == NULL)
1088     return NULL;
1089   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1090   memcpy (ret, uri, sizeof (struct GNUNET_FS_Uri));
1091   switch (ret->type)
1092     {
1093     case ksk:
1094       if (ret->data.ksk.keywordCount > 0)
1095         {
1096           ret->data.ksk.keywords
1097             = GNUNET_malloc (ret->data.ksk.keywordCount * sizeof (char *));
1098           for (i = 0; i < ret->data.ksk.keywordCount; i++)
1099             ret->data.ksk.keywords[i] =
1100               GNUNET_strdup (uri->data.ksk.keywords[i]);
1101         }
1102       else
1103         ret->data.ksk.keywords = NULL;  /* just to be sure */
1104       break;
1105     case sks:
1106       ret->data.sks.identifier = GNUNET_strdup (uri->data.sks.identifier);
1107       break;
1108     case loc:
1109       break;
1110     default:
1111       break;
1112     }
1113   return ret;
1114 }
1115
1116
1117 /**
1118  * Create an FS URI from a single user-supplied string of keywords.
1119  * The string is broken up at spaces into individual keywords.
1120  * Keywords that start with "+" are mandatory.  Double-quotes can
1121  * be used to prevent breaking up strings at spaces (and also
1122  * to specify non-mandatory keywords starting with "+").
1123  *
1124  * Keywords must contain a balanced number of double quotes and
1125  * double quotes can not be used in the actual keywords (for
1126  * example, the string '""foo bar""' will be turned into two
1127  * "OR"ed keywords 'foo' and 'bar', not into '"foo bar"'.
1128  *
1129  * @param keywords the keyword string
1130  * @param emsg where to store an error message
1131  * @return an FS URI for the given keywords, NULL
1132  *  if keywords is not legal (i.e. empty).
1133  */
1134 struct GNUNET_FS_Uri *
1135 GNUNET_FS_uri_ksk_create (const char *keywords,
1136                           char **emsg)
1137 {
1138   char **keywordarr;
1139   unsigned int num_Words;
1140   int inWord;
1141   char *pos;
1142   struct GNUNET_FS_Uri *uri;
1143   char *searchString;
1144   int saw_quote;
1145
1146   if (keywords == NULL)
1147     {
1148       GNUNET_break (0);
1149       return NULL;
1150     }
1151   searchString = GNUNET_strdup (keywords);
1152   num_Words = 0;
1153   inWord = 0;
1154   saw_quote = 0;
1155   pos = searchString;
1156   while ('\0' != *pos)
1157     {
1158       if ((saw_quote == 0) && (isspace ((unsigned char) *pos)))
1159         {
1160           inWord = 0;
1161         }
1162       else if (0 == inWord)
1163         {
1164           inWord = 1;
1165           ++num_Words;
1166         }
1167       if ('"' == *pos)
1168         saw_quote = (saw_quote + 1) % 2;
1169       pos++;
1170     }
1171   if (num_Words == 0)
1172     {
1173       GNUNET_free (searchString);
1174       *emsg = GNUNET_strdup (_("No keywords specified!\n"));
1175       return NULL;
1176     }
1177   if (saw_quote != 0)
1178     {
1179       GNUNET_free (searchString);
1180       *emsg = GNUNET_strdup (_("Number of double-quotes not balanced!\n"));
1181       return NULL;
1182     }
1183   keywordarr = GNUNET_malloc (num_Words * sizeof (char *));
1184   num_Words = 0;
1185   inWord = 0;
1186   pos = searchString;
1187   while ('\0' != *pos)
1188     {
1189       if ((saw_quote == 0) && (isspace ( (unsigned char) *pos)))
1190         {
1191           inWord = 0;
1192           *pos = '\0';
1193         }
1194       else if (0 == inWord)
1195         {
1196           keywordarr[num_Words] = pos;
1197           inWord = 1;
1198           ++num_Words;
1199         }
1200       if ('"' == *pos)
1201         saw_quote = (saw_quote + 1) % 2;
1202       pos++;
1203     }
1204   uri =
1205     GNUNET_FS_uri_ksk_create_from_args (num_Words,
1206                                         (const char **) keywordarr);
1207   GNUNET_free (keywordarr);
1208   GNUNET_free (searchString);
1209   return uri;
1210 }
1211
1212
1213 /**
1214  * Create an FS URI from a user-supplied command line of keywords.
1215  * Arguments should start with "+" to indicate mandatory
1216  * keywords.
1217  *
1218  * @param argc number of keywords
1219  * @param argv keywords (double quotes are not required for
1220  *             keywords containing spaces; however, double
1221  *             quotes are required for keywords starting with
1222  *             "+"); there is no mechanism for having double
1223  *             quotes in the actual keywords (if the user
1224  *             did specifically specify double quotes, the
1225  *             caller should convert each double quote
1226  *             into two single quotes).
1227  * @return an FS URI for the given keywords, NULL
1228  *  if keywords is not legal (i.e. empty).
1229  */
1230 struct GNUNET_FS_Uri *
1231 GNUNET_FS_uri_ksk_create_from_args (unsigned int argc,
1232                                     const char **argv)
1233 {
1234   unsigned int i;
1235   struct GNUNET_FS_Uri *uri;
1236   const char *keyword;
1237   char *val;
1238   const char *r;
1239   char *w;
1240   char *emsg;
1241
1242   if (argc == 0)
1243     return NULL;
1244   /* allow URI to be given as one and only keyword and
1245      handle accordingly */
1246   emsg = NULL;
1247   if ( (argc == 1) &&
1248        (strlen(argv[0]) > strlen(GNUNET_FS_URI_PREFIX)) &&
1249        (0 == strncmp(argv[0], GNUNET_FS_URI_PREFIX, strlen(GNUNET_FS_URI_PREFIX)) ) &&
1250        (NULL != (uri = GNUNET_FS_uri_parse(argv[0], &emsg)) ) )
1251     return uri;
1252   GNUNET_free_non_null (emsg);
1253   uri = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1254   uri->type = ksk;
1255   uri->data.ksk.keywordCount = argc;
1256   uri->data.ksk.keywords = GNUNET_malloc (argc * sizeof (char *));
1257   for (i = 0; i < argc; i++)
1258     {
1259       keyword = argv[i];
1260       if (keyword[0] == '+')
1261         val = GNUNET_strdup (keyword);
1262       else
1263         GNUNET_asprintf (&val, " %s", keyword);
1264       r = val;
1265       w = val;
1266       while ('\0' != *r)
1267         {
1268           if ('"' == *r)
1269             r++;
1270           else
1271             *(w++) = *(r++);
1272         }
1273       *w = '\0';
1274       uri->data.ksk.keywords[i] = val;
1275     }
1276   return uri;
1277 }
1278
1279
1280 /**
1281  * Test if two URIs are equal.
1282  *
1283  * @param u1 one of the URIs
1284  * @param u2 the other URI
1285  * @return GNUNET_YES if the URIs are equal
1286  */
1287 int 
1288 GNUNET_FS_uri_test_equal (const struct GNUNET_FS_Uri *u1,
1289                           const struct GNUNET_FS_Uri *u2)
1290 {
1291   int ret;
1292   unsigned int i;
1293   unsigned int j;
1294
1295   GNUNET_assert (u1 != NULL);
1296   GNUNET_assert (u2 != NULL);
1297   if (u1->type != u2->type)
1298     return GNUNET_NO;
1299   switch (u1->type)
1300     {
1301     case chk:
1302       if (0 == memcmp (&u1->data.chk,
1303                        &u2->data.chk,
1304                        sizeof (struct FileIdentifier)))
1305         return GNUNET_YES;
1306       return GNUNET_NO;
1307     case sks:
1308       if ((0 == memcmp (&u1->data.sks.namespace,
1309                         &u2->data.sks.namespace,
1310                         sizeof (GNUNET_HashCode))) &&
1311           (0 == strcmp (u1->data.sks.identifier,
1312                         u2->data.sks.identifier)))
1313
1314         return GNUNET_YES;
1315       return GNUNET_NO;
1316     case ksk:
1317       if (u1->data.ksk.keywordCount != u2->data.ksk.keywordCount)
1318         return GNUNET_NO;
1319       for (i = 0; i < u1->data.ksk.keywordCount; i++)
1320         {
1321           ret = GNUNET_NO;
1322           for (j = 0; j < u2->data.ksk.keywordCount; j++)
1323             {
1324               if (0 == strcmp (u1->data.ksk.keywords[i],
1325                                u2->data.ksk.keywords[j]))
1326                 {
1327                   ret = GNUNET_YES;
1328                   break;
1329                 }
1330             }
1331           if (ret == GNUNET_NO)
1332             return GNUNET_NO;
1333         }
1334       return GNUNET_YES;
1335     case loc:
1336       if (memcmp (&u1->data.loc,
1337                   &u2->data.loc,
1338                   sizeof (struct FileIdentifier) +
1339                   sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
1340                   sizeof (struct GNUNET_TIME_Absolute) +
1341                   sizeof (unsigned short) + sizeof (unsigned short)) != 0)
1342         return GNUNET_NO;
1343       return GNUNET_YES;
1344     default:
1345       return GNUNET_NO;
1346     }
1347 }
1348
1349
1350 /**
1351  * Is this a namespace URI?
1352  *
1353  * @param uri the uri to check
1354  * @return GNUNET_YES if this is an SKS uri
1355  */
1356 int
1357 GNUNET_FS_uri_test_sks (const struct GNUNET_FS_Uri *uri)
1358 {
1359   return uri->type == sks;
1360 }
1361
1362
1363 /**
1364  * Get the ID of a namespace from the given
1365  * namespace URI.
1366  *
1367  * @param uri the uri to get the namespace ID from
1368  * @param nsid where to store the ID of the namespace
1369  * @return GNUNET_OK on success
1370  */
1371 int 
1372 GNUNET_FS_uri_sks_get_namespace (const struct GNUNET_FS_Uri *uri,
1373                                  GNUNET_HashCode * nsid)
1374 {
1375   if (! GNUNET_FS_uri_test_sks (uri))
1376     {
1377       GNUNET_break (0);
1378       return GNUNET_SYSERR;
1379     }
1380   *nsid = uri->data.sks.namespace;
1381   return GNUNET_OK;
1382 }
1383
1384
1385 /**
1386  * Get the content identifier of an SKS URI.
1387  *
1388  * @param uri the sks uri
1389  * @return NULL on error (not a valid SKS URI)
1390  */
1391 char *
1392 GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
1393 {
1394   if (!GNUNET_FS_uri_test_sks (uri))
1395     {
1396       GNUNET_break (0);
1397       return NULL;
1398     }
1399   return GNUNET_strdup (uri->data.sks.identifier);
1400 }
1401
1402
1403 /**
1404  * Convert namespace URI to a human readable format
1405  * (using the namespace description, if available).
1406  *
1407  * @param cfg configuration to use
1408  * @param uri SKS uri to convert
1409  * @return NULL on error (not an SKS URI)
1410  */
1411 char *
1412 GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
1413                                    const struct GNUNET_FS_Uri *uri)
1414 {
1415   char *ret;
1416   char *name;
1417
1418   if (uri->type != sks)
1419     return NULL;
1420   name = GNUNET_PSEUDONYM_id_to_name (cfg, &uri->data.sks.namespace);
1421   if (name == NULL)
1422     return GNUNET_FS_uri_to_string (uri);
1423   GNUNET_asprintf (&ret,
1424                    "%s: %s",
1425                    name,
1426                    uri->data.sks.identifier);
1427   GNUNET_free (name);
1428   return ret;
1429 }
1430
1431
1432 /**
1433  * Is this a keyword URI?
1434  *
1435  * @param uri the uri
1436  * @return GNUNET_YES if this is a KSK uri
1437  */
1438 int 
1439 GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
1440 {
1441 #if EXTRA_CHECKS
1442   unsigned int i;
1443
1444   if (uri->type == ksk)
1445     {
1446       for (i = uri->data.ksk.keywordCount - 1; i >= 0; i--)
1447         GNUNET_assert (uri->data.ksk.keywords[i] != NULL);
1448     }
1449 #endif
1450   return uri->type == ksk;
1451 }
1452
1453
1454 /**
1455  * Is this a file (or directory) URI?
1456  *
1457  * @param uri the uri to check
1458  * @return GNUNET_YES if this is a CHK uri
1459  */
1460 int 
1461 GNUNET_FS_uri_test_chk (const struct GNUNET_FS_Uri *uri)
1462 {
1463   return uri->type == chk;
1464 }
1465
1466
1467 /**
1468  * What is the size of the file that this URI
1469  * refers to?
1470  *
1471  * @param uri the CHK URI to inspect
1472  * @return size of the file as specified in the CHK URI
1473  */
1474 uint64_t 
1475 GNUNET_FS_uri_chk_get_file_size (const struct GNUNET_FS_Uri *uri)
1476 {
1477   switch (uri->type)
1478     {
1479     case chk:
1480       return GNUNET_ntohll (uri->data.chk.file_length);
1481     case loc:
1482       return GNUNET_ntohll (uri->data.loc.fi.file_length);
1483     default:
1484       GNUNET_assert (0);
1485     }
1486   return 0;                     /* unreachable */
1487 }
1488
1489
1490 /**
1491  * Is this a location URI?
1492  *
1493  * @param uri the uri to check
1494  * @return GNUNET_YES if this is a LOC uri
1495  */
1496 int 
1497 GNUNET_FS_uri_test_loc (const struct GNUNET_FS_Uri *uri)
1498 {
1499   return uri->type == loc;
1500 }
1501
1502
1503 /**
1504  * Function called on each value in the meta data.
1505  * Adds it to the URI.
1506  *
1507  * @param cls URI to update
1508  * @param plugin_name name of the plugin that produced this value;
1509  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
1510  *        used in the main libextractor library and yielding
1511  *        meta data).
1512  * @param type libextractor-type describing the meta data
1513  * @param format basic format information about data 
1514  * @param data_mime_type mime-type of data (not of the original file);
1515  *        can be NULL (if mime-type is not known)
1516  * @param data actual meta-data found
1517  * @param data_len number of bytes in data
1518  * @return 0 (always)
1519  */
1520 static int
1521 gather_uri_data (void *cls,
1522                  const char *plugin_name,
1523                  enum EXTRACTOR_MetaType type, 
1524                  enum EXTRACTOR_MetaFormat format,
1525                  const char *data_mime_type,
1526                  const char *data,
1527                  size_t data_len)
1528 {
1529   struct GNUNET_FS_Uri *uri = cls;
1530   char *nkword;
1531   int j;
1532   
1533   if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
1534        (format != EXTRACTOR_METAFORMAT_C_STRING) )
1535     return 0;
1536   for (j = uri->data.ksk.keywordCount - 1; j >= 0; j--)
1537     if (0 == strcmp (&uri->data.ksk.keywords[j][1], data))
1538       return GNUNET_OK;
1539   nkword = GNUNET_malloc (strlen (data) + 2);
1540   strcpy (nkword, " ");         /* not mandatory */
1541   strcat (nkword, data);
1542   uri->data.ksk.keywords[uri->data.ksk.keywordCount++] = nkword;
1543   return 0;
1544 }
1545
1546
1547 /**
1548  * Construct a keyword-URI from meta-data (take all entries
1549  * in the meta-data and construct one large keyword URI
1550  * that lists all keywords that can be found in the meta-data).
1551  *
1552  * @param md metadata to use
1553  * @return NULL on error, otherwise a KSK URI
1554  */
1555 struct GNUNET_FS_Uri *
1556 GNUNET_FS_uri_ksk_create_from_meta_data (const struct GNUNET_CONTAINER_MetaData *md)
1557 {
1558   struct GNUNET_FS_Uri *ret;
1559
1560   if (md == NULL)
1561     return NULL;
1562   ret = GNUNET_malloc (sizeof (struct GNUNET_FS_Uri));
1563   ret->type = ksk;
1564   ret->data.ksk.keywordCount = 0;
1565   ret->data.ksk.keywords = NULL;
1566   ret->data.ksk.keywords
1567     = GNUNET_malloc (sizeof (char *) *
1568                      GNUNET_CONTAINER_meta_data_iterate (md, NULL, NULL));
1569   GNUNET_CONTAINER_meta_data_iterate (md, &gather_uri_data, ret);
1570   return ret;
1571
1572 }
1573
1574
1575 /**
1576  * In URI-encoding, does the given character
1577  * need to be encoded using %-encoding?
1578  */
1579 static int
1580 needs_percent (char c)
1581 {
1582   return (!((isalnum ( (unsigned char) c)) ||
1583             (c == '-') || (c == '_') || (c == '.') || (c == '~')));
1584 }
1585
1586
1587 /**
1588  * Convert a KSK URI to a string.
1589  *
1590  * @param uri the URI to convert
1591  * @return NULL on error (i.e. keywordCount == 0)
1592  */
1593 static char *
1594 uri_ksk_to_string (const struct GNUNET_FS_Uri *uri)
1595 {
1596   char ** keywords; 
1597   unsigned int keywordCount;
1598   size_t n;
1599   char *ret;
1600   unsigned int i;
1601   unsigned int j;
1602   unsigned int wpos;
1603   size_t slen;
1604   const char *keyword;
1605
1606   if (uri->type != ksk)
1607     return NULL;
1608   keywords = uri->data.ksk.keywords;
1609   keywordCount = uri->data.ksk.keywordCount;
1610   n =
1611     keywordCount + strlen (GNUNET_FS_URI_PREFIX) +
1612     strlen (GNUNET_FS_URI_KSK_INFIX) + 1;
1613   for (i = 0; i < keywordCount; i++)
1614     {
1615       keyword = keywords[i];
1616       slen = strlen (keyword);
1617       n += slen;
1618       for (j = 0; j < slen; j++)
1619         {
1620           if ((j == 0) && (keyword[j] == ' '))
1621             {
1622               n--;
1623               continue;         /* skip leading space */
1624             }
1625           if (needs_percent (keyword[j]))
1626             n += 2;             /* will use %-encoding */
1627         }
1628     }
1629   ret = GNUNET_malloc (n);
1630   strcpy (ret, GNUNET_FS_URI_PREFIX);
1631   strcat (ret, GNUNET_FS_URI_KSK_INFIX);
1632   wpos = strlen (ret);
1633   for (i = 0; i < keywordCount; i++)
1634     {
1635       keyword = keywords[i];
1636       slen = strlen (keyword);
1637       for (j = 0; j < slen; j++)
1638         {
1639           if ((j == 0) && (keyword[j] == ' '))
1640             continue;           /* skip leading space */
1641           if (needs_percent (keyword[j]))
1642             {
1643               sprintf (&ret[wpos], "%%%02X", keyword[j]);
1644               wpos += 3;
1645             }
1646           else
1647             {
1648               ret[wpos++] = keyword[j];
1649             }
1650         }
1651       if (i != keywordCount - 1)
1652         ret[wpos++] = '+';
1653     }
1654   return ret;
1655 }
1656
1657
1658 /**
1659  * Convert SKS URI to a string.
1660  *
1661  * @param uri sks uri to convert
1662  * @return NULL on error
1663  */
1664 static char *
1665 uri_sks_to_string (const struct GNUNET_FS_Uri *uri)
1666 {
1667   const GNUNET_HashCode * namespace;
1668   const char *identifier;
1669   char *ret;
1670   struct GNUNET_CRYPTO_HashAsciiEncoded ns;
1671   
1672   if (uri->type != sks)
1673     return NULL;
1674   namespace = &uri->data.sks.namespace;
1675   identifier = uri->data.sks.identifier;
1676   GNUNET_CRYPTO_hash_to_enc (namespace, &ns);
1677   GNUNET_asprintf (&ret,
1678                    "%s%s%s/%s",
1679                    GNUNET_FS_URI_PREFIX, 
1680                    GNUNET_FS_URI_SKS_INFIX,
1681                    (const char *) &ns, identifier);
1682   return ret;
1683 }
1684
1685
1686 /**
1687  * Convert a CHK URI to a string.
1688  *
1689  * @param uri chk uri to convert
1690  * @return NULL on error
1691  */
1692 static char *
1693 uri_chk_to_string (const struct GNUNET_FS_Uri *uri)
1694 {
1695   const struct FileIdentifier * fi;
1696   char *ret;
1697   struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1698   struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1699
1700   if (uri->type != chk)
1701     return NULL;
1702   fi = &uri->data.chk;
1703   GNUNET_CRYPTO_hash_to_enc (&fi->chk.key, &keyhash);
1704   GNUNET_CRYPTO_hash_to_enc (&fi->chk.query, &queryhash);
1705
1706   GNUNET_asprintf (&ret,
1707                    "%s%s%s.%s.%llu",
1708                    GNUNET_FS_URI_PREFIX,
1709                    GNUNET_FS_URI_CHK_INFIX,
1710                    (const char *) &keyhash, 
1711                    (const char *) &queryhash,
1712                    GNUNET_ntohll (fi->file_length));
1713   return ret;
1714 }
1715
1716 /**
1717  * Convert binary data to a string.
1718  *
1719  * @param data binary data to convert
1720  * @param size number of bytes in data
1721  * @return converted data
1722  */
1723 static char *
1724 bin2enc (const void *data, size_t size)
1725 {
1726   /**
1727    * 64 characters for encoding, 6 bits per character
1728    */
1729   static char *tbl =
1730     "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_=";
1731   
1732   size_t len;
1733   size_t pos;
1734   unsigned int bits;
1735   unsigned int hbits;
1736   char *ret;
1737
1738   GNUNET_assert (strlen (tbl) == 64);
1739   len = size * 8 / 6;
1740   if (((size * 8) % 6) != 0)
1741     len++;
1742   ret = GNUNET_malloc (len + 1);
1743   ret[len] = '\0';
1744   len = 0;
1745   bits = 0;
1746   hbits = 0;
1747   for (pos = 0; pos < size; pos++)
1748     {
1749       bits |= ((((const unsigned char *) data)[pos]) << hbits);
1750       hbits += 8;
1751       while (hbits >= 6)
1752         {
1753           ret[len++] = tbl[bits & 63];
1754           bits >>= 6;
1755           hbits -= 6;
1756         }
1757     }
1758   if (hbits > 0)
1759     ret[len++] = tbl[bits & 63];
1760   return ret;
1761 }
1762
1763
1764 /**
1765  * Convert a LOC URI to a string.
1766  *
1767  * @param uri loc uri to convert
1768  * @return NULL on error
1769  */
1770 static char *
1771 uri_loc_to_string (const struct GNUNET_FS_Uri *uri)
1772 {
1773   char *ret;
1774   struct GNUNET_CRYPTO_HashAsciiEncoded keyhash;
1775   struct GNUNET_CRYPTO_HashAsciiEncoded queryhash;
1776   char *peerId;
1777   char *peerSig;
1778
1779   GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.key, &keyhash);
1780   GNUNET_CRYPTO_hash_to_enc (&uri->data.loc.fi.chk.query, &queryhash);
1781   peerId = bin2enc (&uri->data.loc.peer,
1782                     sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
1783   peerSig = bin2enc (&uri->data.loc.contentSignature, 
1784                      sizeof (struct GNUNET_CRYPTO_RsaSignature));
1785   GNUNET_asprintf (&ret,
1786                    "%s%s%s.%s.%llu.%s.%s.%llu",
1787                    GNUNET_FS_URI_PREFIX,
1788                    GNUNET_FS_URI_LOC_INFIX,
1789                    (const char *) &keyhash,
1790                    (const char *) &queryhash,
1791                    (unsigned long long) GNUNET_ntohll (uri->data.loc.fi.file_length),
1792                    peerId,
1793                    peerSig,
1794                    (unsigned long long) uri->data.loc.expirationTime.value);
1795   GNUNET_free (peerSig);
1796   GNUNET_free (peerId);
1797   return ret;
1798 }
1799
1800
1801 /**
1802  * Convert a URI to a UTF-8 String.
1803  *
1804  * @param uri uri to convert to a string
1805  * @return the UTF-8 string
1806  */
1807 char *
1808 GNUNET_FS_uri_to_string (const struct GNUNET_FS_Uri *uri)
1809 {
1810   if (uri == NULL)
1811     {
1812       GNUNET_break (0);
1813       return NULL;
1814     }
1815   switch (uri->type)
1816     {
1817     case ksk:
1818       return uri_ksk_to_string (uri);
1819     case sks:
1820       return uri_sks_to_string (uri);
1821     case chk:
1822       return uri_chk_to_string (uri);
1823     case loc:
1824       return uri_loc_to_string (uri);
1825     default:
1826       GNUNET_break (0);
1827       return NULL;
1828     }
1829 }
1830
1831 /* end of fs_uri.c */