Download filename determination refactor (3/3)

chrome/browser/download/download_test_observer.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.
 
 #ifndef CHROME_BROWSER_DOWNLOAD_DOWNLOAD_TEST_OBSERVER_H_
 #define CHROME_BROWSER_DOWNLOAD_DOWNLOAD_TEST_OBSERVER_H_
 
 #include <set>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
 #include "content/public/browser/download_item.h"
 #include "content/public/browser/download_manager.h"
 #include "content/public/browser/download_url_parameters.h"
 #include "net/base/net_errors.h"
 
+namespace internal {

[Randy Smith (Not in Mondays), 2012/07/19 18:14:57]

Where does the "namespace internal" pattern come from?  Did you invent it, or is
this used elsewhere in chrome?

[asanka, 2012/07/23 19:47:10]

I thought it was a farly common C++ idiom that's used in Chrome:

$ git grep '^namespace internal' | wc -l
469

I changed the name of the delegate class to be less generic.

[Randy Smith (Not in Mondays), 2012/07/24 15:32:27]

Sounds good; just wasn't aware of that.  

+class TestDownloadManagerDelegate;
+}
+
+class Profile;
+
 // Detects changes to the downloads after construction.
 // Finishes when one of the following happens:
 //   - A specified number of downloads change to a terminal state (defined
 //     in derived classes).
 //   - Specific events, such as a select file dialog.
 // Callers may either probe for the finished state, or wait on it.
 //
 // TODO(rdsmith): Detect manager going down, remove pointer to
 // DownloadManager, transition to finished.  (For right now we
 // just use a scoped_refptr<> to keep it around, but that may cause
 // timeouts on waiting if a DownloadManager::Shutdown() occurs which
 // cancels our in-progress downloads.)
 class DownloadTestObserver : public content::DownloadManager::Observer,
                              public content::DownloadItem::Observer {
  public:
   // Action an observer should take if a dangerous download is encountered.
   enum DangerousDownloadAction {
     ON_DANGEROUS_DOWNLOAD_ACCEPT,  // Accept the download
     ON_DANGEROUS_DOWNLOAD_DENY,  // Deny the download
     ON_DANGEROUS_DOWNLOAD_FAIL  // Fail if a dangerous download is seen
   };
 
   // Create an object that will be considered finished when |wait_count|
   // download items have entered a terminal state.
-  // If |finish_on_select_file| is true, the object will also be
-  // considered finished if the DownloadManager raises a
-  // SelectFileDialogDisplayed() notification.
   DownloadTestObserver(
       content::DownloadManager* download_manager,
       size_t wait_count,
-      bool finish_on_select_file,
       DangerousDownloadAction dangerous_download_action);
 
   virtual ~DownloadTestObserver();
 
-  // State accessors.
-  bool select_file_dialog_seen() const { return select_file_dialog_seen_; }
-
   // Wait for the requested number of downloads to enter a terminal state.
   void WaitForFinished();
 
   // Return true if everything's happened that we're configured for.
   bool IsFinished() const;
 
   // content::DownloadItem::Observer
   virtual void OnDownloadUpdated(content::DownloadItem* download) OVERRIDE;
   virtual void OnDownloadOpened(content::DownloadItem* download) OVERRIDE {}
 
   // content::DownloadManager::Observer
   virtual void ModelChanged(content::DownloadManager* manager) OVERRIDE;
 
-  virtual void SelectFileDialogDisplayed(
-      content::DownloadManager* manager, int32 id) OVERRIDE;
-
   size_t NumDangerousDownloadsSeen() const;
 
   size_t NumDownloadsSeenInState(
       content::DownloadItem::DownloadState state) const;
 
  protected:
   // Only to be called by derived classes' constructors.
   virtual void Init();
 
   // Called to see if a download item is in a final state.
@@ skipping 42 matching lines @@
   // construction and return from wait.  But some downloads may be in our
   // final state (and thus be entered into |finished_downloads_|) when we
   // construct this class.  We don't want to count those in our transition
   // to finished.
   int finished_downloads_at_construction_;
 
   // Whether an internal message loop has been started and must be quit upon
   // all downloads completing.
   bool waiting_;
 
-  // True if we should transition the DownloadTestObserver to finished if
-  // the select file dialog comes up.
-  bool finish_on_select_file_;
-
-  // True if we've seen the select file dialog.
-  bool select_file_dialog_seen_;
-
   // Action to take if a dangerous download is encountered.
   DangerousDownloadAction dangerous_download_action_;
 
   // Holds the download ids which were dangerous.
   std::set<int32> dangerous_downloads_seen_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadTestObserver);
 };
 
 class DownloadTestObserverTerminal : public DownloadTestObserver {
  public:
   // Create an object that will be considered finished when |wait_count|
   // download items have entered a terminal state (any but IN_PROGRESS).
   // If |finish_on_select_file| is true, the object will also be
   // considered finished if the DownloadManager raises a
   // SelectFileDialogDisplayed() notification.
   DownloadTestObserverTerminal(
       content::DownloadManager* download_manager,
       size_t wait_count,
-      bool finish_on_select_file,
       DangerousDownloadAction dangerous_download_action);
 
   virtual ~DownloadTestObserverTerminal();
 
  private:
   virtual bool IsDownloadInFinalState(content::DownloadItem* download) OVERRIDE;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadTestObserverTerminal);
 };
 
 // Detects changes to the downloads after construction.
 // Finishes when a specified number of downloads change to the
 // IN_PROGRESS state, or a Select File Dialog has appeared.
 // Dangerous downloads are accepted.
 // Callers may either probe for the finished state, or wait on it.
 class DownloadTestObserverInProgress : public DownloadTestObserver {
  public:
   // Create an object that will be considered finished when |wait_count|
   // download items have entered state |IN_PROGRESS|.
   // If |finish_on_select_file| is true, the object will also be
   // considered finished if the DownloadManager raises a
   // SelectFileDialogDisplayed() notification.
   DownloadTestObserverInProgress(
       content::DownloadManager* download_manager,
-      size_t wait_count,
-      bool finish_on_select_file);
+      size_t wait_count);
 
   virtual ~DownloadTestObserverInProgress();
 
  private:
   virtual bool IsDownloadInFinalState(content::DownloadItem* download) OVERRIDE;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadTestObserverInProgress);
 };
 
 // The WaitForFlush() method on this class returns after:
@@ skipping 75 matching lines @@
 
   // Count of callbacks.
   size_t called_back_count_;
 
   // We are in the message loop.
   bool waiting_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadTestItemCreationObserver);
 };
 
+// Observes and overrides file chooser activity for a profile. By default, once
+// attached to a profile, this class overrides the default file chooser by
+// replacing the ChromeDownloadManagerDelegate associated with |profile|.
+// NOTE: Again, this overrides the ChromeDownloadManagerDelegate for |profile|.
+class DownloadTestFileChooserObserver {
+ public:
+  // Attaches to |profile|. By default file chooser dialogs will be disabled
+  // once attached. Call EnableFileChooser() to re-enable.
+  explicit DownloadTestFileChooserObserver(Profile* profile);
+  ~DownloadTestFileChooserObserver();
+
+  // Sets whether the file chooser dialog is enabled. If |enable| is false, any
+  // attempt to display a file chooser dialog will cause the download to be
+  // canceled. Otherwise, attempting to display a file chooser dialog will
+  // result in the download continuing with the suggested path.
+  void EnableFileChooser(bool enable);
+
+  // Returns true if a file chooser dialog was displayed since the last time
+  // this method was called.
+  bool TestAndResetDidShowFileChooser();
+
+ private:
+  scoped_refptr<internal::TestDownloadManagerDelegate> test_delegate_;
+};
+
 #endif  // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_TEST_OBSERVER_H_