<!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>[11936] sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php: Profiles: Accept bulk GlotPress activity.</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/11936">11936</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/11936","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-07-05 16:59:12 +0000 (Tue, 05 Jul 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: Accept bulk GlotPress activity.
See https://github.com/WordPress/five-for-the-future/issues/196</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-07-04 16:40:35 UTC (rev 11935)
+++ sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php 2022-07-05 16:59:12 UTC (rev 11936)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,9 +182,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Renaming this allows simple handlers to pass the sanitized $_POST directly to `bp_activity_add()`.
</span><span class="cx" style="display: block; padding: 0 10px"> $_POST['action'] = $_POST['message'] ?? '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // The `slack` source requires multiples users, so the parameters are named differently.
- if ( empty( $_POST['user'] ) && empty( $_POST['user_id'] ) && 'slack' !== $source ) {
- throw new Exception( '-1 No user specified.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Slack and GlotPress sometimes include user IDs in a different location, and they always use
+ // `sanitize_activity()`, which checks for a valid user ID. Checking here too adds complexity and
+ // is unnecessary.
+ if ( ! in_array( $source, array( 'slack', 'glotpress' ), true ) ) {
+ if ( empty( $_POST['user'] ) && empty( $_POST['user_id'] ) ) {
+ throw new Exception( '-1 No user specified.' );
+ }
</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"> // Disable default BP moderation
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,7 +208,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $activity_id = bp_activity_add( $this->sanitize_activity( $_POST ) );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'glotpress':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $activity_id = $this->digest_bump( $this->sanitize_activity( $_POST ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $activity_id = $this->handle_glotpress_activity( $_POST );
</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">@@ -870,18 +874,53 @@
</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">- * Bump the count for an activity digest by 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Process activity from translate.w.org (via api.wordpress.org).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|string `true` if all activities are added, string error message if any of them fail.
+ * @throws Exception
+ */
+ protected function handle_glotpress_activity( $post_unsafe ) {
+ $activities = array();
+ $errors = '';
+
+ // The client may send multiple activities in a single request.
+ if ( isset( $post_unsafe['activities'] ) ) {
+ $activities = $post_unsafe['activities'];
+ } else {
+ $activities[] = $post_unsafe;
+ }
+
+ foreach ( $activities as $activity ) {
+ $bump = intval( $activity['bump'] ?? 1 );
+ $activity_id = $this->digest_bump( $this->sanitize_activity( $activity ), $bump );
+
+ if ( is_wp_error( $activity_id ) ) {
+ $errors .= sprintf(
+ '-1 Unable to save activity for %d: %s. ',
+ $activity['user_id'],
+ $activity_id->get_error_message()
+ );
+ }
+ }
+
+ return $errors ?: true;
+ }
+
+ /**
+ * Bump the count for an activity digest.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * Many contributions happen too frequently to show each one on a profile, because they would quickly fill
</span><span class="cx" style="display: block; padding: 0 10px"> * it, and crowd out all of the person's other activities. This creates a rolling digest, so that only 1
</span><span class="cx" style="display: block; padding: 0 10px"> * entry per day is created. That single entry gets updated each time a new action occurs, so the latest
</span><span class="cx" style="display: block; padding: 0 10px"> * count is always displayed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $new_activity
- *
- * @return WP_Error|bool|int
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Error|int
</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 digest_bump( array $new_activity ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected function digest_bump( array $new_activity, int $bump = 1 ) {
+ // Standardize on this to reduce the number of paths in error handling code.
+ // Also done in `sanitize_activity()`, but callers aren't guaranteed to use that.
+ $new_activity['error_type'] = 'wp_error';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => 'ids',
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page' => 1,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -913,15 +952,16 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $stored_activity_id = bp_activity_get( $args )['activities'][0] ?? false;
</span><span class="cx" style="display: block; padding: 0 10px"> $current_count = (int) bp_activity_get_meta( $stored_activity_id, 'digest_count', true );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_action = $this->get_digest_actions( $new_activity['component'], $new_activity['type'], $current_count + 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_action = $this->get_digest_actions( $new_activity['component'], $new_activity['type'], $current_count + $bump );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $stored_activity_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $activity_id = $stored_activity_id;
- $activity_object = new BP_Activity_Activity( $activity_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $activity_object = new BP_Activity_Activity( $stored_activity_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $activity_object->action = $new_action;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $saved = $activity_object->save();
+ $activity_id = is_wp_error( $saved ) ? $saved : $stored_activity_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">- $activity_object->save();
- bp_activity_update_meta( $activity_id, 'digest_count', $current_count + 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Increase this even if couldn't update action, to preserve accurate count.
+ bp_activity_update_meta( $activity_id, 'digest_count', $current_count + $bump );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $new_activity['action'] = $new_action;
</span></span></pre>
</div>
</div>
</body>
</html>