Markdown Statuses (#116)

* parse markdown statuses if desired

* add some preliminary docs for writing posts

9 files changed, 36 insertions, 39 deletions

diff --git a/internal/processing/account/create.go b/internal/processing/account/create.go
index 58ac0e43c..83e76973d 100644
--- a/internal/processing/account/create.go
+++ b/internal/processing/account/create.go
@@ -23,7 +23,7 @@ import (
 
 	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
-	"github.com/superseriousbusiness/gotosocial/internal/util"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 	"github.com/superseriousbusiness/oauth2/v4"
 )
 
@@ -45,7 +45,7 @@ func (p *processor) Create(applicationToken oauth2.TokenInfo, application *gtsmo
 	}
 
 	l.Trace("creating new username and account")
-	user, err := p.db.NewSignup(form.Username, util.RemoveHTML(reason), p.config.AccountsConfig.RequireApproval, form.Email, form.Password, form.IP, form.Locale, application.ID, false, false)
+	user, err := p.db.NewSignup(form.Username, text.RemoveHTML(reason), p.config.AccountsConfig.RequireApproval, form.Email, form.Password, form.IP, form.Locale, application.ID, false, false)
 	if err != nil {
 		return nil, fmt.Errorf("error creating new signup in the database: %s", err)
 	}
diff --git a/internal/processing/account/update.go b/internal/processing/account/update.go
index fbe29ac86..df842bacd 100644
--- a/internal/processing/account/update.go
+++ b/internal/processing/account/update.go
@@ -28,6 +28,7 @@ import (
 	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 	"github.com/superseriousbusiness/gotosocial/internal/media"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 	"github.com/superseriousbusiness/gotosocial/internal/util"
 )
 
@@ -50,7 +51,7 @@ func (p *processor) Update(account *gtsmodel.Account, form *apimodel.UpdateCrede
 		if err := util.ValidateDisplayName(*form.DisplayName); err != nil {
 			return nil, err
 		}
-		displayName := util.RemoveHTML(*form.DisplayName) // no html allowed in display name
+		displayName := text.RemoveHTML(*form.DisplayName) // no html allowed in display name
 		if err := p.db.UpdateOneByID(account.ID, "display_name", displayName, &gtsmodel.Account{}); err != nil {
 			return nil, err
 		}
@@ -60,7 +61,7 @@ func (p *processor) Update(account *gtsmodel.Account, form *apimodel.UpdateCrede
 		if err := util.ValidateNote(*form.Note); err != nil {
 			return nil, err
 		}
-		note := util.SanitizeHTML(*form.Note) // html OK in note but sanitize it
+		note := text.SanitizeHTML(*form.Note) // html OK in note but sanitize it
 		if err := p.db.UpdateOneByID(account.ID, "note", note, &gtsmodel.Account{}); err != nil {
 			return nil, err
 		}
diff --git a/internal/processing/admin/createdomainblock.go b/internal/processing/admin/createdomainblock.go
index 78c830a43..df02cef94 100644
--- a/internal/processing/admin/createdomainblock.go
+++ b/internal/processing/admin/createdomainblock.go
@@ -28,7 +28,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 	"github.com/superseriousbusiness/gotosocial/internal/id"
-	"github.com/superseriousbusiness/gotosocial/internal/util"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 )
 
 func (p *processor) DomainBlockCreate(account *gtsmodel.Account, domain string, obfuscate bool, publicComment string, privateComment string, subscriptionID string) (*apimodel.DomainBlock, gtserror.WithCode) {
@@ -52,8 +52,8 @@ func (p *processor) DomainBlockCreate(account *gtsmodel.Account, domain string,
 			ID:                 blockID,
 			Domain:             domain,
 			CreatedByAccountID: account.ID,
-			PrivateComment:     util.RemoveHTML(privateComment),
-			PublicComment:      util.RemoveHTML(publicComment),
+			PrivateComment:     text.RemoveHTML(privateComment),
+			PublicComment:      text.RemoveHTML(publicComment),
 			Obfuscate:          obfuscate,
 			SubscriptionID:     subscriptionID,
 		}
diff --git a/internal/processing/instance.go b/internal/processing/instance.go
index 962b841a6..89f60f5d4 100644
--- a/internal/processing/instance.go
+++ b/internal/processing/instance.go
@@ -25,6 +25,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/db"
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 	"github.com/superseriousbusiness/gotosocial/internal/util"
 )
 
@@ -60,7 +61,7 @@ func (p *processor) InstancePatch(form *apimodel.InstanceSettingsUpdateRequest)
 		if err := util.ValidateSiteTitle(*form.Title); err != nil {
 			return nil, gtserror.NewErrorBadRequest(err, fmt.Sprintf("site title invalid: %s", err))
 		}
-		i.Title = util.RemoveHTML(*form.Title) // don't allow html in site title
+		i.Title = text.RemoveHTML(*form.Title) // don't allow html in site title
 	}
 
 	// validate & update site contact account if it's set on the form
@@ -110,7 +111,7 @@ func (p *processor) InstancePatch(form *apimodel.InstanceSettingsUpdateRequest)
 		if err := util.ValidateSiteShortDescription(*form.ShortDescription); err != nil {
 			return nil, gtserror.NewErrorBadRequest(err, err.Error())
 		}
-		i.ShortDescription = util.SanitizeHTML(*form.ShortDescription) // html is OK in site description, but we should sanitize it
+		i.ShortDescription = text.SanitizeHTML(*form.ShortDescription) // html is OK in site description, but we should sanitize it
 	}
 
 	// validate & update site description if it's set on the form
@@ -118,7 +119,7 @@ func (p *processor) InstancePatch(form *apimodel.InstanceSettingsUpdateRequest)
 		if err := util.ValidateSiteDescription(*form.Description); err != nil {
 			return nil, gtserror.NewErrorBadRequest(err, err.Error())
 		}
-		i.Description = util.SanitizeHTML(*form.Description) // html is OK in site description, but we should sanitize it
+		i.Description = text.SanitizeHTML(*form.Description) // html is OK in site description, but we should sanitize it
 	}
 
 	// validate & update site terms if it's set on the form
@@ -126,7 +127,7 @@ func (p *processor) InstancePatch(form *apimodel.InstanceSettingsUpdateRequest)
 		if err := util.ValidateSiteTerms(*form.Terms); err != nil {
 			return nil, gtserror.NewErrorBadRequest(err, err.Error())
 		}
-		i.Terms = util.SanitizeHTML(*form.Terms) // html is OK in site terms, but we should sanitize it
+		i.Terms = text.SanitizeHTML(*form.Terms) // html is OK in site terms, but we should sanitize it
 	}
 
 	// process avatar if provided
diff --git a/internal/processing/media/create.go b/internal/processing/media/create.go
index baf9f2918..5b8cdf604 100644
--- a/internal/processing/media/create.go
+++ b/internal/processing/media/create.go
@@ -26,7 +26,7 @@ import (
 
 	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
-	"github.com/superseriousbusiness/gotosocial/internal/util"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 )
 
 func (p *processor) Create(account *gtsmodel.Account, form *apimodel.AttachmentRequest) (*apimodel.Attachment, error) {
@@ -54,7 +54,7 @@ func (p *processor) Create(account *gtsmodel.Account, form *apimodel.AttachmentR
 	// TODO: handle this inside mediaHandler.ProcessAttachment (just pass more params to it)
 
 	// first description
-	attachment.Description = util.RemoveHTML(form.Description) // remove any HTML from the image description
+	attachment.Description = text.RemoveHTML(form.Description) // remove any HTML from the image description
 
 	// now parse the focus parameter
 	focusx, focusy, err := parseFocus(form.Focus)
diff --git a/internal/processing/media/update.go b/internal/processing/media/update.go
index b5ffc77d8..28f3a26f6 100644
--- a/internal/processing/media/update.go
+++ b/internal/processing/media/update.go
@@ -26,7 +26,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/db"
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
-	"github.com/superseriousbusiness/gotosocial/internal/util"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 )
 
 func (p *processor) Update(account *gtsmodel.Account, mediaAttachmentID string, form *apimodel.AttachmentUpdateRequest) (*apimodel.Attachment, gtserror.WithCode) {
@@ -44,7 +44,7 @@ func (p *processor) Update(account *gtsmodel.Account, mediaAttachmentID string,
 	}
 
 	if form.Description != nil {
-		attachment.Description = util.RemoveHTML(*form.Description)
+		attachment.Description = text.RemoveHTML(*form.Description)
 		if err := p.db.UpdateByID(mediaAttachmentID, attachment); err != nil {
 			return nil, gtserror.NewErrorInternalError(fmt.Errorf("database error updating description: %s", err))
 		}
diff --git a/internal/processing/status/create.go b/internal/processing/status/create.go
index 37d7e6aab..7480efd60 100644
--- a/internal/processing/status/create.go
+++ b/internal/processing/status/create.go
@@ -8,6 +8,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 	"github.com/superseriousbusiness/gotosocial/internal/id"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 	"github.com/superseriousbusiness/gotosocial/internal/util"
 )
 
@@ -29,7 +30,7 @@ func (p *processor) Create(account *gtsmodel.Account, application *gtsmodel.Appl
 		Local:                    true,
 		AccountID:                account.ID,
 		AccountURI:               account.URI,
-		ContentWarning:           util.RemoveHTML(form.SpoilerText),
+		ContentWarning:           text.RemoveHTML(form.SpoilerText),
 		ActivityStreamsType:      gtsmodel.ActivityStreamsNote,
 		Sensitive:                form.Sensitive,
 		Language:                 form.Language,
diff --git a/internal/processing/status/status.go b/internal/processing/status/status.go
index d83c325fd..0073e254b 100644
--- a/internal/processing/status/status.go
+++ b/internal/processing/status/status.go
@@ -7,6 +7,7 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/db"
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
 	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
+	"github.com/superseriousbusiness/gotosocial/internal/text"
 	"github.com/superseriousbusiness/gotosocial/internal/typeutils"
 	"github.com/superseriousbusiness/gotosocial/internal/visibility"
 )
@@ -40,6 +41,7 @@ type processor struct {
 	config        *config.Config
 	db            db.DB
 	filter        visibility.Filter
+	formatter     text.Formatter
 	fromClientAPI chan gtsmodel.FromClientAPI
 	log           *logrus.Logger
 }
@@ -51,6 +53,7 @@ func New(db db.DB, tc typeutils.TypeConverter, config *config.Config, fromClient
 		config:        config,
 		db:            db,
 		filter:        visibility.NewFilter(db, log),
+		formatter:     text.NewFormatter(config, db, log),
 		fromClientAPI: fromClientAPI,
 		log:           log,
 	}
diff --git a/internal/processing/status/util.go b/internal/processing/status/util.go
index eb83babb0..b4d115f8d 100644
--- a/internal/processing/status/util.go
+++ b/internal/processing/status/util.go
@@ -3,7 +3,6 @@ package status
 import (
 	"errors"
 	"fmt"
-	"strings"
 
 	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
 	"github.com/superseriousbusiness/gotosocial/internal/db"
@@ -238,36 +237,28 @@ func (p *processor) processEmojis(form *apimodel.AdvancedStatusCreateForm, accou
 }
 
 func (p *processor) processContent(form *apimodel.AdvancedStatusCreateForm, accountID string, status *gtsmodel.Status) error {
+	// if there's nothing in the status at all we can just return early
 	if form.Status == "" {
 		status.Content = ""
 		return nil
 	}
 
-	// surround the whole status in '<p>'
-	content := fmt.Sprintf(`<p>%s</p>`, form.Status)
-
-	// format mentions nicely
-	for _, menchie := range status.GTSMentions {
-		targetAccount := &gtsmodel.Account{}
-		if err := p.db.GetByID(menchie.TargetAccountID, targetAccount); err == nil {
-			mentionContent := fmt.Sprintf(`<span class="h-card"><a href="%s" class="u-url mention">@<span>%s</span></a></span>`, targetAccount.URL, targetAccount.Username)
-			content = strings.ReplaceAll(content, menchie.NameString, mentionContent)
-		}
+	// if format wasn't specified we should set the default
+	if form.Format == "" {
+		form.Format = apimodel.StatusFormatDefault
 	}
 
-	// format tags nicely
-	for _, tag := range status.GTSTags {
-		tagContent := fmt.Sprintf(`<a href="%s" class="mention hashtag" rel="tag">#<span>%s</span></a>`, tag.URL, tag.Name)
-		content = strings.ReplaceAll(content, fmt.Sprintf("#%s", tag.Name), tagContent)
+	// parse content out of the status depending on what format has been submitted
+	var content string
+	switch form.Format {
+	case apimodel.StatusFormatPlain:
+		content = p.formatter.FromPlain(form.Status, status.GTSMentions, status.GTSTags)
+	case apimodel.StatusFormatMarkdown:
+		content = p.formatter.FromMarkdown(form.Status, status.GTSMentions, status.GTSTags)
+	default:
+		return fmt.Errorf("format %s not recognised as a valid status format", form.Format)
 	}
 
-	// replace newlines with breaks
-	content = strings.ReplaceAll(content, "\n", "<br />")
-
-	// sanitize html to remove any dodgy scripts or other disallowed elements
-	clean := util.SanitizeHTML(content)
-
-	// set the content as the shiny clean parsed content
-	status.Content = clean
+	status.Content = content
 	return nil
 }