file.go 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916
  1. package controller
  2. import (
  3. "context"
  4. "database/sql"
  5. "encoding/json"
  6. "errors"
  7. "fmt"
  8. "runtime/debug"
  9. "strconv"
  10. "strings"
  11. "github.com/ente-io/museum/pkg/controller/email"
  12. "github.com/ente-io/museum/pkg/controller/lock"
  13. "github.com/ente-io/museum/pkg/utils/auth"
  14. "github.com/ente-io/museum/pkg/utils/file"
  15. "github.com/ente-io/stacktrace"
  16. "github.com/gin-contrib/requestid"
  17. "github.com/gin-gonic/gin"
  18. "github.com/google/uuid"
  19. "github.com/aws/aws-sdk-go/service/s3"
  20. "github.com/ente-io/museum/ente"
  21. "github.com/ente-io/museum/pkg/repo"
  22. enteArray "github.com/ente-io/museum/pkg/utils/array"
  23. "github.com/ente-io/museum/pkg/utils/s3config"
  24. "github.com/ente-io/museum/pkg/utils/time"
  25. log "github.com/sirupsen/logrus"
  26. )
  27. // FileController exposes functions to retrieve and access encrypted files
  28. type FileController struct {
  29. FileRepo *repo.FileRepository
  30. ObjectRepo *repo.ObjectRepository
  31. ObjectCleanupRepo *repo.ObjectCleanupRepository
  32. TrashRepository *repo.TrashRepository
  33. UserRepo *repo.UserRepository
  34. UsageCtrl *UsageController
  35. CollectionRepo *repo.CollectionRepository
  36. TaskLockingRepo *repo.TaskLockRepository
  37. QueueRepo *repo.QueueRepository
  38. S3Config *s3config.S3Config
  39. ObjectCleanupCtrl *ObjectCleanupController
  40. LockController *lock.LockController
  41. EmailNotificationCtrl *email.EmailNotificationController
  42. HostName string
  43. cleanupCronRunning bool
  44. }
  45. // StorageOverflowAboveSubscriptionLimit is the amount (50 MB) by which user can go beyond their storage limit
  46. const StorageOverflowAboveSubscriptionLimit = int64(1024 * 1024 * 50)
  47. // MaxFileSize is the maximum file size a user can upload
  48. const MaxFileSize = int64(1024 * 1024 * 1024 * 5)
  49. // MaxUploadURLsLimit indicates the max number of upload urls which can be request in one go
  50. const MaxUploadURLsLimit = 50
  51. const (
  52. DeletedObjectQueueLock = "deleted_objects_queue_lock"
  53. )
  54. func (c *FileController) validateFileCreateOrUpdateReq(userID int64, file ente.File) error {
  55. objectPathPrefix := strconv.FormatInt(userID, 10) + "/"
  56. if !strings.HasPrefix(file.File.ObjectKey, objectPathPrefix) || !strings.HasPrefix(file.Thumbnail.ObjectKey, objectPathPrefix) {
  57. return stacktrace.Propagate(ente.ErrBadRequest, "Incorrect object key reported")
  58. }
  59. isCreateFileReq := file.ID == 0
  60. // Check for attributes for fileCreation. We don't send key details on update
  61. if isCreateFileReq {
  62. if file.EncryptedKey == "" || file.KeyDecryptionNonce == "" {
  63. return stacktrace.Propagate(ente.ErrBadRequest, "EncryptedKey and KeyDecryptionNonce are required")
  64. }
  65. }
  66. if file.File.DecryptionHeader == "" || file.Thumbnail.DecryptionHeader == "" {
  67. return stacktrace.Propagate(ente.ErrBadRequest, "DecryptionHeader for file & thumb is required")
  68. }
  69. if file.UpdationTime == 0 {
  70. return stacktrace.Propagate(ente.ErrBadRequest, "UpdationTime is required")
  71. }
  72. if isCreateFileReq {
  73. collection, err := c.CollectionRepo.Get(file.CollectionID)
  74. if err != nil {
  75. return stacktrace.Propagate(err, "")
  76. }
  77. // Verify that user owns the collection.
  78. // Warning: Do not remove this check
  79. if collection.Owner.ID != userID {
  80. return stacktrace.Propagate(ente.ErrPermissionDenied, "collection doesn't belong to user")
  81. }
  82. if collection.IsDeleted {
  83. return stacktrace.Propagate(ente.ErrNotFound, "collection has been deleted")
  84. }
  85. }
  86. if file.OwnerID != userID {
  87. return stacktrace.Propagate(ente.ErrPermissionDenied, "file ownerID doesn't match with userID")
  88. }
  89. return nil
  90. }
  91. // Create adds an entry for a file in the respective tables
  92. func (c *FileController) Create(ctx context.Context, userID int64, file ente.File, userAgent string, app ente.App) (ente.File, error) {
  93. err := c.validateFileCreateOrUpdateReq(userID, file)
  94. if err != nil {
  95. return file, stacktrace.Propagate(err, "")
  96. }
  97. hotDC := c.S3Config.GetHotDataCenter()
  98. // sizeOf will do also HEAD check to ensure that the object exists in the
  99. // current hot DC
  100. fileSize, err := c.sizeOf(file.File.ObjectKey)
  101. if err != nil {
  102. log.Error("Could not find size of file: " + file.File.ObjectKey)
  103. return file, stacktrace.Propagate(err, "")
  104. }
  105. if fileSize > MaxFileSize {
  106. return file, stacktrace.Propagate(ente.ErrFileTooLarge, "")
  107. }
  108. if file.File.Size != 0 && file.File.Size != fileSize {
  109. return file, stacktrace.Propagate(ente.ErrBadRequest, "mismatch in file size")
  110. }
  111. file.File.Size = fileSize
  112. thumbnailSize, err := c.sizeOf(file.Thumbnail.ObjectKey)
  113. if err != nil {
  114. log.Error("Could not find size of thumbnail: " + file.Thumbnail.ObjectKey)
  115. return file, stacktrace.Propagate(err, "")
  116. }
  117. if file.Thumbnail.Size != 0 && file.Thumbnail.Size != thumbnailSize {
  118. return file, stacktrace.Propagate(ente.ErrBadRequest, "mismatch in thumbnail size")
  119. }
  120. file.Thumbnail.Size = thumbnailSize
  121. var totalUploadSize = fileSize + thumbnailSize
  122. err = c.UsageCtrl.CanUploadFile(ctx, userID, &totalUploadSize, app)
  123. if err != nil {
  124. return file, stacktrace.Propagate(err, "")
  125. }
  126. file.Info = &ente.FileInfo{
  127. FileSize: fileSize,
  128. ThumbnailSize: thumbnailSize,
  129. }
  130. // all iz well
  131. var usage int64
  132. file, usage, err = c.FileRepo.Create(file, fileSize, thumbnailSize, fileSize+thumbnailSize, userID, app)
  133. if err != nil {
  134. if err == ente.ErrDuplicateFileObjectFound || err == ente.ErrDuplicateThumbnailObjectFound {
  135. var existing ente.File
  136. if err == ente.ErrDuplicateFileObjectFound {
  137. existing, err = c.FileRepo.GetFileAttributesFromObjectKey(file.File.ObjectKey)
  138. } else {
  139. existing, err = c.FileRepo.GetFileAttributesFromObjectKey(file.Thumbnail.ObjectKey)
  140. }
  141. if err != nil {
  142. return file, stacktrace.Propagate(err, "")
  143. }
  144. file, err = c.onDuplicateObjectDetected(file, existing, hotDC)
  145. if err != nil {
  146. return file, stacktrace.Propagate(err, "")
  147. }
  148. return file, nil
  149. }
  150. return file, stacktrace.Propagate(err, "")
  151. }
  152. if usage == fileSize+thumbnailSize {
  153. go c.EmailNotificationCtrl.OnFirstFileUpload(file.OwnerID, userAgent)
  154. }
  155. return file, nil
  156. }
  157. // Update verifies permissions and updates the specified file
  158. func (c *FileController) Update(ctx context.Context, userID int64, file ente.File, app ente.App) (ente.UpdateFileResponse, error) {
  159. var response ente.UpdateFileResponse
  160. err := c.validateFileCreateOrUpdateReq(userID, file)
  161. if err != nil {
  162. return response, stacktrace.Propagate(err, "")
  163. }
  164. ownerID, err := c.FileRepo.GetOwnerID(file.ID)
  165. if err != nil {
  166. return response, stacktrace.Propagate(err, "")
  167. }
  168. // verify that user owns the file
  169. if ownerID != userID {
  170. return response, stacktrace.Propagate(ente.ErrPermissionDenied, "")
  171. }
  172. file.OwnerID = ownerID
  173. existingFileObject, err := c.ObjectRepo.GetObject(file.ID, ente.FILE)
  174. if err != nil {
  175. return response, stacktrace.Propagate(err, "")
  176. }
  177. existingFileObjectKey := existingFileObject.ObjectKey
  178. oldFileSize := existingFileObject.FileSize
  179. existingThumbnailObject, err := c.ObjectRepo.GetObject(file.ID, ente.THUMBNAIL)
  180. if err != nil {
  181. return response, stacktrace.Propagate(err, "")
  182. }
  183. existingThumbnailObjectKey := existingThumbnailObject.ObjectKey
  184. oldThumbnailSize := existingThumbnailObject.FileSize
  185. fileSize, err := c.sizeOf(file.File.ObjectKey)
  186. if err != nil {
  187. return response, stacktrace.Propagate(err, "")
  188. }
  189. if fileSize > MaxFileSize {
  190. return response, stacktrace.Propagate(ente.ErrFileTooLarge, "")
  191. }
  192. if file.File.Size != 0 && file.File.Size != fileSize {
  193. return response, stacktrace.Propagate(ente.ErrBadRequest, "mismatch in file size")
  194. }
  195. thumbnailSize, err := c.sizeOf(file.Thumbnail.ObjectKey)
  196. if err != nil {
  197. return response, stacktrace.Propagate(err, "")
  198. }
  199. if file.Thumbnail.Size != 0 && file.Thumbnail.Size != thumbnailSize {
  200. return response, stacktrace.Propagate(ente.ErrBadRequest, "mismatch in thumbnail size")
  201. }
  202. diff := (fileSize + thumbnailSize) - (oldFileSize + oldThumbnailSize)
  203. err = c.UsageCtrl.CanUploadFile(ctx, userID, &diff, app)
  204. if err != nil {
  205. return response, stacktrace.Propagate(err, "")
  206. }
  207. // The client might retry updating the same file accidentally.
  208. //
  209. // This usually happens on iOS, where the first request to update a file
  210. // might succeed, but the client might go into the background before it gets
  211. // to know of it, and then retries again.
  212. //
  213. // As a safety check, also compare the file sizes.
  214. isDuplicateRequest := false
  215. if existingThumbnailObjectKey == file.Thumbnail.ObjectKey &&
  216. existingFileObjectKey == file.File.ObjectKey &&
  217. diff == 0 {
  218. isDuplicateRequest = true
  219. }
  220. oldObjects := make([]string, 0)
  221. if existingThumbnailObjectKey != file.Thumbnail.ObjectKey {
  222. // Ignore accidental retrials
  223. oldObjects = append(oldObjects, existingThumbnailObjectKey)
  224. }
  225. if existingFileObjectKey != file.File.ObjectKey {
  226. // Ignore accidental retrials
  227. oldObjects = append(oldObjects, existingFileObjectKey)
  228. }
  229. if file.Info != nil {
  230. file.Info.FileSize = fileSize
  231. file.Info.ThumbnailSize = thumbnailSize
  232. } else {
  233. file.Info = &ente.FileInfo{
  234. FileSize: fileSize,
  235. ThumbnailSize: thumbnailSize,
  236. }
  237. }
  238. err = c.FileRepo.Update(file, fileSize, thumbnailSize, diff, oldObjects, isDuplicateRequest)
  239. if err != nil {
  240. return response, stacktrace.Propagate(err, "")
  241. }
  242. response.ID = file.ID
  243. response.UpdationTime = file.UpdationTime
  244. return response, nil
  245. }
  246. // GetUploadURLs returns a bunch of presigned URLs for uploading files
  247. func (c *FileController) GetUploadURLs(ctx context.Context, userID int64, count int, app ente.App) ([]ente.UploadURL, error) {
  248. err := c.UsageCtrl.CanUploadFile(ctx, userID, nil, app)
  249. if err != nil {
  250. return []ente.UploadURL{}, stacktrace.Propagate(err, "")
  251. }
  252. s3Client := c.S3Config.GetHotS3Client()
  253. dc := c.S3Config.GetHotDataCenter()
  254. bucket := c.S3Config.GetHotBucket()
  255. urls := make([]ente.UploadURL, 0)
  256. objectKeys := make([]string, 0)
  257. if count > MaxUploadURLsLimit {
  258. count = MaxUploadURLsLimit
  259. }
  260. for i := 0; i < count; i++ {
  261. objectKey := strconv.FormatInt(userID, 10) + "/" + uuid.NewString()
  262. objectKeys = append(objectKeys, objectKey)
  263. url, err := c.getObjectURL(s3Client, dc, bucket, objectKey)
  264. if err != nil {
  265. return urls, stacktrace.Propagate(err, "")
  266. }
  267. urls = append(urls, url)
  268. }
  269. log.Print("Returning objectKeys: " + strings.Join(objectKeys, ", "))
  270. return urls, nil
  271. }
  272. // GetFileURL verifies permissions and returns a presigned url to the requested file
  273. func (c *FileController) GetFileURL(userID int64, fileID int64) (string, error) {
  274. err := c.verifyFileAccess(userID, fileID)
  275. if err != nil {
  276. return "", stacktrace.Propagate(err, "")
  277. }
  278. url, err := c.getSignedURLForType(fileID, ente.FILE)
  279. if err != nil {
  280. if errors.Is(err, sql.ErrNoRows) {
  281. go c.CleanUpStaleCollectionFiles(userID, fileID)
  282. }
  283. return "", stacktrace.Propagate(err, "")
  284. }
  285. return url, nil
  286. }
  287. // GetThumbnailURL verifies permissions and returns a presigned url to the requested thumbnail
  288. func (c *FileController) GetThumbnailURL(userID int64, fileID int64) (string, error) {
  289. err := c.verifyFileAccess(userID, fileID)
  290. if err != nil {
  291. return "", stacktrace.Propagate(err, "")
  292. }
  293. url, err := c.getSignedURLForType(fileID, ente.THUMBNAIL)
  294. if err != nil {
  295. if errors.Is(err, sql.ErrNoRows) {
  296. go c.CleanUpStaleCollectionFiles(userID, fileID)
  297. }
  298. return "", stacktrace.Propagate(err, "")
  299. }
  300. return url, nil
  301. }
  302. func (c *FileController) CleanUpStaleCollectionFiles(userID int64, fileID int64) {
  303. logger := log.WithFields(log.Fields{
  304. "userID": userID,
  305. "fileID": fileID,
  306. "action": "CleanUpStaleCollectionFiles",
  307. })
  308. // catch panic
  309. defer func() {
  310. if r := recover(); r != nil {
  311. logger.Error("Recovered from panic", r)
  312. }
  313. }()
  314. fileIDs := make([]int64, 0)
  315. fileIDs = append(fileIDs, fileID)
  316. // verify file ownership
  317. err := c.FileRepo.VerifyFileOwner(context.Background(), fileIDs, userID, logger)
  318. if err != nil {
  319. logger.Warning("Failed to verify file ownership", err)
  320. return
  321. }
  322. err = c.TrashRepository.CleanUpDeletedFilesFromCollection(context.Background(), fileIDs, userID)
  323. if err != nil {
  324. logger.WithError(err).Error("Failed to clean up stale files from collection")
  325. }
  326. }
  327. // GetPublicFileURL verifies permissions and returns a presigned url to the requested file
  328. func (c *FileController) GetPublicFileURL(ctx *gin.Context, fileID int64, objType ente.ObjectType) (string, error) {
  329. accessContext := auth.MustGetPublicAccessContext(ctx)
  330. accessible, err := c.CollectionRepo.DoesFileExistInCollections(fileID, []int64{accessContext.CollectionID})
  331. if err != nil {
  332. return "", stacktrace.Propagate(err, "")
  333. }
  334. if !accessible {
  335. return "", stacktrace.Propagate(ente.ErrPermissionDenied, "")
  336. }
  337. return c.getSignedURLForType(fileID, objType)
  338. }
  339. // GetCastFileUrl verifies permissions and returns a presigned url to the requested file
  340. func (c *FileController) GetCastFileUrl(ctx *gin.Context, fileID int64, objType ente.ObjectType) (string, error) {
  341. castCtx := auth.GetCastCtx(ctx)
  342. accessible, err := c.CollectionRepo.DoesFileExistInCollections(fileID, []int64{castCtx.CollectionID})
  343. if err != nil {
  344. return "", stacktrace.Propagate(err, "")
  345. }
  346. if !accessible {
  347. return "", stacktrace.Propagate(ente.ErrPermissionDenied, "")
  348. }
  349. return c.getSignedURLForType(fileID, objType)
  350. }
  351. func (c *FileController) getSignedURLForType(fileID int64, objType ente.ObjectType) (string, error) {
  352. s3Object, err := c.ObjectRepo.GetObject(fileID, objType)
  353. if err != nil {
  354. return "", stacktrace.Propagate(err, "")
  355. }
  356. return c.getPreSignedURL(s3Object.ObjectKey)
  357. }
  358. // Trash deletes file and move them to trash
  359. func (c *FileController) Trash(ctx *gin.Context, userID int64, request ente.TrashRequest) error {
  360. fileIDs := make([]int64, 0)
  361. collectionIDs := make([]int64, 0)
  362. for _, trashItem := range request.TrashItems {
  363. fileIDs = append(fileIDs, trashItem.FileID)
  364. collectionIDs = append(collectionIDs, trashItem.CollectionID)
  365. }
  366. if enteArray.ContainsDuplicateInInt64Array(fileIDs) {
  367. return stacktrace.Propagate(ente.ErrBadRequest, "duplicate fileIDs")
  368. }
  369. if err := c.VerifyFileOwnership(ctx, userID, fileIDs); err != nil {
  370. return stacktrace.Propagate(err, "")
  371. }
  372. uniqueCollectionIDs := enteArray.UniqueInt64(collectionIDs)
  373. for _, collectionID := range uniqueCollectionIDs {
  374. ownerID, err := c.CollectionRepo.GetOwnerID(collectionID)
  375. if err != nil {
  376. return stacktrace.Propagate(err, "")
  377. }
  378. if ownerID != userID {
  379. return stacktrace.Propagate(ente.ErrPermissionDenied, "user doesn't own collection")
  380. }
  381. }
  382. return c.TrashRepository.TrashFiles(fileIDs, userID, request)
  383. }
  384. // GetSize returns the size of files indicated by fileIDs that are owned by userID
  385. func (c *FileController) GetSize(userID int64, fileIDs []int64) (int64, error) {
  386. size, err := c.FileRepo.GetSize(userID, fileIDs)
  387. if err != nil {
  388. return -1, stacktrace.Propagate(err, "")
  389. }
  390. return size, nil
  391. }
  392. // GetFileInfo returns the file infos given list of files
  393. func (c *FileController) GetFileInfo(ctx *gin.Context, userID int64, fileIDs []int64) (*ente.FilesInfoResponse, error) {
  394. logger := log.WithFields(log.Fields{
  395. "req_id": requestid.Get(ctx),
  396. })
  397. err := c.FileRepo.VerifyFileOwner(ctx, fileIDs, userID, logger)
  398. if err != nil {
  399. return nil, stacktrace.Propagate(err, "")
  400. }
  401. // Use GetFilesInfo for get fileInfo for the given list.
  402. // Then for fileIDs that are not present in the response of GetFilesInfo, use GetFileInfoFromObjectKeys to get the file info.
  403. // and merge the two responses. and for the fileIDs that are not present in the response of GetFileInfoFromObjectKeys,
  404. // add a new FileInfo entry with size = -1
  405. fileInfoResponse, err := c.FileRepo.GetFilesInfo(ctx, fileIDs, userID)
  406. if err != nil {
  407. return nil, stacktrace.Propagate(err, "")
  408. }
  409. fileIDsNotPresentInFilesDB := make([]int64, 0)
  410. for _, fileID := range fileIDs {
  411. if val, ok := fileInfoResponse[fileID]; !ok || val == nil {
  412. fileIDsNotPresentInFilesDB = append(fileIDsNotPresentInFilesDB, fileID)
  413. }
  414. }
  415. if len(fileIDsNotPresentInFilesDB) > 0 {
  416. logger.WithField("count", len(fileIDsNotPresentInFilesDB)).Info("fileInfos are not present in files table, fetching from object keys")
  417. fileInfoResponseFromObjectKeys, err := c.FileRepo.GetFileInfoFromObjectKeys(ctx, fileIDsNotPresentInFilesDB)
  418. if err != nil {
  419. return nil, stacktrace.Propagate(err, "")
  420. }
  421. err = c.FileRepo.UpdateSizeInfo(ctx, fileInfoResponseFromObjectKeys)
  422. if err != nil {
  423. return nil, stacktrace.Propagate(err, "Failed to update the size info in files")
  424. }
  425. for id, fileInfo := range fileInfoResponseFromObjectKeys {
  426. fileInfoResponse[id] = fileInfo
  427. }
  428. }
  429. missedFileIDs := make([]int64, 0)
  430. for _, fileID := range fileIDs {
  431. if _, ok := fileInfoResponse[fileID]; !ok {
  432. missedFileIDs = append(missedFileIDs, fileID)
  433. }
  434. }
  435. if len(missedFileIDs) > 0 {
  436. return nil, stacktrace.Propagate(ente.NewInternalError("failed to get fileInfo"), "fileIDs not found: %v", missedFileIDs)
  437. }
  438. // prepare a list of FileInfoResponse
  439. fileInfoList := make([]*ente.FileInfoResponse, 0)
  440. for _, fileID := range fileIDs {
  441. fileInfoList = append(fileInfoList, &ente.FileInfoResponse{
  442. ID: fileID,
  443. FileInfo: *fileInfoResponse[fileID],
  444. })
  445. }
  446. return &ente.FilesInfoResponse{
  447. FilesInfo: fileInfoList,
  448. }, nil
  449. }
  450. // GetDuplicates returns the list of files of the same size
  451. func (c *FileController) GetDuplicates(userID int64) ([]ente.DuplicateFiles, error) {
  452. dupes, err := c.FileRepo.GetDuplicateFiles(userID)
  453. if err != nil {
  454. return nil, stacktrace.Propagate(err, "")
  455. }
  456. return dupes, nil
  457. }
  458. // GetLargeThumbnailFiles returns the list of files whose thumbnail size is larger than threshold size
  459. func (c *FileController) GetLargeThumbnailFiles(userID int64, threshold int64) ([]int64, error) {
  460. largeThumbnailFiles, err := c.FileRepo.GetLargeThumbnailFiles(userID, threshold)
  461. if err != nil {
  462. return nil, stacktrace.Propagate(err, "")
  463. }
  464. return largeThumbnailFiles, nil
  465. }
  466. // UpdateMagicMetadata updates the magic metadata for list of files
  467. func (c *FileController) UpdateMagicMetadata(ctx *gin.Context, req ente.UpdateMultipleMagicMetadataRequest, isPublicMetadata bool) error {
  468. err := c.validateUpdateMetadataRequest(ctx, req, isPublicMetadata)
  469. if err != nil {
  470. return stacktrace.Propagate(err, "")
  471. }
  472. err = c.FileRepo.UpdateMagicAttributes(ctx, req.MetadataList, isPublicMetadata)
  473. if err != nil {
  474. return stacktrace.Propagate(err, "failed to update magic attributes")
  475. }
  476. return nil
  477. }
  478. // UpdateThumbnail updates thumbnail of a file
  479. func (c *FileController) UpdateThumbnail(ctx *gin.Context, fileID int64, newThumbnail ente.FileAttributes, app ente.App) error {
  480. userID := auth.GetUserID(ctx.Request.Header)
  481. objectPathPrefix := strconv.FormatInt(userID, 10) + "/"
  482. if !strings.HasPrefix(newThumbnail.ObjectKey, objectPathPrefix) {
  483. return stacktrace.Propagate(ente.ErrBadRequest, "Incorrect object key reported")
  484. }
  485. ownerID, err := c.FileRepo.GetOwnerID(fileID)
  486. if err != nil {
  487. return stacktrace.Propagate(err, "")
  488. }
  489. // verify that user owns the file
  490. if ownerID != userID {
  491. return stacktrace.Propagate(ente.ErrPermissionDenied, "")
  492. }
  493. existingThumbnailObject, err := c.ObjectRepo.GetObject(fileID, ente.THUMBNAIL)
  494. if err != nil {
  495. return stacktrace.Propagate(err, "")
  496. }
  497. existingThumbnailObjectKey := existingThumbnailObject.ObjectKey
  498. oldThumbnailSize := existingThumbnailObject.FileSize
  499. newThumbnailSize, err := c.sizeOf(newThumbnail.ObjectKey)
  500. if err != nil {
  501. return stacktrace.Propagate(err, "")
  502. }
  503. diff := newThumbnailSize - oldThumbnailSize
  504. if diff > 0 {
  505. return stacktrace.Propagate(errors.New("new thumbnail larger than existing thumbnail"), "")
  506. }
  507. err = c.UsageCtrl.CanUploadFile(ctx, userID, &diff, app)
  508. if err != nil {
  509. return stacktrace.Propagate(err, "")
  510. }
  511. var oldObject *string
  512. if existingThumbnailObjectKey != newThumbnail.ObjectKey {
  513. // delete old object only if newThumbnail object key different.
  514. oldObject = &existingThumbnailObjectKey
  515. }
  516. err = c.FileRepo.UpdateThumbnail(ctx, fileID, userID, newThumbnail, newThumbnailSize, diff, oldObject)
  517. if err != nil {
  518. return stacktrace.Propagate(err, "")
  519. }
  520. return nil
  521. }
  522. // VerifyFileOwnership will return error if given fileIDs are not valid or don't belong to the ownerID
  523. func (c *FileController) VerifyFileOwnership(ctx *gin.Context, ownerID int64, fileIDs []int64) error {
  524. countMap, err := c.FileRepo.GetOwnerToFileCountMap(ctx, fileIDs)
  525. if err != nil {
  526. return stacktrace.Propagate(err, "failed to get owners info")
  527. }
  528. logger := log.WithFields(log.Fields{
  529. "req_id": requestid.Get(ctx),
  530. "owner_id": ownerID,
  531. "file_ids": fileIDs,
  532. "owners_map": countMap,
  533. })
  534. if len(countMap) == 0 {
  535. logger.Error("all fileIDs are invalid")
  536. return stacktrace.Propagate(ente.ErrBadRequest, "")
  537. }
  538. if len(countMap) > 1 {
  539. logger.Error("files are owned by multiple users")
  540. return stacktrace.Propagate(ente.ErrPermissionDenied, "")
  541. }
  542. if filesOwned, ok := countMap[ownerID]; ok {
  543. if filesOwned != int64(len(fileIDs)) {
  544. logger.WithField("file_owned", filesOwned).Error("failed to find all fileIDs")
  545. return stacktrace.Propagate(ente.ErrBadRequest, "")
  546. }
  547. return nil
  548. } else {
  549. logger.Error("user is not an owner of any file")
  550. return stacktrace.Propagate(ente.ErrPermissionDenied, "")
  551. }
  552. }
  553. func (c *FileController) validateUpdateMetadataRequest(ctx *gin.Context, req ente.UpdateMultipleMagicMetadataRequest, isPublicMetadata bool) error {
  554. userID := auth.GetUserID(ctx.Request.Header)
  555. for _, updateMMdRequest := range req.MetadataList {
  556. ownerID, existingMetadata, err := c.FileRepo.GetOwnerAndMagicMetadata(updateMMdRequest.ID, isPublicMetadata)
  557. if err != nil {
  558. return stacktrace.Propagate(err, "")
  559. }
  560. if ownerID != userID {
  561. log.WithFields(log.Fields{
  562. "file_id": updateMMdRequest.ID,
  563. "owner_id": ownerID,
  564. "user_id": userID,
  565. "public_md": isPublicMetadata,
  566. }).Error("can't update magic metadata for file which isn't owned by use")
  567. return stacktrace.Propagate(ente.ErrPermissionDenied, "")
  568. }
  569. if existingMetadata != nil && (existingMetadata.Version != updateMMdRequest.MagicMetadata.Version || existingMetadata.Count > updateMMdRequest.MagicMetadata.Count) {
  570. log.WithFields(log.Fields{
  571. "existing_count": existingMetadata.Count,
  572. "existing_version": existingMetadata.Version,
  573. "file_id": updateMMdRequest.ID,
  574. "received_count": updateMMdRequest.MagicMetadata.Count,
  575. "received_version": updateMMdRequest.MagicMetadata.Version,
  576. "public_md": isPublicMetadata,
  577. }).Error("invalid ops: mismatch in metadata version or count")
  578. return stacktrace.Propagate(ente.ErrVersionMismatch, "mismatch in metadata version or count")
  579. }
  580. }
  581. return nil
  582. }
  583. // CleanupDeletedFiles deletes the files from object store. It will delete from both hot storage and
  584. // cold storage (if replicated)
  585. func (c *FileController) CleanupDeletedFiles() {
  586. log.Info("Cleaning up deleted files")
  587. // If cleanup is already running, avoiding concurrent runs to avoid concurrent issues
  588. if c.cleanupCronRunning {
  589. log.Info("Skipping CleanupDeletedFiles cron run as another instance is still running")
  590. return
  591. }
  592. c.cleanupCronRunning = true
  593. defer func() {
  594. c.cleanupCronRunning = false
  595. }()
  596. lockStatus := c.LockController.TryLock(DeletedObjectQueueLock, time.MicrosecondsAfterHours(2))
  597. if !lockStatus {
  598. log.Warning(fmt.Sprintf("Failed to acquire lock %s", DeletedObjectQueueLock))
  599. return
  600. }
  601. defer func() {
  602. c.LockController.ReleaseLock(DeletedObjectQueueLock)
  603. }()
  604. items, err := c.QueueRepo.GetItemsReadyForDeletion(repo.DeleteObjectQueue, 2000)
  605. if err != nil {
  606. log.WithError(err).Error("Failed to fetch items from queue")
  607. return
  608. }
  609. for _, i := range items {
  610. c.cleanupDeletedFile(i)
  611. }
  612. }
  613. func (c *FileController) GetTotalFileCount() (int64, error) {
  614. count, err := c.FileRepo.GetTotalFileCount()
  615. if err != nil {
  616. return -1, stacktrace.Propagate(err, "")
  617. }
  618. return count, nil
  619. }
  620. func (c *FileController) cleanupDeletedFile(qItem repo.QueueItem) {
  621. lockName := file.GetLockNameForObject(qItem.Item)
  622. lockStatus, err := c.TaskLockingRepo.AcquireLock(lockName, time.MicrosecondsAfterHours(1), c.HostName)
  623. ctxLogger := log.WithField("item", qItem.Item).WithField("queue_id", qItem.Id)
  624. if err != nil || !lockStatus {
  625. ctxLogger.Warn("unable to acquire lock")
  626. return
  627. }
  628. defer func() {
  629. err = c.TaskLockingRepo.ReleaseLock(lockName)
  630. if err != nil {
  631. ctxLogger.Errorf("Error while releasing lock %s", err)
  632. }
  633. }()
  634. ctxLogger.Info("Deleting item")
  635. dcs, err := c.ObjectRepo.GetDataCentersForObject(qItem.Item)
  636. if err != nil {
  637. ctxLogger.Errorf("Could not fetch datacenters %s", err)
  638. return
  639. }
  640. for _, dc := range dcs {
  641. if c.S3Config.ShouldDeleteFromDataCenter(dc) {
  642. err = c.ObjectCleanupCtrl.DeleteObjectFromDataCenter(qItem.Item, dc)
  643. }
  644. if err != nil {
  645. ctxLogger.WithError(err).Error("Failed to delete " + qItem.Item + " from " + dc)
  646. return
  647. }
  648. err = c.ObjectRepo.RemoveDataCenterFromObject(qItem.Item, dc)
  649. if err != nil {
  650. ctxLogger.WithError(err).Error("Could not remove from table: " + qItem.Item + ", dc: " + dc)
  651. return
  652. }
  653. }
  654. err = c.ObjectRepo.RemoveObjectsForKey(qItem.Item)
  655. if err != nil {
  656. ctxLogger.WithError(err).Error("Failed to remove item from object_keys")
  657. return
  658. }
  659. err = c.QueueRepo.DeleteItem(repo.DeleteObjectQueue, qItem.Item)
  660. if err != nil {
  661. ctxLogger.WithError(err).Error("Failed to remove item from the queue")
  662. return
  663. }
  664. ctxLogger.Info("Successfully deleted item")
  665. }
  666. func (c *FileController) getPreSignedURL(objectKey string) (string, error) {
  667. s3Client := c.S3Config.GetHotS3Client()
  668. r, _ := s3Client.GetObjectRequest(&s3.GetObjectInput{
  669. Bucket: c.S3Config.GetHotBucket(),
  670. Key: &objectKey,
  671. })
  672. return r.Presign(PreSignedRequestValidityDuration)
  673. }
  674. func (c *FileController) sizeOf(objectKey string) (int64, error) {
  675. s3Client := c.S3Config.GetHotS3Client()
  676. head, err := s3Client.HeadObject(&s3.HeadObjectInput{
  677. Key: &objectKey,
  678. Bucket: c.S3Config.GetHotBucket(),
  679. })
  680. if err != nil {
  681. return -1, stacktrace.Propagate(err, "")
  682. }
  683. return *head.ContentLength, nil
  684. }
  685. func (c *FileController) onDuplicateObjectDetected(file ente.File, existing ente.File, hotDC string) (ente.File, error) {
  686. newJSON, _ := json.Marshal(file)
  687. existingJSON, _ := json.Marshal(existing)
  688. log.Info("Comparing " + string(newJSON) + " against " + string(existingJSON))
  689. if file.Thumbnail.ObjectKey == existing.Thumbnail.ObjectKey &&
  690. file.Thumbnail.Size == existing.Thumbnail.Size &&
  691. file.Thumbnail.DecryptionHeader == existing.Thumbnail.DecryptionHeader &&
  692. file.File.ObjectKey == existing.File.ObjectKey &&
  693. file.File.Size == existing.File.Size &&
  694. file.File.DecryptionHeader == existing.File.DecryptionHeader &&
  695. file.Metadata.EncryptedData == existing.Metadata.EncryptedData &&
  696. file.Metadata.DecryptionHeader == existing.Metadata.DecryptionHeader &&
  697. file.OwnerID == existing.OwnerID {
  698. // Already uploaded file
  699. file.ID = existing.ID
  700. return file, nil
  701. } else {
  702. // Overwrote an existing file or thumbnail
  703. go c.onExistingObjectsReplaced(file, hotDC)
  704. return ente.File{}, ente.ErrBadRequest
  705. }
  706. }
  707. func (c *FileController) onExistingObjectsReplaced(file ente.File, hotDC string) {
  708. defer func() {
  709. if r := recover(); r != nil {
  710. log.Errorf("Panic caught: %s, stack: %s", r, string(debug.Stack()))
  711. }
  712. }()
  713. log.Error("Replaced existing object, reverting", file)
  714. err := c.rollbackObject(file.File.ObjectKey)
  715. if err != nil {
  716. log.Error("Error rolling back latest file from hot storage", err)
  717. }
  718. err = c.rollbackObject(file.Thumbnail.ObjectKey)
  719. if err != nil {
  720. log.Error("Error rolling back latest thumbnail from hot storage", err)
  721. }
  722. c.FileRepo.ResetNeedsReplication(file, hotDC)
  723. }
  724. func (c *FileController) rollbackObject(objectKey string) error {
  725. versions, err := c.getVersions(objectKey)
  726. if err != nil {
  727. return stacktrace.Propagate(err, "")
  728. }
  729. if len(versions) > 1 {
  730. err = c.deleteObjectVersionFromHotStorage(objectKey,
  731. *versions[0].VersionId)
  732. if err != nil {
  733. return stacktrace.Propagate(err, "")
  734. }
  735. }
  736. return nil
  737. }
  738. func (c *FileController) getVersions(objectKey string) ([]*s3.ObjectVersion, error) {
  739. s3Client := c.S3Config.GetHotS3Client()
  740. response, err := s3Client.ListObjectVersions(&s3.ListObjectVersionsInput{
  741. Prefix: &objectKey,
  742. Bucket: c.S3Config.GetHotBucket(),
  743. })
  744. if err != nil {
  745. return nil, stacktrace.Propagate(err, "")
  746. }
  747. return response.Versions, nil
  748. }
  749. func (c *FileController) deleteObjectVersionFromHotStorage(objectKey string, versionID string) error {
  750. var s3Client = c.S3Config.GetHotS3Client()
  751. _, err := s3Client.DeleteObject(&s3.DeleteObjectInput{
  752. Bucket: c.S3Config.GetHotBucket(),
  753. Key: &objectKey,
  754. VersionId: &versionID,
  755. })
  756. if err != nil {
  757. return stacktrace.Propagate(err, "")
  758. }
  759. err = s3Client.WaitUntilObjectNotExists(&s3.HeadObjectInput{
  760. Bucket: c.S3Config.GetHotBucket(),
  761. Key: &objectKey,
  762. })
  763. if err != nil {
  764. return stacktrace.Propagate(err, "")
  765. }
  766. return nil
  767. }
  768. func (c *FileController) verifyFileAccess(actorUserID int64, fileID int64) error {
  769. fileOwnerID, err := c.FileRepo.GetOwnerID(fileID)
  770. if err != nil {
  771. return stacktrace.Propagate(err, "")
  772. }
  773. if fileOwnerID != actorUserID {
  774. cIDs, err := c.CollectionRepo.GetCollectionIDsSharedWithUser(actorUserID)
  775. if err != nil {
  776. return stacktrace.Propagate(err, "")
  777. }
  778. cwIDS, err := c.CollectionRepo.GetCollectionIDsSharedWithUser(fileOwnerID)
  779. if err != nil {
  780. return stacktrace.Propagate(err, "")
  781. }
  782. cIDs = append(cIDs, cwIDS...)
  783. accessible, err := c.CollectionRepo.DoesFileExistInCollections(fileID, cIDs)
  784. if err != nil {
  785. return stacktrace.Propagate(err, "")
  786. }
  787. if !accessible {
  788. return stacktrace.Propagate(ente.ErrPermissionDenied, "")
  789. }
  790. }
  791. return nil
  792. }
  793. func (c *FileController) getObjectURL(s3Client *s3.S3, dc string, bucket *string, objectKey string) (ente.UploadURL, error) {
  794. r, _ := s3Client.PutObjectRequest(&s3.PutObjectInput{
  795. Bucket: bucket,
  796. Key: &objectKey,
  797. })
  798. url, err := r.Presign(PreSignedRequestValidityDuration)
  799. if err != nil {
  800. return ente.UploadURL{}, stacktrace.Propagate(err, "")
  801. }
  802. err = c.ObjectCleanupCtrl.AddTempObjectKey(objectKey, dc)
  803. if err != nil {
  804. return ente.UploadURL{}, stacktrace.Propagate(err, "")
  805. }
  806. return ente.UploadURL{ObjectKey: objectKey, URL: url}, nil
  807. }
  808. // GetMultipartUploadURLs return collections of url to upload the parts of the files
  809. func (c *FileController) GetMultipartUploadURLs(ctx context.Context, userID int64, count int, app ente.App) (ente.MultipartUploadURLs, error) {
  810. err := c.UsageCtrl.CanUploadFile(ctx, userID, nil, app)
  811. if err != nil {
  812. return ente.MultipartUploadURLs{}, stacktrace.Propagate(err, "")
  813. }
  814. s3Client := c.S3Config.GetHotS3Client()
  815. dc := c.S3Config.GetHotDataCenter()
  816. bucket := c.S3Config.GetHotBucket()
  817. objectKey := strconv.FormatInt(userID, 10) + "/" + uuid.NewString()
  818. r, err := s3Client.CreateMultipartUpload(&s3.CreateMultipartUploadInput{
  819. Bucket: bucket,
  820. Key: &objectKey,
  821. })
  822. if err != nil {
  823. return ente.MultipartUploadURLs{}, stacktrace.Propagate(err, "")
  824. }
  825. err = c.ObjectCleanupCtrl.AddMultipartTempObjectKey(objectKey, *r.UploadId, dc)
  826. if err != nil {
  827. return ente.MultipartUploadURLs{}, stacktrace.Propagate(err, "")
  828. }
  829. multipartUploadURLs := ente.MultipartUploadURLs{ObjectKey: objectKey}
  830. urls := make([]string, 0)
  831. for i := 0; i < count; i++ {
  832. url, err := c.getPartURL(*s3Client, objectKey, int64(i+1), r.UploadId)
  833. if err != nil {
  834. return multipartUploadURLs, stacktrace.Propagate(err, "")
  835. }
  836. urls = append(urls, url)
  837. }
  838. multipartUploadURLs.PartURLs = urls
  839. r2, _ := s3Client.CompleteMultipartUploadRequest(&s3.CompleteMultipartUploadInput{
  840. Bucket: c.S3Config.GetHotBucket(),
  841. Key: &objectKey,
  842. UploadId: r.UploadId,
  843. })
  844. url, err := r2.Presign(PreSignedRequestValidityDuration)
  845. if err != nil {
  846. return multipartUploadURLs, stacktrace.Propagate(err, "")
  847. }
  848. multipartUploadURLs.CompleteURL = url
  849. return multipartUploadURLs, nil
  850. }
  851. func (c *FileController) getPartURL(s3Client s3.S3, objectKey string, partNumber int64, uploadID *string) (string, error) {
  852. r, _ := s3Client.UploadPartRequest(&s3.UploadPartInput{
  853. Bucket: c.S3Config.GetHotBucket(),
  854. Key: &objectKey,
  855. UploadId: uploadID,
  856. PartNumber: &partNumber,
  857. })
  858. url, err := r.Presign(PreSignedPartUploadRequestDuration)
  859. if err != nil {
  860. return "", stacktrace.Propagate(err, "")
  861. }
  862. return url, nil
  863. }