Client::setEventDispatcher() - Code Metrics - Inspection of "modify testcase & readme" - slince/smartqq - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( fbea6a...5a4cf9 )

by Taosikai

created 2018-09-27 06:36 UTC

Client::setEventDispatcher() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/*
 * This file is part of the slince/smartqq package.
 *
 * (c) Slince <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slince\SmartQQ;

use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Psr7\Request as HttpRequest;
use GuzzleHttp\Psr7\Response as HttpResponse;
use Slince\EventDispatcher\Dispatcher;
use Slince\EventDispatcher\DispatcherInterface;
use Slince\SmartQQ\Entity;
use Slince\SmartQQ\Exception\InvalidArgumentException;
use Slince\SmartQQ\Message\Request\FriendMessage;
use Slince\SmartQQ\Message\Request\GroupMessage;
use Slince\SmartQQ\Message\Request\Message as RequestMessage;
use Slince\SmartQQ\Message\Response\Message as ResponseMessage;
use Slince\SmartQQ\Request;

class Client
{
    /**
     * 客户端id(固定值).
     *
     * @var int
     */
    static $clientId = 53999199;

    /**
     * @var Credential
     */
    protected $credential;

    /**
     * @var HttpClient
     */
    protected $httpClient;

    /**
     * @var DispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * @var MessageHandler
     */
    protected $messageHandler;

    public function __construct(
        Credential $credential = null,
        HttpClient $httpClient = null,
        DispatcherInterface $eventDispatcher = null
    )
    {
        if (!is_null($credential)) {
            $this->setCredential($credential);
        }
        if (is_null($httpClient)) {
            $httpClient = new HttpClient([
                'verify' => false,
            ]);
        }
        if (is_null($eventDispatcher)) {
            $eventDispatcher = new Dispatcher();
        }
        $this->httpClient = $httpClient;
        $this->eventDispatcher = $eventDispatcher;
    }

    /**
     * 开启登录流程自行获取凭证
     *
     * @param string|callable $callback 二维码图片位置|或者自定义处理器
     * @return Credential
     */
    public function login($callback)
    {
        // 兼容二维码位置传参
        if (is_string($callback)) {
            /* @deprecated 后面会废除此用法，建议传闭包自己处理二维码 */
            $callback = function ($qrcode) use($callback){
                Utils::getFilesystem()->dumpFile($callback, $qrcode);
            };
        }

        $resolver = new CredentialResolver($this);
        // 进行授权流程，确认授权
        $resolver->resolve($callback);
        // 等待授权验证成功
        $credential = $resolver->wait();
        $this->setCredential($credential);
        //获取在线状态避免103
        $this->getFriendsOnlineStatus();

        return $credential;
    }


    /**
     * 设置凭据.
     *
     * @param Credential $credential
     */
    public function setCredential(Credential $credential)
    {
        $this->credential = $credential;
    }

    /**
     * 获取正在使用的凭据.
     *
     * @return Credential
     */
    public function getCredential()
    {
        if (!$this->credential) {
            throw new InvalidArgumentException('Please login first or set a credential');
        }

        return $this->credential;
    }

    /**
     * 设置 http 请求客户端.
     *
     * @param HttpClient $httpClient
     */
    public function setHttpClient($httpClient)
    {
        $this->httpClient = $httpClient;
    }

    /**
     * 获取 http 客户端
     * @return HttpClient
     */
    public function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * 获取事件处理器.
     *
     * @return DispatcherInterface
     */
    public function getEventDispatcher()
    {
        return $this->eventDispatcher;
    }

    /**
     * 获取所有的群.
     *
     * @return EntityCollection
     */
    public function getGroups()
    {
        $request = new Request\GetGroupsRequest($this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetGroupsRequest::parseResponse($response);
    }

    /**
     * 获取群详细信息.
     *
     * @param Entity\Group $group
     *
     * @return Entity\GroupDetail
     */
    public function getGroupDetail(Entity\Group $group)
    {
        $request = new Request\GetGroupDetailRequest($group, $this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetGroupDetailRequest::parseResponse($response);
    }

    /**
     * 获取所有讨论组.
     *
     * @return EntityCollection
     */
    public function getDiscusses()
    {
        $request = new Request\GetDiscussesRequest($this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetDiscussesRequest::parseResponse($response);
    }

    /**
     * 获取讨论组详情.
     *
     * @param Entity\Discuss $discuss
     *
     * @return Entity\DiscussDetail
     */
    public function getDiscussDetail(Entity\Discuss $discuss)
    {
        $request = new Request\GetDiscussDetailRequest($discuss, $this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetDiscussDetailRequest::parseResponse($response);
    }

    /**
     * 获取所有的好友.
     *
     * @return EntityCollection|Entity\Friend[]
     */
    public function getFriends()
    {
        $request = new Request\GetFriendsRequest($this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetFriendsRequest::parseResponse($response);
    }

    /**
     * 获取好友的详细信息.
     *
     * @param Entity\Friend $friend
     *
     * @return Entity\Profile
     */
    public function getFriendDetail(Entity\Friend $friend)
    {
        $request = new Request\GetFriendDetailRequest($friend, $this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetFriendDetailRequest::parseResponse($response);
    }

    /**
     * 获取好友的QQ号.
     *
     * @param Entity\Friend $friend
     *
     * @return int
     * @deprecated 此接口 Smartqq 官方已经不再提供
     */
    public function getFriendQQ(Entity\Friend $friend)
    {
        @trigger_error('The api is not supported now',E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        $request = new Request\GetQQRequest($friend, $this->getCredential());
        $response = $this->sendRequest($request);
        $qq = Request\GetQQRequest::parseResponse($response);
        $friend->setQq($qq);

        return $qq;
    }

    /**
     * 获取好友的个性签名.
     *
     * @param Entity\Friend $friend
     *
     * @return string
     */
    public function getFriendLnick(Entity\Friend $friend)
    {
        $request = new Request\GetLnickRequest($friend, $this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetLnickRequest::parseResponse($response, $friend);
    }

    /**
     * 获取好友在线状态
     *
     * @return EntityCollection
     */
    public function getFriendsOnlineStatus()
    {
        $request = new Request\GetFriendsOnlineStatusRequest($this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetFriendsOnlineStatusRequest::parseResponse($response);
    }

    /**
     * 获取最近的会话.
     *
     * @return EntityCollection|Entity\Recent[]
     */
    public function getRecentList()
    {
        $request = new Request\GetRecentListRequest($this->getCredential());
        $response = $this->sendRequest($request);

        return Request\GetRecentListRequest::parseResponse($response);
    }

    /**
     * 获取当前登录用户信息.
     *
     * @return Entity\Profile
     */
    public function getCurrentUserInfo()
    {
        $request = new Request\GetCurrentUserRequest();
        $response = $this->sendRequest($request);

        return Request\GetCurrentUserRequest::parseResponse($response);
    }

    /**
     * 轮询消息,
     * client并不会组装信息，只是将接口返回的信息完整抽象并返回
     * 如果需要查询信息对应的数据，如发送人、发送群，请自行获取.
     *
     * @return ResponseMessage[]
     */
    public function pollMessages()
    {
        $request = new Request\PollMessagesRequest($this->getCredential());
        $response = $this->sendRequest($request);

        return Request\PollMessagesRequest::parseResponse($response);
    }

    /**
     * 获取 Message handler.
     *
     * @return MessageHandler
     */
    public function getMessageHandler()
    {
        if (null !== $this->messageHandler) {
            return $this->messageHandler;
        }
        return $this->messageHandler = new MessageHandler($this);
    }

    /**
     * 发送消息，包括好友消息，群消息，讨论组消息.
     *
     * @param RequestMessage $message
     *
     * @return bool
     */
    public function sendMessage(RequestMessage $message)
    {
        if ($message instanceof FriendMessage) {
            $request = new Request\SendFriendMessageRequest($message, $this->getCredential());
        } elseif ($message instanceof GroupMessage) {
            $request = new Request\SendGroupMessageRequest($message, $this->getCredential());
        } else {
            $request = new Request\SendDiscusMessageRequest($message, $this->getCredential());

        }
        $response = $this->sendRequest($request);

        return Request\SendMessageRequest::parseResponse($response);
    }


    /**
     * 发送请求
     *
     * @param Request\RequestInterface $request
     * @param array $options
     *
     * @return HttpResponse
     */
    public function sendRequest(Request\RequestInterface $request, array $options = [])
    {
        // cookies 必须启用，如果不设置则使用当前凭证的cookie.
        if (!isset($options['cookies']) && $this->credential) {
            $options['cookies'] = $this->credential->getCookies();
        }
        if ($parameters = $request->getParameters()) {
            if (Request\RequestInterface::REQUEST_METHOD_GET == $request->getMethod()) {
                $options['query'] = $parameters;
            } else {
                $options['form_params'] = $parameters;
            }
        }
        //如果有referer需要伪造该信息
        if ($referer = $request->getReferer()) {
            $options['headers'] = [
                'Referer' => $referer,
            ];
        }
        $response = $this->httpClient->send(
            new HttpRequest($request->getMethod(), $request->getUri()),
            $options
        );

        return $response;
    }
}


1			<?php
2			/*
3			* This file is part of the slince/smartqq package.
4			*
5			* (c) Slince <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace Slince\SmartQQ;
12
13			use GuzzleHttp\Client as HttpClient;
14			use GuzzleHttp\Psr7\Request as HttpRequest;
15			use GuzzleHttp\Psr7\Response as HttpResponse;
16			use Slince\EventDispatcher\Dispatcher;
17			use Slince\EventDispatcher\DispatcherInterface;
18			use Slince\SmartQQ\Entity;
19			use Slince\SmartQQ\Exception\InvalidArgumentException;
20			use Slince\SmartQQ\Message\Request\FriendMessage;
21			use Slince\SmartQQ\Message\Request\GroupMessage;
22			use Slince\SmartQQ\Message\Request\Message as RequestMessage;
23			use Slince\SmartQQ\Message\Response\Message as ResponseMessage;
24			use Slince\SmartQQ\Request;
25
26			class Client
27			{
28			/**
29			* 客户端id(固定值).
30			*
31			* @var int
32			*/
33			static $clientId = 53999199;
34
35			/**
36			* @var Credential
37			*/
38			protected $credential;
39
40			/**
41			* @var HttpClient
42			*/
43			protected $httpClient;
44
45			/**
46			* @var DispatcherInterface
47			*/
48			protected $eventDispatcher;
49
50			/**
51			* @var MessageHandler
52			*/
53			protected $messageHandler;
54
55			public function __construct(
56			Credential $credential = null,
57			HttpClient $httpClient = null,
58			DispatcherInterface $eventDispatcher = null
59			)
60			{
61			if (!is_null($credential)) {
62			$this->setCredential($credential);
63			}
64			if (is_null($httpClient)) {
65			$httpClient = new HttpClient([
66			'verify' => false,
67			]);
68			}
69			if (is_null($eventDispatcher)) {
70			$eventDispatcher = new Dispatcher();
71			}
72			$this->httpClient = $httpClient;
73			$this->eventDispatcher = $eventDispatcher;
74			}
75
76			/**
77			* 开启登录流程自行获取凭证
78			*
79			* @param string\|callable $callback 二维码图片位置\|或者自定义处理器
80			* @return Credential
81			*/
82			public function login($callback)
83			{
84			// 兼容二维码位置传参
85			if (is_string($callback)) {
86			/* @deprecated 后面会废除此用法，建议传闭包自己处理二维码 */
87			$callback = function ($qrcode) use($callback){
88			Utils::getFilesystem()->dumpFile($callback, $qrcode);
89			};
90			}
91
92			$resolver = new CredentialResolver($this);
93			// 进行授权流程，确认授权
94			$resolver->resolve($callback);
95			// 等待授权验证成功
96			$credential = $resolver->wait();
97			$this->setCredential($credential);
98			//获取在线状态避免103
99			$this->getFriendsOnlineStatus();
100
101			return $credential;
102			}
103
104
105			/**
106			* 设置凭据.
107			*
108			* @param Credential $credential
109			*/
110			public function setCredential(Credential $credential)
111			{
112			$this->credential = $credential;
113			}
114
115			/**
116			* 获取正在使用的凭据.
117			*
118			* @return Credential
119			*/
120			public function getCredential()
121			{
122			if (!$this->credential) {
123			throw new InvalidArgumentException('Please login first or set a credential');
124			}
125
126			return $this->credential;
127			}
128
129			/**
130			* 设置 http 请求客户端.
131			*
132			* @param HttpClient $httpClient
133			*/
134			public function setHttpClient($httpClient)
135			{
136			$this->httpClient = $httpClient;
137			}
138
139			/**
140			* 获取 http 客户端
141			* @return HttpClient
142			*/
143			public function getHttpClient()
144			{
145			return $this->httpClient;
146			}
147
148			/**
149			* 获取事件处理器.
150			*
151			* @return DispatcherInterface
152			*/
153			public function getEventDispatcher()
154			{
155			return $this->eventDispatcher;
156			}
157
158			/**
159			* 获取所有的群.
160			*
161			* @return EntityCollection
162			*/
163			public function getGroups()
164			{
165			$request = new Request\GetGroupsRequest($this->getCredential());
166			$response = $this->sendRequest($request);
167
168			return Request\GetGroupsRequest::parseResponse($response);
169			}
170
171			/**
172			* 获取群详细信息.
173			*
174			* @param Entity\Group $group
175			*
176			* @return Entity\GroupDetail
177			*/
178			public function getGroupDetail(Entity\Group $group)
179			{
180			$request = new Request\GetGroupDetailRequest($group, $this->getCredential());
181			$response = $this->sendRequest($request);
182
183			return Request\GetGroupDetailRequest::parseResponse($response);
184			}
185
186			/**
187			* 获取所有讨论组.
188			*
189			* @return EntityCollection
190			*/
191			public function getDiscusses()
192			{
193			$request = new Request\GetDiscussesRequest($this->getCredential());
194			$response = $this->sendRequest($request);
195
196			return Request\GetDiscussesRequest::parseResponse($response);
197			}
198
199			/**
200			* 获取讨论组详情.
201			*
202			* @param Entity\Discuss $discuss
203			*
204			* @return Entity\DiscussDetail
205			*/
206			public function getDiscussDetail(Entity\Discuss $discuss)
207			{
208			$request = new Request\GetDiscussDetailRequest($discuss, $this->getCredential());
209			$response = $this->sendRequest($request);
210
211			return Request\GetDiscussDetailRequest::parseResponse($response);
212			}
213
214			/**
215			* 获取所有的好友.
216			*
217			* @return EntityCollection\|Entity\Friend[]
218			*/
219			public function getFriends()
220			{
221			$request = new Request\GetFriendsRequest($this->getCredential());
222			$response = $this->sendRequest($request);
223
224			return Request\GetFriendsRequest::parseResponse($response);
225			}
226
227			/**
228			* 获取好友的详细信息.
229			*
230			* @param Entity\Friend $friend
231			*
232			* @return Entity\Profile
233			*/
234			public function getFriendDetail(Entity\Friend $friend)
235			{
236			$request = new Request\GetFriendDetailRequest($friend, $this->getCredential());
237			$response = $this->sendRequest($request);
238
239			return Request\GetFriendDetailRequest::parseResponse($response);
240			}
241
242			/**
243			* 获取好友的QQ号.
244			*
245			* @param Entity\Friend $friend
246			*
247			* @return int
248			* @deprecated 此接口 Smartqq 官方已经不再提供
249			*/
250			public function getFriendQQ(Entity\Friend $friend)
251			{
252			@trigger_error('The api is not supported now',E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2018-07-09 08:24 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
253
254			$request = new Request\GetQQRequest($friend, $this->getCredential());
255			$response = $this->sendRequest($request);
256			$qq = Request\GetQQRequest::parseResponse($response);
257			$friend->setQq($qq);
258
259			return $qq;
260			}
261
262			/**
263			* 获取好友的个性签名.
264			*
265			* @param Entity\Friend $friend
266			*
267			* @return string
268			*/
269			public function getFriendLnick(Entity\Friend $friend)
270			{
271			$request = new Request\GetLnickRequest($friend, $this->getCredential());
272			$response = $this->sendRequest($request);
273
274			return Request\GetLnickRequest::parseResponse($response, $friend);
275			}
276
277			/**
278			* 获取好友在线状态
279			*
280			* @return EntityCollection
281			*/
282			public function getFriendsOnlineStatus()
283			{
284			$request = new Request\GetFriendsOnlineStatusRequest($this->getCredential());
285			$response = $this->sendRequest($request);
286
287			return Request\GetFriendsOnlineStatusRequest::parseResponse($response);
288			}
289
290			/**
291			* 获取最近的会话.
292			*
293			* @return EntityCollection\|Entity\Recent[]
294			*/
295			public function getRecentList()
296			{
297			$request = new Request\GetRecentListRequest($this->getCredential());
298			$response = $this->sendRequest($request);
299
300			return Request\GetRecentListRequest::parseResponse($response);
301			}
302
303			/**
304			* 获取当前登录用户信息.
305			*
306			* @return Entity\Profile
307			*/
308			public function getCurrentUserInfo()
309			{
310			$request = new Request\GetCurrentUserRequest();
311			$response = $this->sendRequest($request);
312
313			return Request\GetCurrentUserRequest::parseResponse($response);
314			}
315
316			/**
317			* 轮询消息,
318			* client并不会组装信息，只是将接口返回的信息完整抽象并返回
319			* 如果需要查询信息对应的数据，如发送人、发送群，请自行获取.
320			*
321			* @return ResponseMessage[]
322			*/
323			public function pollMessages()
324			{
325			$request = new Request\PollMessagesRequest($this->getCredential());
326			$response = $this->sendRequest($request);
327
328			return Request\PollMessagesRequest::parseResponse($response);
329			}
330
331			/**
332			* 获取 Message handler.
333			*
334			* @return MessageHandler
335			*/
336			public function getMessageHandler()
337			{
338			if (null !== $this->messageHandler) {
339			return $this->messageHandler;
340			}
341			return $this->messageHandler = new MessageHandler($this);
342			}
343
344			/**
345			* 发送消息，包括好友消息，群消息，讨论组消息.
346			*
347			* @param RequestMessage $message
348			*
349			* @return bool
350			*/
351			public function sendMessage(RequestMessage $message)
352			{
353			if ($message instanceof FriendMessage) {
354			$request = new Request\SendFriendMessageRequest($message, $this->getCredential());
355			} elseif ($message instanceof GroupMessage) {
356			$request = new Request\SendGroupMessageRequest($message, $this->getCredential());
357			} else {
358			$request = new Request\SendDiscusMessageRequest($message, $this->getCredential());
			0 ignored issues – show Compatibility introduced 2017-04-03 16:16 UTC by Report Bug Copy Issue Report `$message` of type `object<Slince\SmartQQ\Message\Request\Message>` is not a sub-type of `object<Slince\SmartQQ\Me...Request\DiscussMessage>`. It seems like you assume a child class of the class `Slince\SmartQQ\Message\Request\Message` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
359			}
360			$response = $this->sendRequest($request);
361
362			return Request\SendMessageRequest::parseResponse($response);
363			}
364
365
366			/**
367			* 发送请求
368			*
369			* @param Request\RequestInterface $request
370			* @param array $options
371			*
372			* @return HttpResponse
373			*/
374			public function sendRequest(Request\RequestInterface $request, array $options = [])
375			{
376			// cookies 必须启用，如果不设置则使用当前凭证的cookie.
377			if (!isset($options['cookies']) && $this->credential) {
378			$options['cookies'] = $this->credential->getCookies();
379			}
380			if ($parameters = $request->getParameters()) {
381			if (Request\RequestInterface::REQUEST_METHOD_GET == $request->getMethod()) {
382			$options['query'] = $parameters;
383			} else {
384			$options['form_params'] = $parameters;
385			}
386			}
387			//如果有referer需要伪造该信息
388			if ($referer = $request->getReferer()) {
389			$options['headers'] = [
390			'Referer' => $referer,
391			];
392			}
393			$response = $this->httpClient->send(
394			new HttpRequest($request->getMethod(), $request->getUri()),
395			$options
396			);
397
398			return $response;
399			}
400			}
401

slince / smartqq

Push — master ( fbea6a...5a4cf9 )

Client::setEventDispatcher() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like