<!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>[10613] sites/trunk/common/includes/slack/announce: Slack: Announce: Inherit whitelisting from parent channels for sub-channels.</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/10613">10613</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/10613","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>2021-01-21 00:50:18 +0000 (Thu, 21 Jan 2021)</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'>Slack: Announce: Inherit whitelisting from parent channels for sub-channels.
This means that a user who is granted announce rights for #foo is also granted announce rights in #foo-bar.
Users can still be granted rights only for a sub-group however, for example to announce in #foo-bar and not #foo.
See https://wordpress.slack.com/archives/C02QB8GMM/p1611188302085900</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkcommonincludesslackannounceconfigphp">sites/trunk/common/includes/slack/announce/config.php</a></li>
<li><a href="#sitestrunkcommonincludesslackannouncelibphp">sites/trunk/common/includes/slack/announce/lib.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkcommonincludesslackannounceconfigphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/common/includes/slack/announce/config.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/common/includes/slack/announce/config.php 2021-01-21 00:44:18 UTC (rev 10612)
+++ sites/trunk/common/includes/slack/announce/config.php 2021-01-21 00:50:18 UTC (rev 10613)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,8 +11,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * As Slack has deprecated the usage of user_names, please use WordPress.org user_logins here. Case Sensitive.
</span><span class="cx" style="display: block; padding: 0 10px"> * See https://api.slack.com/changelog/2017-09-the-one-about-usernames
</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 array keys are the channel name (omit #) and the
- * values are an array of users.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The array keys are the channel name (omit #) and the values are an array of users.
+ *
+ * NOTES:
+ * - Use the linked WordPress.org username, which is case-sensitive. Ask the user to type in `/here` in slack to find out the correct account.
+ * - Private groups do NOT need to be listed here. All members of a private group can use announcements.
+ * - Sub-channels inherit access, if a user is granted announce in #foo, they can also announce in #foo-bar.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_whitelist() {
</span><span class="cx" style="display: block; padding: 0 10px"> $wordcamp_central = array(
</span></span></pre></div>
<a id="sitestrunkcommonincludesslackannouncelibphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/common/includes/slack/announce/lib.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/common/includes/slack/announce/lib.php 2021-01-21 00:44:18 UTC (rev 10612)
+++ sites/trunk/common/includes/slack/announce/lib.php 2021-01-21 00:50:18 UTC (rev 10613)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,17 +7,33 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function get_whitelist_for_channel( $channel ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $whitelist = get_whitelist();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $whitelist[ $channel ] ) ) {
- return $whitelist[ $channel ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $users = [];
+
+ if ( ! empty( $whitelist[ $channel ] ) ) {
+ $users = $whitelist[ $channel ];
</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 array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $parent_channel = get_parent_channel( $channel );
+ if ( $parent_channel && ! empty( $whitelist[ $parent_channel ] ) ) {
+ $users = array_merge( $users, $whitelist[ $parent_channel ] );
+ }
+
+ // Some users are listed twice, due to array_merge() in config & parent channel above.
+ $users = array_unique( $users );
+
+ return $users;
</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"> function get_whitelisted_channels_for_user( $user ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $whitelist = get_whitelist();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Note: Due to inherited whitelisting from parent channels, only channels which are known by config.php will be listed.
+ // although the user might have access to other #parent-xxxx channels that are unknown to the API.
+
+ $whitelist = get_whitelist();
</ins><span class="cx" style="display: block; padding: 0 10px"> $whitelisted = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $whitelist as $channel => $users ) {
- if ( in_array( $user, $users, true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ foreach ( array_keys( $whitelist ) as $channel ) {
+ if ( is_user_whitelisted( $user, $channel ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $whitelisted[] = $channel;
</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">@@ -63,6 +79,40 @@
</span><span class="cx" style="display: block; padding: 0 10px"> printf( "Your linked WordPress.org account that needs to be granted access is '%s'.", $user );
</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">+function get_parent_channel( $channel ) {
+ // Private groups are not actually channels.
+ if ( 'privategroup' === $channel ) {
+ return false;
+ }
+
+ list( $parent_channel, ) = explode( '-', $channel, 2 );
+
+ // Some channels parents are not a 1:1 match.
+ switch ( $parent_channel ) {
+ case 'accessibility':
+ case 'design':
+ case 'feature':
+ case 'tide':
+ $parent_channel = 'core';
+ break;
+ case 'community':
+ $parent_channel = 'community-team';
+ break;
+ }
+
+ // No parent channel!
+ if ( $parent_channel === $channel ) {
+ return false;
+ }
+
+ // Is it an actual channel? Assume that there'll always be at least one whitelisted user for the parent channel
+ if ( ! get_whitelist_for_channel( $parent_channel ) ) {
+ return false;
+ }
+
+ return $parent_channel;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function run( $data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,30 +193,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $send->send( $data['channel_id'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Broadcast this message as a non-@here to the "parent" channel too.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- list( $parent_channel, ) = explode( '-', $channel, 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $parent_channel = get_parent_channel( $channel );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Some channels parents are not a 1:1 match.
- switch ( $parent_channel ) {
- case 'accessibility':
- case 'design':
- case 'feature':
- case 'tide':
- $parent_channel = 'core';
- break;
- case 'community':
- $parent_channel = 'community-team';
- break;
- }
-
- // Validate the channel.
- if (
- // Skip for private groups.
- 'privategroup' === $parent_channel ||
- // If this message was posted in the "parent" channel, nothing to do.
- $parent_channel === $channel ||
- // Is it an actual channel? Assume that there'll always be at least one whitelisted user for the parent channel
- ! get_whitelist_for_channel( $parent_channel )
- ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Validate the parent channel exists.
+ if ( ! $parent_channel ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</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>