better handling, error reporting for downloading and subdocument downloading

panda/src/downloader/Sources.pp

@@ -13,7 +13,8 @@
     bioPtr.I bioPtr.h \
     bioStreamPtr.I bioStreamPtr.h \
     bioStream.I bioStream.h bioStreamBuf.h \
-    chunkedStream.I chunkedStream.h chunkedStreamBuf.h \
+    chunkedStream.I chunkedStream.h \
+    chunkedStreamBuf.h chunkedStreamBuf.I \
     decompressor.h decompressor.I \
     documentSpec.I documentSpec.h \
     downloadDb.I downloadDb.h \
@@ -28,7 +29,8 @@
     httpDigestAuthorization.I httpDigestAuthorization.h \
     httpEntityTag.I httpEntityTag.h \
     httpEnum.h \
-    identityStream.I identityStream.h identityStreamBuf.h \
+    identityStream.I identityStream.h \
+    identityStreamBuf.h identityStreamBuf.I \
     multiplexStream.I multiplexStream.h \
     multiplexStreamBuf.I multiplexStreamBuf.h \
     patcher.h patcher.I \
@@ -67,7 +69,8 @@
     bioPtr.I bioPtr.h \
     bioStreamPtr.I bioStreamPtr.h \
     bioStream.I bioStream.h bioStreamBuf.h \
-    chunkedStream.I chunkedStream.h chunkedStreamBuf.h \
+    chunkedStream.I chunkedStream.h \
+    chunkedStreamBuf.h chunkedStreamBuf.I \
     config_downloader.h \
     decompressor.h decompressor.I \
     documentSpec.h documentSpec.I \
@@ -82,7 +85,8 @@
     httpDigestAuthorization.I httpDigestAuthorization.h \
     httpEntityTag.I httpEntityTag.h \
     httpEnum.h \
-    identityStream.I identityStream.h identityStreamBuf.h \
+    identityStream.I identityStream.h \
+    identityStreamBuf.h identityStreamBuf.I \
     multiplexStream.I multiplexStream.h \
     multiplexStreamBuf.I multiplexStreamBuf.h \
     patcher.h patcher.I \

panda/src/downloader/chunkedStream.cxx

@@ -30,7 +30,7 @@
 ////////////////////////////////////////////////////////////////////
 bool IChunkedStream::
 is_closed() {
-  if (_buf._done || (*_buf._source)->is_closed()) {
+  if (_buf._done || _buf.is_closed()) {
     return true;
   }
   clear();

panda/src/downloader/chunkedStreamBuf.I

@@ -0,0 +1,28 @@
+// Filename: chunkedStreamBuf.I
+// Created by:  drose (14Nov06)
+//
+////////////////////////////////////////////////////////////////////
+//
+// PANDA 3D SOFTWARE
+// Copyright (c) 2001 - 2004, Disney Enterprises, Inc.  All rights reserved
+//
+// All use of this software is subject to the terms of the Panda 3d
+// Software license.  You should have received a copy of this license
+// along with this source code; you will also find a current copy of
+// the license at http://etc.cmu.edu/panda3d/docs/license/ .
+//
+// To contact the maintainers of this program write to
+// panda3d-general@lists.sourceforge.net .
+//
+////////////////////////////////////////////////////////////////////
+
+
+////////////////////////////////////////////////////////////////////
+//     Function: ChunkedStreamBuf::is_closed
+//       Access: Public
+//  Description:
+////////////////////////////////////////////////////////////////////
+INLINE bool ChunkedStreamBuf::
+is_closed() const {
+  return (_source == (BioStreamPtr *)NULL || (*_source)->is_closed());
+}

panda/src/downloader/chunkedStreamBuf.h

@@ -42,6 +42,8 @@ public:
   void open_read(BioStreamPtr *source, HTTPChannel *doc);
   void close_read();
 
+  INLINE bool is_closed() const;
+
 protected:
   virtual int underflow();
 
@@ -60,6 +62,8 @@ private:
   friend class IChunkedStream;
 };
 
+#include "chunkedStreamBuf.I"
+
 #endif  // HAVE_OPENSSL
 
 #endif

panda/src/downloader/httpChannel.cxx

@@ -258,8 +258,14 @@ get_status_string() const {
   case SC_ssl_unexpected_server:
     return "Unexpected SSL server";
 
+  case SC_download_open_error:
+    return "Error opening file";
+
   case SC_download_write_error:
     return "Error writing to disk";
+
+  case SC_download_invalid_range:
+    return "Invalid subrange requested";
   }
 
   return _status_entry._status_string;
@@ -621,20 +627,9 @@ download_to_file(const Filename &filename, bool subdocument_resumes) {
   _download_to_filename.set_binary();
   _download_to_file.close();
   _download_to_file.clear();
-
+  _subdocument_resumes = subdocument_resumes;
-  _subdocument_resumes = (subdocument_resumes && _first_byte_delivered != 0);
-
-  if (!_download_to_filename.open_write(_download_to_file, !_subdocument_resumes)) {
-    downloader_cat.info()
-      << "Could not open " << _download_to_filename << " for writing.\n";
-    return false;
-  }
 
   _download_dest = DD_file;
-  if (!reset_download_position(_first_byte_delivered)) {
-    reset_download_to();
-    return false;
-  }
 
   if (_nonblocking) {
     // In nonblocking mode, we can't start the download yet; that will
@@ -643,6 +638,11 @@ download_to_file(const Filename &filename, bool subdocument_resumes) {
   }
 
   // In normal, blocking mode, go ahead and do the download.
+  if (!open_download_file()) {
+    reset_download_to();
+    return false;
+  }
+
   run();
   return is_download_complete();
 }
@@ -687,11 +687,6 @@ download_to_ram(Ramfile *ramfile, bool subdocument_resumes) {
   _download_dest = DD_ram;
   _subdocument_resumes = (subdocument_resumes && _first_byte_delivered != 0);
 
-  if (!reset_download_position(_first_byte_delivered)) {
-    reset_download_to();
-    return false;
-  }
-
   if (_nonblocking) {
     // In nonblocking mode, we can't start the download yet; that will
     // be done later as run() is called.
@@ -699,6 +694,11 @@ download_to_ram(Ramfile *ramfile, bool subdocument_resumes) {
   }
 
   // In normal, blocking mode, go ahead and do the download.
+  if (!open_download_file()) {
+    reset_download_to();
+    return false;
+  }
+
   run();
   return is_download_complete();
 }
@@ -829,6 +829,9 @@ reached_done_state() {
         _body_stream = NULL;
       }
       _started_download = true;
+
+
+      _done_state = S_read_trailer;
       _last_run_time = TrueClock::get_global_ptr()->get_short_time();
       return true;
     }
@@ -1709,11 +1712,10 @@ run_reading_header() {
     _document_spec.set_date(HTTPDate(date));
   }
 
-  // In case we've got a download in effect, reset the download
+  // In case we've got a download in effect, now we know what the
-  // position to match our starting byte.
+  // first byte of the subdocument request will be, so we can open the
-  if (!reset_download_position(_first_byte_delivered)) {
+  // file and position it.
-    _status_entry._status_code = SC_invalid_http;
+  if (!open_download_file()) {
-    _state = S_failure;
     return false;
   }
 
@@ -2057,20 +2059,31 @@ run_download_to_file() {
   nassertr(_body_stream != (ISocketStream *)NULL, false);
 
   bool do_throttle = _nonblocking && _download_throttle;
-  int count = 0;
 
-  int ch = _body_stream->get();
+  static const size_t buffer_size = 1024;
-  nassertr(_body_stream != (ISocketStream *)NULL, false);
+  char buffer[buffer_size];
-  while (!_body_stream->eof() && !_body_stream->fail()) {
+
-    _download_to_file.put(ch);
+  size_t remaining_this_pass = buffer_size;
-    _bytes_downloaded++;
+  if (do_throttle) {
-    if (do_throttle && (++count >= _bytes_per_update)) {
+    remaining_this_pass = _bytes_per_update;
+  }
+
+  _body_stream->read(buffer, min(buffer_size, remaining_this_pass));
+  size_t count = _body_stream->gcount();
+  while (count != 0) {
+    _download_to_file.write(buffer, count);
+    _bytes_downloaded += count;
+    if (do_throttle) {
+      nassertr(count <= remaining_this_pass, false);
+      remaining_this_pass -= count;
+      if (remaining_this_pass == 0) {
         // That's enough for now.
         return true;
       }
+    }
 
-    ch = _body_stream->get();
+    _body_stream->read(buffer, min(buffer_size, remaining_this_pass));
-    nassertr(_body_stream != (ISocketStream *)NULL, false);
+    count = _body_stream->gcount();
   }
 
   if (_download_to_file.fail()) {
@@ -2078,13 +2091,15 @@ run_download_to_file() {
       << "Error writing to " << _download_to_filename << "\n";
     _status_entry._status_code = SC_download_write_error;
     _state = S_failure;
-    _download_to_file.close();
+    reset_download_to();
     return false;
   }
 
+  _download_to_file.flush();
+
   if (_body_stream->is_closed()) {
     // Done.
-    _download_to_file.close();
+    _started_download = false;
     return false;
   } else {
     // More to come.
@@ -2104,24 +2119,36 @@ run_download_to_ram() {
   nassertr(_download_to_ramfile != (Ramfile *)NULL, false);
 
   bool do_throttle = _nonblocking && _download_throttle;
-  int count = 0;
 
-  int ch = _body_stream->get();
+  static const size_t buffer_size = 1024;
-  nassertr(_body_stream != (ISocketStream *)NULL, false);
+  char buffer[buffer_size];
-  while (!_body_stream->eof() && !_body_stream->fail()) {
+
-    _download_to_ramfile->_data += (char)ch;
+  size_t remaining_this_pass = buffer_size;
-    _bytes_downloaded++;
+  if (do_throttle) {
-    if (do_throttle && (++count >= _bytes_per_update)) {
+    remaining_this_pass = _bytes_per_update;
+  }
+
+  _body_stream->read(buffer, min(buffer_size, remaining_this_pass));
+  size_t count = _body_stream->gcount();
+  while (count != 0) {
+    _download_to_ramfile->_data += string(buffer, count);
+    _bytes_downloaded += count;
+    if (do_throttle) {
+      nassertr(count <= remaining_this_pass, false);
+      remaining_this_pass -= count;
+      if (remaining_this_pass == 0) {
         // That's enough for now.
         return true;
       }
+    }
 
-    ch = _body_stream->get();
+    _body_stream->read(buffer, min(buffer_size, remaining_this_pass));
-    nassertr(_body_stream != (ISocketStream *)NULL, false);
+    count = _body_stream->gcount();
   }
 
   if (_body_stream->is_closed()) {
     // Done.
+    _started_download = false;
     return false;
   } else {
     // More to come.
@@ -2309,16 +2336,30 @@ finished_body(bool has_trailer) {
 }
 
 ////////////////////////////////////////////////////////////////////
-//     Function: HTTPChannel::reset_download_position
+//     Function: HTTPChannel::open_download_file
 //       Access: Private
-//  Description: If a download has been requested, seeks within the
+//  Description: If a download has been requested, opens the file on
-//               download file to the appropriate first_byte position,
+//               disk (or prepares the RamFile) and seeks within it to
-//               so that downloaded bytes will be written to the
+//               the appropriate _first_byte_delivered position, so
+//               that downloaded bytes will be written to the
 //               appropriate point within the file.  Returns true if
-//               the starting position is valid, false otherwise.
+//               the starting position is valid, false otherwise (in
+//               which case the state is set to S_failure).
 ////////////////////////////////////////////////////////////////////
 bool HTTPChannel::
-reset_download_position(size_t first_byte) {
+open_download_file() {
+  _subdocument_resumes = (_subdocument_resumes && _first_byte_delivered != 0);
+
+  if (_download_dest == DD_file) {
+    if (!_download_to_filename.open_write(_download_to_file, !_subdocument_resumes)) {
+      downloader_cat.info()
+        << "Could not open " << _download_to_filename << " for writing.\n";
+      _status_entry._status_code = SC_download_open_error;
+      _state = S_failure;
+      return false;
+    }
+  }
+
   if (_subdocument_resumes) {
     if (_download_dest == DD_file) {
       // Windows doesn't complain if you try to seek past the end of
@@ -2326,38 +2367,42 @@ reset_download_position(size_t first_byte) {
       // difference.  Blecch.  That means we need to get the file size
       // first to check it ourselves.
       _download_to_file.seekp(0, ios::end);
-      if (first_byte > (size_t)_download_to_file.tellp()) {
+      if (_first_byte_delivered > (size_t)_download_to_file.tellp()) {
         downloader_cat.info()
-          << "Invalid starting position of byte " << first_byte
+          << "Invalid starting position of byte " << _first_byte_delivered
           << " within " << _download_to_filename << " (which has " 
           << _download_to_file.tellp() << " bytes)\n";
         _download_to_file.close();
+        _status_entry._status_code = SC_download_invalid_range;
+        _state = S_failure;
         return false;
       }
       
-      _download_to_file.seekp(first_byte);
+      _download_to_file.seekp(_first_byte_delivered);
       
     } else if (_download_dest == DD_ram) {
-      if (first_byte > _download_to_ramfile->_data.length()) {
+      if (_first_byte_delivered > _download_to_ramfile->_data.length()) {
         downloader_cat.info()
-          << "Invalid starting position of byte " << first_byte 
+          << "Invalid starting position of byte " << _first_byte_delivered 
           << " within Ramfile (which has " 
           << _download_to_ramfile->_data.length() << " bytes)\n";
+        _status_entry._status_code = SC_download_invalid_range;
+        _state = S_failure;
         return false;
       }
 
-      if (first_byte == 0) {
+      if (_first_byte_delivered == 0) {
         _download_to_ramfile->_data = string();
       } else {
         _download_to_ramfile->_data = 
-          _download_to_ramfile->_data.substr(0, first_byte);
+          _download_to_ramfile->_data.substr(0, _first_byte_delivered);
       }
     }
 
   } else {
     // If _subdocument_resumes is false, we should be sure to reset to
     // the beginning of the file, regardless of the value of
-    // first_byte.
+    // _first_byte_delivered.
     if (_download_dest == DD_file) {
       _download_to_file.seekp(0);
     } else if (_download_dest == DD_ram) {

panda/src/downloader/httpChannel.h

@@ -102,7 +102,12 @@ PUBLISHED:
 
     SC_ssl_invalid_server_certificate,
     SC_ssl_unexpected_server,
+    
+    // These errors are only generated after a download_to_ram() or
+    // download_to_file() call has been issued.
+    SC_download_open_error,
     SC_download_write_error,
+    SC_download_invalid_range,
   };
 
   INLINE bool is_valid() const;
@@ -227,7 +232,7 @@ private:
   void reset_for_new_request();
 
   void finished_body(bool has_trailer);
-  bool reset_download_position(size_t first_byte);
+  bool open_download_file();
 
   bool server_getline(string &str);
   bool server_getline_failsafe(string &str);

panda/src/downloader/identityStream.cxx

@@ -31,7 +31,7 @@
 bool IIdentityStream::
 is_closed() {
   if ((_buf._has_content_length && _buf._bytes_remaining == 0) || 
-      (*_buf._source)->is_closed()) {
+      _buf.is_closed()) {
     return true;
   }
   clear();

panda/src/downloader/identityStreamBuf.I

@@ -0,0 +1,28 @@
+// Filename: identityStreamBuf.I
+// Created by:  drose (14Nov06)
+//
+////////////////////////////////////////////////////////////////////
+//
+// PANDA 3D SOFTWARE
+// Copyright (c) 2001 - 2004, Disney Enterprises, Inc.  All rights reserved
+//
+// All use of this software is subject to the terms of the Panda 3d
+// Software license.  You should have received a copy of this license
+// along with this source code; you will also find a current copy of
+// the license at http://etc.cmu.edu/panda3d/docs/license/ .
+//
+// To contact the maintainers of this program write to
+// panda3d-general@lists.sourceforge.net .
+//
+////////////////////////////////////////////////////////////////////
+
+
+////////////////////////////////////////////////////////////////////
+//     Function: IdentityStreamBuf::is_closed
+//       Access: Public
+//  Description:
+////////////////////////////////////////////////////////////////////
+INLINE bool IdentityStreamBuf::
+is_closed() const {
+  return (_source == (BioStreamPtr *)NULL || (*_source)->is_closed());
+}

panda/src/downloader/identityStreamBuf.cxx

@@ -156,6 +156,7 @@ read_chars(char *start, size_t length) {
       length = min(length, _bytes_remaining);
       (*_source)->read(start, length);
       read_count = (*_source)->gcount();
+      nassertr(read_count <= _bytes_remaining, 0);
       _bytes_remaining -= read_count;
   
       if (read_count == 0) {
@@ -163,6 +164,7 @@ read_chars(char *start, size_t length) {
           // socket closed unexpectedly; problem.
           if (_doc != (HTTPChannel *)NULL && _read_index == _doc->_read_index) {
             _doc->_state = HTTPChannel::S_failure;
+            _doc->_status_entry._status_code = HTTPChannel::SC_lost_connection;
           }
         }
         return 0;

panda/src/downloader/identityStreamBuf.h

@@ -42,6 +42,8 @@ public:
                  bool has_content_length, size_t content_length);
   void close_read();
 
+  INLINE bool is_closed() const;
+
 protected:
   virtual int underflow();
 
@@ -58,6 +60,8 @@ private:
   friend class IIdentityStream;
 };
 
+#include "identityStreamBuf.I"
+
 #endif  // HAVE_OPENSSL
 
 #endif