<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[11829] sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php: Profiles: Remove unnecessary Learn handler abstraction.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/11829">11829</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/11829","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-05-10 23:25:28 +0000 (Tue, 10 May 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Profiles: Remove unnecessary Learn handler abstraction.
The client is already authenticated, and is already passing `activity_args`, so the abstraction just adds a lot of boilerplate that Learn (and most other handlers) don't need.
`handle_activity()` can still act as a middleman to preserve backcompat if BuddyPress ever changes the options, but that's unlikely. `format_callback` can also be used if we ever want to override the `action` passed by the client.
See https://github.com/WordPress/five-for-the-future/issues/191</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkprofileswordpressorgpublic_htmlwpcontentpluginswporgprofilesactivityhandlerwporgprofilesactivityhandlerphp">sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkprofileswordpressorgpublic_htmlwpcontentpluginswporgprofilesactivityhandlerwporgprofilesactivityhandlerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php 2022-05-10 23:25:22 UTC (rev 11828)
+++ sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php 2022-05-10 23:25:28 UTC (rev 11829)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,7 +6,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> Author URI: http://www.mertyazicioglu.com
</span><span class="cx" style="display: block; padding: 0 10px"> License: GPL2
</span><span class="cx" style="display: block; padding: 0 10px"> Version: 1.1
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-Description: Handles the activites sent from other services in the .org ecosystem (bbPress, WP, Trac).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+Description: Handles the activities sent from other services in the .org ecosystem (bbPress, WP, Trac).
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /* Copyright 2013 Mert Yazicioglu (email : mert@mertyazicioglu.com)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,26 +175,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> die( '-1 Activity component not activated' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ try {
+ $activity = $this->sanitize_activity( $_POST );
+ } catch ( Exception $exception ) {
+ die( wp_kses_post( $exception->getMessage() ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $source = sanitize_text_field( $_POST['source'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> // The `slack` source requires multiples users, so the parameters are named differently.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $_POST['user'] ) && 'slack' !== $source ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $_POST['user'] ) && empty( $_POST['user_id'] ) && 'slack' !== $source ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> die( '-1 No user specified.' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Disable default BP moderation
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_action( 'bp_activity_before_save', 'bp_activity_check_moderation_keys', 2, 1 );
- remove_action( 'bp_activity_before_save', 'bp_activity_check_blacklist_keys', 2, 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_action( 'bp_activity_before_save', 'bp_activity_check_moderation_keys', 2 );
+ remove_action( 'bp_activity_before_save', 'bp_activity_check_blacklist_keys', 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Disable requirement that user have a display_name set
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'bp_activity_before_save', 'bporg_activity_requires_display_name' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If an activity doesn't require special logic, then `add_activity()` can be called directly. Compare
+ // Learn and Slack to see the difference.
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $source ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'forum':
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_id = $this->handle_forum_activity();
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'learn':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $activity_id = $this->handle_learn_activity();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $activity_id = $this->add_activity( $activity );
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'plugin':
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_id = $this->handle_plugin_activity();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -228,32 +235,70 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add an activity payload to a profile
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sanitize a `$_POST` request to add activity.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $component
- * @param string $type
- * @param mixed $user
- * @param array $activity_args The arguments that should be passed to `bp_activity_add()`, minus the other params passed in to this function
- *
- * @return int|string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @throws Exception
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected function add_activity( string $component, string $type, $user, array $activity_args ) {
- $user = $this->get_user( $user );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function sanitize_activity( array $activity ) : array {
+ $defaults = array(
+ // These items are intentionally left out as a precaution.
+ // `id`, `recorded_time`, `is_spam`, `hide_sitewide`.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // These are safe for clients to override.
+ 'action' => '',
+ 'content' => '',
+ 'component' => false,
+ 'type' => false,
+ 'primary_link' => '',
+ 'user_id' => false,
+ 'item_id' => false,
+ 'secondary_item_id' => false,
+ 'error_type' => 'wp_error',
+ );
+
+ // Map a few differences between what the client sends and what `bp_activity_add()` expects.
+ $activity['component'] = $activity['source'];
+ $activity['action'] = $activity['message']; // The original `action` is the `admin-ajax.php` action.
+ $activity['type'] = $activity['component'] . '_' . $activity['type'];
+
+ $activity = array_intersect_key( $activity, $defaults );
+ $activity = array_merge( $defaults, $activity );
+
+ $filters = array(
+ 'wp_kses_data' => array( 'action', 'content' ),
+ 'sanitize_text_field' => array( 'component', 'type', 'error_type' ),
+ 'intval' => array( 'user_id', 'item_id', 'secondary_item_id' ),
+ 'sanitize_url' => array( 'primary_link' ),
+ );
+
+ foreach ( $filters as $filter => $keys ) {
+ foreach ( $keys as $key ) {
+ $activity[ $key ] = call_user_func( $filter, $activity[ $key ] );
+ }
+ }
+
+ $user = get_user_by( 'id', $activity['user_id'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $user ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return '-1 Activity reported for unrecognized user : ' . $user;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ throw new Exception( '-1 Activity reported for unrecognized user ID: ' . $activity['user_id'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $required_args = array(
- 'user_id' => $user->ID,
- 'component' => $component,
- 'type' => "{$component}_$type",
- 'error_type' => 'wp_error',
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $activity['user_id'] = $user->ID;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_activity_args = array_merge( $activity_args, $required_args );
- $activity_id = bp_activity_add( $new_activity_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $activity;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Add an activity payload to a profile
+ *
+ * @param array $activity The arguments that should be passed to `bp_activity_add()`
+ *
+ * @return int|string Activity ID on success; error on failure.
+ */
+ protected function add_activity( array $activity ) {
+ $activity_id = bp_activity_add( $activity );
+
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_int( $activity_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $activity_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,7 +306,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $result = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '-1 Unable to save activity: %s. Request was: %s',
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_id->get_error_message(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_json_encode( $new_activity_args )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_json_encode( $activity )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -389,40 +434,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Process activity stream requests from learn.wordpress.org.
- *
- * @return int|string The activity ID on success; an error message on failure.
- */
- protected function handle_learn_activity() {
- $error = '';
- $activity_args = array();
- $activity_type = sanitize_text_field( $_POST['activity'] );
- $user = sanitize_text_field( $_POST['user'] );
-
- switch ( $activity_type ) {
- case 'course_complete':
- $activity_args = array(
- 'item_id' => absint( $_POST['course_id'] ),
- 'primary_link' => esc_url_raw( $_POST['url'] ),
-
- 'action' => sprintf(
- 'Completed the course <em><a href="%s">%s</a></em> on learn.wordpress.org',
- esc_url( $_POST['url'] ),
- esc_html( $_POST['course_title'] )
- ),
- );
- break;
-
- default:
- $error = '-1 Unrecognized Learn activity.';
- }
-
- $result = $error || $this->add_activity( 'learn', $activity_type, $user, $activity_args );
-
- return $result;
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Handles incoming activities for the Plugins Directory.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Recognized activities:
</span></span></pre>
</div>
</div>
</body>
</html>