Filter away shared camps in the API requests

Author: carlobeltrame

api/src/Doctrine/Filter/CampCollaboratorFilter.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace App\Doctrine\Filter;
+
+use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;
+use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Operation;
+use App\Entity\BelongsToCampInterface;
+use App\Entity\Camp;
+use App\Entity\CampCollaboration;
+use App\Util\QueryBuilderHelper;
+use Doctrine\ORM\QueryBuilder;
+use Doctrine\Persistence\ManagerRegistry;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+
+final class CampCollaboratorFilter extends AbstractFilter {
+    public const QUERY_PARAM_NAME = 'campCollaborator';
+
+    public function __construct(
+        private IriConverterInterface $iriConverter,
+        private QueryBuilderHelper $queryBuilderHelper,
+        ManagerRegistry $managerRegistry,
+        ?LoggerInterface $logger = null,
+        ?array $properties = null,
+        ?NameConverterInterface $nameConverter = null
+    ) {
+        parent::__construct($managerRegistry, $logger, $properties, $nameConverter);
+    }
+
+    // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
+    public function getDescription(string $resourceClass): array {
+        return [self::QUERY_PARAM_NAME => [
+            'property' => self::QUERY_PARAM_NAME,
+            'type' => Type::BUILTIN_TYPE_STRING,
+            'required' => false,
+        ]];
+    }
+
+    protected function filterProperty(
+        string $property,
+        $value,
+        QueryBuilder $queryBuilder,
+        QueryNameGeneratorInterface $queryNameGenerator,
+        string $resourceClass,
+        ?Operation $operation = null,
+        array $context = []
+    ): void {
+        if (!class_implements($resourceClass, BelongsToCampInterface::class)) {
+            throw new \Exception("CampCollaboratorFilter can only be applied to entities which implement BelongsToCampInterface (received: {$resourceClass}).");
+        }
+
+        if (self::QUERY_PARAM_NAME !== $property) {
+            return;
+        }
+
+        $campAlias = Camp::class === $resourceClass ?
+            $queryBuilder->getRootAliases()[0] :
+            $this->queryBuilderHelper->findOrAddInnerRootJoinAlias($queryBuilder, $queryNameGenerator, 'camp');
+
+        // load user from query parameter value
+        $collaborator = $this->iriConverter->getResourceFromIri($value);
+
+        $campsQry = $queryBuilder->getEntityManager()->createQueryBuilder();
+        $campsQry->select('identity(cc.camp)');
+        $campsQry->from(CampCollaboration::class, 'cc');
+        $campsQry->andWhere('cc.user = :collaborator');
+        $campsQry->andWhere('cc.status = :status_established');
+
+        $queryBuilder->andWhere($queryBuilder->expr()->in($campAlias, $campsQry->getDQL()));
+        $queryBuilder->setParameter('collaborator', $collaborator);
+        $queryBuilder->setParameter('status_established', CampCollaboration::STATUS_ESTABLISHED);
+    }
+}

api/src/Doctrine/Filter/ContentNodeCampFilter.php

@@ -8,16 +8,13 @@
 use ApiPlatform\Metadata\Operation;
 use App\Entity\Activity;
 use App\Entity\ContentNode;
-use App\Repository\FiltersByCampCollaboration;
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\PropertyInfo\Type;
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 final class ContentNodeCampFilter extends AbstractFilter {
-    use FiltersByCampCollaboration;
-
     public const CAMP_QUERY_NAME = 'camp';
 
     public function __construct(

api/src/Doctrine/Filter/ContentNodePeriodFilter.php

@@ -8,7 +8,6 @@
 use ApiPlatform\Metadata\Operation;
 use App\Entity\Activity;
 use App\Entity\ContentNode;
-use App\Repository\FiltersByCampCollaboration;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\QueryBuilder;
 use Doctrine\Persistence\ManagerRegistry;
@@ -17,8 +16,6 @@
 use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 final class ContentNodePeriodFilter extends AbstractFilter {
-    use FiltersByCampCollaboration;
-
     public const PERIOD_QUERY_NAME = 'period';
 
     public function __construct(

api/src/Entity/Camp.php

@@ -11,6 +11,7 @@
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Patch;
 use ApiPlatform\Metadata\Post;
+use App\Doctrine\Filter\CampCollaboratorFilter;
 use App\InputFilter;
 use App\Repository\CampRepository;
 use App\Serializer\Normalizer\RelatedCollectionLink;
@@ -64,6 +65,7 @@
     normalizationContext: ['groups' => ['read']]
 )]
 #[ApiFilter(filterClass: SearchFilter::class, properties: ['isPrototype'])]
+#[ApiFilter(filterClass: CampCollaboratorFilter::class)]
 #[ORM\Entity(repositoryClass: CampRepository::class)]
 #[ORM\Index(columns: ['isPrototype'])]
 #[ORM\Index(columns: ['isShared'])]

api/src/Entity/Period.php

@@ -11,6 +11,7 @@
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\Patch;
 use ApiPlatform\Metadata\Post;
+use App\Doctrine\Filter\CampCollaboratorFilter;
 use App\InputFilter;
 use App\Repository\PeriodRepository;
 use App\Serializer\Normalizer\RelatedCollectionLink;
@@ -62,6 +63,7 @@
     order: ['start']
 )]
 #[ApiFilter(filterClass: SearchFilter::class, properties: ['camp'])]
+#[ApiFilter(filterClass: CampCollaboratorFilter::class)]
 #[ORM\Entity(repositoryClass: PeriodRepository::class)]
 class Period extends BaseEntity implements BelongsToCampInterface {
     public const ITEM_NORMALIZATION_CONTEXT = [

frontend/src/components/campAdmin/CampPeriods.vue

@@ -4,7 +4,7 @@ Displays all periods of a single camp and allows to edit them & create new ones
 
 <template>
   <content-group
-    :title="$tc('components.campAdmin.campPeriods.title', api.get().camps().items.length)"
+    :title="$tc('components.campAdmin.campPeriods.title', camp.periods().items.length)"
     icon="mdi-calendar-multiple"
   >
     <template #title-actions>

frontend/src/components/collaborator/PromptCollaboratorDeactivate.vue

@@ -78,7 +78,10 @@ export default {
         if (!this.isOwnCampCollaboration) {
           return
         }
-        this.api.get().camps().$reload()
+        this.api
+          .get()
+          .camps({ campCollaborator: this.$store.getters.getLoggedInUser?._meta.self })
+          .$reload()
         this.$router.push({ name: 'camps' })
       })
 

frontend/src/views/Camps.vue

@@ -106,36 +106,28 @@ export default {
     }
   },
   computed: {
+    currentUserLink() {
+      return this.$store.getters.getLoggedInUser?._meta.self
+    },
     camps() {
-      return this.api.get().camps()
+      return this.api.get().camps({ campCollaborator: this.currentUserLink })
     },
     periods() {
-      return this.api.get().periods()
+      return this.api.get().periods({ campCollaborator: this.currentUserLink })
     },
     prototypeCamps() {
-      return this.camps.items.filter((c) => c.isPrototype)
+      return this.api.get().camps({ isPrototype: true }).items
     },
     upcomingCamps() {
       return Object.values(
         groupBy(
           this.periods.items.filter((p) => dayjs(p.end).endOf('day').isAfter(dayjs())),
           (p) => p.camp()._meta.self
         )
-      )
-        .map((periods) => ({
-          camp: periods[0].camp(),
-          periods: periods,
-        }))
-        .filter(({ camp }) => {
-          const currentUserLink = this.$store.getters.getLoggedInUser?._meta.self
-          const currentUserCampCollaboration = camp
-            .campCollaborations()
-            .items.filter((coll) => typeof coll.user === 'function')
-            .find((coll) => coll.user()._meta.self === currentUserLink)
-          return (
-            currentUserCampCollaboration && !currentUserCampCollaboration._meta.loading
-          )
-        })
+      ).map((periods) => ({
+        camp: periods[0].camp(),
+        periods: periods,
+      }))
     },
     pastCamps() {
       return Object.values(
@@ -162,6 +154,7 @@ export default {
   },
   methods: {
     async loadCamps() {
+      await this.$auth.loadUser()
       // Only reload camps if they were loaded before, to avoid console error
       if (this.camps._meta.self !== null) {
         this.api.reload(this.camps)