xref: /openbmc/bmcweb/include/webassets.hpp (revision 262d7d4b)
1 #pragma once
2 
3 #include "webroutes.hpp"
4 
5 #include <app.hpp>
6 #include <boost/algorithm/string/replace.hpp>
7 #include <boost/container/flat_set.hpp>
8 #include <http_request.hpp>
9 #include <http_response.hpp>
10 #include <routing.hpp>
11 
12 #include <filesystem>
13 #include <fstream>
14 #include <string>
15 
16 namespace crow
17 {
18 namespace webassets
19 {
20 
21 struct CmpStr
22 {
23     bool operator()(const char* a, const char* b) const
24     {
25         return std::strcmp(a, b) < 0;
26     }
27 };
28 
29 inline void requestRoutes(App& app)
30 {
31     constexpr static std::array<std::pair<const char*, const char*>, 17>
32         contentTypes{
33             {{".css", "text/css;charset=UTF-8"},
34              {".html", "text/html;charset=UTF-8"},
35              {".js", "application/javascript;charset=UTF-8"},
36              {".png", "image/png;charset=UTF-8"},
37              {".woff", "application/x-font-woff"},
38              {".woff2", "application/x-font-woff2"},
39              {".gif", "image/gif"},
40              {".ico", "image/x-icon"},
41              {".ttf", "application/x-font-ttf"},
42              {".svg", "image/svg+xml"},
43              {".eot", "application/vnd.ms-fontobject"},
44              {".xml", "application/xml"},
45              {".json", "application/json"},
46              {".jpg", "image/jpeg"},
47              {".jpeg", "image/jpeg"},
48              {".json", "application/json"},
49              // dev tools don't care about map type, setting to json causes
50              // browser to show as text
51              // https://stackoverflow.com/questions/19911929/what-mime-type-should-i-use-for-javascript-source-map-files
52              {".map", "application/json"}}};
53 
54     std::filesystem::path rootpath{"/usr/share/www/"};
55     std::filesystem::recursive_directory_iterator dirIter(rootpath);
56     // In certain cases, we might have both a gzipped version of the file AND a
57     // non-gzipped version.  To avoid duplicated routes, we need to make sure we
58     // get the gzipped version first.  Because the gzipped path should be longer
59     // than the non gzipped path, if we sort in descending order, we should be
60     // guaranteed to get the gzip version first.
61     std::vector<std::filesystem::directory_entry> paths(
62         std::filesystem::begin(dirIter), std::filesystem::end(dirIter));
63     std::sort(paths.rbegin(), paths.rend());
64 
65     for (const std::filesystem::directory_entry& dir : paths)
66     {
67         const std::filesystem::path& absolutePath = dir.path();
68         std::filesystem::path relativePath{
69             absolutePath.string().substr(rootpath.string().size() - 1)};
70         if (std::filesystem::is_directory(dir))
71         {
72             // don't recurse into hidden directories or symlinks
73             if (boost::starts_with(dir.path().filename().string(), ".") ||
74                 std::filesystem::is_symlink(dir))
75             {
76                 dirIter.disable_recursion_pending();
77             }
78         }
79         else if (std::filesystem::is_regular_file(dir))
80         {
81             std::string extension = relativePath.extension();
82             std::filesystem::path webpath = relativePath;
83             const char* contentEncoding = nullptr;
84 
85             if (extension == ".gz")
86             {
87                 webpath = webpath.replace_extension("");
88                 // Use the non-gzip version for determining content type
89                 extension = webpath.extension().string();
90                 contentEncoding = "gzip";
91             }
92 
93             if (boost::starts_with(webpath.filename().string(), "index."))
94             {
95                 webpath = webpath.parent_path();
96                 if (webpath.string().size() == 0 ||
97                     webpath.string().back() != '/')
98                 {
99                     // insert the non-directory version of this path
100                     webroutes::routes.insert(webpath);
101                     webpath += "/";
102                 }
103             }
104 
105             std::pair<boost::container::flat_set<std::string>::iterator, bool>
106                 inserted = webroutes::routes.insert(webpath);
107 
108             if (!inserted.second)
109             {
110                 // Got a duplicated path.  This is expected in certain
111                 // situations
112                 BMCWEB_LOG_DEBUG << "Got duplicated path " << webpath;
113                 continue;
114             }
115             const char* contentType = nullptr;
116 
117             for (const std::pair<const char*, const char*>& ext : contentTypes)
118             {
119                 if (ext.first == nullptr || ext.second == nullptr)
120                 {
121                     continue;
122                 }
123                 if (extension == ext.first)
124                 {
125                     contentType = ext.second;
126                 }
127             }
128 
129             if (contentType == nullptr)
130             {
131                 BMCWEB_LOG_ERROR << "Cannot determine content-type for "
132                                  << absolutePath << " with extension "
133                                  << extension;
134             }
135 
136             app.routeDynamic(webpath)(
137                 [absolutePath, contentType,
138                  contentEncoding](const crow::Request&, crow::Response& res) {
139                     if (contentType != nullptr)
140                     {
141                         res.addHeader("Content-Type", contentType);
142                     }
143 
144                     if (contentEncoding != nullptr)
145                     {
146                         res.addHeader("Content-Encoding", contentEncoding);
147                     }
148 
149                     // res.set_header("Cache-Control", "public, max-age=86400");
150                     std::ifstream inf(absolutePath);
151                     if (!inf)
152                     {
153                         BMCWEB_LOG_DEBUG << "failed to read file";
154                         res.result(
155                             boost::beast::http::status::internal_server_error);
156                         res.end();
157                         return;
158                     }
159 
160                     res.body() = {std::istreambuf_iterator<char>(inf),
161                                   std::istreambuf_iterator<char>()};
162                     res.end();
163                 });
164         }
165     }
166 }
167 } // namespace webassets
168 } // namespace crow
169