xbps/bin/xbps-rindex/index.c

/*-
 * Copyright (c) 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 <sys/stat.h>
#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <dirent.h>
#include <libgen.h>
#include <assert.h>

#include <xbps_api.h>
#include "defs.h"

/*
 * Removes stalled pkg entries in repository's index.plist file, if any
 * binary package cannot be read (unavailable, not enough perms, etc).
 */
int
index_clean(struct xbps_handle *xhp, const char *repodir)
{
	prop_array_t result = NULL;
	prop_object_t obj;
	prop_object_iterator_t iter;
	prop_dictionary_t idx, idxfiles, pkgd;
	const char *filen, *pkgver, *arch, *keyname, *sha256;
	char *plist, *plistf;
	size_t i;
	int rv = 0;
	bool flush = false;

	plist = xbps_pkg_index_plist(xhp, repodir);
	assert(plist);
	plistf = xbps_pkg_index_files_plist(xhp, repodir);
	assert(plistf);

	idx = prop_dictionary_internalize_from_zfile(plist);
	if (idx == NULL) {
		if (errno != ENOENT) {
			fprintf(stderr, "index: cannot read `%s': %s\n",
			    plist, strerror(errno));
			free(plist);
			return -1;
		} else {
			free(plist);
			return 0;
		}
	}
	idxfiles = prop_dictionary_internalize_from_zfile(plistf);
	if (idxfiles == NULL) {
		if (errno != ENOENT) {
			fprintf(stderr, "index: cannot read `%s': %s\n",
			    plistf, strerror(errno));
			rv = -1;
			goto out;
		} else {
			goto out;
		}
	}
	if (chdir(repodir) == -1) {
		fprintf(stderr, "index: cannot chdir to %s: %s\n",
		    repodir, strerror(errno));
		rv = -1;
		goto out;
	}
	printf("Cleaning `%s' index, please wait...\n", repodir);

	iter = prop_dictionary_iterator(idx);
	while ((obj = prop_object_iterator_next(iter))) {
		pkgd = prop_dictionary_get_keysym(idx, obj);
		prop_dictionary_get_cstring_nocopy(pkgd, "filename", &filen);
		if (access(filen, R_OK) == -1) {
			/*
			 * File cannot be read, might be permissions,
			 * broken or simply unexistent; either way, remove it.
			 */
			prop_dictionary_get_cstring_nocopy(pkgd,
			    "pkgver", &pkgver);
			prop_dictionary_get_cstring_nocopy(pkgd,
			    "architecture", &arch);
			printf("index: removed obsolete entry `%s' (%s)\n",
			    pkgver, arch);
			if (result == NULL)
				result = prop_array_create();

			keyname = prop_dictionary_keysym_cstring_nocopy(obj);
			prop_array_add_cstring_nocopy(result, keyname);
			flush = true;
		}
		/*
		 * File can be read; check its hash.
		 */
		prop_dictionary_get_cstring_nocopy(pkgd,
		    "filename-sha256", &sha256);
		rv = xbps_file_hash_check(filen, sha256);
		if (rv != 0) {
			prop_dictionary_get_cstring_nocopy(pkgd,
			    "pkgver", &pkgver);
			prop_dictionary_get_cstring_nocopy(pkgd,
			    "architecture", &arch);
			printf("index: removed entry `%s' due to "
			    "unmatched hash (%s)\n", pkgver, arch);
			if (result == NULL)
				result = prop_array_create();

			keyname = prop_dictionary_keysym_cstring_nocopy(obj);
			prop_array_add_cstring_nocopy(result, keyname);
			flush = true;
		}
	}
	prop_object_iterator_release(iter);

	if (flush) {
		for (i = 0; i < prop_array_count(result); i++) {
			prop_array_get_cstring_nocopy(result, i, &keyname);
			prop_dictionary_remove(idx, keyname);
			prop_dictionary_remove(idxfiles, keyname);
		}
		prop_object_release(result);
		if (!prop_dictionary_externalize_to_zfile(idx, plist) &&
		    !prop_dictionary_externalize_to_zfile(idxfiles, plistf)) {
			fprintf(stderr, "index: failed to externalize %s: %s\n",
			    plist, strerror(errno));
			goto out;
		}
	}
	printf("index: %u packages registered.\n",
	    prop_dictionary_count(idx));
	printf("index-files: %u packages registered.\n",
	    prop_dictionary_count(idxfiles));
out:
	if (plist)
		free(plist);
	if (plistf)
		free(plistf);
	if (idx)
		prop_object_release(idx);
	if (idxfiles)
		prop_object_release(idxfiles);

	return rv;
}

/*
 * Adds a binary package into the index and removes old binary package
 * and entry when it's necessary.
 */
int
index_add(struct xbps_handle *xhp, int argc, char **argv)
{
	prop_array_t filespkgar, pkg_files, pkg_links, pkg_cffiles;
	prop_dictionary_t idx, idxfiles, newpkgd, newpkgfilesd, curpkgd;
	prop_dictionary_t filespkgd;
	prop_object_t obj, fileobj;
	struct stat st;
	const char *pkgname, *version, *regver, *oldfilen, *oldpkgver;
	const char *pkgver, *arch, *oldarch;
	char *sha256, *filen, *repodir, *buf, *buf2;
	char *tmpfilen, *tmprepodir, *plist, *plistf;
	size_t x;
	int i, ret = 0, rv = 0;
	bool files_flush = false, found = false, flush = false;

	idx = idxfiles = newpkgd = newpkgfilesd = curpkgd = NULL;
	tmpfilen = tmprepodir = plist = plistf = NULL;

	if ((tmprepodir = strdup(argv[0])) == NULL) {
		rv = ENOMEM;
		goto out;
	}
	repodir = dirname(tmprepodir);

	/* Internalize index or create it if doesn't exist */
	if ((plist = xbps_pkg_index_plist(xhp, repodir)) == NULL)
		return -1;

	if ((idx = prop_dictionary_internalize_from_zfile(plist)) == NULL) {
		if (errno != ENOENT) {
			fprintf(stderr, "index: cannot read `%s': %s\n",
			    plist, strerror(errno));
			rv = -1;
			goto out;
		} else {
			idx = prop_dictionary_create();
			assert(idx);
		}
	}
	/* Internalize index-files or create it if doesn't exist */
	if ((plistf = xbps_pkg_index_files_plist(xhp, repodir)) == NULL)
		return -1;

	if ((idxfiles = prop_dictionary_internalize_from_zfile(plistf)) == NULL) {
		if (errno != ENOENT) {
			fprintf(stderr, "index: cannot read `%s': %s\n",
			    plistf, strerror(errno));
			rv = -1;
			goto out;
		} else {
			idxfiles = prop_dictionary_create();
			assert(idx);
		}
	}

	/*
	 * Process all packages specified in argv.
	 */
	for (i = 0; i < argc; i++) {
		if ((tmpfilen = strdup(argv[i])) == NULL) {
			rv = ENOMEM;
			goto out;
		}
		filen = basename(tmpfilen);
		/*
		 * Read metadata props plist dictionary from binary package.
		 */
		newpkgd = xbps_get_pkg_plist_from_binpkg(argv[i],
		    "./props.plist");
		if (newpkgd == NULL) {
			fprintf(stderr, "failed to read %s metadata for `%s',"
			    " skipping!\n", XBPS_PKGPROPS, argv[i]);
			free(tmpfilen);
			continue;
		}
		prop_dictionary_get_cstring_nocopy(newpkgd, "architecture",
		    &arch);
		prop_dictionary_get_cstring_nocopy(newpkgd, "pkgver", &pkgver);
		if (!xbps_pkg_arch_match(xhp, arch, NULL)) {
			fprintf(stderr, "index: ignoring %s, unmatched "
			    "arch (%s)\n", pkgver, arch);
			prop_object_release(newpkgd);
			continue;
		}
		prop_dictionary_get_cstring_nocopy(newpkgd, "pkgname",
		    &pkgname);
		prop_dictionary_get_cstring_nocopy(newpkgd, "version",
		    &version);
		/*
		 * Check if this package exists already in the index, but first
		 * checking the version. If current package version is greater
		 * than current registered package, update the index; otherwise
		 * pass to the next one.
		 */
		curpkgd = prop_dictionary_get(idx, pkgname);
		if (curpkgd == NULL) {
			if (errno && errno != ENOENT) {
				prop_object_release(newpkgd);
				free(tmpfilen);
				rv = errno;
				goto out;
			}
		} else {
			prop_dictionary_get_cstring_nocopy(curpkgd,
			    "filename", &oldfilen);
			prop_dictionary_get_cstring_nocopy(curpkgd,
			    "pkgver", &oldpkgver);
			prop_dictionary_get_cstring_nocopy(curpkgd,
			    "architecture", &oldarch);
			prop_dictionary_get_cstring_nocopy(curpkgd,
			    "version", &regver);
			ret = xbps_cmpver(version, regver);
			if (ret == 0) {
				/* Same version */
				fprintf(stderr, "index: skipping `%s-%s' "
				    "(%s), already registered.\n",
				    pkgname, version, arch);
				prop_object_release(newpkgd);
				free(tmpfilen);
				continue;
			} else if (ret == -1) {
				/*
				 * Index version is greater, remove current
				 * package.
				 */
				buf = xbps_xasprintf("`%s' (%s)",
				    oldpkgver, oldarch);
				rv = remove_pkg(repodir,
				    oldarch, oldfilen);
				if (rv != 0) {
					prop_object_release(newpkgd);
					free(tmpfilen);
					free(buf);
					goto out;
				}
				printf("index: removed obsolete binpkg %s.\n", buf);
				free(buf);
				prop_object_release(newpkgd);
				free(tmpfilen);
				continue;
			}
			/*
			 * Current package version is greater than
			 * index version.
			 */
			buf = xbps_xasprintf("`%s' (%s)", oldpkgver, oldarch);
			buf2 = strdup(oldpkgver);
			assert(buf2);
			rv = remove_pkg(repodir, oldarch, oldfilen);
			if (rv != 0) {
				free(buf);
				free(buf2);
				prop_object_release(newpkgd);
				free(tmpfilen);
				goto out;
			}
			prop_dictionary_remove(idx, pkgname);
			free(buf2);
			printf("index: removed obsolete entry/binpkg %s.\n", buf);
			free(buf);
		}
		/*
		 * We have the dictionary now, add the required
		 * objects for the index.
		 */
		if (!prop_dictionary_set_cstring(newpkgd, "filename", filen)) {
			rv = errno;
			prop_object_release(newpkgd);
			free(tmpfilen);
			goto out;
		}
		if ((sha256 = xbps_file_hash(argv[i])) == NULL) {
			rv = errno;
			prop_object_release(newpkgd);
			free(tmpfilen);
			goto out;
		}
		if (!prop_dictionary_set_cstring(newpkgd, "filename-sha256",
		    sha256)) {
			free(sha256);
			prop_object_release(newpkgd);
			free(tmpfilen);
			rv = errno;
			goto out;
		}
		free(sha256);
		if (stat(argv[i], &st) == -1) {
			prop_object_release(newpkgd);
			free(tmpfilen);
			rv = errno;
			goto out;
		}
		if (!prop_dictionary_set_uint64(newpkgd, "filename-size",
		    (uint64_t)st.st_size)) {
			prop_object_release(newpkgd);
			free(tmpfilen);
			rv = errno;
			goto out;
		}
		/*
		 * Add new pkg dictionary into the index.
		 */
		if (!prop_dictionary_set(idx, pkgname, newpkgd)) {
			prop_object_release(newpkgd);
			free(tmpfilen);
			rv = EINVAL;
			goto out;
		}
		flush = true;
		printf("index: added `%s-%s' (%s).\n", pkgname, version, arch);
		free(tmpfilen);
		/*
		 * Add new pkg dictionary into the index-files.
		 */
		found = false;
		newpkgfilesd = xbps_get_pkg_plist_from_binpkg(argv[i],
				"./files.plist");
		if (newpkgfilesd == NULL) {
			rv = EINVAL;
			goto out;
		}

		/* Find out if binary pkg stored in index contain any file */
		pkg_cffiles = prop_dictionary_get(newpkgfilesd, "conf_files");
		if (pkg_cffiles != NULL && prop_array_count(pkg_cffiles))
			found = true;
		else
			pkg_cffiles = NULL;

		pkg_files = prop_dictionary_get(newpkgfilesd, "files");
		if (pkg_files != NULL && prop_array_count(pkg_files))
			found = true;
		else
			pkg_files = NULL;

		pkg_links = prop_dictionary_get(newpkgfilesd, "links");
		if (pkg_links != NULL && prop_array_count(pkg_links))
			found = true;
		else
			pkg_links = NULL;

		/* If pkg does not contain any file, ignore it */
		if (!found) {
			prop_object_release(newpkgfilesd);
			prop_object_release(newpkgd);
			continue;
		}
		/* create pkg files array */
		filespkgar = prop_array_create();
		assert(filespkgar);

		/* add conf_files in pkg files array */
		if (pkg_cffiles != NULL) {
			for (x = 0; x < prop_array_count(pkg_cffiles); x++) {
				obj = prop_array_get(pkg_cffiles, x);
				fileobj = prop_dictionary_get(obj, "file");
				prop_array_add(filespkgar, fileobj);
			}
		}
		/* add files array in pkg array */
		if (pkg_files != NULL) {
			for (x = 0; x < prop_array_count(pkg_files); x++) {
				obj = prop_array_get(pkg_files, x);
				fileobj = prop_dictionary_get(obj, "file");
				prop_array_add(filespkgar, fileobj);
			}
		}
		/* add links array in pkgd */
		if (pkg_links != NULL) {
			for (x = 0; x < prop_array_count(pkg_links); x++) {
				obj = prop_array_get(pkg_links, x);
				fileobj = prop_dictionary_get(obj, "file");
				prop_array_add(filespkgar, fileobj);
			}
		}
		prop_object_release(newpkgfilesd);

		/* create pkg dictionary */
		filespkgd = prop_dictionary_create();
		assert(filespkgd);

		/* add pkg files array into pkg dictionary */
		prop_dictionary_set(filespkgd, "files", filespkgar);
		prop_object_release(filespkgar);

		/* set pkgver obj into pkg dictionary */
		prop_dictionary_set_cstring(filespkgd, "pkgver", pkgver);

		/* add pkg dictionary into index-files */
		prop_dictionary_set(idxfiles, pkgname, filespkgd);
		prop_object_release(filespkgd);

		printf("index-files: added `%s' (%s)\n", pkgver, arch);
		files_flush = true;
		prop_object_release(newpkgd);
	}

	if (flush && !prop_dictionary_externalize_to_zfile(idx, plist)) {
		fprintf(stderr, "index: failed to externalize plist: %s\n",
		    strerror(errno));
		rv = -1;
		goto out;
	}
	if (files_flush &&
	    !prop_dictionary_externalize_to_zfile(idxfiles, plistf)) {
		fprintf(stderr, "index-files: failed to externalize "
		    "plist: %s\n", strerror(errno));
		rv = -1;
		goto out;
	}
	printf("index: %u packages registered.\n",
	    prop_dictionary_count(idx));
	printf("index-files: %u packages registered.\n",
	    prop_dictionary_count(idxfiles));

out:
	if (tmprepodir)
		free(tmprepodir);
	if (plist)
		free(plist);
	if (plistf)
		free(plistf);
	if (idx)
		prop_object_release(idx);
	if (idxfiles)
		prop_object_release(idxfiles);

	return rv;
}