qtwebapp::StaticFileController Class Reference

#include <staticfilecontroller.h>

Inheritance diagram for qtwebapp::StaticFileController:

Collaboration diagram for qtwebapp::StaticFileController:

Classes
struct	CacheEntry

Public Member Functions
	StaticFileController (QSettings *settings, QObject *parent=NULL)
	StaticFileController (const HttpDocrootSettings &settings, QObject *parent=NULL)
void	service (HttpRequest &request, HttpResponse &response)
void	service (QByteArray &path, HttpResponse &response)
Public Member Functions inherited from qtwebapp::HttpRequestHandler
	HttpRequestHandler (QObject *parent=NULL)
virtual	~HttpRequestHandler ()

Private Member Functions
void	setContentType (QString file, HttpResponse &response) const

Private Attributes
QString	encoding
QString	docroot
int	maxAge
int	cacheTimeout
int	maxCachedFileSize
QCache< QString, CacheEntry >	cache
QMutex	mutex
bool	useQtSettings

Detailed Description

Definition at line 49 of file staticfilecontroller.h.

Constructor & Destructor Documentation

StaticFileController() [1/2]

StaticFileController::StaticFileController	(	QSettings *	settings,
		QObject *	parent = NULL
	)

Constructor with Qt settings

Definition at line 15 of file staticfilecontroller.cpp.

References cache, cacheTimeout, docroot, encoding, maxAge, and maxCachedFileSize.

    :HttpRequestHandler(parent), useQtSettings(true)
{
    maxAge=settings->value("maxAge","60000").toInt();
    encoding=settings->value("encoding","UTF-8").toString();
    docroot=settings->value("path",".").toString();
    if(!(docroot.startsWith(":/") || docroot.startsWith("qrc://")))
    {
        // Convert relative path to absolute, based on the directory of the config file.
        #ifdef Q_OS_WIN32
            if (QDir::isRelativePath(docroot) && settings->format()!=QSettings::NativeFormat)
        #else
            if (QDir::isRelativePath(docroot))
        #endif
        {
            QFileInfo configFile(settings->fileName());
            docroot=QFileInfo(configFile.absolutePath(),docroot).absoluteFilePath();
        }
    }
    qDebug("StaticFileController: docroot=%s, encoding=%s, maxAge=%i",qPrintable(docroot),qPrintable(encoding),maxAge);
    maxCachedFileSize=settings->value("maxCachedFileSize","65536").toInt();
    cache.setMaxCost(settings->value("cacheSize","1000000").toInt());
    cacheTimeout=settings->value("cacheTime","60000").toInt();
    qDebug("StaticFileController: cache timeout=%i, size=%i",cacheTimeout,cache.maxCost());
}

StaticFileController() [2/2]

StaticFileController::StaticFileController	(	const HttpDocrootSettings &	settings,
		QObject *	parent = NULL
	)

Constructor with settings structure

Definition at line 41 of file staticfilecontroller.cpp.

References cache, qtwebapp::HttpDocrootSettings::cacheSize, qtwebapp::HttpDocrootSettings::cacheTime, cacheTimeout, docroot, qtwebapp::HttpDocrootSettings::encoding, encoding, qtwebapp::HttpDocrootSettings::maxAge, maxAge, qtwebapp::HttpDocrootSettings::maxCachedFileSize, maxCachedFileSize, and qtwebapp::HttpDocrootSettings::path.

    :HttpRequestHandler(parent), useQtSettings(false)
{
    maxAge=settings.maxAge;
    encoding=settings.encoding;
    docroot=settings.path;
    if(!(docroot.startsWith(":/") || docroot.startsWith("qrc://")))
    {
        // Convert relative path to absolute, based on the directory of the config file.
        if (QDir::isRelativePath(docroot))
        {
            docroot = QFileInfo(QDir::currentPath(), docroot).absoluteFilePath();
        }
    }
    qDebug("StaticFileController: docroot=%s, encoding=%s, maxAge=%i",qPrintable(docroot),qPrintable(encoding),maxAge);
    maxCachedFileSize=settings.maxCachedFileSize;
    cache.setMaxCost(settings.cacheSize);
    cacheTimeout=settings.cacheTime;
    qDebug("StaticFileController: cache timeout=%i, size=%i",cacheTimeout,cache.maxCost());
}

Member Function Documentation

service() [1/2]

void StaticFileController::service ( HttpRequest &  request, HttpResponse &  response  )

virtual

Generates the response from HTTP request

Reimplemented from qtwebapp::HttpRequestHandler.

Definition at line 62 of file staticfilecontroller.cpp.

References qtwebapp::HttpRequest::getPath().

Referenced by WebAPIRequestMapper::service().

{
    QByteArray path = request.getPath();
    service(path, response);
}

Here is the call graph for this function:

Here is the caller graph for this function:

service() [2/2]

void StaticFileController::service	(	QByteArray &	path,
		HttpResponse &	response
	)

Generates the response directly from the path

Definition at line 68 of file staticfilecontroller.cpp.

References cache, cacheTimeout, qtwebapp::StaticFileController::CacheEntry::created, docroot, qtwebapp::StaticFileController::CacheEntry::document, qtwebapp::StaticFileController::CacheEntry::filename, maxAge, maxCachedFileSize, mutex, setContentType(), qtwebapp::HttpResponse::setHeader(), qtwebapp::HttpResponse::setStatus(), and qtwebapp::HttpResponse::write().

{
    //QByteArray path=request.getPath();
    // Check if we have the file in cache
    qint64 now=QDateTime::currentMSecsSinceEpoch();
    mutex.lock();
    CacheEntry* entry=cache.object(path);
    if (entry && (cacheTimeout==0 || entry->created>now-cacheTimeout))
    {
        QByteArray document=entry->document; //copy the cached document, because other threads may destroy the cached entry immediately after mutex unlock.
        QByteArray filename=entry->filename;
        mutex.unlock();
        qDebug("StaticFileController: Cache hit for %s",path.data());
        setContentType(filename,response);
        response.setHeader("Cache-Control","max-age="+QByteArray::number(maxAge/1000));
        response.write(document);
    }
    else
    {
        mutex.unlock();
        // The file is not in cache.
        qDebug("StaticFileController: Cache miss for %s",path.data());
        // Forbid access to files outside the docroot directory
        if (path.contains("/.."))
        {
            qWarning("StaticFileController::service: detected forbidden characters in path %s",path.data());
            response.setStatus(403,"forbidden");
            response.write("403 forbidden",true);
            return;
        }
        // If the filename is a directory, append index.html.
        if (QFileInfo(docroot+path).isDir())
        {
            path+="/index.html";
        }
        // Try to open the file
        QFile file(docroot+path);
        qDebug("StaticFileController: Open file %s",qPrintable(file.fileName()));
        if (file.open(QIODevice::ReadOnly))
        {
            setContentType(path,response);
            response.setHeader("Cache-Control","max-age="+QByteArray::number(maxAge/1000));
            if (file.size()<=maxCachedFileSize)
            {
                // Return the file content and store it also in the cache
                entry=new CacheEntry();
                while (!file.atEnd() && !file.error())
                {
                    QByteArray buffer=file.read(65536);
                    response.write(buffer);
                    entry->document.append(buffer);
                }
                entry->created=now;
                entry->filename=path;
                mutex.lock();
                //cache.insert(request.getPath(),entry,entry->document.size());
                cache.insert(path,entry,entry->document.size());
                mutex.unlock();
            }
            else
            {
                // Return the file content, do not store in cache
                while (!file.atEnd() && !file.error())
                {
                    response.write(file.read(65536));
                }
            }
            file.close();
        }
        else {
            if (file.exists())
            {
                qWarning("StaticFileController::service: Cannot open existing file %s for reading",qPrintable(file.fileName()));
                response.setStatus(403,"forbidden");
                response.write("403 forbidden",true);
            }
            else
            {
                qWarning("StaticFileController::service: File %s not found",qPrintable(file.fileName()));
                response.setStatus(404,"not found");
                response.write("404 not found",true);
            }
        }
    }
}

Here is the call graph for this function:

setContentType()

void StaticFileController::setContentType ( QString  file, HttpResponse &  response  ) const

private

Set a content-type header in the response depending on the ending of the filename

Definition at line 154 of file staticfilecontroller.cpp.

References encoding, and qtwebapp::HttpResponse::setHeader().

Referenced by service().

{
    if (fileName.endsWith(".png"))
    {
        response.setHeader("Content-Type", "image/png");
    }
    else if (fileName.endsWith(".jpg"))
    {
        response.setHeader("Content-Type", "image/jpeg");
    }
    else if (fileName.endsWith(".gif"))
    {
        response.setHeader("Content-Type", "image/gif");
    }
    else if (fileName.endsWith(".pdf"))
    {
        response.setHeader("Content-Type", "application/pdf");
    }
    else if (fileName.endsWith(".txt"))
    {
        response.setHeader("Content-Type", qPrintable("text/plain; charset="+encoding));
    }
    else if (fileName.endsWith(".html") || fileName.endsWith(".htm"))
    {
        response.setHeader("Content-Type", qPrintable("text/html; charset="+encoding));
    }
    else if (fileName.endsWith(".css"))
    {
        response.setHeader("Content-Type", "text/css");
    }
    else if (fileName.endsWith(".js"))
    {
        response.setHeader("Content-Type", "text/javascript");
    }
    else if (fileName.endsWith(".svg"))
    {
        response.setHeader("Content-Type", "image/svg+xml");
    }
    else if (fileName.endsWith(".woff"))
    {
        response.setHeader("Content-Type", "font/woff");
    }
    else if (fileName.endsWith(".woff2"))
    {
        response.setHeader("Content-Type", "font/woff2");
    }
    else if (fileName.endsWith(".ttf"))
    {
        response.setHeader("Content-Type", "application/x-font-ttf");
    }
    else if (fileName.endsWith(".eot"))
    {
        response.setHeader("Content-Type", "application/vnd.ms-fontobject");
    }
    else if (fileName.endsWith(".otf"))
    {
        response.setHeader("Content-Type", "application/font-otf");
    }
    else if (fileName.endsWith(".yaml"))
    {
        response.setHeader("Content-Type", "text/plain");
    }
    // Todo: add all of your content types
    else
    {
        qDebug("StaticFileController: unknown MIME type for filename '%s'", qPrintable(fileName));
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

cache

QCache<QString,CacheEntry> qtwebapp::StaticFileController::cache

private

Cache storage

Definition at line 90 of file staticfilecontroller.h.

Referenced by service(), and StaticFileController().

cacheTimeout

int qtwebapp::StaticFileController::cacheTimeout

private

Timeout for each cached file

Definition at line 84 of file staticfilecontroller.h.

Referenced by service(), and StaticFileController().

docroot

QString qtwebapp::StaticFileController::docroot

private

Root directory of documents

Definition at line 72 of file staticfilecontroller.h.

Referenced by service(), and StaticFileController().

encoding

QString qtwebapp::StaticFileController::encoding

private

Encoding of text files

Definition at line 69 of file staticfilecontroller.h.

Referenced by setContentType(), and StaticFileController().

maxAge

int qtwebapp::StaticFileController::maxAge

private

Maximum age of files in the browser cache

Definition at line 75 of file staticfilecontroller.h.

Referenced by service(), and StaticFileController().

maxCachedFileSize

int qtwebapp::StaticFileController::maxCachedFileSize

private

Maximum size of files in cache, larger files are not cached

Definition at line 87 of file staticfilecontroller.h.

Referenced by service(), and StaticFileController().

mutex

QMutex qtwebapp::StaticFileController::mutex

private

Used to synchronize cache access for threads

Definition at line 93 of file staticfilecontroller.h.

Referenced by service().

useQtSettings

bool qtwebapp::StaticFileController::useQtSettings

private

Settings flag

Definition at line 96 of file staticfilecontroller.h.

---

The documentation for this class was generated from the following files:

• httpserver/staticfilecontroller.h
• httpserver/staticfilecontroller.cpp