/** * @license * Copyright Google Inc. All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import {Type} from '@angular/core'; import {Observable} from 'rxjs/Observable'; import {Observer} from 'rxjs/Observer'; import {of } from 'rxjs/observable/of'; import {Data, ResolveData, Route, Routes} from './config'; import {ActivatedRouteSnapshot, InheritedResolve, RouterStateSnapshot} from './router_state'; import {PRIMARY_OUTLET, Params} from './shared'; import {UrlPathWithParams, UrlSegment, UrlTree, mapChildrenIntoArray} from './url_tree'; import {last, merge} from './utils/collection'; import {TreeNode} from './utils/tree'; class NoMatch { constructor(public segment: UrlSegment = null) {} } class InheritedFromParent { constructor( public parent: InheritedFromParent, public snapshot: ActivatedRouteSnapshot, public params: Params, public data: Data, public resolve: InheritedResolve) {} get allParams(): Params { return this.parent ? merge(this.parent.allParams, this.params) : this.params; } get allData(): Data { return this.parent ? merge(this.parent.allData, this.data) : this.data; } static empty(snapshot: ActivatedRouteSnapshot): InheritedFromParent { return new InheritedFromParent(null, snapshot, {}, {}, new InheritedResolve(null, {})); } } export function recognize(rootComponentType: Type, config: Routes, urlTree: UrlTree, url: string): Observable { try { const children = processSegment(config, urlTree.root, InheritedFromParent.empty(null), PRIMARY_OUTLET); const root = new ActivatedRouteSnapshot( [], Object.freeze({}), {}, PRIMARY_OUTLET, rootComponentType, null, urlTree.root, -1, InheritedResolve.empty); const rootNode = new TreeNode(root, children); return of (new RouterStateSnapshot( url, rootNode, Object.freeze(urlTree.queryParams), urlTree.fragment)); } catch (e) { if (e instanceof NoMatch) { return new Observable( (obs: Observer) => obs.error(new Error(`Cannot match any routes: '${e.segment}'`))); } else { return new Observable( (obs: Observer) => obs.error(e)); } } } function processSegment( config: Route[], segment: UrlSegment, inherited: InheritedFromParent, outlet: string): TreeNode[] { if (segment.pathsWithParams.length === 0 && segment.hasChildren()) { return processSegmentChildren(config, segment, inherited); } else { return processPathsWithParams(config, segment, 0, segment.pathsWithParams, inherited, outlet); } } function processSegmentChildren( config: Route[], segment: UrlSegment, inherited: InheritedFromParent): TreeNode[] { const children = mapChildrenIntoArray( segment, (child, childOutlet) => processSegment(config, child, inherited, childOutlet)); checkOutletNameUniqueness(children); sortActivatedRouteSnapshots(children); return children; } function sortActivatedRouteSnapshots(nodes: TreeNode[]): void { nodes.sort((a, b) => { if (a.value.outlet === PRIMARY_OUTLET) return -1; if (b.value.outlet === PRIMARY_OUTLET) return 1; return a.value.outlet.localeCompare(b.value.outlet); }); } function processPathsWithParams( config: Route[], segment: UrlSegment, pathIndex: number, paths: UrlPathWithParams[], inherited: InheritedFromParent, outlet: string): TreeNode[] { for (let r of config) { try { return processPathsWithParamsAgainstRoute(r, segment, pathIndex, paths, inherited, outlet); } catch (e) { if (!(e instanceof NoMatch)) throw e; } } throw new NoMatch(segment); } function processPathsWithParamsAgainstRoute( route: Route, rawSegment: UrlSegment, pathIndex: number, paths: UrlPathWithParams[], inherited: InheritedFromParent, outlet: string): TreeNode[] { if (route.redirectTo) throw new NoMatch(); if ((route.outlet ? route.outlet : PRIMARY_OUTLET) !== outlet) throw new NoMatch(); const newInheritedResolve = new InheritedResolve(inherited.resolve, getResolve(route)); if (route.path === '**') { const params = paths.length > 0 ? last(paths).parameters : {}; const snapshot = new ActivatedRouteSnapshot( paths, Object.freeze(merge(inherited.allParams, params)), merge(inherited.allData, getData(route)), outlet, route.component, route, getSourceSegment(rawSegment), getPathIndexShift(rawSegment) - 1, newInheritedResolve); return [new TreeNode(snapshot, [])]; } const {consumedPaths, parameters, lastChild} = match(rawSegment, route, paths, inherited.snapshot); const rawSlicedPath = paths.slice(lastChild); const childConfig = getChildConfig(route); const {segment, slicedPath} = split(rawSegment, consumedPaths, rawSlicedPath, childConfig); const snapshot = new ActivatedRouteSnapshot( consumedPaths, Object.freeze(merge(inherited.allParams, parameters)), merge(inherited.allData, getData(route)), outlet, route.component, route, getSourceSegment(rawSegment), getPathIndexShift(rawSegment) + pathIndex + lastChild - 1, newInheritedResolve); const newInherited = route.component ? InheritedFromParent.empty(snapshot) : new InheritedFromParent(inherited, snapshot, parameters, getData(route), newInheritedResolve); if (slicedPath.length === 0 && segment.hasChildren()) { const children = processSegmentChildren(childConfig, segment, newInherited); return [new TreeNode(snapshot, children)]; } else if (childConfig.length === 0 && slicedPath.length === 0) { return [new TreeNode(snapshot, [])]; } else { const children = processPathsWithParams( childConfig, segment, pathIndex + lastChild, slicedPath, newInherited, PRIMARY_OUTLET); return [new TreeNode(snapshot, children)]; } } function getChildConfig(route: Route): Route[] { if (route.children) { return route.children; } else if (route.loadChildren) { return (route)._loadedConfig.routes; } else { return []; } } function match( segment: UrlSegment, route: Route, paths: UrlPathWithParams[], parent: ActivatedRouteSnapshot) { if (route.path === '') { if ((route.terminal || route.pathMatch === 'full') && (segment.hasChildren() || paths.length > 0)) { throw new NoMatch(); } else { const params = parent ? parent.params : {}; return {consumedPaths: [], lastChild: 0, parameters: params}; } } const path = route.path; const parts = path.split('/'); const posParameters: {[key: string]: any} = {}; const consumedPaths: UrlPathWithParams[] = []; let currentIndex = 0; for (let i = 0; i < parts.length; ++i) { if (currentIndex >= paths.length) throw new NoMatch(); const current = paths[currentIndex]; const p = parts[i]; const isPosParam = p.startsWith(':'); if (!isPosParam && p !== current.path) throw new NoMatch(); if (isPosParam) { posParameters[p.substring(1)] = current.path; } consumedPaths.push(current); currentIndex++; } if ((route.terminal || route.pathMatch === 'full') && (segment.hasChildren() || currentIndex < paths.length)) { throw new NoMatch(); } const parameters = merge(posParameters, consumedPaths[consumedPaths.length - 1].parameters); return {consumedPaths, lastChild: currentIndex, parameters}; } function checkOutletNameUniqueness(nodes: TreeNode[]): void { const names: {[k: string]: ActivatedRouteSnapshot} = {}; nodes.forEach(n => { let routeWithSameOutletName = names[n.value.outlet]; if (routeWithSameOutletName) { const p = routeWithSameOutletName.url.map(s => s.toString()).join('/'); const c = n.value.url.map(s => s.toString()).join('/'); throw new Error(`Two segments cannot have the same outlet name: '${p}' and '${c}'.`); } names[n.value.outlet] = n.value; }); } function getSourceSegment(segment: UrlSegment): UrlSegment { let s = segment; while (s._sourceSegment) { s = s._sourceSegment; } return s; } function getPathIndexShift(segment: UrlSegment): number { let s = segment; let res = 0; while (s._sourceSegment) { s = s._sourceSegment; res += segment._pathIndexShift; } return res; } function split( segment: UrlSegment, consumedPaths: UrlPathWithParams[], slicedPath: UrlPathWithParams[], config: Route[]) { if (slicedPath.length > 0 && containsEmptyPathMatchesWithNamedOutlets(segment, slicedPath, config)) { const s = new UrlSegment( consumedPaths, createChildrenForEmptyPaths( segment, consumedPaths, config, new UrlSegment(slicedPath, segment.children))); s._sourceSegment = segment; s._pathIndexShift = 0; return {segment: s, slicedPath: []}; } else if (slicedPath.length === 0 && containsEmptyPathMatches(segment, slicedPath, config)) { const s = new UrlSegment( segment.pathsWithParams, addEmptyPathsToChildrenIfNeeded(segment, slicedPath, config, segment.children)); s._sourceSegment = segment; s._pathIndexShift = 0; return {segment: s, slicedPath}; } else { return {segment, slicedPath}; } } function addEmptyPathsToChildrenIfNeeded( segment: UrlSegment, slicedPath: UrlPathWithParams[], routes: Route[], children: {[name: string]: UrlSegment}): {[name: string]: UrlSegment} { const res: {[name: string]: UrlSegment} = {}; for (let r of routes) { if (emptyPathMatch(segment, slicedPath, r) && !children[getOutlet(r)]) { const s = new UrlSegment([], {}); s._sourceSegment = segment; s._pathIndexShift = segment.pathsWithParams.length; res[getOutlet(r)] = s; } } return merge(children, res); } function createChildrenForEmptyPaths( segment: UrlSegment, consumedPaths: UrlPathWithParams[], routes: Route[], primarySegment: UrlSegment): {[name: string]: UrlSegment} { const res: {[name: string]: UrlSegment} = {}; res[PRIMARY_OUTLET] = primarySegment; primarySegment._sourceSegment = segment; primarySegment._pathIndexShift = consumedPaths.length; for (let r of routes) { if (r.path === '') { const s = new UrlSegment([], {}); s._sourceSegment = segment; s._pathIndexShift = consumedPaths.length; res[getOutlet(r)] = s; } } return res; } function containsEmptyPathMatchesWithNamedOutlets( segment: UrlSegment, slicedPath: UrlPathWithParams[], routes: Route[]): boolean { return routes .filter(r => emptyPathMatch(segment, slicedPath, r) && getOutlet(r) !== PRIMARY_OUTLET) .length > 0; } function containsEmptyPathMatches( segment: UrlSegment, slicedPath: UrlPathWithParams[], routes: Route[]): boolean { return routes.filter(r => emptyPathMatch(segment, slicedPath, r)).length > 0; } function emptyPathMatch(segment: UrlSegment, slicedPath: UrlPathWithParams[], r: Route): boolean { if ((segment.hasChildren() || slicedPath.length > 0) && (r.terminal || r.pathMatch === 'full')) return false; return r.path === '' && r.redirectTo === undefined; } function getOutlet(route: Route): string { return route.outlet ? route.outlet : PRIMARY_OUTLET; } function getData(route: Route): Data { return route.data ? route.data : {}; } function getResolve(route: Route): ResolveData { return route.resolve ? route.resolve : {}; }