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
22 from zeroinstall
.zerostore
import unpack
23 from zeroinstall
.support
import tasks
25 # Element names for bindings in feed files
26 binding_names
= frozenset(['environment', 'overlay'])
28 network_offline
= 'off-line'
29 network_minimal
= 'minimal'
31 network_levels
= (network_offline
, network_minimal
, network_full
)
33 stability_levels
= {} # Name -> Stability
36 'PATH': '/bin:/usr/bin',
37 'XDG_CONFIG_DIRS': '/etc/xdg',
38 'XDG_DATA_DIRS': '/usr/local/share:/usr/share',
41 class InvalidInterface(SafeException
):
42 """Raised when parsing an invalid feed."""
45 def __init__(self
, message
, ex
= None):
48 message
+= "\n\n(exact error: %s)" % ex
50 # Some Python messages have type str but contain UTF-8 sequences.
51 # (e.g. IOException). Adding these to a Unicode 'message' (e.g.
52 # after gettext translation) will cause an error.
54 decoder
= codecs
.lookup('utf-8')
55 decex
= decoder
.decode(str(ex
), errors
= 'replace')[0]
56 message
+= "\n\n(exact error: %s)" % decex
58 SafeException
.__init
__(self
, message
)
60 def __unicode__(self
):
61 if hasattr(SafeException
, '__unicode__'):
64 return _('%s [%s]') % (SafeException
.__unicode
__(self
), self
.feed_url
)
65 return SafeException
.__unicode
__(self
)
67 return unicode(SafeException
.__str
__(self
))
69 def _split_arch(arch
):
70 """Split an arch into an (os, machine) tuple. Either or both parts may be None."""
74 raise SafeException(_("Malformed arch '%s'") % arch
)
76 osys
, machine
= arch
.split('-', 1)
77 if osys
== '*': osys
= None
78 if machine
== '*': machine
= None
81 def _join_arch(osys
, machine
):
82 if osys
== machine
== None: return None
83 return "%s-%s" % (osys
or '*', machine
or '*')
85 def _best_language_match(options
):
86 (language
, encoding
) = locale
.getlocale()
89 # xml:lang uses '-', while LANG uses '_'
90 language
= language
.replace('_', '-')
94 return (options
.get(language
, None) or # Exact match (language+region)
95 options
.get(language
.split('-', 1)[0], None) or # Matching language
96 options
.get('en', None)) # English
98 class Stability(object):
99 """A stability rating. Each implementation has an upstream stability rating and,
100 optionally, a user-set rating."""
101 __slots__
= ['level', 'name', 'description']
102 def __init__(self
, level
, name
, description
):
105 self
.description
= description
106 assert name
not in stability_levels
107 stability_levels
[name
] = self
109 def __cmp__(self
, other
):
110 return cmp(self
.level
, other
.level
)
116 return _("<Stability: %s>") % self
.description
118 def process_binding(e
):
120 if e
.name
== 'environment':
122 None: EnvironmentBinding
.PREPEND
,
123 'prepend': EnvironmentBinding
.PREPEND
,
124 'append': EnvironmentBinding
.APPEND
,
125 'replace': EnvironmentBinding
.REPLACE
,
126 }[e
.getAttribute('mode')]
128 binding
= EnvironmentBinding(e
.getAttribute('name'),
129 insert
= e
.getAttribute('insert'),
130 default
= e
.getAttribute('default'),
131 value
= e
.getAttribute('value'),
133 separator
= e
.getAttribute('separator'))
134 if not binding
.name
: raise InvalidInterface(_("Missing 'name' in binding"))
135 if binding
.insert
is None and binding
.value
is None:
136 raise InvalidInterface(_("Missing 'insert' or 'value' in binding"))
137 if binding
.insert
is not None and binding
.value
is not None:
138 raise InvalidInterface(_("Binding contains both 'insert' and 'value'"))
140 elif e
.name
== 'overlay':
141 return OverlayBinding(e
.getAttribute('src'), e
.getAttribute('mount-point'))
143 raise Exception(_("Unknown binding type '%s'") % e
.name
)
145 def process_depends(item
, local_feed_dir
):
147 # Note: also called from selections
149 dep_iface
= item
.getAttribute('interface')
151 raise InvalidInterface(_("Missing 'interface' on <%s>") % item
.name
)
152 if dep_iface
.startswith('./'):
154 dep_iface
= os
.path
.abspath(os
.path
.join(local_feed_dir
, dep_iface
))
155 # (updates the element too, in case we write it out again)
156 attrs
['interface'] = dep_iface
158 raise InvalidInterface(_('Relative interface URI "%s" in non-local feed') % dep_iface
)
159 dependency
= InterfaceDependency(dep_iface
, element
= item
)
161 for e
in item
.childNodes
:
162 if e
.uri
!= XMLNS_IFACE
: continue
163 if e
.name
in binding_names
:
164 dependency
.bindings
.append(process_binding(e
))
165 elif e
.name
== 'version':
166 dependency
.restrictions
.append(
167 VersionRangeRestriction(not_before
= parse_version(e
.getAttribute('not-before')),
168 before
= parse_version(e
.getAttribute('before'))))
171 def N_(message
): return message
173 insecure
= Stability(0, N_('insecure'), _('This is a security risk'))
174 buggy
= Stability(5, N_('buggy'), _('Known to have serious bugs'))
175 developer
= Stability(10, N_('developer'), _('Work-in-progress - bugs likely'))
176 testing
= Stability(20, N_('testing'), _('Stability unknown - please test!'))
177 stable
= Stability(30, N_('stable'), _('Tested - no serious problems found'))
178 packaged
= Stability(35, N_('packaged'), _('Supplied by the local package manager'))
179 preferred
= Stability(40, N_('preferred'), _('Best of all - must be set manually'))
183 class Restriction(object):
184 """A Restriction limits the allowed implementations of an Interface."""
187 def meets_restriction(self
, impl
):
188 """Called by the L{solver.Solver} to check whether a particular implementation is acceptable.
189 @return: False if this implementation is not a possibility
192 raise NotImplementedError(_("Abstract"))
194 class VersionRestriction(Restriction
):
195 """Only select implementations with a particular version number.
198 def __init__(self
, version
):
199 """@param version: the required version number
200 @see: L{parse_version}; use this to pre-process the version number
202 self
.version
= version
204 def meets_restriction(self
, impl
):
205 return impl
.version
== self
.version
208 return _("(restriction: version = %s)") % format_version(self
.version
)
210 class VersionRangeRestriction(Restriction
):
211 """Only versions within the given range are acceptable"""
212 __slots__
= ['before', 'not_before']
214 def __init__(self
, before
, not_before
):
215 """@param before: chosen versions must be earlier than this
216 @param not_before: versions must be at least this high
217 @see: L{parse_version}; use this to pre-process the versions
220 self
.not_before
= not_before
222 def meets_restriction(self
, impl
):
223 if self
.not_before
and impl
.version
< self
.not_before
:
225 if self
.before
and impl
.version
>= self
.before
:
230 if self
.not_before
is not None or self
.before
is not None:
232 if self
.not_before
is not None:
233 range += format_version(self
.not_before
) + ' <= '
235 if self
.before
is not None:
236 range += ' < ' + format_version(self
.before
)
239 return _("(restriction: %s)") % range
241 class Binding(object):
242 """Information about how the choice of a Dependency is made known
243 to the application being run."""
245 class EnvironmentBinding(Binding
):
246 """Indicate the chosen implementation using an environment variable."""
247 __slots__
= ['name', 'insert', 'default', 'mode', 'value']
253 def __init__(self
, name
, insert
, default
= None, mode
= PREPEND
,
254 value
=None, separator
=None):
256 mode argument added in version 0.28
257 value argument added in version 0.52
261 self
.default
= default
264 if separator
is None:
265 self
.separator
= os
.pathsep
267 self
.separator
= separator
271 return _("<environ %(name)s %(mode)s %(insert)s %(value)s>") % {'name': self
.name
,'mode': self
.mode
, 'insert': self
.insert
, 'value': self
.value
}
275 def get_value(self
, path
, old_value
):
276 """Calculate the new value of the environment variable after applying this binding.
277 @param path: the path to the selected implementation
278 @param old_value: the current value of the environment variable
279 @return: the new value for the environment variable"""
281 if self
.insert
is not None:
282 extra
= os
.path
.join(path
, self
.insert
)
284 assert self
.value
is not None
287 if self
.mode
== EnvironmentBinding
.REPLACE
:
290 if old_value
is None:
291 old_value
= self
.default
or defaults
.get(self
.name
, None)
292 if old_value
is None:
294 if self
.mode
== EnvironmentBinding
.PREPEND
:
295 return extra
+ self
.separator
+ old_value
297 return old_value
+ self
.separator
+ extra
299 def _toxml(self
, doc
):
300 """Create a DOM element for this binding.
301 @param doc: document to use to create the element
302 @return: the new element
304 env_elem
= doc
.createElementNS(XMLNS_IFACE
, 'environment')
305 env_elem
.setAttributeNS(None, 'name', self
.name
)
306 if self
.insert
is not None:
307 env_elem
.setAttributeNS(None, 'insert', self
.insert
)
309 env_elem
.setAttributeNS(None, 'value', self
.value
)
311 env_elem
.setAttributeNS(None, 'default', self
.default
)
314 class OverlayBinding(Binding
):
315 """Make the chosen implementation available by overlaying it onto another part of the file-system.
316 This is to support legacy programs which use hard-coded paths."""
317 __slots__
= ['src', 'mount_point']
319 def __init__(self
, src
, mount_point
):
321 self
.mount_point
= mount_point
324 return _("<overlay %(src)s on %(mount_point)s>") % {'src': self
.src
or '.', 'mount_point': self
.mount_point
or '/'}
328 def _toxml(self
, doc
):
329 """Create a DOM element for this binding.
330 @param doc: document to use to create the element
331 @return: the new element
333 env_elem
= doc
.createElementNS(XMLNS_IFACE
, 'overlay')
334 if self
.src
is not None:
335 env_elem
.setAttributeNS(None, 'src', self
.src
)
336 if self
.mount_point
is not None:
337 env_elem
.setAttributeNS(None, 'mount-point', self
.mount_point
)
341 """An interface's feeds are other interfaces whose implementations can also be
342 used as implementations of this interface."""
343 __slots__
= ['uri', 'os', 'machine', 'user_override', 'langs']
344 def __init__(self
, uri
, arch
, user_override
, langs
= None):
346 # This indicates whether the feed comes from the user's overrides
347 # file. If true, writer.py will write it when saving.
348 self
.user_override
= user_override
349 self
.os
, self
.machine
= _split_arch(arch
)
353 return "<Feed from %s>" % self
.uri
356 arch
= property(lambda self
: _join_arch(self
.os
, self
.machine
))
358 class Dependency(object):
359 """A Dependency indicates that an Implementation requires some additional
360 code to function. This is an abstract base class.
361 @ivar qdom: the XML element for this Dependency (since 0launch 0.51)
362 @type qdom: L{qdom.Element}
363 @ivar metadata: any extra attributes from the XML element
364 @type metadata: {str: str}
368 def __init__(self
, element
):
369 assert isinstance(element
, qdom
.Element
), type(element
) # Use InterfaceDependency instead!
374 return self
.qdom
.attrs
376 class InterfaceDependency(Dependency
):
377 """A Dependency on a Zero Install interface.
378 @ivar interface: the interface required by this dependency
380 @ivar restrictions: a list of constraints on acceptable implementations
381 @type restrictions: [L{Restriction}]
382 @ivar bindings: how to make the choice of implementation known
383 @type bindings: [L{Binding}]
386 __slots__
= ['interface', 'restrictions', 'bindings']
388 def __init__(self
, interface
, restrictions
= None, element
= None):
389 Dependency
.__init
__(self
, element
)
390 assert isinstance(interface
, (str, unicode))
392 self
.interface
= interface
393 if restrictions
is None:
394 self
.restrictions
= []
396 self
.restrictions
= restrictions
400 return _("<Dependency on %(interface)s; bindings: %(bindings)s%(restrictions)s>") % {'interface': self
.interface
, 'bindings': self
.bindings
, 'restrictions': self
.restrictions
}
402 class RetrievalMethod(object):
403 """A RetrievalMethod provides a way to fetch an implementation."""
407 def retrieve(self
, fetcher
, destination
, force
= False, impl_hint
= None):
408 """Retrieve implementation using method
409 @param destination: where to put the retrieved files
410 @param impl_hint: the Implementation this is for (if any) as a hint for the GUI
412 raise NotImplementedError("abstract")
414 class DownloadSource(RetrievalMethod
):
415 """A DownloadSource provides a way to fetch an implementation."""
416 __slots__
= ['implementation', 'url', 'size', 'extract', 'start_offset', 'type']
418 def __init__(self
, implementation
, url
, size
, extract
, start_offset
= 0, type = None):
419 self
.implementation
= implementation
422 self
.extract
= extract
423 self
.start_offset
= start_offset
424 self
.type = type # MIME type - see unpack.py
427 def fromDOM(elem
, impl
):
428 """Make a DownloadSource from a DOM archive element."""
429 url
= elem
.getAttribute('href')
431 raise InvalidInterface(_("Missing href attribute on <archive>"))
432 size
= elem
.getAttribute('size')
434 raise InvalidInterface(_("Missing size attribute on <archive>"))
436 return DownloadSource(impl
, url
= url
, size
= int(size
), extract
= elem
.getAttribute('extract'),
437 start_offset
= _get_long(elem
, 'start-offset'), type = elem
.getAttribute('type'))
439 def prepare(self
, fetcher
, force
, impl_hint
):
441 class StepCommand(object):
442 __slots__
= ['blocker', '_stream']
445 s
.blocker
, s
._stream
= self
.download(fetcher
, force
= force
, impl_hint
= impl_hint
)
447 def run(s
, destination
):
449 unpack
.unpack_archive_over(self
.url
, s
._stream
, destination
,
450 extract
= self
.extract
,
452 start_offset
= self
.start_offset
or 0)
455 def download(self
, fetcher
, force
= False, impl_hint
= None):
456 """Fetch an archive. You should normally call L{Implementation.retrieve}
457 instead, since it handles other kinds of retrieval method too."""
459 if not (url
.startswith('http:') or url
.startswith('https:') or url
.startswith('ftp:')):
460 raise SafeException(_("Unknown scheme in download URL '%s'") % url
)
462 mime_type
= self
.type
464 mime_type
= unpack
.type_from_url(self
.url
)
466 raise SafeException(_("No 'type' attribute on archive, and I can't guess from the name (%s)") % self
.url
)
467 unpack
.check_type_ok(mime_type
)
468 dl
= fetcher
.handler
.get_download(self
.url
, force
= force
, hint
= impl_hint
)
469 dl
.expected_size
= self
.size
+ (self
.start_offset
or 0)
470 return (dl
.downloaded
, dl
.tempfile
)
473 def retrieve(self
, fetcher
, destination
, force
= False, impl_hint
= None):
474 command
= self
.prepare(fetcher
, force
, impl_hint
)
475 yield command
.blocker
476 tasks
.check(command
.blocker
)
477 command
.run(destination
)
480 class UnpackArchive(object):
481 """An UnpackArchive step provides unpacks/extracts an archive.
483 It can be used inside a Recipe."""
484 __slots__
= ['path', 'extract', 'type']
486 def __init__(self
, path
, extract
, type):
488 self
.extract
= extract
491 def prepare(self
, fetcher
, force
, impl_hint
):
493 class StepCommand(object):
494 __slots__
= ['blocker']
500 path
= os
.path
.join(tmpdir
, self
.path
)
501 stream
= open(path
, 'rb')
504 unpack
.unpack_archive_over(path
, stream
, tmpdir
,
505 extract
= self
.extract
,
513 class Recipe(RetrievalMethod
):
514 """Get an implementation by following a series of steps.
515 @ivar size: the combined download sizes from all the steps
517 @ivar steps: the sequence of steps which must be performed
518 @type steps: [L{RetrievalMethod}]"""
519 __slots__
= ['steps']
524 size
= property(lambda self
: sum([x
.size
for x
in self
.steps
]))
527 def retrieve(self
, fetcher
, destination
, force
= False, impl_hint
= None):
528 # Start preparing all steps
529 step_commands
= [step
.prepare(fetcher
, force
, impl_hint
) for step
in self
.steps
]
532 valid_blockers
= [s
.blocker
for s
in step_commands
if s
.blocker
is not None]
533 for step_command
in step_commands
:
534 if step_command
.blocker
:
535 while not step_command
.blocker
.happened
:
537 tasks
.check(valid_blockers
)
538 step_command
.run(destination
)
542 """Make a Recipe from a DOM recipe element"""
544 for recipe_step
in elem
.childNodes
:
545 if recipe_step
.uri
== XMLNS_IFACE
and recipe_step
.name
== 'archive':
546 recipe
.steps
.append(DownloadSource
.fromDOM(recipe_step
, None))
547 elif recipe_step
.uri
== XMLNS_IFACE
and recipe_step
.name
== 'unpack':
548 path
= recipe_step
.getAttribute('path')
550 raise InvalidInterface(_("Missing path attribute on <unpack>"))
551 recipe
.steps
.append(UnpackArchive(path
= path
,
552 extract
= recipe_step
.getAttribute('extract'),
553 type = recipe_step
.getAttribute('type')))
555 info(_("Unknown step '%s' in recipe; skipping recipe"), recipe_step
.name
)
560 class DistributionSource(RetrievalMethod
):
561 """A package that is installed using the distribution's tools (including PackageKit).
562 @ivar install: a function to call to install this package
563 @type install: (L{handler.Handler}) -> L{tasks.Blocker}
564 @ivar package_id: the package name, in a form recognised by the distribution's tools
565 @type package_id: str
566 @ivar size: the download size in bytes
568 @ivar needs_confirmation: whether the user should be asked to confirm before calling install()
569 @type needs_confirmation: bool"""
571 __slots__
= ['package_id', 'size', 'install', 'needs_confirmation']
573 def __init__(self
, package_id
, size
, install
, needs_confirmation
= True):
574 RetrievalMethod
.__init
__(self
)
575 self
.package_id
= package_id
577 self
.install
= install
578 self
.needs_confirmation
= needs_confirmation
580 class Command(object):
581 """A Command is a way of running an Implementation as a program."""
583 __slots__
= ['qdom', '_depends', '_local_dir', '_runner']
585 def __init__(self
, qdom
, local_dir
):
586 """@param qdom: the <command> element
587 @param local_dir: the directory containing the feed (for relative dependencies), or None if not local
589 assert qdom
.name
== 'command', 'not <command>: %s' % qdom
591 self
._local
_dir
= local_dir
594 path
= property(lambda self
: self
.qdom
.attrs
.get("path", None))
596 def _toxml(self
, doc
, prefixes
):
597 return self
.qdom
.toDOM(doc
, prefixes
)
601 if self
._depends
is None:
604 for child
in self
.qdom
.childNodes
:
605 if child
.name
== 'requires':
606 dep
= process_depends(child
, self
._local
_dir
)
608 elif child
.name
== 'runner':
610 raise InvalidInterface(_("Multiple <runner>s in <command>!"))
611 dep
= process_depends(child
, self
._local
_dir
)
614 self
._depends
= depends
617 def get_runner(self
):
618 self
.requires
# (sets _runner)
621 class Implementation(object):
622 """An Implementation is a package which implements an Interface.
623 @ivar download_sources: list of methods of getting this implementation
624 @type download_sources: [L{RetrievalMethod}]
625 @ivar feed: the feed owning this implementation (since 0.32)
626 @type feed: [L{ZeroInstallFeed}]
627 @ivar bindings: how to tell this component where it itself is located (since 0.31)
628 @type bindings: [Binding]
629 @ivar upstream_stability: the stability reported by the packager
630 @type upstream_stability: [insecure | buggy | developer | testing | stable | packaged]
631 @ivar user_stability: the stability as set by the user
632 @type upstream_stability: [insecure | buggy | developer | testing | stable | packaged | preferred]
633 @ivar langs: natural languages supported by this package
635 @ivar requires: interfaces this package depends on
636 @type requires: [L{Dependency}]
637 @ivar commands: ways to execute as a program
638 @type commands: {str: Command}
639 @ivar metadata: extra metadata from the feed
640 @type metadata: {"[URI ]localName": str}
641 @ivar id: a unique identifier for this Implementation
642 @ivar version: a parsed version number
643 @ivar released: release date
644 @ivar local_path: the directory containing this local implementation, or None if it isn't local (id isn't a path)
645 @type local_path: str | None
646 @ivar requires_root_install: whether the user will need admin rights to use this
647 @type requires_root_install: bool
650 # Note: user_stability shouldn't really be here
652 __slots__
= ['upstream_stability', 'user_stability', 'langs',
653 'requires', 'metadata', 'download_sources', 'commands',
654 'id', 'feed', 'version', 'released', 'bindings', 'machine']
656 def __init__(self
, feed
, id):
659 self
.user_stability
= None
660 self
.upstream_stability
= None
661 self
.metadata
= {} # [URI + " "] + localName -> value
665 self
.download_sources
= []
671 def get_stability(self
):
672 return self
.user_stability
or self
.upstream_stability
or testing
678 return "v%s (%s)" % (self
.get_version(), self
.id)
680 def __cmp__(self
, other
):
681 """Newer versions come first"""
682 d
= cmp(other
.version
, self
.version
)
684 # If the version number is the same, just give a stable sort order, and
685 # ensure that two different implementations don't compare equal.
686 d
= cmp(other
.feed
.url
, self
.feed
.url
)
688 return cmp(other
.id, self
.id)
690 def get_version(self
):
691 """Return the version as a string.
692 @see: L{format_version}
694 return format_version(self
.version
)
696 arch
= property(lambda self
: _join_arch(self
.os
, self
.machine
))
701 requires_root_install
= False
704 """"@deprecated: use commands["run"] instead"""
705 main
= self
.commands
.get("run", None)
709 def _set_main(self
, path
):
710 """"@deprecated: use commands["run"] instead"""
712 if "run" in self
.commands
:
713 del self
.commands
["run"]
715 self
.commands
["run"] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'path': path
}), None)
716 main
= property(_get_main
, _set_main
)
718 def is_available(self
, stores
):
719 """Is this Implementation available locally?
720 (a local implementation, an installed distribution package, or a cached ZeroInstallImplementation)
724 raise NotImplementedError("abstract")
727 def best_download_source(self
):
728 """Return the best download source for this implementation.
729 @rtype: L{model.RetrievalMethod}"""
730 if self
.download_sources
:
731 return self
.download_sources
[0]
734 def retrieve(self
, fetcher
, retrieval_method
, stores
, force
= False):
735 """Retrieve an implementation.
736 @param retrieval_method: a way of getting the implementation (e.g. an Archive or a Recipe)
737 @type retrieval_method: L{model.RetrievalMethod}
738 @param stores: where to store the downloaded implementation
739 @type stores: L{zerostore.Stores}
740 @param force: whether to abort and restart an existing download
741 @rtype: L{tasks.Blocker}"""
742 raise NotImplementedError("abstract")
744 class DistributionImplementation(Implementation
):
745 """An implementation provided by the distribution. Information such as the version
746 comes from the package manager.
748 __slots__
= ['distro', 'installed']
750 def __init__(self
, feed
, id, distro
):
751 assert id.startswith('package:')
752 Implementation
.__init
__(self
, feed
, id)
754 self
.installed
= False
757 def requires_root_install(self
):
758 return not self
.installed
760 def is_available(self
, stores
):
761 return self
.installed
763 def retrieve(self
, fetcher
, retrieval_method
, stores
, force
= False):
764 return retrieval_method
.install(fetcher
.handler
)
767 class ZeroInstallImplementation(Implementation
):
768 """An implementation where all the information comes from Zero Install.
769 @ivar digests: a list of "algorith=value" strings (since 0.45)
772 __slots__
= ['os', 'size', 'digests', 'local_path']
774 def __init__(self
, feed
, id, local_path
):
775 """id can be a local path (string starting with /) or a manifest hash (eg "sha1=XXX")"""
777 assert not id.startswith('package:'), id
778 Implementation
.__init
__(self
, feed
, id)
782 self
.local_path
= local_path
785 def fromDOM(feed
, item
, item_attrs
, local_dir
, commands
, bindings
, depends
, id_generation_alg
=None, fetcher
=None, stores
=None):
786 """Make an implementation from a DOM implementation element.
787 @param id_generation_alg: if specified, id will be autogenerated, if id is None, with this alg
788 @type id_generation_alg: L{Algorithm}
789 @param fetcher: must be specified if id_generation_alg is specified
790 @param stores: must be specified if id_generation_alg is specified
792 id = item
.getAttribute('id')
793 local_path
= item_attrs
.get('local-path')
794 if local_dir
and local_path
:
795 abs_local_path
= os
.path
.abspath(os
.path
.join(local_dir
, local_path
))
796 impl
= ZeroInstallImplementation(feed
, id, abs_local_path
)
797 elif local_dir
and (id.startswith('/') or id.startswith('.')):
799 id = os
.path
.abspath(os
.path
.join(local_dir
, id))
800 impl
= ZeroInstallImplementation(feed
, id, id)
802 impl
= ZeroInstallImplementation(feed
, id, None)
804 # In older feeds, the ID was the (single) digest
805 impl
.digests
.append(id)
808 version_mod
= item_attrs
.get('version-modifier', None)
810 item_attrs
['version'] += version_mod
811 del item_attrs
['version-modifier']
812 version
= item_attrs
['version']
814 raise InvalidInterface(_("Missing version attribute"))
815 impl
.version
= parse_version(version
)
817 impl
.metadata
= item_attrs
818 impl
.commands
= commands
819 impl
.bindings
= bindings
820 impl
.requires
= depends
821 impl
.released
= item_attrs
.get('released', None)
822 impl
.langs
= item_attrs
.get('langs', '').replace('_', '-')
824 size
= item
.getAttribute('size')
826 impl
.size
= int(size
)
828 impl
.arch
= item_attrs
.get('arch', None)
831 stability
= stability_levels
[str(item_attrs
['stability'])]
833 stab
= str(item_attrs
['stability'])
834 if stab
!= stab
.lower():
835 raise InvalidInterface(_('Stability "%s" invalid - use lower case!') % item_attrs
.stability
)
836 raise InvalidInterface(_('Stability "%s" invalid') % item_attrs
['stability'])
837 if stability
>= preferred
:
838 raise InvalidInterface(_("Upstream can't set stability to preferred!"))
839 impl
.upstream_stability
= stability
841 for elem
in item
.childNodes
:
842 if elem
.uri
!= XMLNS_IFACE
: continue
843 if elem
.name
== 'archive':
844 impl
.download_sources
.append(DownloadSource
.fromDOM(elem
, impl
))
845 elif elem
.name
== 'manifest-digest':
846 for aname
, avalue
in elem
.attrs
.iteritems():
848 impl
.digests
.append('%s=%s' % (aname
, avalue
))
849 elif elem
.name
== 'recipe':
850 recipe
= Recipe
.fromDOM(elem
)
852 impl
.download_sources
.append(recipe
)
854 if id is None and id_generation_alg
:
857 impl
.id = impl
._generate
_digest
(fetcher
, stores
, id_generation_alg
)
858 feed
.changed_implementations
.append(impl
)
860 raise InvalidInterface(_("Missing 'id' attribute on %s") % item
)
866 dependencies
= property(lambda self
: dict([(x
.interface
, x
) for x
in self
.requires
867 if isinstance(x
, InterfaceDependency
)]))
869 def add_download_source(self
, url
, size
, extract
, start_offset
= 0, type = None):
870 """Add a download source."""
871 # TODO should deprecate?
872 self
.download_sources
.append(DownloadSource(self
, url
, size
, extract
, start_offset
, type))
874 def set_arch(self
, arch
):
875 self
.os
, self
.machine
= _split_arch(arch
)
876 arch
= property(lambda self
: _join_arch(self
.os
, self
.machine
), set_arch
)
878 def is_available(self
, stores
):
879 if self
.local_path
is not None:
880 return os
.path
.exists(self
.local_path
)
882 path
= stores
.lookup_maybe(self
.digests
)
883 return path
is not None
884 return False # (0compile creates fake entries with no digests)
887 def best_digest(self
):
888 """Return the best digest for this implementation
889 @return: tuple (alg, digest) or None"""
890 from zeroinstall
.zerostore
import manifest
892 for digest
in self
.digests
:
893 alg_name
= digest
.split('=', 1)[0]
894 alg
= manifest
.algorithms
.get(alg_name
, None)
895 if alg
and (best_alg
is None or best_alg
.rating
< alg
.rating
):
899 return (best_alg
, best_digest
)
903 def _generate_digest(self
, fetcher
, stores
, alg
):
906 # Create an empty directory for the new implementation
907 store
= stores
.stores
[0]
908 tmpdir
= store
.get_tmp_dir_for('missing')
911 blocker
= self
.best_download_source
.retrieve(fetcher
, tmpdir
, force
=False, impl_hint
= self
)
912 tasks
.wait_for_blocker(blocker
)
914 from zeroinstall
.zerostore
import manifest
915 manifest
.fixup_permissions(tmpdir
)
916 digest
= alg
.getID(manifest
.add_manifest_file(tmpdir
, alg
))
918 # If unpacking fails, remove the temporary directory
919 if tmpdir
is not None:
920 from zeroinstall
import support
921 support
.ro_rmtree(tmpdir
)
926 def retrieve(self
, fetcher
, retrieval_method
, stores
, force
= False):
927 best
= self
.best_digest
931 raise SafeException(_("No <manifest-digest> given for '%(implementation)s' version %(version)s") %
932 {'implementation': self
.feed
.get_name(), 'version': self
.get_version()})
933 raise SafeException(_("Unknown digest algorithms '%(algorithms)s' for '%(implementation)s' version %(version)s") %
934 {'algorithms': self
.digests
, 'implementation': self
.feed
.get_name(), 'version': self
.get_version()})
936 alg
, required_digest
= best
940 # Create an empty directory for the new implementation
941 store
= stores
.stores
[0]
942 tmpdir
= store
.get_tmp_dir_for(required_digest
)
945 blocker
= retrieval_method
.retrieve(fetcher
, tmpdir
, force
, impl_hint
= self
)
949 # Check that the result is correct and store it in the cache
950 store
.check_manifest_and_rename(required_digest
, tmpdir
)
954 # If unpacking fails, remove the temporary directory
955 if tmpdir
is not None:
956 from zeroinstall
import support
957 support
.ro_rmtree(tmpdir
)
959 fetcher
.handler
.impl_added_to_store(self
)
964 class Interface(object):
965 """An Interface represents some contract of behaviour.
966 @ivar uri: the URI for this interface.
967 @ivar stability_policy: user's configured policy.
968 Implementations at this level or higher are preferred.
969 Lower levels are used only if there is no other choice.
971 __slots__
= ['uri', 'stability_policy', 'extra_feeds']
973 implementations
= property(lambda self
: self
._main
_feed
.implementations
)
974 name
= property(lambda self
: self
._main
_feed
.name
)
975 description
= property(lambda self
: self
._main
_feed
.description
)
976 summary
= property(lambda self
: self
._main
_feed
.summary
)
977 last_modified
= property(lambda self
: self
._main
_feed
.last_modified
)
978 feeds
= property(lambda self
: self
.extra_feeds
+ self
._main
_feed
.feeds
)
979 metadata
= property(lambda self
: self
._main
_feed
.metadata
)
981 last_checked
= property(lambda self
: self
._main
_feed
.last_checked
)
983 def __init__(self
, uri
):
985 if uri
.startswith('http:') or uri
.startswith('https:') or os
.path
.isabs(uri
):
988 raise SafeException(_("Interface name '%s' doesn't start "
989 "with 'http:' or 'https:'") % uri
)
992 def _get_feed_for(self
):
994 for key
in self
._main
_feed
.feed_for
:
997 feed_for
= property(_get_feed_for
) # Deprecated (used by 0publish)
1000 self
.extra_feeds
= []
1001 self
.stability_policy
= None
1004 from zeroinstall
.injector
.iface_cache
import iface_cache
1005 feed
= iface_cache
.get_feed(self
.uri
)
1007 return feed
.get_name()
1008 return '(' + os
.path
.basename(self
.uri
) + ')'
1011 return _("<Interface %s>") % self
.uri
1013 def set_stability_policy(self
, new
):
1014 assert new
is None or isinstance(new
, Stability
)
1015 self
.stability_policy
= new
1017 def get_feed(self
, url
):
1019 #warnings.warn("use iface_cache.get_feed instead", DeprecationWarning, 2)
1020 for x
in self
.extra_feeds
:
1023 #return self._main_feed.get_feed(url)
1026 def get_metadata(self
, uri
, name
):
1027 return self
._main
_feed
.get_metadata(uri
, name
)
1030 def _main_feed(self
):
1032 #warnings.warn("use the feed instead", DeprecationWarning, 3)
1033 from zeroinstall
.injector
import policy
1034 iface_cache
= policy
.get_deprecated_singleton_config().iface_cache
1035 feed
= iface_cache
.get_feed(self
.uri
)
1040 def _merge_attrs(attrs
, item
):
1041 """Add each attribute of item to a copy of attrs and return the copy.
1042 @type attrs: {str: str}
1043 @type item: L{qdom.Element}
1047 for a
in item
.attrs
:
1048 new
[str(a
)] = item
.attrs
[a
]
1051 def _get_long(elem
, attr_name
):
1052 val
= elem
.getAttribute(attr_name
)
1057 raise SafeException(_("Invalid value for integer attribute '%(attribute_name)s': %(value)s") % {'attribute_name': attr_name
, 'value': val
})
1060 class ZeroInstallFeed(object):
1061 """A feed lists available implementations of an interface.
1062 @ivar url: the URL for this feed
1063 @ivar implementations: Implementations in this feed, indexed by ID
1064 @type implementations: {str: L{Implementation}}
1065 @ivar changed_implementations: Ordered list of implementations that had their ID changed (i.e. they had their id changed)
1066 @ivar name: human-friendly name
1067 @ivar summaries: short textual description (in various languages, since 0.49)
1068 @type summaries: {str: str}
1069 @ivar descriptions: long textual description (in various languages, since 0.49)
1070 @type descriptions: {str: str}
1071 @ivar last_modified: timestamp on signature
1072 @ivar last_checked: time feed was last successfully downloaded and updated
1073 @ivar feeds: list of <feed> elements in this feed
1074 @type feeds: [L{Feed}]
1075 @ivar feed_for: interfaces for which this could be a feed
1076 @type feed_for: set(str)
1077 @ivar metadata: extra elements we didn't understand
1079 # _main is deprecated
1080 __slots__
= ['url', 'implementations', 'changed_implementations', 'name', 'descriptions', 'first_description', 'summaries', 'first_summary', '_package_implementations',
1081 'last_checked', 'last_modified', 'feeds', 'feed_for', 'metadata']
1083 def __init__(self
, feed_element
, local_path
= None, distro
= None,
1084 implementation_id_alg
=None, fetcher
=None, stores
=None):
1085 """Create a feed object from a DOM.
1086 @param feed_element: the root element of a feed file
1087 @type feed_element: L{qdom.Element}
1088 @param local_path: the pathname of this local feed, or None for remote feeds
1089 @param implementation_id_alg: if specified, missing impl ids will be generated with this alg
1090 @type implementation_id_alg: L{Algorithm}
1091 @param fetcher: cannot be None if implementation_id_alg is specified
1092 @param stores: cannot be None if implementation_id_alg is specified"""
1093 self
.implementations
= {}
1094 self
.changed_implementations
= []
1096 self
.summaries
= {} # { lang: str }
1097 self
.first_summary
= None
1098 self
.descriptions
= {} # { lang: str }
1099 self
.first_description
= None
1100 self
.last_modified
= None
1102 self
.feed_for
= set()
1104 self
.last_checked
= None
1105 self
._package
_implementations
= []
1107 if distro
is not None:
1109 warnings
.warn("distro argument is now ignored", DeprecationWarning, 2)
1111 if feed_element
is None:
1112 return # XXX subclass?
1114 assert feed_element
.name
in ('interface', 'feed'), "Root element should be <interface>, not %s" % feed_element
1115 assert feed_element
.uri
== XMLNS_IFACE
, "Wrong namespace on root element: %s" % feed_element
.uri
1117 main
= feed_element
.getAttribute('main')
1118 #if main: warn("Setting 'main' on the root element is deprecated. Put it on a <group> instead")
1121 self
.url
= local_path
1122 local_dir
= os
.path
.dirname(local_path
)
1124 self
.url
= feed_element
.getAttribute('uri')
1126 raise InvalidInterface(_("<interface> uri attribute missing"))
1127 local_dir
= None # Can't have relative paths
1129 min_injector_version
= feed_element
.getAttribute('min-injector-version')
1130 if min_injector_version
:
1131 if parse_version(min_injector_version
) > parse_version(version
):
1132 raise InvalidInterface(_("This feed requires version %(min_version)s or later of "
1133 "Zero Install, but I am only version %(version)s. "
1134 "You can get a newer version from http://0install.net") %
1135 {'min_version': min_injector_version
, 'version': version
})
1137 for x
in feed_element
.childNodes
:
1138 if x
.uri
!= XMLNS_IFACE
:
1139 self
.metadata
.append(x
)
1141 if x
.name
== 'name':
1142 self
.name
= x
.content
1143 elif x
.name
== 'description':
1144 if self
.first_description
== None:
1145 self
.first_description
= x
.content
1146 self
.descriptions
[x
.attrs
.get("http://www.w3.org/XML/1998/namespace lang", 'en')] = x
.content
1147 elif x
.name
== 'summary':
1148 if self
.first_summary
== None:
1149 self
.first_summary
= x
.content
1150 self
.summaries
[x
.attrs
.get("http://www.w3.org/XML/1998/namespace lang", 'en')] = x
.content
1151 elif x
.name
== 'feed-for':
1152 feed_iface
= x
.getAttribute('interface')
1154 raise InvalidInterface(_('Missing "interface" attribute in <feed-for>'))
1155 self
.feed_for
.add(feed_iface
)
1156 # Bug report from a Debian/stable user that --feed gets the wrong value.
1157 # Can't reproduce (even in a Debian/stable chroot), but add some logging here
1158 # in case it happens again.
1159 debug(_("Is feed-for %s"), feed_iface
)
1160 elif x
.name
== 'feed':
1161 feed_src
= x
.getAttribute('src')
1163 raise InvalidInterface(_('Missing "src" attribute in <feed>'))
1164 if feed_src
.startswith('http:') or feed_src
.startswith('https:') or local_path
:
1165 langs
= x
.getAttribute('langs')
1166 if langs
: langs
= langs
.replace('_', '-')
1167 self
.feeds
.append(Feed(feed_src
, x
.getAttribute('arch'), False, langs
= langs
))
1169 raise InvalidInterface(_("Invalid feed URL '%s'") % feed_src
)
1171 self
.metadata
.append(x
)
1174 raise InvalidInterface(_("Missing <name> in feed"))
1175 if not self
.summary
:
1176 raise InvalidInterface(_("Missing <summary> in feed"))
1178 def process_group(group
, group_attrs
, base_depends
, base_bindings
, base_commands
):
1179 for item
in group
.childNodes
:
1180 if item
.uri
!= XMLNS_IFACE
: continue
1182 if item
.name
not in ('group', 'implementation', 'package-implementation'):
1185 # We've found a group or implementation. Scan for dependencies,
1186 # bindings and commands. Doing this here means that:
1187 # - We can share the code for groups and implementations here.
1188 # - The order doesn't matter, because these get processed first.
1189 # A side-effect is that the document root cannot contain
1192 depends
= base_depends
[:]
1193 bindings
= base_bindings
[:]
1194 commands
= base_commands
.copy()
1196 for attr
, command
in [('main', 'run'),
1197 ('self-test', 'test')]:
1198 value
= item
.attrs
.get(attr
, None)
1199 if value
is not None:
1200 commands
[command
] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'path': value
}), None)
1202 for child
in item
.childNodes
:
1203 if child
.uri
!= XMLNS_IFACE
: continue
1204 if child
.name
== 'requires':
1205 dep
= process_depends(child
, local_dir
)
1207 elif child
.name
== 'command':
1208 command_name
= child
.attrs
.get('name', None)
1209 if not command_name
:
1210 raise InvalidInterface('Missing name for <command>')
1211 commands
[command_name
] = Command(child
, local_dir
)
1212 elif child
.name
in binding_names
:
1213 bindings
.append(process_binding(child
))
1215 compile_command
= item
.attrs
.get('http://zero-install.sourceforge.net/2006/namespaces/0compile command')
1216 if compile_command
is not None:
1217 commands
['compile'] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'shell-command': compile_command
}), None)
1219 item_attrs
= _merge_attrs(group_attrs
, item
)
1221 if item
.name
== 'group':
1222 process_group(item
, item_attrs
, depends
, bindings
, commands
)
1223 elif item
.name
== 'implementation':
1224 impl
= ZeroInstallImplementation
.fromDOM(self
, item
, item_attrs
, local_dir
, commands
, bindings
, depends
,
1225 implementation_id_alg
, fetcher
, stores
)
1226 if impl
.id in self
.implementations
:
1227 warn(_("Duplicate ID '%(id)s' in feed '%(feed)s'"), {'id': id, 'feed': self
})
1228 self
.implementations
[impl
.id] = impl
1229 elif item
.name
== 'package-implementation':
1231 warn("A <package-implementation> with dependencies in %s!", self
.url
)
1232 self
._package
_implementations
.append((item
, item_attrs
))
1236 root_attrs
= {'stability': 'testing'}
1239 info("Note: @main on document element is deprecated in %s", self
)
1240 root_commands
['run'] = Command(qdom
.Element(XMLNS_IFACE
, 'command', {'path': main
}), None)
1241 process_group(feed_element
, root_attrs
, [], [], root_commands
)
1243 def get_distro_feed(self
):
1244 """Does this feed contain any <pacakge-implementation> elements?
1245 i.e. is it worth asking the package manager for more information?
1246 @return: the URL of the virtual feed, or None
1248 if self
._package
_implementations
:
1249 return "distribution:" + self
.url
1252 def get_package_impls(self
, distro
):
1253 """Find the best <pacakge-implementation> element(s) for the given distribution.
1254 @param distro: the distribution to use to rate them
1255 @type distro: L{distro.Distribution}
1256 @return: a list of tuples for the best ranked elements
1262 for item
, item_attrs
in self
._package
_implementations
:
1263 distro_names
= item_attrs
.get('distributions', '')
1264 for distro_name
in distro_names
.split(' '):
1265 score
= distro
.get_score(distro_name
)
1266 if score
> best_score
:
1269 if score
== best_score
:
1270 best_impls
.append((item
, item_attrs
))
1274 return self
.name
or '(' + os
.path
.basename(self
.url
) + ')'
1277 return _("<Feed %s>") % self
.url
1279 def set_stability_policy(self
, new
):
1280 assert new
is None or isinstance(new
, Stability
)
1281 self
.stability_policy
= new
1283 def get_feed(self
, url
):
1284 for x
in self
.feeds
:
1289 def add_metadata(self
, elem
):
1290 self
.metadata
.append(elem
)
1292 def get_metadata(self
, uri
, name
):
1293 """Return a list of interface metadata elements with this name and namespace URI."""
1294 return [m
for m
in self
.metadata
if m
.name
== name
and m
.uri
== uri
]
1298 return _best_language_match(self
.summaries
) or self
.first_summary
1301 def description(self
):
1302 return _best_language_match(self
.descriptions
) or self
.first_description
1304 class DummyFeed(object):
1305 """Temporary class used during API transition."""
1306 last_modified
= None
1308 last_checked
= property(lambda self
: None)
1309 implementations
= property(lambda self
: {})
1310 feeds
= property(lambda self
: [])
1311 summary
= property(lambda self
: '-')
1312 description
= property(lambda self
: '')
1313 def get_name(self
): return self
.name
1314 def get_feed(self
, url
): return None
1315 def get_metadata(self
, uri
, name
): return []
1316 _dummy_feed
= DummyFeed()
1319 """Convert each %20 to a space, etc.
1321 uri
= uri
.replace('#', '/')
1322 if '%' not in uri
: return uri
1323 return re
.sub('%[0-9a-fA-F][0-9a-fA-F]',
1324 lambda match
: chr(int(match
.group(0)[1:], 16)),
1325 uri
).decode('utf-8')
1328 """Convert each space to %20, etc
1330 return re
.sub('[^-_.a-zA-Z0-9]',
1331 lambda match
: '%%%02x' % ord(match
.group(0)),
1332 uri
.encode('utf-8'))
1334 def _pretty_escape(uri
):
1335 """Convert each space to %20, etc
1336 : is preserved and / becomes #. This makes for nicer strings,
1337 and may replace L{escape} everywhere in future.
1339 if os
.name
== "posix":
1340 # Only preserve : on Posix systems
1341 preserveRegex
= '[^-_.a-zA-Z0-9:/]'
1343 # Other OSes may not allow the : character in file names
1344 preserveRegex
= '[^-_.a-zA-Z0-9/]'
1345 return re
.sub(preserveRegex
,
1346 lambda match
: '%%%02x' % ord(match
.group(0)),
1347 uri
.encode('utf-8')).replace('/', '#')
1349 def canonical_iface_uri(uri
):
1350 """If uri is a relative path, convert to an absolute one.
1351 A "file:///foo" URI is converted to "/foo".
1352 An "alias:prog" URI expands to the URI in the 0alias script
1353 Otherwise, return it unmodified.
1355 @raise SafeException: if uri isn't valid
1357 if uri
.startswith('http://') or uri
.startswith('https://'):
1358 if uri
.count("/") < 3:
1359 raise SafeException(_("Missing / after hostname in URI '%s'") % uri
)
1361 elif uri
.startswith('file:///'):
1363 elif uri
.startswith('alias:'):
1364 from zeroinstall
import alias
, support
1365 alias_prog
= uri
[6:]
1366 if not os
.path
.isabs(alias_prog
):
1367 full_path
= support
.find_in_path(alias_prog
)
1369 raise alias
.NotAnAliasScript("Not found in $PATH: " + alias_prog
)
1371 full_path
= alias_prog
1372 interface_uri
, main
= alias
.parse_script(full_path
)
1373 return interface_uri
1375 iface_uri
= os
.path
.realpath(uri
)
1376 if os
.path
.isfile(iface_uri
):
1378 raise SafeException(_("Bad interface name '%(uri)s'.\n"
1379 "(doesn't start with 'http:', and "
1380 "doesn't exist as a local file '%(interface_uri)s' either)") %
1381 {'uri': uri
, 'interface_uri': iface_uri
})
1383 _version_mod_to_value
= {
1391 _version_value_to_mod
= {}
1392 for x
in _version_mod_to_value
: _version_value_to_mod
[_version_mod_to_value
[x
]] = x
1395 _version_re
= re
.compile('-([a-z]*)')
1397 def parse_version(version_string
):
1398 """Convert a version string to an internal representation.
1399 The parsed format can be compared quickly using the standard Python functions.
1400 - Version := DottedList ("-" Mod DottedList?)*
1401 - DottedList := (Integer ("." Integer)*)
1402 @rtype: tuple (opaque)
1403 @raise SafeException: if the string isn't a valid version
1404 @since: 0.24 (moved from L{reader}, from where it is still available):"""
1405 if version_string
is None: return None
1406 parts
= _version_re
.split(version_string
)
1408 del parts
[-1] # Ends with a modifier
1412 raise SafeException(_("Empty version string!"))
1415 for x
in range(0, l
, 2):
1418 parts
[x
] = map(int, parts
[x
].split('.'))
1420 parts
[x
] = [] # (because ''.split('.') == [''], not [])
1421 for x
in range(1, l
, 2):
1422 parts
[x
] = _version_mod_to_value
[parts
[x
]]
1424 except ValueError, ex
:
1425 raise SafeException(_("Invalid version format in '%(version_string)s': %(exception)s") % {'version_string': version_string
, 'exception': ex
})
1426 except KeyError, ex
:
1427 raise SafeException(_("Invalid version modifier in '%(version_string)s': %(exception)s") % {'version_string': version_string
, 'exception': ex
})
1429 def format_version(version
):
1430 """Format a parsed version for display. Undoes the effect of L{parse_version}.
1431 @see: L{Implementation.get_version}
1434 version
= version
[:]
1436 for x
in range(0, l
, 2):
1437 version
[x
] = '.'.join(map(str, version
[x
]))
1438 for x
in range(1, l
, 2):
1439 version
[x
] = '-' + _version_value_to_mod
[version
[x
]]
1440 if version
[-1] == '-': del version
[-1]
1441 return ''.join(version
)