Clean up error handling logic for extension tab muting

chrome/browser/ui/tabs/tab_utils.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/ui/tabs/tab_utils.h"
 
 #include "base/command_line.h"
 #include "base/strings/string16.h"
 #include "chrome/browser/media/media_capture_devices_dispatcher.h"
 #include "chrome/browser/media/media_stream_capture_indicator.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/grit/generated_resources.h"
 #include "content/public/browser/web_contents.h"
 #include "grit/theme_resources.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/gfx/animation/multi_animation.h"
 
 struct LastMuteMetadata
     : public content::WebContentsUserData<LastMuteMetadata> {
   std::string cause;  // Extension ID or constant from header file
                       // or empty string
+  base::TimeDelta token_bucket;
+  base::TimeTicks last_attempt;
+
  private:
-  explicit LastMuteMetadata(content::WebContents* contents) {}
+  explicit LastMuteMetadata(content::WebContents* contents) {
+    token_bucket =
+        base::TimeDelta::FromSeconds(chrome::kMuteTokenBucketCapacitySeconds);
+    last_attempt = base::TimeTicks::Now();
+  }
   friend class content::WebContentsUserData<LastMuteMetadata>;
 };
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(LastMuteMetadata);
 
 namespace chrome {
 
 const char kMutedToggleCauseUser[] = "user";
 const char kMutedToggleCauseCapture[] = "capture";
 
@@ skipping 223 matching lines @@
     case TAB_MEDIA_STATE_AUDIO_MUTING:
       return IsTabAudioMutingFeatureEnabled();
     case TAB_MEDIA_STATE_RECORDING:
     case TAB_MEDIA_STATE_CAPTURING:
       return false;
   }
   NOTREACHED();
   return false;
 }
 
+// Only run when cause should be rate limited (i.e. extensions)
+void updateTokenBuckets(content::WebContents* contents) {

[miu, 2015/07/16 00:28:26]

This function should be private, so please move it to inside the anonymous
namespace (above, before line 101).

+  DCHECK(contents);
+
+  LastMuteMetadata::CreateForWebContents(contents);  // Create if not exists.

[miu, 2015/07/16 00:28:26]

If this function is private, you could omit this call to CreateForWebContents(),
and just make sure to do it in SetTabAudioMuted() beforehand.

+
+  base::TimeTicks now = base::TimeTicks::Now();
+  base::TimeDelta elapsed_since_last_attempt =
+      now - LastMuteMetadata::FromWebContents(contents)->last_attempt;
+  LastMuteMetadata::FromWebContents(contents)->last_attempt = now;
+
+  // Add tokens to the bucket, proportional to how much time has elapsed, capped
+  // at the maximum capacity.
+  LastMuteMetadata::FromWebContents(contents)->token_bucket = std::min(
+      base::TimeDelta::FromSeconds(chrome::kMuteTokenBucketCapacitySeconds),
+      LastMuteMetadata::FromWebContents(contents)->token_bucket +
+          elapsed_since_last_attempt);
+}
+
+// Only run when cause should be rate limited (i.e. extensions)
+bool IsTabAudioMutedRateLimited(content::WebContents* contents) {

[miu, 2015/07/16 00:28:25]

This function should probably be private as well.  Your call.

+  DCHECK(contents);
+
+  LastMuteMetadata::CreateForWebContents(contents);  // Create if not exists.

[miu, 2015/07/16 00:28:26]

ditto: Also not needed if this function is private (see comment above).

+
+  return (LastMuteMetadata::FromWebContents(contents)->token_bucket <
+          base::TimeDelta::FromSeconds(kMuteTokenBucketCostSeconds));
+}
+
 const std::string& GetTabAudioMutedCause(content::WebContents* contents) {
   LastMuteMetadata::CreateForWebContents(contents);  // Create if not exists.
   if (GetTabMediaStateForContents(contents) == TAB_MEDIA_STATE_CAPTURING) {
     // For tab capture, libcontent forces muting off.
     LastMuteMetadata::FromWebContents(contents)->cause =
         kMutedToggleCauseCapture;
   }
   return LastMuteMetadata::FromWebContents(contents)->cause;
 }
 
-void SetTabAudioMuted(content::WebContents* contents,
-                      bool mute,
-                      const std::string& cause) {
-  if (!contents || !chrome::CanToggleAudioMute(contents))
-    return;
+TabMutedResult SetTabAudioMuted(content::WebContents* contents,
+                                bool mute,
+                                const std::string& cause) {
+  DCHECK(contents);
+
+  if (!IsTabAudioMutingFeatureEnabled())
+    return TAB_MUTED_RESULT_FAIL_NOT_ENABLED;
+
+  if (!chrome::CanToggleAudioMute(contents))
+    return TAB_MUTED_RESULT_FAIL_TABCAPTURE;
+
+  if ((cause != kMutedToggleCauseUser) && (cause != kMutedToggleCauseCapture)) {
+    updateTokenBuckets(contents);
+
+    if (IsTabAudioMutedRateLimited(contents))
+      return TAB_MUTED_RESULT_FAIL_RATE_LIMITED;
+
+    LastMuteMetadata::FromWebContents(contents)->token_bucket -=
+        base::TimeDelta::FromSeconds(kMuteTokenBucketCostSeconds);
+  }
 
   LastMuteMetadata::CreateForWebContents(contents);  // Create if not exists.
   LastMuteMetadata::FromWebContents(contents)->cause = cause;
 
   contents->SetAudioMuted(mute);
+
+  return TAB_MUTED_RESULT_SUCCESS;
 }
 
 bool IsTabAudioMuted(content::WebContents* contents) {
   return contents && contents->IsAudioMuted();
 }
 
 bool AreAllTabsMuted(const TabStripModel& tab_strip,
                      const std::vector<int>& indices) {
   for (std::vector<int>::const_iterator i = indices.begin(); i != indices.end();
        ++i) {
     if (!IsTabAudioMuted(tab_strip.GetWebContentsAt(*i)))
       return false;
   }
   return true;
 }
 
 }  // namespace chrome