password_form_fill_data.h revision eb525c5499e34cc9c4b825d6d9e75bb07cc06ace 
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_CORE_COMMON_PASSWORD_FORM_FILL_DATA_H_
6#define COMPONENTS_AUTOFILL_CORE_COMMON_PASSWORD_FORM_FILL_DATA_H_
7
8#include <map>
9
10#include "base/memory/scoped_ptr.h"
11#include "components/autofill/core/common/form_data.h"
12#include "content/public/common/password_form.h"
13
14namespace autofill {
15
16// Helper struct for PasswordFormFillData
17struct UsernamesCollectionKey {
18  UsernamesCollectionKey();
19  ~UsernamesCollectionKey();
20
21  // Defined so that this struct can be used as a key in a std::map.
22  bool operator<(const UsernamesCollectionKey& other) const;
23
24  base::string16 username;
25  base::string16 password;
26};
27
28struct PasswordAndRealm {
29  base::string16 password;
30  std::string realm;
31};
32
33// Structure used for autofilling password forms.
34struct PasswordFormFillData {
35  typedef std::map<base::string16, PasswordAndRealm> LoginCollection;
36  typedef std::map<UsernamesCollectionKey,
37                   std::vector<base::string16> > UsernamesCollection;
38
39  // Identifies the HTML form on the page and preferred username/password for
40  // login.
41  FormData basic_data;
42
43  // The signon realm of the preferred user/pass pair.
44  std::string preferred_realm;
45
46  // A list of other matching username->PasswordAndRealm pairs for the form.
47  LoginCollection additional_logins;
48
49  // A list of possible usernames in the case where we aren't completely sure
50  // that the original saved username is correct. This data is keyed by the
51  // saved username/password to ensure uniqueness, though the username is not
52  // used.
53  UsernamesCollection other_possible_usernames;
54
55  // Tells us whether we need to wait for the user to enter a valid username
56  // before we autofill the password. By default, this is off unless the
57  // PasswordManager determined there is an additional risk associated with this
58  // form. This can happen, for example, if action URI's of the observed form
59  // and our saved representation don't match up.
60  bool wait_for_username;
61
62  PasswordFormFillData();
63  ~PasswordFormFillData();
64};
65
66// Create a FillData structure in preparation for autofilling a form,
67// from basic_data identifying which form to fill, and a collection of
68// matching stored logins to use as username/password values.
69// |preferred_match| should equal (address) one of matches.
70// |wait_for_username_before_autofill| is true if we should not autofill
71// anything until the user typed in a valid username and blurred the field.
72// If |enable_possible_usernames| is true, we will populate possible_usernames
73// in |result|.
74void InitPasswordFormFillData(
75    const content::PasswordForm& form_on_page,
76    const content::PasswordFormMap& matches,
77    const content::PasswordForm* const preferred_match,
78    bool wait_for_username_before_autofill,
79    bool enable_other_possible_usernames,
80    PasswordFormFillData* result);
81
82}  // namespace autofill
83
84#endif  // COMPONENTS_AUTOFILL_CORE_COMMON_PASSWORD_FORM_FILL_DATA_H__
85