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

  1. #[OA\Parameter(name: 'eligibleForMortgage', description: 'Get listings that has mortgage Percentage', in: 'query', required: false)]
  2. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  3. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  4. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  5. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  6. #[OA\Parameter(name: 'keywordSearch', description: "Search by keyword in listing's title, description and address", in: 'query', required: false)]
  7. #[OA\Parameter(name: 'unitOnly', description: 'Get compound units only', in: 'query', required: false)]
  8. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  9. public function getSearchListings(Request $request, CacheInterface $cache): Response
  10. {
  11. $criteria = $this->builderDirector->build($request)->getResult();
  12. $locations = explode(',', $request->query->get('location', ''));
  13. $request->query->set('locations', $locations);
  15. if (!empty($criteria['keywordSearch'])) {
  16. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  17. }
  19. if ($this->getUser() instanceof User) {
  20. $this->messageBus->dispatch(new Search($request->query, $this->getUser()));
  21. }
  23. $criteria['status'] = ListingStatus::LIVE;
  24. $cacheKey = sprintf('api_v4_listings_search_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  26. $cachedSerialize = $cache->getItem($cacheKey);
  27. if (!$cachedSerialize->isHit() || empty($cachedSerialize->get())) {
  28. $result = $this->mediator->start($criteria)->getResults();
  29. $mapped = new ListingDataMapper();
  30. $mapped->setMapListingAttributes(true);
  31. $mapped->setMapListingMainPhoto(true);
  32. $mapped->setMapListingPhotos(true);
  34. $data = [
  35. 'default' => $this->makeMappedPaginatedBody($result['searchResults'], $mapped),
  36. 'related' => [],
  37. ];
  39. $data = $this->serializer->serialize(
  40. $data,
  41. 'json',
  42. SerializationContext::create()
  43. ->setGroups('SearchV4')
  44. ->enableMaxDepthChecks()
  45. );
  47. $cachedSerialize->set($data);
  48. $cachedSerialize->expiresAfter(3600 * 3);
  49. $cache->save($cachedSerialize);
  50. }
  52. return new Response($cachedSerialize->get());
  53. }
  55. /**
  56. * Related Listings Search V4.
  57. */
  58. #[Rest\Get('/api/v4/listings/search/related', name: 'aqarmap_api_get_related_results_v4', options: ['i18n' => false])]
  59. #[Rest\QueryParam(name: 'propertyType', requirements: '\d+', default: null, description: 'Property Type ID')]
  60. #[Rest\QueryParam(name: 'location', requirements: '\d+', default: null, description: 'Location ID comma spereted')]
  61. #[Rest\QueryParam(name: 'section', requirements: '\d+', default: null, description: 'Section ID')]
  62. #[Rest\QueryParam(name: 'page', requirements: '\d+', default: 1, description: 'Page number, starting from 1.', nullable: true)]
  63. #[Rest\QueryParam(name: 'limit', requirements: '\d+', default: 10, description: 'Number of items per page.', nullable: true)]
  64. #[Rest\QueryParam(name: 'sort', requirements: 'price|area', default: null, description: 'Sort search results by price or area.', nullable: true)]
  65. #[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)]
  66. #[Rest\View(serializerGroups: ['DefaultV4', 'SearchV4'])]
  67. #[OA\Parameter(name: 'propertyType', description: 'Property Type ID', in: 'query', required: false)]
  68. #[OA\Parameter(name: 'location', description: 'Location ID comma seperated', in: 'query', required: false)]
  69. #[OA\Parameter(name: 'section', description: 'Section ID', in: 'query', required: false)]
  70. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  71. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  72. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  73. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  74. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  75. public function getRelatedSearchListings(Request $request, HttpClientInterface $searchClient, SerializerInterface $jmsSerializer, ListingRepository $listingRepository): JsonResponse
  76. {
  77. $response = $searchClient->request('GET', '/api/listing/nearest', [
  78. 'query' => $request->query->all(),
  79. 'headers' => [
  80. 'Accept-Language' => $request->getPreferredLanguage(),
  81. ],
  82. ]);
  84. if (200 === $response->getStatusCode()) {
  85. $data = $response->toArray();
  87. if (isset($data['data']) && is_array($data['data'])) {
  88. foreach ($data['data'] as &$item) {
  89. if (isset($item['listings']) && is_array($item['listings'])) {
  90. $listings = $listingRepository->getListingsByIds(array_column($item['listings'], 'id'))->getQuery()->getResult();
  91. $context = SerializationContext::create()
  92. ->setGroups(['DefaultV4', 'SearchV4']);
  94. $item['listings'] = json_decode(
  95. $jmsSerializer->serialize($listings, 'json', $context),
  96. true
  97. );
  98. }
  99. }
  100. }
  102. return $this->json($data);
  103. }
  105. return $this->json([
  106. 'error' => 'Failed to fetch nearest search listings',
  107. ], $response->getStatusCode());
  108. }
  110. #[Rest\Get('/api/v4/listings', name: 'aqarmap_api_get_listings', options: ['i18n' => false])]
  111. #[Rest\Get('/api/v4/listings/search', name: 'aqarmap_api_listings_search_v4', options: ['i18n' => false])]
  112. #[Rest\QueryParam(name: 'personalizedSearch', requirements: '(1)|(0)', default: '0', description: 'Enable personalized search', strict: true, nullable: true)]
  113. #[OA\Parameter(name: 'personalizedSearch', description: 'Enable personalized search (requires active subscription)', in: 'query', required: false)]
  114. #[Rest\QueryParam(name: 'amenities', description: 'A list of amenities to filter by.', map: true, nullable: true)]
  115. #[OA\Parameter(name: 'amenities', description: 'Filter by a list of amenities. Can be provided as an array.', in: 'query', required: false, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string', enum: Amenities::ALL)))]
  116. public function getListings(Request $request, ListingRepository $listingRepository, ListingManager $listingManager, CacheInterface $cache, MessageBusInterface $messageBus)
  117. {
  118. // This to prevent the "result window is too large" exception in ElasticSearch.
  119. if ($request->get('page', 1) > 500) {
  120. throw new \LogicException('Page number must be less than or equal to 500');
  121. }
  123. /** @var UserInterface $user */
  124. $user = $this->getUser();
  125. $hasSearchScoringRole = $user && $user->hasRole('ROLE_SEARCH_SCORING');
  126. if (!$hasSearchScoringRole && ($request->get('esdebug') || $request->get('scoredebug'))) {
  127. $request->query->remove('esdebug');
  128. $request->query->remove('scoredebug');
  129. }
  131. if ($request->get('location')) {
  132. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  133. }
  135. $personalizedSearch = $request->query->getBoolean('personalizedSearch', false);
  136. if ($personalizedSearch) {
  137. if (!$user instanceof User) {
  138. throw new UnauthorizedHttpException('Personalized search requires an active session. Please log in.');
  139. }
  141. if (!$user->hasSubscriptionPlan()) {
  142. throw new AccessDeniedHttpException('Active subscription required for personalized search.');
  143. }
  145. $request->query->set('personalizedSearch', true);
  146. $request->query->set('personalizedForUser', $user->getId());
  147. }
  149. if ($personalizedSearch) {
  150. $data = $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  151. } else {
  152. $cacheKey = sprintf('api_listings_search_v4_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  153. $data = $cache->get(
  154. $cacheKey,
  155. function(ItemInterface $item) use ($request, $listingRepository, $listingManager) {
  156. $item->expiresAfter(3600 * 3);
  158. return $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  159. }
  160. );
  161. }
  163. return new Response($data);
  164. }
  166. private function getSerializedListingSearchResults(Request $request, ListingRepository $listingRepository, ListingManager $listingManager): string
  167. {
  168. $listingsElasticResponse = $listingManager->getListingsElasticResponse($request);
  169. $listingsQueryBuilder = $listingRepository->getListingsByIds(array_column($listingsElasticResponse['items'], 'id'));
  171. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  172. $listingsElasticResponse['pagination']['totalPages'] = (float) $listingsElasticResponse['pagination']['totalPages'];
  173. }
  175. $listings = $listingsQueryBuilder->getQuery()->getResult();
  177. $data = [
  178. 'default' => $this->mapPaginatedBody($listingsElasticResponse, $listings),
  179. 'related' => [],
  180. ];
  182. return $this->serializer->serialize(
  183. $data,
  184. 'json',
  185. SerializationContext::create()
  186. ->setGroups('SearchV4')
  187. ->enableMaxDepthChecks()
  188. );
  189. }
  191. #[Rest\Get('/api/v4/listings/debug', options: ['i18n' => false], name: 'aqarmap_api_get_listings_debug')]
  192. public function getListingsEsDebug(Request $request, ListingManager $listingManager)
  193. {
  194. /** @var UserInterface $user */
  195. $user = $this->getUser();
  197. if (!($user && $user->hasRole('ROLE_SEARCH_SCORING'))) {
  198. throw new UnauthorizedHttpException();
  199. }
  201. $request->query->set('esdebug', 1);
  203. if ($request->get('location')) {
  204. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  205. }
  207. $listingsDebugElasticResponse = $listingManager->getListingsDebugElasticResponse($request);
  209. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  210. $listingsDebugElasticResponse['pagination']['totalPages'] = (float) $listingsDebugElasticResponse['pagination']['totalPages'];
  211. }
  213. $data = [
  214. 'default' => $this->mapPaginatedBody($listingsDebugElasticResponse, $listingsDebugElasticResponse['items']),
  215. ];
  217. return new JsonResponse($data);
  218. }
  220. #[Rest\Get('/api/v4/listings/search/ssr-data', name: 'aqarmap_api_get_listings_search_ssr-data', options: ['i18n' => false])]
  221. #[OA\Get(
  222. summary: 'Get listing search SSR data',
  223. description: 'Provides the pre-rendered content required for the listing search SSR page such as location hierarchy, SEO metadata and UI chips.',
  224. tags: ['Listings', 'Search']
  225. )]
  226. #[OA\Parameter(name: 'location', in: 'query', required: false, description: 'Slug of the primary location to load contextual data for.', schema: new OA\Schema(type: 'string'))]
  227. #[OA\Parameter(
  228. name: 'locations[]',
  229. in: 'query',
  230. required: false,
  231. description: 'Optional list of location slugs used to resolve additional data.',
  232. schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string'))
  233. )]
  234. #[OA\Parameter(name: 'section', in: 'query', required: false, description: 'Section slug to scope the returned data.', schema: new OA\Schema(type: 'string'))]
  235. #[OA\Parameter(name: 'propertyType', in: 'query', required: false, description: 'Property type slug to scope the returned data.', schema: new OA\Schema(type: 'string'))]
  236. #[OA\Parameter(name: 'byOwnerOnly', in: 'query', required: false, description: 'Whether to limit content to owner only listings.', schema: new OA\Schema(type: 'boolean'))]
  237. #[OA\Response(
  238. response: 200,
  239. description: 'Successful response containing SSR data required by the listing search page.',
  240. content: new OA\JsonContent(
  241. type: 'object',
  242. properties: [
  243. new OA\Property(
  244. property: 'locationChildren',
  245. description: 'Hierarchy of child locations related to the requested location.',
  246. type: 'array',
  247. items: new OA\Items(type: 'object')
  248. ),
  249. new OA\Property(
  250. property: 'longTail',
  251. description: 'SEO long-tail content blocks generated for the section, property type and location.',
  252. type: 'array',
  253. items: new OA\Items(type: 'object')
  254. ),
  255. new OA\Property(
  256. property: 'customParagraph',
  257. description: 'Custom paragraph content tailored to the current search context.',
  258. type: 'array',
  259. items: new OA\Items(type: 'object')
  260. ),
  261. new OA\Property(
  262. property: 'slugResolver',
  263. description: 'Resolved slugs mapping for the provided filters.',
  264. type: 'array',
  265. items: new OA\Items(type: 'object')
  266. ),
  267. new OA\Property(
  268. property: 'faqData',
  269. description: 'Frequently asked questions related to the current search.',
  270. type: 'array',
  271. items: new OA\Items(type: 'object')
  272. ),
  273. new OA\Property(
  274. property: 'locationParents',
  275. description: 'Ordered list of parent locations for breadcrumb generation.',
  276. type: 'array',
  277. items: new OA\Items(type: 'object')
  278. ),
  279. new OA\Property(
  280. property: 'sections',
  281. description: 'Available sections that can be displayed in the SSR page.',
  282. type: 'array',
  283. items: new OA\Items(type: 'object')
  284. ),
  285. new OA\Property(
  286. property: 'propertyTypeChips',
  287. description: 'Property type chips rendered in the search interface.',
  288. type: 'array',
  289. items: new OA\Items(type: 'object')
  290. ),
  291. ]
  292. )
  293. )]
  294. #[OA\Response(response: 500, description: 'Returned when SSR data could not be generated or cached.')]
  295. public function getListingsSearchSSRData(Request $request, ListingManager $listingManager, CacheInterface $cache, SectionService $sectionService)
  296. {
  297. $cacheKey = sprintf('api_listings_search_ssr_data_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  298. $cachedResponse = $cache->getItem($cacheKey);
  300. if (!$cachedResponse->isHit() || empty($cachedResponse->get())) {
  301. $customParagraph = $locationChildren = $slugResolver = $faqData = $locationParents = [];
  303. if ($request->get('location')) {
  304. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  305. }
  307. $location = $request->query->all('locations') ? $request->query->all('locations')[0] : null;
  308. $location = $this->locationRepository->findOneBy(['slug' => $location]);
  309. $section = $this->sectionRepository->findOneBy(['slug' => $request->query->get('section')]);
  310. $propertyType = $this->propertyTypeRepository->findOneBy(['slug' => $request->query->get('propertyType')]);
  312. if ($location) {
  313. $locationChildren = $listingManager->getSerializedLocationChildren($location);
  314. $locationParents = $listingManager->getLocationParents($location, $request->getLocale());
  315. }
  317. if ($section && $propertyType && $location) {
  318. $longTail = $this->seoListingSearchService->getSerializedLongTailData($section, $propertyType, $location) ?? [];
  319. }
  321. if ($section && $propertyType) {
  322. $byOwnerOnly = filter_var($request->get('byOwnerOnly'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
  323. $customParagraph = $listingManager->getSerializedCustomParagraph($section, $propertyType, $location, $byOwnerOnly) ?? [];
  324. $slugResolver = $listingManager->getSerializedResolvedSlugs($section, $propertyType, $request->query->all('locations'));
  325. $faqData = $listingManager->getFaqs($section, $propertyType, $location, $request->getLocale());
  326. }
  328. $response = [
  329. 'locationChildren' => !empty($locationChildren) ? json_decode((string) $locationChildren, true) : [],
  330. 'longTail' => !empty($longTail) ? json_decode((string) $longTail, true) : [],
  331. 'customParagraph' => !empty($customParagraph) ? json_decode((string) $customParagraph, true) : [],
  332. 'slugResolver' => !empty($slugResolver) ? json_decode((string) $slugResolver, true) : [],
  333. 'faqData' => $faqData,
  334. 'locationParents' => $locationParents,
  335. 'sections' => json_decode((string) $sectionService->getSerializedSections(), true),
  336. 'propertyTypeChips' => $listingManager->getListingPropertyTypesChips($request, $location, $section, $propertyType),
  337. ];
  339. $cachedResponse->set(json_encode($response));
  340. $cachedResponse->expiresAfter(3600 * 3);
  341. $cache->save($cachedResponse);
  342. }
  344. return new JsonResponse(json_decode((string) $cachedResponse->get(), true));
  345. }
  347. #[Rest\Get('/api/v4/listings/trigger-search', options: ['i18n' => false], name: 'aqarmap_api_trigger_search_listings_v4')]
  348. public function triggerSearchListings(Request $request, MessageBusInterface $messageBus)
  349. {
  350. $user = $this->getUser();
  352. if ($request->get('location')) {
  353. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  354. }
  356. if ($request->get('keywordSearch')) {
  357. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  358. }
  360. if ($user) {
  361. $messageBus->dispatch(new Search($request->query, $user));
  362. }
  364. return new JsonResponse([
  365. 'statusCode' => Response::HTTP_OK,
  366. 'statusMessage' => 'Search triggered successfully!',
  367. ]);
  368. }
  370. private function mapPaginatedBody(array $result, array $listings): array
  371. {
  372. if (!$result['pagination']) {
  373. return [
  374. 'statusCode' => $this->getStatusCode(),
  375. 'statusMessage' => $this->getStatusMessage(),
  376. 'paginate' => [],
  377. 'data' => [],
  378. 'errors' => $this->getErrors(),
  379. ];
  380. }
  382. return [
  383. 'statusCode' => $this->getStatusCode(),
  384. 'statusMessage' => $this->getStatusMessage(),
  385. 'paginate' => $result['pagination'],
  386. 'data' => $listings,
  387. 'errors' => $this->getErrors(),
  388. ];
  389. }
  390. }