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