cutelyst 3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
staticsimple.cpp
1/*
2 * SPDX-FileCopyrightText: (C) 2014-2022 Daniel Nicoletti <dantti12@gmail.com>
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5#include "application.h"
6#include "context.h"
7#include "request.h"
8#include "response.h"
9#include "staticsimple_p.h"
10
11#include <QDateTime>
12#include <QDir>
13#include <QFile>
14#include <QLoggingCategory>
15#include <QMimeDatabase>
16
17using namespace Cutelyst;
18
19Q_LOGGING_CATEGORY(C_STATICSIMPLE, "cutelyst.plugin.staticsimple", QtWarningMsg)
20
22 : Plugin(parent)
23 , d_ptr(new StaticSimplePrivate)
24{
25 Q_D(StaticSimple);
26 d->includePaths.append(parent->config(QLatin1String("root")).toString());
27}
28
29StaticSimple::~StaticSimple()
30{
31 delete d_ptr;
32}
33
35{
36 Q_D(StaticSimple);
37 d->includePaths.clear();
38 for (const QString &path : paths) {
39 d->includePaths.append(QDir(path));
40 }
41}
42
44{
45 Q_D(StaticSimple);
46 d->dirs = dirs;
47}
48
50{
51 connect(app, &Application::beforePrepareAction, this, &StaticSimple::beforePrepareAction);
52 return true;
53}
54
55void StaticSimple::beforePrepareAction(Context *c, bool *skipMethod)
56{
57 Q_D(StaticSimple);
58
59 if (*skipMethod) {
60 return;
61 }
62
63 const QString path = c->req()->path();
64 const QRegularExpression re = d->re; // Thread-safe
65
66 for (const QString &dir : d->dirs) {
67 if (path.startsWith(dir)) {
68 if (!locateStaticFile(c, path)) {
69 Response *res = c->response();
70 res->setStatus(Response::NotFound);
71 res->setContentType(QStringLiteral("text/html"));
72 res->setBody(QStringLiteral("File not found: ") + path);
73 }
74
75 *skipMethod = true;
76 return;
77 }
78 }
79
80 QRegularExpressionMatch match = re.match(path);
81 if (match.hasMatch() && locateStaticFile(c, path)) {
82 *skipMethod = true;
83 }
84}
85
86bool StaticSimple::locateStaticFile(Context *c, const QString &relPath)
87{
88 Q_D(const StaticSimple);
89
90 for (const QDir &includePath : d->includePaths) {
91 QString path = includePath.absoluteFilePath(relPath);
92 QFileInfo fileInfo(path);
93 if (fileInfo.exists()) {
94 Response *res = c->res();
95 const QDateTime currentDateTime = fileInfo.lastModified();
96 if (!c->req()->headers().ifModifiedSince(currentDateTime)) {
97 res->setStatus(Response::NotModified);
98 return true;
99 }
100
101 QFile *file = new QFile(path);
102 if (file->open(QFile::ReadOnly)) {
103 qCDebug(C_STATICSIMPLE) << "Serving" << path;
104 Headers &headers = res->headers();
105
106 // set our open file
107 res->setBody(file);
108
109 static QMimeDatabase db;
110 // use the extension to match to be faster
111 QMimeType mimeType = db.mimeTypeForFile(path, QMimeDatabase::MatchExtension);
112 if (mimeType.isValid()) {
113 headers.setContentType(mimeType.name());
114 }
115 headers.setContentLength(file->size());
116
117 headers.setLastModified(currentDateTime);
118 // Tell Firefox & friends its OK to cache, even over SSL
119 headers.setHeader(QStringLiteral("CACHE_CONTROL"), QStringLiteral("public"));
120
121 return true;
122 }
123
124 qCWarning(C_STATICSIMPLE) << "Could not serve" << path << file->errorString();
125 return false;
126 }
127 }
128
129 qCWarning(C_STATICSIMPLE) << "File not found" << relPath;
130 return false;
131}
132
133#include "moc_staticsimple.cpp"
The Cutelyst Application.
Definition application.h:43
void beforePrepareAction(Cutelyst::Context *c, bool *skipMethod)
The Cutelyst Context.
Definition context.h:39
Response * res() const noexcept
Definition context.cpp:102
Response * response() const noexcept
Definition context.cpp:96
void setLastModified(const QString &value)
Definition headers.cpp:267
void setContentLength(qint64 value)
Definition headers.cpp:167
void setContentType(const QString &contentType)
Definition headers.cpp:69
QString ifModifiedSince() const
Definition headers.cpp:200
void setHeader(const QString &field, const QString &value)
Definition headers.cpp:396
Plugin(Application *parent)
Definition plugin.cpp:12
Headers headers() const noexcept
Definition request.cpp:310
Headers & headers() noexcept
Definition response.cpp:339
void setStatus(quint16 status) noexcept
Definition response.cpp:70
void setBody(QIODevice *body)
Definition response.cpp:100
void setContentType(const QString &type)
Definition response.h:220
void setDirs(const QStringList &dirs)
virtual bool setup(Application *app) override
StaticSimple(Application *parent)
void setIncludePaths(const QStringList &paths)
The Cutelyst namespace holds all public Cutelyst API.
Definition Mainpage.dox:8
QString absoluteFilePath(const QString &fileName) const const
virtual bool open(OpenMode mode) override
virtual qint64 size() const const override
QString errorString() const const
QMimeType mimeTypeForFile(const QString &fileName, MatchMode mode) const const
bool isValid() const const
QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QObject * parent() const const
QRegularExpressionMatch match(const QString &subject, int offset, MatchType matchType, MatchOptions matchOptions) const const
bool hasMatch() const const
bool startsWith(const QString &s, Qt::CaseSensitivity cs) const const