Add connect to Wifi and File Manager Webserver (#41)

## Summary - **What is the goal of this PR?** Implements wireless EPUB file management via a built-in web server, enabling users to upload, browse, organize, and delete EPUB files from any device on the same WiFi network without needing a computer cable connection. - **What changes are included?** - **New Web Server** ([`CrossPointWebServer.cpp`](src/CrossPointWebServer.cpp), [`CrossPointWebServer.h`](src/CrossPointWebServer.h)): - HTTP server on port 80 with a responsive HTML/CSS interface - Home page showing device status (version, IP, free memory) - File Manager with folder navigation and breadcrumb support - EPUB file upload with progress tracking - Folder creation and file/folder deletion - XSS protection via HTML escaping - Hidden system folders (`.` prefixed, "System Volume Information", "XTCache") - **WiFi Screen** ([`WifiScreen.cpp`](src/screens/WifiScreen.cpp), [`WifiScreen.h`](src/screens/WifiScreen.h)): - Network scanning with signal strength indicators - Visual indicators for encrypted (`*`) and saved (`+`) networks - State machine managing: scanning, network selection, password entry, connecting, save/forget prompts - 15-second connection timeout handling - Integration with web server (starts on connect, stops on exit) - **WiFi Credential Storage** ([`WifiCredentialStore.cpp`](src/WifiCredentialStore.cpp), [`WifiCredentialStore.h`](src/WifiCredentialStore.h)): - Persistent storage in `/sd/.crosspoint/wifi.bin` - XOR obfuscation for stored passwords (basic protection against casual reading) - Up to 8 saved networks with add/remove/update operations - **On-Screen Keyboard** ([`OnScreenKeyboard.cpp`](src/screens/OnScreenKeyboard.cpp), [`OnScreenKeyboard.h`](src/screens/OnScreenKeyboard.h)): - Reusable QWERTY keyboard component with shift support - Special keys: Shift, Space, Backspace, Done - Support for password masking mode - **Settings Screen Integration** ([`SettingsScreen.h`](src/screens/SettingsScreen.h)): - Added WiFi action to navigate to the new WiFi screen - **Documentation** ([`docs/webserver.md`](docs/webserver.md)): - Comprehensive user guide covering WiFi setup, web interface usage, file management, troubleshooting, and security notes - See this for more screenshots! - Working "displays the right way in GitHub" on my repo: https://github.com/olearycrew/crosspoint-reader/blob/feature/connect-to-wifi/docs/webserver.md **Video demo** https://github.com/user-attachments/assets/283e32dc-2d9f-4ae2-848e-01f41166a731 ## Additional Context - **Security considerations**: The web server has no authentication—anyone on the same WiFi network can access files. This is documented as a limitation, recommending use only on trusted private networks. Password obfuscation in the credential store is XOR-based, not cryptographically secure. - **Memory implications**: The web server and WiFi stack consume significant memory. The implementation properly cleans up (stops server, disconnects WiFi, sets `WIFI_OFF` mode) when exiting the WiFi screen to free resources. - **Async operations**: Network scanning and connection use async patterns with FreeRTOS tasks to prevent blocking the UI. The display task handles rendering on a dedicated thread with mutex protection. - **Browser compatibility**: The web interface uses standard HTML5/CSS3/JavaScript and is tested to work with all modern browsers on desktop and mobile. --------- Co-authored-by: Dave Allie <dave@daveallie.com>
2025-12-19 09:05:43 -05:00
parent cf6fec78dc
commit d41d539435
29 changed files with 3791 additions and 20 deletions
--- a/src/activities/network/CrossPointWebServerActivity.cpp
+++ b/src/activities/network/CrossPointWebServerActivity.cpp
@@ -0,0 +1,243 @@
+#include "CrossPointWebServerActivity.h"
+
+#include <GfxRenderer.h>
+#include <WiFi.h>
+
+#include "config.h"
+
+void CrossPointWebServerActivity::taskTrampoline(void* param) {
+  auto* self = static_cast<CrossPointWebServerActivity*>(param);
+  self->displayTaskLoop();
+}
+
+void CrossPointWebServerActivity::onEnter() {
+  Serial.printf("[%lu] [WEBACT] ========== CrossPointWebServerActivity onEnter ==========\n", millis());
+  Serial.printf("[%lu] [WEBACT] [MEM] Free heap at onEnter: %d bytes\n", millis(), ESP.getFreeHeap());
+
+  renderingMutex = xSemaphoreCreateMutex();
+
+  // Reset state
+  state = WebServerActivityState::WIFI_SELECTION;
+  connectedIP.clear();
+  connectedSSID.clear();
+  lastHandleClientTime = 0;
+  updateRequired = true;
+
+  xTaskCreate(&CrossPointWebServerActivity::taskTrampoline, "WebServerActivityTask",
+              2048,               // Stack size
+              this,               // Parameters
+              1,                  // Priority
+              &displayTaskHandle  // Task handle
+  );
+
+  // Turn on WiFi immediately
+  Serial.printf("[%lu] [WEBACT] Turning on WiFi...\n", millis());
+  WiFi.mode(WIFI_STA);
+
+  // Launch WiFi selection subactivity
+  Serial.printf("[%lu] [WEBACT] Launching WifiSelectionActivity...\n", millis());
+  wifiSelection.reset(new WifiSelectionActivity(renderer, inputManager,
+                                                [this](bool connected) { onWifiSelectionComplete(connected); }));
+  wifiSelection->onEnter();
+}
+
+void CrossPointWebServerActivity::onExit() {
+  Serial.printf("[%lu] [WEBACT] ========== CrossPointWebServerActivity onExit START ==========\n", millis());
+  Serial.printf("[%lu] [WEBACT] [MEM] Free heap at onExit start: %d bytes\n", millis(), ESP.getFreeHeap());
+
+  state = WebServerActivityState::SHUTTING_DOWN;
+
+  // Stop the web server first (before disconnecting WiFi)
+  stopWebServer();
+
+  // Exit WiFi selection subactivity if still active
+  if (wifiSelection) {
+    Serial.printf("[%lu] [WEBACT] Exiting WifiSelectionActivity...\n", millis());
+    wifiSelection->onExit();
+    wifiSelection.reset();
+    Serial.printf("[%lu] [WEBACT] WifiSelectionActivity exited\n", millis());
+  }
+
+  // CRITICAL: Wait for LWIP stack to flush any pending packets
+  Serial.printf("[%lu] [WEBACT] Waiting 500ms for network stack to flush pending packets...\n", millis());
+  delay(500);
+
+  // Disconnect WiFi gracefully
+  Serial.printf("[%lu] [WEBACT] Disconnecting WiFi (graceful)...\n", millis());
+  WiFi.disconnect(false);  // false = don't erase credentials, send disconnect frame
+  delay(100);              // Allow disconnect frame to be sent
+
+  Serial.printf("[%lu] [WEBACT] Setting WiFi mode OFF...\n", millis());
+  WiFi.mode(WIFI_OFF);
+  delay(100);  // Allow WiFi hardware to fully power down
+
+  Serial.printf("[%lu] [WEBACT] [MEM] Free heap after WiFi disconnect: %d bytes\n", millis(), ESP.getFreeHeap());
+
+  // Acquire mutex before deleting task
+  Serial.printf("[%lu] [WEBACT] Acquiring rendering mutex before task deletion...\n", millis());
+  xSemaphoreTake(renderingMutex, portMAX_DELAY);
+
+  // Delete the display task
+  Serial.printf("[%lu] [WEBACT] Deleting display task...\n", millis());
+  if (displayTaskHandle) {
+    vTaskDelete(displayTaskHandle);
+    displayTaskHandle = nullptr;
+    Serial.printf("[%lu] [WEBACT] Display task deleted\n", millis());
+  }
+
+  // Delete the mutex
+  Serial.printf("[%lu] [WEBACT] Deleting mutex...\n", millis());
+  vSemaphoreDelete(renderingMutex);
+  renderingMutex = nullptr;
+  Serial.printf("[%lu] [WEBACT] Mutex deleted\n", millis());
+
+  Serial.printf("[%lu] [WEBACT] [MEM] Free heap at onExit end: %d bytes\n", millis(), ESP.getFreeHeap());
+  Serial.printf("[%lu] [WEBACT] ========== CrossPointWebServerActivity onExit COMPLETE ==========\n", millis());
+}
+
+void CrossPointWebServerActivity::onWifiSelectionComplete(bool connected) {
+  Serial.printf("[%lu] [WEBACT] WifiSelectionActivity completed, connected=%d\n", millis(), connected);
+
+  if (connected) {
+    // Get connection info before exiting subactivity
+    connectedIP = wifiSelection->getConnectedIP();
+    connectedSSID = WiFi.SSID().c_str();
+
+    // Exit the wifi selection subactivity
+    wifiSelection->onExit();
+    wifiSelection.reset();
+
+    // Start the web server
+    startWebServer();
+  } else {
+    // User cancelled - go back
+    onGoBack();
+  }
+}
+
+void CrossPointWebServerActivity::startWebServer() {
+  Serial.printf("[%lu] [WEBACT] Starting web server...\n", millis());
+
+  // Create the web server instance
+  webServer.reset(new CrossPointWebServer());
+  webServer->begin();
+
+  if (webServer->isRunning()) {
+    state = WebServerActivityState::SERVER_RUNNING;
+    Serial.printf("[%lu] [WEBACT] Web server started successfully\n", millis());
+
+    // Force an immediate render since we're transitioning from a subactivity
+    // that had its own rendering task. We need to make sure our display is shown.
+    xSemaphoreTake(renderingMutex, portMAX_DELAY);
+    render();
+    xSemaphoreGive(renderingMutex);
+    Serial.printf("[%lu] [WEBACT] Rendered File Transfer screen\n", millis());
+  } else {
+    Serial.printf("[%lu] [WEBACT] ERROR: Failed to start web server!\n", millis());
+    webServer.reset();
+    // Go back on error
+    onGoBack();
+  }
+}
+
+void CrossPointWebServerActivity::stopWebServer() {
+  if (webServer && webServer->isRunning()) {
+    Serial.printf("[%lu] [WEBACT] Stopping web server...\n", millis());
+    webServer->stop();
+    Serial.printf("[%lu] [WEBACT] Web server stopped\n", millis());
+  }
+  webServer.reset();
+}
+
+void CrossPointWebServerActivity::loop() {
+  // Handle different states
+  switch (state) {
+    case WebServerActivityState::WIFI_SELECTION:
+      // Forward loop to WiFi selection subactivity
+      if (wifiSelection) {
+        wifiSelection->loop();
+      }
+      break;
+
+    case WebServerActivityState::SERVER_RUNNING:
+      // Handle web server requests - call handleClient multiple times per loop
+      // to improve responsiveness and upload throughput
+      if (webServer && webServer->isRunning()) {
+        unsigned long timeSinceLastHandleClient = millis() - lastHandleClientTime;
+
+        // Log if there's a significant gap between handleClient calls (>100ms)
+        if (lastHandleClientTime > 0 && timeSinceLastHandleClient > 100) {
+          Serial.printf("[%lu] [WEBACT] WARNING: %lu ms gap since last handleClient\n", millis(),
+                        timeSinceLastHandleClient);
+        }
+
+        // Call handleClient multiple times to process pending requests faster
+        // This is critical for upload performance - HTTP file uploads send data
+        // in chunks and each handleClient() call processes incoming data
+        constexpr int HANDLE_CLIENT_ITERATIONS = 10;
+        for (int i = 0; i < HANDLE_CLIENT_ITERATIONS && webServer->isRunning(); i++) {
+          webServer->handleClient();
+        }
+        lastHandleClientTime = millis();
+      }
+
+      // Handle exit on Back button
+      if (inputManager.wasPressed(InputManager::BTN_BACK)) {
+        onGoBack();
+        return;
+      }
+      break;
+
+    case WebServerActivityState::SHUTTING_DOWN:
+      // Do nothing - waiting for cleanup
+      break;
+  }
+}
+
+void CrossPointWebServerActivity::displayTaskLoop() {
+  while (true) {
+    if (updateRequired) {
+      updateRequired = false;
+      xSemaphoreTake(renderingMutex, portMAX_DELAY);
+      render();
+      xSemaphoreGive(renderingMutex);
+    }
+    vTaskDelay(10 / portTICK_PERIOD_MS);
+  }
+}
+
+void CrossPointWebServerActivity::render() const {
+  // Only render our own UI when server is running
+  // WiFi selection handles its own rendering
+  if (state == WebServerActivityState::SERVER_RUNNING) {
+    renderer.clearScreen();
+    renderServerRunning();
+    renderer.displayBuffer();
+  }
+}
+
+void CrossPointWebServerActivity::renderServerRunning() const {
+  const auto pageWidth = GfxRenderer::getScreenWidth();
+  const auto pageHeight = GfxRenderer::getScreenHeight();
+  const auto height = renderer.getLineHeight(UI_FONT_ID);
+  const auto top = (pageHeight - height * 5) / 2;
+
+  renderer.drawCenteredText(READER_FONT_ID, top - 30, "File Transfer", true, BOLD);
+
+  std::string ssidInfo = "Network: " + connectedSSID;
+  if (ssidInfo.length() > 28) {
+    ssidInfo = ssidInfo.substr(0, 25) + "...";
+  }
+  renderer.drawCenteredText(UI_FONT_ID, top + 10, ssidInfo.c_str(), true, REGULAR);
+
+  std::string ipInfo = "IP Address: " + connectedIP;
+  renderer.drawCenteredText(UI_FONT_ID, top + 40, ipInfo.c_str(), true, REGULAR);
+
+  // Show web server URL prominently
+  std::string webInfo = "http://" + connectedIP + "/";
+  renderer.drawCenteredText(UI_FONT_ID, top + 70, webInfo.c_str(), true, BOLD);
+
+  renderer.drawCenteredText(SMALL_FONT_ID, top + 110, "Open this URL in your browser", true, REGULAR);
+
+  renderer.drawCenteredText(SMALL_FONT_ID, pageHeight - 30, "Press BACK to exit", true, REGULAR);
+}