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