Skip to content

Commit

Permalink
remove filter_cache_row
Browse files Browse the repository at this point in the history
Remove filter_cache_row in favour of filter_get_row
Remove "trigger error" functionality from filter_cache_row, since it was
not used or already assumed by the callers.
  • Loading branch information
cproensa authored and atrol committed Mar 4, 2018
1 parent 558bb1e commit fb44aad
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 38 deletions.
2 changes: 1 addition & 1 deletion api/soap/mc_filter_api.php
Expand Up @@ -127,7 +127,7 @@ function mc_filter_get( $p_username, $p_password, $p_project_id, $p_filter_id =
function mci_filter_delete( $p_filter_id ) {
$t_user_id = auth_get_current_user_id();

$t_filter = filter_cache_row( $p_filter_id, /* trigger_errors */ false );
$t_filter = filter_get_row( $p_filter_id );
if( !$t_filter ) {
return ApiObjectFactory::faultNotFound( 'Filter not found' );
}
Expand Down
47 changes: 15 additions & 32 deletions core/filter_api.php
Expand Up @@ -1035,13 +1035,21 @@ function filter_is_cookie_valid() {
}

/**
* Get the array fields specified by $p_filter_id
* Get the filter db row $p_filter_id
* using the cached row if it's available
* @param integer $p_filter_id A filter identifier to look up in the database.
* @return array a filter row
* @global array $g_cache_filter_db_rows
* @param integer $p_filter_id A filter identifier to look up in the database.
* @return array|boolean The row of filter data as stored in db table, or false if does not exist
*/
function filter_get_row( $p_filter_id ) {
return filter_cache_row( $p_filter_id );
global $g_cache_filter_db_rows;

if( !isset( $g_cache_filter_db_rows[$p_filter_id] ) ) {
filter_cache_rows( array($p_filter_id) );
}

$t_row = $g_cache_filter_db_rows[$p_filter_id];
return $t_row;
}

/**
Expand Down Expand Up @@ -2687,31 +2695,6 @@ function filter_cache_rows( array $p_filter_ids ) {
}
}

/**
* Cache a filter row if necessary and return the cached copy
* If the second parameter is true (default), trigger an error
* if the filter can't be found. If the second parameter is
* false, return false if the filter can't be found.
* @param integer $p_filter_id A filter identifier to retrieve.
* @param boolean $p_trigger_errors Whether to trigger an error if the filter is not found.
* @return array|boolean Array if filter exists, false if it doesn't exist and trigger errors is not set.
*/
function filter_cache_row( $p_filter_id, $p_trigger_errors = true ) {
global $g_cache_filter_db_rows;

if( !isset( $g_cache_filter_db_rows[$p_filter_id] ) ) {
filter_cache_rows( array($p_filter_id) );
}

$t_row = $g_cache_filter_db_rows[$p_filter_id];
if( $p_trigger_errors && !$t_row ) {
error_parameters( $p_filter_id );
trigger_error( ERROR_FILTER_NOT_FOUND, ERROR );
}

return $t_row;
}

/**
* Clear the filter cache (or just the given id if specified)
* @param integer $p_filter_id Filter id.
Expand Down Expand Up @@ -2848,7 +2831,7 @@ function filter_db_get_filter( $p_filter_id, $p_user_id = null ) {
return $g_cache_filter_db_serialized[$c_filter_id];
}

$t_filter_row = filter_cache_row( $c_filter_id, /* trigger_errors */ false );
$t_filter_row = filter_get_row( $c_filter_id );
if( $t_filter_row ) {
$g_cache_filter_db_serialized[$c_filter_id] = $t_filter_row['filter_string'];
} else {
Expand Down Expand Up @@ -3607,7 +3590,7 @@ function filter_get_visible_sort_properties_array( array $p_filter, $p_columns_t
* @return boolean
*/
function filter_is_named_filter( $p_filter_id ) {
$t_filter_row = filter_cache_row( $p_filter_id, /* trigger_errors */ false );
$t_filter_row = filter_get_row( $p_filter_id );
if( $t_filter_row ) {
return !empty( $t_filter_row['name'] ) && $t_filter_row['project_id'] >= 0;
}
Expand All @@ -3627,7 +3610,7 @@ function filter_is_accessible( $p_filter_id, $p_user_id = null ) {
} else {
$t_user_id = $p_user_id;
}
$t_filter_row = filter_cache_row( $p_filter_id, /* trigger_errors */ false );
$t_filter_row = filter_get_row( $p_filter_id );
if( $t_filter_row ) {
if( $t_filter_row['user_id'] == $t_user_id || $t_filter_row['is_public'] ) {
# If the filter is a named filter, check the config options
Expand Down
1 change: 0 additions & 1 deletion core/user_api.php
Expand Up @@ -1471,7 +1471,6 @@ function user_get_bug_filter( $p_user_id, $p_project_id = null ) {
# check if filter id is a proper stored filter, and is accesible
if( filter_is_named_filter( $t_source_query_id ) && filter_is_accessible( $t_source_query_id ) ){
# the actual stored filter can be retrieved
$t_filter_row = filter_cache_row( $t_source_query_id, /* trigger_errors */ false );
$t_filter = filter_deserialize( filter_db_get_filter( $t_source_query_id ) );
# update the referenced stored filter id
$t_filter['_source_query_id'] = $t_source_query_id;
Expand Down
1 change: 0 additions & 1 deletion manage_filter_edit_page.php
Expand Up @@ -76,7 +76,6 @@
} else {
$t_filter = filter_deserialize( $t_filter_string );
$t_filter['_source_query_id'] = $f_filter_id;
filter_cache_row( $f_filter_id );
}

$f_view_type = gpc_get_string( 'view_type', $t_filter['_view_type'] );
Expand Down
1 change: 0 additions & 1 deletion manage_filter_edit_update.php
Expand Up @@ -45,7 +45,6 @@
access_denied();
} else {
$t_filter = filter_deserialize( $t_filter_string );
filter_cache_row( $f_filter_id );
}

$f_filter_name = gpc_get_string( 'filter_name', null );
Expand Down
1 change: 0 additions & 1 deletion return_dynamic_filters.php
Expand Up @@ -71,7 +71,6 @@
} else {
$t_filter = filter_deserialize( $t_filter_string );
$t_filter['_source_query_id'] = $f_filter_id;
filter_cache_row( $c_filter_id );
}
}

Expand Down
1 change: 0 additions & 1 deletion view_filters_page.php
Expand Up @@ -79,7 +79,6 @@
} else {
$t_filter = filter_deserialize( $t_filter_string );
$t_named_filter = true;
filter_cache_row( $c_filter_id );
}
}

Expand Down

0 comments on commit fb44aad

Please sign in to comment.