Serve static files directly from your application. More...

#include <Cutelyst/Plugins/StaticSimple/StaticSimple>

Inheritance diagram for Cutelyst::StaticSimple:

Public Member Functions
	StaticSimple (Application *parent)

virtual	~StaticSimple () override

void	setDirs (const QStringList &dirs)

void	setIncludePaths (const QStringList &paths)

void	setServeDirsOnly (bool dirsOnly)

virtual bool	setup (Application *app) override

Public Member Functions inherited from Cutelyst::Plugin
	Plugin (Application *parent)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

Detailed Description

The StaticSimple plugin for Cutelyst can be used to serve static files from specific directories. Optionally it only serves files where the request path starts with a specific directory. Files that end with something that look like a file extension will tried to be served by this plugin.

Beside serving the file content this will also set the respective HTTP header fields Content-Type, Content-Length, Last-Modified and Cache-Control=public.

Only serve for specific request paths

You can use setDirs() to set a list of directories/paths below your web root where files should always be served by this plugin. By default, the plugin also tries to serve files from other paths when they have a file extension when they do not start with one of these paths. You can set setServeDirsOnly() to true (since Cutelyst 4.0.0) to only serve files beginning with these paths. Have a look at setDirs() to learn more.

Usage example

#include <Cutelyst/Plugins/StaticSimple/StaticSimple>
 
bool MyCutelystApp::init()
{
     // other initialization stuff
     // ...
 
     // construct a new StaticSimple plugin
     auto stat = new StaticSimple(this);
     stat->setIncludePaths({"/path/to/my/static/files"});
 
     // maybe more initialization stuff
     // ...
}

Logging category: cutelyst.plugin.staticsimple
Logging with Cutelyst

See also: StaticCompressed; Serve static files

Definition at line 60 of file staticsimple.h.

Constructor & Destructor Documentation

◆ StaticSimple()

StaticSimple::StaticSimple ( Application * parent )

Constructs a new StaticSimple object with the given parent.

Definition at line 21 of file staticsimple.cpp.

◆ ~StaticSimple()

StaticSimple::~StaticSimple ( )

overridevirtual

Destroys the StaticSimple object.

Definition at line 29 of file staticsimple.cpp.

Member Function Documentation

◆ setDirs()

void StaticSimple::setDirs ( const QStringList & dirs )

Sets a list of top-level directories below your web root that should always be served in static mode. Set setServeDirsOnly() to true to only serve files in static mode (since Cutelyst 4.0.0) if their path begins with one of the listed directories. By default, this list is empty.

If your static files for example are organized like:

/path/to/my/static/files/assets/css
/path/to/my/static/files/assets/js
...

When your include path is /path/to/my/static/files and you set "assets" to the list of dirs, requested files like /assets/css/style.css will always be tried to be served by this plugin. If these files are not found, a 404 status will be returned.

If setServeDirsOnly() is set to false (the default), the plugin will still try to serve files as static if they end with something that looks like a file extension, no matter if their request path starts with of of the dirs. Set setServeDirsOnly() to true to only serve files as static that start with paths defined here. If you would than request a file like /some/where/else/script.js it would not be tried to be found in the included directories and the dispatcher would try to find a fitting controller method for it.

See also: setServeDirsOnly()

Definition at line 43 of file staticsimple.cpp.

◆ setIncludePaths()

void StaticSimple::setIncludePaths ( const QStringList & paths )

Sets a list of directories in which to search for your static files. The directories will be searched in order and will return the first file found. Note that your root directory is not automatically added to the search path when you specify an include path.

Definition at line 34 of file staticsimple.cpp.

◆ setServeDirsOnly()

void StaticSimple::setServeDirsOnly ( bool dirsOnly )

Set this to true to only serve static files where their path begins with one of the directories set by setDirs(). The default value is false.

See also: setDirs()

Since: Cutelyst 4.0.0

Definition at line 49 of file staticsimple.cpp.

◆ setup()

bool StaticSimple::setup ( Cutelyst::Application * app )

overridevirtual

Reimplemented from Plugin::setup().

Reimplemented from Cutelyst::Plugin.

Definition at line 55 of file staticsimple.cpp.

References Cutelyst::Application::beforePrepareAction(), and QObject::connect().

Public Member Functions

Additional Inherited Members