Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2021 The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <chainparams.h>
7 : : #include <common/args.h>
8 : : #include <logging.h>
9 : : #include <util/fs.h>
10 : : #include <wallet/db.h>
11 : :
12 : : #include <algorithm>
13 : : #include <exception>
14 : : #include <fstream>
15 : : #include <string>
16 : : #include <system_error>
17 : : #include <vector>
18 : :
19 : : namespace wallet {
20 [ + - ]: 3 : bool operator<(BytePrefix a, Span<const std::byte> b) { return std::ranges::lexicographical_compare(a.prefix, b.subspan(0, std::min(a.prefix.size(), b.size()))); }
21 [ - + ]: 3 : bool operator<(Span<const std::byte> a, BytePrefix b) { return std::ranges::lexicographical_compare(a.subspan(0, std::min(a.size(), b.prefix.size())), b.prefix); }
22 : :
23 : 0 : std::vector<std::pair<fs::path, std::string>> ListDatabases(const fs::path& wallet_dir)
24 : : {
25 : 0 : std::vector<std::pair<fs::path, std::string>> paths;
26 [ # # ]: 0 : std::error_code ec;
27 : :
28 [ # # # # : 0 : for (auto it = fs::recursive_directory_iterator(wallet_dir, ec); it != fs::recursive_directory_iterator(); it.increment(ec)) {
# # # # ]
29 [ # # ]: 0 : if (ec) {
30 [ # # # # ]: 0 : if (fs::is_directory(*it)) {
31 : 0 : it.disable_recursion_pending();
32 [ # # # # : 0 : LogPrintf("%s: %s %s -- skipping.\n", __func__, ec.message(), fs::PathToString(it->path()));
# # # # ]
33 : : } else {
34 [ # # # # : 0 : LogPrintf("%s: %s %s\n", __func__, ec.message(), fs::PathToString(it->path()));
# # # # ]
35 : : }
36 : 0 : continue;
37 : : }
38 : :
39 : 0 : try {
40 [ # # ]: 0 : const fs::path path{it->path().lexically_relative(wallet_dir)};
41 : :
42 [ # # # # ]: 0 : if (it->status().type() == fs::file_type::directory) {
43 [ # # # # : 0 : if (IsBDBFile(BDBDataFile(it->path()))) {
# # # # ]
44 : : // Found a directory which contains wallet.dat btree file, add it as a wallet with BERKELEY format.
45 [ # # ]: 0 : paths.emplace_back(path, "bdb");
46 [ # # # # : 0 : } else if (IsSQLiteFile(SQLiteDataFile(it->path()))) {
# # # # ]
47 : : // Found a directory which contains wallet.dat sqlite file, add it as a wallet with SQLITE format.
48 [ # # ]: 0 : paths.emplace_back(path, "sqlite");
49 : : }
50 [ # # # # : 0 : } else if (it.depth() == 0 && it->symlink_status().type() == fs::file_type::regular && it->path().extension() != ".bak") {
# # # # #
# # # # #
# # # # ]
51 [ # # # # : 0 : if (it->path().filename() == "wallet.dat") {
# # ]
52 : : // Found top-level wallet.dat file, add top level directory ""
53 : : // as a wallet.
54 [ # # # # : 0 : if (IsBDBFile(it->path())) {
# # ]
55 [ # # ]: 0 : paths.emplace_back(fs::path(), "bdb");
56 [ # # # # : 0 : } else if (IsSQLiteFile(it->path())) {
# # ]
57 [ # # ]: 0 : paths.emplace_back(fs::path(), "sqlite");
58 : : }
59 [ # # # # : 0 : } else if (IsBDBFile(it->path())) {
# # ]
60 : : // Found top-level btree file not called wallet.dat. Current bitcoin
61 : : // software will never create these files but will allow them to be
62 : : // opened in a shared database environment for backwards compatibility.
63 : : // Add it to the list of available wallets.
64 [ # # ]: 0 : paths.emplace_back(path, "bdb");
65 : : }
66 : : }
67 [ # # ]: 0 : } catch (const std::exception& e) {
68 [ - - - - : 0 : LogPrintf("%s: Error scanning %s: %s\n", __func__, fs::PathToString(it->path()), e.what());
- - ]
69 : 0 : it.disable_recursion_pending();
70 : 0 : }
71 : 0 : }
72 : :
73 : 0 : return paths;
74 : 0 : }
75 : :
76 : 78 : fs::path BDBDataFile(const fs::path& wallet_path)
77 : : {
78 [ + - ]: 78 : if (fs::is_regular_file(wallet_path)) {
79 : : // Special case for backwards compatibility: if wallet path points to an
80 : : // existing file, treat it as the path to a BDB data file in a parent
81 : : // directory that also contains BDB log files.
82 : 78 : return wallet_path;
83 : : } else {
84 : : // Normal case: Interpret wallet path as a directory path containing
85 : : // data and log files.
86 [ # # ]: 0 : return wallet_path / "wallet.dat";
87 : : }
88 : : }
89 : :
90 : 0 : fs::path SQLiteDataFile(const fs::path& path)
91 : : {
92 [ # # ]: 0 : return path / "wallet.dat";
93 : : }
94 : :
95 : 0 : bool IsBDBFile(const fs::path& path)
96 : : {
97 [ # # ]: 0 : if (!fs::exists(path)) return false;
98 : :
99 : : // A Berkeley DB Btree file has at least 4K.
100 : : // This check also prevents opening lock files.
101 : 0 : std::error_code ec;
102 : 0 : auto size = fs::file_size(path, ec);
103 [ # # # # : 0 : if (ec) LogPrintf("%s: %s %s\n", __func__, ec.message(), fs::PathToString(path));
# # ]
104 [ # # ]: 0 : if (size < 4096) return false;
105 : :
106 : 0 : std::ifstream file{path, std::ios::binary};
107 [ # # ]: 0 : if (!file.is_open()) return false;
108 : :
109 [ # # ]: 0 : file.seekg(12, std::ios::beg); // Magic bytes start at offset 12
110 : 0 : uint32_t data = 0;
111 [ # # ]: 0 : file.read((char*) &data, sizeof(data)); // Read 4 bytes of file to compare against magic
112 : :
113 : : // Berkeley DB Btree magic bytes, from:
114 : : // https://github.com/file/file/blob/5824af38469ec1ca9ac3ffd251e7afe9dc11e227/magic/Magdir/database#L74-L75
115 : : // - big endian systems - 00 05 31 62
116 : : // - little endian systems - 62 31 05 00
117 : 0 : return data == 0x00053162 || data == 0x62310500;
118 : 0 : }
119 : :
120 : 0 : bool IsSQLiteFile(const fs::path& path)
121 : : {
122 [ # # ]: 0 : if (!fs::exists(path)) return false;
123 : :
124 : : // A SQLite Database file is at least 512 bytes.
125 : 0 : std::error_code ec;
126 : 0 : auto size = fs::file_size(path, ec);
127 [ # # # # : 0 : if (ec) LogPrintf("%s: %s %s\n", __func__, ec.message(), fs::PathToString(path));
# # ]
128 [ # # ]: 0 : if (size < 512) return false;
129 : :
130 : 0 : std::ifstream file{path, std::ios::binary};
131 [ # # ]: 0 : if (!file.is_open()) return false;
132 : :
133 : : // Magic is at beginning and is 16 bytes long
134 : 0 : char magic[16];
135 [ # # ]: 0 : file.read(magic, 16);
136 : :
137 : : // Application id is at offset 68 and 4 bytes long
138 [ # # ]: 0 : file.seekg(68, std::ios::beg);
139 : 0 : char app_id[4];
140 [ # # ]: 0 : file.read(app_id, 4);
141 : :
142 [ # # ]: 0 : file.close();
143 : :
144 : : // Check the magic, see https://sqlite.org/fileformat.html
145 [ # # ]: 0 : std::string magic_str(magic, 16);
146 [ # # # # ]: 0 : if (magic_str != std::string{"SQLite format 3\000", 16}) {
147 : : return false;
148 : : }
149 : :
150 : : // Check the application id matches our network magic
151 [ # # ]: 0 : return memcmp(Params().MessageStart().data(), app_id, 4) == 0;
152 : 0 : }
153 : :
154 : 0 : void ReadDatabaseArgs(const ArgsManager& args, DatabaseOptions& options)
155 : : {
156 : : // Override current options with args values, if any were specified
157 [ # # ]: 0 : options.use_unsafe_sync = args.GetBoolArg("-unsafesqlitesync", options.use_unsafe_sync);
158 [ # # ]: 0 : options.use_shared_memory = !args.GetBoolArg("-privdb", !options.use_shared_memory);
159 [ # # ]: 0 : options.max_log_mb = args.GetIntArg("-dblogsize", options.max_log_mb);
160 : 0 : }
161 : :
162 : : } // namespace wallet
|
