PKG_CLIENT_NAME = "pkgrepo"

EXIT_OK = 0

EXIT_OOPS = 1

EXIT_BADOPT = 2

EXIT_PARTIAL = 3

LISTING_FORMATS = ("json", "json-formatted", "tsv")

tmpdirs = []

import atexit

import collections

import copy

import errno

import getopt

import gettext

import locale

import logging

import shlex

import shutil

import sys

import tempfile

import textwrap

import traceback

import warnings

from pkg.client import global_settings

from pkg.misc import msg, PipeError

import pkg

import pkg.catalog

import pkg.client.api_errors as apx

import pkg.client.pkgdefs as pkgdefs

import pkg.client.progress

import pkg.client.publisher as publisher

import pkg.client.transport.transport as transport

import pkg.misc as misc

import pkg.server.repository as sr

logger = global_settings.logger

@atexit.register

def cleanup():

"""To be called at program finish."""

for d in tmpdirs:

shutil.rmtree(d, True)

def error(text, cmd=None):

"""Emit an error message prefixed by the command name """

if cmd:

text = "%s: %s" % (cmd, text)

pkg_cmd = "pkgrepo "

else:

pkg_cmd = "pkgrepo: "

# If we get passed something like an Exception, we can convert

# it down to a string.

text = str(text)

# If the message starts with whitespace, assume that it should come

# *before* the command-name prefix.

text_nows = text.lstrip()

ws = text[:len(text) - len(text_nows)]

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

# program name on all platforms.

logger.error(ws + pkg_cmd + text_nows)

def get_tracker(quiet=False):

if quiet:

progtrack = pkg.client.progress.QuietProgressTracker()

else:

try:

progtrack = \

pkg.client.progress.FancyUNIXProgressTracker()

except pkg.client.progress.ProgressTrackerException:

progtrack = \

pkg.client.progress.CommandLineProgressTracker()

return progtrack

def usage(usage_error=None, cmd=None, retcode=2, full=False):

"""Emit a usage message and optionally prefix it with a more

if usage_error:

error(usage_error, cmd=cmd)

if not full:

# The full usage message isn't desired.

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

"information."))

sys.exit(retcode)

msg(_("""\

Displays a usage message."""))

sys.exit(retcode)

class OptionError(Exception):

"""Option exception. """

def __init__(self, *args):

Exception.__init__(self, *args)

def parse_uri(uri):

"""Parse the repository location provided and attempt to transform it

return publisher.RepositoryURI(misc.parse_uri(uri))

def subcmd_remove(conf, args):

subcommand = "remove"

opts, pargs = getopt.getopt(args, "np:s:")

dry_run = False

pubs = set()

for opt, arg in opts:

if opt == "-n":

dry_run = True

elif opt == "-p":

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

if not pargs:

usage(_("At least one package pattern must be provided."),

cmd=subcommand)

# Get repository object.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

repo = get_repo(conf, read_only=False, subcommand=subcommand)

if "all" in pubs:

pubs = set()

# Find matching packages.

try:

matching, refs = repo.get_matching_fmris(pargs, pubs=pubs)

except apx.PackageMatchErrors, e:

error(str(e), cmd=subcommand)

return EXIT_OOPS

if dry_run:

# Don't make any changes; display list of packages to be

# removed and exit.

packages = set(f for m in matching.values() for f in m)

count = len(packages)

plist = "\n".join("\t%s" % p for p in sorted(packages))

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

"%(plist)s") % locals())

return EXIT_OK

progtrack = get_tracker()

packages = collections.defaultdict(list)

for m in matching.values():

for f in m:

packages[f.publisher].append(f)

for pub in packages:

logger.info(_("Removing packages for publisher %s ...") % pub)

repo.remove_packages(packages[pub], progtrack=progtrack,

pub=pub)

if len(packages) > 1:

# Add a newline between each publisher.

logger.info("")

return EXIT_OK

def get_repo(conf, read_only=True, subcommand=None):

"""Return the repository object for current program configuration."""

repo_uri = conf["repo_uri"]

if repo_uri.scheme != "file":

usage(_("Network repositories are not currently supported "

"for this operation."), cmd=subcommand)

path = repo_uri.get_pathname()

if not path:

# Bad URI?

raise sr.RepositoryInvalidError(str(repo_uri))

return sr.Repository(read_only=read_only, root=path)

def setup_transport(conf, subcommand=None, verbose=False):

repo_uri = conf.get("repo_uri", None)

if not repo_uri:

usage(_("No repository location specified."), cmd=subcommand)

temp_root = misc.config_temp_root()

tmp_dir = tempfile.mkdtemp(dir=temp_root)

tmpdirs.append(tmp_dir)

incoming_dir = tempfile.mkdtemp(dir=temp_root)

tmpdirs.append(incoming_dir)

cache_dir = tempfile.mkdtemp(dir=temp_root)

tmpdirs.append(cache_dir)

# Create transport and transport config.

xport, xport_cfg = transport.setup_transport()

xport_cfg.add_cache(cache_dir, readonly=False)

xport_cfg.incoming_root = incoming_dir

# Configure target publisher.

src_pub = transport.setup_publisher(str(repo_uri), "target", xport,

xport_cfg, remote_prefix=True)

return xport, src_pub, tmp_dir

def subcmd_add_publisher(conf, args):

"""Add publisher(s) to the specified repository."""

subcommand = "add-publisher"

opts, pargs = getopt.getopt(args, "s:")

for opt, arg in opts:

if opt == "-s":

conf["repo_uri"] = parse_uri(arg)

repo_uri = conf.get("repo_uri", None)

if not repo_uri:

usage(_("No repository location specified."), cmd=subcommand)

if repo_uri.scheme != "file":

usage(_("Network repositories are not currently supported "

"for this operation."), cmd=subcommand)

if not pargs:

usage(_("At least one publisher must be specified"),

cmd=subcommand)

abort = False

for pfx in pargs:

if not misc.valid_pub_prefix(pfx):

error(_("Invalid publisher prefix '%s'") % pfx,

cmd=subcommand)

abort = True

if abort:

return EXIT_OOPS

repo = get_repo(conf, read_only=False, subcommand=subcommand)

make_default = not repo.publishers

existing = repo.publishers & set(pargs)

# Elide the publishers that already exist, but retain the order

# publishers were specified in.

new_pubs = [

pfx for pfx in pargs

if pfx not in repo.publishers

]

# Tricky logic; _set_pub will happily add new publishers if necessary

# and not set any properties if you didn't specify any.

rval = _set_pub(conf, subcommand, {}, new_pubs, repo)

if make_default:

# No publisher existed previously, so set the default publisher

# to be the first new one that was added.

_set_repo(conf, subcommand, { "publisher": {

"prefix": new_pubs[0] } }, repo)

if rval == EXIT_OK and existing:

# Some of the publishers that were requested for addition

# were already known.

error(_("specified publisher(s) already exist: %s") %

", ".join(existing), cmd=subcommand)

if new_pubs:

return EXIT_PARTIAL

return EXIT_OOPS

return rval

def subcmd_create(conf, args):

"""Create a package repository at the given location."""

subcommand = "create"

opts, pargs = getopt.getopt(args, "s:", ["version="])

version = None

for opt, arg in opts:

if opt == "-s":

conf["repo_uri"] = parse_uri(arg)

elif opt == "--version":

# This option is currently private and allows creating a

# repository with a specific format based on version.

try:

version = int(arg)

except ValueError:

usage(_("Version must be an integer value."),

cmd=subcommand)

if len(pargs) > 1:

usage(_("Only one repository location may be specified."),

cmd=subcommand)

elif pargs:

conf["repo_uri"] = parse_uri(pargs[0])

repo_uri = conf.get("repo_uri", None)

if not repo_uri:

usage(_("No repository location specified."), cmd=subcommand)

if repo_uri.scheme != "file":

usage(_("Network repositories are not currently supported "

"for this operation."), cmd=subcommand)

# Attempt to create a repository at the specified location. Allow

# whatever exceptions are raised to bubble up.

sr.repository_create(repo_uri, version=version)

return EXIT_OK

def subcmd_get(conf, args):

"""Display repository properties."""

subcommand = "get"

omit_headers = False

out_format = "default"

pubs = set()

opts, pargs = getopt.getopt(args, "F:Hp:s:")

for opt, arg in opts:

if opt == "-F":

out_format = arg

if out_format not in LISTING_FORMATS:

usage(_("Unrecognized format %(format)s."

" Supported formats: %(valid)s") % \

{ "format": out_format,

"valid": LISTING_FORMATS }, cmd=subcommand)

return EXIT_OOPS

elif opt == "-H":

omit_headers = True

elif opt == "-p":

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

# Setup transport so configuration can be retrieved.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

# Get properties.

if pubs:

return _get_pub(conf, subcommand, xport, xpub, omit_headers,

out_format, pubs, pargs)

return _get_repo(conf, subcommand, xport, xpub, omit_headers,

out_format, pargs)

def _get_repo(conf, subcommand, xport, xpub, omit_headers, out_format, pargs):

"""Display repository properties."""

# Configuration index is indexed by section name and property name.

# Retrieve and flatten it to simplify listing process.

stat_idx = xport.get_status(xpub)

cfg_idx = stat_idx.get("repository", {}).get("configuration", {})

props = set()

# Set minimum widths for section and property name columns by using the

# length of the column headers.

max_sname_len = len(_("SECTION"))

max_pname_len = len(_("PROPERTY"))

for sname in cfg_idx:

max_sname_len = max(max_sname_len, len(sname))

for pname in cfg_idx[sname]:

max_pname_len = max(max_pname_len, len(pname))

props.add("/".join((sname, pname)))

req_props = set(pargs)

if len(req_props) >= 1:

found = props & req_props

notfound = req_props - found

del props

else:

found = props

notfound = set()

def gen_listing():

for prop in sorted(found):

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

sval = cfg_idx[sname][pname]

yield {

"section": sname,

"property": pname,

"value": sval,

}

# SECTION PROPERTY VALUE

# <sec_1> <prop_1> <prop_1_value>

# <sec_2> <prop_2> <prop_2_value>

# ...

field_data = {

"section" : [("default", "json", "tsv"), _("SECTION"), ""],

"property" : [("default", "json", "tsv"), _("PROPERTY"), ""],

"value" : [("default", "json", "tsv"), _("VALUE"), ""],

}

desired_field_order = (_("SECTION"), _("PROPERTY"), _("VALUE"))

# Default output formatting.

def_fmt = "%-" + str(max_sname_len) + "s %-" + str(max_pname_len) + \

"s %s"

if found or (not req_props and out_format == "default"):

# print without trailing newline.

sys.stdout.write(misc.get_listing(desired_field_order,

field_data, gen_listing(), out_format, def_fmt,

omit_headers))

if found and notfound:

return EXIT_PARTIAL

if req_props and not found:

if out_format == "default":

# Don't pollute other output formats.

error(_("no matching properties found"),

cmd=subcommand)

return EXIT_OOPS

return EXIT_OK

def _get_matching_pubs(subcommand, pubs, xport, xpub, out_format="default",

use_transport=False):

# Retrieve publisher information.

pub_data = xport.get_publisherdata(xpub)

known_pubs = set(p.prefix for p in pub_data)

if len(pubs) > 0 and "all" not in pubs:

found = known_pubs & pubs

notfound = pubs - found

pub_data = [p for p in pub_data if p.prefix in found]

else:

found = known_pubs

notfound = set()

if use_transport:

# Assign transport information.

for p in pub_data:

p.repository = xpub.repository

# Establish initial return value and perform early exit if appropriate.

rval = EXIT_OK

if found and notfound:

rval = EXIT_PARTIAL

elif pubs and not found:

if out_format == "default":

# Don't pollute other output formats.

error(_("no matching publishers found"),

cmd=subcommand)

return EXIT_OOPS, None, None

return rval, found, pub_data

def _get_pub(conf, subcommand, xport, xpub, omit_headers, out_format, pubs,

pargs):

"""Display publisher properties."""

rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

xpub, out_format=out_format)

if rval == EXIT_OOPS:

return rval

# Set minimum widths for section and property name columns by using the

# length of the column headers and data.

max_pubname_len = str(max(

[len(_("PUBLISHER"))] + [len(p) for p in found]

))

max_sname_len = len(_("SECTION"))

max_pname_len = len(_("PROPERTY"))

# For each requested publisher, retrieve the requested property data.

pub_idx = {}

for pub in pub_data:

pub_idx[pub.prefix] = {

"publisher": {

"alias": pub.alias,

"prefix": pub.prefix,

},

}

pub_repo = pub.repository

if pub_repo:

pub_idx[pub.prefix]["repository"] = {

"collection-type": pub_repo.collection_type,

"description": pub_repo.description,

"legal-uris": pub_repo.legal_uris,

"mirrors": pub_repo.mirrors,

"name": pub_repo.name,

"origins": pub_repo.origins,

"refresh-seconds": pub_repo.refresh_seconds,

"registration-uri": pub_repo.registration_uri,

"related-uris": pub_repo.related_uris,

}

else:

pub_idx[pub.prefix]["repository"] = {

"collection-type": "core",

"description": "",

"legal-uris": [],

"mirrors": [],

"name": "",

"origins": [],

"refresh-seconds": "",

"registration-uri": "",

"related-uris": [],

}

# Determine possible set of properties and lengths.

props = set()

for pub in pub_idx:

for sname in pub_idx[pub]:

max_sname_len = max(max_sname_len, len(sname))

for pname in pub_idx[pub][sname]:

max_pname_len = max(max_pname_len, len(pname))

props.add("/".join((sname, pname)))

# Determine properties to display.

req_props = set(pargs)

if len(req_props) >= 1:

found = props & req_props

notfound = req_props - found

del props

else:

found = props

notfound = set()

def gen_listing():

for pub in sorted(pub_idx.keys()):

for prop in sorted(found):

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

sval = pub_idx[pub][sname][pname]

yield {

"publisher": pub,

"section": sname,

"property": pname,

"value": sval,

}

# PUBLISHER SECTION PROPERTY VALUE

# <pub_1> <sec_1> <prop_1> <prop_1_value>

# <pub_1> <sec_2> <prop_2> <prop_2_value>

# ...

field_data = {

"publisher" : [("default", "json", "tsv"), _("PUBLISHER"), ""],

"section" : [("default", "json", "tsv"), _("SECTION"), ""],

"property" : [("default", "json", "tsv"), _("PROPERTY"), ""],

"value" : [("default", "json", "tsv"), _("VALUE"), ""],

}

desired_field_order = (_("PUBLISHER"), _("SECTION"), _("PROPERTY"),

_("VALUE"))

# Default output formatting.

def_fmt = "%-" + str(max_pubname_len) + "s %-" + str(max_sname_len) + \

"s %-" + str(max_pname_len) + "s %s"

if found or (not req_props and out_format == "default"):

# print without trailing newline.

sys.stdout.write(misc.get_listing(desired_field_order,

field_data, gen_listing(), out_format, def_fmt,

omit_headers))

if found and notfound:

rval = EXIT_PARTIAL

if req_props and not found:

if out_format == "default":

# Don't pollute other output formats.

error(_("no matching properties found"),

cmd=subcommand)

rval = EXIT_OOPS

return rval

def subcmd_info(conf, args):

"""Display a list of known publishers and a summary of known packages

subcommand = "info"

omit_headers = False

out_format = "default"

pubs = set()

opts, pargs = getopt.getopt(args, "F:Hp:s:")

for opt, arg in opts:

if opt == "-F":

if arg not in LISTING_FORMATS:

usage(_("Unrecognized format %(format)s."

" Supported formats: %(valid)s") % \

{ "format": arg,

"valid": LISTING_FORMATS }, cmd=subcommand)

return EXIT_OOPS

out_format = arg

elif opt == "-H":

omit_headers = True

elif opt == "-p":

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

if pargs:

usage(_("command does not take operands"), cmd=subcommand)

# Setup transport so status can be retrieved.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

# Retrieve repository status information.

stat_idx = xport.get_status(xpub)

pub_idx = stat_idx.get("repository", {}).get("publishers", {})

if len(pubs) > 0 and "all" not in pubs:

found = set(pub_idx.keys()) & pubs

notfound = pubs - found

else:

found = set(pub_idx.keys())

notfound = set()

def gen_listing():

for pfx in found:

pdata = pub_idx[pfx]

pkg_count = pdata.get("package-count", 0)

last_update = pdata.get("last-catalog-update", "")

if last_update:

# Reformat the date into something more user

# friendly (and locale specific).

last_update = pkg.catalog.basic_ts_to_datetime(

last_update)

last_update = "%sZ" % pkg.catalog.datetime_to_ts(

last_update)

rstatus = _(pub_idx[pfx].get("status", "online"))

yield {

"publisher": pfx,

"packages": pkg_count,

"status": rstatus,

"updated": last_update,

}

# PUBLISHER PACKAGES STATUS UPDATED

# <pub_1> <num_uniq_pkgs> <status> <cat_last_modified>

# <pub_2> <num_uniq_pkgs> <status> <cat_last_modified>

# ...

field_data = {

"publisher" : [("default", "json", "tsv"), _("PUBLISHER"), ""],

"packages" : [("default", "json", "tsv"), _("PACKAGES"), ""],

"status" : [("default", "json", "tsv"), _("STATUS"), ""],

"updated" : [("default", "json", "tsv"), _("UPDATED"), ""],

}

desired_field_order = (_("PUBLISHER"), "", _("PACKAGES"), _("STATUS"),

_("UPDATED"))

# Default output formatting.

pub_len = str(max(

[len(desired_field_order[0])] + [len(p) for p in found]

))

def_fmt = "%-" + pub_len + "s %-8s %-16s %s"

if found or (not pubs and out_format == "default"):

# print without trailing newline.

sys.stdout.write(misc.get_listing(desired_field_order,

field_data, gen_listing(), out_format, def_fmt,

omit_headers))

if found and notfound:

return EXIT_PARTIAL

if pubs and not found:

if out_format == "default":

# Don't pollute other output formats.

error(_("no matching publishers found"),

cmd=subcommand)

return EXIT_OOPS

return EXIT_OK

def subcmd_list(conf, args):

"""List all packages matching the specified patterns."""

subcommand = "list"

omit_headers = False

out_format = "default"

pubs = set()

opts, pargs = getopt.getopt(args, "F:Hp:s:")

for opt, arg in opts:

if opt == "-F":

out_format = arg

if out_format not in LISTING_FORMATS:

usage(_("Unrecognized format %(format)s."

" Supported formats: %(valid)s") %

{ "format": out_format,

"valid": LISTING_FORMATS }, cmd=subcommand)

return EXIT_OOPS

elif opt == "-H":

omit_headers = True

elif opt == "-p":

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

# Setup transport so configuration can be retrieved.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

xpub, out_format=out_format, use_transport=True)

if rval == EXIT_OOPS:

return rval

temp_root = misc.config_temp_root()

progtrack = get_tracker()

progtrack.set_purpose(progtrack.PURPOSE_LISTING)

progtrack.refresh_start(pub_cnt=len(pub_data), full_refresh=True,

target_catalog=False)

for pub in pub_data:

progtrack.refresh_start_pub(pub)

meta_root = tempfile.mkdtemp(dir=temp_root)

tmpdirs.append(meta_root)

pub.meta_root = meta_root

pub.transport = xport

try:

pub.refresh(True, True, progtrack=progtrack)

except apx.TransportError:

# Assume that a catalog doesn't exist for the target

# publisher and drive on.

pass

progtrack.refresh_end_pub(pub)

progtrack.refresh_done()

listed = {}

matched = set()

unmatched = set()

def gen_listing():

collect_attrs = out_format.startswith("json")

for pub in pub_data:

cat = pub.catalog

for f, states, attrs in cat.gen_packages(

collect_attrs=collect_attrs, matched=matched,

patterns=pargs, pubs=[pub.prefix],

unmatched=unmatched, return_fmris=True):

if not listed:

listed["packages"] = True

state = None

if out_format == "default" or \

out_format == "tsv":

if pkgdefs.PKG_STATE_OBSOLETE in \

states:

state = "o"

elif pkgdefs.PKG_STATE_RENAMED in \

states:

state = "r"

ret = {

"publisher": f.publisher,

"name": f.pkg_name,

"version": str(f.version),

"release": str(f.version.release),

"build-release":

str(f.version.build_release),

"branch": str(f.version.branch),

"timestamp":

str(f.version.timestr),

"pkg.fmri": str(f),

"short_state": state,

}

for attr in attrs:

ret[attr] = []

for mods in attrs[attr]:

d = dict(mods)

d["value"] = \

attrs[attr][mods]

ret[attr].append(d)

yield ret

unmatched.difference_update(matched)

field_data = {

"publisher": [("default", "json", "tsv"), _("PUBLISHER"), ""],

"name": [("default", "json", "tsv"), _("NAME"), ""],

"version": [("default", "json"), _("VERSION"), ""],

"release": [("json", "tsv",), _("RELEASE"), ""],

"build-release": [("json", "tsv",), _("BUILD RELEASE"), ""],

"branch": [("json", "tsv",), _("BRANCH"), ""],

"timestamp": [("json", "tsv",), _("PACKAGING DATE"), ""],

"pkg.fmri": [("json", "tsv",), _("FMRI"), ""],

"short_state": [("default", "tsv"), "O", ""],

}

desired_field_order = (_("PUBLISHER"), _("NAME"), "O", _("VERSION"),

_("SUMMARY"), _("DESCRIPTION"), _("CATEGORIES"), _("RELEASE"),

_("BUILD RELEASE"), _("BRANCH"), _("PACKAGING DATE"), _("FMRI"),

_("STATE"))

# Default output formatting.

max_pub_name_len = str(

max(list(len(p) for p in found) + [len(_("PUBLISHER"))]))

def_fmt = "%-" + max_pub_name_len + "s %-45s %-1s %-s"

# print without trailing newline.

sys.stdout.write(misc.get_listing(

desired_field_order, field_data, gen_listing(),

out_format, def_fmt, omit_headers))

if not listed and pargs:

# No matching packages.

logger.error("")

if not unmatched:

unmatched = pargs

error(apx.PackageMatchErrors(unmatched_fmris=unmatched),

cmd=subcommand)

return EXIT_OOPS

elif unmatched:

# One or more patterns didn't match a package from any

# publisher; only display the error.

logger.error("")

error(apx.PackageMatchErrors(unmatched_fmris=unmatched),

cmd=subcommand)

return EXIT_PARTIAL

return EXIT_OK

def subcmd_rebuild(conf, args):

"""Rebuild the repository's catalog and index data (as permitted)."""

subcommand = "rebuild"

build_catalog = True

build_index = True

opts, pargs = getopt.getopt(args, "p:s:", ["no-catalog", "no-index"])

pubs = set()

for opt, arg in opts:

if opt == "-p":

if not misc.valid_pub_prefix(arg):

error(_("Invalid publisher prefix '%s'") % arg,

cmd=subcommand)

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

elif opt == "--no-catalog":

build_catalog = False

elif opt == "--no-index":

build_index = False

if pargs:

usage(_("command does not take operands"), cmd=subcommand)

if not build_catalog and not build_index:

# Why? Who knows; but do what was requested--nothing!

return EXIT_OK

# Setup transport so operation can be performed.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

def do_rebuild(xport, xpub):

if build_catalog and build_index:

xport.publish_rebuild(xpub)

elif build_catalog:

xport.publish_rebuild_packages(xpub)

elif build_index:

xport.publish_rebuild_indexes(xpub)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

xpub)

if rval == EXIT_OOPS:

return rval

logger.info("Initiating repository rebuild.")

for pfx in found:

xpub.prefix = pfx

do_rebuild(xport, xpub)

return rval

def subcmd_refresh(conf, args):

"""Refresh the repository's catalog and index data (as permitted)."""

subcommand = "refresh"

add_content = True

refresh_index = True

opts, pargs = getopt.getopt(args, "p:s:", ["no-catalog", "no-index"])

pubs = set()

for opt, arg in opts:

if opt == "-p":

if not misc.valid_pub_prefix(arg):

error(_("Invalid publisher prefix '%s'") % arg,

cmd=subcommand)

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

elif opt == "--no-catalog":

add_content = False

elif opt == "--no-index":

refresh_index = False

if pargs:

usage(_("command does not take operands"), cmd=subcommand)

if not add_content and not refresh_index:

# Why? Who knows; but do what was requested--nothing!

return EXIT_OK

# Setup transport so operation can be performed.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

def do_refresh(xport, xpub):

if add_content and refresh_index:

xport.publish_refresh(xpub)

elif add_content:

xport.publish_refresh_packages(xpub)

elif refresh_index:

xport.publish_refresh_indexes(xpub)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

xpub)

if rval == EXIT_OOPS:

return rval

logger.info("Initiating repository refresh.")

for pfx in found:

xpub.prefix = pfx

do_refresh(xport, xpub)

return rval

def subcmd_set(conf, args):

"""Set repository properties."""

subcommand = "set"

pubs = set()

opts, pargs = getopt.getopt(args, "p:s:")

for opt, arg in opts:

if opt == "-p":

pubs.add(arg)

elif opt == "-s":

conf["repo_uri"] = parse_uri(arg)

bad_args = False

props = {}

if not pargs:

bad_args = True

else:

for arg in pargs:

try:

# Attempt to parse property into components.

prop, val = arg.split("=", 1)

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

# Store property values by section.

props.setdefault(sname, {})

# Parse the property value into a list if

# necessary, otherwise append it to the list

# of values for the property.

if len(val) > 0 and val[0] == "(" and \

val[-1] == ")":

val = shlex.split(val.strip("()"))

if sname in props and pname in props[sname]:

# Determine if previous value is already

# a list, and if not, convert and append

# the value.

pval = props[sname][pname]

if not isinstance(pval, list):

pval = [pval]

if isinstance(val, list):

pval.extend(val)

else:

pval.append(val)

props[sname][pname] = pval

else:

# Otherwise, just store the value.

props[sname][pname] = val

except ValueError:

bad_args = True

break

if bad_args:

usage(_("a property name and value must be provided in the "

"form <section/property>=<value> or "

"<section/property>=([\"<value>\" ...])"))

# Get repository object.

if not conf.get("repo_uri", None):

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

repo = get_repo(conf, read_only=False, subcommand=subcommand)

# Set properties.

if pubs:

return _set_pub(conf, subcommand, props, pubs, repo)

return _set_repo(conf, subcommand, props, repo)

def _set_pub(conf, subcommand, props, pubs, repo):

"""Set publisher properties."""

for sname, sprops in props.iteritems():

if sname not in ("publisher", "repository"):

usage(_("unknown property section "

"'%s'") % sname, cmd=subcommand)

for pname in sprops:

if sname == "publisher" and pname == "prefix":

usage(_("'%s' may not be set using "

"this command" % pname))

attrname = pname.replace("-", "_")

if not hasattr(publisher.Publisher, attrname) and \

not hasattr(publisher.Repository, attrname):

usage(_("unknown property '%s'") %

pname, cmd=subcommand)

if "all" in pubs:

# Default to list of all publishers.

pubs = repo.publishers

if not pubs:

# If there are still no known publishers, this

# operation cannot succeed, so fail now.

usage(_("One or more publishers must be specified to "

"create and set properties for as none exist yet."),

cmd=subcommand)

# Get publishers and update properties.

failed = []

new_pub = False

for pfx in pubs:

try:

# Get a copy of the existing publisher.

pub = copy.copy(repo.get_publisher(pfx))

except sr.RepositoryUnknownPublisher, e:

pub = publisher.Publisher(pfx)

new_pub = True

except sr.RepositoryError, e:

failed.append((pfx, e))

continue

try:

# Set/update the publisher's properties.

for sname, sprops in props.iteritems():

if sname == "publisher":

target = pub

elif sname == "repository":

target = pub.repository

if not target:

target = publisher.Repository()

pub.repository = target

for pname, val in sprops.iteritems():

attrname = pname.replace("-", "_")

pval = getattr(target, attrname)

if isinstance(pval, list) and \

not isinstance(val, list):

# If the target property expects

# a list, transform the provided

# value into one if it isn't

# already.

if val == "":

val = []

else:

val = [val]

setattr(target, attrname, val)

except apx.ApiException, e:

failed.append((pfx, e))

continue

if new_pub:

repo.add_publisher(pub)

else:

repo.update_publisher(pub)

if failed:

for pfx, details in failed:

error(_("Unable to set properties for publisher "

"'%(pfx)s':\n%(details)s") % locals())

if len(failed) < len(pubs):

return EXIT_PARTIAL

return EXIT_OOPS

return EXIT_OK

def _set_repo(conf, subcommand, props, repo):

"""Set repository properties."""

# Set properties.

for sname, props in props.iteritems():

for pname, val in props.iteritems():

repo.cfg.set_property(sname, pname, val)

repo.write_config()

return EXIT_OK

def subcmd_version(conf, args):

"""Display the version of the pkg(5) API."""

subcommand = "version"

if args:

usage(_("command does not take operands"), cmd=subcommand)

msg(pkg.VERSION)

return EXIT_OK

verify_error_header = None

verify_warning_header = None

verify_reason_headers = None

def __load_verify_msgs():

"""Since our gettext isn't loaded we need to ensure our globals have

global verify_error_header

global verify_warning_header

global verify_reason_headers

# A map of error detail types to the human-readable description of each

# type. These correspond to keys in the dictionary returned by

# sr.Repository.verify(..)

verify_reason_headers = {

"path": _("Repository path"),

"actual": _("Computed hash"),

"fpath": _("Path"),

"permissionspath": _("Path"),

"pkg": _("Package"),

"err": _("Detail")

}

verify_error_header = _("ERROR")

verify_warning_header = _("WARNING")

def __fmt_verify(verify_tuple):

"""Format a verify_tuple, of the form (error, path, message, reason)

error, path, message, reason = verify_tuple

formatted_message = "%(error_type)16s: %(message)s\n" % \

{"error_type": verify_error_header, "message": message}

reason["path"] = path

if error == sr.REPO_VERIFY_BADMANIFEST:

reason_keys = ["path", "err"]

elif error in [sr.REPO_VERIFY_PERM, sr.REPO_VERIFY_MFPERM]:

reason_keys = ["pkg", "path"]

elif error == sr.REPO_VERIFY_BADHASH:

reason_keys = ["pkg", "path", "actual", "fpath"]

elif error == sr.REPO_VERIFY_UNKNOWN:

reason_keys = ["path", "err"]

elif error == sr.REPO_VERIFY_BADSIG:

reason_keys = ["pkg", "path", "err"]

elif error == sr.REPO_VERIFY_WARN_OPENPERMS:

formatted_message = \

"%(error_type)16s: %(message)s\n" % \

{"error_type": verify_warning_header, "message": message}

reason_keys = ["permissionspath", "err"]

else:

# A list of the details we provide. Some error codes

# have different details associated with them.

reason_keys = ["pkg", "path", "fpath"]

# the detailed error message can be long, so we'll wrap it. If what we

# have fits on a single line, use it, otherwise begin displaying the

# message on the next line.

if "err" in reason_keys:

err_str = ""

lines = textwrap.wrap(reason["err"])

if len(lines) != 1:

for line in lines:

err_str += "%18s\n" % line

reason["err"] = "\n" + err_str.rstrip()

else:

reason["err"] = lines[0]

for key in reason_keys:

# sometimes we don't have the key we want, for example we may

# not have a file path from the package if the error is a

# missing repository file for a 'license' action (which don't

# have 'path' attributes, hence no 'fpath' dictionary entry)

if key not in reason:

continue

formatted_message += "%(key)16s: %(value)s\n" % \

{"key": verify_reason_headers[key], "value": reason[key]}

formatted_message += "\n"

if error == sr.REPO_VERIFY_WARN_OPENPERMS:

return formatted_message, None

elif "pkg" in reason:

return formatted_message, reason["pkg"]

return formatted_message, reason["path"]

def subcmd_verify(conf, args):

"""Verify the repository content (file and manifest content only)."""

subcommand = "verify"

__load_verify_msgs()

opts, pargs = getopt.getopt(args, "p:s:")

pubs = set()

for opt, arg in opts:

if opt == "-s":

conf["repo_uri"] = parse_uri(arg)

if opt == "-p":

if not misc.valid_pub_prefix(arg):

error(_("Invalid publisher prefix '%s'") % arg,

cmd=subcommand)

pubs.add(arg)

if pargs:

usage(_("command does not take operands"), cmd=subcommand)

repo_uri = conf.get("repo_uri", None)

if not repo_uri:

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

if repo_uri.scheme != "file":

usage(_("Network repositories are not currently supported "

"for this operation."), cmd=subcommand)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

xpub)

if rval == EXIT_OOPS:

return rval

logger.info("Initiating repository verification.")

bad_fmris = set()

for pfx in found:

progtrack = get_tracker()

repo = sr.Repository(root=repo_uri.get_pathname())

xpub.prefix = pfx

xpub.transport = xport

for verify_tuple in repo.verify(pub=xpub, progtrack=progtrack):

message, bad_fmri = __fmt_verify(verify_tuple)

if bad_fmri:

bad_fmris.add(bad_fmri)

progtrack.repo_verify_yield_error(bad_fmri, message)

if bad_fmris:

return EXIT_OOPS

return EXIT_OK

def subcmd_fix(conf, args):

"""Fix the repository content (file and manifest content only)

subcommand = "fix"

__load_verify_msgs()

verbose = False

opts, pargs = getopt.getopt(args, "vp:s:")

pubs = set()

for opt, arg in opts:

if opt == "-s":

conf["repo_uri"] = parse_uri(arg)

if opt == "-v":

verbose = True

if opt == "-p":

if not misc.valid_pub_prefix(arg):

error(_("Invalid publisher prefix '%s'") % arg,

cmd=subcommand)

pubs.add(arg)

if pargs:

usage(_("command does not take operands"), cmd=subcommand)

repo_uri = conf.get("repo_uri", None)

if not repo_uri:

usage(_("A package repository location must be provided "

"using -s."), cmd=subcommand)

if repo_uri.scheme != "file":

usage(_("Network repositories are not currently supported "

"for this operation."), cmd=subcommand)

xport, xpub, tmp_dir = setup_transport(conf, subcommand=subcommand)

rval, found, pub_data = _get_matching_pubs(subcommand, pubs, xport,

xpub)

if rval == EXIT_OOPS:

return rval

logger.info("Initiating repository fix.")

progtrack = get_tracker()

def verify_cb(tracker, verify_tuple):

"""A method passed to sr.Repository.fix(..) to emit verify

if not verbose:

return

formatted_message, bad_fmri = __fmt_verify(verify_tuple)

tracker.repo_verify_yield_error(bad_fmri, formatted_message)

repo = sr.Repository(root=repo_uri.get_pathname())

broken_fmris = set()

failed_fix_paths = set()

for pfx in found:

xpub.prefix = pfx

xpub.transport = xport

progtrack = get_tracker()

for status_code, path, message, reason in \

repo.fix(pub=xpub, progtrack=progtrack,

verify_callback=verify_cb):

if status_code == sr.REPO_FIX_ITEM:

# When we can't get the FMRI, eg. in the case

# of a corrupt manifest, use the path instead.

fmri = reason["pkg"]

if not fmri:

fmri = path

broken_fmris.add(fmri)

if verbose:

progtrack.repo_fix_yield_info(fmri,

message)

else:

failed_fix_paths.add(path)

progtrack.flush()

logger.info("")

if broken_fmris:

logger.info(_("Use pkgsend(1) or pkgrecv(1) to republish the\n"

"following packages or paths which were quarantined:\n\n\t"

"%s") % \

"\n\t".join([str(f) for f in broken_fmris]))

if failed_fix_paths:

logger.info(_("\npkgrepo could not repair the following paths "

"in the repository:\n\n\t%s") %

"\n\t".join([p for p in failed_fix_paths]))

if not (broken_fmris or failed_fix_paths):

logger.info(_("No repository fixes required."))

else:

logger.info(_("Repository repairs completed."))

if failed_fix_paths:

return EXIT_OOPS

return EXIT_OK

def main_func():

global_settings.client_name = PKG_CLIENT_NAME

try:

opts, pargs = getopt.getopt(sys.argv[1:], "s:?",

["help"])

except getopt.GetoptError, e:

usage(_("illegal global option -- %s") % e.opt)

conf = {}

show_usage = False

for opt, arg in opts:

if opt == "-s":

conf["repo_uri"] = parse_uri(arg)

elif opt in ("--help", "-?"):

show_usage = True

subcommand = None

if pargs:

subcommand = pargs.pop(0)

if subcommand == "help":

show_usage = True

if show_usage:

usage(retcode=0, full=True)

elif not subcommand:

usage(_("no subcommand specified"))

subcommand = subcommand.replace("-", "_")

func = globals().get("subcmd_%s" % subcommand, None)

if not func:

subcommand = subcommand.replace("_", "-")

usage(_("unknown subcommand '%s'") % subcommand)

try:

return func(conf, pargs)

except getopt.GetoptError, e:

if e.opt in ("help", "?"):

usage(full=True)

usage(_("illegal option -- %s") % e.opt, cmd=subcommand)

def handle_errors(func, *args, **kwargs):

"""Catch exceptions raised by the main program function and then print

traceback_str = misc.get_traceback_message()

try:

# Out of memory errors can be raised as EnvironmentErrors with

# an errno of ENOMEM, so in order to handle those exceptions

# with other errnos, we nest this try block and have the outer

# one handle the other instances.

try:

__ret = func(*args, **kwargs)

except (MemoryError, EnvironmentError), __e:

if isinstance(__e, EnvironmentError) and \

__e.errno != errno.ENOMEM:

raise

error("\n" + misc.out_of_memory())

__ret = EXIT_OOPS

except SystemExit, __e:

raise __e

except (IOError, PipeError, KeyboardInterrupt), __e:

# Don't display any messages here to prevent possible further

# broken pipe (EPIPE) errors.

if isinstance(__e, IOError) and __e.errno != errno.EPIPE:

error(str(__e))

__ret = EXIT_OOPS

except apx.VersionException, __e:

error(_("The pkgrepo command appears out of sync with the "

"libraries provided\nby pkg:/package/pkg. The client "

"version is %(client)s while the library\nAPI version is "

"%(api)s.") % {'client': __e.received_version,

'api': __e.expected_version

})

__ret = EXIT_OOPS

except apx.BadRepositoryURI, __e:

error(str(__e))

__ret = EXIT_BADOPT

except (apx.ApiException, sr.RepositoryError), __e:

error(str(__e))

__ret = EXIT_OOPS

except:

traceback.print_exc()

error(traceback_str)

__ret = 99

return __ret

if __name__ == "__main__":

misc.setlocale(locale.LC_ALL, "", error)

gettext.install("pkg", "/usr/share/locale",

codeset=locale.getpreferredencoding())

# Make all warnings be errors.

warnings.simplefilter('error')

__retval = handle_errors(main_func)

try:

logging.shutdown()

except IOError:

# Ignore python's spurious pipe problems.

pass

sys.exit(__retval)