Cutelyst  2.5.0
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
Cutelyst::Application Class Reference

The Cutelyst Application. More...

#include <Cutelyst/Application>

Inheritance diagram for Cutelyst::Application:
Inheritance graph
[legend]

Signals

void afterDispatch (Context *c)
 
void beforeDispatch (Context *c)
 
void beforePrepareAction (Context *c, bool *skipMethod)
 
void postForked (Application *app)
 
void preForked (Application *app)
 

Public Member Functions

 Application (QObject *parent=nullptr)
 
void addTranslator (const QLocale &locale, QTranslator *translator)
 
void addTranslator (const QString &locale, QTranslator *translator)
 
void addTranslators (const QLocale &locale, const QVector< QTranslator *> &translators)
 
QVariant config (const QString &key, const QVariant &defaultValue=QVariant()) const
 
QVariantMap config () const
 
QVector< Controller * > controllers () const
 
ComponentcreateComponentPlugin (const QString &name, QObject *parent=nullptr)
 
Dispatcherdispatcher () const
 
QVector< DispatchType * > dispatchers () const
 
Engineengine () const
 
bool inited () const
 
void loadTranslations (const QString &filename, const QString &directory=QString(), const QString &prefix=QString(), const QString &suffix=QString())
 
QVector< QLocale > loadTranslationsFromDir (const QString &filename, const QString &directory=QString(), const QString &prefix=QStringLiteral("."), const QString &suffix=QStringLiteral(".qm"))
 
QVector< QLocale > loadTranslationsFromDirs (const QString &directory, const QString &filename)
 
QString pathTo (const QString &path) const
 
QString pathTo (const QStringList &path) const
 
template<typename T >
plugin ()
 Returns the registered plugin that casts to the template type T.
 
QVector< Plugin * > plugins () const
 
QString translate (const QLocale &locale, const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
 
Viewview (const QString &name=QString()) const
 

Static Public Member Functions

static const char * cutelystVersion ()
 

Protected Member Functions

HeadersdefaultHeaders ()
 
bool enginePostFork ()
 Called by the Engine once post fork happened.
 
void handleRequest (Cutelyst::EngineRequest *request)
 Called by the Engine to handle a new Request object.
 
virtual bool init ()
 
virtual bool postFork ()
 
bool registerController (Controller *controller)
 
bool registerDispatcher (DispatchType *dispatcher)
 
bool registerPlugin (Plugin *plugin)
 
bool registerView (View *view)
 
void setConfig (const QString &key, const QVariant &value)
 
bool setup (Engine *engine)
 Called by the Engine to setup the internal data.
 

Friends

class Context
 
class Engine
 

Detailed Description

This is the main class of a Cutelyst appplication

Definition at line 55 of file application.h.

Constructor & Destructor Documentation

◆ Application()

Application::Application ( QObject *  parent = nullptr)
explicit

The constructor is used to setup the class configuration, subclasses should only use this for objects that do not require configuration to be ready.

A Web Engine will instantiate your application through this class, next it will load the settings file, and in the end it will call init() which is where your application should do it's own setup.

Warning
DO NOT register your controllers, plugins or anything that might want to use config() in here, do that in init()

Definition at line 60 of file application.cpp.

References loadTranslations().

Member Function Documentation

◆ addTranslator() [1/2]

void Application::addTranslator ( const QLocale &  locale,
QTranslator *  translator 
)

Adds a translator for the specified locale.

You can add multiple translators for different application parts for every supported locale. The installed translators will then be used by Context::translate() (what itself will use Application::translate()) to translate strings according to the locale set by Context::setLocale().

Usage example:
bool MyCutelystApp::init()
{
// ...
auto trans = new QTranslator(this);
QLocale deDE(QLocale::German, QLocale::Germany);
if (trans->load(deDE, QStringLiteral("mycutelystapp"), QStringLiteral("."), QStringLiteral("/usr/share/mycutelystapp/l10n")) {
addTranslator(deDE, trans);
}
// ...
}
See also
loadTranslations()
Since
Cutelyst 1.5.0

Definition at line 444 of file application.cpp.

Referenced by addTranslator(), loadTranslationsFromDir(), and loadTranslationsFromDirs().

◆ addTranslator() [2/2]

void Application::addTranslator ( const QString &  locale,
QTranslator *  translator 
)

Adds a translator for the specified locale.

The locale string has to be parseable by QLocale.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since
Cutelyst 1.5.0

Definition at line 456 of file application.cpp.

References addTranslator().

◆ addTranslators()

void Application::addTranslators ( const QLocale &  locale,
const QVector< QTranslator *> &  translators 
)

Adds multiple translators for the specified locale.

See also
addTranslator()
Since
Cutelyst 1.5.0

Definition at line 461 of file application.cpp.

◆ afterDispatch

void Cutelyst::Application::afterDispatch ( Context c)
signal

This signal is emitted right after the Action found by the dispatcher got executed.

Referenced by Cutelyst::SessionStoreFile::deleteExpiredSessions(), handleRequest(), Cutelyst::MemcachedSessionStore::setGroupKey(), and Cutelyst::Session::setup().

◆ beforeDispatch

void Cutelyst::Application::beforeDispatch ( Context c)
signal

This signal is emitted right after the Dispatcher returns the Action that will be executed.

Referenced by handleRequest(), and Cutelyst::CSRFProtection::setup().

◆ beforePrepareAction

void Cutelyst::Application::beforePrepareAction ( Context c,
bool *  skipMethod 
)
signal

This signal is emitted before the Dispatcher is called to find an action. It's useful if you need to intercept requests before they are dispached. Always check skipMethod and return if it's true. In case you want to stop further processing set skipMethod to true.

Referenced by handleRequest(), Cutelyst::StaticSimple::setup(), Cutelyst::StaticCompressed::setup(), and Cutelyst::LangSelect::setup().

◆ config() [1/2]

QVariant Application::config ( const QString &  key,
const QVariant &  defaultValue = QVariant() 
) const

Returns application config specified by key, with a possible default value.

Definition at line 185 of file application.cpp.

Referenced by Cutelyst::ViewEmail::ViewEmail().

◆ config() [2/2]

QVariantMap Application::config ( ) const

User configuration for the application

Returns
A variant hash with configuration settings

Definition at line 213 of file application.cpp.

Referenced by loadTranslationsFromDirs(), and pathTo().

◆ controllers()

QVector< Cutelyst::Controller * > Application::controllers ( ) const

Returns a list with all registered controllers.

The list might only be complete after application has been setup.

Definition at line 173 of file application.cpp.

Referenced by enginePostFork(), and setup().

◆ createComponentPlugin()

Component * Application::createComponentPlugin ( const QString &  name,
QObject *  parent = nullptr 
)

Tries to load a plugin in Cutelyst default plugin directory with parent as it's parent. A nullptr is returned in case of failure.

Definition at line 144 of file application.cpp.

References Cutelyst::ComponentFactory::createComponent().

◆ cutelystVersion()

const char * Application::cutelystVersion ( )
static

Returns cutelyst version.

Definition at line 168 of file application.cpp.

Referenced by setup().

◆ defaultHeaders()

Headers & Application::defaultHeaders ( )
protected

This is the HTTP default response headers that each request gets

Do not change it after the application has started.

Definition at line 94 of file application.cpp.

Referenced by Cutelyst::Context::Context().

◆ dispatcher()

Dispatcher * Application::dispatcher ( ) const

Returns the dispatcher class.

Definition at line 195 of file application.cpp.

◆ dispatchers()

QVector< Cutelyst::DispatchType * > Application::dispatchers ( ) const

Returns a list with all registered dispachers.

The list might only be complete after application has been setup.

Definition at line 201 of file application.cpp.

◆ engine()

Cutelyst::Engine * Cutelyst::Application::engine ( ) const

◆ init()

bool Application::init ( )
protectedvirtual

Do your application initialization here, if your application should not proceed log some information that might help on debuggin and return false

For example if your application only works with PostgeSQL and the Qt driver is not available it makes sense to fail here. However you should not initialize resouces that cannot be shared among process.

See also
postFork
Returns
true if your application was successfuly initted

Definition at line 82 of file application.cpp.

Referenced by setup().

◆ inited()

bool Cutelyst::Application::inited ( ) const

Returns true if the application has been inited.

Definition at line 231 of file application.cpp.

◆ loadTranslations()

void Application::loadTranslations ( const QString &  filename,
const QString &  directory = QString(),
const QString &  prefix = QString(),
const QString &  suffix = QString() 
)

Loads translations for a specific filename from a single directory.

This can be used to load translations for a specific component if the translation file names follow a common schema. Let us assume you organised your translation files as follows:

  • /usr/share/myapp/translations/myapp_de.qm
  • /usr/share/myapp/translations/myapp_pt_BR.qm
  • ...

You can then use loadTranslations() in your reimplementation of Application::init() as follows:

bool MyApp::init()
{
loadTranslations(QStringLiteral("myapp"), QStringLiteral("/usr/share/myapp/translations"), QStringLiteral("_"));
}

If directory is empty, the default directory, set by -DI18NDIR, will be used. prefix is the part between the file name and the locale part. In the example above it is "_", if it is not set the default "." will be used. The suffix is the file name suffix that defaults to ".qm".

See also
addTranslator(), loadTranslationsFromDir(), loadTranslationsFromDirs()
Since
Cuteylst 2.0.0

Definition at line 531 of file application.cpp.

References loadTranslationsFromDir().

Referenced by Application(), Cutelyst::Validator::loadTranslations(), Cutelyst::CSRFProtection::setup(), and Cutelyst::Memcached::setup().

◆ loadTranslationsFromDir()

QVector< QLocale > Application::loadTranslationsFromDir ( const QString &  filename,
const QString &  directory = QString(),
const QString &  prefix = QStringLiteral("."),
const QString &  suffix = QStringLiteral(".qm") 
)

Loads translations for a specific filename from a single directory and returns a list of added locales.

This can be used to load translations for a specific component if the translation file names follow a common schema. Let us assume you organised your translation files as follows:

  • /usr/share/myapp/translations/myapp_de.qm
  • /usr/share/myapp/translations/myapp_pt_BR.qm
  • ...

You can then use loadTranslationsFromDir() in your reimplementation of Application::init() as follows:

bool MyApp::init()
{
loadTranslationsFromDir(QStringLiteral("myapp"), QStringLiteral("/usr/share/myapp/translations"), QStringLiteral("_"));
}

If directory is empty, the default directory, set by -DI18NDIR, will be used. prefix is the part between the file name and the locale part. In the example above it is "_", if it is not set the default "." will be used. The suffix is the file name suffix that defaults to ".qm".

See also
addTranslator(), loadTranslationsFromDirs()
Since
Cuteylst 2.1.0

Definition at line 536 of file application.cpp.

References addTranslator().

Referenced by loadTranslations().

◆ loadTranslationsFromDirs()

QVector< QLocale > Application::loadTranslationsFromDirs ( const QString &  directory,
const QString &  filename 
)

Loads translations for a specific filename from a directory structure under directory and returns a list of added locales.

This can be used to load translations for a specific component or application if the the translation files are organized in subdirectories named after locale codes. Let us assume you organised your translation files as follows:

  • /usr/share/locale/de/LC_MESSAGES/myapp.qm
  • /usr/share/locale/pt_BR/LC_MESSAGES/myapp.qm
  • ...

You can then use loadTranslationsFromDirs() in your reimplementation of Application::init() as follows:

bool MyApp::init()
{
loadTranslationsFromDirs(QStringLiteral("/usr/share/locale"), QStringLiteral("LC_MESSAGES/myapp.qm"));
}
See also
addTranslator(), loadTranslationsFromDir()
Since
Cutelyst 2.1.0

Definition at line 584 of file application.cpp.

References Cutelyst::Request::addressString(), addTranslator(), Cutelyst::Request::bodyParameters(), config(), Cutelyst::ComponentFactory::createComponent(), plugin(), plugins(), Cutelyst::Request::queryParameters(), Cutelyst::Request::uploads(), and view().

◆ pathTo() [1/2]

QString Application::pathTo ( const QString &  path) const

Merges path with config("HOME") and returns an absolute path.

Definition at line 219 of file application.cpp.

References config().

◆ pathTo() [2/2]

QString Cutelyst::Application::pathTo ( const QStringList &  path) const

Merges path with config("HOME") and returns an absolute path.

Definition at line 225 of file application.cpp.

References config().

◆ plugins()

QVector< Plugin * > Application::plugins ( ) const

Returns all registered plugins

Definition at line 207 of file application.cpp.

Referenced by loadTranslationsFromDirs(), and setup().

◆ postFork()

bool Application::postFork ( )
protectedvirtual

This method is called after the engine forks

After the web engine forks itself it will call this function so that you can initialize resources that can't be shared with the parent process, namely sockets and file descriptors.

A good example of usage of this function is when openning a connection to the database which can't be shared with other process and should probably make this function return false if it fails to open.

Default implementation returns true.

Returns
False if the engine should not use this process

Definition at line 88 of file application.cpp.

Referenced by enginePostFork().

◆ postForked

void Cutelyst::Application::postForked ( Application app)
signal

◆ preForked

void Cutelyst::Application::preForked ( Application app)
signal

This signal is emitted right after application has been setup and before application forks and

See also
postFork() is called.

Referenced by setup().

◆ registerController()

bool Application::registerController ( Controller controller)
protected

This method registers a Controller class which is responsible for handlying Requests, since they are reused between multiple requests beaware of not storing data there, instead you might want to use a session plugin or the stash.

Parameters
controllerthe Controller class
Returns
true if succeeded

Definition at line 110 of file application.cpp.

◆ registerDispatcher()

bool Application::registerDispatcher ( DispatchType dispatcher)
protected

Registers a custom DispatchType, if none is registered all the built-in dispatchers types will be registered

Definition at line 134 of file application.cpp.

◆ registerPlugin()

bool Application::registerPlugin ( Plugin plugin)
protected

Registers a global plugin ie one that doesn't need to be created explicity for a single request and returns true on plugin->isApplicationPlugin();

Returns
true if the plugin could be registered

Definition at line 100 of file application.cpp.

◆ registerView()

bool Application::registerView ( View view)
protected

This method registers a View class which is responsible for rendering requests.

Parameters
viewthe View class
Returns
true if succeeded

Definition at line 122 of file application.cpp.

References Cutelyst::Component::name(), and view().

◆ setConfig()

void Application::setConfig ( const QString &  key,
const QVariant &  value 
)
protected

Change the value of the configuration key You should never call this from random parts of the code as a way to store shareable data, it should only be called by a subclass

Definition at line 243 of file application.cpp.

◆ translate()

QString Application::translate ( const QLocale &  locale,
const char *  context,
const char *  sourceText,
const char *  disambiguation = nullptr,
int  n = -1 
) const

Translates the sourceText into the target locale language.

This uses the installed translators for the specified locale to translate the sourceText for the given context into the target locale. Optionally you can use a disambiguation and/or the n parameter to translate a pluralized version.

See also
Context::translate(), QTranslator::translate()
Since
Cutelyst 1.5.0

Definition at line 499 of file application.cpp.

◆ view()

View * Application::view ( const QString &  name = QString()) const

Returns the view specified by name, if no view is found nullptr is returned.

Definition at line 179 of file application.cpp.

Referenced by Cutelyst::RenderView::init(), loadTranslationsFromDirs(), registerView(), and setup().