Created uber tray UI for monitoring ongoing WebDrive sync operations

chrome/browser/chromeos/system/ash_system_tray_delegate.cc

 // 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.
 
 #include "chrome/browser/chromeos/system/ash_system_tray_delegate.h"
 
 #include "ash/shell.h"
 #include "ash/shell_window_ids.h"
 #include "ash/system/audio/audio_observer.h"
 #include "ash/system/bluetooth/bluetooth_observer.h"
 #include "ash/system/brightness/brightness_observer.h"
 #include "ash/system/date/clock_observer.h"
+#include "ash/system/drive/drive_observer.h"
 #include "ash/system/ime/ime_observer.h"
 #include "ash/system/network/network_observer.h"
 #include "ash/system/power/power_status_observer.h"
 #include "ash/system/tray/system_tray.h"
 #include "ash/system/tray/system_tray_delegate.h"
 #include "ash/system/tray_accessibility.h"
 #include "ash/system/tray_caps_lock.h"
 #include "ash/system/user/update_observer.h"
 #include "ash/system/user/user_observer.h"
 #include "base/chromeos/chromeos_version.h"
 #include "base/logging.h"
+#include "base/memory/weak_ptr.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/chromeos/audio/audio_handler.h"
 #include "chrome/browser/chromeos/bluetooth/bluetooth_adapter.h"
 #include "chrome/browser/chromeos/bluetooth/bluetooth_device.h"
 #include "chrome/browser/chromeos/cros/cros_library.h"
 #include "chrome/browser/chromeos/cros/network_library.h"
+#include "chrome/browser/chromeos/gdata/gdata_system_service.h"
+#include "chrome/browser/chromeos/gdata/gdata_util.h"
 #include "chrome/browser/chromeos/input_method/input_method_manager.h"
 #include "chrome/browser/chromeos/input_method/input_method_util.h"
 #include "chrome/browser/chromeos/input_method/input_method_whitelist.h"
 #include "chrome/browser/chromeos/input_method/xkeyboard.h"
 #include "chrome/browser/chromeos/kiosk_mode/kiosk_mode_settings.h"
 #include "chrome/browser/chromeos/login/base_login_display_host.h"
 #include "chrome/browser/chromeos/login/login_display_host.h"
 #include "chrome/browser/chromeos/login/message_bubble.h"
 #include "chrome/browser/chromeos/login/user.h"
 #include "chrome/browser/chromeos/login/user_manager.h"
 #include "chrome/browser/chromeos/mobile_config.h"
 #include "chrome/browser/chromeos/status/data_promo_notification.h"
 #include "chrome/browser/chromeos/status/network_menu.h"
 #include "chrome/browser/chromeos/status/network_menu_icon.h"
 #include "chrome/browser/chromeos/system/timezone_settings.h"
 #include "chrome/browser/chromeos/system_key_event_listener.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_list.h"
 #include "chrome/browser/upgrade_detector.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/pref_names.h"
 #include "chrome/common/url_constants.h"
 #include "chromeos/dbus/dbus_thread_manager.h"
 #include "chromeos/dbus/power_manager_client.h"
+#include "content/public/browser/browser_thread.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/user_metrics.h"
 #include "grit/generated_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 
+using gdata::GDataFileSystem;
+using gdata::GDataOperationRegistry;
+using gdata::GDataSystemService;
+using gdata::GDataSystemServiceFactory;
+
 namespace chromeos {
 
 namespace {
 
+// Time delay for rechecking gdata operation when we suspect that there will
+// be no upcoming activity notifications that need to be pushed to UI.
+const int kGDataOperationRecheckDelayMs = 5000;
+
 bool ShouldShowNetworkIconInTray(const Network* network) {
   if (!network)
     return true;
   return !network->connected() || network->type() != TYPE_ETHERNET;
 }
 
 ash::NetworkIconInfo CreateNetworkIconInfo(const Network* network,
                                            NetworkMenuIcon* network_icon,
                                            NetworkMenu* network_menu) {
   ash::NetworkIconInfo info;
   info.name = UTF8ToUTF16(network->name());
   info.image = network_icon->GetBitmap(network, NetworkMenuIcon::COLOR_DARK);
   info.service_path = network->service_path();
   info.highlight = network_menu->ShouldHighlightNetwork(network);
   info.tray_icon_visible = ShouldShowNetworkIconInTray(network);
   return info;
 }
 
 void ExtractIMEInfo(const input_method::InputMethodDescriptor& ime,
                     const input_method::InputMethodUtil& util,
                     ash::IMEInfo* info) {
   info->id = ime.id();
   info->name = util.GetInputMethodLongName(ime);
   info->short_name = util.GetInputMethodShortName(ime);
 }
 
+ash::DriveOperationStatusList GetDriveStatusList(
+    const std::vector<GDataOperationRegistry::ProgressStatus>& list) {
+  ash::DriveOperationStatusList results;
+  for (GDataOperationRegistry::ProgressStatusList::const_iterator it =
+          list.begin();
+       it != list.end(); ++it) {
+    ash::DriveOperationStatus status;
+    status.file_path = it->file_path;
+    status.progress = it->progress_total == 0 ? 0.0 :
+        static_cast<double>(it->progress_current) /
+            static_cast<double>(it->progress_total);
+    status.type = static_cast<ash::DriveOperationStatus::OperationType>(
+        it->operation_type);
+    status.state = static_cast<ash::DriveOperationStatus::OperationState>(
+        it->transfer_state);
+    results.push_back(status);
+  }
+  return results;
+}
 
 void BluetoothPowerFailure() {
   // TODO(sad): Show an error bubble?
 }
 
 void BluetoothDiscoveryFailure() {
   // TODO(sad): Show an error bubble?
 }
 
 void BluetoothDeviceDisconnectError() {
   // TODO(sad): Do something?
 }
 
 void BluetoothDeviceConnectError() {
   // TODO(sad): Do something?
 }
 
 class SystemTrayDelegate : public ash::SystemTrayDelegate,
                            public AudioHandler::VolumeObserver,
                            public PowerManagerClient::Observer,
                            public NetworkMenuIcon::Delegate,
                            public NetworkMenu::Delegate,
                            public NetworkLibrary::NetworkManagerObserver,
                            public NetworkLibrary::NetworkObserver,
                            public NetworkLibrary::CellularDataPlanObserver,
+                           public gdata::GDataOperationRegistry::Observer,
                            public content::NotificationObserver,
                            public input_method::InputMethodManager::Observer,
                            public system::TimezoneSettings::Observer,
                            public BluetoothAdapter::Observer,
                            public SystemKeyEventListener::CapsLockObserver,
                            public MessageBubbleLinkListener {
  public:
   explicit SystemTrayDelegate(ash::SystemTray* tray)
       : tray_(tray),
+        ui_weak_ptr_factory_(ALLOW_THIS_IN_INITIALIZER_LIST(
+            new base::WeakPtrFactory<SystemTrayDelegate>(this))),
         network_icon_(ALLOW_THIS_IN_INITIALIZER_LIST(
                       new NetworkMenuIcon(this, NetworkMenuIcon::MENU_MODE))),
         network_icon_dark_(ALLOW_THIS_IN_INITIALIZER_LIST(
                       new NetworkMenuIcon(this, NetworkMenuIcon::MENU_MODE))),
         network_menu_(ALLOW_THIS_IN_INITIALIZER_LIST(new NetworkMenu(this))),
         clock_type_(base::k24HourClock),
         search_key_mapped_to_(input_method::kSearchKey),
         screen_locked_(false),
         data_promo_notification_(new DataPromoNotification()) {
     AudioHandler::GetInstance()->AddVolumeObserver(this);
@@ skipping 126 matching lines @@
   virtual void ShowNetworkSettings() OVERRIDE {
     content::RecordAction(
         content::UserMetricsAction("OpenInternetOptionsDialog"));
     GetAppropriateBrowser()->ShowOptionsTab(chrome::kInternetOptionsSubPage);
   }
 
   virtual void ShowBluetoothSettings() OVERRIDE {
     // TODO(sad): Make this work.
   }
 
+  virtual void ShowDriveSettings() OVERRIDE {
+    // TODO(zelidrag): Show settings once we put them in.
+  }
+
   virtual void ShowIMESettings() OVERRIDE {
     content::RecordAction(
         content::UserMetricsAction("OpenLanguageOptionsDialog"));
     GetAppropriateBrowser()->ShowOptionsTab(chrome::kLanguageOptionsSubPage);
   }
 
   virtual void ShowHelp() OVERRIDE {
     GetAppropriateBrowser()->ShowHelpTab();
   }
 
@@ skipping 114 matching lines @@
 
   virtual void SwitchIME(const std::string& ime_id) OVERRIDE {
     input_method::InputMethodManager::GetInstance()->ChangeInputMethod(ime_id);
   }
 
   virtual void ActivateIMEProperty(const std::string& key) OVERRIDE {
     input_method::InputMethodManager::GetInstance()->
         ActivateInputMethodProperty(key);
   }
 
+  virtual void CancelDriveOperation(const FilePath& file_path) OVERRIDE {
+    Profile* profile = ProfileManager::GetDefaultProfile();
+    if (!gdata::util::IsGDataAvailable(profile))
+      return;
+
+    GDataSystemService* system_service =
+          GDataSystemServiceFactory::FindForProfile(profile);
+    if (!system_service)
+      return;
+
+    system_service->file_system()->GetOperationRegistry()->CancelForFilePath(
+        file_path);
+  }
+
+  virtual void GetDriveOperationStatusList(
+      ash::DriveOperationStatusList* list) OVERRIDE {
+    Profile* profile = ProfileManager::GetDefaultProfile();
+    if (!gdata::util::IsGDataAvailable(profile))
+      return;
+
+    GDataSystemService* system_service =
+          GDataSystemServiceFactory::FindForProfile(profile);
+    if (!system_service)
+      return;
+
+    *list = GetDriveStatusList(
+        system_service->file_system()->GetOperationRegistry()->
+            GetProgressStatusList());
+  }
+
+
   virtual void GetMostRelevantNetworkIcon(ash::NetworkIconInfo* info,
                                           bool dark) OVERRIDE {
     NetworkLibrary* crosnet = CrosLibrary::Get()->GetNetworkLibrary();
     info->image = !dark ? network_icon_->GetIconAndText(&info->description) :
         network_icon_dark_->GetIconAndText(&info->description);
     info->tray_icon_visible =
         ShouldShowNetworkIconInTray(crosnet->connected_network());
   }
 
   virtual void GetAvailableNetworks(
@@ skipping 231 matching lines @@
   }
 
   void SetProfile(Profile* profile) {
     pref_registrar_.reset(new PrefChangeRegistrar);
     pref_registrar_->Init(profile->GetPrefs());
     pref_registrar_->Add(prefs::kUse24HourClock, this);
     pref_registrar_->Add(prefs::kLanguageXkbRemapSearchKeyTo, this);
     UpdateClockType(profile->GetPrefs());
     search_key_mapped_to_ =
         profile->GetPrefs()->GetInteger(prefs::kLanguageXkbRemapSearchKeyTo);
+
+    if (gdata::util::IsGDataAvailable(profile)) {
+      GDataSystemService* system_service =
+          GDataSystemServiceFactory::FindForProfile(profile);
+      system_service->file_system()->GetOperationRegistry()->
+          AddObserver(this);
+    }
   }
 
   void UpdateClockType(PrefService* service) {
     clock_type_ = service->GetBoolean(prefs::kUse24HourClock) ?
         base::k24HourClock : base::k12HourClock;
     ash::ClockObserver* observer = tray_->clock_observer();
     if (observer)
       observer->OnDateFormatChanged();
   }
 
@@ skipping 20 matching lines @@
     if (observer)
       observer->OnBluetoothRefresh();
   }
 
   void NotifyRefreshIME() {
     ash::IMEObserver* observer = tray_->ime_observer();
     if (observer)
       observer->OnIMERefresh();
   }
 
+  void NotifyRefreshDrive(ash::DriveOperationStatusList& list) {
+    ash::DriveObserver* observer = tray_->drive_observer();
+    if (observer)
+      observer->OnDriveRefresh(list);
+  }
+
   void RefreshNetworkObserver(NetworkLibrary* crosnet) {
     const Network* network = crosnet->active_network();
     std::string new_path = network ? network->service_path() : std::string();
     if (active_network_path_ != new_path) {
       if (!active_network_path_.empty())
         crosnet->RemoveNetworkObserver(active_network_path_, this);
       if (!new_path.empty())
         crosnet->AddNetworkObserver(new_path, this);
       active_network_path_ = new_path;
     }
@@ skipping 157 matching lines @@
   virtual void InputMethodChanged(
       input_method::InputMethodManager* manager) OVERRIDE {
     NotifyRefreshIME();
   }
 
   virtual void InputMethodPropertyChanged(
       input_method::InputMethodManager* manager) OVERRIDE {
     NotifyRefreshIME();
   }
 
+  // gdata::GDataOperationRegistry::Observer overrides.
+  virtual void OnProgressUpdate(
+      const GDataOperationRegistry::ProgressStatusList& list) {
+    std::vector<ash::DriveOperationStatus> ui_list = GetDriveStatusList(list);
+    NotifyRefreshDrive(ui_list);
+
+    // If we have something to report right now (i.e. completion status only),
+    // we need to delayed re-check the status in few seconds to ensure we
+    // raise events that will let us properly clear the uber tray state.
+    if (list.size() > 0) {
+      bool has_in_progress_items = false;
+      for (GDataOperationRegistry::ProgressStatusList::const_iterator it =
+               list.begin();
+          it != list.end(); ++it) {
+        if (it->transfer_state ==
+                GDataOperationRegistry::OPERATION_IN_PROGRESS) {
+          has_in_progress_items = true;
+          break;
+        }
+      }
+      if (!has_in_progress_items) {
+        content::BrowserThread::PostDelayedTask(
+            content::BrowserThread::UI,
+            FROM_HERE,
+            base::Bind(&SystemTrayDelegate::RecheckGDataOperations,
+                       ui_weak_ptr_factory_->GetWeakPtr()),
+            base::TimeDelta::FromMilliseconds(kGDataOperationRecheckDelayMs));
+      }
+    }
+

[xiyuan, 2012/05/01 16:47:53]

nit: nuke empty line.

+  }
+
+  // Pulls the list of ongoing drive operations and initiates status update.
+  // This method is needed to ensure delayed cleanup of the latest reported
+  // status in UI in cases when there are no new changes coming (i.e. when the
+  // last set of transfer operations completed).
+  void RecheckGDataOperations() {
+    Profile* profile = ProfileManager::GetDefaultProfile();
+    if (!gdata::util::IsGDataAvailable(profile))
+      return;
+
+    GDataSystemService* system_service =
+          GDataSystemServiceFactory::FindForProfile(profile);
+    if (!system_service)
+      return;
+
+    OnProgressUpdate(system_service->file_system()->GetOperationRegistry()->
+            GetProgressStatusList());

[sadrul, 2012/05/01 14:28:58]

4-space indent

[zel, 2012/05/01 16:56:52]

Done.

+  }
+
   // Overridden from system::TimezoneSettings::Observer.
   virtual void TimezoneChanged(const icu::TimeZone& timezone) OVERRIDE {
     NotifyRefreshClock();
   }
 
   // Overridden from BluetoothAdapter::Observer.
   virtual void AdapterPresentChanged(BluetoothAdapter* adapter,
                                      bool present) OVERRIDE {
     NotifyRefreshBluetooth();
   }
@@ skipping 65 matching lines @@
 
     if (!deal_url_to_open.empty()) {
       Browser* browser = GetAppropriateBrowser();
       if (!browser)
         return;
       browser->ShowSingletonTab(GURL(deal_url_to_open));
     }
   }
 
   ash::SystemTray* tray_;
+  scoped_ptr<base::WeakPtrFactory<SystemTrayDelegate> > ui_weak_ptr_factory_;

[xiyuan, 2012/05/01 16:47:53]

nit: Any reason to put base::WeakPtrFactory in a scoped_ptr?
"base::WeakPtrFactory<SystemTrayDelegate> ui_weak_ptr_factory_" should work.

   scoped_ptr<NetworkMenuIcon> network_icon_;
   scoped_ptr<NetworkMenuIcon> network_icon_dark_;
   scoped_ptr<NetworkMenu> network_menu_;
   content::NotificationRegistrar registrar_;
   scoped_ptr<PrefChangeRegistrar> pref_registrar_;
   std::string cellular_device_path_;
   std::string active_network_path_;
   PowerSupplyStatus power_supply_status_;
   base::HourClockType clock_type_;
   int search_key_mapped_to_;
   bool screen_locked_;
 
   scoped_ptr<BluetoothAdapter> bluetooth_adapter_;
 
   BooleanPrefMember accessibility_enabled_;
 
   scoped_ptr<DataPromoNotification> data_promo_notification_;
 
   DISALLOW_COPY_AND_ASSIGN(SystemTrayDelegate);
 };
 
 }  // namespace
 
 ash::SystemTrayDelegate* CreateSystemTrayDelegate(ash::SystemTray* tray) {
   return new chromeos::SystemTrayDelegate(tray);
 }
 
 }  // namespace chromeos