src/Wallabag/CoreBundle/Repository/EntryRepository.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Repository;
   4
   5 use Doctrine\ORM\EntityRepository;
   6 use Doctrine\ORM\QueryBuilder;
   7 use Pagerfanta\Adapter\DoctrineORMAdapter;
   8 use Pagerfanta\Pagerfanta;
   9 use Wallabag\CoreBundle\Entity\Entry;
  10 use Wallabag\CoreBundle\Entity\Tag;
  11
  12 class EntryRepository extends EntityRepository
  13 {
  14     /**
  15      * Retrieves all entries for a user.
  16      *
  17      * @param int $userId
  18      *
  19      * @return QueryBuilder
  20      */
  21     public function getBuilderForAllByUser($userId)
  22     {
  23         return $this
  24             ->getSortedQueryBuilderByUser($userId)
  25         ;
  26     }
  27
  28     /**
  29      * Retrieves unread entries for a user.
  30      *
  31      * @param int $userId
  32      *
  33      * @return QueryBuilder
  34      */
  35     public function getBuilderForUnreadByUser($userId)
  36     {
  37         return $this
  38             ->getSortedQueryBuilderByUser($userId)
  39             ->andWhere('e.isArchived = false')
  40         ;
  41     }
  42
  43     /**
  44      * Retrieves read entries for a user.
  45      *
  46      * @param int $userId
  47      *
  48      * @return QueryBuilder
  49      */
  50     public function getBuilderForArchiveByUser($userId)
  51     {
  52         return $this
  53             ->getSortedQueryBuilderByUser($userId, 'archivedAt', 'desc')
  54             ->andWhere('e.isArchived = true')
  55         ;
  56     }
  57
  58     /**
  59      * Retrieves starred entries for a user.
  60      *
  61      * @param int $userId
  62      *
  63      * @return QueryBuilder
  64      */
  65     public function getBuilderForStarredByUser($userId)
  66     {
  67         return $this
  68             ->getSortedQueryBuilderByUser($userId, 'starredAt', 'desc')
  69             ->andWhere('e.isStarred = true')
  70         ;
  71     }
  72
  73     /**
  74      * Retrieves entries filtered with a search term for a user.
  75      *
  76      * @param int    $userId
  77      * @param string $term
  78      * @param string $currentRoute
  79      *
  80      * @return QueryBuilder
  81      */
  82     public function getBuilderForSearchByUser($userId, $term, $currentRoute)
  83     {
  84         $qb = $this
  85             ->getSortedQueryBuilderByUser($userId);
  86
  87         if ('starred' === $currentRoute) {
  88             $qb->andWhere('e.isStarred = true');
  89         } elseif ('unread' === $currentRoute) {
  90             $qb->andWhere('e.isArchived = false');
  91         } elseif ('archive' === $currentRoute) {
  92             $qb->andWhere('e.isArchived = true');
  93         }
  94
  95         // We lower() all parts here because PostgreSQL 'LIKE' verb is case-sensitive
  96         $qb
  97             ->andWhere('lower(e.content) LIKE lower(:term) OR lower(e.title) LIKE lower(:term) OR lower(e.url) LIKE lower(:term)')->setParameter('term', '%' . $term . '%')
  98             ->leftJoin('e.tags', 't')
  99             ->groupBy('e.id');
 100
 101         return $qb;
 102     }
 103
 104     /**
 105      * Retrieve a sorted list of untagged entries for a user.
 106      *
 107      * @param int $userId
 108      *
 109      * @return QueryBuilder
 110      */
 111     public function getBuilderForUntaggedByUser($userId)
 112     {
 113         return $this
 114             ->sortQueryBuilder($this->getRawBuilderForUntaggedByUser($userId));
 115     }
 116
 117     /**
 118      * Retrieve untagged entries for a user.
 119      *
 120      * @param int $userId
 121      *
 122      * @return QueryBuilder
 123      */
 124     public function getRawBuilderForUntaggedByUser($userId)
 125     {
 126         return $this->getQueryBuilderByUser($userId)
 127             ->leftJoin('e.tags', 't')
 128             ->andWhere('t.id is null');
 129     }
 130
 131     /**
 132      * Find Entries.
 133      *
 134      * @param int    $userId
 135      * @param bool   $isArchived
 136      * @param bool   $isStarred
 137      * @param bool   $isPublic
 138      * @param string $sort
 139      * @param string $order
 140      * @param int    $since
 141      * @param string $tags
 142      *
 143      * @return Pagerfanta
 144      */
 145     public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'ASC', $since = 0, $tags = '')
 146     {
 147         $qb = $this->createQueryBuilder('e')
 148             ->leftJoin('e.tags', 't')
 149             ->where('e.user = :userId')->setParameter('userId', $userId);
 150
 151         if (null !== $isArchived) {
 152             $qb->andWhere('e.isArchived = :isArchived')->setParameter('isArchived', (bool) $isArchived);
 153         }
 154
 155         if (null !== $isStarred) {
 156             $qb->andWhere('e.isStarred = :isStarred')->setParameter('isStarred', (bool) $isStarred);
 157         }
 158
 159         if (null !== $isPublic) {
 160             $qb->andWhere('e.uid IS ' . (true === $isPublic ? 'NOT' : '') . ' NULL');
 161         }
 162
 163         if ($since > 0) {
 164             $qb->andWhere('e.updatedAt > :since')->setParameter('since', new \DateTime(date('Y-m-d H:i:s', $since)));
 165         }
 166
 167         if (\is_string($tags) && '' !== $tags) {
 168             foreach (explode(',', $tags) as $i => $tag) {
 169                 $entryAlias = 'e' . $i;
 170                 $tagAlias = 't' . $i;
 171
 172                 // Complexe queries to ensure multiple tags are associated to an entry
 173                 // https://stackoverflow.com/a/6638146/569101
 174                 $qb->andWhere($qb->expr()->in(
 175                     'e.id',
 176                     $this->createQueryBuilder($entryAlias)
 177                         ->select($entryAlias . '.id')
 178                         ->leftJoin($entryAlias . '.tags', $tagAlias)
 179                         ->where($tagAlias . '.label = :label' . $i)
 180                         ->getDQL()
 181                 ));
 182
 183                 // bound parameter to the main query builder
 184                 $qb->setParameter('label' . $i, $tag);
 185             }
 186         }
 187
 188         if ('created' === $sort) {
 189             $qb->orderBy('e.id', $order);
 190         } elseif ('updated' === $sort) {
 191             $qb->orderBy('e.updatedAt', $order);
 192         } elseif ('archived' === $sort) {
 193             $qb->orderBy('e.archivedAt', $order);
 194         }
 195
 196         $pagerAdapter = new DoctrineORMAdapter($qb, true, false);
 197
 198         return new Pagerfanta($pagerAdapter);
 199     }
 200
 201     /**
 202      * Fetch an entry with a tag. Only used for tests.
 203      *
 204      * @param int $userId
 205      *
 206      * @return array
 207      */
 208     public function findOneWithTags($userId)
 209     {
 210         $qb = $this->createQueryBuilder('e')
 211             ->innerJoin('e.tags', 't')
 212             ->innerJoin('e.user', 'u')
 213             ->addSelect('t', 'u')
 214             ->where('e.user = :userId')->setParameter('userId', $userId)
 215         ;
 216
 217         return $qb->getQuery()->getResult();
 218     }
 219
 220     /**
 221      * Find distinct language for a given user.
 222      * Used to build the filter language list.
 223      *
 224      * @param int $userId User id
 225      *
 226      * @return array
 227      */
 228     public function findDistinctLanguageByUser($userId)
 229     {
 230         $results = $this->createQueryBuilder('e')
 231             ->select('e.language')
 232             ->where('e.user = :userId')->setParameter('userId', $userId)
 233             ->andWhere('e.language IS NOT NULL')
 234             ->groupBy('e.language')
 235             ->orderBy('e.language', ' ASC')
 236             ->getQuery()
 237             ->getResult();
 238
 239         $languages = [];
 240         foreach ($results as $result) {
 241             $languages[$result['language']] = $result['language'];
 242         }
 243
 244         return $languages;
 245     }
 246
 247     /**
 248      * Used only in test case to get the right entry associated to the right user.
 249      *
 250      * @param string $username
 251      *
 252      * @return Entry
 253      */
 254     public function findOneByUsernameAndNotArchived($username)
 255     {
 256         return $this->createQueryBuilder('e')
 257             ->leftJoin('e.user', 'u')
 258             ->where('u.username = :username')->setParameter('username', $username)
 259             ->andWhere('e.isArchived = false')
 260             ->setMaxResults(1)
 261             ->getQuery()
 262             ->getSingleResult();
 263     }
 264
 265     /**
 266      * Remove a tag from all user entries.
 267      *
 268      * 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.
 269      * 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:
 270      *
 271      * 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
 272      *
 273      * @param int $userId
 274      * @param Tag $tag
 275      */
 276     public function removeTag($userId, Tag $tag)
 277     {
 278         $entries = $this->getSortedQueryBuilderByUser($userId)
 279             ->innerJoin('e.tags', 't')
 280             ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId())
 281             ->getQuery()
 282             ->getResult();
 283
 284         foreach ($entries as $entry) {
 285             $entry->removeTag($tag);
 286         }
 287
 288         $this->getEntityManager()->flush();
 289     }
 290
 291     /**
 292      * Remove tags from all user entries.
 293      *
 294      * @param int        $userId
 295      * @param Array<Tag> $tags
 296      */
 297     public function removeTags($userId, $tags)
 298     {
 299         foreach ($tags as $tag) {
 300             $this->removeTag($userId, $tag);
 301         }
 302     }
 303
 304     /**
 305      * Find all entries that are attached to a give tag id.
 306      *
 307      * @param int $userId
 308      * @param int $tagId
 309      *
 310      * @return array
 311      */
 312     public function findAllByTagId($userId, $tagId)
 313     {
 314         return $this->getSortedQueryBuilderByUser($userId)
 315             ->innerJoin('e.tags', 't')
 316             ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId)
 317             ->getQuery()
 318             ->getResult();
 319     }
 320
 321     /**
 322      * Find an entry by its url and its owner.
 323      * If it exists, return the entry otherwise return false.
 324      *
 325      * @param $url
 326      * @param $userId
 327      *
 328      * @return Entry|bool
 329      */
 330     public function findByUrlAndUserId($url, $userId)
 331     {
 332         $res = $this->createQueryBuilder('e')
 333             ->where('e.url = :url')->setParameter('url', urldecode($url))
 334             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 335             ->getQuery()
 336             ->getResult();
 337
 338         if (\count($res)) {
 339             return current($res);
 340         }
 341
 342         return false;
 343     }
 344
 345     /**
 346      * Count all entries for a user.
 347      *
 348      * @param int $userId
 349      *
 350      * @return int
 351      */
 352     public function countAllEntriesByUser($userId)
 353     {
 354         $qb = $this->createQueryBuilder('e')
 355             ->select('count(e)')
 356             ->where('e.user = :userId')->setParameter('userId', $userId)
 357         ;
 358
 359         return (int) $qb->getQuery()->getSingleScalarResult();
 360     }
 361
 362     /**
 363      * Remove all entries for a user id.
 364      * Used when a user want to reset all informations.
 365      *
 366      * @param int $userId
 367      */
 368     public function removeAllByUserId($userId)
 369     {
 370         $this->getEntityManager()
 371             ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId')
 372             ->setParameter('userId', $userId)
 373             ->execute();
 374     }
 375
 376     public function removeArchivedByUserId($userId)
 377     {
 378         $this->getEntityManager()
 379             ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId AND e.isArchived = TRUE')
 380             ->setParameter('userId', $userId)
 381             ->execute();
 382     }
 383
 384     /**
 385      * Get id and url from all entries
 386      * Used for the clean-duplicates command.
 387      */
 388     public function findAllEntriesIdAndUrlByUserId($userId)
 389     {
 390         $qb = $this->createQueryBuilder('e')
 391             ->select('e.id, e.url')
 392             ->where('e.user = :userid')->setParameter(':userid', $userId);
 393
 394         return $qb->getQuery()->getArrayResult();
 395     }
 396
 397     /**
 398      * @param int $userId
 399      *
 400      * @return array
 401      */
 402     public function findAllEntriesIdByUserId($userId = null)
 403     {
 404         $qb = $this->createQueryBuilder('e')
 405             ->select('e.id');
 406
 407         if (null !== $userId) {
 408             $qb->where('e.user = :userid')->setParameter(':userid', $userId);
 409         }
 410
 411         return $qb->getQuery()->getArrayResult();
 412     }
 413
 414     /**
 415      * Find all entries by url and owner.
 416      *
 417      * @param $url
 418      * @param $userId
 419      *
 420      * @return array
 421      */
 422     public function findAllByUrlAndUserId($url, $userId)
 423     {
 424         return $this->createQueryBuilder('e')
 425             ->where('e.url = :url')->setParameter('url', urldecode($url))
 426             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 427             ->getQuery()
 428             ->getResult();
 429     }
 430
 431     /**
 432      * Return a query builder to be used by other getBuilderFor* method.
 433      *
 434      * @param int $userId
 435      *
 436      * @return QueryBuilder
 437      */
 438     private function getQueryBuilderByUser($userId)
 439     {
 440         return $this->createQueryBuilder('e')
 441             ->andWhere('e.user = :userId')->setParameter('userId', $userId);
 442     }
 443
 444     /**
 445      * Return a sorted query builder to be used by other getBuilderFor* method.
 446      *
 447      * @param int    $userId
 448      * @param string $sortBy
 449      * @param string $direction
 450      *
 451      * @return QueryBuilder
 452      */
 453     private function getSortedQueryBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc')
 454     {
 455         return $this->sortQueryBuilder($this->getQueryBuilderByUser($userId), $sortBy, $direction);
 456     }
 457
 458     /**
 459      * Return the given QueryBuilder with an orderBy() call.
 460      *
 461      * @param QueryBuilder $qb
 462      * @param string       $sortBy
 463      * @param string       $direction
 464      *
 465      * @return QueryBuilder
 466      */
 467     private function sortQueryBuilder(QueryBuilder $qb, $sortBy = 'createdAt', $direction = 'desc')
 468     {
 469         return $qb
 470             ->orderBy(sprintf('e.%s', $sortBy), $direction);
 471     }
 472 }