zeroinstall/injector/download.py

   1 """
   2 Handles URL downloads.
   3
   4 This is the low-level interface for downloading interfaces, implementations, icons, etc.
   5
   6 @see: L{fetch} higher-level API for downloads that uses this module
   7 """
   8
   9 # Copyright (C) 2009, Thomas Leonard
  10 # See the README file for details, or visit http://0install.net.
  11
  12 import tempfile, os
  13
  14 from zeroinstall import SafeException
  15 from zeroinstall.support import tasks
  16 from logging import info, debug
  17 from zeroinstall import _
  18
  19 download_starting = "starting"  # Waiting for UI to start it (no longer used)
  20 download_fetching = "fetching"  # In progress
  21 download_complete = "complete"  # Downloaded and cached OK
  22 download_failed = "failed"
  23
  24 RESULT_OK = 0
  25 RESULT_FAILED = 1
  26 RESULT_NOT_MODIFIED = 2
  27 RESULT_REDIRECT = 3
  28
  29 class DownloadError(SafeException):
  30         """Download process failed."""
  31         pass
  32
  33 class DownloadAborted(DownloadError):
  34         """Download aborted because of a call to L{Download.abort}"""
  35         def __init__(self, message = None):
  36                 SafeException.__init__(self, message or _("Download aborted at user's request"))
  37
  38 class Download(object):
  39         """A download of a single resource to a temporary file.
  40         @ivar url: the URL of the resource being fetched
  41         @type url: str
  42         @ivar tempfile: the file storing the downloaded data
  43         @type tempfile: file
  44         @ivar status: the status of the download
  45         @type status: (download_fetching | download_failed | download_complete)
  46         @ivar expected_size: the expected final size of the file
  47         @type expected_size: int | None
  48         @ivar downloaded: triggered when the download ends (on success or failure)
  49         @type downloaded: L{tasks.Blocker}
  50         @ivar hint: hint passed by and for caller
  51         @type hint: object
  52         @ivar aborted_by_user: whether anyone has called L{abort}
  53         @type aborted_by_user: bool
  54         @ivar unmodified: whether the resource was not modified since the modification_time given at construction
  55         @type unmodified: bool
  56         """
  57         __slots__ = ['url', 'tempfile', 'status', 'expected_size', 'downloaded',
  58                      'hint', '_final_total_size', 'aborted_by_user',
  59                      'modification_time', 'unmodified', '_aborted']
  60
  61         def __init__(self, url, hint = None, modification_time = None, expected_size = None, auto_delete = True):
  62                 """Create a new download object.
  63                 @param url: the resource to download
  64                 @param hint: object with which this download is associated (an optional hint for the GUI)
  65                 @param modification_time: string with HTTP date that indicates last modification time.
  66                   The resource will not be downloaded if it was not modified since that date.
  67                 @postcondition: L{status} == L{download_fetching}."""
  68                 self.url = url
  69                 self.hint = hint
  70                 self.aborted_by_user = False            # replace with _aborted?
  71                 self.modification_time = modification_time
  72                 self.unmodified = False
  73
  74                 self.tempfile = None            # Stream for result
  75                 self.downloaded = None
  76
  77                 self.expected_size = expected_size      # Final size (excluding skipped bytes)
  78                 self._final_total_size = None   # Set when download is finished
  79
  80                 self.status = download_fetching
  81                 if auto_delete:
  82                         self.tempfile = tempfile.TemporaryFile(prefix = 'injector-dl-data-', mode = 'w+b')
  83                 else:
  84                         self.tempfile = tempfile.NamedTemporaryFile(prefix = 'injector-dl-data-', mode = 'w+b', delete = False)
  85
  86                 self._aborted = tasks.Blocker("abort " + url)
  87
  88         def _finish(self, status):
  89                 assert self.status is download_fetching
  90                 assert self.tempfile is not None
  91                 assert not self.aborted_by_user
  92
  93                 if status == RESULT_NOT_MODIFIED:
  94                         debug("%s not modified", self.url)
  95                         self.tempfile = None
  96                         self.unmodified = True
  97                         self.status = download_complete
  98                         self._final_total_size = 0
  99                         return
 100
 101                 self._final_total_size = self.get_bytes_downloaded_so_far()
 102
 103                 self.tempfile = None
 104
 105                 try:
 106                         assert status == RESULT_OK
 107
 108                         # Check that the download has the correct size, if we know what it should be.
 109                         if self.expected_size is not None:
 110                                 if self._final_total_size != self.expected_size:
 111                                         raise SafeException(_('Downloaded archive has incorrect size.\n'
 112                                                         'URL: %(url)s\n'
 113                                                         'Expected: %(expected_size)d bytes\n'
 114                                                         'Received: %(size)d bytes') % {'url': self.url, 'expected_size': self.expected_size, 'size': self._final_total_size})
 115                 except:
 116                         self.status = download_failed
 117                         raise
 118                 else:
 119                         self.status = download_complete
 120
 121         def abort(self):
 122                 """Signal the current download to stop.
 123                 @postcondition: L{aborted_by_user}"""
 124                 self.status = download_failed
 125
 126                 if self.tempfile is not None:
 127                         info(_("Aborting download of %s"), self.url)
 128                         # TODO: we currently just close the output file; the thread will end when it tries to
 129                         # write to it. We should try harder to stop the thread immediately (e.g. by closing its
 130                         # socket when known), although we can never cover all cases (e.g. a stuck DNS lookup).
 131                         # In any case, we don't wait for the child to exit before notifying tasks that are waiting
 132                         # on us.
 133                         self.aborted_by_user = True
 134                         self.tempfile.close()
 135                         if hasattr(self.tempfile, 'delete') and not self.tempfile.delete:
 136                                 os.remove(self.tempfile.name)
 137                         self.tempfile = None
 138                         self._aborted.trigger()
 139
 140         def get_current_fraction(self):
 141                 """Returns the current fraction of this download that has been fetched (from 0 to 1),
 142                 or None if the total size isn't known.
 143                 @return: fraction downloaded
 144                 @rtype: int | None"""
 145                 if self.tempfile is None:
 146                         return 1
 147                 if self.expected_size is None:
 148                         return None             # Unknown
 149                 current_size = self.get_bytes_downloaded_so_far()
 150                 return float(current_size) / self.expected_size
 151
 152         def get_bytes_downloaded_so_far(self):
 153                 """Get the download progress. Will be zero if the download has not yet started.
 154                 @rtype: int"""
 155                 if self.status is download_fetching:
 156                         return os.fstat(self.tempfile.fileno()).st_size
 157                 else:
 158                         return self._final_total_size or 0
 159
 160         def __str__(self):
 161                 return _("<Download from %s>") % self.url