torchttphandler.cpp

Go to the documentation of this file.

/* Class TorcHTTPHandler
*
* This file is part of the Torc project.
*
* Copyright (C) Mark Kendall 2012-18
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
* USA.
*/

// Qt
#include <QFile>
#include <QFileInfo>

// Torc
#include "torclogging.h"
#include "torchttpserver.h"
#include "torchttphandler.h"

TorcHTTPHandler::TorcHTTPHandler(const QString &Signature, const QString &Name)
  : m_signature(Signature),
    m_recursive(false),
    m_name(Name)
{
    if (!m_signature.endsWith('/'))
        m_signature += '/';

    if (m_name.isEmpty())
        LOG(VB_GENERAL, LOG_DEBUG, QStringLiteral("Not registering '%1' as a handler").arg(m_signature));
    else
        TorcHTTPServer::RegisterHandler(this);
}

TorcHTTPHandler::~TorcHTTPHandler()
{
    TorcHTTPServer::DeregisterHandler(this);
}

QString TorcHTTPHandler::Signature(void) const
{
    return m_signature;
}

bool TorcHTTPHandler::GetRecursive(void) const
{
    return m_recursive;
}

QString TorcHTTPHandler::Name(void) const
{
    return m_name;
}

QVariantMap TorcHTTPHandler::ProcessRequest(const QString &Method, const QVariant &Parameters, QObject *Connection, bool Authenticated)
{
    (void)Method;
    (void)Parameters;
    (void)Connection;
    (void)Authenticated;

    return QVariantMap();
}

bool TorcHTTPHandler::MethodIsAuthorised(TorcHTTPRequest &Request, int Allowed)
{
    if ((Request.IsAuthorised() != HTTPAuthorised) && (Allowed & HTTPAuth))
    {
        TorcHTTPServer::AddAuthenticationHeader(Request);
        return false;
    }
    return true;
}

void TorcHTTPHandler::HandleOptions(TorcHTTPRequest &Request, int Allowed)
{
    Request.SetAllowed(Allowed);
    Request.SetStatus(HTTP_OK);
    Request.SetResponseType(HTTPResponseNone);
    QByteArray empty;
    Request.SetResponseContent(empty);
}

void TorcHTTPHandler::HandleFile(TorcHTTPRequest &Request, const QString &Filename, int Cache)
{
    // sanity checks
    if (QFile::exists(Filename))
    {
        if ((QFile::permissions(Filename) & QFile::ReadOther))
        {
            QFileInfo fileinfo(Filename);
            if (fileinfo.size() > 0)
            {
                QDateTime modified = fileinfo.lastModified();

                // set cache handling before we check for modification. This ensures the modification check is
                // performed and the correct cache headers are re-sent with any 304 Not Modified response.
                Request.SetCache(Cache, modified.toString(TorcHTTPRequest::DateFormat));

                // Unmodified will handle the response
                if (Request.Unmodified(modified))
                    return;

                Request.SetResponseFile(Filename);
                Request.SetStatus(HTTP_OK);
                Request.SetAllowGZip(true);
                return;
            }
            else
            {
                LOG(VB_GENERAL, LOG_ERR, QStringLiteral("'%1' is empty - ignoring").arg(Filename));
                Request.SetStatus(HTTP_NotFound);
            }
        }
        else
        {
            LOG(VB_GENERAL, LOG_ERR, QStringLiteral("'%1' is not readable").arg(Filename));
            Request.SetStatus(HTTP_Forbidden);
        }
    }
    else
    {
        LOG(VB_GENERAL, LOG_ERR, QStringLiteral("Failed to find '%1'").arg(Filename));
        Request.SetStatus(HTTP_NotFound);
    }

    Request.SetResponseType(HTTPResponseNone);
}