Media Galleries: Prune uninteresting folders when scanning.

chrome/browser/media_galleries/media_folder_finder.h

 // Copyright 2014 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_MEDIA_GALLERIES_MEDIA_FOLDER_FINDER_H_
 #define CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_FOLDER_FINDER_H_
 
 #include <map>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "base/sequenced_task_runner.h"
 #include "chrome/browser/media_galleries/media_scan_types.h"
 
 // MediaFolderFinder scans local hard drives and look for folders that contain
 // media files.
 class MediaFolderFinder {
  public:
+  // Key: path to a folder
+  // Value: scan results for that folder, non-recursive.
   typedef std::map<base::FilePath, MediaGalleryScanResult>
       MediaFolderFinderResults;
+
+  // |results| never contains entries for |graylisted_folders_| or parent
+  // directories of |graylisted_folders_|.
   typedef base::Callback<void(bool /*success*/,
                               const MediaFolderFinderResults& /*results*/)>
       MediaFolderFinderResultsCallback;
 
   // |callback| will get called when the scan finishes. If the object is deleted
   // before it finishes, the scan will stop and |callback| will get called with
   // success = false.
   // MediaFolderFinder has a default set of per-platform paths to scan.
   // Override in tests with SetRootsForTesting().
   explicit MediaFolderFinder(const MediaFolderFinderResultsCallback& callback);
   virtual ~MediaFolderFinder();
 
   // Start the scan.
   virtual void StartScan();
 
+  const std::vector<base::FilePath>& graylisted_folders() const;
+
  private:
   friend class MediaFolderFinderTest;
 
   class Worker;
   struct WorkerReply {
     WorkerReply();
     ~WorkerReply();
 
     MediaGalleryScanResult scan_result;
     std::vector<base::FilePath> new_folders;
@@ skipping 11 matching lines @@
 
   // Scan a folder from |folders_to_scan_|.
   void ScanFolder();
 
   // Callback that handles the |reply| from |worker_| for a scanned |path|.
   void GotScanResults(const base::FilePath& path, const WorkerReply& reply);
 
   const MediaFolderFinderResultsCallback results_callback_;
   MediaFolderFinderResults results_;
 
+  std::vector<base::FilePath> graylisted_folders_;
   std::vector<base::FilePath> folders_to_scan_;
   ScanState scan_state_;
 
   scoped_refptr<base::SequencedTaskRunner> worker_task_runner_;
 
   // Owned by MediaFolderFinder, but lives on |worker_task_runner_|.
   Worker* worker_;
 
   // Set of roots to scan for testing.
   bool has_roots_for_testing_;
   std::vector<base::FilePath> roots_for_testing_;
 
   base::WeakPtrFactory<MediaFolderFinder> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaFolderFinder);
 };
 
 #endif  // CHROME_BROWSER_MEDIA_GALLERIES_MEDIA_FOLDER_FINDER_H_