chrome/browser/resources/settings/router.js - chromium/src - Git at Google

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

 // #import {assert, assertNotReached} from 'chrome://resources/js/assert.m.js';
 // #import {loadTimeData} from 'chrome://resources/js/load_time_data.m.js';
 // #import './i18n_setup.js';

 cr.define('settings', function() {
   /**
    * @typedef {{
    *   BASIC: !settings.Route,
    *   ADVANCED: !settings.Route,
    *   ABOUT: !settings.Route,
    * }}
    */
   /* #export */ let MinimumRoutes;

   /** Class for navigable routes. */
   /* #export */ class Route {
     /** @param {string} path */
     constructor(path) {
       /** @type {string} */
       this.path = path;

       /** @type {?settings.Route} */
       this.parent = null;

       /** @type {number} */
       this.depth = 0;

       /**
        * @type {boolean} Whether this route corresponds to a navigable
        *     dialog. Those routes don't belong to a "section".
        */
       this.isNavigableDialog = false;

       // Below are all legacy properties to provide compatibility with the old
       // routing system.

       /** @type {string} */
       this.section = '';
     }

     /**
      * Returns a new Route instance that's a child of this route.
      * @param {string} path Extends this route's path if it doesn't contain a
      *     leading slash.
      * @return {!settings.Route}
      */
     createChild(path) {
       assert(path);

       // |path| extends this route's path if it doesn't have a leading slash.
       // If it does have a leading slash, it's just set as the new route's URL.
       const newUrl = path[0] == '/' ? path : `${this.path}/${path}`;

       const route = new Route(newUrl);
       route.parent = this;
       route.section = this.section;
       route.depth = this.depth + 1;

       return route;
     }

     /**
      * Returns a new Route instance that's a child section of this route.
      * TODO(tommycli): Remove once we've obsoleted the concept of sections.
      * @param {string} path
      * @param {string} section
      * @return {!settings.Route}
      */
     createSection(path, section) {
       const route = this.createChild(path);
       route.section = section;
       return route;
     }

     /**
      * Returns the absolute path string for this Route, assuming this function
      * has been called from within chrome://settings.
      * @return {string}
      */
     getAbsolutePath() {
       return window.location.origin + this.path;
     }

     /**
      * Returns true if this route matches or is an ancestor of the parameter.
      * @param {!settings.Route} route
      * @return {boolean}
      */
     contains(route) {
       for (let r = route; r != null; r = r.parent) {
         if (this == r) {
           return true;
         }
       }
       return false;
     }

     /**
      * Returns true if this route is a subpage of a section.
      * @return {boolean}
      */
     isSubpage() {
       return !!this.parent && !!this.section &&
           this.parent.section == this.section;
     }
   }

   /**
    * Regular expression that captures the leading slash, the content and the
    * trailing slash in three different groups.
    * @type {!RegExp}
    */
   const CANONICAL_PATH_REGEX = /(^\/)([\/-\w]+)(\/$)/;

   /** @type {?settings.Router} */
   let routerInstance = null;

   /* #export */ class Router {
     /** @return {!settings.Router} The singleton instance. */
     static getInstance() {
       return assert(routerInstance);
     }

     /** @param {!settings.Router} instance */
     static setInstance(instance) {
       assert(!routerInstance);
       routerInstance = instance;
     }

     /** @param {!settings.Router} instance */
     static resetInstanceForTesting(instance) {
       if (routerInstance) {
         instance.routeObservers_ = routerInstance.routeObservers_;
       }
       routerInstance = instance;
     }

     /** @param {!settings.MinimumRoutes} availableRoutes */
     constructor(availableRoutes) {
       /**
        * List of available routes. This is populated taking into account current
        * state (like guest mode).
        * @private {!settings.MinimumRoutes}
        */
       this.routes_ = availableRoutes;

       /**
        * The current active route. This updated is only by settings.navigateTo
        * or settings.initializeRouteFromUrl.
        * @type {!settings.Route}
        */
       this.currentRoute = this.routes_.BASIC;

       /**
        * The current query parameters. This is updated only by
        * settings.navigateTo or settings.initializeRouteFromUrl.
        * @private {!URLSearchParams}
        */
       this.currentQueryParameters_ = new URLSearchParams();

       /** @private {boolean} */
       this.wasLastRouteChangePopstate_ = false;

       /** @private {boolean}*/
       this.initializeRouteFromUrlCalled_ = false;

       /** @private {!Set} */
       this.routeObservers_ = new Set();
     }

     /** @param {Object} observer */
     addObserver(observer) {
       assert(!this.routeObservers_.has(observer));
       this.routeObservers_.add(observer);
     }

     /** @param {Object} observer */
     removeObserver(observer) {
       assert(this.routeObservers_.delete(observer));
     }

     /** @return {settings.Route} */
     getRoute(routeName) {
       return this.routes_[routeName];
     }

     /** @return {!Object} */
     getRoutes() {
       return this.routes_;
     }

     /**
      * Helper function to set the current route and notify all observers.
      * @param {!settings.Route} route
      * @param {!URLSearchParams} queryParameters
      * @param {boolean} isPopstate
      */
     setCurrentRoute(route, queryParameters, isPopstate) {
       this.recordMetrics(route.path);

       const oldRoute = this.currentRoute;
       this.currentRoute = route;
       this.currentQueryParameters_ = queryParameters;
       this.wasLastRouteChangePopstate_ = isPopstate;
       new Set(this.routeObservers_).forEach((observer) => {
         observer.currentRouteChanged(this.currentRoute, oldRoute);
       });
     }

     /** @return {!settings.Route} */
     getCurrentRoute() {
       return this.currentRoute;
     }

     /** @return {!URLSearchParams} */
     getQueryParameters() {
       return new URLSearchParams(
           this.currentQueryParameters_);  // Defensive copy.
     }

     /** @return {boolean} */
     lastRouteChangeWasPopstate() {
       return this.wasLastRouteChangePopstate_;
     }

     /**
      * @param {string} path
      * @return {?settings.Route} The matching canonical route, or null if none
      *     matches.
      */
     getRouteForPath(path) {
       // Allow trailing slash in paths.
       const canonicalPath = path.replace(CANONICAL_PATH_REGEX, '$1$2');

       // TODO(tommycli): Use Object.values once Closure compilation supports it.
       const matchingKey =
           Object.keys(this.routes_)
               .find((key) => this.routes_[key].path == canonicalPath);

       return matchingKey ? this.routes_[matchingKey] : null;
     }

     /**
      * Navigates to a canonical route and pushes a new history entry.
      * @param {!settings.Route} route
      * @param {URLSearchParams=} opt_dynamicParameters Navigations to the same
      *     URL parameters in a different order will still push to history.
      * @param {boolean=} opt_removeSearch Whether to strip the 'search' URL
      *     parameter during navigation. Defaults to false.
      */
     navigateTo(route, opt_dynamicParameters, opt_removeSearch) {
       // The ADVANCED route only serves as a parent of subpages, and should not
       // be possible to navigate to it directly.
       if (route == this.routes_.ADVANCED) {
         route = this.routes_.BASIC;
       }

       const params = opt_dynamicParameters || new URLSearchParams();
       const removeSearch = !!opt_removeSearch;

       const oldSearchParam = this.getQueryParameters().get('search') || '';
       const newSearchParam = params.get('search') || '';

       if (!removeSearch && oldSearchParam && !newSearchParam) {
         params.append('search', oldSearchParam);
       }

       let url = route.path;
       const queryString = params.toString();
       if (queryString) {
         url += '?' + queryString;
       }

       // History serializes the state, so we don't push the actual route object.
       window.history.pushState(this.currentRoute.path, '', url);
       this.setCurrentRoute(route, params, false);
     }

     /**
      * Navigates to the previous route if it has an equal or lesser depth.
      * If there is no previous route in history meeting those requirements,
      * this navigates to the immediate parent. This will never exit Settings.
      */
     navigateToPreviousRoute() {
       const previousRoute = window.history.state &&
           assert(this.getRouteForPath(
               /** @type {string} */ (window.history.state)));

       if (previousRoute && previousRoute.depth <= this.currentRoute.depth) {
         window.history.back();
       } else {
         this.navigateTo(this.currentRoute.parent || this.routes_.BASIC);
       }
     }

     /**
      * Initialize the route and query params from the URL.
      */
     initializeRouteFromUrl() {
       assert(!this.initializeRouteFromUrlCalled_);
       this.initializeRouteFromUrlCalled_ = true;

       const route = this.getRouteForPath(window.location.pathname);

       // Record all correct paths entered on the settings page, and
       // as all incorrect paths are routed to the main settings page,
       // record all incorrect paths as hitting the main settings page.
       this.recordMetrics(route ? route.path : this.routes_.BASIC.path);

       // Never allow direct navigation to ADVANCED.
       if (route && route != this.routes_.ADVANCED) {
         this.currentRoute = route;
         this.currentQueryParameters_ =
             new URLSearchParams(window.location.search);
       } else {
         window.history.replaceState(undefined, '', this.routes_.BASIC.path);
       }
     }

     /**
      * Make a UMA note about visiting this URL path.
      * @param {string} urlPath The url path (only).
      */
     recordMetrics(urlPath) {
       assert(!urlPath.startsWith('chrome://'));
       assert(!urlPath.startsWith('settings'));
       assert(urlPath.startsWith('/'));
       assert(!urlPath.match(/\?/g));

       const metricName = loadTimeData.valueExists('isOSSettings') &&
               loadTimeData.getBoolean('isOSSettings') ?
           'ChromeOS.Settings.PathVisited' :
           'WebUI.Settings.PathVisited';
       chrome.metricsPrivate.recordSparseHashable(metricName, urlPath);
     }

     resetRouteForTesting() {
       this.initializeRouteFromUrlCalled_ = false;
       this.wasLastRouteChangePopstate_ = false;
       this.currentRoute = this.routes_.BASIC;
       this.currentQueryParameters_ = new URLSearchParams();
     }
   }

   /** @polymerBehavior */
   /* #export */ const RouteObserverBehavior = {
     /** @override */
     attached() {
       routerInstance.addObserver(this);

       // Emulating Polymer data bindings, the observer is called when the
       // element starts observing the route.
       this.currentRouteChanged(routerInstance.currentRoute, undefined);
     },

     /** @override */
     detached() {
       routerInstance.removeObserver(this);
     },

     /**
      * @param {!settings.Route|undefined} opt_newRoute
      * @param {!settings.Route|undefined} opt_oldRoute
      */
     currentRouteChanged(opt_newRoute, opt_oldRoute) {
       assertNotReached();
     },
   };

   // #cr_define_end
   return {
     MinimumRoutes: MinimumRoutes,
     Route: Route,    // The Route class definition.
     Router: Router,  // The Router class definition.
     RouteObserverBehavior: RouteObserverBehavior,
   };
 });
	// 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.

	// #import {assert, assertNotReached} from 'chrome://resources/js/assert.m.js';
	// #import {loadTimeData} from 'chrome://resources/js/load_time_data.m.js';
	// #import './i18n_setup.js';

	cr.define('settings', function() {
	/**
	* @typedef {{
	* BASIC: !settings.Route,
	* ADVANCED: !settings.Route,
	* ABOUT: !settings.Route,
	* }}
	*/
	/* #export */ let MinimumRoutes;

	/** Class for navigable routes. */
	/* #export */ class Route {
	/** @param {string} path */
	constructor(path) {
	/** @type {string} */
	this.path = path;

	/** @type {?settings.Route} */
	this.parent = null;

	/** @type {number} */
	this.depth = 0;

	/**
	* @type {boolean} Whether this route corresponds to a navigable
	* dialog. Those routes don't belong to a "section".
	*/
	this.isNavigableDialog = false;

	// Below are all legacy properties to provide compatibility with the old
	// routing system.

	/** @type {string} */
	this.section = '';
	}

	/**
	* Returns a new Route instance that's a child of this route.
	* @param {string} path Extends this route's path if it doesn't contain a
	* leading slash.
	* @return {!settings.Route}
	*/
	createChild(path) {
	assert(path);

	// \|path\| extends this route's path if it doesn't have a leading slash.
	// If it does have a leading slash, it's just set as the new route's URL.
	const newUrl = path[0] == '/' ? path : `${this.path}/${path}`;

	const route = new Route(newUrl);
	route.parent = this;
	route.section = this.section;
	route.depth = this.depth + 1;

	return route;
	}

	/**
	* Returns a new Route instance that's a child section of this route.
	* TODO(tommycli): Remove once we've obsoleted the concept of sections.
	* @param {string} path
	* @param {string} section
	* @return {!settings.Route}
	*/
	createSection(path, section) {
	const route = this.createChild(path);
	route.section = section;
	return route;
	}

	/**
	* Returns the absolute path string for this Route, assuming this function
	* has been called from within chrome://settings.
	* @return {string}
	*/
	getAbsolutePath() {
	return window.location.origin + this.path;
	}

	/**
	* Returns true if this route matches or is an ancestor of the parameter.
	* @param {!settings.Route} route
	* @return {boolean}
	*/
	contains(route) {
	for (let r = route; r != null; r = r.parent) {
	if (this == r) {
	return true;
	}
	}
	return false;
	}

	/**
	* Returns true if this route is a subpage of a section.
	* @return {boolean}
	*/
	isSubpage() {
	return !!this.parent && !!this.section &&
	this.parent.section == this.section;
	}
	}

	/**
	* Regular expression that captures the leading slash, the content and the
	* trailing slash in three different groups.
	* @type {!RegExp}
	*/
	const CANONICAL_PATH_REGEX = /(^\/)([\/-\w]+)(\/$)/;

	/** @type {?settings.Router} */
	let routerInstance = null;

	/* #export */ class Router {
	/** @return {!settings.Router} The singleton instance. */
	static getInstance() {
	return assert(routerInstance);
	}

	/** @param {!settings.Router} instance */
	static setInstance(instance) {
	assert(!routerInstance);
	routerInstance = instance;
	}

	/** @param {!settings.Router} instance */
	static resetInstanceForTesting(instance) {
	if (routerInstance) {
	instance.routeObservers_ = routerInstance.routeObservers_;
	}
	routerInstance = instance;
	}

	/** @param {!settings.MinimumRoutes} availableRoutes */
	constructor(availableRoutes) {
	/**
	* List of available routes. This is populated taking into account current
	* state (like guest mode).
	* @private {!settings.MinimumRoutes}
	*/
	this.routes_ = availableRoutes;

	/**
	* The current active route. This updated is only by settings.navigateTo
	* or settings.initializeRouteFromUrl.
	* @type {!settings.Route}
	*/
	this.currentRoute = this.routes_.BASIC;

	/**
	* The current query parameters. This is updated only by
	* settings.navigateTo or settings.initializeRouteFromUrl.
	* @private {!URLSearchParams}
	*/
	this.currentQueryParameters_ = new URLSearchParams();

	/** @private {boolean} */
	this.wasLastRouteChangePopstate_ = false;

	/** @private {boolean}*/
	this.initializeRouteFromUrlCalled_ = false;

	/** @private {!Set} */
	this.routeObservers_ = new Set();
	}

	/** @param {Object} observer */
	addObserver(observer) {
	assert(!this.routeObservers_.has(observer));
	this.routeObservers_.add(observer);
	}

	/** @param {Object} observer */
	removeObserver(observer) {
	assert(this.routeObservers_.delete(observer));
	}

	/** @return {settings.Route} */
	getRoute(routeName) {
	return this.routes_[routeName];
	}

	/** @return {!Object} */
	getRoutes() {
	return this.routes_;
	}

	/**
	* Helper function to set the current route and notify all observers.
	* @param {!settings.Route} route
	* @param {!URLSearchParams} queryParameters
	* @param {boolean} isPopstate
	*/
	setCurrentRoute(route, queryParameters, isPopstate) {
	this.recordMetrics(route.path);

	const oldRoute = this.currentRoute;
	this.currentRoute = route;
	this.currentQueryParameters_ = queryParameters;
	this.wasLastRouteChangePopstate_ = isPopstate;
	new Set(this.routeObservers_).forEach((observer) => {
	observer.currentRouteChanged(this.currentRoute, oldRoute);
	});
	}

	/** @return {!settings.Route} */
	getCurrentRoute() {
	return this.currentRoute;
	}

	/** @return {!URLSearchParams} */
	getQueryParameters() {
	return new URLSearchParams(
	this.currentQueryParameters_); // Defensive copy.
	}

	/** @return {boolean} */
	lastRouteChangeWasPopstate() {
	return this.wasLastRouteChangePopstate_;
	}

	/**
	* @param {string} path
	* @return {?settings.Route} The matching canonical route, or null if none
	* matches.
	*/
	getRouteForPath(path) {
	// Allow trailing slash in paths.
	const canonicalPath = path.replace(CANONICAL_PATH_REGEX, '$1$2');

	// TODO(tommycli): Use Object.values once Closure compilation supports it.
	const matchingKey =
	Object.keys(this.routes_)
	.find((key) => this.routes_[key].path == canonicalPath);

	return matchingKey ? this.routes_[matchingKey] : null;
	}

	/**
	* Navigates to a canonical route and pushes a new history entry.
	* @param {!settings.Route} route
	* @param {URLSearchParams=} opt_dynamicParameters Navigations to the same
	* URL parameters in a different order will still push to history.
	* @param {boolean=} opt_removeSearch Whether to strip the 'search' URL
	* parameter during navigation. Defaults to false.
	*/
	navigateTo(route, opt_dynamicParameters, opt_removeSearch) {
	// The ADVANCED route only serves as a parent of subpages, and should not
	// be possible to navigate to it directly.
	if (route == this.routes_.ADVANCED) {
	route = this.routes_.BASIC;
	}

	const params = opt_dynamicParameters \|\| new URLSearchParams();
	const removeSearch = !!opt_removeSearch;

	const oldSearchParam = this.getQueryParameters().get('search') \|\| '';
	const newSearchParam = params.get('search') \|\| '';

	if (!removeSearch && oldSearchParam && !newSearchParam) {
	params.append('search', oldSearchParam);
	}

	let url = route.path;
	const queryString = params.toString();
	if (queryString) {
	url += '?' + queryString;
	}

	// History serializes the state, so we don't push the actual route object.
	window.history.pushState(this.currentRoute.path, '', url);
	this.setCurrentRoute(route, params, false);
	}

	/**
	* Navigates to the previous route if it has an equal or lesser depth.
	* If there is no previous route in history meeting those requirements,
	* this navigates to the immediate parent. This will never exit Settings.
	*/
	navigateToPreviousRoute() {
	const previousRoute = window.history.state &&
	assert(this.getRouteForPath(
	/** @type {string} */ (window.history.state)));

	if (previousRoute && previousRoute.depth <= this.currentRoute.depth) {
	window.history.back();
	} else {
	this.navigateTo(this.currentRoute.parent \|\| this.routes_.BASIC);
	}
	}

	/**
	* Initialize the route and query params from the URL.
	*/
	initializeRouteFromUrl() {
	assert(!this.initializeRouteFromUrlCalled_);
	this.initializeRouteFromUrlCalled_ = true;

	const route = this.getRouteForPath(window.location.pathname);

	// Record all correct paths entered on the settings page, and
	// as all incorrect paths are routed to the main settings page,
	// record all incorrect paths as hitting the main settings page.
	this.recordMetrics(route ? route.path : this.routes_.BASIC.path);

	// Never allow direct navigation to ADVANCED.
	if (route && route != this.routes_.ADVANCED) {
	this.currentRoute = route;
	this.currentQueryParameters_ =
	new URLSearchParams(window.location.search);
	} else {
	window.history.replaceState(undefined, '', this.routes_.BASIC.path);
	}
	}

	/**
	* Make a UMA note about visiting this URL path.
	* @param {string} urlPath The url path (only).
	*/
	recordMetrics(urlPath) {
	assert(!urlPath.startsWith('chrome://'));
	assert(!urlPath.startsWith('settings'));
	assert(urlPath.startsWith('/'));
	assert(!urlPath.match(/\?/g));

	const metricName = loadTimeData.valueExists('isOSSettings') &&
	loadTimeData.getBoolean('isOSSettings') ?
	'ChromeOS.Settings.PathVisited' :
	'WebUI.Settings.PathVisited';
	chrome.metricsPrivate.recordSparseHashable(metricName, urlPath);
	}

	resetRouteForTesting() {
	this.initializeRouteFromUrlCalled_ = false;
	this.wasLastRouteChangePopstate_ = false;
	this.currentRoute = this.routes_.BASIC;
	this.currentQueryParameters_ = new URLSearchParams();
	}
	}

	/** @polymerBehavior */
	/* #export */ const RouteObserverBehavior = {
	/** @override */
	attached() {
	routerInstance.addObserver(this);

	// Emulating Polymer data bindings, the observer is called when the
	// element starts observing the route.
	this.currentRouteChanged(routerInstance.currentRoute, undefined);
	},

	/** @override */
	detached() {
	routerInstance.removeObserver(this);
	},

	/**
	* @param {!settings.Route\|undefined} opt_newRoute
	* @param {!settings.Route\|undefined} opt_oldRoute
	*/
	currentRouteChanged(opt_newRoute, opt_oldRoute) {
	assertNotReached();
	},
	};

	// #cr_define_end
	return {
	MinimumRoutes: MinimumRoutes,
	Route: Route, // The Route class definition.
	Router: Router, // The Router class definition.
	RouteObserverBehavior: RouteObserverBehavior,
	};
	});