summaryrefslogtreecommitdiff
path: root/common/xdg-app-dir.h
blob: ccca522a4577bc0b74ce6d64dc639af9f64a119c (plain)
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
348
349
350
351
352
353
354
355
356
357
358
359
360
/*
 * Copyright © 2014 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 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://www.gnu.org/licenses/>.
 *
 * Authors:
 *       Alexander Larsson <alexl@redhat.com>
 */

#ifndef __XDG_APP_DIR_H__
#define __XDG_APP_DIR_H__

#include <ostree.h>

#include "libglnx/libglnx.h"
#include <xdg-app-common-types.h>

#define XDG_APP_TYPE_DIR xdg_app_dir_get_type()
#define XDG_APP_DIR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), XDG_APP_TYPE_DIR, XdgAppDir))
#define XDG_APP_IS_DIR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), XDG_APP_TYPE_DIR))

#define XDG_APP_TYPE_DEPLOY xdg_app_deploy_get_type()
#define XDG_APP_DEPLOY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), XDG_APP_TYPE_DEPLOY, XdgAppDeploy))
#define XDG_APP_IS_DEPLOY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), XDG_APP_TYPE_DEPLOY))

GType xdg_app_dir_get_type (void);
GType xdg_app_deploy_get_type (void);

G_DEFINE_AUTOPTR_CLEANUP_FUNC(XdgAppDir, g_object_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(XdgAppDeploy, g_object_unref)

#define XDG_APP_DIR_ERROR xdg_app_dir_error_quark()

typedef enum {
  XDG_APP_DIR_ERROR_ALREADY_DEPLOYED,
  XDG_APP_DIR_ERROR_ALREADY_UNDEPLOYED,
  XDG_APP_DIR_ERROR_NOT_DEPLOYED,
} XdgAppDirErrorEnum;

typedef enum {
  XDG_APP_HELPER_DEPLOY_FLAGS_NONE = 0,
  XDG_APP_HELPER_DEPLOY_FLAGS_UPDATE = 1<<0,
} XdgAppHelperDeployFlags;

#define XDG_APP_HELPER_DEPLOY_FLAGS_ALL (XDG_APP_HELPER_DEPLOY_FLAGS_UPDATE)

GQuark       xdg_app_dir_error_quark      (void);

/**
 * XDG_APP_DEPLOY_DATA_GVARIANT_FORMAT:
 *
 * s - origin
 * s - commit
 * as - subpaths
 * t - installed size
 * a{sv} - Metadata
 */
#define XDG_APP_DEPLOY_DATA_GVARIANT_STRING "(ssasta{sv})"
#define XDG_APP_DEPLOY_DATA_GVARIANT_FORMAT G_VARIANT_TYPE (XDG_APP_DEPLOY_DATA_GVARIANT_STRING)

GFile *  xdg_app_get_system_base_dir_location (void);
GFile *  xdg_app_get_user_base_dir_location   (void);

GKeyFile *     xdg_app_load_override_keyfile (const char  *app_id,
                                              gboolean     user,
                                              GError     **error);
XdgAppContext *xdg_app_load_override_file    (const char  *app_id,
                                              gboolean     user,
                                              GError     **error);
gboolean       xdg_app_save_override_keyfile (GKeyFile    *metakey,
                                              const char  *app_id,
                                              gboolean     user,
                                              GError     **error);

const char *        xdg_app_deploy_data_get_origin         (GVariant *deploy_data);
const char *        xdg_app_deploy_data_get_commit         (GVariant *deploy_data);
const char **       xdg_app_deploy_data_get_subpaths       (GVariant *deploy_data);
guint64             xdg_app_deploy_data_get_installed_size (GVariant *deploy_data);

GFile *        xdg_app_deploy_get_dir       (XdgAppDeploy *deploy);
GFile *        xdg_app_deploy_get_files     (XdgAppDeploy *deploy);
XdgAppContext *xdg_app_deploy_get_overrides (XdgAppDeploy *deploy);
GKeyFile *     xdg_app_deploy_get_metadata  (XdgAppDeploy *deploy);

XdgAppDir*  xdg_app_dir_new             (GFile          *basedir,
                                         gboolean        user);
XdgAppDir*  xdg_app_dir_clone           (XdgAppDir      *self);
XdgAppDir  *xdg_app_dir_get             (gboolean        user);
XdgAppDir  *xdg_app_dir_get_system      (void);
XdgAppDir  *xdg_app_dir_get_user        (void);
gboolean    xdg_app_dir_is_user         (XdgAppDir      *self);
GFile *     xdg_app_dir_get_path        (XdgAppDir      *self);
GFile *     xdg_app_dir_get_changed_path (XdgAppDir     *self);
GFile *     xdg_app_dir_get_deploy_dir  (XdgAppDir      *self,
                                         const char     *ref);
GVariant *  xdg_app_dir_get_deploy_data (XdgAppDir      *dir,
                                         const char     *ref,
                                         GCancellable   *cancellable,
                                         GError        **error);
char *      xdg_app_dir_get_origin      (XdgAppDir      *self,
                                         const char     *ref,
                                         GCancellable   *cancellable,
                                         GError        **error);
char **     xdg_app_dir_get_subpaths    (XdgAppDir      *self,
                                         const char     *ref,
                                         GCancellable   *cancellable,
                                         GError        **error);
GFile *     xdg_app_dir_get_exports_dir (XdgAppDir      *self);
GFile *     xdg_app_dir_get_removed_dir (XdgAppDir      *self);
GFile *     xdg_app_dir_get_if_deployed (XdgAppDir      *self,
                                         const char     *ref,
                                         const char     *checksum,
                                         GCancellable   *cancellable);
char *      xdg_app_dir_find_remote_ref (XdgAppDir      *self,
                                         const char     *remote,
                                         const char     *name,
                                         const char     *opt_branch,
                                         const char     *opt_arch,
                                         gboolean        app,
                                         gboolean        runtime,
                                         gboolean       *is_app,
                                         GCancellable   *cancellable,
                                         GError        **error);
char *      xdg_app_dir_find_installed_ref (XdgAppDir      *self,
                                            const char     *name,
                                            const char     *opt_branch,
                                            const char     *opt_arch,
                                            gboolean        app,
                                            gboolean        runtime,
                                            gboolean       *is_app,
                                            GError        **error);
XdgAppDeploy *xdg_app_dir_load_deployed (XdgAppDir      *self,
                                         const char     *ref,
                                         const char     *checksum,
                                         GCancellable   *cancellable,
                                         GError        **error);
char *    xdg_app_dir_load_override     (XdgAppDir      *dir,
                                         const char     *app_id,
                                         gsize          *length,
                                         GError        **error);
OstreeRepo *xdg_app_dir_get_repo        (XdgAppDir      *self);
gboolean    xdg_app_dir_ensure_path     (XdgAppDir      *self,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_use_child_repo  (XdgAppDir     *self);
gboolean    xdg_app_dir_ensure_system_child_repo (XdgAppDir *self,
                                                  GError **error);
gboolean    xdg_app_dir_ensure_repo     (XdgAppDir      *self,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_mark_changed    (XdgAppDir      *self,
                                         GError        **error);
gboolean    xdg_app_dir_remove_appstream(XdgAppDir      *self,
                                         const char     *remote,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_update_appstream(XdgAppDir      *self,
                                         const char     *remote,
                                         const char     *arch,
                                         gboolean       *out_changed,
                                         OstreeAsyncProgress *progress,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_pull            (XdgAppDir      *self,
                                         const char     *repository,
                                         const char     *ref,
                                         char          **subpaths,
                                         OstreeRepo     *repo,
                                         OstreeRepoPullFlags flags,
                                         OstreeAsyncProgress *progress,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_pull_untrusted_local (XdgAppDir *self,
                                              const char *src_path,
                                              const char *remote_name,
                                              const char *ref,
                                              char **subpaths,
                                              OstreeAsyncProgress *progress,
                                              GCancellable *cancellable,
                                              GError **error);
gboolean    xdg_app_dir_list_refs_for_name (XdgAppDir      *self,
                                            const char     *kind,
                                            const char     *name,
                                            char          ***refs,
                                            GCancellable   *cancellable,
                                            GError        **error);
gboolean    xdg_app_dir_list_refs       (XdgAppDir      *self,
                                         const char     *kind,
                                         char          ***refs,
                                         GCancellable   *cancellable,
                                         GError        **error);
char *      xdg_app_dir_read_latest     (XdgAppDir      *self,
                                         const char     *remote,
                                         const char     *ref,
                                         GCancellable   *cancellable,
                                         GError        **error);
char *      xdg_app_dir_read_active     (XdgAppDir      *self,
                                         const char     *ref,
                                         GCancellable   *cancellable);
gboolean    xdg_app_dir_set_active      (XdgAppDir      *self,
                                         const char     *ref,
                                         const char     *checksum,
                                         GCancellable   *cancellable,
                                         GError        **error);
char *      xdg_app_dir_current_ref     (XdgAppDir      *self,
                                         const char     *name,
                                         GCancellable   *cancellable);
gboolean    xdg_app_dir_drop_current_ref (XdgAppDir      *self,
                                          const char     *name,
                                          GCancellable   *cancellable,
                                          GError        **error);
gboolean    xdg_app_dir_make_current_ref (XdgAppDir      *self,
                                          const char     *ref,
                                          GCancellable   *cancellable,
                                          GError        **error);
gboolean    xdg_app_dir_list_deployed   (XdgAppDir      *self,
                                         const char     *ref,
                                         char         ***deployed_checksums,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_lock            (XdgAppDir      *self,
                                         GLnxLockFile   *lockfile,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_deploy          (XdgAppDir      *self,
                                         const char     *origin,
                                         const char     *ref,
                                         const char     *checksum_or_latest,
                                         const char * const * subpaths,
                                         GVariant       *old_deploy_data,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_deploy_update   (XdgAppDir      *self,
                                         const char     *ref,
                                         const char     *checksum,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean   xdg_app_dir_deploy_install   (XdgAppDir      *self,
                                         const char     *ref,
                                         const char     *origin,
                                         char          **subpaths,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean   xdg_app_dir_install          (XdgAppDir      *self,
                                         gboolean        no_pull,
                                         gboolean        no_deploy,
                                         const char     *ref,
                                         const char     *remote_name,
                                         char          **subpaths,
                                         OstreeAsyncProgress *progress,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean   xdg_app_dir_update           (XdgAppDir      *self,
                                         gboolean        no_pull,
                                         gboolean        no_deploy,
                                         const char     *ref,
                                         const char     *remote_name,
                                         const char     *checksum_or_latest,
                                         char          **subpaths,
                                         OstreeAsyncProgress *progress,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_undeploy        (XdgAppDir      *self,
                                         const char     *ref,
                                         const char     *checksum,
					 gboolean        force_remove,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_undeploy_all    (XdgAppDir      *self,
                                         const char     *ref,
					 gboolean        force_remove,
                                         gboolean       *was_deployed_out,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_remove_all_refs (XdgAppDir      *self,
                                         const char     *remote,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_remove_ref      (XdgAppDir      *self,
                                         const char     *remote_name,
                                         const char     *ref,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_update_exports  (XdgAppDir      *self,
                                         const char     *app,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_prune           (XdgAppDir      *self,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_cleanup_removed (XdgAppDir      *self,
                                         GCancellable   *cancellable,
                                         GError        **error);
gboolean    xdg_app_dir_collect_deployed_refs (XdgAppDir *self,
					       const char *type,
					       const char *name_prefix,
					       const char *branch,
					       const char *arch,
					       GHashTable *hash,
					       GCancellable *cancellable,
					       GError **error);
char      *xdg_app_dir_create_origin_remote (XdgAppDir *self,
                                             const char *url,
                                             const char *id,
                                             const char *title,
                                             GBytes *gpg_data,
                                             GCancellable *cancellable,
                                             GError **error);
char     **xdg_app_dir_list_remotes     (XdgAppDir *self,
                                         GCancellable *cancellable,
                                         GError **error);
char      *xdg_app_dir_get_remote_title (XdgAppDir *self,
                                         const char *remote_name);
int        xdg_app_dir_get_remote_prio  (XdgAppDir *self,
                                         const char *remote_name);
gboolean   xdg_app_dir_get_remote_noenumerate (XdgAppDir *self,
                                               const char *remote_name);
gboolean   xdg_app_dir_get_remote_disabled (XdgAppDir *self,
                                            const char *remote_name);
gboolean   xdg_app_dir_list_remote_refs (XdgAppDir *self,
                                         const char *remote,
                                         GHashTable **refs,
                                         GCancellable *cancellable,
                                         GError **error);
char *   xdg_app_dir_fetch_remote_title (XdgAppDir *self,
                                         const char *remote,
                                         GCancellable *cancellable,
                                         GError **error);
GBytes * xdg_app_dir_fetch_remote_object (XdgAppDir *self,
                                          const char *remote,
                                          const char *checksum,
                                          const char *type,
                                          GCancellable *cancellable,
                                          GError **error);
GBytes * xdg_app_dir_fetch_metadata      (XdgAppDir *self,
                                          const char *remote_name,
                                          const char *commit,
                                          GCancellable *cancellable,
                                          GError **error);
gboolean xdg_app_dir_fetch_ref_cache (XdgAppDir    *self,
                                      const char   *remote_name,
                                      const char   *ref,
                                      guint64      *download_size,
                                      guint64      *installed_size,
                                      char        **metadata,
                                      GCancellable *cancellable,
                                      GError      **error);

#endif /* __XDG_APP_DIR_H__ */