BP_REST_Group_Messages_Endpoint
Group Messages endpoints.
Description
Source
File: bp-messages/classes/class-bp-rest-group-messages-endpoint.php
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 | class BP_REST_Group_Messages_Endpoint extends WP_REST_Controller { /** * Reuse some parts of the BP_REST_Messages_Endpoint class. * * @since 0.1.0 * * @var BP_REST_Messages_Endpoint */ protected $message_endppoint; /** * Constructor. * * @since 0.1.0 */ public function __construct() { $this->namespace = bp_rest_namespace() . '/' . bp_rest_version(); $this->rest_base = buddypress()->messages->id; $this->message_endppoint = new BP_REST_Messages_Endpoint(); } /** * Register the component routes. * * @since 0.1.0 */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base . '/group', array( array( 'methods' => WP_REST_Server::CREATABLE, 'callback' => array( $this, 'create_item' ), 'permission_callback' => array( $this, 'create_item_permissions_check' ), 'args' => $this->get_collection_params(), ), 'schema' => array( $this, 'get_item_schema' ), ) ); } /** * Init a Messages Thread or add a reply to an existing Thread. * -- from bp_nouveau_ajax_groups_send_message(); * * @param WP_REST_Request $request Full details about the request. * * @return WP_REST_Response | WP_Error * @since 0.1.0 * * @api {POST} /wp-json/buddyboss/v1/messages/group Create Group Thread * @apiName CreateBBGroupThread * @apiGroup Messages * @apiDescription Create Group thread * @apiVersion 1.0.0 * @apiPermission LoggedInUser * @apiParam {String} message Content of the Message to add to the Thread. * @apiParam {Number} group_id A unique numeric ID for the Group. * @apiParam {Number} user_id Limit result to messages created by a specific user. * @apiParam {String=open,private} type=open Type of message, Group thread or private reply. * @apiParam {String=all,individual} users=all Group thread users individual or all. * @apiParam {Array} [users_list] Limit result to messages created by a specific user. */ public function create_item( $request ) { global $wpdb, $bp; $group = ( isset( $request['group_id'] ) && ! empty( $request['group_id'] ) ) ? $request['group_id'] : ''; $message = ( isset( $request['message'] ) && ! empty( $request['message'] ) ) ? $request['message'] : ''; $users_list = ( isset( $request['users_list'] ) && ! empty( $request['users_list'] ) ) ? $request['users_list'] : ''; $message_users = ( isset( $request['users'] ) && ! empty( $request['users'] ) ) ? $request['users'] : ''; $message_type = ( isset( $request['type'] ) && ! empty( $request['type'] ) ) ? $request['type'] : ''; // verification for phpcs. wp_verify_nonce( wp_create_nonce( 'group_messages' ), 'group_messages' ); // Get Members list if "All Group Members" selected. if ( 'all' === $message_users ) { // Fetch all the group members. $args = array( 'per_page' => 9999999999999999999, 'group_id' => $group, 'exclude' => array( bp_loggedin_user_id() ), 'exclude_admins_mods' => false, ); $group_members = groups_get_group_members( $args ); $members = wp_list_pluck( $group_members['members'], 'ID' ); // We get members array from $_POST['users_list'] because user already selected them. } else { $members = $users_list; } if ( empty( $group ) ) { return new WP_Error( 'bp_rest_no_group_selected', __( 'Sorry, Group id is missing.', 'buddyboss' ), array( 'status' => 400, ) ); } if ( empty( $members ) ) { return new WP_Error( 'bp_rest_no_members_selected', __( 'Sorry, you have not selected any members.', 'buddyboss' ), array( 'status' => 400, ) ); } $_POST = array(); $_POST['users'] = $message_users; $_POST['type'] = $message_type; $_POST['content'] = $message; $_POST['group'] = $group; // If "Group Thread" selected. if ( 'open' === $message_type ) { // "All Group Members" selected. if ( 'all' === $message_users ) { // Comma separated members list to find in meta query. $message_users_ids = implode( ',', $members ); // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "message_users_ids". $_POST['message_meta_users_list'] = $message_users_ids; $group_thread = groups_get_groupmeta( (int) $group, 'group_message_thread' ); $is_deleted = false; $group_thread_id = ''; $_POST['message_thread_type'] = ''; if ( '' !== $group_thread ) { // phpcs:ignore $total_threads = $wpdb->get_results( $wpdb->prepare( "SELECT is_deleted FROM {$bp->messages->table_name_recipients} WHERE thread_id = %d", (int) $group_thread ) ); // db call ok; no-cache ok; foreach ( $total_threads as $thread ) { if ( 1 === (int) $thread->is_deleted ) { $is_deleted = true; break; } } if ( $is_deleted || empty( $total_threads ) ) { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } if ( '' !== $group_thread && ! $is_deleted && isset( $_POST['message_thread_type'] ) && empty( $_POST['message_thread_type'] ) ) { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; $group_thread_id = $group_thread; } else { // Backward compatibility when we dont store thread_id in group meta. $meta = array( array( 'key' => 'group_id', 'value' => $group, 'compare' => '=', ), array( 'key' => 'group_message_users', 'value' => 'all', 'compare' => '=', ), array( 'key' => 'group_message_type', 'value' => 'open', 'compare' => '=', ), array( 'key' => 'message_users_ids', 'value' => $message_users_ids, ), ); // Check if there is already previously group thread created. if ( bp_has_message_threads( array( 'meta_query' => $meta ) // phpcs:ignore ) ) { $thread_id = 0; while ( bp_message_threads() ) { bp_message_thread(); $thread_id = bp_get_message_thread_id(); if ( $thread_id ) { break; } } // If $thread_id found then add as a reply to that thread. if ( $thread_id ) { $group_thread_id = $thread_id; // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; // Create a new group thread. } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } // Create a new group thread. } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } /** * Create Message based on the `message_thread_type` and `group_thread_id`. */ if ( isset( $_POST['message_thread_type'] ) && 'new' === $_POST['message_thread_type'] ) { $send = $this->bp_rest_groups_messages_new_message( array( 'recipients' => $members, 'subject' => wp_trim_words( $message, messages_get_default_subject_length() ), 'content' => $message, 'error_type' => 'wp_error', 'append_thread' => false, ) ); if ( ! is_wp_error( $send ) && ! empty( $send ) ) { groups_update_groupmeta( (int) $group, 'group_message_thread', $send ); } return $this->bp_rest_groups_messages_validate_message( $send, $request ); } elseif ( isset( $_POST['message_thread_type'] ) && 'reply' === $_POST['message_thread_type'] && ! empty( $group_thread_id ) ) { groups_update_groupmeta( (int) $group, 'group_message_thread', $group_thread_id ); $new_reply = $this->bp_rest_groups_messages_new_message( array( 'thread_id' => $group_thread_id, 'subject' => ! empty( $message ) ? $message : ' ', 'content' => ! empty( $message ) ? $message : ' ', 'date_sent' => bp_core_current_time(), 'mark_visible' => true, 'error_type' => 'wp_error', ) ); return $this->bp_rest_groups_messages_validate_message( $new_reply, $request ); } // "Individual Members" Selected. } else { $meta = array( array( 'key' => 'group_message_type', 'value' => 'open', 'compare' => '!=', ), ); $individual_thread_id = 0; $_POST['message_thread_type'] = ''; // Check if there is already previously individual group thread created. if ( bp_has_message_threads( array( 'meta_query' => $meta ) ) ) { // phpcs:ignore $thread_id = 0; while ( bp_message_threads() ) { bp_message_thread(); $thread_id = bp_get_message_thread_id(); if ( $thread_id ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); $current_recipients = $members; $members_recipients = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members_recipients[] = (int) $single_recipients; } // check both previous and current recipients are same. $is_recipient_match = ( is_array( $previous_thread_recipients ) && is_array( $members_recipients ) && count( $previous_thread_recipients ) === count( $members_recipients ) && array_diff( $previous_thread_recipients, $members_recipients ) === array_diff( $members_recipients, $previous_thread_recipients ) ); $group_thread = (int) groups_get_groupmeta( (int) $group, 'group_message_thread' ); // If recipients are matched. if ( $is_recipient_match && (int) $thread_id !== $group_thread ) { break; } } } // If $thread_id found then add as a reply to that thread. if ( $thread_id ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); $last_message = BP_Messages_Thread::get_last_message( $thread_id ); $message_type = bp_messages_get_meta( $last_message->id, 'group_message_users', true ); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); $current_recipients = $members; $members_recipients = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members_recipients[] = (int) $single_recipients; } // check both previous and current recipients are same. $is_recipient_match = ( is_array( $previous_thread_recipients ) && is_array( $members_recipients ) && count( $previous_thread_recipients ) === count( $members_recipients ) && array_diff( $previous_thread_recipients, $members_recipients ) === array_diff( $members_recipients, $previous_thread_recipients ) ); $group_thread = (int) groups_get_groupmeta( (int) $group, 'group_message_thread' ); // If recipients are matched. if ( $is_recipient_match && (int) $thread_id !== $group_thread ) { $individual_thread_id = $thread_id; // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; // Else recipients not matched. } else { $previous_threads = BP_Messages_Message::get_existing_threads( $members, bp_loggedin_user_id() ); $existing_thread = 0; if ( $previous_threads ) { foreach ( $previous_threads as $thread ) { $is_active_recipient = BP_Messages_Thread::is_thread_recipient( $thread->thread_id, bp_loggedin_user_id() ); if ( $is_active_recipient ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread->thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); $current_recipients = $members; $members = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members[] = (int) $single_recipients; } // check both previous and current recipients are same. $is_recipient_match = ( is_array( $previous_thread_recipients ) && is_array( $members ) && count( $previous_thread_recipients ) === count( $members ) && array_diff( $previous_thread_recipients, $members ) === array_diff( $members, $previous_thread_recipients ) ); // check any messages of this thread should not be a open & all. $message_ids = wp_list_pluck( $thread->messages, 'id' ); $add_existing = true; foreach ( $message_ids as $id ) { // group_message_users not open. $message_users = bp_messages_get_meta( $id, 'group_message_users', true ); // all - individual. if ( 'all' === $message_users ) { $add_existing = false; break; } } // If recipients are matched. if ( $is_recipient_match && $add_existing ) { $existing_thread = (int) $thread->thread_id; } } } if ( $existing_thread > 0 ) { $individual_thread_id = $existing_thread; // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } // Else no thread found. } else { $previous_threads = BP_Messages_Message::get_existing_threads( $members, bp_loggedin_user_id() ); $existing_thread = 0; if ( $previous_threads ) { foreach ( $previous_threads as $thread ) { $is_active_recipient = BP_Messages_Thread::is_thread_recipient( $thread->thread_id, bp_loggedin_user_id() ); if ( $is_active_recipient ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread->thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); $current_recipients = $members; $members = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members[] = (int) $single_recipients; } // check both previous and current recipients are same. $is_recipient_match = ( is_array( $previous_thread_recipients ) && is_array( $members ) && count( $previous_thread_recipients ) === count( $members ) && array_diff( $previous_thread_recipients, $members ) === array_diff( $members, $previous_thread_recipients ) ); // check any messages of this thread should not be a open & all. $message_ids = wp_list_pluck( $thread->messages, 'id' ); $add_existing = true; foreach ( $message_ids as $id ) { // group_message_users not open. $message_users = bp_messages_get_meta( $id, 'group_message_users', true ); // all - individual. if ( 'all' === $message_users ) { $add_existing = false; break; } } // If recipients are matched. if ( $is_recipient_match && $add_existing ) { $existing_thread = (int) $thread->thread_id; } } } if ( $existing_thread > 0 ) { $individual_thread_id = $existing_thread; // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } // Else no previous thread found. } else { $previous_threads = BP_Messages_Message::get_existing_threads( $members, bp_loggedin_user_id() ); $existing_thread = 0; if ( $previous_threads ) { foreach ( $previous_threads as $thread ) { $is_active_recipient = BP_Messages_Thread::is_thread_recipient( $thread->thread_id, bp_loggedin_user_id() ); if ( $is_active_recipient ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread->thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); $current_recipients = $members; $members = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members[] = (int) $single_recipients; } // check both previous and current recipients are same. $is_recipient_match = ( is_array( $previous_thread_recipients ) && is_array( $members ) && count( $previous_thread_recipients ) === count( $members ) && array_diff( $previous_thread_recipients, $members ) === array_diff( $members, $previous_thread_recipients ) ); // check any messages of this thread should not be a open & all. $message_ids = wp_list_pluck( $thread->messages, 'id' ); $add_existing = true; foreach ( $message_ids as $id ) { // group_message_users not open. $message_users = bp_messages_get_meta( $id, 'group_message_users', true ); // all - individual. if ( 'all' === $message_users ) { $add_existing = false; break; } } // If recipients are matched. if ( $is_recipient_match && $add_existing ) { $existing_thread = (int) $thread->thread_id; } } } if ( $existing_thread > 0 ) { $individual_thread_id = $existing_thread; // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } /** * Create Message based on the `message_thread_type` and `individual_thread_id`. */ if ( isset( $_POST['message_thread_type'] ) && 'new' === $_POST['message_thread_type'] ) { $send = $this->bp_rest_groups_messages_new_message( array( 'recipients' => $members, 'subject' => wp_trim_words( $message, messages_get_default_subject_length() ), 'content' => $message, 'error_type' => 'wp_error', 'append_thread' => false, ) ); return $this->bp_rest_groups_messages_validate_message( $send, $request, 'individual' ); } elseif ( isset( $_POST['message_thread_type'] ) && 'reply' === $_POST['message_thread_type'] && ! empty( $individual_thread_id ) ) { $new_reply = $this->bp_rest_groups_messages_new_message( array( 'thread_id' => $individual_thread_id, 'subject' => ! empty( $message ) ? $message : ' ', 'content' => ! empty( $message ) ? $message : ' ', 'date_sent' => bp_core_current_time(), 'mark_visible' => true, 'error_type' => 'wp_error', ) ); return $this->bp_rest_groups_messages_validate_message( $new_reply, $request, 'individual' ); } } // Else "Private Reply (BCC)" selected. } else { $all_members = $members; $messages_all = array(); // We have to send Message to all members to "Individual" message in both cases like "All Group Members" OR "Individual Members" selected. foreach ( $members as $member ) { $meta = array( array( 'key' => 'group_message_type', 'value' => 'open', 'compare' => '!=', ), ); $thread_loop_message_member = $member; $thread_loop_message_sent = false; // Find existing thread which are private. if ( bp_has_message_threads( array( 'meta_query' => $meta ) ) ) { // phpcs:ignore $thread_id = 0; $member_thread_id = 0; while ( bp_message_threads() ) { bp_message_thread(); $thread_id = bp_get_message_thread_id(); if ( $thread_id ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); $current_recipients[] = $thread_loop_message_member; $member_arr = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $member_arr[] = (int) $single_recipients; } $first_message = BP_Messages_Thread::get_first_message( $thread_id ); $message_user = bp_messages_get_meta( $first_message->id, 'group_message_users', true ); $message_type = bp_messages_get_meta( $first_message->id, 'group_message_type', true ); // open - private. // check both previous and current recipients are same. $is_recipient_match = ( $previous_thread_recipients === $member_arr ); // If recipients are matched. if ( $is_recipient_match && 'all' !== $message_user ) { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; $member_thread_id = $thread_id; $thread_loop_message_sent = true; // If recipients then break the loop and go ahead because we don't need to check other threads. break; } elseif ( $is_recipient_match && 'all' === $message_user && 'open' !== $message_type ) { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; $member_thread_id = $thread_id; $thread_loop_message_sent = true; // If recipients then break the loop and go ahead because we don't need to check other threads. break; } } } // If there is no any thread matched. if ( false === $thread_loop_message_sent ) { $member_check = array(); $member_check[] = $member; $member_check[] = bp_loggedin_user_id(); $previous_threads = BP_Messages_Message::get_existing_threads( $member_check, bp_loggedin_user_id() ); $existing_thread = 0; if ( $previous_threads ) { foreach ( $previous_threads as $thread ) { $is_active_recipient = BP_Messages_Thread::is_thread_recipient( $thread->thread_id, bp_loggedin_user_id() ); if ( $is_active_recipient ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread->thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); if ( is_array( $member ) ) { $current_recipients = $member; } else { $current_recipients[] = $member; } $members = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members[] = (int) $single_recipients; } $first_message = BP_Messages_Thread::get_first_message( $thread->thread_id ); $message_user = bp_messages_get_meta( $first_message->id, 'group_message_users', true ); $message_type = bp_messages_get_meta( $first_message->id, 'group_message_type', true ); // open - private. // check both previous and current recipients are same. $is_recipient_match = ( $previous_thread_recipients === $members ); // If recipients are matched. if ( $is_recipient_match && 'all' !== $message_user ) { $existing_thread = (int) $thread->thread_id; } elseif ( $is_recipient_match && 'all' === $message_user && 'open' !== $message_type ) { $existing_thread = (int) $thread->thread_id; } } } if ( $existing_thread > 0 ) { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; $member_thread_id = $existing_thread; } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } /** * Create Message based on the `message_thread_type` and `member_thread_id`. */ if ( isset( $_POST['message_thread_type'] ) && 'new' === $_POST['message_thread_type'] ) { $messages_all[] = $this->bp_rest_groups_messages_new_message( array( 'recipients' => $member, 'subject' => wp_trim_words( $message, messages_get_default_subject_length() ), 'content' => $message, 'error_type' => 'wp_error', 'is_hidden' => true, 'append_thread' => false, ) ); } elseif ( isset( $_POST['message_thread_type'] ) && 'reply' === $_POST['message_thread_type'] && ! empty( $member_thread_id ) ) { $messages_all[] = $this->bp_rest_groups_messages_new_message( array( 'thread_id' => $member_thread_id, 'subject' => ! empty( $message ) ? $message : ' ', 'content' => ! empty( $message ) ? $message : ' ', 'date_sent' => bp_core_current_time(), 'mark_visible' => true, 'error_type' => 'wp_error', ) ); } // If no existing private thread found. } else { $member_check = array(); $member_check[] = $member; $member_check[] = bp_loggedin_user_id(); $previous_threads = BP_Messages_Message::get_existing_threads( $member_check, bp_loggedin_user_id() ); $existing_thread = 0; $member_thread_id = 0; if ( $previous_threads ) { foreach ( $previous_threads as $thread ) { $is_active_recipient = BP_Messages_Thread::is_thread_recipient( $thread->thread_id, bp_loggedin_user_id() ); if ( $is_active_recipient ) { // get the thread recipients. $thread = new BP_Messages_Thread( $thread->thread_id ); $thread_recipients = $thread->get_recipients(); $previous_thread_recipients = array(); // Store thread recipients to $previous_ids array. foreach ( $thread_recipients as $thread_recipient ) { if ( bp_loggedin_user_id() !== $thread_recipient->user_id ) { $previous_thread_recipients[] = $thread_recipient->user_id; } } $current_recipients = array(); if ( is_array( $member ) ) { $current_recipients = $member; } else { $current_recipients[] = $member; } $members = array(); // Store current recipients to $members array. foreach ( $current_recipients as $single_recipients ) { $members[] = (int) $single_recipients; } $first_message = BP_Messages_Thread::get_first_message( $thread->thread_id ); $message_user = bp_messages_get_meta( $first_message->id, 'group_message_users', true ); $message_type = bp_messages_get_meta( $first_message->id, 'group_message_type', true ); // open - private. // check both previous and current recipients are same. $is_recipient_match = ( $previous_thread_recipients === $members ); // If recipients are matched. if ( $is_recipient_match && 'all' !== $message_user ) { $existing_thread = (int) $thread->thread_id; } elseif ( $is_recipient_match && 'all' === $message_user && 'open' !== $message_type ) { $existing_thread = (int) $thread->thread_id; } } } if ( $existing_thread > 0 ) { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'reply'; $member_thread_id = $existing_thread; } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } } else { // This post variable will using in "bp_media_messages_save_group_data" function for storing message meta "group_message_thread_type". $_POST['message_thread_type'] = 'new'; } /** * Create Message based on the `message_thread_type` and `member_thread_id`. */ if ( isset( $_POST['message_thread_type'] ) && 'new' === $_POST['message_thread_type'] ) { $messages_all[] = $this->bp_rest_groups_messages_new_message( array( 'recipients' => $member, 'subject' => wp_trim_words( $message, messages_get_default_subject_length() ), 'content' => $message, 'error_type' => 'wp_error', 'is_hidden' => true, 'append_thread' => false, ) ); } elseif ( isset( $_POST['message_thread_type'] ) && 'reply' === $_POST['message_thread_type'] && ! empty( $member_thread_id ) ) { $messages_all[] = $this->bp_rest_groups_messages_new_message( array( 'thread_id' => $member_thread_id, 'subject' => ! empty( $message ) ? $message : ' ', 'content' => ! empty( $message ) ? $message : ' ', 'date_sent' => $date_sent = bp_core_current_time(), 'mark_visible' => true, 'error_type' => 'wp_error', ) ); } } } $error = array(); $retval = array( 'message' => '', 'errors' => array(), 'data' => array(), ); if ( 'all' !== $message_users ) { $retval['message'] = sprintf( /* translators: Message member count. */ __( 'Your message was sent privately to %s members of this group.', 'buddyboss' ), count( $all_members ) ); } else { $retval['message'] = __( 'Your message was sent privately to all members of this group.', 'buddyboss' ); } if ( ! empty( $messages_all ) ) { foreach ( $messages_all as $message ) { if ( is_wp_error( $message ) ) { $error[] = $message->get_error_message(); } else { $thread = new BP_Messages_Thread( (int) $message ); $last_message = wp_list_filter( $thread->messages, array( 'id' => $thread->last_message_id ) ); $last_message = reset( $last_message ); $fields_update = $this->update_additional_fields_for_object( $last_message, $request ); if ( is_wp_error( $fields_update ) ) { $error[] = $fields_update; } $retval['data'][] = $this->prepare_response_for_collection( $this->message_endppoint->prepare_item_for_response( $thread, $request ) ); } } } if ( ! empty( $error ) ) { $retval['errors'] = $error; } $response = rest_ensure_response( $retval ); /** * Fires after a thread is fetched via the REST API. * * @param BP_Messages_Box_Template $messages_box Fetched thread. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ do_action( 'bp_rest_group_messages_create_items', $message, $response, $request ); return $response; } } /** * Check if a given request has access to create a message. * * @param WP_REST_Request $request Full details about the request. * * @return WP_Error|bool * @since 0.1.0 */ public function create_item_permissions_check( $request ) { $retval = true; if ( ! is_user_logged_in() ) { $retval = new WP_Error( 'bp_rest_authorization_required', __( 'Sorry, you need to be logged in to create a group message.', 'buddyboss' ), array( 'status' => rest_authorization_required_code(), ) ); } if ( true === $retval && function_exists( 'bp_disable_group_messages' ) && false === bp_disable_group_messages() ) { $retval = new WP_Error( 'bp_rest_authorization_required', __( 'Sorry, you are not allowed to create a group message.', 'buddyboss' ), array( 'status' => rest_authorization_required_code(), ) ); } /** * Filter the messages `create_item` permissions check. * * @param bool|WP_Error $retval Returned value. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ return apply_filters( 'bp_rest_messages_group_create_item_permissions_check', $retval, $request ); } /** * Get the message schema, conforming to JSON Schema. * * @return array * @since 0.1.0 */ public function get_item_schema() { $schema = array( 'title' => 'bp_messages', 'type' => 'object', 'properties' => array( 'message' => array( 'context' => array( 'view', 'edit' ), 'description' => __( 'Information for the user.', 'buddyboss' ), 'type' => 'string', ), 'data' => array( 'context' => array( 'view', 'edit' ), 'description' => __( 'Message thread', 'buddyboss' ), 'readonly' => true, 'type' => 'object', 'properties' => array(), ), ), ); $schema['properties']['data']['properties'] = $this->message_endppoint->get_item_schema()['properties']; /** * Filters the message schema. * * @param array $schema The endpoint schema. * * @since 0.1.0 */ return apply_filters( 'bp_rest_message_schema', $this->add_additional_fields_schema( $schema ) ); } /** * Get the query params for Messages collections. * * @return array * @since 0.1.0 */ public function get_collection_params() { $params = parent::get_collection_params(); $params['context']['default'] = 'edit'; unset( $params['page'], $params['per_page'], $params['search'] ); $params['group_id'] = array( 'description' => __( 'A unique numeric ID for the Group.', 'buddyboss' ), 'type' => 'integer', 'required' => true, 'sanitize_callback' => 'absint', 'validate_callback' => 'rest_validate_request_arg', ); $params['message'] = array( 'description' => __( 'Content of the Message to add to the Thread.', 'buddyboss' ), 'type' => 'string', 'required' => true, 'validate_callback' => 'rest_validate_request_arg', ); $params['users'] = array( 'description' => __( 'Group thread users individual or all.', 'buddyboss' ), 'type' => 'string', 'required' => true, 'enum' => array( 'all', 'individual' ), 'validate_callback' => 'rest_validate_request_arg', ); $params['users_list'] = array( 'description' => __( 'Limit result to messages created by a specific user.', 'buddyboss' ), 'type' => 'array', 'items' => array( 'type' => 'integer' ), 'sanitize_callback' => 'bp_rest_sanitize_string_list', 'validate_callback' => 'rest_validate_request_arg', ); $params['type'] = array( 'description' => __( 'Type of message, Group thread or private reply.', 'buddyboss' ), 'type' => 'string', 'required' => true, 'enum' => array( 'open', 'private' ), 'validate_callback' => 'rest_validate_request_arg', ); /** * Filters the collection query params. * * @param array $params Query params. */ return apply_filters( 'bp_rest_messages_group_collection_params', $params ); } /** * Create New Group Message. * -- from bp_groups_messages_new_message(); * * @param array|string $args { * Array of arguments. * * @type int $sender_id Optional. ID of the user who is sending the * message. Default: ID of the logged-in user. * @type int $thread_id Optional. ID of the parent thread. Leave blank to * create a new thread for the message. * @type array $recipients IDs or usernames of message recipients. If this * is an existing thread, it is unnecessary to pass a $recipients * argument - existing thread recipients will be assumed. * @type string $subject Optional. Subject line for the message. For * existing threads, the existing subject will be used. For new * threads, 'No Subject' will be used if no $subject is provided. * @type string $content Content of the message. Cannot be empty. * @type string $date_sent Date sent, in 'Y-m-d H:i:s' format. Default: current date/time. * @type bool $is_hidden Optional. Whether to hide the thread from sender messages inbox or not. Default: false. * @type bool $mark_visible Optional. Whether to mark thread visible to all other participants. Default: false. * @type string $error_type Optional. Error type. Either 'bool' or 'wp_error'. Default: 'bool'. * } * * @return int|bool|WP_Error ID of the message thread on success, false on failure. */ public function bp_rest_groups_messages_new_message( $args = '' ) { $send = ''; remove_action( 'messages_message_sent', 'messages_notification_new_message', 10 ); add_action( 'messages_message_sent', 'group_messages_notification_new_message', 10 ); $r = bp_parse_args( $args, array( 'sender_id' => bp_loggedin_user_id(), 'thread_id' => false, // False for a new message, thread id for a reply to a thread. 'recipients' => array(), // Can be an array of usernames, user_ids or mixed. 'subject' => false, 'content' => false, 'date_sent' => bp_core_current_time(), 'append_thread' => false, 'is_hidden' => false, 'mark_visible' => false, 'group_thread' => true, 'error_type' => 'wp_error', ), 'bp_groups_messages_new_message' ); // Attempt to send the message. $send = messages_new_message( $r ); remove_action( 'messages_message_sent', 'group_messages_notification_new_message', 10 ); add_action( 'messages_message_sent', 'messages_notification_new_message', 10 ); return $send; } /** * Check group message has been successfully sent or not. * - bp_groups_messages_validate_message(); * * @param mixed $send int|bool|WP_Error. * @param WP_REST_Request $request Rest request. * @param string $type Type of the message `all` or `individual`. * * @return WP_Error */ public function bp_rest_groups_messages_validate_message( $send, $request, $type = 'all' ) { if ( is_wp_error( $send ) ) { return new WP_Error( 'bp_rest_unknown_error', $send->get_error_message(), array( 'status' => rest_authorization_required_code(), ) ); } elseif ( ! empty( $send ) ) { $thread = new BP_Messages_Thread( (int) $send ); $recipients_count = ( count( $thread->recipients ) > 1 ? count( $thread->recipients ) - ( isset( $request['user_id'] ) && ! empty( $request['user_id'] ) ? 1 : 0 ) : 0 ); if ( 'individual' === $type ) { $retval['message'] = sprintf( /* translators: Message member count. */ __( 'Your message was sent to %s members of this group.', 'buddyboss' ), $recipients_count ); } else { $retval['message'] = __( 'Your message was sent to all members of this group.', 'buddyboss' ); } $last_message = wp_list_filter( $thread->messages, array( 'id' => $thread->last_message_id ) ); $last_message = reset( $last_message ); $fields_update = $this->update_additional_fields_for_object( $last_message, $request ); if ( is_wp_error( $fields_update ) ) { return $fields_update; } $retval['data'] = $this->prepare_response_for_collection( $this->message_endppoint->prepare_item_for_response( $thread, $request ) ); $response = rest_ensure_response( $retval ); /** * Fires after a thread is fetched via the REST API. * * @param BP_Messages_Box_Template $messages_box Fetched thread. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ do_action( 'bp_rest_group_messages_create_items', $thread, $response, $request ); return $response; } }} |
Changelog
| Version | Description |
|---|---|
| 0.1.0 | Introduced. |
Methods
- __construct — Constructor.
- bp_rest_groups_messages_new_message — Create New Group Message.
- bp_rest_groups_messages_validate_message — Check group message has been successfully sent or not.
- create_item — Init a Messages Thread or add a reply to an existing Thread.
- create_item_permissions_check — Check if a given request has access to create a message.
- get_collection_params — Get the query params for Messages collections.
- get_item_schema — Get the message schema, conforming to JSON Schema.
- register_routes — Register the component routes.
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.