HttpHeaders.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Common/Result.h"
#include "../Common/Span.h"
#include "../Common/StringSpan.h"
#include "HttpExport.h"
 
namespace SC
{
 
struct SC_HTTP_EXPORT HttpHeaderKeyValue
{
    StringSpan name;
    StringSpan value;
    bool       hasValue = false;
};
 
struct SC_HTTP_EXPORT HttpCookieIterator
{
    explicit HttpCookieIterator(StringSpan cookieHeader);
 
    bool next(HttpHeaderKeyValue& pair);
 
  private:
    StringSpan header;
    size_t     cursor = 0;
};
 
struct SC_HTTP_EXPORT HttpSetCookieAttributeIterator
{
    explicit HttpSetCookieAttributeIterator(StringSpan attributes);
 
    bool next(HttpHeaderKeyValue& attribute);
 
  private:
    StringSpan attributes;
    size_t     cursor = 0;
};
 
struct SC_HTTP_EXPORT HttpSetCookieView
{
    StringSpan name;
    StringSpan value;
    StringSpan attributes;
 
    StringSpan path;
    StringSpan domain;
    StringSpan expires;
    StringSpan maxAge;
    StringSpan sameSite;
 
    bool hasMaxAge = false;
    bool secure    = false;
    bool httpOnly  = false;
 
    Result parse(StringSpan setCookieHeader);
};
 
struct SC_HTTP_EXPORT HttpSetCookieBuilder
{
    StringSpan name;
    StringSpan value;
    StringSpan path;
    StringSpan domain;
    StringSpan expires;
    StringSpan maxAge;
    StringSpan sameSite;
 
    bool secure   = false;
    bool httpOnly = false;
 
    Result writeTo(Span<char> storage, StringSpan& output) const;
};
 
SC_HTTP_EXPORT StringSpan HttpContentTypeTextPlainUtf8();
SC_HTTP_EXPORT StringSpan HttpContentTypeTextHtmlUtf8();
SC_HTTP_EXPORT StringSpan HttpContentTypeApplicationJson();
SC_HTTP_EXPORT StringSpan HttpContentTypeApplicationOctetStream();
 
struct SC_HTTP_EXPORT HttpCacheControlBuilder
{
    uint32_t maxAgeSeconds = 0;
 
    bool hasMaxAge      = false;
    bool noStore        = false;
    bool noCache        = false;
    bool publicCache    = false;
    bool privateCache   = false;
    bool mustRevalidate = false;
    bool immutable      = false;
 
    Result writeTo(Span<char> storage, StringSpan& output) const;
};
 
struct SC_HTTP_EXPORT HttpAuthorizationView
{
    StringSpan scheme;
    StringSpan credentials;
 
    Result parse(StringSpan authorizationHeader);
    bool   isBearer() const;
    bool   isBasic() const;
};
 
SC_HTTP_EXPORT Result HttpParseBearerToken(StringSpan authorizationHeader, StringSpan& token);
 
SC_HTTP_EXPORT Result HttpParseBasicCredentials(StringSpan authorizationHeader, Span<char> storage,
                                                StringSpan& username, StringSpan& password);
 
SC_HTTP_EXPORT Result HttpWriteBearerAuthorization(StringSpan token, Span<char> storage, StringSpan& output);
 
SC_HTTP_EXPORT Result HttpWriteBasicAuthorization(StringSpan base64Credentials, Span<char> storage, StringSpan& output);
 
SC_HTTP_EXPORT Result HttpWriteBasicAuthorizationCredentials(StringSpan username, StringSpan password,
                                                             Span<char> storage, StringSpan& output);
 
} // namespace SC