util.c

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

#ifdef HAVE_VASPRINTF
# define _GNU_SOURCE    /* for vasprintf(3) */
#endif

#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <fnmatch.h>
#include <sys/utsname.h>

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "xbps_api_impl.h"

/**
 * @file lib/util.c
 * @brief Utility routines
 * @defgroup util Utility functions
 */
bool
xbps_repository_is_remote(const char *uri)
{
        assert(uri != NULL);

        if ((strncmp(uri, "https://", 8) == 0) ||
            (strncmp(uri, "http://", 7) == 0) ||
            (strncmp(uri, "ftp://", 6) == 0))
                return true;

        return false;
}

int
xbps_pkg_is_installed(struct xbps_handle *xhp, const char *pkg)
{
        prop_dictionary_t dict;
        pkg_state_t state;

        assert(xhp);
        assert(pkg);

        if (((dict = xbps_pkgdb_get_virtualpkg(xhp, pkg)) == NULL) &&
            ((dict = xbps_pkgdb_get_pkg(xhp, pkg)) == NULL))
                return 0; /* not installed */
        /*
         * Check that package state is fully installed, not
         * unpacked or something else.
         */
        if (xbps_pkg_state_dictionary(dict, &state) != 0)
                return -1; /* error */
        if (state != XBPS_PKG_STATE_INSTALLED)
                return 0; /* not fully installed */

        return 1;
}

const char *
xbps_pkg_version(const char *pkg)
{
        const char *p;

        if ((p = strrchr(pkg, '-')) == NULL)
                return NULL;

        if (strrchr(p, '_') == NULL)
                return NULL;

        return p + 1; /* skip first '_' */
}

const char *
xbps_pkg_revision(const char *pkg)
{
        const char *p;

        assert(pkg != NULL);

        /* Get the required revision */
        if ((p = strrchr(pkg, '_')) == NULL)
                return NULL;

        return p + 1; /* skip first '_' */
}

char *
xbps_pkg_name(const char *pkg)
{
        const char *p;
        char *buf;
        size_t len;

        if ((p = strrchr(pkg, '-')) == NULL)
                return NULL;

        if (strrchr(p, '_') == NULL)
                return NULL;

        len = strlen(pkg) - strlen(p) + 1;
        buf = malloc(len);
        assert(buf != NULL);

        memcpy(buf, pkg, len-1);
        buf[len-1] = '\0';

        return buf;
}

char *
xbps_pkgpattern_name(const char *pkg)
{
        char *res, *pkgname;
        size_t len;

        assert(pkg != NULL);

        if ((res = strpbrk(pkg, "><*?[]")) == NULL)
                return NULL;

        len = strlen(pkg) - strlen(res) + 1;
        if (pkg[len-2] == '-')
                len--;

        pkgname = malloc(len);
        assert(pkgname != NULL);

        memcpy(pkgname, pkg, len-1);
        pkgname[len-1] = '\0';

        return pkgname;
}

const char *
xbps_pkgpattern_version(const char *pkg)
{
        assert(pkg != NULL);

        return strpbrk(pkg, "><*?[]");
}

static char *
get_pkg_index_remote_plist(struct xbps_handle *xhp,
                           const char *uri,
                           const char *plistf)
{
        char *uri_fixed, *repodir;

        assert(uri != NULL);

        uri_fixed = xbps_get_remote_repo_string(uri);
        if (uri_fixed == NULL)
                return NULL;

        repodir = xbps_xasprintf("%s/%s/%s-%s", xhp->metadir,
                        uri_fixed, xhp->un_machine, plistf);
        free(uri_fixed);
        return repodir;
}

char *
xbps_pkg_index_plist(struct xbps_handle *xhp, const char *uri)
{
        assert(xhp);
        assert(uri != NULL);

        if (xbps_repository_is_remote(uri))
                return get_pkg_index_remote_plist(xhp, uri, XBPS_PKGINDEX);

        return xbps_xasprintf("%s/%s-%s", uri, xhp->un_machine, XBPS_PKGINDEX);
}

char *
xbps_pkg_index_files_plist(struct xbps_handle *xhp, const char *uri)
{
        assert(xhp);
        assert(uri != NULL);

        if (xbps_repository_is_remote(uri))
                return get_pkg_index_remote_plist(xhp, uri, XBPS_PKGINDEX_FILES);

        return xbps_xasprintf("%s/%s-%s", uri,
                        xhp->un_machine, XBPS_PKGINDEX_FILES);
}

char HIDDEN *
xbps_repository_pkg_path(struct xbps_handle *xhp, prop_dictionary_t pkg_repod)
{
        const char *filen, *repoloc;
        char *lbinpkg = NULL;

        assert(xhp);
        assert(prop_object_type(pkg_repod) == PROP_TYPE_DICTIONARY);

        if (!prop_dictionary_get_cstring_nocopy(pkg_repod,
            "filename", &filen))
                return NULL;
        if (!prop_dictionary_get_cstring_nocopy(pkg_repod,
            "repository", &repoloc))
                return NULL;

        if (xbps_repository_is_remote(repoloc)) {
                /*
                 * First check if binpkg is available in cachedir.
                 */
                lbinpkg = xbps_xasprintf("%s/%s", xhp->cachedir, filen);
                if (access(lbinpkg, R_OK) == 0)
                        return lbinpkg;

                free(lbinpkg);
        }
        /*
         * Local and remote repositories use the same path.
         */
        return xbps_xasprintf("%s/%s", repoloc, filen);
}

bool
xbps_pkg_has_rundeps(prop_dictionary_t pkgd)
{
        prop_array_t array;

        assert(prop_object_type(pkgd) == PROP_TYPE_DICTIONARY);

        array = prop_dictionary_get(pkgd, "run_depends");
        if ((prop_object_type(array) == PROP_TYPE_ARRAY) &&
             prop_array_count(array) > 0)
                return true;

        return false;
}

bool
xbps_pkg_arch_match(struct xbps_handle *xhp,
                    const char *orig,
                    const char *target)
{
        if (target == NULL) {
                if ((strcmp(orig, "noarch") == 0) ||
                    (strcmp(orig, xhp->un_machine) == 0))
                        return true;
        } else {
                if ((strcmp(orig, "noarch") == 0) ||
                    (strcmp(orig, target) == 0))
                        return true;
        }
        return false;
}

char *
xbps_xasprintf(const char *fmt, ...)
{
        va_list ap;
        char *buf = NULL;

        va_start(ap, fmt);
        if (vasprintf(&buf, fmt, ap) == -1) {
                va_end(ap);
                assert(buf);
        }
        va_end(ap);
        assert(buf);

        return buf;
}

/*
 * Match pkg against pattern, return 1 if matching, 0 otherwise or -1 on error.
 */
int
xbps_pkgpattern_match(const char *pkg, const char *pattern)
{
        /* simple match on "pkg" against "pattern" */
        if (strcmp(pattern, pkg) == 0)
                return 1;

        /* perform relational dewey match on version number */
        if (strpbrk(pattern, "<>") != NULL)
                return dewey_match(pattern, pkg);

        /* glob match */
        if (strpbrk(pattern, "*?[]") != NULL)
                if (fnmatch(pattern, pkg, FNM_PERIOD) == 0)
                        return 1;

        /* no match */
        return 0;
}

/*
 * Small wrapper for NetBSD's humanize_number(3) with some
 * defaults set that we care about.
 */
int
xbps_humanize_number(char *buf, int64_t bytes)
{
        assert(buf != NULL);

        return humanize_number(buf, 7, bytes, "B",
            HN_AUTOSCALE, HN_DECIMAL|HN_NOSPACE);
}