File: proto_file_manager.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 (86 lines) | stat: -rw-r--r-- 3,171 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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_APPS_ALMANAC_API_CLIENT_PROTO_FILE_MANAGER_H_
#define CHROME_BROWSER_APPS_ALMANAC_API_CLIENT_PROTO_FILE_MANAGER_H_

#include <optional>

#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/callback_forward.h"
#include "base/logging.h"
#include "base/memory/scoped_refptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"

namespace apps {
// Writes a file to a given `path` on disk. If the write operation fails,
// the existing data on disk will be unaffected. Returns true if data is
// written to disk successfully and false otherwise.
bool WriteFileToDisk(const base::FilePath& path, const std::string& data);

// The ProtoFileManager is used to store protos on disk
// and read the stored data from disk.
template <typename M>
class ProtoFileManager {
 public:
  explicit ProtoFileManager(base::FilePath& path)
      : path_(path),
        task_runner_(base::ThreadPool::CreateSequencedTaskRunner(
            {base::MayBlock(), base::TaskPriority::BEST_EFFORT,
             base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN})) {}

  ~ProtoFileManager() = default;
  ProtoFileManager(const ProtoFileManager&) = delete;
  ProtoFileManager& operator=(const ProtoFileManager&) = delete;

  // Writes proto data to a file on disk using another thread.
  void WriteProtoToFile(M proto, base::OnceCallback<void(bool)> callback) {
    // Write is a blocking function, so the task is posted to another thread.
    task_runner_->PostTaskAndReplyWithResult(
        FROM_HERE,
        base::BindOnce(
            [](const base::FilePath& path, const M& proto) {
              return WriteFileToDisk(path, proto.SerializeAsString());
            },
            path_, std::move(proto)),
        std::move(callback));
  }

  // Reads proto data from the file path on disk using another thread.
  void ReadProtoFromFile(base::OnceCallback<void(std::optional<M>)> callback) {
    // Read is a blocking function, so the task is posted to another thread.
    task_runner_->PostTaskAndReplyWithResult(
        FROM_HERE,
        base::BindOnce(
            [](const base::FilePath& path) -> std::optional<M> {
              std::string serialized_data;
              if (!base::ReadFileToString(path, &serialized_data)) {
                LOG(ERROR) << "Reading file from disk failed: " << path.value();
                return std::nullopt;
              }

              M proto;
              if (!proto.ParseFromString(serialized_data)) {
                LOG(ERROR) << "Parsing proto failed: " << path.value();
                return std::nullopt;
              }

              return proto;
            },
            path_),
        std::move(callback));
  }

 private:
  // Absolute path to the file where data is stored.
  base::FilePath path_;

  scoped_refptr<base::SequencedTaskRunner> task_runner_;
};
}  // namespace apps

#endif  // CHROME_BROWSER_APPS_ALMANAC_API_CLIENT_PROTO_FILE_MANAGER_H_