littlefs_esp8266_filesystem .cpp

Go to the documentation of this file.

/*
littlefs_esp8266_filesystem.cpp - ESP3D littlefs filesystem configuration class
 
  Copyright (c) 2014 Luc Lebosse. All rights reserved.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
#include "../../../include/esp3d_config.h"
#if (FILESYSTEM_FEATURE == ESP_LITTLEFS_FILESYSTEM)
#include "../esp_filesystem.h"
#include "../../../core/genLinkedList.h"
#include <FS.h>
#include <LittleFS.h>
 
Dir tDir_handle[ESP_MAX_OPENHANDLE];
extern File tFile_handle[ESP_MAX_OPENHANDLE];
 
bool ESP_FileSystem::begin()
{
    _started = LittleFS.begin();
    return _started;
}
void ESP_FileSystem::end()
{
    _started = false;
    LittleFS.end();
}
 
size_t ESP_FileSystem::freeBytes()
{
    return totalBytes() - usedBytes();
}
 
size_t ESP_FileSystem::totalBytes()
{
    fs::FSInfo info;
    LittleFS.info (info);
    return info.totalBytes;
}
 
size_t ESP_FileSystem::usedBytes()
{
    fs::FSInfo info;
    LittleFS.info (info);
    return info.usedBytes;
}
 
bool ESP_FileSystem::rename(const char *oldpath, const char *newpath)
{
    return LittleFS.rename(oldpath,newpath);
}
 
const char * ESP_FileSystem::FilesystemName()
{
    return "LittleFS";
}
 
bool ESP_FileSystem::format()
{
    return LittleFS.format();
}
 
ESP_File ESP_FileSystem::open(const char* path, uint8_t mode)
{
    //do some check
    if(((strcmp(path,"/") == 0) && ((mode == ESP_FILE_WRITE) || (mode == ESP_FILE_APPEND))) || (strlen(path) == 0)) {
        return ESP_File();
    }
    // path must start by '/'
    if (path[0] != '/') {
        return ESP_File();
    }
    File ftmp = LittleFS.open(path, (mode == ESP_FILE_READ)?"r":(mode == ESP_FILE_WRITE)?"w":"a");
    if(ftmp) {
        log_esp3d("Success openening: %s", path);
        if (ftmp.isFile()) {
            log_esp3d("It is a file");
            ESP_File esptmp(&ftmp, false,(mode == ESP_FILE_READ)?false:true, path);
            return esptmp;
        }
        if (ftmp.isDirectory()) {
            log_esp3d("It is a Directory");
        }
        ftmp.close();
    }
    log_esp3d("Opening as Directory");
    Dir dtmp = LittleFS.openDir(path);
    ESP_File esptmp(&dtmp, true, false, path);
    return esptmp;
}
 
bool ESP_FileSystem::exists(const char* path)
{
    bool res = false;
    //root should always be there if started
    if (strcmp(path, "/") == 0) {
        return _started;
    }
    String spath = path;
    spath.trim();
    if (spath[spath.length()-1] == '/') {
        if (spath!="/") {
            spath.remove(spath.length()-1);
        }
    }
    return LittleFS.exists(spath.c_str());
}
 
bool ESP_FileSystem::remove(const char *path)
{
    return LittleFS.remove(path);
}
 
bool ESP_FileSystem::mkdir(const char *path)
{
    String spath = path;
    spath.trim();
    if (spath[spath.length()-1] == '/') {
        if (spath!="/") {
            spath.remove(spath.length()-1);
        }
    }
    return LittleFS.mkdir(spath.c_str());
}
 
bool ESP_FileSystem::rmdir(const char *path)
{
    if (!exists(path)) {
        return false;
    }
    bool res = true;
    GenLinkedList<String > pathlist;
    String spath = path;
    spath.trim();
    if (spath[spath.length()-1] != '/') {
        spath+="/";
    }
    if (spath[0] != '/') {
        spath ="/" + spath;
    }
    pathlist.push(spath);
    while (pathlist.count() > 0) {
        spath=pathlist.getLast();
        bool candelete = true;
        if (LittleFS.exists(spath.c_str()))  {
            Dir dir = LittleFS.openDir(pathlist.getLast().c_str());
            while (dir.next()) {
                if (dir.isDirectory()) {
                    candelete = false;
                    String newdir = pathlist.getLast() + dir.fileName() + "/";
                    pathlist.push(newdir);
                } else {
                    log_esp3d("remove %s", dir.fileName().c_str());
                    String s = spath + dir.fileName();
                    LittleFS.remove(s);
                }
            }
        }
        if (candelete) {
            if (spath !="/") {
                if (spath[spath.length()-1] == '/') {
                    spath.remove(spath.length()-1);
                }
                if (LittleFS.exists(spath.c_str()))  {
                    res = LittleFS.rmdir(spath.c_str());
                }
                log_esp3d("rmdir %s %d", spath.c_str(), res);
            }
            pathlist.pop();
        }
    }
    return res;
}
 
void ESP_FileSystem::closeAll()
{
    for (uint8_t i = 0; i < ESP_MAX_OPENHANDLE; i++) {
        tDir_handle[i] = Dir();
        tFile_handle[i].close();
        tFile_handle[i] = File();
    }
}
 
ESP_File::ESP_File(void* handle, bool isdir, bool iswritemode, const char * path)
{
    _isdir = isdir;
    _dirlist = "";
    _isfakedir = false;
    _index = -1;
    _filename = "";
    _name = "";
    _lastwrite = 0;
    _iswritemode = iswritemode;
    _size = 0;
    if (!handle) {
        return ;
    }
    bool set =false;
    if (_isdir) {
        for (uint8_t i=0; (i < ESP_MAX_OPENHANDLE) && !set; i++) {
            if (tDir_handle[i].fileName().length() == 0) {
                tDir_handle[i] = *((Dir *)handle);
                _index = i;
                //Path = filename
                if (path) {
                    _filename = path;
                    _filename.trim();
                    if (!((_filename[_filename.length()-1] == '/') || (_filename == "/"))) {
                        _filename+="/";
                    }
                    //log_esp3d("Filename: %s", _filename.c_str());
                    //Name
                    if (_filename == "/") {
                        _name = "/";
                    } else {
                        _name.remove( 0, _name.lastIndexOf('/')+1);
                    }
                }
                //log_esp3d("Name: %s index: %d", _name.c_str(), _index);
                set = true;
            }
        }
        return;
    }
 
    for (uint8_t i=0; (i < ESP_MAX_OPENHANDLE) && !set; i++) {
        if (!tFile_handle[i]) {
            tFile_handle[i] = *((File*)handle);
            //filename
            _filename = tFile_handle[i].name();
            if (_isdir) {
                if (!((_filename[_filename.length()-1] == '/') || (_filename == "/"))) {
                    _filename+="/";
                }
            }
            //name
            if (_filename == "/") {
                _name = "/";
            } else {
                _name = _filename;
                if (_name[0] == '/') {
                    _name.remove( 0, 1);
                }
                int pos = _name.lastIndexOf('/');
                if (pos != -1) {
                    _name.remove( 0, pos+1);
                }
            }
            //size
            _size = tFile_handle[i].size();
            //time
            //TODO - not yet implemented in esp core
            //_lastwrite =  tFile_handle[i].getLastWrite();
            _lastwrite = 0;
            _index = i;
            //log_esp3d("Opening File at index %d",_index);
            set = true;
        }
    }
}
 
void ESP_File::close()
{
    if (_index != -1) {
        if (_isdir) {
            //log_esp3d("Closing Dir at index %d", _index);
            tDir_handle[_index] = Dir();
            _index = -1;
            return;
        }
        //log_esp3d("Closing File at index %d", _index);
        tFile_handle[_index].close();
        //reopen if mode = write
        //udate size + date
        if (_iswritemode && !_isdir) {
            File ftmp = LittleFS.open(_filename.c_str(), "r");
            if (ftmp) {
                _size = ftmp.size();
                //TODO - not yet implemented in esp core
                //_lastwrite = ftmp.getLastWrite();
                _lastwrite = 0;
                ftmp.close();
            }
        }
        //log_esp3d("Closing File at index %d",_index);
        _index = -1;
    }
}
 
ESP_File  ESP_File::openNextFile()
{
    if ((_index == -1) || !_isdir) {
        log_esp3d("openNextFile failed");
        return ESP_File();
    }
    if(tDir_handle[_index].next()) {
        String name = tDir_handle[_index].fileName();
        log_esp3d("Getting next file from %s", _filename.c_str());
        log_esp3d("name :%s %s", name.c_str(), (tDir_handle[_index].isDirectory())?"isDir":"isFile");
        String  s = _filename;
        if(s[s.length()-1]!='/') {
            s+="/";
        }
        s+=name.c_str();
        if (tDir_handle[_index].isFile()) {
            ESP_File esptmp(name.c_str(), s.c_str(), false, tDir_handle[_index].fileSize()) ;
            return esptmp;
        } else {
            log_esp3d("Found dir  name: %s filename:%s",name.c_str(), s.c_str());
            ESP_File esptmp = ESP_File(name.c_str(), s.c_str());
            return esptmp;
        }
 
    }
    return  ESP_File();
}
 
#endif //ESP_LITTLEFS_FILESYSTEM