httpnode.hpp

/* Copyright (c) 2014, The Nuria Project
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgment in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be plainly marked as such, and must not be
 *       misrepresented as being the original software.
 *    3. This notice may not be removed or altered from any source
 *       distribution.
 */

#ifndef NURIA_HTTPNODE_HPP
#define NURIA_HTTPNODE_HPP

#include "network_global.hpp"
#include "httpclient.hpp"
#include "callback.hpp"
#include <QSharedData>
#include <QObject>
#include <QDir>

namespace Nuria {

class HttpNodePrivate;
class SlotInfoPrivate;
class HttpServer;
class HttpNode;

class NURIA_NETWORK_EXPORT SlotInfo {
public:
    
    SlotInfo (const Callback &callback = Callback ());
    
    SlotInfo (const SlotInfo &other);
    
    SlotInfo &operator= (const SlotInfo &other);
    
    ~SlotInfo ();
    
    bool isValid () const;
    
    Callback callback () const;
    
    bool streamPostBody () const;
    
    void setStreamPostBody (bool value);
    
    HttpClient::HttpVerbs allowedVerbs () const;
    
    void setAllowedVerbs (HttpClient::HttpVerbs verbs);
    
    qint64 maxBodyLength () const;
    
    void setMaxBodyLength (qint64 length);
    
    bool forceEncrypted () const;
    
    void setForceEncrypted (bool force);
    
private:
    friend class HttpNode;
    
    // 
    QSharedDataPointer< SlotInfoPrivate > d;
    
};

typedef QList< HttpNode * > HttpNodeList;

class NURIA_NETWORK_EXPORT HttpNode : public QObject {
    Q_OBJECT
public:
    
    enum StaticResourcesMode {
        
        NoStaticResources = 0,
        
        UseStaticResources = 1,
        
        UseNestedStaticResources = 2
        
    };
    
    HttpNode (const QString &resourceName, HttpNode *parent = 0);
    
    HttpNode (QObject *parent = 0);
    
    ~HttpNode ();
    
    bool isChild () const;
    
    HttpNode *parentNode () const;
    
    SlotInfo connectSlot (const QString &name, const Callback &callback);
    
    SlotInfo connectSlot (const QString &name, QObject *receiver, const char *slot);
    
    bool disconnectSlot (const QString &name);
    
    bool addNode (HttpNode *node);
    
    const QString &resourceName () const;
    
    const QDir &staticResourceDir () const;
    
    StaticResourcesMode staticResourceMode () const;
    
    bool setResourceName (const QString &name);
    
    void setStaticResourceDir (QDir path);
    
    void setStaticResourceMode (StaticResourcesMode mode);
    
    bool hasNode (const QString &name);
    
    bool hasSlot (const QString &name);
    
    HttpNode *findNode (const QString &name) const;
    
protected:
    
    virtual bool invokePath (const QString &path, const QStringList &parts,
                 int index, HttpClient *client);
    
    virtual bool allowAccessToClient (const QString &path, const QStringList &parts,
                      int index, HttpClient *client);
    
    virtual bool callSlotByName (const QString &name, HttpClient *client);
    
    bool sendStaticResource (const QString &name, HttpClient *client);
    
    bool sendStaticResource (const QStringList &path, int indexInPath,
                 HttpClient *client);
    
private:
    friend class HttpServer;
    friend class HttpClient;
    
    static bool callSlot (const SlotInfo &info, HttpClient *client);
    
    // 
    HttpNodePrivate *d_ptr;
    
};
}

#endif // NURIA_HTTPNODE_HPP