Gateway::checkState() - Code Metrics - Inspection of ".gitattributes" - majiameng/OAuth2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 65f1dc...1ff528 )

by ma
created 2023-06-16 11:30 UTC
Gateway::checkState() A

↳ Parent: Gateway
Complexity

Conditions	6
Paths	5
Size

Total Lines	7
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	5
c	0
b	0
f	0
dl	0
loc	7
rs	9.2222
cc	6
nc	5
nop	0
<?php
namespace tinymeng\OAuth2\Connector;

use tinymeng\OAuth2\Helper\ConstCode;
use tinymeng\OAuth2\Helper\Str;

/**
 * 所有第三方登录必须继承的抽象类
 */
abstract class Gateway implements GatewayInterface
{
    /**
     * 配置参数
     * @var array
     */
    protected $config;

    /**
     * AppId
     * @var array
     */
    protected $app_id;

    /**
     * AppSecret
     * @var string
     */
    protected $app_secret;

    /**
     * 回调地址
     * @var string
     */
    protected $callback;

    /**
     * 当前时间戳
     * @var int
     */
    protected $timestamp;

    /**
     * 默认第三方授权页面样式
     * @var string
     */
    protected $display = 'default';

    /**
     * 登录类型：app applets
     * @var bool
     */
    protected $type;

    /**
     * 第三方Token信息
     * @var array
     */
    protected $token = null;

    /**
     * 是否验证回跳地址中的state参数
     * @var boolean
     */
    protected $checkState = false;

    /**
     * 第三方返回的userInfo
     * @var array
     */
    protected $userInfo = [];

    /**
     * 格式化的userInfo
     * @var array
     */
    protected $formatUserInfo = [];

    /**
     * Gateway constructor.
     * @param $config
     * @throws \Exception
     */
    public function __construct($config)
    {
        if (!$config) {
            throw new \Exception('传入的配置不能为空');
        }
        if(isset($_GET['referer']) && $config['callback']){
            $config['callback'] .= ((strpos($config['callback'], '?') !== false) ? '&' : '?').'referer='.$_GET['referer'];
        }
        //默认参数
        $_config = [
            'app_id'        => '',
            'app_secret'    => '',
            'callback'      => '',
            'response_type' => 'code',
            'grant_type'    => 'authorization_code',
            'proxy'         => '',
            'state'         => '',
            'type'          => '',
            'is_sandbox'    => false,//是否是沙箱环境
        ];
        $this->config    = array_merge($_config, $config);
        foreach($this->config as $key=>$val){
            if(property_exists($this,$key)) $this->$key=$val;
        }
        $this->timestamp = time();
    }

    /**
     * Description:  设置授权页面样式
     * @author: JiaMeng <[email protected]>
     * Updater:
     * @param $display
     * @return $this
     */
    public function setDisplay($display)
    {
        $this->display = $display;
        return $this;
    }

    /**
     * Description:  设置是否是App
     * @author: JiaMeng <[email protected]>
     * Updater:
     * @return $this
     */
    public function setType($type)
    {
        $this->type = $type;
        return $this;
    }

    /**
     * Description:  强制验证回跳地址中的state参数
     * @author: JiaMeng <[email protected]>
     * Updater:
     * @return $this
     */
    public function mustCheckState(){
        $this->checkState = true;
        return $this;
    }

    /**
     * 获取配置信息
     * @Author: TinyMeng <[email protected]>
     * @return array
     */
    public function getConfig(){
        return $this->config;
    }

    /**
     * 设置token(App登录时)
     * @param $token
     * @return $this
     */
    public function setToken($token){
        $this->token = $token;
        return $this;
    }

    /**
     * 存储state
     * @Author: TinyMeng <[email protected]>
     */
    public function saveState(){
        if ($this->checkState === true) {
            //是否开启session
            if (session_status() !== PHP_SESSION_ACTIVE) {
                session_start();
            }
            if(empty($this->config['state'])){
                $this->config['state'] = Str::random();//生成随机state
            }
            //存储到session
            $_SESSION['tinymeng_oauth_state'] = $this->config['state'];
        }
    }

    /**
     * 验证state
     * @Author: TinyMeng <[email protected]>
     * @throws \Exception
     */
    public function checkState(){
        if ($this->checkState === true) {
            if (session_status() !== PHP_SESSION_ACTIVE) {
                session_start();
            }
            if (!isset($_REQUEST['state']) || !isset($_SESSION['tinymeng_oauth_state']) || $_REQUEST['state'] != $_SESSION['tinymeng_oauth_state']) {
                throw new \Exception('传递的STATE参数不匹配！');
            }
        }
    }

    /**
     * Description:  默认获取AccessToken请求参数
     * @author: JiaMeng <[email protected]>
     * Updater:
     * @return array
     */
    protected function accessTokenParams(){
        $params = [
            'client_id'     => $this->config['app_id'],
            'client_secret' => $this->config['app_secret'],
            'grant_type'    => $this->config['grant_type'],
            'code'          => isset($_REQUEST['code']) ? $_REQUEST['code'] : '',
            'redirect_uri'  => $this->config['callback'],
        ];
        return $params;
    }

    /**
     * Description:  获取AccessToken
     * @author: JiaMeng <[email protected]>
     * Updater:
     */
    protected function getToken(){
        if (empty($this->token)) {
            /** 验证state参数 */
            $this->checkState();

            /** 获取参数 */
            $params = $this->accessTokenParams();

            /** 获取access_token */
            $token =  $this->POST($this->AccessTokenURL, $params);
            /** 解析token值(子类实现此方法) */
            $this->token = $this->parseToken($token);
            $this->token = $this->parseToken($token);
        }
    }

    /**
     * Description:  执行GET请求操作
     * @author: JiaMeng <[email protected]>
     * Updater:
     * @param $url
     * @param array $params
     * @param array $headers
     * @return string
     */
    protected function get($url, $params = [], $headers = [])
    {
        return \tinymeng\tools\HttpRequest::httpGet($url, $params,$headers);
    }

    /**
     * Description:  执行POST请求操作
     * @author: JiaMeng <[email protected]>
     * Updater:
     * @param $url
     * @param array $params
     * @param array $headers
     * @return mixed
     */
    protected function post($url, $params = [], $headers = [])
    {
        $headers[] = 'Accept: application/json';//GitHub需要的header
        return \tinymeng\tools\HttpRequest::httpPost($url, $params,$headers);
    }

    /**
     * 格式化性别参数
     * M代表男性,F代表女性
     * @param $gender
     */
    public function getGender($gender){
        return strtolower(substr($gender , 0 , 1)) == 'm' ? ConstCode::GENDER_MAN : ConstCode::GENDER_WOMEN;
    }
}

majiameng / OAuth2

Push — master ( 65f1dc...1ff528 )

Gateway::checkState() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
