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

chrome/browser/ui/autofill/save_card_bubble_controller_impl.h

 // 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.
 
 #ifndef CHROME_BROWSER_UI_AUTOFILL_SAVE_CARD_BUBBLE_CONTROLLER_IMPL_H_
 #define CHROME_BROWSER_UI_AUTOFILL_SAVE_CARD_BUBBLE_CONTROLLER_IMPL_H_
 
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/timer/elapsed_timer.h"
 #include "chrome/browser/ui/autofill/save_card_bubble_controller.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 
 namespace autofill {
 
 // Implementation of per-tab class to control the save credit card bubble and
 // Omnibox icon.
 //
 // TODO(bondd): Add text strings so different dialog contents can be shown
 // depending upon whether upstreaming is available.
 class SaveCardBubbleControllerImpl
     : public SaveCardBubbleController,
       public content::WebContentsObserver,
       public content::WebContentsUserData<SaveCardBubbleControllerImpl> {
  public:
   // |save_card_callback| will be invoked if/when the Save button is pressed.
   void SetCallback(const base::Closure& save_card_callback);
 
+  // Example of valid |lines| data:
+  // [ {
+  //   "template" : "The legal documents are: {0} and {1}",
+  //   "template_parameter" : [ {
+  //     "display_text" : "Terms of Service",
+  //     "url": "http://www.example.com/tos"
+  //    }, {
+  //     "display_text" : "Privacy Policy",
+  //     "url": "http://www.example.com/pp"
+  //    } ],
+  // }, {
+  //   "template" : "This is the second line and it has no parameters"
+  // } ]
+  //
+  // Caveats:
+  // 1. '{' and '}' may be displayed by escaping them with an apostrophe in the
+  //    template string, e.g. "template" : "Here is a literal '{'"
+  // 2. Two or more consecutive dollar signs in the template string will not
+  //    expand correctly.
+  // 3. "${" anywhere in the template string is invalid.
+  // 4. "\n" embedded anywhere in the template string, or an empty template
+  //    string, can be used to separate paragraphs. It is not possible to create
+  //    a completely blank line by using two consecutive newlines (they will be
+  //    treated as a single newline by views::StyledLabel).
+  //
+  // Returns false if contents of |lines| are invalid.
+  bool SetLegalMessage(const base::ListValue& lines);
+  void ClearLegalMessage();
+
   // SetCallback() must be called first.
   void ShowBubble();
 
   // Returns true if Omnibox save credit card icon should be visible.
   bool IsIconVisible() const;
 
   // Returns true if Omnibox save credit card should be shown in its "toggled
   // on" state.
   bool IsIconToggled() const;
 
   // Returns nullptr if no bubble is currently shown.
   SaveCardBubbleView* save_card_bubble_view() const;
 
   // SaveCardBubbleController:
   void OnSaveButton() override;
   void OnCancelButton() override;
   void OnLearnMoreClicked() override;
+  void OnLegalMessageLinkClicked(const gfx::Range& link_range) override;
   void OnBubbleClosed() override;
 
+  const base::string16& GetLegalMessage() const override;
+  const std::vector<gfx::Range>& GetLegalMessageLinkRanges() const override;
+
+  // For testing.
+  const std::vector<std::string>& GetLegalMessageLinkUrlsForTesting() const;

[bondd, 2015/11/11 01:53:36]

I'm not sure what the current best practice is for exposing this for testing. I
can think of lots of ways to do it (with various levels of refactoring), but
maybe it's fine this way. Suggestions welcome. Best suggestion being "leave it
like this". :)

+
  private:
   friend class content::WebContentsUserData<SaveCardBubbleControllerImpl>;
 
   explicit SaveCardBubbleControllerImpl(content::WebContents* web_contents);
   ~SaveCardBubbleControllerImpl() override;
 
   // Update the visibility and toggled state of the Omnibox save card icon.
   void UpdateIcon();
 
+  void OpenUrl(const std::string& url);
+
   // content::WebContentsObserver:
   void DidNavigateMainFrame(
       const content::LoadCommittedDetails& details,
       const content::FrameNavigateParams& params) override;
 
   // Weak reference. Will be nullptr if no bubble is currently shown.
   SaveCardBubbleView* save_card_bubble_view_;
 
   // Callback to run if user presses Save button in the bubble.
   // If save_card_callback_.is_null() is true then no bubble is available to
   // show and the icon is not visible.
   base::Closure save_card_callback_;
 
+  // If no legal message should be shown then this variable is an empty string.
+  base::string16 legal_message_;
+
+  // These two vectors describe all of the links in legal_message_. The two
+  // vectors will always be in sync with each other and legal_message_. Empty if
+  // legal_message_ is an empty string.
+  std::vector<gfx::Range> legal_message_link_ranges_;
+  std::vector<std::string> legal_message_link_urls_;

[bondd, 2015/11/11 01:53:36]

Made these separate (instead of combining range and url into LegalMessageLink
like in last patch set) so that GetLegalMessageLinkRanges() can return a const
ref vector. It's a bit of extra internal complexity to make the external
interface simpler. Don't need to expose struct LegalMessageLink.

[Evan Stade, 2015/11/11 22:22:54]

make the testing function protected and create a
TestSaveCardBubbleControllerImpl (if it doesn't already exist) which inherits
from this class

[bondd, 2015/11/13 01:19:52]

Thanks. If we stick with the new interface then I can get the URLs through the
public interface.

+
   // Used to measure the amount of time on a page; if it's less than some
   // reasonable limit, then don't close the bubble upon navigation.
   scoped_ptr<base::ElapsedTimer> timer_;
 
   DISALLOW_COPY_AND_ASSIGN(SaveCardBubbleControllerImpl);
 };
 
 }  // namespace autofill
 
 #endif  // CHROME_BROWSER_UI_AUTOFILL_SAVE_CARD_BUBBLE_CONTROLLER_IMPL_H_