get_email_log_columns() - Code Metrics - Inspection of "Handle non-standard column name when fetching colu..." - sudar/email-log - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 19-feature/export-logs-in-batc... ( 578497...bca245 )

by Maria Daniel Deepak
created 2019-07-28 05:16 UTC
get_email_log_columns() A

↳ Parent: Project
Complexity

Conditions	1
Paths	1
Size

Total Lines	13
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	11
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	12
nc	1
nop	0
dl	0
loc	13
ccs	11
cts	11
cp	1
crap	1
rs	9.8666
c	0
b	0
f	0
<?php namespace EmailLog\Util;

/**
 * Email Log Helper functions.
 * Some of these functions would be used the addons.
 */
defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Perform additional sanitation of emails.
 *
 * @since 1.9
 *
 * @param string $email    Email string to be sanitized.
 * @param bool   $multiple (Optional) Should multiple emails be allowed. True by default.
 *
 * @return string Sanitized email.
 */
function sanitize_email( $email, $multiple = true ) {
	$emails = explode( ',', $email );
	if ( ! $multiple ) {
		$emails = array_slice( $emails, 0, 1 );
	}

	$cleaned_emails = array_map( __NAMESPACE__ . '\\sanitize_email_with_name', $emails );

	return implode( ', ', $cleaned_emails );
}

/**
 * Sanitize email with name.
 *
 * @since 1.9
 *
 * @param string $string Email string to be sanitized.
 *
 * @return string Sanitized email.
 */
function sanitize_email_with_name( $string ) {
	$string = trim( $string );

	$bracket_pos = strpos( $string, '<' );
	if ( false !== $bracket_pos ) {
		if ( $bracket_pos > 0 ) {
			$name = substr( $string, 0, $bracket_pos );
			$name = trim( $name );

			$email = substr( $string, $bracket_pos + 1 );
			$email = str_replace( '>', '', $email );

			return sanitize_text_field( $name ) . ' <' . \sanitize_email( $email ) . '>';
		}
	}

	return \sanitize_email( $string );
}

/**
 * Gets the columns to export logs.
 *
 * If the More Fields add-on is active, additional columns are returned.
 *
 * @since 2.0.0
 *
 * @return string[] List of Columns to export.
 */
function get_log_columns_to_export() {

	if ( is_plugin_active( 'email-log-more-fields/email-log-more-fields.php' ) ) {
		return array( 'id', 'sent_date', 'to_email', 'subject', 'from', 'cc', 'bcc', 'reply-to', 'attachment' );
	}

	return array( 'id', 'sent_date', 'to_email', 'subject' );
}

/**
 * Is it an admin request and not an ajax request.
 *
 * @since 2.1
 *
 * @return bool True if admin non ajax request, False otherwise.
 */
function is_admin_non_ajax_request() {
	if ( function_exists( 'wp_doing_ajax' ) && wp_doing_ajax() ) {
		return false;
	}

	if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
		return false;
	}

	return is_admin();
}

/**
 * Checks the Checkbox when values are present in a given array.
 *
 * Use this function in Checkbox fields.
 *
 * @since 2.1.0
 *
 * @param array  $values  List of all possible values.
 * @param string $current The current value to be checked.
 */
function checked_array( $values, $current ) {
	if ( ! is_array( $values ) ) {
		return;
	}

	if ( in_array( $current, $values ) ) {
		echo "checked='checked'";
	}
}

/**
 * Returns Comma separated values of the given array elements.
 *
 * Use $delimiter param to join elements other than `,`.
 *
 * @since 2.3.0
 *
 * @param array|string $value     The array whose values are to be joined.
 * @param string       $delimiter Optional. Default is `,`.
 *
 * @return string
 */
function join_array_elements_with_delimiter( $value, $delimiter = ',' ) {
	if ( is_array( $value ) ) {
		return implode( $delimiter, $value );
	}

	return is_string( $value ) ? $value : '';
}

/**
 * Gets the User defined Date time format.
 *
 * @used-by \EmailLog\Core\UI\Setting\CoreSetting
 * @used-by \EmailLog\Util\render_auto_delete_logs_next_run_schedule()
 *
 * @since   2.3.0
 *
 * @return string
 */
function get_user_defined_date_time_format() {
	return sprintf( '%1$s %2$s', get_option( 'date_format', 'Y-m-d' ), get_option( 'time_format', 'g:i a' ) );
	return sprintf( '%1$s %2$s', /** @scrutinizer ignore-type */ get_option( 'date_format', 'Y-m-d' ), get_option( 'time_format', 'g:i a' ) );
}

/**
 * Renders the next run auto delete logs schedule in Date and time format set within WordPress.
 *
 * @used-by \EmailLog\Addon\UI\Setting\DashboardWidget
 * @used-by \EmailLog\Core\UI\Component\AutoDeleteLogsSetting
 *
 * @since 2.3.0
 */
function render_auto_delete_logs_next_run_schedule() {
	?>
	<?php if ( wp_next_scheduled( 'el_scheduled_delete_logs' ) ) : ?>
		<p>
			<?php _e( 'Auto delete logs cron will be triggered next at', 'email-log' ); ?>:
			<?php $date_time_format = get_user_defined_date_time_format(); ?>
			<strong><?php echo get_date_from_gmt( date( 'Y-m-d H:i:s', wp_next_scheduled( 'el_scheduled_delete_logs' ) ), $date_time_format ); ?></strong>
			<strong><?php echo get_date_from_gmt( date( 'Y-m-d H:i:s', /** @scrutinizer ignore-type */ wp_next_scheduled( 'el_scheduled_delete_logs' ) ), $date_time_format ); ?></strong>
		</p>
	<?php endif; ?>
	<?php
}

/**
 * Gets the value by key from the array.
 *
 * If the key isn't found, then null is returned.
 *
 * @since 2.3.0
 *
 * @param array  $array   The actual array.
 * @param string $key     The key whose value is to be retrieved.
 * @param string $default Optional.
 *
 * @return mixed|null
 */
function el_array_get( $array, $key, $default = null ) {
	return isset( $array[ $key ] ) ? $array[ $key ] : $default;
}

/**
 * Returns TRUE if the given search term is Advanced Search Term.
 *
 * @param string $term Search Term.
 *
 * @return bool
 */
function is_advanced_search_term( $term ) {
	if ( ! is_string( $term ) ) {

		return false;
	}

	$predicates = get_advanced_search_term_predicates( $term );

	return ! empty( $predicates );
}

/**
 * Gets the Search Term Predicates.
 *
 * Example:
 *
 * If $term = to:[email protected] then,
 *
 * the output would be
 *
 * $output = array(
 *      'to' => [email protected]
 * )
 *
 * @since 2.3.0
 *
 * @param string $term Search Term.
 *
 * @return array
 */
function get_advanced_search_term_predicates( $term ) {
	if ( ! is_string( $term ) ) {

		return array();
	}

	$predicates           = explode( ' ', $term );
	$predicates_organized = array();

	foreach ( $predicates as $predicate ) {
		$is_match = preg_match( '/(id|email|to|cc|bcc|reply-to):(.*)$/', $predicate, $matches );
		if ( 1 === $is_match ) {
			$predicates_organized[ $matches[1] ] = $matches[2];
		}
	}

	return $predicates_organized;
}

/**
 * Gets the Advanced Search URL.
 *
 * @since 2.3.0
 *
 * @return string
 */
function get_advanced_search_url() {
	$admin_url = get_admin_url( null, 'admin.php?page=email-log' );

	return add_query_arg( 'el_as', 1, $admin_url );
}

/**
 * Gets the Column labels to be used in LogList table.
 *
 * @since 2.3.2 Standardize fetching DB Column label by using get_email_log_columns() and $mapping.
 *              Renamed $db_column arg to $maybe_db_column to make it more appropriate.
 * @since 2.3.0 Initial definition.
 *
 * @param string $maybe_db_column
 *
 * @return string
 */
function get_column_label_by_db_column( $maybe_db_column ) {
	// Standard column labels are on the right.
	// $mapping[ $non_standard_key ] => $standard_key
	$mapping = array(
		'to'         => 'to_email', // EmailLog\Core\UI\ListTable::get_columns() uses `to`
		'reply-to'   => 'reply_to',
		'attachment' => 'attachments',
	);

	$labels = get_email_log_columns();

	/**
	 * Filters the Labels used through out the Email Log plugin.
	 *
	 * @since 2.3.0
	 *
	 * @param array $labels {
	 *                      List of DB Columns and its respective labels.
	 *
	 *                      Example:
	 *                      'id'          => __( 'ID', 'email-log' ),
	 *
	 * @type string $key    DB Column or any key for which a Label would be required. Accepts a internationalized string as Label.
	 *              }
	 */
	$labels = apply_filters( 'el_db_column_labels', $labels );

	if ( array_key_exists( $maybe_db_column, $mapping ) ) {
		$maybe_db_column = $mapping[ $maybe_db_column ];
	}

	if ( array_key_exists( $maybe_db_column, $labels ) ) {
		return $labels[ $maybe_db_column ];
	}

	return $maybe_db_column;
}

/**
 * Returns an array of Email Log columns.
 *
 * Keys are the column names in the DB.
 * This holds true except for From, CC, BCC & Reply To as they are put under one column `headers`.
 *
 * @since 2.3.2
 *
 * @return array Key value pair of Email Log columns.
 */
function get_email_log_columns() {
	return array(
		'id'          => __( 'ID', 'email-log' ),
		'sent_date'   => __( 'Sent at', 'email-log' ),
		'to_email'    => __( 'To', 'email-log' ),
		'subject'     => __( 'Subject', 'email-log' ),
		'message'     => __( 'Message', 'email-log' ),
		'from'        => __( 'From', 'email-log' ),
		'cc'          => __( 'CC', 'email-log' ),
		'bcc'         => __( 'BCC', 'email-log' ),
		'attachments' => __( 'Attachment', 'email-log' ),
		'ip_address'  => __( 'IP Address', 'email-log' ),
		'reply_to'    => __( 'Reply To', 'email-log' ),
	);
}

/**
 * Abstract of the core logic behind masking.
 *
 * @since 2.3.2
 *
 * @param string $value     Content
 * @param string $mask_char Mask character.
 * @param int    $percent   The higher the percent, the more masking character on the email.
 *
 * @return string
 */
function get_masked_value( $value, $mask_char, $percent ) {
	$len        = strlen( $value );
	$mask_count = (int) floor( $len * $percent / 100 );
	$offset     = (int) floor( ( $len - $mask_count ) / 2 );

	return substr( $value, 0, $offset )
	       . str_repeat( $mask_char, $mask_count )
	       . substr( $value, $mask_count + $offset );
}

/**
 * Masks Email address.
 *
 * @see http://www.webhostingtalk.com/showthread.php?t=1014672
 * @since 2.3.2
 *
 * @uses get_masked_value()
 *
 * @param string $email     Email to be masked.
 * @param string $mask_char Mask character.
 * @param int    $percent   The higher the percent, the more masking character on the email.
 *
 * @return string
 */
function mask_email( $email, $mask_char = '*', $percent = 50 ) {
	if ( ! is_email( $email ) ) {
		return $email;
	}

	list( $user, $domain ) = preg_split( '/@/', $email );

	return sprintf( '%1$s@%2$s',
		get_masked_value( $user, $mask_char, $percent ),
		get_masked_value( $domain, $mask_char, $percent )
	);
}

/**
 * Mask Content fields.
 *
 * Content fields can be Subject or Email message.
 *
 * @since 2.3.2
 *
 * @uses get_masked_value()
 *
 * @param string $content   The actual content.
 * @param string $mask_char Mask character.
 * @param int    $percent   The higher the percent, the more masking character on the email.
 *
 * @return string
 */
function mask_content( $content, $mask_char = '*', $percent = 80 ) {
	$content = wp_strip_all_tags( $content );

	return get_masked_value( $content, $mask_char, $percent );
}

sudar / email-log

Push — 19-feature/export-logs-in-batc... ( 578497...bca245 )

get_email_log_columns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
