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