Ticket #7856: 7856.diff

src/bp-templates/bp-legacy/buddypress-functions.php

@@ -282 +282 @@
                         wp_enqueue_script( $asset['handle'], $asset['location'], bp_core_get_js_dependencies(), $this->version );
                 }
 
+                /**
+                 * Filters whether directory filter settings ('scope', etc) should be stored in a persistent cookie.
+                 *
+                 * @since 4.0.0
+                 *
+                 * @param bool $store_filter_settings Whether to store settings. Defaults to true for logged-in users.
+                 */
+                $store_filter_settings = apply_filters( 'bp_legacy_store_filter_settings', is_user_logged_in() );
+
                 /**
                  * Filters core JavaScript strings for internationalization before AJAX usage.
                  *
@@ -290 +299 @@
                  * @param array $value Array of key/value pairs for AJAX usage.
                  */
                 $params = apply_filters( 'bp_core_get_js_strings', array(
+                        // Strings for display.
                         'accepted'            => __( 'Accepted', 'buddypress' ),
                         'close'               => __( 'Close', 'buddypress' ),
                         'comments'            => __( 'comments', 'buddypress' ),
@@ -303 +313 @@
                         'show_x_comments'     => __( 'Show all comments (%d)', 'buddypress' ),
                         'unsaved_changes'     => __( 'Your profile has unsaved changes. If you leave the page, the changes will be lost.', 'buddypress' ),
                         'view'                => __( 'View', 'buddypress' ),
+
+                        // Settings.
+                        'store_filter_settings' => $store_filter_settings,
                 ) );
                 wp_localize_script( $asset['handle'], 'BP_DTheme', $params );
 

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

@@ -10 +10 @@
 var newest_activities = '';
 var activity_last_recorded  = 0;
 
+var directoryPreferences = {}
+
 jq(document).ready( function() {
         /**** Page Load Actions *******************************************************/
 
@@ -862 +864 @@
                                 template = 'groups/single/members';
                         }
 
-                        bp_filter_request( object, jq.cookie('bp-' + object + '-filter'), jq.cookie('bp-' + object + '-scope') , 'div.' + object, search_terms, 1, jq.cookie('bp-' + object + '-extras'), null, template );
+                        var scope  = bp_get_directory_preference( object, 'scope' );
+                        var filter = bp_get_directory_preference( object, 'filter' );
+                        var extras = bp_get_directory_preference( object, 'extras' );
+
+                        bp_filter_request( object, filter, scope, 'div.' + object, search_terms, 1, extras, null, template );
 
                         return false;
                 }
@@ -897 +903 @@
                         filter = jq('#' + object + '-order-select select').val();
                         search_terms = jq('#' + object + '_search').val();
 
-                        bp_filter_request( object, filter, scope, 'div.' + object, search_terms, 1, jq.cookie('bp-' + object + '-extras') );
+                        var extras = bp_get_directory_preference( object, 'extras' );
+
+                        bp_filter_request( object, filter, scope, 'div.' + object, search_terms, 1, extras );
 
                         return false;
                 }
@@ -945 +953 @@
                         object = 'members';
                 }
 
-                bp_filter_request( object, filter, scope, 'div.' + object, search_terms, 1, jq.cookie('bp-' + object + '-extras'), null, template );
+                var extras = bp_get_directory_preference( object, 'extras' );
+
+                bp_filter_request( object, filter, scope, 'div.' + object, search_terms, 1, extras, null, template );
 
                 return false;
         });
@@ -1033 +1043 @@
                                 caller = null;
                         }
 
-                        bp_filter_request( object, jq.cookie('bp-' + object + '-filter'), jq.cookie('bp-' + object + '-scope'), 'div.' + object, search_terms, page_number, jq.cookie('bp-' + object + '-extras'), caller, template );
+                        var scope  = bp_get_directory_preference( object, 'scope' );
+                        var filter = bp_get_directory_preference( object, 'filter' );
+                        var extras = bp_get_directory_preference( object, 'extras' );
+
+                        bp_filter_request( object, filter, scope, 'div.' + object, search_terms, page_number, extras, caller, template );
 
                         return false;
                 }
@@ -1401 +1415 @@
                 if ( target.attr('type') === 'submit' || target.attr('type') === 'button' ) {
                         object = 'messages';
 
+                        var scope  = bp_get_directory_preference( object, 'scope' );
+                        var filter = bp_get_directory_preference( object, 'filter' );
+                        var extras = bp_get_directory_preference( object, 'extras' );
+
                         bp_filter_request(
                                 object,
-                                jq.cookie('bp-' + object + '-filter'),
-                                jq.cookie('bp-' + object + '-scope'),
+                                filter,
+                                scope,
                                 'div.' + object, jq('#messages_search').val(),
                                 1,
-                                jq.cookie('bp-' + object + '-extras')
+                                extras
                         );
 
                         return false;
@@ -1737 +1755 @@
         });
 });
 
+/**
+ * Gets the user's current preference for a directory option.
+ */
+function bp_get_directory_preference( directoryType, pref ) {
+        var defaultPrefs = {
+                filter: '',
+                scope: '',
+                extras: ''
+        }
+
+        if ( ! directoryPreferences.hasOwnProperty( directoryType ) ) {
+                directoryPreferences[ directoryType ] = Object.assign( {}, defaultPrefs );
+        }
+
+        if ( BP_DTheme.store_filter_settings ) {
+                directoryPreferences[ directoryType ][ pref ] = jq.cookie( 'bp-' + directoryType + '-' + pref );
+        }
+
+        return directoryPreferences[ directoryType ][ pref ];
+}
+
+/**
+ * Sets the user's current preference for a directory option.
+ */
+function bp_set_directory_preference( directoryType, pref, value ) {
+        if ( ! directoryPreferences.hasOwnProperty( directoryType ) ) {
+                directoryPreferences[ directoryType ] = Object.assign( {}, defaultPrefs );
+        }
+
+        if ( BP_DTheme.store_filter_settings ) {
+                jq.cookie( 'bp-' + directoryType + '-' + pref, value, {
+                        path: '/',
+                        secure: ( 'https:' === window.location.protocol )
+                } );
+        }
+
+        directoryPreferences[ directoryType ][ pref ] = value
+}
+
 /* Setup activity scope and filter based on the current cookie settings. */
 function bp_init_activity() {
-        if ( undefined !== jq.cookie('bp-activity-filter') && jq('#activity-filter-select').length ) {
-                jq('#activity-filter-select select option[value="' + jq.cookie('bp-activity-filter') + '"]').prop( 'selected', true );
+        var scope  = bp_get_directory_preference( 'activity', 'scope' );
+        var filter = bp_get_directory_preference( 'activity', 'filter' );
+
+        if ( undefined !== filter && jq('#activity-filter-select').length ) {
+                jq('#activity-filter-select select option[value="' + filter + '"]').prop( 'selected', true );
         }
 
         /* Activity Tab Set */
-        if ( undefined !== jq.cookie('bp-activity-scope') && jq('.activity-type-tabs').length ) {
+        if ( undefined !== scope && jq('.activity-type-tabs').length ) {
                 jq('.activity-type-tabs li').each( function() {
                         jq(this).removeClass('selected');
                 });
-                jq('#activity-' + jq.cookie('bp-activity-scope') + ', .item-list-tabs li.current').addClass('selected');
+                jq('#activity-' + scope + ', .item-list-tabs li.current').addClass('selected');
         }
 }
 
 /* Setup object scope and filter based on the current cookie settings for the object. */
 function bp_init_objects(objects) {
         jq(objects).each( function(i) {
-                if ( undefined !== jq.cookie('bp-' + objects[i] + '-filter') && jq('#' + objects[i] + '-order-select select').length ) {
-                        jq('#' + objects[i] + '-order-select select option[value="' + jq.cookie('bp-' + objects[i] + '-filter') + '"]').prop( 'selected', true );
+                var scope  = bp_get_directory_preference( objects[i], 'scope' );
+                var filter = bp_get_directory_preference( objects[i], 'filter' );
+
+                if ( undefined !== filter && jq('#' + objects[i] + '-order-select select').length ) {
+                        jq('#' + objects[i] + '-order-select select option[value="' + filter + '"]').prop( 'selected', true );
                 }
 
-                if ( undefined !== jq.cookie('bp-' + objects[i] + '-scope') && jq('div.' + objects[i]).length ) {
+                if ( undefined !== scope && jq('div.' + objects[i]).length ) {
                         jq('.item-list-tabs li').each( function() {
                                 jq(this).removeClass('selected');
                         });
-                        jq('#' + objects[i] + '-' + jq.cookie('bp-' + objects[i] + '-scope') + ', #object-nav li.current').addClass('selected');
+                        jq('#' + objects[i] + '-' + scope + ', #object-nav li.current').addClass('selected');
                 }
         });
 }
@@ -1778 +1841 @@
                 scope = 'all';
         }
 
-        /* Save the settings we want to remain persistent to a cookie */
-        jq.cookie( 'bp-' + object + '-scope', scope, {
-                path: '/',
-                secure: ( 'https:' === window.location.protocol )
-        } );
-        jq.cookie( 'bp-' + object + '-filter', filter, {
-                path: '/',
-                secure: ( 'https:' === window.location.protocol )
-        } );
-        jq.cookie( 'bp-' + object + '-extras', extras, {
-                path: '/',
-                secure: ( 'https:' === window.location.protocol )
-        } );
+        /* Save the settings we want to remain persistent */
+        bp_set_directory_preference( object, 'scope', scope );
+        bp_set_directory_preference( object, 'filter', filter );
+        bp_set_directory_preference( object, 'extras', extras );
 
         /* Set the correct selected nav and filter */
         jq('.item-list-tabs li').each( function() {