1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*
This file is part of GNUnet.
Copyright (C) 2021--2022 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/*
* @author Tobias Frisch
* @file gnunet_chat_file.h
*/
#ifndef GNUNET_CHAT_FILE_H_
#define GNUNET_CHAT_FILE_H_
#include <gnunet/platform.h>
#include <gnunet/gnunet_common.h>
#include <gnunet/gnunet_crypto_lib.h>
#include <gnunet/gnunet_fs_service.h>
#include <gnunet/gnunet_messenger_service.h>
#include <gnunet/gnunet_util_lib.h>
#include "gnunet_chat_lib.h"
struct GNUNET_CHAT_FileUpload
{
struct GNUNET_CHAT_FileUpload *prev;
struct GNUNET_CHAT_FileUpload *next;
struct GNUNET_CHAT_Context *context;
GNUNET_CHAT_FileUploadCallback callback;
void *cls;
};
struct GNUNET_CHAT_FileDownload
{
struct GNUNET_CHAT_FileDownload *prev;
struct GNUNET_CHAT_FileDownload *next;
GNUNET_CHAT_FileDownloadCallback callback;
void *cls;
};
struct GNUNET_CHAT_FileUnindex
{
struct GNUNET_CHAT_FileUnindex *prev;
struct GNUNET_CHAT_FileUnindex *next;
GNUNET_CHAT_FileUnindexCallback callback;
void *cls;
};
struct GNUNET_CHAT_Handle;
#define GNUNET_CHAT_FILE_STATUS_DOWNLOAD 0x1
#define GNUNET_CHAT_FILE_STATUS_PUBLISH 0x2
#define GNUNET_CHAT_FILE_STATUS_UNINDEX 0x4
#define GNUNET_CHAT_FILE_STATUS_MASK 0x7
struct GNUNET_CHAT_File
{
struct GNUNET_CHAT_Handle *handle;
char *name;
struct GNUNET_HashCode hash;
struct GNUNET_CRYPTO_SymmetricSessionKey key;
struct GNUNET_CONTAINER_MetaData *meta;
struct GNUNET_FS_Uri *uri;
struct GNUNET_FS_DownloadContext *download;
struct GNUNET_FS_PublishContext *publish;
struct GNUNET_FS_UnindexContext *unindex;
struct GNUNET_CHAT_FileUpload *upload_head;
struct GNUNET_CHAT_FileUpload *upload_tail;
struct GNUNET_CHAT_FileDownload *download_head;
struct GNUNET_CHAT_FileDownload *download_tail;
struct GNUNET_CHAT_FileUnindex *unindex_head;
struct GNUNET_CHAT_FileUnindex *unindex_tail;
int status;
char *preview;
void *user_pointer;
};
/**
* Creates a chat file handle from a file body in a
* <i>message</i> with a selected chat <i>handle</i>.
*
* @param[in,out] handle Chat handle
* @param[in] message File message body
* @return New chat file handle
*/
struct GNUNET_CHAT_File*
file_create_from_message (struct GNUNET_CHAT_Handle *handle,
const struct GNUNET_MESSENGER_MessageFile *message);
/**
* Creates a chat file handle from a local file on disk
* under a given <i>name</i> using a <i>hash</i> and a
* selected symmetric <i>key</i> with a selected chat
* <i>handle</i>.
*
* @param[in,out] handle Chat handle
* @param[in] name File name
* @param[in] hash File hash
* @param[in] key Symmetric key
* @return New chat file handle
*/
struct GNUNET_CHAT_File*
file_create_from_disk (struct GNUNET_CHAT_Handle *handle,
const char *name,
const struct GNUNET_HashCode *hash,
const struct GNUNET_CRYPTO_SymmetricSessionKey *key);
/**
* Destroys a chat <i>file</i> handle and frees its memory.
*
* @param[in,out] file Chat file handle
*/
void
file_destroy (struct GNUNET_CHAT_File *file);
/**
* Binds a chat <i>context</i>, a callback and a closure
* to a given chat <i>file</i> handle to be called on any
* progress uploading the regarding file.
*
* @param[in,out] file Chat file handle
* @param[in,out] context Chat context
* @param[in] cb Callback for upload progress
* @param[in,out] cls Closure
*/
void
file_bind_upload (struct GNUNET_CHAT_File *file,
struct GNUNET_CHAT_Context *context,
GNUNET_CHAT_FileUploadCallback cb,
void *cls);
/**
* Binds a callback and a closure to a given chat <i>file</i>
* handle to be called on any progress downloading the
* regarding file.
*
* @param[in,out] file Chat file handle
* @param[in] cb Callback for download progress
* @param[in,out] cls Closure
*/
void
file_bind_downlaod (struct GNUNET_CHAT_File *file,
GNUNET_CHAT_FileDownloadCallback cb,
void *cls);
/**
* Binds a callback and a closure to a given chat <i>file</i>
* handle to be called on any progress unindexing the
* regarding file.
*
* @param[in,out] file Chat file handle
* @param[in] cb Callback for unindex progress
* @param[in,out] cls Closure
*/
void
file_bind_unindex (struct GNUNET_CHAT_File *file,
GNUNET_CHAT_FileUnindexCallback cb,
void *cls);
/**
* Calls the regarding events and bound callback of a given
* chat <i>file</i> handle to a file upload progress using
* the provided state of <i>completed</i> bytes and its file
* <i>size</i>.
*
* @param[in,out] file Chat file handle
* @param[in] completed Amount of uploaded bytes
* @param[in] size Full file size
*/
void
file_update_upload (struct GNUNET_CHAT_File *file,
uint64_t completed,
uint64_t size);
/**
* Calls the regarding events and bound callback of a given
* chat <i>file</i> handle to a file download progress using
* the provided state of <i>completed</i> bytes and its file
* <i>size</i>.
*
* @param[in,out] file Chat file handle
* @param[in] completed Amount of downloaded bytes
* @param[in] size Full file size
*/
void
file_update_download (struct GNUNET_CHAT_File *file,
uint64_t completed,
uint64_t size);
/**
* Calls the regarding events and bound callback of a given
* chat <i>file</i> handle to a file unindex progress using
* the provided state of <i>completed</i> bytes and its file
* <i>size</i>.
*
* @param[in,out] file Chat file handle
* @param[in] completed Amount of unindexed bytes
* @param[in] size Full file size
*/
void
file_update_unindex (struct GNUNET_CHAT_File *file,
uint64_t completed,
uint64_t size);
#endif /* GNUNET_CHAT_FILE_H_ */
|
