Changeset 5829 for trunk/bp-settings/bp-settings-actions.php

Timestamp:

02/23/2012 06:18:39 AM (13 years ago)

Author:

johnjamesjacoby

Message:

First pass at adding user capabilities screen and action to settings component:

• Add capabilities template
• Unhook core spammer and deleted user actions and move to settings
• Route admin bar links appropriately to new locations
• Allow delete-account to be accessed by super admins in place of broken alerts
• Improve general settings feedback
• @todo - backpat post mortem
• See #4038

File:

• trunk/bp-settings/bp-settings-actions.php (modified) (7 diffs)

trunk/bp-settings/bp-settings-actions.php

@@ -12 +12 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
-/** General *******************************************************************/
-
-function bp_core_screen_general_settings() {
+/**
+ * Handles the changing and saving of user email addressos and passwords
+ * 
+ * We do quite a bit of logic and error handling here to make sure that users
+ * do not accidentally lock themselves out of their accounts. We also try to
+ * provide as accurate of feedback as possible without exposing anyone else's
+ * inforation to them.
+ * 
+ * Special considerations are made for super admins that are able to edit any
+ * users accounts already, without knowing their existing password.
+ *
+ * @global BuddyPress $bp
+ * @return If no reason to proceed
+ */
+function bp_settings_action_general() {
     global $bp;
 
+    // Bail if not a POST action
+    if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) )
+        return;
+
+    // Bail if not in settings
+    if ( ! bp_is_settings_component() || ! bp_is_current_action( 'general' ) )
+        return;
+
+    // 404 if there are any additional action variables attached
     if ( bp_action_variables() ) {
         bp_do_404();
@@ -22 +43 @@
     }
 
-    // Setup private variables
-    $bp_settings_updated = $pass_error = $email_error = $pwd_error = false;
+    // Define local defaults
+    $email_error   = false;   // invalid|blocked|taken|empty|nochange
+    $pass_error    = false;   // invalid|mismatch|empty|nochange
+    $pass_changed  = false;   // true if the user changes their password
+    $feedback_type = 'error'; // success|error
+    $feedback      = array(); // array of strings for feedback
+
+    /** Handle Form ***********************************************************/
 
     if ( isset( $_POST['submit'] ) ) {
@@ -31 +58 @@
 
         // Validate the user again for the current password when making a big change
-        if ( bp_current_user_can( 'bp_moderate' ) || ( !empty( $_POST['pwd'] ) && $_POST['pwd'] != '' && wp_check_password( $_POST['pwd'], $bp->displayed_user->userdata->user_pass, bp_displayed_user_id() ) ) ) {
+        if ( ( is_super_admin() ) || ( !empty( $_POST['pwd'] ) && wp_check_password( $_POST['pwd'], $bp->displayed_user->userdata->user_pass, bp_displayed_user_id() ) ) ) {
 
             $update_user = get_userdata( bp_displayed_user_id() );
 
-            // Make sure changing an email address does not already exist
-            if ( $_POST['email'] != '' ) {
+            /** Email Change Attempt ******************************************/
+
+            if ( !empty( $_POST['email'] ) ) {
 
                 // What is missing from the profile page vs signup - lets double check the goodies
                 $user_email = sanitize_email( esc_html( trim( $_POST['email'] ) ) );
 
-                // Is email valid
-                if ( !is_email( $user_email ) )
-                    $email_error = true;
-
-                // Get blocked email domains
-                $limited_email_domains = get_site_option( 'limited_email_domains', 'buddypress' );
-
-                // If blocked email domains exist, see if this is one of them
-                if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
-                    $emaildomain = substr( $user_email, 1 + strpos( $user_email, '@' ) );
-
-                    if ( in_array( $emaildomain, (array) $limited_email_domains ) == false ) {
-                        $email_error = true;
+                // Skip this if no change to email
+                if ( $bp->displayed_user->userdata->user_email != $user_email ) {
+
+                    // Is email valid
+                    if ( !is_email( $user_email ) )
+                        $email_error = 'invalid';
+
+                    // Get blocked email domains
+                    $limited_email_domains = get_site_option( 'limited_email_domains', 'buddypress' );
+
+                    // If blocked email domains exist, see if this is one of them
+                    if ( is_array( $limited_email_domains ) && empty( $limited_email_domains ) == false ) {
+                        $emaildomain = substr( $user_email, 1 + strpos( $user_email, '@' ) );
+
+                        if ( in_array( $emaildomain, (array) $limited_email_domains ) == false ) {
+                            $email_error = 'blocked';
+                        }
                     }
-                }
-
-                // No errors, and email address doesn't match
-                if ( ( false === $email_error ) && ( $bp->displayed_user->userdata->user_email != $user_email ) ) {
-
-                    // We don't want email dupes in the system
-                    if ( email_exists( $user_email ) )
-                        $email_error = true;
-
-                    // Set updated user email to this email address
+
+                    // No errors, and email address doesn't match
+                    if ( ( false === $email_error ) && email_exists( $user_email ) ) {
+                        $email_error = 'taken';
+                    }
+
+                // No change
+                } else {
+                    $email_error = 'nochange';
+                }
+
+                // Yay we made it!
+                if ( false === $email_error ) {
                     $update_user->user_email = $user_email;
                 }
-            }
-
-            // Password change
+
+            // Email address cannot be empty
+            } else {
+                $email_error = 'empty';
+            }
+
+            /** Password Change Attempt ***************************************/
+
             if ( !empty( $_POST['pass1'] ) && !empty( $_POST['pass2'] ) ) {
 
                 // Password change attempt is successful
-                if ( $_POST['pass1'] == $_POST['pass2'] && !strpos( " " . $_POST['pass1'], "\\" ) ) {
+                if ( ( $_POST['pass1'] == $_POST['pass2'] ) && !strpos( " " . $_POST['pass1'], "\\" ) ) {
                     $update_user->user_pass = $_POST['pass1'];
+                    $pass_changed = true;
 
                 // Password change attempt was unsuccessful
                 } else {
-                    $pass_error = true;
-                }
+                    $pass_error = 'mismatch';
+                }
+
+            // Both password fields were empty
+            } elseif ( empty( $_POST['pass1'] ) && empty( $_POST['pass2'] ) ) {
+                $pass_error = 'nochange';
 
             // One of the password boxes was left empty
-            } else if ( ( empty( $_POST['pass1'] ) && !empty( $_POST['pass2'] ) ) || ( !empty( $_POST['pass1'] ) && empty( $_POST['pass2'] ) ) ) {
-                $pass_error = true;
-
-            // Not a password change attempt so empty the user_pass
-            } else {
-                // unset( $update_user->user_pass ); // WP_User has no __unset()
-                $update_user->user_pass = null;
+            } elseif ( ( empty( $_POST['pass1'] ) && !empty( $_POST['pass2'] ) ) || ( !empty( $_POST['pass1'] ) && empty( $_POST['pass2'] ) ) ) {
+                $pass_error = 'empty';
             }
 
@@ -95 +135 @@
             if ( isset( $update_user->data ) && is_object( $update_user->data ) ) {
                 $update_user = $update_user->data;
+                $update_user = get_object_vars( $update_user );
+
+                // Unset the password field to prevent it from emptying out the
+                // user's user_pass field in the database.
+                // @see wp_update_user()
+                if ( false === $pass_changed ) {
+                    unset( $update_user['user_pass'] );
+                }
             }
 
             // Make sure these changes are in $bp for the current page load
-            if ( ( false === $email_error ) && ( false === $pass_error ) && ( wp_update_user( get_object_vars( $update_user ) ) ) ) {
+            if ( ( false === $email_error ) && ( false === $pass_error ) && ( wp_update_user( $update_user ) ) ) {
                 $bp->displayed_user->userdata = bp_core_get_core_userdata( bp_displayed_user_id() );
-                $bp_settings_updated = true;
             }
 
         // Password Error
         } else {
-            $pwd_error = true;
-        }
-
-        // Add user feedback messages
-        if ( empty( $pass_error ) && empty( $pwd_error ) && ( empty( $email_error ) ) )
-            bp_core_add_message( __( 'Changes saved.', 'buddypress' ), 'success' );
-
-        elseif ( !empty( $pass_error ) )
-            bp_core_add_message( __( 'Your new passwords did not match.', 'buddypress' ), 'error' );
-
-        elseif ( !empty( $pwd_error ) )
-            bp_core_add_message( __( 'Your existing password is incorrect.', 'buddypress' ), 'error' );
-
-        elseif ( !empty( $email_error ) )
-            bp_core_add_message( __( 'Sorry, that email address is already used or is invalid.', 'buddypress' ), 'error' );
+            $pass_error = 'invalid';
+        }
+
+        // Email feedback
+        switch ( $email_error ) {
+            case 'invalid' :
+                $feedback['email_invalid']  = __( 'That email address is invalid. Check the formatting and try again.', 'buddypress' );
+                break;
+            case 'blocked' :
+                $feedback['email_blocked']  = __( 'That email address is currently unavailable for use.', 'buddypress' );
+                break;
+            case 'taken' :
+                $feedback['email_taken']    = __( 'That email address is already taken.', 'buddypress' );
+                break;
+            case 'empty' :
+                $feedback['email_empty']    = __( 'Email address cannot be empty.', 'buddypress' );
+                break;
+            case 'nochange' :
+                $email_error = false;
+                break;
+        }
+
+        // Password feedback
+        switch ( $pass_error ) {
+            case 'invalid' :
+                $feedback['pass_error']    = __( 'Your current password is invalid.', 'buddypress' );
+                break;
+            case 'mismatch' :
+                $feedback['pass_mismatch'] = __( 'The new password fields did not match.', 'buddypress' );
+                break;
+            case 'empty' :
+                $feedback['pass_empty']    = __( 'One of the password fields was empty.', 'buddypress' );
+                break;
+            case 'nochange' :
+                $pass_error = false;
+                break;
+        }
+
+        // No errors so show a simple success message
+        if ( ( false === $email_error ) && ( ( false == $pass_error ) && ( true === $pass_changed ) ) ) {
+            $feedback[]    = __( 'Your settings have been saved.', 'buddypress' );
+            $feedback_type = 'success';
+
+        // Some kind of errors occurred
+        } elseif ( ( false === $email_error ) && ( ( false == $pass_error ) && ( false === $pass_changed ) ) ) {
+            if ( bp_is_my_profile() ) {
+                $feedback['nochange'] = __( 'No changes were made to your account.', 'buddypress' );
+            } else {
+                $feedback['nochange'] = __( 'No changes were made to this account.', 'buddypress' );
+            }
+        }
+
+        // Set the feedback
+        bp_core_add_message( implode( '</p><p>', $feedback ), $feedback_type );
 
         // Execute additional code
         do_action( 'bp_core_general_settings_after_save' );
-        
-        bp_core_redirect( bp_displayed_user_domain() . bp_get_settings_slug() . '/general/' );
-    }
-
-    // Load the template
-    bp_core_load_template( apply_filters( 'bp_core_screen_general_settings', 'members/single/settings/general' ) );
+
+        // Redirect to prevent issues with browser back button
+        bp_core_redirect( trailingslashit( bp_displayed_user_domain() . bp_get_settings_slug() . '/general' ) );
+    }
 }
-
-/** Notifications *************************************************************/
-
-function bp_core_screen_notification_settings() {
-
+add_action( 'bp_actions', 'bp_settings_action_general' );
+
+/**
+ * Handles the changing and saving of user notification settings
+ *
+ * @return If no reason to proceed
+ */
+function bp_settings_action_notifications() {
+
+    // Bail if not a POST action
+    if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) )
+        return;
+
+    // Bail if not in settings
+    if ( ! bp_is_settings_component() || ! bp_is_current_action( 'notifications' ) )
+        return false;
+
+    // 404 if there are any additional action variables attached
     if ( bp_action_variables() ) {
         bp_do_404();
@@ -141 +238 @@
 
     if ( isset( $_POST['submit'] ) ) {
-        check_admin_referer('bp_settings_notifications');
+        check_admin_referer( 'bp_settings_notifications' );
 
         if ( isset( $_POST['notifications'] ) ) {
             foreach ( (array) $_POST['notifications'] as $key => $value ) {
-                if ( $meta_key = bp_get_user_meta_key( $key ) )
-                    bp_update_user_meta( (int)bp_displayed_user_id(), $meta_key, $value );
-            }
-        }
-
-        bp_core_add_message( __( 'Changes saved.', 'buddypress' ), 'success' );
+                if ( $meta_key = bp_get_user_meta_key( $key ) ) {
+                    bp_update_user_meta( (int) bp_displayed_user_id(), $meta_key, $value );
+                }
+            }
+        }
+
+        // Switch feedback for super admins
+        if ( bp_is_my_profile() ) {
+            bp_core_add_message( __( 'Your notification settings have been saved.',        'buddypress' ), 'success' );
+        } else {
+            bp_core_add_message( __( "This user's notification settings have been saved.", 'buddypress' ), 'success' );
+        }
 
         do_action( 'bp_core_notification_settings_after_save' );
@@ -156 +259 @@
         bp_core_redirect( bp_displayed_user_domain() . bp_get_settings_slug() . '/notifications/' );
     }
-
-    bp_core_load_template( apply_filters( 'bp_core_screen_notification_settings', 'members/single/settings/notifications' ) );
 }
-
-/** Delete Account ************************************************************/
-
-function bp_core_screen_delete_account() {
-
+add_action( 'bp_actions', 'bp_settings_action_notifications' );
+
+/**
+ * Handles the setting of user capabilities, spamming, hamming, role, etc...
+ *
+ * @return If no reason to proceed
+ */
+function bp_settings_action_capabilities() {
+
+    // Bail if not a POST action
+    if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) )
+        return;
+
+    // Bail if not in settings
+    if ( ! bp_is_settings_component() || ! bp_is_current_action( 'capabilities' ) )
+        return false;
+
+    // 404 if there are any additional action variables attached
     if ( bp_action_variables() ) {
         bp_do_404();
@@ -169 +283 @@
     }
 
+    if ( isset( $_POST['capabilities-submit'] ) ) {
+
+        // Nonce check
+        check_admin_referer( 'capabilities' );
+
+        do_action( 'bp_settings_capabilities_before_save' );
+
+        /** Spam **************************************************************/
+
+        $is_spammer = !empty( $_POST['user-spammer'] ) ? true : false;
+
+        if ( bp_is_user_spammer( bp_displayed_user_id() ) != $is_spammer ) {
+            $status = ( true == $is_spammer ) ? 'spam' : 'ham';
+            bp_core_process_spammer_status( bp_displayed_user_id(), $status );
+            do_action( 'bp_core_action_set_spammer_status', bp_displayed_user_id(), $status );
+        }
+
+        /** Other *************************************************************/
+
+        do_action( 'bp_settings_capabilities_after_save' );
+
+        // Redirect to the root domain
+        bp_core_redirect( bp_displayed_user_domain() . bp_get_settings_slug() . '/capabilities/' );
+    }
+}
+add_action( 'bp_actions', 'bp_settings_action_capabilities' );
+
+/**
+ * Handles the deleting of a user
+ *
+ * @return If no reason to proceed
+ */
+function bp_settings_action_delete_account() {
+
+    // Bail if not a POST action
+    if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) )
+        return;
+
+    // Bail if not in settings
+    if ( ! bp_is_settings_component() || ! bp_is_current_action( 'delete-account' ) )
+        return false;
+
+    // 404 if there are any additional action variables attached
+    if ( bp_action_variables() ) {
+        bp_do_404();
+        return;
+    }
+
     if ( isset( $_POST['delete-account-understand'] ) ) {
+
         // Nonce check
         check_admin_referer( 'delete-account' );
 
+        // Get username now because it might be gone soon!
+        $username = bp_get_displayed_user_fullname();
+
         // delete the users account
         if ( bp_core_delete_account( bp_displayed_user_id() ) ) {
-            bp_core_redirect( home_url() );
-        }
-    }
-
-    // Load the template
-    bp_core_load_template( apply_filters( 'bp_core_screen_delete_account', 'members/single/settings/delete-account' ) );
+
+            // Add feedback ater deleting a user
+            bp_core_add_message( sprintf( __( '%s was successfully deleted.', 'buddypress' ), $username ), 'success' );
+
+            // Redirect to the root domain
+            bp_core_redirect( bp_get_root_domain() );
+        }
+    }
 }
+add_action( 'bp_actions', 'bp_settings_action_delete_account' );
 
 ?>