]>
Commit | Line | Data |
---|---|---|
ff7b031d NL |
1 | <?php |
2 | ||
3 | namespace Wallabag\ImportBundle\Import; | |
4 | ||
bf9ace06 | 5 | use Http\Client\Common\HttpMethodsClient; |
6 | use Http\Client\Common\Plugin\ErrorPlugin; | |
7 | use Http\Client\Common\PluginClient; | |
8 | use Http\Client\HttpClient; | |
9 | use Http\Discovery\MessageFactoryDiscovery; | |
10 | use Http\Message\MessageFactory; | |
11 | use Http\Client\Exception\RequestException; | |
ff7b031d | 12 | use Wallabag\CoreBundle\Entity\Entry; |
bf9ace06 | 13 | use Psr\Http\Message\ResponseInterface; |
ff7b031d | 14 | |
19d9efab | 15 | class PocketImport extends AbstractImport |
ff7b031d | 16 | { |
f808b016 | 17 | const NB_ELEMENTS = 5000; |
bf9ace06 | 18 | /** |
19 | * @var HttpMethodsClient | |
20 | */ | |
8eedc8cf | 21 | private $client; |
02f64895 JB |
22 | private $accessToken; |
23 | ||
02f64895 | 24 | /** |
3849a9f3 | 25 | * Only used for test purpose. |
02f64895 JB |
26 | * |
27 | * @return string | |
28 | */ | |
29 | public function getAccessToken() | |
30 | { | |
31 | return $this->accessToken; | |
32 | } | |
33 | ||
0aa344dc JB |
34 | /** |
35 | * {@inheritdoc} | |
36 | */ | |
d51b38ed NL |
37 | public function getName() |
38 | { | |
39 | return 'Pocket'; | |
40 | } | |
41 | ||
7019c7cf JB |
42 | /** |
43 | * {@inheritdoc} | |
44 | */ | |
45 | public function getUrl() | |
46 | { | |
47 | return 'import_pocket'; | |
48 | } | |
49 | ||
0aa344dc JB |
50 | /** |
51 | * {@inheritdoc} | |
52 | */ | |
d51b38ed NL |
53 | public function getDescription() |
54 | { | |
0d42217e | 55 | return 'import.pocket.description'; |
d51b38ed NL |
56 | } |
57 | ||
ff7b031d | 58 | /** |
252ebd60 JB |
59 | * Return the oauth url to authenticate the client. |
60 | * | |
61 | * @param string $redirectUri Redirect url in case of error | |
62 | * | |
4d0ec0e7 | 63 | * @return string|false request_token for callback method |
7ec2897e | 64 | */ |
252ebd60 | 65 | public function getRequestToken($redirectUri) |
7ec2897e | 66 | { |
252ebd60 | 67 | try { |
bf9ace06 | 68 | $response = $this->client->post('https://getpocket.com/v3/oauth/request', [], json_encode([ |
69 | 'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(), | |
70 | 'redirect_uri' => $redirectUri, | |
71 | ])); | |
252ebd60 JB |
72 | } catch (RequestException $e) { |
73 | $this->logger->error(sprintf('PocketImport: Failed to request token: %s', $e->getMessage()), ['exception' => $e]); | |
7ec2897e | 74 | |
252ebd60 JB |
75 | return false; |
76 | } | |
7ec2897e | 77 | |
bf9ace06 | 78 | return $this->jsonDecode($response)['code']; |
7ec2897e JB |
79 | } |
80 | ||
81 | /** | |
252ebd60 JB |
82 | * Usually called by the previous callback to authorize the client. |
83 | * Then it return a token that can be used for next requests. | |
84 | * | |
85 | * @param string $code request_token from getRequestToken | |
86 | * | |
87 | * @return bool | |
7ec2897e | 88 | */ |
252ebd60 | 89 | public function authorize($code) |
7ec2897e | 90 | { |
7ec2897e | 91 | |
252ebd60 | 92 | try { |
bf9ace06 | 93 | $response = $this->client->post('https://getpocket.com/v3/oauth/authorize', [], json_encode([ |
94 | 'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(), | |
95 | 'code' => $code, | |
96 | ])); | |
252ebd60 JB |
97 | } catch (RequestException $e) { |
98 | $this->logger->error(sprintf('PocketImport: Failed to authorize client: %s', $e->getMessage()), ['exception' => $e]); | |
7ec2897e | 99 | |
252ebd60 JB |
100 | return false; |
101 | } | |
102 | ||
bf9ace06 | 103 | $this->accessToken = $this->jsonDecode($response)['access_token']; |
252ebd60 JB |
104 | |
105 | return true; | |
7ec2897e JB |
106 | } |
107 | ||
108 | /** | |
109 | * {@inheritdoc} | |
110 | */ | |
02f64895 | 111 | public function import($offset = 0) |
7ec2897e | 112 | { |
02f64895 JB |
113 | static $run = 0; |
114 | ||
252ebd60 | 115 | try { |
bf9ace06 | 116 | $response = $this->client->post('https://getpocket.com/v3/get', [], json_encode([ |
117 | 'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(), | |
118 | 'access_token' => $this->accessToken, | |
119 | 'detailType' => 'complete', | |
120 | 'state' => 'all', | |
121 | 'sort' => 'newest', | |
122 | 'count' => self::NB_ELEMENTS, | |
123 | 'offset' => $offset, | |
124 | ])); | |
252ebd60 JB |
125 | } catch (RequestException $e) { |
126 | $this->logger->error(sprintf('PocketImport: Failed to import: %s', $e->getMessage()), ['exception' => $e]); | |
127 | ||
128 | return false; | |
129 | } | |
130 | ||
bf9ace06 | 131 | $entries = $this->jsonDecode($response); |
7ec2897e | 132 | |
ef75e122 JB |
133 | if ($this->producer) { |
134 | $this->parseEntriesForProducer($entries['list']); | |
02f64895 JB |
135 | } else { |
136 | $this->parseEntries($entries['list']); | |
ef75e122 JB |
137 | } |
138 | ||
02f64895 JB |
139 | // if we retrieve exactly the amount of items requested it means we can get more |
140 | // re-call import and offset item by the amount previous received: | |
141 | // - first call get 5k offset 0 | |
142 | // - second call get 5k offset 5k | |
143 | // - and so on | |
2a1ceb67 | 144 | if (self::NB_ELEMENTS === \count($entries['list'])) { |
02f64895 JB |
145 | ++$run; |
146 | ||
147 | return $this->import(self::NB_ELEMENTS * $run); | |
148 | } | |
7ec2897e | 149 | |
252ebd60 | 150 | return true; |
7ec2897e JB |
151 | } |
152 | ||
87f23b00 | 153 | /** |
bf9ace06 | 154 | * Set the Http client. |
87f23b00 | 155 | * |
bf9ace06 | 156 | * @param HttpClient $client |
157 | * @param MessageFactory|null $messageFactory | |
87f23b00 | 158 | */ |
bf9ace06 | 159 | public function setClient(HttpClient $client, MessageFactory $messageFactory = null) |
87f23b00 | 160 | { |
bf9ace06 | 161 | $this->client = new HttpMethodsClient(new PluginClient($client, [new ErrorPlugin()]), $messageFactory ?: MessageFactoryDiscovery::find()); |
dda57bb9 NL |
162 | } |
163 | ||
9f8f188d JB |
164 | /** |
165 | * {@inheritdoc} | |
166 | */ | |
167 | public function validateEntry(array $importedEntry) | |
168 | { | |
169 | if (empty($importedEntry['resolved_url']) && empty($importedEntry['given_url'])) { | |
170 | return false; | |
171 | } | |
172 | ||
173 | return true; | |
174 | } | |
175 | ||
6d65c0a8 JB |
176 | /** |
177 | * {@inheritdoc} | |
178 | * | |
179 | * @see https://getpocket.com/developer/docs/v3/retrieve | |
180 | */ | |
c98db1b6 | 181 | public function parseEntry(array $importedEntry) |
ef75e122 | 182 | { |
3ef055ce | 183 | $url = isset($importedEntry['resolved_url']) && '' !== $importedEntry['resolved_url'] ? $importedEntry['resolved_url'] : $importedEntry['given_url']; |
252ebd60 | 184 | |
ef75e122 JB |
185 | $existingEntry = $this->em |
186 | ->getRepository('WallabagCoreBundle:Entry') | |
187 | ->findByUrlAndUserId($url, $this->user->getId()); | |
87f23b00 | 188 | |
ef75e122 JB |
189 | if (false !== $existingEntry) { |
190 | ++$this->skippedEntries; | |
ff7b031d | 191 | |
ef75e122 JB |
192 | return; |
193 | } | |
ff7b031d | 194 | |
ef75e122 | 195 | $entry = new Entry($this->user); |
59b97fae | 196 | $entry->setUrl($url); |
ff7b031d | 197 | |
59b97fae | 198 | // update entry with content (in case fetching failed, the given entry will be return) |
7aba665e | 199 | $this->fetchContent($entry, $url); |
56c778b4 | 200 | |
ef75e122 | 201 | // 0, 1, 2 - 1 if the item is archived - 2 if the item should be deleted |
18460b2d | 202 | $entry->updateArchived(1 === (int) $importedEntry['status'] || $this->markAsRead); |
7019c7cf | 203 | |
8d082488 JB |
204 | // 0 or 1 - 1 if the item is starred |
205 | $entry->setStarred(1 === (int) $importedEntry['favorite']); | |
56c778b4 | 206 | |
ef75e122 | 207 | $title = 'Untitled'; |
3ef055ce | 208 | if (isset($importedEntry['resolved_title']) && '' !== $importedEntry['resolved_title']) { |
c98db1b6 | 209 | $title = $importedEntry['resolved_title']; |
3ef055ce | 210 | } elseif (isset($importedEntry['given_title']) && '' !== $importedEntry['given_title']) { |
c98db1b6 | 211 | $title = $importedEntry['given_title']; |
ff7b031d NL |
212 | } |
213 | ||
ef75e122 | 214 | $entry->setTitle($title); |
ef75e122 JB |
215 | |
216 | // 0, 1, or 2 - 1 if the item has images in it - 2 if the item is an image | |
c98db1b6 JB |
217 | if (isset($importedEntry['has_image']) && $importedEntry['has_image'] > 0 && isset($importedEntry['images'][1])) { |
218 | $entry->setPreviewPicture($importedEntry['images'][1]['src']); | |
ef75e122 JB |
219 | } |
220 | ||
c98db1b6 | 221 | if (isset($importedEntry['tags']) && !empty($importedEntry['tags'])) { |
6bc6fb1f | 222 | $this->tagsAssigner->assignTagsToEntry( |
ef75e122 | 223 | $entry, |
40113585 JB |
224 | array_keys($importedEntry['tags']), |
225 | $this->em->getUnitOfWork()->getScheduledEntityInsertions() | |
ef75e122 JB |
226 | ); |
227 | } | |
228 | ||
7f753117 JB |
229 | if (!empty($importedEntry['time_added'])) { |
230 | $entry->setCreatedAt((new \DateTime())->setTimestamp($importedEntry['time_added'])); | |
231 | } | |
232 | ||
ef75e122 JB |
233 | $this->em->persist($entry); |
234 | ++$this->importedEntries; | |
56c778b4 | 235 | |
ef75e122 JB |
236 | return $entry; |
237 | } | |
238 | ||
239 | /** | |
3849a9f3 | 240 | * {@inheritdoc} |
ef75e122 | 241 | */ |
3849a9f3 | 242 | protected function setEntryAsRead(array $importedEntry) |
ef75e122 | 243 | { |
13470c35 | 244 | $importedEntry['status'] = '1'; |
ef75e122 | 245 | |
3849a9f3 | 246 | return $importedEntry; |
ff7b031d | 247 | } |
bf9ace06 | 248 | |
249 | protected function jsonDecode(ResponseInterface $response) | |
250 | { | |
251 | $data = \json_decode((string) $response->getBody(), true); | |
252 | ||
253 | if (JSON_ERROR_NONE !== json_last_error()) { | |
254 | throw new \InvalidArgumentException('Unable to parse JSON data: ' . json_last_error_msg()); | |
255 | } | |
256 | ||
257 | return $data; | |
258 | } | |
ff7b031d | 259 | } |