# mlsimport/7.0.4/includes/live/live-source.php

MLSImport: IDX Plugin & MLS Plugin for Real Estate Listings, version 7.0.4. 268 lines.

- Page: https://pluginprobe.com/plugins/mlsimport/7.0.4/code/includes/live/live-source.php
- Raw: https://pluginprobe.com/plugins/mlsimport/7.0.4/raw/includes/live/live-source.php
- Modified: 2026-07-25T14:20:50+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/mlsimport/7.0.4/code/includes/live/live-source.php#L10-L20`.

```php
<?php
/**
 * Live mode: the read functions everything else calls.
 *
 * Only mlsimport_live_search() and mlsimport_live_get() talk HTTP to the
 * MLS; both go through the cache. Query building and response parsing stay
 * in the pure modules.
 *
 * @package Mlsimport
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Search listings directly on the MLS.
 *
 * @param array $params Standalone filter params (city, status, limit, page, …).
 * @return array{records:array,total:int}|null Null when the MLS is unreachable
 *         and no warm cache exists.
 */
function mlsimport_live_search( array $params ) {
	$config = mlsimport_live_config();
	if ( array() === $config ) {
		return null;
	}

	// Quantized bbox (~110m outward grid) BEFORE the query is built: nearby
	// map pans produce the identical query and reuse one cache entry.
	$params = mlsimport_live_quantize_bbox( $params );

	$query = mlsimport_live_build_query( $params, $config );
	$key   = mlsimport_live_cache_key(
		'search',
		array(
			'q' => $query,
			'u' => $config['api_import_url'],
			'm' => (string) ( $config['api_media_url'] ?? '' ),
		)
	);

	return mlsimport_live_remember(
		$key,
		static function () use ( $query ) {
			return mlsimport_live_request( $query );
		}
	);
}

/**
 * Fetch one listing by ListingKey.
 *
 * @param string $listing_key RESO ListingKey (string — never cast to int).
 * @return array|null The raw RESO record, or null when not found/unreachable.
 */
function mlsimport_live_get( string $listing_key ) {
	$listing_key = trim( $listing_key );
	if ( '' === $listing_key ) {
		return null;
	}

	$config = mlsimport_live_config();
	if ( array() === $config ) {
		return null;
	}

	if ( 'bridge' === ( $config['type'] ?? '' ) ) {
		$query = '?ListingKey=' . rawurlencode( $listing_key );
	} else {
		$query = '?';
		if ( ! empty( $config['expand'] ) ) {
			$query .= '&$expand=' . $config['expand'];
		}
		$query .= '&$top=1&$filter=' . mlsimport_live_filter_list_segment(
			mlsimport_live_field_alias( 'ListingKey', $config ),
			array( $listing_key )
		);
		$query  = preg_replace( '/ and $/', '', $query );
	}

	// 'q' keys the config shape too (dialect, $expand): a provider-type or
	// expand change refetches instead of serving the stale-shaped record.
	$key    = mlsimport_live_cache_key(
		'get',
		array(
			'k' => $listing_key,
			'q' => $query,
			'u' => $config['api_import_url'],
			'm' => (string) ( $config['api_media_url'] ?? '' ),
		)
	);
	$result = mlsimport_live_remember(
		$key,
		static function () use ( $query ) {
			return mlsimport_live_request( $query );
		}
	);

	return is_array( $result ) && ! empty( $result['records'][0] ) ? $result['records'][0] : null;
}

/**
 * Fetch an explicit set of listings by ListingKey, in the given order.
 *
 * One search request (ListingKey list, no status baseline), reordered to the
 * input order — keys the MLS no longer knows are simply absent.
 *
 * @param string[] $keys ListingKeys (strings — never cast to int).
 * @return array[]|null Raw RESO records in input order, or null when the MLS
 *         is unreachable and no warm cache exists.
 */
function mlsimport_live_keys( array $keys ) {
	$keys = array_values( array_filter( array_map( 'trim', array_map( 'strval', $keys ) ), 'strlen' ) );
	if ( array() === $keys ) {
		return array();
	}

	$result = mlsimport_live_search(
		array(
			'keys'  => $keys,
			'limit' => count( $keys ),
		)
	);
	if ( ! is_array( $result ) ) {
		return null;
	}

	$by_key = array();
	foreach ( $result['records'] as $record ) {
		if ( is_array( $record ) && isset( $record['ListingKey'] ) ) {
			$by_key[ (string) $record['ListingKey'] ] = $record;
		}
	}

	$ordered = array();
	foreach ( $keys as $key ) {
		if ( isset( $by_key[ $key ] ) ) {
			$ordered[] = $by_key[ $key ];
		}
	}
	return $ordered;
}

/**
 * The endpoint live requests hit. For Bridge, the configured OData URL is
 * rewritten to the native listings API (…/OData/{ds}/Property →
 * …/{ds}/listings): the native surface returns Media inline where OData
 * hides it for client tokens (verified vs Stellar 2026-07-03).
 *
 * @param array $config Per-MLS config.
 * @return string
 */
function mlsimport_live_endpoint( array $config ): string {
	$base = isset( $config['api_import_url'] ) ? (string) $config['api_import_url'] : '';
	if ( 'bridge' === ( $config['type'] ?? '' ) ) {
		$native = preg_replace( '#/OData/([^/?]+)/Property/?#i', '/$1/listings', $base );
		if ( is_string( $native ) && '' !== $native ) {
			return $native;
		}
	}
	return $base;
}

/**
 * One direct HTTP GET against the MLS import URL.
 *
 * @param string $query OData query string beginning with '?'.
 * @return array{records:array,total:int}|null Null on transport/auth/parse failure.
 */
function mlsimport_live_request( string $query ) {
	$config  = mlsimport_live_config();
	$headers = mlsimport_live_auth_headers();
	if ( array() === $config || array() === $headers ) {
		return null;
	}

	$base = mlsimport_live_endpoint( $config );
	// The base URL may already carry a query part; keep exactly one '?'.
	$url = false === strpos( $base, '?' )
		? $base . $query
		: $base . '&' . ltrim( $query, '?&' );

	// OData filters carry spaces and quotes; encode the ones URLs can't.
	$url = str_replace( array( ' ', "'" ), array( '%20', '%27' ), $url );

	$response = wp_remote_get(
		$url,
		array(
			'timeout' => 20,
			'headers' => $headers,
		)
	);

	if ( is_wp_error( $response ) || 200 !== (int) wp_remote_retrieve_response_code( $response ) ) {
		return null;
	}

	$result = mlsimport_live_parse_response( (string) wp_remote_retrieve_body( $response ), $config );

	// BrightMLS media lives on a separate endpoint; attach it here, inside the
	// cached request path, so the cache stores records WITH their media.
	if ( is_array( $result ) && 'brightmls' === ( $config['type'] ?? '' ) && array() !== $result['records'] ) {
		$result['records'] = mlsimport_live_attach_brightmls_media( $result['records'], $config, $headers );
	}

	return $result;
}

/**
 * Attach BrightMedia rows as standard Media[] to records that lack media,
 * fetched from the separate media endpoint in chunks of 100 keys (the same
 * request the AWS media fetch runs). A failed media chunk degrades to
 * photo-less cards, never a failed search.
 *
 * @param array $records Raw RESO records from the listings response.
 * @param array $config  Per-MLS config (api_media_url).
 * @param array $headers Auth headers of the listings request.
 * @return array The records, media attached where the endpoint had it.
 */
function mlsimport_live_attach_brightmls_media( array $records, array $config, array $headers ): array {
	$keys = array();
	foreach ( $records as $record ) {
		if ( is_array( $record ) && empty( $record['Media'] ) && isset( $record['ListingKey'] ) ) {
			$keys[] = (string) $record['ListingKey'];
		}
	}
	if ( array() === $keys ) {
		return $records;
	}

	$base = isset( $config['api_media_url'] ) ? trim( (string) $config['api_media_url'] ) : '';
	if ( '' === $base ) {
		// The fixed BrightMedia endpoint — the AWS media fetch's default.
		$base = 'https://bright-reso.brightmls.com/RESO/OData/bright/BrightMedia';
	}
	// BrightMLS's OData server rejects a '/' immediately before '?'.
	$base = rtrim( $base, '/' );

	$map = array();
	foreach ( array_chunk( $keys, 100 ) as $chunk ) {
		$url      = $base . mlsimport_live_brightmls_media_query( $chunk );
		$url      = str_replace( array( ' ', "'" ), array( '%20', '%27' ), $url );
		$response = wp_remote_get(
			$url,
			array(
				'timeout' => 20,
				'headers' => $headers,
			)
		);
		if ( is_wp_error( $response ) || 200 !== (int) wp_remote_retrieve_response_code( $response ) ) {
			continue;
		}
		$data = json_decode( (string) wp_remote_retrieve_body( $response ), true );
		if ( is_array( $data ) && ! empty( $data['value'] ) && is_array( $data['value'] ) ) {
			$map += mlsimport_live_brightmls_media_map( $data['value'] );
		}
	}

	foreach ( $records as $i => $record ) {
		$key = is_array( $record ) && isset( $record['ListingKey'] ) ? (string) $record['ListingKey'] : '';
		if ( '' !== $key && isset( $map[ $key ] ) ) {
			$records[ $i ]['Media'] = $map[ $key ];
		}
	}
	return $records;
}

```