Merge pull request #260 from zeetabit/master

Support attachment base64 and custom filename.

Author: bbernhard

Dockerfile

@@ -118,7 +118,7 @@ COPY src/go.mod /tmp/signal-cli-rest-api-src/
 COPY src/go.sum /tmp/signal-cli-rest-api-src/
 
 # build signal-cli-rest-api
-RUN cd /tmp/signal-cli-rest-api-src && swag init && go build
+RUN cd /tmp/signal-cli-rest-api-src && swag init && go test ./client -v && go build
 
 # build supervisorctl_config_creator
 RUN cd /tmp/signal-cli-rest-api-src/scripts && go build -o jsonrpc2-helper 

src/api/api.go

@@ -69,7 +69,7 @@ type RegisterNumberRequest struct {
 }
 
 type UnregisterNumberRequest struct {
-	DeleteAccount bool `json:"delete_account" example:"false"`
+	DeleteAccount   bool `json:"delete_account" example:"false"`
 	DeleteLocalData bool `json:"delete_local_data" example:"false"`
 }
 
@@ -88,15 +88,15 @@ type SendMessageV1 struct {
 	Number           string   `json:"number"`
 	Recipients       []string `json:"recipients"`
 	Message          string   `json:"message"`
-	Base64Attachment string   `json:"base64_attachment"`
+	Base64Attachment string   `json:"base64_attachment" example:"'<BASE64 ENCODED DATA>' OR 'data:<MIME-TYPE>;base64,<BASE64 ENCODED DATA>' OR 'data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>'"`
 	IsGroup          bool     `json:"is_group"`
 }
 
 type SendMessageV2 struct {
 	Number            string   `json:"number"`
 	Recipients        []string `json:"recipients"`
 	Message           string   `json:"message"`
-	Base64Attachments []string `json:"base64_attachments"`
+	Base64Attachments []string `json:"base64_attachments" example:"<BASE64 ENCODED DATA>,data:<MIME-TYPE>;base64<comma><BASE64 ENCODED DATA>,data:<MIME-TYPE>;filename=<FILENAME>;base64<comma><BASE64 ENCODED DATA>"`
 }
 
 type TypingIndicatorRequest struct {

src/client/attachment.go

@@ -0,0 +1,169 @@
+package client
+
+import (
+	"encoding/base64"
+	"errors"
+	"os"
+	"reflect"
+	"strings"
+
+	"github.com/gabriel-vasile/mimetype"
+	uuid "github.com/gofrs/uuid"
+)
+
+type AttachmentEntry struct {
+	MimeInfo         string
+	FileName         string
+	DirName          string
+	Base64           string
+	FilePath         string
+	attachmentTmpDir string
+}
+
+func NewAttachmentEntry(attachmentData string, attachmentTmpDir string) *AttachmentEntry {
+	attachmentEntry := AttachmentEntry{
+		MimeInfo:         "",
+		FileName:         "",
+		DirName:          "",
+		Base64:           "",
+		FilePath:         "",
+		attachmentTmpDir: attachmentTmpDir,
+	}
+
+	attachmentEntry.extractMetaData(attachmentData)
+
+	return &attachmentEntry
+}
+
+func (attachmentEntry *AttachmentEntry) extractMetaData(attachmentData string) {
+	base64FlagIndex := strings.LastIndex(attachmentData, "base64,")
+
+	if !strings.Contains(attachmentData, "data:") || base64FlagIndex == -1 {
+		attachmentEntry.Base64 = attachmentData
+		return
+	}
+
+	attachmentEntry.Base64 = attachmentData[base64FlagIndex+len("base64,"):]
+	metaDataKeys := map[string]string{
+		"data:":     "MimeInfo",
+		"filename=": "FileName",
+	}
+
+	for _, metaDataLineItem := range strings.Split(attachmentData[:base64FlagIndex-1], ";") {
+		for metaDataKey, metaDataFieldName := range metaDataKeys {
+			flagIndex := strings.Index(metaDataLineItem, metaDataKey)
+
+			if flagIndex != 0 {
+				continue
+			}
+
+			attachmentEntry.setFieldValueByName(metaDataFieldName, metaDataLineItem[len(metaDataKey):])
+		}
+	}
+}
+
+func (attachmentEntry *AttachmentEntry) storeBase64AsTemporaryFile() error {
+	if strings.Compare(attachmentEntry.Base64, "") == 0 {
+		return errors.New("The base64 data does not exist.")
+	}
+
+	dec, err := base64.StdEncoding.DecodeString(attachmentEntry.Base64)
+	if err != nil {
+		return err
+	}
+
+	// if no custom filename
+	if strings.Compare(attachmentEntry.FileName, "") == 0 {
+		mimeType := mimetype.Detect(dec)
+
+		fileNameUuid, err := uuid.NewV4()
+		if err != nil {
+			return err
+		}
+		attachmentEntry.FileName = fileNameUuid.String() + mimeType.Extension()
+	}
+
+	dirNameUuid, err := uuid.NewV4()
+	if err != nil {
+		return err
+	}
+
+	attachmentEntry.DirName = dirNameUuid.String()
+	dirPath := attachmentEntry.attachmentTmpDir + attachmentEntry.DirName
+	if err := os.Mkdir(dirPath, os.ModePerm); err != nil {
+		return err
+	}
+
+	attachmentEntry.FilePath = dirPath + string(os.PathSeparator) + attachmentEntry.FileName
+
+	f, err := os.Create(attachmentEntry.FilePath)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	if _, err := f.Write(dec); err != nil {
+		attachmentEntry.cleanUp()
+		return err
+	}
+	if err := f.Sync(); err != nil {
+		attachmentEntry.cleanUp()
+		return err
+	}
+	f.Close()
+
+	return nil
+}
+
+func (attachmentEntry *AttachmentEntry) cleanUp() {
+	if strings.Compare(attachmentEntry.FilePath, "") != 0 {
+		os.Remove(attachmentEntry.FilePath)
+	}
+
+	if strings.Compare(attachmentEntry.DirName, "") != 0 {
+		dirPath := attachmentEntry.attachmentTmpDir + attachmentEntry.DirName
+		os.Remove(dirPath)
+	}
+}
+
+func (attachmentEntry *AttachmentEntry) setFieldValueByName(fieldName string, fieldValue string) {
+	reflectPointer := reflect.ValueOf(attachmentEntry)
+	reflectStructure := reflectPointer.Elem()
+
+	if reflectStructure.Kind() != reflect.Struct {
+		return
+	}
+
+	field := reflectStructure.FieldByName(fieldName)
+	if !field.IsValid() {
+		return
+	}
+
+	if !field.CanSet() || field.Kind() != reflect.String {
+		return
+	}
+
+	field.SetString(fieldValue)
+}
+
+func (attachmentEntry *AttachmentEntry) isWithMetaData() bool {
+	return len(attachmentEntry.MimeInfo) > 0 && len(attachmentEntry.Base64) > 0
+}
+
+func (attachmentEntry *AttachmentEntry) toDataForSignal() string {
+	if len(attachmentEntry.FilePath) > 0 {
+		return attachmentEntry.FilePath
+	}
+
+	if !attachmentEntry.isWithMetaData() {
+		return attachmentEntry.Base64
+	}
+
+	result := "data:" + attachmentEntry.MimeInfo
+
+	if len(attachmentEntry.FileName) > 0 {
+		result = result + ";filename=" + attachmentEntry.FileName
+	}
+
+	return result + ";base64," + attachmentEntry.Base64
+}

src/client/attachment_test.go

@@ -0,0 +1,107 @@
+package client
+
+import (
+	"flag"
+	"os"
+	"strings"
+	"testing"
+)
+
+func Test_Attachment_ExtractMetadata_ShouldPrepareDataFor_toDataForSignal(t *testing.T) {
+	testCases := []struct {
+		nameTest             string
+		inputData            string
+		resultIsWithMetaData bool
+		base64Expected       string
+		base64Valid          bool
+		fileNameExpected     string
+		mimeInfoExpected     string
+		toDataForSignal      string
+	}{
+		{
+			"BC base64 - compatibility", "MTIzNDU=", false, "MTIzNDU=", true, "", "", "MTIzNDU=",
+		},
+		{
+			"+base64 -data -filename", "base64,MTIzNDU=", false, "base64,MTIzNDU=", false, "", "", "base64,MTIzNDU=",
+		},
+		{
+			"+base64 +data -filename", "data:someData;base64,MTIzNDU=", true, "MTIzNDU=", true, "", "someData", "data:someData;base64,MTIzNDU=",
+		},
+		{
+			"+base64 -data +filename", "filename=file.name;base64,MTIzNDU=", false, "filename=file.name;base64,MTIzNDU=", false, "", "", "filename=file.name;base64,MTIzNDU=",
+		},
+		{
+			"+base64 +data +filename", "data:someData;filename=file.name;base64,MTIzNDU=", true, "MTIzNDU=", true, "file.name", "someData", "data:someData;filename=file.name;base64,MTIzNDU=",
+		},
+		{
+			"-base64 -data -filename", "INVALIDMTIzNDU=", false, "INVALIDMTIzNDU=", false, "", "", "INVALIDMTIzNDU=",
+		},
+		{
+			"-base64 +data -filename", "data:someData;INVALIDMTIzNDU=", false, "data:someData;INVALIDMTIzNDU=", false, "", "", "data:someData;INVALIDMTIzNDU=",
+		},
+		{
+			"-base64 -data +filename", "filename=file.name;INVALIDMTIzNDU=", false, "filename=file.name;INVALIDMTIzNDU=", false, "", "", "filename=file.name;INVALIDMTIzNDU=",
+		},
+		{
+			"-base64 +data +filename", "data:someData;filename=file.name;INVALIDMTIzNDU=", false, "data:someData;filename=file.name;INVALIDMTIzNDU=", false, "", "", "data:someData;filename=file.name;INVALIDMTIzNDU=",
+		},
+	}
+
+	attachmentTmp := flag.String("attachment-tmp-dir", string(os.PathSeparator)+"tmp"+string(os.PathSeparator), "Attachment tmp directory")
+
+	for _, tt := range testCases {
+		t.Run(tt.nameTest, func(t *testing.T) {
+			attachmentEntry := NewAttachmentEntry(tt.inputData, *attachmentTmp)
+
+			if attachmentEntry.isWithMetaData() != tt.resultIsWithMetaData {
+				t.Errorf("isWithMetaData() got \"%v\", want \"%v\"", attachmentEntry.isWithMetaData(), tt.resultIsWithMetaData)
+			}
+
+			if strings.Compare(attachmentEntry.Base64, tt.base64Expected) != 0 {
+				t.Errorf("Base64 got \"%v\", want \"%v\"", attachmentEntry.Base64, tt.base64Expected)
+			}
+
+			if strings.Compare(attachmentEntry.FileName, tt.fileNameExpected) != 0 {
+				t.Errorf("FileName got \"%v\", want \"%v\"", attachmentEntry.FileName, tt.fileNameExpected)
+			}
+
+			if strings.Compare(attachmentEntry.MimeInfo, tt.mimeInfoExpected) != 0 {
+				t.Errorf("MimeInfo got \"%v\", want \"%v\"", attachmentEntry.MimeInfo, tt.mimeInfoExpected)
+			}
+
+			if strings.Compare(attachmentEntry.toDataForSignal(), tt.toDataForSignal) != 0 {
+				t.Errorf("toDataForSignal() got \"%v\", want \"%v\"", attachmentEntry.toDataForSignal(), tt.toDataForSignal)
+			}
+
+			err := attachmentEntry.storeBase64AsTemporaryFile()
+			if err != nil && tt.base64Valid {
+				t.Error("storeBase64AsTemporaryFile error: %w", err)
+				return
+			}
+
+			info, err := os.Stat(attachmentEntry.FilePath)
+			if os.IsNotExist(err) && tt.base64Valid {
+				t.Error("file not exists after storeBase64AsTemporaryFile: %w", err)
+				return
+			}
+			if (info == nil || info.IsDir()) && tt.base64Valid {
+				t.Error("is not a file by path after storeBase64AsTemporaryFile")
+				t.Error(attachmentEntry)
+				return
+			}
+
+			attachmentEntry.cleanUp()
+
+			info, err = os.Stat(attachmentEntry.FilePath)
+			if info != nil && !os.IsNotExist(err) && tt.base64Valid {
+				t.Error("no info or file exists after cleanUp")
+				return
+			}
+			info, err = os.Stat(*attachmentTmp + attachmentEntry.DirName)
+			if info != nil && !os.IsNotExist(err) && tt.base64Valid {
+				t.Error("dir exists after cleanUp")
+				return
+			}
+		})
+	}
+}