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

  1. <?php
  3. namespace Aqarmap\Bundle\SearchBundle\Controller\Api\V4;
  5. use App\Constant\Amenities;
  6. use App\Exception\BadRequestHttpException;
  7. use App\Exception\UnauthorizedHttpException;
  8. use Aqarmap\Bundle\ListingBundle\Constant\ListingStatus;
  9. use Aqarmap\Bundle\ListingBundle\Event\SearchTriggerEvent;
  10. use Aqarmap\Bundle\ListingBundle\Message\Search;
  11. use Aqarmap\Bundle\ListingBundle\Repository\ListingRepository;
  12. use Aqarmap\Bundle\ListingBundle\Repository\LocationRepository;
  13. use Aqarmap\Bundle\ListingBundle\Repository\PropertyTypeRepository;
  14. use Aqarmap\Bundle\ListingBundle\Repository\SectionRepository;
  15. use Aqarmap\Bundle\ListingBundle\Service\ListingManager;
  16. use Aqarmap\Bundle\ListingBundle\Service\RelatedResultService;
  17. use Aqarmap\Bundle\ListingBundle\Service\SectionService;
  18. use Aqarmap\Bundle\MainBundle\Controller\Api\V4\BaseController;
  19. use Aqarmap\Bundle\MainBundle\Model\Listing\V4\ListingDataMapper;
  20. use Aqarmap\Bundle\MainBundle\Repository\CustomParagraphRepository;
  21. use Aqarmap\Bundle\SearchBundle\CriteriaBuilders\BuilderDirector;
  22. use Aqarmap\Bundle\SearchBundle\CriteriaMediator\Contracts\MediatorInterface;
  23. use Aqarmap\Bundle\SearchBundle\Services\ListingFaqService;
  24. use Aqarmap\Bundle\SearchBundle\Services\SEOListingSearchService;
  25. use Aqarmap\Bundle\UserBundle\Entity\User;
  26. use FOS\RestBundle\Controller\Annotations as Rest;
  27. use FOS\UserBundle\Model\UserInterface;
  28. use JMS\Serializer\SerializationContext;
  29. use JMS\Serializer\SerializerInterface;
  30. use OpenApi\Attributes as OA;
  31. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  32. use Symfony\Component\HttpFoundation\JsonResponse;
  33. use Symfony\Component\HttpFoundation\Request;
  34. use Symfony\Component\HttpFoundation\Response;
  35. use Symfony\Component\HttpKernel\Attribute\Cache;
  36. use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
  37. use Symfony\Component\Messenger\MessageBusInterface;
  38. use Symfony\Contracts\Cache\CacheInterface;
  39. use Symfony\Contracts\Cache\ItemInterface;
  40. use Symfony\Contracts\HttpClient\HttpClientInterface;
  42. class ListingSearchController extends BaseController
  43. {
  44. public function __construct(private readonly BuilderDirector $builderDirector, private readonly MediatorInterface $mediator, private readonly EventDispatcherInterface $eventDispatcher, private readonly SerializerInterface $serializer, RelatedResultService $relatedResultService, private readonly LocationRepository $locationRepository, CustomParagraphRepository $customParagraphRepository, private readonly SEOListingSearchService $seoListingSearchService, private readonly SectionRepository $sectionRepository, private readonly PropertyTypeRepository $propertyTypeRepository, ListingFaqService $listingFaqService, private readonly MessageBusInterface $messageBus)
  45. {
  46. }
  48. /**
  49. * Listings Search V4 ( Legacy code ).
  50. */
  51. #[Rest\Get('/api/v4/listings/search-legacy', name: 'legacy_aqarmap_api_listings_search_v4', options: ['i18n' => false])]
  52. #[Rest\QueryParam(name: 'propertyType', requirements: '\d+', default: null, description: 'Property Type ID')]
  53. #[Rest\QueryParam(name: 'location', requirements: '\d+', default: null, description: 'Location ID comma spereted')]
  54. #[Rest\QueryParam(name: 'section', requirements: '\d+', default: null, description: 'Section ID')]
  55. #[Rest\QueryParam(name: 'bounds', requirements: 'South-West Latitude ,
  56. Longitude , North-East Latitude , Longitude')] // default=null,
  57. #[Rest\QueryParam(name: 'minPrice', requirements: '\d+', default: null, description: 'Minimum Prices')]
  58. #[Rest\QueryParam(name: 'maxPrice', requirements: '\d+', default: null, description: 'Maximum Prices')]
  59. #[Rest\QueryParam(name: 'minArea', requirements: '\d+', default: null, description: 'Minimum Area')]
  60. #[Rest\QueryParam(name: 'maxArea', requirements: '\d+', default: null, description: 'Maximum Area')]
  61. #[Rest\QueryParam(name: 'minFloor', requirements: '\d+', default: null, description: 'Minimum Floor')]
  62. #[Rest\QueryParam(name: 'minRoom', requirements: '\d+', default: null, description: 'Minimum Room')]
  63. #[Rest\QueryParam(name: 'floor', requirements: '\d+', default: null, description: 'Floor Number')]
  64. #[Rest\QueryParam(name: 'room', requirements: '\d+', default: null, description: 'Number of Rooms')]
  65. #[Rest\QueryParam(name: 'baths', requirements: '\d+', default: null, description: 'Number of Baths')]
  66. #[Rest\QueryParam(name: 'finishType', default: null, description: 'finish Type')]
  67. #[Rest\QueryParam(name: 'sellerRole', requirements: '\d+', default: null, description: 'sellerRole')]
  68. #[Rest\QueryParam(name: 'paymentMethod', requirements: '\d+', default: null, description: 'paymentMethod')]
  69. #[Rest\QueryParam(name: 'deliveryYear', requirements: '\d+', default: null, description: 'deliveryYear')]
  70. #[Rest\QueryParam(name: 'bath', default: null, description: 'Number of Baths')]
  71. #[Rest\QueryParam(name: 'photos', requirements: '(1)|(0)', default: '0', description: 'Get only listings with photos', strict: true, nullable: true)]
  72. #[Rest\QueryParam(name: 'isMortgage', requirements: '(1)|(0)', default: '0', description: 'Get only listings that support mortgage', strict: true, nullable: true)]
  73. #[Rest\QueryParam(name: 'eligibleForMortgage', description: 'Get listings that has mortgage Percentage', strict: true, nullable: true)]
  74. #[Rest\QueryParam(name: 'page', requirements: '\d+', default: 1, description: 'Page number, starting from 1.', nullable: true)]
  75. #[Rest\QueryParam(name: 'limit', requirements: '\d+', default: 10, description: 'Number of items per page.', nullable: true)]
  76. #[Rest\QueryParam(name: 'sort', requirements: 'price|area', default: null, description: 'Sort search results by price or area.', nullable: true)]
  77. #[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)]
  78. #[Rest\QueryParam(name: 'keywordSearch', description: "Search by keyword in listing's title, description and address")]
  79. #[Rest\QueryParam(name: 'unitOnly', requirements: '(1)|(0)', description: 'Get compound units only', nullable: true)]
  80. #[Rest\View]
  81. #[Cache(expires: '+2 hours', maxage: '+2 hours', smaxage: '+2 hours', public: true, vary: ['Accept-Language', 'X-Accept-Version', 'Accept'])]
  82. #[OA\Parameter(name: 'propertyType', description: 'Property Type ID', in: 'query', required: false)]
  83. #[OA\Parameter(name: 'location', description: 'Location ID comma spereted', in: 'query', required: false)]
  84. #[OA\Parameter(name: 'section', description: 'Section ID', in: 'query', required: false)]
  85. #[OA\Parameter(name: 'bounds', description: 'Map bounds (example: 24.6275450,46.6363017,24.6977461,46.817232)', in: 'query', required: false)]
  86. #[OA\Parameter(name: 'minPrice', description: 'Minimum Prices', in: 'query', required: false)]
  87. #[OA\Parameter(name: 'maxPrice', description: 'Maximum Prices', in: 'query', required: false)]
  88. #[OA\Parameter(name: 'minArea', description: 'Minimum Area', in: 'query', required: false)]
  89. #[OA\Parameter(name: 'maxArea', description: 'Maximum Area', in: 'query', required: false)]
  90. #[OA\Parameter(name: 'minFloor', description: 'Minimum Floor', in: 'query', required: false)]
  91. #[OA\Parameter(name: 'minRoom', description: 'Minimum Room', in: 'query', required: false)]
  92. #[OA\Parameter(name: 'floor', description: 'Floor Number', in: 'query', required: false)]
  93. #[OA\Parameter(name: 'room', description: 'Number of Rooms', in: 'query', required: false)]
  94. #[OA\Parameter(name: 'baths', description: 'Number of Baths', in: 'query', required: false)]
  95. #[OA\Parameter(name: 'finishType', description: 'finish Type', in: 'query', required: false)]
  96. #[OA\Parameter(name: 'sellerRole', description: 'sellerRole', in: 'query', required: false)]
  97. #[OA\Parameter(name: 'paymentMethod', description: 'paymentMethod', in: 'query', required: false)]
  98. #[OA\Parameter(name: 'deliveryYear', description: 'deliveryYear', in: 'query', required: false)]
  99. #[OA\Parameter(name: 'bath', description: 'Number of Baths', in: 'query', required: false)]
  100. #[OA\Parameter(name: 'photos', description: 'Get only listings with photos', in: 'query', required: false)]
  101. #[OA\Parameter(name: 'isMortgage', description: 'Get only listings that support mortgage', in: 'query', required: false)]
  102. #[OA\Parameter(name: 'eligibleForMortgage', description: 'Get listings that has mortgage Percentage', in: 'query', required: false)]
  103. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  104. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  105. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  106. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  107. #[OA\Parameter(name: 'keywordSearch', description: "Search by keyword in listing's title, description and address", in: 'query', required: false)]
  108. #[OA\Parameter(name: 'unitOnly', description: 'Get compound units only', in: 'query', required: false)]
  109. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  110. public function getSearchListings(Request $request, CacheInterface $cache): Response
  111. {
  112. $criteria = $this->builderDirector->build($request)->getResult();
  113. $locations = explode(',', $request->query->get('location', ''));
  114. $request->query->set('locations', $locations);
  116. if (!empty($criteria['keywordSearch'])) {
  117. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  118. }
  120. if ($this->getUser() instanceof User) {
  121. $this->messageBus->dispatch(new Search($request->query, $this->getUser()));
  122. }
  124. $criteria['status'] = ListingStatus::LIVE;
  125. $cacheKey = sprintf('api_v4_listings_search_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  127. $cachedSerialize = $cache->getItem($cacheKey);
  128. if (!$cachedSerialize->isHit() || empty($cachedSerialize->get())) {
  129. $result = $this->mediator->start($criteria)->getResults();
  130. $mapped = new ListingDataMapper();
  131. $mapped->setMapListingAttributes(true);
  132. $mapped->setMapListingMainPhoto(true);
  133. $mapped->setMapListingPhotos(true);
  135. $data = [
  136. 'default' => $this->makeMappedPaginatedBody($result['searchResults'], $mapped),
  137. 'related' => [],
  138. ];
  140. $data = $this->serializer->serialize(
  141. $data,
  142. 'json',
  143. SerializationContext::create()
  144. ->setGroups('SearchV4')
  145. ->enableMaxDepthChecks()
  146. );
  148. $cachedSerialize->set($data);
  149. $cachedSerialize->expiresAfter(3600 * 3);
  150. $cache->save($cachedSerialize);
  151. }
  153. return new Response($cachedSerialize->get());
  154. }
  156. /**
  157. * Related Listings Search V4.
  158. */
  159. #[Rest\Get('/api/v4/listings/search/related', name: 'aqarmap_api_get_related_results_v4', options: ['i18n' => false])]
  160. #[Rest\QueryParam(name: 'propertyType', requirements: '\d+', default: null, description: 'Property Type ID')]
  161. #[Rest\QueryParam(name: 'location', requirements: '\d+', default: null, description: 'Location ID comma spereted')]
  162. #[Rest\QueryParam(name: 'section', requirements: '\d+', default: null, description: 'Section ID')]
  163. #[Rest\QueryParam(name: 'page', requirements: '\d+', default: 1, description: 'Page number, starting from 1.', nullable: true)]
  164. #[Rest\QueryParam(name: 'limit', requirements: '\d+', default: 10, description: 'Number of items per page.', nullable: true)]
  165. #[Rest\QueryParam(name: 'sort', requirements: 'price|area', default: null, description: 'Sort search results by price or area.', nullable: true)]
  166. #[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)]
  167. #[Rest\View(serializerGroups: ['DefaultV4', 'SearchV4'])]
  168. #[OA\Parameter(name: 'propertyType', description: 'Property Type ID', in: 'query', required: false)]
  169. #[OA\Parameter(name: 'location', description: 'Location ID comma seperated', in: 'query', required: false)]
  170. #[OA\Parameter(name: 'section', description: 'Section ID', in: 'query', required: false)]
  171. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  172. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  173. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  174. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  175. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  176. public function getRelatedSearchListings(Request $request, HttpClientInterface $searchClient, SerializerInterface $jmsSerializer, ListingRepository $listingRepository): JsonResponse
  177. {
  178. $response = $searchClient->request('GET', '/api/listing/nearest', [
  179. 'query' => $request->query->all(),
  180. 'headers' => [
  181. 'Accept-Language' => $request->getPreferredLanguage(),
  182. ],
  183. ]);
  185. if (200 === $response->getStatusCode()) {
  186. $data = $response->toArray();
  188. if (isset($data['data']) && is_array($data['data'])) {
  189. foreach ($data['data'] as &$item) {
  190. if (isset($item['listings']) && is_array($item['listings'])) {
  191. $listings = $listingRepository->getListingsByIds(array_column($item['listings'], 'id'))->getQuery()->getResult();
  192. $context = SerializationContext::create()
  193. ->setGroups(['DefaultV4', 'SearchV4']);
  195. $item['listings'] = json_decode(
  196. $jmsSerializer->serialize($listings, 'json', $context),
  197. true
  198. );
  199. }
  200. }
  201. }
  203. return $this->json($data);
  204. }
  206. return $this->json([
  207. 'error' => 'Failed to fetch nearest search listings',
  208. ], $response->getStatusCode());
  209. }
  211. #[Rest\Get('/api/v4/listings', name: 'aqarmap_api_get_listings', options: ['i18n' => false])]
  212. #[Rest\Get('/api/v4/listings/search', name: 'aqarmap_api_listings_search_v4', options: ['i18n' => false])]
  213. #[OA\Get(summary: 'Search listings', description: 'Returns listing search results for the provided filters and pagination settings.', tags: ['ListingsSearch'])]
  214. #[OA\Parameter(name: 'minPrice', description: 'Minimum listing price.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  215. #[OA\Parameter(name: 'maxPrice', description: 'Maximum listing price.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  216. #[OA\Parameter(name: 'minArea', description: 'Minimum listing area.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  217. #[OA\Parameter(name: 'maxArea', description: 'Maximum listing area.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  218. #[OA\Parameter(name: 'room', description: 'Exact number of rooms.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  219. #[OA\Parameter(name: 'minRoom', description: 'Minimum number of rooms.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  220. #[OA\Parameter(name: 'bounds', description: 'Map bounds in south-west/north-east latitude-longitude format.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  221. #[OA\Parameter(name: 'marketPropertyType', description: 'Market-specific property type filter.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  222. #[OA\Parameter(name: 'excludedCategory', description: 'Category identifier to exclude from results.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  223. #[OA\Parameter(name: 'trackTotalHits', description: 'Whether to request exact total hit tracking from the search backend.', in: 'query', required: false, schema: new OA\Schema(type: 'boolean'))]
  224. #[OA\Parameter(name: 'scoredebug', description: 'Include search scoring debug details when permitted.', in: 'query', required: false, schema: new OA\Schema(type: 'boolean'))]
  225. #[OA\Parameter(name: 'esdebug', description: 'Include Elasticsearch debug details when permitted.', in: 'query', required: false, schema: new OA\Schema(type: 'boolean'))]
  226. #[OA\Parameter(name: 'limit', description: 'Maximum number of listings returned per page.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  227. #[OA\Parameter(name: 'sort', description: 'Sorting field for the result set.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  228. #[OA\Parameter(name: 'aggregatedField', description: 'Aggregation field requested from the search backend.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  229. #[OA\Parameter(name: 'creditExpiryDate', description: 'Credit expiry date filter.', in: 'query', required: false, schema: new OA\Schema(type: 'string', format: 'date'))]
  230. #[Rest\QueryParam(name: 'personalizedSearch', requirements: '(1)|(0)', default: '0', description: 'Enable personalized search', strict: true, nullable: true)]
  231. #[OA\Parameter(name: 'personalizedSearch', description: 'Enable personalized search (requires an authenticated user with an active subscription).', in: 'query', required: false, schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
  232. #[OA\Parameter(name: 'personalizedForUser', description: 'Internal user identifier used to scope personalized results.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  233. #[OA\Parameter(name: 'status', description: 'Listing status filter.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  234. #[OA\Parameter(name: 'location', description: 'Comma-separated location identifiers.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  235. #[OA\Parameter(name: 'propertyType', description: 'Property type identifier.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  236. #[OA\Parameter(name: 'section', description: 'Section identifier.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  237. #[OA\Parameter(name: 'excludedListingsIds', description: 'Comma-separated listing identifiers to exclude from results.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  238. #[Rest\QueryParam(name: 'amenities', description: 'A list of amenities to filter by.', map: true, nullable: true)]
  239. #[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)))]
  240. #[Rest\QueryParam(name: 'downPayment', requirements: '\d+', default: null, description: 'Filter by maximum down payment amount', nullable: true)]
  241. #[OA\Parameter(name: 'downPayment', description: 'Filter by maximum down payment amount', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  242. #[Rest\QueryParam(name: 'duration', requirements: '\d+', default: null, description: 'Filter by minimum installment duration (in days)', nullable: true)]
  243. #[OA\Parameter(name: 'duration', description: 'Filter by minimum installment duration (in days)', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  244. #[OA\Response(response: 200, description: 'Paginated listing search results.')]
  245. #[OA\Response(response: 400, description: 'Invalid search request, such as a page number above the supported limit.')]
  246. #[OA\Response(response: 401, description: 'Returned when personalized search is requested without an authenticated user.')]
  247. #[OA\Response(response: 403, description: 'Returned when personalized search is requested without an active subscription.')]
  248. public function getListings(Request $request, ListingRepository $listingRepository, ListingManager $listingManager, CacheInterface $cache, MessageBusInterface $messageBus)
  249. {
  250. // This to prevent the "result window is too large" exception in ElasticSearch.
  251. if ($request->get('page', 1) > 500) {
  252. throw new BadRequestHttpException('Page number must be less than or equal to 500');
  253. }
  255. /** @var UserInterface $user */
  256. $user = $this->getUser();
  257. $hasSearchScoringRole = $user && $user->hasRole('ROLE_SEARCH_SCORING');
  258. if (!$hasSearchScoringRole && ($request->get('esdebug') || $request->get('scoredebug'))) {
  259. $request->query->remove('esdebug');
  260. $request->query->remove('scoredebug');
  261. }
  263. if ($request->get('location')) {
  264. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  265. }
  267. $personalizedSearch = $request->query->getBoolean('personalizedSearch', false);
  268. if ($personalizedSearch) {
  269. if (!$user instanceof User) {
  270. throw new UnauthorizedHttpException('Personalized search requires an active session. Please log in.');
  271. }
  273. if (!$user->hasSubscriptionPlan()) {
  274. throw new AccessDeniedHttpException('Active subscription required for personalized search.');
  275. }
  277. $request->query->set('personalizedSearch', true);
  278. $request->query->set('personalizedForUser', $user->getId());
  279. }
  281. if ($personalizedSearch) {
  282. $data = $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  283. } else {
  284. $cacheKey = sprintf('api_listings_search_v4_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  285. $data = $cache->get(
  286. $cacheKey,
  287. function(ItemInterface $item) use ($request, $listingRepository, $listingManager) {
  288. $item->expiresAfter(3600 * 3);
  290. return $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  291. }
  292. );
  293. }
  295. return new Response($data);
  296. }
  298. private function getSerializedListingSearchResults(Request $request, ListingRepository $listingRepository, ListingManager $listingManager): string
  299. {
  300. $listingsElasticResponse = $listingManager->getListingsElasticResponse($request);
  301. $listingsQueryBuilder = $listingRepository->getListingsByIds(array_column($listingsElasticResponse['items'], 'id'));
  303. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  304. $listingsElasticResponse['pagination']['totalPages'] = (float) $listingsElasticResponse['pagination']['totalPages'];
  305. }
  307. $listings = $listingsQueryBuilder->getQuery()->getResult();
  309. $data = [
  310. 'default' => $this->mapPaginatedBody($listingsElasticResponse, $listings),
  311. 'related' => [],
  312. ];
  314. return $this->serializer->serialize(
  315. $data,
  316. 'json',
  317. SerializationContext::create()
  318. ->setGroups('SearchV4')
  319. ->enableMaxDepthChecks()
  320. );
  321. }
  323. #[Rest\Get('/api/v4/listings/debug', options: ['i18n' => false], name: 'aqarmap_api_get_listings_debug')]
  324. public function getListingsEsDebug(Request $request, ListingManager $listingManager)
  325. {
  326. /** @var UserInterface $user */
  327. $user = $this->getUser();
  329. if (!($user && $user->hasRole('ROLE_SEARCH_SCORING'))) {
  330. throw new UnauthorizedHttpException();
  331. }
  333. $request->query->set('esdebug', 1);
  335. if ($request->get('location')) {
  336. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  337. }
  339. $listingsDebugElasticResponse = $listingManager->getListingsDebugElasticResponse($request);
  341. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  342. $listingsDebugElasticResponse['pagination']['totalPages'] = (float) $listingsDebugElasticResponse['pagination']['totalPages'];
  343. }
  345. $data = [
  346. 'default' => $this->mapPaginatedBody($listingsDebugElasticResponse, $listingsDebugElasticResponse['items']),
  347. ];
  349. return new JsonResponse($data);
  350. }
  352. #[Rest\Get('/api/v4/listings/search/ssr-data', name: 'aqarmap_api_get_listings_search_ssr-data', options: ['i18n' => false])]
  353. #[OA\Get(
  354. summary: 'Get listing search SSR data',
  355. description: 'Provides the pre-rendered content required for the listing search SSR page such as location hierarchy, SEO metadata and UI chips.',
  356. tags: ['ListingsSearch']
  357. )]
  358. #[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'))]
  359. #[OA\Parameter(
  360. name: 'locations[]',
  361. in: 'query',
  362. required: false,
  363. description: 'Optional list of location slugs used to resolve additional data.',
  364. schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string'))
  365. )]
  366. #[OA\Parameter(name: 'section', in: 'query', required: false, description: 'Section slug to scope the returned data.', schema: new OA\Schema(type: 'string'))]
  367. #[OA\Parameter(name: 'propertyType', in: 'query', required: false, description: 'Property type slug to scope the returned data.', schema: new OA\Schema(type: 'string'))]
  368. #[OA\Parameter(name: 'byOwnerOnly', in: 'query', required: false, description: 'Whether to limit content to owner only listings.', schema: new OA\Schema(type: 'boolean'))]
  369. #[OA\Response(
  370. response: 200,
  371. description: 'Successful response containing SSR data required by the listing search page.',
  372. content: new OA\JsonContent(
  373. type: 'object',
  374. properties: [
  375. new OA\Property(
  376. property: 'locationChildren',
  377. description: 'Hierarchy of child locations related to the requested location.',
  378. type: 'array',
  379. items: new OA\Items(type: 'object')
  380. ),
  381. new OA\Property(
  382. property: 'longTail',
  383. description: 'SEO long-tail content blocks generated for the section, property type and location.',
  384. type: 'array',
  385. items: new OA\Items(type: 'object')
  386. ),
  387. new OA\Property(
  388. property: 'customParagraph',
  389. description: 'Custom paragraph content tailored to the current search context.',
  390. type: 'array',
  391. items: new OA\Items(type: 'object')
  392. ),
  393. new OA\Property(
  394. property: 'slugResolver',
  395. description: 'Resolved slugs mapping for the provided filters.',
  396. type: 'array',
  397. items: new OA\Items(type: 'object')
  398. ),
  399. new OA\Property(
  400. property: 'faqData',
  401. description: 'Frequently asked questions related to the current search.',
  402. type: 'array',
  403. items: new OA\Items(type: 'object')
  404. ),
  405. new OA\Property(
  406. property: 'locationParents',
  407. description: 'Ordered list of parent locations for breadcrumb generation.',
  408. type: 'array',
  409. items: new OA\Items(type: 'object')
  410. ),
  411. new OA\Property(
  412. property: 'sections',
  413. description: 'Available sections that can be displayed in the SSR page.',
  414. type: 'array',
  415. items: new OA\Items(type: 'object')
  416. ),
  417. new OA\Property(
  418. property: 'propertyTypeChips',
  419. description: 'Property type chips rendered in the search interface.',
  420. type: 'array',
  421. items: new OA\Items(type: 'object')
  422. ),
  423. ]
  424. )
  425. )]
  426. #[OA\Response(response: 500, description: 'Returned when SSR data could not be generated or cached.')]
  427. public function getListingsSearchSSRData(Request $request, ListingManager $listingManager, CacheInterface $cache, SectionService $sectionService)
  428. {
  429. $cacheKey = sprintf('api_listings_search_ssr_data_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  430. $cachedResponse = $cache->getItem($cacheKey);
  432. if (!$cachedResponse->isHit() || empty($cachedResponse->get())) {
  433. $customParagraph = $locationChildren = $slugResolver = $faqData = $locationParents = $longTail = [];
  435. if ($request->get('location')) {
  436. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  437. }
  439. $location = $request->query->all('locations') ? $request->query->all('locations')[0] : null;
  440. $location = $this->locationRepository->findOneBy(['slug' => $location]);
  441. $section = $this->sectionRepository->findOneBy(['slug' => $request->query->get('section')]);
  442. $propertyType = $this->propertyTypeRepository->findOneBy(['slug' => $request->query->get('propertyType')]);
  444. if ($location) {
  445. $locationChildren = $listingManager->getSerializedLocationChildren($location);
  446. $locationParents = $listingManager->getLocationParents($location, $request->getLocale());
  447. }
  449. if ($section && $propertyType && $location) {
  450. $longTail = $this->seoListingSearchService->getSerializedLongTailData($section, $propertyType, $location) ?? [];
  451. }
  453. if ($section) {
  454. $slugResolver = $listingManager->getSerializedResolvedSlugs($section, $propertyType, $request->query->all('locations'));
  455. }
  457. if ($section && $propertyType) {
  458. $byOwnerOnly = filter_var($request->get('byOwnerOnly'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
  459. $customParagraph = $listingManager->getSerializedCustomParagraph($section, $propertyType, $location, $byOwnerOnly) ?? [];
  460. $faqData = $listingManager->getFaqs($section, $propertyType, $location, $request->getLocale());
  461. }
  463. $response = [
  464. 'locationChildren' => !empty($locationChildren) ? json_decode((string) $locationChildren, true) : [],
  465. 'longTail' => !empty($longTail) ? json_decode((string) $longTail, true) : [],
  466. 'customParagraph' => !empty($customParagraph) ? json_decode((string) $customParagraph, true) : [],
  467. 'slugResolver' => !empty($slugResolver) ? json_decode((string) $slugResolver, true) : [],
  468. 'faqData' => $faqData,
  469. 'locationParents' => $locationParents,
  470. 'sections' => json_decode((string) $sectionService->getSerializedSections(), true),
  471. 'propertyTypeChips' => $listingManager->getListingPropertyTypesChips($request, $location, $section, $propertyType),
  472. ];
  474. $cachedResponse->set(json_encode($response));
  475. $cachedResponse->expiresAfter(3600 * 3);
  476. $cache->save($cachedResponse);
  477. }
  479. return new JsonResponse(json_decode((string) $cachedResponse->get(), true));
  480. }
  482. #[Rest\Get('/api/v4/listings/trigger-search', options: ['i18n' => false], name: 'aqarmap_api_trigger_search_listings_v4')]
  483. #[OA\Get(summary: 'Trigger listings search tracking', description: 'Dispatches search tracking and background processing events for the current listing search request.', tags: ['ListingsSearch'])]
  484. #[OA\Parameter(name: 'location', in: 'query', required: false, description: 'Comma-separated location identifiers to normalize into the locations filter.', schema: new OA\Schema(type: 'string'))]
  485. #[OA\Parameter(name: 'keywordSearch', in: 'query', required: false, description: 'Keyword query that triggers the search event tracking flow.', schema: new OA\Schema(type: 'string'))]
  486. #[OA\Response(response: 200, description: 'Search trigger event dispatched successfully.')]
  487. public function triggerSearchListings(Request $request, MessageBusInterface $messageBus)
  488. {
  489. $user = $this->getUser();
  491. if ($request->get('location')) {
  492. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  493. }
  495. if ($request->get('keywordSearch')) {
  496. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  497. }
  499. if ($user) {
  500. $messageBus->dispatch(new Search($request->query, $user));
  501. }
  503. return new JsonResponse([
  504. 'statusCode' => Response::HTTP_OK,
  505. 'statusMessage' => 'Search triggered successfully!',
  506. ]);
  507. }
  509. private function mapPaginatedBody(array $result, array $listings): array
  510. {
  511. if (!$result['pagination']) {
  512. return [
  513. 'statusCode' => $this->getStatusCode(),
  514. 'statusMessage' => $this->getStatusMessage(),
  515. 'paginate' => [],
  516. 'data' => [],
  517. 'errors' => $this->getErrors(),
  518. ];
  519. }
  521. return [
  522. 'statusCode' => $this->getStatusCode(),
  523. 'statusMessage' => $this->getStatusMessage(),
  524. 'paginate' => $result['pagination'],
  525. 'data' => $listings,
  526. 'errors' => $this->getErrors(),
  527. ];
  528. }
  529. }