| @@ -9,24 +9,18 @@ | ||
| 9 | 9 | class FrmInbox extends FrmFormApi { |
| 10 | 10 | |
| 11 | 11 | protected $cache_key; |
| 12 | 12 | |
| 13 | - /** | |
| 14 | - * @var string | |
| 15 | - */ | |
| 16 | 13 | private $option = 'frm_inbox'; |
| 17 | 14 | |
| 18 | - /** | |
| 19 | - * @var array|false | |
| 20 | - */ | |
| 21 | 15 | private static $messages = false; |
| 22 | 16 | |
| 23 | 17 | /** |
| 24 | - * @var array | |
| 18 | + * @param array | |
| 25 | 19 | */ |
| 26 | 20 | private static $banner_messages; |
| 27 | 21 | |
| 28 | - public function __construct() { | |
| 22 | + public function __construct( $for_parent = null ) { | |
| 29 | 23 | $this->set_cache_key(); |
| 30 | 24 | |
| 31 | 25 | if ( false === self::$messages ) { |
| 32 | 26 | $this->set_messages(); |
| @@ -53,19 +47,15 @@ | ||
| 53 | 47 | |
| 54 | 48 | /** |
| 55 | 49 | * @since 4.05 |
| 56 | 50 | * |
| 57 | - * @param array|false $filter | |
| 58 | - * | |
| 59 | - * @return array | |
| 51 | + * @param false|array $filter | |
| 60 | 52 | */ |
| 61 | 53 | public function get_messages( $filter = false ) { |
| 62 | 54 | $messages = self::$messages; |
| 63 | - | |
| 64 | 55 | if ( $filter === 'filter' ) { |
| 65 | 56 | $this->filter_messages( $messages ); |
| 66 | 57 | } |
| 67 | - | |
| 68 | 58 | return $messages; |
| 69 | 59 | } |
| 70 | 60 | |
| 71 | 61 | /** |
| @@ -74,9 +64,8 @@ | ||
| 74 | 64 | * @return void |
| 75 | 65 | */ |
| 76 | 66 | public function set_messages() { |
| 77 | 67 | self::$messages = get_option( $this->option ); |
| 78 | - | |
| 79 | 68 | if ( ! is_array( self::$messages ) ) { |
| 80 | 69 | self::$messages = array(); |
| 81 | 70 | } |
| 82 | 71 | |
| @@ -94,10 +83,9 @@ | ||
| 94 | 83 | * @return void |
| 95 | 84 | */ |
| 96 | 85 | private function add_api_messages() { |
| 97 | 86 | $api = $this->get_api_info(); |
| 98 | - | |
| 99 | - if ( ! $api ) { | |
| 87 | + if ( empty( $api ) ) { | |
| 100 | 88 | return; |
| 101 | 89 | } |
| 102 | 90 | |
| 103 | 91 | foreach ( $api as $message ) { |
| @@ -121,9 +109,9 @@ | ||
| 121 | 109 | // Don't replace messages unless required. |
| 122 | 110 | return; |
| 123 | 111 | } |
| 124 | 112 | |
| 125 | - if ( ! $this->within_valid_timeframe( $message ) ) { | |
| 113 | + if ( $this->is_expired( $message ) ) { | |
| 126 | 114 | return; |
| 127 | 115 | } |
| 128 | 116 | |
| 129 | 117 | if ( isset( self::$messages[ $message['key'] ] ) ) { |
| @@ -151,10 +139,9 @@ | ||
| 151 | 139 | 'subject' => '', |
| 152 | 140 | 'icon' => 'frm_tooltip_icon', |
| 153 | 141 | 'cta' => '', |
| 154 | 142 | 'expires' => false, |
| 155 | - // Use 'free', 'personal', 'business', 'elite', 'grandfathered'. | |
| 156 | - 'who' => 'all', | |
| 143 | + 'who' => 'all', // use 'free', 'personal', 'business', 'elite', 'grandfathered' | |
| 157 | 144 | 'type' => '', |
| 158 | 145 | ); |
| 159 | 146 | |
| 160 | 147 | $message = array_merge( $defaults, $message ); |
| @@ -167,14 +154,13 @@ | ||
| 167 | 154 | * @return void |
| 168 | 155 | */ |
| 169 | 156 | private function clean_messages() { |
| 170 | 157 | $removed = false; |
| 171 | - | |
| 172 | 158 | foreach ( self::$messages as $t => $message ) { |
| 173 | - $read = ! empty( $message['read'] ) && isset( $message['read'][ get_current_user_id() ] ) && $message['read'][ get_current_user_id() ] < strtotime( '-1 month' ); | |
| 174 | - $dismissed = ! empty( $message['dismissed'] ) && isset( $message['dismissed'][ get_current_user_id() ] ) && $message['dismissed'][ get_current_user_id() ] < strtotime( '-1 week' ); // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong | |
| 175 | - | |
| 176 | - if ( $read || $dismissed || ! $this->within_valid_timeframe( $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' ); | |
| 161 | + $expired = $this->is_expired( $message ); | |
| 162 | + if ( $read || $expired || $dismissed ) { | |
| 177 | 163 | unset( self::$messages[ $t ] ); |
| 178 | 164 | $removed = true; |
| 179 | 165 | } |
| 180 | 166 | } |
| @@ -184,62 +170,30 @@ | ||
| 184 | 170 | } |
| 185 | 171 | } |
| 186 | 172 | |
| 187 | 173 | /** |
| 188 | - * @param array $messages | |
| 189 | - * @param string $type | |
| 190 | - * | |
| 191 | 174 | * @return void |
| 192 | 175 | */ |
| 193 | - public function filter_messages( &$messages, $type = 'unread' ) { | |
| 176 | + private function filter_messages( &$messages ) { | |
| 194 | 177 | $user_id = get_current_user_id(); |
| 195 | - | |
| 196 | 178 | foreach ( $messages as $k => $message ) { |
| 197 | 179 | $dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] ); |
| 198 | - | |
| 199 | - if ( empty( $k ) || ! $this->within_valid_timeframe( $message ) || ( $type === 'dismissed' ) !== $dismissed ) { | |
| 180 | + if ( empty( $k ) || $this->is_expired( $message ) || $dismissed ) { | |
| 200 | 181 | unset( $messages[ $k ] ); |
| 201 | 182 | } elseif ( ! $this->is_for_user( $message ) ) { |
| 202 | 183 | unset( $messages[ $k ] ); |
| 203 | 184 | } |
| 204 | 185 | } |
| 205 | - | |
| 206 | 186 | $messages = apply_filters( 'frm_filter_inbox', $messages ); |
| 207 | 187 | } |
| 208 | 188 | |
| 209 | 189 | /** |
| 210 | - * Check if a message has started and is not expired. | |
| 211 | - * | |
| 212 | - * @since 6.25 | |
| 213 | - * | |
| 214 | 190 | * @param array $message |
| 215 | 191 | * |
| 216 | 192 | * @return bool |
| 217 | 193 | */ |
| 218 | - private function within_valid_timeframe( $message ) { | |
| 219 | - return $this->has_started( $message ) && ! $this->is_expired( $message ); | |
| 220 | - } | |
| 221 | - | |
| 222 | - /** | |
| 223 | - * Check if a message has actually started, so we can prevent showing something that is queued up early. | |
| 224 | - * | |
| 225 | - * @since 6.25 | |
| 226 | - * | |
| 227 | - * @param array $message | |
| 228 | - * | |
| 229 | - * @return bool | |
| 230 | - */ | |
| 231 | - private function has_started( $message ) { | |
| 232 | - return empty( $message['starts'] ) ? true : $message['starts'] <= time(); | |
| 233 | - } | |
| 234 | - | |
| 235 | - /** | |
| 236 | - * @param array $message | |
| 237 | - * | |
| 238 | - * @return bool | |
| 239 | - */ | |
| 240 | 194 | private function is_expired( $message ) { |
| 241 | - return ! empty( $message['expires'] ) && $message['expires'] < time(); | |
| 195 | + return isset( $message['expires'] ) && ! empty( $message['expires'] ) && $message['expires'] < time(); | |
| 242 | 196 | } |
| 243 | 197 | |
| 244 | 198 | /** |
| 245 | 199 | * Show different messages for different accounts. |
| @@ -244,28 +198,27 @@ | ||
| 244 | 198 | /** |
| 245 | 199 | * Show different messages for different accounts. |
| 246 | 200 | * |
| 247 | 201 | * @param array $message |
| 248 | - * | |
| 249 | 202 | * @return bool |
| 250 | 203 | */ |
| 251 | 204 | private function is_for_user( $message ) { |
| 252 | - if ( FrmApiHelper::is_for_user( $message ) ) { | |
| 205 | + if ( ! isset( $message['who'] ) || $message['who'] === 'all' ) { | |
| 253 | 206 | return true; |
| 254 | 207 | } |
| 208 | + $who = (array) $message['who']; | |
| 209 | + if ( in_array( 'all', $who, true ) || in_array( 'everyone', $who, true ) ) { | |
| 210 | + return true; | |
| 211 | + } | |
| 212 | + return in_array( $this->get_user_type(), $who, true ); | |
| 213 | + } | |
| 255 | 214 | |
| 256 | - $who = (array) $message['who']; | |
| 215 | + private function get_user_type() { | |
| 216 | + if ( ! FrmAppHelper::pro_is_installed() ) { | |
| 217 | + return 'free'; | |
| 218 | + } | |
| 257 | 219 | |
| 258 | - /** | |
| 259 | - * Allow for other special inbox cases in other add-ons. | |
| 260 | - * | |
| 261 | - * @since 6.8.1 | |
| 262 | - * | |
| 263 | - * @param bool $is_for_user | |
| 264 | - * @param array $who | |
| 265 | - * @param array $message | |
| 266 | - */ | |
| 267 | - return (bool) apply_filters( 'frm_inbox_message_is_for_user', false, $who, $message ); | |
| 220 | + return FrmAddonsController::license_type(); | |
| 268 | 221 | } |
| 269 | 222 | |
| 270 | 223 | /** |
| 271 | 224 | * @param string $key |
| @@ -285,17 +238,16 @@ | ||
| 285 | 238 | $this->update_list(); |
| 286 | 239 | } |
| 287 | 240 | |
| 288 | 241 | /** |
| 242 | + * @param string $key | |
| 243 | + * | |
| 289 | 244 | * @since 4.05.02 |
| 290 | 245 | * |
| 291 | - * @param string $key | |
| 292 | - * | |
| 293 | 246 | * @return void |
| 294 | 247 | */ |
| 295 | 248 | public function mark_unread( $key ) { |
| 296 | 249 | $is_read = isset( self::$messages[ $key ] ) && isset( self::$messages[ $key ]['read'] ) && isset( self::$messages[ $key ]['read'][ get_current_user_id() ] ); |
| 297 | - | |
| 298 | 250 | if ( $is_read ) { |
| 299 | 251 | unset( self::$messages[ $key ]['read'][ get_current_user_id() ] ); |
| 300 | 252 | $this->update_list(); |
| 301 | 253 | } |
| @@ -330,9 +282,8 @@ | ||
| 330 | 282 | * @return void |
| 331 | 283 | */ |
| 332 | 284 | private function dismiss_all() { |
| 333 | 285 | $user_id = get_current_user_id(); |
| 334 | - | |
| 335 | 286 | foreach ( self::$messages as $key => $message ) { |
| 336 | 287 | if ( ! isset( $message['dismissed'] ) ) { |
| 337 | 288 | self::$messages[ $key ]['dismissed'] = array(); |
| 338 | 289 | } |
| @@ -343,50 +294,31 @@ | ||
| 343 | 294 | } |
| 344 | 295 | $this->update_list(); |
| 345 | 296 | } |
| 346 | 297 | |
| 347 | - /** | |
| 348 | - * @return array | |
| 349 | - */ | |
| 350 | 298 | public function unread() { |
| 351 | 299 | $messages = $this->get_messages( 'filter' ); |
| 352 | 300 | $user_id = get_current_user_id(); |
| 353 | - | |
| 354 | 301 | foreach ( $messages as $t => $message ) { |
| 355 | 302 | if ( isset( $message['read'] ) && isset( $message['read'][ $user_id ] ) ) { |
| 356 | 303 | unset( $messages[ $t ] ); |
| 357 | 304 | } |
| 358 | 305 | } |
| 359 | - | |
| 360 | 306 | return $messages; |
| 361 | 307 | } |
| 362 | 308 | |
| 363 | - /** | |
| 364 | - * @since 6.8.4 The $filtered parameter was added. | |
| 365 | - * | |
| 366 | - * @param bool $filtered | |
| 367 | - * | |
| 368 | - * @return string | |
| 369 | - */ | |
| 370 | - public function unread_html( $filtered = true ) { | |
| 309 | + public function unread_html() { | |
| 310 | + $html = ''; | |
| 371 | 311 | $count = count( $this->unread() ); |
| 312 | + if ( $count ) { | |
| 313 | + $html = ' <span class="update-plugins frm_inbox_count"><span class="plugin-count">' . absint( $count ) . '</span></span>'; | |
| 372 | 314 | |
| 373 | - if ( ! $count ) { | |
| 374 | - return ''; | |
| 315 | + /** | |
| 316 | + * @since 4.06.01 | |
| 317 | + */ | |
| 318 | + $html = apply_filters( 'frm_inbox_badge', $html ); | |
| 375 | 319 | } |
| 376 | - | |
| 377 | - $html = ' <span class="update-plugins frm_inbox_count"><span class="plugin-count">' . absint( $count ) . '</span></span>'; | |
| 378 | - | |
| 379 | - if ( ! $filtered ) { | |
| 380 | - return $html; | |
| 381 | - } | |
| 382 | - | |
| 383 | - /** | |
| 384 | - * @since 4.06.01 | |
| 385 | - * | |
| 386 | - * @param string $html | |
| 387 | - */ | |
| 388 | - return (string) apply_filters( 'frm_inbox_badge', $html ); | |
| 320 | + return $html; | |
| 389 | 321 | } |
| 390 | 322 | |
| 391 | 323 | /** |
| 392 | 324 | * @since 4.05.02 |
| @@ -417,64 +349,18 @@ | ||
| 417 | 349 | public static function maybe_show_banner() { |
| 418 | 350 | if ( empty( self::$banner_messages ) ) { |
| 419 | 351 | return false; |
| 420 | 352 | } |
| 421 | - | |
| 422 | 353 | $message = end( self::$banner_messages ); |
| 423 | - $cta = self::get_prepared_banner_cta( $message['cta'] ); | |
| 424 | - | |
| 425 | 354 | require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php'; |
| 426 | 355 | return true; |
| 427 | 356 | } |
| 428 | 357 | |
| 429 | 358 | /** |
| 430 | - * Make sure that the CTA uses utm_medium=banner. | |
| 431 | - * | |
| 432 | - * @since 6.8.4 | |
| 433 | - * | |
| 434 | - * @param string $cta | |
| 435 | - * | |
| 436 | - * @return string | |
| 437 | - */ | |
| 438 | - private static function get_prepared_banner_cta( $cta ) { | |
| 439 | - $cta = str_replace( 'button-secondary', 'button-primary', $cta ); | |
| 440 | - return preg_replace_callback( | |
| 441 | - '/href=("|\')(.*?)("|\')/', | |
| 442 | - /** | |
| 443 | - * Replace a single href attribute in the CTA. | |
| 444 | - * | |
| 445 | - * @param array $matches The regex results for a single match. | |
| 446 | - * | |
| 447 | - * @return string | |
| 448 | - */ | |
| 449 | - function ( $matches ) { | |
| 450 | - $url = $matches[2]; | |
| 451 | - $parts = parse_url( $url ); | |
| 452 | - | |
| 453 | - if ( '#' === $url ) { | |
| 454 | - return 'href="#"'; | |
| 455 | - } | |
| 456 | - | |
| 457 | - $query = array(); | |
| 458 | - | |
| 459 | - if ( isset( $parts['query'] ) ) { | |
| 460 | - parse_str( $parts['query'], $query ); | |
| 461 | - } | |
| 462 | - | |
| 463 | - $query['utm_medium'] = 'banner'; | |
| 464 | - $parts['query'] = http_build_query( $query ); | |
| 465 | - return 'href="' . $parts['scheme'] . '://' . $parts['host'] . $parts['path'] . '?' . $parts['query'] . '"'; | |
| 466 | - }, | |
| 467 | - $cta | |
| 468 | - ); | |
| 469 | - } | |
| 470 | - | |
| 471 | - /** | |
| 472 | 359 | * @return void |
| 473 | 360 | */ |
| 474 | 361 | public static function maybe_disable_screen_options() { |
| 475 | 362 | self::$banner_messages = self::get_banner_messages(); |
| 476 | - | |
| 477 | 363 | if ( self::$banner_messages ) { |
| 478 | 364 | // disable screen options tab when displaying banner messages because it gets in the way of the banner. |
| 479 | 365 | add_filter( 'screen_options_show_screen', '__return_false' ); |
| 480 | 366 | } |
| @@ -480,123 +366,16 @@ | ||
| 480 | 366 | } |
| 481 | 367 | } |
| 482 | 368 | |
| 483 | 369 | /** |
| 484 | - * Get all message with a "banner" message key defined. | |
| 485 | - * | |
| 486 | 370 | * @return array |
| 487 | 371 | */ |
| 488 | 372 | private static function get_banner_messages() { |
| 489 | - return self::get_messages_with_key( 'banner' ); | |
| 490 | - } | |
| 491 | - | |
| 492 | - /** | |
| 493 | - * Get all messages with a "slidein" message key defined. | |
| 494 | - * | |
| 495 | - * @since 6.8.4 | |
| 496 | - * | |
| 497 | - * @return array | |
| 498 | - */ | |
| 499 | - private static function get_slidein_messages() { | |
| 500 | - return self::get_messages_with_key( 'slidein' ); | |
| 501 | - } | |
| 502 | - | |
| 503 | - /** | |
| 504 | - * Get all messages with a $key message key defined. | |
| 505 | - * | |
| 506 | - * @since 6.8.4 | |
| 507 | - * | |
| 508 | - * @param string $key The key we are checking for (ie. banner or slidein). | |
| 509 | - * | |
| 510 | - * @return array | |
| 511 | - */ | |
| 512 | - private static function get_messages_with_key( $key ) { | |
| 513 | 373 | $inbox = new self(); |
| 514 | 374 | return array_filter( |
| 515 | 375 | $inbox->get_messages( 'filter' ), |
| 516 | - function ( $message ) use ( $key ) { | |
| 517 | - return ! empty( $message[ $key ] ); | |
| 376 | + function( $message ) { | |
| 377 | + return ! empty( $message['banner'] ); | |
| 518 | 378 | } |
| 519 | 379 | ); |
| 520 | - } | |
| 521 | - | |
| 522 | - /** | |
| 523 | - * Check if there is at least one slidein message. | |
| 524 | - * | |
| 525 | - * @since 6.8.4 | |
| 526 | - * | |
| 527 | - * @return bool | |
| 528 | - */ | |
| 529 | - public static function has_a_slidein_message() { | |
| 530 | - return (bool) self::get_slidein_messages(); | |
| 531 | - } | |
| 532 | - | |
| 533 | - /** | |
| 534 | - * Get the array used for frmGlobal.inboxSlideIn | |
| 535 | - * | |
| 536 | - * @since 6.8.4 | |
| 537 | - * | |
| 538 | - * @return array|false | |
| 539 | - */ | |
| 540 | - public static function get_inbox_slide_in_value_for_js() { | |
| 541 | - $messages = self::get_slidein_messages(); | |
| 542 | - | |
| 543 | - if ( ! $messages ) { | |
| 544 | - return false; | |
| 545 | - } | |
| 546 | - | |
| 547 | - $message = reset( $messages ); | |
| 548 | - | |
| 549 | - /** | |
| 550 | - * Extend the keys in the global JS object. | |
| 551 | - * This is used in Pro to include images. | |
| 552 | - * | |
| 553 | - * @since 6.8.4 | |
| 554 | - * | |
| 555 | - * @param array $keys | |
| 556 | - */ | |
| 557 | - $keys_to_return = apply_filters( | |
| 558 | - 'frm_inbox_slidein_js_vars', | |
| 559 | - array( 'key', 'slidein', 'subject', 'cta' ) | |
| 560 | - ); | |
| 561 | - | |
| 562 | - return array_reduce( | |
| 563 | - $keys_to_return, | |
| 564 | - function ( $total, $key ) use ( $message ) { | |
| 565 | - $total[ $key ] = $message[ $key ] ?? ''; | |
| 566 | - return $total; | |
| 567 | - }, | |
| 568 | - array() | |
| 569 | - ); | |
| 570 | - } | |
| 571 | - | |
| 572 | - /** | |
| 573 | - * Clear the inbox cache by deleting the associated option from the database. | |
| 574 | - * | |
| 575 | - * @since 6.17 | |
| 576 | - * | |
| 577 | - * @return void | |
| 578 | - */ | |
| 579 | - public static function clear_cache() { | |
| 580 | - delete_option( 'frm_inbox' ); | |
| 581 | - } | |
| 582 | - | |
| 583 | - /** | |
| 584 | - * Check inbox for an "error" type. This is displayed on the form list page if one exists. | |
| 585 | - * | |
| 586 | - * @since 6.19 | |
| 587 | - * | |
| 588 | - * @return array|false | |
| 589 | - */ | |
| 590 | - public static function check_for_error() { | |
| 591 | - $inbox = new self(); | |
| 592 | - $messages = $inbox->get_messages( 'filter' ); | |
| 593 | - | |
| 594 | - foreach ( $messages as $message ) { | |
| 595 | - if ( is_array( $message ) && isset( $message['type'] ) && 'error' === $message['type'] ) { | |
| 596 | - return $message; | |
| 597 | - } | |
| 598 | - } | |
| 599 | - | |
| 600 | - return false; | |
| 601 | 380 | } |
| 602 | 381 | } |
