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)
  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         }
 193
 194         $pagerAdapter = new DoctrineORMAdapter($qb, true, false);
 195
 196         return new Pagerfanta($pagerAdapter);
 197     }
 198
 199     /**
 200      * Fetch an entry with a tag. Only used for tests.
 201      *
 202      * @param int $userId
 203      *
 204      * @return array
 205      */
 206     public function findOneWithTags($userId)
 207     {
 208         $qb = $this->createQueryBuilder('e')
 209             ->innerJoin('e.tags', 't')
 210             ->innerJoin('e.user', 'u')
 211             ->addSelect('t', 'u')
 212             ->where('e.user = :userId')->setParameter('userId', $userId)
 213         ;
 214
 215         return $qb->getQuery()->getResult();
 216     }
 217
 218     /**
 219      * Find distinct language for a given user.
 220      * Used to build the filter language list.
 221      *
 222      * @param int $userId User id
 223      *
 224      * @return array
 225      */
 226     public function findDistinctLanguageByUser($userId)
 227     {
 228         $results = $this->createQueryBuilder('e')
 229             ->select('e.language')
 230             ->where('e.user = :userId')->setParameter('userId', $userId)
 231             ->andWhere('e.language IS NOT NULL')
 232             ->groupBy('e.language')
 233             ->orderBy('e.language', ' ASC')
 234             ->getQuery()
 235             ->getResult();
 236
 237         $languages = [];
 238         foreach ($results as $result) {
 239             $languages[$result['language']] = $result['language'];
 240         }
 241
 242         return $languages;
 243     }
 244
 245     /**
 246      * Used only in test case to get the right entry associated to the right user.
 247      *
 248      * @param string $username
 249      *
 250      * @return Entry
 251      */
 252     public function findOneByUsernameAndNotArchived($username)
 253     {
 254         return $this->createQueryBuilder('e')
 255             ->leftJoin('e.user', 'u')
 256             ->where('u.username = :username')->setParameter('username', $username)
 257             ->andWhere('e.isArchived = false')
 258             ->setMaxResults(1)
 259             ->getQuery()
 260             ->getSingleResult();
 261     }
 262
 263     /**
 264      * Remove a tag from all user entries.
 265      *
 266      * 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.
 267      * 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:
 268      *
 269      * 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
 270      *
 271      * @param int $userId
 272      * @param Tag $tag
 273      */
 274     public function removeTag($userId, Tag $tag)
 275     {
 276         $entries = $this->getSortedQueryBuilderByUser($userId)
 277             ->innerJoin('e.tags', 't')
 278             ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId())
 279             ->getQuery()
 280             ->getResult();
 281
 282         foreach ($entries as $entry) {
 283             $entry->removeTag($tag);
 284         }
 285
 286         $this->getEntityManager()->flush();
 287     }
 288
 289     /**
 290      * Remove tags from all user entries.
 291      *
 292      * @param int        $userId
 293      * @param Array<Tag> $tags
 294      */
 295     public function removeTags($userId, $tags)
 296     {
 297         foreach ($tags as $tag) {
 298             $this->removeTag($userId, $tag);
 299         }
 300     }
 301
 302     /**
 303      * Find all entries that are attached to a give tag id.
 304      *
 305      * @param int $userId
 306      * @param int $tagId
 307      *
 308      * @return array
 309      */
 310     public function findAllByTagId($userId, $tagId)
 311     {
 312         return $this->getSortedQueryBuilderByUser($userId)
 313             ->innerJoin('e.tags', 't')
 314             ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId)
 315             ->getQuery()
 316             ->getResult();
 317     }
 318
 319     /**
 320      * Find an entry by its url and its owner.
 321      * If it exists, return the entry otherwise return false.
 322      *
 323      * @param $url
 324      * @param $userId
 325      *
 326      * @return Entry|bool
 327      */
 328     public function findByUrlAndUserId($url, $userId)
 329     {
 330         $res = $this->createQueryBuilder('e')
 331             ->where('e.url = :url')->setParameter('url', urldecode($url))
 332             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 333             ->getQuery()
 334             ->getResult();
 335
 336         if (\count($res)) {
 337             return current($res);
 338         }
 339
 340         return false;
 341     }
 342
 343     /**
 344      * Count all entries for a user.
 345      *
 346      * @param int $userId
 347      *
 348      * @return int
 349      */
 350     public function countAllEntriesByUser($userId)
 351     {
 352         $qb = $this->createQueryBuilder('e')
 353             ->select('count(e)')
 354             ->where('e.user = :userId')->setParameter('userId', $userId)
 355         ;
 356
 357         return (int) $qb->getQuery()->getSingleScalarResult();
 358     }
 359
 360     /**
 361      * Remove all entries for a user id.
 362      * Used when a user want to reset all informations.
 363      *
 364      * @param int $userId
 365      */
 366     public function removeAllByUserId($userId)
 367     {
 368         $this->getEntityManager()
 369             ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId')
 370             ->setParameter('userId', $userId)
 371             ->execute();
 372     }
 373
 374     public function removeArchivedByUserId($userId)
 375     {
 376         $this->getEntityManager()
 377             ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId AND e.isArchived = TRUE')
 378             ->setParameter('userId', $userId)
 379             ->execute();
 380     }
 381
 382     /**
 383      * Get id and url from all entries
 384      * Used for the clean-duplicates command.
 385      */
 386     public function findAllEntriesIdAndUrlByUserId($userId)
 387     {
 388         $qb = $this->createQueryBuilder('e')
 389             ->select('e.id, e.url')
 390             ->where('e.user = :userid')->setParameter(':userid', $userId);
 391
 392         return $qb->getQuery()->getArrayResult();
 393     }
 394
 395     /**
 396      * @param int $userId
 397      *
 398      * @return array
 399      */
 400     public function findAllEntriesIdByUserId($userId = null)
 401     {
 402         $qb = $this->createQueryBuilder('e')
 403             ->select('e.id');
 404
 405         if (null !== $userId) {
 406             $qb->where('e.user = :userid')->setParameter(':userid', $userId);
 407         }
 408
 409         return $qb->getQuery()->getArrayResult();
 410     }
 411
 412     /**
 413      * Find all entries by url and owner.
 414      *
 415      * @param $url
 416      * @param $userId
 417      *
 418      * @return array
 419      */
 420     public function findAllByUrlAndUserId($url, $userId)
 421     {
 422         return $this->createQueryBuilder('e')
 423             ->where('e.url = :url')->setParameter('url', urldecode($url))
 424             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 425             ->getQuery()
 426             ->getResult();
 427     }
 428
 429     /**
 430      * Return a query builder to be used by other getBuilderFor* method.
 431      *
 432      * @param int $userId
 433      *
 434      * @return QueryBuilder
 435      */
 436     private function getQueryBuilderByUser($userId)
 437     {
 438         return $this->createQueryBuilder('e')
 439             ->andWhere('e.user = :userId')->setParameter('userId', $userId);
 440     }
 441
 442     /**
 443      * Return a sorted query builder to be used by other getBuilderFor* method.
 444      *
 445      * @param int    $userId
 446      * @param string $sortBy
 447      * @param string $direction
 448      *
 449      * @return QueryBuilder
 450      */
 451     private function getSortedQueryBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc')
 452     {
 453         return $this->sortQueryBuilder($this->getQueryBuilderByUser($userId), $sortBy, $direction);
 454     }
 455
 456     /**
 457      * Return the given QueryBuilder with an orderBy() call.
 458      *
 459      * @param QueryBuilder $qb
 460      * @param string       $sortBy
 461      * @param string       $direction
 462      *
 463      * @return QueryBuilder
 464      */
 465     private function sortQueryBuilder(QueryBuilder $qb, $sortBy = 'createdAt', $direction = 'desc')
 466     {
 467         return $qb
 468             ->orderBy(sprintf('e.%s', $sortBy), $direction);
 469     }
 470 }