chrome/browser/ui/webui/welcome/welcome_ui.cc

// Copyright 2016 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.

#include "chrome/browser/ui/webui/welcome/welcome_ui.h"

#include <memory>
#include <string>

#include "build/build_config.h"
#include "chrome/browser/favicon/favicon_service_factory.h"
#include "chrome/browser/signin/account_consistency_mode_manager.h"
#include "chrome/browser/ui/webui/welcome/nux_helper.h"
#include "chrome/browser/ui/webui/welcome/welcome_handler.h"
#include "chrome/common/pref_names.h"
#include "chrome/grit/browser_resources.h"
#include "chrome/grit/chrome_unscaled_resources.h"
#include "chrome/grit/chromium_strings.h"
#include "chrome/grit/generated_resources.h"
#include "components/prefs/pref_service.h"
#include "content/public/browser/web_ui_data_source.h"
#include "net/base/url_util.h"
#include "ui/base/l10n/l10n_util.h"

#if defined(OS_WIN) && defined(GOOGLE_CHROME_BUILD)
#include "base/metrics/histogram_macros.h"
#include "chrome/browser/bookmarks/bookmark_model_factory.h"
#include "components/nux/constants.h"
#include "components/nux/email/email_handler.h"
#include "components/nux/google_apps/google_apps_handler.h"
#include "components/nux/set_as_default/set_as_default_handler.h"
#include "components/nux/show_promo_delegate.h"
#include "content/public/browser/web_contents.h"
#endif  // defined(OS_WIN) && defined(GOOGLE_CHROME_BUILD)

namespace {
const bool kIsBranded =
#if defined(GOOGLE_CHROME_BUILD)
    true;
#else
    false;
#endif
}  // namespace

WelcomeUI::WelcomeUI(content::WebUI* web_ui, const GURL& url)
    : content::WebUIController(web_ui) {
  Profile* profile = Profile::FromWebUI(web_ui);

  // This page is not shown to incognito or guest profiles. If one should end up
  // here, we return, causing a 404-like page.
  if (!profile ||
      profile->GetProfileType() != Profile::ProfileType::REGULAR_PROFILE) {
    return;
  }

  StorePageSeen(profile, url);

  web_ui->AddMessageHandler(std::make_unique<WelcomeHandler>(web_ui));

  content::WebUIDataSource* html_source =
      content::WebUIDataSource::Create(url.host());

  bool is_dice =
      AccountConsistencyModeManager::IsDiceEnabledForProfile(profile);

  // There are multiple possible configurations that affects the layout, but
  // first add resources that are shared across all layouts.
  html_source->AddLocalizedString("acceptText", IDS_WELCOME_ACCEPT_BUTTON);
  html_source->AddResourcePath("logo.png", IDR_PRODUCT_LOGO_128);
  html_source->AddResourcePath("logo2x.png", IDR_PRODUCT_LOGO_256);

  if (nux::IsNuxOnboardingEnabled()) {
    // Add Onboarding welcome strings.
    html_source->AddLocalizedString("headerText", IDS_WELCOME_HEADER);

    // Add onboarding welcome resources.
    html_source->SetDefaultResource(
        IDR_WELCOME_ONBOARDING_WELCOME_WELCOME_HTML);
    html_source->AddResourcePath(
        "landing_view.html", IDR_WELCOME_ONBOARDING_WELCOME_LANDING_VIEW_HTML);
    html_source->AddResourcePath(
        "landing_view.js", IDR_WELCOME_ONBOARDING_WELCOME_LANDING_VIEW_JS);
    html_source->AddResourcePath(
        "navigation_behavior.html",
        IDR_WELCOME_ONBOARDING_WELCOME_NAVIGATION_BEHAVIOR_HTML);
    html_source->AddResourcePath(
        "navigation_behavior.js",
        IDR_WELCOME_ONBOARDING_WELCOME_NAVIGATION_BEHAVIOR_JS);
    html_source->AddResourcePath("welcome.css",
                                 IDR_WELCOME_ONBOARDING_WELCOME_WELCOME_CSS);
    html_source->AddResourcePath(
        "welcome_app.html", IDR_WELCOME_ONBOARDING_WELCOME_WELCOME_APP_HTML);
    html_source->AddResourcePath("welcome_app.js",
                                 IDR_WELCOME_ONBOARDING_WELCOME_WELCOME_APP_JS);
    html_source->AddResourcePath(
        "welcome_browser_proxy.html",
        IDR_WELCOME_ONBOARDING_WELCOME_WELCOME_BROWSER_PROXY_HTML);
    html_source->AddResourcePath(
        "welcome_browser_proxy.js",
        IDR_WELCOME_ONBOARDING_WELCOME_WELCOME_BROWSER_PROXY_JS);
  } else if (kIsBranded && is_dice) {
    // Use special layout if the application is branded and DICE is enabled.
    // Otherwise use the default layout.
    html_source->AddLocalizedString("headerText", IDS_WELCOME_HEADER);
    html_source->AddLocalizedString("secondHeaderText",
                                    IDS_DICE_WELCOME_SECOND_HEADER);
    html_source->AddLocalizedString("descriptionText",
                                    IDS_DICE_WELCOME_DESCRIPTION);
    html_source->AddLocalizedString("declineText",
                                    IDS_DICE_WELCOME_DECLINE_BUTTON);
    html_source->AddResourcePath("welcome_browser_proxy.html",
                                 IDR_DICE_WELCOME_BROWSER_PROXY_HTML);
    html_source->AddResourcePath("welcome_browser_proxy.js",
                                 IDR_DICE_WELCOME_BROWSER_PROXY_JS);
    html_source->AddResourcePath("welcome_app.html", IDR_DICE_WELCOME_APP_HTML);
    html_source->AddResourcePath("welcome_app.js", IDR_DICE_WELCOME_APP_JS);
    html_source->AddResourcePath("welcome.css", IDR_DICE_WELCOME_CSS);
    html_source->SetDefaultResource(IDR_DICE_WELCOME_HTML);
  } else {
    // Use default layout for non-DICE or unbranded build.
    std::string value;
    bool is_everywhere_variant =
        (net::GetValueForKeyInQuery(url, "variant", &value) &&
         value == "everywhere");

    if (kIsBranded) {
      base::string16 subheader =
          is_everywhere_variant
              ? base::string16()
              : l10n_util::GetStringUTF16(IDS_WELCOME_SUBHEADER);
      html_source->AddString("subheaderText", subheader);
    }

    int header_id = is_everywhere_variant ? IDS_WELCOME_HEADER_AFTER_FIRST_RUN
                                          : IDS_WELCOME_HEADER;
    html_source->AddString("headerText", l10n_util::GetStringUTF16(header_id));
    html_source->AddLocalizedString("descriptionText", IDS_WELCOME_DESCRIPTION);
    html_source->AddLocalizedString("declineText", IDS_WELCOME_DECLINE_BUTTON);
    html_source->AddResourcePath("welcome.js", IDR_WELCOME_JS);
    html_source->AddResourcePath("welcome.css", IDR_WELCOME_CSS);
    html_source->SetDefaultResource(IDR_WELCOME_HTML);
  }

#if defined(OS_WIN) && defined(GOOGLE_CHROME_BUILD)
  if (base::FeatureList::IsEnabled(nux::kNuxOnboardingFeature)) {
    web_ui->AddMessageHandler(std::make_unique<nux::SetAsDefaultHandler>());
    nux::SetAsDefaultHandler::AddSources(html_source);

    // TODO(scottchen): move all NUX features under this flag once individual
    // experiments launch.
  }

  // To avoid diluting data collection, existing users should not be assigned
  // an NUX group. So, the kOnboardDuringNUX flag is used to short-circuit the
  // feature checks below.
  PrefService* prefs = profile->GetPrefs();
  bool onboard_during_nux =
      prefs && prefs->GetBoolean(prefs::kOnboardDuringNUX);

  if (onboard_during_nux &&
      base::FeatureList::IsEnabled(nux::kNuxEmailFeature)) {
    web_ui->AddMessageHandler(std::make_unique<nux::EmailHandler>(
        profile->GetPrefs(), FaviconServiceFactory::GetForProfile(
                                 profile, ServiceAccessType::EXPLICIT_ACCESS)));

    nux::EmailHandler::AddSources(html_source, profile->GetPrefs());
  }

  if (onboard_during_nux &&
      base::FeatureList::IsEnabled(nux::kNuxGoogleAppsFeature)) {
    content::BrowserContext* browser_context =
        web_ui->GetWebContents()->GetBrowserContext();
    web_ui->AddMessageHandler(std::make_unique<nux::GoogleAppsHandler>(
        profile->GetPrefs(),
        FaviconServiceFactory::GetForProfile(
            profile, ServiceAccessType::EXPLICIT_ACCESS),
        BookmarkModelFactory::GetForBrowserContext(browser_context)));

    nux::GoogleAppsHandler::AddSources(html_source);
  }
#endif  // defined(OS_WIN) && defined(GOOGLE_CHROME_BUILD

  content::WebUIDataSource::Add(profile, html_source);
}

WelcomeUI::~WelcomeUI() {}

void WelcomeUI::StorePageSeen(Profile* profile, const GURL& url) {
#if defined(OS_WIN) && defined(GOOGLE_CHROME_BUILD)
  if (url.EqualsIgnoringRef(GURL(nux::kNuxGoogleAppsUrl))) {
    // Record that the new user experience page was visited.
    profile->GetPrefs()->SetBoolean(prefs::kHasSeenGoogleAppsPromoPage, true);

    // Record UMA.
    UMA_HISTOGRAM_ENUMERATION(nux::kGoogleAppsInteractionHistogram,
                              nux::GoogleAppsInteraction::kPromptShown,
                              nux::GoogleAppsInteraction::kCount);
    return;
  }

  if (url.EqualsIgnoringRef(GURL(nux::kNuxEmailUrl))) {
    // Record that the new user experience page was visited.
    profile->GetPrefs()->SetBoolean(prefs::kHasSeenEmailPromoPage, true);

    // TODO(scottchen): Record UMA.

    return;
  }
#endif  // defined(OS_WIN) && defined(GOOGLE_CHROME_BUILD)

  // Store that this profile has been shown the Welcome page.
  profile->GetPrefs()->SetBoolean(prefs::kHasSeenWelcomePage, true);
}