src/Wallabag/CoreBundle/Repository/EntryRepository.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Repository;
   4
   5 use Doctrine\ORM\EntityRepository;
   6 use Pagerfanta\Adapter\DoctrineORMAdapter;
   7 use Pagerfanta\Pagerfanta;
   8 use Wallabag\CoreBundle\Entity\Tag;
   9
  10 class EntryRepository extends EntityRepository
  11 {
  12     /**
  13      * Return a query builder to used by other getBuilderFor* method.
  14      *
  15      * @param int $userId
  16      *
  17      * @return QueryBuilder
  18      */
  19     private function getBuilderByUser($userId)
  20     {
  21         return $this->createQueryBuilder('e')
  22             ->leftJoin('e.user', 'u')
  23             ->andWhere('u.id = :userId')->setParameter('userId', $userId)
  24             ->orderBy('e.id', 'desc')
  25         ;
  26     }
  27
  28     /**
  29      * Retrieves all entries for a user.
  30      *
  31      * @param int $userId
  32      *
  33      * @return QueryBuilder
  34      */
  35     public function getBuilderForAllByUser($userId)
  36     {
  37         return $this
  38             ->getBuilderByUser($userId)
  39         ;
  40     }
  41
  42     /**
  43      * Retrieves unread entries for a user.
  44      *
  45      * @param int $userId
  46      *
  47      * @return QueryBuilder
  48      */
  49     public function getBuilderForUnreadByUser($userId)
  50     {
  51         return $this
  52             ->getBuilderByUser($userId)
  53             ->andWhere('e.isArchived = false')
  54         ;
  55     }
  56
  57     /**
  58      * Retrieves read entries for a user.
  59      *
  60      * @param int $userId
  61      *
  62      * @return QueryBuilder
  63      */
  64     public function getBuilderForArchiveByUser($userId)
  65     {
  66         return $this
  67             ->getBuilderByUser($userId)
  68             ->andWhere('e.isArchived = true')
  69         ;
  70     }
  71
  72     /**
  73      * Retrieves starred entries for a user.
  74      *
  75      * @param int $userId
  76      *
  77      * @return QueryBuilder
  78      */
  79     public function getBuilderForStarredByUser($userId)
  80     {
  81         return $this
  82             ->getBuilderByUser($userId)
  83             ->andWhere('e.isStarred = true')
  84         ;
  85     }
  86
  87     /**
  88      * Find Entries.
  89      *
  90      * @param int    $userId
  91      * @param bool   $isArchived
  92      * @param bool   $isStarred
  93      * @param string $sort
  94      * @param string $order
  95      *
  96      * @return array
  97      */
  98     public function findEntries($userId, $isArchived = null, $isStarred = null, $sort = 'created', $order = 'ASC', $since = 0, $tags = '')
  99     {
 100         $qb = $this->createQueryBuilder('e')
 101             ->leftJoin('e.tags', 't')
 102             ->where('e.user =:userId')->setParameter('userId', $userId);
 103
 104         if (null !== $isArchived) {
 105             $qb->andWhere('e.isArchived =:isArchived')->setParameter('isArchived', (bool) $isArchived);
 106         }
 107
 108         if (null !== $isStarred) {
 109             $qb->andWhere('e.isStarred =:isStarred')->setParameter('isStarred', (bool) $isStarred);
 110         }
 111
 112         if ($since >= 0) {
 113             $qb->andWhere('e.updatedAt > :since')->setParameter('since', new \DateTime(date('Y-m-d H:i:s', $since)));
 114
 115         if ('' !== $tags) {
 116             foreach (explode(',', $tags) as $tag) {
 117                 $qb->andWhere('t.label = :label')->setParameter('label', $tag);
 118             }
 119         }
 120
 121         if ('created' === $sort) {
 122             $qb->orderBy('e.id', $order);
 123         } elseif ('updated' === $sort) {
 124             $qb->orderBy('e.updatedAt', $order);
 125         }
 126
 127         $pagerAdapter = new DoctrineORMAdapter($qb);
 128
 129         return new Pagerfanta($pagerAdapter);
 130     }
 131
 132     /**
 133      * Fetch an entry with a tag. Only used for tests.
 134      *
 135      * @param int $userId
 136      *
 137      * @return Entry
 138      */
 139     public function findOneWithTags($userId)
 140     {
 141         $qb = $this->createQueryBuilder('e')
 142             ->innerJoin('e.tags', 't')
 143             ->innerJoin('e.user', 'u')
 144             ->addSelect('t', 'u')
 145             ->where('e.user=:userId')->setParameter('userId', $userId)
 146         ;
 147
 148         return $qb->getQuery()->getResult();
 149     }
 150
 151     /**
 152      * Find distinct language for a given user.
 153      * Used to build the filter language list.
 154      *
 155      * @param int $userId User id
 156      *
 157      * @return array
 158      */
 159     public function findDistinctLanguageByUser($userId)
 160     {
 161         $results = $this->createQueryBuilder('e')
 162             ->select('e.language')
 163             ->where('e.user = :userId')->setParameter('userId', $userId)
 164             ->andWhere('e.language IS NOT NULL')
 165             ->groupBy('e.language')
 166             ->orderBy('e.language', ' ASC')
 167             ->getQuery()
 168             ->getResult();
 169
 170         $languages = [];
 171         foreach ($results as $result) {
 172             $languages[$result['language']] = $result['language'];
 173         }
 174
 175         return $languages;
 176     }
 177
 178     /**
 179      * Used only in test case to get the right entry associated to the right user.
 180      *
 181      * @param string $username
 182      *
 183      * @return Entry
 184      */
 185     public function findOneByUsernameAndNotArchived($username)
 186     {
 187         return $this->createQueryBuilder('e')
 188             ->leftJoin('e.user', 'u')
 189             ->where('u.username = :username')->setParameter('username', $username)
 190             ->andWhere('e.isArchived = false')
 191             ->setMaxResults(1)
 192             ->getQuery()
 193             ->getSingleResult();
 194     }
 195
 196     /**
 197      * Remove a tag from all user entries.
 198      *
 199      * 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.
 200      * 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:
 201      *
 202      * 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
 203      *
 204      * @param int $userId
 205      * @param Tag $tag
 206      */
 207     public function removeTag($userId, Tag $tag)
 208     {
 209         $entries = $this->getBuilderByUser($userId)
 210             ->innerJoin('e.tags', 't')
 211             ->andWhere('t.id = :tagId')->setParameter('tagId', $tag->getId())
 212             ->getQuery()
 213             ->getResult();
 214
 215         foreach ($entries as $entry) {
 216             $entry->removeTag($tag);
 217         }
 218
 219         $this->getEntityManager()->flush();
 220     }
 221
 222     /**
 223      * Find all entries that are attached to a give tag id.
 224      *
 225      * @param int $userId
 226      * @param int $tagId
 227      *
 228      * @return array
 229      */
 230     public function findAllByTagId($userId, $tagId)
 231     {
 232         return $this->getBuilderByUser($userId)
 233             ->innerJoin('e.tags', 't')
 234             ->andWhere('t.id = :tagId')->setParameter('tagId', $tagId)
 235             ->getQuery()
 236             ->getResult();
 237     }
 238
 239     /**
 240      * Find an entry by its url and its owner.
 241      * If it exists, return the entry otherwise return false.
 242      *
 243      * @param $url
 244      * @param $userId
 245      *
 246      * @return Entry|bool
 247      */
 248     public function findByUrlAndUserId($url, $userId)
 249     {
 250         $res = $this->createQueryBuilder('e')
 251             ->where('e.url = :url')->setParameter('url', $url)
 252             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
 253             ->getQuery()
 254             ->getResult();
 255
 256         if (count($res)) {
 257             return current($res);
 258         }
 259
 260         return false;
 261     }
 262
 263     /**
 264      * Count all entries for a user.
 265      *
 266      * @param int $userId
 267      *
 268      * @return int
 269      */
 270     public function countAllEntriesByUsername($userId)
 271     {
 272         $qb = $this->createQueryBuilder('e')
 273             ->select('count(e)')
 274             ->where('e.user=:userId')->setParameter('userId', $userId)
 275         ;
 276
 277         return $qb->getQuery()->getSingleScalarResult();
 278     }
 279 }