From ab682fd8387374dfa6f47c870b3961f9f8e96bc9 Mon Sep 17 00:00:00 2001 From: Mathieu Carbou Date: Wed, 23 Oct 2024 10:13:10 +0200 Subject: [PATCH] Code cleanup: adding missing const keyword --- src/AsyncEventSource.cpp | 6 +++--- src/AsyncEventSource.h | 2 +- src/AsyncJson.cpp | 2 +- src/AsyncJson.h | 4 ++-- src/AsyncMessagePack.cpp | 2 +- src/AsyncMessagePack.h | 4 ++-- src/AsyncWebSocket.cpp | 2 +- src/AsyncWebSocket.h | 2 +- src/ESPAsyncWebServer.h | 18 +++++++++--------- src/Middleware.cpp | 2 +- src/WebHandlerImpl.h | 8 ++++---- src/WebHandlers.cpp | 10 +++++----- src/WebRequest.cpp | 17 ++++++----------- 13 files changed, 37 insertions(+), 42 deletions(-) diff --git a/src/AsyncEventSource.cpp b/src/AsyncEventSource.cpp index 5e028fa..2d81dbc 100644 --- a/src/AsyncEventSource.cpp +++ b/src/AsyncEventSource.cpp @@ -141,7 +141,7 @@ size_t AsyncEventSourceMessage::ack(size_t len, __attribute__((unused)) uint32_t } size_t AsyncEventSourceMessage::write(AsyncClient* client) { - if(!client) + if (!client) return 0; if (_sent >= _len || !client->canSend()) { @@ -270,7 +270,7 @@ size_t AsyncEventSourceClient::packetsWaiting() const { } void AsyncEventSourceClient::_runQueue() { - if(!_client) + if (!_client) return; size_t total_bytes_written = 0; @@ -385,7 +385,7 @@ size_t AsyncEventSource::count() const { return n_clients; } -bool AsyncEventSource::canHandle(AsyncWebServerRequest* request) { +bool AsyncEventSource::canHandle(AsyncWebServerRequest* request) const { if (request->method() != HTTP_GET || !request->url().equals(_url)) { return false; } diff --git a/src/AsyncEventSource.h b/src/AsyncEventSource.h index b0bd249..35ae319 100644 --- a/src/AsyncEventSource.h +++ b/src/AsyncEventSource.h @@ -143,7 +143,7 @@ class AsyncEventSource : public AsyncWebHandler { // system callbacks (do not call) void _addClient(AsyncEventSourceClient* client); void _handleDisconnect(AsyncEventSourceClient* client); - virtual bool canHandle(AsyncWebServerRequest* request) override final; + virtual bool canHandle(AsyncWebServerRequest* request) const override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; }; diff --git a/src/AsyncJson.cpp b/src/AsyncJson.cpp index 7117a70..ee69f91 100644 --- a/src/AsyncJson.cpp +++ b/src/AsyncJson.cpp @@ -89,7 +89,7 @@ AsyncCallbackJsonWebHandler::AsyncCallbackJsonWebHandler(const String& uri, ArJs : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} #endif -bool AsyncCallbackJsonWebHandler::canHandle(AsyncWebServerRequest* request) { +bool AsyncCallbackJsonWebHandler::canHandle(AsyncWebServerRequest* request) const { if (!_onRequest) return false; diff --git a/src/AsyncJson.h b/src/AsyncJson.h index 167364a..a3db8b6 100644 --- a/src/AsyncJson.h +++ b/src/AsyncJson.h @@ -119,11 +119,11 @@ class AsyncCallbackJsonWebHandler : public AsyncWebHandler { void setMaxContentLength(int maxContentLength) { _maxContentLength = maxContentLength; } void onRequest(ArJsonRequestHandlerFunction fn) { _onRequest = fn; } - virtual bool canHandle(AsyncWebServerRequest* request) override final; + virtual bool canHandle(AsyncWebServerRequest* request) const override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; virtual void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) override final {} virtual void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final; - virtual bool isRequestHandlerTrivial() override final { return !_onRequest; } + virtual bool isRequestHandlerTrivial() const override final { return !_onRequest; } }; #endif // ASYNC_JSON_SUPPORT == 1 diff --git a/src/AsyncMessagePack.cpp b/src/AsyncMessagePack.cpp index 076f558..db995ed 100644 --- a/src/AsyncMessagePack.cpp +++ b/src/AsyncMessagePack.cpp @@ -44,7 +44,7 @@ AsyncCallbackMessagePackWebHandler::AsyncCallbackMessagePackWebHandler(const Str : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} #endif -bool AsyncCallbackMessagePackWebHandler::canHandle(AsyncWebServerRequest* request) { +bool AsyncCallbackMessagePackWebHandler::canHandle(AsyncWebServerRequest* request) const { if (!_onRequest) return false; diff --git a/src/AsyncMessagePack.h b/src/AsyncMessagePack.h index 9ac5ee5..210e0a6 100644 --- a/src/AsyncMessagePack.h +++ b/src/AsyncMessagePack.h @@ -92,11 +92,11 @@ class AsyncCallbackMessagePackWebHandler : public AsyncWebHandler { void setMaxContentLength(int maxContentLength) { _maxContentLength = maxContentLength; } void onRequest(ArMessagePackRequestHandlerFunction fn) { _onRequest = fn; } - virtual bool canHandle(AsyncWebServerRequest* request) override final; + virtual bool canHandle(AsyncWebServerRequest* request) const override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; virtual void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) override final {} virtual void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final; - virtual bool isRequestHandlerTrivial() override final { return !_onRequest; } + virtual bool isRequestHandlerTrivial() const override final { return !_onRequest; } }; #endif // ASYNC_MSG_PACK_SUPPORT == 1 diff --git a/src/AsyncWebSocket.cpp b/src/AsyncWebSocket.cpp index 8dd6244..0bb40e4 100644 --- a/src/AsyncWebSocket.cpp +++ b/src/AsyncWebSocket.cpp @@ -1121,7 +1121,7 @@ const char __WS_STR_UUID[] PROGMEM = {"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"}; #define WS_STR_ACCEPT FPSTR(__WS_STR_ACCEPT) #define WS_STR_UUID FPSTR(__WS_STR_UUID) -bool AsyncWebSocket::canHandle(AsyncWebServerRequest* request) { +bool AsyncWebSocket::canHandle(AsyncWebServerRequest* request) const { if (!_enabled) return false; diff --git a/src/AsyncWebSocket.h b/src/AsyncWebSocket.h index f489aca..5f134b9 100644 --- a/src/AsyncWebSocket.h +++ b/src/AsyncWebSocket.h @@ -350,7 +350,7 @@ class AsyncWebSocket : public AsyncWebHandler { uint32_t _getNextId() { return _cNextId++; } AsyncWebSocketClient* _newClient(AsyncWebServerRequest* request); void _handleEvent(AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len); - virtual bool canHandle(AsyncWebServerRequest* request) override final; + virtual bool canHandle(AsyncWebServerRequest* request) const override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; // messagebuffer functions/objects. diff --git a/src/ESPAsyncWebServer.h b/src/ESPAsyncWebServer.h index be4741f..538fd11 100644 --- a/src/ESPAsyncWebServer.h +++ b/src/ESPAsyncWebServer.h @@ -274,14 +274,14 @@ class AsyncWebServerRequest { #endif RequestedConnectionType requestedConnType() const { return _reqconntype; } - bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED); + bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED) const; void onDisconnect(ArDisconnectHandler fn); // hash is the string representation of: // base64(user:pass) for basic or // user:realm:md5(user:realm:pass) for digest - bool authenticate(const char* hash); - bool authenticate(const char* username, const char* credentials, const char* realm = NULL, bool isHash = false); + bool authenticate(const char* hash) const; + bool authenticate(const char* username, const char* credentials, const char* realm = NULL, bool isHash = false) const; void requestAuthentication(const char* realm = nullptr, bool isDigest = true) { requestAuthentication(isDigest ? AsyncAuthType::AUTH_DIGEST : AsyncAuthType::AUTH_BASIC, realm); } void requestAuthentication(AsyncAuthType method, const char* realm = nullptr, const char* _authFailMsg = nullptr); @@ -588,9 +588,9 @@ class AuthenticationMiddleware : public AsyncMiddleware { bool generateHash(); // returns true if the username and password (or hash) are set - bool hasCredentials() { return _hasCreds; } + bool hasCredentials() const { return _hasCreds; } - bool allowed(AsyncWebServerRequest* request); + bool allowed(AsyncWebServerRequest* request) const; void run(AsyncWebServerRequest* request, ArMiddlewareNext next); @@ -648,7 +648,7 @@ class LoggingMiddleware : public AsyncMiddleware { public: void setOutput(Print& output) { _out = &output; } void setEnabled(bool enabled) { _enabled = enabled; } - bool isEnabled() { return _enabled && _out; } + bool isEnabled() const { return _enabled && _out; } void run(AsyncWebServerRequest* request, ArMiddlewareNext next); @@ -722,7 +722,7 @@ class AsyncWebRewrite { const String& from(void) const { return _from; } const String& toUrl(void) const { return _toUrl; } const String& params(void) const { return _params; } - virtual bool match(AsyncWebServerRequest* request) { return from() == request->url() && filter(request); } + virtual bool match(AsyncWebServerRequest* request) const { return from() == request->url() && filter(request); } }; /* @@ -741,13 +741,13 @@ class AsyncWebHandler : public AsyncMiddlewareChain { AsyncWebHandler& setAuthentication(const String& username, const String& password) { return setAuthentication(username.c_str(), password.c_str()); }; bool filter(AsyncWebServerRequest* request) { return _filter == NULL || _filter(request); } virtual ~AsyncWebHandler() {} - virtual bool canHandle(AsyncWebServerRequest* request __attribute__((unused))) { + virtual bool canHandle(AsyncWebServerRequest* request __attribute__((unused))) const { return false; } virtual void handleRequest(__unused AsyncWebServerRequest* request) {} virtual void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) {} virtual void handleBody(__unused AsyncWebServerRequest* request, __unused uint8_t* data, __unused size_t len, __unused size_t index, __unused size_t total) {} - virtual bool isRequestHandlerTrivial() { return true; } + virtual bool isRequestHandlerTrivial() const { return true; } }; /* diff --git a/src/Middleware.cpp b/src/Middleware.cpp index d5e18c5..78cdfc8 100644 --- a/src/Middleware.cpp +++ b/src/Middleware.cpp @@ -95,7 +95,7 @@ bool AuthenticationMiddleware::generateHash() { } } -bool AuthenticationMiddleware::allowed(AsyncWebServerRequest* request) { +bool AuthenticationMiddleware::allowed(AsyncWebServerRequest* request) const { if (_authMethod == AsyncAuthType::AUTH_NONE) return true; diff --git a/src/WebHandlerImpl.h b/src/WebHandlerImpl.h index cb43f80..c92290d 100644 --- a/src/WebHandlerImpl.h +++ b/src/WebHandlerImpl.h @@ -34,7 +34,7 @@ class AsyncStaticWebHandler : public AsyncWebHandler { using FS = fs::FS; private: - bool _getFile(AsyncWebServerRequest* request); + bool _getFile(AsyncWebServerRequest* request) const; bool _fileExists(AsyncWebServerRequest* request, const String& path); uint8_t _countBits(const uint8_t value) const; @@ -52,7 +52,7 @@ class AsyncStaticWebHandler : public AsyncWebHandler { public: AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control); - virtual bool canHandle(AsyncWebServerRequest* request) override final; + virtual bool canHandle(AsyncWebServerRequest* request) const override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; AsyncStaticWebHandler& setIsDir(bool isDir); AsyncStaticWebHandler& setDefaultFile(const char* filename); @@ -84,11 +84,11 @@ class AsyncCallbackWebHandler : public AsyncWebHandler { void onUpload(ArUploadHandlerFunction fn) { _onUpload = fn; } void onBody(ArBodyHandlerFunction fn) { _onBody = fn; } - virtual bool canHandle(AsyncWebServerRequest* request) override final; + virtual bool canHandle(AsyncWebServerRequest* request) const override final; virtual void handleRequest(AsyncWebServerRequest* request) override final; virtual void handleUpload(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final) override final; virtual void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final; - virtual bool isRequestHandlerTrivial() override final { return !_onRequest; } + virtual bool isRequestHandlerTrivial() const override final { return !_onRequest; } }; #endif /* ASYNCWEBSERVERHANDLERIMPL_H_ */ diff --git a/src/WebHandlers.cpp b/src/WebHandlers.cpp index ae0be51..ad0716a 100644 --- a/src/WebHandlers.cpp +++ b/src/WebHandlers.cpp @@ -104,14 +104,14 @@ AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified() { return setLastModified(last_modified); } #endif -bool AsyncStaticWebHandler::canHandle(AsyncWebServerRequest* request) { +bool AsyncStaticWebHandler::canHandle(AsyncWebServerRequest* request) const { if (request->method() != HTTP_GET || !request->url().startsWith(_uri) || !request->isExpectedRequestedConnType(RCT_DEFAULT, RCT_HTTP)) { return false; } return _getFile(request); } -bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) { +bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) const { // Remove the found uri String path = request->url().substring(_uri.length()); @@ -121,7 +121,7 @@ bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) { path = _path + path; // Do we have a file or .gz file - if (!canSkipFileCheck && _fileExists(request, path)) + if (!canSkipFileCheck && const_cast(this)->_fileExists(request, path)) return true; // Can't handle if not default file @@ -133,7 +133,7 @@ bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) { path += String('/'); path += _default_file; - return _fileExists(request, path); + return const_cast(this)->_fileExists(request, path); } #ifdef ESP32 @@ -260,7 +260,7 @@ void AsyncCallbackWebHandler::setUri(const String& uri) { _isRegex = uri.startsWith("^") && uri.endsWith("$"); } -bool AsyncCallbackWebHandler::canHandle(AsyncWebServerRequest* request) { +bool AsyncCallbackWebHandler::canHandle(AsyncWebServerRequest* request) const { if (!_onRequest) return false; diff --git a/src/WebRequest.cpp b/src/WebRequest.cpp index 8452106..9955576 100644 --- a/src/WebRequest.cpp +++ b/src/WebRequest.cpp @@ -781,7 +781,7 @@ void AsyncWebServerRequest::redirect(const char* url, int code) { send(response); } -bool AsyncWebServerRequest::authenticate(const char* username, const char* password, const char* realm, bool passwordIsHash) { +bool AsyncWebServerRequest::authenticate(const char* username, const char* password, const char* realm, bool passwordIsHash) const { if (_authorization.length()) { if (_authMethod == AsyncAuthType::AUTH_DIGEST) return checkDigestAuthentication(_authorization.c_str(), methodToString(), username, password, realm, passwordIsHash, NULL, NULL, NULL); @@ -793,7 +793,7 @@ bool AsyncWebServerRequest::authenticate(const char* username, const char* passw return false; } -bool AsyncWebServerRequest::authenticate(const char* hash) { +bool AsyncWebServerRequest::authenticate(const char* hash) const { if (!_authorization.length() || hash == NULL) return false; @@ -1018,13 +1018,8 @@ const __FlashStringHelper* AsyncWebServerRequest::requestedConnTypeToString() co } #endif // ESP8266 -bool AsyncWebServerRequest::isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2, RequestedConnectionType erct3) { - bool res = false; - if ((erct1 != RCT_NOT_USED) && (erct1 == _reqconntype)) - res = true; - if ((erct2 != RCT_NOT_USED) && (erct2 == _reqconntype)) - res = true; - if ((erct3 != RCT_NOT_USED) && (erct3 == _reqconntype)) - res = true; - return res; +bool AsyncWebServerRequest::isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2, RequestedConnectionType erct3) const { + return ((erct1 != RCT_NOT_USED) && (erct1 == _reqconntype)) || + ((erct2 != RCT_NOT_USED) && (erct2 == _reqconntype)) || + ((erct3 != RCT_NOT_USED) && (erct3 == _reqconntype)); }