infobar_badge_tab_helper.mm | Explore in Territory

// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#import "ios/chrome/browser/infobars/model/infobar_badge_tab_helper.h"

#import "base/containers/contains.h"
#import "base/ranges/algorithm.h"
#import "ios/chrome/browser/infobars/model/infobar_badge_tab_helper_delegate.h"
#import "ios/chrome/browser/infobars/model/infobar_badge_tab_helper_observer.h"
#import "ios/chrome/browser/infobars/model/infobar_manager_impl.h"

namespace {
// Returns `infobar`'s InfobarType.
InfobarType GetInfobarType(infobars::InfoBar* infobar) {
  return static_cast<InfoBarIOS*>(infobar)->infobar_type();
}
}  // namespace

#pragma mark - InfobarBadgeTabHelper

WEB_STATE_USER_DATA_KEY_IMPL(InfobarBadgeTabHelper)

InfobarBadgeTabHelper::InfobarBadgeTabHelper(web::WebState* web_state)
    : infobar_accept_observer_(this),
      infobar_manager_observer_(this, web_state, &infobar_accept_observer_),
      web_state_(web_state) {}

InfobarBadgeTabHelper::~InfobarBadgeTabHelper() = default;

#pragma mark Public

void InfobarBadgeTabHelper::AddObserver(
    InfobarBadgeTabHelperObserver* observer) {
  badge_updates_observers_.AddObserver(observer);
}

void InfobarBadgeTabHelper::RemoveObserver(
    InfobarBadgeTabHelperObserver* observer) {
  badge_updates_observers_.RemoveObserver(observer);
}

void InfobarBadgeTabHelper::SetDelegate(
    id<InfobarBadgeTabHelperDelegate> delegate) {
  delegate_ = delegate;
  if (delegate_ == nil) {
    return;
  }
  // Prerendering complete; register infobars using delegate.
  for (size_t index = 0; index < infobars_added_when_prerendering_.size();
       ++index) {
    RegisterInfobar(infobars_added_when_prerendering_.at(index));
  }
  infobars_added_when_prerendering_.clear();
  UpdateBadgesShown();
}

void InfobarBadgeTabHelper::UpdateBadgeForInfobarAccepted(
    InfobarType infobar_type) {
  OnInfobarAcceptanceStateChanged(infobar_type, /*accepted=*/true);
}

void InfobarBadgeTabHelper::UpdateBadgeForInfobarReverted(
    InfobarType infobar_type) {
  OnInfobarAcceptanceStateChanged(infobar_type, /*accepted=*/false);
}

void InfobarBadgeTabHelper::UpdateBadgeForInfobarRead(
    InfobarType infobar_type) {
  if (!base::Contains(infobar_badge_states_, infobar_type)) {
    return;
  }
  infobar_badge_states_[infobar_type] |= BadgeStateRead;
}

void InfobarBadgeTabHelper::UpdateBadgeForInfobarBannerPresented(
    InfobarType infobar_type) {
  if (!base::Contains(infobar_badge_states_, infobar_type)) {
    return;
  }
  infobar_badge_states_[infobar_type] |= BadgeStatePresented;
  UpdateBadgesShown();
}

void InfobarBadgeTabHelper::UpdateBadgeForInfobarBannerDismissed(
    InfobarType infobar_type) {
  if (!base::Contains(infobar_badge_states_, infobar_type)) {
    return;
  }
  infobar_badge_states_[infobar_type] &= ~BadgeStatePresented;
  UpdateBadgesShown();
}

std::map<InfobarType, BadgeState> InfobarBadgeTabHelper::GetInfobarBadgeStates()
    const {
  return infobar_badge_states_;
}

size_t InfobarBadgeTabHelper::GetInfobarBadgesCount() {
  return infobar_badge_states_.size();
}

#pragma mark Private

void InfobarBadgeTabHelper::RegisterInfobar(infobars::InfoBar* infobar) {
  // Handling the case where an infobar is added during prerendering.
  if (!delegate_) {
    infobars_added_when_prerendering_.push_back(infobar);
    return;
  }
  // All other cases.
  InfobarType infobar_type = GetInfobarType(infobar);
  if ([delegate_ badgeSupportedForInfobarType:infobar_type]) {
    infobar_badge_states_[infobar_type] = BadgeStateNone;
    infobar_accept_observer_.scoped_observations().AddObservation(
        static_cast<InfoBarIOS*>(infobar));
  }
}

void InfobarBadgeTabHelper::UnregisterInfobar(infobars::InfoBar* infobar) {
  // Handling the case where an infobar is removed during prerendering.
  if (!delegate_) {
    auto pos = base::ranges::find(infobars_added_when_prerendering_, infobar);
    if (pos != infobars_added_when_prerendering_.end())
      infobars_added_when_prerendering_.erase(pos);
    return;
  }
  // All other cases.
  InfobarType infobar_type = GetInfobarType(infobar);
  if ([delegate_ badgeSupportedForInfobarType:infobar_type]) {
    infobar_badge_states_.erase(infobar_type);
    base::ScopedMultiSourceObservation<InfoBarIOS, InfoBarIOS::Observer>&
        infobar_accept_observations =
            infobar_accept_observer_.scoped_observations();
    InfoBarIOS* infobar_ios = static_cast<InfoBarIOS*>(infobar);
    // TODO(crbug.com/330899285): Fix the root cause of infobar not being
    // observed, and remove the `else` condition.
    if (infobar_accept_observations.IsObservingSource(infobar_ios)) {
      infobar_accept_observations.RemoveObservation(infobar_ios);
    } else {
      DUMP_WILL_BE_NOTREACHED()
          << "cannot find observed infobar with type: "
          << static_cast<int>(infobar_ios->infobar_type());
    }
  }
}

void InfobarBadgeTabHelper::OnInfobarAcceptanceStateChanged(
    InfobarType infobar_type,
    bool accepted) {
  if (!base::Contains(infobar_badge_states_, infobar_type)) {
    return;
  }
  if (accepted) {
    infobar_badge_states_[infobar_type] |= BadgeStateAccepted | BadgeStateRead;
  } else {
    infobar_badge_states_[infobar_type] &= ~BadgeStateAccepted;
  }
  UpdateBadgesShown();
}

void InfobarBadgeTabHelper::UpdateBadgesShown() {
  [delegate_ updateBadgesShownForWebState:web_state_];

  // Notify all badge update observers.
  for (auto& observer : badge_updates_observers_) {
    observer.InfobarBadgesUpdated(this);
  }
}

#pragma mark - InfobarBadgeTabHelper::InfobarAcceptanceObserver

InfobarBadgeTabHelper::InfobarAcceptanceObserver::InfobarAcceptanceObserver(
    InfobarBadgeTabHelper* tab_helper)
    : tab_helper_(tab_helper) {
  DCHECK(tab_helper_);
}

InfobarBadgeTabHelper::InfobarAcceptanceObserver::~InfobarAcceptanceObserver() =
    default;

void InfobarBadgeTabHelper::InfobarAcceptanceObserver::DidUpdateAcceptedState(
    InfoBarIOS* infobar) {
  tab_helper_->OnInfobarAcceptanceStateChanged(GetInfobarType(infobar),
                                               infobar->accepted());
}

void InfobarBadgeTabHelper::InfobarAcceptanceObserver::InfobarDestroyed(
    InfoBarIOS* infobar) {
  InfoBarIOS* infobar_ios = static_cast<InfoBarIOS*>(infobar);
  // TODO(crbug.com/330899285): Fix the root cause of infobar not being
  // observed, and remove the `else` condition.
  if (scoped_observations_.IsObservingSource(infobar_ios)) {
    scoped_observations_.RemoveObservation(infobar_ios);
  } else {
    DUMP_WILL_BE_NOTREACHED() << "cannot find observed infobar with type: "
                              << static_cast<int>(infobar_ios->infobar_type());
  }
}

#pragma mark - InfobarBadgeTabHelper::InfobarManagerObserver

InfobarBadgeTabHelper::InfobarManagerObserver::InfobarManagerObserver(
    InfobarBadgeTabHelper* tab_helper,
    web::WebState* web_state,
    InfobarAcceptanceObserver* infobar_accept_observer)
    : tab_helper_(tab_helper),
      infobar_accept_observer_(infobar_accept_observer) {
  DCHECK(tab_helper_);
  DCHECK(infobar_accept_observer_);
  scoped_observation_.Observe(InfoBarManagerImpl::FromWebState(web_state));
}

InfobarBadgeTabHelper::InfobarManagerObserver::~InfobarManagerObserver() =
    default;

void InfobarBadgeTabHelper::InfobarManagerObserver::OnInfoBarAdded(
    infobars::InfoBar* infobar) {
  tab_helper_->RegisterInfobar(infobar);
  tab_helper_->UpdateBadgesShown();
}

void InfobarBadgeTabHelper::InfobarManagerObserver::OnInfoBarRemoved(
    infobars::InfoBar* infobar,
    bool animate) {
  tab_helper_->UnregisterInfobar(infobar);
  tab_helper_->UpdateBadgesShown();
}

void InfobarBadgeTabHelper::InfobarManagerObserver::OnInfoBarReplaced(
    infobars::InfoBar* old_infobar,
    infobars::InfoBar* new_infobar) {
  // New permission infobar in the same tab should keep preserving previous
  // states.
  if (tab_helper_->delegate_ &&
      GetInfobarType(old_infobar) == InfobarType::kInfobarTypePermissions &&
      GetInfobarType(new_infobar) == InfobarType::kInfobarTypePermissions) {
    base::ScopedMultiSourceObservation<InfoBarIOS, InfoBarIOS::Observer>&
        infobar_accept_observations =
            infobar_accept_observer_->scoped_observations();
    InfoBarIOS* old_infobar_ios = static_cast<InfoBarIOS*>(old_infobar);
    // TODO(crbug.com/330899285): Fix the root cause of infobar not being
    // observed, and remove the `else` condition.
    if (infobar_accept_observations.IsObservingSource(old_infobar_ios)) {
      infobar_accept_observations.RemoveObservation(old_infobar_ios);
    } else {
      DUMP_WILL_BE_NOTREACHED();
    }
    infobar_accept_observations.AddObservation(
        static_cast<InfoBarIOS*>(new_infobar));
    return;
  }
  OnInfoBarRemoved(old_infobar, /*animate=*/false);
  OnInfoBarAdded(new_infobar);
}

void InfobarBadgeTabHelper::InfobarManagerObserver::OnManagerShuttingDown(
    infobars::InfoBarManager* manager) {
  DCHECK(scoped_observation_.IsObservingSource(manager));
  scoped_observation_.Reset();
}
chromium/ios/chrome/browser/infobars/model/infobar_badge_tab_helper.mm
