GNUnet  0.19.2
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 "platform.h"
27 #include "messenger_api_room.h"
28 
29 #include "messenger_api_handle.h"
30 
33  const struct GNUNET_HashCode *key)
34 {
35  GNUNET_assert((handle) && (key));
36 
38 
39  room->handle = handle;
40  GNUNET_memcpy(&(room->key), key, sizeof(*key));
41 
42  room->opened = GNUNET_NO;
43  room->contact_id = NULL;
44 
45  init_list_tunnels (&(room->entries));
46 
49 
50  return room;
51 }
52 
53 static int
55  const struct GNUNET_HashCode *key,
56  void *value)
57 {
59 
60  destroy_message (entry->message);
61  GNUNET_free(entry);
62 
63  return GNUNET_YES;
64 }
65 
66 void
68 {
69  GNUNET_assert(room);
70 
71  clear_list_tunnels (&(room->entries));
72 
73  if (room->messages)
74  {
76 
78  }
79 
80  if (room->members)
82 
83  if (room->contact_id)
84  GNUNET_free(room->contact_id);
85 
86  GNUNET_free(room);
87 }
88 
89 const struct GNUNET_MESSENGER_Message*
91  const struct GNUNET_HashCode *hash)
92 {
93  GNUNET_assert((room) && (hash));
94 
96  room->messages, hash
97  );
98 
99  return (entry? entry->message : NULL);
100 }
101 
104  const struct GNUNET_HashCode *hash)
105 {
106  GNUNET_assert((room) && (hash));
107 
109  room->messages, hash
110  );
111 
112  return (entry? entry->sender : NULL);
113 }
114 
115 static struct GNUNET_MESSENGER_Contact*
117  struct GNUNET_MESSENGER_Contact *sender,
118  const struct GNUNET_MESSENGER_Message *message,
119  const struct GNUNET_HashCode *hash)
120 {
121  if (!sender)
122  {
124  struct GNUNET_HashCode context;
125 
126  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
127 
128  sender = get_store_contact(store, &context, &(message->body.join.key));
129  }
130 
134  increase_contact_rc(sender);
135 
136  return sender;
137 }
138 
139 static void
141  struct GNUNET_MESSENGER_Contact *sender,
142  const struct GNUNET_MESSENGER_Message *message,
143  const struct GNUNET_HashCode *hash)
144 {
145  if ((!sender) ||
147  return;
148 
149  struct GNUNET_HashCode context;
150  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
151 
152  if (GNUNET_YES == decrease_contact_rc(sender))
153  GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "A contact does not share any room with you anymore!\n");
154 }
155 
156 static void
158  struct GNUNET_MESSENGER_Contact *sender,
159  const struct GNUNET_MESSENGER_Message *message,
160  const struct GNUNET_HashCode *hash)
161 {
162  if (!sender)
163  return;
164 
165  set_contact_name (sender, message->body.name.name);
166 }
167 
168 static void
170  struct GNUNET_MESSENGER_Contact *sender,
171  const struct GNUNET_MESSENGER_Message *message,
172  const struct GNUNET_HashCode *hash)
173 {
174  if (!sender)
175  return;
176 
177  struct GNUNET_HashCode context;
178  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
179 
181 
182  update_store_contact(store, sender, &context, &context, &(message->body.key.key));
183 }
184 
185 static void
187  struct GNUNET_MESSENGER_Contact *sender,
188  const struct GNUNET_MESSENGER_Message *message,
189  const struct GNUNET_HashCode *hash)
190 {
191  if ((!sender) ||
192  (GNUNET_YES != GNUNET_CONTAINER_multishortmap_remove(room->members, &(message->header.sender_id), sender)) ||
193  (GNUNET_OK != GNUNET_CONTAINER_multishortmap_put(room->members, &(message->body.id.id), sender,
195  return;
196 
197  struct GNUNET_HashCode context, next_context;
198  get_context_from_member(&(room->key), &(message->header.sender_id), &context);
199  get_context_from_member(&(room->key), &(message->body.id.id), &next_context);
200 
202 
203  update_store_contact(store, sender, &context, &next_context, get_contact_key(sender));
204 }
205 
206 static void
208  struct GNUNET_MESSENGER_Contact *sender,
209  const struct GNUNET_MESSENGER_Message *message,
210  const struct GNUNET_HashCode *hash)
211 {
212  if ((room->contact_id) && (0 == GNUNET_memcmp(&(message->header.sender_id), room->contact_id)))
213  {
214  struct GNUNET_MESSENGER_ListTunnel *match = find_list_tunnels (&(room->entries), &(message->body.miss.peer), NULL);
215 
216  if (match)
217  remove_from_list_tunnels (&(room->entries), match);
218  }
219 }
220 
221 static void
223  struct GNUNET_MESSENGER_Contact *sender,
224  const struct GNUNET_MESSENGER_Message *message,
225  const struct GNUNET_HashCode *hash)
226 {
228  room->messages, &(message->body.deletion.hash)
229  );
230 
231  if ((entry) && ((entry->sender == sender) || (get_handle_contact (room->handle, &(room->key)) == sender)) &&
233  {
234  destroy_message (entry->message);
235  GNUNET_free(entry);
236  }
237 }
238 
241  struct GNUNET_MESSENGER_Contact *sender,
242  const struct GNUNET_MESSENGER_Message *message,
243  const struct GNUNET_HashCode *hash)
244 {
246  return sender;
247 
248  switch (message->header.kind)
249  {
251  sender = handle_join_message (room, sender, message, hash);
252  break;
254  handle_leave_message (room, sender, message, hash);
255  break;
257  handle_name_message (room, sender, message, hash);
258  break;
260  handle_key_message (room, sender, message, hash);
261  break;
263  handle_id_message (room, sender, message, hash);
264  break;
266  handle_miss_message (room, sender, message, hash);
267  break;
269  handle_delete_message (room, sender, message, hash);
270  break;
271  default:
272  break;
273  }
274 
276 
277  if (!entry)
278  return sender;
279 
280  entry->sender = sender;
281  entry->message = copy_message (message);
282 
283  if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (room->messages, hash, entry,
285  {
286  destroy_message (entry->message);
287  GNUNET_free(entry);
288  }
289 
290  return sender;
291 }
292 
294 {
297  void *cls;
298 };
299 
300 static int
302  const struct GNUNET_ShortHashCode *key,
303  void *value)
304 {
306  struct GNUNET_MESSENGER_Contact *contact = value;
307 
308  return call->callback(call->cls, call->room, contact);
309 }
310 
311 int
314  void* cls)
315 {
316  GNUNET_assert(room);
317 
318  if (!callback)
319  return GNUNET_CONTAINER_multishortmap_iterate(room->members, NULL, NULL);
320 
322 
323  call.room = room;
324  call.callback = callback;
325  call.cls = cls;
326 
328 
330 }
331 
333 {
335  int result;
336 };
337 
338 static int
340  const struct GNUNET_ShortHashCode *key,
341  void *value)
342 {
343  struct GNUNET_MESSENGER_MemberFind *find = cls;
344  struct GNUNET_MESSENGER_Contact *contact = value;
345 
346  if (contact == find->contact)
347  {
348  find->result = GNUNET_YES;
349  return GNUNET_NO;
350  }
351 
352  return GNUNET_YES;
353 }
354 
355 int
357  const struct GNUNET_MESSENGER_Contact *contact)
358 {
359  GNUNET_assert(room);
360 
361  struct GNUNET_MESSENGER_MemberFind find;
362 
363  find.contact = contact;
364  find.result = GNUNET_NO;
365 
367 
368  return find.result;
369 }
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.
enum GNUNET_GenericReturnValue 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).
enum GNUNET_GenericReturnValue 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.
enum GNUNET_GenericReturnValue 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.
enum GNUNET_GenericReturnValue 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.
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_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).
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_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
@ GNUNET_YES
@ GNUNET_NO
#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.