NET_RateLimit.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_RateLimit.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __NET_RATELIMIT_H__
#define __NET_RATELIMIT_H__

#include "NET_API.h"

#include "NET_UrlHandlerDecorator.h"

#include <UT/UT_StringHolder.h>
#include <UT/UT_Function.h>
#include <UT/UT_StringArray.h>

class NET_HTTPRequest;

enum class NET_HTTPRateKey
{
    RATE_IP,
    RATE_IP_OR_USER
};

class NET_API NET_HTTPRate
{
public:
    using func_t = UT_Function<
            std::pair<int, int>(const UT_StringRef&, const NET_HTTPRequest&)>;

    NET_HTTPRate() = default;

    NET_HTTPRate(int count, int seconds) :
        myCount(count),
        myPeriodS(seconds)
    {}

    explicit NET_HTTPRate(func_t&& f) : myCount(0), myPeriodS(0), myCustom(f) {}

    int myCount = 0;
    int myPeriodS = 0;
    func_t myCustom;
};

class NET_API NET_HTTPRateLimit
{
public:
    int myCount = 0;
    int myLimit = 0;
    bool myShouldLimit = false;
    int myTimeLeft = -1;
};

NET_API bool NETisRateLimited(
        const NET_HTTPRequest& request,
        const UT_StringRef& group,
        NET_HTTPRateKey key,
        const NET_HTTPRate& rate,
        const UT_StringArray& methods = UT_StringArray(),
        bool increment = false);

NET_API NET_HTTPRateLimit NETgetRateUsage(
        const NET_HTTPRequest& request,
        const UT_StringRef& group,
        NET_HTTPRateKey key,
        const NET_HTTPRate& rate,
        const UT_StringArray& methods,
        bool increment);

class NET_RateLimitDecorator : public NET_IUrlHandlerDecorator
{
public:
    void settings(
            const UT_StringHolder& group,
            NET_HTTPRateKey key,
            const NET_HTTPRate& rate,
            const std::initializer_list<UT_StringHolder>& methods);

    void handle(NET_HTTPRequest& req) override;

private:
    UT_StringHolder myGroup;
    NET_HTTPRateKey myKey;
    NET_HTTPRate myRate;
    UT_StringArray myMethods;
};

#endif // __NET_RATELIMIT_H__