photoprism/internal/api/zip.go

package api

import (
	"archive/zip"
	"fmt"
	"io"
	"net/http"
	"os"
	"path"
	"path/filepath"
	"strings"
	"time"

	"github.com/gin-gonic/gin"

	"github.com/photoprism/photoprism/internal/acl"
	"github.com/photoprism/photoprism/internal/form"
	"github.com/photoprism/photoprism/internal/get"
	"github.com/photoprism/photoprism/internal/i18n"
	"github.com/photoprism/photoprism/internal/photoprism"
	"github.com/photoprism/photoprism/internal/query"
	"github.com/photoprism/photoprism/pkg/clean"
	"github.com/photoprism/photoprism/pkg/fs"
	"github.com/photoprism/photoprism/pkg/rnd"
)

// ZipCreate creates a zip file archive for download.
//
// POST /api/v1/zip
func ZipCreate(router *gin.RouterGroup) {
	router.POST("/zip", func(c *gin.Context) {
		s := Auth(c, acl.ResourcePhotos, acl.ActionDownload)

		if s.Abort(c) {
			return
		}

		conf := get.Config()

		if !conf.Settings().Features.Download {
			AbortFeatureDisabled(c)
			return
		}

		var f form.Selection
		start := time.Now()

		if err := c.BindJSON(&f); err != nil {
			AbortBadRequest(c)
			return
		}

		if f.Empty() {
			Abort(c, http.StatusBadRequest, i18n.ErrNoItemsSelected)
			return
		}

		// Configure file selection based on user settings.
		var selection query.FileSelection
		if dl := conf.Settings().Download; dl.Disabled {
			AbortFeatureDisabled(c)
			return
		} else {
			selection = query.DownloadSelection(dl.MediaRaw, dl.MediaSidecar, dl.Originals)
		}

		// Find files to download.
		files, err := query.SelectedFiles(f, selection)

		if err != nil {
			Error(c, http.StatusBadRequest, err, i18n.ErrZipFailed)
			return
		} else if len(files) == 0 {
			Abort(c, http.StatusNotFound, i18n.ErrNoFilesForDownload)
			return
		}

		// Configure file names.
		dlName := DownloadName(c)
		zipPath := path.Join(conf.TempPath(), "zip")
		zipToken := rnd.GenerateToken(8)
		zipBaseName := fmt.Sprintf("photoprism-download-%s-%s.zip", time.Now().Format("20060102-150405"), zipToken)
		zipFileName := path.Join(zipPath, zipBaseName)

		// Create temp directory.
		if err = os.MkdirAll(zipPath, 0700); err != nil {
			Error(c, http.StatusInternalServerError, err, i18n.ErrZipFailed)
			return
		}

		// Create new zip file.
		var newZipFile *os.File
		if newZipFile, err = os.Create(zipFileName); err != nil {
			Error(c, http.StatusInternalServerError, err, i18n.ErrZipFailed)
			return
		} else {
			defer newZipFile.Close()
		}

		// Create zip writer.
		zipWriter := zip.NewWriter(newZipFile)
		defer func(w *zip.Writer) {
			logError("zip", w.Close())
		}(zipWriter)

		var aliases = make(map[string]int)

		// Add files to zip.
		for _, file := range files {
			fileName := photoprism.FileName(file.FileRoot, file.FileName)
			alias := file.DownloadName(dlName, 0)
			key := strings.ToLower(alias)

			if seq := aliases[key]; seq > 0 {
				alias = file.DownloadName(dlName, seq)
			}

			aliases[key] += 1

			if fs.FileExists(fileName) {
				if err := addFileToZip(zipWriter, fileName, alias); err != nil {
					log.Errorf("zip: failed adding %s to zip (%s)", clean.Log(file.FileName), err)
					Abort(c, http.StatusInternalServerError, i18n.ErrZipFailed)
					return
				}

				log.Infof("zip: added %s as %s", clean.Log(file.FileName), clean.Log(alias))
			} else {
				log.Warnf("zip: media file %s is missing", clean.Log(file.FileName))
				logError("zip", file.Update("FileMissing", true))
			}
		}

		elapsed := int(time.Since(start).Seconds())

		log.Infof("zip: created %s [%s]", clean.Log(zipBaseName), time.Since(start))

		c.JSON(http.StatusOK, gin.H{"code": http.StatusOK, "message": i18n.Msg(i18n.MsgZipCreatedIn, elapsed), "filename": zipBaseName})
	})
}

// ZipDownload downloads a zip file archive.
//
// GET /api/v1/zip/:filename
func ZipDownload(router *gin.RouterGroup) {
	router.GET("/zip/:filename", func(c *gin.Context) {
		if InvalidDownloadToken(c) {
			log.Errorf("zip: %s", c.AbortWithError(http.StatusForbidden, fmt.Errorf("invalid download token")))
			return
		}

		conf := get.Config()
		zipBaseName := clean.FileName(filepath.Base(c.Param("filename")))
		zipPath := path.Join(conf.TempPath(), "zip")
		zipFileName := path.Join(zipPath, zipBaseName)

		if !fs.FileExists(zipFileName) {
			log.Errorf("zip: %s", c.AbortWithError(http.StatusNotFound, fmt.Errorf("%s not found", clean.Log(zipFileName))))
			return
		}

		defer func(fileName, baseName string) {
			log.Debugf("zip: %s has been downloaded", clean.Log(baseName))

			// Wait a moment before deleting the zip file, just to be sure:
			// https://github.com/photoprism/photoprism/issues/2532
			time.Sleep(time.Second)

			// Remove the zip file to free up disk space.
			if err := os.Remove(fileName); err != nil {
				log.Warnf("zip: failed deleting %s (%s)", clean.Log(fileName), err)
			} else {
				log.Debugf("zip: deleted %s", clean.Log(baseName))
			}
		}(zipFileName, zipBaseName)

		log.Debugf("zip: submitting %s", clean.Log(zipBaseName))

		c.FileAttachment(zipFileName, zipBaseName)
	})
}

// addFileToZip adds a file to a zip archive.
func addFileToZip(zipWriter *zip.Writer, fileName, fileAlias string) error {
	fileToZip, err := os.Open(fileName)
	if err != nil {
		return err
	}
	defer fileToZip.Close()

	// Get the file information
	info, err := fileToZip.Stat()
	if err != nil {
		return err
	}

	header, err := zip.FileInfoHeader(info)
	if err != nil {
		return err
	}

	header.Name = fileAlias

	// Change to deflate to gain better compression
	// see http://golang.org/pkg/archive/zip/#pkg-constants
	header.Method = zip.Deflate

	writer, err := zipWriter.CreateHeader(header)
	if err != nil {
		return err
	}
	_, err = io.Copy(writer, fileToZip)
	return err
}