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