components/autofill/content/renderer/password_generation_agent.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_AUTOFILL_CONTENT_RENDERER_PASSWORD_GENERATION_AGENT_H_
   6 #define COMPONENTS_AUTOFILL_CONTENT_RENDERER_PASSWORD_GENERATION_AGENT_H_
   7
   8 #include <map>
   9 #include <utility>
  10 #include <vector>
  11
  12 #include "base/memory/linked_ptr.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "content/public/renderer/render_frame_observer.h"
  15 #include "third_party/WebKit/public/web/WebInputElement.h"
  16 #include "url/gurl.h"
  17
  18 namespace blink {
  19 class WebDocument;
  20 }
  21
  22 namespace autofill {
  23
  24 struct FormData;
  25 struct PasswordForm;
  26 class PasswordAutofillAgent;
  27
  28 // This class is responsible for controlling communication for password
  29 // generation between the browser (which shows the popup and generates
  30 // passwords) and WebKit (shows the generation icon in the password field).
  31 class PasswordGenerationAgent : public content::RenderFrameObserver {
  32  public:
  33   PasswordGenerationAgent(content::RenderFrame* render_frame,
  34                           PasswordAutofillAgent* password_agent);
  35   ~PasswordGenerationAgent() override;
  36
  37   // Returns true if the field being changed is one where a generated password
  38   // is being offered. Updates the state of the popup if necessary.
  39   bool TextDidChangeInTextField(const blink::WebInputElement& element);
  40
  41   // Returns true if the newly focused node caused the generation UI to show.
  42   bool FocusedNodeHasChanged(const blink::WebNode& node);
  43
  44   // Called when new form controls are inserted.
  45   void OnDynamicFormsSeen();
  46
  47   // The length that a password can be before the UI is hidden.
  48   static const size_t kMaximumOfferSize = 5;
  49
  50  protected:
  51   // Returns true if the document for |render_frame()| is one that we should
  52   // consider analyzing. Virtual so that it can be overriden during testing.
  53   virtual bool ShouldAnalyzeDocument() const;
  54
  55   // RenderViewObserver:
  56   bool OnMessageReceived(const IPC::Message& message) override;
  57
  58   // Use to force enable during testing.
  59   void set_enabled(bool enabled) { enabled_ = enabled; }
  60
  61  private:
  62   struct AccountCreationFormData {
  63     linked_ptr<PasswordForm> form;
  64     std::vector<blink::WebInputElement> password_elements;
  65
  66     AccountCreationFormData(
  67         linked_ptr<PasswordForm> form,
  68         std::vector<blink::WebInputElement> password_elements);
  69     ~AccountCreationFormData();
  70   };
  71
  72   typedef std::vector<AccountCreationFormData> AccountCreationFormDataList;
  73
  74   // RenderFrameObserver:
  75   void DidFinishDocumentLoad() override;
  76
  77   // Message handlers.
  78   void OnFormNotBlacklisted(const PasswordForm& form);
  79   void OnPasswordAccepted(const base::string16& password);
  80   void OnAccountCreationFormsDetected(
  81       const std::vector<autofill::FormData>& forms);
  82
  83   // Helper function that will try and populate |password_elements_| and
  84   // |possible_account_creation_form_|.
  85   void FindPossibleGenerationForm();
  86
  87   // Helper function to decide if |passwords_| contains password fields for
  88   // an account creation form. Sets |generation_element_| to the field that
  89   // we want to trigger the generation UI on.
  90   void DetermineGenerationElement();
  91
  92   // Show password generation UI anchored at |generation_element_|.
  93   void ShowGenerationPopup();
  94
  95   // Show UI for editing a generated password at |generation_element_|.
  96   void ShowEditingPopup();
  97
  98   // Hides a password generation popup if one exists.
  99   void HidePopup();
 100
 101   // Stores forms that are candidates for account creation.
 102   AccountCreationFormDataList possible_account_creation_forms_;
 103
 104   // Stores the origins of the password forms confirmed not to be blacklisted
 105   // by the browser. A form can be blacklisted if a user chooses "never save
 106   // passwords for this site".
 107   std::vector<GURL> not_blacklisted_password_form_origins_;
 108
 109   // Stores each password form for which the Autofill server classifies one of
 110   // the form's fields as an ACCOUNT_CREATION_PASSWORD. These forms will
 111   // not be sent if the feature is disabled.
 112   std::vector<autofill::FormData> generation_enabled_forms_;
 113
 114   // Data for form which generation is allowed on.
 115   scoped_ptr<AccountCreationFormData> generation_form_data_;
 116
 117   // Element where we want to trigger password generation UI.
 118   blink::WebInputElement generation_element_;
 119
 120   // If the password field at |generation_element_| contains a generated
 121   // password.
 122   bool password_is_generated_;
 123
 124   // True if a password was generated and the user edited it. Used for UMA
 125   // stats.
 126   bool password_edited_;
 127
 128   // True if the generation popup was shown during this navigation. Used to
 129   // track UMA stats per page visit rather than per display, since the former
 130   // is more interesting.
 131   bool generation_popup_shown_;
 132
 133   // True if the editing popup was shown during this navigation. Used to track
 134   // UMA stats per page rather than per display, since the former is more
 135   // interesting.
 136   bool editing_popup_shown_;
 137
 138   // If this feature is enabled. Controlled by Finch.
 139   bool enabled_;
 140
 141   // Unowned pointer. Used to notify PassowrdAutofillAgent when values
 142   // in password fields are updated.
 143   PasswordAutofillAgent* password_agent_;
 144
 145   DISALLOW_COPY_AND_ASSIGN(PasswordGenerationAgent);
 146 };
 147
 148 }  // namespace autofill
 149
 150 #endif  // COMPONENTS_AUTOFILL_CONTENT_RENDERER_PASSWORD_GENERATION_AGENT_H_