Add options to disable flash usage and basic authentication

Author: QuickSander

README.md

@@ -45,6 +45,15 @@ Documentation
 
 Documentation available in the [ArduinoHttpServer Github wiki](https://github.com/QuickSander/ArduinoHttpServer/wiki)
 
+### Compiler options
+The library can be adjusted to include less or more features depending on the board you use and your desires for hardware usage. Specify these in your project's ```platformio.ini``` via the [```build_flags```](https://docs.platformio.org/en/latest/projectconf/section_env_build.html#build-flags) argument or as ```#define``` in your source/header code before including ```ArduinoHttpServer.h```.
+
+| ```#define``` | Description |
+| ------------- | ----------- |
+| ```ARDUINO_HTTP_SERVER_DEBUG``` | Enable debug logging printed towards the default Serial port |
+| ```ARDUINO_HTTP_SERVER_NO_FLASH``` | Do not put string literals used inside the library's implementation in flash memory. Increases RAM usage, decreases flash usage. |
+| ```ARDUINO_HTTP_SERVER_NO_BASIC_AUTH``` | Disable HTTP basic authentication support. Removes the need for the Base64 library. |
+
 Characteristics
 ---------------
 * HTTP parser with protocol validation.

examples/HelloHttp/HelloHttp.cpp

@@ -57,6 +57,7 @@ void loop()
          // Optionally athenticate incoming request
          if(!httpRequest.authenticate("user", "secret"))
          {
+            // Client did not supply correct credentials. Send request to authenticate itself via autheticate reply.
             ArduinoHttpServer::StreamHttpAuthenticateReply httpReply(client, httpRequest.getContentType());
             httpReply.send();
          }

lib/readme.txt

@@ -8,7 +8,7 @@
       "url": "http://sander.technology",
       "maintainer": true
     },
-    "version": "0.10.0",
+    "version": "0.10.1",
     "repository":
     {
         "type": "git",

library.json

@@ -1,5 +1,5 @@
 name=ArduinoHttpServer
-version=0.10.0
+version=0.10.1
 author=Sander van Woensel <sander@vanwoensel.me>
 maintainer=Sander van Woensel <sander@vanwoensel.me>
 sentence=Server side minimalistic HTTP protocol implementation.

library.properties

@@ -12,11 +12,16 @@
 src_dir = examples/HelloHttp
 lib_dir = ../
 
+
 [env:esp01]
 platform = espressif8266
 framework = arduino
 board = esp01
-lib_deps = agdl/Base64@^1.0.0
+#lib_deps = agdl/Base64@^1.0.0
+build_flags = 
+	;-DARDUINO_HTTP_SERVER_DEBUG
+	;-DARDUINO_HTTP_SERVER_NO_FLASH
+	;-DARDUINO_HTTP_SERVER_NO_BASIC_AUTH
 
 [env:uno]
 platform = atmelavr

platformio.ini

@@ -7,7 +7,6 @@
 //
 //! Debug support
 
-//#define ARDUINO_HTTP_SERVER_DEBUG
 #ifdef ARDUINO_HTTP_SERVER_DEBUG
    #define DEBUG_ARDUINO_HTTP_SERVER_PRINT(...) Serial.print(__VA_ARGS__)
    #define DEBUG_ARDUINO_HTTP_SERVER_PRINTLN(...) Serial.println(__VA_ARGS__)
@@ -17,7 +16,6 @@
 #endif
 
 
-//#define ARDUINO_HTTP_SERVER_NO_FLASH
 #ifdef ARDUINO_HTTP_SERVER_NO_FLASH
    #define AHS_F(x) (x)
 #else

src/internals/ArduinoHttpServerDebug.h

@@ -30,7 +30,9 @@ class FixString
 
    // Constructors
    explicit FixString(const char* pCStr="", size_t len=NPOS);
+   #ifndef ARDUINO_HTTP_SERVER_NO_FLASH
    explicit FixString(const __FlashStringHelper * pFlashStr);
+   #endif
    explicit FixString(const String& arduinoStr);
    template<size_t RHS_SIZE> FixString(const FixString<RHS_SIZE>& fixStr); // Not explicit to allow for normal conversions where only size differs.
    FixString(const FixString<MAX_SIZE>& fixStr) = default; // Not marked as "explicit" to allow normal return statements
@@ -40,7 +42,9 @@ class FixString
 
    // Assignment
    FixString<MAX_SIZE>& operator=(const char* pCStr);
+   #ifndef ARDUINO_HTTP_SERVER_NO_FLASH
    FixString<MAX_SIZE>& operator=(const __FlashStringHelper * str);
+   #endif
    FixString<MAX_SIZE>& operator=(const String& arduinostr);
    template<size_t RHS_SIZE> FixString<MAX_SIZE>& operator=(const FixString<RHS_SIZE>& fixStr);
    // We need this since move constructor implicitely declares assignment operators private.
@@ -60,7 +64,9 @@ class FixString
 
    // Modification
    FixString<MAX_SIZE>& operator+=(const char *pRhs);
+   #ifndef ARDUINO_HTTP_SERVER_NO_FLASH
    FixString<MAX_SIZE>& operator+=(const __FlashStringHelper *pRhs);
+   #endif
    template<size_t RHS_SIZE> FixString<MAX_SIZE>& operator+=(const FixString<RHS_SIZE>& rhs);
 
 
@@ -115,13 +121,14 @@ ArduinoHttpServer::FixString<MAX_SIZE>::FixString(const char* pCStr, size_t len)
 
 //------------------------------------------------------------------------------
 //! \brief Construct using Flash String pointer.
+#ifndef ARDUINO_HTTP_SERVER_NO_FLASH
 template <size_t MAX_SIZE>
 ArduinoHttpServer::FixString<MAX_SIZE>::FixString(const __FlashStringHelper * pFlashStr) :
    m_buffer{0}
 {
    strcpy_P(m_buffer, reinterpret_cast<PGM_P>(pFlashStr));
 }
-
+#endif
 
 //------------------------------------------------------------------------------
 //! \brief Construct using an Arduino String object.
@@ -156,11 +163,13 @@ ArduinoHttpServer::FixString<MAX_SIZE>& ArduinoHttpServer::FixString<MAX_SIZE>::
 
 //------------------------------------------------------------------------------
 //! \brief Assignment operator for Flash based strings.
+#ifndef ARDUINO_HTTP_SERVER_NO_FLASH
 template <size_t MAX_SIZE>
 ArduinoHttpServer::FixString<MAX_SIZE>& ArduinoHttpServer::FixString<MAX_SIZE>::operator=(const __FlashStringHelper * pFlashStr)
 {
    return (*this = FixString<MAX_SIZE>(pFlashStr));
 }
+#endif
 
 //------------------------------------------------------------------------------
 //! \brief Assignment operator for Arduino Strings.
@@ -291,12 +300,14 @@ ArduinoHttpServer::FixString<MAX_SIZE>& ArduinoHttpServer::FixString<MAX_SIZE>::
 
 //------------------------------------------------------------------------------
 //! \brief Concatenate with Flash String.
+#ifndef ARDUINO_HTTP_SERVER_NO_FLASH
 template <size_t MAX_SIZE>
 ArduinoHttpServer::FixString<MAX_SIZE>& ArduinoHttpServer::FixString<MAX_SIZE>::operator+=(const __FlashStringHelper *pRhs)
 {
    strncpy_P(m_buffer+length(), (PGM_P)pRhs, MAX_SIZE - length() - 1);
    return *this;
 }
+#endif
 
 //------------------------------------------------------------------------------
 //! \brief Concatenate FixString.

src/internals/FixString.hpp

@@ -134,6 +134,8 @@ String ArduinoHttpServer::StreamHttpErrorReply::getJsonBody(const String& data)
 //                             Class Definition
 //------------------------------------------------------------------------------
 
+#ifndef ARDUINO_HTTP_SERVER_NO_BASIC_AUTH
+
 ArduinoHttpServer::StreamHttpAuthenticateReply::StreamHttpAuthenticateReply(Stream& stream, const String& contentType) :
    AbstractStreamHttpReply(stream, contentType, "401")
 {
@@ -155,3 +157,5 @@ void ArduinoHttpServer::StreamHttpAuthenticateReply::send()
    getStream().println(AHS_F(""));
    DEBUG_ARDUINO_HTTP_SERVER_PRINTLN("done.");
 }
+
+#endif

src/internals/StreamHttpReply.cpp

@@ -63,13 +63,14 @@ class StreamHttpErrorReply: public AbstractStreamHttpReply
 //                             Class Declaration
 //------------------------------------------------------------------------------
 //! Authenticate reply
+#ifndef ARDUINO_HTTP_SERVER_NO_BASIC_AUTH
 class StreamHttpAuthenticateReply: public AbstractStreamHttpReply
 {
 public:
     StreamHttpAuthenticateReply(Stream& stream, const String& contentType);
     virtual void send();
 };
-
+#endif
 
 //------------------------------------------------------------------------------
 //                             Class Declaration

src/internals/StreamHttpReply.hpp

@@ -17,7 +17,9 @@
 #include "ArduinoHttpServerDebug.h"
 
 #include <Arduino.h>
-#include <Base64.h>
+#ifndef ARDUINO_HTTP_SERVER_NO_BASIC_AUTH
+   #include <Base64.h>
+#endif
 
 #include <string.h>
 
@@ -66,7 +68,9 @@ class StreamHttpRequest
     Stream& getStream() { return m_stream; };
 
     // Validate if client provided credentials match _username_ and _password_.
+    #ifndef ARDUINO_HTTP_SERVER_NO_BASIC_AUTH
     bool authenticate(const char * username, const char * password) const;
+    #endif
 
 private:
 
@@ -379,6 +383,7 @@ const ArduinoHttpServer::ErrorString ArduinoHttpServer::StreamHttpRequest<MAX_BO
    return errorString;
 }
 
+#ifndef ARDUINO_HTTP_SERVER_NO_BASIC_AUTH
 template <size_t MAX_BODY_SIZE>
 bool ArduinoHttpServer::StreamHttpRequest<MAX_BODY_SIZE>::authenticate(const char *username, const char *password) const
 {
@@ -415,5 +420,6 @@ bool ArduinoHttpServer::StreamHttpRequest<MAX_BODY_SIZE>::authenticate(const cha
 
    return false;
 }
+#endif
 
 #endif // __ArduinoHttpServer__StreamHttpRequest__