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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
#pragma once
#include "app.hpp"
#include "http_request.hpp"
#include "http_response.hpp"
#include "routing.hpp"
#include "webroutes.hpp"
#include <boost/container/flat_set.hpp>
#include <filesystem>
#include <fstream>
#include <string>
namespace crow
{
namespace webassets
{
struct CmpStr
{
bool operator()(const char* a, const char* b) const
{
return std::strcmp(a, b) < 0;
}
};
inline std::string getStaticEtag(const std::filesystem::path& webpath)
{
// webpack outputs production chunks in the form:
// <filename>.<hash>.<extension>
// For example app.63e2c453.css
// Try to detect this, so we can use the hash as the ETAG
std::vector<std::string> split;
bmcweb::split(split, webpath.filename().string(), '.');
BMCWEB_LOG_DEBUG("Checking {} split.size() {}", webpath.filename().string(),
split.size());
if (split.size() < 3)
{
return "";
}
// get the second to last element
std::string hash = split.rbegin()[1];
// Webpack hashes are 8 characters long
if (hash.size() != 8)
{
return "";
}
// Webpack hashes only include hex printable characters
if (hash.find_first_not_of("0123456789abcdefABCDEF") != std::string::npos)
{
return "";
}
return std::format("\"{}\"", hash);
}
inline void requestRoutes(App& app)
{
constexpr static std::array<std::pair<const char*, const char*>, 17>
contentTypes{
{{".css", "text/css;charset=UTF-8"},
{".html", "text/html;charset=UTF-8"},
{".js", "application/javascript;charset=UTF-8"},
{".png", "image/png;charset=UTF-8"},
{".woff", "application/x-font-woff"},
{".woff2", "application/x-font-woff2"},
{".gif", "image/gif"},
{".ico", "image/x-icon"},
{".ttf", "application/x-font-ttf"},
{".svg", "image/svg+xml"},
{".eot", "application/vnd.ms-fontobject"},
{".xml", "application/xml"},
{".json", "application/json"},
{".jpg", "image/jpeg"},
{".jpeg", "image/jpeg"},
// dev tools don't care about map type, setting to json causes
// browser to show as text
// https://stackoverflow.com/questions/19911929/what-mime-type-should-i-use-for-javascript-source-map-files
{".map", "application/json"}}};
std::filesystem::path rootpath{"/usr/share/www/"};
std::error_code ec;
std::filesystem::recursive_directory_iterator dirIter(rootpath, ec);
if (ec)
{
BMCWEB_LOG_ERROR(
"Unable to find or open {} static file hosting disabled",
rootpath.string());
return;
}
// In certain cases, we might have both a gzipped version of the file AND a
// non-gzipped version. To avoid duplicated routes, we need to make sure we
// get the gzipped version first. Because the gzipped path should be longer
// than the non gzipped path, if we sort in descending order, we should be
// guaranteed to get the gzip version first.
std::vector<std::filesystem::directory_entry> paths(
std::filesystem::begin(dirIter), std::filesystem::end(dirIter));
std::sort(paths.rbegin(), paths.rend());
for (const std::filesystem::directory_entry& dir : paths)
{
const std::filesystem::path& absolutePath = dir.path();
std::filesystem::path relativePath{
absolutePath.string().substr(rootpath.string().size() - 1)};
if (std::filesystem::is_directory(dir))
{
// don't recurse into hidden directories or symlinks
if (dir.path().filename().string().starts_with(".") ||
std::filesystem::is_symlink(dir))
{
dirIter.disable_recursion_pending();
}
}
else if (std::filesystem::is_regular_file(dir))
{
std::string extension = relativePath.extension();
std::filesystem::path webpath = relativePath;
const char* contentEncoding = nullptr;
if (extension == ".gz")
{
webpath = webpath.replace_extension("");
// Use the non-gzip version for determining content type
extension = webpath.extension().string();
contentEncoding = "gzip";
}
std::string etag = getStaticEtag(webpath);
bool renamed = false;
if (webpath.filename().string().starts_with("index."))
{
webpath = webpath.parent_path();
if (webpath.string().empty() || webpath.string().back() != '/')
{
// insert the non-directory version of this path
webroutes::routes.insert(webpath);
webpath += "/";
renamed = true;
}
}
std::pair<boost::container::flat_set<std::string>::iterator, bool>
inserted = webroutes::routes.insert(webpath);
if (!inserted.second)
{
// Got a duplicated path. This is expected in certain
// situations
BMCWEB_LOG_DEBUG("Got duplicated path {}", webpath.string());
continue;
}
const char* contentType = nullptr;
for (const std::pair<const char*, const char*>& ext : contentTypes)
{
if (ext.first == nullptr || ext.second == nullptr)
{
continue;
}
if (extension == ext.first)
{
contentType = ext.second;
}
}
if (contentType == nullptr)
{
BMCWEB_LOG_ERROR(
"Cannot determine content-type for {} with extension {}",
absolutePath.string(), extension);
}
if (webpath == "/")
{
forward_unauthorized::hasWebuiRoute = true;
}
app.routeDynamic(webpath)(
[absolutePath, contentType, contentEncoding, etag,
renamed](const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
if (contentType != nullptr)
{
asyncResp->res.addHeader(
boost::beast::http::field::content_type, contentType);
}
if (contentEncoding != nullptr)
{
asyncResp->res.addHeader(
boost::beast::http::field::content_encoding,
contentEncoding);
}
if (!etag.empty())
{
asyncResp->res.addHeader(boost::beast::http::field::etag,
etag);
// Don't cache paths that don't have the etag in them, like
// index, which gets transformed to /
if (!renamed)
{
// Anything with a hash can be cached forever and is
// immutable
asyncResp->res.addHeader(
boost::beast::http::field::cache_control,
"max-age=31556926, immutable");
}
std::string_view cachedEtag = req.getHeaderValue(
boost::beast::http::field::if_none_match);
if (cachedEtag == etag)
{
asyncResp->res.result(
boost::beast::http::status::not_modified);
return;
}
}
// res.set_header("Cache-Control", "public, max-age=86400");
if (!asyncResp->res.openFile(absolutePath))
{
BMCWEB_LOG_DEBUG("failed to read file");
asyncResp->res.result(
boost::beast::http::status::internal_server_error);
return;
}
});
}
}
}
} // namespace webassets
} // namespace crow
|
