1092 lines
31 KiB
C
1092 lines
31 KiB
C
/*-
|
|
* Copyright (c) 2008-2011 Juan Romero Pardines.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*-
|
|
*/
|
|
|
|
#ifndef _XBPS_API_H_
|
|
#define _XBPS_API_H_
|
|
|
|
#include <stdio.h>
|
|
#include <inttypes.h>
|
|
|
|
#include <prop/proplib.h>
|
|
|
|
#ifdef __cplusplus
|
|
# define __BEGIN_DECLS extern "C" {
|
|
# define __END_DECLS }
|
|
#else
|
|
# define __BEGIN_DECLS
|
|
# define __END_DECLS
|
|
#endif
|
|
|
|
/**
|
|
* @file include/xbps_api.h
|
|
* @brief XBPS Library API header
|
|
*
|
|
* This header documents the full API for the XBPS Library.
|
|
*/
|
|
|
|
/**
|
|
* @def XBPS_RELVER
|
|
* Current library release date.
|
|
*/
|
|
#define XBPS_RELVER "20110119"
|
|
|
|
/**
|
|
* @def XBPS_META_PATH
|
|
* Default root PATH to store metadata info.
|
|
*/
|
|
#define XBPS_META_PATH "/var/db/xbps"
|
|
|
|
/**
|
|
* @def XBPS_CACHE_PATH
|
|
* Default cache PATH to store downloaded binpkgs.
|
|
*/
|
|
#define XBPS_CACHE_PATH "/var/cache/xbps"
|
|
|
|
/**
|
|
* @def XBPS_REPOLIST
|
|
* Filename for the global repository property list.
|
|
*/
|
|
#define XBPS_REPOLIST "repositories.plist"
|
|
|
|
/**
|
|
* @def XBPS_REGPKGDB
|
|
* Filename for the global package register database.
|
|
*/
|
|
#define XBPS_REGPKGDB "regpkgdb.plist"
|
|
|
|
/**
|
|
* @def XBPS_PKGPROPS
|
|
* Filename for package metadata property list.
|
|
*/
|
|
#define XBPS_PKGPROPS "props.plist"
|
|
|
|
/**
|
|
* @def XBPS_PKGFILES
|
|
* Filename for package metadata files property list.
|
|
*/
|
|
#define XBPS_PKGFILES "files.plist"
|
|
|
|
/**
|
|
* @def XBPS_PKGINDEX
|
|
* Filename for the repository package index property list.
|
|
*/
|
|
#define XBPS_PKGINDEX "pkg-index.plist"
|
|
|
|
/**
|
|
* @def XBPS_PKGINDEX_VERSION
|
|
* Current version for the repository package index format.
|
|
*/
|
|
#define XBPS_PKGINDEX_VERSION "1.1"
|
|
|
|
/**
|
|
* @def XBPS_FLAG_VERBOSE
|
|
* Verbose flag used in xbps_unpack_binary_pkg() (for now).
|
|
* Must be set through the xbps_set_flags() function.
|
|
*/
|
|
#define XBPS_FLAG_VERBOSE 0x00000001
|
|
|
|
/**
|
|
* @def XBPS_FLAG_FORCE
|
|
* Force flag used in xbps_configure_pkg() (for now).
|
|
* Must be set through the xbps_set_flags() function.
|
|
*/
|
|
#define XBPS_FLAG_FORCE 0x00000002
|
|
|
|
__BEGIN_DECLS
|
|
|
|
void xbps_dbg_printf(const char *, ...);
|
|
void xbps_dbg_printf_append(const char *, ...);
|
|
|
|
/** @addtogroup initend */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Initialize the XBPS library with the following steps:
|
|
*
|
|
* - Sets default cache connections for libfetch.
|
|
*
|
|
* - Initializes the debug printfs.
|
|
*
|
|
* @param[in] debug If true, debugging output will be shown to stderr.
|
|
*/
|
|
void xbps_init(bool debug);
|
|
|
|
/**
|
|
* Releases all resources used by the XBPS library.
|
|
*/
|
|
void xbps_end(void);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup configure */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Configure (or force reconfiguration of) a package.
|
|
*
|
|
* @param[in] pkgname Package name to configure.
|
|
* @param[in] version Package version (<b>optional</b>).
|
|
* @param[in] check_state Set it to true to check that package is
|
|
* in unpacked state.
|
|
* @param[in] update Set it to true if this package is being updated.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_configure_pkg(const char *pkgname,
|
|
const char *version,
|
|
bool check_state,
|
|
bool update);
|
|
|
|
/**
|
|
* Configure (or force reconfiguration of) all packages.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_configure_all_pkgs(void);
|
|
|
|
/*@}*/
|
|
|
|
/**
|
|
* @ingroup vermatch
|
|
*
|
|
* Compares package version strings.
|
|
*
|
|
* The package version is defined by:
|
|
* ${VERSION}[_${REVISION}][:${EPOCH}].
|
|
*
|
|
* ${EPOCH} supersedes ${VERSION} supersedes ${REVISION}.
|
|
*
|
|
* @param[in] pkg1 a package version string.
|
|
* @param[in] pkg2 a package version string.
|
|
*
|
|
* @return -1, 0 or 1 depending if pkg1 is less than, equal to or
|
|
* greater than pkg2.
|
|
*/
|
|
int xbps_cmpver(const char *pkg1, const char *pkg2);
|
|
|
|
|
|
/** @addtogroup download */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Download a file from a remote URL.
|
|
*
|
|
* @param[in] uri Remote URI string.
|
|
* @param[in] outputdir Directory string to store downloaded file.
|
|
* @param[in] refetch If true and local/remote size/mtime do not match,
|
|
* fetch the file from scratch.
|
|
* @param[in] flags Flags passed to libfetch's fetchXget().
|
|
*
|
|
* @return -1 on error, 0 if not downloaded (because local/remote size/mtime
|
|
* do not match) and 1 if downloaded successfully.
|
|
**/
|
|
int xbps_fetch_file(const char *uri,
|
|
const char *outputdir,
|
|
bool refetch,
|
|
const char *flags);
|
|
|
|
/**
|
|
* Returns last error string reported by xbps_fetch_file().
|
|
*
|
|
* @return A string with the appropiate error message.
|
|
*/
|
|
const char *xbps_fetch_error_string(void);
|
|
|
|
/*@}*/
|
|
|
|
int xbps_humanize_number(char *, int64_t);
|
|
|
|
/**
|
|
* @ingroup dircreate
|
|
*
|
|
* Creates a directory (and required components if necessary).
|
|
*
|
|
* @param[in] path Path for final directory.
|
|
* @param[in] mode Mode for final directory (0755 if not specified).
|
|
*
|
|
* @return 0 on success, -1 on error and errno set appropiately.
|
|
*/
|
|
int xbps_mkpath(char *path, mode_t mode);
|
|
|
|
/**
|
|
* @ingroup pkg_orphans
|
|
*
|
|
* Finds all package orphans currently installed.
|
|
*
|
|
* @return A proplib array of dictionaries with all orphans found,
|
|
* on error NULL is returned and errno is set appropiately.
|
|
*/
|
|
prop_array_t xbps_find_orphan_packages(void);
|
|
|
|
/**
|
|
* @ingroup vermatch
|
|
*
|
|
* Package pattern matching.
|
|
*
|
|
* @param[in] instpkg Package/version string of an installed package.
|
|
* @param[in] pattern Pattern required for \a instpkg to match.
|
|
*
|
|
* @return 1 if \a instpkg is matched against \a pattern, 0 if no match.
|
|
*/
|
|
int xbps_pkgpattern_match(const char *instpkg, char *pattern);
|
|
|
|
/** @addtogroup plist */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Adds a proplib object into a proplib dictionary with specified key.
|
|
*
|
|
* @param[in] dict Proplib dictionary to insert the object to.
|
|
* @param[in] obj Proplib object to be inserted.
|
|
* @param[in] key Key associated with \a obj.
|
|
*
|
|
* @return true on success, false otherwise and errno set appropiately.
|
|
*/
|
|
bool xbps_add_obj_to_dict(prop_dictionary_t dict,
|
|
prop_object_t obj,
|
|
const char *key);
|
|
|
|
/**
|
|
* Adds a proplib object into a proplib array.
|
|
*
|
|
* @param[in] array Proplib array to insert the object to.
|
|
* @param[in] obj Proplib object to be inserted.
|
|
*
|
|
* @return true on success, false otherwise and xbps_errno set appropiately.
|
|
*/
|
|
bool xbps_add_obj_to_array(prop_array_t array, prop_object_t obj);
|
|
|
|
/**
|
|
* Executes a function callback into the array associated with key \a key,
|
|
* contained in a proplib dictionary.
|
|
*
|
|
* @param[in] dict Proplib dictionary where the array resides.
|
|
* @param[in] key Key associated with array.
|
|
* @param[in] fn Function callback to run on every
|
|
* object in the array. While running the function callback, the third
|
|
* parameter (a pointer to a boolean) can be set to true to stop
|
|
* immediately the loop.
|
|
* @param[in] arg Argument to be passed to the function callback.
|
|
*
|
|
* @return 0 on success (all objects were processed), otherwise an
|
|
* errno value is set appropiately.
|
|
*/
|
|
int xbps_callback_array_iter_in_dict(prop_dictionary_t dict,
|
|
const char *key,
|
|
int (*fn)(prop_object_t, void *, bool *),
|
|
void *arg);
|
|
|
|
/**
|
|
* Executes a function callback (in reverse order) into the array
|
|
* associated with key \a key, contained in a proplib dictionary.
|
|
*
|
|
* @param[in] dict Proplib dictionary where the array resides.
|
|
* @param[in] key Key associated with array.
|
|
* @param[in] fn Function callback to run on every
|
|
* object in the array. While running the function callback, the third
|
|
* parameter (a pointer to a boolean) can be set to true to stop
|
|
* immediately the loop.
|
|
* @param[in] arg Argument to be passed to the function callback.
|
|
*
|
|
* @return 0 on success (all objects were processed), otherwise an
|
|
* errno value is set appropiately.
|
|
*/
|
|
int xbps_callback_array_iter_reverse_in_dict(prop_dictionary_t dict,
|
|
const char *key,
|
|
int (*fn)(prop_object_t, void *, bool *),
|
|
void *arg);
|
|
|
|
/**
|
|
* Finds the proplib's dictionary associated with a package, by looking
|
|
* it via its name in a proplib dictionary.
|
|
*
|
|
* @param[in] dict Proplib dictionary to look for the package dictionary.
|
|
* @param[in] key Key associated with the array that stores package's dictionary.
|
|
* @param[in] pkgname Package name to look for.
|
|
*
|
|
* @return The package's proplib dictionary on success, NULL otherwise and
|
|
* errno is set appropiately.
|
|
*/
|
|
prop_dictionary_t xbps_find_pkg_in_dict_by_name(prop_dictionary_t dict,
|
|
const char *key,
|
|
const char *pkgname);
|
|
|
|
/**
|
|
* Finds the proplib's dictionary associated with a package, by looking
|
|
* at it via a package pattern in a proplib dictionary.
|
|
*
|
|
* @param[in] dict Proplib dictionary to look for the package dictionary.
|
|
* @param[in] key Key associated with the array storing the package's dictionary.
|
|
* @param[in] pattern Package pattern to match.
|
|
*
|
|
* @return The package's proplib dictionary on success, NULL otherwise
|
|
* and errno is set appropiately.
|
|
*/
|
|
prop_dictionary_t xbps_find_pkg_in_dict_by_pattern(prop_dictionary_t dict,
|
|
const char *key,
|
|
const char *pattern);
|
|
|
|
/**
|
|
* Finds the package's proplib dictionary by looking at it in
|
|
* a plist file.
|
|
*
|
|
* @param[in] plist Path to a plist file.
|
|
* @param[in] pkgname Package name to look for.
|
|
*
|
|
* @return The package's proplib dictionary on success, NULL otherwise and
|
|
* errno is set appropiately. Returned dictionary is copied via
|
|
* prop_dictionary_copy(), which means that caller is responsible to
|
|
* release the object with prop_object_release() when done.
|
|
*/
|
|
prop_dictionary_t xbps_find_pkg_from_plist(const char *plist,
|
|
const char *pkgname);
|
|
|
|
/**
|
|
* Finds a package's dictionary searching in the registered packages
|
|
* database by using a package name or a package pattern.
|
|
*
|
|
* @param[in] str Package name or package pattern.
|
|
* @param[in] bypattern Set it to true to find the package dictionary
|
|
* by using a package pattern. If false, \a str is assumed to be a package name.
|
|
*
|
|
* @return The package's dictionary on success, NULL otherwise and
|
|
* errno is set appropiately. Returned dictionary is copied via
|
|
* prop_dictionary_copy(), which means that caller is responsible to
|
|
* release the object with prop_object_release() when done.
|
|
*/
|
|
prop_dictionary_t xbps_find_pkg_dict_installed(const char *str,
|
|
bool bypattern);
|
|
|
|
/**
|
|
* Finds a string matching an object in a proplib array.
|
|
*
|
|
* @param[in] array The proplib array where to look for.
|
|
* @param[in] val The value of string to match.
|
|
*
|
|
* @return true on success, false otherwise and errno is set appropiately.
|
|
*/
|
|
bool xbps_find_string_in_array(prop_array_t array, const char *val);
|
|
|
|
/**
|
|
* Gets a proplib object iterator associated with an array, contained
|
|
* in a proplib dictionary matching a key.
|
|
*
|
|
* @param[in] dict Proplib dictionary where to look for the array.
|
|
* @param[in] key Key associated with the array.
|
|
*
|
|
* @return A proplib object iterator on success, NULL otherwise and
|
|
* errno is set appropiately.
|
|
*/
|
|
prop_object_iterator_t xbps_get_array_iter_from_dict(prop_dictionary_t dict,
|
|
const char *key);
|
|
|
|
/**
|
|
* Get a proplib object dictionary associated with the installed package
|
|
* \a pkgn, by internalizing its plist file defined by \a plist.
|
|
*
|
|
* @param[in] pkgn Package name of installed package.
|
|
* @param[in] plist Package metadata property list file.
|
|
*
|
|
* @return The proplib object dictionary on success, NULL otherwise and
|
|
* errno is set appropiately.
|
|
*/
|
|
prop_dictionary_t xbps_get_pkg_dict_from_metadata_plist(const char *pkgn,
|
|
const char *plist);
|
|
|
|
/**
|
|
* Removes the package's proplib dictionary matching \a pkgname
|
|
* in a plist file.
|
|
*
|
|
* @param[in] pkgname Package name to look for.
|
|
* @param[in] plist Path to a plist file.
|
|
*
|
|
* @return true on success, false otherwise and errno is set appropiately.
|
|
*/
|
|
bool xbps_remove_pkg_dict_from_file(const char *pkgname, const char *plist);
|
|
|
|
/**
|
|
* Removes the package's proplib dictionary matching \a pkgname,
|
|
* in an array with key \a key stored in a proplib dictionary.
|
|
*
|
|
* @param[in] dict Proplib dictionary storing the proplib array.
|
|
* @param[in] key Key associated with the proplib array.
|
|
* @param[in] pkgname Package name to look for.
|
|
*
|
|
* @return true on success, false otherwise and errno is set appropiately.
|
|
*/
|
|
bool xbps_remove_pkg_from_dict(prop_dictionary_t dict,
|
|
const char *key,
|
|
const char *pkgname);
|
|
|
|
/**
|
|
* Removes a string from a proplib's array.
|
|
*
|
|
* @param[in] array Proplib array where to look for.
|
|
* @param[in] str String to match in the array.
|
|
*
|
|
* @return true on success, false otherwise and errno is set appropiately.
|
|
*/
|
|
bool xbps_remove_string_from_array(prop_array_t array, const char *str);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup purge */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Purge an installed package.
|
|
*
|
|
* @param[in] pkgname Package name to match.
|
|
* @param[in] check_state Set it to true to check that package
|
|
* is in XBPS_PKG_STATE_CONFIG_FILES state.
|
|
:wq!*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_purge_pkg(const char *pkgname, bool check_state);
|
|
|
|
/**
|
|
* Purge all installed packages. Packages that aren't in
|
|
* XBPS_PKG_STATE_CONFIG_FILES state will be ignored.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_purge_all_pkgs(void);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup pkg_register */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Register a package into the installed packages database.
|
|
*
|
|
* @param[in] pkg_dict A dictionary with the following objects:
|
|
* \a pkgname, \a version, \a pkgver and \a short_desc (string).
|
|
* @param[in] automatic Set it to true to mark package that has been
|
|
* installed by another package, and not explicitly.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_register_pkg(prop_dictionary_t pkg_dict, bool automatic);
|
|
|
|
/**
|
|
* Unregister a package from the package database.
|
|
*
|
|
* @param[in] pkgname Package name.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_unregister_pkg(const char *pkgname);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup regpkgdb */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Initialize resources used by the registered packages database dictionary
|
|
* and returns the internalized proplib dictionary.
|
|
*
|
|
* @note This function is reference counted, if the database has
|
|
* been initialized previously, the counter will be increased by one
|
|
* and dictionary stored in memory will be returned.
|
|
*
|
|
* @warning Don't forget to always use xbps_regpkgdb_dictionary_release()
|
|
* when its dictionary is no longer needed.
|
|
*
|
|
* @return A dictionary as shown above in the Detailed description
|
|
* graph on success, or NULL otherwise and errno is set appropiately.
|
|
*/
|
|
prop_dictionary_t xbps_regpkgdb_dictionary_get(void);
|
|
|
|
/**
|
|
* Release resources used by the registered packages database.
|
|
*
|
|
* @note This function is reference counted, if the database
|
|
* is in use (its reference count number is greater than 1), won't be released.
|
|
*/
|
|
void xbps_regpkgdb_dictionary_release(void);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup pkg_remove */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Remove an installed package.
|
|
*
|
|
* @param[in] pkgname Package name to match.
|
|
* @param[in] version Package version associated.
|
|
* @param[in] update If true, some steps will be skipped. See in the
|
|
* detailed description above for more information.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_remove_pkg(const char *pkgname, const char *version, bool update);
|
|
|
|
/**
|
|
* Remove files defined in a proplib array as specified by \a key
|
|
* of an installed package.
|
|
*
|
|
* @param[in] dict Proplib dictionary internalized from package's
|
|
* <b>XBPS_PKGFILES</b> definition in package's metadata directory.
|
|
* The image in Detailed description shows off its structure.
|
|
* @param[in] key Key of the array object to match, valid values are:
|
|
* <b>files</b>, <b>dirs</b>, <b>links</b> and <b>conf_files</b>.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_remove_pkg_files(prop_dictionary_t dict, const char *key);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup repo_register */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Registers a repository into the database.
|
|
*
|
|
* @param[in] uri URI pointing to the repository.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_register(const char *uri);
|
|
|
|
/**
|
|
* Unregisters a repository from the database.
|
|
*
|
|
* @param[in] uri URI pointing to the repository.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_unregister(const char *uri);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup repo_pkgs */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Finds a package by a pattern and enqueues it into
|
|
* the transaction dictionary for future use. The first repository in
|
|
* the pool that matched the pattern wins.
|
|
*
|
|
* @note The function name might be misleading, but is correct because
|
|
* if package is found, it will be marked as "going to be installed".
|
|
*
|
|
* @param pkgpattern Package name or pattern to find.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_install_pkg(const char *pkgpattern);
|
|
|
|
/**
|
|
* Marks a package as "going to be updated" in the transaction dictionary.
|
|
* All repositories in the pool will be used, and if a newer version
|
|
* is available the package dictionary will be enqueued.
|
|
*
|
|
* @param pkgname The package name to update.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_update_pkg(const char *pkgname);
|
|
|
|
/**
|
|
* Finds newer versions for all installed packages by looking at the
|
|
* repository pool. If a newer version exists, package will be enqueued
|
|
* into the transaction dictionary.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_update_allpkgs(void);
|
|
|
|
/**
|
|
* Returns the transaction proplib dictionary, as shown above in the image.
|
|
*
|
|
* @note
|
|
* - If the array \a missing_deps object in the returned transaction
|
|
* dictionary is not empty, that means that some required package
|
|
* dependencies could not be found; in that case the caller should stop
|
|
* immediately the transaction.
|
|
* - This function won't return anything useful in the proplib
|
|
* dictionary, if either of xbps_repository_install_pkg() or
|
|
* xbps_repository_update_pkg() functions are not called previously.
|
|
*
|
|
* @return The transaction dictionary to install/update/replace
|
|
* a package list. NULL on failure and errno is set appropiately.
|
|
*/
|
|
prop_dictionary_t xbps_repository_get_transaction_dict(void);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup repo_plist */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Iterate over the the repository pool and search for a plist file
|
|
* in the binary package named 'pkgname'. The plist file will be
|
|
* internalized to a proplib dictionary.
|
|
*
|
|
* The first repository that has it wins and the loop is stopped.
|
|
* This will work locally and remotely, thanks to libarchive and
|
|
* libfetch!
|
|
*
|
|
* @param[in] pkgname Package name to match.
|
|
* @param[in] plistf Plist file name to match.
|
|
*
|
|
* @return An internalized proplib dictionary, otherwise NULL and
|
|
* errno is set appropiately.
|
|
*
|
|
* @note if NULL is returned and errno is ENOENT, that means that
|
|
* binary package file has been found but the plist file could not
|
|
* be found.
|
|
*/
|
|
prop_dictionary_t xbps_repository_get_pkg_plist_dict(const char *pkgname,
|
|
const char *plistf);
|
|
|
|
/**
|
|
* Finds a plist file in a binary package file stored local or
|
|
* remotely as specified in the URL.
|
|
*
|
|
* @param[in] url URL to binary package file.
|
|
* @param[in] plistf Plist file name to match.
|
|
*
|
|
* @return An internalized proplib dictionary, otherwise NULL and
|
|
* errno is set appropiately.
|
|
*/
|
|
prop_dictionary_t
|
|
xbps_repository_get_pkg_plist_dict_from_url(const char *url,
|
|
const char *plistf);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup repopool */
|
|
/*@{*/
|
|
|
|
/**
|
|
* @struct repository_pool_index xbps_api.h "xbps_api.h"
|
|
* @brief Repository pool dictionary structure
|
|
*
|
|
* Repository index object structure registered in a private simple queue.
|
|
* The structure contains a dictionary and the URI associated with the
|
|
* registered repository index.
|
|
*/
|
|
struct repository_pool_index {
|
|
/**
|
|
* @var rpi_repod
|
|
*
|
|
* Internalized Proplib dictionary of the pkg-index plist file
|
|
* associated with repository.
|
|
*/
|
|
prop_dictionary_t rpi_repod;
|
|
/**
|
|
* @var rpi_uri
|
|
*
|
|
* URI string associated with repository.
|
|
*/
|
|
char *rpi_uri;
|
|
};
|
|
|
|
/**
|
|
* Initializes the repository pool.
|
|
*
|
|
* Once it's initialized, access to the repositories can be done
|
|
* through the \a xbps_repository_pool_foreach() function.
|
|
*
|
|
* @note This function is reference counted, don't forget to call
|
|
* xbps_repository_pool_release() when it's no longer needed.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_pool_init(void);
|
|
|
|
/**
|
|
* Releases the repository pool with all registered repositories
|
|
* in the database.
|
|
*
|
|
* @note This function is reference counted, it won't be released until
|
|
* its reference counter is 1.
|
|
*/
|
|
void xbps_repository_pool_release(void);
|
|
|
|
/**
|
|
* Iterates over the repository pool and executes the \a fn function
|
|
* callback passing in the void * \a arg argument to it. The bool pointer
|
|
* argument can be used in the callbacks to stop immediately the loop if
|
|
* set to true, otherwise it will only be stopped if it returns a
|
|
* non-zero value.
|
|
*
|
|
* @param[in] fn Function callback to execute for every repository registered in
|
|
* the pool.
|
|
* @param[in] arg Opaque data passed in to the \a fn function callback for
|
|
* client data.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_repository_pool_foreach(
|
|
int (*fn)(struct repository_pool_index *, void *, bool *),
|
|
void *arg);
|
|
|
|
/**
|
|
* Finds a package dictionary in the repository pool by specifying a
|
|
* package pattern or a package name.
|
|
*
|
|
* @param[in] pkg Package pattern or name.
|
|
* @param[in] bypattern True if \a pkg is a pattern, false if it is a pkgname.
|
|
* @param[in] best True to find the best version available in repo, false to
|
|
* fetch the first package found matching its pkgname.
|
|
*
|
|
* @return The package dictionary if found, NULL otherwise.
|
|
*/
|
|
prop_dictionary_t
|
|
xbps_repository_pool_find_pkg(const char *pkg, bool bypattern, bool best);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup reposync */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Syncs the package index file for a remote repository as specified
|
|
* by the \a uri argument (if necessary).
|
|
*
|
|
* @param[in] uri URI to a remote repository.
|
|
*
|
|
* @return -1 on error (errno is set appropiately), 0 if transfer was
|
|
* not necessary (local/remote size/mtime matched) or 1 if
|
|
* downloaded successfully.
|
|
*/
|
|
int xbps_repository_sync_pkg_index(const char *uri);
|
|
|
|
/*@}*/
|
|
|
|
/** @addtogroup pkgstates */
|
|
/*@{*/
|
|
|
|
/**
|
|
* @enum pkg_state_t
|
|
*
|
|
* Integer representing a state on which a package may be. Possible
|
|
* values for this are:
|
|
*
|
|
* <b>XBPS_PKG_STATE_UNPACKED</b>: Package has been unpacked correctly
|
|
* but has not been configured due to unknown reasons.
|
|
*
|
|
* <b>XBPS_PKG_STATE_INSTALLED</b>: Package has been installed successfully.
|
|
*
|
|
* <b>XBPS_PKG_STATE_BROKEN</b>: not yet used.
|
|
*
|
|
* <b>XBPS_PKG_STATE_CONFIG_FILES</b>: Package has been removed but not
|
|
* yet purged.
|
|
*
|
|
* <b>XBPS_PKG_STATE_NOT_INSTALLED</b>: Package going to be installed in
|
|
* a transaction dictionary but that has not been yet unpacked.
|
|
*/
|
|
typedef enum pkg_state {
|
|
XBPS_PKG_STATE_UNPACKED = 1,
|
|
XBPS_PKG_STATE_INSTALLED,
|
|
XBPS_PKG_STATE_BROKEN,
|
|
XBPS_PKG_STATE_CONFIG_FILES,
|
|
XBPS_PKG_STATE_NOT_INSTALLED
|
|
} pkg_state_t;
|
|
|
|
/**
|
|
* Gets package state from package \a pkgname, and sets its state
|
|
* into \a state.
|
|
*
|
|
* @param[in] pkgname Package name.
|
|
* @param[out] state Package state returned.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_get_pkg_state_installed(const char *pkgname, pkg_state_t *state);
|
|
|
|
/**
|
|
* Gets package state from a package dictionary \a dict, and sets its
|
|
* state into \a state.
|
|
*
|
|
* @param[in] dict Package dictionary.
|
|
* @param[out] state Package state returned.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_get_pkg_state_dictionary(prop_dictionary_t dict, pkg_state_t *state);
|
|
|
|
/**
|
|
* Sets package state \a state in package \a pkgname.
|
|
*
|
|
* @param[in] pkgname Package name.
|
|
* @param[in] state Package state to be set.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_set_pkg_state_installed(const char *pkgname, pkg_state_t state);
|
|
|
|
/**
|
|
* Sets package state \a state in package dictionary \a dict.
|
|
*
|
|
* @param[in] dict Package dictionary.
|
|
* @param[in] state Package state to be set.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_set_pkg_state_dictionary(prop_dictionary_t dict, pkg_state_t state);
|
|
|
|
/*@}*/
|
|
|
|
/**
|
|
* @ingroup unpack
|
|
*
|
|
* Unpacks a binary package into specified root directory.
|
|
*
|
|
* @param[in] trans_pkg_dict Package proplib dictionary as stored in the
|
|
* \a packages array returned by the transaction dictionary.
|
|
*
|
|
* @return 0 on success, otherwise an errno value.
|
|
*/
|
|
int xbps_unpack_binary_pkg(prop_dictionary_t trans_pkg_dict);
|
|
|
|
/** @addtogroup util */
|
|
/*@{*/
|
|
|
|
/**
|
|
* Returns a string by concatenating its variable argument list
|
|
* as specified by the format string \a fmt.
|
|
*
|
|
* @param[in] fmt Format string, see printf(3).
|
|
* @return A pointer to a malloc(3)ed string, NULL otherwise and errno
|
|
* is set appropiately. The pointer should be free(3)d when it's
|
|
* no longer needed.
|
|
*/
|
|
char *xbps_xasprintf(const char *fmt, ...);
|
|
|
|
/**
|
|
* Returns a string with the sha256 hash for the file specified
|
|
* by \a file.
|
|
*
|
|
* @param[in] file Path to a file.
|
|
* @return A pointer to a malloc(3)ed string, NULL otherwise and errno
|
|
* is set appropiately. The pointer should be free(3)d when it's no
|
|
* longer needed.
|
|
*/
|
|
char *xbps_get_file_hash(const char *file);
|
|
|
|
/**
|
|
* Compares the sha256 hash of the file \a file with the sha256
|
|
* string specified by \a sha256.
|
|
*
|
|
* @param[in] file Path to a file.
|
|
* @param[in] sha256 SHA256 hash to compare.
|
|
*
|
|
* @return 0 if \a file and \a sha256 have the same hash, ERANGE
|
|
* if it differs, or any other errno value on error.
|
|
*/
|
|
int xbps_check_file_hash(const char *file, const char *sha256);
|
|
|
|
/**
|
|
* Checks if a package is currently installed by matching a package
|
|
* pattern string.
|
|
*
|
|
* @param[in] pkg Package pattern used to find the package.
|
|
*
|
|
* @return -1 on error (errno set appropiately), 0 if package pattern
|
|
* didn't match installed package, 1 if \a pkg pattern fully
|
|
* matched installed package.
|
|
*/
|
|
int xbps_check_is_installed_pkg(const char *pkg);
|
|
|
|
/**
|
|
* Checks if package \a pkgname is currently installed.
|
|
*
|
|
* @param[in] pkgname Package name.
|
|
*
|
|
* @return True if \a pkgname is installed, false otherwise.
|
|
*/
|
|
bool xbps_check_is_installed_pkgname(const char *pkgname);
|
|
|
|
/**
|
|
* Checks if the URI specified by \a uri is remote or local.
|
|
*
|
|
* @param[in] uri URI string.
|
|
*
|
|
* @return true if URI is remote, false if local.
|
|
*/
|
|
bool xbps_check_is_repo_string_remote(const char *uri);
|
|
|
|
/**
|
|
* Gets the full URI to a binary package file as returned by a
|
|
* package dictionary from a repository in \a pkgd, by looking at the
|
|
* repository location object "repository" in its dictionary.
|
|
*
|
|
* @param[in] pkgd Package dictionary stored in a transaction dictionary.
|
|
* @param[in] repoloc Repository URL location string.
|
|
*
|
|
* @return A pointer to a malloc(3)ed string, NULL otherwise and
|
|
* errno is set appropiately. The pointer should be free(3)d when it's
|
|
* no longer needed.
|
|
*/
|
|
char *xbps_get_binpkg_repo_uri(prop_dictionary_t pkgd, const char *repoloc);
|
|
|
|
/**
|
|
* Gets the full path to a repository package index plist file, as
|
|
* specified by \a uri.
|
|
*
|
|
* @param[in] uri Repository URI.
|
|
*
|
|
* @return A pointer to a malloc(3)d string, NULL otherwise and
|
|
* errno is set appropiately. The pointer should be free(3)d when it's
|
|
* no longer needed.
|
|
*/
|
|
char *xbps_get_pkg_index_plist(const char *uri);
|
|
|
|
/**
|
|
* Gets the name of a package string. Package strings are composed
|
|
* by a @<pkgname@>/@<version@> pair and separated by the <em>minus</em>
|
|
* sign, i.e <b>foo-2.0</b>.
|
|
*
|
|
* @param[in] pkg Package string.
|
|
*
|
|
* @return A pointer to a malloc(3)d string, NULL otherwise and
|
|
* errno is set appropiately. The pointer should be free(3)d when it's
|
|
* no longer needed.
|
|
*/
|
|
char *xbps_get_pkg_name(const char *pkg);
|
|
|
|
/**
|
|
* Gets a the package name of a package pattern string specified by
|
|
* the \a pattern argument.
|
|
*
|
|
* @param[in] pattern A package pattern. Package patterns are composed
|
|
* by looking at <b>'><='</b> to split components, i.e <b>foo>=2.0</b>,
|
|
* <b>blah<1.0</b>, <b>blob==2.0</b>, etc.
|
|
*
|
|
* @return A pointer to a malloc(3)ed string with the package name,
|
|
* NULL otherwise and errno is set appropiately. The pointer should be
|
|
* free(3)d when it's no longer needed.
|
|
*/
|
|
char *xbps_get_pkgpattern_name(const char *pattern);
|
|
|
|
/**
|
|
* Gets the package epoch version in a package string, i.e <b>foo-2.0:epoch</b>.
|
|
*
|
|
* @param[in] pkg Package string.
|
|
*
|
|
* @return A string with the epoch version string, NULL if it couldn't find
|
|
* the epoch component.
|
|
*/
|
|
const char *xbps_get_pkg_epoch(const char *pkg);
|
|
|
|
/**
|
|
* Gets the package version in a package string, i.e <b>foo-2.0</b>.
|
|
*
|
|
* @param[in] pkg Package string.
|
|
*
|
|
* @return A string with the version string, NULL if it couldn't
|
|
* find the version component.
|
|
*/
|
|
const char *xbps_get_pkg_version(const char *pkg);
|
|
|
|
/**
|
|
* Gets the package version of a package pattern string specified by
|
|
* the \a pattern argument.
|
|
*
|
|
* @param[in] pattern A package pattern. The same rules in
|
|
* xbps_get_pkgpattern_name() apply here.
|
|
*
|
|
* @return A string with the pattern version, NULL otherwise and
|
|
* errno is set appropiately.
|
|
*/
|
|
const char *xbps_get_pkgpattern_version(const char *pattern);
|
|
|
|
/**
|
|
* Gets the package version revision in a package string.
|
|
*
|
|
* @param[in] pkg Package string, i.e <b>foo-2.0_1</b>.
|
|
*
|
|
* @return A string with the revision number, NULL if it couldn't
|
|
* find the revision component.
|
|
*/
|
|
const char *xbps_get_pkg_revision(const char *pkg);
|
|
|
|
/**
|
|
* Checks if a package has run dependencies.
|
|
*
|
|
* @param[in] dict Package dictionary.
|
|
*
|
|
* @return True if package has run dependencies, false otherwise.
|
|
*/
|
|
bool xbps_pkg_has_rundeps(prop_dictionary_t dict);
|
|
|
|
/**
|
|
* Sets the global root directory.
|
|
*
|
|
* @param[in] path Destination directory.
|
|
*/
|
|
void xbps_set_rootdir(const char *path);
|
|
|
|
/**
|
|
* Gets the global root directory.
|
|
*
|
|
* @return A string with full path to the root directory.
|
|
*/
|
|
const char *xbps_get_rootdir(void);
|
|
|
|
/**
|
|
* Sets globally the cache directory to store downloaded binary
|
|
* packages. Any full path without rootdir is valid.
|
|
*
|
|
* @param[in] cachedir Directory to be set.
|
|
*/
|
|
void xbps_set_cachedir(const char *cachedir);
|
|
|
|
/**
|
|
* Gets the cache directory currently used to store downloaded
|
|
* binary packages.
|
|
*
|
|
* @return The path to a directory.
|
|
*/
|
|
const char *xbps_get_cachedir(void);
|
|
|
|
/**
|
|
* Sets the flag specified in \a flags for internal use.
|
|
*
|
|
* @param[in] flags Flags to be set globally.
|
|
*/
|
|
void xbps_set_flags(int flags);
|
|
|
|
/**
|
|
* Gets the flags currently set internally.
|
|
*
|
|
* @return An integer with flags
|
|
*/
|
|
int xbps_get_flags(void);
|
|
|
|
/*@}*/
|
|
|
|
__END_DECLS
|
|
|
|
#endif /* !_XBPS_API_H_ */
|