/* * * Gosora Topic File * Copyright Azareal 2017 - 2020 * */ package common import ( "database/sql" "html" "html/template" "strconv" "strings" "time" p "github.com/Azareal/Gosora/common/phrases" qgen "github.com/Azareal/Gosora/query_gen" ) // This is also in reply.go //var ErrAlreadyLiked = errors.New("This item was already liked by this user") // ? - Add a TopicMeta struct for *Forums? type Topic struct { ID int Link string Title string Content string CreatedBy int IsClosed bool Sticky bool CreatedAt time.Time LastReplyAt time.Time LastReplyBy int LastReplyID int ParentID int Status string // Deprecated. Marked for removal. IP string ViewCount int64 PostCount int LikeCount int AttachCount int ClassName string // CSS Class Name Poll int Data string // Used for report metadata Rids []int } type TopicUser struct { ID int Link string Title string Content string // TODO: Avoid converting this to bytes in templates, particularly if it's long CreatedBy int IsClosed bool Sticky bool CreatedAt time.Time LastReplyAt time.Time LastReplyBy int LastReplyID int ParentID int Status string // Deprecated. Marked for removal. IP string ViewCount int64 PostCount int LikeCount int AttachCount int ClassName string Poll int Data string // Used for report metadata UserLink string CreatedByName string Group int Avatar string MicroAvatar string ContentLines int ContentHTML string // TODO: Avoid converting this to bytes in templates, particularly if it's long Tag string URL string //URLPrefix string //URLName string Level int Liked bool Attachments []*MiniAttachment Rids []int Deletable bool } // TODO: Embed TopicUser to simplify this structure and it's related logic? type TopicsRow struct { ID int Link string Title string Content string CreatedBy int IsClosed bool Sticky bool CreatedAt time.Time LastReplyAt time.Time LastReplyBy int LastReplyID int ParentID int Status string // Deprecated. Marked for removal. -Is there anything we could use it for? IP string ViewCount int64 PostCount int LikeCount int AttachCount int LastPage int ClassName string Poll int Data string // Used for report metadata Creator *User CSS template.CSS ContentLines int LastUser *User ForumName string //TopicsRow ForumLink string Rids []int } type WsTopicsRow struct { ID int Link string Title string CreatedBy int IsClosed bool Sticky bool CreatedAt time.Time LastReplyAt time.Time RelativeLastReplyAt string LastReplyBy int LastReplyID int ParentID int ViewCount int64 PostCount int LikeCount int AttachCount int ClassName string Creator *WsJSONUser LastUser *WsJSONUser ForumName string ForumLink string } // TODO: Can we get the client side to render the relative times instead? func (r *TopicsRow) WebSockets() *WsTopicsRow { return &WsTopicsRow{r.ID, r.Link, r.Title, r.CreatedBy, r.IsClosed, r.Sticky, r.CreatedAt, r.LastReplyAt, RelativeTime(r.LastReplyAt), r.LastReplyBy, r.LastReplyID, r.ParentID, r.ViewCount, r.PostCount, r.LikeCount, r.AttachCount, r.ClassName, r.Creator.WebSockets(), r.LastUser.WebSockets(), r.ForumName, r.ForumLink} } // TODO: Stop relying on so many struct types? // ! Not quite safe as Topic doesn't contain all the data needed to constructs a TopicsRow func (t *Topic) TopicsRow() *TopicsRow { lastPage := 1 var creator *User = nil contentLines := 1 var lastUser *User = nil forumName := "" forumLink := "" return &TopicsRow{t.ID, t.Link, t.Title, t.Content, t.CreatedBy, t.IsClosed, t.Sticky, t.CreatedAt, t.LastReplyAt, t.LastReplyBy, t.LastReplyID, t.ParentID, t.Status, t.IP, t.ViewCount, t.PostCount, t.LikeCount, t.AttachCount, lastPage, t.ClassName, t.Poll, t.Data, creator, "", contentLines, lastUser, forumName, forumLink, t.Rids} } // ! Some data may be lost in the conversion func (t *TopicsRow) Topic() *Topic { return &Topic{t.ID, t.Link, t.Title, t.Content, t.CreatedBy, t.IsClosed, t.Sticky, t.CreatedAt, t.LastReplyAt, t.LastReplyBy, t.LastReplyID, t.ParentID, t.Status, t.IP, t.ViewCount, t.PostCount, t.LikeCount, t.AttachCount, t.ClassName, t.Poll, t.Data, t.Rids} } // ! Not quite safe as Topic doesn't contain all the data needed to constructs a WsTopicsRow /*func (t *Topic) WsTopicsRows() *WsTopicsRow { var creator *User = nil var lastUser *User = nil forumName := "" forumLink := "" return &WsTopicsRow{t.ID, t.Link, t.Title, t.CreatedBy, t.IsClosed, t.Sticky, t.CreatedAt, t.LastReplyAt, RelativeTime(t.LastReplyAt), t.LastReplyBy, t.LastReplyID, t.ParentID, t.ViewCount, t.PostCount, t.LikeCount, t.AttachCount, t.ClassName, creator, lastUser, forumName, forumLink} }*/ type TopicStmts struct { getRids *sql.Stmt getReplies *sql.Stmt addReplies *sql.Stmt updateLastReply *sql.Stmt lock *sql.Stmt unlock *sql.Stmt moveTo *sql.Stmt stick *sql.Stmt unstick *sql.Stmt hasLikedTopic *sql.Stmt createLike *sql.Stmt addLikesToTopic *sql.Stmt delete *sql.Stmt deleteActivity *sql.Stmt deleteActivitySubs *sql.Stmt edit *sql.Stmt setPoll *sql.Stmt createAction *sql.Stmt getTopicUser *sql.Stmt // TODO: Can we get rid of this? getByReplyID *sql.Stmt } var topicStmts TopicStmts func init() { DbInits.Add(func(acc *qgen.Accumulator) error { t := "topics" topicStmts = TopicStmts{ getRids: acc.Select("replies").Columns("rid").Where("tid = ?").Orderby("rid ASC").Limit("?,?").Prepare(), getReplies: acc.SimpleLeftJoin("replies AS r", "users AS u", "r.rid, r.content, r.createdBy, r.createdAt, r.lastEdit, r.lastEditBy, u.avatar, u.name, u.group, u.level, r.ipaddress, r.likeCount, r.attachCount, r.actionType", "r.createdBy = u.uid", "r.tid = ?", "r.rid ASC", "?,?"), addReplies: acc.Update(t).Set("postCount = postCount + ?, lastReplyBy = ?, lastReplyAt = UTC_TIMESTAMP()").Where("tid = ?").Prepare(), updateLastReply: acc.Update(t).Set("lastReplyID = ?").Where("lastReplyID > ? AND tid = ?").Prepare(), lock: acc.Update(t).Set("is_closed = 1").Where("tid = ?").Prepare(), unlock: acc.Update(t).Set("is_closed = 0").Where("tid = ?").Prepare(), moveTo: acc.Update(t).Set("parentID = ?").Where("tid = ?").Prepare(), stick: acc.Update(t).Set("sticky = 1").Where("tid = ?").Prepare(), unstick: acc.Update(t).Set("sticky = 0").Where("tid = ?").Prepare(), hasLikedTopic: acc.Select("likes").Columns("targetItem").Where("sentBy = ? and targetItem = ? and targetType = 'topics'").Prepare(), createLike: acc.Insert("likes").Columns("weight, targetItem, targetType, sentBy, createdAt").Fields("?,?,?,?,UTC_TIMESTAMP()").Prepare(), addLikesToTopic: acc.Update(t).Set("likeCount = likeCount + ?").Where("tid = ?").Prepare(), delete: acc.Delete(t).Where("tid = ?").Prepare(), deleteActivity: acc.Delete("activity_stream").Where("elementID = ? AND elementType = 'topic'").Prepare(), deleteActivitySubs: acc.Delete("activity_subscriptions").Where("targetID = ? AND targetType = 'topic'").Prepare(), edit: acc.Update(t).Set("title = ?, content = ?, parsed_content = ?").Where("tid = ?").Prepare(), // TODO: Only run the content update bits on non-polls, does this matter? setPoll: acc.Update(t).Set("poll = ?").Where("tid = ? AND poll = 0").Prepare(), createAction: acc.Insert("replies").Columns("tid, actionType, ipaddress, createdBy, createdAt, lastUpdated, content, parsed_content").Fields("?,?,?,?,UTC_TIMESTAMP(),UTC_TIMESTAMP(),'',''").Prepare(), getTopicUser: acc.SimpleLeftJoin("topics AS t", "users AS u", "t.title, t.content, t.createdBy, t.createdAt, t.lastReplyAt, t.lastReplyBy, t.lastReplyID, t.is_closed, t.sticky, t.parentID, t.ipaddress, t.views, t.postCount, t.likeCount, t.attachCount,t.poll, u.name, u.avatar, u.group, u.level", "t.createdBy = u.uid", "tid = ?", "", ""), getByReplyID: acc.SimpleLeftJoin("replies AS r", "topics AS t", "t.tid, t.title, t.content, t.createdBy, t.createdAt, t.is_closed, t.sticky, t.parentID, t.ipaddress, t.views, t.postCount, t.likeCount, t.poll, t.data", "r.tid = t.tid", "rid = ?", "", ""), } return acc.FirstError() }) } // Flush the topic out of the cache // ? - We do a CacheRemove() here instead of mutating the pointer to avoid creating a race condition func (t *Topic) cacheRemove() { if tc := Topics.GetCache(); tc != nil { tc.Remove(t.ID) } TopicListThaw.Thaw() } // TODO: Write a test for this func (t *Topic) AddReply(rid, uid int) (err error) { _, err = topicStmts.addReplies.Exec(1, uid, t.ID) if err != nil { return err } _, err = topicStmts.updateLastReply.Exec(rid, rid, t.ID) t.cacheRemove() return err } func (t *Topic) Lock() (err error) { _, err = topicStmts.lock.Exec(t.ID) t.cacheRemove() return err } func (t *Topic) Unlock() (err error) { _, err = topicStmts.unlock.Exec(t.ID) t.cacheRemove() return err } func (t *Topic) MoveTo(destForum int) (err error) { _, err = topicStmts.moveTo.Exec(destForum, t.ID) t.cacheRemove() if err != nil { return err } err = Attachments.MoveTo(destForum, t.ID, "topics") if err != nil { return err } return Attachments.MoveToByExtra(destForum, "replies", strconv.Itoa(t.ID)) } // TODO: We might want more consistent terminology rather than using stick in some places and pin in others. If you don't understand the difference, there is none, they are one and the same. func (t *Topic) Stick() (err error) { _, err = topicStmts.stick.Exec(t.ID) t.cacheRemove() return err } func (t *Topic) Unstick() (err error) { _, err = topicStmts.unstick.Exec(t.ID) t.cacheRemove() return err } // TODO: Test this // TODO: Use a transaction for this func (t *Topic) Like(score, uid int) (err error) { var disp int // Unused err = topicStmts.hasLikedTopic.QueryRow(uid, t.ID).Scan(&disp) if err != nil && err != ErrNoRows { return err } else if err != ErrNoRows { return ErrAlreadyLiked } _, err = topicStmts.createLike.Exec(score, t.ID, "topics", uid) if err != nil { return err } _, err = topicStmts.addLikesToTopic.Exec(1, t.ID) if err != nil { return err } _, err = userStmts.incLiked.Exec(1, uid) t.cacheRemove() return err } // TODO: Implement this func (t *Topic) Unlike(uid int) error { t.cacheRemove() return nil } // TODO: Use a transaction here func (t *Topic) Delete() error { topicCreator, err := Users.Get(t.CreatedBy) if err == nil { wcount := WordCount(t.Content) err = topicCreator.DecreasePostStats(wcount, true) if err != nil { return err } } else if err != ErrNoRows { return err } _, err = topicStmts.delete.Exec(t.ID) t.cacheRemove() if err != nil { return err } err = Forums.RemoveTopic(t.ParentID) if err != nil && err != ErrNoRows { return err } _, err = topicStmts.deleteActivitySubs.Exec(t.ID) if err != nil { return err } _, err = topicStmts.deleteActivity.Exec(t.ID) return err } // TODO: Write tests for this func (t *Topic) Update(name, content string) error { name = SanitiseSingleLine(html.UnescapeString(name)) if name == "" { return ErrNoTitle } // ? This number might be a little screwy with Unicode, but it's the only consistent thing we have, as Unicode characters can be any number of bytes in theory? if len(name) > Config.MaxTopicTitleLength { return ErrLongTitle } content = PreparseMessage(html.UnescapeString(content)) parsedContent := ParseMessage(content, t.ParentID, "forums", nil) _, err := topicStmts.edit.Exec(name, content, parsedContent, t.ID) t.cacheRemove() return err } func (t *Topic) SetPoll(pollID int) error { _, err := topicStmts.setPoll.Exec(pollID, t.ID) // TODO: Sniff if this changed anything to see if we hit an existing poll t.cacheRemove() return err } // TODO: Have this go through the ReplyStore? func (t *Topic) CreateActionReply(action string, ip string, uid int) (err error) { if Config.DisablePostIP { ip = "0" } res, err := topicStmts.createAction.Exec(t.ID, action, ip, uid) if err != nil { return err } _, err = topicStmts.addReplies.Exec(1, uid, t.ID) if err != nil { return err } lid, err := res.LastInsertId() if err != nil { return err } rid := int(lid) _, err = topicStmts.updateLastReply.Exec(rid, rid, t.ID) t.cacheRemove() // ? - Update the last topic cache for the parent forum? return err } func GetRidsForTopic(tid, offset int) (rids []int, err error) { rows, err := topicStmts.getRids.Query(tid, offset, Config.ItemsPerPage) if err != nil { return nil, err } defer rows.Close() var rid int for rows.Next() { err := rows.Scan(&rid) if err != nil { return nil, err } rids = append(rids, rid) } return rids, rows.Err() } var aipost = ";︎" var lockai = "🔒" + aipost var unlockai = "🔓" var stickai = "📌" var unstickai = "📌" + aipost func (ru *ReplyUser) Init() error { ru.UserLink = BuildProfileURL(NameToSlug(ru.CreatedByName), ru.CreatedBy) ru.ContentLines = strings.Count(ru.Content, "\n") postGroup, err := Groups.Get(ru.Group) if err != nil { return err } if postGroup.IsMod { ru.ClassName = Config.StaffCSS } ru.Tag = postGroup.Tag // TODO: Make a function for this? Build a more sophisticated noavatar handling system? Do bulk user loads and let the c.UserStore initialise this? ru.Avatar, ru.MicroAvatar = BuildAvatar(ru.CreatedBy, ru.Avatar) if ru.Tag == "" { ru.Tag = postGroup.Tag } // We really shouldn't have inline HTML, we should do something about this... if ru.ActionType != "" { aarr := strings.Split(ru.ActionType, "-") action := aarr[0] switch action { case "lock": ru.ActionIcon = lockai case "unlock": ru.ActionIcon = unlockai case "stick": ru.ActionIcon = stickai case "unstick": ru.ActionIcon = unstickai case "move": if len(aarr) == 2 { fid, _ := strconv.Atoi(aarr[1]) forum, err := Forums.Get(fid) if err == nil { ru.ActionType = p.GetTmplPhrasef("topic.action_topic_move_dest", forum.Link, forum.Name, ru.UserLink, ru.CreatedByName) return nil } } default: // TODO: Only fire this off if a corresponding phrase for the ActionType doesn't exist? Or maybe have some sort of action registry? ru.ActionType = p.GetTmplPhrasef("topic.action_topic_default", ru.ActionType) return nil } ru.ActionType = p.GetTmplPhrasef("topic.action_topic_"+action, ru.UserLink, ru.CreatedByName) } return nil } // TODO: Factor TopicUser into a *Topic and *User, as this starting to become overly complicated x.x func (t *TopicUser) Replies(offset int, pFrag int, user *User) (rlist []*ReplyUser, ogdesc string, err error) { var likedMap map[int]int if user.Liked > 0 { likedMap = make(map[int]int) } likedQueryList := []int{user.ID} var attachMap map[int]int if user.Perms.EditReply { attachMap = make(map[int]int) } attachQueryList := []int{} var rid int if len(t.Rids) > 0 { //log.Print("have rid") rid = t.Rids[0] } re, err := Rstore.GetCache().Get(rid) ucache := Users.GetCache() var ruser *User if err == nil && ucache != nil { //log.Print("ucache step") ruser, err = ucache.Get(re.CreatedBy) } hTbl := GetHookTable() rf := func(r *ReplyUser) error { err := r.Init() if err != nil { return err } r.ContentHtml = ParseMessage(r.Content, t.ParentID, "forums", user.ParseSettings) // TODO: Do this more efficiently by avoiding the allocations entirely in ParseMessage, if there's nothing to do. if r.ContentHtml == r.Content { r.ContentHtml = r.Content } // TODO: This doesn't work properly so pick the first one instead? if r.ID == pFrag { ogdesc = r.Content if len(ogdesc) > 200 { ogdesc = ogdesc[:197] + "..." } } if r.LikeCount > 0 && user.Liked > 0 { likedMap[r.ID] = len(rlist) likedQueryList = append(likedQueryList, r.ID) } if user.Perms.EditReply && r.AttachCount > 0 { attachMap[r.ID] = len(rlist) attachQueryList = append(attachQueryList, r.ID) } r.Deletable = user.Perms.DeleteReply || r.CreatedBy == user.ID hTbl.VhookNoRet("topic_reply_row_assign", &rlist, &r) // TODO: Use a pointer instead to make it easier to abstract this loop? What impact would this have on escape analysis? rlist = append(rlist, r) //log.Printf("r: %d-%d", r.ID, len(rlist)-1) return nil } // TODO: Factor the user fields out and embed a user struct instead if err == nil { //log.Print("reply cached serve") reply := &ReplyUser{ClassName: "", Reply: *re, CreatedByName: ruser.Name, Avatar: ruser.Avatar /*URLPrefix: ruser.URLPrefix, URLName: ruser.URLName, */, Level: ruser.Level} err = rf(reply) if err != nil { return nil, "", err } } else { rows, err := topicStmts.getReplies.Query(t.ID, offset, Config.ItemsPerPage) if err != nil { return nil, "", err } defer rows.Close() for rows.Next() { r := &ReplyUser{} err := rows.Scan(&r.ID, &r.Content, &r.CreatedBy, &r.CreatedAt, &r.LastEdit, &r.LastEditBy, &r.Avatar, &r.CreatedByName, &r.Group /*&r.URLPrefix, &r.URLName,*/, &r.Level, &r.IP, &r.LikeCount, &r.AttachCount, &r.ActionType) if err != nil { return nil, "", err } err = rf(r) if err != nil { return nil, "", err } } err = rows.Err() if err != nil { return nil, "", err } } // TODO: Add a config setting to disable the liked query for a burst of extra speed if user.Liked > 0 && len(likedQueryList) > 1 /*&& user.LastLiked <= time.Now()*/ { eids, err := Likes.BulkExists(likedQueryList[1:], user.ID, "replies") if err != nil { return nil, "", err } for _, eid := range eids { rlist[likedMap[eid]].Liked = true } } if user.Perms.EditReply && len(attachQueryList) > 0 { //log.Printf("attachQueryList: %+v\n", attachQueryList) amap, err := Attachments.BulkMiniGetList("replies", attachQueryList) if err != nil && err != sql.ErrNoRows { return nil, "", err } //log.Printf("amap: %+v\n", amap) //log.Printf("attachMap: %+v\n", attachMap) for id, attach := range amap { //log.Print("id:", id) rlist[attachMap[id]].Attachments = attach /*for _, a := range attach { log.Printf("a: %+v\n", a) }*/ } } return rlist, ogdesc, nil } // TODO: Test this func (t *Topic) Author() (*User, error) { return Users.Get(t.CreatedBy) } func (t *Topic) GetID() int { return t.ID } func (t *Topic) GetTable() string { return "topics" } // Copy gives you a non-pointer concurrency safe copy of the topic func (t *Topic) Copy() Topic { return *t } // TODO: Load LastReplyAt and LastReplyID? func TopicByReplyID(rid int) (*Topic, error) { t := Topic{ID: 0} err := topicStmts.getByReplyID.QueryRow(rid).Scan(&t.ID, &t.Title, &t.Content, &t.CreatedBy, &t.CreatedAt, &t.IsClosed, &t.Sticky, &t.ParentID, &t.IP, &t.ViewCount, &t.PostCount, &t.LikeCount, &t.Poll, &t.Data) t.Link = BuildTopicURL(NameToSlug(t.Title), t.ID) return &t, err } // TODO: Refactor the caller to take a Topic and a User rather than a combined TopicUser // TODO: Load LastReplyAt everywhere in here? func GetTopicUser(user *User, tid int) (tu TopicUser, err error) { tcache := Topics.GetCache() ucache := Users.GetCache() if tcache != nil && ucache != nil { topic, err := tcache.Get(tid) if err == nil { if topic.CreatedBy != user.ID { user, err = Users.Get(topic.CreatedBy) if err != nil { return TopicUser{ID: tid}, err } } // We might be better off just passing separate topic and user structs to the caller? return copyTopicToTopicUser(topic, user), nil } else if ucache.Length() < ucache.GetCapacity() { topic, err = Topics.Get(tid) if err != nil { return TopicUser{ID: tid}, err } if topic.CreatedBy != user.ID { user, err = Users.Get(topic.CreatedBy) if err != nil { return TopicUser{ID: tid}, err } } return copyTopicToTopicUser(topic, user), nil } } tu = TopicUser{ID: tid} // TODO: This misses some important bits... err = topicStmts.getTopicUser.QueryRow(tid).Scan(&tu.Title, &tu.Content, &tu.CreatedBy, &tu.CreatedAt, &tu.LastReplyAt, &tu.LastReplyBy, &tu.LastReplyID, &tu.IsClosed, &tu.Sticky, &tu.ParentID, &tu.IP, &tu.ViewCount, &tu.PostCount, &tu.LikeCount, &tu.AttachCount, &tu.Poll, &tu.CreatedByName, &tu.Avatar, &tu.Group, &tu.Level) tu.Avatar, tu.MicroAvatar = BuildAvatar(tu.CreatedBy, tu.Avatar) tu.Link = BuildTopicURL(NameToSlug(tu.Title), tu.ID) tu.UserLink = BuildProfileURL(NameToSlug(tu.CreatedByName), tu.CreatedBy) tu.Tag = Groups.DirtyGet(tu.Group).Tag if tcache != nil { theTopic := Topic{ID: tu.ID, Link: tu.Link, Title: tu.Title, Content: tu.Content, CreatedBy: tu.CreatedBy, IsClosed: tu.IsClosed, Sticky: tu.Sticky, CreatedAt: tu.CreatedAt, LastReplyAt: tu.LastReplyAt, LastReplyID: tu.LastReplyID, ParentID: tu.ParentID, IP: tu.IP, ViewCount: tu.ViewCount, PostCount: tu.PostCount, LikeCount: tu.LikeCount, AttachCount: tu.AttachCount, Poll: tu.Poll} //log.Printf("theTopic: %+v\n", theTopic) _ = tcache.Set(&theTopic) } return tu, err } func copyTopicToTopicUser(t *Topic, u *User) (tu TopicUser) { tu.UserLink = u.Link tu.CreatedByName = u.Name tu.Group = u.Group tu.Avatar = u.Avatar tu.MicroAvatar = u.MicroAvatar //tu.URLPrefix = u.URLPrefix //tu.URLName = u.URLName tu.Level = u.Level tu.ID = t.ID tu.Link = t.Link tu.Title = t.Title tu.Content = t.Content tu.CreatedBy = t.CreatedBy tu.IsClosed = t.IsClosed tu.Sticky = t.Sticky tu.CreatedAt = t.CreatedAt tu.LastReplyAt = t.LastReplyAt tu.LastReplyBy = t.LastReplyBy tu.ParentID = t.ParentID tu.IP = t.IP tu.ViewCount = t.ViewCount tu.PostCount = t.PostCount tu.LikeCount = t.LikeCount tu.AttachCount = t.AttachCount tu.Poll = t.Poll tu.Data = t.Data tu.Rids = t.Rids return tu } // For use in tests and for generating blank topics for forums which don't have a last poster func BlankTopic() *Topic { return new(Topic) } func BuildTopicURL(slug string, tid int) string { if slug == "" || !Config.BuildSlugs { return "/topic/" + strconv.Itoa(tid) } return "/topic/" + slug + "." + strconv.Itoa(tid) } // I don't care if it isn't used,, it will likely be in the future. Nolint. // nolint func getTopicURLPrefix() string { return "/topic/" }