From 89790c11799c4144e37a6a1f0dbe0f6fff89ea89 Mon Sep 17 00:00:00 2001
From: Julian Andres Klode <julian.klode@canonical.com>
Date: Thu, 15 Aug 2019 13:23:55 +0200
Subject: Add ?obsolete and ?upgradable patterns

These match packages that have no version in a repository, or
where an upgrade is available. Notably,

	?and(?obsolete,?upgradable) == ?false

because an upgradable package is by definition not obsolete.
---
 apt-pkg/cachefilter-patterns.cc    |  4 ++++
 apt-pkg/cachefilter-patterns.h     | 35 +++++++++++++++++++++++++++++++++++
 doc/apt-patterns.7.xml             |  6 ++++++
 test/integration/test-apt-patterns | 10 ++++++++++
 4 files changed, 55 insertions(+)

diff --git a/apt-pkg/cachefilter-patterns.cc b/apt-pkg/cachefilter-patterns.cc
index 6b506b740..b97d65a03 100644
--- a/apt-pkg/cachefilter-patterns.cc
+++ b/apt-pkg/cachefilter-patterns.cc
@@ -220,8 +220,12 @@ std::unique_ptr<APT::CacheFilter::Matcher> PatternParser::aPattern(std::unique_p
       return std::make_unique<APT::CacheFilter::PackageNameMatchesRegEx>(aWord(node->arguments[0]));
    if (node->matches("?not", 1, 1))
       return std::make_unique<APT::CacheFilter::NOTMatcher>(aPattern(node->arguments[0]).release());
+   if (node->matches("?obsolete", 0, 0))
+      return std::make_unique<Patterns::PackageIsObsolete>();
    if (node->matches("?true", 0, 0))
       return std::make_unique<APT::CacheFilter::TrueMatcher>();
+   if (node->matches("?upgradable", 0, 0))
+      return std::make_unique<Patterns::PackageIsUpgradable>(file);
    if (node->matches("?x-name-fnmatch", 1, 1))
       return std::make_unique<APT::CacheFilter::PackageNameMatchesFnmatch>(aWord(node->arguments[0]));
 
diff --git a/apt-pkg/cachefilter-patterns.h b/apt-pkg/cachefilter-patterns.h
index 4c2ef48df..68ad32f9a 100644
--- a/apt-pkg/cachefilter-patterns.h
+++ b/apt-pkg/cachefilter-patterns.h
@@ -138,6 +138,41 @@ struct PackageIsGarbage : public PackageMatcher
       return (*Cache)[Pkg].Garbage;
    }
 };
+
+struct PackageIsObsolete : public PackageMatcher
+{
+   bool operator()(pkgCache::PkgIterator const &pkg) override
+   {
+      // This code can be written without loops, as aptitude does, but it
+      // is far less readable.
+      if (pkg.CurrentVer().end())
+	 return false;
+
+      // See if there is any version that exists in a repository,
+      // if so return false
+      for (auto ver = pkg.VersionList(); !ver.end(); ver++)
+      {
+	 for (auto file = ver.FileList(); !file.end(); file++)
+	 {
+	    if ((file.File()->Flags & pkgCache::Flag::NotSource) == 0)
+	       return false;
+	 }
+      }
+
+      return true;
+   }
+};
+
+struct PackageIsUpgradable : public PackageMatcher
+{
+   pkgCacheFile *Cache;
+   explicit PackageIsUpgradable(pkgCacheFile *Cache) : Cache(Cache) {}
+   bool operator()(pkgCache::PkgIterator const &Pkg) override
+   {
+      assert(Cache != nullptr);
+      return Pkg->CurrentVer != 0 && (*Cache)[Pkg].Upgradable();
+   }
+};
 } // namespace Patterns
 } // namespace Internal
 } // namespace APT
diff --git a/doc/apt-patterns.7.xml b/doc/apt-patterns.7.xml
index 327ea17d5..6058d7a74 100644
--- a/doc/apt-patterns.7.xml
+++ b/doc/apt-patterns.7.xml
@@ -78,6 +78,12 @@
      <varlistentry><term><code>?name(REGEX)</code></term>
      <listitem><para>Selects packages where the name matches the given regular expression.</para></listitem>
      </varlistentry>
+     <varlistentry><term><code>?obsolete</code></term>
+     <listitem><para>Selects packages that no longer exist in repositories.</para></listitem>
+     </varlistentry>
+     <varlistentry><term><code>?upgradable</code></term>
+     <listitem><para>Selects packages that can be upgraded (have a newer candidate).</para></listitem>
+     </varlistentry>
    </variablelist>
  </refsect1>
 
diff --git a/test/integration/test-apt-patterns b/test/integration/test-apt-patterns
index 9a2c74f83..549089d8a 100755
--- a/test/integration/test-apt-patterns
+++ b/test/integration/test-apt-patterns
@@ -123,6 +123,16 @@ testsuccessequal "Listing...
 automatic1/now 1.0 i386 [installed,local]
 automatic2/now 1.0 i386 [installed,local]" apt list '?name(^automatic)'
 
+testsuccessequal "Listing...
+available/unstable 1.0 all
+conf-only/now 1.0 i386 [residual-config]
+foreign/unstable 2.0 amd64
+not-obsolete/unstable 2.0 i386 [upgradable from: 1.0]" apt list '?not(?obsolete)'
+
+testsuccessequal "Listing...
+not-obsolete/unstable 2.0 i386 [upgradable from: 1.0]
+N: There is 1 additional version. Please use the '-a' switch to see it" apt list '?upgradable'
+
 testsuccessequal "Listing..." apt list '?x-name-fnmatch(1)'
 testsuccessequal "Listing...
 automatic1/now 1.0 i386 [installed,local]
-- 
cgit v1.2.3