/* * * Gosora User File * Copyright Azareal 2017 - 2020 * */ package common import ( "database/sql" "errors" "strconv" "strings" "time" qgen "github.com/Azareal/Gosora/query_gen" "github.com/go-sql-driver/mysql" ) // TODO: Replace any literals with this var BanGroup = 4 // TODO: Use something else as the guest avatar, maybe a question mark of some sort? // GuestUser is an instance of user which holds guest data to avoid having to initialise a guest every time var GuestUser = User{ID: 0, Name: "Guest", Link: "#", Group: 6, Perms: GuestPerms} // BuildAvatar is done in site.go to make sure it's done after init var ErrNoTempGroup = errors.New("We couldn't find a temporary group for this user") type User struct { ID int Link string Name string Email string Group int Active bool IsMod bool IsSuperMod bool IsAdmin bool IsSuperAdmin bool IsBanned bool Perms Perms PluginPerms map[string]bool Session string //AuthToken string Loggedin bool RawAvatar string Avatar string MicroAvatar string Message string URLPrefix string // Move this to another table? Create a user lite? URLName string Tag string Level int Score int Posts int Liked int LastIP string // ! This part of the UserCache data might fall out of date LastAgent string // ! Temporary hack, don't use TempGroup int } func (u *User) WebSockets() *WsJSONUser { groupID := u.Group if u.TempGroup != 0 { groupID = u.TempGroup } // TODO: Do we want to leak the user's permissions? Users will probably be able to see their status from the group tags, but still return &WsJSONUser{u.ID, u.Link, u.Name, groupID, u.IsMod, u.Avatar, u.MicroAvatar, u.Level, u.Score, u.Liked} } // Use struct tags to avoid having to define this? It really depends on the circumstances, sometimes we want the whole thing, sometimes... not. type WsJSONUser struct { ID int Link string Name string Group int // Be sure to mask with TempGroup IsMod bool Avatar string MicroAvatar string Level int Score int Liked int } func (u *User) Me() *MeUser { groupID := u.Group if u.TempGroup != 0 { groupID = u.TempGroup } return &MeUser{u.ID, u.Link, u.Name, groupID, u.Active, u.IsMod, u.IsSuperMod, u.IsAdmin, u.IsBanned, u.Session, u.Avatar, u.MicroAvatar, u.Tag, u.Level, u.Score, u.Liked} } // For when users need to see their own data, I've omitted some redundancies and less useful items, so we don't wind up sending them on every request type MeUser struct { ID int Link string Name string Group int Active bool IsMod bool IsSuperMod bool IsAdmin bool IsBanned bool // TODO: Implement these as copies (might already be the case for Perms, but we'll want to look at it's definition anyway) //Perms Perms //PluginPerms map[string]bool S string // Session Avatar string MicroAvatar string Tag string Level int Score int Liked int } type UserStmts struct { activate *sql.Stmt changeGroup *sql.Stmt delete *sql.Stmt setAvatar *sql.Stmt setUsername *sql.Stmt incTopics *sql.Stmt updateLevel *sql.Stmt update *sql.Stmt // TODO: Split these into a sub-struct incScore *sql.Stmt incPosts *sql.Stmt incBigposts *sql.Stmt incMegaposts *sql.Stmt incLiked *sql.Stmt decLiked *sql.Stmt updateLastIP *sql.Stmt setPassword *sql.Stmt scheduleAvatarResize *sql.Stmt } var userStmts UserStmts func init() { DbInits.Add(func(acc *qgen.Accumulator) error { w := "uid = ?" userStmts = UserStmts{ activate: acc.SimpleUpdate("users", "active = 1", w), changeGroup: acc.SimpleUpdate("users", "group = ?", w), // TODO: Implement user_count for users_groups here delete: acc.SimpleDelete("users", w), setAvatar: acc.Update("users").Set("avatar = ?").Where(w).Prepare(), setUsername: acc.Update("users").Set("name = ?").Where(w).Prepare(), incTopics: acc.SimpleUpdate("users", "topics = topics + ?", w), updateLevel: acc.SimpleUpdate("users", "level = ?", w), update: acc.Update("users").Set("name = ?, email = ?, group = ?").Where(w).Prepare(), // TODO: Implement user_count for users_groups on things which use this incScore: acc.Update("users").Set("score = score + ?").Where(w).Prepare(), incPosts: acc.Update("users").Set("posts = posts + ?").Where(w).Prepare(), incBigposts: acc.Update("users").Set("posts = posts + ?, bigposts = bigposts + ?").Where(w).Prepare(), incMegaposts: acc.Update("users").Set("posts = posts + ?, bigposts = bigposts + ?, megaposts = megaposts + ?").Where(w).Prepare(), incLiked: acc.Update("users").Set("liked = liked + ?, lastLiked = UTC_TIMESTAMP()").Where(w).Prepare(), decLiked: acc.Update("users").Set("liked = liked - ?").Where(w).Prepare(), //recalcLastLiked: acc... updateLastIP: acc.SimpleUpdate("users", "last_ip = ?", w), setPassword: acc.Update("users").Set("password = ?, salt = ?").Where(w).Prepare(), scheduleAvatarResize: acc.Insert("users_avatar_queue").Columns("uid").Fields("?").Prepare(), } return acc.FirstError() }) } func (u *User) Init() { u.Avatar, u.MicroAvatar = BuildAvatar(u.ID, u.RawAvatar) u.Link = BuildProfileURL(NameToSlug(u.Name), u.ID) u.Tag = Groups.DirtyGet(u.Group).Tag u.InitPerms() } // TODO: Refactor this idiom into something shorter, maybe with a NullUserCache when one isn't set? func (u *User) CacheRemove() { if uc := Users.GetCache(); uc != nil { uc.Remove(u.ID) } TopicListThaw.Thaw() } func (u *User) Ban(duration time.Duration, issuedBy int) error { return u.ScheduleGroupUpdate(BanGroup, issuedBy, duration) } func (u *User) Unban() error { return u.RevertGroupUpdate() } func (u *User) deleteScheduleGroupTx(tx *sql.Tx) error { deleteScheduleGroupStmt, err := qgen.Builder.SimpleDeleteTx(tx, "users_groups_scheduler", "uid = ?") if err != nil { return err } _, err = deleteScheduleGroupStmt.Exec(u.ID) return err } func (u *User) setTempGroupTx(tx *sql.Tx, tempGroup int) error { setTempGroupStmt, err := qgen.Builder.SimpleUpdateTx(tx, "users", "temp_group = ?", "uid = ?") if err != nil { return err } _, err = setTempGroupStmt.Exec(tempGroup, u.ID) return err } // Make this more stateless? func (u *User) ScheduleGroupUpdate(gid int, issuedBy int, duration time.Duration) error { var temp bool if duration.Nanoseconds() != 0 { temp = true } revertAt := time.Now().Add(duration) tx, err := qgen.Builder.Begin() if err != nil { return err } defer tx.Rollback() err = u.deleteScheduleGroupTx(tx) if err != nil { return err } createScheduleGroupTx, err := qgen.Builder.SimpleInsertTx(tx, "users_groups_scheduler", "uid,set_group,issued_by,issued_at,revert_at,temporary", "?,?,?,UTC_TIMESTAMP(),?,?") if err != nil { return err } _, err = createScheduleGroupTx.Exec(u.ID, gid, issuedBy, revertAt, temp) if err != nil { return err } err = u.setTempGroupTx(tx, gid) if err != nil { return err } err = tx.Commit() u.CacheRemove() return err } func (u *User) RevertGroupUpdate() error { tx, err := qgen.Builder.Begin() if err != nil { return err } defer tx.Rollback() err = u.deleteScheduleGroupTx(tx) if err != nil { return err } err = u.setTempGroupTx(tx, 0) if err != nil { return err } err = tx.Commit() u.CacheRemove() return err } // TODO: Use a transaction here // ? - Add a Deactivate method? Not really needed, if someone's been bad you could do a ban, I guess it might be useful, if someone says that email x isn't actually owned by the user in question? func (u *User) Activate() (err error) { _, err = userStmts.activate.Exec(u.ID) if err != nil { return err } _, err = userStmts.changeGroup.Exec(Config.DefaultGroup, u.ID) u.CacheRemove() return err } // TODO: Write tests for this // TODO: Delete this user's content too? // TODO: Expose this to the admin? func (u *User) Delete() error { _, err := userStmts.delete.Exec(u.ID) if err != nil { return err } u.CacheRemove() return nil } func (u *User) bindStmt(stmt *sql.Stmt, params ...interface{}) (err error) { params = append(params, u.ID) _, err = stmt.Exec(params...) u.CacheRemove() return err } func (u *User) ChangeName(name string) (err error) { return u.bindStmt(userStmts.setUsername, name) } func (u *User) ChangeAvatar(avatar string) (err error) { return u.bindStmt(userStmts.setAvatar, avatar) } // TODO: Abstract this with an interface so we can scale this with an actual dedicated queue in a real cluster func (u *User) ScheduleAvatarResize() (err error) { _, err = userStmts.scheduleAvatarResize.Exec(u.ID) if err != nil { // TODO: Do a more generic check so that we're not as tied to MySQL me, ok := err.(*mysql.MySQLError) if !ok { return err } // If it's just telling us that the item already exists in the database, then we can ignore it, as it doesn't matter if it's this call or another which schedules the item in the queue if me.Number != 1062 { return err } } return nil } func (u *User) ChangeGroup(group int) (err error) { return u.bindStmt(userStmts.changeGroup, group) } // ! Only updates the database not the *User for safety reasons func (u *User) UpdateIP(host string) error { _, err := userStmts.updateLastIP.Exec(host, u.ID) if uc := Users.GetCache(); uc != nil { uc.Remove(u.ID) } return err } func (u *User) Update(name string, email string, group int) (err error) { return u.bindStmt(userStmts.update, name, email, group) } func (u *User) IncreasePostStats(wcount int, topic bool) (err error) { var mod int baseScore := 1 if topic { _, err = userStmts.incTopics.Exec(1, u.ID) if err != nil { return err } baseScore = 2 } settings := SettingBox.Load().(SettingMap) if wcount >= settings["megapost_min_words"].(int) { _, err = userStmts.incMegaposts.Exec(1, 1, 1, u.ID) mod = 4 } else if wcount >= settings["bigpost_min_words"].(int) { _, err = userStmts.incBigposts.Exec(1, 1, u.ID) mod = 1 } else { _, err = userStmts.incPosts.Exec(1, u.ID) } if err != nil { return err } _, err = userStmts.incScore.Exec(baseScore+mod, u.ID) if err != nil { return err } //log.Print(u.Score + baseScore + mod) // TODO: Use a transaction to prevent level desyncs? level := GetLevel(u.Score + baseScore + mod) //log.Print(level) _, err = userStmts.updateLevel.Exec(level, u.ID) if err != nil { return err } err = GroupPromotions.PromoteIfEligible(u, level, u.Posts+1) u.CacheRemove() return err } func (u *User) DecreasePostStats(wcount int, topic bool) (err error) { var mod int baseScore := -1 if topic { _, err = userStmts.incTopics.Exec(-1, u.ID) if err != nil { return err } baseScore = -2 } settings := SettingBox.Load().(SettingMap) if wcount >= settings["megapost_min_words"].(int) { _, err = userStmts.incMegaposts.Exec(-1, -1, -1, u.ID) mod = 4 } else if wcount >= settings["bigpost_min_words"].(int) { _, err = userStmts.incBigposts.Exec(-1, -1, u.ID) mod = 1 } else { _, err = userStmts.incPosts.Exec(-1, u.ID) } if err != nil { return err } _, err = userStmts.incScore.Exec(baseScore-mod, u.ID) if err != nil { return err } // TODO: Use a transaction to prevent level desyncs? _, err = userStmts.updateLevel.Exec(GetLevel(u.Score-baseScore-mod), u.ID) u.CacheRemove() return err } // Copy gives you a non-pointer concurrency safe copy of the user func (u *User) Copy() User { return *u } // TODO: Write unit tests for this func (u *User) InitPerms() { if u.TempGroup != 0 { u.Group = u.TempGroup } group := Groups.DirtyGet(u.Group) if u.IsSuperAdmin { u.Perms = AllPerms u.PluginPerms = AllPluginPerms } else { u.Perms = group.Perms u.PluginPerms = group.PluginPerms } /*if len(group.CanSee) == 0 { panic("should not be zero") }*/ u.IsAdmin = u.IsSuperAdmin || group.IsAdmin u.IsSuperMod = u.IsAdmin || group.IsMod u.IsMod = u.IsSuperMod u.IsBanned = group.IsBanned if u.IsBanned && u.IsSuperMod { u.IsBanned = false } } var guestAvatar GuestAvatar type GuestAvatar struct { Normal string Micro string } func buildNoavatar(uid int, width int) string { if !Config.DisableNoavatarRange { // TODO: Find a faster algorithm if uid > 50000 { uid -= 50000 } if uid > 5000 { uid -= 5000 } if uid > 500 { uid -= 500 } for uid > 50 { uid -= 50 } } if !Config.DisableDefaultNoavatar && uid < 5 { return "/s/n" + strconv.Itoa(uid) + "-" + strconv.Itoa(width) + ".png?i=0" } return strings.Replace(strings.Replace(Config.Noavatar, "{id}", strconv.Itoa(uid), 1), "{width}", strconv.Itoa(width), 1) } // ? Make this part of *User? // TODO: Write tests for this func BuildAvatar(uid int, avatar string) (normalAvatar string, microAvatar string) { if avatar == "" { if uid == 0 { return guestAvatar.Normal, guestAvatar.Micro } return buildNoavatar(uid, 200), buildNoavatar(uid, 48) } if avatar[0] == '.' { if avatar[1] == '.' { normalAvatar = "/uploads/avatar_" + strconv.Itoa(uid) + "_tmp" + avatar[1:] return normalAvatar, normalAvatar } normalAvatar = "/uploads/avatar_" + strconv.Itoa(uid) + avatar return normalAvatar, normalAvatar } return avatar, avatar } // TODO: Move this to *User func SetPassword(uid int, password string) error { hashedPassword, salt, err := GeneratePassword(password) if err != nil { return err } _, err = userStmts.setPassword.Exec(hashedPassword, salt, uid) return err } // TODO: Write units tests for this func wordsToScore(wcount int, topic bool) (score int) { if topic { score = 2 } else { score = 1 } settings := SettingBox.Load().(SettingMap) if wcount >= settings["megapost_min_words"].(int) { score += 4 } else if wcount >= settings["bigpost_min_words"].(int) { score++ } return score } // For use in tests and to help generate dummy users for forums which don't have last posters func BlankUser() *User { return new(User) } // TODO: Write unit tests for this func BuildProfileURL(slug string, uid int) string { if slug == "" || !Config.BuildSlugs { return "/user/" + strconv.Itoa(uid) } return "/user/" + slug + "." + strconv.Itoa(uid) }