DownloadManager intereface refactoring to allow cleaner DownloadItem unit tests.

content/browser/download/download_item.h

 // Copyright (c) 2011 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_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_H_
 #define CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_H_
 #pragma once
 
 #include <string>
 
 #include "base/string16.h"
+#include "content/browser/download/download_id.h"

[cbentzel, 2011/12/02 18:00:52]

Why does this need to be included instead of forward declared as it had? 

[Randy Smith (Not in Mondays), 2011/12/02 20:04:12]

Well, I would have thought a by-value return of the type would require a full
declaration so that the calling code could know how much space to allocate for
the return value.  But I agree with you that the change I'm making here doesn't
look like it should produce a new need for including the file, so even though I
don't understand how the forward decl works: Done.

 #include "content/browser/download/download_state_info.h"
 #include "content/browser/download/interrupt_reasons.h"
 
 class DownloadFileManager;
-class DownloadId;
 class DownloadManager;
 class FilePath;
 class GURL;
 class TabContents;
 struct DownloadCreateInfo;
 struct DownloadPersistentStoreInfo;
 namespace base {
 class Time;
 class TimeDelta;
 }
 
+namespace content {
+class BrowserContext;
+}
+
 // One DownloadItem per download. This is the model class that stores all the
 // state for a download. Multiple views, such as a tab's download shelf and the
 // Destination tab's download view, may refer to a given DownloadItem.
 //
 // This is intended to be used only on the UI thread.
 class CONTENT_EXPORT DownloadItem {
  public:
   enum DownloadState {
     // Download is actively progressing.
     IN_PROGRESS = 0,
@@ skipping 96 matching lines @@
   // Called by the delegate after it delayed opening the download in
   // DownloadManagerDelegate::ShouldOpenDownload.
   virtual void DelayedDownloadOpened() = 0;
 
   // Called when all data has been saved. Only has display effects.
   virtual void OnAllDataSaved(int64 size, const std::string& final_hash) = 0;
 
   // Called when the downloaded file is removed.
   virtual void OnDownloadedFileRemoved() = 0;
 
+  // If all pre-requisites have been met, complete download processing, i.e.
+  // do internal cleanup, file rename, and potentially auto-open.
+  // (Dangerous downloads still may block on user acceptance after this
+  // point.)
+  virtual void MaybeCompleteDownload() = 0;
+
   // Download operation had an error.
   // |size| is the amount of data received at interruption.
   // |reason| is the download interrupt reason code that the operation received.
   virtual void Interrupted(int64 size, InterruptReason reason) = 0;
 
   // Deletes the file from disk and removes the download from the views and
   // history.  |user| should be true if this is the result of the user clicking
   // the discard button, and false if it is being deleted for other reasons like
   // browser shutdown.
   virtual void Delete(DeleteReason reason) = 0;
@@ skipping 74 matching lines @@
   virtual std::string GetReferrerCharset() const = 0;
   virtual int64 GetTotalBytes() const = 0;
   virtual void SetTotalBytes(int64 total_bytes) = 0;
   virtual int64 GetReceivedBytes() const = 0;
   virtual int32 GetId() const = 0;
   virtual DownloadId GetGlobalId() const = 0;
   virtual base::Time GetStartTime() const = 0;
   virtual base::Time GetEndTime() const = 0;
   virtual void SetDbHandle(int64 handle) = 0;
   virtual int64 GetDbHandle() const = 0;
-  virtual DownloadManager* GetDownloadManager() = 0;
   virtual bool IsPaused() const = 0;
   virtual bool GetOpenWhenComplete() const = 0;
   virtual void SetOpenWhenComplete(bool open) = 0;
   virtual bool GetFileExternallyRemoved() const = 0;
   virtual SafetyState GetSafetyState() const = 0;
   // Why |safety_state_| is not SAFE.
   virtual DownloadStateInfo::DangerType GetDangerType() const = 0;
   virtual bool IsDangerous() const = 0;
   virtual void MarkContentDangerous() = 0;
   virtual void MarkFileDangerous() = 0;
   virtual void MarkUrlDangerous() = 0;
 
   virtual bool GetAutoOpened() = 0;
   virtual const FilePath& GetTargetName() const = 0;
   virtual bool PromptUserForSaveLocation() const = 0;
   virtual bool IsOtr() const = 0;
   virtual const FilePath& GetSuggestedPath() const = 0;
   virtual bool IsTemporary() const = 0;
   virtual void SetOpened(bool opened) = 0;
   virtual bool GetOpened() const = 0;
 
   virtual InterruptReason GetLastReason() const = 0;
   virtual DownloadPersistentStoreInfo GetPersistentStoreInfo() const = 0;
   virtual DownloadStateInfo GetStateInfo() const = 0;
+  virtual content::BrowserContext* BrowserContext() const = 0;
   virtual TabContents* GetTabContents() const = 0;
 
   // Returns the final target file path for the download.
   virtual FilePath GetTargetFilePath() const = 0;
 
   // Returns the file-name that should be reported to the user, which is
   // target_name possibly with the uniquifier number.
   virtual FilePath GetFileNameToReportUser() const = 0;
 
   // Returns the user-verified target file path for the download.
@@ skipping 11 matching lines @@
   // DownloadManager::FileSelectionCancelled() without doing some
   // rewrites of the DownloadManager queues.
   virtual void OffThreadCancel(DownloadFileManager* file_manager) = 0;
 
   virtual std::string DebugString(bool verbose) const = 0;
 
   virtual void MockDownloadOpenForTesting() = 0;
 };
 
 #endif  // CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_H_