e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger

789e293810190b918998fa027c76126e7aa4bf38henning mueller

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehaseimport os.path

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehaseimport xml.dom.minidom as minidom

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehaseimport xml.parsers

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehaseimport xml.parsers.expat

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehase

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehaseimport pkg.flavor.base as base

ef68dc9d6ba7fc331ecdef35f74cff6bb12835b8Tim Reddehasefrom pkg.portable import PD_LOCAL_PATH, PD_PROTO_DIR, PD_PROTO_DIR_LIST

8855a26fb8a7c3743d2ae2cb817e21fb23b674c4Tim Reddehase

658c5ac5444dac6fd0b33ea20690fa14103dbaebTim Reddehasemanifest_locations = [ "lib/svc/manifest", "var/svc/manifest" ]

658c5ac5444dac6fd0b33ea20690fa14103dbaebTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehaseclass SMFManifestDependency(base.PublishingDependency):

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase # maps SMF fmris to the manifest files that defined them

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase instance_mf = None

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase # maps SMF FMRIs to a list the SMF FMRIs they declare as dependencies

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase instance_deps = None

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase manifest = None

8855a26fb8a7c3743d2ae2cb817e21fb23b674c4Tim Reddehase

8855a26fb8a7c3743d2ae2cb817e21fb23b674c4Tim Reddehase def __init__(self, action, path, pkg_vars, proto_dir):

8855a26fb8a7c3743d2ae2cb817e21fb23b674c4Tim Reddehase """ See __init__ for PublishingDependency.

8855a26fb8a7c3743d2ae2cb817e21fb23b674c4Tim Reddehase self.manifest = path

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase full_paths = None

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase if isinstance(path, basestring):

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase base_names = [os.path.basename(path)]

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase paths = [os.path.dirname(path)]

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase elif isinstance(path, tuple):

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase # we can depend on multiple files delivering instances

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase # of a service that was marked as a dependency. If we

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase # do, we must specify the full paths to the manifests

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase # and not a basenames/paths pair, since SMF does not

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase # search for SMF manifests this way.

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase base_names = []

0404717d2bad53ac5922514e490a2b07361d58d8Tim Reddehase paths = []

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase full_paths = [p.replace(proto_dir, "").lstrip("/")

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase for p in path]

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase else:

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase raise base.InvalidPublishingDependency("A string or "

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase "tuple must be specified for 'path'.")

a41053781a26a3dafdbbe8b740b48128cdacfb43Tim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase base.PublishingDependency.__init__(self, action,

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase base_names, paths, pkg_vars, proto_dir, "smf_manifest",

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase full_paths=full_paths)

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase def __repr__(self):

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase return "SMFDep({0}, {1}, {2}, {3})".format(self.action,

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase self.base_names, self.run_paths, self.pkg_vars)

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase @staticmethod

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase def _clear_cache():

3c4b1bd39fa36d241f2ef0d6f7ebbf2a9a6f4d36henning mueller """Clear our manifest caches. This is primarily provided for

6bbb03b1a673f7709df590df43aaed9e8740f671Tim Reddehase SMFManifestDependency.instance_mf = None

e850c5fd45bb26b64e3a1d02f8beb3a951470d27Tim Reddehase SMFManifestDependency.instance_deps = None

8bc65b8b85b830b0432ea7701f2047acd552cedcTim Reddehase

8bc65b8b85b830b0432ea7701f2047acd552cedcTim Reddehase @staticmethod

6bbb03b1a673f7709df590df43aaed9e8740f671Tim Reddehase def populate_cache(proto_dirs, force_update=False):

8bc65b8b85b830b0432ea7701f2047acd552cedcTim Reddehase """Build our instance_mf and instance_deps dictionaries

6bbb03b1a673f7709df590df43aaed9e8740f671Tim Reddehase

6bbb03b1a673f7709df590df43aaed9e8740f671Tim Reddehase if not force_update:

e5fc71a1941c833e676942534582f2adb510660dTim Reddehase if SMFManifestDependency.instance_mf != None:

8bc65b8b85b830b0432ea7701f2047acd552cedcTim Reddehase return

8bc65b8b85b830b0432ea7701f2047acd552cedcTim Reddehase

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase SMFManifestDependency.instance_mf = {}

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase SMFManifestDependency.instance_deps = {}

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase

56cef2d91f243b2b1f773acc20f9c5ae9fb5c537Tim Reddehase def find(manifests, dirname, fnames):

dc6831d0eb2d0ab3af7b0268a429562b110e07bbTim Reddehase for file in fnames:

56cef2d91f243b2b1f773acc20f9c5ae9fb5c537Tim Reddehase path = os.path.join(dirname, file)

56cef2d91f243b2b1f773acc20f9c5ae9fb5c537Tim Reddehase if os.path.isfile(path):

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger manifests.append(path)

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger manifest_paths = []

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger # we want our proto_dirs to be the authoritative source

a06b758dc863e147d288497ee69491afc2d23b7dTim Reddehase # for SMF manifests, so scan the local system first, then

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger # iterate through the proto_dirs, starting from the

836ef862a9f5bd2a1d5c68bbccb11c00b248758aTim Reddehase # oldest, overwriting with progressively newer proto_dirs

836ef862a9f5bd2a1d5c68bbccb11c00b248758aTim Reddehase for location in manifest_locations:

6b136443f2bc8ea49192210a7281ffa0f44b14fcTim Reddehase manifest_paths.append(os.path.join("/", location))

836ef862a9f5bd2a1d5c68bbccb11c00b248758aTim Reddehase for proto_dir in reversed(proto_dirs):

836ef862a9f5bd2a1d5c68bbccb11c00b248758aTim Reddehase for location in manifest_locations:

cfe6bf1bc38ab15b759dee8bb5c86c3727058a2eTim Reddehase manifest_paths.append(os.path.join(proto_dir,

cfe6bf1bc38ab15b759dee8bb5c86c3727058a2eTim Reddehase location))

cfe6bf1bc38ab15b759dee8bb5c86c3727058a2eTim Reddehase

6876ece18854869a08606c12e0e814435fa73a29Tim Reddehase for location in manifest_paths:

6876ece18854869a08606c12e0e814435fa73a29Tim Reddehase manifests = []

6876ece18854869a08606c12e0e814435fa73a29Tim Reddehase os.path.walk(location, find, manifests)

6876ece18854869a08606c12e0e814435fa73a29Tim Reddehase for manifest_file in manifests:

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger SMFManifestDependency.__populate_smf_dics(

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger manifest_file)

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger @staticmethod

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger def __populate_smf_dics(manifest_file):

61467f8ae537212ba3c895868c91235a21985cb8Tim Reddehase """Add a information information about the SMF instances and

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger instance_mf, instance_deps = parse_smf_manifest(

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger manifest_file)

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger

ee9341b3b65f9d567605249940e4948af119e784Eugen Kuksa # more work is needed here when

ee9341b3b65f9d567605249940e4948af119e784Eugen Kuksa # multiple-manifests per service is supported by

ee9341b3b65f9d567605249940e4948af119e784Eugen Kuksa # SMF: we'll need to merge additional

ee9341b3b65f9d567605249940e4948af119e784Eugen Kuksa # service-level dependencies into each service

e437b19c184243f688c2dd9b3bf083a454c804c7Julian Kornberger # instance as each manifest gets added.

if instance_mf:

SMFManifestDependency.instance_mf.update(

instance_mf)

if instance_deps:

SMFManifestDependency.instance_deps.update(

instance_deps)

def split_smf_fmri(fmri):

"""Split an SMF FMRI into constituent parts, returning the svc protocol,

protocol = None

service = None

instance = None

arr = fmri.split(":")

if len(arr) == 2 and arr[0] == "svc":

protocol = "svc"

service = arr[1]

elif len(arr) == 3 and arr[0] == "svc":

protocol = "svc"

service = arr[1]

instance = arr[2]

else:

raise ValueError(_("FMRI does not appear to be valid"))

return protocol, service, instance

def search_smf_dic(fmri, dictionary):

"""Search a dictionary of SMF FMRI mappings, returning a list of

protocol, service, instance = split_smf_fmri(fmri)

results = []

if instance is not None:

if fmri in dictionary:

results.append(dictionary[fmri])

else:

# return all matching instances of this service

for item in dictionary:

if item.startswith(protocol + ":" + service + ":"):

results.append(dictionary[item])

return results

def get_smf_dependencies(fmri, instance_deps):

"""Given an instance FMRI, determine the FMRIs it depends on. If we

results = search_smf_dic(fmri, instance_deps)

if len(results) == 1:

return results[0]

elif len(results) > 1:

# this can only happen if we've been asked to resolve a

# service-level FMRI, not a fully qualified instance FMRI

raise ValueError(

_("more than one set of dependencies found: {0}").format(

results))

results = search_smf_dic(fmri, SMFManifestDependency.instance_deps)

if len(results) == 1:

return results[0]

elif len(results) > 1:

raise ValueError(

_("more than one set of dependencies found: {0}").format(

results))

return []

def resolve_smf_dependency(fmri, instance_mf):

"""Given an SMF FMRI that satisfies a given SMF dependency, determine

manifests = set()

manifests.update(search_smf_dic(fmri, instance_mf))

manifests.update(search_smf_dic(

fmri, SMFManifestDependency.instance_mf))

if len(manifests) == 0:

# we can't satisfy the dependency at all

raise ValueError(_("cannot resolve FMRI to a delivered file"))

return list(manifests)

def process_smf_manifest_deps(action, pkg_vars, **kwargs):

"""Given an action and a place to find the file it references, if the

if action.name != "file":

return [], \

[ _("{0} actions cannot deliver SMF manifests").format(

action.name)], {}

# we don't report an error here, as SMF manifest files may be delivered

# to a location specifically not intended to be imported to the SMF

# repository.

if not has_smf_manifest_dir(action.attrs["path"]):

return [], [], {}

proto_file = action.attrs[PD_LOCAL_PATH]

SMFManifestDependency.populate_cache(action.attrs[PD_PROTO_DIR_LIST])

deps = []

elist = []

dep_manifests = set()

instance_mf, instance_deps = parse_smf_manifest(proto_file)

if instance_mf is None:

return [], [ _("Unable to parse SMF manifest {0}").format(

proto_file)], {}

for fmri in instance_mf:

try:

protocol, service, instance = split_smf_fmri(fmri)

# we're only interested in trying to resolve

# dependencies that instances have declared

if instance is None:

continue

except ValueError, err:

elist.append(_("Problem resolving {fmri}: {err}").format(

**locals()))

continue

# determine the set of SMF FMRIs we depend on

dep_fmris = set()

try:

dep_fmris = set(

get_smf_dependencies(fmri, instance_deps))

except ValueError, err:

elist.append(

_("Problem determining dependencies for {fmri}:"

"{err}").format(**locals()))

# determine the file paths that deliver those dependencies

for dep_fmri in dep_fmris:

try:

manifests = resolve_smf_dependency(dep_fmri,

instance_mf)

except ValueError, err:

# we've declared an SMF dependency, but can't

# determine what file delivers it from the known

# SMF manifests in either the proto area or the

# local machine.

manifests = []

elist.append(

_("Unable to generate SMF dependency on "

"{dep_fmri} declared in {proto_file} by "

"{fmri}: {err}").format(**locals()))

if len(manifests) == 1:

dep_manifests.add(manifests[0])

elif len(manifests) > 1:

protocol, service, instance = \

split_smf_fmri(dep_fmri)

# This should never happen, as it implies a

# service FMRI, not an instance FMRI has been

# returned from search_smf_dic via

# resolve_smf_dependency.

if instance is not None:

elist.append(

_("Unable to generate SMF "

"dependency on the service FMRI "

"{dep_fmri} declared in "

"{proto_file} by {fmri}. "

"SMF dependencies should always "

"resolve to SMF instances rather "

"than SMF services and multiple "

"files deliver instances of this "

"service: {manifests}").format(

dep_fmri=dep_fmri,

proto_file=proto_file,

fmri=fmri,

manifests=", ".join(manifests)))

dep_manifests.add(tuple(manifests))

for manifest in dep_manifests:

deps.append(SMFManifestDependency(action, manifest, pkg_vars,

action.attrs[PD_PROTO_DIR]))

pkg_attrs = {

"org.opensolaris.smf.fmri": instance_mf.keys()

}

return deps, elist, pkg_attrs

def __get_smf_dependencies(deps):

"""Given a minidom Element deps, search for the <service_fmri> elements

dependencies = []

for dependency in deps:

fmris = dependency.getElementsByTagName("service_fmri")

dep_type = dependency.getAttribute("type")

grouping = dependency.getAttribute("grouping")

delete = dependency.getAttribute("delete")

# we don't include SMF path dependencies as these are often

# not packaged files.

if fmris and dep_type == "service" and \

grouping == "require_all" and \

delete != "true":

for service_fmri in fmris:

dependency = service_fmri.getAttribute("value")

if dependency:

dependencies.append(dependency)

return dependencies

def is_smf_manifest(smf_file):

"""Quickly determine if smf_file is a valid SMF manifest."""

try:

smf_doc = minidom.parse(smf_file)

# catching ValueError, as minidom has been seen to raise this on some

# invalid XML files.

except (xml.parsers.expat.ExpatError, ValueError):

return False

if not smf_doc.doctype:

return False

if smf_doc.doctype.systemId != \

"/usr/share/lib/xml/dtd/service_bundle.dtd.1":

return False

return True

def parse_smf_manifest(smf_file):

"""Returns a tuple of two dictionaries. The first maps the SMF FMRIs

instance_mf = {}

instance_deps = {}

try:

smf_doc = minidom.parse(smf_file)

# catching ValueError, as minidom has been seen to raise this on some

# invalid XML files.

except (xml.parsers.expat.ExpatError, ValueError):

return None, None

if not smf_doc.doctype:

return None, None

if smf_doc.doctype.systemId != \

"/usr/share/lib/xml/dtd/service_bundle.dtd.1":

return None, None

manifest_path = None

if isinstance(smf_file, str):

manifest_path = smf_file

svcs = smf_doc.getElementsByTagName("service")

for service in svcs:

fmris = []

svc_dependencies = []

create_default = False

duplicate_default = False

# get the service name

svc_name = service.getAttribute("name")

if svc_name and not svc_name.startswith("/"):

svc_name = "/" + svc_name

fmris.append("svc:{0}".format(svc_name))

else:

# no defined service name, so no dependencies here

continue

# Get the FMRIs we declare dependencies on. When splitting SMF

# services across multiple manifests is supported, more work

# will be needed here.

svc_deps = []

for child in service.childNodes:

if isinstance(child, minidom.Element) and \

child.tagName == "dependency":

svc_deps.append(child)

svc_dependencies.extend(__get_smf_dependencies(svc_deps))

# determine our instances

if service.getElementsByTagName("create_default_instance"):

create_default = True

insts = service.getElementsByTagName("instance")

for instance in insts:

inst_dependencies = []

inst_name = instance.getAttribute("name")

fmri = None

if inst_name:

if inst_name == "default" and create_default:

# we've declared a

# create_default_instance tag but we've

# also explicitly created an instance

# called "default"

duplicate_default = True

fmri = "svc:{0}:{1}".format(svc_name, inst_name)

# we can use getElementsByTagName here, since

# there are no nested <dependency> tags that

# won't apply, unlike for <service> above, when

# we needed to look strictly at immediate

# children.

inst_deps = instance.getElementsByTagName(

"dependency")

inst_dependencies.extend(

__get_smf_dependencies(inst_deps))

if fmri is not None:

instance_deps[fmri] = svc_dependencies + \

inst_dependencies

fmris.append(fmri)

if create_default and not duplicate_default:

fmri = "svc:{0}:default".format(svc_name)

fmris.append(fmri)

instance_deps[fmri] = svc_dependencies

# add the service FMRI

instance_deps["svc:{0}".format(svc_name)] = svc_dependencies

for fmri in fmris:

instance_mf[fmri] = manifest_path

return instance_mf, instance_deps

def has_smf_manifest_dir(path, prefix=None):

"""Determine if the given path string contains any of the directories

global manifest_locations

check_path = path

if prefix:

check_path = path.replace(prefix, "", 1)

for location in manifest_locations:

if check_path and check_path.startswith(location):

return True

return False