[Resumption 9/11] Handle filename determination for resumed downloads.

chrome/browser/download/download_target_determiner.h

 // Copyright 2013 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.
 
 #ifndef CHROME_BROWSER_DOWNLOAD_DOWNLOAD_TARGET_DETERMINER_H_
 #define CHROME_BROWSER_DOWNLOAD_DOWNLOAD_TARGET_DETERMINER_H_
 
 #include "base/files/file_path.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
@@ skipping 34 matching lines @@
 // responsible for providing external dependencies and prompting the user if
 // necessary.
 //
 // The only public entrypoint is the static Start() method which creates an
 // instance of DownloadTargetDeterminer.
 class DownloadTargetDeterminer
     : public content::DownloadItem::Observer {
  public:
   // Start the process of determing the target of |download|.
   //
+  // |initial_virtual_path| if non-empty, defines the initial virtual path for
+  //   the target determination process. If one isn't specified, one will be
+  //   generated based on the response data specified in |download| and the
+  //   users' downloads directory.
+  //   Note: |initial_virtual_path| is only used if download has prompted the
+  //       user before and doesn't have a forced path.
   // |download_prefs| is required and must outlive |download|. It is used for
   //   determining the user's preferences regarding the default downloads
   //   directory, prompting and auto-open behavior.
   // |delegate| is required and must live until |callback| is invoked.
   // |callback| will be scheduled asynchronously on the UI thread after download
   //   determination is complete or after |download| is destroyed.
   //
   // Start() should be called on the UI thread.
   static void Start(content::DownloadItem* download,
+                    const base::FilePath& initial_virtual_path,
                     DownloadPrefs* download_prefs,
                     DownloadTargetDeterminerDelegate* delegate,
                     const content::DownloadTargetCallback& callback);
 
   // Returns a .crdownload intermediate path for the |suggested_path|.
   static base::FilePath GetCrDownloadPath(const base::FilePath& suggested_path);
 
  private:
   // The main workflow is controlled via a set of state transitions. Each state
   // has an associated handler. The handler for STATE_FOO is DoFoo. Each handler
@@ skipping 33 matching lines @@
   // referrer URL for the download prior to today.
   enum PriorVisitsToReferrer {
     NO_VISITS_TO_REFERRER,
     VISITED_REFERRER,
   };
 
   // Construct a DownloadTargetDeterminer object. Constraints on the arguments
   // are as per Start() above.
   DownloadTargetDeterminer(
       content::DownloadItem* download,
+      const base::FilePath& initial_virtual_path,
       DownloadPrefs* download_prefs,
       DownloadTargetDeterminerDelegate* delegate,
       const content::DownloadTargetCallback& callback);
 
   virtual ~DownloadTargetDeterminer();
 
   // Invoke each successive handler until a handler returns QUIT_DOLOOP or
   // COMPLETE. Note that as a result, this object might be deleted. So |this|
   // should not be accessed after calling DoLoop().
   void DoLoop();
@@ skipping 80 matching lines @@
   // === End of main workflow ===
 
   // Utilities:
 
   void ScheduleCallbackAndDeleteSelf();
 
   void CancelOnFailureAndDeleteSelf();
 
   Profile* GetProfile();
 
-  bool ShouldPromptForDownload(const base::FilePath& filename);
+  // Determine whether to prompt the user for the download location. For regular
+  // downloads, this determination is based on the target disposition, auto-open
+  // behavior, among other factors. For an interrupted download, this
+  // determination will be based on the interrupt reason. It is assumed that
+  // download interruptions always occur after the first round of download
+  // target determination is complete.

[Randy Smith (Not in Mondays), 2013/05/30 21:26:24]

Just calling out that our tentative plan to restart cancelled downloads will
probably have to change this assumption.  No need to do anything about that in
this CL.

[asanka, 2013/05/31 19:23:59]

Yup.

+  bool ShouldPromptForDownload(const base::FilePath& filename) const;
+
+  // Returns true if the user has been prompted for this download at least once
+  // prior to this target determination operation. This method is only expected
+  // to return true for a resuming interrupted download that has prompted the
+  // user before interruption. The return value does not depend on whether the
+  // user will be or has been prompted during the current target determination
+  // operation.
+  bool HasPromptedForPath() const;
 
   // Returns true if this download should show the "dangerous file" warning.
   // Various factors are considered, such as the type of the file, whether a
   // user action initiated the download, and whether the user has explicitly
   // marked the file type as "auto open". Protected virtual for testing.
   bool IsDangerousFile(PriorVisitsToReferrer visits);
 
   // content::DownloadItem::Observer
   virtual void OnDownloadDestroyed(content::DownloadItem* download) OVERRIDE;
 
   // state
   State next_state_;
   bool should_prompt_;
-  bool create_directory_;
+  bool should_notify_extensions_;
+  bool create_target_directory_;
   DownloadPathReservationTracker::FilenameConflictAction conflict_action_;
   content::DownloadDangerType danger_type_;
   base::FilePath virtual_path_;
   base::FilePath local_path_;
   base::FilePath intermediate_path_;
 
   content::DownloadItem* download_;
+  const bool is_resumption_;
   DownloadPrefs* download_prefs_;
   DownloadTargetDeterminerDelegate* delegate_;
   content::DownloadTargetCallback completion_callback_;
   CancelableRequestConsumer history_consumer_;
 
   base::WeakPtrFactory<DownloadTargetDeterminer> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadTargetDeterminer);
 };
 
 #endif  // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_TARGET_DETERMINER_H_