Allow PGP signature to be read from sync database
[pacman-ng.git] / lib / libalpm / alpm.h
blob44722c1cc0861f8399a7f83eda2ed8e78907c96b
1 /*
2 * alpm.h
4 * Copyright (c) 2006-2011 Pacman Development Team <pacman-dev@archlinux.org>
5 * Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
6 * Copyright (c) 2005 by Aurelien Foret <orelien@chez.com>
7 * Copyright (c) 2005 by Christian Hamar <krics@linuxforum.hu>
8 * Copyright (c) 2005, 2006 by Miklos Vajna <vmiklos@frugalware.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #ifndef _ALPM_H
24 #define _ALPM_H
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
30 #include <sys/types.h> /* for off_t */
31 #include <time.h> /* for time_t */
32 #include <stdarg.h> /* for va_list */
34 #include <alpm_list.h>
36 #define DEPRECATED __attribute__((deprecated))
39 * Arch Linux Package Management library
43 * Structures
46 typedef struct __pmdb_t pmdb_t;
47 typedef struct __pmpkg_t pmpkg_t;
48 typedef struct __pmpgpsig_t pmpgpsig_t;
49 typedef struct __pmdelta_t pmdelta_t;
50 typedef struct __pmgrp_t pmgrp_t;
51 typedef struct __pmtrans_t pmtrans_t;
52 typedef struct __pmdepend_t pmdepend_t;
53 typedef struct __pmdepmissing_t pmdepmissing_t;
54 typedef struct __pmconflict_t pmconflict_t;
55 typedef struct __pmfileconflict_t pmfileconflict_t;
58 * Library
61 int alpm_initialize(void);
62 int alpm_release(void);
63 const char *alpm_version(void);
66 * Logging facilities
69 /* Levels */
70 typedef enum _pmloglevel_t {
71 PM_LOG_ERROR = 1,
72 PM_LOG_WARNING = (1 << 1),
73 PM_LOG_DEBUG = (1 << 2),
74 PM_LOG_FUNCTION = (1 << 3)
75 } pmloglevel_t;
77 typedef void (*alpm_cb_log)(pmloglevel_t, const char *, va_list);
78 int alpm_logaction(const char *fmt, ...);
81 * Downloading
84 typedef void (*alpm_cb_download)(const char *filename,
85 off_t xfered, off_t total);
86 typedef void (*alpm_cb_totaldl)(off_t total);
87 /** A callback for downloading files
88 * @param url the URL of the file to be downloaded
89 * @param localpath the directory to which the file should be downloaded
90 * @param force whether to force an update, even if the file is the same
91 * @return 0 on success, 1 if the file exists and is identical, -1 on
92 * error.
94 typedef int (*alpm_cb_fetch)(const char *url, const char *localpath,
95 int force);
98 * Options
101 alpm_cb_log alpm_option_get_logcb(void);
102 void alpm_option_set_logcb(alpm_cb_log cb);
104 alpm_cb_download alpm_option_get_dlcb(void);
105 void alpm_option_set_dlcb(alpm_cb_download cb);
107 alpm_cb_fetch alpm_option_get_fetchcb(void);
108 void alpm_option_set_fetchcb(alpm_cb_fetch cb);
110 alpm_cb_totaldl alpm_option_get_totaldlcb(void);
111 void alpm_option_set_totaldlcb(alpm_cb_totaldl cb);
113 const char *alpm_option_get_root(void);
114 int alpm_option_set_root(const char *root);
116 const char *alpm_option_get_dbpath(void);
117 int alpm_option_set_dbpath(const char *dbpath);
119 alpm_list_t *alpm_option_get_cachedirs(void);
120 int alpm_option_add_cachedir(const char *cachedir);
121 void alpm_option_set_cachedirs(alpm_list_t *cachedirs);
122 int alpm_option_remove_cachedir(const char *cachedir);
124 const char *alpm_option_get_logfile(void);
125 int alpm_option_set_logfile(const char *logfile);
127 const char *alpm_option_get_lockfile(void);
128 /* no set_lockfile, path is determined from dbpath */
130 int alpm_option_get_usesyslog(void);
131 void alpm_option_set_usesyslog(int usesyslog);
133 alpm_list_t *alpm_option_get_noupgrades(void);
134 void alpm_option_add_noupgrade(const char *pkg);
135 void alpm_option_set_noupgrades(alpm_list_t *noupgrade);
136 int alpm_option_remove_noupgrade(const char *pkg);
138 alpm_list_t *alpm_option_get_noextracts(void);
139 void alpm_option_add_noextract(const char *pkg);
140 void alpm_option_set_noextracts(alpm_list_t *noextract);
141 int alpm_option_remove_noextract(const char *pkg);
143 alpm_list_t *alpm_option_get_ignorepkgs(void);
144 void alpm_option_add_ignorepkg(const char *pkg);
145 void alpm_option_set_ignorepkgs(alpm_list_t *ignorepkgs);
146 int alpm_option_remove_ignorepkg(const char *pkg);
148 alpm_list_t *alpm_option_get_ignoregrps(void);
149 void alpm_option_add_ignoregrp(const char *grp);
150 void alpm_option_set_ignoregrps(alpm_list_t *ignoregrps);
151 int alpm_option_remove_ignoregrp(const char *grp);
153 const char *alpm_option_get_arch(void);
154 void alpm_option_set_arch(const char *arch);
156 int alpm_option_get_usedelta(void);
157 void alpm_option_set_usedelta(int usedelta);
159 int alpm_option_get_checkspace(void);
160 void alpm_option_set_checkspace(int checkspace);
162 pmdb_t *alpm_option_get_localdb(void);
163 alpm_list_t *alpm_option_get_syncdbs(void);
166 * Install reasons -- ie, why the package was installed
169 typedef enum _pmpkgreason_t {
170 PM_PKG_REASON_EXPLICIT = 0, /* explicitly requested by the user */
171 PM_PKG_REASON_DEPEND = 1 /* installed as a dependency for another package */
172 } pmpkgreason_t;
175 * Databases
178 pmdb_t *alpm_db_register_sync(const char *treename);
179 int alpm_db_unregister(pmdb_t *db);
180 int alpm_db_unregister_all(void);
182 const char *alpm_db_get_name(const pmdb_t *db);
183 const char *alpm_db_get_url(const pmdb_t *db);
185 int alpm_db_setserver(pmdb_t *db, const char *url);
187 int alpm_db_update(int level, pmdb_t *db);
189 pmpkg_t *alpm_db_get_pkg(pmdb_t *db, const char *name);
190 alpm_list_t *alpm_db_get_pkgcache(pmdb_t *db);
192 pmgrp_t *alpm_db_readgrp(pmdb_t *db, const char *name);
193 alpm_list_t *alpm_db_get_grpcache(pmdb_t *db);
194 alpm_list_t *alpm_db_search(pmdb_t *db, const alpm_list_t* needles);
195 int alpm_db_set_pkgreason(pmdb_t *db, const char *name, pmpkgreason_t reason);
198 * Packages
201 /* Info parameters */
203 int alpm_pkg_load(const char *filename, int full, pmpkg_t **pkg);
204 int alpm_pkg_free(pmpkg_t *pkg);
205 int alpm_pkg_checkmd5sum(pmpkg_t *pkg);
206 char *alpm_fetch_pkgurl(const char *url);
207 int alpm_pkg_vercmp(const char *a, const char *b);
208 alpm_list_t *alpm_pkg_compute_requiredby(pmpkg_t *pkg);
210 const char *alpm_pkg_get_filename(pmpkg_t *pkg);
211 const char *alpm_pkg_get_name(pmpkg_t *pkg);
212 const char *alpm_pkg_get_version(pmpkg_t *pkg);
213 const char *alpm_pkg_get_desc(pmpkg_t *pkg);
214 const char *alpm_pkg_get_url(pmpkg_t *pkg);
215 time_t alpm_pkg_get_builddate(pmpkg_t *pkg);
216 time_t alpm_pkg_get_installdate(pmpkg_t *pkg);
217 const char *alpm_pkg_get_packager(pmpkg_t *pkg);
218 const char *alpm_pkg_get_md5sum(pmpkg_t *pkg);
219 const pmpgpsig_t *alpm_pkg_get_pgpsig(pmpkg_t *pkg);
220 const char *alpm_pkg_get_arch(pmpkg_t *pkg);
221 off_t alpm_pkg_get_size(pmpkg_t *pkg);
222 off_t alpm_pkg_get_isize(pmpkg_t *pkg);
223 pmpkgreason_t alpm_pkg_get_reason(pmpkg_t *pkg);
224 alpm_list_t *alpm_pkg_get_licenses(pmpkg_t *pkg);
225 alpm_list_t *alpm_pkg_get_groups(pmpkg_t *pkg);
226 alpm_list_t *alpm_pkg_get_depends(pmpkg_t *pkg);
227 alpm_list_t *alpm_pkg_get_optdepends(pmpkg_t *pkg);
228 alpm_list_t *alpm_pkg_get_conflicts(pmpkg_t *pkg);
229 alpm_list_t *alpm_pkg_get_provides(pmpkg_t *pkg);
230 alpm_list_t *alpm_pkg_get_deltas(pmpkg_t *pkg);
231 alpm_list_t *alpm_pkg_get_replaces(pmpkg_t *pkg);
232 alpm_list_t *alpm_pkg_get_files(pmpkg_t *pkg);
233 alpm_list_t *alpm_pkg_get_backup(pmpkg_t *pkg);
234 pmdb_t *alpm_pkg_get_db(pmpkg_t *pkg);
235 void *alpm_pkg_changelog_open(pmpkg_t *pkg);
236 size_t alpm_pkg_changelog_read(void *ptr, size_t size,
237 const pmpkg_t *pkg, const void *fp);
238 /*int alpm_pkg_changelog_feof(const pmpkg_t *pkg, void *fp);*/
239 int alpm_pkg_changelog_close(const pmpkg_t *pkg, void *fp);
240 int alpm_pkg_has_scriptlet(pmpkg_t *pkg);
242 off_t alpm_pkg_download_size(pmpkg_t *newpkg);
243 alpm_list_t *alpm_pkg_unused_deltas(pmpkg_t *pkg);
246 * Deltas
249 const char *alpm_delta_get_from(pmdelta_t *delta);
250 const char *alpm_delta_get_to(pmdelta_t *delta);
251 const char *alpm_delta_get_filename(pmdelta_t *delta);
252 const char *alpm_delta_get_md5sum(pmdelta_t *delta);
253 off_t alpm_delta_get_size(pmdelta_t *delta);
256 * Groups
258 const char *alpm_grp_get_name(const pmgrp_t *grp);
259 alpm_list_t *alpm_grp_get_pkgs(const pmgrp_t *grp);
260 alpm_list_t *alpm_find_grp_pkgs(alpm_list_t *dbs, const char *name);
263 * Sync
266 pmpkg_t *alpm_sync_newversion(pmpkg_t *pkg, alpm_list_t *dbs_sync);
269 * Transactions
273 /* Flags */
274 typedef enum _pmtransflag_t {
275 PM_TRANS_FLAG_NODEPS = 1,
276 PM_TRANS_FLAG_FORCE = (1 << 1),
277 PM_TRANS_FLAG_NOSAVE = (1 << 2),
278 PM_TRANS_FLAG_NODEPVERSION = (1 << 3),
279 PM_TRANS_FLAG_CASCADE = (1 << 4),
280 PM_TRANS_FLAG_RECURSE = (1 << 5),
281 PM_TRANS_FLAG_DBONLY = (1 << 6),
282 /* (1 << 7) flag can go here */
283 PM_TRANS_FLAG_ALLDEPS = (1 << 8),
284 PM_TRANS_FLAG_DOWNLOADONLY = (1 << 9),
285 PM_TRANS_FLAG_NOSCRIPTLET = (1 << 10),
286 PM_TRANS_FLAG_NOCONFLICTS = (1 << 11),
287 /* (1 << 12) flag can go here */
288 PM_TRANS_FLAG_NEEDED = (1 << 13),
289 PM_TRANS_FLAG_ALLEXPLICIT = (1 << 14),
290 PM_TRANS_FLAG_UNNEEDED = (1 << 15),
291 PM_TRANS_FLAG_RECURSEALL = (1 << 16),
292 PM_TRANS_FLAG_NOLOCK = (1 << 17)
293 } pmtransflag_t;
296 * @addtogroup alpm_trans
297 * @{
300 * @brief Transaction events.
301 * NULL parameters are passed to in all events unless specified otherwise.
303 typedef enum _pmtransevt_t {
304 /** Dependencies will be computed for a package. */
305 PM_TRANS_EVT_CHECKDEPS_START = 1,
306 /** Dependencies were computed for a package. */
307 PM_TRANS_EVT_CHECKDEPS_DONE,
308 /** File conflicts will be computed for a package. */
309 PM_TRANS_EVT_FILECONFLICTS_START,
310 /** File conflicts were computed for a package. */
311 PM_TRANS_EVT_FILECONFLICTS_DONE,
312 /** Dependencies will be resolved for target package. */
313 PM_TRANS_EVT_RESOLVEDEPS_START,
314 /** Dependencies were resolved for target package. */
315 PM_TRANS_EVT_RESOLVEDEPS_DONE,
316 /** Inter-conflicts will be checked for target package. */
317 PM_TRANS_EVT_INTERCONFLICTS_START,
318 /** Inter-conflicts were checked for target package. */
319 PM_TRANS_EVT_INTERCONFLICTS_DONE,
320 /** Package will be installed.
321 * A pointer to the target package is passed to the callback.
323 PM_TRANS_EVT_ADD_START,
324 /** Package was installed.
325 * A pointer to the new package is passed to the callback.
327 PM_TRANS_EVT_ADD_DONE,
328 /** Package will be removed.
329 * A pointer to the target package is passed to the callback.
331 PM_TRANS_EVT_REMOVE_START,
332 /** Package was removed.
333 * A pointer to the removed package is passed to the callback.
335 PM_TRANS_EVT_REMOVE_DONE,
336 /** Package will be upgraded.
337 * A pointer to the upgraded package is passed to the callback.
339 PM_TRANS_EVT_UPGRADE_START,
340 /** Package was upgraded.
341 * A pointer to the new package, and a pointer to the old package is passed
342 * to the callback, respectively.
344 PM_TRANS_EVT_UPGRADE_DONE,
345 /** Target package's integrity will be checked. */
346 PM_TRANS_EVT_INTEGRITY_START,
347 /** Target package's integrity was checked. */
348 PM_TRANS_EVT_INTEGRITY_DONE,
349 /** Target deltas's integrity will be checked. */
350 PM_TRANS_EVT_DELTA_INTEGRITY_START,
351 /** Target delta's integrity was checked. */
352 PM_TRANS_EVT_DELTA_INTEGRITY_DONE,
353 /** Deltas will be applied to packages. */
354 PM_TRANS_EVT_DELTA_PATCHES_START,
355 /** Deltas were applied to packages. */
356 PM_TRANS_EVT_DELTA_PATCHES_DONE,
357 /** Delta patch will be applied to target package.
358 * The filename of the package and the filename of the patch is passed to the
359 * callback.
361 PM_TRANS_EVT_DELTA_PATCH_START,
362 /** Delta patch was applied to target package. */
363 PM_TRANS_EVT_DELTA_PATCH_DONE,
364 /** Delta patch failed to apply to target package. */
365 PM_TRANS_EVT_DELTA_PATCH_FAILED,
366 /** Scriptlet has printed information.
367 * A line of text is passed to the callback.
369 PM_TRANS_EVT_SCRIPTLET_INFO,
370 /** Files will be downloaded from a repository.
371 * The repository's tree name is passed to the callback.
373 PM_TRANS_EVT_RETRIEVE_START,
374 /** Disk space usage will be computed for a package */
375 PM_TRANS_EVT_DISKSPACE_START,
376 /** Disk space usage was computed for a package */
377 PM_TRANS_EVT_DISKSPACE_DONE,
378 } pmtransevt_t;
379 /*@}*/
381 /* Transaction Conversations (ie, questions) */
382 typedef enum _pmtransconv_t {
383 PM_TRANS_CONV_INSTALL_IGNOREPKG = 1,
384 PM_TRANS_CONV_REPLACE_PKG = (1 << 1),
385 PM_TRANS_CONV_CONFLICT_PKG = (1 << 2),
386 PM_TRANS_CONV_CORRUPTED_PKG = (1 << 3),
387 PM_TRANS_CONV_LOCAL_NEWER = (1 << 4),
388 PM_TRANS_CONV_REMOVE_PKGS = (1 << 5),
389 PM_TRANS_CONV_SELECT_PROVIDER = (1 << 6),
390 } pmtransconv_t;
392 /* Transaction Progress */
393 typedef enum _pmtransprog_t {
394 PM_TRANS_PROGRESS_ADD_START,
395 PM_TRANS_PROGRESS_UPGRADE_START,
396 PM_TRANS_PROGRESS_REMOVE_START,
397 PM_TRANS_PROGRESS_CONFLICTS_START,
398 PM_TRANS_PROGRESS_DISKSPACE_START,
399 PM_TRANS_PROGRESS_INTEGRITY_START,
400 } pmtransprog_t;
402 /* Transaction Event callback */
403 typedef void (*alpm_trans_cb_event)(pmtransevt_t, void *, void *);
405 /* Transaction Conversation callback */
406 typedef void (*alpm_trans_cb_conv)(pmtransconv_t, void *, void *,
407 void *, int *);
409 /* Transaction Progress callback */
410 typedef void (*alpm_trans_cb_progress)(pmtransprog_t, const char *, int, size_t, size_t);
412 int alpm_trans_get_flags(void);
413 alpm_list_t * alpm_trans_get_add(void);
414 alpm_list_t * alpm_trans_get_remove(void);
415 int alpm_trans_init(pmtransflag_t flags,
416 alpm_trans_cb_event cb_event, alpm_trans_cb_conv conv,
417 alpm_trans_cb_progress cb_progress);
418 int alpm_trans_prepare(alpm_list_t **data);
419 int alpm_trans_commit(alpm_list_t **data);
420 int alpm_trans_interrupt(void);
421 int alpm_trans_release(void);
423 int alpm_sync_sysupgrade(int enable_downgrade);
424 int alpm_add_pkg(pmpkg_t *pkg);
425 int alpm_remove_pkg(pmpkg_t *pkg);
428 * Dependencies and conflicts
431 typedef enum _pmdepmod_t {
432 PM_DEP_MOD_ANY = 1,
433 PM_DEP_MOD_EQ,
434 PM_DEP_MOD_GE,
435 PM_DEP_MOD_LE,
436 PM_DEP_MOD_GT,
437 PM_DEP_MOD_LT
438 } pmdepmod_t;
440 alpm_list_t *alpm_checkdeps(alpm_list_t *pkglist, int reversedeps,
441 alpm_list_t *remove, alpm_list_t *upgrade);
442 pmpkg_t *alpm_find_satisfier(alpm_list_t *pkgs, const char *depstring);
443 pmpkg_t *alpm_find_dbs_satisfier(alpm_list_t *dbs, const char *depstring);
445 const char *alpm_miss_get_target(const pmdepmissing_t *miss);
446 pmdepend_t *alpm_miss_get_dep(pmdepmissing_t *miss);
447 const char *alpm_miss_get_causingpkg(const pmdepmissing_t *miss);
449 alpm_list_t *alpm_checkconflicts(alpm_list_t *pkglist);
451 const char *alpm_conflict_get_package1(pmconflict_t *conflict);
452 const char *alpm_conflict_get_package2(pmconflict_t *conflict);
453 const char *alpm_conflict_get_reason(pmconflict_t *conflict);
455 pmdepmod_t alpm_dep_get_mod(const pmdepend_t *dep);
456 const char *alpm_dep_get_name(const pmdepend_t *dep);
457 const char *alpm_dep_get_version(const pmdepend_t *dep);
458 char *alpm_dep_compute_string(const pmdepend_t *dep);
461 * File conflicts
464 typedef enum _pmfileconflicttype_t {
465 PM_FILECONFLICT_TARGET = 1,
466 PM_FILECONFLICT_FILESYSTEM
467 } pmfileconflicttype_t;
469 const char *alpm_fileconflict_get_target(pmfileconflict_t *conflict);
470 pmfileconflicttype_t alpm_fileconflict_get_type(pmfileconflict_t *conflict);
471 const char *alpm_fileconflict_get_file(pmfileconflict_t *conflict);
472 const char *alpm_fileconflict_get_ctarget(pmfileconflict_t *conflict);
475 * Helpers
478 /* checksums */
479 char *alpm_compute_md5sum(const char *name);
482 * Errors
484 enum _pmerrno_t {
485 PM_ERR_MEMORY = 1,
486 PM_ERR_SYSTEM,
487 PM_ERR_BADPERMS,
488 PM_ERR_NOT_A_FILE,
489 PM_ERR_NOT_A_DIR,
490 PM_ERR_WRONG_ARGS,
491 PM_ERR_DISK_SPACE,
492 /* Interface */
493 PM_ERR_HANDLE_NULL,
494 PM_ERR_HANDLE_NOT_NULL,
495 PM_ERR_HANDLE_LOCK,
496 /* Databases */
497 PM_ERR_DB_OPEN,
498 PM_ERR_DB_CREATE,
499 PM_ERR_DB_NULL,
500 PM_ERR_DB_NOT_NULL,
501 PM_ERR_DB_NOT_FOUND,
502 PM_ERR_DB_VERSION,
503 PM_ERR_DB_WRITE,
504 PM_ERR_DB_REMOVE,
505 /* Servers */
506 PM_ERR_SERVER_BAD_URL,
507 PM_ERR_SERVER_NONE,
508 /* Transactions */
509 PM_ERR_TRANS_NOT_NULL,
510 PM_ERR_TRANS_NULL,
511 PM_ERR_TRANS_DUP_TARGET,
512 PM_ERR_TRANS_NOT_INITIALIZED,
513 PM_ERR_TRANS_NOT_PREPARED,
514 PM_ERR_TRANS_ABORT,
515 PM_ERR_TRANS_TYPE,
516 PM_ERR_TRANS_NOT_LOCKED,
517 /* Packages */
518 PM_ERR_PKG_NOT_FOUND,
519 PM_ERR_PKG_IGNORED,
520 PM_ERR_PKG_INVALID,
521 PM_ERR_PKG_OPEN,
522 PM_ERR_PKG_CANT_REMOVE,
523 PM_ERR_PKG_INVALID_NAME,
524 PM_ERR_PKG_INVALID_ARCH,
525 PM_ERR_PKG_REPO_NOT_FOUND,
526 /* Deltas */
527 PM_ERR_DLT_INVALID,
528 PM_ERR_DLT_PATCHFAILED,
529 /* Dependencies */
530 PM_ERR_UNSATISFIED_DEPS,
531 PM_ERR_CONFLICTING_DEPS,
532 PM_ERR_FILE_CONFLICTS,
533 /* Misc */
534 PM_ERR_RETRIEVE,
535 PM_ERR_WRITE,
536 PM_ERR_INVALID_REGEX,
537 /* External library errors */
538 PM_ERR_LIBARCHIVE,
539 PM_ERR_LIBFETCH,
540 PM_ERR_LIBCURL,
541 PM_ERR_EXTERNAL_DOWNLOAD
544 extern enum _pmerrno_t pm_errno;
546 const char *alpm_strerror(int err);
547 const char *alpm_strerrorlast(void);
549 #ifdef __cplusplus
551 #endif
552 #endif /* _ALPM_H */
554 /* vim: set ts=2 sw=2 noet: */