]> git.immae.eu Git - github/wallabag/wallabag.git/blame - src/Wallabag/ImportBundle/Import/PocketImport.php
Only display message in queue for admin
[github/wallabag/wallabag.git] / src / Wallabag / ImportBundle / Import / PocketImport.php
CommitLineData
ff7b031d
NL
1<?php
2
3namespace Wallabag\ImportBundle\Import;
4
252ebd60 5use Psr\Log\NullLogger;
ff7b031d
NL
6use Doctrine\ORM\EntityManager;
7use GuzzleHttp\Client;
252ebd60 8use GuzzleHttp\Exception\RequestException;
ff7b031d 9use Wallabag\CoreBundle\Entity\Entry;
252ebd60 10use Wallabag\CoreBundle\Helper\ContentProxy;
63e40f2d 11use Craue\ConfigBundle\Util\Config;
ff7b031d 12
19d9efab 13class PocketImport extends AbstractImport
ff7b031d 14{
8eedc8cf 15 private $client;
ff7b031d 16 private $consumerKey;
02f64895
JB
17 private $accessToken;
18
19 const NB_ELEMENTS = 5000;
ff7b031d 20
ef75e122 21 public function __construct(EntityManager $em, ContentProxy $contentProxy, Config $craueConfig)
ff7b031d 22 {
ff7b031d 23 $this->em = $em;
252ebd60 24 $this->contentProxy = $contentProxy;
63e40f2d 25 $this->consumerKey = $craueConfig->get('pocket_consumer_key');
252ebd60 26 $this->logger = new NullLogger();
ef75e122
JB
27 }
28
02f64895 29 /**
3849a9f3 30 * Only used for test purpose.
02f64895
JB
31 *
32 * @return string
33 */
34 public function getAccessToken()
35 {
36 return $this->accessToken;
37 }
38
0aa344dc
JB
39 /**
40 * {@inheritdoc}
41 */
d51b38ed
NL
42 public function getName()
43 {
44 return 'Pocket';
45 }
46
7019c7cf
JB
47 /**
48 * {@inheritdoc}
49 */
50 public function getUrl()
51 {
52 return 'import_pocket';
53 }
54
0aa344dc
JB
55 /**
56 * {@inheritdoc}
57 */
d51b38ed
NL
58 public function getDescription()
59 {
0d42217e 60 return 'import.pocket.description';
d51b38ed
NL
61 }
62
ff7b031d 63 /**
252ebd60
JB
64 * Return the oauth url to authenticate the client.
65 *
66 * @param string $redirectUri Redirect url in case of error
67 *
4d0ec0e7 68 * @return string|false request_token for callback method
7ec2897e 69 */
252ebd60 70 public function getRequestToken($redirectUri)
7ec2897e
JB
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
252ebd60
JB
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]);
7ec2897e 85
252ebd60
JB
86 return false;
87 }
7ec2897e 88
252ebd60 89 return $response->json()['code'];
7ec2897e
JB
90 }
91
92 /**
252ebd60
JB
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
7ec2897e 99 */
252ebd60 100 public function authorize($code)
7ec2897e
JB
101 {
102 $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/oauth/authorize',
103 [
104 'body' => json_encode([
105 'consumer_key' => $this->consumerKey,
252ebd60 106 'code' => $code,
7ec2897e
JB
107 ]),
108 ]
109 );
110
252ebd60
JB
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]);
7ec2897e 115
252ebd60
JB
116 return false;
117 }
118
119 $this->accessToken = $response->json()['access_token'];
120
121 return true;
7ec2897e
JB
122 }
123
124 /**
125 * {@inheritdoc}
126 */
02f64895 127 public function import($offset = 0)
7ec2897e 128 {
02f64895
JB
129 static $run = 0;
130
7ec2897e
JB
131 $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/get',
132 [
133 'body' => json_encode([
134 'consumer_key' => $this->consumerKey,
252ebd60 135 'access_token' => $this->accessToken,
7ec2897e
JB
136 'detailType' => 'complete',
137 'state' => 'all',
02f64895
JB
138 'sort' => 'newest',
139 'count' => self::NB_ELEMENTS,
140 'offset' => $offset,
7ec2897e
JB
141 ]),
142 ]
143 );
144
252ebd60
JB
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
7ec2897e
JB
153 $entries = $response->json();
154
ef75e122
JB
155 if ($this->producer) {
156 $this->parseEntriesForProducer($entries['list']);
02f64895
JB
157 } else {
158 $this->parseEntries($entries['list']);
ef75e122
JB
159 }
160
02f64895
JB
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 }
7ec2897e 171
252ebd60 172 return true;
7ec2897e
JB
173 }
174
87f23b00 175 /**
252ebd60 176 * Set the Guzzle client.
87f23b00 177 *
252ebd60 178 * @param Client $client
87f23b00 179 */
252ebd60 180 public function setClient(Client $client)
87f23b00 181 {
252ebd60 182 $this->client = $client;
dda57bb9
NL
183 }
184
6d65c0a8
JB
185 /**
186 * {@inheritdoc}
187 *
188 * @see https://getpocket.com/developer/docs/v3/retrieve
189 */
c98db1b6 190 public function parseEntry(array $importedEntry)
ef75e122 191 {
c98db1b6 192 $url = isset($importedEntry['resolved_url']) && $importedEntry['resolved_url'] != '' ? $importedEntry['resolved_url'] : $importedEntry['given_url'];
252ebd60 193
ef75e122
JB
194 $existingEntry = $this->em
195 ->getRepository('WallabagCoreBundle:Entry')
196 ->findByUrlAndUserId($url, $this->user->getId());
87f23b00 197
ef75e122
JB
198 if (false !== $existingEntry) {
199 ++$this->skippedEntries;
ff7b031d 200
ef75e122
JB
201 return;
202 }
ff7b031d 203
ef75e122
JB
204 $entry = new Entry($this->user);
205 $entry = $this->fetchContent($entry, $url);
ff7b031d 206
ef75e122
JB
207 // jump to next entry in case of problem while getting content
208 if (false === $entry) {
209 ++$this->skippedEntries;
ff7b031d 210
ef75e122
JB
211 return;
212 }
56c778b4 213
ef75e122 214 // 0, 1, 2 - 1 if the item is archived - 2 if the item should be deleted
c98db1b6 215 if ($importedEntry['status'] == 1 || $this->markAsRead) {
ef75e122
JB
216 $entry->setArchived(true);
217 }
7019c7cf 218
ef75e122 219 // 0 or 1 - 1 If the item is starred
c98db1b6 220 if ($importedEntry['favorite'] == 1) {
ef75e122
JB
221 $entry->setStarred(true);
222 }
56c778b4 223
ef75e122 224 $title = 'Untitled';
c98db1b6
JB
225 if (isset($importedEntry['resolved_title']) && $importedEntry['resolved_title'] != '') {
226 $title = $importedEntry['resolved_title'];
227 } elseif (isset($importedEntry['given_title']) && $importedEntry['given_title'] != '') {
228 $title = $importedEntry['given_title'];
ff7b031d
NL
229 }
230
ef75e122
JB
231 $entry->setTitle($title);
232 $entry->setUrl($url);
233
234 // 0, 1, or 2 - 1 if the item has images in it - 2 if the item is an image
c98db1b6
JB
235 if (isset($importedEntry['has_image']) && $importedEntry['has_image'] > 0 && isset($importedEntry['images'][1])) {
236 $entry->setPreviewPicture($importedEntry['images'][1]['src']);
ef75e122
JB
237 }
238
c98db1b6 239 if (isset($importedEntry['tags']) && !empty($importedEntry['tags'])) {
ef75e122
JB
240 $this->contentProxy->assignTagsToEntry(
241 $entry,
c98db1b6 242 array_keys($importedEntry['tags'])
ef75e122
JB
243 );
244 }
245
7f753117
JB
246 if (!empty($importedEntry['time_added'])) {
247 $entry->setCreatedAt((new \DateTime())->setTimestamp($importedEntry['time_added']));
248 }
249
ef75e122
JB
250 $this->em->persist($entry);
251 ++$this->importedEntries;
56c778b4 252
ef75e122
JB
253 return $entry;
254 }
255
256 /**
3849a9f3 257 * {@inheritdoc}
ef75e122 258 */
3849a9f3 259 protected function setEntryAsRead(array $importedEntry)
ef75e122 260 {
13470c35 261 $importedEntry['status'] = '1';
ef75e122 262
3849a9f3 263 return $importedEntry;
ff7b031d 264 }
ff7b031d 265}