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)
55 $queryBuilder = $this->createQueryBuilder('e');
58 ->getSortedQueryBuilderByUser($userId)
59 ->andWhere('e.id <> :entryId')->setParameter('entryId', $entryId)
61 $queryBuilder->expr()->in(
64 ->createQueryBuilder('e2')
65 ->select('e2.domainName')
66 ->where('e2.id = :entryId')->setParameter('entryId', $entryId)
73 * Retrieves read entries for a user.
77 * @return QueryBuilder
79 public function getBuilderForArchiveByUser($userId)
82 ->getSortedQueryBuilderByUser($userId, 'archivedAt', 'desc')
83 ->andWhere('e.isArchived = true')
88 * Retrieves starred entries for a user.
92 * @return QueryBuilder
94 public function getBuilderForStarredByUser($userId)
97 ->getSortedQueryBuilderByUser($userId, 'starredAt', 'desc')
98 ->andWhere('e.isStarred = true')
103 * Retrieves entries filtered with a search term for a user.
106 * @param string $term
107 * @param string $currentRoute
109 * @return QueryBuilder
111 public function getBuilderForSearchByUser($userId, $term, $currentRoute)
114 ->getSortedQueryBuilderByUser($userId);
116 if ('starred' === $currentRoute) {
117 $qb->andWhere('e.isStarred = true');
118 } elseif ('unread' === $currentRoute) {
119 $qb->andWhere('e.isArchived = false');
120 } elseif ('archive' === $currentRoute) {
121 $qb->andWhere('e.isArchived = true');
124 // We lower() all parts here because PostgreSQL 'LIKE' verb is case-sensitive
126 ->andWhere('lower(e.content) LIKE lower(:term) OR lower(e.title) LIKE lower(:term) OR lower(e.url) LIKE lower(:term)')->setParameter('term', '%' . $term . '%')
127 ->leftJoin('e.tags', 't')
134 * Retrieve a sorted list of untagged entries for a user.
138 * @return QueryBuilder
140 public function getBuilderForUntaggedByUser($userId)
142 return $this->sortQueryBuilder($this->getRawBuilderForUntaggedByUser($userId));
146 * Retrieve untagged entries for a user.
150 * @return QueryBuilder
152 public function getRawBuilderForUntaggedByUser($userId)
154 return $this->getQueryBuilderByUser($userId)
155 ->leftJoin('e.tags', 't')
156 ->andWhere('t.id is null');
160 * Retrieve the number of untagged entries for a user.
166 public function countUntaggedEntriesByUser($userId)
168 return (int) $this->getRawBuilderForUntaggedByUser($userId)
169 ->select('count(e.id)')
171 ->getSingleScalarResult();
178 * @param bool $isArchived
179 * @param bool $isStarred
180 * @param bool $isPublic
181 * @param string $sort
182 * @param string $order
184 * @param string $tags
185 * @param string $detail 'metadata' or 'full'. Include content field if 'full'
187 * @todo Breaking change: replace default detail=full by detail=metadata in a future version
191 public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full')
193 if (!\
in_array(strtolower($detail), ['full', 'metadata'], true)) {
194 throw new \
Exception('Detail "' . $detail . '" parameter is wrong, allowed: full or metadata');
197 $qb = $this->createQueryBuilder('e')
198 ->leftJoin('e.tags', 't')
199 ->where('e.user = :userId')->setParameter('userId', $userId);
201 if ('metadata' === $detail) {
202 $fieldNames = $this->getClassMetadata()->getFieldNames();
203 $fields = array_filter($fieldNames, function ($k) {
204 return 'content' !== $k;
206 $qb->select(sprintf('partial e.{%s}', implode(',', $fields)));
209 if (null !== $isArchived) {
210 $qb->andWhere('e.isArchived = :isArchived')->setParameter('isArchived', (bool) $isArchived);
213 if (null !== $isStarred) {
214 $qb->andWhere('e.isStarred = :isStarred')->setParameter('isStarred', (bool) $isStarred);
217 if (null !== $isPublic) {
218 $qb->andWhere('e.uid IS ' . (true === $isPublic ? 'NOT' : '') . ' NULL');
222 $qb->andWhere('e.updatedAt > :since')->setParameter('since', new \
DateTime(date('Y-m-d H:i:s', $since)));
225 if (\
is_string($tags) && '' !== $tags) {
226 foreach (explode(',', $tags) as $i => $tag) {
227 $entryAlias = 'e' . $i;
228 $tagAlias = 't' . $i;
230 // Complexe queries to ensure multiple tags are associated to an entry
231 // https://stackoverflow.com/a/6638146/569101
232 $qb->andWhere($qb->expr()->in(
234 $this->createQueryBuilder($entryAlias)
235 ->select($entryAlias . '.id')
236 ->leftJoin($entryAlias . '.tags', $tagAlias)
237 ->where($tagAlias . '.label = :label' . $i)
241 // bound parameter to the main query builder
242 $qb->setParameter('label' . $i, $tag);
246 if (!\
in_array(strtolower($order), ['asc', 'desc'], true)) {
247 throw new \
Exception('Order "' . $order . '" parameter is wrong, allowed: asc or desc');
250 if ('created' === $sort) {
251 $qb->orderBy('e.id', $order);
252 } elseif ('updated' === $sort) {
253 $qb->orderBy('e.updatedAt', $order);
254 } elseif ('archived' === $sort) {
255 $qb->orderBy('e.archivedAt', $order);
258 $pagerAdapter = new DoctrineORMAdapter($qb, true, false);
260 return new Pagerfanta($pagerAdapter);
264 * Fetch an entry with a tag. Only used for tests.
270 public function findOneWithTags($userId)
272 $qb = $this->createQueryBuilder('e')
273 ->innerJoin('e.tags', 't')
274 ->innerJoin('e.user', 'u')
275 ->addSelect('t', 'u')
276 ->where('e.user = :userId')->setParameter('userId', $userId)
279 return $qb->getQuery()->getResult();
283 * Find distinct language for a given user.
284 * Used to build the filter language list.
286 * @param int $userId User id
290 public function findDistinctLanguageByUser($userId)
292 $results = $this->createQueryBuilder('e')
293 ->select('e.language')
294 ->where('e.user = :userId')->setParameter('userId', $userId)
295 ->andWhere('e.language IS NOT NULL')
296 ->groupBy('e.language')
297 ->orderBy('e.language', ' ASC')
302 foreach ($results as $result) {
303 $languages[$result['language']] = $result['language'];
310 * Used only in test case to get the right entry associated to the right user.
312 * @param string $username
316 public function findOneByUsernameAndNotArchived($username)
318 return $this->createQueryBuilder('e')
319 ->leftJoin('e.user', 'u')
320 ->where('u.username = :username')->setParameter('username', $username)
321 ->andWhere('e.isArchived = false')
328 * Remove a tag from all user entries.
330 * 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.
331 * 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:
333 * 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
337 public function removeTag($userId, Tag
$tag)
339 $entries = $this->getSortedQueryBuilderByUser($userId)
340 ->innerJoin('e.tags', 't')
341 ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId())
345 foreach ($entries as $entry) {
346 $entry->removeTag($tag);
349 $this->getEntityManager()->flush();
353 * Remove tags from all user entries.
356 * @param Array<Tag> $tags
358 public function removeTags($userId, $tags)
360 foreach ($tags as $tag) {
361 $this->removeTag($userId, $tag);
366 * Find all entries that are attached to a give tag id.
373 public function findAllByTagId($userId, $tagId)
375 return $this->getSortedQueryBuilderByUser($userId)
376 ->innerJoin('e.tags', 't')
377 ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId)
383 * Find an entry by its url and its owner.
384 * If it exists, return the entry otherwise return false.
389 * @return Entry|false
391 public function findByUrlAndUserId($url, $userId)
393 return $this->findByHashedUrlAndUserId(
394 UrlHasher
::hashUrl($url),
400 * Find an entry by its hashed url and its owner.
401 * If it exists, return the entry otherwise return false.
403 * @param string $hashedUrl Url hashed using sha1
406 * @return Entry|false
408 public function findByHashedUrlAndUserId($hashedUrl, $userId)
410 // try first using hashed_url (to use the database index)
411 $res = $this->createQueryBuilder('e')
412 ->where('e.hashedUrl = :hashed_url')->setParameter('hashed_url', $hashedUrl)
413 ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
418 return current($res);
421 // then try using hashed_given_url (to use the database index)
422 $res = $this->createQueryBuilder('e')
423 ->where('e.hashedGivenUrl = :hashed_given_url')->setParameter('hashed_given_url', $hashedUrl)
424 ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
429 return current($res);
436 * Count all entries for a user.
442 public function countAllEntriesByUser($userId)
444 $qb = $this->createQueryBuilder('e')
446 ->where('e.user = :userId')->setParameter('userId', $userId)
449 return (int) $qb->getQuery()->getSingleScalarResult();
453 * Remove all entries for a user id.
454 * Used when a user want to reset all informations.
458 public function removeAllByUserId($userId)
460 $this->getEntityManager()
461 ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId')
462 ->setParameter('userId', $userId)
466 public function removeArchivedByUserId($userId)
468 $this->getEntityManager()
469 ->createQuery('DELETE FROM Wallabag\CoreBundle\Entity\Entry e WHERE e.user = :userId AND e.isArchived = TRUE')
470 ->setParameter('userId', $userId)
475 * Get id and url from all entries
476 * Used for the clean-duplicates command.
478 public function findAllEntriesIdAndUrlByUserId($userId)
480 $qb = $this->createQueryBuilder('e')
481 ->select('e.id, e.url')
482 ->where('e.user = :userid')->setParameter(':userid', $userId);
484 return $qb->getQuery()->getArrayResult();
492 public function findAllEntriesIdByUserId($userId = null)
494 $qb = $this->createQueryBuilder('e')
497 if (null !== $userId) {
498 $qb->where('e.user = :userid')->setParameter(':userid', $userId);
501 return $qb->getQuery()->getArrayResult();
505 * Find all entries by url and owner.
512 public function findAllByUrlAndUserId($url, $userId)
514 return $this->createQueryBuilder('e')
515 ->where('e.url = :url')->setParameter('url', urldecode($url))
516 ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
522 * Returns a random entry, filtering by status.
525 * @param string $type Can be unread, archive, starred, etc
527 * @throws NoResultException
531 public function getRandomEntry($userId, $type = '')
533 $qb = $this->getQueryBuilderByUser($userId)
538 $qb->andWhere('e.isArchived = false');
541 $qb->andWhere('e.isArchived = true');
544 $qb->andWhere('e.isStarred = true');
547 $qb->leftJoin('e.tags', 't');
548 $qb->andWhere('t.id is null');
552 $ids = $qb->getQuery()->getArrayResult();
555 throw new NoResultException();
558 // random select one in the list
559 $randomId = $ids[mt_rand(0, \
count($ids) - 1)]['id'];
561 return $this->find($randomId);
565 * Return a query builder to be used by other getBuilderFor* method.
569 * @return QueryBuilder
571 private function getQueryBuilderByUser($userId)
573 return $this->createQueryBuilder('e')
574 ->andWhere('e.user = :userId')->setParameter('userId', $userId);
578 * Return a sorted query builder to be used by other getBuilderFor* method.
581 * @param string $sortBy
582 * @param string $direction
584 * @return QueryBuilder
586 private function getSortedQueryBuilderByUser($userId, $sortBy = 'createdAt', $direction = 'desc')
588 return $this->sortQueryBuilder($this->getQueryBuilderByUser($userId), $sortBy, $direction);
592 * Return the given QueryBuilder with an orderBy() call.
594 * @param string $sortBy
595 * @param string $direction
597 * @return QueryBuilder
599 private function sortQueryBuilder(QueryBuilder
$qb, $sortBy = 'createdAt', $direction = 'desc')
601 return $qb->orderBy(sprintf('e.%s', $sortBy), $direction);