src/Aqarmap/Bundle/SearchBundle/Controller/Api/V4/ListingSearchController.php line 511

  1. #[OA\Parameter(name: 'limit', in: 'query', description: 'Number of items per page.', required: false)]
  2. #[OA\Parameter(name: 'sort', in: 'query', description: 'Sort search results by price or area.', required: false)]
  3. #[OA\Parameter(name: 'direction', in: 'query', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', required: false)]
  4. #[OA\Parameter(name: 'keywordSearch', in: 'query', description: "Search by keyword in listing's title, description and address", required: false)]
  5. #[OA\Parameter(name: 'unitOnly', in: 'query', description: 'Get compound units only', required: false)]
  6. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  7. public function getSearchListings(Request $request, CacheInterface $cache): Response
  8. {
  9. $criteria = $this->builderDirector->build($request)->getResult();
  10. $locations = explode(',', $request->query->get('location', ''));
  11. $request->query->set('locations', $locations);
  13. if (!empty($criteria['keywordSearch'])) {
  14. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  15. }
  17. if ($this->getUser()) {
  18. $this->messageBus->dispatch(new Search($request->query, $this->getUser()));
  19. }
  21. $criteria['status'] = ListingStatus::LIVE;
  22. $cacheKey = sprintf('api_v4_listings_search_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  24. $cachedSerialize = $cache->getItem($cacheKey);
  25. if (!$cachedSerialize->isHit() || empty($cachedSerialize->get())) {
  26. $result = $this->mediator->start($criteria)->getResults();
  27. $mapped = new ListingDataMapper();
  28. $mapped->setMapListingAttributes(true);
  29. $mapped->setMapListingMainPhoto(true);
  30. $mapped->setMapListingPhotos(true);
  32. $data = [
  33. 'default' => $this->makeMappedPaginatedBody($result['searchResults'], $mapped),
  34. 'related' => [],
  35. ];
  37. $data = $this->serializer->serialize(
  38. $data,
  39. 'json',
  40. SerializationContext::create()
  41. ->setGroups('SearchV4')
  42. ->enableMaxDepthChecks()
  43. );
  45. $cachedSerialize->set($data);
  46. $cachedSerialize->expiresAfter(3600 * 3);
  47. $cache->save($cachedSerialize);
  48. }
  50. return new Response($cachedSerialize->get());
  51. }
  53. /**
  54. * Related Listings Search V4.
  55. */
  56. #[Rest\Get('/api/v4/listings/search/related', name: 'aqarmap_api_get_related_results_v4', options: ['i18n' => false])]
  57. #[Rest\QueryParam(name: 'propertyType', requirements: '\d+', default: null, description: 'Property Type ID')]
  58. #[Rest\QueryParam(name: 'location', requirements: '\d+', default: null, description: 'Location ID comma spereted')]
  59. #[Rest\QueryParam(name: 'section', requirements: '\d+', default: null, description: 'Section ID')]
  60. #[Rest\QueryParam(name: 'page', requirements: '\d+', default: 1, description: 'Page number, starting from 1.', nullable: true)]
  61. #[Rest\QueryParam(name: 'limit', requirements: '\d+', default: 10, description: 'Number of items per page.', nullable: true)]
  62. #[Rest\QueryParam(name: 'sort', requirements: 'price|area', default: null, description: 'Sort search results by price or area.', nullable: true)]
  63. #[Rest\QueryParam(name: 'direction', requirements: 'asc|desc', default: 'asc', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', nullable: true)]
  64. #[Rest\View(serializerGroups: ['DefaultV4', 'SearchV4'])]
  65. #[OA\Parameter(name: 'propertyType', description: 'Property Type ID', in: 'query', required: false)]
  66. #[OA\Parameter(name: 'location', description: 'Location ID comma seperated', in: 'query', required: false)]
  67. #[OA\Parameter(name: 'section', description: 'Section ID', in: 'query', required: false)]
  68. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  69. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  70. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  71. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  72. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  73. public function getRelatedSearchListings(Request $request, HttpClientInterface $searchClient, SerializerInterface $jmsSerializer, ListingRepository $listingRepository): JsonResponse
  74. {
  75. $response = $searchClient->request('GET', '/api/listing/nearest', [
  76. 'query' => $request->query->all(),
  77. 'headers' => [
  78. 'Accept-Language' => $request->getPreferredLanguage(),
  79. ],
  80. ]);
  82. if (200 === $response->getStatusCode()) {
  83. $data = $response->toArray();
  85. if (isset($data['data']) && is_array($data['data'])) {
  86. foreach ($data['data'] as &$item) {
  87. if (isset($item['listings']) && is_array($item['listings'])) {
  88. $listings = $listingRepository->getListingsByIds(array_column($item['listings'], 'id'))->getQuery()->getResult();
  89. $context = SerializationContext::create()
  90. ->setGroups(['DefaultV4', 'SearchV4']);
  92. $item['listings'] = json_decode(
  93. $jmsSerializer->serialize($listings, 'json', $context),
  94. true
  95. );
  96. }
  97. }
  98. }
  100. return $this->json($data);
  101. }
  103. return $this->json([
  104. 'error' => 'Failed to fetch nearest search listings',
  105. ], $response->getStatusCode());
  106. }
  108. #[Rest\Get('/api/v4/listings', name: 'aqarmap_api_get_listings', options: ['i18n' => false])]
  109. #[Rest\Get('/api/v4/listings/search', name: 'aqarmap_api_listings_search_v4', options: ['i18n' => false])]
  110. #[Rest\QueryParam(name: 'personalizedSearch', requirements: '(1)|(0)', nullable: true, strict: true, description: 'Enable personalized search', default: '0')]
  111. #[OA\Parameter(name: 'personalizedSearch', in: 'query', description: 'Enable personalized search (requires active subscription)', required: false)]
  112. public function getListings(Request $request, ListingRepository $listingRepository, ListingManager $listingManager, CacheInterface $cache, MessageBusInterface $messageBus)
  113. {
  114. /** @var UserInterface $user */
  115. $user = $this->getUser();
  116. $hasSearchScoringRole = $user && $user->hasRole('ROLE_SEARCH_SCORING');
  117. if (!$hasSearchScoringRole && ($request->get('esdebug') || $request->get('scoredebug'))) {
  118. $request->query->remove('esdebug');
  119. $request->query->remove('scoredebug');
  120. }
  122. if ($request->get('location')) {
  123. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  124. }
  126. $personalizedSearch = $request->query->getBoolean('personalizedSearch', false);
  127. if ($personalizedSearch) {
  128. if (!$user instanceof User) {
  129. throw new UnauthorizedHttpException('Personalized search requires an active session. Please log in.');
  130. }
  132. if (!$user->hasSubscriptionPlan()) {
  133. throw new AccessDeniedHttpException('Active subscription required for personalized search.');
  134. }
  136. $request->query->set('personalizedSearch', true);
  137. $request->query->set('personalizedForUser', $user->getId());
  138. }
  140. if ($personalizedSearch) {
  141. $data = $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  142. } else {
  143. $cacheKey = sprintf('api_listings_search_v4_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  144. $data = $cache->get(
  145. $cacheKey,
  146. function(ItemInterface $item) use ($request, $listingRepository, $listingManager) {
  147. $item->expiresAfter(3600 * 3);
  149. return $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  150. }
  151. );
  152. }
  154. return new Response($data);
  155. }
  157. private function getSerializedListingSearchResults(Request $request, ListingRepository $listingRepository, ListingManager $listingManager): string
  158. {
  159. $listingsElasticResponse = $listingManager->getListingsElasticResponse($request);
  160. $listingsQueryBuilder = $listingRepository->getListingsByIds(array_column($listingsElasticResponse['items'], 'id'));
  162. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  163. $listingsElasticResponse['pagination']['totalPages'] = (float) $listingsElasticResponse['pagination']['totalPages'];
  164. }
  166. $listings = $listingsQueryBuilder->getQuery()->getResult();
  168. $data = [
  169. 'default' => $this->mapPaginatedBody($listingsElasticResponse, $listings),
  170. 'related' => [],
  171. ];
  173. return $this->serializer->serialize(
  174. $data,
  175. 'json',
  176. SerializationContext::create()
  177. ->setGroups('SearchV4')
  178. ->enableMaxDepthChecks()
  179. );
  180. }
  182. #[Rest\Get('/api/v4/listings/debug', options: ['i18n' => false], name: 'aqarmap_api_get_listings_debug')]
  183. public function getListingsEsDebug(Request $request, ListingManager $listingManager)
  184. {
  185. /** @var UserInterface $user */
  186. $user = $this->getUser();
  188. if (!($user && $user->hasRole('ROLE_SEARCH_SCORING'))) {
  189. throw new UnauthorizedHttpException();
  190. }
  192. $request->query->set('esdebug', 1);
  194. if ($request->get('location')) {
  195. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  196. }
  198. $listingsDebugElasticResponse = $listingManager->getListingsDebugElasticResponse($request);
  200. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  201. $listingsDebugElasticResponse['pagination']['totalPages'] = (float) $listingsDebugElasticResponse['pagination']['totalPages'];
  202. }
  204. $data = [
  205. 'default' => $this->mapPaginatedBody($listingsDebugElasticResponse, $listingsDebugElasticResponse['items']),
  206. ];
  208. return new JsonResponse($data);
  209. }
  211. #[Rest\Get('/api/v4/listings/search/ssr-data', name: 'aqarmap_api_get_listings_search_ssr-data', options: ['i18n' => false])]
  212. public function getListingsSearchSSRData(Request $request, ListingManager $listingManager, CacheInterface $cache, SectionService $sectionService)
  213. {
  214. $cacheKey = sprintf('api_listings_search_ssr_data_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  215. $cachedResponse = $cache->getItem($cacheKey);
  217. if (!$cachedResponse->isHit() || empty($cachedResponse->get())) {
  218. $customParagraph = $locationChildren = $slugResolver = $faqData = $locationParents = [];
  220. if ($request->get('location')) {
  221. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  222. }
  224. $location = $request->query->all('locations') ? $request->query->all('locations')[0] : null;
  225. $location = $this->locationRepository->findOneBy(['slug' => $location]);
  226. $section = $this->sectionRepository->findOneBy(['slug' => $request->query->get('section')]);
  227. $propertyType = $this->propertyTypeRepository->findOneBy(['slug' => $request->query->get('propertyType')]);
  229. if ($location) {
  230. $locationChildren = $listingManager->getSerializedLocationChildren($location);
  231. $locationParents = $listingManager->getLocationParents($location, $request->getLocale());
  232. }
  234. if ($section && $propertyType && $location) {
  235. $longTail = $this->seoListingSearchService->getSerializedLongTailData($section, $propertyType, $location) ?? [];
  236. }
  238. if ($section && $propertyType) {
  239. $byOwnerOnly = filter_var($request->get('byOwnerOnly'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
  240. $customParagraph = $listingManager->getSerializedCustomParagraph($section, $propertyType, $location, $byOwnerOnly) ?? [];
  241. $slugResolver = $listingManager->getSerializedResolvedSlugs($section, $propertyType, $request->query->all('locations'));
  242. $faqData = $listingManager->getFaqs($section, $propertyType, $location, $request->getLocale());
  243. }
  245. $response = [
  246. 'locationChildren' => !empty($locationChildren) ? json_decode((string) $locationChildren, true) : [],
  247. 'longTail' => !empty($longTail) ? json_decode((string) $longTail, true) : [],
  248. 'customParagraph' => !empty($customParagraph) ? json_decode((string) $customParagraph, true) : [],
  249. 'slugResolver' => !empty($slugResolver) ? json_decode((string) $slugResolver, true) : [],
  250. 'faqData' => $faqData,
  251. 'locationParents' => $locationParents,
  252. 'sections' => json_decode((string) $sectionService->getSerializedSections(), true),
  253. 'propertyTypeChips' => $listingManager->getListingPropertyTypesChips($request, $location, $section, $propertyType),
  254. ];
  256. $cachedResponse->set(json_encode($response));
  257. $cachedResponse->expiresAfter(3600 * 3);
  258. $cache->save($cachedResponse);
  259. }
  261. return new JsonResponse(json_decode((string) $cachedResponse->get(), true));
  262. }
  264. #[Rest\Get('/api/v4/listings/trigger-search', options: ['i18n' => false], name: 'aqarmap_api_trigger_search_listings_v4')]
  265. public function triggerSearchListings(Request $request, MessageBusInterface $messageBus)
  266. {
  267. $user = $this->getUser();
  269. if ($request->get('location')) {
  270. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  271. }
  273. if ($request->get('keywordSearch')) {
  274. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  275. }
  277. if ($user) {
  278. $messageBus->dispatch(new Search($request->query, $user));
  279. }
  281. return new JsonResponse([
  282. 'statusCode' => Response::HTTP_OK,
  283. 'statusMessage' => 'Search triggered successfully!',
  284. ]);
  285. }
  287. private function mapPaginatedBody(array $result, array $listings): array
  288. {
  289. if (!$result['pagination']) {
  290. return [
  291. 'statusCode' => $this->getStatusCode(),
  292. 'statusMessage' => $this->getStatusMessage(),
  293. 'paginate' => [],
  294. 'data' => [],
  295. 'errors' => $this->getErrors(),
  296. ];
  297. }
  299. return [
  300. 'statusCode' => $this->getStatusCode(),
  301. 'statusMessage' => $this->getStatusMessage(),
  302. 'paginate' => $result['pagination'],
  303. 'data' => $listings,
  304. 'errors' => $this->getErrors(),
  305. ];
  306. }
  307. }