File: quick_answers_controller_impl.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (183 lines) | stat: -rw-r--r-- 7,245 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_ASH_QUICK_ANSWERS_QUICK_ANSWERS_CONTROLLER_IMPL_H_
#define CHROME_BROWSER_UI_ASH_QUICK_ANSWERS_QUICK_ANSWERS_CONTROLLER_IMPL_H_

#include <memory>
#include <string>

#include "base/functional/callback_forward.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "base/time/time.h"
#include "chrome/browser/ui/ash/read_write_cards/read_write_card_controller.h"
#include "chrome/browser/ui/ash/read_write_cards/read_write_cards_ui_controller.h"
#include "chromeos/components/quick_answers/public/cpp/controller/quick_answers_controller.h"
#include "chromeos/components/quick_answers/public/cpp/quick_answers_state.h"
#include "chromeos/components/quick_answers/quick_answers_client.h"
#include "chromeos/components/quick_answers/quick_answers_model.h"
#include "ui/gfx/geometry/rect.h"

class ApplicationLocaleStorage;
class Profile;
class QuickAnswersUiController;

// Implementation of QuickAnswerController. It fetches quick answers
// result via QuickAnswersClient and manages quick answers UI.
class QuickAnswersControllerImpl : public chromeos::ReadWriteCardController,
                                   public QuickAnswersController,
                                   public quick_answers::QuickAnswersDelegate {
 public:
  using TimeTickNowFunction = base::RepeatingCallback<base::TimeTicks()>;

  // `application_locale_storage` must not be null and must outlive `this`.
  QuickAnswersControllerImpl(
      ApplicationLocaleStorage* application_locale_storage,
      chromeos::ReadWriteCardsUiController& read_write_cards_ui_controller);
  // `application_locale_storage` must not be null and must outlive `this`.
  QuickAnswersControllerImpl(
      ApplicationLocaleStorage* application_locale_storage,
      chromeos::ReadWriteCardsUiController& read_write_cards_ui_controller,
      std::unique_ptr<QuickAnswersState> quick_answers_state);
  QuickAnswersControllerImpl(const QuickAnswersControllerImpl&) = delete;
  QuickAnswersControllerImpl& operator=(const QuickAnswersControllerImpl&) =
      delete;
  ~QuickAnswersControllerImpl() override;

  // chromeos::ReadWriteCardController:
  void OnContextMenuShown(Profile* profile) override;
  void OnTextAvailable(const gfx::Rect& anchor_bounds,
                       const std::string& selected_text,
                       const std::string& surrounding_text) override;
  void OnAnchorBoundsChanged(const gfx::Rect& anchor_bounds) override;
  void OnDismiss(bool is_other_command_executed) override;

  // QuickAnswersController:
  // SetClient is required to be called before using these methods.
  // TODO(yanxiao): refactor to delegate to browser.
  void SetClient(
      std::unique_ptr<quick_answers::QuickAnswersClient> client) override;
  quick_answers::QuickAnswersClient* GetClient() const override;
  void DismissQuickAnswers(
      quick_answers::QuickAnswersExitPoint exit_point) override;
  quick_answers::QuickAnswersDelegate* GetQuickAnswersDelegate() override;

  QuickAnswersVisibility GetQuickAnswersVisibility() const override;
  void SetVisibility(QuickAnswersVisibility visibility) override;

  // QuickAnswersDelegate:
  void OnQuickAnswerReceived(std::unique_ptr<quick_answers::QuickAnswersSession>
                                 quick_answers_session) override;
  void OnNetworkError() override;
  void OnRequestPreprocessFinished(
      const quick_answers::QuickAnswersRequest& processed_request) override;

  // Retry sending quick answers request to backend.
  void OnRetryQuickAnswersRequest();

  // User clicks on the quick answer result.
  void OnQuickAnswersResultClick();

  // Handle user consent result.
  void OnUserConsentResult(bool consented);

  void OverrideTimeTickNowForTesting(
      TimeTickNowFunction time_tick_now_function);

  QuickAnswersUiController* quick_answers_ui_controller() {
    return quick_answers_ui_controller_.get();
  }

  // `quick_answers_session()` return non-nullptr if it has received a result,
  // including `kNoResult`. `quick_answer()` return non-nullptr if it has
  // received a result which is NOT `kNoResult`;
  quick_answers::QuickAnswersSession* quick_answers_session() {
    return quick_answers_session_.get();
  }

  quick_answers::QuickAnswer* quick_answer() {
    return quick_answers_session_ ? quick_answers_session_->quick_answer.get()
                                  : nullptr;
  }

  quick_answers::StructuredResult* structured_result() {
    return quick_answers_session_
               ? quick_answers_session_->structured_result.get()
               : nullptr;
  }

  chromeos::ReadWriteCardsUiController& read_write_cards_ui_controller() {
    return read_write_cards_ui_controller_.get();
  }

  base::WeakPtr<QuickAnswersControllerImpl> GetWeakPtr();

  const gfx::Rect& anchor_bounds() { return anchor_bounds_; }

 private:
  friend class QuickAnswersUiControllerTest;

  void HandleQuickAnswerRequest(
      const quick_answers::QuickAnswersRequest& request);

  // Returns true if a consent view has shown by a call. Otherwise returns
  // false.
  bool MaybeShowUserConsent(quick_answers::IntentType intent_type,
                            const std::u16string& intent_text);
  void OnUserConsent(ConsentResultType consent_result_type);

  base::TimeTicks GetTimeTicksNow();

  quick_answers::QuickAnswersRequest BuildRequest();

  // Profile that initiated the current query.
  raw_ptr<Profile> profile_ = nullptr;

  // Bounds of the anchor view.
  gfx::Rect anchor_bounds_;

  // Query used to retrieve quick answer.
  std::string query_;

  // Title to be shown on the QuickAnswers view.
  std::string title_;

  // Context information, including surrounding text and device properties.
  quick_answers::Context context_;

  // Time that the context menu is shown.
  base::TimeTicks menu_shown_time_;

  // Time that the consent ui is shown.
  base::TimeTicks consent_ui_shown_;

  // A fake time tick now function for testing. This must be null in production.
  TimeTickNowFunction time_tick_now_function_;

  std::unique_ptr<quick_answers::QuickAnswersClient> quick_answers_client_;

  std::unique_ptr<QuickAnswersState> quick_answers_state_;

  // The last received `QuickAnswersSession` from client.
  std::unique_ptr<quick_answers::QuickAnswersSession> quick_answers_session_;

  const raw_ref<chromeos::ReadWriteCardsUiController>
      read_write_cards_ui_controller_;

  // `quick_answers_ui_controller_` depends on `read_write_cards_ui_controller_`
  // via this controller. This has to be constructed-after and destructed-before
  // `read_write_cards_ui_controller_`.
  std::unique_ptr<QuickAnswersUiController> quick_answers_ui_controller_;

  QuickAnswersVisibility visibility_ = QuickAnswersVisibility::kClosed;

  // Use `std::unique_ptr` instead of `std::optional` as we can pass a class
  // defined in an unnamed namespace.
  std::unique_ptr<QuickAnswersStateObserver> perform_on_consent_accepted_;

  base::WeakPtrFactory<QuickAnswersControllerImpl> weak_factory_{this};
};

#endif  // CHROME_BROWSER_UI_ASH_QUICK_ANSWERS_QUICK_ANSWERS_CONTROLLER_IMPL_H_