Extend the capability of SystemMonitor to support watching storage free space change

base/system_monitor/system_monitor.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 BASE_SYSTEM_MONITOR_SYSTEM_MONITOR_H_
 #define BASE_SYSTEM_MONITOR_SYSTEM_MONITOR_H_
 
 #include <map>
+#include <set>
 #include <string>
 #include <vector>
 
 #include "base/base_export.h"
 #include "base/basictypes.h"
 #include "base/file_path.h"
 #include "base/string16.h"
 #include "base/synchronization/lock.h"
 #include "build/build_config.h"
 
@@ skipping 33 matching lines @@
     RESUME_EVENT        // The system is being resumed.
   };
 
   // Type of devices whose change need to be monitored, such as add/remove.
   enum DeviceType {
     DEVTYPE_AUDIO_CAPTURE,  // Audio capture device, e.g., microphone.
     DEVTYPE_VIDEO_CAPTURE,  // Video capture device, e.g., webcam.
     DEVTYPE_UNKNOWN,  // Other devices.
   };
 
+  // The delegate interfaces for storage free space change notification.
+  // Since the client code may call these interfaces from any thread, the
+  // implementation must take care to implement it, e.g. if it is not called
+  // from the thread on which the observation is working, you probably need
+  // to post a task to that thread for starting or stopping the watching
+  // operation.
+  class BASE_EXPORT StorageFreeSpaceDelegate {
+   public:
+    virtual ~StorageFreeSpaceDelegate() {}
+
+    // Start watching the storage device identified by the |path| parameter.
+    // The |path| can be a drive path on Windows, or the mount point on Posix.
+    // It can be called from any thread.
+    virtual void StartWatchingStorage(const FilePath& path) = 0;
+
+    // Stop watching the storage device identified by the |path| paramter. It
+    // can be called from any thread.
+    virtual void StopWatchingStorage(const FilePath& path) = 0;
+  };
+
   struct BASE_EXPORT RemovableStorageInfo {
     RemovableStorageInfo();
     RemovableStorageInfo(const std::string& id,
                          const string16& device_name,
                          const FilePath::StringType& device_location);
 
     // Unique device id - persists between device attachments.
     std::string device_id;
 
     // Human readable removable storage device name.
     string16 name;
 
     // Current attached removable storage device location.
     FilePath::StringType location;
   };
 
   // Create SystemMonitor. Only one SystemMonitor instance per application
   // is allowed.
-  SystemMonitor();
+  SystemMonitor(StorageFreeSpaceDelegate* delegate = NULL);
   ~SystemMonitor();
 
   // Get the application-wide SystemMonitor (if not present, returns NULL).
   static SystemMonitor* Get();
 
 #if defined(OS_MACOSX)
   // Allocate system resources needed by the SystemMonitor class.
   //
   // This function must be called before instantiating an instance of the class
   // and before the Sandbox is initialized.
@@ skipping 50 matching lines @@
     virtual void OnRemovableStorageAttached(
         const std::string& id,
         const string16& name,
         const FilePath::StringType& location) {}
     virtual void OnRemovableStorageDetached(const std::string& id) {}
 
    protected:
     virtual ~DevicesChangedObserver() {}
   };
 
+  class BASE_EXPORT StorageFreeSpaceObserver {
+   public:
+    // Triggered when the free space of the storage |path| is changed. The
+    // |available_capacity| indicates the available capacity in bytes.
+    virtual void OnFreeSpaceChanged(const FilePath& path,
+                                    int64 available_capacity) {}
+
+    // Triggered when the free space delegate failed to start watching
+    // the given storage |path|.
+    virtual void OnFreeSpaceChangeError(const FilePath& path) {}
+  };
+
   // Add a new observer.
   // Can be called from any thread.
   // Must not be called from within a notification callback.
   void AddPowerObserver(PowerObserver* obs);
   void AddDevicesChangedObserver(DevicesChangedObserver* obs);
+  void AddStorageFreeSpaceObserver(const FilePath& path,
+                                   StorageFreeSpaceObserver* obs);
 
   // Remove an existing observer.
   // Can be called from any thread.
   // Must not be called from within a notification callback.
   void RemovePowerObserver(PowerObserver* obs);
   void RemoveDevicesChangedObserver(DevicesChangedObserver* obs);
+  void RemoveStorageFreeSpaceObserver(const FilePath& path,
+                                      StorageFreeSpaceObserver* obs);
 
   // The ProcessFoo() style methods are a broken pattern and should not
   // be copied. Any significant addition to this class is blocked on
   // refactoring to improve the state of affairs. See http://crbug.com/149059
 
 #if defined(OS_WIN)
   // Windows-specific handling of a WM_POWERBROADCAST message.
   // Embedders of this API should hook their top-level window
   // message loop and forward WM_POWERBROADCAST through this call.
   void ProcessWmPowerBroadcastMessage(int event_id);
 #endif
 
   // Cross-platform handling of a power event.
   void ProcessPowerMessage(PowerEvent event_id);
 
   // Cross-platform handling of a device change event.
   void ProcessDevicesChanged(DeviceType device_type);
   void ProcessRemovableStorageAttached(const std::string& id,
                                        const string16& name,
                                        const FilePath::StringType& location);
   void ProcessRemovableStorageDetached(const std::string& id);
 
+  // Cross-platform handling of free space change event.
+  void ProcessStorageFreeSpaceChanged(const FilePath& path,
+                                      int64 available_capacity);
+  void ProcessStorageFreeSpaceChangeError(const FilePath& path);
+
  private:
   // Mapping of unique device id to device info tuple.
   typedef std::map<std::string, RemovableStorageInfo> RemovableStorageMap;
 
+  typedef ObserverListThreadSafe<StorageFreeSpaceObserver>
+      StorageFreeSpaceObserverList;
+  typedef std::set<StorageFreeSpaceObserver*> StorageFreeSpaceObserverSet;
+  struct PathObserverPair {
+    scoped_refptr<StorageFreeSpaceObserverList> observer_list;
+    // Used to help decide when to stop watching a storage path since we can't
+    // know when the thread safe observer list becomes empty.
+    StorageFreeSpaceObserverSet observer_set;
+  };
+  // Mapping of the storage device path to its observers.
+  typedef std::map<FilePath, PathObserverPair> StorageFreeSpaceObserverListMap;
+
 #if defined(OS_MACOSX)
   void PlatformInit();
   void PlatformDestroy();
 #endif
 
   // Platform-specific method to check whether the system is currently
   // running on battery power.  Returns true if running on batteries,
   // false otherwise.
   bool IsBatteryPower();
 
@@ skipping 24 matching lines @@
 #if defined(OS_IOS)
   // Holds pointers to system event notification observers.
   std::vector<id> notification_observers_;
 #endif
 
   // For manipulating removable_storage_map_ structure.
   mutable base::Lock removable_storage_lock_;
   // Map of all the attached removable storage devices.
   RemovableStorageMap removable_storage_map_;
 
+  // The delegate that implements free space change notification.
+  StorageFreeSpaceDelegate* free_space_delegate_;
+
+  // Used to map the storage path being watched to its observer list.
+  StorageFreeSpaceObserverListMap free_space_observer_list_map_;
+
+  // A lock used to synchronize access to |free_space_observer_list_map_|.
+  base::Lock free_space_observers_lock_;
+
   DISALLOW_COPY_AND_ASSIGN(SystemMonitor);
 };
 
 }  // namespace base
 
 #endif  // BASE_SYSTEM_MONITOR_SYSTEM_MONITOR_H_