FileHandler Class Reference

Helper class for accessing the file system and serving file content. More...

#include <HttpFileserver.h>

Collaboration diagram for FileHandler:

Public Member Functions
	FileHandler ()
	Construct a new FileHandler object.
bool	init ()
	Initialize and mount the storage (e.g., SD card).
bool	listDirectory (const std::string &path, std::vector< FileInfo > &out)
	Return a list of a given directory.
bool	serveFile (HttpResponse &res, const char *uri)
	Serve a file to the client via the HttpResponse object.

Public Attributes
bool	mounted = false
	Flag indicating whether storage is mounted.

Private Attributes
StorageManager *	storageManager

Detailed Description

Definition at line 27 of file HttpFileserver.h.

Constructor & Destructor Documentation

FileHandler()

FileHandler::FileHandler

(

)

Construct a new FileHandler object.

Definition at line 48 of file HttpFileserver.cpp.

{
}

Member Function Documentation

init()

bool FileHandler::init

(

)

Initialize and mount the storage (e.g., SD card).

Returns

true if mounted successfully.

Returns

true if mounted successfully.

Definition at line 53 of file HttpFileserver.cpp.

{
    StorageManager *storage = AppContext::get<StorageManager>();
    if (storage->mount())
    {
        TRACE("Storage mounted successfully\n");
        return true;
    }
    else
    {
        printf("Storage mount failed\n");
        return false;
    }
}

References AppContext::getTypeKey(), StorageManager::mount(), and TRACE.

Here is the call graph for this function:

listDirectory()

bool FileHandler::listDirectory	(	const std::string &	path,
		std::vector< FileInfo > &	out
	)

Return a list of a given directory.

Parameters

path	Directory path to list.

Parameters

path	Directory path to list.

Definition at line 69 of file HttpFileserver.cpp.

{
    auto *storage = AppContext::get<StorageManager>();
    return storage->listDirectory(path, out);
}

References AppContext::getTypeKey().

Referenced by HttpFileserver::handle_list_directory().

Here is the call graph for this function:

Here is the caller graph for this function:

serveFile()

bool FileHandler::serveFile	(	HttpResponse &	res,
		const char *	uri
	)

Serve a file to the client via the HttpResponse object.

Parameters

res	HTTP response object.
uri	URI or path to the file.

Returns

true if file was served successfully.

Parameters

res	HTTP response object.
uri	URI or path to the file.

Returns

true if file was served successfully.

Definition at line 76 of file HttpFileserver.cpp.

{
    std::string path = uri;
 
    storageManager = AppContext::get<StorageManager>();
    if (!storageManager->mount())
    {
        printf("Storage mount failed\n");
        JsonResponse::sendError(res, 500, "MOUNT_FAILED", "Storage mount failed");
        return false;
    }
 
    if (!storageManager->exists(path))
    {
        if (!storageManager->isMounted())
        {
            TRACE("Storage is not mounted — static file access failed\n");
            JsonResponse::sendError(res, 500, "NOT_MOUNTED", "Storage not mounted");
            return false;
        }
        else
        {
            printf("File not found: %s\n", path.c_str());
            JsonResponse::sendError(res, 404, "NOT_FOUND", "File Not Found: " + std::string(uri));
            return false;
        }
    }
 
    size_t fileSize = storageManager->getFileSize(path);
    if (fileSize == 0)
    {
        JsonResponse::sendError(res, 500, "FILESIZE_ERROR", "Error getting file size for: " + std::string(uri));
        return false;
    }
 
    std::string mimeType = getMimeType(path);
    TRACE("Serving file: %s, size: %zu bytes, MIME type: %s\n", path.c_str(), fileSize, mimeType.c_str());
 
    if (mimeType == "text/html" || mimeType == "application/javascript" || mimeType == "text/css")
    {
        // Gzip magic number: 0x1F 0x8B (in little-endian)
        const uint8_t gzip_magic_number[] = {0x1F, 0x8B};
        std::string magic_number;
        if (storageManager->readFileString(path, 0, 2, magic_number))
        {
            TRACE("Read magic number in hex: ");
            for (size_t i = 0; i < magic_number.size(); ++i)
            {
                TRACE("%02X ", static_cast<unsigned char>(magic_number[i]));
            }
            TRACE("\n");
            if (magic_number[0] == gzip_magic_number[0] && magic_number[1] == gzip_magic_number[1]) // GZIP magic number
            {
                TRACE("File is already gzipped: %s\n", path.c_str());
                TRACE("Setting Content-Encoding to gzip\n");
                res.set("Content-Encoding", "gzip");
            }
        }
    }
 
    res.start(200, fileSize, mimeType.c_str());
 
    storageManager->streamFile(path, [&](const uint8_t *data, size_t len)
                               {
        res.writeChunk(reinterpret_cast<const char*>(data), len);
        vTaskDelay(pdMS_TO_TICKS(STREAM_SEND_DELAY_MS)); }); // allow tcpip thread to get in
 
    res.finish();
    return true;
}

References StorageManager::exists(), HttpResponse::finish(), StorageManager::getFileSize(), getMimeType(), AppContext::getTypeKey(), StorageManager::isMounted(), StorageManager::mount(), StorageManager::readFileString(), JsonResponse::sendError(), HttpResponse::set(), HttpResponse::start(), storageManager, STREAM_SEND_DELAY_MS, StorageManager::streamFile(), TRACE, and HttpResponse::writeChunk().

Referenced by HttpFileserver::handle_static_request(), and HttpResponse::sendFile().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mounted

bool FileHandler::mounted = false

Definition at line 58 of file HttpFileserver.h.

storageManager

StorageManager* FileHandler::storageManager

private

Definition at line 61 of file HttpFileserver.h.

Referenced by serveFile().

---

The documentation for this class was generated from the following files:

• HttpFileserver.h
• HttpFileserver.cpp