Skip to content

Commit

Permalink
moved from loop() to timer/job; improved management of startup/shutdo…
Browse files Browse the repository at this point in the history 
…wn of web server; some auth improvements
  • Loading branch information
@gigapod
gigapod committed Mar 14, 2024
1 parent 7fec265 commit d889628
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 11 deletions.
64 changes: 61 additions & 3 deletions sfeDataLoggerIoT/sfeDLWebServer.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ const int kWebServerFilesPerPage = 20;

const uint32_t kWebServerLogoutInactivity = 300000;

const uint32_t kWebServerJobCheckTimeout = 60000;

const char *kWebServerAuthRelm = "SFE-DataLogger";

///////////////////////////////////////////////////////////////////////////////////////////////
Expand Down Expand Up @@ -51,9 +53,22 @@ bool sfeDLWebServer::checkAuthState(AsyncWebServerRequest *request)
if (!request->authenticate(authUsername().c_str(), authPassword().c_str(), kWebServerAuthRelm) || _bDoLogout)
{
_bDoLogout = false;

// on some browsers, auth of the web page doesn't auth the web-socket connection. So we manage
// this here. If we are not auth for a web page, we make sure auth is set for socket.
//
if (_pWebSocket)
_pWebSocket->setAuthentication(authUsername().c_str(), authPassword().c_str());

request->requestAuthentication(kWebServerAuthRelm);
return false;
}
else
{
// we are auth'd - disable auth on the web socket
if (_pWebSocket)
_pWebSocket->setAuthentication("", "");
}
}

// we had activity - update out watchdog point
Expand All @@ -72,6 +87,18 @@ bool sfeDLWebServer::setupServer(void)
if (_pWebServer)
return true;

// The web server can't be shutdown and then restarted (haven't fully figured this out)
// so if it was shutdown...
if (_wasShutdown)
{
flxLog_N("");
flxSerial.textToYellow();
flxLog_N("\tNOTE: The system must be restarted to start the web server once it's been shutdown.");
flxSerial.textToNormal();

return false;
}

_pWebServer = new AsyncWebServer(80);
if (!_pWebServer)
{
Expand All @@ -86,6 +113,7 @@ bool sfeDLWebServer::setupServer(void)
_pWebServer = nullptr;
return false;
}
_loginTicks = 0;
// hey, we have a web socket - yay
_pWebSocket->onEvent([this](AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg,
uint8_t *data,
Expand Down Expand Up @@ -146,8 +174,39 @@ bool sfeDLWebServer::setupServer(void)
// MDNS?
startMDNS();

// job/timer for when we should check login state
_jobCheckLogin.setup("webserver", kWebServerJobCheckTimeout, this, &sfeDLWebServer::checkLogin);
flxAddJobToQueue(_jobCheckLogin);

return true;
}
//-------------------------------------------------------------------------
void sfeDLWebServer::shutdownServer(void)
{
if (_pWebServer)
{

if (_pWebSocket)
{
_pWebServer->removeHandler(_pWebSocket);
// remove deletes the object
_pWebSocket = nullptr;
}
_pWebServer->end();
delete _pWebServer;
_pWebServer = nullptr;
_wasShutdown = true;

flxLog_N("");
flxSerial.textToYellow();
flxLog_N("\tNOTE: To restart the Web Server, the system must be restarted");
flxSerial.textToNormal();
}
shutdownMDNS();

_loginTicks = 0;
flxRemoveJobFromQueue(_jobCheckLogin);
}

//-------------------------------------------------------------------------
/**
Expand Down Expand Up @@ -465,12 +524,12 @@ std::string sfeDLWebServer::get_MDNSName(void)
//----------------------------------------------------------------

/**
* @brief loop() - system loop routine
* @brief checkLogin() - Job/Timer calling
*
* @return use this to check for logout
*/

bool sfeDLWebServer::loop()
void sfeDLWebServer::checkLogin()
{
// Are we checking auth and if so, did the timeout for inactivity expire?
if (_loginTicks > 0 && millis() - _loginTicks > kWebServerLogoutInactivity)
Expand All @@ -479,5 +538,4 @@ bool sfeDLWebServer::loop()
_bDoLogout = true;
_loginTicks = 0;
}
return false;
}
28 changes: 20 additions & 8 deletions sfeDataLoggerIoT/sfeDLWebServer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#pragma once

#include <Flux/flxCoreInterface.h>
#include <Flux/flxCoreJobs.h>
#include <Flux/flxFS.h>
#include <Flux/flxFileRotate.h>
#include <Flux/flxFlux.h>
Expand All @@ -35,12 +36,20 @@ class sfeDLWebServer : public flxActionType<sfeDLWebServer>

_isEnabled = bEnabled;

// did we disable, but have a file open?
if (!_isEnabled && _dirRoot.isValid())
// did we move to disable the server?
if (!_isEnabled)
{
_dirRoot.close();
_iCurrentFile = 1;
// did we disable, but have a file open?
if (_dirRoot.isValid())
{
_dirRoot.close();
_iCurrentFile = 1;
}
// shutdown the server
shutdownServer();
}
else if (_canConnect) // start server if network is up
setupServer();
}

//----------------------------------------------------------------
Expand Down Expand Up @@ -72,13 +81,14 @@ class sfeDLWebServer : public flxActionType<sfeDLWebServer>
setupServer();
}
bool setupServer(void);
void shutdownServer(void);
void onEventDerived(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg,
uint8_t *data, size_t len);

public:
sfeDLWebServer()
: _theNetwork{nullptr}, _isEnabled{false}, _isMDNSEnabled{false}, _canConnect{false}, _fileSystem{nullptr},
_pWebServer{nullptr}, _pWebSocket{nullptr}, _mdnsName{""}, _mdnsRunning{false},
: _theNetwork{nullptr}, _isEnabled{false}, _isMDNSEnabled{false}, _canConnect{false}, _wasShutdown{false},
_fileSystem{nullptr}, _pWebServer{nullptr}, _pWebSocket{nullptr}, _mdnsName{""}, _mdnsRunning{false},
_sPrefix("sfe"), _iCurrentFile{-1}, _loginTicks{0}, _bDoLogout{true}
{
setName("IoT Web Server", "Browse and Download log files on the SD Card");
Expand Down Expand Up @@ -130,8 +140,6 @@ class sfeDLWebServer : public flxActionType<sfeDLWebServer>
_sPrefix = sPrefix;
}

bool loop();

// Properties

// Enabled/Disabled
Expand Down Expand Up @@ -185,10 +193,12 @@ class sfeDLWebServer : public flxActionType<sfeDLWebServer>
bool startMDNS(void);
void shutdownMDNS(void);
void setupMDNSDefaultName(void);
void checkLogin(void);

bool _isEnabled;
bool _isMDNSEnabled;
bool _canConnect;
bool _wasShutdown; // we can't fully shutdown and restart the server.

AsyncWebServer *_pWebServer;
AsyncWebSocket *_pWebSocket;
Expand All @@ -208,4 +218,6 @@ class sfeDLWebServer : public flxActionType<sfeDLWebServer>

uint32_t _loginTicks;
bool _bDoLogout;

flxJob _jobCheckLogin;
};

0 comments on commit d889628

Please sign in to comment.