[pacman-dev] [PATCH 1/2] Split common utility functions for libalpm and pacman
There is duplicated code in the util.c files in the libalpm and pacman source code. Split this into a separate file so that it can be shared via a symlink. This prevents code divergence between the two code bases. Also, move mbasename and mdirname from pacman/util.c into util-common.c in preparation for the following patch that uses them to add an extension to pacsave files. Signed-off-by: Allan McRae <allan@archlinux.org> --- This is revised based on comments from Dan that suggested a separate directory for the common file and symlinks into both the libalpm and pacman directories so that it would be obvious you are editing a common file. Also pulled in the mbasename/mdirname functions in one patch, because if HAVE_STRNDUP was defined, util-common.c would be an empty translation unit, which gives a error with -Werror=pedantic. Tested that "make distcheck" worked. Makefile.am | 2 +- configure.ac | 1 + lib/libalpm/Makefile.am | 1 + lib/libalpm/util-common.c | 1 + lib/libalpm/util-common.h | 1 + lib/libalpm/util.c | 33 -------------- lib/libalpm/util.h | 5 +-- src/common/Makefile.am | 4 ++ src/common/util-common.c | 109 ++++++++++++++++++++++++++++++++++++++++++++++ src/common/util-common.h | 32 ++++++++++++++ src/pacman/Makefile.am | 3 +- src/pacman/util-common.c | 1 + src/pacman/util-common.h | 1 + src/pacman/util.c | 50 --------------------- src/pacman/util.h | 8 +--- 15 files changed, 157 insertions(+), 95 deletions(-) create mode 120000 lib/libalpm/util-common.c create mode 120000 lib/libalpm/util-common.h create mode 100644 src/common/Makefile.am create mode 100644 src/common/util-common.c create mode 100644 src/common/util-common.h create mode 120000 src/pacman/util-common.c create mode 120000 src/pacman/util-common.h diff --git a/Makefile.am b/Makefile.am index 0010a3e..b05feb6 100644 --- a/Makefile.am +++ b/Makefile.am @@ -3,7 +3,7 @@ if WANT_DOC SUBDIRS += doc endif -DIST_SUBDIRS = $(SUBDIRS) contrib +DIST_SUBDIRS = $(SUBDIRS) contrib src/common ACLOCAL_AMFLAGS = -I m4 --install diff --git a/configure.ac b/configure.ac index 6059fe5..aa3305d 100644 --- a/configure.ac +++ b/configure.ac @@ -462,6 +462,7 @@ AC_CONFIG_FILES([ lib/libalpm/Makefile lib/libalpm/po/Makefile.in lib/libalpm/libalpm.pc +src/common/Makefile src/pacman/Makefile src/pacman/po/Makefile.in src/util/Makefile diff --git a/lib/libalpm/Makefile.am b/lib/libalpm/Makefile.am index c935e2d..5cf66b9 100644 --- a/lib/libalpm/Makefile.am +++ b/lib/libalpm/Makefile.am @@ -53,6 +53,7 @@ libalpm_la_SOURCES = \ sync.h sync.c \ trans.h trans.c \ util.h util.c \ + util-common.h util-common.c \ version.c if !HAVE_LIBSSL diff --git a/lib/libalpm/util-common.c b/lib/libalpm/util-common.c new file mode 120000 index 0000000..cf96517 --- /dev/null +++ b/lib/libalpm/util-common.c @@ -0,0 +1 @@ +../../src/common/util-common.c \ No newline at end of file diff --git a/lib/libalpm/util-common.h b/lib/libalpm/util-common.h new file mode 120000 index 0000000..988c2ac --- /dev/null +++ b/lib/libalpm/util-common.h @@ -0,0 +1 @@ +../../src/common/util-common.h \ No newline at end of file diff --git a/lib/libalpm/util.c b/lib/libalpm/util.c index c33e32a..f6e6632 100644 --- a/lib/libalpm/util.c +++ b/lib/libalpm/util.c @@ -1256,37 +1256,4 @@ void _alpm_alloc_fail(size_t size) fprintf(stderr, "alloc failure: could not allocate %zd bytes\n", size); } -#ifndef HAVE_STRNDUP -/* A quick and dirty implementation derived from glibc */ -/** Determines the length of a fixed-size string. - * @param s string to be measured - * @param max maximum number of characters to search for the string end - * @return length of s or max, whichever is smaller - */ -static size_t strnlen(const char *s, size_t max) -{ - register const char *p; - for(p = s; *p && max--; ++p); - return (p - s); -} - -/** Copies a string. - * Returned string needs to be freed - * @param s string to be copied - * @param n maximum number of characters to copy - * @return pointer to the new string on success, NULL on error - */ -char *strndup(const char *s, size_t n) -{ - size_t len = strnlen(s, n); - char *new = (char *) malloc(len + 1); - - if(new == NULL) - return NULL; - - new[len] = '\0'; - return (char *)memcpy(new, s, len); -} -#endif - /* vim: set ts=2 sw=2 noet: */ diff --git a/lib/libalpm/util.h b/lib/libalpm/util.h index 734e0e5..3a6b14a 100644 --- a/lib/libalpm/util.h +++ b/lib/libalpm/util.h @@ -28,6 +28,7 @@ #include "alpm.h" #include "package.h" /* alpm_pkg_t */ #include "handle.h" /* alpm_handle_t */ +#include "util-common.h" #include <stdio.h> #include <string.h> @@ -142,10 +143,6 @@ int _alpm_fnmatch(const void *pattern, const void *string); char *strsep(char **, const char *); #endif -#ifndef HAVE_STRNDUP -char *strndup(const char *s, size_t n); -#endif - /* check exported library symbols with: nm -C -D <lib> */ #define SYMEXPORT __attribute__((visibility("default"))) #define SYMHIDDEN __attribute__((visibility("internal"))) diff --git a/src/common/Makefile.am b/src/common/Makefile.am new file mode 100644 index 0000000..4950333 --- /dev/null +++ b/src/common/Makefile.am @@ -0,0 +1,4 @@ +EXTRA_DIST = \ + util-common.h util-common.c + +# vim:set ts=2 sw=2 noet: diff --git a/src/common/util-common.c b/src/common/util-common.c new file mode 100644 index 0000000..e2b5939 --- /dev/null +++ b/src/common/util-common.c @@ -0,0 +1,109 @@ +/* + * util-common.c + * + * Copyright (c) 2006-2012 Pacman Development Team <pacman-dev@archlinux.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/>. + */ + +#include <stdlib.h> +#include <string.h> + +#include "util-common.h" + + +/** Parse the basename of a program from a path. +* @param path path to parse basename from +* +* @return everything following the final '/' +*/ +const char *mbasename(const char *path) +{ + const char *last = strrchr(path, '/'); + if(last) { + return last + 1; + } + return path; +} + +/** Parse the dirname of a program from a path. +* The path returned should be freed. +* @param path path to parse dirname from +* +* @return everything preceding the final '/' +*/ +char *mdirname(const char *path) +{ + char *ret, *last; + + /* null or empty path */ + if(path == NULL || path == '\0') { + return strdup("."); + } + + if((ret = strdup(path)) == NULL) { + return NULL; + } + + last = strrchr(ret, '/'); + + if(last != NULL) { + /* we found a '/', so terminate our string */ + if(last == ret) { + /* return "/" for root */ + last++; + } + *last = '\0'; + return ret; + } + + /* no slash found */ + free(ret); + return strdup("."); +} + +#ifndef HAVE_STRNDUP +/* A quick and dirty implementation derived from glibc */ +/** Determines the length of a fixed-size string. + * @param s string to be measured + * @param max maximum number of characters to search for the string end + * @return length of s or max, whichever is smaller + */ +static size_t strnlen(const char *s, size_t max) +{ + register const char *p; + for(p = s; *p && max--; ++p); + return (p - s); +} + +/** Copies a string. + * Returned string needs to be freed + * @param s string to be copied + * @param n maximum number of characters to copy + * @return pointer to the new string on success, NULL on error + */ +char *strndup(const char *s, size_t n) +{ + size_t len = strnlen(s, n); + char *new = (char *) malloc(len + 1); + + if(new == NULL) + return NULL; + + new[len] = '\0'; + return (char *)memcpy(new, s, len); +} +#endif + +/* vim: set ts=2 sw=2 noet: */ diff --git a/src/common/util-common.h b/src/common/util-common.h new file mode 100644 index 0000000..04d4e9d --- /dev/null +++ b/src/common/util-common.h @@ -0,0 +1,32 @@ +/* + * util-common.h + * + * Copyright (c) 2006-2013 Pacman Development Team <pacman-dev@archlinux.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/>. + */ + +#ifndef _PM_UTIL_COMMON_H +#define _PM_UTIL_COMMON_H + +const char *mbasename(const char *path); +char *mdirname(const char *path); + +#ifndef HAVE_STRNDUP +char *strndup(const char *s, size_t n); +#endif + +#endif /* _PM_UTIL_COMMON_H */ + +/* vim: set ts=2 sw=2 noet: */ diff --git a/src/pacman/Makefile.am b/src/pacman/Makefile.am index 311f7c5..ed51573 100644 --- a/src/pacman/Makefile.am +++ b/src/pacman/Makefile.am @@ -38,7 +38,8 @@ pacman_SOURCES = \ sync.c \ callback.h callback.c \ upgrade.c \ - util.h util.c + util.h util.c \ + util-common.h util-common.c LDADD = $(LTLIBINTL) $(top_builddir)/lib/libalpm/.libs/libalpm.la diff --git a/src/pacman/util-common.c b/src/pacman/util-common.c new file mode 120000 index 0000000..a2f6c50 --- /dev/null +++ b/src/pacman/util-common.c @@ -0,0 +1 @@ +../common/util-common.c \ No newline at end of file diff --git a/src/pacman/util-common.h b/src/pacman/util-common.h new file mode 120000 index 0000000..3f0b982 --- /dev/null +++ b/src/pacman/util-common.h @@ -0,0 +1 @@ +../common/util-common.h \ No newline at end of file diff --git a/src/pacman/util.c b/src/pacman/util.c index 81eec67..014be1f 100644 --- a/src/pacman/util.c +++ b/src/pacman/util.c @@ -210,56 +210,6 @@ int rmrf(const char *path) } } -/** Parse the basename of a program from a path. -* @param path path to parse basename from -* -* @return everything following the final '/' -*/ -const char *mbasename(const char *path) -{ - const char *last = strrchr(path, '/'); - if(last) { - return last + 1; - } - return path; -} - -/** Parse the dirname of a program from a path. -* The path returned should be freed. -* @param path path to parse dirname from -* -* @return everything preceding the final '/' -*/ -char *mdirname(const char *path) -{ - char *ret, *last; - - /* null or empty path */ - if(path == NULL || path == '\0') { - return strdup("."); - } - - if((ret = strdup(path)) == NULL) { - return NULL; - } - - last = strrchr(ret, '/'); - - if(last != NULL) { - /* we found a '/', so terminate our string */ - if(last == ret) { - /* return "/" for root */ - last++; - } - *last = '\0'; - return ret; - } - - /* no slash found */ - free(ret); - return strdup("."); -} - /* output a string, but wrap words properly with a specified indentation */ void indentprint(const char *str, unsigned short indent, unsigned short cols) diff --git a/src/pacman/util.h b/src/pacman/util.h index 0c58a47..c38291a 100644 --- a/src/pacman/util.h +++ b/src/pacman/util.h @@ -26,6 +26,8 @@ #include <alpm_list.h> +#include "util-common.h" + #ifdef ENABLE_NLS #include <libintl.h> /* here so it doesn't need to be included elsewhere */ /* define _() as shortcut for gettext() */ @@ -49,8 +51,6 @@ int needs_root(void); int check_syncdbs(size_t need_repos, int check_valid); unsigned short getcols(int fd); int rmrf(const char *path); -const char *mbasename(const char *path); -char *mdirname(const char *path); void indentprint(const char *str, unsigned short indent, unsigned short cols); size_t strtrim(char *str); char *strreplace(const char *str, const char *needle, const char *replace); @@ -80,10 +80,6 @@ int pm_asprintf(char **string, const char *format, ...); int pm_vfprintf(FILE *stream, alpm_loglevel_t level, const char *format, va_list args) __attribute__((format(printf,3,0))); int pm_vasprintf(char **string, alpm_loglevel_t level, const char *format, va_list args) __attribute__((format(printf,3,0))); -#ifndef HAVE_STRNDUP -char *strndup(const char *s, size_t n); -#endif - #endif /* _PM_UTIL_H */ /* vim: set ts=2 sw=2 noet: */ -- 1.8.1
From: Pang Yan Han <pangyanhan@gmail.com> Teach pacman to save backup files with extension .pacsave.n, where n is a positive integer. The current backup file shall be saved as <name>.pacsave, while existing .pacsave.n files will be renamed to <name>.pacsave.n+1 Example: 1. You have subversion installed in your local repo. /etc/conf.d/svnserve is a file to be backed up. It contains local modifications 2. You remove subversion from your repo. /etc/conf.d/svnserve is backed up as /etc/conf.d/svnserve.pacsave 2. You install subversion again 3. You edit /etc/conf.d/svnserve 4. You remove subversion. The existing /etc/conf.d/svnserve.pacsave is renamed to /etc/conf.d/svnserve.pacsave.1 and /etc/conf.d/svnserve is backed up as /etc/conf.d/svnserve.pacsave Signed-off-by: Pang Yan Han <pangyanhan@gmail.com> Rebased from original email and adjusted for util-common usage. Signed-off-by: Florian Pritz <bluewind@xinu.at> --- lib/libalpm/remove.c | 76 ++++++++++++++++++++++++++++++++++++++++++ test/pacman/tests/remove012.py | 20 +++++++++++ 2 files changed, 96 insertions(+) create mode 100644 test/pacman/tests/remove012.py diff --git a/lib/libalpm/remove.c b/lib/libalpm/remove.c index b965391..568fe7c 100644 --- a/lib/libalpm/remove.c +++ b/lib/libalpm/remove.c @@ -26,8 +26,11 @@ #include <errno.h> #include <string.h> #include <limits.h> +#include <dirent.h> +#include <regex.h> #include <unistd.h> #include <sys/stat.h> +#include <sys/types.h> /* libalpm */ #include "remove.h" @@ -299,6 +302,78 @@ static int can_remove_file(alpm_handle_t *handle, const alpm_file_t *file, return 1; } +static void shift_pacsave(alpm_handle_t *handle, const char *file) +{ + DIR *dir = NULL; + struct dirent *ent; + struct stat st; + regex_t reg; + + const char *basename; + char *dirname; + char oldfile[PATH_MAX]; + char newfile[PATH_MAX]; + char regstr[PATH_MAX]; + + unsigned long log_max = 0; + size_t basename_len; + + dirname = mdirname(file); + if (!dirname) { + return; + } + + basename = mbasename(file); + basename_len = strlen(basename); + + snprintf(regstr, PATH_MAX, "^%s\\.pacsave\\.([[:digit:]]+)$", basename); + if (regcomp(®, regstr, REG_EXTENDED | REG_NEWLINE) != 0) { + goto cleanup; + } + + dir = opendir(dirname); + if (dir == NULL) { + _alpm_log(handle, ALPM_LOG_ERROR, _("could not open directory: %s: %s\n"), + dirname, strerror(errno)); + goto cleanup; + } + + while ((ent = readdir(dir)) != NULL) { + if (strcmp(ent->d_name, ".") == 0 || strcmp(ent->d_name, "..") == 0) { + continue; + } + + if (regexec(®, ent->d_name, 0, 0, 0) == 0) { + unsigned long cur_log; + cur_log = strtoul(ent->d_name + basename_len + strlen(".pacsave."), NULL, 10); + if (cur_log > log_max) { + log_max = cur_log; + } + } + } + + /* Shift pacsaves */ + unsigned long i; + for (i = log_max + 1; i > 1; i--) { + snprintf(oldfile, PATH_MAX, "%s.pacsave.%lu", file, i-1); + snprintf(newfile, PATH_MAX, "%s.pacsave.%lu", file, i); + rename(oldfile, newfile); + } + + snprintf(oldfile, PATH_MAX, "%s.pacsave", file); + if (stat(oldfile, &st) == 0) { + snprintf(newfile, PATH_MAX, "%s.1", oldfile); + rename(oldfile, newfile); + } + + regfree(®); + +cleanup: + free(dirname); + closedir(dir); +} + + /** * @brief Unlink a package file, backing it up if necessary. * @@ -399,6 +474,7 @@ static int unlink_file(alpm_handle_t *handle, alpm_pkg_t *oldpkg, char *newpath; size_t len = strlen(file) + 8 + 1; MALLOC(newpath, len, RET_ERR(handle, ALPM_ERR_MEMORY, -1)); + shift_pacsave(handle, file); snprintf(newpath, len, "%s.pacsave", file); if(rename(file, newpath)) { _alpm_log(handle, ALPM_LOG_ERROR, _("could not rename %s to %s (%s)\n"), diff --git a/test/pacman/tests/remove012.py b/test/pacman/tests/remove012.py new file mode 100644 index 0000000..4274487 --- /dev/null +++ b/test/pacman/tests/remove012.py @@ -0,0 +1,20 @@ +self.description = "Remove a package with a modified file marked for backup and has existing pacsaves" + +self.filesystem = ["etc/dummy.conf.pacsave", + "etc/dummy.conf.pacsave.1", + "etc/dummy.conf.pacsave.2"] + +p1 = pmpkg("dummy") +p1.files = ["etc/dummy.conf*"] +p1.backup = ["etc/dummy.conf"] +self.addpkg2db("local", p1) + +self.args = "-R %s" % p1.name + +self.addrule("PACMAN_RETCODE=0") +self.addrule("!PKG_EXIST=dummy") +self.addrule("!FILE_EXIST=etc/dummy.conf") +self.addrule("FILE_PACSAVE=etc/dummy.conf") +self.addrule("FILE_EXIST=etc/dummy.conf.pacsave.1") +self.addrule("FILE_EXIST=etc/dummy.conf.pacsave.2") +self.addrule("FILE_EXIST=etc/dummy.conf.pacsave.3") -- 1.8.1
participants (1)
-
Allan McRae