Cutelyst::StaticSimple Class Reference

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)

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 22 of file staticsimple.cpp.

References Cutelyst::Plugin::Plugin(), and StaticSimple().

Referenced by StaticSimple(), setDirs(), setIncludePaths(), and setServeDirsOnly().

~StaticSimple()

StaticSimple::~StaticSimple ( )

overridevirtual

Destroys the StaticSimple object.

Definition at line 30 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 44 of file staticsimple.cpp.

References StaticSimple().

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 35 of file staticsimple.cpp.

References StaticSimple().

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 50 of file staticsimple.cpp.

References StaticSimple().

setup()

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

overridevirtual

Reimplemented from Plugin::setup().

Reimplemented from Cutelyst::Plugin.

Definition at line 56 of file staticsimple.cpp.

References Cutelyst::Application::beforePrepareAction().