Better Support Private Messaging

This commit introduces the ability to private message in such a way as
to be considered "stable". Each bot get its own discriminator and this
makes it where if you were to connect 2 bots to the same Discord
identity but 2 different IRC networks when you send a private message
since the discriminator is required it will not accidentally be sent to
both IRC networks wherein both networks have a client with the same
nick. This also enhances privacy since it isn't guaranteed the same
person has the same nick on both networks.

Pending: log a fatal and exit if Discriminator == "".

Author: llmII

bridge/bridge.go

@@ -22,6 +22,7 @@ type Config struct {
 	ChannelMappings map[string]string
 
 	IRCServer        string
+	Discriminator    string
 	IRCServerPass    string
 	IRCListenerName  string // i.e, "DiscordBot", required to listen for messages in all cases
 	WebIRCPass       string

bridge/discord.go

@@ -144,7 +144,11 @@ func (d *discordBot) publishMessage(s *discordgo.Session, m *discordgo.Message,
 
 			// if the target could not be deduced. tell them this.
 			if pmTarget == "" {
-				_, _ = d.ChannelMessageSend(m.ChannelID, "Don't know who that is. Can't PM. Try 'name, message here'")
+				_, _ = d.ChannelMessageSend(
+					m.ChannelID,
+					fmt.Sprintf(
+						"Don't know who that is. Can't PM. Try 'name@%s, message here'",
+						d.bridge.Config.Discriminator))
 				return
 			}
 			break

bridge/irc_connection.go

@@ -39,9 +39,6 @@ func (i *ircConnection) OnWelcome(e *irc.Event) {
 			if m.IsAction {
 				i.innerCon.Action(m.IRCChannel, m.Message)
 			} else {
-				if !strings.HasPrefix(m.IRCChannel, "#") {
-					i.experimentalNotice(m.IRCChannel)
-				}
 				i.innerCon.Privmsg(m.IRCChannel, m.Message)
 			}
 		}
@@ -77,7 +74,7 @@ func (i *ircConnection) UpdateDetails(discord DiscordUser) {
 	go i.innerCon.Nick(i.nick)
 }
 
-func (i *ircConnection) experimentalNotice(nick string) {
+func (i *ircConnection) introducePM(nick string) {
 	d := i.manager.bridge.discord
 
 	if i.pmDiscordChannel == "" {
@@ -92,7 +89,9 @@ func (i *ircConnection) experimentalNotice(nick string) {
 
 	if !i.pmNoticed {
 		i.pmNoticed = true
-		_, err := d.ChannelMessageSend(i.pmDiscordChannel, "**Private messaging is still in dev. Proceed with caution.**")
+		_, err := d.ChannelMessageSend(
+			i.pmDiscordChannel,
+			fmt.Sprintf("To reply type: %s@%s, message", nick, i.manager.bridge.Config.Discriminator))
 		if err != nil {
 			log.Warnln("Could not send pmNotice", i.discord, err)
 			return
@@ -102,7 +101,6 @@ func (i *ircConnection) experimentalNotice(nick string) {
 	nick = strings.ToLower(nick)
 	if _, ok := i.pmNoticedSenders[nick]; !ok {
 		i.pmNoticedSenders[nick] = struct{}{}
-		i.innerCon.Privmsg(nick, "Private messaging is still in dev. Proceed with caution.")
 	}
 }
 
@@ -117,9 +115,9 @@ func (i *ircConnection) OnPrivateMessage(e *irc.Event) {
 
 		d := i.manager.bridge.discord
 
-		i.experimentalNotice(e.Nick)
+		i.introducePM(e.Nick)
 
-		msg := fmt.Sprintf("%s,%s: %s", e.Connection.Server, e.Source, e.Message())
+		msg := fmt.Sprintf("%s,%s - %s@%s: %s", e.Connection.Server, e.Source, e.Nick, e.Message())
 		_, err := d.ChannelMessageSend(i.pmDiscordChannel, msg)
 		if err != nil {
 			log.Warnln("Could not send PM", i.discord, err)

main.go

@@ -61,6 +61,7 @@ func main() {
 		log.Fatalln(errors.Wrap(err, "could not read config"))
 	}
 
+	discriminator := viper.GetString("discriminator")               // unique per IRC network connected to, keeps PM's working
 	discordBotToken := viper.GetString("discord_token")             // Discord Bot User Token
 	channelMappings := viper.GetStringMapString("channel_mappings") // Discord:IRC mappings in format '#discord1:#irc1,#discord2:#irc2,...'
 	ircServer := viper.GetString("irc_server")                      // Server address to use, example `irc.freenode.net:7000`.
@@ -119,6 +120,7 @@ func main() {
 
 	dib, err := bridge.New(&bridge.Config{
 		AvatarURL:          avatarURL,
+		Discriminator:      discriminator,
 		DiscordBotToken:    discordBotToken,
 		GuildID:            guildID,
 		IRCListenerName:    ircUsername,