zeroinstall/injector/fetch.py

   1 """
   2 Downloads feeds, keys, packages and icons.
   3 """
   4
   5 # Copyright (C) 2009, Thomas Leonard
   6 # See the README file for details, or visit http://0install.net.
   7
   8 import os
   9 from logging import info, debug, warn
  10
  11 from zeroinstall.support import tasks, basedir
  12 from zeroinstall.injector.namespaces import XMLNS_IFACE, config_site
  13 from zeroinstall.injector.model import DownloadSource, Recipe, SafeException, escape
  14 from zeroinstall.injector.iface_cache import PendingFeed, ReplayAttack
  15 from zeroinstall.injector.handler import NoTrustedKeys
  16
  17 def _escape_slashes(path):
  18         return path.replace('/', '%23')
  19
  20 def _get_feed_dir(feed):
  21         """The algorithm from 0mirror."""
  22         if '#' in feed:
  23                 raise SafeException("Invalid URL '%s'" % feed)
  24         scheme, rest = feed.split('://', 1)
  25         domain, rest = rest.split('/', 1)
  26         for x in [scheme, domain, rest]:
  27                 if not x or x.startswith(','):
  28                         raise SafeException("Invalid URL '%s'" % feed)
  29         return os.path.join('feeds', scheme, domain, _escape_slashes(rest))
  30
  31 class Fetcher(object):
  32         """Downloads and stores various things.
  33         @ivar handler: handler to use for user-interaction
  34         @type handler: L{handler.Handler}
  35         @ivar feed_mirror: the base URL of a mirror site for keys and feeds
  36         @type feed_mirror: str
  37         """
  38         __slots__ = ['handler', 'feed_mirror']
  39
  40         def __init__(self, handler):
  41                 self.handler = handler
  42                 self.feed_mirror = "http://roscidus.com/0mirror"
  43
  44         @tasks.async
  45         def cook(self, required_digest, recipe, stores, force = False, impl_hint = None):
  46                 """Follow a Recipe.
  47                 @param impl_hint: the Implementation this is for (if any) as a hint for the GUI
  48                 @see: L{download_impl} uses this method when appropriate"""
  49                 # Maybe we're taking this metaphor too far?
  50
  51                 # Start downloading all the ingredients.
  52                 downloads = {}  # Downloads that are not yet successful
  53                 streams = {}    # Streams collected from successful downloads
  54
  55                 # Start a download for each ingredient
  56                 blockers = []
  57                 for step in recipe.steps:
  58                         blocker, stream = self.download_archive(step, force = force, impl_hint = impl_hint)
  59                         assert stream
  60                         blockers.append(blocker)
  61                         streams[step] = stream
  62
  63                 while blockers:
  64                         yield blockers
  65                         tasks.check(blockers)
  66                         blockers = [b for b in blockers if not b.happened]
  67
  68                 from zeroinstall.zerostore import unpack
  69
  70                 # Create an empty directory for the new implementation
  71                 store = stores.stores[0]
  72                 tmpdir = store.get_tmp_dir_for(required_digest)
  73                 try:
  74                         # Unpack each of the downloaded archives into it in turn
  75                         for step in recipe.steps:
  76                                 stream = streams[step]
  77                                 stream.seek(0)
  78                                 unpack.unpack_archive_over(step.url, stream, tmpdir, step.extract)
  79                         # Check that the result is correct and store it in the cache
  80                         store.check_manifest_and_rename(required_digest, tmpdir)
  81                         tmpdir = None
  82                 finally:
  83                         # If unpacking fails, remove the temporary directory
  84                         if tmpdir is not None:
  85                                 from zeroinstall import support
  86                                 support.ro_rmtree(tmpdir)
  87
  88         def get_feed_mirror(self, url):
  89                 """Return the URL of a mirror for this feed."""
  90                 import urlparse
  91                 if urlparse.urlparse(url).hostname == 'localhost':
  92                         return None
  93                 return '%s/%s/latest.xml' % (self.feed_mirror, _get_feed_dir(url))
  94
  95         def download_and_import_feed(self, feed_url, iface_cache, force = False):
  96                 """Download the feed, download any required keys, confirm trust if needed and import.
  97                 @param feed_url: the feed to be downloaded
  98                 @type feed_url: str
  99                 @param iface_cache: cache in which to store the feed
 100                 @type iface_cache: L{iface_cache.IfaceCache}
 101                 @param force: whether to abort and restart an existing download"""
 102                 from download import DownloadAborted
 103
 104                 debug("download_and_import_feed %s (force = %d)", feed_url, force)
 105                 assert not feed_url.startswith('/')
 106
 107                 primary = self._download_and_import_feed(feed_url, iface_cache, force, use_mirror = False)
 108
 109                 @tasks.named_async("monitor feed downloads for " + feed_url)
 110                 def wait_for_downloads(primary):
 111                         # Download just the upstream feed, unless it takes too long...
 112                         timeout = tasks.TimeoutBlocker(5, 'Mirror timeout')             # 5 seconds
 113
 114                         yield primary, timeout
 115                         tasks.check(timeout)
 116
 117                         try:
 118                                 tasks.check(primary)
 119                                 if primary.happened:
 120                                         return          # OK, primary succeeded!
 121                                 # OK, maybe it's just being slow...
 122                                 info("Feed download from %s is taking a long time. Trying mirror too...", feed_url)
 123                                 primary_ex = None
 124                         except NoTrustedKeys, ex:
 125                                 raise                   # Don't bother trying the mirror if we have a trust problem
 126                         except ReplayAttack, ex:
 127                                 raise                   # Don't bother trying the mirror if we have a replay attack
 128                         except DownloadAborted, ex:
 129                                 raise                   # Don't bother trying the mirror if the user cancelled
 130                         except SafeException, ex:
 131                                 # Primary failed
 132                                 primary = None
 133                                 primary_ex = ex
 134                                 warn("Trying mirror, as feed download from %s failed: %s", feed_url, ex)
 135
 136                         # Start downloading from mirror...
 137                         mirror = self._download_and_import_feed(feed_url, iface_cache, force, use_mirror = True)
 138
 139                         # Wait until both mirror and primary tasks are complete...
 140                         while True:
 141                                 blockers = filter(None, [primary, mirror])
 142                                 if not blockers:
 143                                         break
 144                                 yield blockers
 145
 146                                 if primary:
 147                                         try:
 148                                                 tasks.check(primary)
 149                                                 if primary.happened:
 150                                                         primary = None
 151                                                         # No point carrying on with the mirror once the primary has succeeded
 152                                                         if mirror:
 153                                                                 info("Primary feed download succeeded; aborting mirror download for " + feed_url)
 154                                                                 mirror.dl.abort()
 155                                         except SafeException, ex:
 156                                                 primary = None
 157                                                 primary_ex = ex
 158                                                 info("Feed download from %s failed; still trying mirror: %s", feed_url, ex)
 159
 160                                 if mirror:
 161                                         try:
 162                                                 tasks.check(mirror)
 163                                                 if mirror.happened:
 164                                                         mirror = None
 165                                                         if primary_ex:
 166                                                                 # We already warned; no need to raise an exception too,
 167                                                                 # as the mirror download succeeded.
 168                                                                 primary_ex = None
 169                                         except ReplayAttack, ex:
 170                                                 info("Version from mirror is older than cached version; ignoring it: %s", ex)
 171                                                 mirror = None
 172                                                 primary_ex = None
 173                                         except SafeException, ex:
 174                                                 info("Mirror download failed: %s", ex)
 175                                                 mirror = None
 176
 177                         if primary_ex:
 178                                 raise primary_ex
 179
 180                 return wait_for_downloads(primary)
 181
 182         def _download_and_import_feed(self, feed_url, iface_cache, force, use_mirror):
 183                 """Download and import a feed.
 184                 @param use_mirror: False to use primary location; True to use mirror."""
 185                 if use_mirror:
 186                         url = self.get_feed_mirror(feed_url)
 187                         if url is None: return None
 188                 else:
 189                         url = feed_url
 190
 191                 dl = self.handler.get_download(url, force = force, hint = feed_url)
 192                 stream = dl.tempfile
 193
 194                 @tasks.named_async("fetch_feed " + url)
 195                 def fetch_feed():
 196                         yield dl.downloaded
 197                         tasks.check(dl.downloaded)
 198
 199                         pending = PendingFeed(feed_url, stream)
 200
 201                         if use_mirror:
 202                                 # If we got the feed from a mirror, get the key from there too
 203                                 key_mirror = self.feed_mirror + '/keys/'
 204                         else:
 205                                 key_mirror = None
 206
 207                         keys_downloaded = tasks.Task(pending.download_keys(self.handler, feed_hint = feed_url, key_mirror = key_mirror), "download keys for " + feed_url)
 208                         yield keys_downloaded.finished
 209                         tasks.check(keys_downloaded.finished)
 210
 211                         iface = iface_cache.get_interface(pending.url)
 212                         if not iface_cache.update_interface_if_trusted(iface, pending.sigs, pending.new_xml):
 213                                 blocker = self.handler.confirm_trust_keys(iface, pending.sigs, pending.new_xml)
 214                                 if blocker:
 215                                         yield blocker
 216                                         tasks.check(blocker)
 217                                 if not iface_cache.update_interface_if_trusted(iface, pending.sigs, pending.new_xml):
 218                                         raise NoTrustedKeys("No signing keys trusted; not importing")
 219
 220                 task = fetch_feed()
 221                 task.dl = dl
 222                 return task
 223
 224         def download_impl(self, impl, retrieval_method, stores, force = False):
 225                 """Download an implementation.
 226                 @param impl: the selected implementation
 227                 @type impl: L{model.ZeroInstallImplementation}
 228                 @param retrieval_method: a way of getting the implementation (e.g. an Archive or a Recipe)
 229                 @type retrieval_method: L{model.RetrievalMethod}
 230                 @param stores: where to store the downloaded implementation
 231                 @type stores: L{zerostore.Stores}
 232                 @param force: whether to abort and restart an existing download
 233                 @rtype: L{tasks.Blocker}"""
 234                 assert impl
 235                 assert retrieval_method
 236
 237                 from zeroinstall.zerostore import manifest
 238                 alg = impl.id.split('=', 1)[0]
 239                 if alg not in manifest.algorithms:
 240                         raise SafeException("Unknown digest algorithm '%s' for '%s' version %s" %
 241                                         (alg, impl.feed.get_name(), impl.get_version()))
 242
 243                 @tasks.async
 244                 def download_impl():
 245                         if isinstance(retrieval_method, DownloadSource):
 246                                 blocker, stream = self.download_archive(retrieval_method, force = force, impl_hint = impl)
 247                                 yield blocker
 248                                 tasks.check(blocker)
 249
 250                                 stream.seek(0)
 251                                 self._add_to_cache(stores, retrieval_method, stream)
 252                         elif isinstance(retrieval_method, Recipe):
 253                                 blocker = self.cook(impl.id, retrieval_method, stores, force, impl_hint = impl)
 254                                 yield blocker
 255                                 tasks.check(blocker)
 256                         else:
 257                                 raise Exception("Unknown download type for '%s'" % retrieval_method)
 258
 259                         self.handler.impl_added_to_store(impl)
 260                 return download_impl()
 261
 262         def _add_to_cache(self, stores, retrieval_method, stream):
 263                 assert isinstance(retrieval_method, DownloadSource)
 264                 required_digest = retrieval_method.implementation.id
 265                 url = retrieval_method.url
 266                 stores.add_archive_to_cache(required_digest, stream, retrieval_method.url, retrieval_method.extract,
 267                                                  type = retrieval_method.type, start_offset = retrieval_method.start_offset or 0)
 268
 269         def download_archive(self, download_source, force = False, impl_hint = None):
 270                 """Fetch an archive. You should normally call L{download_impl}
 271                 instead, since it handles other kinds of retrieval method too."""
 272                 from zeroinstall.zerostore import unpack
 273
 274                 url = download_source.url
 275                 if not (url.startswith('http:') or url.startswith('https:') or url.startswith('ftp:')):
 276                         raise SafeException("Unknown scheme in download URL '%s'" % url)
 277
 278                 mime_type = download_source.type
 279                 if not mime_type:
 280                         mime_type = unpack.type_from_url(download_source.url)
 281                 if not mime_type:
 282                         raise SafeException("No 'type' attribute on archive, and I can't guess from the name (%s)" % download_source.url)
 283                 unpack.check_type_ok(mime_type)
 284                 dl = self.handler.get_download(download_source.url, force = force, hint = impl_hint)
 285                 dl.expected_size = download_source.size + (download_source.start_offset or 0)
 286                 return (dl.downloaded, dl.tempfile)
 287
 288         def download_icon(self, interface, force = False):
 289                 """Download an icon for this interface and add it to the
 290                 icon cache. If the interface has no icon or we are offline, do nothing.
 291                 @return: the task doing the import, or None
 292                 @rtype: L{tasks.Task}"""
 293                 debug("download_icon %s (force = %d)", interface, force)
 294
 295                 # Find a suitable icon to download
 296                 for icon in interface.get_metadata(XMLNS_IFACE, 'icon'):
 297                         type = icon.getAttribute('type')
 298                         if type != 'image/png':
 299                                 debug('Skipping non-PNG icon')
 300                                 continue
 301                         source = icon.getAttribute('href')
 302                         if source:
 303                                 break
 304                         warn('Missing "href" attribute on <icon> in %s', interface)
 305                 else:
 306                         info('No PNG icons found in %s', interface)
 307                         return
 308
 309                 dl = self.handler.get_download(source, force = force, hint = interface)
 310
 311                 @tasks.async
 312                 def download_and_add_icon():
 313                         stream = dl.tempfile
 314                         yield dl.downloaded
 315                         try:
 316                                 tasks.check(dl.downloaded)
 317                                 stream.seek(0)
 318
 319                                 import shutil
 320                                 icons_cache = basedir.save_cache_path(config_site, 'interface_icons')
 321                                 icon_file = file(os.path.join(icons_cache, escape(interface.uri)), 'w')
 322                                 shutil.copyfileobj(stream, icon_file)
 323                         except Exception, ex:
 324                                 self.handler.report_error(ex)
 325
 326                 return download_and_add_icon()
 327
 328         def download_impls(self, implementations, stores):
 329                 """Download the given implementations, choosing a suitable retrieval method for each."""
 330                 blockers = []
 331
 332                 to_download = []
 333                 for impl in implementations:
 334                         debug("start_downloading_impls: for %s get %s", impl.feed, impl)
 335                         source = self.get_best_source(impl)
 336                         if not source:
 337                                 raise SafeException("Implementation " + impl.id + " of "
 338                                         "interface " + impl.feed.get_name() + " cannot be "
 339                                         "downloaded (no download locations given in "
 340                                         "interface!)")
 341                         to_download.append((impl, source))
 342
 343                 for impl, source in to_download:
 344                         blockers.append(self.download_impl(impl, source, stores))
 345
 346                 if not blockers:
 347                         return None
 348
 349                 @tasks.async
 350                 def download_impls(blockers):
 351                         # Record the first error log the rest
 352                         error = []
 353                         def dl_error(ex, tb = None):
 354                                 if error:
 355                                         self.handler.report_error(ex)
 356                                 else:
 357                                         error.append(ex)
 358                         while blockers:
 359                                 yield blockers
 360                                 tasks.check(blockers, dl_error)
 361
 362                                 blockers = [b for b in blockers if not b.happened]
 363                         if error:
 364                                 raise error[0]
 365
 366                 return download_impls(blockers)
 367
 368         def get_best_source(self, impl):
 369                 """Return the best download source for this implementation.
 370                 @rtype: L{model.RetrievalMethod}"""
 371                 if impl.download_sources:
 372                         return impl.download_sources[0]
 373                 return None
 374