| 1 |
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- |
| 2 |
* |
| 3 |
* Copyright (C) 2009-2014 Richard Hughes <[email protected]> |
| 4 |
* |
| 5 |
* Licensed under the GNU Lesser General Public License Version 2.1 |
| 6 |
* |
| 7 |
* This library is free software; you can redistribute it and/or |
| 8 |
* modify it under the terms of the GNU Lesser General Public |
| 9 |
* License as published by the Free Software Foundation; either |
| 10 |
* version 2.1 of the License, or (at your option) any later version. |
| 11 |
* |
| 12 |
* This library is distributed in the hope that it will be useful, |
| 13 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 |
* Lesser General Public License for more details. |
| 16 |
* |
| 17 |
* You should have received a copy of the GNU Lesser General Public |
| 18 |
* License along with this library; if not, write to the Free Software |
| 19 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 |
*/ |
| 21 |
|
| 22 |
#if !defined (__PACKAGEKIT_H_INSIDE__) && !defined (PK_COMPILATION) |
| 23 |
#error "Only <packagekit.h> can be included directly." |
| 24 |
#endif |
| 25 |
|
| 26 |
#ifndef __PK_CLIENT_H |
| 27 |
#define __PK_CLIENT_H |
| 28 |
|
| 29 |
#include <glib-object.h> |
| 30 |
#include <gio/gio.h> |
| 31 |
|
| 32 |
#include <packagekit-glib2/pk-results.h> |
| 33 |
#include <packagekit-glib2/pk-progress.h> |
| 34 |
#include <packagekit-glib2/pk-bitfield.h> |
| 35 |
#include <packagekit-glib2/pk-source.h> |
| 36 |
|
| 37 |
G_BEGIN_DECLS |
| 38 |
|
| 39 |
#define PK_TYPE_CLIENT (pk_client_get_type ()) |
| 40 |
#define PK_CLIENT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), PK_TYPE_CLIENT, PkClient)) |
| 41 |
#define PK_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), PK_TYPE_CLIENT, PkClientClass)) |
| 42 |
#define PK_IS_CLIENT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), PK_TYPE_CLIENT)) |
| 43 |
#define PK_IS_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), PK_TYPE_CLIENT)) |
| 44 |
#define PK_CLIENT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), PK_TYPE_CLIENT, PkClientClass)) |
| 45 |
#define PK_CLIENT_ERROR (pk_client_error_quark ()) |
| 46 |
#define PK_CLIENT_TYPE_ERROR (pk_client_error_get_type ()) |
| 47 |
|
| 48 |
/** |
| 49 |
* PkClientError: |
| 50 |
* @PK_CLIENT_ERROR_FAILED: the transaction failed for an unknown reason |
| 51 |
* @PK_CLIENT_ERROR_FAILED_AUTH: the transaction failed authentication/authorization |
| 52 |
* @PK_CLIENT_ERROR_NO_TID: the transaction id was not pre-allocated (internal error) |
| 53 |
* @PK_CLIENT_ERROR_ALREADY_TID: the transaction id has already been used (internal error) |
| 54 |
* @PK_CLIENT_ERROR_ROLE_UNKNOWN: the role was not set (internal error) |
| 55 |
* @PK_CLIENT_ERROR_CANNOT_START_DAEMON: the PackageKit daemon failed to start |
| 56 |
* @PK_CLIENT_ERROR_INVALID_INPUT: the package_id is invalid |
| 57 |
* @PK_CLIENT_ERROR_INVALID_FILE: the file is invalid |
| 58 |
* @PK_CLIENT_ERROR_NOT_SUPPORTED: the action is not supported |
| 59 |
* @PK_CLIENT_ERROR_DECLINED_SIMULATION: the simulation was declined by the user |
| 60 |
* @PK_CLIENT_ERROR_DECLINED_INTERACTION: the user declined interaction on the task |
| 61 |
* @PK_CLIENT_ERROR_LAST: |
| 62 |
* |
| 63 |
* Errors that can be thrown |
| 64 |
*/ |
| 65 |
typedef enum |
| 66 |
{ |
| 67 |
PK_CLIENT_ERROR_FAILED, |
| 68 |
PK_CLIENT_ERROR_FAILED_AUTH, |
| 69 |
PK_CLIENT_ERROR_NO_TID, |
| 70 |
PK_CLIENT_ERROR_ALREADY_TID, |
| 71 |
PK_CLIENT_ERROR_ROLE_UNKNOWN, |
| 72 |
PK_CLIENT_ERROR_CANNOT_START_DAEMON, |
| 73 |
PK_CLIENT_ERROR_INVALID_INPUT, |
| 74 |
PK_CLIENT_ERROR_INVALID_FILE, |
| 75 |
PK_CLIENT_ERROR_NOT_SUPPORTED, |
| 76 |
PK_CLIENT_ERROR_DECLINED_SIMULATION, |
| 77 |
PK_CLIENT_ERROR_DECLINED_INTERACTION, |
| 78 |
/* we define this so we can punt the PkErrorEnums here at offset 0xff */ |
| 79 |
PK_CLIENT_ERROR_LAST |
| 80 |
} PkClientError; |
| 81 |
|
| 82 |
typedef struct _PkClientPrivate PkClientPrivate; |
| 83 |
typedef struct _PkClient PkClient; |
| 84 |
typedef struct _PkClientClass PkClientClass; |
| 85 |
|
| 86 |
#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC |
| 87 |
G_DEFINE_AUTOPTR_CLEANUP_FUNC(PkClient, g_object_unref) |
| 88 |
#endif |
| 89 |
|
| 90 |
struct _PkClient |
| 91 |
{ |
| 92 |
GObject parent; |
| 93 |
PkClientPrivate *priv; |
| 94 |
}; |
| 95 |
|
| 96 |
struct _PkClientClass |
| 97 |
{ |
| 98 |
GObjectClass parent_class; |
| 99 |
|
| 100 |
/* signals */ |
| 101 |
void (* changed) (PkClient *client); |
| 102 |
/* padding for future expansion */ |
| 103 |
void (*_pk_reserved1) (void); |
| 104 |
void (*_pk_reserved2) (void); |
| 105 |
void (*_pk_reserved3) (void); |
| 106 |
void (*_pk_reserved4) (void); |
| 107 |
void (*_pk_reserved5) (void); |
| 108 |
}; |
| 109 |
|
| 110 |
GQuark pk_client_error_quark (void); |
| 111 |
GType pk_client_get_type (void); |
| 112 |
PkClient *pk_client_new (void); |
| 113 |
|
| 114 |
/* get transaction results */ |
| 115 |
PkResults *pk_client_generic_finish (PkClient *client, |
| 116 |
GAsyncResult *res, |
| 117 |
GError **error); |
| 118 |
|
| 119 |
void pk_client_resolve_async (PkClient *client, |
| 120 |
PkBitfield filters, |
| 121 |
gchar **packages, |
| 122 |
GCancellable *cancellable, |
| 123 |
PkProgressCallback progress_callback, |
| 124 |
gpointer progress_user_data, |
| 125 |
GAsyncReadyCallback callback_ready, |
| 126 |
gpointer user_data); |
| 127 |
|
| 128 |
void pk_client_search_names_async (PkClient *client, |
| 129 |
PkBitfield filters, |
| 130 |
gchar **values, |
| 131 |
GCancellable *cancellable, |
| 132 |
PkProgressCallback progress_callback, |
| 133 |
gpointer progress_user_data, |
| 134 |
GAsyncReadyCallback callback_ready, |
| 135 |
gpointer user_data); |
| 136 |
|
| 137 |
void pk_client_search_details_async (PkClient *client, |
| 138 |
PkBitfield filters, |
| 139 |
gchar **values, |
| 140 |
GCancellable *cancellable, |
| 141 |
PkProgressCallback progress_callback, |
| 142 |
gpointer progress_user_data, |
| 143 |
GAsyncReadyCallback callback_ready, |
| 144 |
gpointer user_data); |
| 145 |
|
| 146 |
void pk_client_search_groups_async (PkClient *client, |
| 147 |
PkBitfield filters, |
| 148 |
gchar **values, |
| 149 |
GCancellable *cancellable, |
| 150 |
PkProgressCallback progress_callback, |
| 151 |
gpointer progress_user_data, |
| 152 |
GAsyncReadyCallback callback_ready, |
| 153 |
gpointer user_data); |
| 154 |
|
| 155 |
void pk_client_search_files_async (PkClient *client, |
| 156 |
PkBitfield filters, |
| 157 |
gchar **values, |
| 158 |
GCancellable *cancellable, |
| 159 |
PkProgressCallback progress_callback, |
| 160 |
gpointer progress_user_data, |
| 161 |
GAsyncReadyCallback callback_ready, |
| 162 |
gpointer user_data); |
| 163 |
|
| 164 |
void pk_client_get_details_async (PkClient *client, |
| 165 |
gchar **package_ids, |
| 166 |
GCancellable *cancellable, |
| 167 |
PkProgressCallback progress_callback, |
| 168 |
gpointer progress_user_data, |
| 169 |
GAsyncReadyCallback callback_ready, |
| 170 |
gpointer user_data); |
| 171 |
|
| 172 |
void pk_client_get_details_local_async (PkClient *client, |
| 173 |
gchar **files, |
| 174 |
GCancellable *cancellable, |
| 175 |
PkProgressCallback progress_callback, |
| 176 |
gpointer progress_user_data, |
| 177 |
GAsyncReadyCallback callback_ready, |
| 178 |
gpointer user_data); |
| 179 |
|
| 180 |
void pk_client_get_files_local_async (PkClient *client, |
| 181 |
gchar **files, |
| 182 |
GCancellable *cancellable, |
| 183 |
PkProgressCallback progress_callback, |
| 184 |
gpointer progress_user_data, |
| 185 |
GAsyncReadyCallback callback_ready, |
| 186 |
gpointer user_data); |
| 187 |
|
| 188 |
void pk_client_get_update_detail_async (PkClient *client, |
| 189 |
gchar **package_ids, |
| 190 |
GCancellable *cancellable, |
| 191 |
PkProgressCallback progress_callback, |
| 192 |
gpointer progress_user_data, |
| 193 |
GAsyncReadyCallback callback_ready, |
| 194 |
gpointer user_data); |
| 195 |
|
| 196 |
void pk_client_download_packages_async (PkClient *client, |
| 197 |
gchar **package_ids, |
| 198 |
const gchar *directory, |
| 199 |
GCancellable *cancellable, |
| 200 |
PkProgressCallback progress_callback, |
| 201 |
gpointer progress_user_data, |
| 202 |
GAsyncReadyCallback callback_ready, |
| 203 |
gpointer user_data); |
| 204 |
|
| 205 |
void pk_client_get_updates_async (PkClient *client, |
| 206 |
PkBitfield filters, |
| 207 |
GCancellable *cancellable, |
| 208 |
PkProgressCallback progress_callback, |
| 209 |
gpointer progress_user_data, |
| 210 |
GAsyncReadyCallback callback_ready, |
| 211 |
gpointer user_data); |
| 212 |
|
| 213 |
void pk_client_get_old_transactions_async (PkClient *client, |
| 214 |
guint number, |
| 215 |
GCancellable *cancellable, |
| 216 |
PkProgressCallback progress_callback, |
| 217 |
gpointer progress_user_data, |
| 218 |
GAsyncReadyCallback callback_ready, |
| 219 |
gpointer user_data); |
| 220 |
|
| 221 |
void pk_client_depends_on_async (PkClient *client, |
| 222 |
PkBitfield filters, |
| 223 |
gchar **package_ids, |
| 224 |
gboolean recursive, |
| 225 |
GCancellable *cancellable, |
| 226 |
PkProgressCallback progress_callback, |
| 227 |
gpointer progress_user_data, |
| 228 |
GAsyncReadyCallback callback_ready, |
| 229 |
gpointer user_data); |
| 230 |
|
| 231 |
void pk_client_get_packages_async (PkClient *client, |
| 232 |
PkBitfield filters, |
| 233 |
GCancellable *cancellable, |
| 234 |
PkProgressCallback progress_callback, |
| 235 |
gpointer progress_user_data, |
| 236 |
GAsyncReadyCallback callback_ready, |
| 237 |
gpointer user_data); |
| 238 |
|
| 239 |
void pk_client_required_by_async (PkClient *client, |
| 240 |
PkBitfield filters, |
| 241 |
gchar **package_ids, |
| 242 |
gboolean recursive, |
| 243 |
GCancellable *cancellable, |
| 244 |
PkProgressCallback progress_callback, |
| 245 |
gpointer progress_user_data, |
| 246 |
GAsyncReadyCallback callback_ready, |
| 247 |
gpointer user_data); |
| 248 |
|
| 249 |
void pk_client_what_provides_async (PkClient *client, |
| 250 |
PkBitfield filters, |
| 251 |
gchar **values, |
| 252 |
GCancellable *cancellable, |
| 253 |
PkProgressCallback progress_callback, |
| 254 |
gpointer progress_user_data, |
| 255 |
GAsyncReadyCallback callback_ready, |
| 256 |
gpointer user_data); |
| 257 |
|
| 258 |
void pk_client_get_distro_upgrades_async (PkClient *client, |
| 259 |
GCancellable *cancellable, |
| 260 |
PkProgressCallback progress_callback, |
| 261 |
gpointer progress_user_data, |
| 262 |
GAsyncReadyCallback callback_ready, |
| 263 |
gpointer user_data); |
| 264 |
|
| 265 |
void pk_client_get_files_async (PkClient *client, |
| 266 |
gchar **package_ids, |
| 267 |
GCancellable *cancellable, |
| 268 |
PkProgressCallback progress_callback, |
| 269 |
gpointer progress_user_data, |
| 270 |
GAsyncReadyCallback callback_ready, |
| 271 |
gpointer user_data); |
| 272 |
|
| 273 |
void pk_client_get_categories_async (PkClient *client, |
| 274 |
GCancellable *cancellable, |
| 275 |
PkProgressCallback progress_callback, |
| 276 |
gpointer progress_user_data, |
| 277 |
GAsyncReadyCallback callback_ready, |
| 278 |
gpointer user_data); |
| 279 |
|
| 280 |
void pk_client_remove_packages_async (PkClient *client, |
| 281 |
PkBitfield transaction_flags, |
| 282 |
gchar **package_ids, |
| 283 |
gboolean allow_deps, |
| 284 |
gboolean autoremove, |
| 285 |
GCancellable *cancellable, |
| 286 |
PkProgressCallback progress_callback, |
| 287 |
gpointer progress_user_data, |
| 288 |
GAsyncReadyCallback callback_ready, |
| 289 |
gpointer user_data); |
| 290 |
|
| 291 |
void pk_client_refresh_cache_async (PkClient *client, |
| 292 |
gboolean force, |
| 293 |
GCancellable *cancellable, |
| 294 |
PkProgressCallback progress_callback, |
| 295 |
gpointer progress_user_data, |
| 296 |
GAsyncReadyCallback callback_ready, |
| 297 |
gpointer user_data); |
| 298 |
|
| 299 |
void pk_client_install_packages_async (PkClient *client, |
| 300 |
PkBitfield transaction_flags, |
| 301 |
gchar **package_ids, |
| 302 |
GCancellable *cancellable, |
| 303 |
PkProgressCallback progress_callback, |
| 304 |
gpointer progress_user_data, |
| 305 |
GAsyncReadyCallback callback_ready, |
| 306 |
gpointer user_data); |
| 307 |
|
| 308 |
void pk_client_install_signature_async (PkClient *client, |
| 309 |
PkSigTypeEnum type, |
| 310 |
const gchar *key_id, |
| 311 |
const gchar *package_id, |
| 312 |
GCancellable *cancellable, |
| 313 |
PkProgressCallback progress_callback, |
| 314 |
gpointer progress_user_data, |
| 315 |
GAsyncReadyCallback callback_ready, |
| 316 |
gpointer user_data); |
| 317 |
|
| 318 |
void pk_client_update_packages_async (PkClient *client, |
| 319 |
PkBitfield transaction_flags, |
| 320 |
gchar **package_ids, |
| 321 |
GCancellable *cancellable, |
| 322 |
PkProgressCallback progress_callback, |
| 323 |
gpointer progress_user_data, |
| 324 |
GAsyncReadyCallback callback_ready, |
| 325 |
gpointer user_data); |
| 326 |
|
| 327 |
void pk_client_install_files_async (PkClient *client, |
| 328 |
PkBitfield transaction_flags, |
| 329 |
gchar **files, |
| 330 |
GCancellable *cancellable, |
| 331 |
PkProgressCallback progress_callback, |
| 332 |
gpointer progress_user_data, |
| 333 |
GAsyncReadyCallback callback_ready, |
| 334 |
gpointer user_data); |
| 335 |
|
| 336 |
void pk_client_accept_eula_async (PkClient *client, |
| 337 |
const gchar *eula_id, |
| 338 |
GCancellable *cancellable, |
| 339 |
PkProgressCallback progress_callback, |
| 340 |
gpointer progress_user_data, |
| 341 |
GAsyncReadyCallback callback_ready, |
| 342 |
gpointer user_data); |
| 343 |
|
| 344 |
void pk_client_get_repo_list_async (PkClient *client, |
| 345 |
PkBitfield filters, |
| 346 |
GCancellable *cancellable, |
| 347 |
PkProgressCallback progress_callback, |
| 348 |
gpointer progress_user_data, |
| 349 |
GAsyncReadyCallback callback_ready, |
| 350 |
gpointer user_data); |
| 351 |
|
| 352 |
void pk_client_repo_enable_async (PkClient *client, |
| 353 |
const gchar *repo_id, |
| 354 |
gboolean enabled, |
| 355 |
GCancellable *cancellable, |
| 356 |
PkProgressCallback progress_callback, |
| 357 |
gpointer progress_user_data, |
| 358 |
GAsyncReadyCallback callback_ready, |
| 359 |
gpointer user_data); |
| 360 |
|
| 361 |
void pk_client_repo_set_data_async (PkClient *client, |
| 362 |
const gchar *repo_id, |
| 363 |
const gchar *parameter, |
| 364 |
const gchar *value, |
| 365 |
GCancellable *cancellable, |
| 366 |
PkProgressCallback progress_callback, |
| 367 |
gpointer progress_user_data, |
| 368 |
GAsyncReadyCallback callback_ready, |
| 369 |
gpointer user_data); |
| 370 |
|
| 371 |
void pk_client_repo_remove_async (PkClient *client, |
| 372 |
PkBitfield transaction_flags, |
| 373 |
const gchar *repo_id, |
| 374 |
gboolean autoremove, |
| 375 |
GCancellable *cancellable, |
| 376 |
PkProgressCallback progress_callback, |
| 377 |
gpointer progress_user_data, |
| 378 |
GAsyncReadyCallback callback_ready, |
| 379 |
gpointer user_data); |
| 380 |
|
| 381 |
void pk_client_upgrade_system_async (PkClient *client, |
| 382 |
PkBitfield transaction_flags, |
| 383 |
const gchar *distro_id, |
| 384 |
PkUpgradeKindEnum upgrade_kind, |
| 385 |
GCancellable *cancellable, |
| 386 |
PkProgressCallback progress_callback, |
| 387 |
gpointer progress_user_data, |
| 388 |
GAsyncReadyCallback callback_ready, |
| 389 |
gpointer user_data); |
| 390 |
|
| 391 |
void pk_client_repair_system_async (PkClient *client, |
| 392 |
PkBitfield transaction_flags, |
| 393 |
GCancellable *cancellable, |
| 394 |
PkProgressCallback progress_callback, |
| 395 |
gpointer progress_user_data, |
| 396 |
GAsyncReadyCallback callback_ready, |
| 397 |
gpointer user_data); |
| 398 |
|
| 399 |
void pk_client_adopt_async (PkClient *client, |
| 400 |
const gchar *transaction_id, |
| 401 |
GCancellable *cancellable, |
| 402 |
PkProgressCallback progress_callback, |
| 403 |
gpointer progress_user_data, |
| 404 |
GAsyncReadyCallback callback_ready, |
| 405 |
gpointer user_data); |
| 406 |
|
| 407 |
PkProgress *pk_client_get_progress_finish (PkClient *client, |
| 408 |
GAsyncResult *res, |
| 409 |
GError **error); |
| 410 |
|
| 411 |
void pk_client_get_progress_async (PkClient *client, |
| 412 |
const gchar *transaction_id, |
| 413 |
GCancellable *cancellable, |
| 414 |
GAsyncReadyCallback callback_ready, |
| 415 |
gpointer user_data); |
| 416 |
|
| 417 |
gboolean pk_client_create_helper_argv_envp (gchar ***argv, |
| 418 |
gchar ***envp_out); |
| 419 |
|
| 420 |
/* getters and setters */ |
| 421 |
void pk_client_set_locale (PkClient *client, |
| 422 |
const gchar *locale); |
| 423 |
const gchar *pk_client_get_locale (PkClient *client); |
| 424 |
void pk_client_set_background (PkClient *client, |
| 425 |
gboolean background); |
| 426 |
gboolean pk_client_get_background (PkClient *client); |
| 427 |
void pk_client_set_interactive (PkClient *client, |
| 428 |
gboolean interactive); |
| 429 |
gboolean pk_client_get_interactive (PkClient *client); |
| 430 |
gboolean pk_client_get_idle (PkClient *client); |
| 431 |
void pk_client_set_cache_age (PkClient *client, |
| 432 |
guint cache_age); |
| 433 |
guint pk_client_get_cache_age (PkClient *client); |
| 434 |
void pk_client_set_details_with_deps_size (PkClient *client, |
| 435 |
gboolean details_with_deps_size); |
| 436 |
gboolean pk_client_get_details_with_deps_size (PkClient *client); |
| 437 |
|
| 438 |
G_END_DECLS |
| 439 |
|
| 440 |
#endif /* __PK_CLIENT_H */ |
| 441 |
|