← All changes | classes/models/FrmInbox.php +188 -23 6.4 → 6.16 View file →

		@@ -14,9 +14,9 @@
14	14
15	15	private static $messages = false;
16	16
17	17	/**
18		- * @param array
	18	+ * @var array
19	19	*/
20	20	private static $banner_messages;
21	21
22	22	public function __construct( $for_parent = null ) {
		@@ -47,9 +47,9 @@
47	47
48	48	/**
49	49	* @since 4.05
50	50	*
51		- * @param false|string $filter
	51	+ * @param array|false $filter
52	52	*/
53	53	public function get_messages( $filter = false ) {
54	54	$messages = self::$messages;
55	55	if ( $filter === 'filter' ) {
		@@ -139,9 +139,10 @@
139	139	'subject' => '',
140	140	'icon' => 'frm_tooltip_icon',
141	141	'cta' => '',
142	142	'expires' => false,
143		- 'who' => 'all', // use 'free', 'personal', 'business', 'elite', 'grandfathered'
	143	+ // Use 'free', 'personal', 'business', 'elite', 'grandfathered'.
	144	+ 'who' => 'all',
144	145	'type' => '',
145	146	);
146	147
147	148	$message = array_merge( $defaults, $message );
		@@ -155,10 +156,10 @@
155	156	*/
156	157	private function clean_messages() {
157	158	$removed = false;
158	159	foreach ( self::$messages as $t => $message ) {
159		- $read = isset( $message['read'] ) && ! empty( $message['read'] ) && isset( $message['read'][ get_current_user_id() ] ) && $message['read'][ get_current_user_id() ] < strtotime( '-1 month' );
160		- $dismissed = isset( $message['dismissed'] ) && ! empty( $message['dismissed'] ) && isset( $message['dismissed'][ get_current_user_id() ] ) && $message['dismissed'][ get_current_user_id() ] < strtotime( '-1 week' );
	160	+ $read = ! empty( $message['read'] ) && isset( $message['read'][ get_current_user_id() ] ) && $message['read'][ get_current_user_id() ] < strtotime( '-1 month' );
	161	+ $dismissed = ! empty( $message['dismissed'] ) && isset( $message['dismissed'][ get_current_user_id() ] ) && $message['dismissed'][ get_current_user_id() ] < strtotime( '-1 week' );
161	162	$expired = $this->is_expired( $message );
162	163	if ( $read || $expired || $dismissed ) {
163	164	unset( self::$messages[ $t ] );
164	165	$removed = true;
		@@ -170,15 +171,17 @@
170	171	}
171	172	}
172	173
173	174	/**
	175	+ * @param array $messages
	176	+ * @param string $type
174	177	* @return void
175	178	*/
176		- private function filter_messages( &$messages ) {
	179	+ public function filter_messages( &$messages, $type = 'unread' ) {
177	180	$user_id = get_current_user_id();
178	181	foreach ( $messages as $k => $message ) {
179	182	$dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] );
180		- if ( empty( $k ) || $this->is_expired( $message ) || $dismissed ) {
	183	+ if ( empty( $k ) || $this->is_expired( $message ) || ( $type === 'dismissed' ) !== $dismissed ) {
181	184	unset( $messages[ $k ] );
182	185	} elseif ( ! $this->is_for_user( $message ) ) {
183	186	unset( $messages[ $k ] );
184	187	}
		@@ -191,9 +194,9 @@
191	194	*
192	195	* @return bool
193	196	*/
194	197	private function is_expired( $message ) {
195		- return isset( $message['expires'] ) && ! empty( $message['expires'] ) && $message['expires'] < time();
	198	+ return ! empty( $message['expires'] ) && $message['expires'] < time();
196	199	}
197	200
198	201	/**
199	202	* Show different messages for different accounts.
		@@ -208,9 +211,24 @@
208	211	$who = (array) $message['who'];
209	212	if ( in_array( 'all', $who, true ) || in_array( 'everyone', $who, true ) ) {
210	213	return true;
211	214	}
212		- return in_array( $this->get_user_type(), $who, true );
	215	+ if ( in_array( $this->get_user_type(), $who, true ) ) {
	216	+ return true;
	217	+ }
	218	+ if ( in_array( 'free_first_30', $who, true ) && $this->is_free_first_30() ) {
	219	+ return true;
	220	+ }
	221	+ /**
	222	+ * Allow for other special inbox cases in other add-ons.
	223	+ *
	224	+ * @since 6.8.1
	225	+ *
	226	+ * @param bool $is_for_user
	227	+ * @param array $who
	228	+ * @param array $message
	229	+ */
	230	+ return (bool) apply_filters( 'frm_inbox_message_is_for_user', false, $who, $message );
213	231	}
214	232
215	233	private function get_user_type() {
216	234	if ( ! FrmAppHelper::pro_is_installed() ) {
		@@ -238,12 +256,11 @@
238	256	$this->update_list();
239	257	}
240	258
241	259	/**
242		- * @param string $key
243		- *
244	260	* @since 4.05.02
245	261	*
	262	+ * @param string $key
246	263	* @return void
247	264	*/
248	265	public function mark_unread( $key ) {
249	266	$is_read = isset( self::$messages[ $key ] ) && isset( self::$messages[ $key ]['read'] ) && isset( self::$messages[ $key ]['read'][ get_current_user_id() ] );
		@@ -305,20 +322,32 @@
305	322	}
306	323	return $messages;
307	324	}
308	325
309		- public function unread_html() {
310		- $html = '';
	326	+ /**
	327	+ * @since 6.8.4 The $filtered parameter was added.
	328	+ *
	329	+ * @param bool $filtered
	330	+ * @return string
	331	+ */
	332	+ public function unread_html( $filtered = true ) {
311	333	$count = count( $this->unread() );
312		- if ( $count ) {
313		- $html = ' <span class="update-plugins frm_inbox_count"><span class="plugin-count">' . absint( $count ) . '</span></span>';
	334	+ if ( ! $count ) {
	335	+ return '';
	336	+ }
314	337
315		- /**
316		- * @since 4.06.01
317		- */
318		- $html = apply_filters( 'frm_inbox_badge', $html );
	338	+ $html = ' <span class="update-plugins frm_inbox_count"><span class="plugin-count">' . absint( $count ) . '</span></span>';
	339	+
	340	+ if ( ! $filtered ) {
	341	+ return $html;
319	342	}
320		- return $html;
	343	+
	344	+ /**
	345	+ * @since 4.06.01
	346	+ *
	347	+ * @param string $html
	348	+ */
	349	+ return (string) apply_filters( 'frm_inbox_badge', $html );
321	350	}
322	351
323	352	/**
324	353	* @since 4.05.02
		@@ -323,9 +352,8 @@
323	352	/**
324	353	* @since 4.05.02
325	354	*
326	355	* @param string $key
327		- *
328	356	* @return void
329	357	*/
330	358	public function remove( $key ) {
331	359	if ( isset( self::$messages[ $key ] ) ) {
		@@ -341,8 +369,31 @@
341	369	update_option( $this->option, self::$messages, 'no' );
342	370	}
343	371
344	372	/**
	373	+ * Check if user is still using the Lite version only, and within
	374	+ * the first 30 days of activation.
	375	+ *
	376	+ * @since 6.16
	377	+ *
	378	+ * @return bool
	379	+ */
	380	+ private function is_free_first_30() {
	381	+ $activation_timestamp = get_option( 'frm_first_activation' );
	382	+ if ( false === $activation_timestamp ) {
	383	+ // If the option does not exist, assume that it is
	384	+ // because the user was active before this option was introduced.
	385	+ return false;
	386	+ }
	387	+ if ( FrmAppHelper::pro_is_included() ) {
	388	+ // Not free.
	389	+ return false;
	390	+ }
	391	+ $cutoff = strtotime( '-30 days' );
	392	+ return $activation_timestamp > $cutoff;
	393	+ }
	394	+
	395	+ /**
345	396	* Show a banner message if one is available.
346	397	*
347	398	* @return bool True if a banner is available and shown.
348	399	*/
		@@ -350,13 +401,53 @@
350	401	if ( empty( self::$banner_messages ) ) {
351	402	return false;
352	403	}
353	404	$message = end( self::$banner_messages );
	405	+ $cta = self::get_prepared_banner_cta( $message['cta'] );
	406	+
354	407	require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php';
355	408	return true;
356	409	}
357	410
358	411	/**
	412	+ * Make sure that the CTA uses utm_medium=banner.
	413	+ *
	414	+ * @since 6.8.4
	415	+ *
	416	+ * @param string $cta
	417	+ * @return string
	418	+ */
	419	+ private static function get_prepared_banner_cta( $cta ) {
	420	+ $cta = str_replace( 'button-secondary', 'button-primary', $cta );
	421	+ return preg_replace_callback(
	422	+ '/href=("|\')(.*?)("|\')/',
	423	+ /**
	424	+ * Replace a single href attribute in the CTA.
	425	+ *
	426	+ * @param array $matches The regex results for a single match.
	427	+ * @return string
	428	+ */
	429	+ function ( $matches ) {
	430	+ $url = $matches[2];
	431	+ $parts = parse_url( $url );
	432	+
	433	+ if ( '#' === $url ) {
	434	+ return 'href="#"';
	435	+ }
	436	+
	437	+ $query = array();
	438	+ if ( isset( $parts['query'] ) ) {
	439	+ parse_str( $parts['query'], $query );
	440	+ }
	441	+ $query['utm_medium'] = 'banner';
	442	+ $parts['query'] = http_build_query( $query );
	443	+ return 'href="' . $parts['scheme'] . '://' . $parts['host'] . $parts['path'] . '?' . $parts['query'] . '"';
	444	+ },
	445	+ $cta
	446	+ );
	447	+ }
	448	+
	449	+ /**
359	450	* @return void
360	451	*/
361	452	public static function maybe_disable_screen_options() {
362	453	self::$banner_messages = self::get_banner_messages();
		@@ -366,16 +457,90 @@
366	457	}
367	458	}
368	459
369	460	/**
	461	+ * Get all message with a "banner" message key defined.
	462	+ *
370	463	* @return array
371	464	*/
372	465	private static function get_banner_messages() {
	466	+ return self::get_messages_with_key( 'banner' );
	467	+ }
	468	+
	469	+ /**
	470	+ * Get all messages with a "slidein" message key defined.
	471	+ *
	472	+ * @since 6.8.4
	473	+ *
	474	+ * @return array
	475	+ */
	476	+ private static function get_slidein_messages() {
	477	+ return self::get_messages_with_key( 'slidein' );
	478	+ }
	479	+
	480	+ /**
	481	+ * Get all messages with a $key message key defined.
	482	+ *
	483	+ * @since 6.8.4
	484	+ *
	485	+ * @param string $key The key we are checking for (ie. banner or slidein).
	486	+ * @return array
	487	+ */
	488	+ private static function get_messages_with_key( $key ) {
373	489	$inbox = new self();
374	490	return array_filter(
375	491	$inbox->get_messages( 'filter' ),
376		- function( $message ) {
377		- return ! empty( $message['banner'] );
	492	+ function ( $message ) use ( $key ) {
	493	+ return ! empty( $message[ $key ] );
378	494	}
	495	+ );
	496	+ }
	497	+
	498	+ /**
	499	+ * Check if there is at least one slidein message.
	500	+ *
	501	+ * @since 6.8.4
	502	+ *
	503	+ * @return bool
	504	+ */
	505	+ public static function has_a_slidein_message() {
	506	+ return (bool) self::get_slidein_messages();
	507	+ }
	508	+
	509	+ /**
	510	+ * Get the array used for frmGlobal.inboxSlideIn
	511	+ *
	512	+ * @since 6.8.4
	513	+ *
	514	+ * @return array|false
	515	+ */
	516	+ public static function get_inbox_slide_in_value_for_js() {
	517	+ $messages = self::get_slidein_messages();
	518	+ if ( ! $messages ) {
	519	+ return false;
	520	+ }
	521	+
	522	+ $message = reset( $messages );
	523	+
	524	+ /**
	525	+ * Extend the keys in the global JS object.
	526	+ * This is used in Pro to include images.
	527	+ *
	528	+ * @since 6.8.4
	529	+ *
	530	+ * @param array $keys
	531	+ */
	532	+ $keys_to_return = apply_filters(
	533	+ 'frm_inbox_slidein_js_vars',
	534	+ array( 'key', 'slidein', 'subject', 'cta' )
	535	+ );
	536	+
	537	+ return array_reduce(
	538	+ $keys_to_return,
	539	+ function ( $total, $key ) use ( $message ) {
	540	+ $total[ $key ] = isset( $message[ $key ] ) ? $message[ $key ] : '';
	541	+ return $total;
	542	+ },
	543	+ array()
379	544	);
380	545	}
381	546	}