GNUnet 0.21.0
gnunet-service-messenger_member_store.c
Go to the documentation of this file.
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2020--2024 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"
28
32
34
35void
37 struct GNUNET_MESSENGER_SrvRoom *room)
38{
39 GNUNET_assert ((store) && (room));
40
41 store->room = room;
43}
44
45
48 const struct GNUNET_ShortHashCode *key,
49 void *value)
50{
51 struct GNUNET_MESSENGER_Member *member = value;
52 destroy_member (member);
53 return GNUNET_YES;
54}
55
56
57void
59{
61
62 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Clear member store of room: %s\n",
64
68}
69
70
73{
74 GNUNET_assert ((store) && (store->room));
75
76 struct GNUNET_MESSENGER_SrvRoom *room = store->room;
77
79}
80
81
82const struct GNUNET_HashCode*
84{
85 GNUNET_assert (store);
86
87 return get_srv_room_key ((const struct
89}
90
91
94 const char *filename)
95{
96 struct GNUNET_MESSENGER_MemberStore *store = cls;
97
99 {
100 char *directory;
101
102 GNUNET_asprintf (&directory, "%s%c", filename, DIR_SEPARATOR);
103
104 load_member (store, directory);
105
106 GNUNET_free (directory);
107 }
108
109 return GNUNET_OK;
110}
111
112
115 const struct GNUNET_ShortHashCode *id,
116 void *value)
117{
118 const char *sync_dir = cls;
119
120 struct GNUNET_MESSENGER_Member *member = value;
121
122 if (! member)
123 return GNUNET_YES;
124
125 char *member_dir;
126 GNUNET_asprintf (&member_dir, "%s%s%c", sync_dir, GNUNET_sh2s (id),
128
130 load_member_next_sessions (member, member_dir);
131
132 GNUNET_free (member_dir);
133 return GNUNET_YES;
134}
135
136
139 const struct GNUNET_ShortHashCode *id,
140 void *value)
141{
142 struct GNUNET_MESSENGER_Member *member = value;
143
144 if (! member)
145 return GNUNET_YES;
146
147 sync_member_contacts (member);
148 return GNUNET_YES;
149}
150
151
152void
154 const char *directory)
155{
156 GNUNET_assert ((store) && (directory));
157
158 char *scan_dir;
159 GNUNET_asprintf (&scan_dir, "%s%s%c", directory, "members", DIR_SEPARATOR);
160
161 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Load member store from directory: %s\n",
162 scan_dir);
163
166
169 scan_dir);
172
174}
175
176
179 const struct GNUNET_ShortHashCode *id,
180 void *value)
181{
182 const char *save_dir = cls;
183
184 struct GNUNET_MESSENGER_Member *member = value;
185
186 if (! member)
187 return GNUNET_YES;
188
189 char *member_dir;
190 GNUNET_asprintf (&member_dir, "%s%s%c", save_dir, GNUNET_sh2s (id),
192
193 if ((GNUNET_YES == GNUNET_DISK_directory_test (member_dir, GNUNET_NO)) ||
194 (GNUNET_OK == GNUNET_DISK_directory_create (member_dir)))
195 save_member (member, member_dir);
196
197 GNUNET_free (member_dir);
198 return GNUNET_YES;
199}
200
201
202void
204 const char *directory)
205{
206 GNUNET_assert ((store) && (directory));
207
208 char *save_dir;
209 GNUNET_asprintf (&save_dir, "%s%s%c", directory, "members", DIR_SEPARATOR);
210
211 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Save member store to directory: %s\n",
212 save_dir);
213
214 if ((GNUNET_YES == GNUNET_DISK_directory_test (save_dir, GNUNET_NO)) ||
217 iterate_save_members, save_dir);
218
219 GNUNET_free (save_dir);
220}
221
222
225 const struct GNUNET_ShortHashCode *id)
226{
227 GNUNET_assert ((store) && (store->members) && (id));
228
230}
231
232
235 const struct GNUNET_MESSENGER_Message *message)
236{
237 GNUNET_assert ((store) && (message));
238
239 if (GNUNET_YES == is_peer_message (message))
240 return NULL;
241
242 if (GNUNET_MESSENGER_KIND_JOIN == message->header.kind)
243 return add_store_member (store, &(message->header.sender_id));
244 else
245 return get_store_member (store, &(message->header.sender_id));
246}
247
248
251 const struct GNUNET_ShortHashCode *id)
252{
254
255 struct GNUNET_MESSENGER_Member *member = id? get_store_member (store, id) :
256 NULL;
257
258 if (member)
259 return member;
260
261 member = create_member (store, id);
262
263 if (! member)
264 return NULL;
265
267 get_member_id (member),
268 member,
270 {
271 destroy_member (member);
272 return NULL;
273 }
274
275 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added store member with id: %s\n",
276 GNUNET_sh2s (get_member_id (member)));
277
278 return member;
279}
280
281
283{
285 void *cls;
286};
287
288static int
290 const struct GNUNET_ShortHashCode *key,
291 void *value)
292{
294 struct GNUNET_MESSENGER_Member *member = value;
295
296 return iterate_member_sessions (member, iterate->it, iterate->cls);
297}
298
299
300int
303 void *cls)
304{
305 GNUNET_assert ((store) && (store->members) && (it));
306
308
309 iterate.it = it;
310 iterate.cls = cls;
311
314 &iterate);
315}
struct GNUNET_HashCode key
The key used in the DHT.
static char * filename
static char * value
Value of the record to add/remove.
const struct GNUNET_ShortHashCode * get_member_id(const struct GNUNET_MESSENGER_Member *member)
Returns the current id of a given member.
void save_member(struct GNUNET_MESSENGER_Member *member, const char *directory)
Saves data from a member into a directory which can be load to restore the member completely.
void destroy_member(struct GNUNET_MESSENGER_Member *member)
Destroys a member and frees its memory fully.
struct GNUNET_MESSENGER_Member * create_member(struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
Creates and allocates a new member of a room with an optionally defined or random id.
void load_member_next_sessions(const struct GNUNET_MESSENGER_Member *member, const char *directory)
Loads data about next sessions from a directory into an empty loaded member which does not contain a ...
void sync_member_contacts(struct GNUNET_MESSENGER_Member *member)
Synchronizes contacts between all sessions from a given member and other sessions which are linked to...
int iterate_member_sessions(struct GNUNET_MESSENGER_Member *member, GNUNET_MESSENGER_MemberIteratorCallback it, void *cls)
Iterate through all member sessions currently connected to a given member and call the provided itera...
void load_member(struct GNUNET_MESSENGER_MemberStore *store, const char *directory)
Loads data from a directory into a new allocated and created member of a store if the required inform...
static enum GNUNET_GenericReturnValue callback_scan_for_members(void *cls, const char *filename)
static enum GNUNET_GenericReturnValue iterate_load_next_member_sessions(void *cls, const struct GNUNET_ShortHashCode *id, void *value)
struct GNUNET_MESSENGER_ContactStore * get_member_contact_store(struct GNUNET_MESSENGER_MemberStore *store)
Returns the used contact store of a given member store.
struct GNUNET_MESSENGER_Member * get_store_member_of(struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_MESSENGER_Message *message)
Returns the member of a store using a sender id of a given message.
int iterate_store_members(struct GNUNET_MESSENGER_MemberStore *store, GNUNET_MESSENGER_MemberIteratorCallback it, void *cls)
Iterate through all member sessions currently connected to the members of the given member store and ...
void save_member_store(struct GNUNET_MESSENGER_MemberStore *store, const char *directory)
Saves members from a member store into a directory.
void load_member_store(struct GNUNET_MESSENGER_MemberStore *store, const char *directory)
Loads members from a directory into a member store.
static enum GNUNET_GenericReturnValue iterate_destroy_members(void *cls, const struct GNUNET_ShortHashCode *key, void *value)
const struct GNUNET_HashCode * get_member_store_key(const struct GNUNET_MESSENGER_MemberStore *store)
Returns the shared secret you need to access a room of the store.
static enum GNUNET_GenericReturnValue iterate_sync_member_contacts(void *cls, const struct GNUNET_ShortHashCode *id, void *value)
static int iterate_store_members_it(void *cls, const struct GNUNET_ShortHashCode *key, void *value)
struct GNUNET_MESSENGER_Member * add_store_member(struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
Adds a member to a store under a specific id and returns it on success.
void init_member_store(struct GNUNET_MESSENGER_MemberStore *store, struct GNUNET_MESSENGER_SrvRoom *room)
Initializes a member store as fully empty connected to a room.
void clear_member_store(struct GNUNET_MESSENGER_MemberStore *store)
Clears a member store, wipes its content and deallocates its memory.
static enum GNUNET_GenericReturnValue iterate_save_members(void *cls, const struct GNUNET_ShortHashCode *id, void *value)
struct GNUNET_MESSENGER_Member * get_store_member(const struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
Returns the member in a store identified by a given id.
enum GNUNET_GenericReturnValue(* GNUNET_MESSENGER_MemberIteratorCallback)(void *cls, const struct GNUNET_CRYPTO_PublicKey *public_key, struct GNUNET_MESSENGER_MemberSession *session)
const struct GNUNET_HashCode * get_srv_room_key(const struct GNUNET_MESSENGER_SrvRoom *room)
Returns the shared secret you need to access a room.
struct GNUNET_MESSENGER_ContactStore * get_service_contact_store(struct GNUNET_MESSENGER_Service *service)
Returns the used contact store of a given service.
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:403
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:496
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:814
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).
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.
void * GNUNET_CONTAINER_multishortmap_get(const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
Given a key find a value in the map matching the key.
int GNUNET_CONTAINER_multishortmap_iterate(struct GNUNET_CONTAINER_MultiShortmap *map, GNUNET_CONTAINER_ShortmapIterator it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multishortmap_destroy(struct GNUNET_CONTAINER_MultiShortmap *map)
Destroy a hash map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
#define GNUNET_log(kind,...)
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_OK
@ GNUNET_YES
@ GNUNET_NO
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
const char * GNUNET_sh2s(const struct GNUNET_ShortHashCode *shc)
Convert a short hash value to a string (for printing debug messages).
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
@ GNUNET_ERROR_TYPE_DEBUG
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_free(ptr)
Wrapper around free.
@ GNUNET_MESSENGER_KIND_JOIN
The join kind.
enum GNUNET_GenericReturnValue is_peer_message(const struct GNUNET_MESSENGER_Message *message)
Returns whether a specific kind of message can be sent by the service without usage of a clients priv...
#define DIR_SEPARATOR
Definition: platform.h:165
A 512-bit hashcode.
struct GNUNET_CONTAINER_MultiShortmap * members
struct GNUNET_MESSENGER_MemberStore * store
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_MESSENGER_MessageHeader header
Header.
struct GNUNET_MESSENGER_Service * service
A 256-bit hashcode.