path: root/lib/libalpm/alpm.c

/*
 *  alpm.c
 *
 *  Copyright (c) 2006-2017 Pacman Development Team <pacman-dev@archlinux.org>
 *  Copyright (c) 2002-2006 by Judd Vinet <jvinet@zeroflux.org>
 *  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>
 *
 *  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
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifdef HAVE_LIBCURL
#include <curl/curl.h>
#endif

/* libalpm */
#include "alpm.h"
#include "alpm_list.h"
#include "handle.h"
#include "log.h"
#include "util.h"

/** \addtogroup alpm_interface Interface Functions
 * @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 SYMEXPORT *alpm_initialize(const char *root, const char *dbpath,
                alpm_errno_t *err)
{
        alpm_errno_t myerr;
        const char *lf = "db.lck";
        char *hookdir;
        size_t lockfilelen;
        alpm_handle_t *myhandle = _alpm_handle_new();

        if(myhandle == NULL) {
                goto nomem;
        }
        if((myerr = _alpm_set_directory_option(root, &(myhandle->root), 1))) {
                goto cleanup;
        }
        if((myerr = _alpm_set_directory_option(dbpath, &(myhandle->dbpath), 1))) {
                goto cleanup;
        }

        /* to contatenate myhandle->root (ends with a slash) with SYSHOOKDIR (starts
         * with a slash) correctly, we skip SYSHOOKDIR[0]; the regular +1 therefore
         * disappears from the allocation */
        MALLOC(hookdir, strlen(myhandle->root) + strlen(SYSHOOKDIR), goto nomem);
        sprintf(hookdir, "%s%s", myhandle->root, SYSHOOKDIR + 1);
        myhandle->hookdirs = alpm_list_add(NULL, hookdir);

        /* set default database extension */
        STRDUP(myhandle->dbext, ".db", goto nomem);

        lockfilelen = strlen(myhandle->dbpath) + strlen(lf) + 1;
        MALLOC(myhandle->lockfile, lockfilelen, goto nomem);
        snprintf(myhandle->lockfile, lockfilelen, "%s%s", myhandle->dbpath, lf);

        if(_alpm_db_register_local(myhandle) == NULL) {
                myerr = myhandle->pm_errno;
                goto cleanup;
        }

#ifdef ENABLE_NLS
        bindtextdomain("libalpm", LOCALEDIR);
#endif

        return myhandle;

nomem:
        myerr = ALPM_ERR_MEMORY;
cleanup:
        _alpm_handle_free(myhandle);
        if(err) {
                *err = myerr;
        }
        return NULL;
}

/** 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.
 * @param myhandle the context handle
 * @return 0 on success, -1 on error
 */
int SYMEXPORT alpm_release(alpm_handle_t *myhandle)
{
        int ret = 0;
        alpm_db_t *db;

        CHECK_HANDLE(myhandle, return -1);

        /* close local database */
        db = myhandle->db_local;
        if(db) {
                db->ops->unregister(db);
                myhandle->db_local = NULL;
        }

        if(alpm_unregister_all_syncdbs(myhandle) == -1) {
                ret = -1;
        }

        _alpm_handle_unlock(myhandle);
        _alpm_handle_free(myhandle);

#ifdef HAVE_LIBCURL
        curl_global_cleanup();
#endif

        return ret;
}

/** @} */

/** @defgroup alpm_misc Miscellaneous Functions
 * @brief Various libalpm functions
 */

/** Get the version of library.
 * @return the library version, e.g. "6.0.4"
 * */
const char SYMEXPORT *alpm_version(void)
{
        return LIB_VERSION;
}

/** Get the capabilities of the library.
 * @return a bitmask of the capabilities
 * */
int SYMEXPORT alpm_capabilities(void)
{
        return 0
#ifdef ENABLE_NLS
                | ALPM_CAPABILITY_NLS
#endif
#ifdef HAVE_LIBCURL
                | ALPM_CAPABILITY_DOWNLOADER
#endif
#ifdef HAVE_LIBGPGME
                | ALPM_CAPABILITY_SIGNATURES
#endif
                | 0;
}

/* vim: set noet: */