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

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