feat(boards2): implement next boards version

examples/gno.land/r/gnoland/boards2/v1/board.gno

@@ -0,0 +1,260 @@
+package boards2
+
+import (
+	"net/url"
+	"std"
+	"strconv"
+	"strings"
+	"time"
+
+	"gno.land/p/demo/avl"
+	"gno.land/p/gnoland/commondao"
+	"gno.land/p/jeronimoalbi/pager"
+	"gno.land/p/moul/realmpath"
+	"gno.land/p/moul/txlink"
+)
+
+type BoardID uint64
+
+func (id BoardID) String() string {
+	return strconv.Itoa(int(id))
+}
+
+func (id BoardID) Key() string {
+	return padZero(uint64(id), 10)
+}
+
+type Board struct {
+	id        BoardID // only set for public boards.
+	name      string
+	aliases   []string
+	creator   std.Address
+	threads   avl.Tree // Post.id -> *Post
+	postsCtr  uint64   // increments Post.id
+	createdAt time.Time
+	deleted   avl.Tree // TODO reserved for fast-delete.
+	perms     Permissions
+	readonly  bool
+}
+
+func newBoard(id BoardID, name string, creator std.Address, p Permissions) *Board {
+	return &Board{
+		id:        id,
+		name:      name,
+		creator:   creator,
+		threads:   avl.Tree{},
+		createdAt: time.Now(),
+		deleted:   avl.Tree{},
+		perms:     p,
+	}
+}
+
+func (board *Board) GetID() BoardID {
+	return board.id
+}
+
+// GetName returns the name of the board.
+func (board *Board) GetName() string {
+	return board.name
+}
+
+// GetURL returns the relative URL of the board.
+func (board *Board) GetURL() string {
+	return strings.TrimPrefix(std.CurrentRealm().PkgPath(), "gno.land") + ":" + url.PathEscape(board.name)
+}
+
+// GetURL returns relative board path relative.
+//
+// Note: returned result is not escaped. Use GetURL to get URL-encoded path.
+func (board *Board) GetPath() string {
+	return strings.TrimPrefix(std.CurrentRealm().PkgPath(), "gno.land") + ":" + board.name
+}
+
+func (board *Board) GetPermissions() Permissions {
+	return board.perms
+}
+
+// SetReadonly updates board's read-only status.
+func (board *Board) SetReadonly(readonly bool) {
+	board.readonly = readonly
+}
+
+// IsReadonly checks if the board is a read-only board.
+func (board *Board) IsReadonly() bool {
+	return board.readonly
+}
+
+func (board *Board) GetThread(threadID PostID) (_ *Post, found bool) {
+	v, found := board.threads.Get(threadID.Key())
+	if !found {
+		return nil, false
+	}
+	return v.(*Post), true
+}
+
+func (board *Board) AddThread(creator std.Address, title string, body string) *Post {
+	pid := board.incGetPostID()
+	thread := newPost(board, pid, creator, title, body, pid, 0, 0)
+	board.threads.Set(pid.Key(), thread)
+	return thread
+}
+
+// NOTE: this can be potentially very expensive for threads with many replies.
+// TODO: implement optional fast-delete where thread is simply moved.
+func (board *Board) DeleteThread(pid PostID) {
+	_, removed := board.threads.Remove(pid.Key())
+	if !removed {
+		panic("thread does not exist with ID " + pid.String())
+	}
+}
+
+// Render renders a board into Markdown.
+func (board *Board) Render(path, menu string) string {
+	var sb strings.Builder
+
+	sb.WriteString("# " + board.GetName() + "  \n")
+	sb.WriteString("_Board created by " + newUserLink(board.creator) + " ")
+	sb.WriteString("on " + board.createdAt.Format(dateFormat))
+	sb.WriteString(", #" + board.id.String() + "_")
+
+	if board.IsReadonly() {
+		sb.WriteString("  \n_**Starting new threads and commenting is disabled**_")
+	}
+
+	// XXX: Menu is rendered by the caller to deal with links and sub-menus
+	// TODO: We should have the render logic separated from boards so avoid sending menu as argument
+	if menu != "" {
+		sb.WriteString("\n\n")
+		sb.WriteString(menu)
+		sb.WriteString("\n")
+	}
+
+	sb.WriteString("\n\n---\n")
+
+	if board.threads.Size() == 0 {
+		sb.WriteString("### This board doesn't have any threads\n")
+		if !board.IsReadonly() {
+			url := board.GetPostFormURL()
+			sb.WriteString("Do you want to [start a new conversation](" + url + ") in this board ?")
+		}
+		return sb.String()
+	}
+
+	p, err := pager.New(path, board.threads.Size(), pager.WithPageSize(pageSizeThreads))
+	if err != nil {
+		panic(err)
+	}
+
+	render := func(_ string, v any) bool {
+		thread := v.(*Post)
+		if thread.isHidden {
+			return false
+		}
+
+		sb.WriteString(thread.RenderSummary())
+		sb.WriteString("\n")
+		return false
+	}
+
+	sb.WriteString("_Sort by ")
+	r := realmpath.Parse(path)
+	if r.Query.Get("order") == "desc" {
+		r.Query.Set("order", "asc")
+		sb.WriteString(newLink("newest first", r.String()))
+		sb.WriteString("_\n")
+		board.threads.ReverseIterateByOffset(p.Offset(), p.PageSize(), render)
+	} else {
+		r.Query.Set("order", "desc")
+		sb.WriteString(newLink("oldest first", r.String()))
+		sb.WriteString("_\n")
+		board.threads.IterateByOffset(p.Offset(), p.PageSize(), render)
+	}
+
+	if p.HasPages() {
+		sb.WriteString("\n---\n")
+		sb.WriteString(pager.Picker(p))
+	}
+
+	return sb.String()
+}
+
+func (board *Board) incGetPostID() PostID {
+	board.postsCtr++
+	return PostID(board.postsCtr)
+}
+
+func (board *Board) GetURLFromThreadID(threadID PostID) string {
+	return board.GetURL() + "/" + threadID.String()
+}
+
+func (board *Board) GetURLFromReplyID(threadID, replyID PostID) string {
+	return board.GetURL() + "/" + threadID.String() + "/" + replyID.String()
+}
+
+func (board *Board) GetRenameFormURL() string { // TODO: These type of functions shouldn't be part of Board type
+	return txlink.Call("RenameBoard", "name", board.name)
+}
+
+func (board *Board) GetFreezeFormURL() string {
+	return txlink.Call("FreezeBoard", "boardID", board.id.String())
+}
+
+func (board *Board) GetUnfreezeFormURL() string {
+	return txlink.Call("UnfreezeBoard", "boardID", board.id.String())
+}
+
+func (board *Board) GetFlaggingThresholdFormURL() string {
+	return txlink.Call("SetFlaggingThreshold", "boardID", board.id.String())
+}
+
+func (board *Board) GetInviteMemberFormURL() string {
+	return txlink.Call("InviteMember", "boardID", board.id.String())
+}
+
+func (board *Board) GetPostFormURL() string {
+	return txlink.Call("CreateThread", "boardID", board.id.String())
+}
+
+func (board *Board) GetMembersURL() string {
+	return board.GetURL() + "/members"
+}
+
+func createDefaultBoardPermissions(owner std.Address) *DefaultPermissions {
+	perms := NewDefaultPermissions(commondao.New())
+	perms.SetSuperRole(RoleOwner)
+	perms.AddRole(
+		RoleAdmin,
+		PermissionBoardRename,
+		PermissionBoardFlaggingUpdate,
+		PermissionMemberInvite,
+		PermissionMemberRemove,
+		PermissionThreadCreate,
+		PermissionThreadEdit,
+		PermissionThreadDelete,
+		PermissionThreadRepost,
+		PermissionThreadFlag,
+		PermissionThreadFreeze,
+		PermissionReplyCreate,
+		PermissionReplyDelete,
+		PermissionReplyFlag,
+		PermissionReplyFreeze,
+		PermissionRoleChange,
+	)
+	perms.AddRole(
+		RoleModerator,
+		PermissionThreadCreate,
+		PermissionThreadEdit,
+		PermissionThreadRepost,
+		PermissionThreadFlag,
+		PermissionReplyCreate,
+		PermissionReplyFlag,
+	)
+	perms.AddRole(
+		RoleGuest,
+		PermissionThreadCreate,
+		PermissionThreadRepost,
+		PermissionReplyCreate,
+	)
+	perms.AddUser(owner, RoleOwner)
+	return perms
+}

examples/gno.land/r/gnoland/boards2/v1/board_readonly.gno

@@ -0,0 +1,80 @@
+package boards2
+
+import (
+	"std"
+	"time"
+)
+
+// ReadonlyBoard defines an interface for readonly boards.
+type ReadonlyBoard interface {
+	// ID returns the unique identifier of the board.
+	ID() BoardID
+
+	// Name returns the name of the board.
+	Name() string
+
+	// Aliases returns a list with previous names assigned to the board.
+	Aliases() []string
+
+	// Creator returns board's creator address.
+	Creator() std.Address
+
+	// LastPostID returns the ID assigned to the last created thread.
+	LastPostID() uint64
+
+	// CreatedAt returns the time when board was created.
+	CreatedAt() time.Time
+
+	// IsReadonly returns true when board shouldn't allow the creation of threads and comments.
+	IsReadonly() bool
+
+	// MembersCount returns the number of invited board members.
+	MembersCount() int
+
+	// IterateMembers allows reading the list of invited board members.
+	IterateMembers(offset, count int, fn UsersIterFn)
+}
+
+type readonlyBoard struct {
+	board *Board
+}
+
+func (b readonlyBoard) ID() BoardID {
+	return b.board.id
+}
+
+func (b readonlyBoard) Name() string {
+	return b.board.name
+}
+
+func (b readonlyBoard) Aliases() []string {
+	aliases := make([]string, len(b.board.aliases))
+	for i, s := range b.board.aliases {
+		aliases[i] = s
+	}
+	return aliases
+}
+
+func (b readonlyBoard) Creator() std.Address {
+	return b.board.creator
+}
+
+func (b readonlyBoard) LastPostID() uint64 {
+	return b.board.postsCtr
+}
+
+func (b readonlyBoard) CreatedAt() time.Time {
+	return b.board.createdAt
+}
+
+func (b readonlyBoard) IsReadonly() bool {
+	return b.board.readonly
+}
+
+func (b readonlyBoard) MembersCount() int {
+	return b.board.perms.UsersCount()
+}
+
+func (b readonlyBoard) IterateMembers(offset, count int, fn UsersIterFn) {
+	b.board.perms.IterateUsers(offset, count, fn)
+}