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