chrome://identity-internals code quality

chrome/browser/ui/webui/identity_internals_ui.cc

 // Copyright 2013 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/identity_internals_ui.h"
 
 #include <set>
 #include <string>
 
 #include "base/bind.h"
@@ skipping 14 matching lines @@
 #include "ui/base/l10n/l10n_util.h"
 
 namespace {
 
 // Properties of the Javascript object representing a token.
 const char kExtensionId[] = "extensionId";
 const char kExtensionName[] = "extensionName";
 const char kScopes[] = "scopes";
 const char kStatus[] = "status";
 const char kTokenExpirationTime[] = "expirationTime";
-const char kTokenId[] = "tokenId";
+const char kAccessToken[] = "accessToken";
 
 // RevokeToken message parameter offsets.
 const int kRevokeTokenExtensionOffset = 0;
 const int kRevokeTokenTokenOffset = 1;
 
 class IdentityInternalsTokenRevoker;
 
+// Class acting as a controller of the chrome://identity-internals WebUI.
 class IdentityInternalsUIMessageHandler : public content::WebUIMessageHandler {
  public:
   IdentityInternalsUIMessageHandler();
   virtual ~IdentityInternalsUIMessageHandler();
 
   // Ensures that a proper clean up happens after a token is revoked. That
   // includes deleting the |token_revoker|, removing the token from Identity API
   // cache and updating the UI that the token is gone.
   void OnTokenRevokerDone(IdentityInternalsTokenRevoker* token_revoker);
 
   // WebUIMessageHandler implementation.
   virtual void RegisterMessages() OVERRIDE;
 
  private:
+  // Gets a name of an extension referred to by |token_cache_key| as a string.

[Michael Courage, 2013/06/20 09:40:54]

tinynit: s/Gets a/Gets the/

[fgorski, 2013/06/20 16:28:48]

Done.

   const std::string GetExtensionName(
       const extensions::IdentityAPI::TokenCacheKey& token_cache_key);
 
+  // Gets a list of scopes specified in |token_cache_key| and returns a pointer
+  // to a ListValue containing the scopes. The caller gets ownership of the
+  // returned object.
   ListValue* GetScopes(
       const extensions::IdentityAPI::TokenCacheKey& token_cache_key);
 
+  // Gets a localized status of the access token in |token_cache_value|.
   const base::string16 GetStatus(
       const extensions::IdentityTokenCacheValue& token_cache_value);
 
+  // Gets a string representation of an expiration time of the access token in
+  // |token_cache_value|.
   const std::string GetExpirationTime(
       const extensions::IdentityTokenCacheValue& token_cache_value);
 
+  // Converts a pair of |token_cache_key| and |token_cache_value| to a
+  // DictionaryValue object with corresponding information in a localized and
+  // readible form and returns a pointer to created object. Caller gets the

[Michael Courage, 2013/06/20 09:40:54]

nits:
s/readible/readable/
returns a pointer to _the_ created object

[fgorski, 2013/06/20 16:28:48]

Done.

+  // ownership of the returned object.
   DictionaryValue* GetInfoForToken(
       const extensions::IdentityAPI::TokenCacheKey& token_cache_key,
       const extensions::IdentityTokenCacheValue& token_cache_value);
 
+  // Gets all of the tokens stored in IdenityAPI token cache and returns them

[Michael Courage, 2013/06/20 09:40:54]

s/IdenityAPI/IdentityAPI/

[fgorski, 2013/06/20 16:28:48]

Done.

+  // to the caller using Javascript callback function
+  // |identity_internals.returnTokens()|.
   void GetInfoForAllTokens(const ListValue* args);
 
   // Initiates revoking of the token, based on the extension ID and token
-  // passed as entries in the args list.
+  // passed as entries in the |args| list. Updates the caller of completion
+  // using Javascript callback function |identity_internals.tokenRevokeDone()|.
   void RevokeToken(const ListValue* args);
 
   // A vector of token revokers that are currently revoking tokens.
   ScopedVector<IdentityInternalsTokenRevoker> token_revokers_;
 };
 
 // Handles the revoking of an access token and helps performing the clean up
 // after it is revoked by holding information about the access token and related
 // extension ID.
 class IdentityInternalsTokenRevoker : public GaiaAuthConsumer {
@@ skipping 98 matching lines @@
 }
 
 DictionaryValue* IdentityInternalsUIMessageHandler::GetInfoForToken(
     const extensions::IdentityAPI::TokenCacheKey& token_cache_key,
     const extensions::IdentityTokenCacheValue& token_cache_value) {
   DictionaryValue* token_data = new DictionaryValue();
   token_data->SetString(kExtensionId, token_cache_key.extension_id);
   token_data->SetString(kExtensionName, GetExtensionName(token_cache_key));
   token_data->Set(kScopes, GetScopes(token_cache_key));
   token_data->SetString(kStatus, GetStatus(token_cache_value));
-  token_data->SetString(kTokenId, token_cache_value.token());
+  token_data->SetString(kAccessToken, token_cache_value.token());
   token_data->SetString(kTokenExpirationTime,
                         GetExpirationTime(token_cache_value));
   return token_data;
 }
 
 void IdentityInternalsUIMessageHandler::GetInfoForAllTokens(
     const ListValue* args) {
   ListValue results;
   extensions::IdentityAPI::CachedTokens tokens =
       extensions::IdentityAPI::GetFactoryInstance()->GetForProfile(
@@ skipping 49 matching lines @@
 IdentityInternalsUI::IdentityInternalsUI(content::WebUI* web_ui)
   : content::WebUIController(web_ui) {
   // chrome://identity-internals source.
   content::WebUIDataSource* html_source =
     content::WebUIDataSource::Create(chrome::kChromeUIIdentityInternalsHost);
   html_source->SetUseJsonJSFormatV2();
 
   // Localized strings
   html_source->AddLocalizedString("tokenCacheHeader",
       IDS_IDENTITY_INTERNALS_TOKEN_CACHE_TEXT);
-  html_source->AddLocalizedString("tokenId",
-      IDS_IDENTITY_INTERNALS_TOKEN_ID);
+  html_source->AddLocalizedString("accessToken",
+      IDS_IDENTITY_INTERNALS_ACCESS_TOKEN);
   html_source->AddLocalizedString("extensionName",
       IDS_IDENTITY_INTERNALS_EXTENSION_NAME);
   html_source->AddLocalizedString("extensionId",
       IDS_IDENTITY_INTERNALS_EXTENSION_ID);
   html_source->AddLocalizedString("tokenStatus",
       IDS_IDENTITY_INTERNALS_TOKEN_STATUS);
   html_source->AddLocalizedString("expirationTime",
       IDS_IDENTITY_INTERNALS_EXPIRATION_TIME);
   html_source->AddLocalizedString("scopes",
       IDS_IDENTITY_INTERNALS_SCOPES);
   html_source->AddLocalizedString("revoke",
       IDS_IDENTITY_INTERNALS_REVOKE);
   html_source->SetJsonPath("strings.js");
 
   // Required resources
   html_source->AddResourcePath("identity_internals.css",
       IDR_IDENTITY_INTERNALS_CSS);
   html_source->AddResourcePath("identity_internals.js",
       IDR_IDENTITY_INTERNALS_JS);
   html_source->SetDefaultResource(IDR_IDENTITY_INTERNALS_HTML);
 
   content::WebUIDataSource::Add(Profile::FromWebUI(web_ui), html_source);
 
   web_ui->AddMessageHandler(new IdentityInternalsUIMessageHandler());
 }
 
 IdentityInternalsUI::~IdentityInternalsUI() {}