1
|
|
|
<?php declare(strict_types=1); |
2
|
|
|
/** |
3
|
|
|
* Anime List Client |
4
|
|
|
* |
5
|
|
|
* An API client for Kitsu and MyAnimeList to manage anime and manga watch lists |
6
|
|
|
* |
7
|
|
|
* PHP version 7 |
8
|
|
|
* |
9
|
|
|
* @package AnimeListClient |
10
|
|
|
* @author Timothy J. Warren <[email protected]> |
11
|
|
|
* @copyright 2015 - 2017 Timothy J. Warren |
12
|
|
|
* @license http://www.opensource.org/licenses/mit-license.html MIT License |
13
|
|
|
* @version 4.0 |
14
|
|
|
* @link https://github.com/timw4mail/HummingBirdAnimeClient |
15
|
|
|
*/ |
16
|
|
|
|
17
|
|
|
namespace Aviat\AnimeClient\API\MAL; |
18
|
|
|
|
19
|
|
|
use Amp\Artax\{Client, FormBody, Request}; |
20
|
|
|
use Aviat\AnimeClient\API\{ |
21
|
|
|
MAL as M, |
22
|
|
|
APIRequestBuilder, |
23
|
|
|
XML |
24
|
|
|
}; |
25
|
|
|
use Aviat\AnimeClient\API\MALRequestBuilder; |
|
|
|
|
26
|
|
|
use Aviat\Ion\Json; |
27
|
|
|
use InvalidArgumentException; |
28
|
|
|
|
29
|
|
|
trait MALTrait { |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* The request builder for the MAL API |
33
|
|
|
* @var MALRequestBuilder |
34
|
|
|
*/ |
35
|
|
|
protected $requestBuilder; |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* The base url for api requests |
39
|
|
|
* @var string $base_url |
40
|
|
|
*/ |
41
|
|
|
protected $baseUrl = M::BASE_URL; |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* HTTP headers to send with every request |
45
|
|
|
* |
46
|
|
|
* @var array |
47
|
|
|
*/ |
48
|
|
|
protected $defaultHeaders = [ |
49
|
|
|
'Accept' => 'text/xml', |
50
|
|
|
'Accept-Encoding' => 'gzip', |
51
|
|
|
'Content-type' => 'application/x-www-form-urlencoded', |
52
|
|
|
'User-Agent' => "Tim's Anime Client/4.0" |
53
|
|
|
]; |
54
|
|
|
|
55
|
|
|
/** |
56
|
|
|
* Set the request builder object |
57
|
|
|
* |
58
|
|
|
* @param MALRequestBuilder $requestBuilder |
59
|
|
|
* @return self |
60
|
|
|
*/ |
61
|
|
|
public function setRequestBuilder($requestBuilder): self |
62
|
|
|
{ |
63
|
|
|
$this->requestBuilder = $requestBuilder; |
64
|
|
|
return $this; |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* Unencode the dual-encoded ampersands in the body |
69
|
|
|
* |
70
|
|
|
* This is a dirty hack until I can fully track down where |
71
|
|
|
* the dual-encoding happens |
72
|
|
|
* |
73
|
|
|
* @param FormBody $formBody The form builder object to fix |
|
|
|
|
74
|
|
|
* @return string |
75
|
|
|
*/ |
76
|
|
|
private function fixBody(FormBody $formBody): string |
|
|
|
|
77
|
|
|
{ |
78
|
|
|
$rawBody = \Amp\wait($formBody->getBody()); |
79
|
|
|
return html_entity_decode($rawBody, \ENT_HTML5, 'UTF-8'); |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
/** |
83
|
|
|
* Create a request object |
84
|
|
|
* |
85
|
|
|
* @param string $type |
86
|
|
|
* @param string $url |
87
|
|
|
* @param array $options |
88
|
|
|
* @return \Amp\Artax\Response |
89
|
|
|
*/ |
90
|
|
|
public function setUpRequest(string $type, string $url, array $options = []) |
91
|
|
|
{ |
92
|
|
|
$config = $this->container->get('config'); |
|
|
|
|
93
|
|
|
|
94
|
|
|
$request = $this->requestBuilder |
95
|
|
|
->newRequest($type, $url) |
96
|
|
|
->setBasicAuth($config->get(['mal','username']), $config->get(['mal','password'])); |
97
|
|
|
|
98
|
|
|
if (array_key_exists('query', $options)) |
99
|
|
|
{ |
100
|
|
|
$request->setQuery($options['query']); |
101
|
|
|
} |
102
|
|
|
|
103
|
|
|
if (array_key_exists('body', $options)) |
104
|
|
|
{ |
105
|
|
|
$request->setBody($options['body']); |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
return $request->getFullRequest(); |
109
|
|
|
} |
110
|
|
|
|
111
|
|
|
/** |
112
|
|
|
* Make a request |
113
|
|
|
* |
114
|
|
|
* @param string $type |
115
|
|
|
* @param string $url |
116
|
|
|
* @param array $options |
117
|
|
|
* @return \Amp\Artax\Response |
118
|
|
|
*/ |
119
|
|
|
private function getResponse(string $type, string $url, array $options = []) |
120
|
|
|
{ |
121
|
|
|
$logger = null; |
122
|
|
|
if ($this->getContainer()) |
|
|
|
|
123
|
|
|
{ |
124
|
|
|
$logger = $this->container->getLogger('mal-request'); |
125
|
|
|
} |
126
|
|
|
|
127
|
|
|
$request = $this->setUpRequest($type, $url, $options); |
128
|
|
|
$response = \Amp\wait((new Client)->request($request)); |
129
|
|
|
|
130
|
|
|
$logger->debug('MAL api response', [ |
131
|
|
|
'status' => $response->getStatus(), |
132
|
|
|
'reason' => $response->getReason(), |
133
|
|
|
'body' => $response->getBody(), |
134
|
|
|
'headers' => $response->getAllHeaders(), |
135
|
|
|
'requestHeaders' => $request->getAllHeaders(), |
136
|
|
|
]); |
137
|
|
|
|
138
|
|
|
return $response; |
139
|
|
|
} |
140
|
|
|
|
141
|
|
|
/** |
142
|
|
|
* Make a request |
143
|
|
|
* |
144
|
|
|
* @param string $type |
145
|
|
|
* @param string $url |
146
|
|
|
* @param array $options |
147
|
|
|
* @return array |
148
|
|
|
*/ |
149
|
|
View Code Duplication |
private function request(string $type, string $url, array $options = []): array |
|
|
|
|
150
|
|
|
{ |
151
|
|
|
$logger = null; |
152
|
|
|
if ($this->getContainer()) |
|
|
|
|
153
|
|
|
{ |
154
|
|
|
$logger = $this->container->getLogger('mal-request'); |
155
|
|
|
} |
156
|
|
|
|
157
|
|
|
$response = $this->getResponse($type, $url, $options); |
158
|
|
|
|
159
|
|
|
if ((int) $response->getStatus() > 299 || (int) $response->getStatus() < 200) |
160
|
|
|
{ |
161
|
|
|
if ($logger) |
162
|
|
|
{ |
163
|
|
|
$logger->warning('Non 200 response for api call', $response->getBody()); |
164
|
|
|
} |
165
|
|
|
} |
166
|
|
|
|
167
|
|
|
return XML::toArray((string) $response->getBody()); |
168
|
|
|
} |
169
|
|
|
|
170
|
|
|
/** |
171
|
|
|
* Remove some boilerplate for get requests |
172
|
|
|
* |
173
|
|
|
* @param array $args |
174
|
|
|
* @return array |
175
|
|
|
*/ |
176
|
|
|
protected function getRequest(...$args): array |
177
|
|
|
{ |
178
|
|
|
return $this->request('GET', ...$args); |
|
|
|
|
179
|
|
|
} |
180
|
|
|
|
181
|
|
|
/** |
182
|
|
|
* Remove some boilerplate for post requests |
183
|
|
|
* |
184
|
|
|
* @param array $args |
185
|
|
|
* @return array |
186
|
|
|
*/ |
187
|
|
View Code Duplication |
protected function postRequest(...$args): array |
|
|
|
|
188
|
|
|
{ |
189
|
|
|
$logger = null; |
190
|
|
|
if ($this->getContainer()) |
|
|
|
|
191
|
|
|
{ |
192
|
|
|
$logger = $this->container->getLogger('mal-request'); |
193
|
|
|
} |
194
|
|
|
|
195
|
|
|
$response = $this->getResponse('POST', ...$args); |
|
|
|
|
196
|
|
|
$validResponseCodes = [200, 201]; |
197
|
|
|
|
198
|
|
|
if ( ! in_array((int) $response->getStatus(), $validResponseCodes)) |
199
|
|
|
{ |
200
|
|
|
if ($logger) |
201
|
|
|
{ |
202
|
|
|
$logger->warning('Non 201 response for POST api call', $response->getBody()); |
203
|
|
|
} |
204
|
|
|
} |
205
|
|
|
|
206
|
|
|
return XML::toArray($response->getBody()); |
207
|
|
|
} |
208
|
|
|
} |
Let’s assume that you have a directory layout like this:
and let’s assume the following content of
Bar.php
:If both files
OtherDir/Foo.php
andSomeDir/Foo.php
are loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php
However, as
OtherDir/Foo.php
does not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php
, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: