ServerApi - Code Metrics - tianye/WechatMpSDK - Measure and Improve Code Quality continuously with Scrutinizer

ServerApi C
last analyzed 2017-08-29 08:57 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	385
Duplicated Lines	2.86 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	69
c	0
b	0
f	0
lcom	1
cbo	3
dl	11
loc	385
rs	5.6445

11 Methods

Rating	Name	Duplication	Size	Complexity
C	on()	0	52	11
B	makeSignature()	0	15	5
B	encryptMsg()	0	22	6
B	decryptMsg()	0	21	5
B	checkSignature()	0	18	7
C	receiveAgent()	0	52	10
D	__call()	0	37	10
D	arrayToXml()	0	34	10
A	getXmlObject()	0	4	1
A	https_xml()	0	16	2
A	getRandomStr()	11	11	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ServerApi often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ServerApi, and based on these observations, apply Extract Interface, too.

<?php
namespace Wechat\API;

use Wechat\Api;
use Wechat\Utils\Code\WXBizMsgCrypt;

/**
 * 微信接收回调相关接口.
 *
 * @author Tian.
 */
class ServerApi extends BaseApi
{
    private static $XML_OBJECT;

    /**
     * 监听
     *
     * @param string          $target
     * @param string|callable $event
     * @param callable        $callback
     *
     * @return bool Server
     */

    public function on($target, $event, $callback = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $echostr        = isset($_GET['echostr']) ? $_GET['echostr'] : null;
        $checkSignature = $this->checkSignature();

        if (!$checkSignature) {
            exit("签名验证失败");

        }

        if (!empty($echostr)) {
            echo $echostr;
            exit;

        }

        if (is_null($callback)) {
            $callback = $event;
            $event    = '*';
        }

        if (!is_callable($callback)) {
            exit("$callback 不是一个可调用的函数或方法");

        }

        $rest = $this->$target($event);

        $datas         = [];
        $datas['data'] = $rest;

        if (!empty($rest)) {
            $rest_user                 = [];
            $rest_user['ToUserName']   = $rest['FromUserName'];
            $rest_user['FromUserName'] = $rest['ToUserName'];
            $rest_msg                  = call_user_func_array($callback, $datas);

            if ($rest_msg == 'success') {
                exit('success');

            }

            $rest_array = array_merge($rest_user, $rest_msg);

            $rest_xml = $this->arrayToXml($rest_array);

            $msg_signature = isset($_GET['msg_signature']) ? $_GET['msg_signature'] : null;
            if (!empty($msg_signature) && $msg_signature != '') {
                $rest_xml = $this->encryptMsg($rest_xml);
            }

            exit($rest_xml);

        } else {
            return false;
        }
    }

    /**
     * 验证签名
     *
     * string $signature [签名]
     * int    $timestamp [时间戳]
     * string $nonce     [随机字符串]
     *
     * @param string $token [token]
     *
     * @return mixed|bool
     */
    public function checkSignature($token = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $config_token = Api::getToken();
        $signature    = isset($_GET['signature']) ? $_GET['signature'] : null;
        $timestamp    = isset($_GET['timestamp']) ? $_GET['timestamp'] : null;
        $nonce        = isset($_GET['nonce']) ? $_GET['nonce'] : null;
        $token        = empty($token) ? $config_token : $token;
        $tmpArr       = [$token, $timestamp, $nonce];
        sort($tmpArr, SORT_STRING);
        $tmpStr = implode($tmpArr);
        $tmpStr = sha1($tmpStr);

        if ($tmpStr == $signature && $signature != null) {
            return $this;
        }

        return false;
    }

    /**
     * 生成签名 - 用作 转发到第三方
     *
     * @param string $token
     * @param string $time
     * @param string $nonce
     *
     * @return bool|string
     */
    public function makeSignature($token = null, $time = null, $nonce = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!is_string($token) || empty($token)) {
            exit("$token 参数错误");

        }

        $timestamp = !empty($time) ? $time : $_GET['timestamp'];
        $nonce     = !empty($nonce) ? $nonce : $_GET['nonce'];
        $tmpArr    = [$token, $timestamp, $nonce];
        sort($tmpArr, SORT_STRING);
        $tmpStr = implode($tmpArr);
        $tmpStr = sha1($tmpStr);

        return $tmpStr;
    }

    /**
     * 推送到第三方
     *
     * @param string $url      [地址]
     * @param string $token    [token]
     * @param string $xml      [XML]
     * @param bool   $encipher [是否加密]
     *
     * @return array|bool XML
     */
    public function receiveAgent($url = '', $token = '', $xml = '', $encipher = false)
    {
        $object = simplexml_load_string($xml, 'SimpleXMLElement', LIBXML_NOCDATA);

        $object = json_decode(json_encode($object), true);

        if (isset($object['Encrypt']) && !empty($object['Encrypt']) && $object['Encrypt'] != '') {
            $xml = $this->decryptMsg($xml);
        }

        if ($encipher) {
            $xml = $this->encryptMsg($xml);

            $object_enc                    = simplexml_load_string($xml, 'SimpleXMLElement', LIBXML_NOCDATA);
            $object_enc                    = json_decode(json_encode($object_enc), true);
            $postQueryStr                  = [];
            $postQueryStr['timestamp']     = $object_enc['TimeStamp'];
            $postQueryStr['nonce']         = $object_enc['Nonce'];
            $postQueryStr['signature']     = $this->makeSignature($token, $postQueryStr['timestamp'], $postQueryStr['nonce']);
            $postQueryStr['msg_signature'] = $object_enc['MsgSignature'];

            $array               = [];
            $array['ToUserName'] = $object['ToUserName'];
            $array['Encrypt']    = $object_enc['Encrypt'];

            $xml = $this->arrayToXml($array);
        } else {
            $postQueryStr['timestamp'] = time();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            $postQueryStr['nonce']     = $this->getRandomStr();
            $postQueryStr['signature'] = $this->makeSignature($token, $postQueryStr['timestamp'], $postQueryStr['nonce']);
        }

        asort($postQueryStr);
        $postQueryStr = http_build_query($postQueryStr);

        $rest = $this->https_xml($url . '?' . $postQueryStr, $xml);

        if ($rest) {
            $object_rest = simplexml_load_string($rest, 'SimpleXMLElement', LIBXML_NOCDATA);
            $object_rest = json_decode(json_encode($object_rest), true);

            if (!empty($object_rest['MsgSignature']) && !empty($object_rest['TimeStamp']) && !empty($object_rest['Nonce']) && !empty($object_rest['Encrypt'])) {
                $rest = $this->decryptMsg($rest, $object_rest['MsgSignature'], $object_rest['TimeStamp'], $object_rest['Nonce']);
            }
            $object_rest = simplexml_load_string($rest, 'SimpleXMLElement', LIBXML_NOCDATA);
            $rest_array  = json_decode(json_encode($object_rest), true);

            return $rest_array;
        }

        return false;
    }

    /**
     * 加密XML
     *
     * @param $xml
     *
     * @return string
     */
    public function encryptMsg($xml)
    {
        $appId          = Api::getAppId();
        $token          = Api::getToken();
        $encodingAesKey = Api::getEncoding_Aes_Key();

        if (empty($token) || !$token || empty($encodingAesKey) || !$encodingAesKey) {
            return $xml;
        }

        $timeStamp = time();
        $nonce     = $this->getRandomStr();

        $pc         = new WXBizMsgCrypt($token, $encodingAesKey, $appId);
        $encryptMsg = '';
        $errCode    = $pc->encryptMsg($xml, $timeStamp, $nonce, $encryptMsg);
        if ($errCode == 0) {
            return $encryptMsg;
        } else {
            exit($errCode);

        }
    }

    /**
     * 解密XML
     *
     * @param      $xml
     * @param null $msg_signature
     * @param null $timeStamp
     * @param null $nonce
     *
     * @return string
     */
    public function decryptMsg($xml, $msg_signature = null, $timeStamp = null, $nonce = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $appId          = Api::getAppId();
        $token          = Api::getToken();
        $encodingAesKey = Api::getEncoding_Aes_Key();

        $msg_signature = !empty($msg_signature) ? $msg_signature : $_GET['msg_signature'];
        $timeStamp     = !empty($timeStamp) ? $timeStamp : $_GET['timestamp'];
        $nonce         = !empty($nonce) ? $nonce : $_GET['nonce'];

        $pc  = new WXBizMsgCrypt($token, $encodingAesKey, $appId);
        $msg = '';

        $errCode = $pc->decryptMsg($msg_signature, $timeStamp, $nonce, $xml, $msg);

        if ($errCode == 0) {
            return $msg;
        } else {
            exit($errCode);

        }
    }

    /**
     * 魔术方法 处理 返回结果
     *
     * @param  string $target [事件]
     * @param         $event
     *
     * @return string $event  [类型]
     * @return array  $xml    [xml]
     */
    public function __call($target, $event)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $object = self::$XML_OBJECT;
        if (!$object || !is_object($object) || empty($object)) {
            $xml = file_get_contents('php://input');

            $msg_signature = isset($_GET['msg_signature']) ? $_GET['msg_signature'] : null;

            if (!empty($msg_signature) && $msg_signature != '') {
                $xml = $this->decryptMsg($xml);
            }

            $object           = simplexml_load_string($xml, 'SimpleXMLElement', LIBXML_NOCDATA);
            self::$XML_OBJECT = $object;
        }

        $target = strtolower(trim($target));

        $event = strtolower(trim(reset($event)));

        $rx_target = strtolower(trim($object->MsgType));
        $rx_event  = strtolower(trim($object->Event));

        if ($target == $rx_target) {
            if ($event == '*') {
                $array = json_decode(json_encode($object), true);
            } elseif ($event == $rx_event) {
                $array = json_decode(json_encode($object), true);
            } else {
                $array = false;
            }
        } else {
            $array = false;
        }

        return $array;
    }

    /**
     * array转xml.
     *
     * @param array $arr
     * @param bool  $flag
     * @param bool  $especial
     *
     * @return string
     */
    public function arrayToXml($arr = [], $flag = true, $especial = false)
    {
        if ($flag) {
            $xml = '<xml>';
        } else {
            $xml = '';
        }

        foreach ($arr as $key => $val) {
            if (is_numeric($val)) {
                $xml .= '<' . $key . '>' . $val . '</' . $key . '>';
            } elseif (is_array($val)) {
                if (strtolower($key) == 'item') {
                    $xml .= $this->arrayToXml($val, false, true);
                } elseif ($especial == true) {

                    $xml .= '<item>';
                    $xml .= $this->arrayToXml($val, false, true);
                    $xml .= '</item>';
                } else {
                    $xml .= !is_numeric($key) ? '<' . ucfirst($key) . '>' : '';
                    $xml .= $this->arrayToXml($val, false);
                    $xml .= !is_numeric($key) ? '</' . ucfirst($key) . '>' : '';
                }
            } else {
                $xml .= '<' . $key . '><![CDATA[' . $val . ']]></' . $key . '>';
            }
        }

        if ($flag) {
            $xml .= '</xml>';
        }

        return $xml;
    }

    public function getXmlObject()
    {
        return self::$XML_OBJECT;
    }

    /**
     * 第三方 post 推送
     *
     * @param      $url
     * @param null $xml
     *
     * @return mixed
     */
    public function https_xml($url, $xml = null)
    {
        $ch = curl_init($url);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        //curl_setopt($ch, CURLOPT_HTTPHEADER, $header);

        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
        $response = curl_exec($ch);
        if (curl_errno($ch)) {
            print curl_error($ch);
        }
        curl_close($ch);

        return $response;
    }

    /**
     * 随机生成16位字符串
     *
     * @return string 生成的字符串
     */
    public function getRandomStr()

    {
        $str     = "";
        $str_pol = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789abcdefghijklmnopqrstuvwxyz";
        $max     = strlen($str_pol) - 1;
        for ($i = 0; $i < 16; $i++) {
            $str .= $str_pol[mt_rand(0, $max)];
        }

        return $str;
    }
}

1			<?php
2			namespace Wechat\API;
3
4			use Wechat\Api;
5			use Wechat\Utils\Code\WXBizMsgCrypt;
6
7			/**
8			* 微信接收回调相关接口.
9			*
10			* @author Tian.
11			*/
12			class ServerApi extends BaseApi
13			{
14			private static $XML_OBJECT;
15
16			/**
17			* 监听
18			*
19			* @param string $target
20			* @param string\|callable $event
21			* @param callable $callback
22			*
23			* @return bool Server
24			*/
25
26			public function on($target, $event, $callback = null)
			0 ignored issues – show Coding Style introduced 2017-08-29 08:57 UTC by Report Bug Copy Issue Report `on` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
27			{
28			$echostr = isset($_GET['echostr']) ? $_GET['echostr'] : null;
29			$checkSignature = $this->checkSignature();
30
31			if (!$checkSignature) {
32			exit("签名验证失败");
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-06 08:27 UTC by Report Bug Copy Issue Report The method `on()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
33			}
34
35			if (!empty($echostr)) {
36			echo $echostr;
37			exit;
			0 ignored issues – show Coding Style Compatibility introduced 2016-08-06 08:27 UTC by Report Bug Copy Issue Report The method `on()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...

tianye / WechatMpSDK

ServerApi C last analyzed 2017-08-29 08:57 UTC