chrome/browser/resources/settings/route.ts

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

import {assert} from 'chrome://resources/js/assert.js';

import {loadTimeData} from './i18n_setup.js';
import {pageVisibility} from './page_visibility.js';
import type {SettingsRoutes} from './router.js';
import {Route, Router} from './router.js';

/**
 * Add all of the child routes that originate from the privacy route,
 * regardless of whether the privacy section under basic or advanced.
 */
function addPrivacyChildRoutes(r: Partial<SettingsRoutes>) {
  assert(r.PRIVACY);
  r.CLEAR_BROWSER_DATA = r.PRIVACY.createChild('/clearBrowserData');
  r.CLEAR_BROWSER_DATA.isNavigableDialog = true;

  const visibility = pageVisibility || {};

  if (visibility.safetyHub !== false) {
    r.SAFETY_HUB = r.PRIVACY.createChild('/safetyCheck');
    r.SAFETY_HUB.hasMigratedToPlugin = true;
  }

  if (loadTimeData.getBoolean('showPrivacyGuide')) {
    r.PRIVACY_GUIDE = r.PRIVACY.createChild('guide');
  }
  r.SITE_SETTINGS = r.PRIVACY.createChild('/content');
  r.SITE_SETTINGS.hasMigratedToPlugin = true;
  r.SECURITY = r.PRIVACY.createChild('/security');

  r.COOKIES = r.PRIVACY.createChild('/cookies');
  r.COOKIES.hasMigratedToPlugin = true;
  if (loadTimeData.getBoolean('enableIncognitoTrackingProtections') ) {
    r.INCOGNITO_TRACKING_PROTECTIONS = r.PRIVACY.createChild('/incognito');
    r.INCOGNITO_TRACKING_PROTECTIONS.hasMigratedToPlugin = true;
  }

  if (!loadTimeData.getBoolean('isPrivacySandboxRestricted')) {
    r.PRIVACY_SANDBOX = r.PRIVACY.createChild('/adPrivacy');
    r.PRIVACY_SANDBOX.hasMigratedToPlugin = true;
    r.PRIVACY_SANDBOX_TOPICS =
        r.PRIVACY_SANDBOX.createChild('/adPrivacy/interests');
    r.PRIVACY_SANDBOX_TOPICS.hasMigratedToPlugin = true;
    r.PRIVACY_SANDBOX_MANAGE_TOPICS =
        r.PRIVACY_SANDBOX_TOPICS.createChild('/adPrivacy/interests/manage');
    r.PRIVACY_SANDBOX_MANAGE_TOPICS.hasMigratedToPlugin = true;
    r.PRIVACY_SANDBOX_FLEDGE =
        r.PRIVACY_SANDBOX.createChild('/adPrivacy/sites');
    r.PRIVACY_SANDBOX_FLEDGE.hasMigratedToPlugin = true;
    r.PRIVACY_SANDBOX_AD_MEASUREMENT =
        r.PRIVACY_SANDBOX.createChild('/adPrivacy/measurement');
    r.PRIVACY_SANDBOX_AD_MEASUREMENT.hasMigratedToPlugin = true;
  } else if (loadTimeData.getBoolean(
                 'isPrivacySandboxRestrictedNoticeEnabled')) {
    r.PRIVACY_SANDBOX = r.PRIVACY.createChild('/adPrivacy');
    r.PRIVACY_SANDBOX.hasMigratedToPlugin = true;
    // When the view is restricted, but the notice is configured to show, allow
    // measurement settings only.
    r.PRIVACY_SANDBOX_AD_MEASUREMENT =
        r.PRIVACY_SANDBOX.createChild('/adPrivacy/measurement');
    r.PRIVACY_SANDBOX_AD_MEASUREMENT.hasMigratedToPlugin = true;
  }

  if (loadTimeData.getBoolean('enableSecurityKeysSubpage')) {
    r.SECURITY_KEYS = r.SECURITY.createChild('/securityKeys');
    r.SECURITY_KEYS.hasMigratedToPlugin = true;
  }

  r.SITE_SETTINGS_ALL = r.SITE_SETTINGS.createChild('all');
  r.SITE_SETTINGS_SITE_DETAILS =
      r.SITE_SETTINGS_ALL.createChild('/content/siteDetails');

  r.SITE_SETTINGS_HANDLERS = r.SITE_SETTINGS.createChild('/handlers');
  r.SITE_SETTINGS_HANDLERS.hasMigratedToPlugin = true;

  // TODO(tommycli): Find a way to refactor these repetitive category
  // routes.
  r.SITE_SETTINGS_ADS = r.SITE_SETTINGS.createChild('ads');
  r.SITE_SETTINGS_AR = r.SITE_SETTINGS.createChild('ar');
  r.SITE_SETTINGS_AUTOMATIC_DOWNLOADS =
      r.SITE_SETTINGS.createChild('automaticDownloads');
  if (loadTimeData.getBoolean('autoPictureInPictureEnabled')) {
    r.SITE_SETTINGS_AUTO_PICTURE_IN_PICTURE =
        r.SITE_SETTINGS.createChild('autoPictureInPicture');
  }
  if (loadTimeData.getBoolean('capturedSurfaceControlEnabled')) {
    r.SITE_SETTINGS_CAPTURED_SURFACE_CONTROL =
        r.SITE_SETTINGS.createChild('capturedSurfaceControl');
  }
  // <if expr="is_chromeos">
  if (loadTimeData.getBoolean('enableSmartCardReadersContentSetting')) {
    r.SITE_SETTINGS_SMART_CARD_READERS =
        r.SITE_SETTINGS.createChild('smartCardReaders');
  }
  // </if>
  r.SITE_SETTINGS_AUTO_VERIFY = r.SITE_SETTINGS.createChild('autoVerify');
  r.SITE_SETTINGS_BACKGROUND_SYNC =
      r.SITE_SETTINGS.createChild('backgroundSync');
  r.SITE_SETTINGS_CAMERA = r.SITE_SETTINGS.createChild('camera');
  r.SITE_SETTINGS_CLIPBOARD = r.SITE_SETTINGS.createChild('clipboard');
  if (loadTimeData.getBoolean('enableHandTrackingContentSetting')) {
    r.SITE_SETTINGS_HAND_TRACKING = r.SITE_SETTINGS.createChild('handTracking');
  }
  r.SITE_SETTINGS_IDLE_DETECTION = r.SITE_SETTINGS.createChild('idleDetection');
  r.SITE_SETTINGS_IMAGES = r.SITE_SETTINGS.createChild('images');
  r.SITE_SETTINGS_MIXEDSCRIPT = r.SITE_SETTINGS.createChild('insecureContent');
  r.SITE_SETTINGS_JAVASCRIPT = r.SITE_SETTINGS.createChild('javascript');
  r.SITE_SETTINGS_JAVASCRIPT_OPTIMIZER = r.SITE_SETTINGS.createChild('v8');
  if (loadTimeData.getBoolean('enableKeyboardLockPrompt')) {
    r.SITE_SETTINGS_KEYBOARD_LOCK = r.SITE_SETTINGS.createChild('keyboardLock');
    r.SITE_SETTINGS_KEYBOARD_LOCK.hasMigratedToPlugin = true;
  }
  r.SITE_SETTINGS_SOUND = r.SITE_SETTINGS.createChild('sound');
  r.SITE_SETTINGS_SENSORS = r.SITE_SETTINGS.createChild('sensors');
  r.SITE_SETTINGS_LOCATION = r.SITE_SETTINGS.createChild('location');
  r.SITE_SETTINGS_LOCATION.hasMigratedToPlugin = true;
  r.SITE_SETTINGS_MICROPHONE = r.SITE_SETTINGS.createChild('microphone');
  r.SITE_SETTINGS_NOTIFICATIONS = r.SITE_SETTINGS.createChild('notifications');
  r.SITE_SETTINGS_NOTIFICATIONS.hasMigratedToPlugin = true;
  r.SITE_SETTINGS_POPUPS = r.SITE_SETTINGS.createChild('popups');
  r.SITE_SETTINGS_MIDI_DEVICES = r.SITE_SETTINGS.createChild('midiDevices');
  r.SITE_SETTINGS_USB_DEVICES = r.SITE_SETTINGS.createChild('usbDevices');
  r.SITE_SETTINGS_HID_DEVICES = r.SITE_SETTINGS.createChild('hidDevices');
  r.SITE_SETTINGS_SERIAL_PORTS = r.SITE_SETTINGS.createChild('serialPorts');
  if (loadTimeData.getBoolean('enableWebPrintingContentSetting')) {
    r.SITE_SETTINGS_WEB_PRINTING = r.SITE_SETTINGS.createChild('webPrinting');
  }
  if (loadTimeData.getBoolean('enableWebBluetoothNewPermissionsBackend')) {
    r.SITE_SETTINGS_BLUETOOTH_DEVICES =
        r.SITE_SETTINGS.createChild('bluetoothDevices');
  }
  r.SITE_SETTINGS_ZOOM_LEVELS = r.SITE_SETTINGS.createChild('zoomLevels');
  r.SITE_SETTINGS_ZOOM_LEVELS.hasMigratedToPlugin = true;
  r.SITE_SETTINGS_PDF_DOCUMENTS = r.SITE_SETTINGS.createChild('pdfDocuments');
  r.SITE_SETTINGS_PDF_DOCUMENTS.hasMigratedToPlugin = true;
  r.SITE_SETTINGS_PROTECTED_CONTENT =
      r.SITE_SETTINGS.createChild('protectedContent');
  if (loadTimeData.getBoolean('enablePaymentHandlerContentSetting')) {
    r.SITE_SETTINGS_PAYMENT_HANDLER =
        r.SITE_SETTINGS.createChild('paymentHandler');
  }
  if (loadTimeData.getBoolean('enableFederatedIdentityApiContentSetting')) {
    r.SITE_SETTINGS_FEDERATED_IDENTITY_API =
        r.SITE_SETTINGS.createChild('federatedIdentityApi');
  }
  r.SITE_SETTINGS_SITE_DATA = r.SITE_SETTINGS.createChild('siteData');
  r.SITE_SETTINGS_SITE_DATA.hasMigratedToPlugin = true;
  r.SITE_SETTINGS_VR = r.SITE_SETTINGS.createChild('vr');
  if (loadTimeData.getBoolean('enableExperimentalWebPlatformFeatures')) {
    r.SITE_SETTINGS_BLUETOOTH_SCANNING =
        r.SITE_SETTINGS.createChild('bluetoothScanning');
  }

  r.SITE_SETTINGS_WINDOW_MANAGEMENT =
      r.SITE_SETTINGS.createChild('windowManagement');
  r.SITE_SETTINGS_FILE_SYSTEM_WRITE = r.SITE_SETTINGS.createChild('filesystem');
  r.SITE_SETTINGS_FILE_SYSTEM_WRITE_DETAILS =
      r.SITE_SETTINGS_FILE_SYSTEM_WRITE.createChild('siteDetails');
  r.SITE_SETTINGS_LOCAL_FONTS = r.SITE_SETTINGS.createChild('localFonts');
  r.SITE_SETTINGS_STORAGE_ACCESS = r.SITE_SETTINGS.createChild('storageAccess');
  r.SITE_SETTINGS_AUTOMATIC_FULLSCREEN =
      r.SITE_SETTINGS.createChild('automaticFullScreen');
  r.SITE_SETTINGS_AUTOMATIC_FULLSCREEN.hasMigratedToPlugin = true;
  if (loadTimeData.getBoolean('enableWebAppInstallation')) {
    r.SITE_SETTINGS_WEB_APP_INSTALLATION =
        r.SITE_SETTINGS.createChild('webApplications');
    r.SITE_SETTINGS_WEB_APP_INSTALLATION.hasMigratedToPlugin = true;
  }
  if (loadTimeData.getBoolean('enableLocalNetworkAccessSetting')) {
    r.SITE_SETTINGS_LOCAL_NETWORK_ACCESS =
        r.SITE_SETTINGS.createChild('localNetworkAccess');
    r.SITE_SETTINGS_LOCAL_NETWORK_ACCESS.hasMigratedToPlugin = true;
  }
}

/**
 * Adds Route objects for each path.
 */
function createRoutes(): SettingsRoutes {
  const r: Partial<SettingsRoutes> = {};

  // Root page.
  r.BASIC = new Route('/');

  r.ABOUT = r.BASIC.createSection(
      '/help', 'about', loadTimeData.getString('aboutPageTitle'));
  r.ABOUT.hasMigratedToPlugin = true;

  // Search page.
  r.SEARCH = r.BASIC.createSection(
      '/search', 'search', loadTimeData.getString('searchPageTitle'));
  r.SEARCH.hasMigratedToPlugin = true;
  r.SEARCH_ENGINES = r.SEARCH.createChild('/searchEngines');
  r.SEARCH_ENGINES.hasMigratedToPlugin = true;

  const visibility = pageVisibility || {};

  if (visibility.people !== false) {
    r.PEOPLE = r.BASIC.createSection(
        '/people', 'people', loadTimeData.getString('peoplePageTitle'));
    r.PEOPLE.hasMigratedToPlugin = true;
    // <if expr="not is_chromeos">
    r.SIGN_OUT = r.PEOPLE.createChild('/signOut');
    r.SIGN_OUT.isNavigableDialog = true;
    r.SIGN_OUT.hasMigratedToPlugin = true;
    r.IMPORT_DATA = r.PEOPLE.createChild('/importData');
    r.IMPORT_DATA.isNavigableDialog = true;
    r.IMPORT_DATA.hasMigratedToPlugin = true;
    if (loadTimeData.getBoolean('replaceSyncPromosWithSignInPromos')) {
      r.ACCOUNT = r.PEOPLE.createChild('/account');
      r.ACCOUNT.hasMigratedToPlugin = true;
      r.GOOGLE_SERVICES = r.PEOPLE.createChild('/googleServices');
      r.GOOGLE_SERVICES.hasMigratedToPlugin = true;
    }
    r.MANAGE_PROFILE = r.PEOPLE.createChild('/manageProfile');
    r.MANAGE_PROFILE.hasMigratedToPlugin = true;
    // </if>

    r.SYNC = r.PEOPLE.createChild('/syncSetup');
    r.SYNC.hasMigratedToPlugin = true;
    r.SYNC_ADVANCED = r.SYNC.createChild('/syncSetup/advanced');
    r.SYNC_ADVANCED.hasMigratedToPlugin = true;
  }

  if (visibility.ai !== false && loadTimeData.getBoolean('showAiPage')) {
    r.AI = r.BASIC.createSection(
        '/ai', 'ai', loadTimeData.getString('aiInnovationsPageTitle'));
    r.AI.hasMigratedToPlugin = true;
    if (loadTimeData.getBoolean('showTabOrganizationControl')) {
      r.AI_TAB_ORGANIZATION = r.AI.createChild('/ai/tabOrganizer');
      r.AI_TAB_ORGANIZATION.hasMigratedToPlugin = true;
    }
    if (loadTimeData.getBoolean('showHistorySearchControl')) {
      r.HISTORY_SEARCH = r.AI.createChild('/ai/historySearch');
      r.HISTORY_SEARCH.hasMigratedToPlugin = true;
    }
    if (loadTimeData.getBoolean('showComposeControl')) {
      r.OFFER_WRITING_HELP = r.AI.createChild('/ai/helpMeWrite');
      r.OFFER_WRITING_HELP.hasMigratedToPlugin = true;
    }
    if (loadTimeData.getBoolean('showCompareControl')) {
      r.COMPARE = r.AI.createChild('/ai/compareProducts');
      r.COMPARE.hasMigratedToPlugin = true;
    }
    // <if expr="enable_glic">
    if (loadTimeData.getBoolean('showGlicSettings')) {
      r.GEMINI = r.AI.createChild('/ai/gemini');
      r.GEMINI.hasMigratedToPlugin = true;
    }
    // </if>
  }

  if (visibility.appearance !== false) {
    r.APPEARANCE = r.BASIC.createSection(
        '/appearance', 'appearance',
        loadTimeData.getString('appearancePageTitle'));
    r.APPEARANCE.hasMigratedToPlugin = true;
    r.FONTS = r.APPEARANCE.createChild('/fonts');
    r.FONTS.hasMigratedToPlugin = true;
  }

  if (visibility.autofill !== false) {
    r.AUTOFILL = r.BASIC.createSection(
        '/autofill', 'autofill', loadTimeData.getString('autofillPageTitle'));
    r.AUTOFILL.hasMigratedToPlugin = true;
    r.PAYMENTS = r.AUTOFILL.createChild('/payments');
    r.PAYMENTS.hasMigratedToPlugin = true;
    r.ADDRESSES = r.AUTOFILL.createChild('/addresses');
    r.ADDRESSES.hasMigratedToPlugin = true;

    if (loadTimeData.getBoolean('showAutofillAiControl')) {
      r.AUTOFILL_AI = r.AUTOFILL.createChild('/enhancedAutofill');
      r.AUTOFILL_AI.hasMigratedToPlugin = true;
    }

    // <if expr="is_win or is_macosx">
    r.PASSKEYS = r.AUTOFILL.createChild('/passkeys');
    r.PASSKEYS.hasMigratedToPlugin = true;
    // </if>
  }

  if (visibility.privacy !== false) {
    r.PRIVACY = r.BASIC.createSection(
        '/privacy', 'privacy', loadTimeData.getString('privacyPageTitle'));
    addPrivacyChildRoutes(r);
  }

  // <if expr="not is_chromeos">
  if (visibility.defaultBrowser !== false) {
    r.DEFAULT_BROWSER = r.BASIC.createSection(
        '/defaultBrowser', 'defaultBrowser',
        loadTimeData.getString('defaultBrowser'));
    r.DEFAULT_BROWSER.hasMigratedToPlugin = true;
  }
  // </if>

  if (visibility.onStartup !== false) {
    r.ON_STARTUP = r.BASIC.createSection(
        '/onStartup', 'onStartup', loadTimeData.getString('onStartup'));
    r.ON_STARTUP.hasMigratedToPlugin = true;
  }

  // Advanced Routes
  r.ADVANCED = new Route('/advanced');
  r.ADVANCED.hasMigratedToPlugin = true;

  if (visibility.languages !== false) {
    r.LANGUAGES = r.ADVANCED.createSection(
        '/languages', 'languages',
        loadTimeData.getString('languagesPageTitle'));
    r.LANGUAGES.hasMigratedToPlugin = true;
    r.SPELL_CHECK = r.LANGUAGES.createSection('/spellCheck', 'languages');
    r.SPELL_CHECK.hasMigratedToPlugin = true;
    // <if expr="not is_chromeos and not is_macosx">
    r.EDIT_DICTIONARY = r.SPELL_CHECK.createChild('/editDictionary');
    r.EDIT_DICTIONARY.hasMigratedToPlugin = true;
    // </if>
  }

  if (visibility.downloads !== false) {
    r.DOWNLOADS = r.ADVANCED.createSection(
        '/downloads', 'downloads',
        loadTimeData.getString('downloadsPageTitle'));
    r.DOWNLOADS.hasMigratedToPlugin = true;
  }

  if (visibility.a11y !== false) {
    r.ACCESSIBILITY = r.ADVANCED.createSection(
        '/accessibility', 'a11y', loadTimeData.getString('a11yPageTitle'));
    r.ACCESSIBILITY.hasMigratedToPlugin = true;

    // <if expr="is_linux">
    r.CAPTIONS = r.ACCESSIBILITY.createChild('/captions');
    r.CAPTIONS.hasMigratedToPlugin = true;
    // </if>
  }

  // <if expr="not is_chromeos">
  if (visibility.system !== false) {
    r.SYSTEM = r.ADVANCED.createSection(
        '/system', 'system', loadTimeData.getString('systemPageTitle'));
    r.SYSTEM.hasMigratedToPlugin = true;
  }
  // </if>

  if (visibility.reset !== false) {
    r.RESET = r.ADVANCED.createSection(
        '/reset', 'reset', loadTimeData.getString('resetPageTitle'));
    r.RESET.hasMigratedToPlugin = true;
    r.RESET_DIALOG = r.RESET.createChild('/resetProfileSettings');
    r.RESET_DIALOG.hasMigratedToPlugin = true;
    r.RESET_DIALOG.isNavigableDialog = true;
    r.TRIGGERED_RESET_DIALOG =
        r.RESET.createChild('/triggeredResetProfileSettings');
    r.TRIGGERED_RESET_DIALOG.isNavigableDialog = true;
    r.TRIGGERED_RESET_DIALOG.hasMigratedToPlugin = true;
  }

  if (visibility.performance !== false) {
    r.PERFORMANCE = r.BASIC.createSection(
        '/performance', 'performance',
        loadTimeData.getString('performancePageTitle'));
    r.PERFORMANCE.hasMigratedToPlugin = true;
  }

  return r as unknown as SettingsRoutes;
}

/**
 * @return A router with the browser settings routes.
 */
export function buildRouter(): Router {
  return new Router(createRoutes());
}

export function resetRouterForTesting(router: Router = buildRouter()) {
  Router.resetInstanceForTesting(router);

  // Update the exported `routes` variable, otherwise it will be holding stale
  // routes from the previous singleton instance.
  routes = Router.getInstance().getRoutes();
}

Router.setInstance(buildRouter());
window.addEventListener('popstate', function() {
  // On pop state, do not push the state onto the window.history again.
  const routerInstance = Router.getInstance();
  routerInstance.setCurrentRoute(
      routerInstance.getRouteForPath(window.location.pathname) ||
          routerInstance.getRoutes().BASIC,
      new URLSearchParams(window.location.search), true);
});

export let routes: SettingsRoutes = Router.getInstance().getRoutes();

// Returns the "effective" route when at chrome://settings/.
export function getTopLevelRoute(): Route {
  if (!loadTimeData.getBoolean('isGuest')) {
    return routes.PEOPLE;
  }

  let guestTopLevelRoute = routes.SEARCH;
  // <if expr="is_chromeos">
  guestTopLevelRoute = routes.PRIVACY;
  // </if>

  return guestTopLevelRoute;
}