1 """In-memory representation of interfaces and other data structures.
3 The objects in this module are used to build a representation of an XML interface
6 @see: L{reader} constructs these data-structures
7 @see: U{http://0install.net/interface-spec.html} description of the domain model
9 @var defaults: Default values for the 'default' attribute for <environment> bindings of
13 # Copyright (C) 2009, Thomas Leonard
14 # See the README file for details, or visit http://0install.net.
16 from zeroinstall
import _
18 from logging
import info
, debug
, warn
19 from zeroinstall
import SafeException
, version
20 from zeroinstall
.injector
.namespaces
import XMLNS_IFACE
21 from zeroinstall
.injector
import qdom
23 # Element names for bindings in feed files
24 binding_names
= frozenset(['environment', 'overlay'])
26 network_offline
= 'off-line'
27 network_minimal
= 'minimal'
29 network_levels
= (network_offline
, network_minimal
, network_full
)
31 stability_levels
= {} # Name -> Stability
34 'PATH': '/bin:/usr/bin',
35 'XDG_CONFIG_DIRS': '/etc/xdg',
36 'XDG_DATA_DIRS': '/usr/local/share:/usr/share',
39 class InvalidInterface(SafeException
):
40 """Raised when parsing an invalid feed."""
43 def __init__(self
, message
, ex
= None):
46 message
+= "\n\n(exact error: %s)" % ex
48 # Some Python messages have type str but contain UTF-8 sequences.
49 # (e.g. IOException). Adding these to a Unicode 'message' (e.g.
50 # after gettext translation) will cause an error.
52 decoder
= codecs
.lookup('utf-8')
53 decex
= decoder
.decode(str(ex
), errors
= 'replace')[0]
54 message
+= "\n\n(exact error: %s)" % decex
56 SafeException
.__init
__(self
, message
)
60 return SafeException
.__str
__(self
) + ' in ' + self
.feed_url
61 return SafeException
.__str
__(self
)
63 def _split_arch(arch
):
64 """Split an arch into an (os, machine) tuple. Either or both parts may be None."""
68 raise SafeException(_("Malformed arch '%s'") % arch
)
70 osys
, machine
= arch
.split('-', 1)
71 if osys
== '*': osys
= None
72 if machine
== '*': machine
= None
75 def _join_arch(osys
, machine
):
76 if osys
== machine
== None: return None
77 return "%s-%s" % (osys
or '*', machine
or '*')
79 def _best_language_match(options
):
80 (language
, encoding
) = locale
.getlocale(locale
.LC_ALL
)
81 return (options
.get(language
, None) or
82 options
.get(language
.split('_', 1)[0], None) or
83 options
.get(None, None))
85 class Stability(object):
86 """A stability rating. Each implementation has an upstream stability rating and,
87 optionally, a user-set rating."""
88 __slots__
= ['level', 'name', 'description']
89 def __init__(self
, level
, name
, description
):
92 self
.description
= description
93 assert name
not in stability_levels
94 stability_levels
[name
] = self
96 def __cmp__(self
, other
):
97 return cmp(self
.level
, other
.level
)
103 return _("<Stability: %s>") % self
.description
105 def process_binding(e
):
107 if e
.name
== 'environment':
109 None: EnvironmentBinding
.PREPEND
,
110 'prepend': EnvironmentBinding
.PREPEND
,
111 'append': EnvironmentBinding
.APPEND
,
112 'replace': EnvironmentBinding
.REPLACE
,
113 }[e
.getAttribute('mode')]
115 binding
= EnvironmentBinding(e
.getAttribute('name'),
116 insert
= e
.getAttribute('insert'),
117 default
= e
.getAttribute('default'),
119 if not binding
.name
: raise InvalidInterface(_("Missing 'name' in binding"))
120 if binding
.insert
is None: raise InvalidInterface(_("Missing 'insert' in binding"))
122 elif e
.name
== 'overlay':
123 return OverlayBinding(e
.getAttribute('src'), e
.getAttribute('mount-point'))
125 raise Exception(_("Unknown binding type '%s'") % e
.name
)
127 def process_depends(item
, local_feed_dir
):
129 # Note: also called from selections
131 dep_iface
= item
.getAttribute('interface')
133 raise InvalidInterface(_("Missing 'interface' on <%s>") % item
.name
)
134 if dep_iface
.startswith('./'):
136 dep_iface
= os
.path
.abspath(os
.path
.join(local_feed_dir
, dep_iface
))
137 # (updates the element too, in case we write it out again)
138 attrs
['interface'] = dep_iface
140 raise InvalidInterface(_('Relative interface URI "%s" in non-local feed') % dep_iface
)
141 dependency
= InterfaceDependency(dep_iface
, element
= item
)
143 for e
in item
.childNodes
:
144 if e
.uri
!= XMLNS_IFACE
: continue
145 if e
.name
in binding_names
:
146 dependency
.bindings
.append(process_binding(e
))
147 elif e
.name
== 'version':
148 dependency
.restrictions
.append(
149 VersionRangeRestriction(not_before
= parse_version(e
.getAttribute('not-before')),
150 before
= parse_version(e
.getAttribute('before'))))
153 def N_(message
): return message
155 insecure
= Stability(0, N_('insecure'), _('This is a security risk'))
156 buggy
= Stability(5, N_('buggy'), _('Known to have serious bugs'))
157 developer
= Stability(10, N_('developer'), _('Work-in-progress - bugs likely'))
158 testing
= Stability(20, N_('testing'), _('Stability unknown - please test!'))
159 stable
= Stability(30, N_('stable'), _('Tested - no serious problems found'))
160 packaged
= Stability(35, N_('packaged'), _('Supplied by the local package manager'))
161 preferred
= Stability(40, N_('preferred'), _('Best of all - must be set manually'))
165 class Restriction(object):
166 """A Restriction limits the allowed implementations of an Interface."""
169 def meets_restriction(self
, impl
):
170 """Called by the L{solver.Solver} to check whether a particular implementation is acceptable.
171 @return: False if this implementation is not a possibility
174 raise NotImplementedError(_("Abstract"))
176 class VersionRestriction(Restriction
):
177 """Only select implementations with a particular version number.
180 def __init__(self
, version
):
181 """@param version: the required version number
182 @see: L{parse_version}; use this to pre-process the version number
184 self
.version
= version
186 def meets_restriction(self
, impl
):
187 return impl
.version
== self
.version
190 return _("(restriction: version = %s)") % format_version(self
.version
)
192 class VersionRangeRestriction(Restriction
):
193 """Only versions within the given range are acceptable"""
194 __slots__
= ['before', 'not_before']
196 def __init__(self
, before
, not_before
):
197 """@param before: chosen versions must be earlier than this
198 @param not_before: versions must be at least this high
199 @see: L{parse_version}; use this to pre-process the versions
202 self
.not_before
= not_before
204 def meets_restriction(self
, impl
):
205 if self
.not_before
and impl
.version
< self
.not_before
:
207 if self
.before
and impl
.version
>= self
.before
:
212 if self
.not_before
is not None or self
.before
is not None:
214 if self
.not_before
is not None:
215 range += format_version(self
.not_before
) + ' <= '
217 if self
.before
is not None:
218 range += ' < ' + format_version(self
.before
)
221 return _("(restriction: %s)") % range
223 class Binding(object):
224 """Information about how the choice of a Dependency is made known
225 to the application being run."""
227 class EnvironmentBinding(Binding
):
228 """Indicate the chosen implementation using an environment variable."""
229 __slots__
= ['name', 'insert', 'default', 'mode']
235 def __init__(self
, name
, insert
, default
= None, mode
= PREPEND
):
236 """mode argument added in version 0.28"""
239 self
.default
= default
243 return _("<environ %(name)s %(mode)s %(insert)s>") % {'name': self
.name
,'mode': self
.mode
, 'insert': self
.insert
}
247 def get_value(self
, path
, old_value
):
248 """Calculate the new value of the environment variable after applying this binding.
249 @param path: the path to the selected implementation
250 @param old_value: the current value of the environment variable
251 @return: the new value for the environment variable"""
252 extra
= os
.path
.join(path
, self
.insert
)
254 if self
.mode
== EnvironmentBinding
.REPLACE
:
257 if old_value
is None:
258 old_value
= self
.default
or defaults
.get(self
.name
, None)
259 if old_value
is None:
261 if self
.mode
== EnvironmentBinding
.PREPEND
:
262 return extra
+ os
.pathsep
+ old_value
264 return old_value
+ os
.pathsep
+ extra
266 def _toxml(self
, doc
):
267 """Create a DOM element for this binding.
268 @param doc: document to use to create the element
269 @return: the new element
271 env_elem
= doc
.createElementNS(XMLNS_IFACE
, 'environment')
272 env_elem
.setAttributeNS(None, 'name', self
.name
)
273 env_elem
.setAttributeNS(None, 'insert', self
.insert
)
275 env_elem
.setAttributeNS(None, 'default', self
.default
)
278 class OverlayBinding(Binding
):
279 """Make the chosen implementation available by overlaying it onto another part of the file-system.
280 This is to support legacy programs which use hard-coded paths."""
281 __slots__
= ['src', 'mount_point']
283 def __init__(self
, src
, mount_point
):
285 self
.mount_point
= mount_point
288 return _("<overlay %(src)s on %(mount_point)s>") % {'src': self
.src
or '.', 'mount_point': self
.mount_point
or '/'}
292 def _toxml(self
, doc
):
293 """Create a DOM element for this binding.
294 @param doc: document to use to create the element
295 @return: the new element
297 env_elem
= doc
.createElementNS(XMLNS_IFACE
, 'overlay')
298 if self
.src
is not None:
299 env_elem
.setAttributeNS(None, 'src', self
.src
)
300 if self
.mount_point
is not None:
301 env_elem
.setAttributeNS(None, 'mount-point', self
.mount_point
)
305 """An interface's feeds are other interfaces whose implementations can also be
306 used as implementations of this interface."""
307 __slots__
= ['uri', 'os', 'machine', 'user_override', 'langs']
308 def __init__(self
, uri
, arch
, user_override
, langs
= None):
310 # This indicates whether the feed comes from the user's overrides
311 # file. If true, writer.py will write it when saving.
312 self
.user_override
= user_override
313 self
.os
, self
.machine
= _split_arch(arch
)
317 return "<Feed from %s>" % self
.uri
320 arch
= property(lambda self
: _join_arch(self
.os
, self
.machine
))
322 class Dependency(object):
323 """A Dependency indicates that an Implementation requires some additional
324 code to function. This is an abstract base class.
325 @ivar qdom: the XML element for this Dependency (since 0launch 0.51)
326 @type qdom: L{qdom.Element}
327 @ivar metadata: any extra attributes from the XML element
328 @type metadata: {str: str}
332 def __init__(self
, element
):
333 assert isinstance(element
, qdom
.Element
), type(element
) # Use InterfaceDependency instead!
338 return self
.qdom
.attrs
340 class InterfaceDependency(Dependency
):
341 """A Dependency on a Zero Install interface.
342 @ivar interface: the interface required by this dependency
344 @ivar restrictions: a list of constraints on acceptable implementations
345 @type restrictions: [L{Restriction}]
346 @ivar bindings: how to make the choice of implementation known
347 @type bindings: [L{Binding}]
350 __slots__
= ['interface', 'restrictions', 'bindings']
352 def __init__(self
, interface
, restrictions
= None, element
= None):
353 Dependency
.__init
__(self
, element
)
354 assert isinstance(interface
, (str, unicode))
356 self
.interface
= interface
357 if restrictions
is None:
358 self
.restrictions
= []
360 self
.restrictions
= restrictions
364 return _("<Dependency on %(interface)s; bindings: %(bindings)s%(restrictions)s>") % {'interface': self
.interface
, 'bindings': self
.bindings
, 'restrictions': self
.restrictions
}
366 class RetrievalMethod(object):
367 """A RetrievalMethod provides a way to fetch an implementation."""
370 class DownloadSource(RetrievalMethod
):
371 """A DownloadSource provides a way to fetch an implementation."""
372 __slots__
= ['implementation', 'url', 'size', 'extract', 'start_offset', 'type']
374 def __init__(self
, implementation
, url
, size
, extract
, start_offset
= 0, type = None):
375 self
.implementation
= implementation
378 self
.extract
= extract
379 self
.start_offset
= start_offset
380 self
.type = type # MIME type - see unpack.py
382 class Recipe(RetrievalMethod
):
383 """Get an implementation by following a series of steps.
384 @ivar size: the combined download sizes from all the steps
386 @ivar steps: the sequence of steps which must be performed
387 @type steps: [L{RetrievalMethod}]"""
388 __slots__
= ['steps']
393 size
= property(lambda self
: sum([x
.size
for x
in self
.steps
]))
395 class DistributionSource(RetrievalMethod
):
396 """A package that is installed using the distribution's tools (including PackageKit).
397 @ivar install: a function to call to install this package
398 @type install: (L{handler.Handler}) -> L{tasks.Blocker}
399 @ivar package_id: the package name, in a form recognised by the distribution's tools
400 @type package_id: str
401 @ivar size: the download size in bytes
403 @ivar needs_confirmation: whether the user should be asked to confirm before calling install()
404 @type needs_confirmation: bool"""
406 __slots__
= ['package_id', 'size', 'install', 'needs_confirmation']
408 def __init__(self
, package_id
, size
, install
, needs_confirmation
= True):
409 RetrievalMethod
.__init
__(self
)
410 self
.package_id
= package_id
412 self
.install
= install
413 self
.needs_confirmation
= needs_confirmation
415 class Command(object):
416 """A Command is a way of running an Implementation as a program."""
418 __slots__
= ['qdom', '_depends', '_local_dir', '_runner']
420 def __init__(self
, qdom
, local_dir
):
421 """@param qdom: the <command> element
422 @param local_dir: the directory containing the feed (for relative dependencies), or None if not local
424 assert qdom
.name
== 'command', 'not <command>: %s' % qdom
426 self
._local
_dir
= local_dir
429 path
= property(lambda self
: self
.qdom
.attrs
.get("path", None))
431 def _toxml(self
, doc
, prefixes
):
432 return self
.qdom
.toDOM(doc
, prefixes
)
436 if self
._depends
is None:
439 for child
in self
.qdom
.childNodes
:
440 if child
.name
== 'requires':
441 dep
= process_depends(child
, self
._local
_dir
)
443 elif child
.name
== 'runner':
445 raise InvalidInterface(_("Multiple <runner>s in <command>!"))
446 dep
= process_depends(child
, self
._local
_dir
)
449 self
._depends
= depends
452 def get_runner(self
):
453 self
.requires
# (sets _runner)
456 class Implementation(object):
457 """An Implementation is a package which implements an Interface.
458 @ivar download_sources: list of methods of getting this implementation
459 @type download_sources: [L{RetrievalMethod}]
460 @ivar feed: the feed owning this implementation (since 0.32)
461 @type feed: [L{ZeroInstallFeed}]
462 @ivar bindings: how to tell this component where it itself is located (since 0.31)
463 @type bindings: [Binding]
464 @ivar upstream_stability: the stability reported by the packager
465 @type upstream_stability: [insecure | buggy | developer | testing | stable | packaged]
466 @ivar user_stability: the stability as set by the user
467 @type upstream_stability: [insecure | buggy | developer | testing | stable | packaged | preferred]
468 @ivar langs: natural languages supported by this package
470 @ivar requires: interfaces this package depends on
471 @type requires: [L{Dependency}]
472 @ivar commands: ways to execute as a program
473 @type commands: {str: Command}
474 @ivar metadata: extra metadata from the feed
475 @type metadata: {"[URI ]localName": str}
476 @ivar id: a unique identifier for this Implementation
477 @ivar version: a parsed version number
478 @ivar released: release date
479 @ivar local_path: the directory containing this local implementation, or None if it isn't local (id isn't a path)
480 @type local_path: str | None
481 @ivar requires_root_install: whether the user will need admin rights to use this
482 @type requires_root_install: bool
485 # Note: user_stability shouldn't really be here
487 __slots__
= ['upstream_stability', 'user_stability', 'langs',
488 'requires', 'metadata', 'download_sources', 'commands',
489 'id', 'feed', 'version', 'released', 'bindings', 'machine']
491 def __init__(self
, feed
, id):
495 self
.user_stability
= None
496 self
.upstream_stability
= None
497 self
.metadata
= {} # [URI + " "] + localName -> value
501 self
.download_sources
= []
507 def get_stability(self
):
508 return self
.user_stability
or self
.upstream_stability
or testing
514 return "v%s (%s)" % (self
.get_version(), self
.id)
516 def __cmp__(self
, other
):
517 """Newer versions come first"""
518 d
= cmp(other
.version
, self
.version
)
520 # If the version number is the same, just give a stable sort order, and
521 # ensure that two different implementations don't compare equal.
522 d
= cmp(other
.feed
.url
, self
.feed
.url
)
524 return cmp(other
.id, self
.id)
526 def get_version(self
):
527 """Return the version as a string.
528 @see: L{format_version}
530 return format_version(self
.version
)
532 arch
= property(lambda self
: _join_arch(self
.os
, self
.machine
))
537 requires_root_install
= False
540 """"@deprecated: use commands["run"] instead"""
541 main
= self
.commands
.get("run", None)
545 def _set_main(self
, path
):
546 """"@deprecated: use commands["run"] instead"""
548 if "run" in self
.commands
:
549 del self
.commands
["run"]
551 self
.commands
["run"] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'path': path
}), None)
552 main
= property(_get_main
, _set_main
)
554 class DistributionImplementation(Implementation
):
555 """An implementation provided by the distribution. Information such as the version
556 comes from the package manager.
558 __slots__
= ['distro', 'installed']
560 def __init__(self
, feed
, id, distro
):
561 assert id.startswith('package:')
562 Implementation
.__init
__(self
, feed
, id)
564 self
.installed
= False
567 def requires_root_install(self
):
568 return not self
.installed
570 class ZeroInstallImplementation(Implementation
):
571 """An implementation where all the information comes from Zero Install.
572 @ivar digests: a list of "algorith=value" strings (since 0.45)
575 __slots__
= ['os', 'size', 'digests', 'local_path']
577 def __init__(self
, feed
, id, local_path
):
578 """id can be a local path (string starting with /) or a manifest hash (eg "sha1=XXX")"""
579 assert not id.startswith('package:'), id
580 Implementation
.__init
__(self
, feed
, id)
584 self
.local_path
= local_path
587 dependencies
= property(lambda self
: dict([(x
.interface
, x
) for x
in self
.requires
588 if isinstance(x
, InterfaceDependency
)]))
590 def add_download_source(self
, url
, size
, extract
, start_offset
= 0, type = None):
591 """Add a download source."""
592 self
.download_sources
.append(DownloadSource(self
, url
, size
, extract
, start_offset
, type))
594 def set_arch(self
, arch
):
595 self
.os
, self
.machine
= _split_arch(arch
)
596 arch
= property(lambda self
: _join_arch(self
.os
, self
.machine
), set_arch
)
598 class Interface(object):
599 """An Interface represents some contract of behaviour.
600 @ivar uri: the URI for this interface.
601 @ivar stability_policy: user's configured policy.
602 Implementations at this level or higher are preferred.
603 Lower levels are used only if there is no other choice.
605 __slots__
= ['uri', 'stability_policy', 'extra_feeds']
607 implementations
= property(lambda self
: self
._main
_feed
.implementations
)
608 name
= property(lambda self
: self
._main
_feed
.name
)
609 description
= property(lambda self
: self
._main
_feed
.description
)
610 summary
= property(lambda self
: self
._main
_feed
.summary
)
611 last_modified
= property(lambda self
: self
._main
_feed
.last_modified
)
612 feeds
= property(lambda self
: self
.extra_feeds
+ self
._main
_feed
.feeds
)
613 metadata
= property(lambda self
: self
._main
_feed
.metadata
)
615 last_checked
= property(lambda self
: self
._main
_feed
.last_checked
)
617 def __init__(self
, uri
):
619 if uri
.startswith('http:') or uri
.startswith('https:') or os
.path
.isabs(uri
):
622 raise SafeException(_("Interface name '%s' doesn't start "
623 "with 'http:' or 'https:'") % uri
)
626 def _get_feed_for(self
):
628 for key
in self
._main
_feed
.feed_for
:
631 feed_for
= property(_get_feed_for
) # Deprecated (used by 0publish)
634 self
.extra_feeds
= []
635 self
.stability_policy
= None
638 from zeroinstall
.injector
.iface_cache
import iface_cache
639 feed
= iface_cache
.get_feed(self
.uri
)
641 return feed
.get_name()
642 return '(' + os
.path
.basename(self
.uri
) + ')'
645 return _("<Interface %s>") % self
.uri
647 def set_stability_policy(self
, new
):
648 assert new
is None or isinstance(new
, Stability
)
649 self
.stability_policy
= new
651 def get_feed(self
, url
):
653 #warnings.warn("use iface_cache.get_feed instead", DeprecationWarning, 2)
654 for x
in self
.extra_feeds
:
657 #return self._main_feed.get_feed(url)
660 def get_metadata(self
, uri
, name
):
661 return self
._main
_feed
.get_metadata(uri
, name
)
664 def _main_feed(self
):
666 #warnings.warn("use the feed instead", DeprecationWarning, 3)
667 from zeroinstall
.injector
import policy
668 iface_cache
= policy
.get_deprecated_singleton_config().iface_cache
669 feed
= iface_cache
.get_feed(self
.uri
)
674 def _merge_attrs(attrs
, item
):
675 """Add each attribute of item to a copy of attrs and return the copy.
676 @type attrs: {str: str}
677 @type item: L{qdom.Element}
682 new
[str(a
)] = item
.attrs
[a
]
685 def _get_long(elem
, attr_name
):
686 val
= elem
.getAttribute(attr_name
)
691 raise SafeException(_("Invalid value for integer attribute '%(attribute_name)s': %(value)s") % {'attribute_name': attr_name
, 'value': val
})
694 class ZeroInstallFeed(object):
695 """A feed lists available implementations of an interface.
696 @ivar url: the URL for this feed
697 @ivar implementations: Implementations in this feed, indexed by ID
698 @type implementations: {str: L{Implementation}}
699 @ivar name: human-friendly name
700 @ivar summaries: short textual description (in various languages, since 0.49)
701 @type summaries: {str: str}
702 @ivar descriptions: long textual description (in various languages, since 0.49)
703 @type descriptions: {str: str}
704 @ivar last_modified: timestamp on signature
705 @ivar last_checked: time feed was last successfully downloaded and updated
706 @ivar feeds: list of <feed> elements in this feed
707 @type feeds: [L{Feed}]
708 @ivar feed_for: interfaces for which this could be a feed
709 @type feed_for: set(str)
710 @ivar metadata: extra elements we didn't understand
712 # _main is deprecated
713 __slots__
= ['url', 'implementations', 'name', 'descriptions', 'summaries', '_package_implementations',
714 'last_checked', 'last_modified', 'feeds', 'feed_for', 'metadata']
716 def __init__(self
, feed_element
, local_path
= None, distro
= None):
717 """Create a feed object from a DOM.
718 @param feed_element: the root element of a feed file
719 @type feed_element: L{qdom.Element}
720 @param local_path: the pathname of this local feed, or None for remote feeds"""
721 self
.implementations
= {}
723 self
.summaries
= {} # { lang: str }
724 self
.descriptions
= {} # { lang: str }
725 self
.last_modified
= None
727 self
.feed_for
= set()
729 self
.last_checked
= None
730 self
._package
_implementations
= []
732 if distro
is not None:
734 warnings
.warn("distro argument is now ignored", DeprecationWarning, 2)
736 if feed_element
is None:
737 return # XXX subclass?
739 assert feed_element
.name
in ('interface', 'feed'), "Root element should be <interface>, not %s" % feed_element
740 assert feed_element
.uri
== XMLNS_IFACE
, "Wrong namespace on root element: %s" % feed_element
.uri
742 main
= feed_element
.getAttribute('main')
743 #if main: warn("Setting 'main' on the root element is deprecated. Put it on a <group> instead")
746 self
.url
= local_path
747 local_dir
= os
.path
.dirname(local_path
)
749 self
.url
= feed_element
.getAttribute('uri')
751 raise InvalidInterface(_("<interface> uri attribute missing"))
752 local_dir
= None # Can't have relative paths
754 min_injector_version
= feed_element
.getAttribute('min-injector-version')
755 if min_injector_version
:
756 if parse_version(min_injector_version
) > parse_version(version
):
757 raise InvalidInterface(_("This feed requires version %(min_version)s or later of "
758 "Zero Install, but I am only version %(version)s. "
759 "You can get a newer version from http://0install.net") %
760 {'min_version': min_injector_version
, 'version': version
})
762 for x
in feed_element
.childNodes
:
763 if x
.uri
!= XMLNS_IFACE
:
764 self
.metadata
.append(x
)
767 self
.name
= x
.content
768 elif x
.name
== 'description':
769 self
.descriptions
[x
.attrs
.get("http://www.w3.org/XML/1998/namespace lang", None)] = x
.content
770 elif x
.name
== 'summary':
771 self
.summaries
[x
.attrs
.get("http://www.w3.org/XML/1998/namespace lang", None)] = x
.content
772 elif x
.name
== 'feed-for':
773 feed_iface
= x
.getAttribute('interface')
775 raise InvalidInterface(_('Missing "interface" attribute in <feed-for>'))
776 self
.feed_for
.add(feed_iface
)
777 # Bug report from a Debian/stable user that --feed gets the wrong value.
778 # Can't reproduce (even in a Debian/stable chroot), but add some logging here
779 # in case it happens again.
780 debug(_("Is feed-for %s"), feed_iface
)
781 elif x
.name
== 'feed':
782 feed_src
= x
.getAttribute('src')
784 raise InvalidInterface(_('Missing "src" attribute in <feed>'))
785 if feed_src
.startswith('http:') or feed_src
.startswith('https:') or local_path
:
786 self
.feeds
.append(Feed(feed_src
, x
.getAttribute('arch'), False, langs
= x
.getAttribute('langs')))
788 raise InvalidInterface(_("Invalid feed URL '%s'") % feed_src
)
790 self
.metadata
.append(x
)
793 raise InvalidInterface(_("Missing <name> in feed"))
795 raise InvalidInterface(_("Missing <summary> in feed"))
797 def process_group(group
, group_attrs
, base_depends
, base_bindings
, base_commands
):
798 for item
in group
.childNodes
:
799 if item
.uri
!= XMLNS_IFACE
: continue
801 if item
.name
not in ('group', 'implementation', 'package-implementation'):
804 depends
= base_depends
[:]
805 bindings
= base_bindings
[:]
806 commands
= base_commands
.copy()
808 item_attrs
= _merge_attrs(group_attrs
, item
)
810 # We've found a group or implementation. Scan for dependencies
811 # and bindings. Doing this here means that:
812 # - We can share the code for groups and implementations here.
813 # - The order doesn't matter, because these get processed first.
814 # A side-effect is that the document root cannot contain
816 for child
in item
.childNodes
:
817 if child
.uri
!= XMLNS_IFACE
: continue
818 if child
.name
== 'requires':
819 dep
= process_depends(child
, local_dir
)
821 elif child
.name
== 'command':
822 command_name
= child
.attrs
.get('name', None)
824 raise InvalidInterface('Missing name for <command>')
825 commands
[command_name
] = Command(child
, local_dir
)
826 elif child
.name
in binding_names
:
827 bindings
.append(process_binding(child
))
829 for attr
, command
in [('main', 'run'),
830 ('self-test', 'test')]:
831 value
= item
.attrs
.get(attr
, None)
832 if value
is not None:
833 commands
[command
] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'path': value
}), None)
835 compile_command
= item
.attrs
.get('http://zero-install.sourceforge.net/2006/namespaces/0compile command')
836 if compile_command
is not None:
837 commands
['compile'] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'shell-command': compile_command
}), None)
839 if item
.name
== 'group':
840 process_group(item
, item_attrs
, depends
, bindings
, commands
)
841 elif item
.name
== 'implementation':
842 process_impl(item
, item_attrs
, depends
, bindings
, commands
)
843 elif item
.name
== 'package-implementation':
845 warn("A <package-implementation> with dependencies in %s!", self
.url
)
846 self
._package
_implementations
.append((item
, item_attrs
))
850 def process_impl(item
, item_attrs
, depends
, bindings
, commands
):
851 id = item
.getAttribute('id')
853 raise InvalidInterface(_("Missing 'id' attribute on %s") % item
)
854 local_path
= item_attrs
.get('local-path')
855 if local_dir
and local_path
:
856 abs_local_path
= os
.path
.abspath(os
.path
.join(local_dir
, local_path
))
857 impl
= ZeroInstallImplementation(self
, id, abs_local_path
)
858 elif local_dir
and (id.startswith('/') or id.startswith('.')):
860 id = os
.path
.abspath(os
.path
.join(local_dir
, id))
861 impl
= ZeroInstallImplementation(self
, id, id)
863 impl
= ZeroInstallImplementation(self
, id, None)
865 # In older feeds, the ID was the (single) digest
866 impl
.digests
.append(id)
867 if id in self
.implementations
:
868 warn(_("Duplicate ID '%(id)s' in feed '%(feed)s'"), {'id': id, 'feed': self
})
869 self
.implementations
[id] = impl
871 impl
.metadata
= item_attrs
873 version_mod
= item_attrs
.get('version-modifier', None)
875 item_attrs
['version'] += version_mod
876 del item_attrs
['version-modifier']
877 version
= item_attrs
['version']
879 raise InvalidInterface(_("Missing version attribute"))
880 impl
.version
= parse_version(version
)
882 impl
.commands
= commands
884 impl
.released
= item_attrs
.get('released', None)
885 impl
.langs
= item_attrs
.get('langs', '')
887 size
= item
.getAttribute('size')
889 impl
.size
= long(size
)
890 impl
.arch
= item_attrs
.get('arch', None)
892 stability
= stability_levels
[str(item_attrs
['stability'])]
894 stab
= str(item_attrs
['stability'])
895 if stab
!= stab
.lower():
896 raise InvalidInterface(_('Stability "%s" invalid - use lower case!') % item_attrs
.stability
)
897 raise InvalidInterface(_('Stability "%s" invalid') % item_attrs
['stability'])
898 if stability
>= preferred
:
899 raise InvalidInterface(_("Upstream can't set stability to preferred!"))
900 impl
.upstream_stability
= stability
902 impl
.bindings
= bindings
903 impl
.requires
= depends
905 for elem
in item
.childNodes
:
906 if elem
.uri
!= XMLNS_IFACE
: continue
907 if elem
.name
== 'archive':
908 url
= elem
.getAttribute('href')
910 raise InvalidInterface(_("Missing href attribute on <archive>"))
911 size
= elem
.getAttribute('size')
913 raise InvalidInterface(_("Missing size attribute on <archive>"))
914 impl
.add_download_source(url
= url
, size
= long(size
),
915 extract
= elem
.getAttribute('extract'),
916 start_offset
= _get_long(elem
, 'start-offset'),
917 type = elem
.getAttribute('type'))
918 elif elem
.name
== 'manifest-digest':
919 for aname
, avalue
in elem
.attrs
.iteritems():
921 impl
.digests
.append('%s=%s' % (aname
, avalue
))
922 elif elem
.name
== 'recipe':
924 for recipe_step
in elem
.childNodes
:
925 if recipe_step
.uri
== XMLNS_IFACE
and recipe_step
.name
== 'archive':
926 url
= recipe_step
.getAttribute('href')
928 raise InvalidInterface(_("Missing href attribute on <archive>"))
929 size
= recipe_step
.getAttribute('size')
931 raise InvalidInterface(_("Missing size attribute on <archive>"))
932 recipe
.steps
.append(DownloadSource(None, url
= url
, size
= long(size
),
933 extract
= recipe_step
.getAttribute('extract'),
934 start_offset
= _get_long(recipe_step
, 'start-offset'),
935 type = recipe_step
.getAttribute('type')))
937 info(_("Unknown step '%s' in recipe; skipping recipe"), recipe_step
.name
)
940 impl
.download_sources
.append(recipe
)
942 root_attrs
= {'stability': 'testing'}
945 info("Note: @main on document element is deprecated in %s", self
)
946 root_commands
['run'] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'path': main
}), None)
947 process_group(feed_element
, root_attrs
, [], [], root_commands
)
949 def get_distro_feed(self
):
950 """Does this feed contain any <pacakge-implementation> elements?
951 i.e. is it worth asking the package manager for more information?
952 @return: the URL of the virtual feed, or None
954 if self
._package
_implementations
:
955 return "distribution:" + self
.url
958 def get_package_impls(self
, distro
):
959 """Find the best <pacakge-implementation> element(s) for the given distribution.
960 @param distro: the distribution to use to rate them
961 @type distro: L{distro.Distribution}
962 @return: a list of tuples for the best ranked elements
968 for item
, item_attrs
in self
._package
_implementations
:
969 distro_names
= item_attrs
.get('distributions', '')
970 for distro_name
in distro_names
.split(' '):
971 score
= distro
.get_score(distro_name
)
972 if score
> best_score
:
975 if score
== best_score
:
976 best_impls
.append((item
, item_attrs
))
980 return self
.name
or '(' + os
.path
.basename(self
.url
) + ')'
983 return _("<Feed %s>") % self
.url
986 def _get_impl(self
, id):
987 assert id not in self
.implementations
989 if id.startswith('.') or id.startswith('/'):
990 id = os
.path
.abspath(os
.path
.join(self
.url
, id))
992 impl
= ZeroInstallImplementation(self
, id, local_path
)
994 impl
= ZeroInstallImplementation(self
, id, None)
995 impl
.digests
.append(id)
997 self
.implementations
[id] = impl
1000 def set_stability_policy(self
, new
):
1001 assert new
is None or isinstance(new
, Stability
)
1002 self
.stability_policy
= new
1004 def get_feed(self
, url
):
1005 for x
in self
.feeds
:
1010 def add_metadata(self
, elem
):
1011 self
.metadata
.append(elem
)
1013 def get_metadata(self
, uri
, name
):
1014 """Return a list of interface metadata elements with this name and namespace URI."""
1015 return [m
for m
in self
.metadata
if m
.name
== name
and m
.uri
== uri
]
1019 return _best_language_match(self
.summaries
)
1022 def description(self
):
1023 return _best_language_match(self
.descriptions
)
1025 class DummyFeed(object):
1026 """Temporary class used during API transition."""
1027 last_modified
= None
1029 last_checked
= property(lambda self
: None)
1030 implementations
= property(lambda self
: {})
1031 feeds
= property(lambda self
: [])
1032 summary
= property(lambda self
: '-')
1033 description
= property(lambda self
: '')
1034 def get_name(self
): return self
.name
1035 def get_feed(self
, url
): return None
1036 def get_metadata(self
, uri
, name
): return []
1037 _dummy_feed
= DummyFeed()
1040 """Convert each %20 to a space, etc.
1042 uri
= uri
.replace('#', '/')
1043 if '%' not in uri
: return uri
1044 return re
.sub('%[0-9a-fA-F][0-9a-fA-F]',
1045 lambda match
: chr(int(match
.group(0)[1:], 16)),
1046 uri
).decode('utf-8')
1049 """Convert each space to %20, etc
1051 return re
.sub('[^-_.a-zA-Z0-9]',
1052 lambda match
: '%%%02x' % ord(match
.group(0)),
1053 uri
.encode('utf-8'))
1055 def _pretty_escape(uri
):
1056 """Convert each space to %20, etc
1057 : is preserved and / becomes #. This makes for nicer strings,
1058 and may replace L{escape} everywhere in future.
1060 return re
.sub('[^-_.a-zA-Z0-9:/]',
1061 lambda match
: '%%%02x' % ord(match
.group(0)),
1062 uri
.encode('utf-8')).replace('/', '#')
1064 def canonical_iface_uri(uri
):
1065 """If uri is a relative path, convert to an absolute one.
1066 A "file:///foo" URI is converted to "/foo".
1067 An "alias:prog" URI expands to the URI in the 0alias script
1068 Otherwise, return it unmodified.
1070 @raise SafeException: if uri isn't valid
1072 if uri
.startswith('http://') or uri
.startswith('https://'):
1073 if uri
.count("/") < 3:
1074 raise SafeException(_("Missing / after hostname in URI '%s'") % uri
)
1076 elif uri
.startswith('file:///'):
1078 elif uri
.startswith('alias:'):
1079 from zeroinstall
import alias
, support
1080 alias_prog
= uri
[6:]
1081 if not os
.path
.isabs(alias_prog
):
1082 full_path
= support
.find_in_path(alias_prog
)
1084 raise alias
.NotAnAliasScript("Not found in $PATH: " + alias_prog
)
1086 full_path
= alias_prog
1087 interface_uri
, main
= alias
.parse_script(full_path
)
1088 return interface_uri
1090 iface_uri
= os
.path
.realpath(uri
)
1091 if os
.path
.isfile(iface_uri
):
1093 raise SafeException(_("Bad interface name '%(uri)s'.\n"
1094 "(doesn't start with 'http:', and "
1095 "doesn't exist as a local file '%(interface_uri)s' either)") %
1096 {'uri': uri
, 'interface_uri': iface_uri
})
1098 _version_mod_to_value
= {
1106 _version_value_to_mod
= {}
1107 for x
in _version_mod_to_value
: _version_value_to_mod
[_version_mod_to_value
[x
]] = x
1110 _version_re
= re
.compile('-([a-z]*)')
1112 def parse_version(version_string
):
1113 """Convert a version string to an internal representation.
1114 The parsed format can be compared quickly using the standard Python functions.
1115 - Version := DottedList ("-" Mod DottedList?)*
1116 - DottedList := (Integer ("." Integer)*)
1117 @rtype: tuple (opaque)
1118 @raise SafeException: if the string isn't a valid version
1119 @since: 0.24 (moved from L{reader}, from where it is still available):"""
1120 if version_string
is None: return None
1121 parts
= _version_re
.split(version_string
)
1123 del parts
[-1] # Ends with a modifier
1127 raise SafeException(_("Empty version string!"))
1130 for x
in range(0, l
, 2):
1133 parts
[x
] = map(int, parts
[x
].split('.'))
1135 parts
[x
] = [] # (because ''.split('.') == [''], not [])
1136 for x
in range(1, l
, 2):
1137 parts
[x
] = _version_mod_to_value
[parts
[x
]]
1139 except ValueError, ex
:
1140 raise SafeException(_("Invalid version format in '%(version_string)s': %(exception)s") % {'version_string': version_string
, 'exception': ex
})
1141 except KeyError, ex
:
1142 raise SafeException(_("Invalid version modifier in '%(version_string)s': %(exception)s") % {'version_string': version_string
, 'exception': ex
})
1144 def format_version(version
):
1145 """Format a parsed version for display. Undoes the effect of L{parse_version}.
1146 @see: L{Implementation.get_version}
1149 version
= version
[:]
1151 for x
in range(0, l
, 2):
1152 version
[x
] = '.'.join(map(str, version
[x
]))
1153 for x
in range(1, l
, 2):
1154 version
[x
] = '-' + _version_value_to_mod
[version
[x
]]
1155 if version
[-1] == '-': del version
[-1]
1156 return ''.join(version
)