Support private channels

This patch adds support to private channels. Previously, private
channels were read-only, while now it's bidirectional like public
channels and IMs.

This required a refactoring of the channels API, and a few bug fixes.
Now anything channel-related goes through the Channel and Channels
structures, and should not use the Slack conversations API directly
anymore.

Signed-off-by: Andrea Barberio <[email protected]>

pkg/ircslack/channel.go

@@ -0,0 +1,90 @@
+package ircslack
+
+import (
+	"strings"
+
+	"github.com/slack-go/slack"
+)
+
+// Constants for public, private, and multi-party conversation prefixes.
+// Channel threads are prefixed with "+" but they are not conversation types
+// so they do not belong here. A thread is just a message whose destination
+// is within another message in a public, private, or multi-party conversation.
+const (
+	ChannelPrefixPublicChannel  = "#"
+	ChannelPrefixPrivateChannel = "@"
+	ChannelPrefixMpIM           = "&"
+	// NOTE: a thread is not a channel type
+	ChannelPrefixThread = "+"
+)
+
+// HasChannelPrefix returns true if the channel name starts with one of the
+// supproted channel prefixes.
+func HasChannelPrefix(name string) bool {
+	if len(name) == 0 {
+		return false
+	}
+	switch string(name[0]) {
+	case ChannelPrefixPublicChannel, ChannelPrefixPrivateChannel, ChannelPrefixMpIM, ChannelPrefixThread:
+		return true
+	default:
+		return false
+	}
+}
+
+// StripChannelPrefix returns a channel name without its channel prefix. If no
+// channel prefix is present, the string is returned unchanged.
+func StripChannelPrefix(name string) string {
+	if HasChannelPrefix(name) {
+		return name[1:]
+	}
+	return name
+}
+
+// Channel wraps a Slack conversation with a few utility functions.
+type Channel slack.Channel
+
+// IsPublicChannel returns true if the channel is public.
+func (c *Channel) IsPublicChannel() bool {
+	return c.IsChannel && !c.IsPrivate
+}
+
+// IsPrivateChannel returns true if the channel is private.
+func (c *Channel) IsPrivateChannel() bool {
+	return c.IsGroup && c.IsPrivate
+}
+
+// IsMP returns true if it is a multi-party conversation.
+func (c *Channel) IsMP() bool {
+	return c.IsMpIM
+}
+
+// IRCName returns the channel name as it would appear on IRC.
+// Examples:
+// * #channel for public groups
+// * @channel for private groups
+// * &Gxxxx|nick1-nick2-nick3 for multi-party IMs
+func (c *Channel) IRCName() string {
+	switch {
+	case c.IsPublicChannel():
+		return ChannelPrefixPublicChannel + c.Name
+	case c.IsGroup && c.IsPrivate:
+		return ChannelPrefixPrivateChannel + c.Name
+	case c.IsMP():
+		name := ChannelPrefixMpIM + c.ID + "|" + c.Name
+		name = strings.Replace(name, "mpdm-", "", -1)
+		name = strings.Replace(name, "--", "-", -1)
+		if len(name) >= 30 {
+			return name[:29] + "…"
+		}
+		return name
+	default:
+		log.Warningf("Unknown channel type for channel %+v", c)
+		return "<unknow-channel-type>"
+	}
+}
+
+// SlackName returns the slack.Channel.Name field.
+func (c *Channel) SlackName() string {
+	return c.Name
+}

pkg/ircslack/channels.go

@@ -2,7 +2,6 @@ package ircslack
 
 import (
 	"context"
-	"strings"
 	"sync"
 	"time"
 
@@ -11,23 +10,36 @@ import (
 
 // Channels wraps the channel list with convenient operations and cache.
 type Channels struct {
-	channels   map[string]slack.Channel
+	channels   map[string]Channel
 	Pagination int
 	mu         sync.Mutex
 }
 
 // NewChannels creates a new Channels object.
 func NewChannels(pagination int) *Channels {
 	return &Channels{
-		channels:   make(map[string]slack.Channel),
+		channels:   make(map[string]Channel),
 		Pagination: pagination,
 	}
 }
 
+// SupportedChannelPrefixes returns a list of supported channel prefixes.
+func SupportedChannelPrefixes() []string {
+	return []string{
+		ChannelPrefixPublicChannel,
+		ChannelPrefixPrivateChannel,
+		ChannelPrefixMpIM,
+		ChannelPrefixThread,
+	}
+
+}
+
 // AsMap returns the channels as a map of name -> channel. The map is copied to
 // avoid data races
-func (c *Channels) AsMap() map[string]slack.Channel {
-	var ret map[string]slack.Channel
+func (c *Channels) AsMap() map[string]Channel {
+	c.mu.Lock()
+	defer c.mu.Unlock()
+	ret := make(map[string]Channel, len(c.channels))
 	for k, v := range c.channels {
 		ret[k] = v
 	}
@@ -43,20 +55,22 @@ func (c *Channels) Fetch(client *slack.Client) error {
 	var (
 		err      error
 		ctx      = context.Background()
-		channels = make(map[string]slack.Channel)
+		channels = make(map[string]Channel)
 	)
 	start := time.Now()
 	params := slack.GetConversationsParameters{
+		Types: []string{"public_channel", "private_channel"},
 		Limit: c.Pagination,
 	}
 	for err == nil {
 		chans, nextCursor, err := client.GetConversationsContext(ctx, &params)
 		if err == nil {
 			log.Debugf("Retrieved %d channels (current total is %d)", len(chans), len(channels))
-			for _, c := range chans {
+			for _, sch := range chans {
 				// WARNING WARNING WARNING: channels are internally mapped by
-				// name, while users are mapped by ID.
-				channels[c.Name] = c
+				// the Slack name, while users are mapped by Slack ID.
+				ch := Channel(sch)
+				channels[ch.SlackName()] = ch
 			}
 		} else if rateLimitedError, ok := err.(*slack.RateLimitedError); ok {
 			select {
@@ -88,7 +102,7 @@ func (c *Channels) Count() int {
 }
 
 // ByID retrieves a channel by its Slack ID.
-func (c *Channels) ByID(id string) *slack.Channel {
+func (c *Channels) ByID(id string) *Channel {
 	c.mu.Lock()
 	defer c.mu.Unlock()
 	for _, c := range c.channels {
@@ -99,17 +113,16 @@ func (c *Channels) ByID(id string) *slack.Channel {
 	return nil
 }
 
-// ByName retrieves a channel by its Slack name.
-func (c *Channels) ByName(name string) *slack.Channel {
-	if strings.HasPrefix(name, "#") {
+// ByName retrieves a channel by its Slack or IRC name.
+func (c *Channels) ByName(name string) *Channel {
+	if HasChannelPrefix(name) {
+		// without prefix, the channel now has the form of a Slack name
 		name = name[1:]
 	}
 	c.mu.Lock()
 	defer c.mu.Unlock()
-	for _, c := range c.channels {
-		if c.Name == name {
-			return &c
-		}
+	if ch, ok := c.channels[name]; ok {
+		return &ch
 	}
 	return nil
 }

pkg/ircslack/event_handler.go

@@ -18,28 +18,18 @@ func joinText(first string, second string, divider string) string {
 	return first + divider + second
 }
 
-func formatMultipartyChannelName(slackChannelID string, slackChannelName string) string {
-	name := "&" + slackChannelID + "|" + slackChannelName
-	name = strings.Replace(name, "mpdm-", "", -1)
-	name = strings.Replace(name, "--", "-", -1)
-	if len(name) >= 30 {
-		return name[:29] + "…"
-	}
-	return name
-}
-
-func formatThreadChannelName(threadTimestamp string, channel *slack.Channel) string {
+func formatThreadChannelName(threadTimestamp string, channel *Channel) string {
 	return "+" + channel.Name + "-" + threadTimestamp
 }
 
 func resolveChannelName(ctx *IrcContext, msgChannel, threadTimestamp string) string {
 	// channame := ""
 	if strings.HasPrefix(msgChannel, "C") || strings.HasPrefix(msgChannel, "G") {
 		// Channel message
-		channel, err := ctx.GetConversationInfo(msgChannel)
+		channel := ctx.Channels.ByID(msgChannel)
 
-		if err != nil {
-			log.Warningf("Failed to get channel info for %v: %v", msgChannel, err)
+		if channel == nil {
+			log.Warningf("Unknown channel  %s", msgChannel)
 			return ""
 		} else if threadTimestamp != "" {
 			channame := formatThreadChannelName(threadTimestamp, channel)
@@ -77,21 +67,20 @@ func resolveChannelName(ctx *IrcContext, msgChannel, threadTimestamp string) str
 			}
 			return channame
 		} else if channel.IsMpIM {
-			channame := formatMultipartyChannelName(msgChannel, channel.Name)
-			if ctx.Channels.ByName(channame) == nil {
+			if ctx.Channels.ByName(channel.IRCName()) == nil {
 				IrcSendChanInfoAfterJoin(
 					ctx,
-					channame,
+					channel.IRCName(),
 					msgChannel,
 					channel.Purpose.Value,
 					[]string{},
 					true,
 				)
 			}
-			return channame
+			return channel.IRCName()
 		}
 
-		return "#" + channel.Name
+		return channel.IRCName()
 	} else if strings.HasPrefix(msgChannel, "D") {
 		// Direct message to me
 		users, err := usersInConversation(ctx, msgChannel)
@@ -301,11 +290,11 @@ func eventHandler(ctx *IrcContext, rtm *slack.RTM) {
 			case "channel_topic":
 				// https://api.slack.com/events/message/channel_topic
 				// Send out new topic
-				channel, err := ctx.SlackClient.GetChannelInfo(message.Channel)
-				if err != nil {
+				channel := ctx.Channels.ByID(message.Channel)
+				if channel == nil {
 					log.Warningf("Cannot get channel name for %v", message.Channel)
 				} else {
-					newTopic := fmt.Sprintf(":%v TOPIC #%v :%v\r\n", ctx.Mask(), channel.Name, message.Topic)
+					newTopic := fmt.Sprintf(":%v TOPIC %s :%v\r\n", ctx.Mask(), channel.IRCName(), message.Topic)
 					log.Infof("Got new topic: %v", newTopic)
 					if _, err := ctx.Conn.Write([]byte(newTopic)); err != nil {
 						log.Warningf("Failed to send IRC message: %v", err)
@@ -339,7 +328,7 @@ func eventHandler(ctx *IrcContext, rtm *slack.RTM) {
 				log.Warningf("Unknown channel: %s", ev.Channel)
 				continue
 			}
-			if _, err := ctx.Conn.Write([]byte(fmt.Sprintf(":%v JOIN #%v\r\n", ctx.Mask(), ch.Name))); err != nil {
+			if _, err := ctx.Conn.Write([]byte(fmt.Sprintf(":%v JOIN %s\r\n", ctx.Mask(), ch.IRCName()))); err != nil {
 				log.Warningf("Failed to send IRC message: %v", err)
 			}
 		case *slack.MemberLeftChannelEvent:
@@ -352,7 +341,7 @@ func eventHandler(ctx *IrcContext, rtm *slack.RTM) {
 				log.Warningf("Unknown channel: %s", ev.Channel)
 				continue
 			}
-			if _, err := ctx.Conn.Write([]byte(fmt.Sprintf(":%v PART #%v\r\n", ctx.Mask(), ch.Name))); err != nil {
+			if _, err := ctx.Conn.Write([]byte(fmt.Sprintf(":%v PART %s\r\n", ctx.Mask(), ch.IRCName()))); err != nil {
 				log.Warningf("Failed to send IRC message: %v", err)
 			}
 		case *slack.TeamJoinEvent: