src/Wallabag/ImportBundle/Import/PocketImport.php

   1 <?php
   2
   3 namespace Wallabag\ImportBundle\Import;
   4
   5 use Psr\Log\LoggerInterface;
   6 use Psr\Log\NullLogger;
   7 use Doctrine\ORM\EntityManager;
   8 use GuzzleHttp\Client;
   9 use GuzzleHttp\Exception\RequestException;
  10 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  11 use Wallabag\CoreBundle\Entity\Entry;
  12 use Wallabag\CoreBundle\Entity\Tag;
  13 use Wallabag\CoreBundle\Helper\ContentProxy;
  14
  15 class PocketImport implements ImportInterface
  16 {
  17     private $user;
  18     private $em;
  19     private $contentProxy;
  20     private $logger;
  21     private $consumerKey;
  22     private $skippedEntries = 0;
  23     private $importedEntries = 0;
  24     protected $accessToken;
  25
  26     public function __construct(TokenStorageInterface $tokenStorage, EntityManager $em, ContentProxy $contentProxy, $consumerKey)
  27     {
  28         $this->user = $tokenStorage->getToken()->getUser();
  29         $this->em = $em;
  30         $this->contentProxy = $contentProxy;
  31         $this->consumerKey = $consumerKey;
  32         $this->logger = new NullLogger();
  33     }
  34
  35     public function setLogger(LoggerInterface $logger)
  36     {
  37         $this->logger = $logger;
  38     }
  39
  40     /**
  41      * {@inheritdoc}
  42      */
  43     public function getName()
  44     {
  45         return 'Pocket';
  46     }
  47
  48     /**
  49      * {@inheritdoc}
  50      */
  51     public function getDescription()
  52     {
  53         return 'This importer will import all your <a href="https://getpocket.com">Pocket</a> data.';
  54     }
  55
  56     /**
  57      * Return the oauth url to authenticate the client.
  58      *
  59      * @param string $redirectUri Redirect url in case of error
  60      *
  61      * @return string request_token for callback method
  62      */
  63     public function getRequestToken($redirectUri)
  64     {
  65         $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/oauth/request',
  66             [
  67                 'body' => json_encode([
  68                     'consumer_key' => $this->consumerKey,
  69                     'redirect_uri' => $redirectUri,
  70                 ]),
  71             ]
  72         );
  73
  74         try {
  75             $response = $this->client->send($request);
  76         } catch (RequestException $e) {
  77             $this->logger->error(sprintf('PocketImport: Failed to request token: %s', $e->getMessage()), ['exception' => $e]);
  78
  79             return false;
  80         }
  81
  82         return $response->json()['code'];
  83     }
  84
  85     /**
  86      * Usually called by the previous callback to authorize the client.
  87      * Then it return a token that can be used for next requests.
  88      *
  89      * @param string $code request_token from getRequestToken
  90      *
  91      * @return bool
  92      */
  93     public function authorize($code)
  94     {
  95         $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/oauth/authorize',
  96             [
  97                 'body' => json_encode([
  98                     'consumer_key' => $this->consumerKey,
  99                     'code' => $code,
 100                 ]),
 101             ]
 102         );
 103
 104         try {
 105             $response = $this->client->send($request);
 106         } catch (RequestException $e) {
 107             $this->logger->error(sprintf('PocketImport: Failed to authorize client: %s', $e->getMessage()), ['exception' => $e]);
 108
 109             return false;
 110         }
 111
 112         $this->accessToken = $response->json()['access_token'];
 113
 114         return true;
 115     }
 116
 117     /**
 118      * {@inheritdoc}
 119      */
 120     public function import()
 121     {
 122         $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/get',
 123             [
 124                 'body' => json_encode([
 125                     'consumer_key' => $this->consumerKey,
 126                     'access_token' => $this->accessToken,
 127                     'detailType' => 'complete',
 128                     'state' => 'all',
 129                     'sort' => 'oldest',
 130                 ]),
 131             ]
 132         );
 133
 134         try {
 135             $response = $this->client->send($request);
 136         } catch (RequestException $e) {
 137             $this->logger->error(sprintf('PocketImport: Failed to import: %s', $e->getMessage()), ['exception' => $e]);
 138
 139             return false;
 140         }
 141
 142         $entries = $response->json();
 143
 144         $this->parsePocketEntries($entries['list']);
 145
 146         return true;
 147     }
 148
 149     /**
 150      * {@inheritdoc}
 151      */
 152     public function getSummary()
 153     {
 154         return [
 155             'skipped' => $this->skippedEntries,
 156             'imported' => $this->importedEntries,
 157         ];
 158     }
 159
 160     /**
 161      * Set the Guzzle client.
 162      *
 163      * @param Client $client
 164      */
 165     public function setClient(Client $client)
 166     {
 167         $this->client = $client;
 168     }
 169
 170     /**
 171      * @todo move that in a more global place
 172      */
 173     private function assignTagsToEntry(Entry $entry, $tags)
 174     {
 175         foreach ($tags as $tag) {
 176             $label = trim($tag['tag']);
 177             $tagEntity = $this->em
 178                 ->getRepository('WallabagCoreBundle:Tag')
 179                 ->findOneByLabelAndUserId($label, $this->user->getId());
 180
 181             if (is_object($tagEntity)) {
 182                 $entry->addTag($tagEntity);
 183             } else {
 184                 $newTag = new Tag($this->user);
 185                 $newTag->setLabel($label);
 186                 $entry->addTag($newTag);
 187             }
 188             $this->em->flush();
 189         }
 190     }
 191
 192     /**
 193      * @see https://getpocket.com/developer/docs/v3/retrieve
 194      *
 195      * @param $entries
 196      */
 197     private function parsePocketEntries($entries)
 198     {
 199         foreach ($entries as $pocketEntry) {
 200             $entry = new Entry($this->user);
 201
 202             $url = isset($pocketEntry['resolved_url']) && $pocketEntry['resolved_url'] != '' ? $pocketEntry['resolved_url'] : $pocketEntry['given_url'];
 203
 204             $existingEntry = $this->em
 205                 ->getRepository('WallabagCoreBundle:Entry')
 206                 ->existByUrlAndUserId($url, $this->user->getId());
 207
 208             if (false !== $existingEntry) {
 209                 ++$this->skippedEntries;
 210                 continue;
 211             }
 212
 213             $entry = $this->contentProxy->updateEntry($entry, $url);
 214
 215             // 0, 1, 2 - 1 if the item is archived - 2 if the item should be deleted
 216             if ($pocketEntry['status'] == 1) {
 217                 $entry->setArchived(true);
 218             }
 219
 220             // 0 or 1 - 1 If the item is favorited
 221             if ($pocketEntry['favorite'] == 1) {
 222                 $entry->setStarred(true);
 223             }
 224
 225             $title = 'Untitled';
 226             if (isset($pocketEntry['resolved_title']) && $pocketEntry['resolved_title'] != '') {
 227                 $title = $pocketEntry['resolved_title'];
 228             } elseif (isset($pocketEntry['given_title']) && $pocketEntry['given_title'] != '') {
 229                 $title = $pocketEntry['given_title'];
 230             }
 231
 232             $entry->setTitle($title);
 233
 234             // 0, 1, or 2 - 1 if the item has images in it - 2 if the item is an image
 235             if (isset($pocketEntry['has_image']) && $pocketEntry['has_image'] > 0 && isset($pocketEntry['images'][1])) {
 236                 $entry->setPreviewPicture($pocketEntry['images'][1]['src']);
 237             }
 238
 239             if (isset($pocketEntry['tags']) && !empty($pocketEntry['tags'])) {
 240                 $this->assignTagsToEntry($entry, $pocketEntry['tags']);
 241             }
 242
 243             $this->em->persist($entry);
 244             ++$this->importedEntries;
 245         }
 246
 247         $this->em->flush();
 248     }
 249 }