pkg_noisrev 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem "open4", "~>1.1.0"
+gem "git", "~>1.2.5"

data/README.rdoc

@@ -0,0 +1,102 @@
+=Name
+
+pkg_noisrev--a fast way to summarize installed versions of FreeBSD packages.
+
+
+==Synopsis
+
+ pkg_noisrev [options]
+
+
+==Description
+
+The pkg_noisrev utility is a <b>very fast</b> version of pkg_version
+program that ships with FreeBSD. Consider the example from virtualized
+FreeBSD 8.2 (with 696 installed packages) where virtual hdd is a main
+performance bottle neck:
+
+ % time pkg_version
+ [...]
+ 21.006u 68.076s 1:59.73 74.3%   403+713k 1155+0io 3pf+0w
+
+ % time pkg_noisrev
+ [...]
+ 12.261u 10.249s 0:26.29 85.5%   95+1128k 0+0io 0pf+0w
+
+pkg_noisrev is basically <b>~ 4.6 times faster</b>. It achieves this
+speed by doing its work in several parallel threads + making some
+not-so-interesting tricks of extracting version strings from Makefiles.
+
+pkg_noisrev also adds filtering to the output, thus you can, for
+example, only see out of sync packages. If you are a portmaster user,
+you may like <tt>--likeportmaster</tt> option (I do!).
+
+The options are as follows:
+
+--config-dirs::             List all possible locations for the
+                            configuration file. The first found wins.
+
+--config NAME::             The name of the configuration file. If
+                            it contains <tt>/</tt> in it, the list from
+                            <tt>--config-dirs</tt> is ignored.
+
+-V::                        Show version and exit.
+
+-v::                        Be more verbose. You can supply it several
+                            times, viz. <tt>-vv</tt> dumps even more
+                            debug info.
+
+--pkg-dir STR::             Set the alternate package db directory.
+
+--ports-dir STR::           Set the alternate ports db directory.
+
+--outofsync::               Filter all but out of sync packages.
+
+--missing::                 Filter all but packages that doesn't exists
+                            in ports.
+
+--likeportmaster::          Print like (but not quite) "portmaster -L".
+
+
+==Installation
+
+(Only if you are not installing the gem.)
+
+pkg_noisrev ships with a shared library (the comparator of a 2
+versions-as-a-string that was extracted from pkg_version sources) which
+must be compiled before you can use the program.
+
+cd to a directory with pkg_noisrev sources and type:
+
+ % rake mydll:default
+
+Then run <tt>bin/pkg_noisrev</tt> or make a symlink to it in one of your
+directories in PATH.
+
+
+==Configuration
+
+pkg_noisrev looks for its configuration at 3 places at start up.
+
+1. At <tt>PKG_NOISREV_CONF</tt> env variable.
+   (Its format is exactly similar to CL options.)
+
+2. At the configuration file. Its default name is
+   <tt>pkg_noisrev.yaml</tt> and it can be stored in several
+   system directories which are observable by <tt>--config--dirs</tt> CL
+   option.
+
+3. At command line.
+
+Higher number levels overrides the values from lower number levels.
+
+The configuration file must be in YAML format. Look into <tt>`gem env
+gemdir`/gems/pkg_noisrev-x.y.z/etc/</tt> directory for samples.
+
+
+==Examples
+
+ % ri Pkg_noisrev
+ % pkg_noisrev --likeportmaster
+ % pkg_noisrev --outofsync
+ % pkg_noisrev --missing --likeportmaster

data/Rakefile

@@ -0,0 +1,58 @@
+# -*-ruby-*-
+
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rubygems/package_task'
+
+gem 'rdoc'
+require 'rdoc/task'
+
+require_relative 'ext/rakefile'
+require_relative 'lib/pkg_noisrev/meta'
+include Pkg_noisrev
+
+require_relative 'test/rake_git'
+
+spec = Gem::Specification.new {|i|
+  i.name = Meta::NAME
+  i.version = Meta::VERSION
+  i.summary = 'A fast way to summarize installed versions of FreeBSD packages'
+  i.description = i.summary + '.'
+  i.author = Meta::AUTHOR
+  i.email = Meta::EMAIL
+  i.homepage = Meta::HOMEPAGE
+
+  i.platform = Gem::Platform::RUBY
+  i.required_ruby_version = '>= 1.9.2'
+  i.files = git_ls('.')
+
+  i.executables = FileList['bin/*'].gsub(/^bin\//, '')
+  
+  i.test_files = FileList['test/test_*.rb']
+  
+  i.rdoc_options << '-m' << 'doc/README.rdoc'
+  i.extra_rdoc_files = FileList['doc/*']
+
+  i.extensions << 'ext/extconf.rb'
+
+  i.add_dependency('open4', '>= 1.1.0')
+  i.add_development_dependency('git', '>= 1.2.5')
+}
+
+Gem::PackageTask.new(spec).define
+
+task default: [:repackage]
+
+RDoc::Task.new('html') do |i|
+  i.main = 'doc/README.rdoc'
+  i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
+#  i.rdoc_files.exclude("lib/**/some-nasty-staff")
+end
+
+Rake::TestTask.new do |i|
+  i.test_files = FileList['test/test_*.rb']
+end
+
+task default: ['mydll:default', :repackage]
+task clean: ['mydll:clean']

data/bin/pkg_noisrev

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+
+require 'thread'
+require 'logger'
+
+require_relative '../lib/pkg_noisrev/trestle.rb'
+require_relative '../lib/pkg_noisrev/fbsdpackage.rb'
+
+include Pkg_noisrev
+
+$conf = Hash.new
+u = Trestle.new($conf)
+
+$conf[:banner] = "Usage: #{File.basename($0)} [options]"
+$conf[:pkg_dir] = '/var/db/pkg'
+$conf[:ports_dir] = '/usr/ports'
+$conf[:log] = '/tmp/' + Pkg_noisrev::Meta::NAME  + '.log'
+$conf[:filter] = '' # or 'outofsync', 'missing'
+$conf[:mode] = 'default' # or 'likeportmaster'
+$conf[:int_attempts] = 2
+
+# --[ main ]------------------------------------------------------------
+
+u.config_parse(['foobar']) {|src|
+  o = u.cl_parse(src) # create an OptionParser object
+  o.on('--pkg-dir STR', 'Set the alternate package db directory.') {|i|
+    $conf[:pkg_dir] = i
+  }
+  o.on('--ports-dir STR', 'Set the alternate ports db directory.') {|i|
+    $conf[:ports_dir] = i
+  }
+  o.on('--outofsync', 'Filter all but out of sync packages.') {|i|
+    $conf[:filter] = 'outofsync'
+  }
+  o.on('--missing', 'Filter all but packages that doesn\'t exists in ports.') {|i|
+    $conf[:filter] = 'missing'
+  }
+  o.on('--likeportmaster', 'Print like (but not quite) "portmaster -L".') {|i|
+    $conf[:mode] = 'likeportmaster'
+  }
+  u.cl_parse(src, o) # run cl parser
+}
+
+# print our env
+if $conf[:verbose] >= 2
+  puts 'Libs dir: ' + Trestle.gem_libdir
+  pp $conf
+end
+
+File.delete $conf[:log] rescue nil
+log = Logger.new($conf[:log])
+log.formatter = proc { |severity, d, p, msg| "#{severity}: #{msg}\n" }
+
+Signal.trap(:INT) do
+  if $conf[:int_attempts] >= 0
+    print "\nWoot! (#{$conf[:int_attempts]})\n"
+  else
+    print "\n"
+  end
+  $conf[:int_attempts] == -1 ? exit(1) : $conf[:int_attempts] -= 1
+end
+
+begin
+  pkg = FbsdPackage.new $conf[:pkg_dir], $conf[:ports_dir]
+rescue
+  Trestle.errx 1, $!.to_s
+end
+pkg.analyze log
+pkg.print $conf[:mode], $conf[:filter]

data/doc/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Alexander Gromnitsky.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/doc/NEWS.rdoc

@@ -0,0 +1,5 @@
+=== 0.0.1
+
+Mon, 1 Aug 2011 12:34:04 +0300
+
+- Created a first skeleton.

data/doc/README.rdoc

@@ -0,0 +1,102 @@
+=Name
+
+pkg_noisrev--a fast way to summarize installed versions of FreeBSD packages.
+
+
+==Synopsis
+
+ pkg_noisrev [options]
+
+
+==Description
+
+The pkg_noisrev utility is a <b>very fast</b> version of pkg_version
+program that ships with FreeBSD. Consider the example from virtualized
+FreeBSD 8.2 (with 696 installed packages) where virtual hdd is a main
+performance bottle neck:
+
+ % time pkg_version
+ [...]
+ 21.006u 68.076s 1:59.73 74.3%   403+713k 1155+0io 3pf+0w
+
+ % time pkg_noisrev
+ [...]
+ 12.261u 10.249s 0:26.29 85.5%   95+1128k 0+0io 0pf+0w
+
+pkg_noisrev is basically <b>~ 4.6 times faster</b>. It achieves this
+speed by doing its work in several parallel threads + making some
+not-so-interesting tricks of extracting version strings from Makefiles.
+
+pkg_noisrev also adds filtering to the output, thus you can, for
+example, only see out of sync packages. If you are a portmaster user,
+you may like <tt>--likeportmaster</tt> option (I do!).
+
+The options are as follows:
+
+--config-dirs::             List all possible locations for the
+                            configuration file. The first found wins.
+
+--config NAME::             The name of the configuration file. If
+                            it contains <tt>/</tt> in it, the list from
+                            <tt>--config-dirs</tt> is ignored.
+
+-V::                        Show version and exit.
+
+-v::                        Be more verbose. You can supply it several
+                            times, viz. <tt>-vv</tt> dumps even more
+                            debug info.
+
+--pkg-dir STR::             Set the alternate package db directory.
+
+--ports-dir STR::           Set the alternate ports db directory.
+
+--outofsync::               Filter all but out of sync packages.
+
+--missing::                 Filter all but packages that doesn't exists
+                            in ports.
+
+--likeportmaster::          Print like (but not quite) "portmaster -L".
+
+
+==Installation
+
+(Only if you are not installing the gem.)
+
+pkg_noisrev ships with a shared library (the comparator of a 2
+versions-as-a-string that was extracted from pkg_version sources) which
+must be compiled before you can use the program.
+
+cd to a directory with pkg_noisrev sources and type:
+
+ % rake mydll:default
+
+Then run <tt>bin/pkg_noisrev</tt> or make a symlink to it in one of your
+directories in PATH.
+
+
+==Configuration
+
+pkg_noisrev looks for its configuration at 3 places at start up.
+
+1. At <tt>PKG_NOISREV_CONF</tt> env variable.
+   (Its format is exactly similar to CL options.)
+
+2. At the configuration file. Its default name is
+   <tt>pkg_noisrev.yaml</tt> and it can be stored in several
+   system directories which are observable by <tt>--config--dirs</tt> CL
+   option.
+
+3. At command line.
+
+Higher number levels overrides the values from lower number levels.
+
+The configuration file must be in YAML format. Look into <tt>`gem env
+gemdir`/gems/pkg_noisrev-x.y.z/etc/</tt> directory for samples.
+
+
+==Examples
+
+ % ri Pkg_noisrev
+ % pkg_noisrev --likeportmaster
+ % pkg_noisrev --outofsync
+ % pkg_noisrev --missing --likeportmaster

data/doc/TODO

@@ -0,0 +1,6 @@
+-*-text-*-
+
++ look for missing ports in /usr/ports/MOVED file
++ apply filtering to --likeportmaster too
++ docs
++ tests

data/etc/pkg_noisrev.yaml

@@ -0,0 +1,2 @@
+--- 
+:foobar: foobar

data/ext/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+name = 'version'
+create_makefile('pkg_noisrev/' + name)
+#require 'pp'
+#pp $configure_args

data/ext/rakefile.rb

@@ -0,0 +1,24 @@
+# Building shared libraries.
+
+module MyDll
+  PATH = File.dirname(__FILE__)
+  MK = PATH + '/Makefile'
+  EXTCONF = PATH + '/extconf.rb'
+end
+
+namespace 'mydll' do
+  desc "Generate dlls"
+  task :default => [MyDll::MK] do |i|
+    sh "cd #{MyDll::PATH} && make"
+  end
+
+  desc "Clean all crap"
+  task :clean => [MyDll::MK] do |i|
+    sh "cd #{MyDll::PATH} && make clean"
+    rm_rf i.prerequisites
+  end
+  
+  file MyDll::MK => [MyDll::EXTCONF] do |i|
+    sh "cd #{MyDll::PATH} && ruby #{i.prerequisites.join(' ')}"
+  end
+end

data/ext/version.c

@@ -0,0 +1,286 @@
+/*
+ A modified version of /usr/src/usr.sbin/pkg_install/lib/version.c from
+ FreeBSD 8.2.
+*/
+
+#include "version.h"
+
+/*
+ * split_version(pkgname, endname, epoch, revision) returns a pointer to
+ * the version portion of a package name and the two special components.
+ *
+ * Syntax is:  ${PORTNAME}-${PORTVERSION}[_${PORTREVISION}][,${PORTEPOCH}]
+ *
+ * Written by Oliver Eikemeier
+ * Based on work of Jeremy D. Lea.
+ */
+static const char *
+split_version(const char *pkgname, const char **endname, unsigned long *epoch, unsigned long *revision)
+{
+    char *ch;
+    const char *versionstr;
+    const char *endversionstr;
+
+    if (pkgname == NULL)
+	errx(2, "%s: Passed NULL pkgname.", __func__);
+
+    /* Look for the last '-' the the pkgname */
+    ch = strrchr(pkgname, '-');
+    /* Cheat if we are just passed a version, not a valid package name */
+    versionstr = ch ? ch + 1 : pkgname;
+
+    /* Look for the last '_' in the version string, advancing the end pointer */
+    ch = strrchr(versionstr, '_');
+    if (revision != NULL) {
+	*revision = ch ? strtoul(ch + 1, NULL, 10) : 0;
+    }
+    endversionstr = ch;
+
+    /* Look for the last ',' in the remaining version string */
+    ch = strrchr(endversionstr ? endversionstr + 1 : versionstr, ',');
+    if (epoch != NULL) {
+	*epoch = ch ? strtoul(ch + 1, NULL, 10) : 0;
+    }
+    if (ch && !endversionstr)
+	endversionstr = ch;
+
+    /* set the pointer behind the last character of the version without revision or epoch */
+    if (endname)
+	*endname = endversionstr ? endversionstr : strrchr(versionstr, '\0');
+
+    return versionstr;
+}
+
+/*
+ * PORTVERSIONs are composed of components separated by dots. A component
+ * consists of a version number, a letter and a patchlevel number. This does
+ * not conform to the porter's handbook, but let us formulate rules that
+ * fit the current practice and are far simpler than to make decisions
+ * based on the order of netters and lumbers. Besides, people use versions
+ * like 10b2 in the ports...
+ */
+
+typedef struct {
+#ifdef __LONG_LONG_SUPPORTED
+    long long n;
+    long long pl;
+#else
+    long n;
+    long pl;
+#endif
+    int a;
+} version_component;
+
+/*
+ * get_component(position, component) gets the value of the next component
+ * (number - letter - number triple) and returns a pointer to the next character
+ * after any leading separators
+ *
+ * - components are separated by dots
+ * - characters !~ [a-zA-Z0-9.+*] are treated as separators
+ *   (1.0:2003.09.16 = 1.0.2003.09.16), this may not be what you expect:
+ *   1.0.1:2003.09.16 < 1.0:2003.09.16
+ * - consecutive separators are collapsed (10..1 = 10.1)
+ * - missing separators are inserted, essentially
+ *   letter number letter => letter number . letter (10a1b2 = 10a1.b2)
+ * - missing components are assumed to be equal to 0 (10 = 10.0 = 10.0.0)
+ * - the letter sort order is: [none], a, b, ..., z; numbers without letters
+ *   sort first (10 < 10a < 10b)
+ * - missing version numbers (in components starting with a letter) sort as -1
+ *   (a < 0, 10.a < 10)
+ * - a separator is inserted before the special strings "pl", "alpha", "beta", 
+ *   "pre" and "rc".
+ * - "pl" sorts before every other letter, "alpha", "beta", "pre" and "rc"
+ *   sort as a, b, p and r. (10alpha = 10.a < 10, but 10 < 10a; pl11 < alpha3
+ *   < 0.1beta2 = 0.1.b2 < 0.1)
+ * - other strings use only the first letter for sorting, case is ignored
+ *   (1.d2 = 1.dev2 = 1.Development2)
+ * - The special component `*' is guaranteed to be the smallest possible
+ *   component (2.* < 2pl1 < 2alpha3 < 2.9f7 < 3.*)
+ * - components separated by `+' are handled by version_cmp below
+ *
+ * Oliver Eikemeier
+ */
+
+static const struct {
+    const char *name;
+    size_t namelen;
+    int value;
+} stage[] = {
+    { "pl",    2,  0        },
+    { "alpha", 5, 'a'-'a'+1 },
+    { "beta",  4, 'b'-'a'+1 },
+    { "pre",   3, 'p'-'a'+1 },
+    { "rc",    2, 'r'-'a'+1 },
+    { NULL,    0,  -1       }
+};
+
+static const char *
+get_component(const char *position, version_component *component)
+{
+    const char *pos = position;
+    int hasstage = 0, haspatchlevel = 0;
+
+    if (!pos)
+	errx(2, "%s: Passed NULL position.", __func__);
+
+    /* handle version number */
+    if (isdigit(*pos)) {
+	char *endptr;
+#ifdef __LONG_LONG_SUPPORTED
+	component->n = strtoll(pos, &endptr, 10);
+#else
+	component->n = strtol(pos, &endptr, 10);
+#endif
+	/* should we test for errno == ERANGE? */
+	pos = endptr;
+    } else if (*pos == '*') {
+	component->n = -2;
+	do {
+	    pos++;
+	} while(*pos && *pos != '+');
+    } else {
+	component->n = -1;
+	hasstage = 1;
+    }
+
+    /* handle letter */
+    if (isalpha(*pos)) {
+	int c = tolower(*pos);
+	haspatchlevel = 1;
+	/* handle special suffixes */
+	if (isalpha(pos[1])) {
+	    int i;
+	    for (i = 0; stage[i].name; i++) {
+		if (strncasecmp(pos, stage[i].name, stage[i].namelen) == 0
+                    && !isalpha(pos[stage[i].namelen])) {
+		    if (hasstage) {
+			/* stage to value */
+			component->a = stage[i].value;
+			pos += stage[i].namelen;
+		    } else {
+			/* insert dot */
+			component->a = 0;
+			haspatchlevel = 0;
+		    }
+		    c = 0;
+		    break;
+		}
+	    }
+	}
+	/* unhandled above */
+	if (c) {
+	    /* use the first letter and skip following */
+	    component->a = c - 'a' + 1;
+	    do {
+		++pos;
+	    } while (isalpha(*pos));
+	}
+    } else {
+	component->a = 0;
+	haspatchlevel = 0;
+    }
+
+    if (haspatchlevel) {
+	/* handle patch number */
+	if (isdigit(*pos)) {
+	    char *endptr;
+#ifdef __LONG_LONG_SUPPORTED
+	    component->pl = strtoll(pos, &endptr, 10);
+#else
+	    component->pl = strtol(pos, &endptr, 10);
+#endif
+	    /* should we test for errno == ERANGE? */
+	    pos = endptr;
+	} else {
+	    component->pl = -1;
+	}
+    } else {
+	component->pl = 0;
+    }
+
+    /* skip trailing separators */
+    while (*pos && !isdigit(*pos) && !isalpha(*pos) && *pos != '+' && *pos != '*') {
+	pos++;
+    }
+
+    return pos;
+}
+
+/*
+ * version_cmp(pkg1, pkg2) returns -1, 0 or 1 depending on if the version
+ * components of pkg1 is less than, equal to or greater than pkg2. No
+ * comparison of the basenames is done.
+ *
+ * The port version is defined by:
+ * ${PORTVERSION}[_${PORTREVISION}][,${PORTEPOCH}]
+ * ${PORTEPOCH} supersedes ${PORTVERSION} supersedes ${PORTREVISION}.
+ * See the commit log for revision 1.349 of ports/Mk/bsd.port.mk
+ * for more information.
+ *
+ * The epoch and revision are defined to be a single number, while the rest
+ * of the version should conform to the porting guidelines. It can contain
+ * multiple components, separated by a period, including letters.
+ *
+ * The tests allow for significantly more latitude in the version numbers
+ * than is allowed in the guidelines. No point in enforcing them here.
+ * That's what portlint is for.
+ *
+ * Jeremy D. Lea.
+ * reimplemented by Oliver Eikemeier
+ */
+int
+version_cmp(const char *pkg1, const char *pkg2)
+{
+    const char *v1, *v2, *ve1, *ve2;
+    unsigned long e1, e2, r1, r2;
+    int result = 0;
+
+    v1 = split_version(pkg1, &ve1, &e1, &r1);
+    v2 = split_version(pkg2, &ve2, &e2, &r2);
+
+    /* Check epoch, port version, and port revision, in that order. */
+    if (e1 != e2) {
+	result = (e1 < e2 ? -1 : 1);
+    }
+
+    /* Shortcut check for equality before invoking the parsing routines. */
+    if (result == 0 && (ve1 - v1 != ve2 - v2 || strncasecmp(v1, v2, ve1 - v1) != 0)) {
+	/* Loop over different components (the parts separated by dots).
+	 * If any component differs, we have the basis for an inequality. */
+	while(result == 0 && (v1 < ve1 || v2 < ve2)) {
+	    int block_v1 = 0;
+	    int block_v2 = 0;
+	    version_component vc1 = {0, 0, 0};
+	    version_component vc2 = {0, 0, 0};
+	    if (v1 < ve1 && *v1 != '+') {
+		v1 = get_component(v1, &vc1);
+	    } else {
+		block_v1 = 1;
+	    }
+	    if (v2 < ve2 && *v2 != '+') {
+		v2 = get_component(v2, &vc2);
+	    } else {
+		block_v2 = 1;
+	    }
+	    if (block_v1 && block_v2) {
+		if (v1 < ve1)
+		    v1++;
+		if (v2 < ve2)
+		    v2++;
+	    } else if (vc1.n != vc2.n) {
+		result = (vc1.n < vc2.n ? -1 : 1);
+	    } else if (vc1.a != vc2.a) {
+		result = (vc1.a < vc2.a ? -1 : 1);
+	    } else if (vc1.pl != vc2.pl) {
+		result = (vc1.pl < vc2.pl ? -1 : 1);
+	    }
+	}
+    }
+
+    /* Compare FreeBSD revision numbers. */
+    if (result == 0 && r1 != r2) {
+	result = (r1 < r2 ? -1 : 1);
+    }
+    return result;
+}