Adding FileWillBeUploaded plugin hook (#9169)

* Adding file upload hook.

* Adding hook test for FileWillBeUploaded

* Some debugging fixes.

* Fix typo.

* Fixing double close

* Fix capitalization on docs.

app/file.go

@@ -28,6 +28,7 @@ import (
 
 	"github.com/mattermost/mattermost-server/mlog"
 	"github.com/mattermost/mattermost-server/model"
+	"github.com/mattermost/mattermost-server/plugin"
 	"github.com/mattermost/mattermost-server/utils"
 )
 
@@ -366,7 +367,7 @@ func (a *App) UploadFiles(teamId string, channelId string, userId string, files
 		io.Copy(buf, file)
 		data := buf.Bytes()
 
-		info, err := a.DoUploadFile(time.Now(), teamId, channelId, userId, filenames[i], data)
+		info, data, err := a.DoUploadFileExpectModification(time.Now(), teamId, channelId, userId, filenames[i], data)
 		if err != nil {
 			return nil, err
 		}
@@ -390,6 +391,11 @@ func (a *App) UploadFiles(teamId string, channelId string, userId string, files
 }
 
 func (a *App) DoUploadFile(now time.Time, rawTeamId string, rawChannelId string, rawUserId string, rawFilename string, data []byte) (*model.FileInfo, *model.AppError) {
+	info, _, err := a.DoUploadFileExpectModification(now, rawTeamId, rawChannelId, rawUserId, rawFilename, data)
+	return info, err
+}
+
+func (a *App) DoUploadFileExpectModification(now time.Time, rawTeamId string, rawChannelId string, rawUserId string, rawFilename string, data []byte) (*model.FileInfo, []byte, *model.AppError) {
 	filename := filepath.Base(rawFilename)
 	teamId := filepath.Base(rawTeamId)
 	channelId := filepath.Base(rawChannelId)
@@ -398,7 +404,7 @@ func (a *App) DoUploadFile(now time.Time, rawTeamId string, rawChannelId string,
 	info, err := model.GetInfoForBytes(filename, data)
 	if err != nil {
 		err.StatusCode = http.StatusBadRequest
-		return nil, err
+		return nil, data, err
 	}
 
 	if orientation, err := getImageOrientation(bytes.NewReader(data)); err == nil &&
@@ -419,7 +425,7 @@ func (a *App) DoUploadFile(now time.Time, rawTeamId string, rawChannelId string,
 		// Check dimensions before loading the whole thing into memory later on
 		if info.Width*info.Height > MaxImageSize {
 			err := model.NewAppError("uploadFile", "api.file.upload_file.large_image.app_error", map[string]interface{}{"Filename": filename}, "", http.StatusBadRequest)
-			return nil, err
+			return nil, data, err
 		}
 
 		nameWithoutExtension := filename[:strings.LastIndex(filename, ".")]
@@ -427,15 +433,33 @@ func (a *App) DoUploadFile(now time.Time, rawTeamId string, rawChannelId string,
 		info.ThumbnailPath = pathPrefix + nameWithoutExtension + "_thumb.jpg"
 	}
 
+	if a.PluginsReady() {
+		pluginContext := &plugin.Context{}
+		var rejectionReason string
+		a.Plugins.RunMultiPluginHook(func(hooks plugin.Hooks) bool {
+			var newBytes bytes.Buffer
+			info, rejectionReason = hooks.FileWillBeUploaded(pluginContext, info, bytes.NewReader(data), &newBytes)
+			rejected := info == nil
+			if !rejected && newBytes.Len() != 0 {
+				data = newBytes.Bytes()
+				info.Size = int64(len(data))
+			}
+			return !rejected
+		}, plugin.FileWillBeUploadedId)
+		if info == nil {
+			return nil, data, model.NewAppError("DoUploadFile", "File rejected by plugin. "+rejectionReason, nil, "", http.StatusBadRequest)
+		}
+	}
+
 	if _, err := a.WriteFile(bytes.NewReader(data), info.Path); err != nil {
-		return nil, err
+		return nil, data, err
 	}
 
 	if result := <-a.Srv.Store.FileInfo().Save(info); result.Err != nil {
-		return nil, result.Err
+		return nil, data, result.Err
 	}
 
-	return info, nil
+	return info, data, nil
 }
 
 func (a *App) HandleImages(previewPathList []string, thumbnailPathList []string, fileData [][]byte) {

app/plugin_api.go

@@ -45,9 +45,14 @@ func (api *PluginAPI) LoadPluginConfiguration(dest interface{}) error {
 	}
 
 	if pluginSettingsJsonBytes, err := json.Marshal(finalConfig); err != nil {
-		return err
+		api.logger.Error("Error marshaling config for plugin", mlog.Err(err))
+		return nil
 	} else {
-		return json.Unmarshal(pluginSettingsJsonBytes, dest)
+		err := json.Unmarshal(pluginSettingsJsonBytes, dest)
+		if err != nil {
+			api.logger.Error("Error unmarshaling config for plugin", mlog.Err(err))
+		}
+		return nil
 	}
 }
 

app/plugin_hooks_test.go

@@ -4,6 +4,8 @@
 package app
 
 import (
+	"bytes"
+	"io"
 	"io/ioutil"
 	"os"
 	"os/exec"
@@ -302,3 +304,69 @@ func TestHookMessageHasBeenUpdated(t *testing.T) {
 		t.Fatal(err)
 	}
 }
+
+func TestHookFileWillBeUploaded(t *testing.T) {
+	th := Setup().InitBasic()
+	defer th.TearDown()
+
+	var mockAPI plugintest.API
+	mockAPI.On("LoadPluginConfiguration", mock.Anything).Return(nil)
+	mockAPI.On("DeleteUser", "testhook.txt").Return(nil)
+	mockAPI.On("DeleteTeam", "inputfile").Return(nil)
+	SetAppEnvironmentWithPlugins(t,
+		[]string{
+			`
+		package main
+
+		import (
+			"io"
+			"bytes"
+			"github.com/mattermost/mattermost-server/plugin"
+			"github.com/mattermost/mattermost-server/model"
+		)
+
+		type MyPlugin struct {
+			plugin.MattermostPlugin
+		}
+
+		func (p *MyPlugin) FileWillBeUploaded(c *plugin.Context, info *model.FileInfo, file io.Reader, output io.Writer) (*model.FileInfo, string) {
+			p.API.DeleteUser(info.Name)
+			var buf bytes.Buffer
+			buf.ReadFrom(file)
+			p.API.DeleteTeam(buf.String())
+
+			outbuf := bytes.NewBufferString("changedtext")
+			io.Copy(output, outbuf)
+			info.Name = "modifiedinfo"
+			return info, ""
+		}
+
+		func main() {
+			plugin.ClientMain(&MyPlugin{})
+		}
+	`}, th.App, func(*model.Manifest) plugin.API { return &mockAPI })
+
+	response, err := th.App.UploadFiles(
+		"noteam",
+		th.BasicChannel.Id,
+		th.BasicUser.Id,
+		[]io.ReadCloser{ioutil.NopCloser(bytes.NewBufferString("inputfile"))},
+		[]string{"testhook.txt"},
+		[]string{},
+	)
+	assert.Nil(t, err)
+	assert.NotNil(t, response)
+	assert.Equal(t, 1, len(response.FileInfos))
+	fileId := response.FileInfos[0].Id
+
+	fileInfo, err := th.App.GetFileInfo(fileId)
+	assert.Nil(t, err)
+	assert.NotNil(t, fileInfo)
+	assert.Equal(t, "modifiedinfo", fileInfo.Name)
+
+	fileReader, err := th.App.FileReader(fileInfo.Path)
+	assert.Nil(t, err)
+	var resultBuf bytes.Buffer
+	io.Copy(&resultBuf, fileReader)
+	assert.Equal(t, "changedtext", resultBuf.String())
+}