AuthAccountCreationTrait.php

Go to the documentation of this file.

<?php
 
namespace Ubiquity\controllers\auth\traits;
 
use Ajax\semantic\components\validation\Rule;
use Ajax\semantic\html\collections\form\HtmlForm;
use Ubiquity\controllers\auth\AuthFiles;
use Ubiquity\controllers\auth\AuthTokens;
use Ubiquity\utils\base\UDateTime;
use Ubiquity\utils\flash\FlashMessage;
use Ubiquity\utils\http\URequest;
 
class AuthAccountCreationTrait {
 
    protected static string $TOKENS_VALIDATE_EMAIL='email.validation';
 
    abstract protected function getBaseUrl():string;
 
    abstract protected function fMessage(FlashMessage $fMessage, $id = null):string;
 
    abstract protected function useAjax():bool;
 
    abstract public function _addFrmAjaxBehavior($id):HtmlForm;
 
    abstract public function _getPasswordInputName():string;
 
    abstract public function _getLoginInputName():string;
 
    abstract protected function authLoadView($viewName, $vars = [ ]):void;
 
    abstract protected function rememberCaption():string;
 
    abstract protected function loginLabel():string;
 
    abstract protected function passwordConfLabel(): string;
 
    abstract protected function passwordLabel(): string;
 
    abstract protected function _getFiles(): AuthFiles;
 
    abstract public function _getBodySelector():string;
 
    protected function hasAccountCreation():bool{
        return false;
    }
 
    protected function hasEmailValidation():bool{
        return false;
    }
 
    protected function emailValidationDuration():\DateInterval{
        return new \DateInterval('PT24H');
    }
    protected function createAccountMessage(FlashMessage $fMessage) {
    }
 
    protected function canCreateAccountMessage(FlashMessage $fMessage) {
    }
 
    protected function createAccountErrorMessage(FlashMessage $fMessage) {
    }
 
    protected function emailValidationSuccess(FlashMessage $fMessage){
 
    }
 
    protected function emailValidationError(FlashMessage $fMessage){
 
    }
 
    protected function _create(string $login,string $password):?bool{
        return false;
    }
    
    protected function _newAccountCreationRule(string $accountName):?bool{
        
    }
    
    protected function _sendEmailValidation(string $email,string $validationURL,string $expire):void{
        
    }
    
    protected function getEmailFromNewAccount($account):string{
        return $account;
    }
 
    protected function getAuthTokensEmailValidation():AuthTokens{
        return new AuthTokens(self::$TOKENS_VALIDATE_EMAIL,10,$this->emailValidationDuration()->s,false);
    }
 
    protected function generateEmailValidationUrl($email):array {
        $duration=$this->emailValidationDuration();
        $tokens=$this->getAuthTokensEmailValidation();
        $d=new \DateTime();
        $dExpire=$d->add($duration);
        $key=$tokens->store(['email'=>$email]);
        return ['url'=>$key.'/'.\md5($email),'expire'=>$dExpire];
    }
 
    protected function prepareEmailValidation(string $email){
        $data=$this->generateEmailValidationUrl($email);
        $validationURL=$this->getBaseUrl().'/checkEmail/'.$data['url'];
        $this->_sendEmailValidation($email, $validationURL,UDateTime::elapsed($data['expire']));
    }
 
    protected function validateEmail(string $mail):bool{
        return true;
    }
 
 
    public function checkEmail(string $key,string $hashMail){
        $isValid=false;
        $tokens=$this->getAuthTokensEmailValidation();
        if($tokens->exists($key)){
            if(!$tokens->expired($key)){
                $data=$tokens->fetch($key);
                $email=$data['email'];
                if(\md5($email)===$hashMail && $this->validateEmail($email)){
                    $fMessage = new FlashMessage ( "Your email <b>$email</b> has been validated.", 'Account creation', 'success', 'user' );
                    $this->emailValidationSuccess($fMessage);
                    $isValid=true;
                }
                $msg='This validation link is not valid!';
            }else{
                $msg='This validation link is no longer active!';
            }
        }
        if(!$isValid){
            $fMessage = new FlashMessage ( $msg??'This validation link is not valid!', 'Account creation', 'error', 'user' );
            $this->emailValidationError($fMessage);
        }
        echo $this->fMessage($fMessage);
    }
 
    public function addAccount(){
        if($this->hasAccountCreation()){
            $loginInputName=$this->_getLoginInputName();
            $passwordInputName=$this->_getPasswordInputName();
            if($this->useAjax()){
                $frm=$this->_addFrmAjaxBehavior('frm-create');
                $frm->addExtraFieldRules($passwordInputName.'-conf', ['empty',"match[$passwordInputName]"]);
                if($this->_newAccountCreationRule('')!==null){
                    $this->jquery->exec(Rule::ajax($this->jquery, 'checkAccount', $this->getBaseUrl () . '/newAccountCreationRule', '{}', 'result=data.result;', 'postForm', [
                        'form' => 'frm-create'
                    ]), true);
                    $frm->addExtraFieldRule($loginInputName, 'checkAccount',"This $loginInputName value is not available!");
                }
            }
            $this->authLoadView ( $this->_getFiles ()->getViewCreate(), [ 'action' => $this->getBaseUrl () . '/createAccount','loginInputName' => $loginInputName,'loginLabel' => $this->loginLabel (),'passwordInputName' => $passwordInputName,'passwordLabel' => $this->passwordLabel (),'passwordConfLabel'=>$this->passwordConfLabel(),'rememberCaption' => $this->rememberCaption () ] );
        }
    }
 
 
    #[\Ubiquity\attributes\items\router\Post]
    public function createAccount(){
        $account=URequest::post($this->_getLoginInputName());
        $msgSup='';
        if($this->_create($account,URequest::post($this->_getPasswordInputName()))){
            if($this->hasEmailValidation()){
                $email=$this->getEmailFromNewAccount($account);
                $this->prepareEmailValidation($email);
                $msgSup="<br>Confirm your email address <b>$email</b> by checking your mailbox.";
            }
            $msg=new FlashMessage ( '<b>{account}</b> account created with success!'.$msgSup, 'Account creation', 'success', 'check square' );
        }else{
            $msg=new FlashMessage ( 'The account <b>{account}</b> was not created!', 'Account creation', 'error', 'warning circle' );
        }
        $message=$this->fMessage($msg->parseContent(['account'=>$account]));
        $this->authLoadView ( $this->_getFiles ()->getViewNoAccess (), [ '_message' => $message,'authURL' => $this->getBaseUrl (),'bodySelector' => $this->_getBodySelector (),'_loginCaption' => $this->_loginCaption ] );
    }
}