Skip to content

IMPB-1588: Add more aggressive gaurd rails for 412 requests #549

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KashIDX wants to merge 1 commit into
base: release/3.2.8
Choose a base branch
from
Open

IMPB-1588: Add more aggressive gaurd rails for 412 requests #549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Author: IDX, LLC
Author URL: https://idxbroker.com
**Tags:** IDX, MLS, multiple listing service, impress, idx impress, impress for idx broker, IDX plugin, idx broker, idxbroker, idx broker platinum, idx wordpress, idx wordpress plugin, integrated idx, real estate, real estate wordpress, RETS, wordpress idx, wordpress mls, WordPress Plugin, platinum, realtor, idx broker lite, idx lite, idxbroker lite, crm
**Requires at least:** 5.3
**Tested up to:** 6.9
**Stable tag:** 3.2.7
**Tested up to:** 6.9.1
**Stable tag:** 3.2.8
**Minimum PHP:** 7.1.8
**License:** GPLv2 or later
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
Expand Down Expand Up @@ -112,6 +112,9 @@ For users with IMPress 3.0+ who have legacy versions of IMPress Listings and/or

## Changelog ##

### 3.2.8 ###
* Fix : Handle for 412 response for the accountType request

### 3.2.7 ###
* Fix : Removed the manual transient caching

Expand Down
4 changes: 2 additions & 2 deletions idx-broker-platinum.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Plugin Name: IMPress for IDX Broker
Plugin URI: https://idxbroker.com
Description: Over 600 IDX/MLS feeds serviced. The #1 IDX/MLS solution just got even better!
Version: 3.2.7
Version: 3.2.8
Author: IDX Broker
Contributors: IDX, LLC
Author URI: https://idxbroker.com
Expand All @@ -18,7 +18,7 @@
class Idx_Broker_Plugin {

// Placed here for convenient updating.
const IDX_WP_PLUGIN_VERSION = '3.2.7';
const IDX_WP_PLUGIN_VERSION = '3.2.8';
const VUE_DEV_MODE = false;

/**
Expand Down
36 changes: 29 additions & 7 deletions idx/idx-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,14 @@ public function idx_api(
return [];
}

$cache_key = 'idx_' . $level . '_' . $method . '_cache';
$cache_key = 'idx_' . $level . '_' . $method . '_cache';
$api_maybe_exceeded = get_option( 'idx_api_limit_exceeded' );
$limit_window_active = $api_maybe_exceeded && time() <= ( (int) $api_maybe_exceeded + ( 60 * 60 ) );
$is_cacheable_request = 'POST' !== $request_type && 'PUT' !== $request_type;
$main_site_cache = is_multisite() && $this->api_key === get_blog_option( get_main_site_id(), 'idx_broker_apikey' );

// Check cache
if ( is_multisite() && $this->api_key === get_blog_option( get_main_site_id(), 'idx_broker_apikey' ) ) {
if ( $main_site_cache ) {
$cached = get_blog_option( get_main_site_id(), $cache_key );
} else {
$cached = get_option( $cache_key );
Expand All @@ -133,19 +137,24 @@ public function idx_api(

if ( is_array( $cached ) && isset( $cached['data'] ) && isset( $cached['expiration'] ) ) {
$expiration = $cached['expiration'];
$api_maybe_exceeded = get_option( 'idx_api_limit_exceeded' );

// If the data is past expiration, but we've currently exceeded the API limit,
// let's return the cached data so we don't continue to call the API until
// after one hour since the first 412 error.
if ( $api_maybe_exceeded && time() <= $api_maybe_exceeded + ( 60 * 60 ) && $expiration < time() ) {
if ( $limit_window_active && $expiration < time() ) {
return $cached['data'];
} elseif ( $expiration >= time() ) {
return $cached['data'];
}
}
}

// If we are currently in the 412 cooldown window and there was no usable cache,
// avoid making another API request and return a safe default response.
if ( $is_cacheable_request && $limit_window_active ) {
return array();
}

$headers = array(
'Content-Type' => 'application/x-www-form-urlencoded',
'accesskey' => $this->api_key,
Expand Down Expand Up @@ -182,12 +191,25 @@ public function idx_api(
if ( isset( $error ) && $error !== false ) {
if ( $code == 401 ) {
// Delete cache on 401 error
if ( is_multisite() && $this->api_key === get_blog_option( get_main_site_id(), 'idx_broker_apikey' ) ) {
if ( $main_site_cache ) {
delete_blog_option( get_main_site_id(), $cache_key );
} else {
delete_option( $cache_key );
}
}
if ( $code == 412 && $is_cacheable_request ) {
$limit_exceeded_at = (int) get_option( 'idx_api_limit_exceeded' );
$fallback_expiration = ( $limit_exceeded_at > 0 ? $limit_exceeded_at : time() ) + ( 60 * 60 );
$fallback_cache_data = array(
'data' => array(),
'expiration' => $fallback_expiration,
);
if ( $main_site_cache ) {
update_blog_option( get_main_site_id(), $cache_key, $fallback_cache_data );
} else {
update_option( $cache_key, $fallback_cache_data, false );
}
}
return new \WP_Error(
'idx_api_error',
__( 'Error ' ) . $code . __( ': ' ) . $error,
Expand All @@ -198,13 +220,13 @@ public function idx_api(
);
} else {
$data = (array) json_decode( (string) $response['body'], $json_decode_type );
if ( 'POST' !== $request_type && 'PUT' !== $request_type ) {
if ( $is_cacheable_request ) {
// Store in cache
$cache_data = array(
'data' => $data,
'expiration' => time() + $expiration,
);
if ( is_multisite() && $this->api_key === get_blog_option( get_main_site_id(), 'idx_broker_apikey' ) ) {
if ( $main_site_cache ) {
update_blog_option( get_main_site_id(), $cache_key, $cache_data );
} else {
update_option( $cache_key, $cache_data, false );
Expand Down
7 changes: 5 additions & 2 deletions readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Contributors: idxco
Author URL: https://idxbroker.com
Tags: IDX, MLS, multiple listing service, impress, idx impress, impress for idx broker, IDX plugin, idx broker, idxbroker, idx broker platinum, idx wordpress, idx wordpress plugin, integrated idx, real estate, real estate wordpress, RETS, wordpress idx, wordpress mls, WordPress Plugin, platinum, realtor, idx broker lite, idx lite, idxbroker lite, crm
Requires at least: 5.3
Tested up to: 6.9
Stable tag: 3.2.7
Tested up to: 6.9.1
Stable tag: 3.2.8
Requires PHP: 7.1.8
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Expand Down Expand Up @@ -133,6 +133,9 @@ For users with IMPress 3.0+ who have legacy versions of IMPress Listings and/or

== Changelog ==

= 3.2.8 =
* Fix : Handle for 412 response for the accountType request

= 3.2.7 =
* Fix : Removed the manual transient caching

Expand Down