File: indexed_db_external_object_storage.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (91 lines) | stat: -rw-r--r-- 3,629 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_EXTERNAL_OBJECT_STORAGE_H_
#define CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_EXTERNAL_OBJECT_STORAGE_H_

#include <stdint.h>

#include <map>
#include <string>
#include <vector>

#include "base/functional/callback_forward.h"
#include "components/services/storage/public/mojom/blob_storage_context.mojom.h"
#include "content/browser/indexed_db/indexed_db_external_object.h"
#include "content/browser/indexed_db/indexed_db_leveldb_coding.h"
#include "content/browser/indexed_db/status.h"
#include "storage/common/file_system/file_system_mount_option.h"

namespace content::indexed_db {

// This file contains all of the classes & types used to store external objects
// (such as blobs) in IndexedDB. Currently it is messy because this is
// mid-refactor, but it will be cleaned up over time.

enum class BlobWriteResult {
  // There was an error writing the blobs.
  kFailure,
  // The blobs were written, and phase two should be scheduled asynchronously.
  // The returned status will be ignored.
  kRunPhaseTwoAsync,
  // The blobs were written, and phase two should be run now. The returned
  // status will be correctly propagated.
  kRunPhaseTwoAndReturnResult,
};

// This callback is used to signify that writing blobs is complete. The
// BlobWriteResult signifies if the operation succeeded or not, and the returned
// status is used to handle errors in the next part of the transcation commit
// lifecycle. Note: The returned status can only be used when the result is
// |kRunPhaseTwoAndReturnResult|.  The WriteBlobToFileResult is a more granular
// error in the case something goes wrong.
using BlobWriteCallback =
    base::OnceCallback<Status(BlobWriteResult,
                              storage::mojom::WriteBlobToFileResult)>;

// This object represents a change in the database involving adding or removing
// external objects. if external_objects() is empty, then objects are to be
// deleted, and if external_objects() is populated, then objects are two be
// written (and also possibly deleted if there were already objects).
class IndexedDBExternalObjectChangeRecord {
 public:
  IndexedDBExternalObjectChangeRecord(const std::string& object_store_data_key);

  IndexedDBExternalObjectChangeRecord(
      const IndexedDBExternalObjectChangeRecord&) = delete;
  IndexedDBExternalObjectChangeRecord& operator=(
      const IndexedDBExternalObjectChangeRecord&) = delete;

  ~IndexedDBExternalObjectChangeRecord();

  const std::string& object_store_data_key() const {
    return object_store_data_key_;
  }
  void SetExternalObjects(
      std::vector<IndexedDBExternalObject>* external_objects);
  std::vector<IndexedDBExternalObject>& mutable_external_objects() {
    return external_objects_;
  }
  const std::vector<IndexedDBExternalObject>& external_objects() const {
    return external_objects_;
  }
  std::unique_ptr<IndexedDBExternalObjectChangeRecord> Clone() const;

 private:
  std::string object_store_data_key_;
  std::vector<IndexedDBExternalObject> external_objects_;
};

// Reports that the recovery and/or active journals have been processed, and
// blob files have been deleted.
using BlobFilesCleanedCallback = base::RepeatingClosure;

// Reports that there are (or are not) active blobs.
using ReportOutstandingBlobsCallback =
    base::RepeatingCallback<void(/*outstanding_blobs=*/bool)>;

}  // namespace content::indexed_db

#endif  // CONTENT_BROWSER_INDEXED_DB_INDEXED_DB_EXTERNAL_OBJECT_STORAGE_H_