/
flatpak-transaction.h
347 lines (318 loc) · 18.1 KB
/
flatpak-transaction.h
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/*
* Copyright © 2016 Red Hat, Inc
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http:https://www.gnu.org/licenses/>.
*
* Authors:
* Alexander Larsson <[email protected]>
*/
#if !defined(__FLATPAK_H_INSIDE__) && !defined(FLATPAK_COMPILATION)
#error "Only <flatpak.h> can be included directly."
#endif
#ifndef __FLATPAK_TRANSACTION_H__
#define __FLATPAK_TRANSACTION_H__
#include <gio/gio.h>
#include <flatpak-installation.h>
G_BEGIN_DECLS
#define FLATPAK_TYPE_TRANSACTION flatpak_transaction_get_type ()
#define FLATPAK_TYPE_TRANSACTION_PROGRESS flatpak_transaction_progress_get_type ()
#define FLATPAK_TYPE_TRANSACTION_OPERATION flatpak_transaction_operation_get_type ()
/**
* FlatpakTransactionOperationType
* @FLATPAK_TRANSACTION_OPERATION_INSTALL: Install a ref from a remote
* @FLATPAK_TRANSACTION_OPERATION_UPDATE: Update an installed ref
* @FLATPAK_TRANSACTION_OPERATION_INSTALL_BUNDLE: Install a bundle from a file
* @FLATPAK_TRANSACTION_OPERATION_UNINSTALL: Uninstall a ref
* @FLATPAK_TRANSACTION_OPERATION_LAST_TYPE: The (currently) last operation type
*
* The type of a #FlatpakTransactionOperation.
*/
typedef enum {
FLATPAK_TRANSACTION_OPERATION_INSTALL,
FLATPAK_TRANSACTION_OPERATION_UPDATE,
FLATPAK_TRANSACTION_OPERATION_INSTALL_BUNDLE,
FLATPAK_TRANSACTION_OPERATION_UNINSTALL,
FLATPAK_TRANSACTION_OPERATION_LAST_TYPE
} FlatpakTransactionOperationType;
/**
* FlatpakTransactionErrorDetails
* @FLATPAK_TRANSACTION_ERROR_DETAILS_NON_FATAL: The operation failure was not fatal
*
* The details for #FlatpakTransaction::operation-error.
*/
typedef enum {
FLATPAK_TRANSACTION_ERROR_DETAILS_NON_FATAL = 1 << 0,
} FlatpakTransactionErrorDetails;
/**
* FlatpakTransactionResult
* @FLATPAK_TRANSACTION_RESULT_NO_CHANGE: The update caused no changes
*
* The details for #FlatpakTransaction::operation-done.
*/
typedef enum {
FLATPAK_TRANSACTION_RESULT_NO_CHANGE = 1 << 0,
} FlatpakTransactionResult;
/**
* FlatpakTransactionRemoteReason
* @FLATPAK_TRANSACTION_REMOTE_GENERIC_REPO: The remote specified in the flatpakref has other apps too
* @FLATPAK_TRANSACTION_REMOTE_RUNTIME_DEPS: The remote has runtimes needed for the app
*
* The reason for #FlatpakTransaction::add-new-remote.
*/
typedef enum {
FLATPAK_TRANSACTION_REMOTE_GENERIC_REPO,
FLATPAK_TRANSACTION_REMOTE_RUNTIME_DEPS,
} FlatpakTransactionRemoteReason;
FLATPAK_EXTERN
G_DECLARE_FINAL_TYPE (FlatpakTransactionProgress, flatpak_transaction_progress, FLATPAK, TRANSACTION_PROGRESS, GObject)
FLATPAK_EXTERN
G_DECLARE_FINAL_TYPE (FlatpakTransactionOperation, flatpak_transaction_operation, FLATPAK, TRANSACTION_OPERATION, GObject)
FLATPAK_EXTERN
G_DECLARE_DERIVABLE_TYPE (FlatpakTransaction, flatpak_transaction, FLATPAK, TRANSACTION, GObject)
struct _FlatpakTransactionClass
{
GObjectClass parent_class;
void (*new_operation) (FlatpakTransaction *transaction,
FlatpakTransactionOperation *operation,
FlatpakTransactionProgress *progress);
void (*operation_done) (FlatpakTransaction *transaction,
FlatpakTransactionOperation *operation,
const char *commit,
FlatpakTransactionResult details);
gboolean (*operation_error) (FlatpakTransaction *transaction,
FlatpakTransactionOperation *operation,
const GError *error,
FlatpakTransactionErrorDetails detail);
int (*choose_remote_for_ref) (FlatpakTransaction *transaction,
const char *for_ref,
const char *runtime_ref,
const char * const *remotes);
void (*end_of_lifed) (FlatpakTransaction *transaction,
const char *ref,
const char *reason,
const char *rebase);
gboolean (*ready) (FlatpakTransaction *transaction);
gboolean (*add_new_remote) (FlatpakTransaction *transaction,
FlatpakTransactionRemoteReason reason,
const char *from_id,
const char *remote_name,
const char *url);
gboolean (*run) (FlatpakTransaction *transaction,
GCancellable *cancellable,
GError **error);
gboolean (*end_of_lifed_with_rebase) (FlatpakTransaction *transaction,
const char *remote,
const char *ref,
const char *reason,
const char *rebased_to_ref,
const char **previous_ids);
gboolean (*webflow_start) (FlatpakTransaction *transaction,
const char *remote,
const char *url,
GVariant *options,
guint id);
void (*webflow_done) (FlatpakTransaction *transaction,
GVariant *options,
guint id);
gboolean (*basic_auth_start) (FlatpakTransaction *transaction,
const char *remote,
const char *realm,
GVariant *options,
guint id);
void (*install_authenticator) (FlatpakTransaction *transaction,
const char *remote,
const char *authenticator_ref);
gboolean (*ready_pre_auth) (FlatpakTransaction *transaction);
gpointer padding[3];
};
FLATPAK_EXTERN
FlatpakTransaction *flatpak_transaction_new_for_installation (FlatpakInstallation *installation,
GCancellable *cancellable,
GError **error);
FLATPAK_EXTERN
void flatpak_transaction_progress_set_update_frequency (FlatpakTransactionProgress *self,
guint update_interval);
FLATPAK_EXTERN
char * flatpak_transaction_progress_get_status (FlatpakTransactionProgress *self);
FLATPAK_EXTERN
gboolean flatpak_transaction_progress_get_is_estimating (FlatpakTransactionProgress *self);
FLATPAK_EXTERN
int flatpak_transaction_progress_get_progress (FlatpakTransactionProgress *self);
FLATPAK_EXTERN
guint64 flatpak_transaction_progress_get_bytes_transferred (FlatpakTransactionProgress *self);
FLATPAK_EXTERN
guint64 flatpak_transaction_progress_get_start_time (FlatpakTransactionProgress *self);
FLATPAK_EXTERN
FlatpakTransactionOperationType flatpak_transaction_operation_get_operation_type (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
const char * flatpak_transaction_operation_get_ref (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
GPtrArray * flatpak_transaction_operation_get_related_to_ops (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
gboolean flatpak_transaction_operation_get_is_skipped (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
const char * flatpak_transaction_operation_get_remote (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
GFile * flatpak_transaction_operation_get_bundle_path (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
const char * flatpak_transaction_operation_get_commit (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
guint64 flatpak_transaction_operation_get_download_size (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
guint64 flatpak_transaction_operation_get_installed_size (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
GKeyFile * flatpak_transaction_operation_get_metadata (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
GKeyFile * flatpak_transaction_operation_get_old_metadata (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
const char * const * flatpak_transaction_operation_get_subpaths (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
gboolean flatpak_transaction_operation_get_requires_authentication (FlatpakTransactionOperation *self);
FLATPAK_EXTERN
const char * flatpak_transaction_operation_type_to_string (FlatpakTransactionOperationType kind);
FLATPAK_EXTERN
void flatpak_transaction_set_no_pull (FlatpakTransaction *self,
gboolean no_pull);
FLATPAK_EXTERN
gboolean flatpak_transaction_get_no_pull (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_set_no_deploy (FlatpakTransaction *self,
gboolean no_deploy);
FLATPAK_EXTERN
gboolean flatpak_transaction_get_no_deploy (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_set_disable_static_deltas (FlatpakTransaction *self,
gboolean disable_static_deltas);
FLATPAK_EXTERN
void flatpak_transaction_set_disable_prune (FlatpakTransaction *self,
gboolean disable_prune);
FLATPAK_EXTERN
void flatpak_transaction_set_disable_dependencies (FlatpakTransaction *self,
gboolean disable_dependencies);
FLATPAK_EXTERN
void flatpak_transaction_set_disable_related (FlatpakTransaction *self,
gboolean disable_related);
FLATPAK_EXTERN
void flatpak_transaction_set_disable_auto_pin (FlatpakTransaction *self,
gboolean disable_pin);
FLATPAK_EXTERN
void flatpak_transaction_set_reinstall (FlatpakTransaction *self,
gboolean reinstall);
FLATPAK_EXTERN
gboolean flatpak_transaction_get_no_interaction (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_set_no_interaction (FlatpakTransaction *self,
gboolean no_interaction);
FLATPAK_EXTERN
void flatpak_transaction_set_force_uninstall (FlatpakTransaction *self,
gboolean force_uninstall);
FLATPAK_EXTERN
void flatpak_transaction_set_default_arch (FlatpakTransaction *self,
const char *arch);
FLATPAK_EXTERN
void flatpak_transaction_set_parent_window (FlatpakTransaction *self,
const char *parent_window);
FLATPAK_EXTERN
const char * flatpak_transaction_get_parent_window (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_set_include_unused_uninstall_ops (FlatpakTransaction *self,
gboolean include_unused_uninstall_ops);
FLATPAK_EXTERN
gboolean flatpak_transaction_get_include_unused_uninstall_ops (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_set_auto_install_sdk (FlatpakTransaction *self,
gboolean auto_install_sdk);
FLATPAK_EXTERN
gboolean flatpak_transaction_get_auto_install_sdk (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_set_auto_install_debug (FlatpakTransaction *self,
gboolean auto_install_debug);
FLATPAK_EXTERN
gboolean flatpak_transaction_get_auto_install_debug (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_add_dependency_source (FlatpakTransaction *self,
FlatpakInstallation *installation);
FLATPAK_EXTERN
void flatpak_transaction_add_sideload_repo (FlatpakTransaction *self,
const char *path);
FLATPAK_EXTERN
void flatpak_transaction_add_default_dependency_sources (FlatpakTransaction *self);
FLATPAK_EXTERN
gboolean flatpak_transaction_run (FlatpakTransaction *transaction,
GCancellable *cancellable,
GError **error);
FLATPAK_EXTERN
FlatpakTransactionOperation *flatpak_transaction_get_current_operation (FlatpakTransaction *self);
FLATPAK_EXTERN
FlatpakTransactionOperation *flatpak_transaction_get_operation_for_ref (FlatpakTransaction *self,
const char *remote,
const char *ref,
GError **error);
FLATPAK_EXTERN
FlatpakInstallation *flatpak_transaction_get_installation (FlatpakTransaction *self);
FLATPAK_EXTERN
GList *flatpak_transaction_get_operations (FlatpakTransaction *self);
FLATPAK_EXTERN
void flatpak_transaction_abort_webflow (FlatpakTransaction *self,
guint id);
FLATPAK_EXTERN
void flatpak_transaction_complete_basic_auth (FlatpakTransaction *self,
guint id,
const char *user,
const char *password,
GVariant *options);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_install (FlatpakTransaction *self,
const char *remote,
const char *ref,
const char **subpaths,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_rebase (FlatpakTransaction *self,
const char *remote,
const char *ref,
const char **subpaths,
const char **previous_ids,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_rebase_and_uninstall (FlatpakTransaction *self,
const char *remote,
const char *new_ref,
const char *old_ref,
const char **subpaths,
const char **previous_ids,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_install_bundle (FlatpakTransaction *self,
GFile *file,
GBytes *gpg_data,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_install_flatpakref (FlatpakTransaction *self,
GBytes *flatpakref_data,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_update (FlatpakTransaction *self,
const char *ref,
const char **subpaths,
const char *commit,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_add_uninstall (FlatpakTransaction *self,
const char *ref,
GError **error);
FLATPAK_EXTERN
gboolean flatpak_transaction_is_empty (FlatpakTransaction *self);
G_END_DECLS
#endif /* __FLATPAK_TRANSACTION_H__ */