5#include "application_p.h"
10#include "controller_p.h"
11#include "dispatchtype.h"
16#include "response_p.h"
21#include <QJsonDocument>
22#include <QtCore/QCoreApplication>
23#include <QtCore/QDataStream>
25#include <QtCore/QFileInfo>
26#include <QtCore/QLocale>
27#include <QtCore/QPluginLoader>
28#include <QtCore/QStringList>
29#include <QtCore/QTranslator>
31Q_LOGGING_CATEGORY(CUTELYST_DISPATCHER,
"cutelyst.dispatcher", QtWarningMsg)
32Q_LOGGING_CATEGORY(CUTELYST_DISPATCHER_PATH,
"cutelyst.dispatcher.path", QtWarningMsg)
33Q_LOGGING_CATEGORY(CUTELYST_DISPATCHER_CHAINED,
"cutelyst.dispatcher.chained", QtWarningMsg)
34Q_LOGGING_CATEGORY(CUTELYST_CONTROLLER,
"cutelyst.controller", QtWarningMsg)
35Q_LOGGING_CATEGORY(CUTELYST_CORE,
"cutelyst.core", QtWarningMsg)
36Q_LOGGING_CATEGORY(CUTELYST_ENGINE,
"cutelyst.engine", QtWarningMsg)
37Q_LOGGING_CATEGORY(CUTELYST_UPLOAD,
"cutelyst.upload", QtWarningMsg)
38Q_LOGGING_CATEGORY(CUTELYST_MULTIPART,
"cutelyst.multipart", QtWarningMsg)
39Q_LOGGING_CATEGORY(CUTELYST_VIEW,
"cutelyst.view", QtWarningMsg)
40Q_LOGGING_CATEGORY(CUTELYST_REQUEST,
"cutelyst.request", QtWarningMsg)
41Q_LOGGING_CATEGORY(CUTELYST_RESPONSE,
"cutelyst.response", QtWarningMsg)
42Q_LOGGING_CATEGORY(CUTELYST_STATS,
"cutelyst.stats", QtWarningMsg)
43Q_LOGGING_CATEGORY(CUTELYST_COMPONENT,
"cutelyst.component", QtWarningMsg)
46using namespace Qt::Literals::StringLiterals;
50 , d_ptr(new ApplicationPrivate)
56 qRegisterMetaType<ParamsMultiMap>();
70 qCDebug(CUTELYST_CORE) <<
"Default Application::init called on pid:"
71 << QCoreApplication::applicationPid();
77 qCDebug(CUTELYST_CORE) <<
"Default Application::postFork called on pid:"
78 << QCoreApplication::applicationPid();
91 d->headers.setHeader(
"X-Cutelyst"_ba, QByteArrayLiteral(CUTELYST_VERSION));
97 if (d->plugins.contains(
plugin)) {
100 d->plugins.append(
plugin);
107 const auto name = QString::fromLatin1(controller->metaObject()->className());
108 if (d->controllersHash.contains(name)) {
111 d->controllersHash.insert(name, controller);
112 d->controllers.append(controller);
119 if (d->views.contains(
view->name())) {
120 qCWarning(CUTELYST_CORE) <<
"Not registering View." <<
view->metaObject()->className()
121 <<
"There is already a view with this name:" <<
view->name();
124 d->views.insert(
view->name(),
view);
142 auto it = d->factories.constFind(name);
143 if (it != d->factories.constEnd()) {
152 const QByteArrayList dirs = QByteArrayList{QByteArrayLiteral(CUTELYST_PLUGINS_DIR)} +
153 qgetenv(
"CUTELYST_PLUGINS_DIR").split(
';');
154 for (
const QByteArray &dir : dirs) {
155 Component *component = d->createComponentPlugin(name, parent, QString::fromLocal8Bit(dir));
160 qCDebug(CUTELYST_CORE) <<
"Did not find plugin" << name <<
"on" << dirs <<
"for" << parent;
167 return CUTELYST_VERSION;
173 return d->controllers;
179 return d->views.value(name);
185 auto it = d->config.constFind(key);
186 if (it != d->config.constEnd()) {
195 return d->dispatcher;
201 return d->dispatcher->dispatchers();
218 QDir home =
config(u
"home"_s).toString();
219 return home.absoluteFilePath(path);
224 QDir home =
config(u
"home"_s).toString();
225 return home.absoluteFilePath(path.join(u
'/'));
243 d->config.insert(key, value);
255 d->useStats = CUTELYST_STATS().isDebugEnabled();
257 d->config =
engine->config(QLatin1String(
"Cutelyst"));
264 d->setupChildren(children());
266 bool zeroCore =
engine->workerCore() == 0;
268 QVector<QStringList> tablePlugins;
269 const auto plugins = d->plugins;
271 if (
plugin->objectName().isEmpty()) {
272 plugin->setObjectName(QString::fromLatin1(
plugin->metaObject()->className()));
274 tablePlugins.append({
plugin->objectName()});
279 if (zeroCore && !tablePlugins.isEmpty()) {
280 qCDebug(CUTELYST_CORE)
281 << Utils::buildTable(tablePlugins, QStringList(), QLatin1String(
"Loaded plugins:"))
286 QVector<QStringList> tableDataHandlers;
287 tableDataHandlers.append({u
"application/x-www-form-urlencoded"_s});
288 tableDataHandlers.append({u
"application/json"_s});
289 tableDataHandlers.append({u
"multipart/form-data"_s});
290 qCDebug(CUTELYST_CORE)
291 << Utils::buildTable(tableDataHandlers,
293 QLatin1String(
"Loaded Request Data Handlers:"))
296 qCDebug(CUTELYST_CORE) <<
"Loaded dispatcher"
297 << QString::fromLatin1(d->dispatcher->metaObject()->className());
298 qCDebug(CUTELYST_CORE)
299 <<
"Using engine" << QString::fromLatin1(d->engine->metaObject()->className());
302 QString home = d->config.value(u
"home"_s).toString();
303 if (home.isEmpty()) {
305 qCDebug(CUTELYST_CORE) <<
"Couldn't find home";
308 QFileInfo homeInfo(home);
309 if (homeInfo.isDir()) {
311 qCDebug(CUTELYST_CORE) <<
"Found home" << home;
315 qCDebug(CUTELYST_CORE) <<
"Home" << home <<
"doesn't exist";
320 QVector<QStringList> table;
321 QStringList controllerNames = d->controllersHash.keys();
322 controllerNames.sort();
323 for (
const QString &controller : controllerNames) {
324 table.append({controller, QLatin1String(
"Controller")});
327 const auto views = d->views;
329 if (
view->reverse().isEmpty()) {
330 const QString className = QString::fromLatin1(
view->metaObject()->className()) +
331 QLatin1String(
"->execute");
332 view->setReverse(className);
334 table.append({
view->reverse(), QLatin1String(
"View")});
337 if (zeroCore && !table.isEmpty()) {
338 qCDebug(CUTELYST_CORE)
339 << Utils::buildTable(table,
340 {QLatin1String(
"Class"), QLatin1String(
"Type")},
341 QLatin1String(
"Loaded components:"))
347 controller->d_ptr->init(
this, d->dispatcher);
350 d->dispatcher->setupActions(d->controllers, d->dispatchers, d->engine->workerCore() == 0);
353 qCInfo(CUTELYST_CORE) << qPrintable(
354 QString::fromLatin1(
"%1 powered by Cutelyst %2, Qt %3.")
355 .arg(QCoreApplication::applicationName(),
357 QLatin1String(qVersion())));
372 Engine *
engine = d->engine;
374 auto priv =
new ContextPrivate(
this,
engine, d->dispatcher, d->plugins);
375 auto c =
new Context(priv);
378 priv->engineRequest = request;
379 priv->response =
new Response(d->headers, request);
380 priv->request =
new Request(request);
381 priv->locale = d->defaultLocale;
384 priv->stats =
new Stats(request);
388 bool skipMethod =
false;
392 static bool log = CUTELYST_REQUEST().isEnabled(QtDebugMsg);
394 d->logRequest(priv->request);
397 d->dispatcher->prepareAction(c);
401 d->dispatcher->dispatch(c);
403 if (request->
status & EngineRequest::Async) {
423 if (!controller->postFork(
this)) {
436 Q_ASSERT_X(translator,
"add translator to application",
"invalid QTranslator object");
437 auto it = d->translators.find(locale);
438 if (it != d->translators.end()) {
439 it.value().prepend(translator);
441 d->translators.insert(locale, QVector<QTranslator *>(1, translator));
453 Q_ASSERT_X(!translators.empty(),
"add translators to application",
"empty translators vector");
454 auto transIt = d->translators.find(locale);
455 if (transIt != d->translators.end()) {
456 for (
auto it = translators.crbegin(); it != translators.crend(); ++it) {
457 transIt.value().prepend(*it);
460 d->translators.insert(locale, translators);
464static void replacePercentN(QString *result,
int n)
469 while ((percentPos = result->indexOf(u
'%', percentPos + len)) != -1) {
472 if (result->at(percentPos + len) == u
'L') {
474 fmt = QStringLiteral(
"%L1");
476 fmt = QStringLiteral(
"%1");
478 if (result->at(percentPos + len) == u
'n') {
481 result->replace(percentPos, len, fmt);
490 const char *sourceText,
491 const char *disambiguation,
502 const QVector<QTranslator *> translators = d->translators.value(locale);
503 if (translators.empty()) {
504 result = QString::fromUtf8(sourceText);
505 replacePercentN(&result, n);
509 for (QTranslator *translator : translators) {
510 result = translator->translate(context, sourceText, disambiguation, n);
511 if (!result.isEmpty()) {
516 if (result.isEmpty()) {
517 result = QString::fromUtf8(sourceText);
520 replacePercentN(&result, n);
525 const QString &directory,
526 const QString &prefix,
527 const QString &suffix)
533 const QString &directory,
534 const QString &prefix,
535 const QString &suffix)
537 QVector<QLocale> locales;
539 if (Q_LIKELY(!filename.isEmpty())) {
540 const QString _dir = directory.isEmpty() ? QStringLiteral(CUTELYST_I18N_DIR) : directory;
541 const QDir i18nDir(_dir);
542 if (Q_LIKELY(i18nDir.exists())) {
543 const QString _prefix = prefix.isEmpty() ? QStringLiteral(
".") : prefix;
544 const QString _suffix = suffix.isEmpty() ? QStringLiteral(
".qm") : suffix;
545 const QStringList namesFilter = QStringList({filename + _prefix + u
'*' + _suffix});
547 const QFileInfoList tsFiles = i18nDir.entryInfoList(namesFilter, QDir::Files);
548 if (Q_LIKELY(!tsFiles.empty())) {
549 locales.reserve(tsFiles.size());
550 for (
const QFileInfo &ts : tsFiles) {
551 const QString fn = ts.fileName();
552 const int prefIdx = fn.indexOf(_prefix);
553 const QString locString =
554 fn.mid(prefIdx + _prefix.length(),
555 fn.length() - prefIdx - _suffix.length() - _prefix.length());
556 QLocale loc(locString);
557 if (Q_LIKELY(loc.language() != QLocale::C)) {
558 auto trans =
new QTranslator(
this);
559 if (Q_LIKELY(trans->load(loc, filename, _prefix, _dir))) {
562 qCDebug(CUTELYST_CORE) <<
"Loaded translations for" << loc <<
"from"
563 << ts.absoluteFilePath();
566 qCWarning(CUTELYST_CORE) <<
"Can not load translations for" << loc
567 <<
"from" << ts.absoluteFilePath();
570 qCWarning(CUTELYST_CORE)
571 <<
"Can not load translations for invalid locale string" << locString;
576 qCWarning(CUTELYST_CORE)
577 <<
"Can not find translation files for" << filename <<
"in directory" << _dir;
580 qCWarning(CUTELYST_CORE)
581 <<
"Can not load translations from not existing directory:" << _dir;
584 qCWarning(CUTELYST_CORE) <<
"Can not load translations for empty file name.";
591 const QString &filename)
593 QVector<QLocale> locales;
595 if (Q_LIKELY(!directory.isEmpty() && !filename.isEmpty())) {
596 const QDir dir(directory);
597 if (Q_LIKELY(dir.exists())) {
598 const auto dirs = dir.entryList(QDir::AllDirs);
599 if (Q_LIKELY(!dirs.empty())) {
600 locales.reserve(dirs.size());
601 for (
const QString &subDir : dirs) {
602 const QString relFn = subDir + u
'/' + filename;
603 if (dir.exists(relFn)) {
604 const QLocale l(subDir);
605 if (Q_LIKELY(l.language() != QLocale::C)) {
606 auto trans =
new QTranslator(
this);
607 const QFileInfo fi(dir, relFn);
608 if (Q_LIKELY(trans->load(
609 l, fi.baseName(), QString(), fi.absolutePath(), fi.suffix()))) {
612 qCDebug(CUTELYST_CORE) <<
"Loaded translations for" << l <<
"from"
613 << fi.absoluteFilePath();
616 qCWarning(CUTELYST_CORE) <<
"Can not load translations for" << l
617 <<
"from" << fi.absoluteFilePath();
620 qCWarning(CUTELYST_CORE)
621 <<
"Can not load translations for invalid locale string:" << subDir;
627 qCWarning(CUTELYST_CORE) <<
"Can not find locale dirs under" << directory;
630 qCWarning(CUTELYST_CORE)
631 <<
"Can not load translations from not existing directory:" << directory;
634 qCWarning(CUTELYST_CORE)
635 <<
"Can not load translations for empty file name or directory name";
644 return d->defaultLocale;
650 d->defaultLocale = locale;
653void Cutelyst::ApplicationPrivate::setupHome()
656 if (!config.contains(QLatin1String(
"home"))) {
657 config.insert(QStringLiteral(
"home"), QDir::currentPath());
660 if (!config.contains(QLatin1String(
"root"))) {
661 QDir home = config.value(QLatin1String(
"home")).toString();
662 config.insert(QStringLiteral(
"root"), home.absoluteFilePath(QLatin1String(
"root")));
666void ApplicationPrivate::setupChildren(
const QObjectList &children)
669 for (QObject *child : children) {
670 auto controller = qobject_cast<Controller *>(child);
672 q->registerController(controller);
676 auto plugin = qobject_cast<Plugin *>(child);
678 q->registerPlugin(plugin);
682 auto view = qobject_cast<View *>(child);
684 q->registerView(view);
688 auto dispatchType = qobject_cast<DispatchType *>(child);
690 q->registerDispatcher(dispatchType);
696void Cutelyst::ApplicationPrivate::logRequest(
Request *req)
698 QString path = req->path();
699 if (path.isEmpty()) {
700 path = QStringLiteral(
"/");
702 qCDebug(CUTELYST_REQUEST) << req->method() <<
"request for" << path <<
"from"
706 if (!params.isEmpty()) {
707 logRequestParameters(params, QLatin1String(
"Query Parameters are:"));
711 if (!params.isEmpty()) {
712 logRequestParameters(params, QLatin1String(
"Body Parameters are:"));
715 const auto bodyData = req->bodyData();
716 if (bodyData.typeId() == QMetaType::QJsonDocument) {
717 const auto doc = bodyData.toJsonDocument();
718 qCDebug(CUTELYST_REQUEST).noquote() <<
"JSON body:\n"
719 << doc.toJson(QJsonDocument::Indented);
722 const auto uploads = req->
uploads();
723 if (!uploads.isEmpty()) {
724 logRequestUploads(uploads);
728void Cutelyst::ApplicationPrivate::logRequestParameters(
const ParamsMultiMap ¶ms,
729 const QString &title)
731 QVector<QStringList> table;
732 auto it = params.constBegin();
733 while (it != params.constEnd()) {
734 table.append({it.key(), it.value()});
737 qCDebug(CUTELYST_REQUEST) << Utils::buildTable(table,
739 QLatin1String(
"Parameter"),
740 QLatin1String(
"Value"),
746void Cutelyst::ApplicationPrivate::logRequestUploads(
const QVector<Cutelyst::Upload *> &uploads)
748 QVector<QStringList> table;
749 for (
Upload *upload : uploads) {
750 table.append({upload->name(),
752 QString::fromLatin1(upload->contentType()),
753 QString::number(upload->size())});
755 qCDebug(CUTELYST_REQUEST) << Utils::buildTable(table,
757 QLatin1String(
"Parameter"),
758 QLatin1String(
"Filename"),
759 QLatin1String(
"Type"),
760 QLatin1String(
"Size"),
762 QLatin1String(
"File Uploads are:"))
766Component *ApplicationPrivate::createComponentPlugin(
const QString &name,
768 const QString &directory)
773 auto matchMetadata = [name](
const QJsonObject &metadata) {
774 const QJsonObject json = metadata[u
"MetaData"].toObject();
775 qCDebug(CUTELYST_CORE) <<
"Found plugin metadata" << json;
776 return json[u
"name"].toString() == name;
779 auto createComponent = [name, parent, &factory](QObject *plugin) ->
Component * {
780 factory = qobject_cast<ComponentFactory *>(plugin);
788 const QList<QStaticPlugin> &staticPlugins = QPluginLoader::staticPlugins();
789 for (
const QStaticPlugin &plugin : staticPlugins) {
790 if (matchMetadata(plugin.metaData())) {
791 component = createComponent(plugin.instance());
796 qCCritical(CUTELYST_CORE)
797 <<
"Could not create a component for static plugin" << plugin.metaData();
801 if (factory && component) {
802 factories.insert(name, factory);
806 QDir pluginsDir(directory);
807 QPluginLoader loader;
808 const auto plugins = pluginsDir.entryList(QDir::Files);
809 for (
const QString &fileName : plugins) {
810 loader.setFileName(pluginsDir.absoluteFilePath(fileName));
812 if (matchMetadata(loader.metaData())) {
813 component = createComponent(loader.instance());
818 qCCritical(CUTELYST_CORE)
819 <<
"Could not create a component for plugin" << fileName << loader.metaData();
824 factories.insert(name, factory);
830#include "moc_application.cpp"
The Cutelyst application.
Engine * engine() const noexcept
QVector< Controller * > controllers() const noexcept
void afterDispatch(Cutelyst::Context *c)
bool setup(Engine *engine)
void handleRequest(Cutelyst::EngineRequest *request)
void beforePrepareAction(Cutelyst::Context *c, bool *skipMethod)
Application(QObject *parent=nullptr)
void setConfig(const QString &key, const QVariant &value)
QVariantMap config() const noexcept
Dispatcher * dispatcher() const noexcept
bool registerPlugin(Plugin *plugin)
bool registerController(Controller *controller)
bool registerDispatcher(DispatchType *dispatcher)
QString pathTo(const QString &path) const
Headers & defaultHeaders() noexcept
QString translate(const QLocale &locale, const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
View * view(QStringView name={}) const
bool inited() const noexcept
void beforeDispatch(Cutelyst::Context *c)
void preForked(Cutelyst::Application *app)
void setDefaultLocale(const QLocale &locale)
QVector< Plugin * > plugins() const noexcept
void addTranslator(const QLocale &locale, QTranslator *translator)
QLocale defaultLocale() const noexcept
bool registerView(View *view)
void addTranslators(const QLocale &locale, const QVector< QTranslator * > &translators)
QVector< DispatchType * > dispatchers() const noexcept
static const char * cutelystVersion() noexcept
QVector< QLocale > loadTranslationsFromDirs(const QString &directory, const QString &filename)
void addXCutelystVersionHeader()
Component * createComponentPlugin(const QString &name, QObject *parent=nullptr)
void loadTranslations(const QString &filename, const QString &directory={}, const QString &prefix={}, const QString &suffix={})
QVariant config(const QString &key, const QVariant &defaultValue={}) const
QVector< QLocale > loadTranslationsFromDir(const QString &filename, const QString &directory=QString(), const QString &prefix=QStringLiteral("."), const QString &suffix=QStringLiteral(".qm"))
void postForked(Cutelyst::Application *app)
virtual Component * createComponent(QObject *parent=nullptr)=0
The Cutelyst Component base class.
Cutelyst Controller base class.
Abstract class to described a dispatch type.
Base class for Cutelyst Plugins.
QString addressString() const
QVector< Upload * > uploads() const
ParamsMultiMap bodyParameters() const
ParamsMultiMap queryParameters() const
Cutelyst Upload handles file upload requests.
Abstract View component for Cutelyst.
QMultiMap< QString, QString > ParamsMultiMap
The Cutelyst namespace holds all public Cutelyst API.