2005-03-15 01:51:43 +00:00
|
|
|
/*
|
|
|
|
* alpm.h
|
2007-11-16 20:18:45 -06:00
|
|
|
*
|
2022-01-02 13:34:52 +10:00
|
|
|
* Copyright (c) 2006-2022 Pacman Development Team <pacman-dev@lists.archlinux.org>
|
2009-07-01 02:08:33 -05:00
|
|
|
* Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
|
2006-10-15 19:31:03 +00:00
|
|
|
* Copyright (c) 2005 by Aurelien Foret <orelien@chez.com>
|
|
|
|
* Copyright (c) 2005 by Christian Hamar <krics@linuxforum.hu>
|
|
|
|
* Copyright (c) 2005, 2006 by Miklos Vajna <vmiklos@frugalware.org>
|
2007-11-16 20:18:45 -06:00
|
|
|
*
|
2005-03-15 01:51:43 +00:00
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
2007-12-10 22:55:22 -06:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2005-03-15 01:51:43 +00:00
|
|
|
*/
|
2020-12-07 22:19:35 +00:00
|
|
|
|
|
|
|
|
|
|
|
/** @mainpage alpm
|
|
|
|
*
|
|
|
|
* libalpm is a package management library, primarily used by pacman.
|
|
|
|
*/
|
|
|
|
|
2016-09-03 22:14:49 -05:00
|
|
|
#ifndef ALPM_H
|
|
|
|
#define ALPM_H
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2005-12-28 10:38:12 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2012-01-06 16:09:19 -06:00
|
|
|
#include <stdint.h> /* int64_t */
|
2011-09-07 10:21:47 -05:00
|
|
|
#include <sys/types.h> /* off_t */
|
|
|
|
#include <stdarg.h> /* va_list */
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2012-05-02 11:08:07 +10:00
|
|
|
/* libarchive */
|
|
|
|
#include <archive.h>
|
|
|
|
#include <archive_entry.h>
|
|
|
|
|
2007-10-14 17:29:32 -05:00
|
|
|
#include <alpm_list.h>
|
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm The libalpm Public API
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*
|
2021-01-09 09:19:50 +10:00
|
|
|
* libalpm is a package management library, primarily used by pacman.
|
2020-12-29 11:54:56 +10:00
|
|
|
* For ease of access, the libalpm manual has been split up into several sections.
|
2020-12-07 22:19:54 +00:00
|
|
|
*
|
|
|
|
* @section see_also See Also
|
2020-12-29 11:54:56 +10:00
|
|
|
* \b libalpm_list(3),
|
2021-01-09 09:26:53 +10:00
|
|
|
* \b libalpm_cb(3),
|
2021-01-09 09:19:50 +10:00
|
|
|
* \b libalpm_databases(3),
|
|
|
|
* \b libalpm_depends(3),
|
|
|
|
* \b libalpm_errors(3),
|
|
|
|
* \b libalpm_files(3),
|
|
|
|
* \b libalpm_groups(3),
|
2021-01-09 09:26:53 +10:00
|
|
|
* \b libalpm_handle(3),
|
|
|
|
* \b libalpm_log(3),
|
|
|
|
* \b libalpm_misc(3),
|
2021-01-09 09:19:50 +10:00
|
|
|
* \b libalpm_options(3),
|
|
|
|
* \b libalpm_packages(3),
|
|
|
|
* \b libalpm_sig(3),
|
|
|
|
* \b libalpm_trans(3)
|
2020-12-07 22:19:49 +00:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2005-03-15 01:51:43 +00:00
|
|
|
/*
|
2020-12-07 22:19:36 +00:00
|
|
|
* Opaque Structures
|
2005-03-15 01:51:43 +00:00
|
|
|
*/
|
|
|
|
|
2020-12-07 22:19:36 +00:00
|
|
|
/** The libalpm context handle.
|
|
|
|
*
|
|
|
|
* This struct represents an instance of libalpm.
|
2020-12-29 11:54:56 +10:00
|
|
|
* @ingroup libalpm_handle
|
2014-03-16 13:40:54 +01:00
|
|
|
*/
|
2021-05-03 11:58:22 +01:00
|
|
|
typedef struct _alpm_handle_t alpm_handle_t;
|
2020-12-07 22:19:36 +00:00
|
|
|
|
|
|
|
/** A database.
|
|
|
|
*
|
|
|
|
* A database is a container that stores metadata about packages.
|
|
|
|
*
|
|
|
|
* A database can be located on the local filesystem or on a remote server.
|
|
|
|
*
|
|
|
|
* To use a database, it must first be registered via \link alpm_register_syncdb \endlink.
|
2020-12-29 23:31:21 +00:00
|
|
|
* If the database is already present in dbpath then it will be usable. Otherwise,
|
2020-12-07 22:19:36 +00:00
|
|
|
* the database needs to be downloaded using \link alpm_db_update \endlink. Even if the
|
|
|
|
* source of the database is the local filesystem.
|
|
|
|
*
|
|
|
|
* After this, the database can be used to query packages and groups. Any packages or groups
|
|
|
|
* from the database will continue to be owned by the database and do not need to be freed by
|
|
|
|
* the user. They will be freed when the database is unregistered.
|
|
|
|
*
|
|
|
|
* Databases are automatically unregistered when the \link alpm_handle_t \endlink is released.
|
2020-12-29 11:54:56 +10:00
|
|
|
* @ingroup libalpm_databases
|
2020-12-07 22:19:36 +00:00
|
|
|
*/
|
2021-05-03 11:58:22 +01:00
|
|
|
typedef struct _alpm_db_t alpm_db_t;
|
2020-12-07 22:19:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
/** A package.
|
|
|
|
*
|
|
|
|
* A package can be loaded from disk via \link alpm_pkg_load \endlink or retrieved from a database.
|
|
|
|
* Packages from databases are automatically freed when the database is unregistered. Packages loaded
|
|
|
|
* from a file must be freed manually.
|
|
|
|
*
|
2022-03-06 15:26:37 +10:00
|
|
|
* Packages can then be queried for metadata or added to a transaction
|
2020-12-07 22:19:36 +00:00
|
|
|
* to be added or removed from the system.
|
2020-12-29 11:54:56 +10:00
|
|
|
* @ingroup libalpm_packages
|
2020-12-07 22:19:36 +00:00
|
|
|
*/
|
2021-05-03 11:58:22 +01:00
|
|
|
typedef struct _alpm_pkg_t alpm_pkg_t;
|
2020-12-07 22:19:36 +00:00
|
|
|
|
2022-11-08 14:19:35 +10:00
|
|
|
/** The extended data type used to store non-standard package data fields
|
|
|
|
* @ingroup libalpm_packages
|
|
|
|
*/
|
|
|
|
typedef struct _alpm_pkg_xdata_t {
|
|
|
|
char *name;
|
|
|
|
char *value;
|
|
|
|
} alpm_pkg_xdata_t;
|
|
|
|
|
2020-12-07 22:19:50 +00:00
|
|
|
/** The time type used by libalpm. Represents a unix time stamp
|
2020-12-29 11:54:56 +10:00
|
|
|
* @ingroup libalpm_misc */
|
2020-12-07 22:19:50 +00:00
|
|
|
typedef int64_t alpm_time_t;
|
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_files Files
|
2020-12-07 22:19:44 +00:00
|
|
|
* @brief Functions for package files
|
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:41 +00:00
|
|
|
|
|
|
|
/** File in a package */
|
|
|
|
typedef struct _alpm_file_t {
|
2020-12-07 22:19:44 +00:00
|
|
|
/** Name of the file */
|
|
|
|
char *name;
|
|
|
|
/** Size of the file */
|
|
|
|
off_t size;
|
|
|
|
/** The file's permissions */
|
|
|
|
mode_t mode;
|
2020-12-07 22:19:41 +00:00
|
|
|
} alpm_file_t;
|
|
|
|
|
|
|
|
/** Package filelist container */
|
|
|
|
typedef struct _alpm_filelist_t {
|
2020-12-07 22:19:44 +00:00
|
|
|
/** Amount of files in the array */
|
|
|
|
size_t count;
|
|
|
|
/** An array of files */
|
|
|
|
alpm_file_t *files;
|
2020-12-07 22:19:41 +00:00
|
|
|
} alpm_filelist_t;
|
|
|
|
|
|
|
|
/** Local package or package file backup entry */
|
|
|
|
typedef struct _alpm_backup_t {
|
2020-12-07 22:19:44 +00:00
|
|
|
/** Name of the file (without .pacsave extension) */
|
|
|
|
char *name;
|
|
|
|
/** Hash of the filename (used internally) */
|
|
|
|
char *hash;
|
2020-12-07 22:19:41 +00:00
|
|
|
} alpm_backup_t;
|
|
|
|
|
2020-12-07 22:19:44 +00:00
|
|
|
/** Determines whether a package filelist contains a given path.
|
|
|
|
* The provided path should be relative to the install root with no leading
|
|
|
|
* slashes, e.g. "etc/localtime". When searching for directories, the path must
|
|
|
|
* have a trailing slash.
|
|
|
|
* @param filelist a pointer to a package filelist
|
|
|
|
* @param path the path to search for in the package
|
|
|
|
* @return a pointer to the matching file or NULL if not found
|
|
|
|
*/
|
2022-01-09 16:58:55 +00:00
|
|
|
alpm_file_t *alpm_filelist_contains(const alpm_filelist_t *filelist, const char *path);
|
2020-12-07 22:19:44 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_files */
|
2020-12-07 22:19:44 +00:00
|
|
|
/** @} */
|
2020-12-07 22:19:41 +00:00
|
|
|
|
2020-12-07 22:19:36 +00:00
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_groups Groups
|
2020-12-07 22:19:44 +00:00
|
|
|
* @brief Functions for package groups
|
2020-12-07 22:19:36 +00:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2020-12-07 22:19:44 +00:00
|
|
|
/** Package group */
|
|
|
|
typedef struct _alpm_group_t {
|
|
|
|
/** group name */
|
|
|
|
char *name;
|
|
|
|
/** list of alpm_pkg_t packages */
|
|
|
|
alpm_list_t *packages;
|
|
|
|
} alpm_group_t;
|
|
|
|
|
|
|
|
/** Find group members across a list of databases.
|
|
|
|
* If a member exists in several databases, only the first database is used.
|
|
|
|
* IgnorePkg is also handled.
|
|
|
|
* @param dbs the list of alpm_db_t *
|
|
|
|
* @param name the name of the group
|
|
|
|
* @return the list of alpm_pkg_t * (caller is responsible for alpm_list_free)
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_find_group_pkgs(alpm_list_t *dbs, const char *name);
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_groups */
|
2020-12-07 22:19:44 +00:00
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_errors Error Codes
|
2020-12-07 22:19:36 +00:00
|
|
|
* Error codes returned by libalpm.
|
2014-03-16 13:40:54 +01:00
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:36 +00:00
|
|
|
|
|
|
|
/** libalpm's error type */
|
2014-03-16 13:40:54 +01:00
|
|
|
typedef enum _alpm_errno_t {
|
2020-12-07 22:19:36 +00:00
|
|
|
/** No error */
|
2016-10-12 15:13:31 -05:00
|
|
|
ALPM_ERR_OK = 0,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to allocate memory */
|
2016-10-12 15:13:31 -05:00
|
|
|
ALPM_ERR_MEMORY,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** A system error occurred */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_SYSTEM,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Permmision denied */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_BADPERMS,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Should be a file */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_NOT_A_FILE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Should be a directory */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_NOT_A_DIR,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Function was called with invalid arguments */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_WRONG_ARGS,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Insufficient disk space */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DISK_SPACE,
|
|
|
|
/* Interface */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Handle should be null */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_HANDLE_NULL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Handle should not be null */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_HANDLE_NOT_NULL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to acquire lock */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_HANDLE_LOCK,
|
|
|
|
/* Databases */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to open database */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_OPEN,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to create database */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_CREATE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Database should not be null */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_NULL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Database should be null */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_NOT_NULL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** The database could not be found */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_NOT_FOUND,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Database is invalid */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_INVALID,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Database has an invalid signature */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_INVALID_SIG,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** The localdb is in a newer/older format than libalpm expects */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_VERSION,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to write to the database */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_WRITE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to remove entry from database */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_DB_REMOVE,
|
|
|
|
/* Servers */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Server URL is in an invalid format */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_SERVER_BAD_URL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** The database has no configured servers */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_SERVER_NONE,
|
|
|
|
/* Transactions */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** A transaction is already initialized */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_NOT_NULL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** A transaction has not been initialized */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_NULL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Duplicate target in transaction */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_DUP_TARGET,
|
2021-05-09 15:18:17 +01:00
|
|
|
/** Duplicate filename in transaction */
|
|
|
|
ALPM_ERR_TRANS_DUP_FILENAME,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** A transaction has not been initialized */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_NOT_INITIALIZED,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Transaction has not been prepared */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_NOT_PREPARED,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Transaction was aborted */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_ABORT,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to interrupt transaction */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_TYPE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Tried to commit transaction without locking the database */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_TRANS_NOT_LOCKED,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** A hook failed to run */
|
2015-10-16 20:28:25 -04:00
|
|
|
ALPM_ERR_TRANS_HOOK_FAILED,
|
2014-03-16 13:40:54 +01:00
|
|
|
/* Packages */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package not found */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_NOT_FOUND,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package is in ignorepkg */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_IGNORED,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package is invalid */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_INVALID,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package has an invalid checksum */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_INVALID_CHECKSUM,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package has an invalid signature */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_INVALID_SIG,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package does not have a signature */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_MISSING_SIG,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Cannot open the package file */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_OPEN,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Failed to remove package files */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_CANT_REMOVE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package has an invalid name */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_INVALID_NAME,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Package has an invalid architecture */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_PKG_INVALID_ARCH,
|
|
|
|
/* Signatures */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Signatures are missing */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_SIG_MISSING,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Signatures are invalid */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_SIG_INVALID,
|
|
|
|
/* Dependencies */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Dependencies could not be satisfied */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_UNSATISFIED_DEPS,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Conflicting dependencies */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_CONFLICTING_DEPS,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Files conflict */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_FILE_CONFLICTS,
|
|
|
|
/* Misc */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Download failed */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_RETRIEVE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Invalid Regex */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_INVALID_REGEX,
|
|
|
|
/* External library errors */
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Error in libarchive */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_LIBARCHIVE,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Error in libcurl */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_LIBCURL,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Error in external download program */
|
2014-03-16 13:40:54 +01:00
|
|
|
ALPM_ERR_EXTERNAL_DOWNLOAD,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Error in gpgme */
|
2018-11-24 15:56:11 -08:00
|
|
|
ALPM_ERR_GPGME,
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Missing compile-time features */
|
2018-11-24 15:56:11 -08:00
|
|
|
ALPM_ERR_MISSING_CAPABILITY_SIGNATURES
|
2014-03-16 13:40:54 +01:00
|
|
|
} alpm_errno_t;
|
|
|
|
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Returns the current error code from the handle.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the current error code of the handle
|
|
|
|
*/
|
2014-03-16 13:40:54 +01:00
|
|
|
alpm_errno_t alpm_errno(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:36 +00:00
|
|
|
/** Returns the string corresponding to an error number.
|
|
|
|
* @param err the error code to get the string for
|
|
|
|
* @return the string relating to the given error code
|
|
|
|
*/
|
2014-03-16 13:40:54 +01:00
|
|
|
const char *alpm_strerror(alpm_errno_t err);
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_errors */
|
2014-03-16 13:40:54 +01:00
|
|
|
/** @} */
|
|
|
|
|
2020-12-07 22:19:37 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/** \addtogroup libalpm_handle Handle
|
2020-12-07 22:19:37 +00:00
|
|
|
* @brief Functions to initialize and release libalpm
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Initializes the library.
|
|
|
|
* Creates handle, connects to database and creates lockfile.
|
|
|
|
* This must be called before any other functions are called.
|
|
|
|
* @param root the root path for all filesystem operations
|
|
|
|
* @param dbpath the absolute path to the libalpm database
|
|
|
|
* @param err an optional variable to hold any error return codes
|
|
|
|
* @return a context handle on success, NULL on error, err will be set if provided
|
|
|
|
*/
|
|
|
|
alpm_handle_t *alpm_initialize(const char *root, const char *dbpath,
|
|
|
|
alpm_errno_t *err);
|
|
|
|
|
|
|
|
/** Release the library.
|
|
|
|
* Disconnects from the database, removes handle and lockfile
|
|
|
|
* This should be the last alpm call you make.
|
|
|
|
* After this returns, handle should be considered invalid and cannot be reused
|
|
|
|
* in any way.
|
2020-12-07 22:19:38 +00:00
|
|
|
* @param handle the context handle
|
2020-12-07 22:19:37 +00:00
|
|
|
* @return 0 on success, -1 on error
|
|
|
|
*/
|
|
|
|
int alpm_release(alpm_handle_t *handle);
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_handle */
|
2020-12-07 22:19:37 +00:00
|
|
|
/** @} */
|
|
|
|
|
2011-09-07 10:21:47 -05:00
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_sig Signature checking
|
2020-12-07 22:19:38 +00:00
|
|
|
* @brief Functions to check signatures
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** PGP signature verification options */
|
|
|
|
typedef enum _alpm_siglevel_t {
|
|
|
|
/** Packages require a signature */
|
|
|
|
ALPM_SIG_PACKAGE = (1 << 0),
|
|
|
|
/** Packages do not require a signature,
|
|
|
|
* but check packages that do have signatures */
|
|
|
|
ALPM_SIG_PACKAGE_OPTIONAL = (1 << 1),
|
|
|
|
/* Allow packages with signatures that are marginal trust */
|
|
|
|
ALPM_SIG_PACKAGE_MARGINAL_OK = (1 << 2),
|
2020-12-29 23:31:21 +00:00
|
|
|
/** Allow packages with signatures that are unknown trust */
|
2020-12-07 22:19:38 +00:00
|
|
|
ALPM_SIG_PACKAGE_UNKNOWN_OK = (1 << 3),
|
|
|
|
|
|
|
|
/** Databases require a signature */
|
|
|
|
ALPM_SIG_DATABASE = (1 << 10),
|
|
|
|
/** Databases do not require a signature,
|
|
|
|
* but check databases that do have signatures */
|
|
|
|
ALPM_SIG_DATABASE_OPTIONAL = (1 << 11),
|
|
|
|
/** Allow databases with signatures that are marginal trust */
|
|
|
|
ALPM_SIG_DATABASE_MARGINAL_OK = (1 << 12),
|
2020-12-29 23:31:21 +00:00
|
|
|
/** Allow databases with signatures that are unknown trust */
|
2020-12-07 22:19:38 +00:00
|
|
|
ALPM_SIG_DATABASE_UNKNOWN_OK = (1 << 13),
|
|
|
|
|
|
|
|
/** The Default siglevel */
|
|
|
|
ALPM_SIG_USE_DEFAULT = (1 << 30)
|
|
|
|
} alpm_siglevel_t;
|
|
|
|
|
|
|
|
/** PGP signature verification status return codes */
|
|
|
|
typedef enum _alpm_sigstatus_t {
|
|
|
|
/** Signature is valid */
|
|
|
|
ALPM_SIGSTATUS_VALID,
|
|
|
|
/** The key has expired */
|
|
|
|
ALPM_SIGSTATUS_KEY_EXPIRED,
|
|
|
|
/** The signature has expired */
|
|
|
|
ALPM_SIGSTATUS_SIG_EXPIRED,
|
|
|
|
/** The key is not in the keyring */
|
|
|
|
ALPM_SIGSTATUS_KEY_UNKNOWN,
|
|
|
|
/** The key has been disabled */
|
|
|
|
ALPM_SIGSTATUS_KEY_DISABLED,
|
|
|
|
/** The signature is invalid */
|
|
|
|
ALPM_SIGSTATUS_INVALID
|
|
|
|
} alpm_sigstatus_t;
|
|
|
|
|
|
|
|
|
|
|
|
/** The trust level of a PGP key */
|
|
|
|
typedef enum _alpm_sigvalidity_t {
|
|
|
|
/** The signature is fully trusted */
|
|
|
|
ALPM_SIGVALIDITY_FULL,
|
|
|
|
/** The signature is marginally trusted */
|
|
|
|
ALPM_SIGVALIDITY_MARGINAL,
|
|
|
|
/** The signature is never trusted */
|
|
|
|
ALPM_SIGVALIDITY_NEVER,
|
|
|
|
/** The signature has unknown trust */
|
|
|
|
ALPM_SIGVALIDITY_UNKNOWN
|
|
|
|
} alpm_sigvalidity_t;
|
|
|
|
|
|
|
|
/** A PGP key */
|
|
|
|
typedef struct _alpm_pgpkey_t {
|
|
|
|
/** The actual key data */
|
|
|
|
void *data;
|
|
|
|
/** The key's fingerprint */
|
|
|
|
char *fingerprint;
|
|
|
|
/** UID of the key */
|
|
|
|
char *uid;
|
|
|
|
/** Name of the key's owner */
|
|
|
|
char *name;
|
|
|
|
/** Email of the key's owner */
|
|
|
|
char *email;
|
|
|
|
/** When the key was created */
|
|
|
|
alpm_time_t created;
|
|
|
|
/** When the key expires */
|
|
|
|
alpm_time_t expires;
|
|
|
|
/** The length of the key */
|
|
|
|
unsigned int length;
|
|
|
|
/** has the key been revoked */
|
|
|
|
unsigned int revoked;
|
|
|
|
/** A character representing the encryption algorithm used by the public key
|
|
|
|
*
|
|
|
|
* ? = unknown
|
|
|
|
* R = RSA
|
|
|
|
* D = DSA
|
|
|
|
* E = EDDSA
|
|
|
|
*/
|
|
|
|
char pubkey_algo;
|
|
|
|
} alpm_pgpkey_t;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Signature result. Contains the key, status, and validity of a given
|
|
|
|
* signature.
|
|
|
|
*/
|
|
|
|
typedef struct _alpm_sigresult_t {
|
|
|
|
/** The key of the signature */
|
|
|
|
alpm_pgpkey_t key;
|
|
|
|
/** The status of the signature */
|
|
|
|
alpm_sigstatus_t status;
|
|
|
|
/** The validity of the signature */
|
|
|
|
alpm_sigvalidity_t validity;
|
|
|
|
} alpm_sigresult_t;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Signature list. Contains the number of signatures found and a pointer to an
|
|
|
|
* array of results. The array is of size count.
|
|
|
|
*/
|
|
|
|
typedef struct _alpm_siglist_t {
|
|
|
|
/** The amount of results in the array */
|
|
|
|
size_t count;
|
|
|
|
/** An array of sigresults */
|
|
|
|
alpm_sigresult_t *results;
|
|
|
|
} alpm_siglist_t;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check the PGP signature for the given package file.
|
|
|
|
* @param pkg the package to check
|
|
|
|
* @param siglist a pointer to storage for signature results
|
2023-12-04 15:33:59 +00:00
|
|
|
* @return 0 if valid, -1 if an error occurred or signature is invalid
|
2020-12-07 22:19:38 +00:00
|
|
|
*/
|
|
|
|
int alpm_pkg_check_pgp_signature(alpm_pkg_t *pkg, alpm_siglist_t *siglist);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check the PGP signature for the given database.
|
|
|
|
* @param db the database to check
|
|
|
|
* @param siglist a pointer to storage for signature results
|
2023-12-04 15:33:59 +00:00
|
|
|
* @return 0 if valid, -1 if an error occurred or signature is invalid
|
2020-12-07 22:19:38 +00:00
|
|
|
*/
|
|
|
|
int alpm_db_check_pgp_signature(alpm_db_t *db, alpm_siglist_t *siglist);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Clean up and free a signature result list.
|
|
|
|
* Note that this does not free the siglist object itself in case that
|
|
|
|
* was allocated on the stack; this is the responsibility of the caller.
|
|
|
|
* @param siglist a pointer to storage for signature results
|
|
|
|
* @return 0 on success, -1 on error
|
|
|
|
*/
|
|
|
|
int alpm_siglist_cleanup(alpm_siglist_t *siglist);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Decode a loaded signature in base64 form.
|
|
|
|
* @param base64_data the signature to attempt to decode
|
|
|
|
* @param data the decoded data; must be freed by the caller
|
|
|
|
* @param data_len the length of the returned data
|
|
|
|
* @return 0 on success, -1 on failure to properly decode
|
|
|
|
*/
|
|
|
|
int alpm_decode_signature(const char *base64_data,
|
|
|
|
unsigned char **data, size_t *data_len);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extract the Issuer Key ID from a signature
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param identifier the identifier of the key.
|
|
|
|
* This may be the name of the package or the path to the package.
|
|
|
|
* @param sig PGP signature
|
|
|
|
* @param len length of signature
|
|
|
|
* @param keys a pointer to storage for key IDs
|
|
|
|
* @return 0 on success, -1 on error
|
|
|
|
*/
|
|
|
|
int alpm_extract_keyid(alpm_handle_t *handle, const char *identifier,
|
|
|
|
const unsigned char *sig, const size_t len, alpm_list_t **keys);
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_sig */
|
2020-12-07 22:19:38 +00:00
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_depends Dependency
|
2020-12-07 22:19:39 +00:00
|
|
|
* @brief Functions dealing with libalpm's dependency and conflict
|
|
|
|
* information.
|
|
|
|
* @{
|
2011-04-20 19:29:14 -05:00
|
|
|
*/
|
|
|
|
|
2011-06-16 11:42:10 -05:00
|
|
|
/** Types of version constraints in dependency specs. */
|
2011-06-28 13:56:46 +10:00
|
|
|
typedef enum _alpm_depmod_t {
|
2020-12-07 22:19:39 +00:00
|
|
|
/** No version constraint */
|
|
|
|
ALPM_DEP_MOD_ANY = 1,
|
|
|
|
/** Test version equality (package=x.y.z) */
|
|
|
|
ALPM_DEP_MOD_EQ,
|
|
|
|
/** Test for at least a version (package>=x.y.z) */
|
|
|
|
ALPM_DEP_MOD_GE,
|
|
|
|
/** Test for at most a version (package<=x.y.z) */
|
|
|
|
ALPM_DEP_MOD_LE,
|
|
|
|
/** Test for greater than some version (package>x.y.z) */
|
|
|
|
ALPM_DEP_MOD_GT,
|
|
|
|
/** Test for less than some version (package<x.y.z) */
|
|
|
|
ALPM_DEP_MOD_LT
|
2011-06-28 13:56:46 +10:00
|
|
|
} alpm_depmod_t;
|
2011-06-16 11:42:10 -05:00
|
|
|
|
2011-06-16 11:27:44 -05:00
|
|
|
/**
|
|
|
|
* File conflict type.
|
|
|
|
* Whether the conflict results from a file existing on the filesystem, or with
|
|
|
|
* another target in the transaction.
|
|
|
|
*/
|
2011-06-28 13:58:59 +10:00
|
|
|
typedef enum _alpm_fileconflicttype_t {
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The conflict results with a another target in the transaction */
|
2011-07-02 02:01:38 +10:00
|
|
|
ALPM_FILECONFLICT_TARGET = 1,
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The conflict results from a file existing on the filesystem */
|
2011-07-02 02:01:38 +10:00
|
|
|
ALPM_FILECONFLICT_FILESYSTEM
|
2011-06-28 13:58:59 +10:00
|
|
|
} alpm_fileconflicttype_t;
|
2011-06-16 11:27:44 -05:00
|
|
|
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The basic dependency type.
|
|
|
|
*
|
|
|
|
* This type is used throughout libalpm, not just for dependencies
|
|
|
|
* but also conflicts and providers. */
|
2011-06-28 14:29:55 +10:00
|
|
|
typedef struct _alpm_depend_t {
|
2020-12-07 22:19:39 +00:00
|
|
|
/** Name of the provider to satisfy this dependency */
|
2011-06-16 11:42:10 -05:00
|
|
|
char *name;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** Version of the provider to match against (optional) */
|
2011-06-16 11:42:10 -05:00
|
|
|
char *version;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** A description of why this dependency is needed (optional) */
|
2011-12-12 13:34:48 -06:00
|
|
|
char *desc;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** A hash of name (used internally to speed up conflict checks) */
|
2011-06-16 11:42:10 -05:00
|
|
|
unsigned long name_hash;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** How the version should match against the provider */
|
2011-06-28 13:56:46 +10:00
|
|
|
alpm_depmod_t mod;
|
2011-06-28 14:29:55 +10:00
|
|
|
} alpm_depend_t;
|
2011-06-16 11:42:10 -05:00
|
|
|
|
2020-12-07 22:19:39 +00:00
|
|
|
/** Missing dependency. */
|
2011-06-28 14:32:09 +10:00
|
|
|
typedef struct _alpm_depmissing_t {
|
2020-12-07 22:19:39 +00:00
|
|
|
/** Name of the package that has the dependency */
|
2011-06-16 11:42:10 -05:00
|
|
|
char *target;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The dependency that was wanted */
|
2011-06-28 14:29:55 +10:00
|
|
|
alpm_depend_t *depend;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** If the depmissing was caused by a conflict, the name of the package
|
|
|
|
* that would be installed, causing the satisfying package to be removed */
|
2011-06-16 11:42:10 -05:00
|
|
|
char *causingpkg;
|
2011-06-28 14:32:09 +10:00
|
|
|
} alpm_depmissing_t;
|
2011-06-16 11:33:20 -05:00
|
|
|
|
2020-12-07 22:19:39 +00:00
|
|
|
/** A conflict that has occurred between two packages. */
|
2011-06-28 14:33:55 +10:00
|
|
|
typedef struct _alpm_conflict_t {
|
2019-11-14 05:45:51 +00:00
|
|
|
/** The first package */
|
|
|
|
alpm_pkg_t *package1;
|
|
|
|
/** The second package */
|
|
|
|
alpm_pkg_t *package2;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The conflict */
|
2011-08-09 01:00:16 -05:00
|
|
|
alpm_depend_t *reason;
|
2011-06-28 14:33:55 +10:00
|
|
|
} alpm_conflict_t;
|
2011-06-16 11:27:44 -05:00
|
|
|
|
2020-12-07 22:19:39 +00:00
|
|
|
/** File conflict.
|
|
|
|
*
|
|
|
|
* A conflict that has happened due to a two packages containing the same file,
|
|
|
|
* or a package contains a file that is already on the filesystem and not owned
|
|
|
|
* by that package. */
|
2011-06-28 14:35:17 +10:00
|
|
|
typedef struct _alpm_fileconflict_t {
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The name of the package that caused the conflict */
|
2011-06-16 11:27:44 -05:00
|
|
|
char *target;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The type of conflict */
|
2011-06-28 13:58:59 +10:00
|
|
|
alpm_fileconflicttype_t type;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The name of the file that the package conflicts with */
|
2011-06-16 11:27:44 -05:00
|
|
|
char *file;
|
2020-12-07 22:19:39 +00:00
|
|
|
/** The name of the package that also owns the file if there is one*/
|
2011-06-16 11:27:44 -05:00
|
|
|
char *ctarget;
|
2011-06-28 14:35:17 +10:00
|
|
|
} alpm_fileconflict_t;
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2020-12-07 22:19:39 +00:00
|
|
|
/** Checks dependencies and returns missing ones in a list.
|
|
|
|
* Dependencies can include versions with depmod operators.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param pkglist the list of local packages
|
|
|
|
* @param remove an alpm_list_t* of packages to be removed
|
|
|
|
* @param upgrade an alpm_list_t* of packages to be upgraded (remove-then-upgrade)
|
|
|
|
* @param reversedeps handles the backward dependencies
|
|
|
|
* @return an alpm_list_t* of alpm_depmissing_t pointers.
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_checkdeps(alpm_handle_t *handle, alpm_list_t *pkglist,
|
|
|
|
alpm_list_t *remove, alpm_list_t *upgrade, int reversedeps);
|
|
|
|
|
|
|
|
/** Find a package satisfying a specified dependency.
|
|
|
|
* The dependency can include versions with depmod operators.
|
2020-12-29 23:31:21 +00:00
|
|
|
* @param pkgs an alpm_list_t* of alpm_pkg_t where the satisfyer will be searched
|
2020-12-07 22:19:39 +00:00
|
|
|
* @param depstring package or provision name, versioned or not
|
|
|
|
* @return a alpm_pkg_t* satisfying depstring
|
|
|
|
*/
|
|
|
|
alpm_pkg_t *alpm_find_satisfier(alpm_list_t *pkgs, const char *depstring);
|
|
|
|
|
|
|
|
/** Find a package satisfying a specified dependency.
|
|
|
|
* First look for a literal, going through each db one by one. Then look for
|
2020-12-29 23:31:21 +00:00
|
|
|
* providers. The first satisfyer that belongs to an installed package is
|
2020-12-07 22:19:39 +00:00
|
|
|
* returned. If no providers belong to an installed package then an
|
|
|
|
* alpm_question_select_provider_t is created to select the provider.
|
|
|
|
* The dependency can include versions with depmod operators.
|
|
|
|
*
|
|
|
|
* @param handle the context handle
|
2020-12-29 23:31:21 +00:00
|
|
|
* @param dbs an alpm_list_t* of alpm_db_t where the satisfyer will be searched
|
2020-12-07 22:19:39 +00:00
|
|
|
* @param depstring package or provision name, versioned or not
|
|
|
|
* @return a alpm_pkg_t* satisfying depstring
|
|
|
|
*/
|
|
|
|
alpm_pkg_t *alpm_find_dbs_satisfier(alpm_handle_t *handle,
|
|
|
|
alpm_list_t *dbs, const char *depstring);
|
|
|
|
|
|
|
|
/** Check the package conflicts in a database
|
|
|
|
*
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param pkglist the list of packages to check
|
|
|
|
*
|
|
|
|
* @return an alpm_list_t of alpm_conflict_t
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_checkconflicts(alpm_handle_t *handle, alpm_list_t *pkglist);
|
|
|
|
|
|
|
|
/** Returns a newly allocated string representing the dependency information.
|
|
|
|
* @param dep a dependency info structure
|
|
|
|
* @return a formatted string, e.g. "glibc>=2.12"
|
|
|
|
*/
|
|
|
|
char *alpm_dep_compute_string(const alpm_depend_t *dep);
|
|
|
|
|
|
|
|
/** Return a newly allocated dependency information parsed from a string
|
|
|
|
*\link alpm_dep_free should be used to free the dependency \endlink
|
|
|
|
* @param depstring a formatted string, e.g. "glibc=2.12"
|
|
|
|
* @return a dependency info structure
|
|
|
|
*/
|
|
|
|
alpm_depend_t *alpm_dep_from_string(const char *depstring);
|
|
|
|
|
|
|
|
/** Free a dependency info structure
|
|
|
|
* @param dep struct to free
|
|
|
|
*/
|
|
|
|
void alpm_dep_free(alpm_depend_t *dep);
|
|
|
|
|
|
|
|
/** Free a fileconflict and its members.
|
|
|
|
* @param conflict the fileconflict to free
|
|
|
|
*/
|
|
|
|
void alpm_fileconflict_free(alpm_fileconflict_t *conflict);
|
|
|
|
|
|
|
|
/** Free a depmissing and its members
|
|
|
|
* @param miss the depmissing to free
|
|
|
|
* */
|
|
|
|
void alpm_depmissing_free(alpm_depmissing_t *miss);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Free a conflict and its members.
|
|
|
|
* @param conflict the conflict to free
|
|
|
|
*/
|
|
|
|
void alpm_conflict_free(alpm_conflict_t *conflict);
|
|
|
|
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_depends */
|
2020-12-07 22:19:39 +00:00
|
|
|
/** @} */
|
|
|
|
|
2011-06-16 11:55:26 -05:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/** \addtogroup libalpm_cb Callbacks
|
2020-12-07 22:19:40 +00:00
|
|
|
* @brief Functions and structures for libalpm's callbacks
|
2020-01-26 07:01:42 +00:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2012-02-01 23:14:01 -06:00
|
|
|
/**
|
2014-01-10 16:25:14 +01:00
|
|
|
* Type of events.
|
2011-09-01 17:35:50 -05:00
|
|
|
*/
|
2014-01-10 16:25:14 +01:00
|
|
|
typedef enum _alpm_event_type_t {
|
2011-09-01 17:35:50 -05:00
|
|
|
/** Dependencies will be computed for a package. */
|
|
|
|
ALPM_EVENT_CHECKDEPS_START = 1,
|
|
|
|
/** Dependencies were computed for a package. */
|
|
|
|
ALPM_EVENT_CHECKDEPS_DONE,
|
|
|
|
/** File conflicts will be computed for a package. */
|
|
|
|
ALPM_EVENT_FILECONFLICTS_START,
|
|
|
|
/** File conflicts were computed for a package. */
|
|
|
|
ALPM_EVENT_FILECONFLICTS_DONE,
|
|
|
|
/** Dependencies will be resolved for target package. */
|
|
|
|
ALPM_EVENT_RESOLVEDEPS_START,
|
|
|
|
/** Dependencies were resolved for target package. */
|
|
|
|
ALPM_EVENT_RESOLVEDEPS_DONE,
|
|
|
|
/** Inter-conflicts will be checked for target package. */
|
|
|
|
ALPM_EVENT_INTERCONFLICTS_START,
|
|
|
|
/** Inter-conflicts were checked for target package. */
|
|
|
|
ALPM_EVENT_INTERCONFLICTS_DONE,
|
2015-12-14 13:39:58 +10:00
|
|
|
/** Processing the package transaction is starting. */
|
|
|
|
ALPM_EVENT_TRANSACTION_START,
|
|
|
|
/** Processing the package transaction is finished. */
|
|
|
|
ALPM_EVENT_TRANSACTION_DONE,
|
2014-01-10 16:25:14 +01:00
|
|
|
/** Package will be installed/upgraded/downgraded/re-installed/removed; See
|
|
|
|
* alpm_event_package_operation_t for arguments. */
|
|
|
|
ALPM_EVENT_PACKAGE_OPERATION_START,
|
|
|
|
/** Package was installed/upgraded/downgraded/re-installed/removed; See
|
|
|
|
* alpm_event_package_operation_t for arguments. */
|
|
|
|
ALPM_EVENT_PACKAGE_OPERATION_DONE,
|
2011-09-01 17:35:50 -05:00
|
|
|
/** Target package's integrity will be checked. */
|
|
|
|
ALPM_EVENT_INTEGRITY_START,
|
|
|
|
/** Target package's integrity was checked. */
|
|
|
|
ALPM_EVENT_INTEGRITY_DONE,
|
2011-09-19 21:01:26 -05:00
|
|
|
/** Target package will be loaded. */
|
|
|
|
ALPM_EVENT_LOAD_START,
|
|
|
|
/** Target package is finished loading. */
|
|
|
|
ALPM_EVENT_LOAD_DONE,
|
2014-01-10 16:25:14 +01:00
|
|
|
/** Scriptlet has printed information; See alpm_event_scriptlet_info_t for
|
|
|
|
* arguments. */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_EVENT_SCRIPTLET_INFO,
|
2020-05-05 18:28:49 -07:00
|
|
|
/** Database files will be downloaded from a repository. */
|
|
|
|
ALPM_EVENT_DB_RETRIEVE_START,
|
|
|
|
/** Database files were downloaded from a repository. */
|
|
|
|
ALPM_EVENT_DB_RETRIEVE_DONE,
|
|
|
|
/** Not all database files were successfully downloaded from a repository. */
|
|
|
|
ALPM_EVENT_DB_RETRIEVE_FAILED,
|
|
|
|
/** Package files will be downloaded from a repository. */
|
|
|
|
ALPM_EVENT_PKG_RETRIEVE_START,
|
|
|
|
/** Package files were downloaded from a repository. */
|
|
|
|
ALPM_EVENT_PKG_RETRIEVE_DONE,
|
|
|
|
/** Not all package files were successfully downloaded from a repository. */
|
|
|
|
ALPM_EVENT_PKG_RETRIEVE_FAILED,
|
2014-01-10 16:25:14 +01:00
|
|
|
/** Disk space usage will be computed for a package. */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_EVENT_DISKSPACE_START,
|
2014-01-10 16:25:14 +01:00
|
|
|
/** Disk space usage was computed for a package. */
|
2012-08-11 16:07:44 +10:00
|
|
|
ALPM_EVENT_DISKSPACE_DONE,
|
2014-01-10 16:25:14 +01:00
|
|
|
/** An optdepend for another package is being removed; See
|
|
|
|
* alpm_event_optdep_removal_t for arguments. */
|
2014-01-10 16:25:13 +01:00
|
|
|
ALPM_EVENT_OPTDEP_REMOVAL,
|
2014-01-10 16:25:14 +01:00
|
|
|
/** A configured repository database is missing; See
|
|
|
|
* alpm_event_database_missing_t for arguments. */
|
2012-11-03 00:21:48 +10:00
|
|
|
ALPM_EVENT_DATABASE_MISSING,
|
|
|
|
/** Checking keys used to create signatures are in keyring. */
|
|
|
|
ALPM_EVENT_KEYRING_START,
|
|
|
|
/** Keyring checking is finished. */
|
|
|
|
ALPM_EVENT_KEYRING_DONE,
|
|
|
|
/** Downloading missing keys into keyring. */
|
|
|
|
ALPM_EVENT_KEY_DOWNLOAD_START,
|
|
|
|
/** Key downloading is finished. */
|
2014-01-10 16:25:15 +01:00
|
|
|
ALPM_EVENT_KEY_DOWNLOAD_DONE,
|
2014-02-12 16:32:30 +01:00
|
|
|
/** A .pacnew file was created; See alpm_event_pacnew_created_t for arguments. */
|
|
|
|
ALPM_EVENT_PACNEW_CREATED,
|
|
|
|
/** A .pacsave file was created; See alpm_event_pacsave_created_t for
|
2020-12-07 22:19:40 +00:00
|
|
|
* arguments. */
|
2015-12-06 18:35:37 +01:00
|
|
|
ALPM_EVENT_PACSAVE_CREATED,
|
|
|
|
/** Processing hooks will be started. */
|
|
|
|
ALPM_EVENT_HOOK_START,
|
|
|
|
/** Processing hooks is finished. */
|
2015-12-14 15:48:44 +10:00
|
|
|
ALPM_EVENT_HOOK_DONE,
|
|
|
|
/** A hook is starting */
|
|
|
|
ALPM_EVENT_HOOK_RUN_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A hook has finished running. */
|
2015-12-14 15:48:44 +10:00
|
|
|
ALPM_EVENT_HOOK_RUN_DONE
|
2014-01-10 16:25:14 +01:00
|
|
|
} alpm_event_type_t;
|
|
|
|
|
2020-12-29 23:31:21 +00:00
|
|
|
/** An event that may represent any event. */
|
2014-06-15 19:43:07 +02:00
|
|
|
typedef struct _alpm_event_any_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_event_type_t type;
|
2014-06-15 19:43:07 +02:00
|
|
|
} alpm_event_any_t;
|
2011-09-01 17:35:50 -05:00
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** An enum over the kind of package operations. */
|
2014-01-10 16:25:14 +01:00
|
|
|
typedef enum _alpm_package_operation_t {
|
|
|
|
/** Package (to be) installed. (No oldpkg) */
|
|
|
|
ALPM_PACKAGE_INSTALL = 1,
|
|
|
|
/** Package (to be) upgraded */
|
|
|
|
ALPM_PACKAGE_UPGRADE,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package (to be) re-installed */
|
2014-01-10 16:25:14 +01:00
|
|
|
ALPM_PACKAGE_REINSTALL,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package (to be) downgraded */
|
2014-01-10 16:25:14 +01:00
|
|
|
ALPM_PACKAGE_DOWNGRADE,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package (to be) removed (No newpkg) */
|
2014-01-10 16:25:14 +01:00
|
|
|
ALPM_PACKAGE_REMOVE
|
|
|
|
} alpm_package_operation_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A package operation event occurred. */
|
2014-01-10 16:25:14 +01:00
|
|
|
typedef struct _alpm_event_package_operation_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of operation */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_package_operation_t operation;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Old package */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_pkg_t *oldpkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** New package */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_pkg_t *newpkg;
|
|
|
|
} alpm_event_package_operation_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** An optional dependency was removed. */
|
2014-01-10 16:25:14 +01:00
|
|
|
typedef struct _alpm_event_optdep_removal_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package with the optdep */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_pkg_t *pkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Optdep being removed */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_depend_t *optdep;
|
|
|
|
} alpm_event_optdep_removal_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A scriptlet was ran. */
|
2014-01-10 16:25:14 +01:00
|
|
|
typedef struct _alpm_event_scriptlet_info_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Line of scriptlet output */
|
2014-01-10 16:25:14 +01:00
|
|
|
const char *line;
|
|
|
|
} alpm_event_scriptlet_info_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
|
|
|
|
/** A database is missing.
|
|
|
|
*
|
|
|
|
* The database is registered but has not been downloaded
|
|
|
|
*/
|
2014-01-10 16:25:14 +01:00
|
|
|
typedef struct _alpm_event_database_missing_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-01-10 16:25:14 +01:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Name of the database */
|
2014-01-10 16:25:14 +01:00
|
|
|
const char *dbname;
|
|
|
|
} alpm_event_database_missing_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A package was downloaded. */
|
2014-01-10 16:25:17 +01:00
|
|
|
typedef struct _alpm_event_pkgdownload_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-01-10 16:25:17 +01:00
|
|
|
alpm_event_type_t type;
|
|
|
|
/** Name of the file */
|
|
|
|
const char *file;
|
|
|
|
} alpm_event_pkgdownload_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A pacnew file was created. */
|
2014-02-12 16:32:30 +01:00
|
|
|
typedef struct _alpm_event_pacnew_created_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-02-12 16:32:30 +01:00
|
|
|
alpm_event_type_t type;
|
|
|
|
/** Whether the creation was result of a NoUpgrade or not */
|
|
|
|
int from_noupgrade;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Old package */
|
2014-02-12 16:32:30 +01:00
|
|
|
alpm_pkg_t *oldpkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** New Package */
|
2014-02-12 16:32:30 +01:00
|
|
|
alpm_pkg_t *newpkg;
|
|
|
|
/** Filename of the file without the .pacnew suffix */
|
|
|
|
const char *file;
|
|
|
|
} alpm_event_pacnew_created_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A pacsave file was created. */
|
2014-02-12 16:32:30 +01:00
|
|
|
typedef struct _alpm_event_pacsave_created_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2014-02-12 16:32:30 +01:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Old package */
|
2014-02-12 16:32:30 +01:00
|
|
|
alpm_pkg_t *oldpkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Filename of the file without the .pacsave suffix */
|
2014-02-12 16:32:30 +01:00
|
|
|
const char *file;
|
|
|
|
} alpm_event_pacsave_created_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Kind of hook. */
|
|
|
|
typedef enum _alpm_hook_when_t {
|
|
|
|
/* Pre transaction hook */
|
|
|
|
ALPM_HOOK_PRE_TRANSACTION = 1,
|
|
|
|
/* Post transaction hook */
|
|
|
|
ALPM_HOOK_POST_TRANSACTION
|
|
|
|
} alpm_hook_when_t;
|
|
|
|
|
|
|
|
/** pre/post transaction hooks are to be ran. */
|
2015-12-06 18:35:37 +01:00
|
|
|
typedef struct _alpm_event_hook_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event*/
|
2015-12-06 18:35:37 +01:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of hook */
|
2015-12-06 18:35:37 +01:00
|
|
|
alpm_hook_when_t when;
|
|
|
|
} alpm_event_hook_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A pre/post transaction hook was ran. */
|
2015-12-14 15:48:44 +10:00
|
|
|
typedef struct _alpm_event_hook_run_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event */
|
2015-12-14 15:48:44 +10:00
|
|
|
alpm_event_type_t type;
|
|
|
|
/** Name of hook */
|
|
|
|
const char *name;
|
2015-12-14 20:23:26 +10:00
|
|
|
/** Description of hook to be outputted */
|
|
|
|
const char *desc;
|
2015-12-14 15:48:44 +10:00
|
|
|
/** position of hook being run */
|
|
|
|
size_t position;
|
|
|
|
/** total hooks being run */
|
|
|
|
size_t total;
|
|
|
|
} alpm_event_hook_run_t;
|
|
|
|
|
2021-03-15 16:33:08 -07:00
|
|
|
/** Packages downloading about to start. */
|
|
|
|
typedef struct _alpm_event_pkg_retrieve_t {
|
|
|
|
/** Type of event */
|
|
|
|
alpm_event_type_t type;
|
|
|
|
/** Number of packages to download */
|
|
|
|
size_t num;
|
|
|
|
/** Total size of packages to download */
|
|
|
|
off_t total_size;
|
|
|
|
} alpm_event_pkg_retrieve_t;
|
|
|
|
|
2014-06-15 19:43:07 +02:00
|
|
|
/** Events.
|
2020-12-07 22:19:40 +00:00
|
|
|
* This is a union passed to the callback that allows the frontend to know
|
2014-06-15 19:43:07 +02:00
|
|
|
* which type of event was triggered (via type). It is then possible to
|
|
|
|
* typecast the pointer to the right structure, or use the union field, in order
|
|
|
|
* to access event-specific data. */
|
|
|
|
typedef union _alpm_event_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of event it's always safe to access this. */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** The any event type. It's always safe to access this. */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_any_t any;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package operation */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_package_operation_t package_operation;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** An optdept was remove */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_optdep_removal_t optdep_removal;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A scriptlet was ran */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_scriptlet_info_t scriptlet_info;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A database is missing */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_database_missing_t database_missing;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A package was downloaded */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_pkgdownload_t pkgdownload;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A pacnew file was created */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_pacnew_created_t pacnew_created;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A pacsave file was created */
|
2014-06-15 19:43:07 +02:00
|
|
|
alpm_event_pacsave_created_t pacsave_created;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Pre/post transaction hooks are being ran */
|
2015-12-06 18:35:37 +01:00
|
|
|
alpm_event_hook_t hook;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A hook was ran */
|
2015-12-14 15:48:44 +10:00
|
|
|
alpm_event_hook_run_t hook_run;
|
2021-03-15 16:33:08 -07:00
|
|
|
/** Download packages */
|
|
|
|
alpm_event_pkg_retrieve_t pkg_retrieve;
|
2014-06-15 19:43:07 +02:00
|
|
|
} alpm_event_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Event callback.
|
|
|
|
*
|
|
|
|
* Called when an event occurs
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context
|
2020-12-07 22:19:40 +00:00
|
|
|
* @param event the event that occurred */
|
2022-03-06 15:24:19 +10:00
|
|
|
typedef void (*alpm_cb_event)(void *ctx, alpm_event_t *event);
|
2011-09-01 17:35:50 -05:00
|
|
|
|
2012-02-01 23:14:01 -06:00
|
|
|
/**
|
2020-12-07 22:19:40 +00:00
|
|
|
* Type of question.
|
2012-02-01 23:14:01 -06:00
|
|
|
* Unlike the events or progress enumerations, this enum has bitmask values
|
|
|
|
* so a frontend can use a bitmask map to supply preselected answers to the
|
|
|
|
* different types of questions.
|
|
|
|
*/
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef enum _alpm_question_type_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should target in ignorepkg be installed anyway? */
|
2014-06-15 19:42:40 +02:00
|
|
|
ALPM_QUESTION_INSTALL_IGNOREPKG = (1 << 0),
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a package be replaced? */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_QUESTION_REPLACE_PKG = (1 << 1),
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a conflicting package be removed? */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_QUESTION_CONFLICT_PKG = (1 << 2),
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a corrupted package be deleted? */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_QUESTION_CORRUPTED_PKG = (1 << 3),
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should unresolvable targets be removed from the transaction? */
|
2013-04-18 01:40:06 -07:00
|
|
|
ALPM_QUESTION_REMOVE_PKGS = (1 << 4),
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Provider selection */
|
2013-04-18 01:40:06 -07:00
|
|
|
ALPM_QUESTION_SELECT_PROVIDER = (1 << 5),
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a key be imported? */
|
2013-04-18 01:40:06 -07:00
|
|
|
ALPM_QUESTION_IMPORT_KEY = (1 << 6)
|
2014-06-15 19:42:40 +02:00
|
|
|
} alpm_question_type_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A question that can represent any other question. */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_any_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer */
|
2014-06-15 19:42:40 +02:00
|
|
|
int answer;
|
|
|
|
} alpm_question_any_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should target in ignorepkg be installed anyway? */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_install_ignorepkg_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: whether or not to install pkg anyway */
|
2014-06-15 19:42:40 +02:00
|
|
|
int install;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** The ignored package that we are deciding whether to install */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_pkg_t *pkg;
|
|
|
|
} alpm_question_install_ignorepkg_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a package be replaced? */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_replace_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: whether or not to replace oldpkg with newpkg */
|
2014-06-15 19:42:40 +02:00
|
|
|
int replace;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package to be replaced */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_pkg_t *oldpkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package to replace with.*/
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_pkg_t *newpkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** DB of newpkg */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_db_t *newdb;
|
|
|
|
} alpm_question_replace_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a conflicting package be removed? */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_conflict_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: whether or not to remove conflict->package2 */
|
2014-06-15 19:42:40 +02:00
|
|
|
int remove;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Conflict info */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_conflict_t *conflict;
|
|
|
|
} alpm_question_conflict_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a corrupted package be deleted? */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_corrupted_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: whether or not to remove filepath */
|
2014-06-15 19:42:40 +02:00
|
|
|
int remove;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** File to remove */
|
2014-06-15 19:42:40 +02:00
|
|
|
const char *filepath;
|
|
|
|
/** Error code indicating the reason for package invalidity */
|
|
|
|
alpm_errno_t reason;
|
|
|
|
} alpm_question_corrupted_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should unresolvable targets be removed from the transaction? */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_remove_pkgs_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: whether or not to skip packages */
|
2014-06-15 19:42:40 +02:00
|
|
|
int skip;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** List of alpm_pkg_t* with unresolved dependencies */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_list_t *packages;
|
|
|
|
} alpm_question_remove_pkgs_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Provider selection */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_select_provider_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: which provider to use (index from providers) */
|
2014-06-15 19:42:40 +02:00
|
|
|
int use_index;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** List of alpm_pkg_t* as possible providers */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_list_t *providers;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** What providers provide for */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_depend_t *depend;
|
|
|
|
} alpm_question_select_provider_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a key be imported? */
|
2014-06-15 19:42:40 +02:00
|
|
|
typedef struct _alpm_question_import_key_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Type of question */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Answer: whether or not to import key */
|
2014-06-15 19:42:40 +02:00
|
|
|
int import;
|
2021-06-03 21:25:04 +01:00
|
|
|
/** UID of the key to import */
|
|
|
|
const char *uid;
|
|
|
|
/** Fingerprint the key to import */
|
|
|
|
const char *fingerprint;
|
2014-06-15 19:42:40 +02:00
|
|
|
} alpm_question_import_key_t;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Questions.
|
2020-12-07 22:19:40 +00:00
|
|
|
* This is an union passed to the callback that allows the frontend to know
|
2014-06-15 19:42:40 +02:00
|
|
|
* which type of question was triggered (via type). It is then possible to
|
|
|
|
* typecast the pointer to the right structure, or use the union field, in order
|
|
|
|
* to access question-specific data. */
|
|
|
|
typedef union _alpm_question_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** The type of question. It's always safe to access this. */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_type_t type;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A question that can represent any question.
|
|
|
|
* It's always safe to access this. */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_any_t any;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should target in ignorepkg be installed anyway? */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_install_ignorepkg_t install_ignorepkg;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a package be replaced? */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_replace_t replace;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a conflicting package be removed? */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_conflict_t conflict;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a corrupted package be deleted? */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_corrupted_t corrupted;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should unresolvable targets be removed from the transaction? */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_remove_pkgs_t remove_pkgs;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Provider selection */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_select_provider_t select_provider;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Should a key be imported? */
|
2014-06-15 19:42:40 +02:00
|
|
|
alpm_question_import_key_t import_key;
|
2011-09-01 17:35:50 -05:00
|
|
|
} alpm_question_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Question callback.
|
|
|
|
*
|
|
|
|
* This callback allows user to give input and decide what to do during certain events
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context
|
2020-12-07 22:19:40 +00:00
|
|
|
* @param question the question being asked.
|
|
|
|
*/
|
2022-03-06 15:24:19 +10:00
|
|
|
typedef void (*alpm_cb_question)(void *ctx, alpm_question_t *question);
|
2011-09-01 17:35:50 -05:00
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** An enum over different kinds of progress alerts. */
|
2011-09-01 17:35:50 -05:00
|
|
|
typedef enum _alpm_progress_t {
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package install */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_PROGRESS_ADD_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package upgrade */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_PROGRESS_UPGRADE_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package downgrade */
|
2013-03-07 01:32:41 -05:00
|
|
|
ALPM_PROGRESS_DOWNGRADE_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package reinstall */
|
2013-03-07 01:32:41 -05:00
|
|
|
ALPM_PROGRESS_REINSTALL_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package removal */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_PROGRESS_REMOVE_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Conflict checking */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_PROGRESS_CONFLICTS_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Diskspace checking */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_PROGRESS_DISKSPACE_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Package Integrity checking */
|
2011-09-01 17:35:50 -05:00
|
|
|
ALPM_PROGRESS_INTEGRITY_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Loading packages from disk */
|
2012-11-03 00:21:48 +10:00
|
|
|
ALPM_PROGRESS_LOAD_START,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Checking signatures of packages */
|
2012-11-03 00:21:48 +10:00
|
|
|
ALPM_PROGRESS_KEYRING_START
|
2011-09-01 17:35:50 -05:00
|
|
|
} alpm_progress_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Progress callback
|
|
|
|
*
|
|
|
|
* Alert the front end about the progress of certain events.
|
|
|
|
* Allows the implementation of loading bars for events that
|
|
|
|
* make take a while to complete.
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context
|
2020-12-07 22:19:40 +00:00
|
|
|
* @param progress the kind of event that is progressing
|
2024-02-03 14:31:43 +00:00
|
|
|
* @param pkg the name of the package being operated on. if the progress kind
|
|
|
|
* is a packae operation (add, upgrade, downgrade, reinstall, remove).
|
|
|
|
* otherwise this will be an empty string.
|
2020-12-07 22:19:40 +00:00
|
|
|
* @param percent the percent completion of the action
|
|
|
|
* @param howmany the total amount of items in the action
|
|
|
|
* @param current the current amount of items completed
|
|
|
|
*/
|
2011-09-01 17:35:50 -05:00
|
|
|
/** Progress callback */
|
2021-04-25 11:03:54 -07:00
|
|
|
typedef void (*alpm_cb_progress)(void *ctx, alpm_progress_t progress, const char *pkg,
|
2020-12-07 22:19:40 +00:00
|
|
|
int percent, size_t howmany, size_t current);
|
2011-09-01 17:35:50 -05:00
|
|
|
|
2006-11-20 09:10:23 +00:00
|
|
|
/*
|
|
|
|
* Downloading
|
|
|
|
*/
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** File download events.
|
2020-05-05 19:50:51 -07:00
|
|
|
* These events are reported by ALPM via download callback.
|
|
|
|
*/
|
2020-12-07 22:19:40 +00:00
|
|
|
typedef enum _alpm_download_event_type_t {
|
|
|
|
/** A download was started */
|
|
|
|
ALPM_DOWNLOAD_INIT,
|
|
|
|
/** A download made progress */
|
|
|
|
ALPM_DOWNLOAD_PROGRESS,
|
2021-05-09 14:23:57 +01:00
|
|
|
/** Download will be retried */
|
|
|
|
ALPM_DOWNLOAD_RETRY,
|
2020-12-07 22:19:40 +00:00
|
|
|
/** A download completed */
|
|
|
|
ALPM_DOWNLOAD_COMPLETED
|
2020-05-05 19:50:51 -07:00
|
|
|
} alpm_download_event_type_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Context struct for when a download starts. */
|
|
|
|
typedef struct _alpm_download_event_init_t {
|
|
|
|
/** whether this file is optional and thus the errors could be ignored */
|
|
|
|
int optional;
|
2020-05-05 19:50:51 -07:00
|
|
|
} alpm_download_event_init_t;
|
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
/** Context struct for when a download progresses. */
|
|
|
|
typedef struct _alpm_download_event_progress_t {
|
|
|
|
/** Amount of data downloaded */
|
|
|
|
off_t downloaded;
|
|
|
|
/** Total amount need to be downloaded */
|
|
|
|
off_t total;
|
2020-05-05 19:50:51 -07:00
|
|
|
} alpm_download_event_progress_t;
|
|
|
|
|
2021-05-09 14:23:57 +01:00
|
|
|
/** Context struct for when a download retries. */
|
|
|
|
typedef struct _alpm_download_event_retry_t {
|
|
|
|
/** If the download will resume or start over */
|
|
|
|
int resume;
|
|
|
|
} alpm_download_event_retry_t;
|
2020-12-07 22:19:40 +00:00
|
|
|
|
|
|
|
/** Context struct for when a download completes. */
|
|
|
|
typedef struct _alpm_download_event_completed_t {
|
|
|
|
/** Total bytes in file */
|
2020-05-05 19:50:51 -07:00
|
|
|
off_t total;
|
2020-12-07 22:19:40 +00:00
|
|
|
/** download result code:
|
2020-11-24 12:39:06 +00:00
|
|
|
* 0 - download completed successfully
|
|
|
|
* 1 - the file is up-to-date
|
|
|
|
* -1 - error
|
2020-05-05 19:50:51 -07:00
|
|
|
*/
|
|
|
|
int result;
|
|
|
|
} alpm_download_event_completed_t;
|
|
|
|
|
2011-04-21 07:45:11 +02:00
|
|
|
/** Type of download progress callbacks.
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context
|
2011-04-21 07:45:11 +02:00
|
|
|
* @param filename the name of the file being downloaded
|
2020-05-05 19:50:51 -07:00
|
|
|
* @param event the event type
|
|
|
|
* @param data the event data of type alpm_download_event_*_t
|
2011-04-21 07:45:11 +02:00
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
typedef void (*alpm_cb_download)(void *ctx, const char *filename,
|
2020-05-05 19:50:51 -07:00
|
|
|
alpm_download_event_type_t event, void *data);
|
2011-04-21 07:45:11 +02:00
|
|
|
|
2020-12-07 22:19:40 +00:00
|
|
|
|
2009-04-04 16:17:30 +08:00
|
|
|
/** A callback for downloading files
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context
|
2009-04-04 16:17:30 +08:00
|
|
|
* @param url the URL of the file to be downloaded
|
|
|
|
* @param localpath the directory to which the file should be downloaded
|
download: major refactor to address lingering issues
Sorry for this being such a huge patch, but I believe it is necessary for
quite a few reasons which I will attempt to explain herein. I've been
mulling this over for a while, but wasn't super happy with making the
download interface more complex. Instead, if we carefully order things in
the internal download code, we can actually make the interface simpler.
1. FS#15657 - This involves `name.db.tar.gz.part` files being left around the
filesystem, and then causing all sorts of issues when someone attempts to
rerun the operation they canceled. We need to ensure that if we resume a
download, we are resuming it on exactly the same file; if we cannot be
almost postive of that then we need to start over.
2. http://www.mail-archive.com/pacman-dev@archlinux.org/msg03536.html - Here
we have a lighttpd bug to ruin the day. If we send both a Range: header and
If-Modified-Since: header across the wire in a GET request, lighttpd doesn't
do what we want in several cases. If the file hadn't been modified, it
returns a '304 Not Modified' instead of a '206 Partial Content'. We need to
do a stat (e.g. HEAD in HTTP terms) operation here, and the proceed
accordingly based off the values we get back from it.
3. The mtime stuff was rather ugly, and relied on the called function to
write back to a passed in reference, which isn't the greatest. Instead, use
the power of the filesystem to contain this info. Every file downloaded
internally is now carefully timestamped with the remote file time. This
should allow the resume logic to work. In order to guarantee this, we need
to implement a signal handler that catches interrupts, notifies the running
code, and causes it to set the mtimes on the file. It then rethrows the
signal so the pacman signal handler (or any frontend) works as expected.
4. We did a lot of funky stuff in trying to track the DB last modified time.
It is a lot easier to just keep the downloaded DB file around and track the
time on that rather than in a funky dot file. It also kills a lot of code.
5. For GPG verification of the databases down the road, we are going to need
the DB file around for at least a short bit of time anyway, so this gets us
closer to that.
Signed-off-by: Dan McGee <dan@archlinux.org>
[Xav: fixed printf with off_t]
Signed-off-by: Xavier Chantry <shiningxc@gmail.com>
2009-11-11 23:39:26 -06:00
|
|
|
* @param force whether to force an update, even if the file is the same
|
|
|
|
* @return 0 on success, 1 if the file exists and is identical, -1 on
|
2009-04-04 16:17:30 +08:00
|
|
|
* error.
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
typedef int (*alpm_cb_fetch)(void *ctx, const char *url, const char *localpath,
|
download: major refactor to address lingering issues
Sorry for this being such a huge patch, but I believe it is necessary for
quite a few reasons which I will attempt to explain herein. I've been
mulling this over for a while, but wasn't super happy with making the
download interface more complex. Instead, if we carefully order things in
the internal download code, we can actually make the interface simpler.
1. FS#15657 - This involves `name.db.tar.gz.part` files being left around the
filesystem, and then causing all sorts of issues when someone attempts to
rerun the operation they canceled. We need to ensure that if we resume a
download, we are resuming it on exactly the same file; if we cannot be
almost postive of that then we need to start over.
2. http://www.mail-archive.com/pacman-dev@archlinux.org/msg03536.html - Here
we have a lighttpd bug to ruin the day. If we send both a Range: header and
If-Modified-Since: header across the wire in a GET request, lighttpd doesn't
do what we want in several cases. If the file hadn't been modified, it
returns a '304 Not Modified' instead of a '206 Partial Content'. We need to
do a stat (e.g. HEAD in HTTP terms) operation here, and the proceed
accordingly based off the values we get back from it.
3. The mtime stuff was rather ugly, and relied on the called function to
write back to a passed in reference, which isn't the greatest. Instead, use
the power of the filesystem to contain this info. Every file downloaded
internally is now carefully timestamped with the remote file time. This
should allow the resume logic to work. In order to guarantee this, we need
to implement a signal handler that catches interrupts, notifies the running
code, and causes it to set the mtimes on the file. It then rethrows the
signal so the pacman signal handler (or any frontend) works as expected.
4. We did a lot of funky stuff in trying to track the DB last modified time.
It is a lot easier to just keep the downloaded DB file around and track the
time on that rather than in a funky dot file. It also kills a lot of code.
5. For GPG verification of the databases down the road, we are going to need
the DB file around for at least a short bit of time anyway, so this gets us
closer to that.
Signed-off-by: Dan McGee <dan@archlinux.org>
[Xav: fixed printf with off_t]
Signed-off-by: Xavier Chantry <shiningxc@gmail.com>
2009-11-11 23:39:26 -06:00
|
|
|
int force);
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_cb */
|
2020-12-07 22:19:40 +00:00
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_databases Database
|
2020-12-07 22:19:41 +00:00
|
|
|
* @brief Functions to query and manipulate the database of libalpm.
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Get the database of locally installed packages.
|
|
|
|
* The returned pointer points to an internal structure
|
|
|
|
* of libalpm which should only be manipulated through
|
|
|
|
* libalpm functions.
|
|
|
|
* @return a reference to the local database
|
|
|
|
*/
|
|
|
|
alpm_db_t *alpm_get_localdb(alpm_handle_t *handle);
|
|
|
|
|
|
|
|
/** Get the list of sync databases.
|
|
|
|
* Returns a list of alpm_db_t structures, one for each registered
|
|
|
|
* sync database.
|
|
|
|
*
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a reference to an internal list of alpm_db_t structures
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_get_syncdbs(alpm_handle_t *handle);
|
|
|
|
|
|
|
|
/** Register a sync database of packages.
|
|
|
|
* Databases can not be registered when there is an active transaction.
|
|
|
|
*
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param treename the name of the sync repository
|
|
|
|
* @param level what level of signature checking to perform on the
|
|
|
|
* database; note that this must be a '.sig' file type verification
|
|
|
|
* @return an alpm_db_t* on success (the value), NULL on error
|
|
|
|
*/
|
|
|
|
alpm_db_t *alpm_register_syncdb(alpm_handle_t *handle, const char *treename,
|
|
|
|
int level);
|
|
|
|
|
|
|
|
/** Unregister all package databases.
|
|
|
|
* Databases can not be unregistered while there is an active transaction.
|
|
|
|
*
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_unregister_all_syncdbs(alpm_handle_t *handle);
|
|
|
|
|
|
|
|
/** Unregister a package database.
|
|
|
|
* Databases can not be unregistered when there is an active transaction.
|
|
|
|
*
|
|
|
|
* @param db pointer to the package database to unregister
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_unregister(alpm_db_t *db);
|
|
|
|
|
2021-12-04 10:26:57 +00:00
|
|
|
/** Get the handle of a package database.
|
|
|
|
* @param db pointer to the package database
|
|
|
|
* @return the alpm handle that the package database belongs to
|
|
|
|
*/
|
|
|
|
alpm_handle_t *alpm_db_get_handle(alpm_db_t *db);
|
|
|
|
|
2020-12-07 22:19:41 +00:00
|
|
|
/** Get the name of a package database.
|
|
|
|
* @param db pointer to the package database
|
|
|
|
* @return the name of the package database, NULL on error
|
|
|
|
*/
|
|
|
|
const char *alpm_db_get_name(const alpm_db_t *db);
|
|
|
|
|
|
|
|
/** Get the signature verification level for a database.
|
|
|
|
* Will return the default verification level if this database is set up
|
|
|
|
* with ALPM_SIG_USE_DEFAULT.
|
|
|
|
* @param db pointer to the package database
|
|
|
|
* @return the signature verification level
|
|
|
|
*/
|
|
|
|
int alpm_db_get_siglevel(alpm_db_t *db);
|
|
|
|
|
|
|
|
/** Check the validity of a database.
|
|
|
|
* This is most useful for sync databases and verifying signature status.
|
|
|
|
* If invalid, the handle error code will be set accordingly.
|
|
|
|
* @param db pointer to the package database
|
|
|
|
* @return 0 if valid, -1 if invalid (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_get_valid(alpm_db_t *db);
|
|
|
|
|
|
|
|
/** @name Server accessors
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Get the list of servers assigned to this db.
|
|
|
|
* @param db pointer to the database to get the servers from
|
|
|
|
* @return a char* list of servers
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_db_get_servers(const alpm_db_t *db);
|
|
|
|
|
|
|
|
/** Sets the list of servers for the database to use.
|
2021-05-09 13:18:38 +01:00
|
|
|
* @param db the database to set the servers. The list will be duped and
|
|
|
|
* the original will still need to be freed by the caller.
|
|
|
|
* @param servers a char* list of servers.
|
2020-12-07 22:19:41 +00:00
|
|
|
*/
|
|
|
|
int alpm_db_set_servers(alpm_db_t *db, alpm_list_t *servers);
|
|
|
|
|
|
|
|
/** Add a download server to a database.
|
|
|
|
* @param db database pointer
|
|
|
|
* @param url url of the server
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_add_server(alpm_db_t *db, const char *url);
|
|
|
|
|
|
|
|
/** Remove a download server from a database.
|
|
|
|
* @param db database pointer
|
|
|
|
* @param url url of the server
|
|
|
|
* @return 0 on success, 1 on server not present,
|
|
|
|
* -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_remove_server(alpm_db_t *db, const char *url);
|
|
|
|
|
2023-11-22 14:19:21 -08:00
|
|
|
/** Get the list of cache servers assigned to this db.
|
|
|
|
* @param db pointer to the database to get the servers from
|
|
|
|
* @return a char* list of servers
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_db_get_cache_servers(const alpm_db_t *db);
|
|
|
|
|
|
|
|
/** Sets the list of cache servers for the database to use.
|
|
|
|
* @param db the database to set the servers. The list will be duped and
|
|
|
|
* the original will still need to be freed by the caller.
|
|
|
|
* @param servers a char* list of servers.
|
|
|
|
*/
|
|
|
|
int alpm_db_set_cache_servers(alpm_db_t *db, alpm_list_t *servers);
|
|
|
|
|
|
|
|
/** Add a download cache server to a database.
|
|
|
|
* @param db database pointer
|
|
|
|
* @param url url of the server
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_add_cache_server(alpm_db_t *db, const char *url);
|
|
|
|
|
|
|
|
/** Remove a download cache server from a database.
|
|
|
|
* @param db database pointer
|
|
|
|
* @param url url of the server
|
|
|
|
* @return 0 on success, 1 on server not present,
|
|
|
|
* -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_remove_cache_server(alpm_db_t *db, const char *url);
|
|
|
|
|
2020-12-07 22:19:41 +00:00
|
|
|
/* End of server accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
/** Update package databases.
|
|
|
|
*
|
|
|
|
* An update of the package databases in the list \a dbs will be attempted.
|
|
|
|
* Unless \a force is true, the update will only be performed if the remote
|
|
|
|
* databases were modified since the last update.
|
|
|
|
*
|
|
|
|
* This operation requires a database lock, and will return an applicable error
|
|
|
|
* if the lock could not be obtained.
|
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
* @code
|
|
|
|
* alpm_list_t *dbs = alpm_get_syncdbs(config->handle);
|
|
|
|
* ret = alpm_db_update(config->handle, dbs, force);
|
|
|
|
* if(ret < 0) {
|
|
|
|
* pm_printf(ALPM_LOG_ERROR, _("failed to synchronize all databases (%s)\n"),
|
|
|
|
* alpm_strerror(alpm_errno(config->handle)));
|
|
|
|
* }
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* @note After a successful update, the \link alpm_db_get_pkgcache()
|
|
|
|
* package cache \endlink will be invalidated
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param dbs list of package databases to update
|
|
|
|
* @param force if true, then forces the update, otherwise update only in case
|
|
|
|
* the databases aren't up to date
|
2021-04-26 20:47:58 -07:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly),
|
|
|
|
* 1 if all databases are up to to date
|
2020-12-07 22:19:41 +00:00
|
|
|
*/
|
|
|
|
int alpm_db_update(alpm_handle_t *handle, alpm_list_t *dbs, int force);
|
|
|
|
|
|
|
|
/** Get a package entry from a package database.
|
|
|
|
* Looking up a package is O(1) and will be significantly faster than
|
|
|
|
* iterating over the pkgcahe.
|
|
|
|
* @param db pointer to the package database to get the package from
|
|
|
|
* @param name of the package
|
|
|
|
* @return the package entry on success, NULL on error
|
|
|
|
*/
|
|
|
|
alpm_pkg_t *alpm_db_get_pkg(alpm_db_t *db, const char *name);
|
|
|
|
|
|
|
|
/** Get the package cache of a package database.
|
|
|
|
* This is a list of all packages the db contains.
|
|
|
|
* @param db pointer to the package database to get the package from
|
|
|
|
* @return the list of packages on success, NULL on error
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_db_get_pkgcache(alpm_db_t *db);
|
|
|
|
|
|
|
|
/** Get a group entry from a package database.
|
|
|
|
* Looking up a group is O(1) and will be significantly faster than
|
|
|
|
* iterating over the groupcahe.
|
|
|
|
* @param db pointer to the package database to get the group from
|
|
|
|
* @param name of the group
|
|
|
|
* @return the groups entry on success, NULL on error
|
|
|
|
*/
|
|
|
|
alpm_group_t *alpm_db_get_group(alpm_db_t *db, const char *name);
|
|
|
|
|
|
|
|
/** Get the group cache of a package database.
|
|
|
|
* @param db pointer to the package database to get the group from
|
|
|
|
* @return the list of groups on success, NULL on error
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_db_get_groupcache(alpm_db_t *db);
|
|
|
|
|
|
|
|
/** Searches a database with regular expressions.
|
|
|
|
* @param db pointer to the package database to search in
|
|
|
|
* @param needles a list of regular expressions to search for
|
|
|
|
* @param ret pointer to list for storing packages matching all
|
|
|
|
* regular expressions - must point to an empty (NULL) alpm_list_t *.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_db_search(alpm_db_t *db, const alpm_list_t *needles,
|
|
|
|
alpm_list_t **ret);
|
|
|
|
|
|
|
|
/** The usage level of a database. */
|
|
|
|
typedef enum _alpm_db_usage_t {
|
|
|
|
/** Enable refreshes for this database */
|
|
|
|
ALPM_DB_USAGE_SYNC = 1,
|
|
|
|
/** Enable search for this database */
|
|
|
|
ALPM_DB_USAGE_SEARCH = (1 << 1),
|
|
|
|
/** Enable installing packages from this database */
|
|
|
|
ALPM_DB_USAGE_INSTALL = (1 << 2),
|
|
|
|
/** Enable sysupgrades with this database */
|
|
|
|
ALPM_DB_USAGE_UPGRADE = (1 << 3),
|
|
|
|
/** Enable all usage levels */
|
|
|
|
ALPM_DB_USAGE_ALL = (1 << 4) - 1,
|
|
|
|
} alpm_db_usage_t;
|
|
|
|
|
|
|
|
/** @name Usage accessors
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Sets the usage of a database.
|
|
|
|
* @param db pointer to the package database to set the status for
|
|
|
|
* @param usage a bitmask of alpm_db_usage_t values
|
|
|
|
* @return 0 on success, or -1 on error
|
|
|
|
*/
|
|
|
|
int alpm_db_set_usage(alpm_db_t *db, int usage);
|
|
|
|
|
|
|
|
/** Gets the usage of a database.
|
|
|
|
* @param db pointer to the package database to get the status of
|
|
|
|
* @param usage pointer to an alpm_db_usage_t to store db's status
|
|
|
|
* @return 0 on success, or -1 on error
|
|
|
|
*/
|
|
|
|
int alpm_db_get_usage(alpm_db_t *db, int *usage);
|
|
|
|
|
|
|
|
/* End of usage accessors */
|
|
|
|
/** @} */
|
|
|
|
|
2020-12-07 22:19:43 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_databases */
|
2020-12-07 22:19:41 +00:00
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/** \addtogroup libalpm_log Logging Functions
|
2020-12-07 22:19:40 +00:00
|
|
|
* @brief Functions to log using libalpm
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Logging Levels */
|
|
|
|
typedef enum _alpm_loglevel_t {
|
2020-12-07 22:19:42 +00:00
|
|
|
/** Error */
|
|
|
|
ALPM_LOG_ERROR = 1,
|
|
|
|
/** Warning */
|
|
|
|
ALPM_LOG_WARNING = (1 << 1),
|
|
|
|
/** Debug */
|
|
|
|
ALPM_LOG_DEBUG = (1 << 2),
|
|
|
|
/** Function */
|
|
|
|
ALPM_LOG_FUNCTION = (1 << 3)
|
2020-12-07 22:19:40 +00:00
|
|
|
} alpm_loglevel_t;
|
|
|
|
|
2020-12-07 22:19:42 +00:00
|
|
|
|
|
|
|
/** The callback type for logging.
|
|
|
|
*
|
|
|
|
* libalpm will call this function whenever something is to be logged.
|
|
|
|
* many libalpm will produce log output. Additionally any calls to \link alpm_logaction
|
|
|
|
* \endlink will also call this callback.
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context
|
2020-12-07 22:19:42 +00:00
|
|
|
* @param level the currently set loglevel
|
|
|
|
* @param fmt the printf like format string
|
|
|
|
* @param args printf like arguments
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
typedef void (*alpm_cb_log)(void *ctx, alpm_loglevel_t level, const char *fmt, va_list args);
|
2020-12-07 22:19:40 +00:00
|
|
|
|
|
|
|
/** A printf-like function for logging.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param prefix caller-specific prefix for the log
|
|
|
|
* @param fmt output format
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_logaction(alpm_handle_t *handle, const char *prefix,
|
|
|
|
const char *fmt, ...) __attribute__((format(printf, 3, 4)));
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_log */
|
2020-12-07 22:19:40 +00:00
|
|
|
/** @} */
|
|
|
|
|
2011-03-06 19:07:25 +01:00
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_options Options
|
2011-03-06 18:51:54 +01:00
|
|
|
* Libalpm option getters and setters
|
|
|
|
* @{
|
2005-03-15 01:51:43 +00:00
|
|
|
*/
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** @name Accessors for callbacks
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Returns the callback used for logging.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set log callback
|
|
|
|
*/
|
2014-09-28 17:45:35 -04:00
|
|
|
alpm_cb_log alpm_option_get_logcb(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-25 11:03:54 -07:00
|
|
|
/** Returns the callback used for logging.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set log callback context
|
|
|
|
*/
|
|
|
|
void *alpm_option_get_logcb_ctx(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Sets the callback used for logging.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cb the cb to use
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context to pass to cb
|
2020-12-07 22:19:48 +00:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
int alpm_option_set_logcb(alpm_handle_t *handle, alpm_cb_log cb, void *ctx);
|
2014-09-28 17:45:35 -04:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the callback used to report download progress.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set download callback
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
alpm_cb_download alpm_option_get_dlcb(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-25 11:03:54 -07:00
|
|
|
/** Returns the callback used to report download progress.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set download callback context
|
|
|
|
*/
|
|
|
|
void *alpm_option_get_dlcb_ctx(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Sets the callback used to report download progress.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cb the cb to use
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context to pass to cb
|
2020-12-07 22:19:48 +00:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
int alpm_option_set_dlcb(alpm_handle_t *handle, alpm_cb_download cb, void *ctx);
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the downloading callback.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set fetch callback
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
alpm_cb_fetch alpm_option_get_fetchcb(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-25 11:03:54 -07:00
|
|
|
/** Returns the downloading callback.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set fetch callback context
|
|
|
|
*/
|
|
|
|
void *alpm_option_get_fetchcb_ctx(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Sets the downloading callback.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cb the cb to use
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context to pass to cb
|
2020-12-07 22:19:48 +00:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
int alpm_option_set_fetchcb(alpm_handle_t *handle, alpm_cb_fetch cb, void *ctx);
|
2009-04-04 16:17:30 +08:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the callback used for events.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set event callback
|
|
|
|
*/
|
2011-09-01 17:35:50 -05:00
|
|
|
alpm_cb_event alpm_option_get_eventcb(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-25 11:03:54 -07:00
|
|
|
/** Returns the callback used for events.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set event callback context
|
|
|
|
*/
|
|
|
|
void *alpm_option_get_eventcb_ctx(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Sets the callback used for events.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cb the cb to use
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context to pass to cb
|
2020-12-07 22:19:48 +00:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
int alpm_option_set_eventcb(alpm_handle_t *handle, alpm_cb_event cb, void *ctx);
|
2011-09-01 17:35:50 -05:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the callback used for questions.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set question callback
|
|
|
|
*/
|
2011-09-01 17:35:50 -05:00
|
|
|
alpm_cb_question alpm_option_get_questioncb(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-25 11:03:54 -07:00
|
|
|
/** Returns the callback used for questions.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set question callback context
|
|
|
|
*/
|
|
|
|
void *alpm_option_get_questioncb_ctx(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Sets the callback used for questions.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cb the cb to use
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context to pass to cb
|
2020-12-07 22:19:48 +00:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
int alpm_option_set_questioncb(alpm_handle_t *handle, alpm_cb_question cb, void *ctx);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/**Returns the callback used for operation progress.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set progress callback
|
|
|
|
*/
|
2011-09-01 17:35:50 -05:00
|
|
|
alpm_cb_progress alpm_option_get_progresscb(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-25 11:03:54 -07:00
|
|
|
/**Returns the callback used for operation progress.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the currently set progress callback context
|
|
|
|
*/
|
|
|
|
void *alpm_option_get_progresscb_ctx(alpm_handle_t *handle);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Sets the callback used for operation progress.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cb the cb to use
|
2021-04-25 11:03:54 -07:00
|
|
|
* @param ctx user-provided context to pass to cb
|
2020-12-07 22:19:48 +00:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2021-04-25 11:03:54 -07:00
|
|
|
int alpm_option_set_progresscb(alpm_handle_t *handle, alpm_cb_progress cb, void *ctx);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of callback accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors to the root directory
|
|
|
|
*
|
|
|
|
* The root directory is the prefix to which libalpm installs packages to.
|
|
|
|
* Hooks and scriptlets will also be run in a chroot to ensure they behave correctly
|
|
|
|
* in alternative roots.
|
|
|
|
* @{
|
|
|
|
*/
|
2011-09-01 17:35:50 -05:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the root path. Read-only.
|
|
|
|
* @param handle the context handle
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
const char *alpm_option_get_root(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of root accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors to the database path
|
|
|
|
*
|
|
|
|
* The dbpath is where libalpm stores the local db and
|
|
|
|
* downloads sync databases.
|
|
|
|
* @{
|
|
|
|
*/
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the path to the database directory. Read-only.
|
|
|
|
* @param handle the context handle
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
const char *alpm_option_get_dbpath(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of dbpath accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors to the lockfile
|
|
|
|
*
|
|
|
|
* The lockfile is used to ensure two instances of libalpm can not write
|
|
|
|
* to the database at the same time. The lock file is created when
|
|
|
|
* committing a transaction and released when the transaction completes.
|
|
|
|
* Or when calling \link alpm_unlock \endlink.
|
|
|
|
* @{
|
|
|
|
*/
|
2011-06-03 15:24:01 -05:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Get the name of the database lock file. Read-only.
|
|
|
|
* This is the name that the lockfile would have. It does not
|
|
|
|
* matter if the lockfile actually exists on disk.
|
|
|
|
* @param handle the context handle
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
const char *alpm_option_get_lockfile(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of lockfile accessors */
|
|
|
|
/** @} */
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2010-10-18 16:39:04 -05:00
|
|
|
/** @name Accessors to the list of package cache directories.
|
2020-12-07 22:19:48 +00:00
|
|
|
*
|
|
|
|
* This is where libalpm will store downloaded packages.
|
2011-04-21 07:39:16 +02:00
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Gets the currently configured cachedirs,
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a char* list of cache directories
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
alpm_list_t *alpm_option_get_cachedirs(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the cachedirs.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cachedirs a char* list of cachdirs. The list will be duped and
|
|
|
|
* the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_cachedirs(alpm_handle_t *handle, alpm_list_t *cachedirs);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Append a cachedir to the configured cachedirs.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cachedir the cachedir to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_add_cachedir(alpm_handle_t *handle, const char *cachedir);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove a cachedir from the configured cachedirs.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param cachedir the cachedir to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_remove_cachedir(alpm_handle_t *handle, const char *cachedir);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of cachedir accessors */
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @} */
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2015-10-16 20:28:23 -04:00
|
|
|
/** @name Accessors to the list of package hook directories.
|
2020-12-07 22:19:48 +00:00
|
|
|
*
|
|
|
|
* libalpm will search these directories for hooks to run. A hook in
|
|
|
|
* a later directory will override previous hooks if they have the same name.
|
2015-10-16 20:28:23 -04:00
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Gets the currently configured hookdirs,
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a char* list of hook directories
|
|
|
|
*/
|
2015-10-16 20:28:23 -04:00
|
|
|
alpm_list_t *alpm_option_get_hookdirs(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the hookdirs.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param hookdirs a char* list of hookdirs. The list will be duped and
|
|
|
|
* the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2015-10-16 20:28:23 -04:00
|
|
|
int alpm_option_set_hookdirs(alpm_handle_t *handle, alpm_list_t *hookdirs);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Append a hookdir to the configured hookdirs.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param hookdir the hookdir to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2015-10-16 20:28:23 -04:00
|
|
|
int alpm_option_add_hookdir(alpm_handle_t *handle, const char *hookdir);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove a hookdir from the configured hookdirs.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param hookdir the hookdir to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2015-10-16 20:28:23 -04:00
|
|
|
int alpm_option_remove_hookdir(alpm_handle_t *handle, const char *hookdir);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of hookdir accessors */
|
2015-10-16 20:28:23 -04:00
|
|
|
/** @} */
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** @name Accessors to the list of overwritable files.
|
|
|
|
*
|
|
|
|
* Normally libalpm will refuse to install a package that owns files that
|
|
|
|
* are already on disk and not owned by that package.
|
|
|
|
*
|
|
|
|
* If a conflicting file matches a glob in the overwrite_files list, then no
|
|
|
|
* conflict will be raised and libalpm will simply overwrite the file.
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Gets the currently configured overwritable files,
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a char* list of overwritable file globs
|
|
|
|
*/
|
2017-04-09 20:42:01 -04:00
|
|
|
alpm_list_t *alpm_option_get_overwrite_files(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the overwritable files.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param globs a char* list of overwritable file globs. The list will be duped and
|
|
|
|
* the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2017-04-09 20:42:01 -04:00
|
|
|
int alpm_option_set_overwrite_files(alpm_handle_t *handle, alpm_list_t *globs);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Append an overwritable file to the configured overwritable files.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param glob the file glob to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2017-04-09 20:42:01 -04:00
|
|
|
int alpm_option_add_overwrite_file(alpm_handle_t *handle, const char *glob);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove a file glob from the configured overwritable files globs.
|
|
|
|
* @note The overwritable file list contains a list of globs. The glob to
|
|
|
|
* remove must exactly match the entry to remove. There is no glob expansion.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param glob the file glob to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2017-04-09 20:42:01 -04:00
|
|
|
int alpm_option_remove_overwrite_file(alpm_handle_t *handle, const char *glob);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of overwrite accessors */
|
|
|
|
/** @} */
|
|
|
|
|
2017-04-09 20:42:01 -04:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** @name Accessors to the log file
|
|
|
|
*
|
|
|
|
* This controls where libalpm will save log output to.
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Gets the filepath to the currently set logfile.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the path to the logfile
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
const char *alpm_option_get_logfile(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the logfile path.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param logfile path to the new location of the logfile
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_logfile(alpm_handle_t *handle, const char *logfile);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of logfile accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors to the GPG directory
|
|
|
|
*
|
|
|
|
* This controls where libalpm will store GnuPG's files.
|
|
|
|
* @{
|
|
|
|
*/
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Returns the path to libalpm's GnuPG home directory.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the path to libalpms's GnuPG home directory
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
const char *alpm_option_get_gpgdir(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the path to libalpm's GnuPG home directory.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param gpgdir the gpgdir to set
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_gpgdir(alpm_handle_t *handle, const char *gpgdir);
|
2022-11-08 11:13:03 +10:00
|
|
|
/* End of gpgdir accessors */
|
2020-12-07 22:19:48 +00:00
|
|
|
/** @} */
|
|
|
|
|
2008-12-07 13:12:33 -06:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** @name Accessors for use syslog
|
|
|
|
*
|
|
|
|
* This controls whether libalpm will also use the syslog. Even if this option
|
|
|
|
* is enabled, libalpm will still try to log to its log file.
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Returns whether to use syslog (0 is FALSE, TRUE otherwise).
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_get_usesyslog(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets whether to use syslog (0 is FALSE, TRUE otherwise).
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param usesyslog whether to use the syslog (0 is FALSE, TRUE otherwise)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_usesyslog(alpm_handle_t *handle, int usesyslog);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of usesyslog accessors */
|
|
|
|
/** @} */
|
|
|
|
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @name Accessors to the list of no-upgrade files.
|
|
|
|
* These functions modify the list of files which should
|
|
|
|
* not be updated by package installation.
|
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Get the list of no-upgrade files
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the char* list of no-upgrade files
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
alpm_list_t *alpm_option_get_noupgrades(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Add a file to the no-upgrade list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param path the path to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-08-01 14:19:44 -07:00
|
|
|
int alpm_option_add_noupgrade(alpm_handle_t *handle, const char *path);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the list of no-upgrade files
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param noupgrade a char* list of file to not upgrade.
|
|
|
|
* The list will be duped and the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_noupgrades(alpm_handle_t *handle, alpm_list_t *noupgrade);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove an entry from the no-upgrade list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param path the path to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-08-01 14:19:44 -07:00
|
|
|
int alpm_option_remove_noupgrade(alpm_handle_t *handle, const char *path);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Test if a path matches any of the globs in the no-upgrade list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param path the path to test
|
|
|
|
* @return 0 is the path matches a glob, negative if there is no match and
|
|
|
|
* positive is the match was inverted
|
|
|
|
*/
|
2014-11-29 18:02:55 -05:00
|
|
|
int alpm_option_match_noupgrade(alpm_handle_t *handle, const char *path);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of noupgrade accessors */
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @} */
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @name Accessors to the list of no-extract files.
|
|
|
|
* These functions modify the list of filenames which should
|
|
|
|
* be skipped packages which should
|
|
|
|
* not be upgraded by a sysupgrade operation.
|
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Get the list of no-extract files
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the char* list of no-extract files
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
alpm_list_t *alpm_option_get_noextracts(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Add a file to the no-extract list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param path the path to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-08-01 14:19:44 -07:00
|
|
|
int alpm_option_add_noextract(alpm_handle_t *handle, const char *path);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the list of no-extract files
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param noextract a char* list of file to not extract.
|
|
|
|
* The list will be duped and the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_noextracts(alpm_handle_t *handle, alpm_list_t *noextract);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove an entry from the no-extract list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param path the path to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-08-01 14:19:44 -07:00
|
|
|
int alpm_option_remove_noextract(alpm_handle_t *handle, const char *path);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Test if a path matches any of the globs in the no-extract list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param path the path to test
|
|
|
|
* @return 0 is the path matches a glob, negative if there is no match and
|
|
|
|
* positive is the match was inverted
|
|
|
|
*/
|
2014-11-18 12:31:30 +10:00
|
|
|
int alpm_option_match_noextract(alpm_handle_t *handle, const char *path);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of noextract accessors */
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @} */
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @name Accessors to the list of ignored packages.
|
|
|
|
* These functions modify the list of packages that
|
|
|
|
* should be ignored by a sysupgrade.
|
2020-12-07 22:19:48 +00:00
|
|
|
*
|
|
|
|
* Entries in this list may be globs and only match the package's
|
|
|
|
* name. Providers are not taken into account.
|
2011-04-21 07:39:16 +02:00
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Get the list of ignored packages
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the char* list of ignored packages
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
alpm_list_t *alpm_option_get_ignorepkgs(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Add a file to the ignored package list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param pkg the package to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_add_ignorepkg(alpm_handle_t *handle, const char *pkg);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the list of packages to ignore
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param ignorepkgs a char* list of packages to ignore
|
|
|
|
* The list will be duped and the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_ignorepkgs(alpm_handle_t *handle, alpm_list_t *ignorepkgs);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove an entry from the ignorepkg list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param pkg the package to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_remove_ignorepkg(alpm_handle_t *handle, const char *pkg);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of ignorepkg accessors */
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @} */
|
2006-11-20 09:10:23 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @name Accessors to the list of ignored groups.
|
|
|
|
* These functions modify the list of groups whose packages
|
|
|
|
* should be ignored by a sysupgrade.
|
2020-12-07 22:19:48 +00:00
|
|
|
*
|
|
|
|
* Entries in this list may be globs.
|
2011-04-21 07:39:16 +02:00
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Get the list of ignored groups
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the char* list of ignored groups
|
|
|
|
*/
|
2011-06-29 15:46:49 +10:00
|
|
|
alpm_list_t *alpm_option_get_ignoregroups(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Add a file to the ignored group list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param grp the group to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-29 15:46:49 +10:00
|
|
|
int alpm_option_add_ignoregroup(alpm_handle_t *handle, const char *grp);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the list of groups to ignore
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param ignoregrps a char* list of groups to ignore
|
|
|
|
* The list will be duped and the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-29 15:46:49 +10:00
|
|
|
int alpm_option_set_ignoregroups(alpm_handle_t *handle, alpm_list_t *ignoregrps);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove an entry from the ignoregroup list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param grp the group to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-29 15:46:49 +10:00
|
|
|
int alpm_option_remove_ignoregroup(alpm_handle_t *handle, const char *grp);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of ignoregroup accessors */
|
2011-04-21 07:39:16 +02:00
|
|
|
/** @} */
|
2007-11-09 20:13:28 -05:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2014-07-04 23:12:01 +02:00
|
|
|
/** @name Accessors to the list of ignored dependencies.
|
|
|
|
* These functions modify the list of dependencies that
|
|
|
|
* should be ignored by a sysupgrade.
|
2020-12-07 22:19:48 +00:00
|
|
|
*
|
2020-12-29 23:31:21 +00:00
|
|
|
* This is effectively a list of virtual providers that
|
2020-12-07 22:19:48 +00:00
|
|
|
* packages can use to satisfy their dependencies.
|
2014-07-04 23:12:01 +02:00
|
|
|
* @{
|
|
|
|
*/
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Gets the list of dependencies that are assumed to be met
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a list of alpm_depend_t*
|
|
|
|
*/
|
2014-07-04 23:12:01 +02:00
|
|
|
alpm_list_t *alpm_option_get_assumeinstalled(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Add a depend to the assumed installed list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param dep the dependency to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-07-04 23:12:01 +02:00
|
|
|
int alpm_option_add_assumeinstalled(alpm_handle_t *handle, const alpm_depend_t *dep);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2020-12-29 23:31:21 +00:00
|
|
|
/** Sets the list of dependencies that are assumed to be met
|
2020-12-07 22:19:48 +00:00
|
|
|
* @param handle the context handle
|
|
|
|
* @param deps a list of *alpm_depend_t
|
|
|
|
* The list will be duped and the original will still need to be freed by the caller.
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-07-04 23:12:01 +02:00
|
|
|
int alpm_option_set_assumeinstalled(alpm_handle_t *handle, alpm_list_t *deps);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Remove an entry from the assume installed list
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param dep the dep to remove
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2014-07-04 23:12:01 +02:00
|
|
|
int alpm_option_remove_assumeinstalled(alpm_handle_t *handle, const alpm_depend_t *dep);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of assunmeinstalled accessors */
|
2014-07-04 23:12:01 +02:00
|
|
|
/** @} */
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-21 22:47:13 +10:00
|
|
|
/** @name Accessors to the list of allowed architectures.
|
|
|
|
* libalpm will only install packages that match one of the configured
|
|
|
|
* architectures. The architectures do not need to match the physical
|
|
|
|
architecture. They can just be treated as a label.
|
2020-12-07 22:19:48 +00:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Returns the allowed package architecture.
|
|
|
|
* @param handle the context handle
|
2021-04-21 22:47:13 +10:00
|
|
|
* @return the configured package architectures
|
2020-12-07 22:19:48 +00:00
|
|
|
*/
|
2021-04-21 22:47:13 +10:00
|
|
|
alpm_list_t *alpm_option_get_architectures(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-04-21 22:47:13 +10:00
|
|
|
/** Adds an allowed package architecture.
|
2020-12-07 22:19:48 +00:00
|
|
|
* @param handle the context handle
|
|
|
|
* @param arch the architecture to set
|
|
|
|
*/
|
2021-04-21 22:47:13 +10:00
|
|
|
int alpm_option_add_architecture(alpm_handle_t *handle, const char *arch);
|
|
|
|
|
|
|
|
/** Sets the allowed package architecture.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param arches the architecture to set
|
|
|
|
*/
|
|
|
|
int alpm_option_set_architectures(alpm_handle_t *handle, alpm_list_t *arches);
|
|
|
|
|
|
|
|
/** Removes an allowed package architecture.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param arch the architecture to remove
|
|
|
|
*/
|
|
|
|
int alpm_option_remove_architecture(alpm_handle_t *handle, const char *arch);
|
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of arch accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors for check space.
|
|
|
|
*
|
|
|
|
* This controls whether libalpm will check if there is sufficient before
|
|
|
|
* installing packages.
|
|
|
|
* @{
|
|
|
|
*/
|
2009-07-21 23:03:25 -05:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Get whether or not checking for free space before installing packages is enabled.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return 0 if disabled, 1 if enabled
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_get_checkspace(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Enable/disable checking free space before installing packages.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param checkspace 0 for disabled, 1 for enabled
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_option_set_checkspace(alpm_handle_t *handle, int checkspace);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of checkspace accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors for the database extension
|
|
|
|
*
|
|
|
|
* This controls the extension used for sync databases. libalpm will use this
|
|
|
|
* extension to both lookup remote databses and as the name used when opening
|
|
|
|
* reading them.
|
|
|
|
*
|
|
|
|
* This is useful for file databases. Seems as files can increase the size of
|
|
|
|
* a database by quite a lot, a server could hold a database without files under
|
|
|
|
* one extension, and another with files under another extension.
|
|
|
|
*
|
|
|
|
* Which one is downloaded and used then depends on this setting.
|
|
|
|
* @{
|
|
|
|
*/
|
2010-11-16 16:54:30 +10:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Gets the configured database extension.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the configured database extension
|
|
|
|
*/
|
2015-07-14 21:45:59 +10:00
|
|
|
const char *alpm_option_get_dbext(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Sets the database extension.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param dbext the database extension to use
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2015-07-14 21:45:59 +10:00
|
|
|
int alpm_option_set_dbext(alpm_handle_t *handle, const char *dbext);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of dbext accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Accessors for the signature levels
|
|
|
|
* @{
|
|
|
|
*/
|
2015-07-14 21:45:59 +10:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Get the default siglevel.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a \link alpm_siglevel_t \endlink bitfield of the siglevel
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_option_get_default_siglevel(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Set the default siglevel.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param level a \link alpm_siglevel_t \endlink bitfield of the level to set
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_option_set_default_siglevel(alpm_handle_t *handle, int level);
|
2011-03-25 21:40:16 -04:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Get the configured local file siglevel.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a \link alpm_siglevel_t \endlink bitfield of the siglevel
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_option_get_local_file_siglevel(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Set the local file siglevel.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param level a \link alpm_siglevel_t \endlink bitfield of the level to set
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_option_set_local_file_siglevel(alpm_handle_t *handle, int level);
|
2011-12-22 20:19:18 +10:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** Get the configured remote file siglevel.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return a \link alpm_siglevel_t \endlink bitfield of the siglevel
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_option_get_remote_file_siglevel(alpm_handle_t *handle);
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** Set the remote file siglevel.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param level a \link alpm_siglevel_t \endlink bitfield of the level to set
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_option_set_remote_file_siglevel(alpm_handle_t *handle, int level);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of signature accessors */
|
|
|
|
/** @} */
|
2011-12-22 20:19:18 +10:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
|
|
|
/** @name Accessors for download timeout
|
|
|
|
*
|
|
|
|
* By default, libalpm will timeout if a download has been transferring
|
|
|
|
* less than 1 byte for 10 seconds.
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Enables/disables the download timeout.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param disable_dl_timeout 0 for enabled, 1 for disabled
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2016-12-02 11:53:53 +01:00
|
|
|
int alpm_option_set_disable_dl_timeout(alpm_handle_t *handle, unsigned short disable_dl_timeout);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of disable_dl_timeout accessors */
|
|
|
|
/** @} */
|
|
|
|
|
2016-12-02 11:53:53 +01:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
/** @name Accessors for parallel downloads
|
|
|
|
* \link alpm_db_update \endlink, \link alpm_fetch_pkgurl \endlink and
|
|
|
|
* \link alpm_trans_commit \endlink can all download packages in parallel.
|
|
|
|
* This setting configures how many packages can be downloaded in parallel,
|
|
|
|
*
|
|
|
|
* By default this value is set to 1, meaning packages are downloading
|
|
|
|
* sequentially.
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** Gets the number of parallel streams to download database and package files.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return the number of parallel streams to download database and package files
|
|
|
|
*/
|
2020-11-24 12:39:08 +00:00
|
|
|
int alpm_option_get_parallel_downloads(alpm_handle_t *handle);
|
|
|
|
|
2020-03-08 13:33:32 -07:00
|
|
|
/** Sets number of parallel streams to download database and package files.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param num_streams number of parallel download streams
|
|
|
|
* @return 0 on success, -1 on error
|
|
|
|
*/
|
|
|
|
int alpm_option_set_parallel_downloads(alpm_handle_t *handle, unsigned int num_streams);
|
2020-12-07 22:19:48 +00:00
|
|
|
/* End of parallel_downloads accessors */
|
|
|
|
/** @} */
|
2020-03-08 13:33:32 -07:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_options */
|
2011-03-06 18:51:54 +01:00
|
|
|
/** @} */
|
2007-01-19 09:28:44 +00:00
|
|
|
|
2020-12-07 22:19:48 +00:00
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_packages Package Functions
|
2011-03-06 18:51:54 +01:00
|
|
|
* Functions to manipulate libalpm packages
|
|
|
|
* @{
|
|
|
|
*/
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2020-12-07 22:19:43 +00:00
|
|
|
/** Package install reasons. */
|
|
|
|
typedef enum _alpm_pkgreason_t {
|
|
|
|
/** Explicitly requested by the user. */
|
|
|
|
ALPM_PKG_REASON_EXPLICIT = 0,
|
|
|
|
/** Installed as a dependency for another package. */
|
2024-02-04 10:10:28 +10:00
|
|
|
ALPM_PKG_REASON_DEPEND = 1,
|
|
|
|
/** Failed parsing of local database */
|
|
|
|
ALPM_PKG_REASON_UNKNOWN = 2
|
2020-12-07 22:19:43 +00:00
|
|
|
} alpm_pkgreason_t;
|
|
|
|
|
|
|
|
/** Location a package object was loaded from. */
|
|
|
|
typedef enum _alpm_pkgfrom_t {
|
|
|
|
/** Loaded from a file via \link alpm_pkg_load \endlink */
|
|
|
|
ALPM_PKG_FROM_FILE = 1,
|
|
|
|
/** From the local database */
|
|
|
|
ALPM_PKG_FROM_LOCALDB,
|
|
|
|
/** From a sync database */
|
|
|
|
ALPM_PKG_FROM_SYNCDB
|
|
|
|
} alpm_pkgfrom_t;
|
|
|
|
|
|
|
|
|
|
|
|
/** Method used to validate a package. */
|
|
|
|
typedef enum _alpm_pkgvalidation_t {
|
|
|
|
/** The package's validation type is unknown */
|
|
|
|
ALPM_PKG_VALIDATION_UNKNOWN = 0,
|
|
|
|
/** The package does not have any validation */
|
|
|
|
ALPM_PKG_VALIDATION_NONE = (1 << 0),
|
|
|
|
/** The package is validated with md5 */
|
|
|
|
ALPM_PKG_VALIDATION_MD5SUM = (1 << 1),
|
|
|
|
/** The package is validated with sha256 */
|
|
|
|
ALPM_PKG_VALIDATION_SHA256SUM = (1 << 2),
|
|
|
|
/** The package is validated with a PGP signature */
|
|
|
|
ALPM_PKG_VALIDATION_SIGNATURE = (1 << 3)
|
|
|
|
} alpm_pkgvalidation_t;
|
|
|
|
|
2011-03-06 19:07:25 +01:00
|
|
|
/** Create a package from a file.
|
|
|
|
* If full is false, the archive is read only until all necessary
|
|
|
|
* metadata is found. If it is true, the entire archive is read, which
|
2011-04-17 09:45:52 +02:00
|
|
|
* serves as a verification of integrity and the filelist can be created.
|
|
|
|
* The allocated structure should be freed using alpm_pkg_free().
|
2011-06-07 13:46:11 -05:00
|
|
|
* @param handle the context handle
|
2011-03-06 19:07:25 +01:00
|
|
|
* @param filename location of the package tarball
|
|
|
|
* @param full whether to stop the load after metadata is read or continue
|
2011-04-21 23:39:01 -05:00
|
|
|
* through the full archive
|
2011-06-27 16:29:49 -05:00
|
|
|
* @param level what level of package signature checking to perform on the
|
2011-04-21 23:39:01 -05:00
|
|
|
* package; note that this must be a '.sig' file type verification
|
2011-03-06 19:07:25 +01:00
|
|
|
* @param pkg address of the package pointer
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_pkg_load(alpm_handle_t *handle, const char *filename, int full,
|
2016-10-12 15:13:32 -05:00
|
|
|
int level, alpm_pkg_t **pkg);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
2020-12-07 22:19:43 +00:00
|
|
|
/** Fetch a list of remote packages.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param urls list of package URLs to download
|
|
|
|
* @param fetched list of filepaths to the fetched packages, each item
|
|
|
|
* corresponds to one in `urls` list. This is an output parameter,
|
|
|
|
* the caller should provide a pointer to an empty list
|
|
|
|
* (*fetched === NULL) and the callee fills the list with data.
|
|
|
|
* @return 0 on success or -1 on failure
|
|
|
|
*/
|
|
|
|
int alpm_fetch_pkgurl(alpm_handle_t *handle, const alpm_list_t *urls,
|
|
|
|
alpm_list_t **fetched);
|
|
|
|
|
2012-08-12 20:48:53 +10:00
|
|
|
/** Find a package in a list by name.
|
|
|
|
* @param haystack a list of alpm_pkg_t
|
|
|
|
* @param needle the package name
|
|
|
|
* @return a pointer to the package if found or NULL
|
|
|
|
*/
|
|
|
|
alpm_pkg_t *alpm_pkg_find(alpm_list_t *haystack, const char *needle);
|
|
|
|
|
2011-03-06 19:07:25 +01:00
|
|
|
/** Free a package.
|
2020-12-07 22:19:43 +00:00
|
|
|
* Only packages loaded with \link alpm_pkg_load \endlink can be freed.
|
|
|
|
* Packages from databases will be freed by libalpm when they are unregistered.
|
2011-03-06 19:07:25 +01:00
|
|
|
* @param pkg package pointer to free
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
int alpm_pkg_free(alpm_pkg_t *pkg);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
|
|
|
/** Check the integrity (with md5) of a package from the sync cache.
|
|
|
|
* @param pkg package pointer
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
int alpm_pkg_checkmd5sum(alpm_pkg_t *pkg);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
/** Compare two version strings and determine which one is 'newer'.
|
|
|
|
* Returns a value comparable to the way strcmp works. Returns 1
|
|
|
|
* if a is newer than b, 0 if a and b are the same version, or -1
|
|
|
|
* if b is newer than a.
|
|
|
|
*
|
|
|
|
* Different epoch values for version strings will override any further
|
|
|
|
* comparison. If no epoch is provided, 0 is assumed.
|
|
|
|
*
|
|
|
|
* Keep in mind that the pkgrel is only compared if it is available
|
|
|
|
* on both versions handed to this function. For example, comparing
|
|
|
|
* 1.5-1 and 1.5 will yield 0; comparing 1.5-1 and 1.5-2 will yield
|
|
|
|
* -1 as expected. This is mainly for supporting versioned dependencies
|
|
|
|
* that do not include the pkgrel.
|
|
|
|
*/
|
2008-05-14 00:37:51 -05:00
|
|
|
int alpm_pkg_vercmp(const char *a, const char *b);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
|
|
|
/** Computes the list of packages requiring a given package.
|
|
|
|
* The return value of this function is a newly allocated
|
|
|
|
* list of package names (char*), it should be freed by the caller.
|
|
|
|
* @param pkg a package
|
|
|
|
* @return the list of packages requiring pkg
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_compute_requiredby(alpm_pkg_t *pkg);
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2012-08-12 16:28:42 +10:00
|
|
|
/** Computes the list of packages optionally requiring a given package.
|
|
|
|
* The return value of this function is a newly allocated
|
|
|
|
* list of package names (char*), it should be freed by the caller.
|
|
|
|
* @param pkg a package
|
|
|
|
* @return the list of packages optionally requiring pkg
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_pkg_compute_optionalfor(alpm_pkg_t *pkg);
|
|
|
|
|
2013-10-16 12:23:11 +10:00
|
|
|
/** Test if a package should be ignored.
|
|
|
|
* Checks if the package is ignored via IgnorePkg, or if the package is
|
|
|
|
* in a group ignored via IgnoreGroup.
|
|
|
|
* @param handle the context handle
|
|
|
|
* @param pkg the package to test
|
|
|
|
* @return 1 if the package should be ignored, 0 otherwise
|
|
|
|
*/
|
|
|
|
int alpm_pkg_should_ignore(alpm_handle_t *handle, alpm_pkg_t *pkg);
|
|
|
|
|
2011-03-06 18:18:43 +01:00
|
|
|
/** @name Package Property Accessors
|
|
|
|
* Any pointer returned by these functions points to internal structures
|
|
|
|
* allocated by libalpm. They should not be freed nor modified in any
|
|
|
|
* way.
|
2020-12-07 22:19:43 +00:00
|
|
|
*
|
|
|
|
* For loaded packages, they will be freed when \link alpm_pkg_free \endlink is called.
|
|
|
|
* For database packages, they will be freed when the database is unregistered.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2021-12-04 10:26:57 +00:00
|
|
|
/** Gets the handle of a package
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return the alpm handle that the package belongs to
|
|
|
|
*/
|
|
|
|
alpm_handle_t *alpm_pkg_get_handle(alpm_pkg_t *pkg);
|
|
|
|
|
2011-03-06 18:18:43 +01:00
|
|
|
/** Gets the name of the file from which the package was loaded.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_filename(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2014-12-22 15:11:39 +01:00
|
|
|
/** Returns the package base name.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
|
|
|
const char *alpm_pkg_get_base(alpm_pkg_t *pkg);
|
|
|
|
|
2011-03-06 18:18:43 +01:00
|
|
|
/** Returns the package name.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_name(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the package version as a string.
|
|
|
|
* This includes all available epoch, version, and pkgrel components. Use
|
|
|
|
* alpm_pkg_vercmp() to compare version strings if necessary.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_version(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-08-28 23:41:17 -05:00
|
|
|
/** Returns the origin of the package.
|
2011-09-22 16:29:03 -05:00
|
|
|
* @return an alpm_pkgfrom_t constant, -1 on error
|
2011-08-28 23:41:17 -05:00
|
|
|
*/
|
|
|
|
alpm_pkgfrom_t alpm_pkg_get_origin(alpm_pkg_t *pkg);
|
|
|
|
|
2011-03-06 18:18:43 +01:00
|
|
|
/** Returns the package description.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_desc(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the package URL.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_url(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the build timestamp of the package.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return the timestamp of the build time
|
|
|
|
*/
|
2011-09-07 10:21:47 -05:00
|
|
|
alpm_time_t alpm_pkg_get_builddate(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the install timestamp of the package.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return the timestamp of the install time
|
|
|
|
*/
|
2011-09-07 10:21:47 -05:00
|
|
|
alpm_time_t alpm_pkg_get_installdate(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the packager's name.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_packager(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the package's MD5 checksum as a string.
|
2011-08-11 20:15:15 -05:00
|
|
|
* The returned string is a sequence of 32 lowercase hexadecimal digits.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_md5sum(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-08-11 20:15:15 -05:00
|
|
|
/** Returns the package's SHA256 checksum as a string.
|
|
|
|
* The returned string is a sequence of 64 lowercase hexadecimal digits.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
|
|
|
const char *alpm_pkg_get_sha256sum(alpm_pkg_t *pkg);
|
|
|
|
|
2011-03-06 18:18:43 +01:00
|
|
|
/** Returns the architecture for which the package was built.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
const char *alpm_pkg_get_arch(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-09-02 19:26:07 -05:00
|
|
|
/** Returns the size of the package. This is only available for sync database
|
|
|
|
* packages and package files, not those loaded from the local database.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return the size of the package in bytes.
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
off_t alpm_pkg_get_size(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the installed size of the package.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return the total size of files installed by the package.
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
off_t alpm_pkg_get_isize(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the package installation reason.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return an enum member giving the install reason.
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_pkgreason_t alpm_pkg_get_reason(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the list of package licenses.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a pointer to an internal list of strings.
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_licenses(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the list of package groups.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a pointer to an internal list of strings.
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_groups(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-06-28 14:29:55 +10:00
|
|
|
/** Returns the list of package dependencies as alpm_depend_t.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @param pkg a pointer to package
|
2011-06-28 14:29:55 +10:00
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_depends(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the list of package optional dependencies.
|
|
|
|
* @param pkg a pointer to package
|
2011-07-18 01:54:06 +02:00
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_optdepends(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2017-01-03 17:32:27 -05:00
|
|
|
/** Returns a list of package check dependencies
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_pkg_get_checkdepends(alpm_pkg_t *pkg);
|
|
|
|
|
|
|
|
/** Returns a list of package make dependencies
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_pkg_get_makedepends(alpm_pkg_t *pkg);
|
|
|
|
|
2011-08-09 01:00:16 -05:00
|
|
|
/** Returns the list of packages conflicting with pkg.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @param pkg a pointer to package
|
2011-08-09 01:00:16 -05:00
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_conflicts(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-08-09 01:00:16 -05:00
|
|
|
/** Returns the list of packages provided by pkg.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @param pkg a pointer to package
|
2011-08-09 01:00:16 -05:00
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_provides(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the list of packages to be replaced by pkg.
|
|
|
|
* @param pkg a pointer to package
|
2011-08-09 01:00:16 -05:00
|
|
|
* @return a reference to an internal list of alpm_depend_t structures.
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_replaces(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the list of files installed by pkg.
|
|
|
|
* The filenames are relative to the install root,
|
|
|
|
* and do not include leading slashes.
|
|
|
|
* @param pkg a pointer to package
|
Convert package filelists to an array instead of linked list
This accomplishes quite a few things with one rather invasive change.
1. Iteration is much more performant, due to a reduction in pointer
chasing and linear item access.
2. Data structures are smaller- we no longer have the overhead of the
linked list as the file struts are now laid out consecutively in
memory.
3. Memory allocation has been massively reworked. Before, we would
allocate three different pieces of memory per file item- the list
struct, the file struct, and the copied filename. What this resulted
in was massive fragmentation of memory when loading filelists since
the memory allocator had to leave holes all over the place. The new
situation here now removes the need for any list item allocation;
allocates the file structs in contiguous memory (and reallocs as
necessary), leaving only the strings as individually allocated. Tests
using valgrind (massif) show some pretty significant memory
reductions on the worst case `pacman -Ql > /dev/null` (366387 files
on my machine):
Before:
Peak heap: 54,416,024 B
Useful heap: 36,840,692 B
Extra heap: 17,575,332 B
After:
Peak heap: 38,004,352 B
Useful heap: 28,101,347 B
Extra heap: 9,903,005 B
Several small helper methods have been introduced, including a list to
array conversion helper as well as a filelist merge sort that works
directly on arrays.
Signed-off-by: Dan McGee <dan@archlinux.org>
2011-07-19 04:47:29 -05:00
|
|
|
* @return a pointer to a filelist object containing a count and an array of
|
|
|
|
* package file objects
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
Convert package filelists to an array instead of linked list
This accomplishes quite a few things with one rather invasive change.
1. Iteration is much more performant, due to a reduction in pointer
chasing and linear item access.
2. Data structures are smaller- we no longer have the overhead of the
linked list as the file struts are now laid out consecutively in
memory.
3. Memory allocation has been massively reworked. Before, we would
allocate three different pieces of memory per file item- the list
struct, the file struct, and the copied filename. What this resulted
in was massive fragmentation of memory when loading filelists since
the memory allocator had to leave holes all over the place. The new
situation here now removes the need for any list item allocation;
allocates the file structs in contiguous memory (and reallocs as
necessary), leaving only the strings as individually allocated. Tests
using valgrind (massif) show some pretty significant memory
reductions on the worst case `pacman -Ql > /dev/null` (366387 files
on my machine):
Before:
Peak heap: 54,416,024 B
Useful heap: 36,840,692 B
Extra heap: 17,575,332 B
After:
Peak heap: 38,004,352 B
Useful heap: 28,101,347 B
Extra heap: 9,903,005 B
Several small helper methods have been introduced, including a list to
array conversion helper as well as a filelist merge sort that works
directly on arrays.
Signed-off-by: Dan McGee <dan@archlinux.org>
2011-07-19 04:47:29 -05:00
|
|
|
alpm_filelist_t *alpm_pkg_get_files(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
|
|
|
/** Returns the list of files backed up when installing pkg.
|
|
|
|
* @param pkg a pointer to package
|
2012-07-12 15:29:59 -05:00
|
|
|
* @return a reference to a list of alpm_backup_t objects
|
2011-03-06 18:18:43 +01:00
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_list_t *alpm_pkg_get_backup(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-04-21 19:51:51 -05:00
|
|
|
/** Returns the database containing pkg.
|
2011-06-28 14:11:43 +10:00
|
|
|
* Returns a pointer to the alpm_db_t structure the package is
|
2011-04-21 19:51:51 -05:00
|
|
|
* originating from, or NULL if the package was loaded from a file.
|
2011-03-06 18:18:43 +01:00
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a pointer to the DB containing pkg, or NULL.
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
alpm_db_t *alpm_pkg_get_db(alpm_pkg_t *pkg);
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2012-02-06 22:12:11 -06:00
|
|
|
/** Returns the base64 encoded package signature.
|
2011-08-13 14:40:41 -04:00
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to an internal string
|
|
|
|
*/
|
|
|
|
const char *alpm_pkg_get_base64_sig(alpm_pkg_t *pkg);
|
|
|
|
|
2020-05-26 19:12:08 -07:00
|
|
|
/** Extracts package signature either from embedded package signature
|
|
|
|
* or if it is absent then reads data from detached signature file.
|
|
|
|
* @param pkg a pointer to package.
|
|
|
|
* @param sig output parameter for signature data. Callee function allocates
|
|
|
|
* a buffer needed for the signature data. Caller is responsible for
|
|
|
|
* freeing this buffer.
|
|
|
|
* @param sig_len output parameter for the signature data length.
|
|
|
|
* @return 0 on success, negative number on error.
|
|
|
|
*/
|
|
|
|
int alpm_pkg_get_sig(alpm_pkg_t *pkg, unsigned char **sig, size_t *sig_len);
|
|
|
|
|
2012-02-18 16:31:37 +10:00
|
|
|
/** Returns the method used to validate a package during install.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return an enum member giving the validation method
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_pkg_get_validation(alpm_pkg_t *pkg);
|
2012-02-18 16:31:37 +10:00
|
|
|
|
2022-11-08 14:19:35 +10:00
|
|
|
/** Gets the extended data field of a package.
|
|
|
|
* @param pkg a pointer to package
|
|
|
|
* @return a reference to a list of alpm_pkg_xdata_t objects
|
|
|
|
*/
|
|
|
|
alpm_list_t *alpm_pkg_get_xdata(alpm_pkg_t *pkg);
|
|
|
|
|
2020-12-07 22:19:43 +00:00
|
|
|
/** Returns whether the package has an install scriptlet.
|
|
|
|
* @return 0 if FALSE, TRUE otherwise
|
|
|
|
*/
|
|
|
|
int alpm_pkg_has_scriptlet(alpm_pkg_t *pkg);
|
|
|
|
|
|
|
|
/** Returns the size of the files that will be downloaded to install a
|
|
|
|
* package.
|
|
|
|
* @param newpkg the new package to upgrade to
|
|
|
|
* @return the size of the download
|
|
|
|
*/
|
|
|
|
off_t alpm_pkg_download_size(alpm_pkg_t *newpkg);
|
|
|
|
|
|
|
|
/** Set install reason for a package in the local database.
|
|
|
|
* The provided package object must be from the local database or this method
|
|
|
|
* will fail. The write to the local database is performed immediately.
|
|
|
|
* @param pkg the package to update
|
|
|
|
* @param reason the new install reason
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
|
|
|
int alpm_pkg_set_reason(alpm_pkg_t *pkg, alpm_pkgreason_t reason);
|
|
|
|
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_pkg_t accessors */
|
2020-12-07 22:19:43 +00:00
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Changelog functions
|
|
|
|
* Functions for reading the changelog
|
|
|
|
* @{
|
|
|
|
*/
|
2011-03-06 18:18:43 +01:00
|
|
|
|
2011-03-06 19:07:25 +01:00
|
|
|
/** Open a package changelog for reading.
|
|
|
|
* Similar to fopen in functionality, except that the returned 'file
|
|
|
|
* stream' could really be from an archive as well as from the database.
|
|
|
|
* @param pkg the package to read the changelog of (either file or db)
|
|
|
|
* @return a 'file stream' to the package changelog
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
void *alpm_pkg_changelog_open(alpm_pkg_t *pkg);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
|
|
|
/** Read data from an open changelog 'file stream'.
|
|
|
|
* Similar to fread in functionality, this function takes a buffer and
|
|
|
|
* amount of data to read. If an error occurs pm_errno will be set.
|
|
|
|
* @param ptr a buffer to fill with raw changelog data
|
|
|
|
* @param size the size of the buffer
|
|
|
|
* @param pkg the package that the changelog is being read from
|
|
|
|
* @param fp a 'file stream' to the package changelog
|
|
|
|
* @return the number of characters read, or 0 if there is no more data or an
|
|
|
|
* error occurred.
|
|
|
|
*/
|
2007-12-08 23:42:04 -06:00
|
|
|
size_t alpm_pkg_changelog_read(void *ptr, size_t size,
|
2011-09-18 17:07:05 -05:00
|
|
|
const alpm_pkg_t *pkg, void *fp);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
/** Close a package changelog for reading.
|
|
|
|
* @param pkg the package to close the changelog of (either file or db)
|
2020-12-07 22:19:43 +00:00
|
|
|
* @param fp the 'file stream' to the package changelog to close
|
2020-01-26 07:01:42 +00:00
|
|
|
* @return 0 on success, -1 on error
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
int alpm_pkg_changelog_close(const alpm_pkg_t *pkg, void *fp);
|
2011-03-06 19:07:25 +01:00
|
|
|
|
2020-12-07 22:19:43 +00:00
|
|
|
/* End of changelog accessors */
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
|
|
|
|
/** @name Mtree functions
|
|
|
|
* Functions for reading the mtree
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2012-05-02 11:08:07 +10:00
|
|
|
/** Open a package mtree file for reading.
|
2020-01-26 07:01:42 +00:00
|
|
|
* @param pkg the local package to read the mtree of
|
|
|
|
* @return an archive structure for the package mtree file
|
2012-05-02 11:08:07 +10:00
|
|
|
*/
|
|
|
|
struct archive *alpm_pkg_mtree_open(alpm_pkg_t *pkg);
|
|
|
|
|
|
|
|
/** Read next entry from a package mtree file.
|
|
|
|
* @param pkg the package that the mtree file is being read from
|
|
|
|
* @param archive the archive structure reading from the mtree file
|
|
|
|
* @param entry an archive_entry to store the entry header information
|
2019-11-26 11:37:32 +10:00
|
|
|
* @return 0 on success, 1 if end of archive is reached, -1 otherwise.
|
2012-05-02 11:08:07 +10:00
|
|
|
*/
|
|
|
|
int alpm_pkg_mtree_next(const alpm_pkg_t *pkg, struct archive *archive,
|
|
|
|
struct archive_entry **entry);
|
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
/** Close a package mtree file.
|
|
|
|
* @param pkg the local package to close the mtree of
|
2020-12-07 22:19:43 +00:00
|
|
|
* @param archive the archive to close
|
2020-01-26 07:01:42 +00:00
|
|
|
*/
|
2012-05-02 11:08:07 +10:00
|
|
|
int alpm_pkg_mtree_close(const alpm_pkg_t *pkg, struct archive *archive);
|
|
|
|
|
2020-12-07 22:19:43 +00:00
|
|
|
/* End of mtree accessors */
|
|
|
|
/** @} */
|
2012-02-01 23:45:52 -06:00
|
|
|
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_packages */
|
2011-03-06 18:51:54 +01:00
|
|
|
/** @} */
|
|
|
|
|
2020-12-29 11:54:56 +10:00
|
|
|
/** @addtogroup libalpm_trans Transaction
|
2020-12-07 22:19:45 +00:00
|
|
|
* @brief Functions to manipulate libalpm transactions
|
|
|
|
*
|
|
|
|
* Transactions are the way to add/remove packages to/from the system.
|
|
|
|
* Only one transaction can exist at a time.
|
|
|
|
*
|
|
|
|
* The basic workflow of a transaction is to:
|
|
|
|
*
|
|
|
|
* - Initialize with \link alpm_trans_init \endlink
|
|
|
|
* - Choose which packages to add with \link alpm_add_pkg \endlink and \link alpm_remove_pkg \endlink
|
|
|
|
* - Prepare the transaction with \link alpm_trans_prepare \endlink
|
|
|
|
* - Commit the transaction with \link alpm_trans_commit \endlink
|
|
|
|
* - Release the transaction with \link alpm_trans_release \endlink
|
|
|
|
*
|
|
|
|
* A transaction can be released at any time. A transaction does not have to be committed.
|
2011-03-06 17:50:01 +01:00
|
|
|
* @{
|
2005-03-15 01:51:43 +00:00
|
|
|
*/
|
|
|
|
|
2011-03-06 17:50:01 +01:00
|
|
|
/** Transaction flags */
|
2011-06-28 14:42:24 +10:00
|
|
|
typedef enum _alpm_transflag_t {
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Ignore dependency checks. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NODEPS = 1,
|
2018-05-29 13:57:13 +10:00
|
|
|
/* (1 << 1) flag can go here */
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Delete files even if they are tagged as backup. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NOSAVE = (1 << 2),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Ignore version numbers when checking dependencies. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NODEPVERSION = (1 << 3),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Remove also any packages depending on a package being removed. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_CASCADE = (1 << 4),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Remove packages and their unneeded deps (not explicitly installed). */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_RECURSE = (1 << 5),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Modify database but do not commit changes to the filesystem. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_DBONLY = (1 << 6),
|
2021-06-13 13:28:15 +01:00
|
|
|
/** Do not run hooks during a transaction */
|
|
|
|
ALPM_TRANS_FLAG_NOHOOKS = (1 << 7),
|
2011-07-02 02:01:38 +10:00
|
|
|
/** Use ALPM_PKG_REASON_DEPEND when installing packages. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_ALLDEPS = (1 << 8),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Only download packages and do not actually install. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_DOWNLOADONLY = (1 << 9),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Do not execute install scriptlets after installing. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NOSCRIPTLET = (1 << 10),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Ignore dependency conflicts. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NOCONFLICTS = (1 << 11),
|
2009-09-26 19:30:32 +02:00
|
|
|
/* (1 << 12) flag can go here */
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Do not install a package if it is already installed and up to date. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NEEDED = (1 << 13),
|
2011-07-02 02:01:38 +10:00
|
|
|
/** Use ALPM_PKG_REASON_EXPLICIT when installing packages. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_ALLEXPLICIT = (1 << 14),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Do not remove a package if it is needed by another one. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_UNNEEDED = (1 << 15),
|
|
|
|
/** Remove also explicitly installed unneeded deps (use with ALPM_TRANS_FLAG_RECURSE). */
|
|
|
|
ALPM_TRANS_FLAG_RECURSEALL = (1 << 16),
|
2011-04-09 23:28:00 +02:00
|
|
|
/** Do not lock the database during the operation. */
|
2011-07-02 02:01:39 +10:00
|
|
|
ALPM_TRANS_FLAG_NOLOCK = (1 << 17)
|
2011-06-28 14:42:24 +10:00
|
|
|
} alpm_transflag_t;
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2011-04-21 07:45:11 +02:00
|
|
|
/** Returns the bitfield of flags for the current transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
|
|
|
* @return the bitfield of transaction flags
|
2011-04-21 07:45:11 +02:00
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_trans_get_flags(alpm_handle_t *handle);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Returns a list of packages added by the transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2011-06-28 23:26:39 +10:00
|
|
|
* @return a list of alpm_pkg_t structures
|
2011-03-06 17:50:01 +01:00
|
|
|
*/
|
2011-08-12 22:50:37 -04:00
|
|
|
alpm_list_t *alpm_trans_get_add(alpm_handle_t *handle);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Returns the list of packages removed by the transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2011-06-28 23:26:39 +10:00
|
|
|
* @return a list of alpm_pkg_t structures
|
2011-03-06 17:50:01 +01:00
|
|
|
*/
|
2011-08-12 22:50:37 -04:00
|
|
|
alpm_list_t *alpm_trans_get_remove(alpm_handle_t *handle);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Initialize the transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2016-10-12 15:13:32 -05:00
|
|
|
* @param flags flags of the transaction (like nodeps, etc; see alpm_transflag_t)
|
2011-03-06 17:50:01 +01:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_trans_init(alpm_handle_t *handle, int flags);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Prepare a transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2011-03-06 17:50:01 +01:00
|
|
|
* @param data the address of an alpm_list where a list
|
2011-06-28 14:32:09 +10:00
|
|
|
* of alpm_depmissing_t objects is dumped (conflicting packages)
|
2011-03-06 17:50:01 +01:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_trans_prepare(alpm_handle_t *handle, alpm_list_t **data);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Commit a transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2011-03-06 17:50:01 +01:00
|
|
|
* @param data the address of an alpm_list where detailed description
|
2012-02-06 22:12:11 -06:00
|
|
|
* of an error can be dumped (i.e. list of conflicting files)
|
2011-03-06 17:50:01 +01:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_trans_commit(alpm_handle_t *handle, alpm_list_t **data);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Interrupt a transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2011-03-06 17:50:01 +01:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_trans_interrupt(alpm_handle_t *handle);
|
2011-03-06 17:50:01 +01:00
|
|
|
|
|
|
|
/** Release a transaction.
|
2011-06-07 13:29:05 -05:00
|
|
|
* @param handle the context handle
|
2011-03-06 17:50:01 +01:00
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_trans_release(alpm_handle_t *handle);
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2020-12-07 22:19:45 +00:00
|
|
|
/** @name Add/Remove packages
|
|
|
|
* These functions remove/add packages to the transactions
|
|
|
|
* @{
|
|
|
|
* */
|
2011-04-17 09:45:52 +02:00
|
|
|
|
|
|
|
/** Search for packages to upgrade and add them to the transaction.
|
2011-06-07 13:39:52 -05:00
|
|
|
* @param handle the context handle
|
2011-04-17 09:45:52 +02:00
|
|
|
* @param enable_downgrade allow downgrading of packages if the remote version is lower
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 14:04:00 +10:00
|
|
|
int alpm_sync_sysupgrade(alpm_handle_t *handle, int enable_downgrade);
|
2011-04-17 09:45:52 +02:00
|
|
|
|
|
|
|
/** Add a package to the transaction.
|
|
|
|
* If the package was loaded by alpm_pkg_load(), it will be freed upon
|
2020-12-07 22:19:45 +00:00
|
|
|
* \link alpm_trans_release \endlink invocation.
|
2011-06-09 16:00:55 -05:00
|
|
|
* @param handle the context handle
|
2011-04-17 09:45:52 +02:00
|
|
|
* @param pkg the package to add
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
int alpm_add_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg);
|
2011-04-17 09:45:52 +02:00
|
|
|
|
2020-12-07 22:19:45 +00:00
|
|
|
/** Add a package removal to the transaction.
|
2011-06-09 16:00:55 -05:00
|
|
|
* @param handle the context handle
|
2011-04-17 09:45:52 +02:00
|
|
|
* @param pkg the package to uninstall
|
|
|
|
* @return 0 on success, -1 on error (pm_errno is set accordingly)
|
|
|
|
*/
|
2011-06-28 23:26:39 +10:00
|
|
|
int alpm_remove_pkg(alpm_handle_t *handle, alpm_pkg_t *pkg);
|
2011-04-17 09:45:52 +02:00
|
|
|
|
2020-12-07 22:19:45 +00:00
|
|
|
/* End of add/remove packages */
|
2011-03-28 20:56:13 +02:00
|
|
|
/** @} */
|
2010-10-17 00:57:37 +02:00
|
|
|
|
2020-12-07 22:19:46 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_trans */
|
2011-03-06 18:51:54 +01:00
|
|
|
/** @} */
|
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/** \addtogroup libalpm_misc Miscellaneous Functions
|
2020-01-26 07:01:42 +00:00
|
|
|
* @brief Various libalpm functions
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2020-12-07 22:19:46 +00:00
|
|
|
/** Check for new version of pkg in syncdbs.
|
|
|
|
*
|
|
|
|
* If the same package appears multiple dbs only the first will be checked
|
|
|
|
*
|
|
|
|
* This only checks the syncdb for a newer version. It does not access the network at all.
|
|
|
|
* See \link alpm_db_update \endlink to update a database.
|
|
|
|
*/
|
|
|
|
alpm_pkg_t *alpm_sync_get_new_version(alpm_pkg_t *pkg, alpm_list_t *dbs_sync);
|
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
/** Get the md5 sum of file.
|
|
|
|
* @param filename name of the file
|
|
|
|
* @return the checksum on success, NULL on error
|
|
|
|
*/
|
2012-02-01 23:14:01 -06:00
|
|
|
char *alpm_compute_md5sum(const char *filename);
|
2020-01-26 07:01:42 +00:00
|
|
|
|
|
|
|
/** Get the sha256 sum of file.
|
|
|
|
* @param filename name of the file
|
|
|
|
* @return the checksum on success, NULL on error
|
|
|
|
*/
|
2011-08-11 15:46:18 -05:00
|
|
|
char *alpm_compute_sha256sum(const char *filename);
|
2005-03-15 01:51:43 +00:00
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
/** Remove the database lock file
|
|
|
|
* @param handle the context handle
|
|
|
|
* @return 0 on success, -1 on error
|
|
|
|
*
|
|
|
|
* @note Safe to call from inside signal handlers.
|
|
|
|
*/
|
2015-11-12 18:06:53 -05:00
|
|
|
int alpm_unlock(alpm_handle_t *handle);
|
2011-09-21 10:31:30 -05:00
|
|
|
|
2020-12-07 22:19:46 +00:00
|
|
|
/** Enum of possible compile time features */
|
2011-09-21 10:31:30 -05:00
|
|
|
enum alpm_caps {
|
2020-12-07 22:19:46 +00:00
|
|
|
/** localization */
|
|
|
|
ALPM_CAPABILITY_NLS = (1 << 0),
|
|
|
|
/** Ability to download */
|
|
|
|
ALPM_CAPABILITY_DOWNLOADER = (1 << 1),
|
|
|
|
/** Signature checking */
|
|
|
|
ALPM_CAPABILITY_SIGNATURES = (1 << 2)
|
2011-09-21 10:31:30 -05:00
|
|
|
};
|
|
|
|
|
2020-01-26 07:01:42 +00:00
|
|
|
/** Get the version of library.
|
|
|
|
* @return the library version, e.g. "6.0.4"
|
|
|
|
* */
|
2011-06-03 15:24:01 -05:00
|
|
|
const char *alpm_version(void);
|
2020-01-26 07:01:42 +00:00
|
|
|
|
|
|
|
/** Get the capabilities of the library.
|
|
|
|
* @return a bitmask of the capabilities
|
|
|
|
* */
|
2016-10-12 15:13:32 -05:00
|
|
|
int alpm_capabilities(void);
|
2011-06-03 15:24:01 -05:00
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_misc */
|
2020-12-07 22:19:46 +00:00
|
|
|
/** @} */
|
|
|
|
|
2021-01-09 09:26:53 +10:00
|
|
|
/* End of libalpm_api */
|
2011-03-06 18:51:54 +01:00
|
|
|
/** @} */
|
|
|
|
|
2006-01-07 09:42:48 +00:00
|
|
|
#ifdef __cplusplus
|
2005-12-28 10:38:12 +00:00
|
|
|
}
|
|
|
|
#endif
|
2016-09-03 22:14:49 -05:00
|
|
|
#endif /* ALPM_H */
|