388 lines
14 KiB
HTML
388 lines
14 KiB
HTML
|
<!doctype html>
|
||
|
|
<html class="no-js" lang="">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
||
|
|
<title>CICADA</title>
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
|
||
|
|
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
|
||
|
|
<link rel="stylesheet" href="../styles/style.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div class="navbar navbar-default navbar-fixed-top visible-xs">
|
||
|
|
<a href="../" class="navbar-brand">CICADA</a>
|
||
|
|
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="xs-menu menu" id="mobile-menu">
|
||
|
|
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="container-fluid main">
|
||
|
|
<div class="row main">
|
||
|
|
<div class="hidden-xs menu">
|
||
|
|
<compodoc-menu mode="normal"></compodoc-menu>
|
||
|
|
</div>
|
||
|
|
<!-- START CONTENT -->
|
||
|
|
<div class="content guard">
|
||
|
|
<div class="content-data">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<ol class="breadcrumb">
|
||
|
|
<li>Guards</li>
|
||
|
|
<li>RoleGuard</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<ul class="nav nav-tabs" role="tablist">
|
||
|
|
<li class="active">
|
||
|
|
<a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
|
||
|
|
</li>
|
||
|
|
<li >
|
||
|
|
<a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<div class="tab-content">
|
||
|
|
<div class="tab-pane fade active in" id="c-info">
|
||
|
|
<p class="comment">
|
||
|
|
<h3>File</h3>
|
||
|
|
</p>
|
||
|
|
<p class="comment">
|
||
|
|
<code>src/app/_guards/role.guard.ts</code>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p class="comment">
|
||
|
|
<h3>Description</h3>
|
||
|
|
</p>
|
||
|
|
<p class="comment">
|
||
|
|
<p>Role guard implementation.
|
||
|
|
Dictates access to routes depending on the user's role.</p>
|
||
|
|
|
||
|
|
</p>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h3 id="index">Index</h3>
|
||
|
|
<table class="table table-sm table-bordered index-table">
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<h6><b>Methods</b></h6>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<ul class="index-list">
|
||
|
|
<li>
|
||
|
|
<a href="#canActivate">canActivate</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<h3 id="constructor">Constructor</h3>
|
||
|
|
<table class="table table-sm table-bordered">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<code>constructor(router: <a href="https://angular.io/api/router/Router" target="_blank">Router</a>)</code>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<div class="io-line">Defined in <a href="" data-line="21" class="link-to-prism">src/app/_guards/role.guard.ts:21</a></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<div class="io-description"><p>Instantiates the role guard class.</p>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<b>Parameters :</b>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<td>Name</td>
|
||
|
|
<td>Type</td>
|
||
|
|
<td>Optional</td>
|
||
|
|
<td>Description</td>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>router</td>
|
||
|
|
|
||
|
|
<td>
|
||
|
|
<code><a href="https://angular.io/api/router/Router" target="_blank" >Router</a></code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td>
|
||
|
|
No
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td>
|
||
|
|
<code><ul>
|
||
|
|
<li>A service that provides navigation among views and URL manipulation capabilities.</li>
|
||
|
|
</ul>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<h3 id="methods">
|
||
|
|
Methods
|
||
|
|
</h3>
|
||
|
|
<table class="table table-sm table-bordered">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<a name="canActivate"></a>
|
||
|
|
<span class="name">
|
||
|
|
<b>
|
||
|
|
canActivate
|
||
|
|
</b>
|
||
|
|
<a href="#canActivate"><span class="icon ion-ios-link"></span></a>
|
||
|
|
</span>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<code>canActivate(route: <a href="https://angular.io/api/router/ActivatedRouteSnapshot" target="_blank">ActivatedRouteSnapshot</a>, state: <a href="https://angular.io/api/router/RouterStateSnapshot" target="_blank">RouterStateSnapshot</a>)</code>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<div class="io-line">Defined in <a href="" data-line="38"
|
||
|
|
class="link-to-prism">src/app/_guards/role.guard.ts:38</a></div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="col-md-4">
|
||
|
|
<div class="io-description"><p>Returns whether navigation to a specific route is acceptable.
|
||
|
|
Checks if the user has the required role to access the route.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="io-description">
|
||
|
|
<b>Parameters :</b>
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<td>Name</td>
|
||
|
|
<td>Type</td>
|
||
|
|
<td>Optional</td>
|
||
|
|
<td>Description</td>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>route</td>
|
||
|
|
<td>
|
||
|
|
<code><a href="https://angular.io/api/router/ActivatedRouteSnapshot" target="_blank" >ActivatedRouteSnapshot</a></code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td>
|
||
|
|
No
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td>
|
||
|
|
<ul>
|
||
|
|
<li>Contains the information about a route associated with a component loaded in an outlet at a particular moment in time.
|
||
|
|
ActivatedRouteSnapshot can also be used to traverse the router state tree.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>state</td>
|
||
|
|
<td>
|
||
|
|
<code><a href="https://angular.io/api/router/RouterStateSnapshot" target="_blank" >RouterStateSnapshot</a></code>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td>
|
||
|
|
No
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td>
|
||
|
|
<ul>
|
||
|
|
<li>Represents the state of the router at a moment in time.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
</div>
|
||
|
|
<div class="io-description">
|
||
|
|
<b>Returns : </b> <code>Observable | Promise | boolean | UrlTree</code>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="io-description">
|
||
|
|
<p>true - If the user's role matches with accepted roles.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="tab-pane fade tab-source-code" id="c-source">
|
||
|
|
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Injectable } from '@angular/core';
|
||
|
|
import {
|
||
|
|
ActivatedRouteSnapshot,
|
||
|
|
CanActivate,
|
||
|
|
Router,
|
||
|
|
RouterStateSnapshot,
|
||
|
|
UrlTree,
|
||
|
|
} from '@angular/router';
|
||
|
|
|
||
|
|
// Third party imports
|
||
|
|
import { Observable } from 'rxjs';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Role guard implementation.
|
||
|
|
* Dictates access to routes depending on the user's role.
|
||
|
|
*/
|
||
|
|
@Injectable({
|
||
|
|
providedIn: 'root',
|
||
|
|
})
|
||
|
|
export class RoleGuard implements CanActivate {
|
||
|
|
/**
|
||
|
|
* Instantiates the role guard class.
|
||
|
|
*
|
||
|
|
* @param router - A service that provides navigation among views and URL manipulation capabilities.
|
||
|
|
*/
|
||
|
|
constructor(private router: Router) {}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns whether navigation to a specific route is acceptable.
|
||
|
|
* Checks if the user has the required role to access the route.
|
||
|
|
*
|
||
|
|
* @param route - Contains the information about a route associated with a component loaded in an outlet at a particular moment in time.
|
||
|
|
* ActivatedRouteSnapshot can also be used to traverse the router state tree.
|
||
|
|
* @param state - Represents the state of the router at a moment in time.
|
||
|
|
* @returns true - If the user's role matches with accepted roles.
|
||
|
|
*/
|
||
|
|
canActivate(
|
||
|
|
route: ActivatedRouteSnapshot,
|
||
|
|
state: RouterStateSnapshot
|
||
|
|
): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree {
|
||
|
|
const currentUser = JSON.parse(localStorage.getItem(atob('CICADA_USER')));
|
||
|
|
if (currentUser) {
|
||
|
|
if (route.data.roles && route.data.roles.indexOf(currentUser.role) === -1) {
|
||
|
|
this.router.navigate(['/']);
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
this.router.navigate(['/auth'], { queryParams: { returnUrl: state.url } });
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div><div class="search-results">
|
||
|
|
<div class="has-results">
|
||
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
|
||
|
|
<ul class="search-results-list"></ul>
|
||
|
|
</div>
|
||
|
|
<div class="no-results">
|
||
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- END CONTENT -->
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script>
|
||
|
|
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
|
||
|
|
var COMPODOC_CURRENT_PAGE_CONTEXT = 'guard';
|
||
|
|
var COMPODOC_CURRENT_PAGE_URL = 'RoleGuard.html';
|
||
|
|
var MAX_SEARCH_RESULTS = 15;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<script src="../js/libs/custom-elements.min.js"></script>
|
||
|
|
<script src="../js/libs/lit-html.js"></script>
|
||
|
|
<!-- Required to polyfill modern browsers as code is ES5 for IE... -->
|
||
|
|
<script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
|
||
|
|
<script src="../js/menu-wc.js" defer></script>
|
||
|
|
|
||
|
|
<script src="../js/libs/bootstrap-native.js"></script>
|
||
|
|
|
||
|
|
<script src="../js/libs/es6-shim.min.js"></script>
|
||
|
|
<script src="../js/libs/EventDispatcher.js"></script>
|
||
|
|
<script src="../js/libs/promise.min.js"></script>
|
||
|
|
<script src="../js/libs/zepto.min.js"></script>
|
||
|
|
|
||
|
|
<script src="../js/compodoc.js"></script>
|
||
|
|
|
||
|
|
<script src="../js/tabs.js"></script>
|
||
|
|
<script src="../js/menu.js"></script>
|
||
|
|
<script src="../js/libs/clipboard.min.js"></script>
|
||
|
|
<script src="../js/libs/prism.js"></script>
|
||
|
|
<script src="../js/sourceCode.js"></script>
|
||
|
|
<script src="../js/search/search.js"></script>
|
||
|
|
<script src="../js/search/lunr.min.js"></script>
|
||
|
|
<script src="../js/search/search-lunr.js"></script>
|
||
|
|
<script src="../js/search/search_index.js"></script>
|
||
|
|
<script src="../js/lazy-load-graphs.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|