src/Wallabag/CoreBundle/Repository/EntryRepository.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Repository;
   4
   5 use Doctrine\ORM\EntityRepository;
   6 use Doctrine\ORM\NoResultException;
   7 use Doctrine\ORM\QueryBuilder;
   8 use Pagerfanta\Adapter\DoctrineORMAdapter;
   9 use Pagerfanta\Pagerfanta;
  10 use Wallabag\CoreBundle\Entity\Entry;
  11 use Wallabag\CoreBundle\Entity\Tag;
  12 use Wallabag\CoreBundle\Helper\UrlHasher;
  13
  14 class EntryRepository extends EntityRepository
  15 {
  16     /**
  17      * Retrieves all entries for a user.
  18      *
  19      * @param int $userId
  20      *
  21      * @return QueryBuilder
  22      */
  23     public function getBuilderForAllByUser($userId)
  24     {
  25         return $this
  26             ->getSortedQueryBuilderByUser($userId)
  27         ;
  28     }
  29
  30     /**
  31      * Retrieves unread entries for a user.
  32      *
  33      * @param int $userId
  34      *
  35      * @return QueryBuilder
  36      */
  37     public function getBuilderForUnreadByUser($userId)
  38     {
  39         return $this
  40             ->getSortedQueryBuilderByUser($userId)
  41             ->andWhere('e.isArchived = false')
  42         ;
  43     }
  44
  45     /**
  46      * Retrieves read entries for a user.
  47      *
  48      * @param int $userId
  49      *
  50      * @return QueryBuilder
  51      */
  52     public function getBuilderForArchiveByUser($userId)
  53     {
  54         return $this
  55             ->getSortedQueryBuilderByUser($userId, 'archivedAt', 'desc')
  56             ->andWhere('e.isArchived = true')
  57         ;
  58     }
  59
  60     /**
  61      * Retrieves starred entries for a user.
  62      *
  63      * @param int $userId
  64      *
  65      * @return QueryBuilder
  66      */
  67     public function getBuilderForStarredByUser($userId)
  68     {
  69         return $this
  70             ->getSortedQueryBuilderByUser($userId, 'starredAt', 'desc')
  71             ->andWhere('e.isStarred = true')
  72         ;
  73     }
  74
  75     /**
  76      * Retrieves entries filtered with a search term for a user.
  77      *
  78      * @param int    $userId
  79      * @param string $term
  80      * @param string $currentRoute
  81      *
  82      * @return QueryBuilder
  83      */
  84     public function getBuilderForSearchByUser($userId, $term, $currentRoute)
  85     {
  86         $qb = $this
  87             ->getSortedQueryBuilderByUser($userId);
  88
  89         if ('starred' === $currentRoute) {
  90             $qb->andWhere('e.isStarred = true');
  91         } elseif ('unread' === $currentRoute) {
  92             $qb->andWhere('e.isArchived = false');
  93         } elseif ('archive' === $currentRoute) {
  94             $qb->andWhere('e.isArchived = true');
  95         }
  96
  97         // We lower() all parts here because PostgreSQL 'LIKE' verb is case-sensitive
  98         $qb
  99             ->andWhere('lower(e.content) LIKE lower(:term) OR lower(e.title) LIKE lower(:term) OR lower(e.url) LIKE lower(:term)')->setParameter('term', '%' . $term . '%')
 100             ->leftJoin('e.tags', 't')
 101             ->groupBy('e.id');
 102
 103         return $qb;
 104     }
 105
 106     /**
 107      * Retrieve a sorted list of untagged entries for a user.
 108      *
 109      * @param int $userId
 110      *
 111      * @return QueryBuilder
 112      */
 113     public function getBuilderForUntaggedByUser($userId)
 114     {
 115         return $this->sortQueryBuilder($this->getRawBuilderForUntaggedByUser($userId));
 116     }
 117
 118     /**
 119      * Retrieve untagged entries for a user.
 120      *
 121      * @param int $userId
 122      *
 123      * @return QueryBuilder
 124      */
 125     public function getRawBuilderForUntaggedByUser($userId)
 126     {
 127         return $this->getQueryBuilderByUser($userId)
 128             ->leftJoin('e.tags', 't')
 129             ->andWhere('t.id is null');
 130     }
 131
 132     /**
 133      * Retrieve the number of untagged entries for a user.
 134      *
 135      * @param int $userId
 136      *
 137      * @return int
 138      */
 139     public function countUntaggedEntriesByUser($userId)
 140     {
 141         return (int) $this->getRawBuilderForUntaggedByUser($userId)
 142             ->select('count(e.id)')
 143             ->getQuery()
 144             ->getSingleScalarResult();
 145     }
 146
 147     /**
 148      * Find Entries.
 149      *
 150      * @param int    $userId
 151      * @param bool   $isArchived
 152      * @param bool   $isStarred
 153      * @param bool   $isPublic
 154      * @param string $sort
 155      * @param string $order
 156      * @param int    $since
 157      * @param string $tags
 158      * @param string $detail     'metadata' or 'full'. Include content field if 'full'
 159      *
 160      * @todo Breaking change: replace default detail=full by detail=metadata in a future version
 161      *
 162      * @return Pagerfanta
 163      */
 164     public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full')
 165     {
 166         if (!\in_array(strtolower($detail), ['full', 'metadata'], true)) {
 167             throw new \Exception('Detail "' . $detail . '" parameter is wrong, allowed: full or metadata');
 168         }
 169
 170         $qb = $this->createQueryBuilder('e')
 171             ->leftJoin('e.tags', 't')
 172             ->where('e.user = :userId')->setParameter('userId', $userId);
 173
 174         if ('metadata' === $detail) {
 175             $fieldNames = $this->getClassMetadata()->getFieldNames();
 176             $fields = array_filter($fieldNames, function ($k) {
 177                 return 'content' !== $k;
 178             });
 179             $qb->select(sprintf('partial e.{%s}', implode(',', $fields)));
 180         }
 181
 182         if (null !== $isArchived) {
 183             $qb->andWhere('e.isArchived = :isArchived')->setParameter('isArchived', (bool) $isArchived);
 184         }
 185
 186         if (null !== $isStarred) {
 187             $qb->andWhere('e.isStarred = :isStarred')->setParameter('isStarred', (bool) $isStarred);
 188         }
 189
 190         if (null !== $isPublic) {
 191             $qb->andWhere('e.uid IS ' . (true === $isPublic ? 'NOT' : '') . ' NULL');
 192         }
 193
 194         if ($since > 0) {
 195             $qb->andWhere('e.updatedAt > :since')->setParameter('since', new \DateTime(date('Y-m-d H:i:s', $since)));
 196         }
 197
 198         if (\is_string($tags) && '' !== $tags) {
 199             foreach (explode(',', $tags) as $i => $tag) {
 200                 $entryAlias = 'e' . $i;
 201                 $tagAlias = 't' . $i;
 202
 203                 // Complexe queries to ensure multiple tags are associated to an entry
 204                 // https://stackoverflow.com/a/6638146/569101
 205                 $qb->andWhere($qb->expr()->in(
 206                     'e.id',
 207                     $this->createQueryBuilder($entryAlias)
 208                         ->select($entryAlias . '.id')
 209                         ->leftJoin($entryAlias . '.tags', $tagAlias)
 210                         ->where($tagAlias . '.label = :label' . $i)
 211                         ->getDQL()
 212                 ));
 213
 214                 // bound parameter to the main query builder
 215                 $qb->setParameter('label' . $i, $tag);
 216             }
 217         }
 218
 219         if (!\in_array(strtolower($order), ['asc', 'desc'], true)) {
 220             throw new \Exception('Order "' . $order . '" parameter is wrong, allowed: asc or desc');
 221         }
 222
 223         if ('created' === $sort) {
 224             $qb->orderBy('e.id', $order);
 225         } elseif ('updated' === $sort) {
 226             $qb->orderBy('e.updatedAt', $order);
 227         } elseif ('archived' === $sort) {
 228             $qb->orderBy('e.archivedAt', $order);
 229         }
 230
 231         $pagerAdapter = new DoctrineORMAdapter($qb, true, false);
 232
 233         return new Pagerfanta($pagerAdapter);
 234     }
 235
 236     /**
 237      * Fetch an entry with a tag. Only used for tests.
 238      *
 239      * @param int $userId
 240      *
 241      * @return array
 242      */
 243     public function findOneWithTags($userId)
 244     {
 245         $qb = $this->createQueryBuilder('e')
 246             ->innerJoin('e.tags', 't')
 247             ->innerJoin('e.user', 'u')
 248             ->addSelect('t', 'u')
 249             ->where('e.user = :userId')->setParameter('userId', $userId)
 250         ;
 251
 252         return $qb->getQuery()->getResult();
 253     }
 254
 255     /**
 256      * Find distinct language for a given user.
 257      * Used to build the filter language list.
 258      *
 259      * @param int $userId User id
 260      *
 261      * @return array
 262      */
 263     public function findDistinctLanguageByUser($userId)
 264     {
 265         $results = $this->createQueryBuilder('e')
 266             ->select('e.language')
 267             ->where('e.user = :userId')->setParameter('userId', $userId)
 268             ->andWhere('e.language IS NOT NULL')
 269             ->groupBy('e.language')
 270             ->orderBy('e.language', ' ASC')
 271             ->getQuery()
 272             ->getResult();
 273
 274         $languages = [];
 275         foreach ($results as $result) {
 276             $languages[$result['language']] = $result['language'];
 277         }
 278
 279         return $languages;
 280     }
 281
 282     /**
 283      * Used only in test case to get the right entry associated to the right user.
 284      *
 285      * @param string $username
 286      *
 287      * @return Entry
 288      */
 289     public function findOneByUsernameAndNotArchived($username)
 290     {
 291         return $this->createQueryBuilder('e')
 292             ->leftJoin('e.user', 'u')
 293             ->where('u.username = :username')->setParameter('username', $username)
 294             ->andWhere('e.isArchived = false')
 295             ->setMaxResults(1)
 296             ->getQuery()
 297             ->getSingleResult();
 298     }
 299
 300     /**
 301      * Remove a tag from all user entries.
 302      *
 303      * We need to loop on each entry attached to the given tag to remove it, since Doctrine doesn't know EntryTag entity because it's a ManyToMany relation.
 304      * It could be faster with one query but I don't know how to retrieve the table name `entry_tag` which can have a prefix:
 305      *
 306      * DELETE et FROM entry_tag et WHERE et.entry_id IN ( SELECT e.id FROM entry e WHERE e.user_id = :userId ) AND et.tag_id = :tagId
 307      *
 308      * @param int $userId
 309      */
 310     public function removeTag($userId, Tag $tag)
 311     {
 312         $entries = $this->getSortedQueryBuilderByUser($userId)
 313             ->innerJoin('e.tags', 't')
 314             ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId())
 315             ->getQuery()
 316             ->getResult();
 317
 318         foreach ($entries as $entry) {
 319             $entry->removeTag($tag);
 320         }
 321
 322         $this->getEntityManager()->flush();
 323     }
 324
 325     /**
 326      * Remove tags from all user entries.
 327      *
 328      * @param int        $userId
 329      * @param Array<Tag> $tags
 330      */
 331     public function removeTags($userId, $tags)
 332     {
 333         foreach ($tags as $tag) {
 334             $this->removeTag($userId, $tag);
 335         }
 336     }
 337
 338     /**
 339      * Find all entries that are attached to a give tag id.
 340      *
 341      * @param int $userId
 342      * @param int $tagId
 343      *
 344      * @return array
 345      */
 346     public function findAllByTagId($userId, $tagId)
 347     {
 348         return $this->getSortedQueryBuilderByUser($userId)
 349             ->innerJoin('e.tags', 't')
 350             ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId)
 351             ->getQuery()
 352             ->getResult();
 353     }
 354
 355     /**
 356      * Find an entry by its url and its owner.
 357      * If it exists, return the entry otherwise return false.
 358      *
 359      * @param string $url
 360      * @param int    $userId
 361      *
 362      * @return Entry|false
 363      */
 364     public function findByUrlAndUserId($url, $userId)
 365     {
 366         return $this->findByHashedUrlAndUserId(
 367             UrlHasher::hashUrl($url),
 368             $userId
 369         );
 370     }
 371
 372     /**
 373      * Find an entry by its hashed url and its owner.
 374      * If it exists, return the entry otherwise return false.
 375      *
 376      * @param string $hashedUrl Url hashed using sha1
 377      * @param int    $userId
 378      *
 379      * @return Entry|false
 380      */
 381     public function findByHashedUrlAndUserId($hashedUrl, $userId)
 382     {
 383         // try first using hashed_url (to use the database index)
 384         $res = $this->createQueryBuilder('e')
 385             ->where('e.hashedUrl = :hashed_url')->setParameter('hashed_url', $hashedUrl)
 386             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 387             ->getQuery()
 388             ->getResult();
 389
 390         if (\count($res)) {
 391             return current($res);
 392         }
 393
 394         // then try using hashed_given_url (to use the database index)
 395         $res = $this->createQueryBuilder('e')
 396             ->where('e.hashedGivenUrl = :hashed_given_url')->setParameter('hashed_given_url', $hashedUrl)
 397             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 398             ->getQuery()
 399             ->getResult();
 400
 401         if (\count($res)) {
 402             return current($res);
 403         }
 404
 405         return false;
 406     }
 407
 408     /**
 409      * Count all entries for a user.
 410      *
 411      * @param int $userId
 412      *
 413      * @return int
 414      */
 415     public function countAllEntriesByUser($userId)
 416     {
 417         $qb = $this->createQueryBuilder('e')
 418             ->select('count(e)')
 419             ->where('e.user = :userId')->setParameter('userId', $userId)
 420         ;
 421
 422         return (int) $qb->getQuery()->getSingleScalarResult();
 423     }
 424
 425     /**
 426      * Remove all entries for a user id.
 427      * Used when a user want to reset all informations.
 428      *
 429      * @param int $userId
 430      */
 431     public function removeAllByUserId($userId)
 432     {
 433         $this->getEntityManager()
 434             ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId')
 435             ->setParameter('userId', $userId)
 436             ->execute();
 437     }
 438
 439     public function removeArchivedByUserId($userId)
 440     {
 441         $this->getEntityManager()
 442             ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId AND e.isArchived = TRUE')
 443             ->setParameter('userId', $userId)
 444             ->execute();
 445     }
 446
 447     /**
 448      * Get id and url from all entries
 449      * Used for the clean-duplicates command.
 450      */
 451     public function findAllEntriesIdAndUrlByUserId($userId)
 452     {
 453         $qb = $this->createQueryBuilder('e')
 454             ->select('e.id, e.url')
 455             ->where('e.user = :userid')->setParameter(':userid', $userId);
 456
 457         return $qb->getQuery()->getArrayResult();
 458     }
 459
 460     /**
 461      * @param int $userId
 462      *
 463      * @return array
 464      */
 465     public function findAllEntriesIdByUserId($userId = null)
 466     {
 467         $qb = $this->createQueryBuilder('e')
 468             ->select('e.id');
 469
 470         if (null !== $userId) {
 471             $qb->where('e.user = :userid')->setParameter(':userid', $userId);
 472         }
 473
 474         return $qb->getQuery()->getArrayResult();
 475     }
 476
 477     /**
 478      * Find all entries by url and owner.
 479      *
 480      * @param string $url
 481      * @param int    $userId
 482      *
 483      * @return array
 484      */
 485     public function findAllByUrlAndUserId($url, $userId)
 486     {
 487         return $this->createQueryBuilder('e')
 488             ->where('e.url = :url')->setParameter('url', urldecode($url))
 489             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 490             ->getQuery()
 491             ->getResult();
 492     }
 493
 494     /**
 495      * Returns a random entry, filtering by status.
 496      *
 497      * @param int    $userId
 498      * @param string $type   Can be unread, archive, starred, etc
 499      *
 500      * @throws NoResultException
 501      *
 502      * @return Entry
 503      */
 504     public function getRandomEntry($userId, $type = '')
 505     {
 506         $qb = $this->getQueryBuilderByUser($userId)
 507             ->select('e.id');
 508
 509         switch ($type) {
 510             case 'unread':
 511                 $qb->andWhere('e.isArchived = false');
 512                 break;
 513             case 'archive':
 514                 $qb->andWhere('e.isArchived = true');
 515                 break;
 516             case 'starred':
 517                 $qb->andWhere('e.isStarred = true');
 518                 break;
 519             case 'untagged':
 520                 $qb->leftJoin('e.tags', 't');
 521                 $qb->andWhere('t.id is null');
 522                 break;
 523         }
 524
 525         $ids = $qb->getQuery()->getArrayResult();
 526
 527         if (empty($ids)) {
 528             throw new NoResultException();
 529         }
 530
 531         // random select one in the list
 532         $randomId = $ids[mt_rand(0, \count($ids) - 1)]['id'];
 533
 534         return $this->find($randomId);
 535     }
 536
 537     /**
 538      * Return a query builder to be used by other getBuilderFor* method.
 539      *
 540      * @param int $userId
 541      *
 542      * @return QueryBuilder
 543      */
 544     private function getQueryBuilderByUser($userId)
 545     {
 546         return $this->createQueryBuilder('e')
 547             ->andWhere('e.user = :userId')->setParameter('userId', $userId);
 548     }
 549
 550     /**
 551      * Return a sorted query builder to be used by other getBuilderFor* method.
 552      *
 553      * @param int    $userId
 554      * @param string $sortBy
 555      * @param string $direction
 556      *
 557      * @return QueryBuilder
 558      */
 559     private function getSortedQueryBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc')
 560     {
 561         return $this->sortQueryBuilder($this->getQueryBuilderByUser($userId), $sortBy, $direction);
 562     }
 563
 564     /**
 565      * Return the given QueryBuilder with an orderBy() call.
 566      *
 567      * @param string $sortBy
 568      * @param string $direction
 569      *
 570      * @return QueryBuilder
 571      */
 572     private function sortQueryBuilder(QueryBuilder $qb, $sortBy = 'createdAt', $direction = 'desc')
 573     {
 574         return $qb->orderBy(sprintf('e.%s', $sortBy), $direction);
 575     }
 576 }