UMA for Windows 8 Secondary Tile pinning/unpinning user actions

win8/metro_driver/secondary_tile.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 "stdafx.h"
 #include "secondary_tile.h"
 
 #include <windows.ui.startscreen.h>
 
 #include "base/bind.h"
 #include "base/logging.h"
 #include "base/utf_string_conversions.h"
 #include "googleurl/src/gurl.h"
 #include "win8/metro_driver/chrome_app_view.h"
 #include "win8/metro_driver/winrt_utils.h"
 
 namespace {
 
-void DeleteTileFromStartScreen(const string16& tile_id) {
+// Callback for asynchronous pin requests.
+class TileRequestDone {
+ public:
+  enum PinType {
+    PIN,
+    UNPIN
+  };
+  TileRequestDone(PinType type, base::win::MetroPinResultCallback callback)
+      : type_(type), callback_(callback) {
+  }

[benwells, 2012/11/29 04:19:46]

Blank line after. Can have {} on one line.

[tapted, 2012/11/29 07:19:27]

Done.

+  void Complete(mswr::ComPtr<winfoundtn::IAsyncOperation<bool>>& completion);
+
+ private:
+  HRESULT Respond(winfoundtn::IAsyncOperation<bool>* async,
+                  AsyncStatus status);
+
+  PinType type_;
+  base::win::MetroPinResultCallback callback_;
+};
+
+void TileRequestDone::Complete(
+    mswr::ComPtr<winfoundtn::IAsyncOperation<bool>>& completion) {
+  typedef winfoundtn::IAsyncOperationCompletedHandler<bool> RequestDoneType;
+  mswr::ComPtr<RequestDoneType> handler(mswr::Callback<RequestDoneType>(
+      this, &TileRequestDone::Respond));
+  DCHECK(handler.Get() != NULL);
+  HRESULT hr = completion->put_Completed(handler.Get());
+  CheckHR(hr, "Failed to put_Completed");
+}
+
+HRESULT TileRequestDone::Respond(winfoundtn::IAsyncOperation<bool>* async,
+                                 AsyncStatus status) {
+  base::win::MetroSecondaryTilePinState pin_state =
+      base::win::METRO_PIN_STATE_NONE;
+
+  if (status == Completed) {
+    unsigned char result;
+    CheckHR(async->GetResults(&result));
+    LOG(INFO) << __FUNCTION__ << " result " << static_cast<int>(result);
+    switch (result) {
+      case 0:
+        pin_state = type_ == PIN ?
+            base::win::METRO_PIN_RESULT_CANCEL :
+            base::win::METRO_UNPIN_RESULT_CANCEL;
+        break;
+      case 1:
+        pin_state = type_ == PIN ?
+            base::win::METRO_PIN_RESULT_OK :
+            base::win::METRO_UNPIN_RESULT_OK;
+        break;
+      default:
+        pin_state = type_ == PIN ?
+            base::win::METRO_PIN_RESULT_OTHER :
+            base::win::METRO_UNPIN_RESULT_OTHER;
+        break;
+    }
+  } else {
+    LOG(ERROR) << __FUNCTION__ << " Unexpected async status " << status;
+    pin_state = type_ == PIN ?
+        base::win::METRO_PIN_RESULT_ERROR :
+        base::win::METRO_UNPIN_RESULT_ERROR;
+  }
+  if (callback_)
+    callback_(pin_state);
+
+  delete this;
+  return S_OK;
+}
+
+void DeleteTileFromStartScreen(const string16& tile_id,
+                               base::win::MetroPinResultCallback callback) {
   DVLOG(1) << __FUNCTION__;
   mswr::ComPtr<winui::StartScreen::ISecondaryTileFactory> tile_factory;
   HRESULT hr = winrt_utils::CreateActivationFactory(
       RuntimeClass_Windows_UI_StartScreen_SecondaryTile,
       tile_factory.GetAddressOf());
   CheckHR(hr, "Failed to create instance of ISecondaryTileFactory");
 
   mswrw::HString id;
   id.Attach(MakeHString(tile_id));
 
   mswr::ComPtr<winui::StartScreen::ISecondaryTile> tile;
   hr = tile_factory->CreateWithId(id.Get(), tile.GetAddressOf());
   CheckHR(hr, "Failed to create tile");
 
   mswr::ComPtr<winfoundtn::IAsyncOperation<bool>> completion;
   hr = tile->RequestDeleteAsync(completion.GetAddressOf());
   CheckHR(hr, "RequestDeleteAsync failed");
 
-  typedef winfoundtn::IAsyncOperationCompletedHandler<bool> RequestDoneType;
-  mswr::ComPtr<RequestDoneType> handler(mswr::Callback<RequestDoneType>(
-      globals.view, &ChromeAppView::TileRequestCreateDone));
-  DCHECK(handler.Get() != NULL);
-  hr = completion->put_Completed(handler.Get());
-  CheckHR(hr, "Failed to put_Completed");
+  if (FAILED(hr)) {
+    if (callback)
+      callback(base::win::METRO_UNPIN_REQUEST_SHOW_ERROR);
+    return;
+  }
+
+  (new TileRequestDone(TileRequestDone::UNPIN,
+                       callback))->Complete(completion);
 }
 
 void CreateTileOnStartScreen(const string16& tile_id,
                              const string16& title_str,
                              const string16& url_str,
-                             const FilePath& logo_path) {
+                             const FilePath& logo_path,
+                             base::win::MetroPinResultCallback callback) {
   VLOG(1) << __FUNCTION__;
 
   mswr::ComPtr<winui::StartScreen::ISecondaryTileFactory> tile_factory;
   HRESULT hr = winrt_utils::CreateActivationFactory(
       RuntimeClass_Windows_UI_StartScreen_SecondaryTile,
       tile_factory.GetAddressOf());
   CheckHR(hr, "Failed to create instance of ISecondaryTileFactory");
 
   winui::StartScreen::TileOptions options =
       winui::StartScreen::TileOptions_ShowNameOnLogo;
@@ skipping 32 matching lines @@
                                 tile.GetAddressOf());
   CheckHR(hr, "Failed to create tile");
 
   hr = tile->put_ForegroundText(winui::StartScreen::ForegroundText_Light);
   CheckHR(hr, "Failed to change foreground text color");
 
   mswr::ComPtr<winfoundtn::IAsyncOperation<bool>> completion;
   hr = tile->RequestCreateAsync(completion.GetAddressOf());
   CheckHR(hr, "RequestCreateAsync failed");
 
-  typedef winfoundtn::IAsyncOperationCompletedHandler<bool> RequestDoneType;
-  mswr::ComPtr<RequestDoneType> handler(mswr::Callback<RequestDoneType>(
-      globals.view, &ChromeAppView::TileRequestCreateDone));
-  DCHECK(handler.Get() != NULL);
-  hr = completion->put_Completed(handler.Get());
-  CheckHR(hr, "Failed to put_Completed");
+  if (FAILED(hr)) {
+    if (callback)
+      callback(base::win::METRO_PIN_REQUEST_SHOW_ERROR);
+    return;
+  }
+
+  (new TileRequestDone(TileRequestDone::PIN,

[benwells, 2012/11/29 04:19:46]

Please add a comment here about this object's lifetime.

[tapted, 2012/11/29 07:19:27]

Done.

+                       callback))->Complete(completion);
 }
 
 }  // namespace
 
 BOOL MetroIsPinnedToStartScreen(const string16& tile_id) {
   mswr::ComPtr<winui::StartScreen::ISecondaryTileStatics> tile_statics;
   HRESULT hr = winrt_utils::CreateActivationFactory(
       RuntimeClass_Windows_UI_StartScreen_SecondaryTile,
       tile_statics.GetAddressOf());
   CheckHR(hr, "Failed to create instance of ISecondaryTileStatics");
 
   boolean exists;
   hr = tile_statics->Exists(MakeHString(tile_id), &exists);
   CheckHR(hr, "ISecondaryTileStatics.Exists failed");
   return exists;
 }
 
-void MetroUnPinFromStartScreen(const string16& tile_id) {
+void MetroUnPinFromStartScreen(const string16& tile_id,
+                               base::win::MetroPinResultCallback callback) {
+  // Ensure function signature is correct.
   globals.appview_msg_loop->PostTask(
-      FROM_HERE, base::Bind(&DeleteTileFromStartScreen, tile_id));
+      FROM_HERE, base::Bind(&DeleteTileFromStartScreen,
+                            tile_id,
+                            callback));
 }
 
 void MetroPinToStartScreen(const string16& tile_id,
                            const string16& title,
                            const string16& url,
-                           const FilePath& logo_path) {
+                           const FilePath& logo_path,
+                           base::win::MetroPinResultCallback callback) {
   globals.appview_msg_loop->PostTask(
     FROM_HERE, base::Bind(&CreateTileOnStartScreen,
                           tile_id,
                           title,
                           url,
-                          logo_path));
+                          logo_path,
+                          callback));
 }