Add Wallabag\CoreBundle\Helper\UrlHasher

[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Repository / EntryRepository.php

diff --git a/src/Wallabag/CoreBundle/Repository/EntryRepository.php b/src/Wallabag/CoreBundle/Repository/EntryRepository.php
index 45366623d23204e8d8a1ffd3bfd9b1fd1c2ca832..37fc1000fb78af4caf0901e3c3f87807d0600c1b 100644 (file)
--- a/src/Wallabag/CoreBundle/Repository/EntryRepository.php
+++ b/src/Wallabag/CoreBundle/Repository/EntryRepository.php
@@ -9,6 +9,7 @@ use Pagerfanta\Adapter\DoctrineORMAdapter;
 use Pagerfanta\Pagerfanta;
 use Wallabag\CoreBundle\Entity\Entry;
 use Wallabag\CoreBundle\Entity\Tag;
+use Wallabag\CoreBundle\Helper\UrlHasher;
 
 class EntryRepository extends EntityRepository
 {
@@ -139,15 +140,30 @@ class EntryRepository extends EntityRepository
      * @param string $order
      * @param int    $since
      * @param string $tags
+     * @param string $detail     'metadata' or 'full'. Include content field if 'full'
+     *
+     * @todo Breaking change: replace default detail=full by detail=metadata in a future version
      *
      * @return Pagerfanta
      */
-    public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '')
+    public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full')
     {
+        if (!\in_array(strtolower($detail), ['full', 'metadata'], true)) {
+            throw new \Exception('Detail "' . $detail . '" parameter is wrong, allowed: full or metadata');
+        }
+
         $qb = $this->createQueryBuilder('e')
             ->leftJoin('e.tags', 't')
             ->where('e.user = :userId')->setParameter('userId', $userId);
 
+        if ('metadata' === $detail) {
+            $fieldNames = $this->getClassMetadata()->getFieldNames();
+            $fields = array_filter($fieldNames, function ($k) {
+                return 'content' !== $k;
+            });
+            $qb->select(sprintf('partial e.{%s}', implode(',', $fields)));
+        }
+
         if (null !== $isArchived) {
             $qb->andWhere('e.isArchived = :isArchived')->setParameter('isArchived', (bool) $isArchived);
         }
@@ -332,9 +348,25 @@ class EntryRepository extends EntityRepository
      * @return Entry|bool
      */
     public function findByUrlAndUserId($url, $userId)
+    {
+        return $this->findByHashedUrlAndUserId(
+            UrlHasher::hashUrl($url),
+            $userId);
+    }
+
+    /**
+     * Find an entry by its hashed url and its owner.
+     * If it exists, return the entry otherwise return false.
+     *
+     * @param string $hashedUrl Url hashed using sha1
+     * @param int    $userId
+     *
+     * @return Entry|bool
+     */
+    public function findByHashedUrlAndUserId($hashedUrl, $userId)
     {
         $res = $this->createQueryBuilder('e')
-            ->where('e.url = :url')->setParameter('url', urldecode($url))
+            ->where('e.hashedUrl = :hashed_url')->setParameter('hashed_url', $hashedUrl)
             ->andWhere('e.user = :user_id')->setParameter('user_id', $userId)
             ->getQuery()
             ->getResult();
@@ -475,6 +507,32 @@ class EntryRepository extends EntityRepository
         return $this->find($randomId);
     }
 
+    /**
+     * Inject a UrlHasher.
+     *
+     * @param UrlHasher $hasher
+     */
+    public function setUrlHasher(UrlHasher $hasher)
+    {
+        $this->urlHasher = $hasher;
+    }
+
+    /**
+     * Get the UrlHasher, or create a default one if not injected.
+     *
+     * XXX: the default uses the default hash algorithm
+     *
+     * @return UrlHasher
+     */
+    protected function getUrlHasher()
+    {
+        if (!isset($this->urlHasher)) {
+            $this->setUrlHasher(new UrlHasher());
+        }
+
+        return $this->urlHasher;
+    }
+
     /**
      * Return a query builder to be used by other getBuilderFor* method.
      *