Changeset 9682

Timestamp:

04/02/2020 02:23:28 AM (5 years ago)

Author:

dd32

Message:

Plugin Directory: Add audit log entries for plugin committer/support reps addition/removal.

Fixes #2717.

Location:

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

Files:

• admin/class-status-transitions.php (modified) (5 diffs)
• admin/metabox/class-internal-notes.php (modified) (1 diff)
• api/routes/class-plugin-self-close.php (modified) (1 diff)
• class-tools.php (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/class-status-transitions.php

@@ -280 +280 @@
         );
 
-        $this->audit_log( 'Plugin approved.', $post_id );
+        Tools::audit_log( 'Plugin approved.', $post_id );
         wp_mail( $plugin_author->user_email, $subject, $content, 'From: plugins@wordpress.org' );
     }
@@ -322 +322 @@
         );
 
-        $this->audit_log( 'Plugin rejected.', $post_id );
+        Tools::audit_log( 'Plugin rejected.', $post_id );
         wp_mail( $email, $subject, $content, 'From: plugins@wordpress.org' );
     }
@@ -362 +362 @@
         $post = get_post( $post_id );
         if ( $post && 'approved' != $post->post_status ) {
-            $this->audit_log( 'Plugin reopened.', $post_id );
+            Tools::audit_log( 'Plugin reopened.', $post_id );
         }
     }
@@ -385 +385 @@
         update_post_meta( $post_id, 'plugin_closed_date', current_time( 'mysql' ) );
 
-        $this->audit_log( sprintf( 'Plugin closed. Reason: %s', $close_reason ), $post_id );
+        Tools::audit_log( sprintf( 'Plugin closed. Reason: %s', $close_reason ), $post_id );
     }
 
@@ -406 +406 @@
         $new_owner = get_userdata( $post_after->post_author );
 
-        $this->audit_log( sprintf(
+        Tools::audit_log( sprintf(
             'Ownership transferred to <a href="%s">%s</a>.',
-            esc_url( '//profiles.wordpress.org/' . $new_owner->user_nicename ),
+            esc_url( 'https://profiles.wordpress.org/' . $new_owner->user_nicename .'/' ),
             $new_owner->user_login
         ), $post_id );
     }
 
-    /**
-     * Saves an audit_log comment for the plugin.
-     *
-     * @param string  $message The message for the audit log.
-     * @param integer $post_id The Post ID.
-     */
-    public function audit_log( $message, $post_id ) {
-        $user = wp_get_current_user();
-
-        $comment = array(
-            'comment_author'       => $user->display_name,
-            'comment_author_email' => $user->user_email,
-            'comment_author_url'   => $user->user_url,
-            'comment_type'         => 'internal-note',
-            'comment_post_ID'      => $post_id,
-            'user_id'              => get_current_user_id(),
-            'comment_content'      => $message,
-        );
-        wp_insert_comment( $comment );
-    }
 }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/metabox/class-internal-notes.php

@@ -47 +47 @@
      * @param string $action Action to perform.
      */
-    function get_notes( $action ) {
+    public static function get_notes( $action ) {
         global $post_id;
         if ( empty( $action ) ) {

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

@@ -74 +74 @@
 
         // Add an audit-log entry as to why this has happened.
-        $user = wp_get_current_user();
-        wp_insert_comment( [
-            'comment_author'       => $user->display_name,
-            'comment_author_email' => $user->user_email,
-            'comment_author_url'   => $user->user_url,
-            'comment_type'         => 'internal-note',
-            'comment_post_ID'      => $plugin->ID,
-            'user_id'              => get_current_user_id(),
-            'comment_content'      => sprintf( 'Plugin closed. Reason: Author Self-close Request from %s', $_SERVER['REMOTE_ADDR'] ),
-        ] );
+        Tools::audit_log(
+            $plugin,
+            sprintf( 'Plugin closed. Reason: Author Self-close Request from %s', $_SERVER['REMOTE_ADDR'] )
+        );
 
         // Email all Plugin Committers.

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

@@ -197 +197 @@
         Tools::sync_plugin_committers_with_taxonomy( $plugin_slug );
 
+        Tools::audit_log(
+            sprintf(
+                'Added <a href="%s">%s</a> as a committer.',
+                esc_url( 'https://profiles.wordpress.org/' . $user->user_nicename . '/' ),
+                $user->user_login
+            ),
+            $plugin_slug
+        );
+
         return $result;
     }
@@ -229 +238 @@
         wp_cache_delete( $user->user_login, 'committer-plugins' );
         Tools::sync_plugin_committers_with_taxonomy( $plugin_slug );
+
+        Tools::audit_log(
+            sprintf(
+                'Removed <a href="%s">%s</a> as a committer.',
+                esc_url( 'https://profiles.wordpress.org/' . $user->user_nicename . '/' ),
+                $user->user_login
+            ),
+            $plugin_slug
+        );
 
         return $result;
@@ -326 +344 @@
         wp_cache_delete( $user->user_nicename, 'support-rep-plugins' );
 
+        Tools::audit_log(
+            sprintf(
+                'Added <a href="%s">%s</a> as a support rep.',
+                esc_url( 'https://profiles.wordpress.org/' . $user->user_nicename . '/' ),
+                $user->user_login
+            ),
+            $plugin_slug
+        );
+
         return $result;
     }
@@ -357 +384 @@
         wp_cache_delete( $plugin_slug, 'plugin-support-reps' );
         wp_cache_delete( $user->user_nicename, 'support-rep-plugins' );
+
+        Tools::audit_log(
+            sprintf(
+                'Removed <a href="%s">%s</a> as a support rep.',
+                esc_url( 'https://profiles.wordpress.org/' . $user->user_nicename . '/' ),
+                $user->user_login
+            ),
+            $plugin_slug
+        );
 
         return $result;
@@ -557 +593 @@
         }
     }
+
+    /**
+     * Add an Audit Internal Note for a plugin.
+     * 
+     * @param int|string|WP_Post $plugin A Post ID, Plugin Slug or, WP_Post object.
+     * @param string $note The note to audit log entry to add.
+     * @param WP_User $user The user which performed the action. Optional.
+     */
+    public static function audit_log( $note, $plugin = null, $user = false ) {
+        if ( is_string( $plugin ) && ! is_numeric( $plugin ) ) {
+            $plugin = Plugin_Directory::get_plugin_post( $plugin );
+        } else {
+            $plugin = get_post( $plugin );
+        }
+
+        if ( ! $note || ! $plugin ) {
+            return false;
+        }
+        if ( ! $user || ! ( $user instanceof \WP_User ) ) {
+            $user = wp_get_current_user();
+        }
+
+        return wp_insert_comment( [
+            'comment_author'       => $user->display_name,
+            'comment_author_email' => $user->user_email,
+            'comment_author_url'   => $user->user_url,
+            'comment_author_IP'    => $_SERVER['REMOTE_ADDR'],
+            'comment_type'         => 'internal-note',
+            'comment_post_ID'      => $plugin->ID,
+            'user_id'              => $user->ID,
+            'comment_content'      => $note,
+        ] );
+    }
 }