package models import ( "encoding/json" "fmt" "time" "github.com/NyaaPantsu/nyaa/utils/log" "github.com/fatih/structs" "net/http" "errors" "math" "github.com/NyaaPantsu/nyaa/config" "github.com/NyaaPantsu/nyaa/utils/crypto" ) const ( // UserStatusBanned : Int for User status banned UserStatusBanned = -1 // UserStatusMember : Int for User status member UserStatusMember = 0 // UserStatusTrusted : Int for User status trusted UserStatusTrusted = 1 // UserStatusModerator : Int for User status moderator UserStatusModerator = 2 // UserStatusScraped : Int for User status scrapped UserStatusScraped = 3 // UserStatusModerator : Int for User status moderator UserStatusJanitor = 4 ) // User model type User struct { ID uint `gorm:"column:user_id;primary_key"` Username string `gorm:"column:username;unique"` Password string `gorm:"column:password"` Email string `gorm:"column:email;unique"` Status int `gorm:"column:status"` CreatedAt time.Time `gorm:"column:created_at"` UpdatedAt time.Time `gorm:"column:updated_at"` APIToken string `gorm:"column:api_token"` APITokenExpiry time.Time `gorm:"column:api_token_expiry"` Language string `gorm:"column:language"` Theme string `gorm:"column:theme"` AltColors string `gorm:"column:alt_colors"` OldNav string `gorm:"column:old_nav"` Mascot string `gorm:"column:mascot"` MascotURL string `gorm:"column:mascot_url"` AnidexAPIToken string `gorm:"column:anidex_api_token"` NyaasiAPIToken string `gorm:"column:nyaasi_api_token"` TokyoTAPIToken string `gorm:"column:tokyotosho_api_token"` UserSettings string `gorm:"column:settings"` Pantsu float64 `gorm:"column:pantsu"` // TODO: move this to PublicUser Followers []User // Don't work `gorm:"foreignkey:user_id;associationforeignkey:follower_id;many2many:user_follows"` Likings []User // Don't work `gorm:"foreignkey:follower_id;associationforeignkey:user_id;many2many:user_follows"` MD5 string `json:"md5" gorm:"column:md5"` // Hash of email address, used for Gravatar Torrents []Torrent `gorm:"ForeignKey:UploaderID"` Notifications []Notification `gorm:"ForeignKey:UserID"` UnreadNotifications int `gorm:"-"` // We don't want to loop every notifications when accessing user unread notif Settings UserSettings `gorm:"-"` // We don't want to load settings everytime, stock it as a string, parse it when needed Tags Tags `gorm:"-"` // We load tags only when viewing a torrent } // UserJSON : User model conversion in JSON type UserJSON struct { ID uint `json:"user_id"` Username string `json:"username"` Status int `json:"status"` APIToken string `json:"token,omitempty"` MD5 string `json:"md5"` CreatedAt string `json:"created_at"` LikingCount int `json:"liking_count"` LikedCount int `json:"liked_count"` } // UserFollows association table : different users following eachother type UserFollows struct { UserID uint `gorm:"column:user_id"` FollowerID uint `gorm:"column:following"` } // UserUploadsOld model : Is it deprecated? type UserUploadsOld struct { Username string `gorm:"column:username"` TorrentID uint `gorm:"column:torrent_id"` } // UserSettings : Struct for user settings, not a model type UserSettings struct { Settings map[string]bool `json:"settings"` } /* * User Model */ // Size : Returns the total size of memory recursively allocated for this struct func (u User) Size() (s int) { s += 4 + // ints 6*2 + // string pointers 4*3 + //time.Time 3*2 + // arrays // string arrays len(u.Username) + len(u.Password) + len(u.Email) + len(u.APIToken) + len(u.MD5) + len(u.Language) + len(u.Theme) s *= 8 // Ignoring foreign key users. Fuck them. return } // IsBanned : Return true if user is banned func (u *User) IsBanned() bool { return u.Status == UserStatusBanned } // IsMember : Return true if user is member func (u *User) IsMember() bool { return u.Status == UserStatusMember } // IsTrusted : Return true if user is tusted func (u *User) IsTrusted() bool { return u.Status == UserStatusTrusted } // IsModerator : Return true if user is moderator func (u *User) IsModerator() bool { return u.Status == UserStatusModerator } // IsJanitor : Return true if user is janitor OR moderator func (u *User) IsJanitor() bool { return u.Status == UserStatusJanitor || u.Status == UserStatusModerator } // IsScraped : Return true if user is a scrapped user func (u *User) IsScraped() bool { return u.Status == UserStatusScraped } // GetUnreadNotifications : Get unread notifications from a user func (u *User) GetUnreadNotifications() int { if u.UnreadNotifications == 0 { for _, notif := range u.Notifications { if !notif.Read { u.UnreadNotifications++ } } } return u.UnreadNotifications } // ToggleBan : Ban/Unban an user an user, return true if the user is now banned func (u *User) ToggleBan() bool { if u.IsBanned() { u.Status = UserStatusMember } else { u.Status = UserStatusBanned } u.Update() return u.IsBanned() } // CurrentOrAdmin check that user has admin permission or user is the current user. func (u *User) CurrentOrAdmin(userID uint) bool { if userID == 0 && !u.IsModerator() { return false } log.Debugf("user.ID == userID %d %d %s", u.ID, userID, u.ID == userID) return (u.IsModerator() || u.ID == userID) } // CurrentOrJanitor check that user has janitor permission or user is the current user. func (u *User) CurrentOrJanitor(userID uint) bool { if userID == 0 && !u.IsJanitor() { return false } log.Debugf("user.ID == userID %d %d %s", u.ID, userID, u.ID == userID) return (u.IsJanitor() || u.ID == userID) } // CurrentUserIdentical check that userID is same as current user's ID. // TODO: Inline this (won't go do this for us?) func (u *User) CurrentUserIdentical(userID uint) bool { return u.ID == userID } // NeedsCaptcha : Check if a user needs captcha func (u *User) NeedsCaptcha() bool { // Trusted members & Moderators don't return !(u.IsTrusted() || u.IsJanitor()) } // CanUpload : Check if a user can upload or if upload is enabled in config func (u *User) CanUpload() bool { if config.Get().Upload.UploadsDisabled { if config.Get().Upload.AdminsAreStillAllowedTo && u.IsModerator() { return true } if config.Get().Upload.TrustedUsersAreStillAllowedTo && u.IsTrusted() { return true } return false } return true } // GetRole : Get the status/role of a user func (u *User) GetRole() string { if u.ID == 0 { return "" } switch u.Status { case UserStatusBanned: return "userstatus_banned" case UserStatusMember: return "userstatus_member" case UserStatusScraped: return "userstatus_scraped" case UserStatusTrusted: return "userstatus_trusted" case UserStatusJanitor: return "userstatus_janitor" case UserStatusModerator: return "userstatus_moderator" } return "userstatus_member" } // IsFollower : Check if a user is following another func (follower *User) IsFollower(userid uint) bool { var likingUserCount int ORM.Model(&UserFollows{}).Where("user_id = ? and following = ?", follower.ID, userid).Count(&likingUserCount) return likingUserCount != 0 } // ToJSON : Conversion of a user model to json func (u *User) ToJSON() UserJSON { json := UserJSON{ ID: u.ID, Username: u.Username, APIToken: u.APIToken, MD5: u.MD5, Status: u.Status, CreatedAt: u.CreatedAt.Format(time.RFC3339), LikingCount: len(u.Followers), LikedCount: len(u.Likings), } return json } // GetLikings : Gets who is followed by the user func (u *User) GetLikings() int { var liked []User ORM.Joins("JOIN user_follows on user_follows.following=?", u.ID).Where("users.user_id = user_follows.user_id").Group("users.user_id").Find(&liked) u.Likings = liked return len(u.Likings) } // GetFollowers : Gets who is following the user func (u *User) GetFollowers() int { var likings []User ORM.Joins("JOIN user_follows on user_follows.user_id=?", u.ID).Where("users.user_id = user_follows.following").Group("users.user_id").Find(&likings) u.Followers = likings return len(u.Followers) } // SetFollow : Makes a user follow another func (u *User) SetFollow(follower *User) { if follower.ID > 0 && u.ID > 0 { var userFollows = UserFollows{UserID: u.ID, FollowerID: follower.ID} ORM.Create(&userFollows) u.Likings = append(u.Likings, *follower) } } // RemoveFollow : Remove a user following another func (u *User) RemoveFollow(follower *User) { if follower.ID > 0 && u.ID > 0 { var userFollows = UserFollows{UserID: u.ID, FollowerID: follower.ID} ORM.Delete(&userFollows) for i, followr := range u.Likings { if followr.ID == follower.ID { u.Likings[i] = u.Likings[len(u.Likings)-1] // The very last follower will take the place of the one that is getting deleted in the array u.Likings = u.Likings[:len(u.Likings)-1] // We now proceed to delete the very last array element since it got copied to another position return } } } } /* * Old User */ // TableName : Return the name of OldComment table func (c UserUploadsOld) TableName() string { // is this needed here? return config.Get().Models.UploadsOldTableName } /* * User Settings */ // Get a user setting by keyname func (s *UserSettings) Get(key string) bool { if val, ok := s.Settings[key]; ok { return val } return config.Get().Users.DefaultUserSettings[key] } // GetSettings : get all user settings func (s *UserSettings) GetSettings() map[string]bool { return s.Settings } // Set a user setting by keyname func (s *UserSettings) Set(key string, val bool) { if s.Settings == nil { s.Settings = make(map[string]bool) } s.Settings[key] = val } // ToDefault : Set user settings to default func (s *UserSettings) ToDefault() { s.Settings = config.Get().Users.DefaultUserSettings } func (s *UserSettings) initialize() { s.Settings = make(map[string]bool) } // SaveSettings : Format settings into a json string for preparing before user insertion func (u *User) SaveSettings() { byteArray, err := json.Marshal(u.Settings) if err != nil { fmt.Print(err) } u.UserSettings = string(byteArray) } // ParseSettings : Function to parse json string into usersettings struct, only parse if necessary func (u *User) ParseSettings() { if len(u.Settings.GetSettings()) == 0 && u.UserSettings != "" { u.Settings.initialize() json.Unmarshal([]byte(u.UserSettings), &u.Settings) } else if len(u.Settings.GetSettings()) == 0 && u.UserSettings != "" { u.Settings.initialize() u.Settings.ToDefault() } } // Update updates a user. (Applying the modifed data of user). func (u *User) Update() (int, error) { if u.Email == "" { u.MD5 = "" } else { var err error u.MD5, err = crypto.GenerateMD5Hash(u.Email) if err != nil { return http.StatusInternalServerError, err } } u.UpdatedAt = time.Now() err := ORM.Save(u).Error if err != nil { return http.StatusInternalServerError, err } return http.StatusOK, nil } // UpdateRaw : Function to update a user without updating his associations model func (u *User) UpdateRaw() (int, error) { u.UpdatedAt = time.Now() err := ORM.Model(u).UpdateColumn(u.toMap()).Error if err != nil { return http.StatusInternalServerError, err } return http.StatusOK, nil } // Delete deletes a user. func (u *User) Delete(currentUser *User) (int, error) { if u.ID == 0 { return http.StatusInternalServerError, errors.New("permission_delete_error") } err := ORM.Delete(u).Error if err != nil { return http.StatusInternalServerError, errors.New("user_not_deleted") } return http.StatusOK, nil } // toMap : convert the model to a map of interface func (u *User) toMap() map[string]interface{} { return structs.Map(u) } // Splice : get a subset of torrents func (u *User) Splice(start int, length int) *User { if (len(u.Torrents) <= length && start == 0) || len(u.Torrents) == 0 { return u } if start > len(u.Torrents) { u.Torrents = []Torrent{} return u } if len(u.Torrents) < length { length = len(u.Torrents) } u.Torrents = u.Torrents[start:length] return u } // Filter : filter the hidden torrents func (u *User) Filter() *User { torrents := []Torrent{} for _, t := range u.Torrents { if !t.Hidden { torrents = append(torrents, t) } } u.Torrents = torrents return u } // IncreasePantsu is a function that uses the formula to increase the Pantsu points of a user func (u *User) IncreasePantsu() { if u.Pantsu <= 0 { u.Pantsu = 1 // Pantsu points should never be less or equal to 0. This would trigger a division by 0 } u.Pantsu = u.Pantsu * (1 + 1/(math.Pow(math.Log(u.Pantsu+1), 5))) // First votes substancially increases the vote, further it increase slowly } // DecreasePantsu is a function that uses the formula to decrease the Pantsu points of a user func (u *User) DecreasePantsu() { u.Pantsu = 0.8 * u.Pantsu // You lose 20% of your pantsu points each wrong vote } func (u *User) LoadTags(torrent *Torrent) { if u.ID == 0 { return } if err := ORM.Where("torrent_id = ? AND user_id = ?", torrent.ID, u.ID).Find(&u.Tags).Error; err != nil { log.CheckErrorWithMessage(err, "LOAD_TAGS_ERROR: Couldn't load tags!") return } }