<!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>[11830] sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php: Profiles: Use exceptions to simplify error flows and centralize logs.</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/11830">11830</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/11830","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:37 +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: Use exceptions to simplify error flows and centralize logs.
Adding logging to the previous structure would have created a lot of redundant code.</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:28 UTC (rev 11829)
+++ sites/trunk/profiles.wordpress.org/public_html/wp-content/plugins/wporg-profiles-activity-handler/wporg-profiles-activity-handler.php 2022-05-10 23:25:37 UTC (rev 11830)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,80 +158,88 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * register themselves.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function handle_activity() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * This is useful for testing on your sandbox.
- *
- * e.g., Edit `$_POST['user_id']` so that activity goes to a test account rather than a real one.
- */
- do_action( 'wporg_profiles_before_handle_activity' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ try {
+ /*
+ * This is useful for testing on your sandbox.
+ *
+ * e.g., Edit `$_POST['user_id']` so that activity goes to a test account rather than a real one.
+ */
+ do_action( 'wporg_profiles_before_handle_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">- // Return error if not a valid activity request.
- if ( true !== apply_filters( 'wporg_is_valid_activity_request', false ) ) {
- die( '-1 Not a valid activity request' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Return error if not a valid activity request.
+ if ( true !== apply_filters( 'wporg_is_valid_activity_request', false ) ) {
+ throw new Exception( '-1 Not a valid activity request' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Return error if activities are not enabled.
- if ( ! bp_is_active( 'activity' ) ) {
- die( '-1 Activity component not activated' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Return error if activities are not enabled.
+ if ( ! bp_is_active( 'activity' ) ) {
+ throw new Exception( '-1 Activity component not activated' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- try {
- $activity = $this->sanitize_activity( $_POST );
- } catch ( Exception $exception ) {
- die( wp_kses_post( $exception->getMessage() ) );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $source = sanitize_text_field( $_POST['source'] ?? $_POST['component'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $source = sanitize_text_field( $_POST['source'] );
- // The `slack` source requires multiples users, so the parameters are named differently.
- if ( empty( $_POST['user'] ) && empty( $_POST['user_id'] ) && 'slack' !== $source ) {
- die( '-1 No user specified.' );
- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Disable default BP moderation
- remove_action( 'bp_activity_before_save', 'bp_activity_check_moderation_keys', 2 );
- remove_action( 'bp_activity_before_save', 'bp_activity_check_blacklist_keys', 2 );
</del><ins style="background-color: #dfd; 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.' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Disable requirement that user have a display_name set
- remove_filter( 'bp_activity_before_save', 'bporg_activity_requires_display_name' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Disable default BP moderation
+ 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><del style="background-color: #fdd; 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.
- switch ( $source ) {
- case 'forum':
- $activity_id = $this->handle_forum_activity();
- break;
- case 'learn':
- $activity_id = $this->add_activity( $activity );
- break;
- case 'plugin':
- $activity_id = $this->handle_plugin_activity();
- break;
- case 'theme':
- $activity_id = $this->handle_theme_activity();
- break;
- case 'trac':
- $activity_id = $this->handle_trac_activity();
- break;
- case 'wordcamp':
- $activity_id = $this->handle_wordcamp_activity();
- break;
- case 'wordpress':
- $activity_id = $this->handle_wordpress_activity();
- break;
- case 'slack':
- $activity_id = $this->handle_slack_activity();
- break;
- default:
- $activity_id = '-1 Unrecognized activity source';
- break;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Disable requirement that user have a display_name set
+ remove_filter( 'bp_activity_before_save', 'bporg_activity_requires_display_name' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( false === $activity_id ) {
- $activity_id = '-1 Unable to save activity';
</del><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.
+ switch ( $source ) {
+ case 'forum':
+ $activity_id = $this->handle_forum_activity();
+ break;
+ case 'learn':
+ $activity_id = $this->add_activity( $activity );
+ break;
+ case 'plugin':
+ $activity_id = $this->handle_plugin_activity();
+ break;
+ case 'theme':
+ $activity_id = $this->handle_theme_activity();
+ break;
+ case 'trac':
+ $activity_id = $this->handle_trac_activity();
+ break;
+ case 'wordcamp':
+ $activity_id = $this->handle_wordcamp_activity();
+ break;
+ case 'wordpress':
+ $activity_id = $this->handle_wordpress_activity();
+ break;
+ case 'slack':
+ $activity_id = $this->handle_slack_activity();
+ break;
+ default:
+ throw new Exception( '-1 Unrecognized activity source' );
+ break;
+ }
+
+ if ( is_wp_error( $activity_id ) ) {
+ throw new Exception( '-1 Unable to save activity: ' . $activity_id->get_error_message() );
+ } elseif ( str_starts_with( $activity_id, '-1' ) ) {
+ throw new Exception( $activity_id );
+ } elseif ( false === $activity_id || intval( $activity_id ) <= 0 ) {
+ throw new Exception( '-1 Unable to save activity' );
+ }
+
+ $response = '1';
+
+ } catch ( Exception $exception ) {
+ trigger_error( $exception->getMessage(), E_USER_WARNING );
+
+ $response = $exception->getMessage();
</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">- $success = intval( $activity_id ) > 0 ? '1' : $activity_id;
- die( $success );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ die( $response );
</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></pre>
</div>
</div>
</body>
</html>