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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
/*
* Copyright (C) 2016 Canonical Ltd.
*
* This library 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 or version 3 of the License.
* See http://www.gnu.org/copyleft/lgpl.html the full text of the license.
*/
#include "config.h"
#include <string.h>
#include "snapd-task.h"
#include "snapd-change.h"
/**
* SECTION: snapd-task
* @short_description: Task progress
* @include: snapd-glib/snapd-glib.h
*
* A #SnapdTask contains information on a task in a #SnapdChange.
*/
/**
* SnapdTask:
*
* #SnapdTask is an opaque data structure and can only be accessed
* using the provided functions.
*/
struct _SnapdTask
{
GObject parent_instance;
gchar *id;
gchar *kind;
gchar *summary;
gchar *status;
gchar *progress_label;
gint64 progress_done;
gint64 progress_total;
GDateTime *spawn_time;
GDateTime *ready_time;
};
enum
{
PROP_ID = 1,
PROP_KIND,
PROP_SUMMARY,
PROP_STATUS,
PROP_READY,
PROP_PROGRESS_DONE,
PROP_PROGRESS_TOTAL,
PROP_SPAWN_TIME,
PROP_READY_TIME,
PROP_PROGRESS_LABEL,
PROP_LAST
};
G_DEFINE_TYPE (SnapdTask, snapd_task, G_TYPE_OBJECT)
/**
* snapd_task_get_id:
* @task: a #SnapdTask.
*
* Get the unique ID for this task.
*
* Returns: an ID.
*/
const gchar *
snapd_task_get_id (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_id (SNAPD_CHANGE (task));
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->id;
}
/**
* snapd_task_get_kind:
* @task: a #SnapdTask.
*
* Gets the kind of task this is.
*
* Returns: the kind of task.
*/
const gchar *
snapd_task_get_kind (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_kind (SNAPD_CHANGE (task));
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->kind;
}
/**
* snapd_task_get_summary:
* @task: a #SnapdTask.
*
* Get a human readable description of the task.
*
* Returns: a string describing the task.
*/
const gchar *
snapd_task_get_summary (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_summary (SNAPD_CHANGE (task));
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->summary;
}
/**
* snapd_task_get_status:
* @task: a #SnapdTask.
*
* Get the status of the task.
*
* Returns: a status string.
*/
const gchar *
snapd_task_get_status (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_status (SNAPD_CHANGE (task));
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->status;
}
/**
* snapd_task_get_ready:
* @task: a #SnapdTask.
*
* Get if this task is completed.
*
* Depcrecated: 1.5: Use snapd_change_get_ready() instead.
*
* Returns: %TRUE if this task is complete.
*/
gboolean
snapd_task_get_ready (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_ready (SNAPD_CHANGE (task));
return FALSE;
}
/**
* snapd_task_get_progress_label:
* @task: a #SnapdTask.
*
* Get the the label associated with the progress.
*
* Returns: a label string.
*/
const gchar *
snapd_task_get_progress_label (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return NULL;
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->progress_label;
}
/**
* snapd_task_get_progress_done:
* @task: a #SnapdTask.
*
* Get the the number of items completed in this task.
*
* Returns: a count.
*/
gint64
snapd_task_get_progress_done (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return 0;
g_return_val_if_fail (SNAPD_IS_TASK (task), 0);
return task->progress_done;
}
/**
* snapd_task_get_progress_total:
* @task: a #SnapdTask.
*
* Get the the total number of items to be completed in this task.
*
* Returns: a count.
*/
gint64
snapd_task_get_progress_total (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return 0;
g_return_val_if_fail (SNAPD_IS_TASK (task), 0);
return task->progress_total;
}
/**
* snapd_task_get_spawn_time:
* @task: a #SnapdTask.
*
* Get the time this task started.
*
* Returns: (transfer none): a #GDateTime.
*/
GDateTime *
snapd_task_get_spawn_time (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_spawn_time (SNAPD_CHANGE (task));
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->spawn_time;
}
/**
* snapd_task_get_ready_time:
* @task: a #SnapdTask.
*
* Get the time this taksk completed or %NULL if not yet completed.
*
* Returns: (transfer none) (allow-none): a #GDateTime or %NULL.
*/
GDateTime *
snapd_task_get_ready_time (SnapdTask *task)
{
/* Workaround to handle API change in SnapdProgressCallback */
if (SNAPD_IS_CHANGE (task))
return snapd_change_get_ready_time (SNAPD_CHANGE (task));
g_return_val_if_fail (SNAPD_IS_TASK (task), NULL);
return task->ready_time;
}
static void
snapd_task_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
{
SnapdTask *task = SNAPD_TASK (object);
switch (prop_id) {
case PROP_ID:
g_free (task->id);
task->id = g_strdup (g_value_get_string (value));
break;
case PROP_KIND:
g_free (task->kind);
task->kind = g_strdup (g_value_get_string (value));
break;
case PROP_SUMMARY:
g_free (task->summary);
task->summary = g_strdup (g_value_get_string (value));
break;
case PROP_STATUS:
g_free (task->status);
task->status = g_strdup (g_value_get_string (value));
break;
case PROP_READY:
// Deprecated
break;
case PROP_PROGRESS_LABEL:
g_free (task->progress_label);
task->progress_label = g_strdup (g_value_get_string (value));
break;
case PROP_PROGRESS_DONE:
task->progress_done = g_value_get_int64 (value);
break;
case PROP_PROGRESS_TOTAL:
task->progress_total = g_value_get_int64 (value);
break;
case PROP_SPAWN_TIME:
g_clear_pointer (&task->spawn_time, g_date_time_unref);
if (g_value_get_boxed (value) != NULL)
task->spawn_time = g_date_time_ref (g_value_get_boxed (value));
break;
case PROP_READY_TIME:
g_clear_pointer (&task->ready_time, g_date_time_unref);
if (g_value_get_boxed (value) != NULL)
task->ready_time = g_date_time_ref (g_value_get_boxed (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
snapd_task_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
{
SnapdTask *task = SNAPD_TASK (object);
switch (prop_id) {
case PROP_ID:
g_value_set_string (value, task->id);
break;
case PROP_KIND:
g_value_set_string (value, task->kind);
break;
case PROP_SUMMARY:
g_value_set_string (value, task->summary);
break;
case PROP_STATUS:
g_value_set_string (value, task->status);
break;
case PROP_PROGRESS_LABEL:
g_value_set_string (value, task->progress_label);
break;
case PROP_PROGRESS_DONE:
g_value_set_int64 (value, task->progress_done);
break;
case PROP_PROGRESS_TOTAL:
g_value_set_int64 (value, task->progress_total);
break;
case PROP_READY:
g_value_set_boolean (value, FALSE);
break;
case PROP_SPAWN_TIME:
g_value_set_boxed (value, task->spawn_time);
break;
case PROP_READY_TIME:
g_value_set_boxed (value, task->ready_time);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
snapd_task_finalize (GObject *object)
{
SnapdTask *task = SNAPD_TASK (object);
g_clear_pointer (&task->id, g_free);
g_clear_pointer (&task->kind, g_free);
g_clear_pointer (&task->summary, g_free);
g_clear_pointer (&task->status, g_free);
g_clear_pointer (&task->progress_label, g_free);
g_clear_pointer (&task->spawn_time, g_date_time_unref);
g_clear_pointer (&task->ready_time, g_date_time_unref);
}
static void
snapd_task_class_init (SnapdTaskClass *klass)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
gobject_class->set_property = snapd_task_set_property;
gobject_class->get_property = snapd_task_get_property;
gobject_class->finalize = snapd_task_finalize;
g_object_class_install_property (gobject_class,
PROP_ID,
g_param_spec_string ("id",
"id",
"ID of task",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_KIND,
g_param_spec_string ("kind",
"kind",
"Kind of task",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_SUMMARY,
g_param_spec_string ("summary",
"summary",
"Summary of task",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_STATUS,
g_param_spec_string ("status",
"status",
"Status of task",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_PROGRESS_LABEL,
g_param_spec_string ("progress-label",
"progress-label",
"Label for progress",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_PROGRESS_DONE,
g_param_spec_int64 ("progress-done",
"progress-done",
"Number of items done in this task",
0, G_MAXINT64, 0,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_PROGRESS_TOTAL,
g_param_spec_int64 ("progress-total",
"progress-total",
"Total number of items to be done in this task",
0, G_MAXINT64, 0,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_READY,
g_param_spec_boolean ("ready",
"ready",
"TRUE when task complete",
FALSE,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_DEPRECATED));
g_object_class_install_property (gobject_class,
PROP_SPAWN_TIME,
g_param_spec_boxed ("spawn-time",
"spawn-time",
"Time this task started",
G_TYPE_DATE_TIME,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (gobject_class,
PROP_READY_TIME,
g_param_spec_boxed ("ready-time",
"ready-time",
"Time this task completed",
G_TYPE_DATE_TIME,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
}
static void
snapd_task_init (SnapdTask *task)
{
}
|