Serve static files compressed on the fly or pre-compressed. More...

#include <Cutelyst/Plugins/StaticCompressed/StaticCompressed>

Inheritance diagram for Cutelyst::StaticCompressed:

[legend]

Public Member Functions
	StaticCompressed (Application *parent)

	StaticCompressed (Application *parent, const QVariantMap &defaultConfig)

	~StaticCompressed () override

void	setDirs (const QStringList &dirs)

void	setIncludePaths (const QStringList &paths)

void	setServeDirsOnly (bool dirsOnly)

bool	setup (Application *app) override

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

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

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_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	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	signalsBlocked () const const

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

int	startTimer (std::chrono::milliseconds time, 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 StaticCompressed plugin for Cutelyst can be used to serve specific static files like CSS and JavaScript files compressed. It has built in support for gzip and DEFLATE compression format and can be extended by external libraries to support the Brotli compression algorithm and to use Zopfli for gzip compression. Beside compressing the raw data on the fly and store the result in a cache directory, it supports pre-compressed files distinguished by file extension in the static source directories. The plugin uses the Accept-Encoding HTTP request header to determine the compression methods supported by the user agent. If you do not need this, use the StaticSimple plugin to serve your static files.

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

Compression formats

Support for gzip and DEFLATE compression format is built in by using the qCompress() function. To enable suport for Brotli, build with -DPLUGIN_STATICCOMPRESSED_BROTLI:BOOL=ON and have the libbrotlienc development and header files available.

To use Zopfli for the gzip compression, build with -DPLUGIN_STATICCOMPRESSED_ZOPFLI:BOOL=ON and have the libzopfli development and header files available. Also set the configuration key use_zopfli to true. Be aware that Zopfli gives better compression rate than default gzip but is also much slower. So Zopfli is disabled by default even if it is enabled at compilation time.

On the fly compression

Static files of the configured mime_types or with the configured suffixes can be compressed on the fly into a format that is accepted by the requesting user agent. The compressed data is saved into files in the cache_diretory specified in the configuration. The cache file name will be the MD5 hash sum of the original local file path together with the file extension indicating the compression format (.br for Brotli, .gz for gzip/Zopfli and .deflate for DEFLATE). If the modification time of the original file is newer than the modification time of the cached compressed file, the file will be compressed again. It is safe to clean the content of the cache directory - the files will then be recompressed on the next request. On the fly compression can be disabled by setting on_the_fly_compression to false in the configuration file.

Pre-compressed files

Beside the cached on the fly compression it is also possible to serve pre-compressed static files that are available from the same directories as the original files. The StaticCompressed plugin will try to find a compressed file at the same path as the original file appended by an extension indicating the compression method. So if you have for example boostrap.min.css and bootstrap.min.css.gz in your static files directory, the plugin will serve the compressed variant if the requesting user agent supports the gzip encoding. The delivery of pre-compressed files can be disabled by setting check_pre_compressed to false in the configuration file.

Used file extensions/suffixes

.br - Brotli compressed files
.gz - gzip/Zopfli compressed files
.deflate - DEFLATE compressed files

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.

Runtime configuration

The plugin offers some configuration options that can be set in the application configuration file in the Cutelyst_StaticCompressed_Plugin section. You can override the defaults by setting a QVariantMap with selected default values to the constructor.

cache_directory

Type: string Default: QStandardPaths::CacheLocation + /compressed-static

Sets the directory path where on the fly compressed data is saved.

mime_types

Type: string Default: text/css,application/javascript,text/javascript

Comma separated list of MIME types that should be compressed.

suffixes

Type: string Default: js.map,css.map,min.js.map,min.css.map

Comma separted list of file suffixes/extensions that should be compressed.

check_pre_compressed

Type: bool Default: true

Enables or disables the check for pre compressed files.

on_the_fly_compression

Type: bool Default: true

Enables or disables the compression on the fly.

zlib_compression_level

Type: integer Default: 9

Compression level for built in zlib based compression between 0 and 9, with 9 corresponding to the best compression.

brotli_quality_level

Type: integer Default: 11

Quality level for Brotli compression between 0 and 11, with 11 corresponding to the best compression.

use_zopfli

Type: bool Default: false

Enables the optional use of Zopfli for the gzip compression. Note that Zopfli gives much better compression results for the cost of a slower compression.

zopfli_iterations

Type: integer Default: 15

Number of iterations used for Zopfli compression, more gives better compression but is slower.

Usage example

#include <Cutelyst/Plugins/StaticCompressed/StaticCompressed>
 
bool MyCutelystApp::init()
{
    // other initialization stuff
    // ...
 
    // constructs a new plugin and sets the default value for
    // the config file option use_zopfli to true
    auto staticCompressed = new StaticCompressed(this, {{"use_zopfli", true}});
    staticCompressed->setIncludePaths({QStringLiteral("/path/to/my/static/files")});
 
    // maybe more initialization stuff
    //...
}

Build configuration

-DPLUGIN_STATICCOMPRESSED:BOOL=ON - enables the build of the plugin (default: off)
-DPLUGIN_STATICCOMPRESSED_ZOPFLI:BOOL=ON - enables the Zopfli support for gzip, libzopfli development and header files have to be present (default: off)
-DPLUGIN_STATICCOMPRESSED_BROTLI:BOOL=ON - enables the Brotli support, libbrotlienc development and header files have to be present (default: off)

Since Cutelyst 2.0.0 you can check if CUTELYST_STATICCOMPRESSED_WITH_ZOPFLI and/or CUTELYST_STATICCOMPRESSED_WITH_BROTLI are defined if you need to know that the plugin supports that compressions.

Logging category: cutelyst.plugin.csrfprotection
Logging with Cutelyst

Since: Cutelyst 1.11.0

See also: StaticSimple; Serve static files

Definition at line 176 of file staticcompressed.h.

Constructor & Destructor Documentation

◆ StaticCompressed() [1/2]

StaticCompressed::StaticCompressed ( Application * parent )

explicit

Constructs a new StaticCompressed plugin with the given parent.

Definition at line 38 of file staticcompressed.cpp.

◆ StaticCompressed() [2/2]

Cutelyst::StaticCompressed::StaticCompressed	(	Application *	parent,
		const QVariantMap &	defaultConfig
	)

Constructs a new StaticCompressed plugin with the given parent and defaultConfig.

Use the defaultConfig to set default values for the configuration entries from the configuration file.

Since: Cutelyst 4.0.0

◆ ~StaticCompressed()

StaticCompressed::~StaticCompressed ( )

overridedefault

Destroys the StaticCompressed object.

Member Function Documentation

◆ setDirs()

void StaticCompressed::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 57 of file staticcompressed.cpp.

◆ setIncludePaths()

void StaticCompressed::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 48 of file staticcompressed.cpp.

◆ setServeDirsOnly()

void StaticCompressed::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 63 of file staticcompressed.cpp.

◆ setup()

bool StaticCompressed::setup ( Application * app )

overridevirtual

Configures the plugin by reading the Cutelyst_StaticCompressed_Plugin section from the Cutelyst application configuration file and connects to the Application::beforePrepareAction() signal. Returns false if the cache directory can not be created or if it not exists.

Reimplemented from Cutelyst::Plugin.

Definition at line 69 of file staticcompressed.cpp.

References Cutelyst::Application::beforePrepareAction(), QStandardPaths::CacheLocation, Cutelyst::Engine::config(), QObject::connect(), Cutelyst::Application::engine(), Qt::SkipEmptyParts, QString::split(), QList::value(), and QStandardPaths::writableLocation().

Public Member Functions

Additional Inherited Members