feature: Unfurl status links

VERSION

@@ -1 +1 @@
-0.169.0
+0.170.0

protocol/common/media_server_image_id.go

@@ -0,0 +1,28 @@
+package common
+
+type MediaServerImageIDPrefix string
+type MediaServerImageIDPostfix string
+type MediaServerImageID string
+
+func CreateImageID(prefix MediaServerImageIDPrefix, postfix MediaServerImageIDPostfix) MediaServerImageID {
+	return MediaServerImageID(string(prefix) + string(postfix))
+}
+
+const (
+	MediaServerIconPostfix   MediaServerImageIDPostfix = "icon"
+	MediaServerBannerPostfix MediaServerImageIDPostfix = "banner"
+)
+
+const (
+	MediaServerContactPrefix          MediaServerImageIDPrefix = "contact-"
+	MediaServerCommunityPrefix        MediaServerImageIDPrefix = "community-"
+	MediaServerChannelCommunityPrefix MediaServerImageIDPrefix = "community-channel-"
+)
+
+const (
+	MediaServerContactIcon            = MediaServerImageID(string(MediaServerContactPrefix) + string(MediaServerIconPostfix))
+	MediaServerCommunityIcon          = MediaServerImageID(string(MediaServerCommunityPrefix) + string(MediaServerIconPostfix))
+	MediaServerCommunityBanner        = MediaServerImageID(string(MediaServerCommunityPrefix) + string(MediaServerBannerPostfix))
+	MediaServerChannelCommunityIcon   = MediaServerImageID(string(MediaServerChannelCommunityPrefix) + string(MediaServerIconPostfix))
+	MediaServerChannelCommunityBanner = MediaServerImageID(string(MediaServerChannelCommunityPrefix) + string(MediaServerBannerPostfix))
+)

protocol/common/message.go

@@ -8,7 +8,6 @@ import (
 	"errors"
 	"fmt"
 	"io/ioutil"
-	"net/url"
 	"os"
 	"strings"
 	"unicode"
@@ -82,26 +81,6 @@ const (
 	ContactVerificationStateCanceled
 )
 
-type LinkPreviewThumbnail struct {
-	Width  int `json:"width"`
-	Height int `json:"height"`
-	// Non-empty when the thumbnail is available via the media server, i.e. after
-	// the chat message is sent.
-	URL string `json:"url,omitempty"`
-	// Non-empty when the thumbnail payload needs to be shared with the client,
-	// but before it has been persisted.
-	DataURI string `json:"dataUri,omitempty"`
-}
-
-type LinkPreview struct {
-	Type        protobuf.UnfurledLink_LinkType `json:"type"`
-	URL         string                         `json:"url"`
-	Hostname    string                         `json:"hostname"`
-	Title       string                         `json:"title,omitempty"`
-	Description string                         `json:"description,omitempty"`
-	Thumbnail   LinkPreviewThumbnail           `json:"thumbnail,omitempty"`
-}
-
 const EveryoneMentionTag = "0x00001"
 
 type CommandParameters struct {
@@ -219,8 +198,9 @@ type Message struct {
 	Replied bool `json:"replied"`
 
 	// Links is an array of links within given message
-	Links        []string
-	LinkPreviews []LinkPreview `json:"linkPreviews"`
+	Links              []string
+	LinkPreviews       []LinkPreview       `json:"linkPreviews"`
+	StatusLinkPreviews []StatusLinkPreview `json:"statusLinkPreviews"`
 
 	// EditedAt indicates the clock value it was edited
 	EditedAt uint64 `json:"editedAt"`
@@ -292,6 +272,7 @@ func (m *Message) MarshalJSON() ([]byte, error) {
 		Replied                  bool                             `json:"replied,omitempty"`
 		Links                    []string                         `json:"links,omitempty"`
 		LinkPreviews             []LinkPreview                    `json:"linkPreviews,omitempty"`
+		StatusLinkPreviews       []StatusLinkPreview              `json:"statusLinkPreviews,omitempty"`
 		EditedAt                 uint64                           `json:"editedAt,omitempty"`
 		Deleted                  bool                             `json:"deleted,omitempty"`
 		DeletedBy                string                           `json:"deletedBy,omitempty"`
@@ -331,6 +312,7 @@ func (m *Message) MarshalJSON() ([]byte, error) {
 		Replied:                  m.Replied,
 		Links:                    m.Links,
 		LinkPreviews:             m.LinkPreviews,
+		StatusLinkPreviews:       m.StatusLinkPreviews,
 		MessageType:              m.MessageType,
 		CommandParameters:        m.CommandParameters,
 		GapParameters:            m.GapParameters,
@@ -763,98 +745,6 @@ func (m *Message) LoadImage() error {
 	return nil
 }
 
-func isValidLinkPreviewThumbnail(thumbnail LinkPreviewThumbnail) bool {
-	return (thumbnail.DataURI == "" && thumbnail.Width == 0 && thumbnail.Height == 0) ||
-		(thumbnail.DataURI != "" && thumbnail.Width > 0 && thumbnail.Height > 0)
-}
-
-func isValidLinkPreviewForProto(preview LinkPreview) bool {
-	switch preview.Type {
-	case protobuf.UnfurledLink_IMAGE:
-		return preview.URL != "" && isValidLinkPreviewThumbnail(preview.Thumbnail)
-	default: // Validate as a link type by default.
-		return preview.Title != "" && preview.URL != "" && isValidLinkPreviewThumbnail(preview.Thumbnail)
-	}
-}
-
-// ConvertLinkPreviewsToProto expects previews to be correctly sent by the
-// client because we can't attempt to re-unfurl URLs at this point (it's
-// actually undesirable). We run a basic validation as an additional safety net.
-func (m *Message) ConvertLinkPreviewsToProto() ([]*protobuf.UnfurledLink, error) {
-	if len(m.LinkPreviews) == 0 {
-		return nil, nil
-	}
-
-	unfurledLinks := make([]*protobuf.UnfurledLink, 0, len(m.LinkPreviews))
-
-	for _, preview := range m.LinkPreviews {
-		// Do not process subsequent previews because we do expect all previews to
-		// be valid at this stage.
-		if !isValidLinkPreviewForProto(preview) {
-			return nil, fmt.Errorf("invalid link preview, url='%s'", preview.URL)
-		}
-
-		var payload []byte
-		var err error
-		if preview.Thumbnail.DataURI != "" {
-			payload, err = images.GetPayloadFromURI(preview.Thumbnail.DataURI)
-			if err != nil {
-				return nil, fmt.Errorf("could not get data URI payload, url='%s': %w", preview.URL, err)
-			}
-		}
-
-		ul := &protobuf.UnfurledLink{
-			Type:             preview.Type,
-			Url:              preview.URL,
-			Title:            preview.Title,
-			Description:      preview.Description,
-			ThumbnailWidth:   uint32(preview.Thumbnail.Width),
-			ThumbnailHeight:  uint32(preview.Thumbnail.Height),
-			ThumbnailPayload: payload,
-		}
-		unfurledLinks = append(unfurledLinks, ul)
-	}
-
-	return unfurledLinks, nil
-}
-
-func (m *Message) ConvertFromProtoToLinkPreviews(makeMediaServerURL func(msgID string, previewURL string) string) []LinkPreview {
-	var links []*protobuf.UnfurledLink
-
-	if links = m.GetUnfurledLinks(); links == nil {
-		return nil
-	}
-
-	previews := make([]LinkPreview, 0, len(links))
-	for _, link := range links {
-		parsedURL, err := url.Parse(link.Url)
-		var hostname string
-		// URL parsing in Go can fail with URLs that weren't correctly URL encoded.
-		// This shouldn't happen in general, but if an error happens we just reuse
-		// the full URL.
-		if err != nil {
-			hostname = link.Url
-		} else {
-			hostname = parsedURL.Hostname()
-		}
-		lp := LinkPreview{
-			Description: link.Description,
-			Hostname:    hostname,
-			Title:       link.Title,
-			Type:        link.Type,
-			URL:         link.Url,
-		}
-		if payload := link.GetThumbnailPayload(); payload != nil {
-			lp.Thumbnail.Width = int(link.ThumbnailWidth)
-			lp.Thumbnail.Height = int(link.ThumbnailHeight)
-			lp.Thumbnail.URL = makeMediaServerURL(m.ID, link.Url)
-		}
-		previews = append(previews, lp)
-	}
-
-	return previews
-}
-
 func (m *Message) SetAlbumIDAndImagesCount(albumID string, imagesCount uint32) error {
 	imageMessage := m.GetImage()
 	if imageMessage == nil {