<!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>[10614] sites/trunk/common/includes/slack/announce/lib.php: Slack: Announce: Add some context to `get_whitelisted_channels_for_user()` to ensure that it will properly state the user has access to an "unknown" current channel if it has no whitelisted users, but the user is granted access via the inherited grants.</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/10614">10614</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/10614","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 01:01:08 +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: Add some context to `get_whitelisted_channels_for_user()` to ensure that it will properly state the user has access to an "unknown" current channel if it has no whitelisted users, but the user is granted access via the inherited grants.

Follow up to <a href="http://meta.trac.wordpress.org/changeset/10613">[10613]</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkcommonincludesslackannouncelibphp">sites/trunk/common/includes/slack/announce/lib.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<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:50:18 UTC (rev 10613)
+++ sites/trunk/common/includes/slack/announce/lib.php  2021-01-21 01:01:08 UTC (rev 10614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,19 +25,30 @@
</span><span class="cx" style="display: block; padding: 0 10px">        return $users;
</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">-function get_whitelisted_channels_for_user( $user ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Get the whitelisted channels for a user.
+ * 
+ * @param $user           string The user to get the list of channels for.
+ * @param $known_channels array  An optional list of channels which are known, so messaging can correctly identify a channel that's not whitelisted. Optional.
+ */
+function get_whitelisted_channels_for_user( $user, $known_channels = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">         // Note: Due to inherited whitelisting from parent channels, only channels which are known by config.php will be listed.
</span><span class="cx" style="display: block; padding: 0 10px">        // although the user might have access to other #parent-xxxx channels that are unknown to the API.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        // $known_channels attempts to help with this, ensuring that the authorization message has the context of the current channel.
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        $whitelist   = get_whitelist();
</span><span class="cx" style="display: block; padding: 0 10px">        $whitelisted = array();
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        foreach ( array_keys( $whitelist ) as $channel ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $channels = array_unique( array_merge( array_keys( $whitelist ), (array) $known_channels ) );
+
+       foreach ( $channels as $channel ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                 if ( is_user_whitelisted( $user, $channel ) ) {
</span><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="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        sort( $whitelisted );
+
</ins><span class="cx" style="display: block; padding: 0 10px">         return $whitelisted;
</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">@@ -56,7 +67,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        echo "Valid commands are /at-channel for an @channel, and /announce or /here to perform an @here.\n";
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        $channels = get_whitelisted_channels_for_user( $user );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $channels = get_whitelisted_channels_for_user( $user, $channel );
</ins><span class="cx" style="display: block; padding: 0 10px">         if ( $channel === 'privategroup' ) {
</span><span class="cx" style="display: block; padding: 0 10px">                echo "Any private group members can use these commands in this group.";
</span><span class="cx" style="display: block; padding: 0 10px">                return;
</span></span></pre>
</div>
</div>

</body>
</html>