Merge branch 'master' into toghci

Author: d-a-v

doc/esp8266wifi/readme.rst

@@ -78,7 +78,7 @@ The last line will then print out the IP address assigned to the ESP module by `
 
     Serial.println(WiFi.localIP());
 
-If you don't see the last line but just more and more dots ``.........``, then likely name or password to the Wi-Fi network is entered incorrectl in the sketchy. Verify the name and password by connecting from scratch to this Wi-Fi network with a PC or a mobile phone.
+If you don't see the last line but just more and more dots ``.........``, then likely name or password to the Wi-Fi network is entered incorrectly in the sketch. Verify the name and password by connecting from scratch to this Wi-Fi network with a PC or a mobile phone.
 
 *Note:* if connection is established, and then lost for some reason, ESP will automatically reconnect to the last used access point once it is again back on-line. This will be done automatically by Wi-Fi library, without any user intervention.
 
@@ -165,7 +165,7 @@ BearSSL Client Secure and Server Secure
 .. figure:: pictures/esp8266-client-secure.png
    :alt: ESP8266 operating as the Client Secure
 
-Secure clients and servers require siginificant amounts of additional memory and processing to enable their cryptographic algorithms.  In general, only a single secure client or server connection at a time can be processed given the little RAM present on the ESP8266, but there are methods of reducing this RAM requirement detailed in the relevant sections.
+Secure clients and servers require significant amounts of additional memory and processing to enable their cryptographic algorithms.  In general, only a single secure client or server connection at a time can be processed given the little RAM present on the ESP8266, but there are methods of reducing this RAM requirement detailed in the relevant sections.
 
 `BearSSL::WiFiClientSecure <bearssl-client-secure-class.rst>`__ contains more information on using and configuring TLS connections.
 
@@ -309,11 +309,11 @@ The tool crawls through all header and source files collecting information from
    :alt: Example of documentation for station begin method by Doxygen
 
 .. figure:: pictures/doxygen-example-station-hostname.png
-   :alt: Example of documentation for station hostname propert by Doxygen
+   :alt: Example of documentation for station hostname property by Doxygen
 
 If code is not annotated, you will still see the function prototype including types of arguments, and can use provided links to jump straight to the source code to check it out on your own. Doxygen provides really excellent navigation between members of library.
 
 .. figure:: pictures/doxygen-example-udp-begin.png
-   :alt: Example of documentation for UDP begin method (not annotaed in code)by Doxygen
+   :alt: Example of documentation for UDP begin method (not annotated in code)by Doxygen
 
 Several classes of `ESP8266WiFi <https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266WiFi>`__ are not annotated. When preparing this document, `Doxygen <https://www.doxygen.nl/>`__ has been tremendous help to quickly navigate through almost 30 files that make this library.

doc/esp8266wifi/station-examples.rst

@@ -3,9 +3,9 @@
 Station
 -------
 
-Example of connecting to an access point has been shown in chapter `Quick Start <readme.rst#quick-start>`__. In case connection is lost, ESP8266 will automatically reconnect to the last used access point, once it is again available.
+Example of connecting to an access point has been shown in chapter `Quick Start <readme.rst#quick-start>`__. In case connection is lost, ESP8266 will automatically reconnect to the last used access point, once it is available again.
 
-Can we provide more robust connection to Wi-Fi than that?
+Can we provide a more robust connection to Wi-Fi than that?
 
 Table of Contents
 -----------------
@@ -19,7 +19,7 @@ Table of Contents
 Introduction
 ~~~~~~~~~~~~
 
-Following the example in `Quick Start <readme.rst#quick-start>`__, we would like to go one step further and made ESP connect to next available access point if current connection is lost. This functionality is provided with 'ESP8266WiFiMulti' class and demonstrated in sketch below.
+Following the example in `Quick Start <readme.rst#quick-start>`__, we would like to go one step further and make the ESP connect to the next available access point if the current connection is lost. This functionality is provided with the 'ESP8266WiFiMulti' class and demonstrated in the sketch below.
 
 .. code:: cpp
 
@@ -66,7 +66,7 @@ Following the example in `Quick Start <readme.rst#quick-start>`__, we would like
 Prepare Access Points
 ~~~~~~~~~~~~~~~~~~~~~
 
-To try this sketch in action you need two (or more) access points. In lines below replace ``primary-network-name`` and ``pass-to-primary-network`` with name and password to your primary network. Do the same for secondary network.
+To try this sketch in action you need two (or more) access points. In the lines below replace ``primary-network-name`` and ``pass-to-primary-network`` with the name and password to your primary network. Do the same for the secondary network.
 
 .. code:: cpp
 
@@ -83,7 +83,7 @@ You may add more networks if you have more access points.
 Try it Out
 ~~~~~~~~~~
 
-Now upload updated sketch to ESP module and open serial monitor. Module will first scan for available networks. Then it will select and connect to the network with stronger signal. In case connection is lost, module will connect to next one available.
+Now upload the updated sketch to the ESP module and open a serial monitor. The module will first scan for available networks. Then it will select and connect to the network with a stronger signal. In case the connection is lost, the module will connect to the next one available.
 
 This process may look something like:
 
@@ -93,14 +93,14 @@ This process may look something like:
     Looking for WiFi ....... connected to sensor-net-2
     Looking for WiFi .... connected to sensor-net-1
 
-In above example ESP connected first to ``sensor-net-1``. Then I have switched ``sensor-net-1`` off. ESP discovered that connection is lost and started searching for another configured network. That happened to be ``sensor-net-2`` so ESP connected to it. Then I have switched ``sensor-net-1`` back on and shut down ``sensor-net-2``. ESP reconnected automatically to ``sensor-net-1``.
+In the above example the ESP connects first to ``sensor-net-1``. Then, after I have switched ``sensor-net-1`` off. The ESP discovers that the connection is lost and starts searching for another configured network. That happened to be ``sensor-net-2`` so the ESP connected to it. Then after I have switched ``sensor-net-1`` back on and shut down ``sensor-net-2``. The ESP reconnected automatically to ``sensor-net-1``.
 
-Function ``monitorWiFi()`` is in place to show when connection is lost by displaying ``Looking for WiFi``. Dots ``....`` are displayed during process of searching for another configured access point. Then a message like ``connected to sensor-net-2`` is shown when connection is established.
+Function ``monitorWiFi()`` is in place to show when connection is lost by displaying ``Looking for WiFi``. Dots ``....`` are displayed during the process of searching for another configured access point. Then a message like ``connected to sensor-net-2`` is shown when a connection is established.
 
 Can we Make it Simpler?
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-Please note that you may simplify this sketch by removing function ``monitorWiFi()`` and putting inside ``loop()`` only ``wifiMulti.run()``. ESP will still reconnect between configured access points if required. Now you won't be able to see it on serial monitor unless you add ``Serial.setDebugOutput(true)`` as described in point `Enable Wi-Fi Diagnostic <readme.rst#enable-wi-fi-diagnostic>`__.
+Please note that you may simplify this sketch by removing the function ``monitorWiFi()`` and putting inside ``loop()`` only ``wifiMulti.run()``. ESP will still reconnect between configured access points if required. Now you won't be able to see it on serial monitor unless you add ``Serial.setDebugOutput(true)`` as described in point `Enable Wi-Fi Diagnostic <readme.rst#enable-wi-fi-diagnostic>`__.
 
 Updated sketch for such scenario will look as follows:
 
@@ -127,9 +127,9 @@ Updated sketch for such scenario will look as follows:
       wifiMulti.run();
     }
 
-That's it! This is really all the code you need to make ESP automatically reconnecting between available networks.
+That's it! This is really all the code you need to make ESP automatically reconnect between available networks.
 
-After uploading sketch and opening the serial monitor, the messages will look as below.
+After uploading the sketch and opening the serial monitor, the messages will look as below.
 
 *Initial connection to sensor-net-1 on power up:*
 
@@ -198,8 +198,8 @@ After uploading sketch and opening the serial monitor, the messages will look as
 Conclusion
 ~~~~~~~~~~
 
-I believe the minimalist sketch with ``ESP8266WiFiMulti`` class is a cool example what ESP8266 can do for us behind the scenes with just couple lines of code.
+I believe the minimalist sketch with ``ESP8266WiFiMulti`` class is a cool example of what the ESP8266 can do for us behind the scenes with just couple lines of code.
 
-As shown in above example, reconnecting between access points takes time and is not seamless. Therefore, in practical applications, you will likely need to monitor connection status to decide e.g. if you can send the data to external system or should wait until connection is back.
+As shown in the above example, reconnecting between access points takes time and is not seamless. Therefore, in practical applications, you will likely need to monitor connection status to decide e.g. if you can send the data to an external system or should wait until the connection is back.
 
-For detailed review of functions provided to manage station mode please refer to the `Station Class <station-class.rst>`__ documentation.
+For a detailed review of functions provided to manage station mode please refer to the `Station Class <station-class.rst>`__ documentation.

libraries/ESP8266WebServer/src/detail/RequestHandler.h

@@ -10,10 +10,10 @@ class RequestHandler {
     using WebServerType = ESP8266WebServerTemplate<ServerType>;
 public:
     virtual ~RequestHandler() { }
-    virtual bool canHandle(HTTPMethod method, String uri) { (void) method; (void) uri; return false; }
-    virtual bool canUpload(String uri) { (void) uri; return false; }
-    virtual bool handle(WebServerType& server, HTTPMethod requestMethod, String requestUri) { (void) server; (void) requestMethod; (void) requestUri; return false; }
-    virtual void upload(WebServerType& server, String requestUri, HTTPUpload& upload) { (void) server; (void) requestUri; (void) upload; }
+    virtual bool canHandle(HTTPMethod method, const String& uri) { (void) method; (void) uri; return false; }
+    virtual bool canUpload(const String& uri) { (void) uri; return false; }
+    virtual bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) { (void) server; (void) requestMethod; (void) requestUri; return false; }
+    virtual void upload(WebServerType& server, const String& requestUri, HTTPUpload& upload) { (void) server; (void) requestUri; (void) upload; }
 
     RequestHandler<ServerType>* next() { return _next; }
     void next(RequestHandler<ServerType>* r) { _next = r; }

libraries/ESP8266WebServer/src/detail/RequestHandlersImpl.h

@@ -25,21 +25,21 @@ class FunctionRequestHandler : public RequestHandler<ServerType> {
         delete _uri;
     }
 
-    bool canHandle(HTTPMethod requestMethod, String requestUri) override  {
+    bool canHandle(HTTPMethod requestMethod, const String& requestUri) override  {
         if (_method != HTTP_ANY && _method != requestMethod)
             return false;
 
         return _uri->canHandle(requestUri, RequestHandler<ServerType>::pathArgs);
     }
 
-    bool canUpload(String requestUri) override  {
+    bool canUpload(const String& requestUri) override  {
         if (!_ufn || !canHandle(HTTP_POST, requestUri))
             return false;
 
         return true;
     }
 
-    bool handle(WebServerType& server, HTTPMethod requestMethod, String requestUri) override {
+    bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
         (void) server;
         if (!canHandle(requestMethod, requestUri))
             return false;
@@ -48,7 +48,7 @@ class FunctionRequestHandler : public RequestHandler<ServerType> {
         return true;
     }
 
-    void upload(WebServerType& server, String requestUri, HTTPUpload& upload) override {
+    void upload(WebServerType& server, const String& requestUri, HTTPUpload& upload) override {
         (void) server;
         (void) upload;
         if (canUpload(requestUri))
@@ -85,7 +85,7 @@ class StaticRequestHandler : public RequestHandler<ServerType> {
         _baseUriLength = _uri.length();
     }
 
-    bool canHandle(HTTPMethod requestMethod, String requestUri) override  {
+    bool canHandle(HTTPMethod requestMethod, const String& requestUri) override  {
         if ((requestMethod != HTTP_GET) && (requestMethod != HTTP_HEAD))
             return false;
 
@@ -95,27 +95,31 @@ class StaticRequestHandler : public RequestHandler<ServerType> {
         return true;
     }
 
-    bool handle(WebServerType& server, HTTPMethod requestMethod, String requestUri) override {
+    bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
+
         if (!canHandle(requestMethod, requestUri))
             return false;
 
         DEBUGV("StaticRequestHandler::handle: request=%s _uri=%s\r\n", requestUri.c_str(), _uri.c_str());
 
-        String path(_path);
+        String path;
+        path.reserve(_path.length() + requestUri.length() + 32);
+        path = _path;
 
         if (!_isFile) {
-            // Base URI doesn't point to a file.
-            // If a directory is requested, look for index file.
-            if (requestUri.endsWith("/"))
-              requestUri += "index.htm";
 
             // Append whatever follows this URI in request to get the file path.
             path += requestUri.substring(_baseUriLength);
 
+            // Base URI doesn't point to a file.
+            // If a directory is requested, look for index file.
+            if (path.endsWith("/"))
+                path += F("index.htm");
+
             // If neither <blah> nor <blah>.gz exist, and <blah> is a file.htm, try it with file.html instead
             // For the normal case this will give a search order of index.htm, index.htm.gz, index.html, index.html.gz
             if (!_fs.exists(path) && !_fs.exists(path + ".gz") && path.endsWith(".htm")) {
-                path += "l";
+                path += 'l';
             }
         }
         DEBUGV("StaticRequestHandler::handle: path=%s, isFile=%d\r\n", path.c_str(), _isFile);