file.go 18.1 KB
Newer Older
1
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
2 3 4 5 6 7 8 9 10
// See License.txt for license information.

package app

import (
	"bytes"
	"crypto/sha256"
	"encoding/base64"
	"fmt"
11 12 13
	"image"
	"image/color"
	"image/draw"
14
	_ "image/gif"
15
	"image/jpeg"
16
	"io"
17
	"mime/multipart"
18
	"net/http"
19 20 21 22
	"net/url"
	"path/filepath"
	"strings"
	"sync"
23
	"time"
24

25
	"github.com/disintegration/imaging"
26 27
	"github.com/rwcarlsen/goexif/exif"
	_ "golang.org/x/image/bmp"
28

29
	"github.com/mattermost/mattermost-server/mlog"
Christopher Speller's avatar
Christopher Speller committed
30 31
	"github.com/mattermost/mattermost-server/model"
	"github.com/mattermost/mattermost-server/utils"
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
)

const (
	/*
	  EXIF Image Orientations
	  1        2       3      4         5            6           7          8

	  888888  888888      88  88      8888888888  88                  88  8888888888
	  88          88      88  88      88  88      88  88          88  88      88  88
	  8888      8888    8888  8888    88          8888888888  8888888888          88
	  88          88      88  88
	  88          88  888888  888888
	*/
	Upright            = 1
	UprightMirrored    = 2
	UpsideDown         = 3
	UpsideDownMirrored = 4
	RotatedCWMirrored  = 5
	RotatedCCW         = 6
	RotatedCCWMirrored = 7
	RotatedCW          = 8

54 55
	MaxImageSize                 = 6048 * 4032 // 24 megapixels, roughly 36MB as a raw image
	IMAGE_THUMBNAIL_PIXEL_WIDTH  = 120
56
	IMAGE_THUMBNAIL_PIXEL_HEIGHT = 100
57
	IMAGE_PREVIEW_PIXEL_WIDTH    = 1024
58 59
)

60
func (a *App) FileBackend() (utils.FileBackend, *model.AppError) {
61 62
	license := a.License()
	return utils.NewFileBackend(&a.Config().FileSettings, license != nil && *license.Features.Compliance)
63 64 65 66 67 68 69 70 71 72
}

func (a *App) ReadFile(path string) ([]byte, *model.AppError) {
	backend, err := a.FileBackend()
	if err != nil {
		return nil, err
	}
	return backend.ReadFile(path)
}

73 74 75 76 77 78 79 80
func (a *App) FileExists(path string) (bool, *model.AppError) {
	backend, err := a.FileBackend()
	if err != nil {
		return false, err
	}
	return backend.FileExists(path)
}

81 82 83 84 85 86 87 88
func (a *App) MoveFile(oldPath, newPath string) *model.AppError {
	backend, err := a.FileBackend()
	if err != nil {
		return err
	}
	return backend.MoveFile(oldPath, newPath)
}

89
func (a *App) WriteFile(fr io.Reader, path string) (int64, *model.AppError) {
90 91
	backend, err := a.FileBackend()
	if err != nil {
92
		return 0, err
93
	}
94 95

	return backend.WriteFile(fr, path)
96 97 98 99 100 101 102 103 104 105 106
}

func (a *App) RemoveFile(path string) *model.AppError {
	backend, err := a.FileBackend()
	if err != nil {
		return err
	}
	return backend.RemoveFile(path)
}

func (a *App) GetInfoForFilename(post *model.Post, teamId string, filename string) *model.FileInfo {
107 108 109
	// Find the path from the Filename of the form /{channelId}/{userId}/{uid}/{nameWithExtension}
	split := strings.SplitN(filename, "/", 5)
	if len(split) < 5 {
110
		mlog.Error("Unable to decipher filename when migrating post to use FileInfos", mlog.String("post_id", post.Id), mlog.String("filename", filename))
111 112 113 114 115 116 117 118 119
		return nil
	}

	channelId := split[1]
	userId := split[2]
	oldId := split[3]
	name, _ := url.QueryUnescape(split[4])

	if split[0] != "" || split[1] != post.ChannelId || split[2] != post.UserId || strings.Contains(split[4], "/") {
120 121 122 123 124 125 126
		mlog.Warn(
			"Found an unusual filename when migrating post to use FileInfos",
			mlog.String("post_id", post.Id),
			mlog.String("channel_id", post.ChannelId),
			mlog.String("user_id", post.UserId),
			mlog.String("filename", filename),
		)
127 128 129 130 131 132 133
	}

	pathPrefix := fmt.Sprintf("teams/%s/channels/%s/users/%s/%s/", teamId, channelId, userId, oldId)
	path := pathPrefix + name

	// Open the file and populate the fields of the FileInfo
	var info *model.FileInfo
134
	if data, err := a.ReadFile(path); err != nil {
135 136 137 138 139 140
		mlog.Error(
			fmt.Sprintf("File not found when migrating post to use FileInfos, err=%v", err),
			mlog.String("post_id", post.Id),
			mlog.String("filename", filename),
			mlog.String("path", path),
		)
141 142 143 144 145
		return nil
	} else {
		var err *model.AppError
		info, err = model.GetInfoForBytes(name, data)
		if err != nil {
146 147 148 149 150
			mlog.Warn(
				fmt.Sprintf("Unable to fully decode file info when migrating post to use FileInfos, err=%v", err),
				mlog.String("post_id", post.Id),
				mlog.String("filename", filename),
			)
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
		}
	}

	// Generate a new ID because with the old system, you could very rarely get multiple posts referencing the same file
	info.Id = model.NewId()
	info.CreatorId = post.UserId
	info.PostId = post.Id
	info.CreateAt = post.CreateAt
	info.UpdateAt = post.UpdateAt
	info.Path = path

	if info.IsImage() {
		nameWithoutExtension := name[:strings.LastIndex(name, ".")]
		info.PreviewPath = pathPrefix + nameWithoutExtension + "_preview.jpg"
		info.ThumbnailPath = pathPrefix + nameWithoutExtension + "_thumb.jpg"
	}

	return info
}

Chris's avatar
Chris committed
171
func (a *App) FindTeamIdForFilename(post *model.Post, filename string) string {
172 173 174 175 176
	split := strings.SplitN(filename, "/", 5)
	id := split[3]
	name, _ := url.QueryUnescape(split[4])

	// This post is in a direct channel so we need to figure out what team the files are stored under.
Chris's avatar
Chris committed
177
	if result := <-a.Srv.Store.Team().GetTeamsByUserId(post.UserId); result.Err != nil {
178
		mlog.Error(fmt.Sprintf("Unable to get teams when migrating post to use FileInfo, err=%v", result.Err), mlog.String("post_id", post.Id))
179 180 181 182 183 184
	} else if teams := result.Data.([]*model.Team); len(teams) == 1 {
		// The user has only one team so the post must've been sent from it
		return teams[0].Id
	} else {
		for _, team := range teams {
			path := fmt.Sprintf("teams/%s/channels/%s/users/%s/%s/%s", team.Id, post.ChannelId, post.UserId, id, name)
185
			if _, err := a.ReadFile(path); err == nil {
186 187 188 189 190 191 192 193 194 195 196 197
				// Found the team that this file was posted from
				return team.Id
			}
		}
	}

	return ""
}

var fileMigrationLock sync.Mutex

// Creates and stores FileInfos for a post created before the FileInfos table existed.
Chris's avatar
Chris committed
198
func (a *App) MigrateFilenamesToFileInfos(post *model.Post) []*model.FileInfo {
199
	if len(post.Filenames) == 0 {
200
		mlog.Warn("Unable to migrate post to use FileInfos with an empty Filenames field", mlog.String("post_id", post.Id))
201 202 203
		return []*model.FileInfo{}
	}

Chris's avatar
Chris committed
204
	cchan := a.Srv.Store.Channel().Get(post.ChannelId, true)
205 206 207 208 209 210

	// There's a weird bug that rarely happens where a post ends up with duplicate Filenames so remove those
	filenames := utils.RemoveDuplicatesFromStringArray(post.Filenames)

	var channel *model.Channel
	if result := <-cchan; result.Err != nil {
211 212 213 214 215
		mlog.Error(
			fmt.Sprintf("Unable to get channel when migrating post to use FileInfos, err=%v", result.Err),
			mlog.String("post_id", post.Id),
			mlog.String("channel_id", post.ChannelId),
		)
216 217 218 219 220 221 222 223 224
		return []*model.FileInfo{}
	} else {
		channel = result.Data.(*model.Channel)
	}

	// Find the team that was used to make this post since its part of the file path that isn't saved in the Filename
	var teamId string
	if channel.TeamId == "" {
		// This post was made in a cross-team DM channel so we need to find where its files were saved
Chris's avatar
Chris committed
225
		teamId = a.FindTeamIdForFilename(post, filenames[0])
226 227 228 229 230 231 232
	} else {
		teamId = channel.TeamId
	}

	// Create FileInfo objects for this post
	infos := make([]*model.FileInfo, 0, len(filenames))
	if teamId == "" {
233 234 235 236
		mlog.Error(
			fmt.Sprintf("Unable to find team id for files when migrating post to use FileInfos, filenames=%v", filenames),
			mlog.String("post_id", post.Id),
		)
237 238
	} else {
		for _, filename := range filenames {
239
			info := a.GetInfoForFilename(post, teamId, filename)
240 241 242 243 244 245 246 247 248 249 250 251
			if info == nil {
				continue
			}

			infos = append(infos, info)
		}
	}

	// Lock to prevent only one migration thread from trying to update the post at once, preventing duplicate FileInfos from being created
	fileMigrationLock.Lock()
	defer fileMigrationLock.Unlock()

Chris's avatar
Chris committed
252
	if result := <-a.Srv.Store.Post().Get(post.Id); result.Err != nil {
253
		mlog.Error(fmt.Sprintf("Unable to get post when migrating post to use FileInfos, err=%v", result.Err), mlog.String("post_id", post.Id))
254 255 256
		return []*model.FileInfo{}
	} else if newPost := result.Data.(*model.PostList).Posts[post.Id]; len(newPost.Filenames) != len(post.Filenames) {
		// Another thread has already created FileInfos for this post, so just return those
Chris's avatar
Chris committed
257
		if result := <-a.Srv.Store.FileInfo().GetForPost(post.Id, true, false); result.Err != nil {
258
			mlog.Error(fmt.Sprintf("Unable to get FileInfos for migrated post, err=%v", result.Err), mlog.String("post_id", post.Id))
259 260
			return []*model.FileInfo{}
		} else {
261
			mlog.Debug("Post already migrated to use FileInfos", mlog.String("post_id", post.Id))
262 263 264 265
			return result.Data.([]*model.FileInfo)
		}
	}

266
	mlog.Debug("Migrating post to use FileInfos", mlog.String("post_id", post.Id))
267 268 269 270

	savedInfos := make([]*model.FileInfo, 0, len(infos))
	fileIds := make([]string, 0, len(filenames))
	for _, info := range infos {
Chris's avatar
Chris committed
271
		if result := <-a.Srv.Store.FileInfo().Save(info); result.Err != nil {
272 273 274 275 276 277
			mlog.Error(
				fmt.Sprintf("Unable to save file info when migrating post to use FileInfos, err=%v", result.Err),
				mlog.String("post_id", post.Id),
				mlog.String("file_info_id", info.Id),
				mlog.String("file_info_path", info.Path),
			)
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
			continue
		}

		savedInfos = append(savedInfos, info)
		fileIds = append(fileIds, info.Id)
	}

	// Copy and save the updated post
	newPost := &model.Post{}
	*newPost = *post

	newPost.Filenames = []string{}
	newPost.FileIds = fileIds

	// Update Posts to clear Filenames and set FileIds
Chris's avatar
Chris committed
293
	if result := <-a.Srv.Store.Post().Update(newPost, post); result.Err != nil {
294
		mlog.Error(fmt.Sprintf("Unable to save migrated post when migrating to use FileInfos, new_file_ids=%v, old_filenames=%v, err=%v", newPost.FileIds, post.Filenames, result.Err), mlog.String("post_id", post.Id))
295 296 297 298 299 300
		return []*model.FileInfo{}
	} else {
		return savedInfos
	}
}

Chris's avatar
Chris committed
301 302
func (a *App) GeneratePublicLink(siteURL string, info *model.FileInfo) string {
	hash := GeneratePublicLinkHash(info.Id, *a.Config().FileSettings.PublicLinkSalt)
303 304 305
	return fmt.Sprintf("%s/files/%v/public?h=%s", siteURL, info.Id, hash)
}

306 307 308 309 310 311 312
func GeneratePublicLinkHash(fileId, salt string) string {
	hash := sha256.New()
	hash.Write([]byte(salt))
	hash.Write([]byte(fileId))

	return base64.RawURLEncoding.EncodeToString(hash.Sum(nil))
}
313

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
func (a *App) UploadMultipartFiles(teamId string, channelId string, userId string, fileHeaders []*multipart.FileHeader, clientIds []string) (*model.FileUploadResponse, *model.AppError) {
	files := make([]io.ReadCloser, len(fileHeaders))
	filenames := make([]string, len(fileHeaders))

	for i, fileHeader := range fileHeaders {
		file, fileErr := fileHeader.Open()
		if fileErr != nil {
			return nil, model.NewAppError("UploadFiles", "api.file.upload_file.bad_parse.app_error", nil, fileErr.Error(), http.StatusBadRequest)
		}

		// Will be closed after UploadFiles returns
		defer file.Close()

		files[i] = file
		filenames[i] = fileHeader.Filename
	}

	return a.UploadFiles(teamId, channelId, userId, files, filenames, clientIds)
}

// Uploads some files to the given team and channel as the given user. files and filenames should have
// the same length. clientIds should either not be provided or have the same length as files and filenames.
// The provided files should be closed by the caller so that they are not leaked.
func (a *App) UploadFiles(teamId string, channelId string, userId string, files []io.ReadCloser, filenames []string, clientIds []string) (*model.FileUploadResponse, *model.AppError) {
Chris's avatar
Chris committed
338
	if len(*a.Config().FileSettings.DriverName) == 0 {
339 340 341
		return nil, model.NewAppError("uploadFile", "api.file.upload_file.storage.app_error", nil, "", http.StatusNotImplemented)
	}

342 343 344 345
	if len(filenames) != len(files) || (len(clientIds) > 0 && len(clientIds) != len(files)) {
		return nil, model.NewAppError("UploadFiles", "api.file.upload_file.incorrect_number_of_files.app_error", nil, "", http.StatusBadRequest)
	}

346 347 348 349 350 351 352 353 354
	resStruct := &model.FileUploadResponse{
		FileInfos: []*model.FileInfo{},
		ClientIds: []string{},
	}

	previewPathList := []string{}
	thumbnailPathList := []string{}
	imageDataList := [][]byte{}

355
	for i, file := range files {
356 357 358 359
		buf := bytes.NewBuffer(nil)
		io.Copy(buf, file)
		data := buf.Bytes()

360
		info, err := a.DoUploadFile(time.Now(), teamId, channelId, userId, filenames[i], data)
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
		if err != nil {
			return nil, err
		}

		if info.PreviewPath != "" || info.ThumbnailPath != "" {
			previewPathList = append(previewPathList, info.PreviewPath)
			thumbnailPathList = append(thumbnailPathList, info.ThumbnailPath)
			imageDataList = append(imageDataList, data)
		}

		resStruct.FileInfos = append(resStruct.FileInfos, info)

		if len(clientIds) > 0 {
			resStruct.ClientIds = append(resStruct.ClientIds, clientIds[i])
		}
	}

378
	a.HandleImages(previewPathList, thumbnailPathList, imageDataList)
379 380 381 382

	return resStruct, nil
}

383
func (a *App) DoUploadFile(now time.Time, rawTeamId string, rawChannelId string, rawUserId string, rawFilename string, data []byte) (*model.FileInfo, *model.AppError) {
384
	filename := filepath.Base(rawFilename)
385 386 387
	teamId := filepath.Base(rawTeamId)
	channelId := filepath.Base(rawChannelId)
	userId := filepath.Base(rawUserId)
388 389 390 391 392 393 394

	info, err := model.GetInfoForBytes(filename, data)
	if err != nil {
		err.StatusCode = http.StatusBadRequest
		return nil, err
	}

395 396 397 398 399 400 401 402
	if orientation, err := getImageOrientation(bytes.NewReader(data)); err == nil &&
		(orientation == RotatedCWMirrored ||
			orientation == RotatedCCW ||
			orientation == RotatedCCWMirrored ||
			orientation == RotatedCW) {
		info.Width, info.Height = info.Height, info.Width
	}

403 404 405
	info.Id = model.NewId()
	info.CreatorId = userId

406
	pathPrefix := now.Format("20060102") + "/teams/" + teamId + "/channels/" + channelId + "/users/" + userId + "/" + info.Id + "/"
407 408 409 410 411
	info.Path = pathPrefix + filename

	if info.IsImage() {
		// Check dimensions before loading the whole thing into memory later on
		if info.Width*info.Height > MaxImageSize {
412
			err := model.NewAppError("uploadFile", "api.file.upload_file.large_image.app_error", map[string]interface{}{"Filename": filename}, "", http.StatusBadRequest)
413 414 415 416 417 418 419 420
			return nil, err
		}

		nameWithoutExtension := filename[:strings.LastIndex(filename, ".")]
		info.PreviewPath = pathPrefix + nameWithoutExtension + "_preview.jpg"
		info.ThumbnailPath = pathPrefix + nameWithoutExtension + "_thumb.jpg"
	}

421
	if _, err := a.WriteFile(bytes.NewReader(data), info.Path); err != nil {
422 423 424
		return nil, err
	}

Chris's avatar
Chris committed
425
	if result := <-a.Srv.Store.FileInfo().Save(info); result.Err != nil {
426 427 428 429 430 431
		return nil, result.Err
	}

	return info, nil
}

432
func (a *App) HandleImages(previewPathList []string, thumbnailPathList []string, fileData [][]byte) {
433 434 435 436 437 438 439 440
	wg := new(sync.WaitGroup)

	for i := range fileData {
		img, width, height := prepareImage(fileData[i])
		if img != nil {
			wg.Add(2)
			go func(img *image.Image, path string, width int, height int) {
				defer wg.Done()
441
				a.generateThumbnailImage(*img, path, width, height)
442
			}(img, thumbnailPathList[i], width, height)
443 444 445

			go func(img *image.Image, path string, width int) {
				defer wg.Done()
446
				a.generatePreviewImage(*img, path, width)
447 448
			}(img, previewPathList[i], width)
		}
449
	}
450
	wg.Wait()
451 452 453 454 455 456
}

func prepareImage(fileData []byte) (*image.Image, int, int) {
	// Decode image bytes into Image object
	img, imgType, err := image.Decode(bytes.NewReader(fileData))
	if err != nil {
457
		mlog.Error(fmt.Sprintf("Unable to decode image err=%v", err))
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
		return nil, 0, 0
	}

	width := img.Bounds().Dx()
	height := img.Bounds().Dy()

	// Fill in the background of a potentially-transparent png file as white
	if imgType == "png" {
		dst := image.NewRGBA(img.Bounds())
		draw.Draw(dst, dst.Bounds(), image.NewUniform(color.White), image.Point{}, draw.Src)
		draw.Draw(dst, dst.Bounds(), img, img.Bounds().Min, draw.Over)
		img = dst
	}

	// Flip the image to be upright
473 474
	orientation, _ := getImageOrientation(bytes.NewReader(fileData))
	img = makeImageUpright(img, orientation)
475

476 477 478 479
	return &img, width, height
}

func makeImageUpright(img image.Image, orientation int) image.Image {
480 481
	switch orientation {
	case UprightMirrored:
482
		return imaging.FlipH(img)
483
	case UpsideDown:
484
		return imaging.Rotate180(img)
485
	case UpsideDownMirrored:
486
		return imaging.FlipV(img)
487
	case RotatedCWMirrored:
488
		return imaging.Transpose(img)
489
	case RotatedCCW:
490
		return imaging.Rotate270(img)
491
	case RotatedCCWMirrored:
492
		return imaging.Transverse(img)
493
	case RotatedCW:
494 495 496
		return imaging.Rotate90(img)
	default:
		return img
497 498 499
	}
}

500 501
func getImageOrientation(input io.Reader) (int, error) {
	if exifData, err := exif.Decode(input); err != nil {
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
		return Upright, err
	} else {
		if tag, err := exifData.Get("Orientation"); err != nil {
			return Upright, err
		} else {
			orientation, err := tag.Int(0)
			if err != nil {
				return Upright, err
			} else {
				return orientation, nil
			}
		}
	}
}

517
func (a *App) generateThumbnailImage(img image.Image, thumbnailPath string, width int, height int) {
518 519 520 521 522
	thumbWidth := float64(IMAGE_THUMBNAIL_PIXEL_WIDTH)
	thumbHeight := float64(IMAGE_THUMBNAIL_PIXEL_HEIGHT)
	imgWidth := float64(width)
	imgHeight := float64(height)

523
	var thumbnail image.Image
524
	if imgHeight < IMAGE_THUMBNAIL_PIXEL_HEIGHT && imgWidth < thumbWidth {
525
		thumbnail = img
526 527
	} else if imgHeight/imgWidth < thumbHeight/thumbWidth {
		thumbnail = imaging.Resize(img, 0, IMAGE_THUMBNAIL_PIXEL_HEIGHT, imaging.Lanczos)
528
	} else {
529
		thumbnail = imaging.Resize(img, IMAGE_THUMBNAIL_PIXEL_WIDTH, 0, imaging.Lanczos)
530 531 532 533
	}

	buf := new(bytes.Buffer)
	if err := jpeg.Encode(buf, thumbnail, &jpeg.Options{Quality: 90}); err != nil {
534
		mlog.Error(fmt.Sprintf("Unable to encode image as jpeg path=%v err=%v", thumbnailPath, err))
535 536 537
		return
	}

538
	if _, err := a.WriteFile(buf, thumbnailPath); err != nil {
539
		mlog.Error(fmt.Sprintf("Unable to upload thumbnail path=%v err=%v", thumbnailPath, err))
540 541 542 543
		return
	}
}

544
func (a *App) generatePreviewImage(img image.Image, previewPath string, width int) {
545
	var preview image.Image
546 547 548

	if width > IMAGE_PREVIEW_PIXEL_WIDTH {
		preview = imaging.Resize(img, IMAGE_PREVIEW_PIXEL_WIDTH, 0, imaging.Lanczos)
549 550 551 552 553 554 555
	} else {
		preview = img
	}

	buf := new(bytes.Buffer)

	if err := jpeg.Encode(buf, preview, &jpeg.Options{Quality: 90}); err != nil {
556
		mlog.Error(fmt.Sprintf("Unable to encode image as preview jpg err=%v", err), mlog.String("path", previewPath))
557 558 559
		return
	}

560
	if _, err := a.WriteFile(buf, previewPath); err != nil {
561
		mlog.Error(fmt.Sprintf("Unable to upload preview err=%v", err), mlog.String("path", previewPath))
562 563 564
		return
	}
}
565

Chris's avatar
Chris committed
566 567
func (a *App) GetFileInfo(fileId string) (*model.FileInfo, *model.AppError) {
	if result := <-a.Srv.Store.FileInfo().Get(fileId); result.Err != nil {
568 569 570 571 572
		return nil, result.Err
	} else {
		return result.Data.(*model.FileInfo), nil
	}
}