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/>.
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
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
;
61 int alpm_initialize(void);
62 int alpm_release(void);
63 const char *alpm_version(void);
70 typedef enum _pmloglevel_t
{
72 PM_LOG_WARNING
= (1 << 1),
73 PM_LOG_DEBUG
= (1 << 2),
74 PM_LOG_FUNCTION
= (1 << 3)
77 typedef void (*alpm_cb_log
)(pmloglevel_t
, const char *, va_list);
78 int alpm_logaction(const char *fmt
, ...);
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
94 typedef int (*alpm_cb_fetch
)(const char *url
, const char *localpath
,
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 const char *alpm_option_get_signaturedir(void);
131 int alpm_option_set_signaturedir(const char *signaturedir
);
133 int alpm_option_get_usesyslog(void);
134 void alpm_option_set_usesyslog(int usesyslog
);
136 alpm_list_t
*alpm_option_get_noupgrades(void);
137 void alpm_option_add_noupgrade(const char *pkg
);
138 void alpm_option_set_noupgrades(alpm_list_t
*noupgrade
);
139 int alpm_option_remove_noupgrade(const char *pkg
);
141 alpm_list_t
*alpm_option_get_noextracts(void);
142 void alpm_option_add_noextract(const char *pkg
);
143 void alpm_option_set_noextracts(alpm_list_t
*noextract
);
144 int alpm_option_remove_noextract(const char *pkg
);
146 alpm_list_t
*alpm_option_get_ignorepkgs(void);
147 void alpm_option_add_ignorepkg(const char *pkg
);
148 void alpm_option_set_ignorepkgs(alpm_list_t
*ignorepkgs
);
149 int alpm_option_remove_ignorepkg(const char *pkg
);
151 alpm_list_t
*alpm_option_get_ignoregrps(void);
152 void alpm_option_add_ignoregrp(const char *grp
);
153 void alpm_option_set_ignoregrps(alpm_list_t
*ignoregrps
);
154 int alpm_option_remove_ignoregrp(const char *grp
);
156 const char *alpm_option_get_arch(void);
157 void alpm_option_set_arch(const char *arch
);
159 int alpm_option_get_usedelta(void);
160 void alpm_option_set_usedelta(int usedelta
);
162 int alpm_option_get_checkspace(void);
163 void alpm_option_set_checkspace(int checkspace
);
165 pmdb_t
*alpm_option_get_localdb(void);
166 alpm_list_t
*alpm_option_get_syncdbs(void);
169 * Install reasons -- ie, why the package was installed
172 typedef enum _pmpkgreason_t
{
173 PM_PKG_REASON_EXPLICIT
= 0, /* explicitly requested by the user */
174 PM_PKG_REASON_DEPEND
= 1 /* installed as a dependency for another package */
181 pmdb_t
*alpm_db_register_sync(const char *treename
);
182 int alpm_db_unregister(pmdb_t
*db
);
183 int alpm_db_unregister_all(void);
185 const char *alpm_db_get_name(const pmdb_t
*db
);
186 const char *alpm_db_get_url(const pmdb_t
*db
);
188 int alpm_db_setserver(pmdb_t
*db
, const char *url
);
190 int alpm_db_update(int level
, pmdb_t
*db
);
192 pmpkg_t
*alpm_db_get_pkg(pmdb_t
*db
, const char *name
);
193 alpm_list_t
*alpm_db_get_pkgcache(pmdb_t
*db
);
195 pmgrp_t
*alpm_db_readgrp(pmdb_t
*db
, const char *name
);
196 alpm_list_t
*alpm_db_get_grpcache(pmdb_t
*db
);
197 alpm_list_t
*alpm_db_search(pmdb_t
*db
, const alpm_list_t
* needles
);
198 int alpm_db_set_pkgreason(pmdb_t
*db
, const char *name
, pmpkgreason_t reason
);
204 /* Info parameters */
206 int alpm_pkg_load(const char *filename
, int full
, pmpkg_t
**pkg
);
207 int alpm_pkg_free(pmpkg_t
*pkg
);
208 int alpm_pkg_checkmd5sum(pmpkg_t
*pkg
);
209 char *alpm_fetch_pkgurl(const char *url
);
210 int alpm_pkg_vercmp(const char *a
, const char *b
);
211 alpm_list_t
*alpm_pkg_compute_requiredby(pmpkg_t
*pkg
);
213 const char *alpm_pkg_get_filename(pmpkg_t
*pkg
);
214 const char *alpm_pkg_get_name(pmpkg_t
*pkg
);
215 const char *alpm_pkg_get_version(pmpkg_t
*pkg
);
216 const char *alpm_pkg_get_desc(pmpkg_t
*pkg
);
217 const char *alpm_pkg_get_url(pmpkg_t
*pkg
);
218 time_t alpm_pkg_get_builddate(pmpkg_t
*pkg
);
219 time_t alpm_pkg_get_installdate(pmpkg_t
*pkg
);
220 const char *alpm_pkg_get_packager(pmpkg_t
*pkg
);
221 const char *alpm_pkg_get_md5sum(pmpkg_t
*pkg
);
222 const pmpgpsig_t
*alpm_pkg_get_pgpsig(pmpkg_t
*pkg
);
223 const char *alpm_pkg_get_arch(pmpkg_t
*pkg
);
224 off_t
alpm_pkg_get_size(pmpkg_t
*pkg
);
225 off_t
alpm_pkg_get_isize(pmpkg_t
*pkg
);
226 pmpkgreason_t
alpm_pkg_get_reason(pmpkg_t
*pkg
);
227 alpm_list_t
*alpm_pkg_get_licenses(pmpkg_t
*pkg
);
228 alpm_list_t
*alpm_pkg_get_groups(pmpkg_t
*pkg
);
229 alpm_list_t
*alpm_pkg_get_depends(pmpkg_t
*pkg
);
230 alpm_list_t
*alpm_pkg_get_optdepends(pmpkg_t
*pkg
);
231 alpm_list_t
*alpm_pkg_get_conflicts(pmpkg_t
*pkg
);
232 alpm_list_t
*alpm_pkg_get_provides(pmpkg_t
*pkg
);
233 alpm_list_t
*alpm_pkg_get_deltas(pmpkg_t
*pkg
);
234 alpm_list_t
*alpm_pkg_get_replaces(pmpkg_t
*pkg
);
235 alpm_list_t
*alpm_pkg_get_files(pmpkg_t
*pkg
);
236 alpm_list_t
*alpm_pkg_get_backup(pmpkg_t
*pkg
);
237 pmdb_t
*alpm_pkg_get_db(pmpkg_t
*pkg
);
238 void *alpm_pkg_changelog_open(pmpkg_t
*pkg
);
239 size_t alpm_pkg_changelog_read(void *ptr
, size_t size
,
240 const pmpkg_t
*pkg
, const void *fp
);
241 /*int alpm_pkg_changelog_feof(const pmpkg_t *pkg, void *fp);*/
242 int alpm_pkg_changelog_close(const pmpkg_t
*pkg
, void *fp
);
243 int alpm_pkg_has_scriptlet(pmpkg_t
*pkg
);
245 off_t
alpm_pkg_download_size(pmpkg_t
*newpkg
);
246 alpm_list_t
*alpm_pkg_unused_deltas(pmpkg_t
*pkg
);
252 int alpm_pkg_check_pgp_signature(pmpkg_t
*pkg
);
253 int alpm_db_check_pgp_signature(pmdb_t
*db
);
255 /* GPG signature verification option */
256 typedef enum _pgp_verify_t
{
257 PM_PGP_VERIFY_ALWAYS
,
258 PM_PGP_VERIFY_OPTIONAL
,
262 int alpm_db_set_pgp_verify(pmdb_t
*db
, pgp_verify_t verify
);
268 const char *alpm_delta_get_from(pmdelta_t
*delta
);
269 const char *alpm_delta_get_to(pmdelta_t
*delta
);
270 const char *alpm_delta_get_filename(pmdelta_t
*delta
);
271 const char *alpm_delta_get_md5sum(pmdelta_t
*delta
);
272 off_t
alpm_delta_get_size(pmdelta_t
*delta
);
277 const char *alpm_grp_get_name(const pmgrp_t
*grp
);
278 alpm_list_t
*alpm_grp_get_pkgs(const pmgrp_t
*grp
);
279 alpm_list_t
*alpm_find_grp_pkgs(alpm_list_t
*dbs
, const char *name
);
285 pmpkg_t
*alpm_sync_newversion(pmpkg_t
*pkg
, alpm_list_t
*dbs_sync
);
293 typedef enum _pmtransflag_t
{
294 PM_TRANS_FLAG_NODEPS
= 1,
295 PM_TRANS_FLAG_FORCE
= (1 << 1),
296 PM_TRANS_FLAG_NOSAVE
= (1 << 2),
297 PM_TRANS_FLAG_NODEPVERSION
= (1 << 3),
298 PM_TRANS_FLAG_CASCADE
= (1 << 4),
299 PM_TRANS_FLAG_RECURSE
= (1 << 5),
300 PM_TRANS_FLAG_DBONLY
= (1 << 6),
301 /* (1 << 7) flag can go here */
302 PM_TRANS_FLAG_ALLDEPS
= (1 << 8),
303 PM_TRANS_FLAG_DOWNLOADONLY
= (1 << 9),
304 PM_TRANS_FLAG_NOSCRIPTLET
= (1 << 10),
305 PM_TRANS_FLAG_NOCONFLICTS
= (1 << 11),
306 /* (1 << 12) flag can go here */
307 PM_TRANS_FLAG_NEEDED
= (1 << 13),
308 PM_TRANS_FLAG_ALLEXPLICIT
= (1 << 14),
309 PM_TRANS_FLAG_UNNEEDED
= (1 << 15),
310 PM_TRANS_FLAG_RECURSEALL
= (1 << 16),
311 PM_TRANS_FLAG_NOLOCK
= (1 << 17)
315 * @addtogroup alpm_trans
319 * @brief Transaction events.
320 * NULL parameters are passed to in all events unless specified otherwise.
322 typedef enum _pmtransevt_t
{
323 /** Dependencies will be computed for a package. */
324 PM_TRANS_EVT_CHECKDEPS_START
= 1,
325 /** Dependencies were computed for a package. */
326 PM_TRANS_EVT_CHECKDEPS_DONE
,
327 /** File conflicts will be computed for a package. */
328 PM_TRANS_EVT_FILECONFLICTS_START
,
329 /** File conflicts were computed for a package. */
330 PM_TRANS_EVT_FILECONFLICTS_DONE
,
331 /** Dependencies will be resolved for target package. */
332 PM_TRANS_EVT_RESOLVEDEPS_START
,
333 /** Dependencies were resolved for target package. */
334 PM_TRANS_EVT_RESOLVEDEPS_DONE
,
335 /** Inter-conflicts will be checked for target package. */
336 PM_TRANS_EVT_INTERCONFLICTS_START
,
337 /** Inter-conflicts were checked for target package. */
338 PM_TRANS_EVT_INTERCONFLICTS_DONE
,
339 /** Package will be installed.
340 * A pointer to the target package is passed to the callback.
342 PM_TRANS_EVT_ADD_START
,
343 /** Package was installed.
344 * A pointer to the new package is passed to the callback.
346 PM_TRANS_EVT_ADD_DONE
,
347 /** Package will be removed.
348 * A pointer to the target package is passed to the callback.
350 PM_TRANS_EVT_REMOVE_START
,
351 /** Package was removed.
352 * A pointer to the removed package is passed to the callback.
354 PM_TRANS_EVT_REMOVE_DONE
,
355 /** Package will be upgraded.
356 * A pointer to the upgraded package is passed to the callback.
358 PM_TRANS_EVT_UPGRADE_START
,
359 /** Package was upgraded.
360 * A pointer to the new package, and a pointer to the old package is passed
361 * to the callback, respectively.
363 PM_TRANS_EVT_UPGRADE_DONE
,
364 /** Target package's integrity will be checked. */
365 PM_TRANS_EVT_INTEGRITY_START
,
366 /** Target package's integrity was checked. */
367 PM_TRANS_EVT_INTEGRITY_DONE
,
368 /** Target deltas's integrity will be checked. */
369 PM_TRANS_EVT_DELTA_INTEGRITY_START
,
370 /** Target delta's integrity was checked. */
371 PM_TRANS_EVT_DELTA_INTEGRITY_DONE
,
372 /** Deltas will be applied to packages. */
373 PM_TRANS_EVT_DELTA_PATCHES_START
,
374 /** Deltas were applied to packages. */
375 PM_TRANS_EVT_DELTA_PATCHES_DONE
,
376 /** Delta patch will be applied to target package.
377 * The filename of the package and the filename of the patch is passed to the
380 PM_TRANS_EVT_DELTA_PATCH_START
,
381 /** Delta patch was applied to target package. */
382 PM_TRANS_EVT_DELTA_PATCH_DONE
,
383 /** Delta patch failed to apply to target package. */
384 PM_TRANS_EVT_DELTA_PATCH_FAILED
,
385 /** Scriptlet has printed information.
386 * A line of text is passed to the callback.
388 PM_TRANS_EVT_SCRIPTLET_INFO
,
389 /** Files will be downloaded from a repository.
390 * The repository's tree name is passed to the callback.
392 PM_TRANS_EVT_RETRIEVE_START
,
393 /** Disk space usage will be computed for a package */
394 PM_TRANS_EVT_DISKSPACE_START
,
395 /** Disk space usage was computed for a package */
396 PM_TRANS_EVT_DISKSPACE_DONE
,
400 /* Transaction Conversations (ie, questions) */
401 typedef enum _pmtransconv_t
{
402 PM_TRANS_CONV_INSTALL_IGNOREPKG
= 1,
403 PM_TRANS_CONV_REPLACE_PKG
= (1 << 1),
404 PM_TRANS_CONV_CONFLICT_PKG
= (1 << 2),
405 PM_TRANS_CONV_CORRUPTED_PKG
= (1 << 3),
406 PM_TRANS_CONV_LOCAL_NEWER
= (1 << 4),
407 PM_TRANS_CONV_REMOVE_PKGS
= (1 << 5),
408 PM_TRANS_CONV_SELECT_PROVIDER
= (1 << 6),
411 /* Transaction Progress */
412 typedef enum _pmtransprog_t
{
413 PM_TRANS_PROGRESS_ADD_START
,
414 PM_TRANS_PROGRESS_UPGRADE_START
,
415 PM_TRANS_PROGRESS_REMOVE_START
,
416 PM_TRANS_PROGRESS_CONFLICTS_START
,
417 PM_TRANS_PROGRESS_DISKSPACE_START
,
418 PM_TRANS_PROGRESS_INTEGRITY_START
,
421 /* Transaction Event callback */
422 typedef void (*alpm_trans_cb_event
)(pmtransevt_t
, void *, void *);
424 /* Transaction Conversation callback */
425 typedef void (*alpm_trans_cb_conv
)(pmtransconv_t
, void *, void *,
428 /* Transaction Progress callback */
429 typedef void (*alpm_trans_cb_progress
)(pmtransprog_t
, const char *, int, size_t, size_t);
431 int alpm_trans_get_flags(void);
432 alpm_list_t
* alpm_trans_get_add(void);
433 alpm_list_t
* alpm_trans_get_remove(void);
434 int alpm_trans_init(pmtransflag_t flags
,
435 alpm_trans_cb_event cb_event
, alpm_trans_cb_conv conv
,
436 alpm_trans_cb_progress cb_progress
);
437 int alpm_trans_prepare(alpm_list_t
**data
);
438 int alpm_trans_commit(alpm_list_t
**data
);
439 int alpm_trans_interrupt(void);
440 int alpm_trans_release(void);
442 int alpm_sync_sysupgrade(int enable_downgrade
);
443 int alpm_add_pkg(pmpkg_t
*pkg
);
444 int alpm_remove_pkg(pmpkg_t
*pkg
);
447 * Dependencies and conflicts
450 typedef enum _pmdepmod_t
{
459 alpm_list_t
*alpm_checkdeps(alpm_list_t
*pkglist
, int reversedeps
,
460 alpm_list_t
*remove
, alpm_list_t
*upgrade
);
461 pmpkg_t
*alpm_find_satisfier(alpm_list_t
*pkgs
, const char *depstring
);
462 pmpkg_t
*alpm_find_dbs_satisfier(alpm_list_t
*dbs
, const char *depstring
);
464 const char *alpm_miss_get_target(const pmdepmissing_t
*miss
);
465 pmdepend_t
*alpm_miss_get_dep(pmdepmissing_t
*miss
);
466 const char *alpm_miss_get_causingpkg(const pmdepmissing_t
*miss
);
468 alpm_list_t
*alpm_checkconflicts(alpm_list_t
*pkglist
);
470 const char *alpm_conflict_get_package1(pmconflict_t
*conflict
);
471 const char *alpm_conflict_get_package2(pmconflict_t
*conflict
);
472 const char *alpm_conflict_get_reason(pmconflict_t
*conflict
);
474 pmdepmod_t
alpm_dep_get_mod(const pmdepend_t
*dep
);
475 const char *alpm_dep_get_name(const pmdepend_t
*dep
);
476 const char *alpm_dep_get_version(const pmdepend_t
*dep
);
477 char *alpm_dep_compute_string(const pmdepend_t
*dep
);
483 typedef enum _pmfileconflicttype_t
{
484 PM_FILECONFLICT_TARGET
= 1,
485 PM_FILECONFLICT_FILESYSTEM
486 } pmfileconflicttype_t
;
488 const char *alpm_fileconflict_get_target(pmfileconflict_t
*conflict
);
489 pmfileconflicttype_t
alpm_fileconflict_get_type(pmfileconflict_t
*conflict
);
490 const char *alpm_fileconflict_get_file(pmfileconflict_t
*conflict
);
491 const char *alpm_fileconflict_get_ctarget(pmfileconflict_t
*conflict
);
498 char *alpm_compute_md5sum(const char *name
);
513 PM_ERR_HANDLE_NOT_NULL
,
525 PM_ERR_SERVER_BAD_URL
,
528 PM_ERR_TRANS_NOT_NULL
,
530 PM_ERR_TRANS_DUP_TARGET
,
531 PM_ERR_TRANS_NOT_INITIALIZED
,
532 PM_ERR_TRANS_NOT_PREPARED
,
535 PM_ERR_TRANS_NOT_LOCKED
,
537 PM_ERR_PKG_NOT_FOUND
,
541 PM_ERR_PKG_CANT_REMOVE
,
542 PM_ERR_PKG_INVALID_NAME
,
543 PM_ERR_PKG_INVALID_ARCH
,
544 PM_ERR_PKG_REPO_NOT_FOUND
,
546 PM_ERR_SIG_MISSINGDIR
,
551 PM_ERR_DLT_PATCHFAILED
,
553 PM_ERR_UNSATISFIED_DEPS
,
554 PM_ERR_CONFLICTING_DEPS
,
555 PM_ERR_FILE_CONFLICTS
,
559 PM_ERR_INVALID_REGEX
,
560 /* External library errors */
563 PM_ERR_EXTERNAL_DOWNLOAD
,
567 extern enum _pmerrno_t pm_errno
;
569 const char *alpm_strerror(int err
);
570 const char *alpm_strerrorlast(void);
577 /* vim: set ts=2 sw=2 noet: */