[WebServer] Mark functions as const + reduce copy of strings

TD-er · TD-er · commit 4466fbb27024 · 2024-09-12T22:16:14.000+02:00
diff --git a/libraries/WebServer/src/Parsing.cpp b/libraries/WebServer/src/Parsing.cpp
@@ -280,7 +280,7 @@ bool WebServer::_collectHeader(const char *headerName, const char *headerValue)
   return false;
 }
 
-void WebServer::_parseArguments(String data) {
+void WebServer::_parseArguments(const String& data) {
   log_v("args: %s", data.c_str());
   if (_currentArgs) {
     delete[] _currentArgs;
@@ -387,7 +387,7 @@ int WebServer::_uploadReadByte(NetworkClient &client) {
   return res;
 }
 
-bool WebServer::_parseForm(NetworkClient &client, String boundary, uint32_t len) {
+bool WebServer::_parseForm(NetworkClient &client, const String& boundary, uint32_t len) {
   (void)len;
   log_v("Parse Form: Boundary: %s Length: %d", boundary.c_str(), len);
   String line;
diff --git a/libraries/WebServer/src/WebServer.cpp b/libraries/WebServer/src/WebServer.cpp
@@ -673,14 +673,14 @@ void WebServer::_streamFileCore(const size_t fileSize, const String &fileName, c
   send(code, contentType, "");
 }
 
-String WebServer::pathArg(unsigned int i) {
+String WebServer::pathArg(unsigned int i) const {
   if (_currentHandler != nullptr) {
     return _currentHandler->pathArg(i);
   }
   return "";
 }
 
-String WebServer::arg(String name) {
+String WebServer::arg(const String& name) const {
   for (int j = 0; j < _postArgsLen; ++j) {
     if (_postArgs[j].key == name) {
       return _postArgs[j].value;
@@ -694,25 +694,25 @@ String WebServer::arg(String name) {
   return "";
 }
 
-String WebServer::arg(int i) {
+String WebServer::arg(int i) const {
   if (i < _currentArgCount) {
     return _currentArgs[i].value;
   }
   return "";
 }
 
-String WebServer::argName(int i) {
+String WebServer::argName(int i) const {
   if (i < _currentArgCount) {
     return _currentArgs[i].key;
   }
   return "";
 }
 
-int WebServer::args() {
+int WebServer::args() const {
   return _currentArgCount;
 }
 
-bool WebServer::hasArg(String name) {
+bool WebServer::hasArg(const String& name) const {
   for (int j = 0; j < _postArgsLen; ++j) {
     if (_postArgs[j].key == name) {
       return true;
@@ -726,7 +726,7 @@ bool WebServer::hasArg(String name) {
   return false;
 }
 
-String WebServer::header(String name) {
+String WebServer::header(const String& name) const {
   for (int i = 0; i < _headerKeysCount; ++i) {
     if (_currentHeaders[i].key.equalsIgnoreCase(name)) {
       return _currentHeaders[i].value;
@@ -748,25 +748,25 @@ void WebServer::collectHeaders(const char *headerKeys[], const size_t headerKeys
   }
 }
 
-String WebServer::header(int i) {
+String WebServer::header(int i) const {
   if (i < _headerKeysCount) {
     return _currentHeaders[i].value;
   }
   return "";
 }
 
-String WebServer::headerName(int i) {
+String WebServer::headerName(int i) const {
   if (i < _headerKeysCount) {
     return _currentHeaders[i].key;
   }
   return "";
 }
 
-int WebServer::headers() {
+int WebServer::headers() const {
   return _headerKeysCount;
 }
 
-bool WebServer::hasHeader(String name) {
+bool WebServer::hasHeader(const String& name) const {
   for (int i = 0; i < _headerKeysCount; ++i) {
     if ((_currentHeaders[i].key.equalsIgnoreCase(name)) && (_currentHeaders[i].value.length() > 0)) {
       return true;
@@ -775,7 +775,7 @@ bool WebServer::hasHeader(String name) {
   return false;
 }
 
-String WebServer::hostHeader() {
+String WebServer::hostHeader() const {
   return _hostHeader;
 }
 
diff --git a/libraries/WebServer/src/WebServer.h b/libraries/WebServer/src/WebServer.h
@@ -158,10 +158,10 @@ class WebServer {
   void onNotFound(THandlerFunction fn);     //called when handler is not assigned
   void onFileUpload(THandlerFunction ufn);  //handle file uploads
 
-  String uri() {
+  String uri() const {
     return _currentUri;
   }
-  HTTPMethod method() {
+  HTTPMethod method() const {
     return _currentMethod;
   }
   virtual NetworkClient &client() {
@@ -174,24 +174,24 @@ class WebServer {
     return *_currentRaw;
   }
 
-  String pathArg(unsigned int i);                                               // get request path argument by number
-  String arg(String name);                                                      // get request argument value by name
-  String arg(int i);                                                            // get request argument value by number
-  String argName(int i);                                                        // get request argument name by number
-  int args();                                                                   // get arguments count
-  bool hasArg(String name);                                                     // check if argument exists
+  String pathArg(unsigned int i) const;                                               // get request path argument by number
+  String arg(const String& name) const;                                                      // get request argument value by name
+  String arg(int i) const;                                                            // get request argument value by number
+  String argName(int i) const;                                                        // get request argument name by number
+  int args() const;                                                                   // get arguments count
+  bool hasArg(const String& name) const;                                                     // check if argument exists
   void collectHeaders(const char *headerKeys[], const size_t headerKeysCount);  // set the request headers to collect
-  String header(String name);                                                   // get request header value by name
-  String header(int i);                                                         // get request header value by number
-  String headerName(int i);                                                     // get request header name by number
-  int headers();                                                                // get header count
-  bool hasHeader(String name);                                                  // check if header exists
+  String header(const String& name) const;                                                   // get request header value by name
+  String header(int i) const;                                                         // get request header value by number
+  String headerName(int i) const;                                                     // get request header name by number
+  int headers() const;                                                                // get header count
+  bool hasHeader(const String& name) const;                                                  // check if header exists
 
-  int clientContentLength() {
+  int clientContentLength() const {
     return _clientContentLength;
   }  // return "content-length" of incoming HTTP header from "_currentClient"
 
-  String hostHeader();  // get request host header if available or empty String if not
+  String hostHeader() const;  // get request host header if available or empty String if not
 
   // send response to the client
   // code - HTTP response code, can be 200 or 404
@@ -240,9 +240,9 @@ class WebServer {
   void _handleRequest();
   void _finalizeResponse();
   bool _parseRequest(NetworkClient &client);
-  void _parseArguments(String data);
+  void _parseArguments(const String& data);
   static String _responseCodeToString(int code);
-  bool _parseForm(NetworkClient &client, String boundary, uint32_t len);
+  bool _parseForm(NetworkClient &client, const String& boundary, uint32_t len);
   bool _parseFormUploadAborted();
   void _uploadWriteByte(uint8_t b);
   int _uploadReadByte(NetworkClient &client);

Original file line number	Diff line number	Diff line change
`@@ -673,14 +673,14 @@ void WebServer::_streamFileCore(const size_t fileSize, const String &fileName, c`
`673`	`673`	`send(code, contentType, "");`
`674`	`674`	`}`
`675`	`675`
`676`		`-String WebServer::pathArg(unsigned int i) {`
	`676`	`+String WebServer::pathArg(unsigned int i) const {`
`677`	`677`	`if (_currentHandler != nullptr) {`
`678`	`678`	`return _currentHandler->pathArg(i);`
`679`	`679`	`}`
`680`	`680`	`return "";`
`681`	`681`	`}`
`682`	`682`
`683`		`-String WebServer::arg(String name) {`
	`683`	`+String WebServer::arg(const String& name) const {`
`684`	`684`	`for (int j = 0; j < _postArgsLen; ++j) {`
`685`	`685`	`if (_postArgs[j].key == name) {`
`686`	`686`	`return _postArgs[j].value;`
`@@ -694,25 +694,25 @@ String WebServer::arg(String name) {`
`694`	`694`	`return "";`
`695`	`695`	`}`
`696`	`696`
`697`		`-String WebServer::arg(int i) {`
	`697`	`+String WebServer::arg(int i) const {`
`698`	`698`	`if (i < _currentArgCount) {`
`699`	`699`	`return _currentArgs[i].value;`
`700`	`700`	`}`
`701`	`701`	`return "";`
`702`	`702`	`}`
`703`	`703`
`704`		`-String WebServer::argName(int i) {`
	`704`	`+String WebServer::argName(int i) const {`
`705`	`705`	`if (i < _currentArgCount) {`
`706`	`706`	`return _currentArgs[i].key;`
`707`	`707`	`}`
`708`	`708`	`return "";`
`709`	`709`	`}`
`710`	`710`
`711`		`-int WebServer::args() {`
	`711`	`+int WebServer::args() const {`
`712`	`712`	`return _currentArgCount;`
`713`	`713`	`}`
`714`	`714`
`715`		`-bool WebServer::hasArg(String name) {`
	`715`	`+bool WebServer::hasArg(const String& name) const {`
`716`	`716`	`for (int j = 0; j < _postArgsLen; ++j) {`
`717`	`717`	`if (_postArgs[j].key == name) {`
`718`	`718`	`return true;`
`@@ -726,7 +726,7 @@ bool WebServer::hasArg(String name) {`
`726`	`726`	`return false;`
`727`	`727`	`}`
`728`	`728`
`729`		`-String WebServer::header(String name) {`
	`729`	`+String WebServer::header(const String& name) const {`
`730`	`730`	`for (int i = 0; i < _headerKeysCount; ++i) {`
`731`	`731`	`if (_currentHeaders[i].key.equalsIgnoreCase(name)) {`
`732`	`732`	`return _currentHeaders[i].value;`
`@@ -748,25 +748,25 @@ void WebServer::collectHeaders(const char *headerKeys[], const size_t headerKeys`
`748`	`748`	`}`
`749`	`749`	`}`
`750`	`750`
`751`		`-String WebServer::header(int i) {`
	`751`	`+String WebServer::header(int i) const {`
`752`	`752`	`if (i < _headerKeysCount) {`
`753`	`753`	`return _currentHeaders[i].value;`
`754`	`754`	`}`
`755`	`755`	`return "";`
`756`	`756`	`}`
`757`	`757`
`758`		`-String WebServer::headerName(int i) {`
	`758`	`+String WebServer::headerName(int i) const {`
`759`	`759`	`if (i < _headerKeysCount) {`
`760`	`760`	`return _currentHeaders[i].key;`
`761`	`761`	`}`
`762`	`762`	`return "";`
`763`	`763`	`}`
`764`	`764`
`765`		`-int WebServer::headers() {`
	`765`	`+int WebServer::headers() const {`
`766`	`766`	`return _headerKeysCount;`
`767`	`767`	`}`
`768`	`768`
`769`		`-bool WebServer::hasHeader(String name) {`
	`769`	`+bool WebServer::hasHeader(const String& name) const {`
`770`	`770`	`for (int i = 0; i < _headerKeysCount; ++i) {`
`771`	`771`	`if ((_currentHeaders[i].key.equalsIgnoreCase(name)) && (_currentHeaders[i].value.length() > 0)) {`
`772`	`772`	`return true;`
`@@ -775,7 +775,7 @@ bool WebServer::hasHeader(String name) {`
`775`	`775`	`return false;`
`776`	`776`	`}`
`777`	`777`
`778`		`-String WebServer::hostHeader() {`
	`778`	`+String WebServer::hostHeader() const {`
`779`	`779`	`return _hostHeader;`
`780`	`780`	`}`
`781`	`781`