Fix TestNewImageAttachment tests

In particular, this will support audio attachments.

Ref T872

activitystreams/attachment.go

@@ -14,20 +14,34 @@ type Attachment struct {
 
 type AttachmentType string
 
-const AttachImage AttachmentType = "Image"
+const (
+	AttachImage    AttachmentType = "Image"
+	AttachDocument AttachmentType = "Document"
+)
 
 // NewImageAttachment creates a new Attachment from the given URL, setting the
 // correct type and automatically detecting the MediaType based on the file
 // extension.
 func NewImageAttachment(url string) Attachment {
-	var imgType string
+	return newAttachment(url, AttachImage)
+}
+
+// NewDocumentAttachment creates a new Attachment from the given URL, setting the
+// correct type and automatically detecting the MediaType based on the file
+// extension.
+func NewDocumentAttachment(url string) Attachment {
+	return newAttachment(url, AttachDocument)
+}
+
+func newAttachment(url string, attachType AttachmentType) Attachment {
+	var fileType string
 	extIdx := strings.LastIndexByte(url, '.')
 	if extIdx > -1 {
-		imgType = mime.TypeByExtension(url[extIdx:])
+		fileType = mime.TypeByExtension(url[extIdx:])
 	}
 	return Attachment{
-		Type:      AttachImage,
+		Type:      attachType,
 		URL:       url,
-		MediaType: imgType,
+		MediaType: fileType,
 	}
 }

activitystreams/attachment_test.go

@@ -12,19 +12,19 @@ func TestNewImageAttachment(t *testing.T) {
 	tests := []struct {
 		name string
 		args args
-		want *Attachment
+		want Attachment
 	}{
-		{name: "good svg", args: args{"https://writefreely.org/img/writefreely.svg"}, want: &Attachment{
+		{name: "good svg", args: args{"https://writefreely.org/img/writefreely.svg"}, want: Attachment{
 			Type:      "Image",
 			URL:       "https://writefreely.org/img/writefreely.svg",
 			MediaType: "image/svg+xml",
 		}},
-		{name: "good png", args: args{"https://i.snap.as/12345678.png"}, want: &Attachment{
+		{name: "good png", args: args{"https://i.snap.as/12345678.png"}, want: Attachment{
 			Type:      "Image",
 			URL:       "https://i.snap.as/12345678.png",
 			MediaType: "image/png",
 		}},
-		{name: "no extension", args: args{"https://i.snap.as/12345678"}, want: &Attachment{
+		{name: "no extension", args: args{"https://i.snap.as/12345678"}, want: Attachment{
 			Type:      "Image",
 			URL:       "https://i.snap.as/12345678",
 			MediaType: "",
@@ -38,3 +38,27 @@ func TestNewImageAttachment(t *testing.T) {
 		})
 	}
 }
+
+func TestNewDocumentAttachment(t *testing.T) {
+	type args struct {
+		url string
+	}
+	tests := []struct {
+		name string
+		args args
+		want Attachment
+	}{
+		{name: "mp3", args: args{"https://listen.as/matt/abc.mp3"}, want: Attachment{
+			Type:      "Document",
+			URL:       "https://listen.as/matt/abc.mp3",
+			MediaType: "audio/mpeg",
+		}},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := NewDocumentAttachment(tt.args.url); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("NewDocumentAttachment() = %+v, want %+v", got, tt.want)
+			}
+		})
+	}
+}

go.mod

@@ -4,14 +4,14 @@ go 1.10
 
 require (
 	github.com/gofrs/uuid v3.3.0+incompatible
-	github.com/kr/pretty v0.1.0 // indirect
 	github.com/kylemcc/twitter-text-go v0.0.0-20180726194232-7f582f6736ec
 	github.com/microcosm-cc/bluemonday v1.0.2
 	github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
-	github.com/writeas/impart v1.1.0
+	github.com/writeas/go-strip-markdown v2.0.1+incompatible
+	github.com/writeas/impart v1.1.1
 	github.com/writeas/openssl-go v1.0.0
-	github.com/writeas/saturday v1.6.0
+	github.com/writeas/saturday v1.7.1
-	golang.org/x/crypto v0.0.0-20190131182504-b8fe1690c613
+	golang.org/x/crypto v0.0.0-20200109152110-61a87790db17
-	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0 // indirect
 )

go.sum

@@ -1,8 +1,7 @@
-github.com/gofrs/uuid v1.2.0 h1:coDhrjgyJaglxSjxuJdqQSSdUpG3w6p1OwN2od6frBU=
 github.com/gofrs/uuid v3.3.0+incompatible h1:8K4tyRfvU1CYPgJsveYFQMhpFd/wXNM7iK6rR7UHz84=
 github.com/gofrs/uuid v3.3.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
-github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
-github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
@@ -12,17 +11,25 @@ github.com/microcosm-cc/bluemonday v1.0.2 h1:5lPfLTTAvAbtS0VqT+94yOtFnGfUWYyx0+i
 github.com/microcosm-cc/bluemonday v1.0.2/go.mod h1:iVP4YcDBq+n/5fb23BhYFvIMq/leAFZyRl6bYmGDlGc=
 github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
-github.com/writeas/impart v1.1.0 h1:nPnoO211VscNkp/gnzir5UwCDEvdHThL5uELU60NFSE=
+github.com/writeas/go-strip-markdown v2.0.1+incompatible h1:IIqxTM5Jr7RzhigcL6FkrCNfXkvbR+Nbu1ls48pXYcw=
-github.com/writeas/impart v1.1.0/go.mod h1:g0MpxdnTOHHrl+Ca/2oMXUHJ0PcRAEWtkCzYCJUXC9Y=
+github.com/writeas/go-strip-markdown v2.0.1+incompatible/go.mod h1:Rsyu10ZhbEK9pXdk8V6MVnZmTzRG0alMNLMwa0J01fE=
+github.com/writeas/impart v1.1.1 h1:RyA9+CqbdbDuz53k+nXCWUY+NlEkdyw6+nWanxSBl5o=
+github.com/writeas/impart v1.1.1/go.mod h1:g0MpxdnTOHHrl+Ca/2oMXUHJ0PcRAEWtkCzYCJUXC9Y=
 github.com/writeas/openssl-go v1.0.0 h1:YXM1tDXeYOlTyJjoMlYLQH1xOloUimSR1WMF8kjFc5o=
 github.com/writeas/openssl-go v1.0.0/go.mod h1:WsKeK5jYl0B5y8ggOmtVjbmb+3rEGqSD25TppjJnETA=
-github.com/writeas/saturday v1.6.0 h1:HNUtX8TVJJnSdxE8vaAgtHiAJVt+Of5AJYlm62pmVlI=
+github.com/writeas/saturday v1.7.1 h1:lYo1EH6CYyrFObQoA9RNWHVlpZA5iYL5Opxo7PYAnZE=
-github.com/writeas/saturday v1.6.0/go.mod h1:ETE1EK6ogxptJpAgUbcJD0prAtX48bSloie80+tvnzQ=
+github.com/writeas/saturday v1.7.1/go.mod h1:ETE1EK6ogxptJpAgUbcJD0prAtX48bSloie80+tvnzQ=
-golang.org/x/crypto v0.0.0-20190131182504-b8fe1690c613 h1:MQ/ZZiDsUapFFiMS+vzwXkCTeEKaum+Do5rINYJDmxc=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.0.0-20190131182504-b8fe1690c613/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+golang.org/x/crypto v0.0.0-20200109152110-61a87790db17 h1:nVJ3guKA9qdkEQ3TUdXI9QSINo2CUPM/cySEvw2w8I0=
+golang.org/x/crypto v0.0.0-20200109152110-61a87790db17/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/net v0.0.0-20181220203305-927f97764cc3 h1:eH6Eip3UpmR+yM/qI9Ijluzb1bNv/cAU/n+6l8tRSis=
 golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 h1:0GoQqolDA55aaLxZyTzK/Y2ePZzZTUrRacwib7cNsYQ=
-gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0 h1:POO/ycCATvegFmVuPpQzZFJ+pGZeX22Ufu6fibxDVjU=
 gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0/go.mod h1:WDnlLJ4WF5VGsH/HVa3CI79GS0ol3YnhVnKP89i0kNg=

id/random.go

@@ -1,8 +1,8 @@
 package id
 
 import (
-	"fmt"
 	"crypto/rand"
+	"fmt"
 )
 
 // GenerateRandomString creates a random string of characters of the given
@@ -24,3 +24,15 @@ func GenerateRandomString(dictionary string, l int) string {
 func GenSafeUniqueSlug(slug string) string {
 	return fmt.Sprintf("%s-%s", slug, GenerateRandomString("0123456789bcdfghjklmnpqrstvwxyz", 4))
 }
+
+// Generate62RandomString creates a random string with the given length
+// consisting of characters in [A-Za-z0-9].
+func Generate62RandomString(l int) string {
+	return GenerateRandomString("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", l)
+}
+
+// GenerateFriendlyRandomString creates a random string of characters with the
+// given length consisting of characters in [a-z0-9].
+func GenerateFriendlyRandomString(l int) string {
+	return GenerateRandomString("0123456789abcdefghijklmnopqrstuvwxyz", l)
+}

posts/parse.go

@@ -1,7 +1,24 @@
 package posts
 
 import (
+	"fmt"
+	stripmd "github.com/writeas/go-strip-markdown"
+	"github.com/writeas/web-core/stringmanip"
+	"regexp"
 	"strings"
+	"unicode"
+	"unicode/utf8"
+)
+
+const (
+	maxTitleLen     = 80
+	assumedTitleLen = 80
+)
+
+var (
+	titleElementReg = regexp.MustCompile("</?p>")
+	urlReg          = regexp.MustCompile("https?://")
+	imgReg          = regexp.MustCompile(`!\[([^]]+)\]\([^)]+\)`)
 )
 
 // ExtractTitle takes the given raw post text and returns a title, if explicitly
@@ -19,3 +36,130 @@ func ExtractTitle(content string) (title string, body string) {
 	body = content
 	return
 }
+
+func FriendlyPostTitle(content, friendlyId string) string {
+	content = StripHTMLWithoutEscaping(content)
+
+	content = strings.TrimLeftFunc(stripmd.Strip(content), unicode.IsSpace)
+	eol := strings.IndexRune(content, '\n')
+	blankLine := strings.Index(content, "\n\n")
+	if blankLine != -1 && blankLine <= eol && blankLine <= assumedTitleLen {
+		return strings.TrimSpace(content[:blankLine])
+	} else if eol == -1 && utf8.RuneCountInString(content) <= maxTitleLen {
+		return content
+	}
+
+	title, truncd := TruncToWord(PostLede(content, true), maxTitleLen)
+	if truncd {
+		title += "..."
+	}
+	return title
+}
+
+// PostDescription generates a description based on the given post content,
+// title, and post ID. This doesn't consider a V2 post field, `title` when
+// choosing what to generate. In case a post has a title, this function will
+// fail, and logic should instead be implemented to skip this when there's no
+// title, like so:
+//    var desc string
+//    if title == "" {
+//        desc = PostDescription(content, title, friendlyId)
+//    } else {
+//        desc = ShortPostDescription(content)
+//    }
+func PostDescription(content, title, friendlyId string) string {
+	maxLen := 140
+
+	if content == "" {
+		content = "WriteFreely is a painless, simple, federated blogging platform."
+	} else {
+		fmtStr := "%s"
+		truncation := 0
+		if utf8.RuneCountInString(content) > maxLen {
+			// Post is longer than the max description, so let's show a better description
+			fmtStr = "%s..."
+			truncation = 3
+		}
+
+		if title == friendlyId {
+			// No specific title was found; simply truncate the post, starting at the beginning
+			content = fmt.Sprintf(fmtStr, strings.Replace(stringmanip.Substring(content, 0, maxLen-truncation), "\n", " ", -1))
+		} else {
+			// There was a title, so return a real description
+			blankLine := strings.Index(content, "\n\n")
+			if blankLine < 0 {
+				blankLine = 0
+			}
+			truncd := stringmanip.Substring(content, blankLine, blankLine+maxLen-truncation)
+			contentNoNL := strings.Replace(truncd, "\n", " ", -1)
+			content = strings.TrimSpace(fmt.Sprintf(fmtStr, contentNoNL))
+		}
+	}
+
+	return content
+}
+
+func ShortPostDescription(content string) string {
+	maxLen := 140
+	fmtStr := "%s"
+	truncation := 0
+	if utf8.RuneCountInString(content) > maxLen {
+		// Post is longer than the max description, so let's show a better description
+		fmtStr = "%s..."
+		truncation = 3
+	}
+	return strings.TrimSpace(fmt.Sprintf(fmtStr, strings.Replace(stringmanip.Substring(content, 0, maxLen-truncation), "\n", " ", -1)))
+}
+
+// TruncToWord truncates the given text to the provided limit.
+func TruncToWord(s string, l int) (string, bool) {
+	truncated := false
+	c := []rune(s)
+	if len(c) > l {
+		truncated = true
+		s = string(c[:l])
+		spaceIdx := strings.LastIndexByte(s, ' ')
+		if spaceIdx > -1 {
+			s = s[:spaceIdx]
+		}
+	}
+	return s, truncated
+}
+
+// PostLede attempts to extract the first thought of the given post, generally
+// contained within the first line or sentence of text.
+func PostLede(t string, includePunc bool) string {
+	// Adjust where we truncate if we want to include punctuation
+	iAdj := 0
+	if includePunc {
+		iAdj = 1
+	}
+
+	// Find lede within first line of text
+	nl := strings.IndexRune(t, '\n')
+	if nl > -1 {
+		t = t[:nl]
+	}
+
+	// Strip certain HTML tags
+	t = titleElementReg.ReplaceAllString(t, "")
+
+	// Strip URL protocols
+	t = urlReg.ReplaceAllString(t, "")
+
+	// Strip image URL, leaving only alt text
+	t = imgReg.ReplaceAllString(t, " $1 ")
+
+	// Find lede within first sentence
+	punc := strings.Index(t, ". ")
+	if punc > -1 {
+		t = t[:punc+iAdj]
+	}
+	punc = stringmanip.IndexRune(t, '。')
+	if punc > -1 {
+		c := []rune(t)
+		t = string(c[:punc+iAdj])
+	}
+
+	return t
+}

posts/render.go

@@ -3,6 +3,7 @@ package posts
 import (
 	"github.com/microcosm-cc/bluemonday"
 	"github.com/writeas/saturday"
+	"html"
 	"regexp"
 	"strings"
 	"unicode"
@@ -61,3 +62,9 @@ func ApplyBasicMarkdown(data []byte) string {
 
 	return outHTML
 }
+
+// StripHTMLWithoutEscaping strips HTML tags with bluemonday's StrictPolicy, then unescapes the HTML
+// entities added in by sanitizing the content.
+func StripHTMLWithoutEscaping(content string) string {
+	return html.UnescapeString(bluemonday.StrictPolicy().Sanitize(content))
+}