Replace PermissionType in chrome/ with ContentSettingsType

chrome/browser/permissions/permission_manager.cc

 // Copyright 2015 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/permissions/permission_manager.h"
 
-#include <stddef.h>
-
 #include <memory>
 #include <utility>
 
 #include "base/callback.h"
 #include "base/memory/ptr_util.h"
 #include "build/build_config.h"
 #include "chrome/browser/background_sync/background_sync_permission_context.h"
 #include "chrome/browser/content_settings/host_content_settings_map_factory.h"
 #include "chrome/browser/media/midi_permission_context.h"
 #include "chrome/browser/media/webrtc/media_stream_device_permission_context.h"
@@ skipping 60 matching lines @@
     ContentSetting setting) {
   callback.Run(ContentSettingToPermissionStatus(setting));
 }
 
 // Helper method to convert PermissionType to ContentSettingType.
 ContentSettingsType PermissionTypeToContentSetting(PermissionType permission) {
   switch (permission) {
     case PermissionType::MIDI_SYSEX:
       return CONTENT_SETTINGS_TYPE_MIDI_SYSEX;
     case PermissionType::PUSH_MESSAGING:
+      return CONTENT_SETTINGS_TYPE_PUSH_MESSAGING;
     case PermissionType::NOTIFICATIONS:
       return CONTENT_SETTINGS_TYPE_NOTIFICATIONS;
     case PermissionType::GEOLOCATION:
       return CONTENT_SETTINGS_TYPE_GEOLOCATION;
     case PermissionType::PROTECTED_MEDIA_IDENTIFIER:
 #if defined(OS_ANDROID) || defined(OS_CHROMEOS)
       return CONTENT_SETTINGS_TYPE_PROTECTED_MEDIA_IDENTIFIER;
 #else
       NOTIMPLEMENTED();
       break;
@@ skipping 40 matching lines @@
     const std::vector<PermissionStatus>& vector) {
   DCHECK_EQ(vector.size(), 1ul);
   callback.Run(vector[0]);
 }
 
 // Function used for handling permission types which do not change their
 // value i.e. they are always approved or always denied etc.
 // CONTENT_SETTING_DEFAULT is returned if the permission needs further handling.
 // This function should only be called when IsConstantPermission has returned
 // true for the PermissionType.
-ContentSetting GetContentSettingForConstantPermission(PermissionType type) {
+blink::mojom::PermissionStatus GetPermissionStatusForConstantPermission(
+    PermissionType type) {
   DCHECK(IsConstantPermission(type));
   switch (type) {
     case PermissionType::MIDI:
-      return CONTENT_SETTING_ALLOW;
+      return PermissionStatus::GRANTED;
     default:
-      return CONTENT_SETTING_DEFAULT;
+      return PermissionStatus::DENIED;
   }
 }
 
 }  // anonymous namespace
 
 class PermissionManager::PendingRequest {
  public:
   PendingRequest(content::RenderFrameHost* render_frame_host,
                  const std::vector<PermissionType> permissions,
                  const base::Callback<
@@ skipping 39 matching lines @@
   std::vector<PermissionType> permissions_;
   std::vector<PermissionStatus> results_;
   size_t remaining_results_;
 };
 
 struct PermissionManager::Subscription {
   PermissionType permission;
   GURL requesting_origin;
   GURL embedding_origin;
   base::Callback<void(PermissionStatus)> callback;
-  ContentSetting current_value;
+  PermissionStatus current_value;
 };
 
 // static
 PermissionManager* PermissionManager::Get(Profile* profile) {
   return PermissionManagerFactory::GetForProfile(profile);
 }
 
 PermissionManager::PermissionManager(Profile* profile)
     : profile_(profile),
       weak_ptr_factory_(this) {
-  permission_contexts_[PermissionType::MIDI_SYSEX] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_MIDI_SYSEX] =
       base::MakeUnique<MidiPermissionContext>(profile);
-  permission_contexts_[PermissionType::PUSH_MESSAGING] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_PUSH_MESSAGING] =
       base::MakeUnique<NotificationPermissionContext>(
-          profile, PermissionType::PUSH_MESSAGING);
-  permission_contexts_[PermissionType::NOTIFICATIONS] =
+          profile, CONTENT_SETTINGS_TYPE_PUSH_MESSAGING);
+  permission_contexts_[CONTENT_SETTINGS_TYPE_NOTIFICATIONS] =
       base::MakeUnique<NotificationPermissionContext>(
-          profile, PermissionType::NOTIFICATIONS);
+          profile, CONTENT_SETTINGS_TYPE_NOTIFICATIONS);
 #if !defined(OS_ANDROID)
-  permission_contexts_[PermissionType::GEOLOCATION] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_GEOLOCATION] =
       base::MakeUnique<GeolocationPermissionContext>(profile);
 #else
-  permission_contexts_[PermissionType::GEOLOCATION] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_GEOLOCATION] =
       base::MakeUnique<GeolocationPermissionContextAndroid>(profile);
 #endif
 #if defined(OS_CHROMEOS) || defined(OS_ANDROID)
-  permission_contexts_[PermissionType::PROTECTED_MEDIA_IDENTIFIER] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_PROTECTED_MEDIA_IDENTIFIER] =
       base::MakeUnique<ProtectedMediaIdentifierPermissionContext>(profile);
 #endif
-  permission_contexts_[PermissionType::DURABLE_STORAGE] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_DURABLE_STORAGE] =
       base::MakeUnique<DurableStoragePermissionContext>(profile);
-  permission_contexts_[PermissionType::AUDIO_CAPTURE] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC] =
       base::MakeUnique<MediaStreamDevicePermissionContext>(
-          profile, content::PermissionType::AUDIO_CAPTURE,
-          CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC);
-  permission_contexts_[PermissionType::VIDEO_CAPTURE] =
+          profile, CONTENT_SETTINGS_TYPE_MEDIASTREAM_MIC);
+  permission_contexts_[CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA] =
       base::MakeUnique<MediaStreamDevicePermissionContext>(
-          profile, content::PermissionType::VIDEO_CAPTURE,
-          CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA);
-  permission_contexts_[PermissionType::BACKGROUND_SYNC] =
+          profile, CONTENT_SETTINGS_TYPE_MEDIASTREAM_CAMERA);
+  permission_contexts_[CONTENT_SETTINGS_TYPE_BACKGROUND_SYNC] =
       base::MakeUnique<BackgroundSyncPermissionContext>(profile);
 #if BUILDFLAG(ENABLE_PLUGINS)
-  permission_contexts_[PermissionType::FLASH] =
+  permission_contexts_[CONTENT_SETTINGS_TYPE_PLUGINS] =
       base::MakeUnique<FlashPermissionContext>(profile);
 #endif
 }
 
 PermissionManager::~PermissionManager() {
   if (!subscriptions_.IsEmpty())
     HostContentSettingsMapFactory::GetForProfile(profile_)
         ->RemoveObserver(this);
 }
 
 int PermissionManager::RequestPermission(
+    ContentSettingsType content_settings_type,
+    content::RenderFrameHost* render_frame_host,
+    const GURL& requesting_origin,
+    bool user_gesture,
+    const base::Callback<void(PermissionStatus)>& callback) {
+  PermissionType permission_type;
+  bool success = PermissionUtil::GetPermissionType(content_settings_type,
+                                                   &permission_type);
+  DCHECK(success);
+  return RequestPermissions(

[raymes, 2017/02/07 04:46:15]

I think it would be better to have functions that take PermissionType always
based on functions that take ContentSettingsType, to avoid the 2-way conversion.

Could we add a RequestPermissions that takes a ContentSettingsType and have
everything built on top of that? The idea would be that we could remove
PermissionUtil::GetPermissionType which is a bit of a rough edge (you'll see the
TODO on that function header).

[Timothy Loh, 2017/02/08 04:01:06]

I think we can't do this until we add MIDI as a ContentSettingsType. I added a
TODO.

+      std::vector<PermissionType>(1, permission_type), render_frame_host,
+      requesting_origin, user_gesture,
+      base::Bind(&PermissionRequestResponseCallbackWrapper, callback));
+}
+
+int PermissionManager::RequestPermission(
     PermissionType permission,
     content::RenderFrameHost* render_frame_host,
     const GURL& requesting_origin,
     bool user_gesture,
     const base::Callback<void(PermissionStatus)>& callback) {
   return RequestPermissions(
       std::vector<PermissionType>(1, permission),
       render_frame_host,
       requesting_origin,
       user_gesture,
@@ skipping 19 matching lines @@
 
   int request_id = pending_requests_.Add(base::MakeUnique<PendingRequest>(
       render_frame_host, permissions, callback));
 
   const PermissionRequestID request(render_frame_host, request_id);
 
   for (size_t i = 0; i < permissions.size(); ++i) {
     const PermissionType permission = permissions[i];
 
     if (IsConstantPermission(permission) ||
-        !GetPermissionContext(permission)) {
+        !GetPermissionContext(PermissionTypeToContentSetting(permission))) {
       // Track permission request usages even for constant permissions.
       PermissionUmaUtil::PermissionRequested(permission, requesting_origin,
                                              embedding_origin, profile_);
-      OnPermissionsRequestResponseStatus(request_id, i,
-          GetPermissionStatus(permission, requesting_origin, embedding_origin));
+      OnPermissionsRequestResponseStatus(
+          request_id, i, GetPermissionStatusForConstantPermission(permission));
       continue;
     }
 
-    PermissionContextBase* context = GetPermissionContext(permission);
+    PermissionContextBase* context =
+        GetPermissionContext(PermissionTypeToContentSetting(permission));
     context->RequestPermission(
         web_contents, request, requesting_origin, user_gesture,
         base::Bind(&ContentSettingToPermissionStatusCallbackWrapper,
             base::Bind(&PermissionManager::OnPermissionsRequestResponseStatus,
                 weak_ptr_factory_.GetWeakPtr(), request_id, i)));
   }
 
   // The request might have been resolved already.
   if (!pending_requests_.Lookup(request_id))
     return kNoPendingOperation;
 
   return request_id;
 }
 
 PermissionContextBase* PermissionManager::GetPermissionContext(
-    PermissionType type) {
+    ContentSettingsType type) {
   const auto& it = permission_contexts_.find(type);
   return it == permission_contexts_.end() ? nullptr : it->second.get();
 }
 
 void PermissionManager::OnPermissionsRequestResponseStatus(
     int request_id,
     int permission_id,
     PermissionStatus status) {
   PendingRequest* pending_request = pending_requests_.Lookup(request_id);
   pending_request->SetPermissionStatus(permission_id, status);
@@ skipping 12 matching lines @@
     return;
 
   content::WebContents* web_contents = tab_util::GetWebContentsByFrameID(
       pending_request->render_process_id(), pending_request->render_frame_id());
   DCHECK(web_contents);
 
   const PermissionRequestID request(pending_request->render_process_id(),
                                     pending_request->render_frame_id(),
                                     request_id);
   for (PermissionType permission : pending_request->permissions()) {
-    PermissionContextBase* context = GetPermissionContext(permission);
+    PermissionContextBase* context =
+        GetPermissionContext(PermissionTypeToContentSetting(permission));
     if (!context)
       continue;
     context->CancelPermissionRequest(web_contents, request);
   }
   pending_requests_.Remove(request_id);
 }
 
 void PermissionManager::ResetPermission(PermissionType permission,
                                         const GURL& requesting_origin,
                                         const GURL& embedding_origin) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
-  PermissionContextBase* context = GetPermissionContext(permission);
+  PermissionContextBase* context =
+      GetPermissionContext(PermissionTypeToContentSetting(permission));
   if (!context)
     return;
 
   context->ResetPermission(requesting_origin.GetOrigin(),
                            embedding_origin.GetOrigin());
 }
 
 PermissionStatus PermissionManager::GetPermissionStatus(
     PermissionType permission,
     const GURL& requesting_origin,
     const GURL& embedding_origin) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
-  return ContentSettingToPermissionStatus(GetPermissionStatusInternal(
-      permission, requesting_origin, embedding_origin));
+  if (IsConstantPermission(permission))
+    return GetPermissionStatusForConstantPermission(permission);
+  return GetPermissionStatus(PermissionTypeToContentSetting(permission),
+                             requesting_origin, embedding_origin);
+}
+
+PermissionStatus PermissionManager::GetPermissionStatus(
+    ContentSettingsType permission,
+    const GURL& requesting_origin,
+    const GURL& embedding_origin) {
+  PermissionContextBase* context = GetPermissionContext(permission);
+  return ContentSettingToPermissionStatus(
+      context->GetPermissionStatus(requesting_origin.GetOrigin(),
+                                   embedding_origin.GetOrigin()));

[raymes, 2017/02/07 04:46:15]

nit: function order should match the header

[Timothy Loh, 2017/02/08 04:01:06]

Done.

 }
 
 void PermissionManager::RegisterPermissionUsage(PermissionType permission,
                                                 const GURL& requesting_origin,
                                                 const GURL& embedding_origin) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
   // This is required because constant permissions don't have a
   // ContentSettingsType.
   if (IsConstantPermission(permission))
     return;
@@ skipping 12 matching lines @@
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
   if (subscriptions_.IsEmpty())
     HostContentSettingsMapFactory::GetForProfile(profile_)->AddObserver(this);
 
   auto subscription = base::MakeUnique<Subscription>();
   subscription->permission = permission;
   subscription->requesting_origin = requesting_origin;
   subscription->embedding_origin = embedding_origin;
   subscription->callback = callback;
 
-  subscription->current_value = GetPermissionStatusInternal(
-      permission, requesting_origin, embedding_origin);
+  subscription->current_value =
+      GetPermissionStatus(permission, requesting_origin, embedding_origin);
 
   return subscriptions_.Add(std::move(subscription));
 }
 
 void PermissionManager::UnsubscribePermissionStatusChange(int subscription_id) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
   // Whether |subscription_id| is known will be checked by the Remove() call.
   subscriptions_.Remove(subscription_id);
 
   if (subscriptions_.IsEmpty())
     HostContentSettingsMapFactory::GetForProfile(profile_)
         ->RemoveObserver(this);
 }
 
 bool PermissionManager::IsPermissionKillSwitchOn(
-    content::PermissionType permission) {
+    ContentSettingsType permission) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
   return GetPermissionContext(permission)->IsPermissionKillSwitchOn();
 }
 
 void PermissionManager::OnContentSettingChanged(
     const ContentSettingsPattern& primary_pattern,
     const ContentSettingsPattern& secondary_pattern,
     ContentSettingsType content_type,
     std::string resource_identifier) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
   std::list<base::Closure> callbacks;
 
   for (SubscriptionsMap::iterator iter(&subscriptions_);
        !iter.IsAtEnd(); iter.Advance()) {
     Subscription* subscription = iter.GetCurrentValue();
     if (IsConstantPermission(subscription->permission))
       continue;
     if (PermissionTypeToContentSetting(subscription->permission) !=
         content_type) {
       continue;
     }
 
     if (primary_pattern.IsValid() &&
         !primary_pattern.Matches(subscription->requesting_origin))
       continue;
     if (secondary_pattern.IsValid() &&
         !secondary_pattern.Matches(subscription->embedding_origin))
       continue;
 
-    ContentSetting new_value = GetPermissionStatusInternal(
+    PermissionStatus new_value = GetPermissionStatus(
         subscription->permission, subscription->requesting_origin,
         subscription->embedding_origin);
     if (subscription->current_value == new_value)
       continue;
 
     subscription->current_value = new_value;
 
     // Add the callback to |callbacks| which will be run after the loop to
     // prevent re-entrance issues.
-    callbacks.push_back(
-        base::Bind(subscription->callback,
-                   ContentSettingToPermissionStatus(new_value)));
+    callbacks.push_back(base::Bind(subscription->callback, new_value));
   }
 
   for (const auto& callback : callbacks)
     callback.Run();
 }
-
-ContentSetting PermissionManager::GetPermissionStatusInternal(
-    PermissionType permission,
-    const GURL& requesting_origin,
-    const GURL& embedding_origin) {
-  if (IsConstantPermission(permission))
-    return GetContentSettingForConstantPermission(permission);
-
-  PermissionContextBase* context = GetPermissionContext(permission);
-  return context->GetPermissionStatus(requesting_origin.GetOrigin(),
-                                      embedding_origin.GetOrigin());
-}