<!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>[13675] sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php: Profile Helpers: Avoid calling the badges API if the user already has the badge.</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/13675">13675</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/13675","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-05-08 05:44:41 +0000 (Wed, 08 May 2024)</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'>Profile Helpers: Avoid calling the badges API if the user already has the badge.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentmupluginspubprofilehelpersphp">sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentmupluginspubprofilehelpersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php 2024-05-08 05:10:15 UTC (rev 13674)
+++ sites/trunk/wordpress.org/public_html/wp-content/mu-plugins/pub/profile-helpers.php 2024-05-08 05:44:41 UTC (rev 13675)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,6 +32,31 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get a list of badges for a given user.
+ *
+ * WARNING: Uncached. Excludes dynamically allocated badges.
+ *
+ * @param $users mixed The user to fetch the badged for. A WP_User/ID/Login/Email.
+ * @return array
+ */
+function get_user_badges( $user ) {
+ global $wpdb;
+
+ $user_id = find_user_id( $user );
+
+ $badges = $wpdb->get_results( $wpdb->prepare(
+ "SELECT slug, name
+ FROM bpmain_wporg_groups_members m
+ JOIN bpmain_wporg_groups g ON m.group_id = g.id
+ WHERE m.user_id = %d
+ ORDER BY slug",
+ $user_id
+ ), ARRAY_A );
+
+ return array_column( $badges, 'name', 'slug' );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Record an activity item for a user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $component string The component to be used for the acitivity.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,40 +100,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Assign a badge to a given user.
</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 $action string The action to perform; 'add' or 'remove'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param $action string The action to perform; 'add', 'remove', 'list'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param $badge string The badge group to assign.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param $users mixed The user(s) to assign to. A WP_User/ID/Login/Email/Slug (or array of) of the user(s) to assign.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function badge_api( string $action, string $badge, $users ) : bool {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $users = (array) $users;
- $users = array_filter( array_map( function( $user ) {
- // WP_User-like object.
- if ( is_object( $user ) ) {
- return $user->ID ?? false;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $users = is_object( $users ) ? [ $users ] : (array) $users;
+ $users = array_filter( array_map( __NAMESPACE__ . '\find_user_id', $users ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // User ID.
- if ( is_numeric( $user ) && absint( $user ) == $user ) {
- return (int) $user;
- }
-
- // Support user login / email / slug.
- $_user = get_user_by( 'login', $user );
- if ( ! $_user && is_email( $user ) ) {
- $_user = get_user_by( 'email', $user );
- }
- if ( ! $_user ) {
- $_user = get_user_by( 'slug', $user );
- }
-
- return $_user->ID ?? false;
- }, $users ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! $action || ! $badge || ! $users ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ if ( 'remove' === $action ) {
+ $users = array_filter(
+ $users,
+ function( $user ) use ( $badge ) {
+ return isset( get_user_badges( $user )[ $badge ] );
+ }
+ );
+ } elseif ( 'add' === $action ) {
+ $users = array_filter(
+ $users,
+ function( $user ) use ( $badge ) {
+ return ! isset( get_user_badges( $user )[ $badge ] );
+ }
+ );
+ }
+ // If there are no users now, then the action must have already occured.
+ if ( ! $users ) {
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = api( [
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => 'wporg_handle_association',
</span><span class="cx" style="display: block; padding: 0 10px"> 'source' => 'generic-badge',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -122,6 +146,35 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Find a user ID from a variety of inputs.
+ *
+ * @param $user mixed A WP_User object, user ID, login, email, or slug.
+ * @return int|false
+ */
+function find_user_id( $user ) {
+ // WP_User-like object.
+ if ( is_object( $user ) ) {
+ return $user->ID ?? false;
+ }
+
+ // User ID.
+ if ( is_numeric( $user ) && absint( $user ) == $user ) {
+ return (int) $user;
+ }
+
+ // Support user login / email / slug.
+ $_user = get_user_by( 'login', $user );
+ if ( ! $_user && is_email( $user ) ) {
+ $_user = get_user_by( 'email', $user );
+ }
+ if ( ! $_user ) {
+ $_user = get_user_by( 'slug', $user );
+ }
+
+ return $_user->ID ?? false;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Send requests to Profiles and handle errors.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * `$request_args` should match what the handler expects for a particular request.
</span></span></pre>
</div>
</div>
</body>
</html>