GNUnet 0.22.0
gnunet-service-messenger_operation.c
Go to the documentation of this file.
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2021, 2023, 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 */
27
31
34{
36
38
40
42 GNUNET_memcpy (&(op->hash), hash, sizeof(*hash));
43 op->timestamp = GNUNET_TIME_absolute_get_zero_ ();
44 op->store = NULL;
45 op->task = NULL;
46
47 return op;
48}
49
50
51void
53{
55
56 if (op->task)
58
60}
61
62
63static void
64callback_operation (void *cls);
65
68 const char *path)
69{
72
73 GNUNET_assert ((store) && (path));
74
75 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Load operation configuration: %s\n",
76 path);
77
79
80 if (! cfg)
81 return NULL;
82
83 op = NULL;
84
86 goto destroy_config;
87
88 {
89 struct GNUNET_HashCode hash;
90
91 if (GNUNET_OK != GNUNET_CONFIGURATION_get_data (cfg, "operation", "hash",
92 &hash, sizeof(hash)))
93 goto destroy_config;
94
95 op = create_operation (&hash);
96 }
97
98 {
99 unsigned long long type_number;
101 "type", &type_number))
102 switch (type_number)
103 {
106 break;
109 break;
112 break;
113 default:
114 break;
115 }
116 }
117
118 if ((GNUNET_MESSENGER_OP_UNKNOWN == op->type) ||
120 "timestamp",
121 &(op->timestamp),
122 sizeof(op->timestamp))))
123 {
125 op = NULL;
126 goto destroy_config;
127 }
128
129 {
130 struct GNUNET_TIME_Relative delay;
131 delay = GNUNET_TIME_absolute_get_remaining (op->timestamp);
132
134 delay,
137 op
138 );
139 }
140
141 op->store = store;
142
143destroy_config:
145
146 return op;
147}
148
149
150void
152 const char *path)
153{
155 char *hash_data;
156 char *timestamp_data;
157
158 GNUNET_assert ((path) && (op));
159
160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Save operation configuration: %s\n",
161 path);
162
164
165 if (! cfg)
166 return;
167
168 hash_data = GNUNET_STRINGS_data_to_string_alloc (&(op->hash),
169 sizeof(op->hash));
170
171 if (hash_data)
172 {
173 GNUNET_CONFIGURATION_set_value_string (cfg, "operation", "hash", hash_data);
174
175 GNUNET_free (hash_data);
176 }
177
178 GNUNET_CONFIGURATION_set_value_number (cfg, "operation", "type", op->type);
179
180 timestamp_data = GNUNET_STRINGS_data_to_string_alloc (&(op->timestamp),
181 sizeof(op->timestamp));
182
183 if (timestamp_data)
184 {
185 GNUNET_CONFIGURATION_set_value_string (cfg, "operation", "timestamp",
186 timestamp_data);
187
188 GNUNET_free (timestamp_data);
189 }
190
193}
194
195
196extern void
198 const struct GNUNET_HashCode *hash);
199
200extern void
202 const struct GNUNET_HashCode *hash);
203
204static void
206{
209 struct GNUNET_MESSENGER_SrvRoom *room;
211 struct GNUNET_HashCode hash;
212
213 GNUNET_assert (cls);
214
215 op = cls;
216 op->task = NULL;
217
218 GNUNET_assert ((op->store) && (op->store->room));
219
220 store = op->store;
221 room = store->room;
222 type = op->type;
223
224 GNUNET_memcpy (&hash, &(op->hash), sizeof(hash));
225
226 cancel_store_operation (store, &hash);
227
228 switch (type)
229 {
231 break;
233 {
235 &hash))
236 {
237 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Deletion of message failed! (%s)\n",
238 GNUNET_h2s (&hash));
239 break;
240 }
241
242 break;
243 }
245 {
246 if (! room->host)
247 break;
248
249 send_srv_room_message (room, room->host, create_message_merge (&hash));
250 break;
251 }
252 default:
253 break;
254 }
255}
256
257
262 struct GNUNET_TIME_Relative delay)
263{
265
266 GNUNET_assert ((op) && (store));
267
268 if (op->task)
269 return GNUNET_SYSERR;
270
272
274 delay,
277 op
278 );
279
280 op->type = type;
281 op->timestamp = timestamp;
282 op->store = store;
283
284 return GNUNET_OK;
285}
286
287
290{
292
293 if (! op->task)
294 return GNUNET_SYSERR;
295
297 op->task = NULL;
298
300 op->timestamp = GNUNET_TIME_absolute_get_zero_ ();
301 op->store = NULL;
302
303 return GNUNET_OK;
304}
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:143
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:108
static uint64_t timestamp(void)
Get current timestamp.
static uint32_t type
Type string converted to DNS type value.
struct GNUNET_MESSENGER_Message * create_message_merge(const struct GNUNET_HashCode *previous)
Creates and allocates a new merge message containing the hash of a second previous message besides th...
enum GNUNET_GenericReturnValue delete_store_message(struct GNUNET_MESSENGER_MessageStore *store, const struct GNUNET_HashCode *hash)
Deletes a message in the message store.
struct GNUNET_MESSENGER_Operation * create_operation(const struct GNUNET_HashCode *hash)
Creates and allocates a new operation under a given hash.
enum GNUNET_GenericReturnValue stop_operation(struct GNUNET_MESSENGER_Operation *op)
Stops an active operation and resets its type to be GNUNET_MESSENGER_OP_UNKNOWN.
struct GNUNET_MESSENGER_Operation * load_operation(struct GNUNET_MESSENGER_OperationStore *store, const char *path)
Loads data from a configuration file at a selected path into a new allocated and created operation fo...
enum GNUNET_GenericReturnValue start_operation(struct GNUNET_MESSENGER_Operation *op, enum GNUNET_MESSENGER_OperationType type, struct GNUNET_MESSENGER_OperationStore *store, struct GNUNET_TIME_Relative delay)
Starts an inactive operation with a given delay in a specific operation store.
void save_operation(const struct GNUNET_MESSENGER_Operation *op, const char *path)
Saves data from an operation into a configuration file at a selected path which can be load to restor...
static void callback_operation(void *cls)
void destroy_operation(struct GNUNET_MESSENGER_Operation *op)
Destroys an operation and frees its memory fully.
void callback_room_deletion(struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_HashCode *hash)
void callback_room_merge(struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_HashCode *hash)
void cancel_store_operation(struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash)
Stops any active operation under a given hash in a specific operation store.
struct GNUNET_MESSENGER_MessageStore * get_srv_room_message_store(struct GNUNET_MESSENGER_SrvRoom *room)
Returns the used message store of a given room.
enum GNUNET_GenericReturnValue send_srv_room_message(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvHandle *handle, struct GNUNET_MESSENGER_Message *message)
Sends a message from a given handle into a room.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_data(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, void *buf, size_t buf_size)
Get Crockford32-encoded fixed-size binary data from a configuration.
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_number(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number)
Get a configuration value that should be a number.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
void GNUNET_CONFIGURATION_set_value_number(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long number)
Set a configuration value that should be a number.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Parse a configuration file, add all of the options in the file to the configuration environment.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
#define GNUNET_log(kind,...)
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_SCHEDULER_PRIORITY_BACKGROUND
Run as background job (higher than idle, lower than default).
@ GNUNET_OK
@ GNUNET_SYSERR
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
@ GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_DEBUG
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:979
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1206
char * GNUNET_STRINGS_data_to_string_alloc(const void *buf, size_t size)
Return the base32crockford encoding of the given buffer.
Definition: strings.c:764
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get_zero_(void)
Return absolute time of 0ms.
Definition: time.c:142
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:406
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:111
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add(struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Relative duration)
Add a given relative duration to the given start time.
Definition: time.c:452
A 512-bit hashcode.
struct GNUNET_MESSENGER_OperationStore * store
struct GNUNET_MESSENGER_SrvHandle * host
Time for absolute times used by GNUnet, in microseconds.
Time for relative time used by GNUnet, in microseconds.