1968N/A

1968N/A

1968N/APKG_CLIENT_NAME = "pkgrepo"

1968N/A

1968N/AEXIT_OK = 0

1968N/AEXIT_OOPS = 1

1968N/AEXIT_BADOPT = 2

1968N/AEXIT_PARTIAL = 3

1968N/A

3031N/ALISTING_FORMATS = ("default", "json", "json-formatted", "tsv")

1968N/A

2028N/Atmpdirs = []

2028N/A

2028N/Aimport atexit

2301N/Aimport collections

2028N/Aimport copy

1968N/Aimport errno

1968N/Aimport getopt

1968N/Aimport gettext

1968N/Aimport locale

1968N/Aimport logging

3138N/Aimport os

2028N/Aimport shlex

2028N/Aimport shutil

1968N/Aimport sys

2028N/Aimport tempfile

2843N/Aimport textwrap

2028N/Aimport traceback

1968N/Aimport warnings

3041N/Aimport itertools

1968N/A

1968N/Afrom pkg.client import global_settings

2864N/Afrom pkg.client.debugvalues import DebugValues

1968N/Afrom pkg.misc import msg, PipeError

1968N/Aimport pkg

2028N/Aimport pkg.catalog

1968N/Aimport pkg.client.api_errors as apx

2616N/Aimport pkg.client.pkgdefs as pkgdefs

2301N/Aimport pkg.client.progress

1968N/Aimport pkg.client.publisher as publisher

2028N/Aimport pkg.client.transport.transport as transport

1968N/Aimport pkg.misc as misc

1968N/Aimport pkg.server.repository as sr

1968N/A

1968N/Alogger = global_settings.logger

2028N/A

2028N/A@atexit.register

2028N/Adef cleanup():

2028N/A """To be called at program finish."""

2028N/A for d in tmpdirs:

2028N/A shutil.rmtree(d, True)

1968N/A

2301N/A

1968N/Adef error(text, cmd=None):

1968N/A """Emit an error message prefixed by the command name """

1968N/A

1968N/A if cmd:

1968N/A text = "%s: %s" % (cmd, text)

1968N/A pkg_cmd = "pkgrepo "

1968N/A else:

1968N/A pkg_cmd = "pkgrepo: "

1968N/A

1968N/A # If we get passed something like an Exception, we can convert

1968N/A # it down to a string.

1968N/A text = str(text)

1968N/A

1968N/A # If the message starts with whitespace, assume that it should come

1968N/A # *before* the command-name prefix.

1968N/A text_nows = text.lstrip()

1968N/A ws = text[:len(text) - len(text_nows)]

1968N/A

1968N/A # This has to be a constant value as we can't reliably get our actual

1968N/A # program name on all platforms.

1968N/A logger.error(ws + pkg_cmd + text_nows)

1968N/A

1968N/A

2301N/Adef get_tracker(quiet=False):

2301N/A if quiet:

2301N/A progtrack = pkg.client.progress.QuietProgressTracker()

2301N/A else:

2301N/A try:

2301N/A progtrack = \

2301N/A pkg.client.progress.FancyUNIXProgressTracker()

2301N/A except pkg.client.progress.ProgressTrackerException:

2301N/A progtrack = \

2301N/A pkg.client.progress.CommandLineProgressTracker()

2301N/A return progtrack

2301N/A

2301N/A

1968N/Adef usage(usage_error=None, cmd=None, retcode=2, full=False):

1968N/A """Emit a usage message and optionally prefix it with a more

1968N/A

1968N/A if usage_error:

1968N/A error(usage_error, cmd=cmd)

1968N/A

1968N/A if not full:

1968N/A # The full usage message isn't desired.

1968N/A logger.error(_("Try `pkgrepo --help or -?' for more "

1968N/A "information."))

1968N/A sys.exit(retcode)

1968N/A

1968N/A msg(_("""\

1978N/A Displays a usage message."""))

1968N/A

1968N/A sys.exit(retcode)

1968N/A

3041N/A

1968N/Aclass OptionError(Exception):

1968N/A """Option exception. """

1968N/A

1968N/A def __init__(self, *args):

1968N/A Exception.__init__(self, *args)

1968N/A

1968N/A

1968N/Adef parse_uri(uri):

1968N/A """Parse the repository location provided and attempt to transform it

1968N/A

2028N/A return publisher.RepositoryURI(misc.parse_uri(uri))

1968N/A

1968N/A

2301N/Adef subcmd_remove(conf, args):

2301N/A subcommand = "remove"

2301N/A

2301N/A opts, pargs = getopt.getopt(args, "np:s:")

2301N/A

2301N/A dry_run = False

2301N/A pubs = set()

2301N/A for opt, arg in opts:

2301N/A if opt == "-n":

2301N/A dry_run = True

2301N/A elif opt == "-p":

2301N/A pubs.add(arg)

2301N/A elif opt == "-s":

2301N/A conf["repo_uri"] = parse_uri(arg)

2301N/A

2301N/A if not pargs:

2301N/A usage(_("At least one package pattern must be provided."),

2301N/A cmd=subcommand)

2301N/A

2301N/A # Get repository object.

2301N/A if not conf.get("repo_uri", None):

2301N/A usage(_("A package repository location must be provided "

2301N/A "using -s."), cmd=subcommand)

2301N/A repo = get_repo(conf, read_only=False, subcommand=subcommand)

2301N/A

2301N/A if "all" in pubs:

2301N/A pubs = set()

2301N/A

2301N/A # Find matching packages.

2301N/A try:

2301N/A matching, refs = repo.get_matching_fmris(pargs, pubs=pubs)

2301N/A except apx.PackageMatchErrors, e:

2301N/A error(str(e), cmd=subcommand)

2301N/A return EXIT_OOPS

2301N/A

2301N/A if dry_run:

2301N/A # Don't make any changes; display list of packages to be

2301N/A # removed and exit.

2301N/A packages = set(f for m in matching.values() for f in m)

2301N/A count = len(packages)

2958N/A plist = "\n".join("\t%s" % p.get_fmri(include_build=False)

2958N/A for p in sorted(packages))

2301N/A logger.info(_("%(count)d package(s) will be removed:\n"

2301N/A "%(plist)s") % locals())

2301N/A return EXIT_OK

2301N/A

2301N/A progtrack = get_tracker()

2301N/A packages = collections.defaultdict(list)

2301N/A for m in matching.values():

2301N/A for f in m:

2301N/A packages[f.publisher].append(f)

2301N/A

2301N/A for pub in packages:

2301N/A logger.info(_("Removing packages for publisher %s ...") % pub)

2301N/A repo.remove_packages(packages[pub], progtrack=progtrack,

2301N/A pub=pub)

2301N/A if len(packages) > 1:

2301N/A # Add a newline between each publisher.

2301N/A logger.info("")

2301N/A

2301N/A return EXIT_OK

2301N/A

2301N/A

2990N/Adef get_repo(conf, allow_invalid=False, read_only=True, subcommand=None):

2990N/A """Return the repository object for current program configuration.

2028N/A

2028N/A repo_uri = conf["repo_uri"]

2028N/A if repo_uri.scheme != "file":

2028N/A usage(_("Network repositories are not currently supported "

2028N/A "for this operation."), cmd=subcommand)

2028N/A

2028N/A path = repo_uri.get_pathname()

2028N/A if not path:

2028N/A # Bad URI?

2028N/A raise sr.RepositoryInvalidError(str(repo_uri))

2990N/A return sr.Repository(allow_invalid=allow_invalid, read_only=read_only,

2990N/A root=path)

2028N/A

2028N/A

3140N/Adef setup_transport(conf, subcommand=None, prefix=None, verbose=False,

3140N/A remote_prefix=True, ssl_key=None, ssl_cert=None):

2028N/A repo_uri = conf.get("repo_uri", None)

2028N/A if not repo_uri:

2028N/A usage(_("No repository location specified."), cmd=subcommand)

2028N/A

3041N/A global tmpdirs

2028N/A temp_root = misc.config_temp_root()

2028N/A

2028N/A tmp_dir = tempfile.mkdtemp(dir=temp_root)

2028N/A tmpdirs.append(tmp_dir)

2028N/A

2028N/A incoming_dir = tempfile.mkdtemp(dir=temp_root)

2028N/A tmpdirs.append(incoming_dir)

2028N/A

2028N/A cache_dir = tempfile.mkdtemp(dir=temp_root)

2028N/A tmpdirs.append(cache_dir)

2028N/A

2028N/A # Create transport and transport config.

2028N/A xport, xport_cfg = transport.setup_transport()

2073N/A xport_cfg.add_cache(cache_dir, readonly=False)

2073N/A xport_cfg.incoming_root = incoming_dir

3041N/A xport_cfg.pkg_root = tmp_dir

2028N/A

3140N/A if not prefix:

3140N/A pub = "target"

3140N/A else:

3140N/A pub = prefix

3140N/A

2028N/A # Configure target publisher.

3140N/A src_pub = transport.setup_publisher(str(repo_uri), pub, xport,

3140N/A xport_cfg, remote_prefix=remote_prefix, ssl_key=ssl_key,

3140N/A ssl_cert=ssl_cert)

2028N/A

2028N/A return xport, src_pub, tmp_dir

2028N/A

1968N/A

2142N/Adef subcmd_add_publisher(conf, args):

2142N/A """Add publisher(s) to the specified repository."""

2142N/A

2142N/A subcommand = "add-publisher"

2142N/A

2142N/A opts, pargs = getopt.getopt(args, "s:")

2142N/A for opt, arg in opts:

2142N/A if opt == "-s":

2142N/A conf["repo_uri"] = parse_uri(arg)

2142N/A

2142N/A repo_uri = conf.get("repo_uri", None)

2142N/A if not repo_uri:

2142N/A usage(_("No repository location specified."), cmd=subcommand)

2142N/A if repo_uri.scheme != "file":

2142N/A usage(_("Network repositories are not currently supported "

2142N/A "for this operation."), cmd=subcommand)

2142N/A

2142N/A if not pargs:

2142N/A usage(_("At least one publisher must be specified"),

2142N/A cmd=subcommand)

2142N/A

2142N/A abort = False

2142N/A for pfx in pargs:

2142N/A if not misc.valid_pub_prefix(pfx):

2142N/A error(_("Invalid publisher prefix '%s'") % pfx,

2142N/A cmd=subcommand)

2142N/A abort = True

2142N/A if abort:

2142N/A return EXIT_OOPS

2142N/A

2142N/A repo = get_repo(conf, read_only=False, subcommand=subcommand)

2142N/A make_default = not repo.publishers

2142N/A existing = repo.publishers & set(pargs)

2142N/A

2142N/A # Elide the publishers that already exist, but retain the order

2142N/A # publishers were specified in.

2142N/A new_pubs = [

2142N/A pfx for pfx in pargs

2142N/A if pfx not in repo.publishers

2142N/A ]

2142N/A

2142N/A # Tricky logic; _set_pub will happily add new publishers if necessary

2142N/A # and not set any properties if you didn't specify any.

2142N/A rval = _set_pub(conf, subcommand, {}, new_pubs, repo)

2142N/A

2142N/A if make_default:

2142N/A # No publisher existed previously, so set the default publisher

2142N/A # to be the first new one that was added.

2142N/A _set_repo(conf, subcommand, { "publisher": {

2142N/A "prefix": new_pubs[0] } }, repo)

2142N/A

2142N/A if rval == EXIT_OK and existing:

2142N/A # Some of the publishers that were requested for addition

2142N/A # were already known.

2142N/A error(_("specified publisher(s) already exist: %s") %

2142N/A ", ".join(existing), cmd=subcommand)

2142N/A if new_pubs:

2142N/A return EXIT_PARTIAL

2142N/A return EXIT_OOPS

2142N/A return rval

2142N/A

2970N/Adef subcmd_remove_publisher(conf, args):

2970N/A """Remove publisher(s) from a repository"""

2970N/A

2970N/A subcommand = "remove-publisher"

2970N/A

2970N/A dry_run = False

2970N/A synch = False

2970N/A opts, pargs = getopt.getopt(args, "ns:", ["synchronous"])

2970N/A for opt, arg in opts:

2970N/A if opt == "-s":

2970N/A conf["repo_uri"] = parse_uri(arg)

2970N/A elif opt == "-n":

2970N/A dry_run = True

2970N/A elif opt == "--synchronous":

2970N/A synch = True

2970N/A repo_uri = conf.get("repo_uri", None)

2970N/A if not repo_uri:

2970N/A usage(_("No repository location specified."), cmd=subcommand)

2970N/A if repo_uri.scheme != "file":

2970N/A usage(_("Network repositories are not currently supported "

2970N/A "for this operation."), cmd=subcommand)

2970N/A

2970N/A if not pargs:

2970N/A usage(_("At least one publisher must be specified"),

2970N/A cmd=subcommand)

2970N/A

2970N/A inv_pfxs = []

2970N/A for pfx in pargs:

2970N/A if not misc.valid_pub_prefix(pfx):

2970N/A inv_pfxs.append(pfx)

2970N/A

2970N/A if inv_pfxs:

2970N/A error(_("Invalid publisher prefix(es):\n %s") %

2970N/A "\n ".join(inv_pfxs), cmd=subcommand)

2970N/A return EXIT_OOPS

2970N/A

2970N/A repo = get_repo(conf, read_only=False, subcommand=subcommand)

2970N/A existing = repo.publishers & set(pargs)

2970N/A noexisting = [pfx for pfx in pargs

2970N/A if pfx not in repo.publishers]

2970N/A # Publishers left if remove succeeds.

2970N/A left = [pfx for pfx in repo.publishers if pfx not in pargs]

2970N/A

2970N/A if noexisting:

2970N/A error(_("The following publisher(s) could not be found:\n %s")

2970N/A % "\n ".join(noexisting), cmd=subcommand)

2970N/A return EXIT_OOPS

2970N/A

2970N/A logger.info(_("Removing publisher(s)"))

2970N/A for pfx in existing:

2970N/A rstore = repo.get_pub_rstore(pfx)

2970N/A numpkg = rstore.catalog.package_count

2970N/A logger.info(_("\'%(pfx)s\'\t(%(num)s package(s))") %

2970N/A {"pfx":pfx, "num":str(numpkg)})

2970N/A

2970N/A if dry_run:

2970N/A return EXIT_OK

2970N/A

2970N/A defaultpfx = repo.cfg.get_property("publisher", "prefix")

2970N/A repo_path = repo_uri.get_pathname()

2970N/A

2970N/A repo.remove_publisher(existing, repo_path, synch)

2970N/A # Change the repository publisher/prefix property, if necessary.

2970N/A if defaultpfx in existing:

2970N/A if len(left) == 1:

2970N/A _set_repo(conf, subcommand, { "publisher" : {

2970N/A "prefix" : left[0]} }, repo)

2970N/A msg(_("The default publisher was removed."

2970N/A " Setting 'publisher/prefix' to '%s',"

2970N/A " the only publisher left") % left[0])

2970N/A else:

2970N/A _set_repo(conf, subcommand, { "publisher": {

2970N/A "prefix" : ""} }, repo)

2970N/A msg(_("The default publisher was removed."

2970N/A " The 'publisher/prefix' property has been"

2970N/A " unset"))

2970N/A

2970N/A return EXIT_OK

2142N/A

2028N/Adef subcmd_create(conf, args):

2028N/A """Create a package repository at the given location."""

2028N/A

2028N/A subcommand = "create"

2028N/A

2028N/A opts, pargs = getopt.getopt(args, "s:", ["version="])

2028N/A

2028N/A version = None

2028N/A for opt, arg in opts:

2028N/A if opt == "-s":

2028N/A conf["repo_uri"] = parse_uri(arg)

2028N/A elif opt == "--version":

2028N/A # This option is currently private and allows creating a

2028N/A # repository with a specific format based on version.

2028N/A try:

2028N/A version = int(arg)

2028N/A except ValueError:

2028N/A usage(_("Version must be an integer value."),

2028N/A cmd=subcommand)

1968N/A

2028N/A if len(pargs) > 1:

2028N/A usage(_("Only one repository location may be specified."),

2028N/A cmd=subcommand)

2028N/A elif pargs:

2028N/A conf["repo_uri"] = parse_uri(pargs[0])

2028N/A

2028N/A repo_uri = conf.get("repo_uri", None)

2028N/A if not repo_uri:

2028N/A usage(_("No repository location specified."), cmd=subcommand)

2028N/A if repo_uri.scheme != "file":

2028N/A usage(_("Network repositories are not currently supported "

2028N/A "for this operation."), cmd=subcommand)

2028N/A

2028N/A # Attempt to create a repository at the specified location. Allow

2028N/A # whatever exceptions are raised to bubble up.

2028N/A sr.repository_create(repo_uri, version=version)

2028N/A

2028N/A return EXIT_OK

2028N/A

2028N/A

2028N/Adef subcmd_get(conf, args):

2028N/A """Display repository properties."""

2028N/A

2028N/A subcommand = "get"

1968N/A omit_headers = False

1968N/A out_format = "default"

2028N/A pubs = set()

2864N/A key = None

2864N/A cert = None

1968N/A

2864N/A opts, pargs = getopt.getopt(args, "F:Hp:s:", ["key=", "cert="])

1968N/A for opt, arg in opts:

1968N/A if opt == "-F":

3031N/A if arg not in LISTING_FORMATS:

3031N/A raise apx.InvalidOptionError(

3031N/A apx.InvalidOptionError.ARG_INVALID,

3031N/A [arg, opt])

1968N/A out_format = arg

1968N/A elif opt == "-H":

1968N/A omit_headers = True

2028N/A elif opt == "-p":

2028N/A pubs.add(arg)

2028N/A elif opt == "-s":

2028N/A conf["repo_uri"] = parse_uri(arg)

2864N/A elif opt == "--key":

2864N/A key = arg

2864N/A elif opt == "--cert":

2864N/A cert = arg

2028N/A

2028N/A # Setup transport so configuration can be retrieved.

2028N/A if not conf.get("repo_uri", None):

2028N/A usage(_("A package repository location must be provided "

2028N/A "using -s."), cmd=subcommand)

2864N/A xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand,

2864N/A ssl_key=key, ssl_cert=cert)

2028N/A

2028N/A # Get properties.

2028N/A if pubs:

2028N/A return _get_pub(conf, subcommand, xport, xpub, omit_headers,

2028N/A out_format, pubs, pargs)

2028N/A return _get_repo(conf, subcommand, xport, xpub, omit_headers,

2028N/A out_format, pargs)

2028N/A

2028N/A

2028N/Adef _get_repo(conf, subcommand, xport, xpub, omit_headers, out_format, pargs):

2028N/A """Display repository properties."""

1968N/A

1968N/A # Configuration index is indexed by section name and property name.

2028N/A # Retrieve and flatten it to simplify listing process.

2028N/A stat_idx = xport.get_status(xpub)

2028N/A cfg_idx = stat_idx.get("repository", {}).get("configuration", {})

1968N/A props = set()

1968N/A

1968N/A # Set minimum widths for section and property name columns by using the

1968N/A # length of the column headers.

1968N/A max_sname_len = len(_("SECTION"))

1968N/A max_pname_len = len(_("PROPERTY"))

1968N/A

1968N/A for sname in cfg_idx:

1968N/A max_sname_len = max(max_sname_len, len(sname))

1968N/A for pname in cfg_idx[sname]:

1968N/A max_pname_len = max(max_pname_len, len(pname))

1968N/A props.add("/".join((sname, pname)))

1968N/A

2028N/A req_props = set(pargs)

2028N/A if len(req_props) >= 1:

2028N/A found = props & req_props

2028N/A notfound = req_props - found

1968N/A del props

1968N/A else:

1968N/A found = props

1968N/A notfound = set()

1968N/A

1968N/A def gen_listing():

1968N/A for prop in sorted(found):

1968N/A sname, pname = prop.rsplit("/", 1)

2028N/A sval = cfg_idx[sname][pname]

1968N/A yield {

1968N/A "section": sname,

1968N/A "property": pname,

1968N/A "value": sval,

1968N/A }

1968N/A

1968N/A # SECTION PROPERTY VALUE

1968N/A # <sec_1> <prop_1> <prop_1_value>

1968N/A # <sec_2> <prop_2> <prop_2_value>

1968N/A # ...

1968N/A field_data = {

2510N/A "section" : [("default", "json", "tsv"), _("SECTION"), ""],

2510N/A "property" : [("default", "json", "tsv"), _("PROPERTY"), ""],

2510N/A "value" : [("default", "json", "tsv"), _("VALUE"), ""],

1968N/A }

2510N/A desired_field_order = (_("SECTION"), _("PROPERTY"), _("VALUE"))

1968N/A

1968N/A # Default output formatting.

1968N/A def_fmt = "%-" + str(max_sname_len) + "s %-" + str(max_pname_len) + \

1968N/A "s %s"

1968N/A

2028N/A if found or (not req_props and out_format == "default"):

2453N/A # print without trailing newline.

2510N/A sys.stdout.write(misc.get_listing(desired_field_order,

2453N/A field_data, gen_listing(), out_format, def_fmt,

2453N/A omit_headers))

1968N/A

1968N/A if found and notfound:

1968N/A return EXIT_PARTIAL

2028N/A if req_props and not found:

1968N/A if out_format == "default":

1968N/A # Don't pollute other output formats.

1968N/A error(_("no matching properties found"),

1968N/A cmd=subcommand)

1968N/A return EXIT_OOPS

1968N/A return EXIT_OK

1968N/A

1968N/A

2510N/Adef _get_matching_pubs(subcommand, pubs, xport, xpub, out_format="default",

2510N/A use_transport=False):

1968N/A

2028N/A # Retrieve publisher information.

2028N/A pub_data = xport.get_publisherdata(xpub)

2028N/A known_pubs = set(p.prefix for p in pub_data)

2028N/A if len(pubs) > 0 and "all" not in pubs:

2028N/A found = known_pubs & pubs

2028N/A notfound = pubs - found

2510N/A pub_data = [p for p in pub_data if p.prefix in found]

1968N/A else:

2028N/A found = known_pubs

2028N/A notfound = set()

2028N/A

2510N/A if use_transport:

2510N/A # Assign transport information.

2510N/A for p in pub_data:

2510N/A p.repository = xpub.repository

2510N/A

2028N/A # Establish initial return value and perform early exit if appropriate.

2028N/A rval = EXIT_OK

2028N/A if found and notfound:

2028N/A rval = EXIT_PARTIAL

2028N/A elif pubs and not found:

2028N/A if out_format == "default":

2028N/A # Don't pollute other output formats.

2028N/A error(_("no matching publishers found"),

2028N/A cmd=subcommand)

2132N/A return EXIT_OOPS, None, None

2132N/A return rval, found, pub_data

2132N/A

2132N/A

2132N/Adef _get_pub(conf, subcommand, xport, xpub, omit_headers, out_format, pubs,

2132N/A pargs):

2132N/A """Display publisher properties."""

2132N/A

2132N/A rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

2132N/A xpub, out_format=out_format)

2132N/A if rval == EXIT_OOPS:

2132N/A return rval

2028N/A

2028N/A # Set minimum widths for section and property name columns by using the

2028N/A # length of the column headers and data.

2028N/A max_pubname_len = str(max(

2028N/A [len(_("PUBLISHER"))] + [len(p) for p in found]

2028N/A ))

2028N/A max_sname_len = len(_("SECTION"))

2028N/A max_pname_len = len(_("PROPERTY"))

2028N/A

2028N/A # For each requested publisher, retrieve the requested property data.

2028N/A pub_idx = {}

2028N/A for pub in pub_data:

2028N/A pub_idx[pub.prefix] = {

2028N/A "publisher": {

2028N/A "alias": pub.alias,

2028N/A "prefix": pub.prefix,

2028N/A },

2028N/A }

2028N/A

2310N/A pub_repo = pub.repository

2028N/A if pub_repo:

2028N/A pub_idx[pub.prefix]["repository"] = {

2028N/A "collection-type": pub_repo.collection_type,

2028N/A "description": pub_repo.description,

2028N/A "legal-uris": pub_repo.legal_uris,

2028N/A "mirrors": pub_repo.mirrors,

2028N/A "name": pub_repo.name,

2028N/A "origins": pub_repo.origins,

2028N/A "refresh-seconds": pub_repo.refresh_seconds,

2028N/A "registration-uri": pub_repo.registration_uri,

2028N/A "related-uris": pub_repo.related_uris,

2028N/A }

2028N/A else:

2028N/A pub_idx[pub.prefix]["repository"] = {

2028N/A "collection-type": "core",

2028N/A "description": "",

2028N/A "legal-uris": [],

2028N/A "mirrors": [],

2028N/A "name": "",

2028N/A "origins": [],

2028N/A "refresh-seconds": "",

2028N/A "registration-uri": "",

2028N/A "related-uris": [],

2028N/A }

1968N/A

2028N/A # Determine possible set of properties and lengths.

2028N/A props = set()

2028N/A for pub in pub_idx:

2073N/A for sname in pub_idx[pub]:

2073N/A max_sname_len = max(max_sname_len, len(sname))

2073N/A for pname in pub_idx[pub][sname]:

2073N/A max_pname_len = max(max_pname_len, len(pname))

2073N/A props.add("/".join((sname, pname)))

2028N/A

2028N/A # Determine properties to display.

2028N/A req_props = set(pargs)

2028N/A if len(req_props) >= 1:

2028N/A found = props & req_props

2028N/A notfound = req_props - found

2028N/A del props

2028N/A else:

2028N/A found = props

2028N/A notfound = set()

2028N/A

2028N/A def gen_listing():

2028N/A for pub in sorted(pub_idx.keys()):

2028N/A for prop in sorted(found):

2028N/A sname, pname = prop.rsplit("/", 1)

2028N/A sval = pub_idx[pub][sname][pname]

2028N/A yield {

2028N/A "publisher": pub,

2028N/A "section": sname,

2028N/A "property": pname,

2028N/A "value": sval,

2028N/A }

1968N/A

2028N/A # PUBLISHER SECTION PROPERTY VALUE

2028N/A # <pub_1> <sec_1> <prop_1> <prop_1_value>

2028N/A # <pub_1> <sec_2> <prop_2> <prop_2_value>

2028N/A # ...

2028N/A field_data = {

2510N/A "publisher" : [("default", "json", "tsv"), _("PUBLISHER"), ""],

2510N/A "section" : [("default", "json", "tsv"), _("SECTION"), ""],

2510N/A "property" : [("default", "json", "tsv"), _("PROPERTY"), ""],

2510N/A "value" : [("default", "json", "tsv"), _("VALUE"), ""],

2028N/A }

2028N/A desired_field_order = (_("PUBLISHER"), _("SECTION"), _("PROPERTY"),

2028N/A _("VALUE"))

1968N/A

2028N/A # Default output formatting.

2028N/A def_fmt = "%-" + str(max_pubname_len) + "s %-" + str(max_sname_len) + \

2028N/A "s %-" + str(max_pname_len) + "s %s"

2028N/A

2028N/A if found or (not req_props and out_format == "default"):

2453N/A # print without trailing newline.

2510N/A sys.stdout.write(misc.get_listing(desired_field_order,

2453N/A field_data, gen_listing(), out_format, def_fmt,

2453N/A omit_headers))

2028N/A

2028N/A if found and notfound:

2028N/A rval = EXIT_PARTIAL

2028N/A if req_props and not found:

2028N/A if out_format == "default":

2028N/A # Don't pollute other output formats.

2028N/A error(_("no matching properties found"),

2028N/A cmd=subcommand)

2028N/A rval = EXIT_OOPS

2028N/A return rval

1968N/A

1968N/A

2028N/Adef subcmd_info(conf, args):

1968N/A """Display a list of known publishers and a summary of known packages

1968N/A

2028N/A subcommand = "info"

1968N/A omit_headers = False

1968N/A out_format = "default"

2028N/A pubs = set()

2864N/A key = None

2864N/A cert = None

1968N/A

2864N/A opts, pargs = getopt.getopt(args, "F:Hp:s:", ["key=", "cert="])

1968N/A for opt, arg in opts:

1968N/A if opt == "-F":

2028N/A if arg not in LISTING_FORMATS:

3031N/A raise apx.InvalidOptionError(

3031N/A apx.InvalidOptionError.ARG_INVALID,

3031N/A [arg, opt])

2028N/A out_format = arg

1968N/A elif opt == "-H":

1968N/A omit_headers = True

2028N/A elif opt == "-p":

2028N/A pubs.add(arg)

2028N/A elif opt == "-s":

2028N/A conf["repo_uri"] = parse_uri(arg)

2864N/A elif opt == "--key":

2864N/A key = arg

2864N/A elif opt == "--cert":

2864N/A cert = arg

1968N/A

2028N/A if pargs:

2028N/A usage(_("command does not take operands"), cmd=subcommand)

1968N/A

2028N/A # Setup transport so status can be retrieved.

2028N/A if not conf.get("repo_uri", None):

2028N/A usage(_("A package repository location must be provided "

2028N/A "using -s."), cmd=subcommand)

2864N/A xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand,

2864N/A ssl_key=key, ssl_cert=cert)

2028N/A

2028N/A # Retrieve repository status information.

2028N/A stat_idx = xport.get_status(xpub)

2028N/A pub_idx = stat_idx.get("repository", {}).get("publishers", {})

2028N/A if len(pubs) > 0 and "all" not in pubs:

2028N/A found = set(pub_idx.keys()) & pubs

2028N/A notfound = pubs - found

1968N/A else:

1968N/A found = set(pub_idx.keys())

1968N/A notfound = set()

1968N/A

1968N/A def gen_listing():

1968N/A for pfx in found:

2028N/A pdata = pub_idx[pfx]

2028N/A pkg_count = pdata.get("package-count", 0)

2028N/A last_update = pdata.get("last-catalog-update", "")

2028N/A if last_update:

2028N/A # Reformat the date into something more user

2028N/A # friendly (and locale specific).

2028N/A last_update = pkg.catalog.basic_ts_to_datetime(

2028N/A last_update)

2028N/A last_update = "%sZ" % pkg.catalog.datetime_to_ts(

2028N/A last_update)

2028N/A rstatus = _(pub_idx[pfx].get("status", "online"))

1968N/A yield {

1968N/A "publisher": pfx,

1968N/A "packages": pkg_count,

2028N/A "status": rstatus,

2028N/A "updated": last_update,

1968N/A }

1968N/A

2028N/A # PUBLISHER PACKAGES STATUS UPDATED

2028N/A # <pub_1> <num_uniq_pkgs> <status> <cat_last_modified>

2028N/A # <pub_2> <num_uniq_pkgs> <status> <cat_last_modified>

1968N/A # ...

1968N/A field_data = {

2510N/A "publisher" : [("default", "json", "tsv"), _("PUBLISHER"), ""],

2510N/A "packages" : [("default", "json", "tsv"), _("PACKAGES"), ""],

2510N/A "status" : [("default", "json", "tsv"), _("STATUS"), ""],

2510N/A "updated" : [("default", "json", "tsv"), _("UPDATED"), ""],

1968N/A }

1968N/A

2028N/A desired_field_order = (_("PUBLISHER"), "", _("PACKAGES"), _("STATUS"),

1968N/A _("UPDATED"))

1968N/A

1968N/A # Default output formatting.

2028N/A pub_len = str(max(

2028N/A [len(desired_field_order[0])] + [len(p) for p in found]

2028N/A ))

2028N/A def_fmt = "%-" + pub_len + "s %-8s %-16s %s"

1968N/A

2028N/A if found or (not pubs and out_format == "default"):

2453N/A # print without trailing newline.

2510N/A sys.stdout.write(misc.get_listing(desired_field_order,

2453N/A field_data, gen_listing(), out_format, def_fmt,

2453N/A omit_headers))

1968N/A

1968N/A if found and notfound:

1968N/A return EXIT_PARTIAL

2028N/A if pubs and not found:

1968N/A if out_format == "default":

1968N/A # Don't pollute other output formats.

1968N/A error(_("no matching publishers found"),

1968N/A cmd=subcommand)

1968N/A return EXIT_OOPS

1968N/A return EXIT_OK

1968N/A

2510N/Adef subcmd_list(conf, args):

2510N/A """List all packages matching the specified patterns."""

2510N/A

2510N/A subcommand = "list"

2510N/A omit_headers = False

2510N/A out_format = "default"

2510N/A pubs = set()

2864N/A key = None

2864N/A cert = None

2510N/A

2864N/A opts, pargs = getopt.getopt(args, "F:Hp:s:", ["key=", "cert="])

2510N/A for opt, arg in opts:

2510N/A if opt == "-F":

3031N/A if arg not in LISTING_FORMATS:

3031N/A raise apx.InvalidOptionError(

3031N/A apx.InvalidOptionError.ARG_INVALID,

3031N/A [arg, opt])

2510N/A out_format = arg

2510N/A elif opt == "-H":

2510N/A omit_headers = True

2510N/A elif opt == "-p":

2510N/A pubs.add(arg)

2510N/A elif opt == "-s":

2510N/A conf["repo_uri"] = parse_uri(arg)

2864N/A elif opt == "--key":

2864N/A key = arg

2864N/A elif opt == "--cert":

2864N/A cert = arg

2864N/A

2510N/A

2510N/A # Setup transport so configuration can be retrieved.

2510N/A if not conf.get("repo_uri", None):

2510N/A usage(_("A package repository location must be provided "

2510N/A "using -s."), cmd=subcommand)

2864N/A xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand,

2864N/A ssl_key=key, ssl_cert=cert)

2510N/A

2510N/A rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

2510N/A xpub, out_format=out_format, use_transport=True)

2510N/A if rval == EXIT_OOPS:

2510N/A return rval

2510N/A

3041N/A refresh_pub(pub_data, xport)

2510N/A listed = {}

2510N/A matched = set()

2510N/A unmatched = set()

2510N/A

2510N/A def gen_listing():

2510N/A collect_attrs = out_format.startswith("json")

2510N/A for pub in pub_data:

2510N/A cat = pub.catalog

2510N/A for f, states, attrs in cat.gen_packages(

2510N/A collect_attrs=collect_attrs, matched=matched,

2510N/A patterns=pargs, pubs=[pub.prefix],

2510N/A unmatched=unmatched, return_fmris=True):

2510N/A if not listed:

2510N/A listed["packages"] = True

2510N/A

2510N/A state = None

2510N/A if out_format == "default" or \

2510N/A out_format == "tsv":

2616N/A if pkgdefs.PKG_STATE_OBSOLETE in \

2616N/A states:

2510N/A state = "o"

2616N/A elif pkgdefs.PKG_STATE_RENAMED in \

2616N/A states:

2510N/A state = "r"

2510N/A

2958N/A if out_format == "default":

2958N/A fver = str(f.version.get_version(

2958N/A include_build=False))

2958N/A ffmri = str(f.get_fmri(include_build=False))

2958N/A else:

2958N/A fver = str(f.version)

2958N/A ffmri = str(f)

2958N/A

2510N/A ret = {

2510N/A "publisher": f.publisher,

2510N/A "name": f.pkg_name,

2958N/A "version": fver,

2510N/A "release": str(f.version.release),

2510N/A "build-release":

2510N/A str(f.version.build_release),

2510N/A "branch": str(f.version.branch),

2510N/A "timestamp":

2510N/A str(f.version.timestr),

2958N/A "pkg.fmri": ffmri,

2510N/A "short_state": state,

2510N/A }

2510N/A

2510N/A for attr in attrs:

2510N/A ret[attr] = []

2510N/A for mods in attrs[attr]:

2510N/A d = dict(mods)

2510N/A d["value"] = \

2510N/A attrs[attr][mods]

2510N/A ret[attr].append(d)

2510N/A yield ret

2510N/A

2510N/A unmatched.difference_update(matched)

2510N/A

2510N/A field_data = {

2510N/A "publisher": [("default", "json", "tsv"), _("PUBLISHER"), ""],

2510N/A "name": [("default", "json", "tsv"), _("NAME"), ""],

2510N/A "version": [("default", "json"), _("VERSION"), ""],

2510N/A "release": [("json", "tsv",), _("RELEASE"), ""],

2510N/A "build-release": [("json", "tsv",), _("BUILD RELEASE"), ""],

2510N/A "branch": [("json", "tsv",), _("BRANCH"), ""],

2510N/A "timestamp": [("json", "tsv",), _("PACKAGING DATE"), ""],

2510N/A "pkg.fmri": [("json", "tsv",), _("FMRI"), ""],

2510N/A "short_state": [("default", "tsv"), "O", ""],

2510N/A }

2510N/A

2510N/A desired_field_order = (_("PUBLISHER"), _("NAME"), "O", _("VERSION"),

2510N/A _("SUMMARY"), _("DESCRIPTION"), _("CATEGORIES"), _("RELEASE"),

2510N/A _("BUILD RELEASE"), _("BRANCH"), _("PACKAGING DATE"), _("FMRI"),

2510N/A _("STATE"))

2510N/A

2510N/A # Default output formatting.

2510N/A max_pub_name_len = str(

2510N/A max(list(len(p) for p in found) + [len(_("PUBLISHER"))]))

2510N/A def_fmt = "%-" + max_pub_name_len + "s %-45s %-1s %-s"

2510N/A

2510N/A # print without trailing newline.

2510N/A sys.stdout.write(misc.get_listing(

2510N/A desired_field_order, field_data, gen_listing(),

2510N/A out_format, def_fmt, omit_headers))

2510N/A

2510N/A if not listed and pargs:

2510N/A # No matching packages.

2510N/A logger.error("")

2510N/A if not unmatched:

2510N/A unmatched = pargs

2510N/A error(apx.PackageMatchErrors(unmatched_fmris=unmatched),

2510N/A cmd=subcommand)

2510N/A return EXIT_OOPS

2510N/A elif unmatched:

2510N/A # One or more patterns didn't match a package from any

2510N/A # publisher; only display the error.

2510N/A logger.error("")

2510N/A error(apx.PackageMatchErrors(unmatched_fmris=unmatched),

2510N/A cmd=subcommand)

2510N/A return EXIT_PARTIAL

2510N/A

2510N/A return EXIT_OK

2510N/A

1968N/A

3041N/Adef refresh_pub(pub_data, xport):

3041N/A """A helper function to refresh all specified publishers."""

3041N/A

3041N/A global tmpdirs

3041N/A temp_root = misc.config_temp_root()

3041N/A progtrack = get_tracker()

3041N/A progtrack.set_purpose(progtrack.PURPOSE_LISTING)

3041N/A

3041N/A progtrack.refresh_start(pub_cnt=len(pub_data), full_refresh=True,

3041N/A target_catalog=False)

3041N/A

3041N/A for pub in pub_data:

3041N/A progtrack.refresh_start_pub(pub)

3041N/A meta_root = tempfile.mkdtemp(dir=temp_root)

3041N/A tmpdirs.append(meta_root)

3041N/A pub.meta_root = meta_root

3041N/A pub.transport = xport

3041N/A

3041N/A try:

3041N/A pub.refresh(True, True, progtrack=progtrack)

3041N/A except apx.TransportError:

3041N/A # Assume that a catalog doesn't exist for the target

3041N/A # publisher and drive on.

3041N/A pass

3041N/A progtrack.refresh_end_pub(pub)

3041N/A

3041N/A progtrack.refresh_done()

3041N/A

3041N/A

3041N/Adef subcmd_contents(conf, args):

3041N/A """List package contents."""

3041N/A

3041N/A subcommand = "contents"

3041N/A display_raw = False

3041N/A pubs = set()

3041N/A key = None

3041N/A cert = None

3041N/A attrs = []

3041N/A action_types = []

3041N/A

3041N/A opts, pargs = getopt.getopt(args, "ms:t:", ["key=", "cert="])

3041N/A for opt, arg in opts:

3041N/A if opt == "-s":

3041N/A conf["repo_uri"] = parse_uri(arg)

3041N/A elif opt == "-m":

3041N/A display_raw = True

3041N/A elif opt == "-t":

3041N/A action_types.extend(arg.split(","))

3041N/A elif opt == "--key":

3041N/A key = arg

3041N/A elif opt == "--cert":

3041N/A cert = arg

3041N/A

3041N/A # Setup transport so configuration can be retrieved.

3041N/A if not conf.get("repo_uri", None):

3041N/A usage(_("A package repository location must be provided "

3041N/A "using -s."), cmd=subcommand)

3041N/A

3041N/A xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand,

3041N/A ssl_key=key, ssl_cert=cert)

3041N/A

3041N/A rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

3041N/A xpub, use_transport=True)

3041N/A if rval == EXIT_OOPS:

3041N/A return rval

3041N/A

3041N/A # Default output prints out the raw manifest. The -m option is implicit

3138N/A # for now and supported to make the interface equivalent to pkg

3138N/A # contents.

3041N/A if not attrs or display_raw:

3041N/A attrs = ["action.raw"]

3041N/A

3041N/A refresh_pub(pub_data, xport)

3041N/A listed = False

3041N/A matched = set()

3041N/A unmatched = set()

3041N/A manifests = []

3041N/A

3041N/A for pub in pub_data:

3041N/A cat = pub.catalog

3041N/A for f, states, attr in cat.gen_packages(matched=matched,

3041N/A patterns=pargs, pubs=[pub.prefix],

3041N/A unmatched=unmatched, return_fmris=True):

3041N/A if not listed:

3041N/A listed = True

3041N/A manifests.append(xport.get_manifest(f))

3041N/A unmatched.difference_update(matched)

3041N/A

3041N/A # Build a generator expression based on whether specific action types

3041N/A # were provided.

3041N/A if action_types:

3041N/A # If query is limited to specific action types, use the more

3041N/A # efficient type-based generation mechanism.

3041N/A gen_expr = (

3041N/A (m.fmri, a, None, None, None)

3041N/A for m in manifests

3041N/A for a in m.gen_actions_by_types(action_types)

3041N/A )

3041N/A else:

3041N/A gen_expr = (

3041N/A (m.fmri, a, None, None, None)

3041N/A for m in manifests

3041N/A for a in m.gen_actions()

3041N/A )

3041N/A

3041N/A # Determine if the query returned any results by "peeking" at the first

3041N/A # value returned from the generator expression.

3041N/A try:

3041N/A got = gen_expr.next()

3041N/A except StopIteration:

3041N/A got = None

3041N/A actionlist = []

3041N/A

3041N/A if got:

3041N/A actionlist = itertools.chain([got], gen_expr)

3041N/A

3041N/A rval = EXIT_OK

3041N/A if action_types and manifests and not got:

3041N/A logger.error(_(gettext.ngettext("""\

3041N/Ausing the -t option""", """\

3041N/Ausing the -t option.""", len(pargs))))

3041N/A rval = EXIT_OOPS

3041N/A

3041N/A if manifests and rval == EXIT_OK:

3041N/A lines = misc.list_actions_by_attrs(actionlist, attrs)

3041N/A for line in lines:

3041N/A text = ("%s" % tuple(line)).rstrip()

3041N/A if not text:

3041N/A continue

3041N/A msg(text)

3041N/A

3041N/A if unmatched:

3041N/A if manifests:

3041N/A logger.error("")

3041N/A logger.error(_("""\

3041N/Awere found in the repository."""))

3041N/A logger.error("")

3041N/A for p in unmatched:

3041N/A logger.error(" %s" % p)

3041N/A rval = EXIT_OOPS

3041N/A

3041N/A return rval

3041N/A

3041N/A

2990N/Adef __rebuild_local(subcommand, conf, pubs, build_catalog, build_index):

2990N/A """In an attempt to allow operations on potentially corrupt

2990N/A

2990N/A repo = get_repo(conf, allow_invalid=build_catalog, read_only=False,

2990N/A subcommand=subcommand)

2990N/A

2990N/A rpubs = set(repo.publishers)

2990N/A if not pubs:

2990N/A found = rpubs

2990N/A else:

2990N/A found = rpubs & pubs

2990N/A notfound = pubs - found

2990N/A

2990N/A rval = EXIT_OK

2990N/A if found and notfound:

2990N/A rval = EXIT_PARTIAL

2990N/A elif pubs and not found:

2990N/A error(_("no matching publishers found"), cmd=subcommand)

2990N/A return EXIT_OOPS

2990N/A

2990N/A logger.info("Initiating repository rebuild.")

2990N/A for pfx in found:

2990N/A repo.rebuild(build_catalog=build_catalog,

2990N/A build_index=build_index, pub=pfx)

2990N/A

2990N/A return rval

2990N/A

2990N/A

2990N/Adef __rebuild_remote(subcommand, conf, pubs, key, cert, build_catalog,

2990N/A build_index):

2990N/A def do_rebuild(xport, xpub):

2990N/A if build_catalog and build_index:

2990N/A xport.publish_rebuild(xpub)

2990N/A elif build_catalog:

2990N/A xport.publish_rebuild_packages(xpub)

2990N/A elif build_index:

2990N/A xport.publish_rebuild_indexes(xpub)

2990N/A

2990N/A xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand,

2990N/A ssl_key=key, ssl_cert=cert)

2990N/A rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

2990N/A xpub)

2990N/A if rval == EXIT_OOPS:

2990N/A return rval

2990N/A

2990N/A logger.info("Initiating repository rebuild.")

2990N/A for pfx in found:

2990N/A xpub.prefix = pfx

2990N/A do_rebuild(xport, xpub)

2990N/A

2990N/A return rval

2990N/A

2990N/A

1968N/Adef subcmd_rebuild(conf, args):

1968N/A """Rebuild the repository's catalog and index data (as permitted)."""

1968N/A

1968N/A subcommand = "rebuild"

2028N/A build_catalog = True

1968N/A build_index = True

2864N/A key = None

2864N/A cert = None

2028N/A

2864N/A opts, pargs = getopt.getopt(args, "p:s:", ["no-catalog", "no-index",

2864N/A "key=", "cert="])

2132N/A pubs = set()

1968N/A for opt, arg in opts:

2132N/A if opt == "-p":

2132N/A if not misc.valid_pub_prefix(arg):

2132N/A error(_("Invalid publisher prefix '%s'") % arg,

2132N/A cmd=subcommand)

2132N/A pubs.add(arg)

2132N/A elif opt == "-s":

2028N/A conf["repo_uri"] = parse_uri(arg)

2028N/A elif opt == "--no-catalog":