3 namespace Wallabag\CoreBundle\Repository
;
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
;
14 class EntryRepository
extends EntityRepository
17 * Retrieves all entries for a user.
21 * @return QueryBuilder
23 public function getBuilderForAllByUser($userId)
26 ->getSortedQueryBuilderByUser($userId)
31 * Retrieves unread entries for a user.
35 * @return QueryBuilder
37 public function getBuilderForUnreadByUser($userId)
40 ->getSortedQueryBuilderByUser($userId)
41 ->andWhere('e.isArchived = false')
46 * Retrieves entries with the same domain.
51 * @return QueryBuilder
53 public function getBuilderForSameDomainByUser($userId, $entryId)
60 ->getSortedQueryBuilderByUser($userId)
61 ->andWhere('e.isArchived = false')
66 * Retrieves read entries for a user.
70 * @return QueryBuilder
72 public function getBuilderForArchiveByUser($userId)
75 ->getSortedQueryBuilderByUser($userId, 'archivedAt', 'desc')
76 ->andWhere('e.isArchived = true')
81 * Retrieves starred entries for a user.
85 * @return QueryBuilder
87 public function getBuilderForStarredByUser($userId)
90 ->getSortedQueryBuilderByUser($userId, 'starredAt', 'desc')
91 ->andWhere('e.isStarred = true')
96 * Retrieves entries filtered with a search term for a user.
100 * @param string $currentRoute
102 * @return QueryBuilder
104 public function getBuilderForSearchByUser($userId, $term, $currentRoute)
107 ->getSortedQueryBuilderByUser($userId);
109 if ('starred' === $currentRoute) {
110 $qb->andWhere('e.isStarred = true');
111 } elseif ('unread' === $currentRoute) {
112 $qb->andWhere('e.isArchived = false');
113 } elseif ('archive' === $currentRoute) {
114 $qb->andWhere('e.isArchived = true');
117 // We lower() all parts here because PostgreSQL 'LIKE' verb is case-sensitive
119 ->andWhere('lower(e.content) LIKE lower(:term) OR lower(e.title) LIKE lower(:term) OR lower(e.url) LIKE lower(:term)')->setParameter('term', '%' . $term . '%')
120 ->leftJoin('e.tags', 't')
127 * Retrieve a sorted list of untagged entries for a user.
131 * @return QueryBuilder
133 public function getBuilderForUntaggedByUser($userId)
135 return $this->sortQueryBuilder($this->getRawBuilderForUntaggedByUser($userId));
139 * Retrieve untagged entries for a user.
143 * @return QueryBuilder
145 public function getRawBuilderForUntaggedByUser($userId)
147 return $this->getQueryBuilderByUser($userId)
148 ->leftJoin('e.tags', 't')
149 ->andWhere('t.id is null');
153 * Retrieve the number of untagged entries for a user.
159 public function countUntaggedEntriesByUser($userId)
161 return (int) $this->getRawBuilderForUntaggedByUser($userId)
162 ->select('count(e.id)')
164 ->getSingleScalarResult();
171 * @param bool $isArchived
172 * @param bool $isStarred
173 * @param bool $isPublic
174 * @param string $sort
175 * @param string $order
177 * @param string $tags
178 * @param string $detail 'metadata' or 'full'. Include content field if 'full'
180 * @todo Breaking change: replace default detail=full by detail=metadata in a future version
184 public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full')
186 if (!\
in_array(strtolower($detail), ['full', 'metadata'], true)) {
187 throw new \
Exception('Detail "' . $detail . '" parameter is wrong, allowed: full or metadata');
190 $qb = $this->createQueryBuilder('e')
191 ->leftJoin('e.tags', 't')
192 ->where('e.user = :userId')->setParameter('userId', $userId);
194 if ('metadata' === $detail) {
195 $fieldNames = $this->getClassMetadata()->getFieldNames();
196 $fields = array_filter($fieldNames, function ($k) {
197 return 'content' !== $k;
199 $qb->select(sprintf('partial e.{%s}', implode(',', $fields)));
202 if (null !== $isArchived) {
203 $qb->andWhere('e.isArchived = :isArchived')->setParameter('isArchived', (bool) $isArchived);
206 if (null !== $isStarred) {
207 $qb->andWhere('e.isStarred = :isStarred')->setParameter('isStarred', (bool) $isStarred);
210 if (null !== $isPublic) {
211 $qb->andWhere('e.uid IS ' . (true === $isPublic ? 'NOT' : '') . ' NULL');
215 $qb->andWhere('e.updatedAt > :since')->setParameter('since', new \
DateTime(date('Y-m-d H:i:s', $since)));
218 if (\
is_string($tags) && '' !== $tags) {
219 foreach (explode(',', $tags) as $i => $tag) {
220 $entryAlias = 'e' . $i;
221 $tagAlias = 't' . $i;
223 // Complexe queries to ensure multiple tags are associated to an entry
224 // https://stackoverflow.com/a/6638146/569101
225 $qb->andWhere($qb->expr()->in(
227 $this->createQueryBuilder($entryAlias)
228 ->select($entryAlias . '.id')
229 ->leftJoin($entryAlias . '.tags', $tagAlias)
230 ->where($tagAlias . '.label = :label' . $i)
234 // bound parameter to the main query builder
235 $qb->setParameter('label' . $i, $tag);
239 if (!\
in_array(strtolower($order), ['asc', 'desc'], true)) {
240 throw new \
Exception('Order "' . $order . '" parameter is wrong, allowed: asc or desc');
243 if ('created' === $sort) {
244 $qb->orderBy('e.id', $order);
245 } elseif ('updated' === $sort) {
246 $qb->orderBy('e.updatedAt', $order);
247 } elseif ('archived' === $sort) {
248 $qb->orderBy('e.archivedAt', $order);
251 $pagerAdapter = new DoctrineORMAdapter($qb, true, false);
253 return new Pagerfanta($pagerAdapter);
257 * Fetch an entry with a tag. Only used for tests.
263 public function findOneWithTags($userId)
265 $qb = $this->createQueryBuilder('e')
266 ->innerJoin('e.tags', 't')
267 ->innerJoin('e.user', 'u')
268 ->addSelect('t', 'u')
269 ->where('e.user = :userId')->setParameter('userId', $userId)
272 return $qb->getQuery()->getResult();
276 * Find distinct language for a given user.
277 * Used to build the filter language list.
279 * @param int $userId User id
283 public function findDistinctLanguageByUser($userId)
285 $results = $this->createQueryBuilder('e')
286 ->select('e.language')
287 ->where('e.user = :userId')->setParameter('userId', $userId)
288 ->andWhere('e.language IS NOT NULL')
289 ->groupBy('e.language')
290 ->orderBy('e.language', ' ASC')
295 foreach ($results as $result) {
296 $languages[$result['language']] = $result['language'];
303 * Used only in test case to get the right entry associated to the right user.
305 * @param string $username
309 public function findOneByUsernameAndNotArchived($username)
311 return $this->createQueryBuilder('e')
312 ->leftJoin('e.user', 'u')
313 ->where('u.username = :username')->setParameter('username', $username)
314 ->andWhere('e.isArchived = false')
321 * Remove a tag from all user entries.
323 * 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.
324 * 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:
326 * 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
330 public function removeTag($userId, Tag
$tag)
332 $entries = $this->getSortedQueryBuilderByUser($userId)
333 ->innerJoin('e.tags', 't')
334 ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId())
338 foreach ($entries as $entry) {
339 $entry->removeTag($tag);
342 $this->getEntityManager()->flush();
346 * Remove tags from all user entries.
349 * @param Array<Tag> $tags
351 public function removeTags($userId, $tags)
353 foreach ($tags as $tag) {
354 $this->removeTag($userId, $tag);
359 * Find all entries that are attached to a give tag id.
366 public function findAllByTagId($userId, $tagId)
368 return $this->getSortedQueryBuilderByUser($userId)
369 ->innerJoin('e.tags', 't')
370 ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId)
376 * Find an entry by its url and its owner.
377 * If it exists, return the entry otherwise return false.
382 * @return Entry|false
384 public function findByUrlAndUserId($url, $userId)
386 return $this->findByHashedUrlAndUserId(
387 UrlHasher
::hashUrl($url),
393 * Find an entry by its hashed url and its owner.
394 * If it exists, return the entry otherwise return false.
396 * @param string $hashedUrl Url hashed using sha1
399 * @return Entry|false
401 public function findByHashedUrlAndUserId($hashedUrl, $userId)
403 // try first using hashed_url (to use the database index)
404 $res = $this->createQueryBuilder('e')
405 ->where('e.hashedUrl = :hashed_url')->setParameter('hashed_url', $hashedUrl)
406 ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
411 return current($res);
414 // then try using hashed_given_url (to use the database index)
415 $res = $this->createQueryBuilder('e')
416 ->where('e.hashedGivenUrl = :hashed_given_url')->setParameter('hashed_given_url', $hashedUrl)
417 ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
422 return current($res);
429 * Count all entries for a user.
435 public function countAllEntriesByUser($userId)
437 $qb = $this->createQueryBuilder('e')
439 ->where('e.user = :userId')->setParameter('userId', $userId)
442 return (int) $qb->getQuery()->getSingleScalarResult();
446 * Remove all entries for a user id.
447 * Used when a user want to reset all informations.
451 public function removeAllByUserId($userId)
453 $this->getEntityManager()
454 ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId')
455 ->setParameter('userId', $userId)
459 public function removeArchivedByUserId($userId)
461 $this->getEntityManager()
462 ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId AND e.isArchived = TRUE')
463 ->setParameter('userId', $userId)
468 * Get id and url from all entries
469 * Used for the clean-duplicates command.
471 public function findAllEntriesIdAndUrlByUserId($userId)
473 $qb = $this->createQueryBuilder('e')
474 ->select('e.id, e.url')
475 ->where('e.user = :userid')->setParameter(':userid', $userId);
477 return $qb->getQuery()->getArrayResult();
485 public function findAllEntriesIdByUserId($userId = null)
487 $qb = $this->createQueryBuilder('e')
490 if (null !== $userId) {
491 $qb->where('e.user = :userid')->setParameter(':userid', $userId);
494 return $qb->getQuery()->getArrayResult();
498 * Find all entries by url and owner.
505 public function findAllByUrlAndUserId($url, $userId)
507 return $this->createQueryBuilder('e')
508 ->where('e.url = :url')->setParameter('url', urldecode($url))
509 ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
515 * Returns a random entry, filtering by status.
518 * @param string $type Can be unread, archive, starred, etc
520 * @throws NoResultException
524 public function getRandomEntry($userId, $type = '')
526 $qb = $this->getQueryBuilderByUser($userId)
531 $qb->andWhere('e.isArchived = false');
534 $qb->andWhere('e.isArchived = true');
537 $qb->andWhere('e.isStarred = true');
540 $qb->leftJoin('e.tags', 't');
541 $qb->andWhere('t.id is null');
545 $ids = $qb->getQuery()->getArrayResult();
548 throw new NoResultException();
551 // random select one in the list
552 $randomId = $ids[mt_rand(0, \
count($ids) - 1)]['id'];
554 return $this->find($randomId);
558 * Return a query builder to be used by other getBuilderFor* method.
562 * @return QueryBuilder
564 private function getQueryBuilderByUser($userId)
566 return $this->createQueryBuilder('e')
567 ->andWhere('e.user = :userId')->setParameter('userId', $userId);
571 * Return a sorted query builder to be used by other getBuilderFor* method.
574 * @param string $sortBy
575 * @param string $direction
577 * @return QueryBuilder
579 private function getSortedQueryBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc')
581 return $this->sortQueryBuilder($this->getQueryBuilderByUser($userId), $sortBy, $direction);
585 * Return the given QueryBuilder with an orderBy() call.
587 * @param string $sortBy
588 * @param string $direction
590 * @return QueryBuilder
592 private function sortQueryBuilder(QueryBuilder
$qb, $sortBy = 'createdAt', $direction = 'desc')
594 return $qb->orderBy(sprintf('e.%s', $sortBy), $direction);