restfulhttpnode.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_RESTFULHTTPNODE_HPP
#define NURIA_RESTFULHTTPNODE_HPP

#include "httpclient.hpp"
#include "httpnode.hpp"

#define NURIA_RESTFUL(Path) NURIA_ANNOTATE(org.nuriaproject.network.restful, Path)

#define NURIA_RESTFUL_VERBS(Verbs) NURIA_ANNOTATE(org.nuriaproject.network.restful.verbs, int(Verbs))

namespace Nuria {

namespace Internal { struct RestfulHttpNodeSlotData; }

class RestfulHttpNodePrivate;
class MetaMethod;
class MetaObject;

class NURIA_NETWORK_EXPORT RestfulHttpNode : public HttpNode {
    Q_OBJECT
    Q_ENUMS(ReplyFormat)
public:
    
    explicit RestfulHttpNode (void *object, MetaObject *metaObject, const QString &resourceName,
                  HttpNode *parent = 0);
    
    explicit RestfulHttpNode (const QString &resourceName = QString (), HttpNode *parent = 0);
    
    ~RestfulHttpNode ();
    
    void setRestfulHandler (HttpClient::HttpVerbs verbs, const QString &path,
                const QStringList &argumentNames, const Callback &callback);
    
    void setRestfulHandler (const QString &path, const QStringList &argumentNames,
                const Callback &callback);
    
protected:
    
    virtual QByteArray convertVariantToData (const QVariant &variant);
    
    virtual QVariant convertArgumentToVariant (const QString &argumentData, int targetType);
    
    virtual void conversionFailure (const QVariant &variant, HttpClient *client);
    
    QByteArray generateResultData (QVariant result, HttpClient *client);
    
    bool invokePath (const QString &path, const QStringList &parts,
             int index, HttpClient *client) override;
    
private:
    friend class RestfulHttpNodePrivate;
    
    void registerAnnotatedHandlers ();
    void registerMetaMethod (MetaMethod &method);
    void registerRestfulHandlerFromMethod (const QString &path, MetaMethod &method);
    void delayedRegisterMetaObject ();
    QStringList argumentNamesWithoutClient (MetaMethod &method);
    QString compilePathRegEx (QString path);
    bool invokeMatch (Internal::RestfulHttpNodeSlotData &slotData,
              QRegularExpressionMatch &match, HttpClient *client);
    QVariantList argumentValues (const QStringList &names, const QList<int> &types,
                     QRegularExpressionMatch &match, HttpClient *client);
    bool writeResponse (const QVariant &response, HttpClient *client);
    
    RestfulHttpNodePrivate *d_ptr;
    
};

}

#endif // NURIA_RESTFULHTTPNODE_HPP