xbps/lib/repository_pool_find.c

/*-
 * Copyright (c) 2009-2012 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.
 */

#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>

#include "xbps_api_impl.h"

/**
 * @file lib/repository_pool_find.c
 * @brief Repository pool routines
 * @defgroup repopool Repository pool functions
 */
struct repo_pool_fpkg {
	prop_dictionary_t pkgd;
	const char *pattern;
	const char *bestpkgver;
	bool bypattern;
	bool exact;
};

static int
repo_find_virtualpkg_cb(struct xbps_handle *xhp,
			struct xbps_rpool_index *rpi,
			void *arg,
			bool *done)
{
	struct repo_pool_fpkg *rpf = arg;

	(void)xhp;

	if (rpf->bypattern) {
		rpf->pkgd =
		    xbps_find_virtualpkg_in_array_by_pattern(xhp, rpi->repo,
		    rpf->pattern);
	} else {
		rpf->pkgd =
		    xbps_find_virtualpkg_in_array_by_name(xhp, rpi->repo,
		    rpf->pattern);
	}
	if (rpf->pkgd) {
		prop_dictionary_set_cstring_nocopy(rpf->pkgd,
		    "repository", rpi->uri);
		*done = true;
		return 0;
	}
	/* not found */
	return 0;
}

static int
repo_find_virtualpkg_conf_cb(struct xbps_handle *xhp,
			     struct xbps_rpool_index *rpi,
			     void *arg,
			     bool *done)
{
	struct repo_pool_fpkg *rpf = arg;

	if (rpf->bypattern) {
		rpf->pkgd =
		    xbps_find_virtualpkg_conf_in_array_by_pattern(xhp,
		    rpi->repo, rpf->pattern);
	} else {
		rpf->pkgd =
		    xbps_find_virtualpkg_conf_in_array_by_name(xhp,
		    rpi->repo, rpf->pattern);
	}
	if (rpf->pkgd) {
		prop_dictionary_set_cstring_nocopy(rpf->pkgd,
		    "repository", rpi->uri);
		*done = true;
		return 0;
	}
	/* not found */
	return 0;
}

static int
repo_find_pkg_cb(struct xbps_handle *xhp,
		 struct xbps_rpool_index *rpi,
		 void *arg,
		 bool *done)
{
	struct repo_pool_fpkg *rpf = arg;

	(void)xhp;

	if (rpf->exact) {
		/* exact match by pkgver */
		rpf->pkgd = xbps_find_pkg_in_array_by_pkgver(xhp, rpi->repo,
		    rpf->pattern, NULL);
	} else if (rpf->bypattern) {
		/* match by pkgpattern in pkgver*/
		rpf->pkgd = xbps_find_pkg_in_array_by_pattern(xhp, rpi->repo,
		    rpf->pattern, NULL);
	} else {
		/* match by pkgname */
		rpf->pkgd = xbps_find_pkg_in_array_by_name(xhp, rpi->repo,
		    rpf->pattern, NULL);
	}
	if (rpf->pkgd) {
		/*
		 * Package dictionary found, add the "repository"
		 * object with the URI.
		 */
		prop_dictionary_set_cstring_nocopy(rpf->pkgd,
		    "repository", rpi->uri);
		*done = true;
		return 0;
	}
	/* Not found */
	return 0;
}

static int
repo_find_best_pkg_cb(struct xbps_handle *xhp,
		      struct xbps_rpool_index *rpi,
		      void *arg,
		      bool *done)
{
	struct repo_pool_fpkg *rpf = arg;
	const char *repopkgver;
	prop_dictionary_t pkgd;

	(void)done;
	(void)xhp;

	if (rpf->bypattern) {
		pkgd = xbps_find_pkg_in_array_by_pattern(xhp, rpi->repo,
		    rpf->pattern, NULL);
	} else {
		pkgd = xbps_find_pkg_in_array_by_name(xhp, rpi->repo,
		    rpf->pattern, NULL);
	}
	if (pkgd == NULL) {
		if (errno && errno != ENOENT)
			return errno;

		xbps_dbg_printf(xhp,
		    "[rpool] Package '%s' not found in repository "
		    "'%s'.\n", rpf->pattern, rpi->uri);
		return 0;
	}
	prop_dictionary_get_cstring_nocopy(pkgd,
	    "pkgver", &repopkgver);
	if (rpf->bestpkgver == NULL) {
		xbps_dbg_printf(xhp,
		    "[rpool] Found best match '%s' (%s).\n",
		    repopkgver, rpi->uri);
		rpf->pkgd = pkgd;
		prop_dictionary_set_cstring_nocopy(rpf->pkgd,
		    "repository", rpi->uri);
		rpf->bestpkgver = repopkgver;
		return 0;
	}
	/*
	 * Compare current stored version against new
	 * version from current package in repository.
	 */
	if (xbps_cmpver(repopkgver, rpf->bestpkgver) == 1) {
		xbps_dbg_printf(xhp,
		    "[rpool] Found best match '%s' (%s).\n",
		    repopkgver, rpi->uri);
		rpf->pkgd = pkgd;
		prop_dictionary_set_cstring_nocopy(rpf->pkgd,
		    "repository", rpi->uri);
		rpf->bestpkgver = repopkgver;
	}
	return 0;
}

typedef enum {
	BEST_PKG = 1,
	EXACT_PKG,
	VIRTUAL_PKG,
	VIRTUAL_CONF_PKG,
	REAL_PKG
} pkg_repo_type_t;

static prop_dictionary_t
repo_find_pkg(struct xbps_handle *xhp,
	      const char *pkg,
	      bool bypattern,
	      pkg_repo_type_t type)
{
	struct repo_pool_fpkg rpf;
	int rv = 0;

	rpf.pattern = pkg;
	rpf.bypattern = bypattern;
	rpf.exact = false;
	rpf.pkgd = NULL;
	rpf.bestpkgver = NULL;

	switch (type) {
	case EXACT_PKG:
		/*
		 * Find exact pkg version.
		 */
		rpf.exact = true;
		rv = xbps_rpool_foreach(xhp, repo_find_pkg_cb, &rpf);
		break;
	case BEST_PKG:
		/*
		 * Find best pkg version.
		 */
		rv = xbps_rpool_foreach(xhp, repo_find_best_pkg_cb, &rpf);
		break;
	case VIRTUAL_PKG:
		/*
		 * Find virtual pkg.
		 */
		rv = xbps_rpool_foreach(xhp, repo_find_virtualpkg_cb, &rpf);
		break;
	case VIRTUAL_CONF_PKG:
		/*
		 * Find virtual pkg as specified in configuration file.
		 */
		rv = xbps_rpool_foreach(xhp, repo_find_virtualpkg_conf_cb, &rpf);
		break;
	case REAL_PKG:
		/*
		 * Find real pkg.
		 */
		rv = xbps_rpool_foreach(xhp, repo_find_pkg_cb, &rpf);
		break;
	}
	if (rv != 0) {
		errno = rv;
		return NULL;
	}

	return rpf.pkgd;
}

prop_dictionary_t
xbps_rpool_find_virtualpkg(struct xbps_handle *xhp,
			   const char *pkg,
			   bool bypattern)
{
	assert(pkg != NULL);

	return repo_find_pkg(xhp, pkg, bypattern, VIRTUAL_PKG);
}

prop_dictionary_t
xbps_rpool_find_virtualpkg_conf(struct xbps_handle *xhp,
				const char *pkg,
				bool bypattern)
{
	assert(pkg != NULL);

	return repo_find_pkg(xhp, pkg, bypattern, VIRTUAL_CONF_PKG);
}

prop_dictionary_t
xbps_rpool_find_pkg(struct xbps_handle *xhp,
		    const char *pkg,
		    bool bypattern,
		    bool best)
{
	assert(pkg != NULL);

	if (best)
		return repo_find_pkg(xhp, pkg, bypattern, BEST_PKG);

	return repo_find_pkg(xhp, pkg, bypattern, REAL_PKG);
}

prop_dictionary_t
xbps_rpool_find_pkg_exact(struct xbps_handle *xhp, const char *pkgver)
{
	assert(pkgver != NULL);

	return repo_find_pkg(xhp, pkgver, false, EXACT_PKG);
}

prop_dictionary_t
xbps_rpool_dictionary_metadata_plist(struct xbps_handle *xhp,
				     const char *pattern,
				     const char *plistf)
{
	prop_dictionary_t pkgd = NULL, plistd = NULL;
	const char *repoloc;
	char *url;

	assert(pattern != NULL);
	assert(plistf != NULL);
	/*
	 * Iterate over the the repository pool and search for a plist file
	 * in the binary package matching `pattern'. 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!
	 */
	if (xbps_pkgpattern_version(pattern))
		pkgd = xbps_rpool_find_pkg(xhp, pattern, true, false);
	else
		pkgd = xbps_rpool_find_pkg(xhp, pattern, false, true);

	if (pkgd == NULL)
		goto out;

	prop_dictionary_get_cstring_nocopy(pkgd, "repository", &repoloc);
	url = xbps_path_from_repository_uri(xhp, pkgd, repoloc);
	if (url == NULL) {
		errno = EINVAL;
		goto out;
	}
	plistd = xbps_dictionary_metadata_plist_by_url(url, plistf);
	free(url);

out:
	if (plistd == NULL)
		errno = ENOENT;
	if (prop_object_type(pkgd) == PROP_TYPE_DICTIONARY)
		prop_object_release(pkgd);

	return plistd;
}