Sending known policy names for extensions to chrome://policy page

chrome/browser/ui/webui/policy_ui.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/webui/policy_ui.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/callback.h"
 #include "base/compiler_specific.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/strings/string16.h"
 #include "base/time.h"
 #include "base/values.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_system.h"
 #include "chrome/browser/policy/browser_policy_connector.h"
 #include "chrome/browser/policy/cloud/cloud_policy_client.h"
 #include "chrome/browser/policy/cloud/cloud_policy_constants.h"
 #include "chrome/browser/policy/cloud/cloud_policy_core.h"
 #include "chrome/browser/policy/cloud/cloud_policy_refresh_scheduler.h"
 #include "chrome/browser/policy/cloud/cloud_policy_store.h"
 #include "chrome/browser/policy/cloud/cloud_policy_validator.h"
 #include "chrome/browser/policy/cloud/message_util.h"
 #include "chrome/browser/policy/configuration_policy_handler_list.h"
+#include "chrome/browser/policy/policy_domain_descriptor.h"
 #include "chrome/browser/policy/policy_error_map.h"
 #include "chrome/browser/policy/policy_map.h"
+#include "chrome/browser/policy/policy_schema.h"
 #include "chrome/browser/policy/policy_service.h"
 #include "chrome/browser/policy/policy_types.h"
 #include "chrome/browser/policy/profile_policy_connector.h"
 #include "chrome/browser/policy/profile_policy_connector_factory.h"
 #include "chrome/browser/policy/proto/cloud/device_management_backend.pb.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/extensions/extension.h"
 #include "chrome/common/extensions/extension_set.h"
 #include "chrome/common/extensions/manifest.h"
 #include "chrome/common/time_format.h"
 #include "chrome/common/url_constants.h"
+#include "content/public/browser/notification_observer.h"
+#include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/web_ui.h"
 #include "content/public/browser/web_ui_data_source.h"
 #include "content/public/browser/web_ui_message_handler.h"
 #include "google_apis/gaia/gaia_auth_util.h"
 #include "grit/browser_resources.h"
 #include "grit/generated_resources.h"
 #include "policy/policy_constants.h"
 #include "ui/base/l10n/l10n_util.h"
 
 #if defined(OS_CHROMEOS)
@@ skipping 204 matching lines @@
 
  private:
   const std::string user_id_;
   policy::DeviceLocalAccountPolicyService* service_;
 
   DISALLOW_COPY_AND_ASSIGN(DeviceLocalAccountPolicyStatusProvider);
 };
 #endif
 
 // The JavaScript message handler for the chrome://policy page.
-class PolicyUIHandler : public content::WebUIMessageHandler,
+class PolicyUIHandler : public content::NotificationObserver,
+                        public content::WebUIMessageHandler,
                         public policy::PolicyService::Observer {
  public:
   PolicyUIHandler();
   virtual ~PolicyUIHandler();
 
+  // content::NotificationObserver implementation.
+  virtual void Observe(int type,
+                       const content::NotificationSource& source,
+                       const content::NotificationDetails& details) OVERRIDE;
+
   // content::WebUIMessageHandler implementation.
   virtual void RegisterMessages() OVERRIDE;
 
   // policy::PolicyService::Observer implementation.
   virtual void OnPolicyUpdated(const policy::PolicyNamespace& ns,
                                const policy::PolicyMap& previous,
                                const policy::PolicyMap& current) OVERRIDE;
 
  private:
   // Send a dictionary containing the names of all known policies to the UI.
@@ skipping 27 matching lines @@
   bool initialized_;
   std::string device_domain_;
   base::WeakPtrFactory<PolicyUIHandler> weak_factory_;
 
   // Providers that supply status dictionaries for user and device policy,
   // respectively. These are created on initialization time as appropriate for
   // the platform (Chrome OS / desktop) and type of policy that is in effect.
   scoped_ptr<CloudPolicyStatusProvider> user_status_provider_;
   scoped_ptr<CloudPolicyStatusProvider> device_status_provider_;
 
+  content::NotificationRegistrar registrar_;
+
   DISALLOW_COPY_AND_ASSIGN(PolicyUIHandler);
 };
 
 CloudPolicyStatusProvider::CloudPolicyStatusProvider() {
 }
 
 CloudPolicyStatusProvider::~CloudPolicyStatusProvider() {
 }
 
 void CloudPolicyStatusProvider::SetStatusChangeCallback(
@@ skipping 152 matching lines @@
   if (!device_status_provider_.get())
     device_status_provider_.reset(new CloudPolicyStatusProvider());
 
   base::Closure update_callback(base::Bind(&PolicyUIHandler::SendStatus,
                                            base::Unretained(this)));
   user_status_provider_->SetStatusChangeCallback(update_callback);
   device_status_provider_->SetStatusChangeCallback(update_callback);
   GetPolicyService()->AddObserver(policy::POLICY_DOMAIN_CHROME, this);
   GetPolicyService()->AddObserver(policy::POLICY_DOMAIN_EXTENSIONS, this);
 
+  registrar_.Add(this,
+                 chrome::NOTIFICATION_EXTENSION_LOADED,
+                 content::NotificationService::AllSources());
+  registrar_.Add(this,
+                 chrome::NOTIFICATION_EXTENSION_UNLOADED,
+                 content::NotificationService::AllSources());
+
   web_ui()->RegisterMessageCallback(
       "initialized",
       base::Bind(&PolicyUIHandler::HandleInitialized, base::Unretained(this)));
   web_ui()->RegisterMessageCallback(
       "reloadPolicies",
       base::Bind(&PolicyUIHandler::HandleReloadPolicies,
                  base::Unretained(this)));
 }
 
+void PolicyUIHandler::Observe(int type,
+                              const content::NotificationSource& source,
+                              const content::NotificationDetails& details) {
+  DCHECK(type == chrome::NOTIFICATION_EXTENSION_LOADED ||
+         type == chrome::NOTIFICATION_EXTENSION_UNLOADED);
+  SendPolicyNames();
+  SendPolicyValues();
+}
+
 void PolicyUIHandler::OnPolicyUpdated(const policy::PolicyNamespace& ns,
                                       const policy::PolicyMap& previous,
                                       const policy::PolicyMap& current) {
   SendPolicyValues();
 }
 
 void PolicyUIHandler::SendPolicyNames() const {
   base::DictionaryValue names;
+
+  // Add Chrome policy names.
+  base::DictionaryValue* chrome_policy_names = new base::DictionaryValue;
   const policy::PolicyDefinitionList* list =
       policy::GetChromePolicyDefinitionList();
   for (const policy::PolicyDefinitionList::Entry* entry = list->begin;
        entry != list->end; ++entry) {
-    names.SetBoolean(entry->name, true);
+    chrome_policy_names->SetBoolean(entry->name, true);
   }
+  names.Set("chromePolicyNames", chrome_policy_names);
+
+  // Add extension policy names.
+  base::DictionaryValue* extension_policy_names = new base::DictionaryValue;
+
+  // Get extensions.

[James Hawkins, 2013/06/20 18:18:52]

High-level: Some of your code comments are borderline superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

I take your point; I initially added these comments as notes to help myself
understand the code (since it's my first time coding in C++), with the intention
of removing them later, thanks for spotting this.

I've removed the ones you mentioned here. What should I do about the other
superfluous comments in the SendPolicyValues() method below? (Introduced in
issue 16689004 which I have just committed). Should I remove them as part of
this CL too? Or start a new issue?

[James Hawkins, 2013/06/21 14:54:25]

Up to you.

+  extensions::ExtensionSystem* extension_system =
+      extensions::ExtensionSystem::Get(Profile::FromWebUI(web_ui()));
+  const ExtensionSet* extensions =
+      extension_system->extension_service()->extensions();
+
+  // Get the policy schema map.

[James Hawkins, 2013/06/20 18:18:52]

Superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

Done.

+  scoped_refptr<const policy::PolicyDomainDescriptor> policy_domain_descriptor;
+  policy_domain_descriptor = GetPolicyService()->
+      GetPolicyDomainDescriptor(policy::POLICY_DOMAIN_EXTENSIONS);
+  const policy::PolicyDomainDescriptor::SchemaMap& schema_map =
+      policy_domain_descriptor->components();
+
+  // Add extension names and policies to the map.

[James Hawkins, 2013/06/20 18:18:52]

Superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

Done.

+  for (ExtensionSet::const_iterator it = extensions->begin();
+       it != extensions->end(); ++it) {
+    const extensions::Extension* extension = *it;
+
+    // Skip this extension if it's a component extension.

[James Hawkins, 2013/06/20 18:18:52]

Superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

Done.

+    if (extension->location() == extensions::Manifest::COMPONENT)
+      continue;
+
+    // Add extension name to map.

[James Hawkins, 2013/06/20 18:18:52]

Superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

Done.

+    base::DictionaryValue* extension_value = new base::DictionaryValue;
+    extension_value->SetString("name", extension->name());
+
+    // Get extension's policy schema.

[James Hawkins, 2013/06/20 18:18:52]

Superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

Done.

+    policy::PolicyDomainDescriptor::SchemaMap::const_iterator it =
+        schema_map.find(extension->id());
+    base::DictionaryValue* policy_names = new base::DictionaryValue;
+    if (it != schema_map.end()) {
+      // Get policy names from the extension's policy schema.
+      // Store in a map, not an array, for faster lookup on JS side.
+      const policy::PolicySchemaMap* policies = it->second->GetProperties();
+      policy::PolicySchemaMap::const_iterator it_policies;
+      for (it_policies = policies->begin(); it_policies != policies->end();
+           it_policies++) {
+        policy_names->SetBoolean(it_policies->first, true);
+      }
+    }
+    extension_value->Set("policyNames", policy_names);
+
+    // Add extension's entry to the map.

[James Hawkins, 2013/06/20 18:18:52]

Superfluous.

[anitawoodruff, 2013/06/21 10:16:16]

Done.

+    extension_policy_names->Set(extension->id(), extension_value);
+  }
+
+  names.Set("extensionPolicyNames", extension_policy_names);
   web_ui()->CallJavascriptFunction("policy.Page.setPolicyNames", names);
 }
 
 void PolicyUIHandler::SendPolicyValues() const {
   base::DictionaryValue all_policies;
 
   // Add chrome policies.
   base::DictionaryValue* chrome_policies = new base::DictionaryValue;
   GetChromePolicyValues(chrome_policies);
   all_policies.Set("chromePolicies", chrome_policies);
 
   // Get extensions.
   extensions::ExtensionSystem* extension_system =
       extensions::ExtensionSystem::Get(Profile::FromWebUI(web_ui()));
   const ExtensionSet* extensions =
       extension_system->extension_service()->extensions();
 
   // Add policies for each extension.
   base::DictionaryValue* extension_values = new base::DictionaryValue;
   for (ExtensionSet::const_iterator it = extensions->begin();
        it != extensions->end(); ++it) {
     const extensions::Extension* extension = *it;
 
     // Skip this extension if it's a component extension.
     if (extension->location() == extensions::Manifest::COMPONENT)
       continue;
 
-    base::DictionaryValue* extension_value = new base::DictionaryValue;
-
-    // Add name.
-    extension_value->SetString("name", extension->name());
-
-    // Add policies.
+    // Add policies values.
+    // Store in a map, not an array, for faster lookup on JS side.
     base::DictionaryValue* extension_policies = new base::DictionaryValue;
     policy::PolicyNamespace policy_namespace = policy::PolicyNamespace(
         policy::POLICY_DOMAIN_EXTENSIONS, extension->id());
     policy::PolicyErrorMap empty_error_map;
     GetPolicyValues(GetPolicyService()->GetPolicies(policy_namespace),
                     &empty_error_map, extension_policies);
-    extension_value->Set("policies", extension_policies);
 
     // Add entry to the dictionary.
-    extension_values->Set(extension->id(), extension_value);
+    extension_values->Set(extension->id(), extension_policies);
   }
   all_policies.Set("extensionPolicies", extension_values);
 
   web_ui()->CallJavascriptFunction("policy.Page.setPolicyValues", all_policies);
 }
 
 void PolicyUIHandler::GetPolicyValues(const policy::PolicyMap& map,
                                       policy::PolicyErrorMap* errors,
                                       base::DictionaryValue* values) const {
   for (policy::PolicyMap::const_iterator entry = map.begin();
@@ skipping 80 matching lines @@
 }
 
 PolicyUI::PolicyUI(content::WebUI* web_ui) : WebUIController(web_ui) {
   web_ui->AddMessageHandler(new PolicyUIHandler);
   content::WebUIDataSource::Add(Profile::FromWebUI(web_ui),
                                 CreatePolicyUIHTMLSource());
 }
 
 PolicyUI::~PolicyUI() {
 }