Documentation
¶
Index ¶
- Constants
- func AdminCategoriesPage(w http.ResponseWriter, r *http.Request)
- func AdminCategoryEditPage(w http.ResponseWriter, r *http.Request)
- func AdminCategoryGrantsPage(w http.ResponseWriter, r *http.Request)
- func AdminCategoryPage(w http.ResponseWriter, r *http.Request)
- func AdminPage(w http.ResponseWriter, r *http.Request)
- func AdminWritingsPage(w http.ResponseWriter, r *http.Request)
- func ArticleAddActionPage(w http.ResponseWriter, r *http.Request)
- func ArticleAddPage(w http.ResponseWriter, r *http.Request)
- func ArticleCommentEditActionCancelPage(w http.ResponseWriter, r *http.Request)
- func ArticleCommentEditActionPage(w http.ResponseWriter, r *http.Request)
- func ArticleEditActionPage(w http.ResponseWriter, r *http.Request)
- func ArticleEditPage(w http.ResponseWriter, r *http.Request)
- func ArticlePage(w http.ResponseWriter, r *http.Request)
- func ArticleReplyActionPage(w http.ResponseWriter, r *http.Request)
- func AtomPage(w http.ResponseWriter, r *http.Request)
- func CategoriesPage(w http.ResponseWriter, r *http.Request)
- func CategoryPage(w http.ResponseWriter, r *http.Request)
- func CustomWritingsIndex(data *common.CoreData, r *http.Request)
- func MatchCanEditWritingArticle(r *http.Request, rm *mux.RouteMatch) bool
- func MatchCanPostWriting(r *http.Request, rm *mux.RouteMatch) bool
- func NewWritingsTask() tasks.Task
- func Register(reg *router.Registry)
- func RegisterAdminRoutes(ar *mux.Router)
- func RegisterRoutes(r *mux.Router, _ *config.RuntimeConfig) []navpkg.RouterOptions
- func RegisterTasks() []tasks.NamedTask
- func RequireWritingAuthor(next http.Handler) http.Handler
- func RequireWritingViewAccess(next http.Handler) http.Handler
- func RoleInfoByPermID(ctx context.Context, q db.Querier, id int32) (int32, string, string, error)
- func RssPage(w http.ResponseWriter, r *http.Request)
- func SharedPreviewPage(w http.ResponseWriter, r *http.Request)
- func UserCanCreateWriting(ctx context.Context, q db.Querier, categoryID, uid int32) (bool, error)
- func WriterListPage(w http.ResponseWriter, r *http.Request)
- func WriterPage(w http.ResponseWriter, r *http.Request)
- func WritingCategoryWouldLoop(ctx context.Context, queries db.Querier, cid, parentID int32) ([]int32, bool, error)
- func WritingsCustomIndexItems(cd *common.CoreData, r *http.Request) []common.IndexItem
- func WritingsGeneralIndexItems(cd *common.CoreData, r *http.Request) []common.IndexItem
- func WritingsPage(w http.ResponseWriter, r *http.Request)
- func WritingsPageSpecificItems(cd *common.CoreData, r *http.Request) []common.IndexItem
- type CancelTask
- type CategoryGrantCreateTask
- type CategoryGrantDeleteTask
- type EditReplyTask
- func (EditReplyTask) Action(w http.ResponseWriter, r *http.Request) any
- func (EditReplyTask) AdminEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
- func (EditReplyTask) AdminInternalNotificationTemplate(evt eventbus.TaskEvent) *string
- func (EditReplyTask) RequiredTemplates() []tasks.Template
- type MarkWritingReadTask
- type ReplyTask
- func (ReplyTask) Action(w http.ResponseWriter, r *http.Request) any
- func (ReplyTask) AutoSubscribeGrants(evt eventbus.TaskEvent) ([]notif.GrantRequirement, error)
- func (ReplyTask) AutoSubscribePath(evt eventbus.TaskEvent) (string, string, error)
- func (ReplyTask) GrantsRequired(evt eventbus.TaskEvent) ([]notif.GrantRequirement, error)
- func (ReplyTask) IndexData(data map[string]any) []searchworker.IndexEventData
- func (ReplyTask) IndexType() string
- func (ReplyTask) RequiredTemplates() []tasks.Template
- func (ReplyTask) SubscribedEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
- func (ReplyTask) SubscribedInternalNotificationTemplate(evt eventbus.TaskEvent) *string
- type SetLabelsTask
- type SubmitWritingTask
- func (SubmitWritingTask) Action(w http.ResponseWriter, r *http.Request) any
- func (SubmitWritingTask) GrantsRequired(evt eventbus.TaskEvent) ([]notif.GrantRequirement, error)
- func (SubmitWritingTask) Page(w http.ResponseWriter, r *http.Request)
- func (SubmitWritingTask) RequiredTemplates() []tasks.Template
- func (SubmitWritingTask) SubscribedEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
- func (SubmitWritingTask) SubscribedInternalNotificationTemplate(evt eventbus.TaskEvent) *string
- type UpdateWritingTask
- func (UpdateWritingTask) Action(w http.ResponseWriter, r *http.Request) any
- func (UpdateWritingTask) GrantsRequired(evt eventbus.TaskEvent) ([]notif.GrantRequirement, error)
- func (UpdateWritingTask) Page(w http.ResponseWriter, r *http.Request)
- func (UpdateWritingTask) RequiredTemplates() []tasks.Template
- func (UpdateWritingTask) SubscribedEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
- func (UpdateWritingTask) SubscribedInternalNotificationTemplate(evt eventbus.TaskEvent) *string
- type WritingCategoryChangeTask
- type WritingCategoryCreateTask
Constants ¶
const ( // WritingTopicName is the default name for the hidden writing forum. WritingTopicName = "A WRITING TOPIC" // WritingTopicDescription describes the hidden writing forum. WritingTopicDescription = "THIS IS A HIDDEN FORUM FOR A WRITING" )
const ( EmailTemplateWriting notif.EmailTemplateName = "writingEmail" NotificationTemplateWriting notif.NotificationTemplateName = "writing" EmailTemplateWritingUpdate notif.EmailTemplateName = "writingUpdateEmail" NotificationTemplateWritingUpdate notif.NotificationTemplateName = "writing_update" EmailTemplateWritingReply notif.EmailTemplateName = "replyEmail" NotificationTemplateWritingReply notif.NotificationTemplateName = "reply" EmailTemplateAdminNotificationWritingCommentEdit notif.EmailTemplateName = "adminNotificationNewsCommentEditEmail" )
const ( // TaskSubmitWriting submits a new writing. TaskSubmitWriting tasks.TaskString = "Submit writing" // TaskReply posts a reply on a writing. TaskReply = "Reply" // TaskEditReply edits a comment or reply. TaskEditReply = "Edit Reply" // TaskCancel cancels a pending edit. TaskCancel = "Cancel" // TaskUpdateWriting updates an existing writing. TaskUpdateWriting = "Update writing" // TaskWritingCategoryChange changes a writing category name. TaskWritingCategoryChange = "writing category change" // TaskWritingCategoryCreate creates a new writing category. TaskWritingCategoryCreate = "writing category create" // TaskCategoryGrantCreate adds a new grant to a writing category. TaskCategoryGrantCreate tasks.TaskString = "Create grant" // TaskCategoryGrantDelete removes an existing grant from a writing category. TaskCategoryGrantDelete tasks.TaskString = "Delete grant" )
Task constants used by writings handlers.
const AdminNoAccessPageTmpl tasks.Template = "domains/admin/noAccessPage.gohtml"
const AdminWritingsPageTmpl tasks.Template = "domains/writings/adminWritingsPage.gohtml"
const ArticlePageTmpl tasks.Template = "domains/writings/articlePage.gohtml"
const (
// SectionWeight controls the order of the Writings section in navigation.
SectionWeight = 30
)
const WritingsAdminCategoriesPageTmpl tasks.Template = "domains/writings/writingsAdminCategoriesPage.gohtml"
const WritingsAdminCategoryEditPageTmpl tasks.Template = "domains/writings/writingsAdminCategoryEditPage.gohtml"
const WritingsAdminCategoryGrantsPageTmpl tasks.Template = "domains/writings/adminCategoryGrantsPage.gohtml"
const WritingsAdminCategoryPageTmpl tasks.Template = "domains/writings/writingsAdminCategoryPage.gohtml"
const WritingsAdminPageTmpl tasks.Template = "domains/writings/writingsAdminPage.gohtml"
const WritingsArticleAddPageTmpl tasks.Template = "domains/writings/articleAddPage.gohtml"
const WritingsArticleEditPageTmpl tasks.Template = "domains/writings/articleEditPage.gohtml"
const WritingsCategoriesPageTmpl tasks.Template = "domains/writings/writingsCategoriesPage.gohtml"
const WritingsCategoryPageTmpl tasks.Template = "domains/writings/categoryPage.gohtml"
const (
WritingsPageTmpl tasks.Template = "domains/writings/page.gohtml"
)
const WritingsWriterListPageTmpl tasks.Template = "domains/writings/writerListPage.gohtml"
const WritingsWriterPageTmpl tasks.Template = "domains/writings/writerPage.gohtml"
Variables ¶
This section is empty.
Functions ¶
func AdminCategoriesPage ¶
func AdminCategoriesPage(w http.ResponseWriter, r *http.Request)
func AdminCategoryEditPage ¶
func AdminCategoryEditPage(w http.ResponseWriter, r *http.Request)
AdminCategoryEditPage shows a form to edit a single writing category.
func AdminCategoryGrantsPage ¶
func AdminCategoryGrantsPage(w http.ResponseWriter, r *http.Request)
AdminCategoryGrantsPage shows grants for a writing category.
func AdminCategoryPage ¶
func AdminCategoryPage(w http.ResponseWriter, r *http.Request)
AdminCategoryPage shows a single writing category and its writings.
func AdminPage ¶
func AdminPage(w http.ResponseWriter, r *http.Request)
AdminPage renders the writings administration page.
func AdminWritingsPage ¶
func AdminWritingsPage(w http.ResponseWriter, r *http.Request)
AdminWritingsPage renders the writings admin index with role summaries.
func ArticleAddActionPage ¶
func ArticleAddActionPage(w http.ResponseWriter, r *http.Request)
func ArticleAddPage ¶
func ArticleAddPage(w http.ResponseWriter, r *http.Request)
func ArticleCommentEditActionCancelPage ¶
func ArticleCommentEditActionCancelPage(w http.ResponseWriter, r *http.Request)
ArticleCommentEditActionCancelPage aborts editing a comment.
func ArticleCommentEditActionPage ¶
func ArticleCommentEditActionPage(w http.ResponseWriter, r *http.Request)
ArticleCommentEditActionPage updates a comment on a writing and refreshes thread metadata.
func ArticleEditActionPage ¶
func ArticleEditActionPage(w http.ResponseWriter, r *http.Request)
func ArticleEditPage ¶
func ArticleEditPage(w http.ResponseWriter, r *http.Request)
func ArticlePage ¶
func ArticlePage(w http.ResponseWriter, r *http.Request)
func ArticleReplyActionPage ¶
func ArticleReplyActionPage(w http.ResponseWriter, r *http.Request)
func CategoriesPage ¶
func CategoriesPage(w http.ResponseWriter, r *http.Request)
func CategoryPage ¶
func CategoryPage(w http.ResponseWriter, r *http.Request)
func MatchCanEditWritingArticle ¶
func MatchCanEditWritingArticle(r *http.Request, rm *mux.RouteMatch) bool
MatchCanEditWritingArticle matches requests where the user may edit the referenced writing article.
func MatchCanPostWriting ¶
func MatchCanPostWriting(r *http.Request, rm *mux.RouteMatch) bool
MatchCanPostWriting matches requests where the user may create an article in the referenced category.
func NewWritingsTask ¶
func RegisterAdminRoutes ¶
RegisterAdminRoutes attaches writings admin endpoints to ar.
func RegisterRoutes ¶
func RegisterRoutes(r *mux.Router, _ *config.RuntimeConfig) []navpkg.RouterOptions
RegisterRoutes attaches the public writings endpoints to r.
func RegisterTasks ¶
RegisterTasks returns writing related tasks.
func RequireWritingAuthor ¶
RequireWritingAuthor ensures the requester may edit the writing referenced in the URL.
func RequireWritingViewAccess ¶ added in v0.0.211
RequireWritingViewAccess ensures the user has permission to view the article specified in the URL path. It sets the current thread and topic on success.
func RoleInfoByPermID ¶ added in v0.0.214
func SharedPreviewPage ¶
func SharedPreviewPage(w http.ResponseWriter, r *http.Request)
SharedPreviewPage renders an OpenGraph preview for a writing article.
func UserCanCreateWriting ¶
UserCanCreateWriting reports whether uid may publish an article in the category.
func WriterListPage ¶
func WriterListPage(w http.ResponseWriter, r *http.Request)
WriterListPage shows all writers with their article counts.
func WriterPage ¶
func WriterPage(w http.ResponseWriter, r *http.Request)
func WritingCategoryWouldLoop ¶ added in v0.0.214
func WritingsCustomIndexItems ¶
Deprecated/Wrapper
func WritingsPage ¶
func WritingsPage(w http.ResponseWriter, r *http.Request)
Types ¶
type CancelTask ¶
type CancelTask struct{ tasks.TaskString }
CancelTask cancels comment editing.
func (CancelTask) Action ¶
func (CancelTask) Action(w http.ResponseWriter, r *http.Request) any
type CategoryGrantCreateTask ¶
type CategoryGrantCreateTask struct{ tasks.TaskString }
CategoryGrantCreateTask creates a new grant for a writing category.
func (CategoryGrantCreateTask) Action ¶
func (CategoryGrantCreateTask) Action(w http.ResponseWriter, r *http.Request) any
type CategoryGrantDeleteTask ¶
type CategoryGrantDeleteTask struct{ tasks.TaskString }
CategoryGrantDeleteTask removes a grant from a writing category.
func (CategoryGrantDeleteTask) Action ¶
func (CategoryGrantDeleteTask) Action(w http.ResponseWriter, r *http.Request) any
type EditReplyTask ¶
type EditReplyTask struct{ tasks.TaskString }
EditReplyTask updates an existing comment.
func (EditReplyTask) Action ¶
func (EditReplyTask) Action(w http.ResponseWriter, r *http.Request) any
func (EditReplyTask) AdminEmailTemplate ¶
func (EditReplyTask) AdminEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
func (EditReplyTask) AdminInternalNotificationTemplate ¶
func (EditReplyTask) AdminInternalNotificationTemplate(evt eventbus.TaskEvent) *string
func (EditReplyTask) RequiredTemplates ¶
func (EditReplyTask) RequiredTemplates() []tasks.Template
type MarkWritingReadTask ¶
type MarkWritingReadTask struct{ tasks.TaskString }
MarkWritingReadTask clears the special new/unread flags for a writing and its thread.
func (MarkWritingReadTask) Action ¶
func (MarkWritingReadTask) Action(w http.ResponseWriter, r *http.Request) any
type ReplyTask ¶
type ReplyTask struct{ tasks.TaskString }
ReplyTask posts a comment reply.
func (ReplyTask) AutoSubscribeGrants ¶
func (ReplyTask) AutoSubscribePath ¶
func (ReplyTask) GrantsRequired ¶
func (ReplyTask) IndexData ¶
func (ReplyTask) IndexData(data map[string]any) []searchworker.IndexEventData
func (ReplyTask) RequiredTemplates ¶
func (ReplyTask) SubscribedEmailTemplate ¶
type SetLabelsTask ¶
type SetLabelsTask struct{ tasks.TaskString }
SetLabelsTask replaces private labels on a writing.
func (SetLabelsTask) Action ¶
func (SetLabelsTask) Action(w http.ResponseWriter, r *http.Request) any
type SubmitWritingTask ¶
type SubmitWritingTask struct{ tasks.TaskString }
SubmitWritingTask encapsulates creating a new writing.
func (SubmitWritingTask) Action ¶
func (SubmitWritingTask) Action(w http.ResponseWriter, r *http.Request) any
func (SubmitWritingTask) GrantsRequired ¶
func (SubmitWritingTask) GrantsRequired(evt eventbus.TaskEvent) ([]notif.GrantRequirement, error)
func (SubmitWritingTask) Page ¶
func (SubmitWritingTask) Page(w http.ResponseWriter, r *http.Request)
func (SubmitWritingTask) RequiredTemplates ¶
func (SubmitWritingTask) RequiredTemplates() []tasks.Template
func (SubmitWritingTask) SubscribedEmailTemplate ¶
func (SubmitWritingTask) SubscribedEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
func (SubmitWritingTask) SubscribedInternalNotificationTemplate ¶
func (SubmitWritingTask) SubscribedInternalNotificationTemplate(evt eventbus.TaskEvent) *string
type UpdateWritingTask ¶
type UpdateWritingTask struct{ tasks.TaskString }
UpdateWritingTask applies changes to an article.
func (UpdateWritingTask) Action ¶
func (UpdateWritingTask) Action(w http.ResponseWriter, r *http.Request) any
func (UpdateWritingTask) GrantsRequired ¶
func (UpdateWritingTask) GrantsRequired(evt eventbus.TaskEvent) ([]notif.GrantRequirement, error)
func (UpdateWritingTask) Page ¶
func (UpdateWritingTask) Page(w http.ResponseWriter, r *http.Request)
func (UpdateWritingTask) RequiredTemplates ¶
func (UpdateWritingTask) RequiredTemplates() []tasks.Template
func (UpdateWritingTask) SubscribedEmailTemplate ¶
func (UpdateWritingTask) SubscribedEmailTemplate(evt eventbus.TaskEvent) (templates *notif.EmailTemplates, send bool)
func (UpdateWritingTask) SubscribedInternalNotificationTemplate ¶
func (UpdateWritingTask) SubscribedInternalNotificationTemplate(evt eventbus.TaskEvent) *string
type WritingCategoryChangeTask ¶
type WritingCategoryChangeTask struct{ tasks.TaskString }
WritingCategoryChangeTask modifies a category.
func (WritingCategoryChangeTask) Action ¶
func (WritingCategoryChangeTask) Action(w http.ResponseWriter, r *http.Request) any
type WritingCategoryCreateTask ¶
type WritingCategoryCreateTask struct{ tasks.TaskString }
WritingCategoryCreateTask creates a new category.
func (WritingCategoryCreateTask) Action ¶
func (WritingCategoryCreateTask) Action(w http.ResponseWriter, r *http.Request) any
Source Files
¶
- admin_pages.go
- cancel_task.go
- category_grant_create_task.go
- category_grant_delete_task.go
- constants.go
- customindex.go
- edit_reply_task.go
- label_tasks.go
- matchers.go
- notification_templates.go
- permissions.go
- reply_task.go
- role_info.go
- routes.go
- routes_admin.go
- section.go
- shared_preview.go
- submit_writing_task.go
- tasks.go
- tasks_register.go
- update_writing_task.go
- writing_category_change_task.go
- writing_category_create_task.go
- writingsAdminCategoriesPage.go
- writingsAdminCategoryEditPage.go
- writingsAdminCategoryGrantsPage.go
- writingsAdminCategoryPage.go
- writingsAdminPage.go
- writingsArticleAddPage.go
- writingsArticleCommentEditPage.go
- writingsArticleEditPage.go
- writingsArticlePage.go
- writingsCategoriesPage.go
- writingsCategoryPage.go
- writingsFeed.go
- writingsPage.go
- writingsTask.go
- writingsWriterListPage.go
- writingsWriterPage.go