firmware/src/FSCommon.cpp

/**
 * @file FSCommon.cpp
 * @brief This file contains functions for common filesystem operations such as copying, renaming, listing and deleting files and
 * directories.
 *
 * The functions in this file are used to perform common filesystem operations such as copying, renaming, listing and deleting
 * files and directories. These functions are used in the Meshtastic-device project to manage files and directories on the
 * device's filesystem.
 *
 */
#include "FSCommon.h"
#include "configuration.h"

#ifdef HAS_SDCARD
#include <SD.h>
#include <SPI.h>

#ifdef SDCARD_USE_SPI1
SPIClass SPI1(HSPI);
#define SDHandler SPI1
#else
#define SDHandler SPI
#endif

#endif // HAS_SDCARD

/**
 * @brief Copies a file from one location to another.
 *
 * @param from The path of the source file.
 * @param to The path of the destination file.
 * @return true if the file was successfully copied, false otherwise.
 */
bool copyFile(const char *from, const char *to)
{
#ifdef FSCom
    unsigned char cbuffer[16];

    File f1 = FSCom.open(from, FILE_O_READ);
    if (!f1) {
        LOG_ERROR("Failed to open source file %s\n", from);
        return false;
    }

    File f2 = FSCom.open(to, FILE_O_WRITE);
    if (!f2) {
        LOG_ERROR("Failed to open destination file %s\n", to);
        return false;
    }

    while (f1.available() > 0) {
        byte i = f1.read(cbuffer, 16);
        f2.write(cbuffer, i);
    }

    f2.flush();
    f2.close();
    f1.close();
    return true;
#endif
}

/**
 * Renames a file from pathFrom to pathTo.
 *
 * @param pathFrom The original path of the file.
 * @param pathTo The new path of the file.
 *
 * @return True if the file was successfully renamed, false otherwise.
 */
bool renameFile(const char *pathFrom, const char *pathTo)
{
#ifdef FSCom
#ifdef ARCH_ESP32
    // rename was fixed for ESP32 IDF LittleFS in April
    return FSCom.rename(pathFrom, pathTo);
#else
    if (copyFile(pathFrom, pathTo) && FSCom.remove(pathFrom)) {
        return true;
    } else {
        return false;
    }
#endif
#endif
}

/**
 * Lists the contents of a directory.
 *
 * @param dirname The name of the directory to list.
 * @param levels The number of levels of subdirectories to list.
 * @param del Whether or not to delete the contents of the directory after listing.
 */
void listDir(const char *dirname, uint8_t levels, bool del = false)
{
#ifdef FSCom
#if (defined(ARCH_ESP32) || defined(ARCH_RP2040) || defined(ARCH_PORTDUINO))
    char buffer[255];
#endif
    File root = FSCom.open(dirname, FILE_O_READ);
    if (!root) {
        return;
    }
    if (!root.isDirectory()) {
        return;
    }

    File file = root.openNextFile();
    while (file) {
        if (file.isDirectory() && !String(file.name()).endsWith(".")) {
            if (levels) {
#ifdef ARCH_ESP32
                listDir(file.path(), levels - 1, del);
                if (del) {
                    LOG_DEBUG("Removing %s\n", file.path());
                    strncpy(buffer, file.path(), sizeof(buffer));
                    file.close();
                    FSCom.rmdir(buffer);
                } else {
                    file.close();
                }
#elif (defined(ARCH_RP2040) || defined(ARCH_PORTDUINO))
                listDir(file.name(), levels - 1, del);
                if (del) {
                    LOG_DEBUG("Removing %s\n", file.name());
                    strncpy(buffer, file.name(), sizeof(buffer));
                    file.close();
                    FSCom.rmdir(buffer);
                } else {
                    file.close();
                }
#else
                listDir(file.name(), levels - 1, del);
                file.close();
#endif
            }
        } else {
#ifdef ARCH_ESP32
            if (del) {
                LOG_DEBUG("Deleting %s\n", file.path());
                strncpy(buffer, file.path(), sizeof(buffer));
                file.close();
                FSCom.remove(buffer);
            } else {
                LOG_DEBUG(" %s (%i Bytes)\n", file.path(), file.size());
                file.close();
            }
#elif (defined(ARCH_RP2040) || defined(ARCH_PORTDUINO))
            if (del) {
                LOG_DEBUG("Deleting %s\n", file.name());
                strncpy(buffer, file.name(), sizeof(buffer));
                file.close();
                FSCom.remove(buffer);
            } else {
                LOG_DEBUG(" %s (%i Bytes)\n", file.name(), file.size());
                file.close();
            }
#else
            LOG_DEBUG(" %s (%i Bytes)\n", file.name(), file.size());
            file.close();
#endif
        }
        file = root.openNextFile();
    }
#ifdef ARCH_ESP32
    if (del) {
        LOG_DEBUG("Removing %s\n", root.path());
        strncpy(buffer, root.path(), sizeof(buffer));
        root.close();
        FSCom.rmdir(buffer);
    } else {
        root.close();
    }
#elif (defined(ARCH_RP2040) || defined(ARCH_PORTDUINO))
    if (del) {
        LOG_DEBUG("Removing %s\n", root.name());
        strncpy(buffer, root.name(), sizeof(buffer));
        root.close();
        FSCom.rmdir(buffer);
    } else {
        root.close();
    }
#else
    root.close();
#endif
#endif
}

/**
 * @brief Removes a directory and all its contents.
 *
 * This function recursively removes a directory and all its contents, including subdirectories and files.
 *
 * @param dirname The name of the directory to remove.
 */
void rmDir(const char *dirname)
{
#ifdef FSCom
#if (defined(ARCH_ESP32) || defined(ARCH_RP2040) || defined(ARCH_PORTDUINO))
    listDir(dirname, 10, true);
#elif defined(ARCH_NRF52)
    // nRF52 implementation of LittleFS has a recursive delete function
    FSCom.rmdir_r(dirname);
#endif
#endif
}

bool fsCheck()
{
#if defined(ARCH_NRF52)
    size_t write_size = 0;
    size_t read_size = 0;
    char buf[32] = {0};

    Adafruit_LittleFS_Namespace::File file(FSCom);
    const char *text = "meshtastic fs test";
    size_t text_length = strlen(text);
    const char *filename = "/meshtastic.txt";

    LOG_DEBUG("Try create file .\n");
    if (file.open(filename, FILE_O_WRITE)) {
        write_size = file.write(text);
    } else {
        LOG_DEBUG("Open file failed .\n");
        goto FORMAT_FS;
    }

    if (write_size != text_length) {
        LOG_DEBUG("Text bytes do not match .\n");
        file.close();
        goto FORMAT_FS;
    }

    file.close();

    if (!file.open(filename, FILE_O_READ)) {
        LOG_DEBUG("Open file failed .\n");
        goto FORMAT_FS;
    }

    read_size = file.readBytes(buf, text_length);
    if (read_size != text_length) {
        LOG_DEBUG("Text bytes do not match .\n");
        file.close();
        goto FORMAT_FS;
    }

    if (memcmp(buf, text, text_length) != 0) {
        LOG_DEBUG("The written bytes do not match the read bytes .\n");
        file.close();
        goto FORMAT_FS;
    }
    return true;
FORMAT_FS:
    LOG_DEBUG("Format FS ....\n");
    FSCom.format();
    FSCom.begin();
    return false;
#else
    return true;
#endif
}

void fsInit()
{
#ifdef FSCom
    if (!FSBegin()) {
        LOG_ERROR("Filesystem mount Failed.\n");
        // assert(0); This auto-formats the partition, so no need to fail here.
    }
#if defined(ARCH_ESP32)
    LOG_DEBUG("Filesystem files (%d/%d Bytes):\n", FSCom.usedBytes(), FSCom.totalBytes());
#elif defined(ARCH_NRF52)
    /*
     * nRF52840 has a certain chance of automatic formatting failure.
     * Try to create a file after initializing the file system. If the creation fails,
     * it means that the file system is not working properly. Please format it manually again.
     * To check the normality of the file system, you need to disable the LFS_NO_ASSERT assertion.
     * Otherwise, the assertion will be entered at the moment of reading or opening, and the FS will not be formatted.
     * */
    bool ret = false;
    uint8_t retry = 3;

    while (retry--) {
        ret = fsCheck();
        if (ret) {
            LOG_DEBUG("File system check is OK.\n");
            break;
        }
        delay(10);
    }

    // It may not be possible to reach this step.
    // Add a loop here to prevent unpredictable situations from happening.
    // Can add a screen to display error status later.
    if (!ret) {
        while (1) {
            LOG_ERROR("The file system is damaged and cannot proceed to the next step.\n");
            delay(1000);
        }
    }
#else
    LOG_DEBUG("Filesystem files:\n");
#endif
    listDir("/", 10);
#endif
}

/**
 * Initializes the SD card and mounts the file system.
 */
void setupSDCard()
{
#ifdef HAS_SDCARD
    SDHandler.begin(SPI_SCK, SPI_MISO, SPI_MOSI);

    if (!SD.begin(SDCARD_CS, SDHandler)) {
        LOG_DEBUG("No SD_MMC card detected\n");
        return;
    }
    uint8_t cardType = SD.cardType();
    if (cardType == CARD_NONE) {
        LOG_DEBUG("No SD_MMC card attached\n");
        return;
    }
    LOG_DEBUG("SD_MMC Card Type: ");
    if (cardType == CARD_MMC) {
        LOG_DEBUG("MMC\n");
    } else if (cardType == CARD_SD) {
        LOG_DEBUG("SDSC\n");
    } else if (cardType == CARD_SDHC) {
        LOG_DEBUG("SDHC\n");
    } else {
        LOG_DEBUG("UNKNOWN\n");
    }

    uint64_t cardSize = SD.cardSize() / (1024 * 1024);
    LOG_DEBUG("SD Card Size: %lluMB\n", cardSize);
    LOG_DEBUG("Total space: %llu MB\n", SD.totalBytes() / (1024 * 1024));
    LOG_DEBUG("Used space: %llu MB\n", SD.usedBytes() / (1024 * 1024));
#endif
}