Changeset 3510

Timestamp:

06/20/2016 04:37:50 PM (10 years ago)

Author:

dd32

Message:

Plugin Directory: Allow a user to subscribe/unsubscribe from plugin commit emails.

Note: Plugin committers are automatically subscribed, and cannot unsubscribe.

See #1597

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• api/class-base.php (modified) (1 diff)
• api/routes/class-commit-subscriptions.php (added)
• class-tools.php (modified) (2 diffs)
• shortcodes/class-developers.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/class-base.php

@@ -12 +12 @@
          */
         static function load_routes() {
+                new Routes\Commit_Subscriptions();
                 new Routes\Internal_Stats();
                 new Routes\Plugin();

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-tools.php

@@ -1 +1 @@
 <?php
 namespace WordPressdotorg\Plugin_Directory;
+use WP_User;
 
 /**
@@ -169 +170 @@
                 );
         }
+
+        /**
+         * Subscribe/Unsubscribe a user to a plugins commits.
+         *
+         * Plugin Committers are automatically subscribed to plugin commit
+         * emails and cannot unsubscribe.
+         *
+         * @param string      $plugin_slug The plugin to subscribe to.
+         * @param int|WP_User $user        The user to subscribe. Default current user.
+         * @param bool        $subscribe   Whether to subscribe (true) or unsubscribe (false).
+         *
+         * @return bool Whether the user is subscribed.
+         */
+        public static function subscribe_to_plugin_commits( $plugin_slug, $user = 0, $subscribe = true ) {
+                $post = Plugin_Directory::get_plugin_post( $plugin_slug );
+                if ( ! $post ) {
+                        return false;
+                }
+
+                $user = new WP_User( $user ?: get_current_user_id() );
+                if ( ! $user->exists() ) {
+                        return false;
+                }
+
+                $users = get_post_meta( $post->ID, '_commit_subscribed', true ) ?: array();
+
+                if ( $subscribe ) {
+                        $users[] = $user->ID;
+                        $users = array_unique( $users );
+                } else {
+                        if ( false !== ( $pos = array_search( $user->ID, $users, true ) ) ) {
+                                unset( $users[ $pos ] );
+                        }
+                }
+
+                update_post_meta( $post->ID, '_commit_subscribed', $users );
+
+                return self::subscribed_to_plugin_commits( $plugin_slug, $user->ID );
+        }
+
+        /**
+         * Determine if a user is subscribed to a plugins commits.
+         *
+         * Plugin Committers are automatically subscribed to commits, and this
+         * function does not respect that status.
+         *
+         * @param string      $plugin_slug The plugin to subscribe to.
+         * @param int|WP_User $user        The user to check. Default current user.
+         *
+         * @return bool Whether the specified user is subscribed to commits.
+         */
+        public static function subscribed_to_plugin_commits( $plugin_slug, $user = 0 ) {
+                $post = Plugin_Directory::get_plugin_post( $plugin_slug );
+                if ( ! $post ) {
+                        return false;
+                }
+
+                $user = new WP_User( $user ?: get_current_user_id() );
+                if ( ! $user->exists() ) {
+                        return false;
+                }
+
+                $users = get_post_meta( $post->ID, '_commit_subscribed', true ) ?: array();
+
+                return in_array( $user->ID, $users, true );
+        }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-developers.php

@@ -32 +32 @@
                 $output .= '</ul>';
 
+                if ( is_user_logged_in() ) {
+                        $subscribed = Tools::subscribed_to_plugin_commits( $post, get_current_user_id() );
+
+                        $subscribe_change_url = esc_url( add_query_arg(
+                                array(
+                                        '_wpnonce' => wp_create_nonce( 'wp_rest' ),
+                                        ( $subscribed ? 'unsubscribe' : 'subscribe' ) => '1'
+                                ),
+                                home_url( 'wp-json/plugins/v1/plugin/' . $post->post_name . '/commit-subscription' )
+                        ) );
+                }
+
                 return $output .
                         '<h5>' . __( 'Browse the code', 'wporg-plugins' ) . '</h5>' .
@@ -37 +49 @@
                                 '<li>' .
                                         '<a href="' . esc_url( "https://plugins.trac.wordpress.org/log/{$post->post_name}/" ) . '" rel="nofollow">' . __( 'Development Log', 'wporg-plugins' ) . '</a>' . "\n" .
-                                        '<a href="' . esc_url( "https://plugins.trac.wordpress.org/log/{$post->post_name}/?limit=100&mode=stop_on_copy&format=rss" ) . '" rel="nofollow"><img src="//s.w.org/style/images/feedicon.png" /></a>' .
+                                        '<a href="' . esc_url( "https://plugins.trac.wordpress.org/log/{$post->post_name}/?limit=100&mode=stop_on_copy&format=rss" ) . '" rel="nofollow"><img src="https://s.w.org/style/images/feedicon.png" /></a>' .
                                 '</li>' .
                                 '<li><a href="' . esc_url( "https://plugins.svn.wordpress.org/{$post->post_name}/" ) . '" rel="nofollow">' . __( 'Subversion Repository', 'wporg-plugins' ) . '</a></li>' .
                                 '<li><a href="' . esc_url( "https://plugins.trac.wordpress.org/browser/{$post->post_name}/" ) . '" rel="nofollow">' . __( 'Browse in Trac', 'wporg-plugins' ) . '</a></li>' .
                                 '<li><a href="' . esc_url( "https://translate.wordpress.org/projects/wp-plugins/{$post->post_name}/" ) . '" rel="nofollow">' . __( 'Translation Contributors', 'wporg-plugins' ) . '</a></li>' .
+                                 ( !is_user_logged_in() ? '' : (
+                                        $subscribed ?
+                                        "<li><a href='$subscribe_change_url'>" . __( 'Unsubscribe from plugin commits', 'wporg-plugins' ) . '</a></li>' :
+                                        "<li><a href='$subscribe_change_url'>" . __( 'Subscribe to plugin commits via email', 'wporg-plugins' ) . '</a></li>'
+                                 ) ) .
                         '</ul>';
         }