chrome/browser/android/autofill_assistant/interaction_handler_android.h

// Copyright 2019 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_ANDROID_AUTOFILL_ASSISTANT_INTERACTION_HANDLER_ANDROID_H_
#define CHROME_BROWSER_ANDROID_AUTOFILL_ASSISTANT_INTERACTION_HANDLER_ANDROID_H_

#include <map>
#include <string>
#include <vector>

#include "base/android/jni_android.h"
#include "base/android/scoped_java_ref.h"
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "components/autofill_assistant/browser/event_handler.h"
#include "components/autofill_assistant/browser/service.pb.h"

namespace autofill_assistant {
class BasicInteractions;
class GenericUiControllerAndroid;
class UserModel;

// Receives incoming events and runs the corresponding set of callbacks.
//
// - It is NOT safe to register new interactions while listening to events!
// - This class is NOT thread-safe!
// - The lifetimes of instances should be tied to the existence of a particular
// UI.
class InteractionHandlerAndroid : public EventHandler::Observer {
 public:
  using InteractionCallback = base::RepeatingCallback<void()>;

  // Constructor. |event_handler|, |user_model|, |basic_interactions|,
  // |views|, |jcontext| and |jdelegate| must outlive this instance.
  InteractionHandlerAndroid(
      EventHandler* event_handler,
      UserModel* user_model,
      BasicInteractions* basic_interactions,
      std::map<std::string, base::android::ScopedJavaGlobalRef<jobject>>* views,
      base::android::ScopedJavaGlobalRef<jobject> jcontext,
      base::android::ScopedJavaGlobalRef<jobject> jdelegate);
  ~InteractionHandlerAndroid() override;

  base::WeakPtr<InteractionHandlerAndroid> GetWeakPtr();

  void StartListening();
  void StopListening();

  // Access to the user model that this interaction handler is bound to.
  UserModel* GetUserModel() const;

  // Access to the basic interactions that this interaction handler is bound to.
  BasicInteractions* GetBasicInteractions() const;

  // Creates interaction callbacks as specified by |proto|. Returns false if
  // |proto| is invalid.
  bool AddInteractionsFromProto(const InteractionProto& proto);

  // Adds a single interaction. This can be used to add internal interactions
  // which are not exposed in the proto interface.
  void AddInteraction(const EventHandler::EventKey& key,
                      const InteractionCallback& callback);

  // Overrides autofill_assistant::EventHandler::Observer.
  void OnEvent(const EventHandler::EventKey& key) override;

  // Adds |model_identifier| to the list of model identifiers belonging to
  // |radio_group|.
  void AddRadioButtonToGroup(const std::string& radio_group,
                             const std::string& model_identifier);

  // Ensures that only |selected_model_identifier| is set to true in
  // |radio_group|.
  void UpdateRadioButtonGroup(const std::string& radio_group,
                              const std::string& selected_model_identifier);

 private:
  base::Optional<InteractionCallback> CreateInteractionCallbackFromProto(
      const CallbackProto& proto);

  // Deletes the nested ui controller associated with |identifier|.
  void DeleteNestedUi(const std::string& identifier);

  // Attempts to inflate |proto|. If successful, the new controller is added
  // to the list of managed nested controllers. Note that *this keeps ownership
  // of created nested UIs!
  const GenericUiControllerAndroid* CreateNestedUi(
      const GenericUserInterfaceProto& proto,
      const std::string& identifier);

  void CreateAndShowGenericPopup(const ShowGenericUiPopupProto& proto);

  // Maps event keys to the corresponding list of callbacks to execute.
  std::map<EventHandler::EventKey, std::vector<InteractionCallback>>
      interactions_;

  EventHandler* event_handler_ = nullptr;
  UserModel* user_model_ = nullptr;
  BasicInteractions* basic_interactions_ = nullptr;
  std::map<std::string, base::android::ScopedJavaGlobalRef<jobject>>* views_;
  base::android::ScopedJavaGlobalRef<jobject> jcontext_ = nullptr;
  base::android::ScopedJavaGlobalRef<jobject> jdelegate_ = nullptr;
  bool is_listening_ = false;

  // TODO(b/154811503): move radio_groups_ and nested_ui_controllers_ to
  // generic_ui_controller_android.
  // Maps radiogroup identifiers to the list of corresponding model identifiers.
  std::map<std::string, std::vector<std::string>> radio_groups_;
  // Maps nested-ui identifiers to their instances.
  std::map<std::string, std::unique_ptr<GenericUiControllerAndroid>>
      nested_ui_controllers_;

  base::WeakPtrFactory<InteractionHandlerAndroid> weak_ptr_factory_{this};
  DISALLOW_COPY_AND_ASSIGN(InteractionHandlerAndroid);
};

}  //  namespace autofill_assistant

#endif  //  CHROME_BROWSER_ANDROID_AUTOFILL_ASSISTANT_INTERACTION_HANDLER_ANDROID_H_