From 13f24a5bdabf9c2c7bfa07aff7176495bb775a0d Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Mon, 21 Jan 2008 21:23:54 -0600 Subject: Refactor pkg_load/parse_descfile into a new backend file alpm_pkg_load() and parse_descfile() are specific to getting information from package files, just as other code is specific to getting information into or out of a package database. Move this code out of package.c, which should eventually only contain operators on the pmpkg_t struct that do not depend at all on where the data came from. Signed-off-by: Dan McGee --- lib/libalpm/Makefile.am | 1 + lib/libalpm/be_package.c | 283 +++++++++++++++++++++++++++++++++++++++++++++++ lib/libalpm/package.c | 244 +--------------------------------------- lib/libalpm/package.h | 1 - 4 files changed, 285 insertions(+), 244 deletions(-) create mode 100644 lib/libalpm/be_package.c (limited to 'lib/libalpm') diff --git a/lib/libalpm/Makefile.am b/lib/libalpm/Makefile.am index 7b737363..871855ef 100644 --- a/lib/libalpm/Makefile.am +++ b/lib/libalpm/Makefile.am @@ -26,6 +26,7 @@ libalpm_la_SOURCES = \ alpm_list.h alpm_list.c \ backup.h backup.c \ be_files.c \ + be_package.c \ cache.h cache.c \ conflict.h conflict.c \ db.h db.c \ diff --git a/lib/libalpm/be_package.c b/lib/libalpm/be_package.c new file mode 100644 index 00000000..5b45edf9 --- /dev/null +++ b/lib/libalpm/be_package.c @@ -0,0 +1,283 @@ +/* + * be_package.c + * + * Copyright (c) 2002-2008 by Judd Vinet + * + * 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 . + */ + +#include "config.h" + +#include +#include +#include +#include +#include +#include /* setlocale */ + +/* libarchive */ +#include +#include + +/* libalpm */ +#include "alpm_list.h" +#include "util.h" +#include "log.h" +#include "error.h" +#include "package.h" +#include "deps.h" /* _alpm_splitdep */ + +/** + * Parses the package description file for a package into a pmpkg_t struct. + * @param archive the archive to read from, pointed at the .PKGINFO entry + * @param newpkg an empty pmpkg_t struct to fill with package info + * + * @return 0 on success, 1 on error + */ +static int parse_descfile(struct archive *a, pmpkg_t *newpkg) +{ + char line[PATH_MAX]; + char *ptr = NULL; + char *key = NULL; + int linenum = 0; + + ALPM_LOG_FUNC; + + /* loop until we reach EOF (where archive_fgets will return NULL) */ + while(_alpm_archive_fgets(line, PATH_MAX, a) != NULL) { + linenum++; + _alpm_strtrim(line); + if(strlen(line) == 0 || line[0] == '#') { + continue; + } + ptr = line; + key = strsep(&ptr, "="); + if(key == NULL || ptr == NULL) { + _alpm_log(PM_LOG_DEBUG, "%s: syntax error in description file line %d\n", + newpkg->name ? newpkg->name : "error", linenum); + } else { + key = _alpm_strtrim(key); + ptr = _alpm_strtrim(ptr); + if(!strcmp(key, "pkgname")) { + STRDUP(newpkg->name, ptr, RET_ERR(PM_ERR_MEMORY, -1)); + } else if(!strcmp(key, "pkgver")) { + STRDUP(newpkg->version, ptr, RET_ERR(PM_ERR_MEMORY, -1)); + } else if(!strcmp(key, "pkgdesc")) { + STRDUP(newpkg->desc, ptr, RET_ERR(PM_ERR_MEMORY, -1)); + } else if(!strcmp(key, "group")) { + newpkg->groups = alpm_list_add(newpkg->groups, strdup(ptr)); + } else if(!strcmp(key, "url")) { + STRDUP(newpkg->url, ptr, RET_ERR(PM_ERR_MEMORY, -1)); + } else if(!strcmp(key, "license")) { + newpkg->licenses = alpm_list_add(newpkg->licenses, strdup(ptr)); + } else if(!strcmp(key, "builddate")) { + char first = tolower(ptr[0]); + if(first > 'a' && first < 'z') { + struct tm tmp_tm = {0}; //initialize to null in case of failure + setlocale(LC_TIME, "C"); + strptime(ptr, "%a %b %e %H:%M:%S %Y", &tmp_tm); + newpkg->builddate = mktime(&tmp_tm); + setlocale(LC_TIME, ""); + } else { + newpkg->builddate = atol(ptr); + } + } else if(!strcmp(key, "packager")) { + STRDUP(newpkg->packager, ptr, RET_ERR(PM_ERR_MEMORY, -1)); + } else if(!strcmp(key, "arch")) { + STRDUP(newpkg->arch, ptr, RET_ERR(PM_ERR_MEMORY, -1)); + } else if(!strcmp(key, "size")) { + /* size in the raw package is uncompressed (installed) size */ + newpkg->isize = atol(ptr); + } else if(!strcmp(key, "depend")) { + pmdepend_t *dep = _alpm_splitdep(ptr); + newpkg->depends = alpm_list_add(newpkg->depends, dep); + } else if(!strcmp(key, "optdepend")) { + newpkg->optdepends = alpm_list_add(newpkg->optdepends, strdup(ptr)); + } else if(!strcmp(key, "conflict")) { + newpkg->conflicts = alpm_list_add(newpkg->conflicts, strdup(ptr)); + } else if(!strcmp(key, "replaces")) { + newpkg->replaces = alpm_list_add(newpkg->replaces, strdup(ptr)); + } else if(!strcmp(key, "provides")) { + newpkg->provides = alpm_list_add(newpkg->provides, strdup(ptr)); + } else if(!strcmp(key, "backup")) { + newpkg->backup = alpm_list_add(newpkg->backup, strdup(ptr)); + } else { + _alpm_log(PM_LOG_DEBUG, "%s: syntax error in description file line %d\n", + newpkg->name ? newpkg->name : "error", linenum); + } + } + line[0] = '\0'; + } + + return(0); +} + +/** + * Load a package and create the corresponding pmpkg_t struct. + * @param pkgfile path to the package file + * @param full whether to stop the load after metadata is read or continue + * through the full archive + * @return An information filled pmpkg_t struct + */ +static pmpkg_t *pkg_load(const char *pkgfile, unsigned short full) +{ + int ret = ARCHIVE_OK; + int config = 0; + struct archive *archive; + struct archive_entry *entry; + pmpkg_t *newpkg = NULL; + struct stat st; + + ALPM_LOG_FUNC; + + if(pkgfile == NULL || strlen(pkgfile) == 0) { + RET_ERR(PM_ERR_WRONG_ARGS, NULL); + } + + if((archive = archive_read_new()) == NULL) { + RET_ERR(PM_ERR_LIBARCHIVE, NULL); + } + + archive_read_support_compression_all(archive); + archive_read_support_format_all(archive); + + if (archive_read_open_filename(archive, pkgfile, + ARCHIVE_DEFAULT_BYTES_PER_BLOCK) != ARCHIVE_OK) { + RET_ERR(PM_ERR_PKG_OPEN, NULL); + } + + newpkg = _alpm_pkg_new(NULL, NULL); + if(newpkg == NULL) { + archive_read_finish(archive); + RET_ERR(PM_ERR_MEMORY, NULL); + } + + if(stat(pkgfile, &st) == 0) { + newpkg->size = st.st_size; + } + + /* If full is false, only read through the archive until we find our needed + * metadata. If it is true, read through the entire archive, which serves + * as a verfication of integrity and allows us to create the filelist. */ + while((ret = archive_read_next_header(archive, &entry)) == ARCHIVE_OK) { + const char *entry_name = archive_entry_pathname(entry); + + if(strcmp(entry_name, ".PKGINFO") == 0) { + /* parse the info file */ + if(parse_descfile(archive, newpkg) != 0) { + _alpm_log(PM_LOG_ERROR, _("could not parse package description file in %s\n"), + pkgfile); + goto pkg_invalid; + } + if(newpkg->name == NULL || strlen(newpkg->name) == 0) { + _alpm_log(PM_LOG_ERROR, _("missing package name in %s\n"), pkgfile); + goto pkg_invalid; + } + if(newpkg->version == NULL || strlen(newpkg->version) == 0) { + _alpm_log(PM_LOG_ERROR, _("missing package version in %s\n"), pkgfile); + goto pkg_invalid; + } + config = 1; + continue; + } else if(strcmp(entry_name, ".INSTALL") == 0) { + newpkg->scriptlet = 1; + } else if(*entry_name == '.') { + /* for now, ignore all files starting with '.' that haven't + * already been handled (for future possibilities) */ + } else { + /* Keep track of all files for filelist generation */ + newpkg->files = alpm_list_add(newpkg->files, strdup(entry_name)); + } + + if(archive_read_data_skip(archive)) { + _alpm_log(PM_LOG_ERROR, _("error while reading package %s: %s\n"), + pkgfile, archive_error_string(archive)); + pm_errno = PM_ERR_LIBARCHIVE; + goto error; + } + + /* if we are not doing a full read, see if we have all we need */ + if(!full && config) { + break; + } + } + + if(ret != ARCHIVE_EOF && ret != ARCHIVE_OK) { /* An error occured */ + _alpm_log(PM_LOG_ERROR, _("error while reading package %s: %s\n"), + pkgfile, archive_error_string(archive)); + pm_errno = PM_ERR_LIBARCHIVE; + goto error; + } + + if(!config) { + _alpm_log(PM_LOG_ERROR, _("missing package metadata in %s\n"), pkgfile); + goto pkg_invalid; + } + + archive_read_finish(archive); + + /* internal fields for package struct */ + newpkg->origin = PKG_FROM_FILE; + newpkg->origin_data.file = strdup(pkgfile); + + if(full) { + /* "checking for conflicts" requires a sorted list, ensure that here */ + _alpm_log(PM_LOG_DEBUG, "sorting package filelist for %s\n", pkgfile); + newpkg->files = alpm_list_msort(newpkg->files, alpm_list_count(newpkg->files), + _alpm_str_cmp); + newpkg->infolevel = INFRQ_ALL; + } else { + /* get rid of any partial filelist we may have collected, it is invalid */ + FREELIST(newpkg->files); + newpkg->infolevel = INFRQ_BASE | INFRQ_DESC | INFRQ_DEPENDS; + } + + return(newpkg); + +pkg_invalid: + pm_errno = PM_ERR_PKG_INVALID; +error: + _alpm_pkg_free(newpkg); + archive_read_finish(archive); + + return(NULL); +} + +/** Create a package from a file. + * @param filename location of the package tarball + * @param full whether to stop the load after metadata is read or continue + * through the full archive + * @param pkg address of the package pointer + * @return 0 on success, -1 on error (pm_errno is set accordingly) + */ +int SYMEXPORT alpm_pkg_load(const char *filename, unsigned short full, + pmpkg_t **pkg) +{ + ALPM_LOG_FUNC; + + /* Sanity checks */ + ASSERT(filename != NULL && strlen(filename) != 0, + RET_ERR(PM_ERR_WRONG_ARGS, -1)); + ASSERT(pkg != NULL, RET_ERR(PM_ERR_WRONG_ARGS, -1)); + + *pkg = pkg_load(filename, full); + if(*pkg == NULL) { + /* pm_errno is set by pkg_load */ + return(-1); + } + + return(0); +} + +/* vim: set ts=2 sw=2 noet: */ diff --git a/lib/libalpm/package.c b/lib/libalpm/package.c index ffaa96b3..3989b76d 100644 --- a/lib/libalpm/package.c +++ b/lib/libalpm/package.c @@ -31,7 +31,6 @@ #include #include #include -#include /* setlocale */ /* libarchive */ #include @@ -53,39 +52,13 @@ * @{ */ -/** Create a package from a file. - * @param filename location of the package tarball - * @param full whether to stop the load after metadata is read or continue - * through the full archive - * @param pkg address of the package pointer - * @return 0 on success, -1 on error (pm_errno is set accordingly) - */ -int SYMEXPORT alpm_pkg_load(const char *filename, unsigned short full, - pmpkg_t **pkg) -{ - _alpm_log(PM_LOG_FUNCTION, "enter alpm_pkg_load\n"); - - /* Sanity checks */ - ASSERT(filename != NULL && strlen(filename) != 0, - RET_ERR(PM_ERR_WRONG_ARGS, -1)); - ASSERT(pkg != NULL, RET_ERR(PM_ERR_WRONG_ARGS, -1)); - - *pkg = _alpm_pkg_load(filename, full); - if(*pkg == NULL) { - /* pm_errno is set by pkg_load */ - return(-1); - } - - return(0); -} - /** Free a package. * @param pkg package pointer to free * @return 0 on success, -1 on error (pm_errno is set accordingly) */ int SYMEXPORT alpm_pkg_free(pmpkg_t *pkg) { - _alpm_log(PM_LOG_FUNCTION, "enter alpm_pkg_free\n"); + ALPM_LOG_FUNC; ASSERT(pkg != NULL, RET_ERR(PM_ERR_WRONG_ARGS, -1)); @@ -875,221 +848,6 @@ int _alpm_pkgname_pkg_cmp(const void *pkgname, const void *package) return(strcmp(alpm_pkg_get_name((pmpkg_t *) package), (char *) pkgname)); } - -/* Parses the package description file for the current package. This - * is handed the struct archive when the .PKGINFO file is open. - * Returns: 0 on success, 1 on error - */ -static int parse_descfile(struct archive *a, pmpkg_t *info) -{ - char line[PATH_MAX]; - char *ptr = NULL; - char *key = NULL; - int linenum = 0; - - ALPM_LOG_FUNC; - - /* loop until we reach EOF (where archive_fgets will return NULL) */ - while(_alpm_archive_fgets(line, PATH_MAX, a) != NULL) { - linenum++; - _alpm_strtrim(line); - if(strlen(line) == 0 || line[0] == '#') { - continue; - } - ptr = line; - key = strsep(&ptr, "="); - if(key == NULL || ptr == NULL) { - _alpm_log(PM_LOG_DEBUG, "%s: syntax error in description file line %d\n", - info->name ? info->name : "error", linenum); - } else { - key = _alpm_strtrim(key); - ptr = _alpm_strtrim(ptr); - if(!strcmp(key, "pkgname")) { - STRDUP(info->name, ptr, RET_ERR(PM_ERR_MEMORY, -1)); - } else if(!strcmp(key, "pkgver")) { - STRDUP(info->version, ptr, RET_ERR(PM_ERR_MEMORY, -1)); - } else if(!strcmp(key, "pkgdesc")) { - STRDUP(info->desc, ptr, RET_ERR(PM_ERR_MEMORY, -1)); - } else if(!strcmp(key, "group")) { - info->groups = alpm_list_add(info->groups, strdup(ptr)); - } else if(!strcmp(key, "url")) { - STRDUP(info->url, ptr, RET_ERR(PM_ERR_MEMORY, -1)); - } else if(!strcmp(key, "license")) { - info->licenses = alpm_list_add(info->licenses, strdup(ptr)); - } else if(!strcmp(key, "builddate")) { - char first = tolower(ptr[0]); - if(first > 'a' && first < 'z') { - struct tm tmp_tm = {0}; //initialize to null in case of failure - setlocale(LC_TIME, "C"); - strptime(ptr, "%a %b %e %H:%M:%S %Y", &tmp_tm); - info->builddate = mktime(&tmp_tm); - setlocale(LC_TIME, ""); - } else { - info->builddate = atol(ptr); - } - } else if(!strcmp(key, "packager")) { - STRDUP(info->packager, ptr, RET_ERR(PM_ERR_MEMORY, -1)); - } else if(!strcmp(key, "arch")) { - STRDUP(info->arch, ptr, RET_ERR(PM_ERR_MEMORY, -1)); - } else if(!strcmp(key, "size")) { - /* size in the raw package is uncompressed (installed) size */ - info->isize = atol(ptr); - } else if(!strcmp(key, "depend")) { - pmdepend_t *dep = _alpm_splitdep(ptr); - info->depends = alpm_list_add(info->depends, dep); - } else if(!strcmp(key, "optdepend")) { - info->optdepends = alpm_list_add(info->optdepends, strdup(ptr)); - } else if(!strcmp(key, "conflict")) { - info->conflicts = alpm_list_add(info->conflicts, strdup(ptr)); - } else if(!strcmp(key, "replaces")) { - info->replaces = alpm_list_add(info->replaces, strdup(ptr)); - } else if(!strcmp(key, "provides")) { - info->provides = alpm_list_add(info->provides, strdup(ptr)); - } else if(!strcmp(key, "backup")) { - info->backup = alpm_list_add(info->backup, strdup(ptr)); - } else { - _alpm_log(PM_LOG_DEBUG, "%s: syntax error in description file line %d\n", - info->name ? info->name : "error", linenum); - } - } - line[0] = '\0'; - } - - return(0); -} - - -/** - * Load a package and create the corresponding pmpkg_t struct. - * @param pkgfile path to the package file - * @param full whether to stop the load after metadata is read or continue - * through the full archive - * @return An information filled pmpkg_t struct - */ -pmpkg_t *_alpm_pkg_load(const char *pkgfile, unsigned short full) -{ - int ret = ARCHIVE_OK; - int config = 0; - struct archive *archive; - struct archive_entry *entry; - pmpkg_t *info = NULL; - struct stat st; - - ALPM_LOG_FUNC; - - if(pkgfile == NULL || strlen(pkgfile) == 0) { - RET_ERR(PM_ERR_WRONG_ARGS, NULL); - } - - if((archive = archive_read_new()) == NULL) { - RET_ERR(PM_ERR_LIBARCHIVE, NULL); - } - - archive_read_support_compression_all(archive); - archive_read_support_format_all(archive); - - if (archive_read_open_filename(archive, pkgfile, - ARCHIVE_DEFAULT_BYTES_PER_BLOCK) != ARCHIVE_OK) { - RET_ERR(PM_ERR_PKG_OPEN, NULL); - } - - info = _alpm_pkg_new(NULL, NULL); - if(info == NULL) { - archive_read_finish(archive); - RET_ERR(PM_ERR_MEMORY, NULL); - } - - if(stat(pkgfile, &st) == 0) { - info->size = st.st_size; - } - - /* If full is false, only read through the archive until we find our needed - * metadata. If it is true, read through the entire archive, which serves - * as a verfication of integrity and allows us to create the filelist. */ - while((ret = archive_read_next_header(archive, &entry)) == ARCHIVE_OK) { - const char *entry_name = archive_entry_pathname(entry); - - if(strcmp(entry_name, ".PKGINFO") == 0) { - /* parse the info file */ - if(parse_descfile(archive, info) != 0) { - _alpm_log(PM_LOG_ERROR, _("could not parse package description file in %s\n"), - pkgfile); - goto pkg_invalid; - } - if(info->name == NULL || strlen(info->name) == 0) { - _alpm_log(PM_LOG_ERROR, _("missing package name in %s\n"), pkgfile); - goto pkg_invalid; - } - if(info->version == NULL || strlen(info->version) == 0) { - _alpm_log(PM_LOG_ERROR, _("missing package version in %s\n"), pkgfile); - goto pkg_invalid; - } - config = 1; - continue; - } else if(strcmp(entry_name, ".INSTALL") == 0) { - info->scriptlet = 1; - } else if(*entry_name == '.') { - /* for now, ignore all files starting with '.' that haven't - * already been handled (for future possibilities) */ - } else { - /* Keep track of all files for filelist generation */ - info->files = alpm_list_add(info->files, strdup(entry_name)); - } - - if(archive_read_data_skip(archive)) { - _alpm_log(PM_LOG_ERROR, _("error while reading package %s: %s\n"), - pkgfile, archive_error_string(archive)); - pm_errno = PM_ERR_LIBARCHIVE; - goto error; - } - - /* if we are not doing a full read, see if we have all we need */ - if(!full && config) { - break; - } - } - - if(ret != ARCHIVE_EOF && ret != ARCHIVE_OK) { /* An error occured */ - _alpm_log(PM_LOG_ERROR, _("error while reading package %s: %s\n"), - pkgfile, archive_error_string(archive)); - pm_errno = PM_ERR_LIBARCHIVE; - goto error; - } - - if(!config) { - _alpm_log(PM_LOG_ERROR, _("missing package metadata in %s\n"), pkgfile); - goto pkg_invalid; - } - - archive_read_finish(archive); - - /* internal fields for package struct */ - info->origin = PKG_FROM_FILE; - info->origin_data.file = strdup(pkgfile); - - if(full) { - /* "checking for conflicts" requires a sorted list, ensure that here */ - _alpm_log(PM_LOG_DEBUG, "sorting package filelist for %s\n", pkgfile); - info->files = alpm_list_msort(info->files, alpm_list_count(info->files), - _alpm_str_cmp); - info->infolevel = INFRQ_ALL; - } else { - /* get rid of any partial filelist we may have collected, it is invalid */ - FREELIST(info->files); - info->infolevel = INFRQ_BASE | INFRQ_DESC | INFRQ_DEPENDS; - } - - return(info); - -pkg_invalid: - pm_errno = PM_ERR_PKG_INVALID; -error: - _alpm_pkg_free(info); - archive_read_finish(archive); - - return(NULL); -} - /* Test for existence of a package in a alpm_list_t* * of pmpkg_t* */ diff --git a/lib/libalpm/package.h b/lib/libalpm/package.h index 0ba8aac4..2e4ff31e 100644 --- a/lib/libalpm/package.h +++ b/lib/libalpm/package.h @@ -81,7 +81,6 @@ void _alpm_pkg_free(pmpkg_t *pkg); int _alpm_pkg_cmp(const void *p1, const void *p2); int _alpm_pkgname_pkg_cmp(const void *pkgname, const void *package); int _alpm_pkg_compare_versions(pmpkg_t *local_pkg, pmpkg_t *pkg); -pmpkg_t *_alpm_pkg_load(const char *pkgfile, unsigned short full); pmpkg_t *_alpm_pkg_find(const char *needle, alpm_list_t *haystack); int _alpm_pkg_should_ignore(pmpkg_t *pkg); -- cgit v1.2.3-24-g4f1b