Download resumption - Preliminary

content/public/browser/download_item.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 // Each download is represented by a DownloadItem, and all DownloadItems
 // are owned by the DownloadManager which maintains a global list of all
 // downloads. DownloadItems are created when a user initiates a download,
 // and exist for the duration of the browser life time.
 //
 // Download observers:
 //   DownloadItem::Observer:
 //     - allows observers to receive notifications about one download from start
 //       to completion
 // Use AddObserver() / RemoveObserver() on the appropriate download object to
 // receive state updates.
 
 #ifndef CONTENT_PUBLIC_BROWSER_DOWNLOAD_ITEM_H_
 #define CONTENT_PUBLIC_BROWSER_DOWNLOAD_ITEM_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/file_path.h"
 #include "base/string16.h"
 #include "base/supports_user_data.h"
 #include "content/public/browser/download_danger_type.h"
 #include "content/public/browser/download_interrupt_reasons.h"
 #include "content/public/common/page_transition_types.h"
+#include "net/base/net_log.h"
 
 class FilePath;
 class GURL;
 struct DownloadCreateInfo;
 
 namespace base {
 class Time;
 class TimeDelta;
 }
 
@@ skipping 42 matching lines @@
   };
 
   // How the final target path should be used.
   enum TargetDisposition {
     TARGET_DISPOSITION_OVERWRITE, // Overwrite if the target already exists.
     TARGET_DISPOSITION_PROMPT     // Prompt the user for the actual
                                   // target. Implies
                                   // TARGET_DISPOSITION_OVERWRITE.
   };
 
+  enum ResumeMode {
+    RESUME_MODE_INVALID = 0,
+    RESUME_MODE_IMMEDIATE_CONTINUE,
+    RESUME_MODE_IMMEDIATE_RESTART,
+    RESUME_MODE_USER_CONTINUE,
+    RESUME_MODE_USER_RESTART
+  };

[Randy Smith (Not in Mondays), 2012/10/15 00:36:08]

I'm uncomfortable about exposing this at the DownloadItem level, at least before
we have some need of it at that level.  All that the DownloadItem consumers need
is != INVALID, which is most of what CanResumeDownload() gives.  Can we use just
that, and leave this (and CanResumeInterrupted()) out of the DownloadItem?

+
   // A fake download table ID which represents a download that has started,
   // but is not yet in the table.
   static const int kUninitializedHandle;
 
   static const char kEmptyFileHash[];
 
   // Interface that observers of a particular download must implement in order
   // to receive updates to the download's status.
   class CONTENT_EXPORT Observer {
    public:
@@ skipping 55 matching lines @@
 
   virtual int32 GetId() const = 0;
   virtual DownloadId GetGlobalId() const = 0;
   virtual int64 GetDbHandle() const = 0;
   virtual DownloadState GetState() const = 0;
 
   // Only valid if |GetState() == DownloadItem::INTERRUPTED|.
   virtual DownloadInterruptReason GetLastReason() const = 0;
 
   virtual bool IsPaused() const = 0;
+  virtual ResumeMode CanResumeInterrupted() const = 0;
   virtual bool IsTemporary() const = 0;
   virtual bool IsPersisted() const = 0;
 
   //    Convenience routines for accessing GetState() results conceptually -----
 
   // Returns true if the download needs more data.
   virtual bool IsPartialDownload() const = 0;
 
   // Returns true if the download is still receiving data.
   virtual bool IsInProgress() const = 0;
@@ skipping 101 matching lines @@
   virtual base::Time GetEndTime() const = 0;
 
   //    Open/Show State accessors ----------------------------------------------
 
   // Returns true if it is OK to open a folder which this file is inside.
   virtual bool CanShowInFolder() = 0;
 
   // Returns true if it is OK to open the download.
   virtual bool CanOpenDownload() = 0;
 
+  // Returns true if the download is paused or interrupted, and can be resumed.
+  virtual bool CanResumeDownload() const = 0;
+
   // Tests if a file type should be opened automatically.
   virtual bool ShouldOpenFileBasedOnExtension() = 0;
 
   // Returns true if the download will be auto-opened when complete.
   virtual bool GetOpenWhenComplete() const = 0;
 
   // Returns true if the download has been auto-opened by the system.
   virtual bool GetAutoOpened() = 0;
 
   // Returns true if the download has been opened.
@@ skipping 27 matching lines @@
 
   // Mark the download as having been opened (without actually opening it).
   virtual void SetOpened(bool opened) = 0;
 
   // Set a display name for the download that will be independent of the target
   // filename. If |name| is not empty, then GetFileNameToReportUser() will
   // return |name|. Has no effect on the final target filename.
   virtual void SetDisplayName(const FilePath& name) = 0;
 
   // Debug/testing -------------------------------------------------------------
+  // Gets the BoundNetLog associated with this download.
+  virtual const net::BoundNetLog& GetBoundNetLog() const = 0;
+
   virtual std::string DebugString(bool verbose) const = 0;
   virtual void MockDownloadOpenForTesting() = 0;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_DOWNLOAD_ITEM_H_