GNUnet  0.11.x
messenger_api_room.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2020--2021 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your 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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
26 #include "messenger_api_room.h"
27 
28 #include "messenger_api_handle.h"
29 
32 {
33  GNUNET_assert((handle) && (key));
34 
36 
37  room->handle = handle;
38  GNUNET_memcpy(&(room->key), key, sizeof(*key));
39 
40  room->opened = GNUNET_NO;
41  room->contact_id = NULL;
42 
43  init_list_tunnels (&(room->entries));
44 
47 
48  return room;
49 }
50 
51 static int
52 iterate_destroy_message (void *cls, const struct GNUNET_HashCode *key, void *value)
53 {
55 
56  destroy_message (entry->message);
57  GNUNET_free(entry);
58 
59  return GNUNET_YES;
60 }
61 
62 void
64 {
65  GNUNET_assert(room);
66 
67  clear_list_tunnels (&(room->entries));
68 
69  if (room->messages)
70  {
72 
74  }
75 
76  if (room->members)
78 
79  if (room->contact_id)
80  GNUNET_free(room->contact_id);
81 
82  GNUNET_free(room);
83 }
84 
85 const struct GNUNET_MESSENGER_Message*
86 get_room_message (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash)
87 {
88  GNUNET_assert((room) && (hash));
89 
91  room->messages, hash
92  );
93 
94  return (entry? entry->message : NULL);
95 }
96 
98 get_room_sender (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash)
99 {
100  GNUNET_assert((room) && (hash));
101 
103  room->messages, hash
104  );
105 
106  return (entry? entry->sender : NULL);
107 }
108 
109 static struct GNUNET_MESSENGER_Contact*
111  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
112 {
113  if (!sender)
114  {
116  struct GNUNET_HashCode context;
117 
118  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
119 
120  sender = get_store_contact(store, &context, &(message->body.join.key));
121  }
122 
126  increase_contact_rc(sender);
127 
128  return sender;
129 }
130 
131 static void
133  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
134 {
135  if ((!sender) ||
137  return;
138 
139  struct GNUNET_HashCode context;
140  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
141 
142  if (GNUNET_YES == decrease_contact_rc(sender))
143  GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "A contact does not share any room with you anymore!\n");
144 }
145 
146 static void
148  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
149 {
150  if (!sender)
151  return;
152 
153  set_contact_name (sender, message->body.name.name);
154 }
155 
156 static void
158  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
159 {
160  if (!sender)
161  return;
162 
163  struct GNUNET_HashCode context;
164  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
165 
167 
168  update_store_contact(store, sender, &context, &context, &(message->body.key.key));
169 }
170 
171 static void
173  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
174 {
175  if ((!sender) ||
176  (GNUNET_YES != GNUNET_CONTAINER_multishortmap_remove(room->members, &(message->header.sender_id), sender)) ||
177  (GNUNET_OK != GNUNET_CONTAINER_multishortmap_put(room->members, &(message->body.id.id), sender,
179  return;
180 
181  struct GNUNET_HashCode context, next_context;
182  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
183  get_context_from_member(&(room->key), &(message->body.id.id), &next_context);
184 
186 
187  update_store_contact(store, sender, &context, &next_context, get_contact_key(sender));
188 }
189 
190 static void
192  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
193 {
194  if ((room->contact_id) && (0 == GNUNET_memcmp(&(message->header.sender_id), room->contact_id)))
195  {
196  struct GNUNET_MESSENGER_ListTunnel *match = find_list_tunnels (&(room->entries), &(message->body.miss.peer), NULL);
197 
198  if (match)
199  remove_from_list_tunnels (&(room->entries), match);
200  }
201 }
202 
203 static void
205  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
206 {
208  room->messages, &(message->body.deletion.hash)
209  );
210 
211  if ((entry) && ((entry->sender == sender) || (get_handle_contact (room->handle, &(room->key)) == sender)) &&
213  {
214  destroy_message (entry->message);
215  GNUNET_free(entry);
216  }
217 }
218 
221  const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
222 {
224  return sender;
225 
226  switch (message->header.kind)
227  {
229  sender = handle_join_message (room, sender, message, hash);
230  break;
232  handle_leave_message (room, sender, message, hash);
233  break;
235  handle_name_message (room, sender, message, hash);
236  break;
238  handle_key_message (room, sender, message, hash);
239  break;
241  handle_id_message (room, sender, message, hash);
242  break;
244  handle_miss_message (room, sender, message, hash);
245  break;
247  handle_delete_message (room, sender, message, hash);
248  break;
249  default:
250  break;
251  }
252 
254 
255  if (!entry)
256  return sender;
257 
258  entry->sender = sender;
259  entry->message = copy_message (message);
260 
261  if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (room->messages, hash, entry,
263  {
264  destroy_message (entry->message);
265  GNUNET_free(entry);
266  }
267 
268  return sender;
269 }
270 
272 {
275  void *cls;
276 };
277 
278 static int
279 iterate_local_members (void* cls, const struct GNUNET_ShortHashCode *key, void *value)
280 {
282  struct GNUNET_MESSENGER_Contact *contact = value;
283 
284  return call->callback(call->cls, call->room, contact);
285 }
286 
287 int
289  void* cls)
290 {
291  GNUNET_assert(room);
292 
293  if (!callback)
294  return GNUNET_CONTAINER_multishortmap_iterate(room->members, NULL, NULL);
295 
297 
298  call.room = room;
299  call.callback = callback;
300  call.cls = cls;
301 
303 
305 }
306 
308 {
310  int result;
311 };
312 
313 static int
314 iterate_find_member (void* cls, const struct GNUNET_ShortHashCode *key, void *value)
315 {
316  struct GNUNET_MESSENGER_MemberFind *find = cls;
317  struct GNUNET_MESSENGER_Contact *contact = value;
318 
319  if (contact == find->contact)
320  {
321  find->result = GNUNET_YES;
322  return GNUNET_NO;
323  }
324 
325  return GNUNET_YES;
326 }
327 
328 int
329 find_room_member (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_MESSENGER_Contact *contact)
330 {
331  GNUNET_assert(room);
332 
333  struct GNUNET_MESSENGER_MemberFind find;
334 
335  find.contact = contact;
336  find.result = GNUNET_NO;
337 
339 
340  return find.result;
341 }
static struct GNUNET_CONVERSATION_Call * call
Call handle (for active outgoing call).
struct GNUNET_HashCode key
The key used in the DHT.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
static pa_context * context
Pulseaudio context.
static char * value
Value of the record to add/remove.
#define GNUNET_log(kind,...)
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_YES
Definition: gnunet_common.h:97
@ GNUNET_NO
Definition: gnunet_common.h:94
int GNUNET_CONTAINER_multihashmap_contains(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Check if the map contains any value under the given key (including values that are NULL).
int GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
int GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
int GNUNET_CONTAINER_multishortmap_iterate(struct GNUNET_CONTAINER_MultiShortmap *map, GNUNET_CONTAINER_ShortmapIterator it, void *it_cls)
Iterate over all entries in the map.
int GNUNET_CONTAINER_multishortmap_contains_value(const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, const void *value)
Check if the map contains the given value under the given key.
struct GNUNET_CONTAINER_MultiShortmap * GNUNET_CONTAINER_multishortmap_create(unsigned int len, int do_not_copy_keys)
Create a multi peer map (hash map for public keys of peers).
int GNUNET_CONTAINER_multishortmap_put(struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
void GNUNET_CONTAINER_multishortmap_destroy(struct GNUNET_CONTAINER_MultiShortmap *map)
Destroy a hash map.
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.
int GNUNET_CONTAINER_multishortmap_remove(struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, const void *value)
Remove the given key-value pair from the map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE
Allow multiple values with the same key.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
int(* GNUNET_MESSENGER_MemberCallback)(void *cls, struct GNUNET_MESSENGER_Room *room, const struct GNUNET_MESSENGER_Contact *contact)
Method called for each member in a room during iteration.
@ GNUNET_MESSENGER_KIND_MISS
The miss kind.
@ GNUNET_MESSENGER_KIND_NAME
The name kind.
@ GNUNET_MESSENGER_KIND_LEAVE
The leave kind.
@ GNUNET_MESSENGER_KIND_KEY
The key kind.
@ GNUNET_MESSENGER_KIND_JOIN
The join kind.
@ GNUNET_MESSENGER_KIND_DELETE
The delete kind.
@ GNUNET_MESSENGER_KIND_ID
The id kind.
void set_contact_name(struct GNUNET_MESSENGER_Contact *contact, const char *name)
Changes the current name of a given contact by copying it from the parameter name.
int decrease_contact_rc(struct GNUNET_MESSENGER_Contact *contact)
Decreases the reference counter if possible (can not underflow!) of a given contact and returns GNUNE...
void increase_contact_rc(struct GNUNET_MESSENGER_Contact *contact)
Increases the reference counter of a given contact which is zero as default.
void get_context_from_member(const struct GNUNET_HashCode *key, const struct GNUNET_ShortHashCode *id, struct GNUNET_HashCode *context)
Calculates the context hash of a member in a room and returns it.
const struct GNUNET_IDENTITY_PublicKey * get_contact_key(const struct GNUNET_MESSENGER_Contact *contact)
Returns the public key of a given contact.
struct GNUNET_MESSENGER_Contact * get_store_contact(struct GNUNET_MESSENGER_ContactStore *store, const struct GNUNET_HashCode *context, const struct GNUNET_IDENTITY_PublicKey *pubkey)
Returns a contact using a specific public key.
void update_store_contact(struct GNUNET_MESSENGER_ContactStore *store, struct GNUNET_MESSENGER_Contact *contact, const struct GNUNET_HashCode *context, const struct GNUNET_HashCode *next_context, const struct GNUNET_IDENTITY_PublicKey *pubkey)
Moves a contact from the store to another location matching a given public key and member context.
struct GNUNET_MESSENGER_Contact * get_handle_contact(struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
Returns the contact of a given handle in a room identified by a given key.
struct GNUNET_MESSENGER_ContactStore * get_handle_contact_store(struct GNUNET_MESSENGER_Handle *handle)
Returns the used contact store of a given handle.
messenger api: client implementation of GNUnet MESSENGER service
void init_list_tunnels(struct GNUNET_MESSENGER_ListTunnels *tunnels)
Initializes list of tunnels peer identities as empty list.
struct GNUNET_MESSENGER_ListTunnel * remove_from_list_tunnels(struct GNUNET_MESSENGER_ListTunnels *tunnels, struct GNUNET_MESSENGER_ListTunnel *element)
Removes a specific element from the list of tunnels peer identities and returns the next element in t...
struct GNUNET_MESSENGER_ListTunnel * find_list_tunnels(struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer, size_t *index)
Searches linearly through the list of tunnels peer identities for matching a specific peer identity a...
void clear_list_tunnels(struct GNUNET_MESSENGER_ListTunnels *tunnels)
Clears the list of tunnels peer identities.
struct GNUNET_MESSENGER_Message * copy_message(const struct GNUNET_MESSENGER_Message *message)
Creates and allocates a copy of a given message.
void destroy_message(struct GNUNET_MESSENGER_Message *message)
Destroys a message and frees its memory fully.
static struct GNUNET_MESSENGER_Contact * handle_join_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
static int iterate_local_members(void *cls, const struct GNUNET_ShortHashCode *key, void *value)
static void handle_key_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
static void handle_delete_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
static int iterate_find_member(void *cls, const struct GNUNET_ShortHashCode *key, void *value)
static void handle_leave_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
struct GNUNET_MESSENGER_Contact * handle_room_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
Handles a message with a given hash in a room for the client API to update members and its informatio...
struct GNUNET_MESSENGER_Contact * get_room_sender(const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash)
Returns a messages sender locally stored from a map for a given hash in a room.
const struct GNUNET_MESSENGER_Message * get_room_message(const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash)
Returns a message locally stored from a map for a given hash in a room.
static int iterate_destroy_message(void *cls, const struct GNUNET_HashCode *key, void *value)
int find_room_member(const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_MESSENGER_Contact *contact)
Checks through all members of a given room if a specific contact is found and returns a result depend...
struct GNUNET_MESSENGER_Room * create_room(struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
Creates and allocates a new room for a handle with a given key for the client API.
static void handle_id_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
static void handle_name_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
int iterate_room_members(struct GNUNET_MESSENGER_Room *room, GNUNET_MESSENGER_MemberCallback callback, void *cls)
Iterates through all members of a given room to forward each of them to a selected callback with a cu...
void destroy_room(struct GNUNET_MESSENGER_Room *room)
Destroys a room and frees its memory fully from the client API.
static void handle_miss_message(struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
messenger api: client implementation of GNUnet MESSENGER service
A 512-bit hashcode.
GNUNET_MESSENGER_MemberCallback callback
struct GNUNET_MESSENGER_Room * room
const struct GNUNET_MESSENGER_Contact * contact
struct GNUNET_MESSENGER_MessageId id
struct GNUNET_MESSENGER_MessageName name
struct GNUNET_MESSENGER_MessageKey key
struct GNUNET_MESSENGER_MessageMiss miss
struct GNUNET_MESSENGER_MessageJoin join
struct GNUNET_MESSENGER_MessageDelete deletion
struct GNUNET_HashCode hash
The hash of the message to delete.
enum GNUNET_MESSENGER_MessageKind kind
The kind of the message.
struct GNUNET_ShortHashCode sender_id
The senders id inside of the room the message was sent in.
struct GNUNET_ShortHashCode id
The new id which will replace the senders id in a room.
struct GNUNET_IDENTITY_PublicKey key
The senders public key to verify its signatures.
struct GNUNET_IDENTITY_PublicKey key
The new public key which replaces the current senders public key.
struct GNUNET_PeerIdentity peer
The peer identity of a disconnected door to a room.
char * name
The new name which replaces the current senders name.
struct GNUNET_MESSENGER_MessageHeader header
Header.
struct GNUNET_MESSENGER_MessageBody body
Body.
struct GNUNET_MESSENGER_Message * message
struct GNUNET_MESSENGER_Contact * sender
struct GNUNET_MESSENGER_Handle * handle
struct GNUNET_CONTAINER_MultiShortmap * members
struct GNUNET_CONTAINER_MultiHashMap * messages
struct GNUNET_MESSENGER_ListTunnels entries
struct GNUNET_ShortHashCode * contact_id
struct GNUNET_HashCode key
A 256-bit hashcode.