Autofill: Add legal message footer to save credit card bubble.

chrome/browser/ui/autofill/save_card_bubble_controller_impl.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/ui/autofill/save_card_bubble_controller_impl.h"
 
+#include "base/i18n/message_formatter.h"
+#include "base/strings/string_util.h"
+#include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/ui/autofill/save_card_bubble_view.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/browser_finder.h"
 #include "chrome/browser/ui/browser_window.h"
 #include "chrome/browser/ui/location_bar/location_bar.h"
 #include "components/autofill/core/common/autofill_constants.h"
 #include "content/public/browser/navigation_details.h"
 
 DEFINE_WEB_CONTENTS_USER_DATA_KEY(autofill::SaveCardBubbleControllerImpl);
 
 namespace {
 
 // Number of seconds the bubble and icon will survive navigations, starting
 // from when the bubble is shown.
 // TODO(bondd): Share with ManagePasswordsUIController.
 const int kSurviveNavigationSeconds = 5;
 
+// Replace "{0}", "{1}", ... in |template_icu| with corresponding strings
+// from |display_texts|. Sets |out_message| to the resulting string, with
+// start position of each replacement in |out_offsets|.
+// Return false on failure. If false is returned then contents of |out_message|
+// and |out_offsets| are undefined.
+bool ReplaceTemplatePlaceholders(
+    const base::string16& template_icu,
+    const std::vector<base::string16>& display_texts,
+    base::string16& out_message,

[Evan Stade, 2015/11/18 22:01:19]

non const ref outparams still not allowed

[bondd, 2015/11/18 23:41:42]

Gah sorry, I can't believe I missed this one. I saw both of them, then went off
to look everywhere else for more, and came back and only fixed one. Thanks.

+    std::vector<size_t>* out_offsets) {
+  // Escape "$" -> "$$" for ReplaceStringPlaceholders().
+  //
+  // Edge cases:
+  // 1. Two or more consecutive $ characters will be incorrectly expanded
+  //    ("$$" -> "$$$$", which ReplaceStringPlaceholders() then turns into
+  //    "$$$").
+  //
+  // 2. "${" will cause false to be returned. "${0}" will expand to "$${0}".
+  //    FormatWithNumberedArgs() turns it into "$$$1", which
+  //    ReplaceStringPlaceholders() then turns into "$$1" without doing the
+  //    parameter replacement. This causes false to be returned because each
+  //    parameter is not used exactly once.
+  //
+  // Both of these cases are noted in the header file, and are unlikely to
+  // occur in any actual legal message.
+  base::string16 template_icu_escaped;
+  base::ReplaceChars(template_icu, base::ASCIIToUTF16("$"),
+                     base::ASCIIToUTF16("$$"), &template_icu_escaped);
+
+  // Replace "{0}" -> "$1", "{1}" -> "$2", ... to prepare |template_dollars|
+  // for ReplaceStringPlaceholders().
+  base::string16 template_dollars =
+      base::i18n::MessageFormatter::FormatWithNumberedArgs(
+          template_icu_escaped, "$1", "$2", "$3", "$4", "$5", "$6", "$7");
+
+  // FormatWithNumberedArgs() returns an empty string on failure.
+  if (template_dollars.empty() && !template_icu.empty())
+    return false;
+
+  // Replace "$1", "$2", ... with the display text of each parameter.
+  out_message = base::ReplaceStringPlaceholders(template_dollars, display_texts,
+                                                out_offsets);
+
+  // Each parameter must be used exactly once. If a parameter is unused or
+  // used more than once then it can't be determined which |offsets| entry
+  // corresponds to which parameter.
+  return out_offsets->size() == display_texts.size();
+}
+
+// Parses |line| and sets |out|.
+// Returns false on failure. |out| is not modified if false is returned.
+bool ParseLegalMessageLine(
+    const base::DictionaryValue& line,
+    autofill::SaveCardBubbleController::LegalMessageLine* out) {
+  autofill::SaveCardBubbleController::LegalMessageLine result;

[Evan Stade, 2015/11/18 22:01:19]

this should already be in the autofill:: namespace

[bondd, 2015/11/18 23:41:42]

Done.

+
+  // |display_texts| elements are the strings that will be substituted for
+  // "{0}", "{1}", etc. in the template string.
+  std::vector<base::string16> display_texts;
+
+  // Process all the template parameters.
+  const base::ListValue* template_parameters = nullptr;
+  if (line.GetList("template_parameter", &template_parameters)) {

[Evan Stade, 2015/11/18 22:01:19]

display_texts.resize(template_parameters->GetSize());

then you don't need to push_back below. Same for result.links.

This doesn't save any lines of code but it should be marginally more efficient
and imo is more legible (easy to see that results.link.size() ==
display_texts.size())

[bondd, 2015/11/18 23:41:42]

Done.

+    for (size_t parameter_index = 0;
+         parameter_index < template_parameters->GetSize(); ++parameter_index) {
+      // Get a single element of the "template_parameter" list.
+      const base::DictionaryValue* single_parameter;
+      if (!template_parameters->GetDictionary(parameter_index,
+                                              &single_parameter)) {
+        return false;
+      }
+
+      // Read and store the "display_text" string.
+      display_texts.push_back(base::string16());
+      if (!single_parameter->GetString("display_text", &display_texts.back()))
+        return false;
+
+      // Read and store the "url" string.
+      std::string url;
+      if (!single_parameter->GetString("url", &url))
+        return false;
+      result.links.push_back(
+          autofill::SaveCardBubbleController::LegalMessageLine::Link());
+      result.links.back().url = GURL(url);
+    }
+  }
+
+  // Read the template string. It's a small subset of the ICU message format
+  // syntax.
+  base::string16 template_icu;
+  if (!line.GetString("template", &template_icu))
+    return false;
+
+  // Replace the placeholders in |template_icu| with strings from
+  // |display_texts|, and store the start position of each replacement in
+  // |offsets|.
+  std::vector<size_t> offsets;
+  if (!ReplaceTemplatePlaceholders(template_icu, display_texts, result.text,
+                                   &offsets)) {
+    return false;
+  }
+
+  // Fill in range values for all links.
+  for (size_t offset_index = 0; offset_index < offsets.size(); ++offset_index) {
+    size_t range_start = offsets[offset_index];
+    result.links[offset_index].range = gfx::Range(
+        range_start, range_start + display_texts[offset_index].size());
+  }
+
+  *out = result;
+  return true;
+}
+
 }  // namespace
 
 namespace autofill {
 
 SaveCardBubbleControllerImpl::SaveCardBubbleControllerImpl(
     content::WebContents* web_contents)
     : content::WebContentsObserver(web_contents),
       save_card_bubble_view_(nullptr) {
   DCHECK(web_contents);
 }
 
 SaveCardBubbleControllerImpl::~SaveCardBubbleControllerImpl() {
   if (save_card_bubble_view_)
     save_card_bubble_view_->Hide();
 }
 
 void SaveCardBubbleControllerImpl::SetCallback(
     const base::Closure& save_card_callback) {
   save_card_callback_ = save_card_callback;
 }
 
+bool SaveCardBubbleControllerImpl::SetLegalMessage(
+    const base::ListValue& lines) {
+  // Process all lines of the message. See comment in header file for example
+  // of valid |lines| data.
+  legal_message_lines_.clear();

[Evan Stade, 2015/11/18 22:01:19]

another place you can resize once instead of pushing back many times

[bondd, 2015/11/18 23:41:42]

Done.

+  for (size_t line_index = 0; line_index < lines.GetSize(); ++line_index) {
+    const base::DictionaryValue* single_line;
+    legal_message_lines_.push_back(LegalMessageLine());
+    if (!lines.GetDictionary(line_index, &single_line) ||
+        !ParseLegalMessageLine(*single_line, &legal_message_lines_.back())) {
+      legal_message_lines_.clear();
+      return false;
+    }
+  }
+
+  return true;
+}
+
 void SaveCardBubbleControllerImpl::ShowBubble(bool user_action) {
   DCHECK(!save_card_callback_.is_null());
 
   // Need to create location bar icon before bubble, otherwise bubble will be
   // unanchored.
   UpdateIcon();
 
   Browser* browser = chrome::FindBrowserWithWebContents(web_contents());
   save_card_bubble_view_ = browser->window()->ShowSaveCreditCardBubble(
       web_contents(), this, user_action);
@@ skipping 18 matching lines @@
 void SaveCardBubbleControllerImpl::OnSaveButton() {
   save_card_callback_.Run();
   save_card_callback_.Reset();
 }
 
 void SaveCardBubbleControllerImpl::OnCancelButton() {
   save_card_callback_.Reset();
 }
 
 void SaveCardBubbleControllerImpl::OnLearnMoreClicked() {
-  web_contents()->OpenURL(content::OpenURLParams(
-      GURL(kHelpURL), content::Referrer(), NEW_FOREGROUND_TAB,
-      ui::PAGE_TRANSITION_LINK, false));
+  OpenUrl(GURL(kHelpURL));
+}
+
+void SaveCardBubbleControllerImpl::OnLegalMessageLinkClicked(const GURL& url) {
+  OpenUrl(url);
 }
 
 void SaveCardBubbleControllerImpl::OnBubbleClosed() {
   save_card_bubble_view_ = nullptr;
   UpdateIcon();
 }
 
+const SaveCardBubbleController::LegalMessageLines&
+SaveCardBubbleControllerImpl::GetLegalMessageLines() const {
+  return legal_message_lines_;
+}
+
 void SaveCardBubbleControllerImpl::UpdateIcon() {
   Browser* browser = chrome::FindBrowserWithWebContents(web_contents());
   LocationBar* location_bar = browser->window()->GetLocationBar();
   location_bar->UpdateSaveCreditCardIcon();
 }
 
+void SaveCardBubbleControllerImpl::OpenUrl(const GURL& url) {
+  web_contents()->OpenURL(
+      content::OpenURLParams(url, content::Referrer(), NEW_FOREGROUND_TAB,
+                             ui::PAGE_TRANSITION_LINK, false));
+}
+
 void SaveCardBubbleControllerImpl::DidNavigateMainFrame(
     const content::LoadCommittedDetails& details,
     const content::FrameNavigateParams& params) {
   // Nothing to do if there's no bubble available.
   if (save_card_callback_.is_null())
     return;
 
   // Don't react to in-page (fragment) navigations.
   if (details.is_in_page)
     return;
 
   // Don't do anything if a navigation occurs before a user could reasonably
   // interact with the bubble.
   if (timer_->Elapsed() <
       base::TimeDelta::FromSeconds(kSurviveNavigationSeconds))
     return;
 
   // Otherwise, get rid of the bubble and icon.
   save_card_callback_.Reset();
   if (save_card_bubble_view_) {
     save_card_bubble_view_->Hide();
     OnBubbleClosed();
   } else {
     UpdateIcon();
   }
 }
 
 }  // namespace autofill