AuthController::_setNoAccessMsg() - Code Metrics - Inspection of "Update AdminCest.php" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 367555...dfeadf )

by Jean-Christophe

created 2019-02-06 20:57 UTC

AuthController::_setNoAccessMsg() A

↳ Parent: AuthController

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	4
dl	0
loc	2
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace Ubiquity\controllers\auth;

use Ubiquity\utils\http\USession;
use Ubiquity\utils\http\URequest;
use Ubiquity\utils\flash\FlashMessage;
use Ubiquity\controllers\ControllerBase;
use Ubiquity\controllers\Auth\AuthFiles;
use Ubiquity\utils\http\UResponse;
use Ubiquity\utils\base\UString;
use Ubiquity\controllers\Startup;
use Ajax\service\Javascript;
use Ubiquity\utils\http\UCookie;

 /**
 * Controller Auth
 * @property \Ajax\php\ubiquity\JsUtils $jquery
 **/
abstract class AuthController extends ControllerBase{
	use AuthControllerCoreTrait,AuthControllerVariablesTrait,AuthControllerOverrideTrait;
	
	/**
	 * @var AuthFiles
	 */
	protected $authFiles;
	protected $_controller;
	protected $_action;
	protected $_actionParams;
	protected $_noAccessMsg;
	protected $_loginCaption;
	protected $_attemptsSessionKey="_attempts";
	protected $_controllerInstance;
	
	public function __construct($instance=null){
		parent::__construct();
		$this->_controller=Startup::getController();
		$this->_action=Startup::getAction();
		$this->_actionParams=Startup::getActionParams();
		$this->_noAccessMsg=new FlashMessage("You are not authorized to access the page <b>{url}</b> !","Forbidden access","error","warning circle");
		$this->_loginCaption="Log in";
		$this->_controllerInstance=$instance;
		if(isset($instance))
			Startup::injectDependences($instance);
	}
	
	public function index(){
		if(($nbAttempsMax=$this->attemptsNumber())!==null){
			$nb=USession::getTmp($this->_attemptsSessionKey,$nbAttempsMax);
			if($nb<=0){
				$this->badLogin();
				return;
			}
		}
		$this->authLoadView($this->_getFiles()->getViewIndex(),["action"=>$this->getBaseUrl()."/connect",
				"loginInputName"=>$this->_getLoginInputName(),"loginLabel"=>$this->loginLabel(),
				"passwordInputName"=>$this->_getPasswordInputName(),"passwordLabel"=>$this->passwordLabel(),
				"rememberCaption"=>$this->rememberCaption()
		]);
	}
	
	/**
	 * {@inheritDoc}
	 * @see \controllers\ControllerBase::isValid()
	 */
	public final function isValid($action) {
		return true;
	}
	
	/**
	 * Action called when the user does not have access rights to a requested resource
	 * @param array|string $urlParts
	 */
	public function noAccess($urlParts){
		if(!is_array($urlParts)){
			$urlParts=explode(".", $urlParts);
		}
		USession::set("urlParts", $urlParts);
		$fMessage=$this->_noAccessMsg;
		$this->noAccessMessage($fMessage);
		$message=$this->fMessage($fMessage->parseContent(["url"=>implode("/",$urlParts)]));
		/*if(URequest::isAjax()){
			$this->jquery->get($this->_getBaseRoute()."/info/f","#_userInfo",["historize"=>false,"jqueryDone"=>"replaceWith","hasLoader"=>false,"attr"=>""]);
			$this->jquery->compile($this->view);
		}*/
		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
	}
	

	
	/**
	 * Override to implement the complete connection procedure 
	 */
	public function connect(){
		if(URequest::isPost()){
			if($connected=$this->_connect()){
				if(isset($_POST["ck-remember"])){
					$this->rememberMe($connected);
				}
				if(USession::exists($this->_attemptsSessionKey)){
					USession::delete($this->_attemptsSessionKey);
				}
				$this->onConnect($connected);
			}else{
				$this->onBadCreditentials();
			}
		}
	}
	
	/**
	 * Default Action for invalid creditentials
	 */
	public function badLogin(){
		$fMessage=new FlashMessage("Invalid creditentials!","Connection problem","warning","warning circle");
		$this->badLoginMessage($fMessage);
		$attemptsMessage="";
		if(($nbAttempsMax=$this->attemptsNumber())!==null){
			$nb=USession::getTmp($this->_attemptsSessionKey,$nbAttempsMax);
			$nb--;
			if($nb<0) $nb=0;
			if($nb==0){
				$fAttemptsNumberMessage=$this->noAttempts();
			}else{
				$fAttemptsNumberMessage=new FlashMessage("<i class='ui warning icon'></i> You still have {_attemptsCount} attempts to log in.",null,"bottom attached warning","");
			}
			USession::setTmp($this->_attemptsSessionKey, $nb,$this->attemptsTimeout());
			$this->attemptsNumberMessage($fAttemptsNumberMessage,$nb);
			$fAttemptsNumberMessage->parseContent(["_attemptsCount"=>$nb,"_timer"=>"<span id='timer'></span>"]);
			$attemptsMessage=$this->fMessage($fAttemptsNumberMessage,"timeout-message");
			$fMessage->addType("attached");
		}
		$message=$this->fMessage($fMessage,"bad-login").$attemptsMessage;
		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
	}
	
	/**
	 * Logout action
	 * Terminate the session and display a logout message
	 */
	public function terminate(){
		USession::terminate();
		$fMessage=new FlashMessage("You have been properly disconnected!","Logout","success","checkmark");
		$this->terminateMessage($fMessage);
		$message=$this->fMessage($fMessage);
		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
	}
	
	public function _disConnected(){
		$fMessage=new FlashMessage("You have been disconnected from the application!","Logout","","sign out");
		$this->disconnectedMessage($fMessage);
		$message=$this->fMessage($fMessage);
		$this->jquery->getOnClick("._signin", $this->getBaseUrl(),$this->_getBodySelector(),["stopPropagation"=>false,"preventDefault"=>false]);
		$this->jquery->execOn("click", "._close", "window.open(window.location,'_self').close();");
		return $this->jquery->renderView($this->_getFiles()->getViewDisconnected(),["_title"=>"Session ended","_message"=>$message],true);
	}
	
	/**
	 * Action displaying the logged user information 
	 * if _displayInfoAsString returns true, use _infoUser var in views to display user info
	 * @return string|null
	 */
	public function info($force=null){
		if(isset($force)){
			$displayInfoAsString=($force===true)?true:false;
		}else{
			$displayInfoAsString=$this->_displayInfoAsString();
		}
		return $this->loadView($this->_getFiles()->getViewInfo(),["connected"=>USession::get($this->_getUserSessionKey()),"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector()],$displayInfoAsString);
	}
	
	public function checkConnection(){
		UResponse::asJSON();
		echo "{\"valid\":".UString::getBooleanStr($this->_isValidUser())."}";
	}
	
	/**
	 * Sets the default noAccess message
	 * Default : "You are not authorized to access the page <b>{url}</b> !"
	 * @param string $content
	 * @param string $title
	 * @param string $type
	 * @param string $icon
	 */
	public function _setNoAccessMsg($content,$title=NULL,$type=NULL,$icon=null) {
		$this->_noAccessMsg->setValues($content,$title,$type,$icon);
	}
	/**
	 * @param string $_loginCaption
	 */
	public function _setLoginCaption($_loginCaption) {
		$this->_loginCaption = $_loginCaption;
	}
	
	/**
	 * Auto connect the user
	 */
	public function _autoConnect() {
		$cookie=$this->getCookieUser();
		if(isset($cookie)){
			$user=$this->fromCookie($cookie);
			if(isset($user)){
				USession::set($this->_getUserSessionKey(), $user);
			}
		}
	}
	/**
	 * Deletes the cookie for auto connection and returns to index
	 */
	public function forgetConnection(){
		UCookie::delete($this->_getUserSessionKey());
		$this->index();
	}
	
	/**
	 * {@inheritDoc}
	 * @see \Ubiquity\controllers\ControllerBase::finalize()
	 */
	public function finalize() {
		if(!UResponse::isJSON()){
			if(!URequest::isAjax()){
				if(isset($this->_controllerInstance)){
					call_user_func_array(array($this->_controllerInstance, 'parent::finalize'), []);
				}else{
					parent::finalize();	
				}
			}
			$this->jquery->execAtLast("if($('#_userInfo').length){\$('#_userInfo').html(".preg_replace("/$\R?^/m", "",Javascript::prep_element($this->info())).");}");
			echo $this->jquery->compile();
		}
	}

	/**
	 * {@inheritDoc}
	 * @see \Ubiquity\controllers\ControllerBase::initialize()
	 */
	public function initialize() {
		if(!URequest::isAjax()){
			if(isset($this->_controllerInstance)){
				call_user_func_array(array($this->_controllerInstance, 'parent::initialize'), []);
			}else{
				parent::initialize();
			}
		}
	}
	
	/**
	 * @param string $url
	 */
	public function _forward($url){
		$initFinalize=true;
		if(isset($this->_controllerInstance) && !URequest::isAjax()){
			$initFinalize=false;
		}
		Startup::forward($url,$initFinalize,$initFinalize);
	}
}


1		<?php
2		namespace Ubiquity\controllers\auth;
3
4		use Ubiquity\utils\http\USession;
5		use Ubiquity\utils\http\URequest;
6		use Ubiquity\utils\flash\FlashMessage;
7		use Ubiquity\controllers\ControllerBase;
8		use Ubiquity\controllers\Auth\AuthFiles;
9		use Ubiquity\utils\http\UResponse;
10		use Ubiquity\utils\base\UString;
11		use Ubiquity\controllers\Startup;
12		use Ajax\service\Javascript;
13		use Ubiquity\utils\http\UCookie;
14
15		/**
16		* Controller Auth
17		* @property \Ajax\php\ubiquity\JsUtils $jquery
18		**/
19		abstract class AuthController extends ControllerBase{
20		use AuthControllerCoreTrait,AuthControllerVariablesTrait,AuthControllerOverrideTrait;
21
22		/**
23		* @var AuthFiles
24		*/
25		protected $authFiles;
26		protected $_controller;
27		protected $_action;
28		protected $_actionParams;
29		protected $_noAccessMsg;
30		protected $_loginCaption;
31		protected $_attemptsSessionKey="_attempts";
32		protected $_controllerInstance;
33
34	2	public function __construct($instance=null){
35	2	parent::__construct();
36	2	$this->_controller=Startup::getController();
37	2	$this->_action=Startup::getAction();
38	2	$this->_actionParams=Startup::getActionParams();
39	2	$this->_noAccessMsg=new FlashMessage("You are not authorized to access the page <b>{url}</b> !","Forbidden access","error","warning circle");
40	2	$this->_loginCaption="Log in";
41	2	$this->_controllerInstance=$instance;
42	2	if(isset($instance))
43		Startup::injectDependences($instance);
44	2	}
45
46		public function index(){
47		if(($nbAttempsMax=$this->attemptsNumber())!==null){
48		$nb=USession::getTmp($this->_attemptsSessionKey,$nbAttempsMax);
49		if($nb<=0){
50		$this->badLogin();
51		return;
52		}
53		}
54		$this->authLoadView($this->_getFiles()->getViewIndex(),["action"=>$this->getBaseUrl()."/connect",
55		"loginInputName"=>$this->_getLoginInputName(),"loginLabel"=>$this->loginLabel(),
56		"passwordInputName"=>$this->_getPasswordInputName(),"passwordLabel"=>$this->passwordLabel(),
57		"rememberCaption"=>$this->rememberCaption()
58		]);
59		}
60
61		/**
62		* {@inheritDoc}
63		* @see \controllers\ControllerBase::isValid()
64		*/
65		public final function isValid($action) {
66		return true;
67		}
68
69		/**
70		* Action called when the user does not have access rights to a requested resource
71		* @param array\|string $urlParts
72		*/
73		public function noAccess($urlParts){
74		if(!is_array($urlParts)){
75		$urlParts=explode(".", $urlParts);
76		}
77		USession::set("urlParts", $urlParts);
78		$fMessage=$this->_noAccessMsg;
79		$this->noAccessMessage($fMessage);
80		$message=$this->fMessage($fMessage->parseContent(["url"=>implode("/",$urlParts)]));
81		/*if(URequest::isAjax()){
82		$this->jquery->get($this->_getBaseRoute()."/info/f","#_userInfo",["historize"=>false,"jqueryDone"=>"replaceWith","hasLoader"=>false,"attr"=>""]);
83		$this->jquery->compile($this->view);
84		}*/
85		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
86		}
87
88
89
90		/**
91		* Override to implement the complete connection procedure
92		*/
93		public function connect(){
94		if(URequest::isPost()){
95		if($connected=$this->_connect()){
96		if(isset($_POST["ck-remember"])){
97		$this->rememberMe($connected);
98		}
99		if(USession::exists($this->_attemptsSessionKey)){
100		USession::delete($this->_attemptsSessionKey);
101		}
102		$this->onConnect($connected);
103		}else{
104		$this->onBadCreditentials();
105		}
106		}
107		}
108
109		/**
110		* Default Action for invalid creditentials
111		*/
112		public function badLogin(){
113		$fMessage=new FlashMessage("Invalid creditentials!","Connection problem","warning","warning circle");
114		$this->badLoginMessage($fMessage);
115		$attemptsMessage="";
116		if(($nbAttempsMax=$this->attemptsNumber())!==null){
117		$nb=USession::getTmp($this->_attemptsSessionKey,$nbAttempsMax);
118		$nb--;
119		if($nb<0) $nb=0;
120		if($nb==0){
121		$fAttemptsNumberMessage=$this->noAttempts();
122		}else{
123		$fAttemptsNumberMessage=new FlashMessage("<i class='ui warning icon'></i> You still have {_attemptsCount} attempts to log in.",null,"bottom attached warning","");
124		}
125		USession::setTmp($this->_attemptsSessionKey, $nb,$this->attemptsTimeout());
126		$this->attemptsNumberMessage($fAttemptsNumberMessage,$nb);
127		$fAttemptsNumberMessage->parseContent(["_attemptsCount"=>$nb,"_timer"=>"<span id='timer'></span>"]);
128		$attemptsMessage=$this->fMessage($fAttemptsNumberMessage,"timeout-message");
129		$fMessage->addType("attached");
130		}
131		$message=$this->fMessage($fMessage,"bad-login").$attemptsMessage;
132		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
133		}
134
135		/**
136		* Logout action
137		* Terminate the session and display a logout message
138		*/
139		public function terminate(){
140		USession::terminate();
141		$fMessage=new FlashMessage("You have been properly disconnected!","Logout","success","checkmark");
142		$this->terminateMessage($fMessage);
143		$message=$this->fMessage($fMessage);
144		$this->authLoadView($this->_getFiles()->getViewNoAccess(),["_message"=>$message,"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector(),"_loginCaption"=>$this->_loginCaption]);
145		}
146
147		public function _disConnected(){
148		$fMessage=new FlashMessage("You have been disconnected from the application!","Logout","","sign out");
149		$this->disconnectedMessage($fMessage);
150		$message=$this->fMessage($fMessage);
151		$this->jquery->getOnClick("._signin", $this->getBaseUrl(),$this->_getBodySelector(),["stopPropagation"=>false,"preventDefault"=>false]);
152		$this->jquery->execOn("click", "._close", "window.open(window.location,'_self').close();");
153		return $this->jquery->renderView($this->_getFiles()->getViewDisconnected(),["_title"=>"Session ended","_message"=>$message],true);
154		}
155
156		/**
157		* Action displaying the logged user information
158		* if _displayInfoAsString returns true, use _infoUser var in views to display user info
159		* @return string\|null
160		*/
161		public function info($force=null){
162		if(isset($force)){
163		$displayInfoAsString=($force===true)?true:false;
164		}else{
165		$displayInfoAsString=$this->_displayInfoAsString();
166		}
167		return $this->loadView($this->_getFiles()->getViewInfo(),["connected"=>USession::get($this->_getUserSessionKey()),"authURL"=>$this->getBaseUrl(),"bodySelector"=>$this->_getBodySelector()],$displayInfoAsString);
168		}
169
170		public function checkConnection(){
171		UResponse::asJSON();
172		echo "{\"valid\":".UString::getBooleanStr($this->_isValidUser())."}";
173		}
174
175		/**
176		* Sets the default noAccess message
177		* Default : "You are not authorized to access the page <b>{url}</b> !"
178		* @param string $content
179		* @param string $title
180		* @param string $type
181		* @param string $icon
182		*/
183		public function _setNoAccessMsg($content,$title=NULL,$type=NULL,$icon=null) {
184		$this->_noAccessMsg->setValues($content,$title,$type,$icon);
185		}
186		/**
187		* @param string $_loginCaption
188		*/
189		public function _setLoginCaption($_loginCaption) {
190		$this->_loginCaption = $_loginCaption;
191		}
192
193		/**
194		* Auto connect the user
195		*/
196		public function _autoConnect() {
197		$cookie=$this->getCookieUser();
198		if(isset($cookie)){
199		$user=$this->fromCookie($cookie);
200		if(isset($user)){
201		USession::set($this->_getUserSessionKey(), $user);
202		}
203		}
204		}
205		/**
206		* Deletes the cookie for auto connection and returns to index
207		*/
208		public function forgetConnection(){
209		UCookie::delete($this->_getUserSessionKey());
210		$this->index();
211		}
212
213		/**
214		* {@inheritDoc}
215		* @see \Ubiquity\controllers\ControllerBase::finalize()
216		*/
217		public function finalize() {
218		if(!UResponse::isJSON()){
219		if(!URequest::isAjax()){
220		if(isset($this->_controllerInstance)){
221		call_user_func_array(array($this->_controllerInstance, 'parent::finalize'), []);
222		}else{
223		parent::finalize();
224		}
225		}
226		$this->jquery->execAtLast("if($('#_userInfo').length){\$('#_userInfo').html(".preg_replace("/$\R?^/m", "",Javascript::prep_element($this->info())).");}");
227		echo $this->jquery->compile();
228		}
229		}
230
231		/**
232		* {@inheritDoc}
233		* @see \Ubiquity\controllers\ControllerBase::initialize()
234		*/
235		public function initialize() {
236		if(!URequest::isAjax()){
237		if(isset($this->_controllerInstance)){
238		call_user_func_array(array($this->_controllerInstance, 'parent::initialize'), []);
239		}else{
240		parent::initialize();
241		}
242		}
243		}
244
245		/**
246		* @param string $url
247		*/
248		public function _forward($url){
249		$initFinalize=true;
250		if(isset($this->_controllerInstance) && !URequest::isAjax()){
251		$initFinalize=false;
252		}
253		Startup::forward($url,$initFinalize,$initFinalize);
254		}
255		}
256

phpMv / ubiquity

Push — master ( 367555...dfeadf )

AuthController::_setNoAccessMsg() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like