Changeset 4525 for sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/mentors/dashboard.php

Timestamp:

12/13/2016 08:45:19 PM (10 years ago)

Author:

coreymckrill

Message:

Mentor Dashboard: Use dotorg usernames to id mentors instead of email

• Adds the Mentor WordPress.org User Name field to wcpt.
• Introduces "protected" fields in wcpt, which will be marked as readonly unless current user has specific caps. Used to make all mentor fields in the wcpt edit screen readonly unless current user can manage the network.
• Adds a dropdown pick list of current mentors next to Mentor WordPress.org User Name that will fill in username, name, and email when a mentor is chosen. This only appears if current user has the right caps.
• Adds a field in the Mentor Dashboard for managing the list of current mentors based on their dotorg usernames.
• Uses dotorg username to determine which camps a mentor currently has, with their dotorg account email address as a backup.
• All camps that don't have a value for Mentor WordPress.org User Name or whose value doesn't match a current mentor will appear in the "Active Camps that don't have a mentor" list.
• Enqueues existing admin.js script for wcpt instead of printing it in the footer.

File:

• sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/mentors/dashboard.php (modified) (5 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/mentors/dashboard.php

@@ -3 +3 @@
 namespace WordCamp\Mentors_Dashboard;
 defined( 'WPINC' ) or die();
+
+const USERNAMES_KEY     = 'wcpt-mentors-usernames';
+const MENTORS_CACHE_KEY = 'wcpt-mentors-data';
+
+const STATUS_UPDATED       = 'Mentor usernames updated.';
+const STATUS_INVALID_NONCE = 'Invalid nonce. Mentor usernames were not updated.';
+const STATUS_NO_USERNAME   = 'No username data was submitted.';
+const STATUS_UPDATE_FAILED = 'Mentor usernames could not be updated.';
+
+
+add_action( 'admin_init', __NAMESPACE__ . '\admin_init' );
+
+/**
+ * Initialize admin functionality
+ */
+function admin_init() {
+        if ( isset( $_GET['wcpt-status'] ) ) {
+                add_action( 'admin_notices', __NAMESPACE__ . '\status_admin_notice' );
+        }
+}
 
 add_action( 'admin_menu', __NAMESPACE__ . '\add_admin_pages' );
@@ -26 +46 @@
         $mentors          = get_mentors();
         $unmentored_camps = get_unmentored_camps();
+        $usernames        = get_usernames();
 
         require_once( dirname( __DIR__ ) . '/views/mentors/dashboard.php' );
@@ -36 +57 @@
  */
 function get_mentors() {
-        $mentors = array();
-
-        $mentored_camps = get_posts( array(
-                'post_type'      => WCPT_POST_TYPE_ID,
-                'post_status'    => \WordCamp_Loader::get_mentored_post_statuses(),
-                'posts_per_page' => 10000,
-                'meta_query'     => array(
-                        array(
-                                'key'     => 'Mentor E-mail Address',
-                                'value'   => '',
-                                'compare' => '!='
-                        ),
-                ),
-        ) );
-
-        foreach ( $mentored_camps as $camp ) {
-                $email = get_post_meta( $camp->ID, 'Mentor E-mail Address', true );
-
-                /*
-                 * Closed camps were included in the query above, in order to get all mentors, even if they're not
-                 * currently mentoring any active camps. Closed camps shouldn't be included in the list of camps being
-                 * actively mentored, though.
-                 */
-                $count_camp = 'wcpt-closed' !== $camp->post_status;
-
-                if ( array_key_exists( $email, $mentors ) ) {
-                        if ( $count_camp ) {
-                                $mentors[ $email ]['camps_mentoring'][] = $camp->post_title;
-                        }
-                } else {
-                        $mentor_name = get_post_meta( $camp->ID, 'Mentor Name', true );
-
-                        $mentors[ $email ] = array(
-                                'name'            => $mentor_name,
-                                'camps_mentoring' => $count_camp ? array( $camp->post_title ) : array(),
-                        );
-                }
-        }
-
-        return $mentors;
-}
-
-/**
- * Count the total number of camps being mentored
- *
- * @param array $mentors
- *
- * @return int
- */
-function count_camps_being_mentored( $mentors ) {
-        $camps_being_mentored = 0;
-
-        foreach ( $mentors as $mentor ) {
-                $camps_being_mentored += count( $mentor['camps_mentoring'] );
-        }
-
-        return $camps_being_mentored;
-}
-
-/**
- * Get active camps that haven't been assigned a mentor
- *
- * @return array
- */
-function get_unmentored_camps() {
-        $unmentored_camps = array();
+        $mentors = get_all_mentor_data();
+
+        if ( empty( $mentors ) ) {
+                return array();
+        }
+
+        $mentor_email = wp_list_pluck( $mentors, 'email' );
 
         $post_statuses = array_diff(
@@ -108 +70 @@
         );
 
+        $mentored_camps = get_posts( array(
+                'post_type'      => WCPT_POST_TYPE_ID,
+                'post_status'    => $post_statuses,
+                'posts_per_page' => 10000,
+                'order'          => 'ASC',
+                'orderby'        => 'name',
+                'meta_query'     => array(
+                        'relation' => 'OR',
+                        array(
+                                'key'     => 'Mentor WordPress.org User Name',
+                                'value'   => get_usernames(),
+                                'compare' => 'IN',
+                        ),
+                        array(
+                                'key'     => 'Mentor E-mail Address',
+                                'value'   => $mentor_email,
+                                'compare' => 'IN',
+                        ),
+                ),
+        ) );
+
+        $mentors = array_map( function( $value ) {
+                $value['camps_mentoring'] = array();
+                return $value;
+        }, $mentors );
+
+        foreach ( $mentored_camps as $camp ) {
+                $username = get_post_meta( $camp->ID, 'Mentor WordPress.org User Name', true );
+                $email    = get_post_meta( $camp->ID, 'Mentor E-mail Address', true );
+
+                // Camp has username
+                if ( false !== $username && isset( $mentors[ $username ] ) ) {
+                        $mentors[ $username ]['camps_mentoring'][ $camp->ID ] = $camp->post_title;
+                }
+                // Camp doesn't have username, but has email
+                else if ( false !== $email && false !== $key = array_search( $email, $mentor_email ) ) {
+                        // Add asterisk to show camp has mentor email but not username
+                        $mentors[ $key ]['camps_mentoring'][ $camp->ID ] = $camp->post_title . ' *';
+                }
+        }
+
+        return $mentors;
+}
+
+/**
+ * Count the total number of camps being mentored
+ *
+ * @param array $mentors
+ *
+ * @return int
+ */
+function count_camps_being_mentored( $mentors ) {
+        $camps_being_mentored = 0;
+
+        foreach ( $mentors as $mentor ) {
+                $camps_being_mentored += count( $mentor['camps_mentoring'] );
+        }
+
+        return $camps_being_mentored;
+}
+
+/**
+ * Get active camps that haven't been assigned a mentor
+ *
+ * @return array
+ */
+function get_unmentored_camps() {
+        $unmentored_camps = array();
+
+        $post_statuses = array_diff(
+                \WordCamp_Loader::get_mentored_post_statuses(),
+                array( 'wcpt-closed' )
+        );
+
         $posts = get_posts( array(
                 'post_type'      => WCPT_POST_TYPE_ID,
                 'post_status'    => $post_statuses,
                 'posts_per_page' => 10000,
+                'order'          => 'ASC',
+                'orderby'        => 'name',
                 'meta_query'     => array(
+                        'relation' => 'OR',
                         array(
-                                'key'     => 'Mentor E-mail Address',
-                                'value'   => '',
-                                'compare' => '='
+                                'key'     => 'Mentor WordPress.org User Name',
+                                'value'   => get_usernames(),
+                                'compare' => 'NOT IN'
+                        ),
+                        array(
+                                'key'     => 'Mentor WordPress.org User Name',
+                                'compare' => 'NOT EXISTS'
                         ),
                 ),
@@ -122 +165 @@
 
         foreach ( $posts as $post ) {
-                $unmentored_camps[ $post->ID ] = $post->post_title;
+                $email = get_post_meta( $post->ID, 'Mentor E-mail Address', true );
+                $camp_name = $post->post_title;
+
+                if ( $email ) {
+                        $camp_name .= ' *';
+                }
+
+                $unmentored_camps[ $post->ID ] = $camp_name;
         }
 
         return $unmentored_camps;
 }
+
+/**
+ * Get the stored array of mentor usernames and sanitize before returning.
+ *
+ * @return array
+ */
+function get_usernames() {
+        $raw_usernames = get_site_option( USERNAMES_KEY, array() );
+
+        return sanitize_usernames( $raw_usernames );
+}
+
+/**
+ * Sanitize a list of usernames and store in the database.
+ *
+ * @param string|array $usernames
+ *
+ * @return bool
+ */
+function set_usernames( $usernames ) {
+        $sanitized_usernames = sanitize_usernames( $usernames );
+
+        return update_site_option( USERNAMES_KEY, $sanitized_usernames );
+}
+
+/**
+ * Sanitize an array of usernames. Convert to an array first if a string is provided.
+ *
+ * @param string|array $usernames
+ *
+ * @return array
+ */
+function sanitize_usernames( $usernames ) {
+        if ( ! is_array( $usernames ) ) {
+                $usernames = explode( ',', $usernames );
+        }
+
+        $usernames = array_map( 'trim', $usernames );
+
+        $usernames = array_map( 'sanitize_user', $usernames );
+
+        // Remove empty array items
+        return array_filter( $usernames );
+}
+
+/**
+ * @todo
+ *
+ * @param array $sanitized_usernames
+ */
+function validate_usernames( array $sanitized_usernames ) {
+        // todo
+}
+
+add_action( 'admin_post_wcpt-mentors-update-usernames', __NAMESPACE__ . '\update_usernames' );
+
+/**
+ * Admin Post callback to receive a list of usernames from a form and store it in the database.
+ */
+function update_usernames() {
+        // Base redirect URL
+        $redirect_url = add_query_arg( array(
+                'post_type' => 'wordcamp',
+                'page'      => 'mentors',
+        ), admin_url( 'edit.php' ) );
+
+        // Invalid nonce
+        if ( ! isset( $_POST['wcpt-mentors-nonce'] ) ||
+                 ! wp_verify_nonce( $_POST['wcpt-mentors-nonce'], 'wcpt-mentors-update-usernames' ) ) {
+                $status_code = 'invalid-nonce';
+        }
+        // No usernames field
+        else if ( ! isset( $_POST['wcpt-mentors-usernames'] ) ) {
+                $status_code = 'no-username';
+        }
+        //
+        else {
+                $raw_usernames = $_POST['wcpt-mentors-usernames'];
+
+                $success = set_usernames( $raw_usernames );
+
+                if ( $success ) {
+                        $status_code = 'updated';
+
+                        // Bust cache
+                        delete_site_transient( MENTORS_CACHE_KEY );
+                } else {
+                        $status_code = 'update-failed';
+                }
+        }
+
+        $redirect_url = add_query_arg( 'wcpt-status', $status_code, $redirect_url );
+
+        wp_safe_redirect( esc_url_raw( $redirect_url ) );
+}
+
+/**
+ * Display the result of `update_usernames`
+ */
+function status_admin_notice() {
+        if ( ! isset( $_GET['wcpt-status'] ) ) {
+                return;
+        }
+
+        $status = 'STATUS_' . strtoupper( str_replace( '-', '_', $_GET['wcpt-status'] ) );
+
+        if ( ! defined( __NAMESPACE__ . '\\' . $status ) ) {
+                return;
+        }
+
+        $type = 'success';
+        if ( 'STATUS_UPDATED' !== $status ) {
+                $type = 'error';
+        }
+
+        $message = constant( __NAMESPACE__ . '\\' . $status );
+
+        ?>
+        <div class="notice notice-<?php echo esc_attr( $type ); ?> is-dismissible">
+                <?php echo wpautop( esc_html( $message ) ); ?>
+        </div>
+<?php
+}
+
+/**
+ * Retrieve name and email for a particular mentor username.
+ *
+ * @param string $username
+ *
+ * @return array
+ */
+function get_mentor_data( $username ) {
+        $usernames = get_usernames();
+        $data = array();
+
+        // Data for specific mentor
+        if ( in_array( $username, $usernames ) ) {
+                $user = \get_user_by( 'login', $username );
+
+                if ( $user instanceof \WP_User ) {
+                        $data[ $username ] = array(
+                                'name'  => $user->display_name,
+                                'email' => $user->user_email,
+                        );
+                }
+        }
+
+        return $data;
+}
+
+/**
+ * Retrieve data for all the mentor usernames in the list.
+ *
+ * @return array
+ */
+function get_all_mentor_data() {
+        if ( false !== $data = \get_site_transient( MENTORS_CACHE_KEY ) ) {
+                return $data;
+        }
+
+        $usernames = get_usernames();
+        $data = array();
+
+        foreach ( $usernames as $username ) {
+                $data = array_merge( $data, get_mentor_data( $username ) );
+        }
+
+        ksort( $data );
+
+        \set_site_transient( MENTORS_CACHE_KEY, $data, WEEK_IN_SECONDS );
+
+        return $data;
+}