Changeset 3545

Timestamp:

06/22/2016 01:33:53 PM (8 years ago)

Author:

dd32

Message:

Plugin Directory: Add plugin favoriting to the user interface.
Someone will need to style this properly.

Fixes #1577

Location:

sites/trunk/wordpress.org/public_html/wp-content

Files:

• plugins/plugin-directory/api/class-base.php (modified) (1 diff)
• plugins/plugin-directory/api/routes/class-plugin-favorites.php (copied) (copied from sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/api/routes/class-commit-subscriptions.php) (3 diffs)
• plugins/plugin-directory/class-template.php (modified) (1 diff)
• plugins/plugin-directory/class-tools.php (modified) (1 diff)
• themes/pub/wporg-plugins/css/style-rtl.css (modified) (1 diff)
• themes/pub/wporg-plugins/css/style.css (modified) (1 diff)
• themes/pub/wporg-plugins/sass/site/primary/_plugin-single.scss (modified) (1 diff)
• themes/pub/wporg-plugins/template-parts/plugin-single.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();
         new Routes\Plugin_Translations();
+        new Routes\Plugin_Favorites();
+        new Routes\Commit_Subscriptions();
         new Routes\Popular_Categories();
         new Routes\Query_Plugins();

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

@@ -6 +6 @@
 
 /**
- * An API endpoint for subscribing to commits for a particular plugin.
+ * An API endpoint for favoriting a particular plugin.
  *
  * @package WordPressdotorg_Plugin_Directory
  */
-class Commit_Subscriptions extends Base {
+class Plugin_Favorites extends Base {
 
     public function __construct() {
-        register_rest_route( 'plugins/v1', '/plugin/(?P<plugin_slug>[^/]+)/commit-subscription', array(
-            'methods'  => \WP_REST_Server::READABLE,
-            'callback' => array( $this, 'subscribe' ),
+        register_rest_route( 'plugins/v1', '/plugin/(?P<plugin_slug>[^/]+)/favorite', array(
+            'methods'  => array( \WP_REST_Server::READABLE, \WP_REST_Server::CREATABLE ),
+            'callback' => array( $this, 'favorite' ),
             'args' => array(
                 'plugin_slug' => array(
                     'validate_callback' => array( $this, 'validate_plugin_slug_callback' ),
                 ),
-                'subscribe' => array(
+                'favorite' => array(
                     'validate_callback' => function( $bool ) { return is_numeric( $bool ); },
                 ),
-                'unsubscribe' => array(
+                'unfavorite' => array(
                     'validate_callback' => function( $bool ) { return is_numeric( $bool ); },
                 ),
@@ -32 +32 @@
 
     /**
-     * Endpoint to subscribe to a plugin's commits.
+     * Endpoint to favorite a plugin.
      *
      * @param \WP_REST_Request $request The Rest API Request.
-     * @return bool True if the subscription was successful.
+     * @return bool True if the favoriting was successful.
      */
-    public function subscribe( $request ) {
-        $location = get_permalink( Plugin_Directory::get_plugin_post( $request['plugin_slug'] ) ) . '#developers';
+    public function favorite( $request ) {
+        $location = get_permalink( Plugin_Directory::get_plugin_post( $request['plugin_slug'] ) );
         header( "Location: $location" );
 
@@ -45 +45 @@
         );
 
-        if ( ! isset( $request['subscribe'] ) && ! isset( $request['unsubscribe'] ) ) {
+        if ( ! isset( $request['favorite'] ) && ! isset( $request['unfavorite'] ) ) {
             $result['error'] = 'Unknown Action';
         }
 
-        $result['subscribed'] = Tools::subscribe_to_plugin_commits( $request['plugin_slug'], get_current_user_id(), isset( $request['subscribe'] ) );
+        $result['favorite'] = Tools::favorite_plugin( $request['plugin_slug'], get_current_user_id(), isset( $request['favorite'] ) );
 
         return (object) $result;

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

@@ -462 +462 @@
         return ent2ncr( htmlspecialchars_decode( htmlentities( $string, ENT_NOQUOTES, 'UTF-8' ), ENT_NOQUOTES ) );
     }
+
+    /**
+     * Generates a link to toggle a plugin favorites state.
+     *
+     * @param string $plugin_slug The plugin slug.
+     * @param mixed  $user        The user to alter the favorite status for.
+     * @return string URL to toggle status.
+     */
+    public static function get_favourite_link( $plugin_slug, $user = 0 ) {
+        $post = Plugin_Directory::get_plugin_post( $plugin_slug );
+        if ( ! $post ) {
+            return false;
+        }
+
+        $favorited = Tools::favorited_plugin( $post, $user );
+
+        return add_query_arg(
+            array(
+                '_wpnonce' => wp_create_nonce( 'wp_rest' ),
+                ( $favorited ? 'unfavorite' : 'favorite' ) => '1'
+            ),
+            home_url( 'wp-json/plugins/v1/plugin/' . $post->post_name . '/favorite' )
+        );
+    }
 }

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

@@ -257 +257 @@
 
     /**
+     * Determine if a plugin has been favorited by a user.
+     *
+     * @param string $plugin_slug The plugin to check.
+     * @param mixed  $user        The user to check.
+     * @return bool
+     */
+    public static function favorited_plugin( $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_favorites = get_user_meta( $user->ID, 'plugin_favorites', true ) ?: array();
+
+        return in_array( $post->post_name, $users_favorites, true );
+    }
+
+    /**
+     * Favorite a plugin
+     *
+     * @param string $plugin_slug The plugin to favorite
+     * @param mixed  $user        The user favorite
+     * @param bool   $favorite    Whether it's a favorite, or unfavorite.
+     * @return bool
+     */
+    public static function favorite_plugin( $plugin_slug, $user = 0, $favorite = 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_favorites = get_user_meta( $user->ID, 'plugin_favorites', true ) ?: array();
+
+        $already_favorited = in_array( $post->post_name, $users_favorites, true );
+
+        if ( $favorite && $already_favorited ) {
+            return true;
+        } elseif ( $favorite ) {
+            // Add it
+            $users_favorites[] = $post->post_name;
+        } elseif ( ! $favorite && $already_favorited ) {
+            // Remove it
+            unset( $users_favorites[ array_search( $post->post_name, $users_favorites, true ) ] );
+        } else {
+            return true;
+        }
+
+        return update_user_meta( $user->ID, 'plugin_favorites', wp_slash( array_values( $users_favorites ) ) );
+
+    }
+
+    /**
      * Retrieve a list of users who are subscribed to plugin commits.
      *

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/css/style-rtl.css

@@ -2159 +2159 @@
 }
 
-.single .type-plugin .plugin-header .plugin-download {
+.single .type-plugin .plugin-header .plugin-actions {
   float: left;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart {
+  color: gray;
+  line-heght: 3em;
+  font-size: 3em;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart.favorited, .single .type-plugin .plugin-header .plugin-favorite-heart:hover, .single .type-plugin .plugin-header .plugin-favorite-heart:focus {
+  color: red;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart:hover, .single .type-plugin .plugin-header .plugin-favorite-heart:focus {
+  text-decoration: none;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart:after {
+  content: "\f487";
+  font-family: dashicons;
+  vertical-align: top;
 }
 

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/css/style.css

@@ -2159 +2159 @@
 }
 
-.single .type-plugin .plugin-header .plugin-download {
+.single .type-plugin .plugin-header .plugin-actions {
   float: right;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart {
+  /* FIX ME */
+  color: gray;
+  line-heght: 3em;
+  font-size: 3em;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart.favorited, .single .type-plugin .plugin-header .plugin-favorite-heart:hover, .single .type-plugin .plugin-header .plugin-favorite-heart:focus {
+  color: red;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart:hover, .single .type-plugin .plugin-header .plugin-favorite-heart:focus {
+  text-decoration: none;
+}
+
+.single .type-plugin .plugin-header .plugin-favorite-heart:after {
+  content: "\f487";
+  font-family: dashicons;
+  vertical-align: top;
 }
 

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/sass/site/primary/_plugin-single.scss

@@ -47 +47 @@
         }
 
-        .plugin-download {
+        .plugin-actions {
             float: right;
+        }
+
+        .plugin-favorite-heart {
+            /* FIX ME */
+            color: gray;
+            line-heght: 3em;
+            font-size: 3em;
+
+            &.favorited,
+            &:hover,
+            &:focus {
+                color: red;
+            }
+
+            &:hover,
+            &:focus {
+                text-decoration: none;
+            }
+
+            &:after {
+                content: "\f487";
+                font-family: dashicons;
+                vertical-align: top;
+            }
+            
         }
 

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-plugins/template-parts/plugin-single.php

@@ -11 +11 @@
 use WordPressdotorg\Plugin_Directory\Plugin_Directory;
 use WordPressdotorg\Plugin_Directory\Template;
+use WordPressdotorg\Plugin_Directory\Tools;
 
 $content = Plugin_Directory::instance()->split_post_content_into_pages( get_the_content() );
@@ -33 +34 @@
         </div>
 
-        <a class="plugin-download button download-button button-large" href="<?php echo esc_url( Template::download_link() ); ?>" itemprop="downloadUrl"><?php _e( 'Download', 'wporg-plugins' ); ?></a>
-        <meta itemprop="softwareVersion" content="<?php echo esc_attr( get_post_meta( get_the_ID(), 'version', true ) ); ?>">
-        <meta itemprop="fileFormat" content="application/zip">
+        <div class="plugin-actions">
+
+            <?php
+            if ( is_user_logged_in() ) {
+                $url = Template::get_favourite_link( $post );
+                echo '<a href="' . esc_url( $url ) . '" class="plugin-favorite-heart' . (Tools::favorited_plugin( $post ) ? ' favorited' : '' ) . '" onclick="jQuery(this).toggleClass(\'favorited\')"></a>';
+            }
+            ?>
+
+            <a class="plugin-download button download-button button-large" href="<?php echo esc_url( Template::download_link() ); ?>" itemprop="downloadUrl"><?php _e( 'Download', 'wporg-plugins' ); ?></a>
+            <meta itemprop="softwareVersion" content="<?php echo esc_attr( get_post_meta( get_the_ID(), 'version', true ) ); ?>">
+            <meta itemprop="fileFormat" content="application/zip">
+        </div>
 
         <?php the_title( '<h1 class="plugin-title">', '</h1>' ); ?>