blob: 4bcc8cb69bc40a431dd16d61e0adac16c3661d27 [file] [log] [blame]
Ed Tanous911ac312017-08-15 09:37:42 -07001#pragma once
2
Ed Tanous3ccb3ad2023-01-13 17:40:03 -08003#include "app.hpp"
4#include "http_request.hpp"
5#include "http_response.hpp"
6#include "routing.hpp"
James Feist3909dc82020-04-03 10:58:55 -07007#include "webroutes.hpp"
8
Ed Tanous911ac312017-08-15 09:37:42 -07009#include <boost/container/flat_set.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050010
James Feist4418c7f2019-04-15 11:09:15 -070011#include <filesystem>
Ed Tanous1abe55e2018-09-05 08:30:59 -070012#include <fstream>
13#include <string>
Ed Tanous911ac312017-08-15 09:37:42 -070014
Ed Tanous1abe55e2018-09-05 08:30:59 -070015namespace crow
16{
17namespace webassets
18{
Ed Tanous911ac312017-08-15 09:37:42 -070019
Ed Tanous1abe55e2018-09-05 08:30:59 -070020struct CmpStr
21{
22 bool operator()(const char* a, const char* b) const
23 {
24 return std::strcmp(a, b) < 0;
25 }
Ed Tanousba9f9a62017-10-11 16:40:35 -070026};
Ed Tanous911ac312017-08-15 09:37:42 -070027
Ed Tanous499b5b42024-04-06 08:39:18 -070028inline std::string getStaticEtag(const std::filesystem::path& webpath)
29{
30 // webpack outputs production chunks in the form:
31 // <filename>.<hash>.<extension>
32 // For example app.63e2c453.css
33 // Try to detect this, so we can use the hash as the ETAG
34 std::vector<std::string> split;
35 bmcweb::split(split, webpath.filename().string(), '.');
36 BMCWEB_LOG_DEBUG("Checking {} split.size() {}", webpath.filename().string(),
37 split.size());
38 if (split.size() < 3)
39 {
40 return "";
41 }
42
43 // get the second to last element
44 std::string hash = split.rbegin()[1];
45
46 // Webpack hashes are 8 characters long
47 if (hash.size() != 8)
48 {
49 return "";
50 }
51 // Webpack hashes only include hex printable characters
52 if (hash.find_first_not_of("0123456789abcdefABCDEF") != std::string::npos)
53 {
54 return "";
55 }
56 return std::format("\"{}\"", hash);
57}
58
Ed Tanous23a21a12020-07-25 04:45:05 +000059inline void requestRoutes(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -070060{
Ed Tanous218bd472019-10-24 10:10:07 -070061 constexpr static std::array<std::pair<const char*, const char*>, 17>
Ed Tanous1abe55e2018-09-05 08:30:59 -070062 contentTypes{
63 {{".css", "text/css;charset=UTF-8"},
64 {".html", "text/html;charset=UTF-8"},
Ed Tanous7e513892018-12-20 07:11:04 -080065 {".js", "application/javascript;charset=UTF-8"},
Ed Tanous1abe55e2018-09-05 08:30:59 -070066 {".png", "image/png;charset=UTF-8"},
67 {".woff", "application/x-font-woff"},
68 {".woff2", "application/x-font-woff2"},
69 {".gif", "image/gif"},
70 {".ico", "image/x-icon"},
71 {".ttf", "application/x-font-ttf"},
72 {".svg", "image/svg+xml"},
73 {".eot", "application/vnd.ms-fontobject"},
74 {".xml", "application/xml"},
Ed Tanous683f7272018-07-26 12:47:19 -070075 {".json", "application/json"},
Ed Tanous1abe55e2018-09-05 08:30:59 -070076 {".jpg", "image/jpeg"},
77 {".jpeg", "image/jpeg"},
Ed Tanous1abe55e2018-09-05 08:30:59 -070078 // dev tools don't care about map type, setting to json causes
79 // browser to show as text
80 // https://stackoverflow.com/questions/19911929/what-mime-type-should-i-use-for-javascript-source-map-files
81 {".map", "application/json"}}};
Ed Tanousa47f32b2019-10-24 10:08:04 -070082
83 std::filesystem::path rootpath{"/usr/share/www/"};
Ed Tanous153fdcf2021-03-04 16:43:14 -080084
85 std::error_code ec;
86
87 std::filesystem::recursive_directory_iterator dirIter(rootpath, ec);
88 if (ec)
89 {
Ed Tanous62598e32023-07-17 17:06:25 -070090 BMCWEB_LOG_ERROR(
91 "Unable to find or open {} static file hosting disabled",
92 rootpath.string());
Ed Tanous153fdcf2021-03-04 16:43:14 -080093 return;
94 }
95
Ed Tanous1abe55e2018-09-05 08:30:59 -070096 // In certain cases, we might have both a gzipped version of the file AND a
97 // non-gzipped version. To avoid duplicated routes, we need to make sure we
98 // get the gzipped version first. Because the gzipped path should be longer
Ed Tanous8b156452018-10-12 11:09:26 -070099 // than the non gzipped path, if we sort in descending order, we should be
Ed Tanous1abe55e2018-09-05 08:30:59 -0700100 // guaranteed to get the gzip version first.
Ed Tanousa47f32b2019-10-24 10:08:04 -0700101 std::vector<std::filesystem::directory_entry> paths(
102 std::filesystem::begin(dirIter), std::filesystem::end(dirIter));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700103 std::sort(paths.rbegin(), paths.rend());
Ed Tanous9dc2c4d2018-03-07 14:51:27 -0800104
Ed Tanousa47f32b2019-10-24 10:08:04 -0700105 for (const std::filesystem::directory_entry& dir : paths)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700106 {
Ed Tanous3174e4d2020-10-07 11:41:22 -0700107 const std::filesystem::path& absolutePath = dir.path();
Ed Tanousa47f32b2019-10-24 10:08:04 -0700108 std::filesystem::path relativePath{
Ed Tanous1abe55e2018-09-05 08:30:59 -0700109 absolutePath.string().substr(rootpath.string().size() - 1)};
Ed Tanousa47f32b2019-10-24 10:08:04 -0700110 if (std::filesystem::is_directory(dir))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700111 {
112 // don't recurse into hidden directories or symlinks
Ed Tanous11ba3972022-07-11 09:50:41 -0700113 if (dir.path().filename().string().starts_with(".") ||
Ed Tanousa47f32b2019-10-24 10:08:04 -0700114 std::filesystem::is_symlink(dir))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700115 {
116 dirIter.disable_recursion_pending();
117 }
Ed Tanousba9f9a62017-10-11 16:40:35 -0700118 }
Ed Tanousa47f32b2019-10-24 10:08:04 -0700119 else if (std::filesystem::is_regular_file(dir))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700120 {
121 std::string extension = relativePath.extension();
Ed Tanousa47f32b2019-10-24 10:08:04 -0700122 std::filesystem::path webpath = relativePath;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700123 const char* contentEncoding = nullptr;
Ed Tanous911ac312017-08-15 09:37:42 -0700124
Ed Tanous1abe55e2018-09-05 08:30:59 -0700125 if (extension == ".gz")
126 {
127 webpath = webpath.replace_extension("");
128 // Use the non-gzip version for determining content type
129 extension = webpath.extension().string();
130 contentEncoding = "gzip";
Ed Tanous911ac312017-08-15 09:37:42 -0700131 }
Ed Tanousba9f9a62017-10-11 16:40:35 -0700132
Ed Tanous499b5b42024-04-06 08:39:18 -0700133 std::string etag = getStaticEtag(webpath);
134
135 bool renamed = false;
Ed Tanous11ba3972022-07-11 09:50:41 -0700136 if (webpath.filename().string().starts_with("index."))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700137 {
138 webpath = webpath.parent_path();
Ed Tanous26f69762022-01-25 09:49:11 -0800139 if (webpath.string().empty() || webpath.string().back() != '/')
Ed Tanous1abe55e2018-09-05 08:30:59 -0700140 {
141 // insert the non-directory version of this path
James Feist3909dc82020-04-03 10:58:55 -0700142 webroutes::routes.insert(webpath);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700143 webpath += "/";
Ed Tanous499b5b42024-04-06 08:39:18 -0700144 renamed = true;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700145 }
Ed Tanousba9f9a62017-10-11 16:40:35 -0700146 }
147
Ed Tanous1abe55e2018-09-05 08:30:59 -0700148 std::pair<boost::container::flat_set<std::string>::iterator, bool>
James Feist3909dc82020-04-03 10:58:55 -0700149 inserted = webroutes::routes.insert(webpath);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700150
151 if (!inserted.second)
152 {
153 // Got a duplicated path. This is expected in certain
154 // situations
Ed Tanous62598e32023-07-17 17:06:25 -0700155 BMCWEB_LOG_DEBUG("Got duplicated path {}", webpath.string());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700156 continue;
157 }
158 const char* contentType = nullptr;
159
Ed Tanous218bd472019-10-24 10:10:07 -0700160 for (const std::pair<const char*, const char*>& ext : contentTypes)
161 {
162 if (ext.first == nullptr || ext.second == nullptr)
163 {
164 continue;
165 }
166 if (extension == ext.first)
167 {
168 contentType = ext.second;
169 }
170 }
171
172 if (contentType == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700173 {
Ed Tanous62598e32023-07-17 17:06:25 -0700174 BMCWEB_LOG_ERROR(
175 "Cannot determine content-type for {} with extension {}",
176 absolutePath.string(), extension);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700177 }
Ed Tanous911ac312017-08-15 09:37:42 -0700178
Ed Tanousd4b6c662021-03-10 13:29:30 -0800179 if (webpath == "/")
180 {
181 forward_unauthorized::hasWebuiRoute = true;
182 }
183
Ed Tanous1abe55e2018-09-05 08:30:59 -0700184 app.routeDynamic(webpath)(
Ed Tanous499b5b42024-04-06 08:39:18 -0700185 [absolutePath, contentType, contentEncoding, etag,
186 renamed](const crow::Request& req,
187 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700188 if (contentType != nullptr)
189 {
Ed Tanousd9f6c622022-03-17 09:12:17 -0700190 asyncResp->res.addHeader(
191 boost::beast::http::field::content_type, contentType);
Ed Tanous002d39b2022-05-31 08:59:27 -0700192 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700193
Ed Tanous002d39b2022-05-31 08:59:27 -0700194 if (contentEncoding != nullptr)
195 {
Ed Tanousd9f6c622022-03-17 09:12:17 -0700196 asyncResp->res.addHeader(
197 boost::beast::http::field::content_encoding,
198 contentEncoding);
Ed Tanous002d39b2022-05-31 08:59:27 -0700199 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700200
Ed Tanous499b5b42024-04-06 08:39:18 -0700201 if (!etag.empty())
202 {
203 asyncResp->res.addHeader(boost::beast::http::field::etag,
204 etag);
205 // Don't cache paths that don't have the etag in them, like
206 // index, which gets transformed to /
207 if (!renamed)
208 {
209 // Anything with a hash can be cached forever and is
210 // immutable
211 asyncResp->res.addHeader(
212 boost::beast::http::field::cache_control,
213 "max-age=31556926, immutable");
214 }
215
216 std::string_view cachedEtag = req.getHeaderValue(
217 boost::beast::http::field::if_none_match);
218 if (cachedEtag == etag)
219 {
220 asyncResp->res.result(
221 boost::beast::http::status::not_modified);
222 return;
223 }
224 }
225
Ed Tanous002d39b2022-05-31 08:59:27 -0700226 // res.set_header("Cache-Control", "public, max-age=86400");
Ed Tanous27b0cf92023-08-07 12:02:40 -0700227 if (!asyncResp->res.openFile(absolutePath))
Ed Tanous002d39b2022-05-31 08:59:27 -0700228 {
Ed Tanous62598e32023-07-17 17:06:25 -0700229 BMCWEB_LOG_DEBUG("failed to read file");
Ed Tanous002d39b2022-05-31 08:59:27 -0700230 asyncResp->res.result(
231 boost::beast::http::status::internal_server_error);
232 return;
233 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700234 });
Ed Tanous1abe55e2018-09-05 08:30:59 -0700235 }
Ed Tanous911ac312017-08-15 09:37:42 -0700236 }
Ed Tanous99dc9c72019-10-24 10:09:03 -0700237}
Ed Tanous1abe55e2018-09-05 08:30:59 -0700238} // namespace webassets
239} // namespace crow