belak · March 14, 2023 01:48 · Mar 14, 2023 · Mar 14, 2023 · Mar 31, 2016 · Mar 31, 2016
diff --git a/README.md b/README.md
@@ -1,14 +1,18 @@
-# IRC User tracking
+# IRC User Mode Tracking
 
-Note that this assumes we don't have access to any IRCv3 caps
+This doc includes some random notes on implementing mode/presence tracking
+in IRC. Note that this implementation assumes we don't have access to any
+IRCv3 caps.
+
+There is a rough implementation for go-irc [here](https://github.com/go-irc/irc/blob/master/tracker.go).
 
 ## Simple cases
 
 - MODE - look up the user and channel and modify this mode
 - NICK - rename a user
 - RPL_NAMREPLY (353) - add user to channel and set modes
 
-## Single user cases (so, anyone other than the bot itself)
+## Single user cases (anyone other than the connected user)
 
 - JOIN - add the user to the channel, creating the user if they aren't tracked
   yet.
@@ -36,9 +40,12 @@ Note that this assumes we don't have access to any IRCv3 caps
 - A user must be in at least one channel common to the bot, or they will not
   be tracked. This means they can only use privmsg tracking if they are in at
   least one common channel.
-- Modes need to be grabbed from ISUPPORT (005) messages
+- Modes need to be grabbed from ISUPPORT (005) messages - RFC2812 defines 005
+  as something else, but this is not how it is used in practice.
 - We don't really know the bot's NICK until the 001 welcome message
 
 ## CAP notes
 
+If we can request IRCv3 CAPs, the following make this easier.
+
 - multi-prefix allows us to get all modes on joining a channel
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# User tracking
+# IRC User tracking
 
 Note that this assumes we don't have access to any IRCv3 caps
 

diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ Note that this assumes we don't have access to any IRCv3 caps
 
 - MODE - look up the user and channel and modify this mode
 - NICK - rename a user
+- RPL_NAMREPLY (353) - add user to channel and set modes
 
 ## Single user cases (so, anyone other than the bot itself)
 
@@ -28,8 +29,6 @@ Note that this assumes we don't have access to any IRCv3 caps
 
 ## Annoying notes:
 
-- When a bot joins a channel, we need to look up all users in the channel to
-  grab channel modes.
 - Without the multi-prefix CAP, in order to properly track a mode change we
   need to run a NAMES lookup every time a mode changes on a user.
 - There are a number of race conditions, all over the place, mostly around
@@ -38,4 +37,8 @@ Note that this assumes we don't have access to any IRCv3 caps
   be tracked. This means they can only use privmsg tracking if they are in at
   least one common channel.
 - Modes need to be grabbed from ISUPPORT (005) messages
-- We don't really know the bot's NICK until the 001 welcome message
+- We don't really know the bot's NICK until the 001 welcome message
+
+## CAP notes
+
+- multi-prefix allows us to get all modes on joining a channel
diff --git a/README.md b/README.md
@@ -37,4 +37,5 @@ Note that this assumes we don't have access to any IRCv3 caps
 - A user must be in at least one channel common to the bot, or they will not
   be tracked. This means they can only use privmsg tracking if they are in at
   least one common channel.
-- Modes need to be grabbed from ISUPPORT (005) messages
+- Modes need to be grabbed from ISUPPORT (005) messages
+- We don't really know the bot's NICK until the 001 welcome message
diff --git a/README.md b/README.md
@@ -36,4 +36,5 @@ Note that this assumes we don't have access to any IRCv3 caps
   private messages.
 - A user must be in at least one channel common to the bot, or they will not
   be tracked. This means they can only use privmsg tracking if they are in at
-  least one common channel.
+  least one common channel.
+- Modes need to be grabbed from ISUPPORT (005) messages
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@ Note that this assumes we don't have access to any IRCv3 caps
 ## Simple cases
 
 - MODE - look up the user and channel and modify this mode
+- NICK - rename a user
 
 ## Single user cases (so, anyone other than the bot itself)
 

diff --git a/README.md b/README.md
@@ -1,31 +1,31 @@
-* User tracking
+# User tracking
 
 Note that this assumes we don't have access to any IRCv3 caps
 
-** Simple cases
+## Simple cases
 
 - MODE - look up the user and channel and modify this mode
 
-** Single user cases (so, anyone other than the bot itself)
+## Single user cases (so, anyone other than the bot itself)
 
 - JOIN - add the user to the channel, creating the user if they aren't tracked
   yet.
 - PART/KICK - remove the user from a channel, then if they aren't in any other
   tracked channels, remove them.
 - QUIT - remove the user from all channels.
 
-** Bot user cases
+## Bot user cases
 
 - JOIN - Add the bot to the channel and wait for the RPL_NAMREPLY response
 - PART/KICK - Remove all users from the given channel and run cleanup as needed.
 - QUIT - Pretty much a fatal error.
 
-** Useful notes:
+## Useful notes:
 
 - When a single user JOINs we don't need to grab modes from anywhere, since
   they should get MODE called on them after joining.
 
-** Annoying notes:
+## Annoying notes:
 
 - When a bot joins a channel, we need to look up all users in the channel to
   grab channel modes.
@@ -35,4 +35,4 @@ Note that this assumes we don't have access to any IRCv3 caps
   private messages.
 - A user must be in at least one channel common to the bot, or they will not
   be tracked. This means they can only use privmsg tracking if they are in at
-  least one common channel.
+  least one common channel.
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+* User tracking
+
+Note that this assumes we don't have access to any IRCv3 caps
+
+** Simple cases
+
+- MODE - look up the user and channel and modify this mode
+
+** Single user cases (so, anyone other than the bot itself)
+
+- JOIN - add the user to the channel, creating the user if they aren't tracked
+  yet.
+- PART/KICK - remove the user from a channel, then if they aren't in any other
+  tracked channels, remove them.
+- QUIT - remove the user from all channels.
+
+** Bot user cases
+
+- JOIN - Add the bot to the channel and wait for the RPL_NAMREPLY response
+- PART/KICK - Remove all users from the given channel and run cleanup as needed.
+- QUIT - Pretty much a fatal error.
+
+** Useful notes:
+
+- When a single user JOINs we don't need to grab modes from anywhere, since
+  they should get MODE called on them after joining.
+
+** Annoying notes:
+
+- When a bot joins a channel, we need to look up all users in the channel to
+  grab channel modes.
+- Without the multi-prefix CAP, in order to properly track a mode change we
+  need to run a NAMES lookup every time a mode changes on a user.
+- There are a number of race conditions, all over the place, mostly around
+  private messages.
+- A user must be in at least one channel common to the bot, or they will not
+  be tracked. This means they can only use privmsg tracking if they are in at
+  least one common channel.