Ticket #6712: 6712.04.patch

new file src/bp-notifications/bp-notifications-settings.php

@@ +1 @@
+<?php
+/**
+ * BuddyPress Notifications Settings.
+ *
+ * Functions and hooks related to the Settings component.
+ *
+ * @package BuddyPress
+ * @since 2.7.0
+ */
+
+/** REGISTRATION *********************************************************/
+
+/**
+ * Register our screen notification type with the Settings component.
+ *
+ * @since 2.7.0
+ */
+function bp_notifications_register_notification_settings_type() {
+        bp_settings_register_notification_type( 'screen', array(
+                'label'         => esc_html__( 'Screen', 'buddypress' ),
+                'post_variable' => 'screen'
+        ) );
+}
+add_action( 'bp_setup_globals', 'bp_notifications_register_notification_settings_type' );
+
+/** HOOKS ****************************************************************/
+
+/**
+ * Block screen notification if a user has disabled it from their settings page.
+ *
+ * @since 2.7.0
+ *
+ * @param BP_Notification_Notification $n
+ */
+function bp_notifications_block_screen_notifications_for_user_hook( $n ) {
+        $disabled = bp_get_user_meta( $n->user_id, 'screen_notifications_disabled', true );
+
+        $component_action = $n->component_action;
+
+        // Edge cases - the following actions are shared.
+        if ( 'member_promoted_to_admin' === $component_action ) {
+                $component_action = 'member_promoted_to_mod';
+        } elseif ( 'membership_request_accepted' === $component_action ) {
+                $component_action = 'membership_request_rejected';
+        }
+
+        // Block notification from being recorded by wiping out the component name.
+        if ( isset( $disabled[ $component_action ] ) ) {
+                $n->component_name = '';
+        }
+}
+add_action( 'bp_notification_before_save', 'bp_notifications_block_screen_notifications_for_user_hook' );
+
+/** SCREEN ***************************************************************/
+
+/**
+ * Revamp the "Settings > Notifications" page to use a checkbox interface.
+ *
+ * @since 2.7.0
+ */
+function bp_notifications_new_checkbox_interface() {
+        if ( ! did_action( 'bp_before_member_settings_template' ) ) {
+                return;
+        }
+
+        add_action( 'bp_notification_settings', 'bp_notifications_new_checkbox_interface_end_buffer', 99999999 );
+
+        ob_start();
+}
+add_action( 'bp_notification_settings', 'bp_notifications_new_checkbox_interface', -99999999 );
+
+/**
+ * Umm... this is madness! Proof of concept. Not commit-worthy.
+ *
+ * @since 2.7.0
+ */
+function bp_notifications_new_checkbox_interface_end_buffer() {
+        $html = ob_get_contents();
+        ob_end_clean();
+
+        $notification_types = bp_settings_get_notification_types();
+        if ( empty( $notification_types ) ) {
+                return;
+        }
+
+        $options = array();
+
+        libxml_use_internal_errors( false );
+        $dom = new DOMDocument();
+        $dom->loadHTML( $html );
+
+        // Loop through each notification group.
+        foreach ( $dom->getElementsByTagName('tbody') as $node ) {
+                $option = '';
+
+                $group_title = $node->parentNode->childNodes->item(0)->childNodes->item(0)->childNodes->item(2)->nodeValue;
+                $key         = sanitize_title( $group_title );
+
+                $options[ $key ] = array(
+                        'title' => $group_title
+                );
+
+                $options[ $key ][ 'options' ] = array();
+
+                // Loop through the <tr>'s to grab the options for each group.
+                foreach ( $node->childNodes as $item ) {
+                        if ( $item->childNodes->item(4) ) {
+                                $option = $item->childNodes->item(4)->firstChild->attributes->getNamedItem( 'name' )->value;
+                                $option = str_replace( 'notifications[', '', $option );
+                                $option = str_replace( ']', '', $option );
+        
+
+                        }
+
+                        // Option description.
+                        if ( $item->childNodes->item(2) && ! empty( $option ) ) {
+                                $options[ $key ][ 'options' ][ $option ] = $item->childNodes->item(2)->textContent;
+                        }
+
+                }
+            
+        }
+
+        unset( $dom );
+
+        foreach( $options as $group_key => $group ) {
+                if ( empty( $group['options'] ) ) {
+                        continue;
+                }
+
+        ?>
+
+        <fieldset>
+        <legend><?php esc_html_e( $group['title'] ); ?></legend>
+
+                <?php foreach ( $group['options'] as $key => $desc ) : ?>
+                        <p id="<?php esc_attr_e( $key ); ?>"><?php esc_html_e( $desc ); ?></p>
+
+                        <?php
+                                foreach ( $notification_types as $ntype => $nargs ) :
+                                        $metakey = bp_settings_get_metakey_for_notification_type( $key, $ntype );
+                                        if ( '' === $metakey ) {
+                                                continue;
+                                        }
+
+                                        $setting = bp_settings_get_notification_user_setting( 0, $metakey, $ntype );
+                        ?>
+
+                                <label for="<?php printf( '%1$s-%2$s', $ntype, $metakey ); ?>" aria-describedby="<?php esc_attr_e( $key ); ?>">
+                                        <input name="<?php printf( '%1$s[%2$s]', bp_settings_get_notification_type( $ntype )->post_variable, esc_attr( $metakey ) ); ?>" id="<?php printf( '%1$s-%2$s', $ntype, $metakey ); ?>" value="yes" <?php checked( $setting, 'yes', true ); ?> type="checkbox">
+                                <?php esc_html_e( bp_settings_get_notification_type( $ntype )->label ); ?></label>
+
+                        <?php endforeach; ?>
+
+                <?php endforeach; ?>
+
+        </fieldset>
+
+        <?php
+        }
+}
+
+/**
+ * Saves custom user settings for our notification type.
+ *
+ * @since 2.7.0
+ */
+function bp_notifications_save_screen_notification_settings() {
+        $ntype = bp_settings_get_notification_type( 'screen' );
+        if ( false === $ntype || empty( $_POST[ $ntype->post_variable ] ) ) {
+                return;
+        }
+
+        $removed = array_diff_key( bp_notifications_get_mapped_notification_actions(), $_POST[ $ntype->post_variable ] );
+
+        // Edge cases - These options are shared with other email options.
+        unset( $removed['member_promoted_to_admin'], $removed[ 'membership_request_accepted' ] );
+
+        // We only save disabled screen notification data.
+        bp_update_user_meta( bp_displayed_user_id(), 'screen_notifications_disabled', array_fill_keys( array_keys( $removed ), 1 ) );
+}
+add_action( 'bp_core_notification_settings_after_save', 'bp_notifications_save_screen_notification_settings' );
+
+/** UTILITY **************************************************************/
+
+/**
+ * Fetch mappped notification actions to notification meta keys.
+ *
+ * @since 2.7.0
+ * @todo Would be nice to merge this with bp_email_get_type_schema() somehow...
+ *
+ * @return array
+ */
+function bp_notifications_get_mapped_notification_actions() {
+        $actions = array(
+                // Activity
+                // notification action -> meta key
+                'new_at_mention' => 'activity_new_mention',
+                'comment_reply'  => 'activity_new_reply',
+
+                // Friends
+                'friendship_requested' => 'friends_friendship_request',
+                'friendship_accepted'  => 'friends_friendship_accepted',
+
+                // Groups
+                'group_invite' => 'groups_invite',
+                'member_promoted_to_admin' => 'groups_admin_promotion',
+                'member_promoted_to_mod'   => 'groups_admin_promotion',
+                'new_membership_request'   => 'groups_membership_request',
+                'membership_request_accepted' => 'membership_request_completed',
+                'membership_request_rejected' => 'membership_request_completed',
+
+                // Messages
+                'new_message' => 'messages_new_message'
+        );
+
+        return apply_filters( 'bp_notifications_get_mapped_notification_actions', $actions );
+}
+
+/**
+ * Get custom metakey for our notification type.
+ *
+ * @since 2.7.0
+ *
+ * @param string $key Current notification key.
+ */
+function bp_notifications_get_metakey_for_notification_type( $key ) {
+        $key = str_replace( 'notification_', '', $key );
+
+        $mapped_keys = array_flip( bp_notifications_get_mapped_notification_actions() );
+
+        if ( isset( $mapped_keys[ $key ] ) ) {
+                return $mapped_keys[ $key ];
+
+        /*
+         * 3rd-party screen notifications need to be registered on the
+         * 'bp_notifications_get_mapped_notification_actions' filter.
+         */
+        } else {
+                return '';
+        }
+}
+add_filter( 'bp_settings_get_metakey_for_screen_notification_type', 'bp_notifications_get_metakey_for_notification_type', 50 );
+
+/**
+ * Get user setting for our screen notification type.
+ *
+ * @since 2.7.0
+ *
+ * @param  string $setting Current setting. Default: 'yes'.
+ * @param  int    $user_id User ID.
+ * @param  string $key     Meta key.
+ * @return string
+ */
+function bp_notifications_filter_user_notification_setting( $setting, $user_id, $key ) {
+        $disabled_screen_notifications = bp_get_user_meta( $user_id, 'screen_notifications_disabled', true );
+
+        if ( isset( $disabled_screen_notifications[ $key ] ) ) {
+                $setting = 'no';
+        }
+
+        return $setting;
+}
+add_filter( 'bp_settings_get_screen_notification_user_setting', 'bp_notifications_filter_user_notification_setting', 10, 3 );
+ No newline at end of file

src/bp-notifications/classes/class-bp-notifications-component.php

@@ -52 +52 @@
                         'cache',
                 );
 
+                if ( bp_is_active( 'settings' ) ) {
+                        $includes[] = 'settings';
+                }
+
                 if ( ! buddypress()->do_autoload ) {
                         $includes[] = 'classes';
                 }

src/bp-notifications/classes/class-bp-notifications-notification.php

@@ -125 +125 @@
                  */
                 do_action_ref_array( 'bp_notification_before_save', array( &$this ) );
 
+                // Ensure that the 'component_name' property is always set.
+                if ( empty( $this->component_name ) ) {
+                        return false;
+                }
+
                 $data = array(
                         'user_id'           => $this->user_id,
                         'item_id'           => $this->item_id,

src/bp-settings/bp-settings-functions.php

@@ -77 +77 @@
                 $sanitized_settings[ $key ] = $value;
         }
 
+        // Handle new checkbox interface, specifically unchecked settings.
+        $enabled_notifications = array_intersect( array_keys( $settings ), $registered_notification_settings );
+        $removed_notifications = array_unique( array_diff( $registered_notification_settings, $enabled_notifications ) );
+        foreach ( $removed_notifications as $key ) {
+                $sanitized_settings[ $key ] = 'no';
+        }
+
         return $sanitized_settings;
 }
 
@@ -103 +110 @@
 
         return $key_whitelist;
 }
+
+/**
+ * Register a notification type on the "Settings > Notifications" page.
+ *
+ * Used primarily to output a user's "Settings > Notifications" page, but
+ * could be used for other things.
+ *
+ * You should run this function after 'bp_setup_globals'.
+ *
+ * @since 2.7.0
+ *
+ * @param string $type The notification type to register.
+ * @param array $args {
+ *     Array of arguments to register for the notification type.
+ *     @type string $label         Label for the notification type.
+ *     @type string $post_variable Unique post variable used for input name in form.
+ * }
+ * @return bool
+ */
+function bp_settings_register_notification_type( $type = '', $args = array() ) {
+        if ( ! did_action( 'bp_setup_globals' ) ) {
+                _doing_it_wrong( __FUNCTION__, "Function must be called after the 'bp_setup_globals' hook." );
+                return false;
+        }
+
+        if ( empty( $type ) || empty( $args ) ) {
+                return false;
+        }
+
+        if ( ! isset( buddypress()->settings->notification_type ) ) {
+                buddypress()->settings->notification_type = array();
+        }
+
+        $component = sanitize_key( $type );
+
+        buddypress()->settings->notification_type[$type] = (object) $args;
+
+        return true;
+}
+
+/**
+ * Fetch all available notification types.
+ *
+ * @since 2.7.0
+ *
+ * @return array
+ */
+function bp_settings_get_notification_types() {
+        if ( ! isset( buddypress()->settings->notification_type ) ) {
+                $types = array();
+        }
+
+        // Email always exists by default.
+        $types['email'] = (object) array(
+                'label'         => esc_html__( 'Email', 'buddypress' ),
+                'post_variable' => 'notifications'
+        );
+
+        /**
+         * Filters the notification types for 3rd-party notification types.
+         */
+        $custom_types = apply_filters( 'bp_settings_get_notification_types', buddypress()->settings->notification_type );
+
+        return $types + $custom_types;
+}
+
+/**
+ * Get data about a registered notification type
+ *
+ * @since 2.7.0
+ *
+ * @param  string $type Notification type.
+ * @return object|false
+ */
+function bp_settings_get_notification_type( $type ) {
+        $types = bp_settings_get_notification_types();
+        if ( isset( $types[ $type ] ) ) {
+                return $types[ $type ];
+        } else {
+                return false;
+        }
+}
+
+/**
+ * Get the meta key used to store the user's setting for the notification type
+ *
+ * @since 2.7.0
+ *
+ * @param  string $key  Meta key to use when checking user meta.
+ * @param  string $type Notification type to check against.
+ * @return string
+ */
+function bp_settings_get_metakey_for_notification_type( $key, $type ) {
+        // Email already works.
+        if ( 'email' === $type ) {
+                return $key;
+        }
+
+        $unmodified_key = $key;
+
+        /**
+         * Dynamic filter used to determine the meta key for the current notification type.
+         *
+         * @since 2.7.0
+         *
+         * @param string $key Meta key to use when checking user meta.
+         */
+        $key = apply_filters( "bp_settings_get_metakey_for_{$type}_notification_type", $key );
+
+        // If key didn't change, return blank string.
+        if ( $key === bp_settings_get_metakey_for_notification_type( $unmodified_key, 'email' ) ) {
+                return '';
+        } else {
+                return $key;
+        }
+}
+
+/**
+ * Get a user's notification user setting, depending on the notification type
+ *
+ * @since 2.7.0
+ *
+ * @param  string $key  Meta key to use when checking user meta.
+ * @param  string $type Notification type to check against.
+ * @return string
+ */
+function bp_settings_get_notification_user_setting( $user_id = 0, $key = '', $type = '' ) {
+        if ( 0 === $user_id ) {
+                $user_id = bp_displayed_user_id();
+        }
+
+        // Email is hardcoded.
+        if ( 'email' === $type ) {
+                $setting = bp_get_user_meta( $user_id, $key, true );
+
+                // No setting saved; default is 'yes'.
+                if ( '' === $setting ) {
+                        $setting = 'yes';
+                }
+
+                return $setting;
+        }
+
+        /**
+         * Allow 3rd-party notification types to filter the notification user setting
+         *
+         * Filter name is dynamic, depending on the notification type.
+         *
+         * @since 2.7.0
+         *
+         * @param string $setting Defaults to 'yes'.
+         * @param int    $user_id User ID to fetch the notification setting for.
+         * @param string $key     Notification key.
+         */
+        return apply_filters( "bp_settings_get_{$type}_notification_user_setting", 'yes', $user_id, $key );
+}

src/bp-settings/classes/class-bp-settings-component.php

@@ -117 +117 @@
                         'user_has_access' => $access
                 );
 
-                // Add Email nav item. Formerly called 'Notifications', we
-                // retain the old slug and function names for backward compat.
+                // Add Notifications nav item.
                 $sub_nav[] = array(
-                        'name'            => __( 'Email', 'buddypress' ),
+                        'name'            => __( 'Notifications', 'buddypress' ),
                         'slug'            => 'notifications',
                         'parent_url'      => $settings_link,
                         'parent_slug'     => $slug,
@@ -195 +194 @@
                                 $wp_admin_nav[] = array(
                                         'parent'   => 'my-account-' . $this->id,
                                         'id'       => 'my-account-' . $this->id . '-notifications',
-                                        'title'    => __( 'Email', 'buddypress' ),
+                                        'title'    => __( 'Notifications', 'buddypress' ),
                                         'href'     => trailingslashit( $settings_link . 'notifications' ),
                                         'position' => 20
                                 );

src/bp-templates/bp-legacy/buddypress/members/single/settings/notifications.php

@@ -9 +9 @@
 /** This action is documented in bp-templates/bp-legacy/buddypress/members/single/settings/profile.php */
 do_action( 'bp_before_member_settings_template' ); ?>
 
+<h2 class="bp-screen-reader-text"><?php _e( 'Notification Settings', 'buddypress' ); ?></h2>
+
 <form action="<?php echo bp_displayed_user_domain() . bp_get_settings_slug() . '/notifications'; ?>" method="post" class="standard-form" id="settings-form">
-        <p><?php _e( 'Send an email notice when:', 'buddypress' ); ?></p>
 
         <?php
 

src/bp-templates/bp-legacy/css/buddypress.css

@@ -875 +875 @@
         word-wrap: normal !important;
 }
 
+/* Settings > Notifications */
+#settings-form.standard-form fieldset {
+        margin-bottom: 1em;
+}
+
+#settings-form.standard-form legend {
+        margin-bottom: 15px;
+}
+
+#settings-form.standard-form fieldset p {
+        clear: both;
+        margin-bottom: 0;
+}
+
+#settings-form.standard-form label {
+        float: left;
+        margin-bottom: 1em;
+        margin-right: 3em;
+}
+
 /*--------------------------------------------------------------
 3.6 - Ajax Loading
 --------------------------------------------------------------*/

tests/phpunit/testcases/notifications/functions.php

@@ -394 +394 @@
         }
 
         /**
+         * @group notification_settings
+         */
+        public function test_notifications_disabled_by_user() {
+                $u = $this->factory->user->create();
+
+                // Disable notifications for the 'new_at_mention' action.
+                bp_update_user_meta( $u, 'screen_notifications_disabled', array( 'new_at_mention' => 1 ) );
+
+                // This should be blocked.
+                $n1 = $this->factory->notification->create( array(
+                        'component_name'    => 'activity',
+                        'component_action'  => 'new_at_mention',
+                        'item_id'           => 99,
+                        'user_id'           => $u,
+                ) );
+
+                // This should pass through.
+                $n2 = $this->factory->notification->create( array(
+                        'component_name'    => 'activity',
+                        'component_action'  => 'kwyjibo',
+                        'item_id'           => 99,
+                        'user_id'           => $u,
+                ) );
+
+                $this->assertFalse( $n1 );
+                $this->assertNotFalse( $n2 );
+        }
+
+        /**
          * Used in test_notification_callback_parameter_integrity() test.
          */
         public function dummy_notification_callback( $action, $item_id, $secondary_item_id, $total_items, $format = 'string', $id = 0 ) {