template for the dns-block
[oweals/gnunet.git] / src / block / plugin_block_dns.c
1 /*
2      This file is part of GNUnet
3      (C) 2010 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 block/plugin_block_dns.c
23  * @brief block plugin for storing .gnunet-bindings
24  * @author Philipp Tölke
25  */
26
27 #include "platform.h"
28 #include "plugin_block.h"
29
30 #define DEBUG_DHT GNUNET_NO
31
32 /**
33  * Function called to validate a reply or a request.  For
34  * request evaluation, simply pass "NULL" for the reply_block.
35  *
36  * @param cls closure
37  * @param type block type
38  * @param query original query (hash)
39  * @param bf pointer to bloom filter associated with query; possibly updated (!)
40  * @param bf_mutator mutation value for bf
41  * @param xquery extended query data (can be NULL, depending on type)
42  * @param xquery_size number of bytes in xquery
43  * @param reply_block response to validate
44  * @param reply_block_size number of bytes in reply block
45  * @return characterization of result
46  */
47 static enum GNUNET_BLOCK_EvaluationResult
48 block_plugin_dht_evaluate (void *cls,
49                            enum GNUNET_BLOCK_Type type,
50                            const GNUNET_HashCode *query,
51                            struct GNUNET_CONTAINER_BloomFilter **bf,
52                            int32_t bf_mutator,
53                            const void *xquery,
54                            size_t xquery_size,
55                            const void *reply_block,
56                            size_t reply_block_size)
57 {
58   switch (type)
59   {
60   case GNUNET_BLOCK_TYPE_DNS:
61     if (xquery_size != 0)
62       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
63     if (reply_block_size == 0)
64       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
65     return GNUNET_BLOCK_EVALUATION_OK_LAST;
66   default:
67     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
68   }
69 }
70
71
72 /**
73  * Function called to obtain the key for a block.
74  *
75  * @param cls closure
76  * @param type block type
77  * @param block block to get the key for
78  * @param block_size number of bytes in block
79  * @param key set to the key (query) for the given block
80  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
81  *         (or if extracting a key from a block of this type does not work)
82  */
83 static int
84 block_plugin_dht_get_key (void *cls,
85                           enum GNUNET_BLOCK_Type type,
86                           const void *block,
87                           size_t block_size,
88                           GNUNET_HashCode *key)
89 {
90   if (type != GNUNET_BLOCK_TYPE_DNS)
91     return GNUNET_SYSERR;
92   return GNUNET_SYSERR;
93 }
94
95 /**
96  * Entry point for the plugin.
97  */
98 void *
99 libgnunet_plugin_block_dht_init (void *cls)
100 {
101   static enum GNUNET_BLOCK_Type types[] = 
102     {
103       GNUNET_BLOCK_TYPE_DNS,
104       GNUNET_BLOCK_TYPE_ANY /* end of list */
105     };
106   struct GNUNET_BLOCK_PluginFunctions *api;
107
108   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
109   api->evaluate = &block_plugin_dht_evaluate;
110   api->get_key = &block_plugin_dht_get_key;
111   api->types = types;
112   return api;
113 }
114
115
116 /**
117  * Exit point from the plugin.
118  */
119 void *
120 libgnunet_plugin_block_dht_done (void *cls)
121 {
122   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
123
124   GNUNET_free (api);
125   return NULL;
126 }
127
128 /* end of plugin_block_dns.c */