Merge lp:~smoser/software-properties/shortcut-refactor into lp:software-properties

[Scott Moser]

Refactor ppa handling into generic 'shortcuts', add handler for cloud-archive

This re-factors the 'ppa:' handling into something more generic.
Then, we add a handler for 'cloud-archive:<item>' where item is one of 'tools{,-updates,proposed}', or '<openstack-release>{,-updates,-proposed}.

fixes bug 1233486

We're wanting to get this into saucy, even though we only expect for it to be used on precise. We'd then backport the code and SRU it to 12.04 to make users of the cloud archive able to use it.

Please don't let that affect your review. I think it should stand on its own as a rework of the 'ppa:' code.

[Michael Vogt (mvo)]

On Tue, Oct 01, 2013 at 03:17:34AM -0000, Scott Moser wrote:
> The proposal to merge lp:~smoser/software-properties/shortcut-refactor into lp:software-properties has been updated.
>
> Commit Message changed to:
>
> Refactor ppa handling into generic 'shortcuts', add handler for cloud-archive
>
> This re-factors the 'ppa:' handling into something more generic.
> Then, we add a handler for 'cloud-archive:<item>' where item is one of 'tools{,-updates,proposed}', or '<openstack-release>{,-updates,-proposed}.
>
> fixes bug 1233486

Thanks for this branch! I looked over the code and it looks good,
thanks for the refactor, this made the concept nicer and more
generic. But it seems like the branch is breaking the tests, i.e. when
I run "python setup.py test" on my box I get some test failures.

Cheers,
 Michael

[Scott Moser (smoser)]

I'll fix. thanks.

[Scott Moser (smoser)]

I've fixed the test case.

[lp:~smoser/software-properties/shortcut-refactor]

881. By Scott Moser on 2013-10-02

fix test case, make AddPPASigningKeyThread more correct.

[Scott Moser (smoser)]

Michael,
  the test case is fixed now, please do review. and accept or merge if you see fit.
  Thanks.

[lp:~smoser/software-properties/shortcut-refactor]

882. By Scott Moser on 2013-10-05

support adding cloud-archive repositories using syntax like
cloud-archive:havana (LP: #1233486)

=== modified file 'add-apt-repository'
--- add-apt-repository	2013-05-28 19:52:17 +0000
+++ add-apt-repository	2013-10-05 13:08:15 +0000
@@ -8,50 +8,14 @@
 import gettext
 import locale
 
-from softwareproperties.SoftwareProperties import SoftwareProperties
-from softwareproperties.ppa import DEFAULT_KEYSERVER, expand_ppa_line
-from softwareproperties import lp_application_name
+from softwareproperties.SoftwareProperties import SoftwareProperties, shortcut_handler
+from softwareproperties.shortcuts import ShortcutException
+from softwareproperties.ppa import DEFAULT_KEYSERVER
 import aptsources
 from aptsources.sourceslist import SourceEntry
-from aptsources.distro import *
 from optparse import OptionParser
 from gettext import gettext as _
 
-try:
-    from urllib.error import HTTPError, URLError
-except ImportError:
-    import pycurl
-    HTTPError = pycurl.error
-
-def _maybe_suggest_ppa_name_based_on_user(user):
-    try:
-        from launchpadlib.launchpad import Launchpad
-        lp = Launchpad.login_anonymously(lp_application_name, "production")
-        try:
-            user_inst = lp.people[user]
-            entity_name = _("team") if user_inst.is_team else _("user")
-            if len(user_inst.ppas) > 0:
-                # Translators: %(entity)s is either "team" or "user"
-                print(_("The %(entity)s named '%(user)s' has no PPA named '%(ppa)s'") % {
-                        'entity' : entity_name,
-                         'user' : user,
-                         'ppa' : ppa_name})
-                print(_("Please choose from the following available PPAs:"))
-                for ppa in user_inst.ppas:
-                    print(_(" * '%(name)s':  %(displayname)s") % {
-                            'name' : ppa.name,
-                            'displayname' : ppa.displayname})
-            else:
-                # Translators: %(entity)s is either "team" or "user"
-                print(_("The %(entity)s named '%(user)s' does not have any PPA") % {
-                        'entity' : entity_name,
-                         'user' : user})
-        except KeyError:
-            pass
-    except ImportError:
-        print(_("Please check that the PPA name or format is correct."))
-
-
 if __name__ == "__main__":
     # Force encoding to UTF-8 even in non-UTF-8 locales.
     sys.stdout = io.TextIOWrapper(
@@ -123,46 +87,6 @@
     # get the line
     line = args[0]
 
-    # display PPA info (if needed)
-    if line.startswith("ppa:") and not options.assume_yes:
-        from softwareproperties.ppa import PPAException, get_ppa_info_from_lp, LAUNCHPAD_PPA_API
-        user, sep, ppa_name = line.split(":")[1].partition("/")
-        ppa_name = ppa_name or "ppa"
-        try:
-            ppa_info = get_ppa_info_from_lp(user, ppa_name)
-        except HTTPError:
-            print(_("Cannot add PPA: '%s'.") % line)
-            if user.startswith("~"):
-                print(_("Did you mean 'ppa:%s/%s' ?") %(user[1:], ppa_name))
-                sys.exit(1) # Exit because the user cannot be correct
-            # If the PPA does not exist, then try to find if the user/team
-            # exists. If it exists, list down the PPAs
-            _maybe_suggest_ppa_name_based_on_user(user)
-            sys.exit(1)
-        except (ValueError, PPAException):
-            print(_("Cannot access PPA (%s) to get PPA information, "
-                    "please check your internet connection.") % \
-                (LAUNCHPAD_PPA_API % (user, ppa_name)))
-            sys.exit(1)
-        # private PPAs are not supported
-        if "private" in ppa_info and ppa_info["private"]:
-            print(_("Adding private PPAs is not supported currently"))
-            sys.exit(1)
-
-        if options.remove:
-            print(_("You are about to remove the following PPA from your system:"))
-        else:
-            print(_("You are about to add the following PPA to your system:"))
-        print(" %s" % (ppa_info["description"] or ""))
-        print(_(" More info: %s") % str(ppa_info["web_link"]))
-        if (sys.stdin.isatty() and
-            not "FORCE_ADD_APT_REPOSITORY" in os.environ):
-            if options.remove:
-                print(_("Press [ENTER] to continue or ctrl-c to cancel removing it"))
-            else:
-                print(_("Press [ENTER] to continue or ctrl-c to cancel adding it"))
-            sys.stdin.readline()
-
     # add it
     sp = SoftwareProperties(options=options)
     distro = aptsources.distro.get_distro()
@@ -188,8 +112,39 @@
         sp.sourceslist.save()
         sys.exit(0)
 
+    # this wasn't a component name ('multiverse', 'backports'), so its either
+    # a actual line to be added or a shortcut.
+    try:
+        shortcut = shortcut_handler(line)
+    except ShortcutException as e:
+        print(e)
+        sys.exit(1)
+
+    # display more information about the shortcut / ppa info
+    if not options.assume_yes and shortcut.should_confirm():
+        try:
+            info = shortcut.info()
+        except ShortcutException as e:
+            print(e)
+            sys.exit(1)
+
+        print(" %s" % (info["description"] or ""))
+        print(_(" More info: %s") % str(info["web_link"]))
+        if (sys.stdin.isatty() and
+            not "FORCE_ADD_APT_REPOSITORY" in os.environ):
+            if options.remove:
+                print(_("Press [ENTER] to continue or ctrl-c to cancel removing it"))
+            else:
+                print(_("Press [ENTER] to continue or ctrl-c to cancel adding it"))
+            sys.stdin.readline()
+
+
     if options.remove:
-        (line, file) = expand_ppa_line(line.strip(), sp.distro.codename)
+        try:
+            (line, file) = shortcut.expand(sp.distro.codename)
+        except ShortcutException as e:
+            print(e)
+            sys.exit(1)
         deb_line = sp.expand_http_line(line)
         debsrc_line = 'deb-src' + deb_line[3:]
         deb_entry = SourceEntry(deb_line, file)
@@ -204,7 +159,12 @@
             print(_("Error: '%s' doesn't exist in a sourcelist file") % debsrc_line)
 
     else:
-        if not sp.add_source_from_line(line, options.enable_source):
-            print(_("Error: '%s' invalid") % line)
+        try:
+            if not sp.add_source_from_shortcut(shortcut, options.enable_source):
+                print(_("Error: '%s' invalid") % line)
+                sys.exit(1)
+        except ShortcutException as e:
+            print(e)
             sys.exit(1)
+        
         sp.sourceslist.save()
 
=== modified file 'debian/changelog'
--- debian/changelog	2013-09-18 17:55:08 +0000
+++ debian/changelog	2013-10-05 13:08:15 +0000
@@ -1,3 +1,10 @@
+software-properties (0.92.26ubuntu1) UNRELEASED; urgency=low
+
+  * support adding cloud-archive repositories using syntax like
+    cloud-archive:havana (LP: #1233486)
+
+ -- Scott Moser <[e-mail]>  Sat, 05 Oct 2013 09:06:25 -0400
+
 software-properties (0.92.26) saucy; urgency=low
 
   * SECURITY UPDATE: possible privilege escalation via policykit UID lookup
 
=== modified file 'softwareproperties/SoftwareProperties.py'
--- softwareproperties/SoftwareProperties.py	2013-06-19 19:48:08 +0000
+++ softwareproperties/SoftwareProperties.py	2013-10-05 13:08:15 +0000
@@ -24,7 +24,6 @@
 
 from __future__ import absolute_import, print_function
 
-import apt
 import apt_pkg
 import copy
 from hashlib import md5
@@ -48,10 +47,6 @@
 except ImportError:
   from ConfigParser import ConfigParser
 from gettext import gettext as _
-try:
-  from urllib.parse import urlparse
-except ImportError:
-  from urlparse import urlparse
 
 import aptsources
 import aptsources.distro
@@ -59,7 +54,16 @@
 
 from .AptAuth import AptAuth
 from aptsources.sourceslist import SourcesList, SourceEntry
-from .ppa import AddPPASigningKeyThread, expand_ppa_line
+from . import shortcuts
+from . import ppa
+from . import cloudarchive
+
+_SHORTCUT_FACTORIES = [
+    ppa.shortcut_handler,
+    cloudarchive.shortcut_handler,
+    shortcuts.shortcut_handler,
+]
+
 
 class SoftwareProperties(object):
 
@@ -650,7 +654,7 @@
     helper that checks if a given line is in the source list
     return the channel name or None if not found
     """
-    srcentry = SourceEntry(srcline)    
+    srcentry = SourceEntry(srcline)
     if os.path.exists(self.CHANNEL_PATH):
       for f in glob.glob("%s/*.list" % self.CHANNEL_PATH):
         for line in open(f):
@@ -661,23 +665,30 @@
     return None
 
   def check_and_add_key_for_whitelisted_channels(self, srcline):
+    # This is maintained for any legacy callers
+    return self.check_and_add_key_for_whitelisted_shortcut(shortcut_handler(srcline))
+
+  def check_and_add_key_for_whitelisted_shortcut(self, shortcut):
     """
     helper that adds the gpg key of the channel to the apt
     keyring *if* the channel is in the whitelist
     /usr/share/app-install/channels or it is a public Launchpad PPA.
     """
+    (srcline, _fname) = shortcut.expand(codename=self.distro.codename)
     channel = self._is_line_in_whitelisted_channel(srcline)
     if channel:
       keyp = "%s/%s.key" % (self.CHANNEL_PATH, channel)
       self.add_key(keyp)
-    # FIXME: abstract this all alway into the ppa.py file
-    parsed_uri = urlparse(SourceEntry(srcline).uri)
-    if parsed_uri.netloc == 'ppa.launchpad.net':
-      worker = AddPPASigningKeyThread(parsed_uri.path, self.options and self.options.keyserver)
-      worker.start()
-      return worker
-    else:
-      return None
+
+    cdata = (shortcut.add_key, {'keyserver': (self.options and
+                                              self.options.keyserver)})
+    def addkey_func():
+        func, kwargs = cdata
+        func(**kwargs)
+
+    worker = threading.Thread(target=addkey_func)
+    worker.start()
+    return worker
 
   def update_interface(self):
     " abstract interface to keep the UI alive "
@@ -701,10 +712,18 @@
 
   def add_source_from_line(self, line, enable_source_code=False):
     """
-    Add a source with the given apt line and auto-add
-    signing key if we have it in the whitelist
-    """
-    (deb_line, file) = expand_ppa_line(line.strip(), self.distro.codename)
+    Add a source for the given line.
+    """
+    return self.add_source_from_shortcut(shortcut=shortcut_handler(line),
+                                         enable_source_code=enable_source_code)
+
+  def add_source_from_shortcut(self, shortcut, enable_source_code=False):
+    """
+    Add a source with the given shortcut and add the signing key if the
+    site is in whitelist or the shortcut implementer adds it.
+    """
+
+    (deb_line, file) = shortcut.expand(codename=self.distro.codename)
     deb_line = self.expand_http_line(deb_line)
     debsrc_entry_type = 'deb-src' if enable_source_code else '# deb-src'
     debsrc_line = debsrc_entry_type + deb_line[3:]
@@ -712,7 +731,7 @@
     new_debsrc_entry = SourceEntry(debsrc_line, file)
     if new_deb_entry.invalid or new_debsrc_entry.invalid:
       return False
-    worker = self.check_and_add_key_for_whitelisted_channels(deb_line)
+    worker = self.check_and_add_key_for_whitelisted_shortcut(shortcut)
     self.sourceslist.add(new_deb_entry.type,
                          new_deb_entry.uri,
                          new_deb_entry.dist,
@@ -812,6 +831,15 @@
       return False
 
 
+def shortcut_handler(shortcut):
+    for factory in _SHORTCUT_FACTORIES:
+        ret = factory(shortcut)
+        if ret is not None:
+            return ret
+
+    raise shortcuts.ShortcutException("Unable to handle input '%s'" % shortcut)
+
+
 if __name__ == "__main__":
   sp = SoftwareProperties()
   print(sp.get_release_upgrades_policy())
 
=== added file 'softwareproperties/cloudarchive.py'
--- softwareproperties/cloudarchive.py	1970-01-01 00:00:00 +0000
+++ softwareproperties/cloudarchive.py	2013-10-05 13:08:15 +0000
@@ -0,0 +1,123 @@
+#  software-properties cloud-archive support
+#
+#  Copyright (c) 2013 Canonical Ltd.
+#
+#  Author: Scott Moser <[e-mail]>
+#
+#  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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+#  USA
+
+from __future__ import print_function
+
+import apt_pkg
+import os
+import subprocess
+from gettext import gettext as _
+
+from softwareproperties.shortcuts import ShortcutException
+
+CODENAME = "precise"
+OS_RELEASES = ('folsom', 'grizzly', 'havana', 'icehouse')
+MIRROR = "http://ubuntu-cloud.archive.canonical.com/ubuntu"
+UCA = "Ubuntu Cloud Archive"
+WEB_LINK = 'https://wiki.ubuntu.com/ServerTeam/CloudArchive'
+APT_INSTALL_KEY = ['apt-get', '--quiet', '--assume-yes', 'install',
+                   'ubuntu-cloud-keyring']
+
+ALIASES = {'tools-updates': 'tools'}
+for _r in OS_RELEASES:
+    ALIASES["%s-updates" % _r] = _r
+
+MAP = {
+    'tools': {
+        'sldfmt': '%(codename)s-updates/cloud-tools',
+        'description': UCA + " for cloud-tools (JuJu and MAAS)"},
+    'tools-proposed': {
+        'sldfmt': '%(codename)s-proposed/cloud-tools',
+        'description': UCA + " for cloud-tools (JuJu and MAAS) [proposed]"}
+}
+
+for _r in OS_RELEASES:
+    MAP[_r] = {
+        'sldfmt': '%(codename)s-updates/' + _r,
+        'description': UCA + ' for ' + 'Openstack ' + _r}
+    MAP[_r + "-proposed"] = {
+        'sldfmt': '%(codename)s-proposed/' + _r,
+        'description': UCA + ' for ' + 'Openstack %s [proposed]' % _r}
+
+
+class CloudArchiveShortcutHandler(object):
+    def __init__(self, shortcut):
+        self.shortcut = shortcut
+
+        prefix = "cloud-archive:"
+
+        subs = {'shortcut': shortcut, 'prefix': prefix,
+                'ca_names': sorted(MAP.keys())}
+        if not shortcut.startswith(prefix):
+            raise ValueError(
+                _("shortcut '%(shortcut)s' did not start with '%(prefix)s'")
+                % subs)
+
+        name_in = shortcut[len(prefix):]
+        caname = ALIASES.get(name_in, name_in)
+        
+        subs.update({'input_name': name_in})
+        if caname not in MAP:
+            raise ShortcutException(
+                _("'%(input_name)s': not a valid cloud-archive name.\n"
+                  "Must be one of %(ca_names)s") % subs)
+
+        self.caname = caname
+        self._info = MAP[caname].copy()
+        self._info['web_link' ] = WEB_LINK
+
+    def info(self):
+        return self._info
+
+    def expand(self, codename):
+        if codename not in (CODENAME, os.environ.get("CA_ALLOW_CODENAME")):
+            raise ShortcutException(
+                _("cloud-archive only supported on %(codename)s")
+                % {'codename': CODENAME})
+        dist = MAP[self.caname]['sldfmt'] % {'codename': codename}
+        line = ' '.join(('deb', MIRROR, dist, 'main',))
+        return (line, _fname_for_caname(self.caname))
+
+    def should_confirm(self):
+        return True
+
+    def add_key(self, keyserver=None):
+        env = os.environ.copy()
+        env['DEBIAN_FRONTEND'] = 'noninteractive'
+        try:
+            subprocess.check_call(args=APT_INSTALL_KEY, env=env)
+        except subprocess.CalledProcessError as e:
+            return False
+        return True
+
+
+def _fname_for_caname(caname):
+    # caname is an entry in MAP ('tools' or 'tools-proposed')
+    return os.path.join(
+        apt_pkg.config.find_dir("Dir::Etc::sourceparts"),
+        'cloudarchive-%s.list' % caname)
+
+
+def shortcut_handler(shortcut):
+    try:
+        return CloudArchiveShortcutHandler(shortcut)
+    except ValueError:
+        return None
 
=== modified file 'softwareproperties/ppa.py'
--- softwareproperties/ppa.py	2013-05-30 17:49:39 +0000
+++ softwareproperties/ppa.py	2013-10-05 13:08:15 +0000
@@ -29,17 +29,29 @@
 import subprocess
 import tempfile
 
+from aptsources.sourceslist import SourceEntry
+from gettext import gettext as _
 from threading import Thread
 
+from .shortcuts import ShortcutException
+
 try:
     import urllib.request
-    from urllib.error import URLError
+    from urllib.error import HTTPError, URLError
     import urllib.parse
     from http.client import HTTPException
     NEED_PYCURL = False
 except ImportError:
     NEED_PYCURL = True
     import pycurl
+    HTTPError = pycurl.error
+
+
+try:
+  from urllib.parse import urlparse
+except ImportError:
+  from urlparse import urlparse
+
 
 DEFAULT_KEYSERVER = "hkp://keyserver.ubuntu.com:80/"
 # maintained until 2015
@@ -138,20 +150,16 @@
     return len(signing_key_fingerprint) >= 160/8
 
 
-class AddPPASigningKeyThread(Thread):
+class AddPPASigningKey(object):
     " thread class for adding the signing key in the background "
 
     GPG_DEFAULT_OPTIONS = ["gpg", "--no-default-keyring", "--no-options"]
 
     def __init__(self, ppa_path, keyserver=None):
-        Thread.__init__(self)
         self.ppa_path = ppa_path
         self.keyserver = (keyserver if keyserver is not None
                           else DEFAULT_KEYSERVER)
 
-    def run(self):
-        self.add_ppa_signing_key(self.ppa_path)
-
     def _recv_key(self, keyring, secret_keyring, signing_key_fingerprint, keyring_dir):
         try:
             # double check that the signing key is a v4 fingerprint (160bit)
@@ -211,12 +219,15 @@
             return False
         return True
 
-    def add_ppa_signing_key(self, ppa_path):
+    def add_ppa_signing_key(self, ppa_path=None):
         """Query and add the corresponding PPA signing key.
         
         The signing key fingerprint is obtained from the Launchpad PPA page,
         via a secure channel, so it can be trusted.
         """
+        if ppa_path is None:
+            ppa_path = self.ppa_path
+
         def cleanup(tmpdir):
             shutil.rmtree(tmp_keyring_dir)
         owner_name, ppa_name, distro = ppa_path[1:].split('/')
@@ -261,6 +272,110 @@
         return (res == 0)
 
 
+class AddPPASigningKeyThread(Thread, AddPPASigningKey):
+    # This class is legacy.  There are no users inside the software-properties
+    # codebase other than a test case.  It was left in case there were outside
+    # users.  Internally, we've changed from having a class implement the
+    # tread to explicitly launching a thread and invoking a method in it
+    # see check_and_add_key_for_whitelisted_shortcut for how.
+    def __init__(self, ppa_path, keyserver=None):
+        Thread.__init__(self)
+        AddPPASigningKey.__init__(self, ppa_path=ppa_path, keyserver=keyserver)
+
+    def run(self):
+        self.add_ppa_signing_key(self.ppa_path)
+
+
+def _get_suggested_ppa_message(user):
+    try:
+        msg = []
+        from launchpadlib.launchpad import Launchpad
+        lp = Launchpad.login_anonymously(lp_application_name, "production")
+        try:
+            user_inst = lp.people[user]
+            entity_name = _("team") if user_inst.is_team else _("user")
+            if len(user_inst.ppas) > 0:
+                # Translators: %(entity)s is either "team" or "user"
+                msg.append(_("The %(entity)s named '%(user)s' has no PPA named '%(ppa)s'") % {
+                        'entity' : entity_name,
+                         'user' : user,
+                         'ppa' : ppa_name})
+                msg.append(_("Please choose from the following available PPAs:"))
+                for ppa in user_inst.ppas:
+                    msg.append(_(" * '%(name)s':  %(displayname)s") % {
+                                 'name' : ppa.name,
+                                 'displayname' : ppa.displayname})
+            else:
+                # Translators: %(entity)s is either "team" or "user"
+                msg.append(_("The %(entity)s named '%(user)s' does not have any PPA") % {
+                             'entity' : entity_name, 'user' : user})
+            return '\n'.join(msg)
+        except KeyError:
+            return ''
+    except ImportError:
+        return _("Please check that the PPA name or format is correct.")
+
+
+def get_ppa_info(shortcut):
+    user, sep, ppa_name = shortcut.split(":")[1].partition("/")
+    ppa_name = ppa_name or "ppa"
+
+    try:
+        ret = get_ppa_info_from_lp(user, ppa_name)
+        return ret
+    except (HTTPError, Exception) as e:
+        msg = []
+        msg.append(_("Cannot add PPA: '%s'.") % shortcut)
+        if user.startswith("~"):
+            msg.append((_("Did you mean 'ppa:%s/%s' ?") %(user[1:], ppa_name)))
+            raise ShortcutException('\n'.join(msg) + "\n")
+
+        # If the PPA does not exist, then try to find if the user/team
+        # exists. If it exists, list down the PPAs
+        raise ShortcutException('\n'.join(msg) + "\n" +
+                                _get_suggested_ppa_message(user))
+
+    except (ValueError, PPAException):
+        raise ShortcutException(
+            _("Cannot access PPA (%s) to get PPA information, "
+              "please check your internet connection.") % \
+              (LAUNCHPAD_PPA_API % (user, ppa_name)))
+
+
+class PPAShortcutHandler(object):
+    def __init__(self, shortcut):
+        super(PPAShortcutHandler, self).__init__()
+        info = get_ppa_info(shortcut)
+
+        if "private" in info and info["private"]:
+            raise ShortcutException(
+                _("Adding private PPAs is not supported currently"))
+
+        self._info = info
+        self.shortcut = shortcut
+
+    def info(self):
+        return self._info
+
+    def expand(self, codename):
+        return expand_ppa_line(self.shortcut, codename)
+
+    def should_confirm(self):
+        return True
+
+    def add_key(self, keyserver=None):
+        (srcline, _fname) = self.expand("PPA_SCH_CODENAME")
+        ppa_path = urlparse(SourceEntry(srcline).uri).path
+        apsk = AddPPASigningKey(ppa_path, keyserver=keyserver)
+        return apsk.add_ppa_signing_key()
+
+
+def shortcut_handler(shortcut):
+    if not shortcut.startswith("ppa:"):
+        return None
+    return PPAShortcutHandler(shortcut)
+
+
 if __name__ == "__main__":
     import sys
     owner_name, ppa_name = sys.argv[1].split(":")[1].split("/")
 
=== added file 'softwareproperties/shortcuts.py'
--- softwareproperties/shortcuts.py	1970-01-01 00:00:00 +0000
+++ softwareproperties/shortcuts.py	2013-10-05 13:08:15 +0000
@@ -0,0 +1,57 @@
+#  Copyright (c) 2013 Canonical Ltd.
+#
+#  Author: Scott Moser <[e-mail]>
+#
+#  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, write to the Free Software
+#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+#  USA
+
+import aptsources.distro
+from gettext import gettext as _
+
+_DEF_CODENAME = aptsources.distro.get_distro().codename
+
+
+class ShortcutHandler(object):
+    # the defeault ShortcutHandler only handles actual apt lines.
+    # ie, 'shortcut' here is a line like you'd find in /etc/apt/sources.list:
+    #   deb MIRROR RELEASE-POCKET COMPONENT
+    def __init__(self, shortcut):
+        self.shortcut = shortcut
+
+    def add_key(self, keyserver=None):
+        return None
+
+    def expand(self, codename=None):
+        return (self.shortcut, None)
+
+    def info(self):
+        return {
+            'description': _("No description available for '%(shortcut)s'") %
+                             {'shortcut': self.shortcut},
+            'web_link': _("web link unavailable")}
+
+    def should_confirm(self):
+        return False
+
+
+class ShortcutException(Exception):
+    pass
+
+
+def shortcut_handler(shortcut):
+    # this is the default shortcut handler, so it matches anything
+    return ShortcutHandler(shortcut)
+
+# vi: ts=4 expandtab