patch: v0.12.3

[rbdr/mobius] / hotline / user.go

diff --git a/hotline/user.go b/hotline/user.go
index 5d09b2d449e069fc0f9ffaa296e6567ccd510248..5b1b705b0c718cad09b9cc8ab8631327e8100ffc 100644 (file)
--- a/hotline/user.go
+++ b/hotline/user.go
@@ -4,12 +4,19 @@ import (
        "encoding/binary"
 )
 
-// User flags are stored as a 2 byte bitmap with the following values:
+// User flags are stored as a 2 byte bitmap and represent various user states
 const (
-       userFlagAway        = 0 // User is away
-       userFlagAdmin       = 1 // User is admin
-       userFlagRefusePM    = 2 // User refuses private messages
-       userFLagRefusePChat = 3 // User refuses private chat
+       UserFlagAway        = 0 // User is away
+       UserFlagAdmin       = 1 // User is admin
+       UserFlagRefusePM    = 2 // User refuses private messages
+       UserFlagRefusePChat = 3 // User refuses private chat
+)
+
+// FieldOptions flags are sent from v1.5+ clients as part of TranAgreed
+const (
+       refusePM     = 0 // User has "Refuse private messages" pref set
+       refuseChat   = 1 // User has "Refuse private chat" pref set
+       autoResponse = 2 // User has "Automatic response" pref set
 )
 
 type User struct {
@@ -49,19 +56,19 @@ func ReadUser(b []byte) (*User, error) {
        return u, nil
 }
 
-// DecodeUserString decodes an obfuscated user string from a client
+// decodeString decodes an obfuscated user string from a client
 // e.g. 98 8a 9a 8c 8b => "guest"
-func DecodeUserString(obfuText []byte) (clearText string) {
+func decodeString(obfuText []byte) (clearText string) {
        for _, char := range obfuText {
                clearText += string(rune(255 - uint(char)))
        }
        return clearText
 }
 
-// negateString takes []byte s containing cleartext and rotates by 255 into obfuscated cleartext.
+// encodeString takes []byte s containing cleartext and rotates by 255 into obfuscated cleartext.
 // The Hotline protocol uses this format for sending passwords over network.
 // Not secure, but hey, it was the 90s!
-func negateString(clearText []byte) []byte {
+func encodeString(clearText []byte) []byte {
        obfuText := make([]byte, len(clearText))
        for i := 0; i < len(clearText); i++ {
                obfuText[i] = 255 - clearText[i]