give / includes / filters.php

filters.php in GiveWP – Donation Plugin and Fundraising Platform 2.3.1, at includes/filters.php

271 lines 6.6 KB

Raw Download Zip

1	<?php
2	/**
3	* Front-end Filters
4	*
5	* @package Give
6	* @subpackage Functions
7	* @copyright Copyright (c) 2016, GiveWP
8	* @license https://opensource.org/licenses/gpl-license GNU Public License
9	* @since 1.0
10	*/
11
12	// Exit if accessed directly.
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit;
15	}
16
17
18	/**
19	* Add backward compatibility for settings who has disable_ as name prefix.
20	* TODO: Remove this backward compatibility when do not need.
21	*
22	* @since 1.8
23	*
24	* @param array $old_settings Array of settings.
25	* @param array $settings Array of settings.
26	*
27	* @return void
28	*/
29	function give_set_settings_with_disable_prefix( $old_settings, $settings ) {
30	// Bailout.
31	if ( ! function_exists( 'give_v18_renamed_core_settings' ) ) {
32	return;
33	}
34
35	// Get old setting names.
36	$old_settings = array_flip( give_v18_renamed_core_settings() );
37	$update_setting = false;
38
39	foreach ( $settings as $key => $value ) {
40
41	// Check 1. Check if new option is really updated or not.
42	// Check 2. Continue if key is not renamed.
43	if ( ! isset( $old_settings[ $key ] ) ) {
44	continue;
45	}
46
47	// Set old setting.
48	$settings[ $old_settings[ $key ] ] = 'on';
49
50	// Do not need to set old setting if new setting is not set.
51	if (
52	( give_is_setting_enabled( $value ) && ( false !== strpos( $old_settings[ $key ], 'disable_' ) ) )
53	\|\| ( ! give_is_setting_enabled( $value ) && ( false !== strpos( $old_settings[ $key ], 'enable_' ) ) )
54
55	) {
56	unset( $settings[ $old_settings[ $key ] ] );
57	}
58
59	// Tell bot to update setting.
60	$update_setting = true;
61	}
62
63	// Update setting if any old setting set.
64	if ( $update_setting ) {
65	update_option( 'give_settings', $settings, false );
66	}
67	}
68
69	add_action( 'update_option_give_settings', 'give_set_settings_with_disable_prefix', 10, 2 );
70
71	/**
72	* Check spam through Akismet.
73	*
74	* It will build Akismet query string and call Akismet API.
75	* Akismet response return 'true' for spam donation.
76	*
77	* @since 1.8.14
78	*
79	* @param $spam
80	*
81	* @return bool\|mixed
82	*/
83	function give_akismet( $spam ) {
84
85	// Bail out, If spam.
86	if ( $spam ) {
87	return $spam;
88	}
89
90	// Bail out, if Akismet key not exist.
91	if ( ! give_check_akismet_key() ) {
92	return false;
93	}
94
95	// Build args array.
96	$args = array();
97
98	$args['comment_author'] = isset( $_POST['give_first'] ) ? give_clean( $_POST['give_first'] ) : '';
99	$args['comment_author_email'] = isset( $_POST['give_email'] ) ? sanitize_email( $_POST['give_email'] ) : false;
100	$args['blog'] = get_option( 'home' );
101	$args['blog_lang'] = get_locale();
102	$args['blog_charset'] = get_option( 'blog_charset' );
103	$args['user_ip'] = $_SERVER['REMOTE_ADDR'];
104	$args['user_agent'] = $_SERVER['HTTP_USER_AGENT'];
105	$args['referrer'] = $_SERVER['HTTP_REFERER'];
106	$args['comment_type'] = 'contact-form';
107
108	$form_id = isset( $_POST['give-form-id'] ) ? absint( $_POST['give-form-id'] ) : 0;
109
110	// Pass Donor comment if enabled.
111	if ( give_is_donor_comment_field_enabled( $form_id ) ) {
112	$give_comment = isset( $_POST['give_comment'] ) ? give_clean( $_POST['give_comment'] ) : '';
113
114	$args['comment_content'] = $give_comment;
115	}
116
117	$ignore = array( 'HTTP_COOKIE', 'HTTP_COOKIE2', 'PHP_AUTH_PW' );
118
119	foreach ( $_SERVER as $key => $value ) {
120	if ( ! in_array( $key, (array) $ignore ) ) {
121	$args["$key"] = $value;
122	}
123	}
124
125	// It will return Akismet spam detect API response.
126	return give_akismet_spam_check( $args );
127
128	}
129
130	add_filter( 'give_spam', 'give_akismet' );
131
132	/**
133	* Check Akismet API Key.
134	*
135	* @since 1.8.14
136	*
137	* @return bool
138	*/
139	function give_check_akismet_key() {
140	if ( is_callable( array( 'Akismet', 'get_api_key' ) ) ) { // Akismet v3.0+
141	return (bool) Akismet::get_api_key();
142	}
143
144	if ( function_exists( 'akismet_get_key' ) ) {
145	return (bool) akismet_get_key();
146	}
147
148	return false;
149	}
150
151	/**
152	* Detect spam through Akismet Comment API.
153	*
154	* @since 1.8.14
155	*
156	* @param array $args
157	*
158	* @return bool\|mixed
159	*/
160	function give_akismet_spam_check( $args ) {
161	global $akismet_api_host, $akismet_api_port;
162
163	$spam = false;
164	$query_string = http_build_query( $args );
165
166	if ( is_callable( array( 'Akismet', 'http_post' ) ) ) { // Akismet v3.0+
167	$response = Akismet::http_post( $query_string, 'comment-check' );
168	} else {
169	$response = akismet_http_post( $query_string, $akismet_api_host,
170	'/1.1/comment-check', $akismet_api_port );
171	}
172
173	// It's spam if response status is true.
174	if ( 'true' === $response[1] ) {
175	$spam = true;
176	}
177
178	// Allow developer to modified Akismet spam detection response.
179	return apply_filters( 'give_akismet_spam_check', $spam, $args );
180	}
181
182	/**
183	* Add support of RIAL code for backward compatibility.
184	* Note: for internal use only
185	*
186	* @since 1.8.17
187	*
188	* @param array $currencies
189	*
190	* @return array
191	*/
192	function give_bc_v1817_iranian_currency_code( $currencies ) {
193	if ( ! give_has_upgrade_completed( 'v1817_update_donation_iranian_currency_code' ) ) {
194	$currencies['RIAL'] = $currencies['IRR'];
195	}
196
197	return $currencies;
198	}
199
200	add_filter( 'give_currencies', 'give_bc_v1817_iranian_currency_code', 0 );
201
202
203	/**
204	* Format right to left supported currency amount.
205	*
206	* @since 1.8.17
207	*
208	* @param $formatted_amount
209	* @param $currency_args
210	* @param $price
211	*
212	* @return string
213	*/
214	function give_format_price_for_right_to_left_supported_currency( $formatted_amount, $currency_args, $price ) {
215	if ( ! give_is_right_to_left_supported_currency( $currency_args['currency_code'] ) ) {
216	return $formatted_amount;
217	}
218
219	$formatted_amount = (
220	'before' === (string) $currency_args['position'] ?
221	'‫' . $price . $currency_args['symbol'] . '‬' :
222	'‪' . $price . $currency_args['symbol'] . '‬'
223	);
224
225	$formatted_amount = $currency_args['decode_currency'] ?
226	html_entity_decode( $formatted_amount, ENT_COMPAT, 'UTF-8' ) :
227	$formatted_amount;
228
229	return $formatted_amount;
230	}
231
232	add_filter( 'give_currency_filter', 'give_format_price_for_right_to_left_supported_currency', 10, 3 );
233
234	/**
235	* Validate active gateway value before returning result.
236	*
237	* @since 2.1.0
238	*
239	* @param $value
240	*
241	* @return array
242	*/
243	function __give_validate_active_gateways( $value ) {
244	$gateways = array_keys( give_get_payment_gateways() );
245	$active_gateways = is_array( $value ) ? array_keys( $value ) : array();
246
247	// Remove deactivated payment gateways.
248	if( ! empty( $active_gateways ) ) {
249	foreach ( $active_gateways as $index => $gateway_id ) {
250	if( ! in_array( $gateway_id, $gateways ) ) {
251	unset( $value[$gateway_id] );
252	}
253	}
254	}
255
256	if ( empty( $value ) ) {
257	/**
258	* Filter the default active gateway
259	*
260	* @since 2.1.0
261	*/
262	$value = apply_filters( 'give_default_active_gateways', array(
263	'manual' => 1,
264	) );
265	}
266
267	return $value;
268	}
269
270	add_filter( 'give_get_option_gateways', '__give_validate_active_gateways', 10, 1 );
271