Changeset 568 in code

Timestamp:

Jun 25, 2021, 6:33:13 PM (4 years ago)

Author:

contact

Message:

Add per-user realname setting

This allows users to set a default realname used if the per-network
realname isn't set.

A new "user update" command is introduced and can be extended to edit
other user properties and other users in the future.

Location:

trunk

Files:

• db.go (modified) (2 diffs)
• db_sqlite.go (modified) (4 diffs)
• doc/soju.1.scd (modified) (2 diffs)
• downstream.go (modified) (5 diffs)
• service.go (modified) (5 diffs)
• upstream.go (modified) (1 diff)
• user.go (modified) (2 diffs)

trunk/db.go

@@ -31 +31 @@
         Username string
         Password string // hashed
+        Realname string
         Admin    bool
 }
@@ -93 +94 @@
 }
 
-func (net *Network) GetRealname() string {
+func GetRealname(user *User, net *Network) string {
         if net.Realname != "" {
                 return net.Realname
+        }
+        if user.Realname != "" {
+                return user.Realname
         }
         return net.Nick

trunk/db_sqlite.go

@@ -17 +17 @@
         username VARCHAR(255) NOT NULL UNIQUE,
         password VARCHAR(255),
-        admin INTEGER NOT NULL DEFAULT 0
+        admin INTEGER NOT NULL DEFAULT 0,
+        realname VARCHAR(255)
 );
 
@@ -134 +135 @@
         "ALTER TABLE Channel ADD COLUMN detached_internal_msgid VARCHAR(255)",
         "ALTER TABLE Network ADD COLUMN enabled INTEGER NOT NULL DEFAULT 1",
+        "ALTER TABLE User ADD COLUMN realname VARCHAR(255)",
 }
 
@@ -243 +245 @@
         user := &User{Username: username}
 
-        var password sql.NullString
-        row := db.db.QueryRow("SELECT id, password, admin FROM User WHERE username = ?", username)
-        if err := row.Scan(&user.ID, &password, &user.Admin); err != nil {
+        var password, realname sql.NullString
+        row := db.db.QueryRow("SELECT id, password, admin, realname FROM User WHERE username = ?", username)
+        if err := row.Scan(&user.ID, &password, &user.Admin, &realname); err != nil {
                 return nil, err
         }
         user.Password = password.String
+        user.Realname = realname.String
         return user, nil
 }
@@ -257 +260 @@
 
         password := toNullString(user.Password)
+        realname := toNullString(user.Realname)
 
         var err error
         if user.ID != 0 {
-                _, err = db.db.Exec("UPDATE User SET password = ?, admin = ? WHERE username = ?",
-                        password, user.Admin, user.Username)
+                _, err = db.db.Exec("UPDATE User SET password = ?, admin = ?, realname = ? WHERE username = ?",
+                        password, user.Admin, realname, user.Username)
         } else {
                 var res sql.Result
-                res, err = db.db.Exec("INSERT INTO User(username, password, admin) VALUES (?, ?, ?)",
-                        user.Username, password, user.Admin)
+                res, err = db.db.Exec("INSERT INTO User(username, password, admin, realname) VALUES (?, ?, ?, ?)",
+                        user.Username, password, user.Admin, realname)
                 if err != nil {
                         return err

trunk/doc/soju.1.scd

@@ -161 +161 @@
 
         *-realname* <realname>
-                Connect with the specified real name. By default, the nickname is used.
+                Connect with the specified real name. By default, the account's realname
+                is used if set, otherwise the network's nickname is used.
 
         *-nick* <nickname>
@@ -297 +298 @@
         Disable SASL authentication and remove stored credentials.
 
-*user create* -username <username> -password <password> [-admin]
+*user create* -username <username> -password <password> [options...]
         Create a new soju user. Only admin users can create new accounts.
+
+        Options:
+
+        *-admin*
+                Make the new user an administrator.
+
+        *-realname* <realname>
+                Set the user's realname. This is used as a fallback if there is no
+                realname set for a network.
+
+*user update* [-realname <realname>]
+        Update the current user.
 
 *user delete* <username>

trunk/downstream.go

@@ -84 +84 @@
                 attrs["username"] = irc.TagValue(network.Username)
         }
-        if network.Realname != "" {
-                attrs["realname"] = irc.TagValue(network.Realname)
+        if realname := GetRealname(&network.user.User, &network.Network); realname != "" {
+                attrs["realname"] = irc.TagValue(realname)
         }
 
@@ -1388 +1388 @@
                 }
 
+                // If the client just resets to the default, just wipe the per-network
+                // preference
+                storeRealname := realname
+                if realname == dc.user.Realname {
+                        storeRealname = ""
+                }
+
                 var storeErr error
                 var needUpdate []Network
@@ -1399 +1406 @@
                                 })
 
-                                n.Realname = realname
+                                n.Realname = storeRealname
                                 if err := dc.srv.db.StoreNetwork(dc.user.ID, &n.Network); err != nil {
                                         dc.logger.Printf("failed to store network realname: %v", err)
@@ -1408 +1415 @@
 
                         record := n.Network // copy network record because we'll mutate it
-                        record.Realname = realname
+                        record.Realname = storeRealname
                         needUpdate = append(needUpdate, record)
                 })
@@ -2224 +2231 @@
                         pass, _ := attrs.GetTag("pass")
 
+                        if realname == dc.user.Realname {
+                                realname = ""
+                        }
+
                         // TODO: reject unknown attributes
 

trunk/service.go

@@ -255 +255 @@
                         children: serviceCommandSet{
                                 "create": {
-                                        usage:  "-username <username> -password <password> [-admin]",
+                                        usage:  "-username <username> -password <password> [-realname <realname>] [-admin]",
                                         desc:   "create a new soju user",
                                         handle: handleUserCreate,
                                         admin:  true,
+                                },
+                                "update": {
+                                        usage:  "[-realname <realname>]",
+                                        desc:   "update the current user",
+                                        handle: handleUserUpdate,
                                 },
                                 "delete": {
@@ -267 +272 @@
                                 },
                         },
-                        admin: true,
                 },
                 "change-password": {
@@ -752 +756 @@
         username := fs.String("username", "", "")
         password := fs.String("password", "", "")
+        realname := fs.String("realname", "", "")
         admin := fs.Bool("admin", false, "")
 
@@ -772 +777 @@
                 Username: *username,
                 Password: string(hashed),
+                Realname: *realname,
                 Admin:    *admin,
         }
@@ -779 +785 @@
 
         sendServicePRIVMSG(dc, fmt.Sprintf("created user %q", *username))
+        return nil
+}
+
+func handleUserUpdate(dc *downstreamConn, params []string) error {
+        fs := newFlagSet()
+        realname := fs.String("realname", "", "")
+
+        if err := fs.Parse(params); err != nil {
+                return err
+        }
+
+        if err := dc.user.updateRealname(*realname); err != nil {
+                return err
+        }
+
+        sendServicePRIVMSG(dc, fmt.Sprintf("updated user %q", dc.user.Username))
         return nil
 }

trunk/upstream.go

@@ -1672 +1672 @@
         uc.nickCM = uc.network.casemap(uc.nick)
         uc.username = uc.network.GetUsername()
-        uc.realname = uc.network.GetRealname()
+        uc.realname = GetRealname(&uc.user.User, &uc.network.Network)
 
         uc.SendMessage(&irc.Message{

trunk/user.go

@@ -764 +764 @@
         }
 
+        // If the realname is reset to the default, just wipe the per-network
+        // setting
+        if record.Realname == u.Realname {
+                record.Realname = ""
+        }
+
         if err := u.checkNetwork(record); err != nil {
                 return nil, err
@@ -856 +862 @@
 }
 
+func (u *user) updateRealname(realname string) error {
+        u.User.Realname = realname
+        if err := u.srv.db.StoreUser(&u.User); err != nil {
+                return fmt.Errorf("failed to update user %q: %v", u.Username, err)
+        }
+
+        // Re-connect to networks which use the default realname
+        var needUpdate []Network
+        u.forEachNetwork(func(net *network) {
+                if net.Realname == "" {
+                        needUpdate = append(needUpdate, net.Network)
+                }
+        })
+
+        var netErr error
+        for _, net := range needUpdate {
+                if _, err := u.updateNetwork(&net); err != nil {
+                        netErr = err
+                }
+        }
+
+        return netErr
+}
+
 func (u *user) stop() {
         u.events <- eventStop{}