restfulhttpnode.hpp

/* Copyright (c) 2014-2015, The Nuria Project
 * The NuriaProject Framework is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * The NuriaProject Framework 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with The NuriaProject Framework.
 * If not, see <http://www.gnu.org/licenses/>.
 */

#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
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,
                                bool waitForRequestPostBody = true);
        
        void setRestfulHandler (const QString &path, const QStringList &argumentNames,
                                const Callback &callback, bool waitForRequestPostBody = true);
        
protected:
        
        virtual QVariant serializeVariant (const QVariant &variant);
        
        virtual QVariant convertArgumentToVariant (const QString &argumentData, int targetType);
        
        virtual void conversionFailure (const QVariant &variant, HttpClient *client);
        
        virtual QByteArray generateResultData (const 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 invokeMatchLater (Callback callback, const QVariantList &arguments, HttpClient *client);
        bool invokeMatchNow (Callback callback, const QVariantList &arguments, HttpClient *client);
        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);
        void addJsonContentTypeHeaderToResponse (HttpClient *client);
        QVariantMap deepConvertMap (QVariantMap map);
        QVariantList deepConvertList (QVariantList list);
        QVariant serializeUserStructure (const QVariant &variant);
        QByteArray sendVariantAsJson (const QVariant &variant, HttpClient *client);
        
        RestfulHttpNodePrivate *d_ptr;
        
};

}

#endif // NURIA_RESTFULHTTPNODE_HPP