- qfile -x/--exclude option. TGL bug 160735

3 files changed, 168 insertions, 10 deletions

diff --git a/man/include/qfile-05-collisions.include b/man/include/qfile-05-collisions.include
new file mode 100644
index 00000000..1f12dbc5
--- /dev/null
+++ b/man/include/qfile-05-collisions.include
@@ -0,0 +1,46 @@
+[Searching for files collisions]
+.PP
+A last option of \fBqfile\fP is \fB\-\-exclude\-pkg\fP, which will makes it
+skip one particular package when doing its files owners search.  This option
+takes one argument, which can be a package name (\fBapp\-shells/bash\fP), or a
+versioned package (\fBapp\-shells/bash\-3.2_p9\-r1\fP), or a slotted package 
+(\fBapp\-shells/bash:0\fP). It is useful for finding file collisions beetween 
+packages (ie., comparing the contents of one package with the contents of all 
+the others).
+.PP
+For example, the following script will search collisions beetween all your 
+installed packages. Be careful, this will takes time:
+.nf\fI
+	#!/bin/bash
+	cd $(portageq vdb_path)
+	for pkg in *-*/*-* ; do
+		[[ -f ${pkg}/CONTENTS ]] || continue
+		collisions=$(sed -n \\
+				'/^obj\\|^sym/s:^... \\([^ ]\\+\\).*:\1:p' \\
+				${pkg}/CONTENTS \\
+			| qfile -e -x ${pkg} -f -)
+		[[ -n ${collisions} ]] \\
+			&& echo ">>> ${pkg}:" \\
+			&& echo "${collisions}"
+	done
+.fi
+.PP
+An other example is the following script, which can be used to check that a 
+binary package (.tbz2) has no conflict with any of your installed packages,
+but the one it may replace (same name and slot), if any:
+.nf\fI
+#!/bin/bash
+pkgver=$(basename "${1}")
+pkgver=${pkgver%%.tbz2}
+pn=$(qatom ${pkgver} | cut -d\\  -f2)
+tmpdir=$(mktemp -t -d) || exit 1
+tarbz2=${tmpdir}/${pkgver}.tar.bz2
+xpak=${tmpdir}/${pkgver}.xpak
+qtbz2 -s "${1}" "${tarbz2}" "${xpak}"
+categ=$(qxpak -O -x "${xpak}" CATEGORY)
+slot=$(qxpak -O -x "${xpak}" SLOT)
+tar tjf "${tarbz2}" \\
+	| sed -e 's:^\\./:/:' -e '\\:/$:d' \\
+	| qfile -e -f - -x ${categ}/${pn}:${slot}
+rm -rf "${tmpdir}"
+.PP
diff --git a/man/qfile.1 b/man/qfile.1
index d5d51ace..b551e02d 100644
--- a/man/qfile.1
+++ b/man/qfile.1
@@ -13,7 +13,7 @@ Options: \fB\-[ef:m:oRx:vqChV]\fR
 \fB\-f\fR, \fB\-\-from\fR
 <arg>
 .BR
- * Read arguments from file <arg> ("-" for stdin)
+ * Read arguments from file <arg> ("\-" for stdin)
 .HP
 \fB\-m\fR, \fB\-\-max\-args\fR <arg>
 .BR
@@ -25,6 +25,11 @@ Options: \fB\-[ef:m:oRx:vqChV]\fR
 \fB\-R\fR, \fB\-\-root\-prefix\fR
 * Assume arguments are already prefixed by $ROOT
 .TP
+\fB\-x\fR, \fB\-\-exclude\fR
+<arg>
+.BR
+ * Don't look in package <arg>
+.TP
 \fB\-v\fR, \fB\-\-verbose\fR
 * Make a lot of noise
 .TP
@@ -40,7 +45,7 @@ Options: \fB\-[ef:m:oRx:vqChV]\fR
 \fB\-V\fR, \fB\-\-version\fR
 * Print version and exit
 .PP
-$Id: qfile.1,v 1.22 2007/01/07 20:32:41 solar Exp $
+$Id: qfile.1,v 1.23 2007/01/12 22:19:01 solar Exp $
 file written for Gentoo by <solar and vapier 
  gentoo.org>
 .SH "FINDING FILES OWNERS"
@@ -209,6 +214,52 @@ bit more memory, but may be a bit faster for really big queries.  Be careful
 though, using some stupidly high or low value can completly kill the
 performances.  In short, you probably don't want to touch this option.
 .PP
+.SH "SEARCHING FOR FILES COLLISIONS"
+.PP
+A last option of \fBqfile\fP is \fB\-\-exclude\-pkg\fP, which will makes it
+skip one particular package when doing its files owners search.  This option
+takes one argument, which can be a package name (\fBapp\-shells/bash\fP), or a
+versioned package (\fBapp\-shells/bash\-3.2_p9\-r1\fP), or a slotted package 
+(\fBapp\-shells/bash:0\fP). It is useful for finding file collisions beetween 
+packages (ie., comparing the contents of one package with the contents of all 
+the others).
+.PP
+For example, the following script will search collisions beetween all your 
+installed packages. Be careful, this will takes time:
+.nf\fI
+	#!/bin/bash
+	cd $(portageq vdb_path)
+	for pkg in *-*/*-* ; do
+		[[ -f ${pkg}/CONTENTS ]] || continue
+		collisions=$(sed -n \\
+				'/^obj\\|^sym/s:^... \\([^ ]\\+\\).*:\1:p' \\
+				${pkg}/CONTENTS \\
+			| qfile -e -x ${pkg} -f -)
+		[[ -n ${collisions} ]] \\
+			&& echo ">>> ${pkg}:" \\
+			&& echo "${collisions}"
+	done
+.fi
+.PP
+An other example is the following script, which can be used to check that a 
+binary package (.tbz2) has no conflict with any of your installed packages,
+but the one it may replace (same name and slot), if any:
+.nf\fI
+#!/bin/bash
+pkgver=$(basename "${1}")
+pkgver=${pkgver%%.tbz2}
+pn=$(qatom ${pkgver} | cut -d\\  -f2)
+tmpdir=$(mktemp -t -d) || exit 1
+tarbz2=${tmpdir}/${pkgver}.tar.bz2
+xpak=${tmpdir}/${pkgver}.xpak
+qtbz2 -s "${1}" "${tarbz2}" "${xpak}"
+categ=$(qxpak -O -x "${xpak}" CATEGORY)
+slot=$(qxpak -O -x "${xpak}" SLOT)
+tar tjf "${tarbz2}" \\
+	| sed -e 's:^\\./:/:' -e '\\:/$:d' \\
+	| qfile -e -f - -x ${categ}/${pn}:${slot}
+rm -rf "${tmpdir}"
+.PP
 .SH "ADDITIONAL CONTRIBUTORS"
 .TP
 TGL degrenier[at]easyconnect.fr
diff --git a/qfile.c b/qfile.c
index afb75ed2..1900b0bf 100644
--- a/qfile.c
+++ b/qfile.c
@@ -1,7 +1,7 @@
 /*
  * Copyright 2005-2006 Gentoo Foundation
  * Distributed under the terms of the GNU General Public License v2
- * $Header: /var/cvsroot/gentoo-projects/portage-utils/qfile.c,v 1.40 2007/01/07 20:40:30 solar Exp $
+ * $Header: /var/cvsroot/gentoo-projects/portage-utils/qfile.c,v 1.41 2007/01/12 22:19:01 solar Exp $
  *
  * Copyright 2005-2006 Ned Ludd        - <solar@gentoo.org>
  * Copyright 2005-2006 Mike Frysinger  - <vapier@gentoo.org>
@@ -16,10 +16,11 @@
 #define QFILE_FLAGS "ef:m:oRx:" COMMON_FLAGS
 static struct option const qfile_long_opts[] = {
 	{"exact",       no_argument, NULL, 'e'},
-	{"from",	a_argument,  NULL, 'f'},
-	{"max-args",	a_argument,  NULL, 'm'},
+	{"from",        a_argument,  NULL, 'f'},
+	{"max-args",    a_argument,  NULL, 'm'},
 	{"orphans",     no_argument, NULL, 'o'},
 	{"root-prefix", no_argument, NULL, 'R'},
+	{"exclude",     a_argument,  NULL, 'x'},
 	COMMON_LONG_OPTS
 };
 static const char *qfile_opts_help[] = {
@@ -28,9 +29,10 @@ static const char *qfile_opts_help[] = {
 	"Treat from file arguments by groups of <arg> (defaults to " QFILE_DEFAULT_MAX_ARGS_STR ")",
 	"List orphan files",
 	"Assume arguments are already prefixed by $ROOT",
+	"Don't look in package <arg>",
 	COMMON_OPTS_HELP
 };
-static char qfile_rcsid[] = "$Id: qfile.c,v 1.40 2007/01/07 20:40:30 solar Exp $";
+static char qfile_rcsid[] = "$Id: qfile.c,v 1.41 2007/01/12 22:19:01 solar Exp $";
 #define qfile_usage(ret) usage(ret, QFILE_FLAGS, qfile_long_opts, qfile_opts_help, lookup_applet_idx("qfile"))
 
 static inline short qfile_is_prefix(const char* path, const char* prefix, int prefix_length)
@@ -49,6 +51,8 @@ typedef struct {
 	char *bn_firstchars;
 	short *non_orphans;
 	char *real_root;
+	char *exclude_pkg;
+	char *exclude_slot;
 } qfile_args_t;
 
 void qfile(char *, const char *, qfile_args_t *);
@@ -82,6 +86,41 @@ void qfile(char *path, const char *root, qfile_args_t *args)
 		snprintf(pkg, sizeof(pkg), "%s/%s", basename(path), dentry->d_name);
 		atom = NULL; /* Will be exploded once at most, as needed. */
 
+		/* If exclude_pkg is not NULL, check it.  We are looking for files
+		 * collisions, and must exclude one package.
+		 */
+		if (args->exclude_pkg != NULL) {
+			if (strncmp(args->exclude_pkg, pkg, sizeof(pkg)) == 0)
+				continue; /* skip this package (name+version match) */
+			if ((atom = atom_explode(pkg)) == NULL) {
+				warn("invalid atom %s", pkg);
+				goto dont_skip_pkg;
+			}
+			snprintf(buf, sizeof(buf), "%s/%s", basename(path), atom->PN);
+			if (strncmp(args->exclude_pkg, buf, sizeof(buf)) != 0)
+				goto dont_skip_pkg; /* current pkg name doesn't match */
+			if (args->exclude_slot == NULL) {
+				atom_implode(atom);
+				continue; /* skip this package (name match) */
+			}
+			buf[0] = '0'; buf[1] = '\0';
+			xasprintf(&p, "%s/%s/SLOT", path, dentry->d_name);
+			if ((fp = fopen(p, "r")) != NULL) {
+				free(p);
+				if (fgets(buf, sizeof(buf), fp) != NULL)
+					if ((p = strchr(buf, '\n')) != NULL)
+						*p = 0;
+				fclose(fp);
+			} else {
+				free(p);
+			}
+			if (strncmp(args->exclude_slot, buf, sizeof(buf)) == 0) {
+				atom_implode(atom);
+				continue; /* skip this package (name+slot match) */
+			}
+		}
+dont_skip_pkg: /* End of the package exclusion tests. */
+
 		xasprintf(&p, "%s/%s/CONTENTS", path, dentry->d_name);
 		if ((fp = fopen(p, "r")) == NULL) {
 			free(p);
@@ -240,11 +279,18 @@ void destroy_qfile_args(qfile_args_t *qfile_args)
 	if (qfile_args->real_root != NULL)
 		free(qfile_args->real_root);
 
+	if (qfile_args->exclude_pkg != NULL)
+		free(qfile_args->exclude_pkg);
+	/* don't free qfile_args->exclude_slot, it's the same chunk */
+
 	memset(qfile_args, 0, sizeof(qfile_args_t));
 }
 
-int prepare_qfile_args(const int, const char **, const short, const short, qfile_args_t *);
-int prepare_qfile_args(const int argc, const char **argv, const short assume_root_prefix, const short search_orphans, qfile_args_t *qfile_args)
+int prepare_qfile_args(const int, const char **,
+		const short, const short, const char *, qfile_args_t *);
+int prepare_qfile_args(const int argc, const char **argv,
+		const short assume_root_prefix, const short search_orphans,
+		const char *exclude_pkg_arg, qfile_args_t *qfile_args)
 {
 	int i;
 	int nb_of_queries = argc;
@@ -410,6 +456,13 @@ int prepare_qfile_args(const int argc, const char **argv, const short assume_roo
 		memset(qfile_args->non_orphans, 0, argc);
 	}
 
+	if (exclude_pkg_arg != NULL) {
+		qfile_args->exclude_pkg = xstrdup(exclude_pkg_arg);
+		if ((qfile_args->exclude_slot = strchr(qfile_args->exclude_pkg, ':')) != NULL)
+			*qfile_args->exclude_slot++ = '\0';
+		/* Maybe this should be atom-exploded instead (to check syntax, etc.) */
+	}
+
 	return nb_of_queries;
 }
 
@@ -422,6 +475,7 @@ int qfile_main(int argc, char **argv)
 	short search_orphans = 0;
 	short assume_root_prefix = 0;
 	char *root_prefix = NULL;
+	char *exclude_pkg_arg = NULL;
 	qfile_args_t *qfile_args = NULL;
 	int qargc = 0;
 	char **qargv = NULL;
@@ -466,6 +520,13 @@ int qfile_main(int argc, char **argv)
 				break;
 			case 'o': search_orphans = 1; break;
 			case 'R': assume_root_prefix = 1; break;
+			case 'x':
+				if (exclude_pkg_arg != NULL) {
+					warn("--exclude can only be used once.");
+					goto exit;
+				}
+				exclude_pkg_arg = optarg;
+				break;
 		}
 	}
 	if (!exact && verbose) exact++;
@@ -501,7 +562,7 @@ int qfile_main(int argc, char **argv)
 		qargv = xcalloc(max_args, sizeof(char*));
 	}
 
-	do { /* This block lay be repeated if using --from with a big files list */
+	do { /* This block may be repeated if using --from with a big files list */
 		if (args_file != NULL) {
 			qargc = 0;
 			/* Read up to max_args files from the input file */
@@ -528,7 +589,7 @@ int qfile_main(int argc, char **argv)
 
 		/* Prepare the qfile(...) arguments structure */
 		nb_of_queries = prepare_qfile_args(qargc, (const char **) qargv,
-				assume_root_prefix, search_orphans, qfile_args);
+				assume_root_prefix, search_orphans, exclude_pkg_arg, qfile_args);
 		if (nb_of_queries < 0)
 			goto exit;