Add Forum Post Support #1609

KTStephano · 2024-01-25T03:00:30Z

Continuation of #1604 and #1453

This PR does two things:

Updates discordgo, dstate with new fields related to forums (available tags, applied tags, default thread rate limits, etc.)
Adds createForumPost and deleteForumPost templates

Other Info:

Limits for create and remove are currently shared with thread's create and remove limits
Optional args for createForumPost are set to use key-value style so that order doesn't matter and we can also expose other optional args later

API (templates):

Field	Description
.Channel.IsForum	true if channel is forum type
.Channel.AvailableTags	Slice of discordgo.ForumTag. Only present if channel is forum type.
.Channel.AppliedTags	Slice of int64 representing tag ids. Only present if channel represents a specific forum thread/post.

API (functions):

createForumPost channel name content (optional: "slowmode" arg "tags" arg)

Creates a new forum post in channel. content can be a string, embed or complex message. name represents the title of the post. "slowmode" arg allows the user to specify the thread's slowmode (in seconds). "tags" arg allows the user to specify one or more forum tags. Duplicate and invalid tags are ignored, and arg can be either a string or cslice. Returns *templates.CtxChannel upon success.

deleteForumPost post

Removes post. Can be either thread's ID or mention.

Examples:

(Create)

{{$forumChannel := ...}}
{{$postTitle := "Forum Post Title"}}
{{$post := createForumPost $forumChannel $postTitle "post content as string"}}

{{$tags = cslice "discussion" "bot" "info"}}
{{$post = createForumPost $forumChannel $postTitle (cembed ...) "tags" $tags}}

{{$oneMinute := 60}}
{{$post = createForumPost $forumChannel $postTitle (cembed ...) "slowmode" $oneMinute}}

{{$post = createForumPost $forumChannel $postTitle (cembed ...) "tags" $tags "slowmode" $oneMinute}}

(Delete)

{{deleteForumPost $post.ID}}

…s createForumPost and removeForumPost IsForum exposed to CCs to quickly check if a channel is a forum channel AvailableTags are exposed to CCs as a slice of discordgo.ForumTag AppliedTags are exposed to CCs as a slice of int64 ids

mrbentarikau · 2024-01-25T15:17:41Z

common/templates/context.go

 	c.addContextFunc("createThread", c.tmplCreateThread)
 	c.addContextFunc("deleteThread", c.tmplDeleteThread)
 	c.addContextFunc("addThreadMember", c.tmplThreadMemberAdd)
 	c.addContextFunc("removeThreadMember", c.tmplThreadMemberRemove)

+	// forum functions
+	c.addContextFunc("createForumPost", c.tmplCreateForumPost)
+	c.addContextFunc("removeForumPost", c.tmplRemoveForumPost)


deleteForumPost feels better (create > delete, add > remove, give > take logic), also no need for additional c.tmplRemoveForumPost why not just c.tmplDeleteThread

one could always add a comment to that method, that it deletes both, simple thread and a forum post

That makes sense, I renamed it "deleteForumPost". I also removed tmplRemoveForumPost in favor of reusing tmplDeleteThread (added a comment about being it able to delete both types of threads like you suggested).

mrbentarikau · 2024-01-25T15:45:39Z

common/templates/context_funcs.go

+	return rateLimit, tags, nil
+}
+
+func (c *Context) tmplCreateForumPost(channel, content interface{}, name string, optional ...interface{}) (*CtxChannel, error) {


To me workflow of giving arguments > channel, name, content, (optional...) feels better. Post title is sort of first than post content. I know it needs interface{} twice then : )

Latest commit switches the order to be channel, name, content, (optional...)

I'm also wondering if createThread from the last PR should be changed to follow the same format. For example
createThread channel name (optional: "message_id" arg "private" arg)

looks reasonable, to have thread's name first rest is already all content and how content is shown

but at its current state, it is less code and writing createThread nil nil "threadName" is not that cumbersome.

so let's wait what developer thinks, both ways are good for me.

it think that parameter name could also be part of type interface{} and you later ToString() it, because in some cases it is easier to use pure numbers as thread/forumPost name : )

Pushed a change that switches both create functions to use interface{} for name. It calls ToString() on it before passing it to discordgo.

…or createForumPost

…moveForumPost (reuses tmplDeleteThread instead)

mrbentarikau · 2024-01-26T00:01:22Z

lib/dstate/interface.go

+	DefaultReactionEmoji          discordgo.ForumDefaultReaction `json:"default_reaction_emoji"`
+	DefaultThreadRateLimitPerUser int                            `json:"default_thread_rate_limit_per_user"`
+	DefaultSortOrder              *discordgo.ForumSortOrderType  `json:"default_sort_order"`
+	DefaultForumLayout            discordgo.ForumLayout          `json:"default_forum_layout"`


I think, for IsPrivate() method few lines down, || c.Type == discordgo.ChannelTypeGuildPrivateThread needs to be added to if

Does GuildPrivateThread sit on the same level as DM privacy?

looking at how this is handled in context functions, well it is a badly named field. Channel Type 12 says yeah it's private as well. so better not change this.

…ForumPost

mrbentarikau · 2024-01-26T15:07:45Z

lib/discordgo/structs.go

+	DefaultReactionEmoji ForumDefaultReaction `json:"default_reaction_emoji"`
+
+	// The initial RateLimitPerUser to set on newly created threads in a channel.
+	// This field is copied to the thread at creation time and does not live update.
+	DefaultThreadRateLimitPerUser int `json:"default_thread_rate_limit_per_user"`
+
+	// The default sort order type used to order posts in forum channels.
+	// Defaults to null, which indicates a preferred sort order hasn't been set by a channel admin.
+	DefaultSortOrder *ForumSortOrderType `json:"default_sort_order"`
+
+	// The default forum layout view used to display posts in forum channels.
+	// Defaults to ForumLayoutNotSet, which indicates a layout view has not been set by a channel admin.
+	DefaultForumLayout ForumLayout `json:"default_forum_layout"`


Perhaps these fields should be in templates/structs.go > CtxChannel as well

Yeah could add them. When I first went through it I just wasn't sure if people would need those fields in CCs. They're present in the dstate.ChannelState struct though for Go code to use

KTStephano changed the title ~~templates,discordgo,dstate: Adds extended support for forums API; add…~~ Add Forum Post Support Jan 25, 2024

templates: Adds better handling of invalid tags being passed to create

6be3018

mrbentarikau reviewed Jan 25, 2024

View reviewed changes

KTStephano added 2 commits January 25, 2024 13:53

templates: changes arg order to channel, name, content, optional... f…

1f75601

…or createForumPost

templates: changes createForumPost to deleteForumPost; removes tmplRe…

75c532b

…moveForumPost (reuses tmplDeleteThread instead)

mrbentarikau reviewed Jan 26, 2024

View reviewed changes

templates: changes arg to use interface{} for createThread and create…

fb17875

…ForumPost

mrbentarikau reviewed Jan 26, 2024

View reviewed changes

ashishjh-bst merged commit fa1f387 into botlabs-gg:dev Jan 30, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Forum Post Support #1609

Add Forum Post Support #1609

KTStephano commented Jan 25, 2024 •

edited

mrbentarikau Jan 25, 2024 •

edited

KTStephano Jan 25, 2024

mrbentarikau Jan 25, 2024 •

edited

KTStephano Jan 25, 2024

KTStephano Jan 25, 2024

mrbentarikau Jan 25, 2024 •

edited

mrbentarikau Jan 26, 2024 •

edited

KTStephano Jan 26, 2024 •

edited

mrbentarikau Jan 26, 2024

KTStephano Jan 26, 2024

mrbentarikau Jan 26, 2024

mrbentarikau Jan 26, 2024

KTStephano Jan 26, 2024 •

edited

Add Forum Post Support #1609

Add Forum Post Support #1609

Conversation

KTStephano commented Jan 25, 2024 • edited

createForumPost channel name content (optional: "slowmode" arg "tags" arg)

deleteForumPost post

mrbentarikau Jan 25, 2024 • edited

Choose a reason for hiding this comment

KTStephano Jan 25, 2024

Choose a reason for hiding this comment

mrbentarikau Jan 25, 2024 • edited

Choose a reason for hiding this comment

KTStephano Jan 25, 2024

Choose a reason for hiding this comment

KTStephano Jan 25, 2024

Choose a reason for hiding this comment

mrbentarikau Jan 25, 2024 • edited

Choose a reason for hiding this comment

mrbentarikau Jan 26, 2024 • edited

Choose a reason for hiding this comment

KTStephano Jan 26, 2024 • edited

Choose a reason for hiding this comment

mrbentarikau Jan 26, 2024

Choose a reason for hiding this comment

KTStephano Jan 26, 2024

Choose a reason for hiding this comment

mrbentarikau Jan 26, 2024

Choose a reason for hiding this comment

mrbentarikau Jan 26, 2024

Choose a reason for hiding this comment

KTStephano Jan 26, 2024 • edited

Choose a reason for hiding this comment

KTStephano commented Jan 25, 2024 •

edited

mrbentarikau Jan 25, 2024 •

edited

mrbentarikau Jan 25, 2024 •

edited

mrbentarikau Jan 25, 2024 •

edited

mrbentarikau Jan 26, 2024 •

edited

KTStephano Jan 26, 2024 •

edited

KTStephano Jan 26, 2024 •

edited