Logo Search packages:      
Sourcecode: zeroinstall-injector version File versions


00001 """In-memory representation of interfaces and other data structures.

The objects in this module are used to build a representation of an XML interface
file in memory.

@see: L{reader} constructs these data-structures.

@var defaults: Default values for the 'default' attribute for <environment> bindings of
well-known variables.

# Copyright (C) 2006, Thomas Leonard
# See the README file for details, or visit http://0install.net.

import os, re
from zeroinstall import SafeException

network_offline = 'off-line'
network_minimal = 'minimal'
network_full = 'full'
network_levels = (network_offline, network_minimal, network_full)

stability_levels = {}   # Name -> Stability

defaults = {
      'PATH': '/bin:/usr/bin',
      'XDG_CONFIG_DIRS': '/etc/xdg',
      'XDG_DATA_DIRS': '/usr/local/share:/usr/share',

00031 def _split_arch(arch):
      """Split an arch into an (os, machine) tuple. Either or both parts may be None."""
      if not arch:
            return None, None
      elif '-' not in arch:
            raise SafeException("Malformed arch '%s'" % arch)
            os, machine = arch.split('-', 1)
            if os == '*': os = None
            if machine == '*': machine = None
            return os, machine

def _join_arch(os, machine):
      if os == machine == None: return None
      return "%s-%s" % (os or '*', machine or '*')
00047 class Stability(object):
      """A stability rating. Each implementation has an upstream stability rating and,
      optionally, a user-set rating."""
      __slots__ = ['level', 'name', 'description']
      def __init__(self, level, name, description):
            self.level = level
            self.name = name
            self.description = description
            assert name not in stability_levels
            stability_levels[name] = self
      def __cmp__(self, other):
            return cmp(self.level, other.level)
      def __str__(self):
            return self.name

      def __repr__(self):
            return "<Stability: " + self.description + ">"

insecure = Stability(0, 'insecure', 'This is a security risk')
buggy = Stability(5, 'buggy', 'Known to have serious bugs')
developer = Stability(10, 'developer', 'Work-in-progress - bugs likely')
testing = Stability(20, 'testing', 'Stability unknown - please test!')
stable = Stability(30, 'stable', 'Tested - no serious problems found')
preferred = Stability(40, 'preferred', 'Best of all - must be set manually')

00074 class Restriction(object):
      """A Restriction limits the allowed implementations of an Interface."""
      __slots__ = ['before', 'not_before']
      def __init__(self, before, not_before):
            self.before = before
            self.not_before = not_before
      def meets_restriction(self, impl):
            if self.not_before and impl.version < self.not_before:
                  return False
            if self.before and impl.version >= self.before:
                  return False
            return True
      def __str__(self):
            if self.not_before is not None or self.before is not None:
                  range = ''
                  if self.not_before is not None:
                        range += format_version(self.not_before) + ' <= '
                  range += 'version'
                  if self.before is not None:
                        range += ' < ' + format_version(self.before)
                  range = 'none'
            return "(restriction: %s)" % range

00100 class Binding(object):
      """Information about how the choice of a Dependency is made known
      to the application being run."""

00104 class EnvironmentBinding(Binding):
      """Indicate the chosen implementation using an environment variable."""
      __slots__ = ['name', 'insert', 'default']

      def __init__(self, name, insert, default = None):
            self.name = name
            self.insert = insert
            self.default = default
      def __str__(self):
            return "<environ %s += %s>" % (self.name, self.insert)
      __repr__ = __str__
      def get_value(self, path, old_value):
            extra = os.path.join(path, self.insert)
            if old_value is None:
                  old_value = self.default or defaults.get(self.name, None)
            if old_value is None:
                  return extra
            return extra + ':' + old_value

00125 class Feed(object):
      """An interface's feeds are other interfaces whose implementations can also be
      used as implementations of this interface."""
      __slots__ = ['uri', 'os', 'machine', 'user_override']
      def __init__(self, uri, arch, user_override):
            self.uri = uri
            # This indicates whether the feed comes from the user's overrides
            # file. If true, writer.py will write it when saving.
            self.user_override = user_override
            self.os, self.machine = _split_arch(arch)
      def __str__(self):
            return "<Feed from %s>" % self.uri
      __repr__ = __str__

      arch = property(lambda self: _join_arch(self.os, self.machine))

00142 class Dependency(object):
      """A Dependency indicates that an Implementation requires some additional
      code to function, specified by another Interface.
      @ivar interface: the interface required by this dependency
      @type interface: str
      @ivar restrictions: a list of constraints on acceptable implementations
      @type restrictions: [L{Restriction}]
      @ivar bindings: how to make the choice of implementation known
      @type bindings: [L{Binding}]
      @ivar metadata: any extra attributes from the XML element
      @type metadata: {str: str}
      __slots__ = ['interface', 'restrictions', 'bindings', 'metadata']

      def __init__(self, interface, restrictions = None, metadata = None):
            assert isinstance(interface, (str, unicode))
            assert interface
            self.interface = interface
            if restrictions is None:
                  self.restrictions = []
                  self.restrictions = restrictions
            self.bindings = []
            if metadata is None:
                  metadata = {}
            self.metadata = metadata
      def __str__(self):
            return "<Dependency on %s; bindings: %s%s>" % (self.interface, self.bindings, self.restrictions)

00172 class RetrievalMethod(object):
      """A RetrievalMethod provides a way to fetch an implementation."""
      __slots__ = []

00176 class DownloadSource(RetrievalMethod):
      """A DownloadSource provides a way to fetch an implementation."""
      __slots__ = ['implementation', 'url', 'size', 'extract', 'start_offset', 'type']

      def __init__(self, implementation, url, size, extract, start_offset = 0, type = None):
            assert url.startswith('http:') or url.startswith('ftp:') or url.startswith('/')
            self.implementation = implementation
            self.url = url
            self.size = size
            self.extract = extract
            self.start_offset = start_offset
            self.type = type        # MIME type - see unpack.py

00189 class Recipe(RetrievalMethod):
      """Get an implementation by following a series of steps.
      @ivar size: the combined download sizes from all the steps
      @type size: int
      @ivar steps: the sequence of steps which must be performed
      @type steps: [L{RetrievalMethod}]"""
      __slots__ = ['steps']

      def __init__(self):
            self.steps = []
      size = property(lambda self: sum([x.size for x in self.steps]))

00202 class Implementation(object):
      """An Implementation is a package which implements an Interface."""
      __slots__ = ['os', 'machine', 'upstream_stability', 'user_stability',
                 'version', 'size', 'dependencies', 'main', 'metadata',
                 'id', 'download_sources', 'released', 'interface']

00208       def __init__(self, interface, id):
            """id can be a local path (string starting with /) or a manifest hash (eg "sha1=XXX")"""
            assert id
            self.interface = interface
            self.id = id
            self.main = None
            self.size = None
            self.version = None
            self.released = None
            self.user_stability = None
            self.upstream_stability = None
            self.os = None
            self.machine = None
            self.metadata = {}      # [URI + " "] + localName -> value
            self.dependencies = {}  # URI -> Dependency
            self.download_sources = []    # [RetrievalMethod]
00225       def add_download_source(self, url, size, extract, start_offset = 0, type = None):
            """Add a download source."""
            self.download_sources.append(DownloadSource(self, url, size, extract, start_offset, type))
      def get_stability(self):
            return self.user_stability or self.upstream_stability or testing
00232       def get_version(self):
            """Return the version as a string.
            @see: L{format_version}
            return format_version(self.version)
      def __str__(self):
            return self.id

00241       def __cmp__(self, other):
            """Newer versions come first"""
            return cmp(other.version, self.version)
      def set_arch(self, arch):
            self.os, self.machine = _split_arch(arch)
      arch = property(lambda self: _join_arch(self.os, self.machine), set_arch)
00249 class Interface(object):
      """An Interface represents some contract of behaviour."""
      __slots__ = ['uri', 'implementations', 'name', 'description', 'summary',
                 'stability_policy', 'last_modified', 'last_local_update', 'last_checked',
                 'main', 'feeds', 'feed_for', 'metadata']

      # last_local_update is deprecated
      # stability_policy:
      # Implementations at this level or higher are preferred.
      # Lower levels are used only if there is no other choice.

      def __init__(self, uri):
            assert uri
            if uri.startswith('http:') or uri.startswith('/'):
                  self.uri = uri
                  raise SafeException("Interface name '%s' doesn't start "
                                  "with 'http:'" % uri)

      def reset(self):
            self.implementations = {}     # Path -> Implementation
            self.name = None
            self.summary = None
            self.description = None
            self.stability_policy = None
            self.last_modified = None
            self.last_local_update = None
            self.last_checked = None
            self.main = None
            self.feeds = []
            self.feed_for = {}      # URI -> True
            self.metadata = []
      def get_name(self):
            return self.name or '(' + os.path.basename(self.uri) + ')'
      def __repr__(self):
            return "<Interface %s>" % self.uri
      def get_impl(self, id):
            if id not in self.implementations:
                  self.implementations[id] = Implementation(self, id)
            return self.implementations[id]
      def set_stability_policy(self, new):
            assert new is None or isinstance(new, Stability)
            self.stability_policy = new
      def get_feed(self, uri):
            for x in self.feeds:
                  if x.uri == uri:
                        return x
            return None
      def add_metadata(self, elem):
00308       def get_metadata(self, uri, name):
            """Return a list of interface metadata elements with this name and namespace URI."""
            return [m for m in self.metadata if m.name == name and m.uri == uri]

00312 def unescape(uri):
      """Convert each %20 to a space, etc.
      @rtype: str"""
      if '%' not in uri: return uri
      import re
      return re.sub('%[0-9a-fA-F][0-9a-fA-F]',
            lambda match: chr(int(match.group(0)[1:], 16)),

00321 def escape(uri):
      """Convert each space to %20, etc
      @rtype: str"""
      import re
      return re.sub('[^-_.a-zA-Z0-9]',
            lambda match: '%%%02x' % ord(match.group(0)),

00329 def canonical_iface_uri(uri):
      """If uri is a relative path, convert to an absolute one.
      Otherwise, return it unmodified.
      @rtype: str
      @raise SafeException: if uri isn't valid
      if uri.startswith('http:'):
            return uri
            iface_uri = os.path.realpath(uri)
            if os.path.isfile(iface_uri):
                  return iface_uri
      raise SafeException("Bad interface name '%s'.\n"
                  "(doesn't start with 'http:', and "
                  "doesn't exist as a local file '%s' either)" %
                  (uri, iface_uri))

_version_mod_to_value = {
      'pre': -2,
      'rc': -1,
      '': 0,
      'post': 1,

# Reverse mapping
_version_value_to_mod = {}
for x in _version_mod_to_value: _version_value_to_mod[_version_mod_to_value[x]] = x
del x

_version_re = re.compile('-([a-z]*)')

00360 def parse_version(version_string):
      """Convert a version string to an internal representation.
      The parsed format can be compared quickly using the standard Python functions.
       - Version := DottedList ("-" Mod DottedList?)*
       - DottedList := (Integer ("." Integer)*)
      @rtype: tuple (opaque)
      @since: 0.24 (moved from L{reader}, from where it is still available):"""
      if version_string is None: return None
      parts = _version_re.split(version_string)
      if parts[-1] == '':
            del parts[-1]     # Ends with a modifier
      if not parts:
            raise SafeException("Empty version string!")
      l = len(parts)
            for x in range(0, l, 2):
                  part = parts[x]
                  if part:
                        parts[x] = map(int, parts[x].split('.'))
                        parts[x] = []     # (because ''.split('.') == [''], not [])
            for x in range(1, l, 2):
                  parts[x] = _version_mod_to_value[parts[x]]
            return parts
      except ValueError, ex:
            raise SafeException("Invalid version format in '%s': %s" % (version_string, ex))
      except KeyError, ex:
            raise SafeException("Invalid version modifier in '%s': %s" % (version_string, ex))

00391 def format_version(version):
      """Format a parsed version for display. Undoes the effect of L{parse_version}.
      @see: L{Implementation.get_version}
      @rtype: str
      @since: 0.24"""
      version = version[:]
      l = len(version)
      for x in range(0, l, 2):
            version[x] = '.'.join(map(str, version[x]))
      for x in range(1, l, 2):
            version[x] = '-' + _version_value_to_mod[version[x]]
      if version[-1] == '-': del version[-1]
      return ''.join(version)

Generated by  Doxygen 1.6.0   Back to index